-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Hackage and Portage integration tool
--   
--   A command line tool to manage an overlay of Gentoo ebuilds that are
--   generated from a hackage repo of Cabal packages.
@package hackport
@version 0.7.2.1

module Error

-- | Type holding all of the <a>HackPortError</a> constructors.
data HackPortError
ArgumentError :: String -> HackPortError
ConnectionFailed :: String -> String -> HackPortError
PackageNotFound :: String -> HackPortError
InvalidTarballURL :: String -> String -> HackPortError
InvalidSignatureURL :: String -> String -> HackPortError
VerificationFailed :: String -> String -> HackPortError
DownloadFailed :: String -> String -> HackPortError
UnknownCompression :: String -> HackPortError
UnpackingFailed :: String -> Int -> HackPortError
NoCabalFound :: String -> HackPortError
ExtractionFailed :: String -> String -> Int -> HackPortError
CabalParseFailed :: String -> String -> HackPortError
BashNotFound :: HackPortError
BashError :: String -> HackPortError
NoOverlay :: HackPortError
MultipleOverlays :: [String] -> HackPortError
UnknownVerbosityLevel :: String -> HackPortError

-- | WrongCacheVersion | InvalidCache
InvalidServer :: String -> HackPortError

-- | Throw a <a>HackPortError</a>.
throwEx :: HackPortError -> IO a

-- | Catch a <a>HackPortError</a>.
catchEx :: IO a -> (HackPortError -> IO a) -> IO a

-- | Show the error string for a given <a>HackPortError</a>.
hackPortShowError :: HackPortError -> String
instance GHC.Classes.Eq Error.HackPortError
instance GHC.Show.Show Error.HackPortError
instance GHC.Exception.Type.Exception Error.HackPortError

module Paths_hackport
version :: Version
getBinDir :: IO FilePath
getLibDir :: IO FilePath
getDynLibDir :: IO FilePath
getDataDir :: IO FilePath
getLibexecDir :: IO FilePath
getDataFileName :: FilePath -> IO FilePath
getSysconfDir :: IO FilePath


-- | Portage package identifiers, which unlike Cabal ones include a
--   category.
module Portage.PackageId
newtype Category
Category :: String -> Category
[unCategory] :: Category -> String

-- | Portage-style <a>PackageName</a>, containing a <a>Category</a> and a
--   <a>PackageName</a>.
data PackageName
PackageName :: Category -> PackageName -> PackageName
[category] :: PackageName -> Category
[cabalPkgName] :: PackageName -> PackageName

-- | Portage-style <a>PackageId</a>, containing a <a>PackageName</a> and a
--   <a>Version</a>.
data PackageId
PackageId :: PackageName -> Version -> PackageId
[packageId] :: PackageId -> PackageName
[pkgVersion] :: PackageId -> Version

-- | Portage-style version type.
data Version
Version :: [Int] -> Maybe Char -> [Suffix] -> Int -> Version

-- | <tt>[1,42,3]</tt> ~= 1.42.3
[versionNumber] :: Version -> [Int]

-- | optional letter
[versionChar] :: Version -> Maybe Char
[versionSuffix] :: Version -> [Suffix]

-- | revision, 0 means none
[versionRevision] :: Version -> Int

-- | Create a <a>PackageName</a> from supplied category and package name
--   <a>String</a>s.
mkPackageName :: String -> String -> PackageName

-- | Create a <a>PackageId</a> from a <a>Category</a> and
--   <a>PackageIdentifier</a>.
fromCabalPackageId :: Category -> PackageIdentifier -> PackageId

-- | Convert a <a>PackageId</a> into a <a>Maybe</a>
--   <a>PackageIdentifier</a>.
toCabalPackageId :: PackageId -> Maybe PackageIdentifier

-- | Parse a <a>String</a> as a package in the form of
--   <tt>[category/]name[-version]</tt>:
--   
--   Note that we <i>cannot</i> use the <a>parsec</a> function to parse the
--   <a>PackageName</a>, since it fails the entire parse if it tries to
--   parse a <tt>Version</tt>. See <a>parseCabalPackageName</a> below.
--   
--   If parsing a valid package string:
--   
--   <pre>
--   &gt;&gt;&gt; parseFriendlyPackage "category-name/package-name1-0.0.0.1a_beta2-r4"
--   Right (Just (Category {unCategory = "category-name"}),PackageName "package-name1",Just (Version {versionNumber = [0,0,0,1], versionChar = Just 'a', versionSuffix = [Beta 2], versionRevision = 4}))
--   </pre>
--   
--   If malformed, return an error string:
--   
--   <pre>
--   &gt;&gt;&gt; parseFriendlyPackage "category-name/package-name-1-0.0.0.1a_beta2-r4"
--   Left ...
--   </pre>
parseFriendlyPackage :: String -> Either String (Maybe Category, PackageName, Maybe Version)

-- | Convert a <a>PackageName</a> into lowercase. Internally uses
--   <a>cabal_pn_to_PN</a>.
--   
--   <pre>
--   &gt;&gt;&gt; normalizeCabalPackageName (Cabal.mkPackageName "FooBar1")
--   PackageName "foobar1"
--   </pre>
normalizeCabalPackageName :: PackageName -> PackageName

-- | Apply <a>normalizeCabalPackageName</a> to the <a>PackageName</a> of a
--   supplied <a>PackageIdentifier</a>.
normalizeCabalPackageId :: PackageIdentifier -> PackageIdentifier

-- | Maybe generate a <a>PackageId</a> from a <a>FilePath</a>. Note that
--   the <a>FilePath</a> must have its file extension stripped before being
--   passed to <a>filePathToPackageId</a>.
--   
--   <pre>
--   &gt;&gt;&gt; filePathToPackageId (Category "dev-haskell") "foo-bar2-3.0.0b_rc2-r1"
--   Just (PackageId {packageId = PackageName {category = Category {unCategory = "dev-haskell"}, cabalPkgName = PackageName "foo-bar2"}, pkgVersion = Version {versionNumber = [3,0,0], versionChar = Just 'b', versionSuffix = [RC 2], versionRevision = 1}})
--   </pre>
filePathToPackageId :: Category -> FilePath -> Maybe PackageId

-- | Transform a <a>PackageId</a> into a <a>FilePath</a>.
--   
--   <pre>
--   &gt;&gt;&gt; packageIdToFilePath (PackageId (PackageName (Category "dev-haskell") (Cabal.mkPackageName "foo-bar2")) (Portage.Version [3,0,0] (Just 'b') [Portage.RC 2] 1 ))
--   "dev-haskell/foo-bar2/foo-bar2-3.0.0b_rc2-r1.ebuild"
--   </pre>
packageIdToFilePath :: PackageId -> FilePath

-- | Pretty-print a lowercase <a>PackageName</a>.
--   
--   Note the difference between this function and
--   <a>normalizeCabalPackageName</a>: this function returns a
--   <a>String</a>, the other a <a>PackageName</a>.
--   
--   <pre>
--   &gt;&gt;&gt; cabal_pn_to_PN (Cabal.mkPackageName "FooBar1")
--   "foobar1"
--   </pre>
cabal_pn_to_PN :: PackageName -> String
instance GHC.Read.Read Portage.PackageId.Category
instance GHC.Show.Show Portage.PackageId.Category
instance GHC.Classes.Ord Portage.PackageId.Category
instance GHC.Classes.Eq Portage.PackageId.Category
instance GHC.Read.Read Portage.PackageId.PackageName
instance GHC.Show.Show Portage.PackageId.PackageName
instance GHC.Classes.Ord Portage.PackageId.PackageName
instance GHC.Classes.Eq Portage.PackageId.PackageName
instance GHC.Read.Read Portage.PackageId.PackageId
instance GHC.Show.Show Portage.PackageId.PackageId
instance GHC.Classes.Ord Portage.PackageId.PackageId
instance GHC.Classes.Eq Portage.PackageId.PackageId
instance Control.DeepSeq.NFData Portage.PackageId.PackageId
instance Distribution.Pretty.Pretty Portage.PackageId.PackageId
instance Distribution.Parsec.Parsec Portage.PackageId.PackageId
instance Control.DeepSeq.NFData Portage.PackageId.PackageName
instance Distribution.Pretty.Pretty Portage.PackageId.PackageName
instance Distribution.Parsec.Parsec Portage.PackageId.PackageName
instance Control.DeepSeq.NFData Portage.PackageId.Category
instance Distribution.Pretty.Pretty Portage.PackageId.Category
instance Distribution.Parsec.Parsec Portage.PackageId.Category

module Portage.Overlay
data ExistingEbuild
ExistingEbuild :: PackageId -> PackageIdentifier -> FilePath -> ExistingEbuild
[ebuildId] :: ExistingEbuild -> PackageId
[ebuildCabalId] :: ExistingEbuild -> PackageIdentifier
[ebuildPath] :: ExistingEbuild -> FilePath

-- | Type describing an overlay.
data Overlay
Overlay :: FilePath -> Map PackageName [ExistingEbuild] -> Map PackageName Metadata -> Overlay
[overlayPath] :: Overlay -> FilePath
[overlayMap] :: Overlay -> Map PackageName [ExistingEbuild]
[overlayMetadata] :: Overlay -> Map PackageName Metadata
loadLazy :: FilePath -> IO Overlay
readOverlay :: DirectoryTree -> [PackageId]
readOverlayByPackage :: DirectoryTree -> [(PackageName, [Version])]
getDirectoryTree :: FilePath -> IO DirectoryTree
type DirectoryTree = [DirectoryEntry]

-- | Make sure there is only one ebuild for each version number (by
--   selecting the highest ebuild version revision)
reduceOverlay :: Overlay -> Overlay
filterByEmail :: ([String] -> Bool) -> Overlay -> Overlay

-- | Is <a>PackageId</a> found in <a>Overlay</a>?
inOverlay :: Overlay -> PackageId -> Bool
instance GHC.Classes.Eq Portage.Overlay.ExistingEbuild
instance GHC.Classes.Ord Portage.Overlay.ExistingEbuild
instance GHC.Show.Show Portage.Overlay.ExistingEbuild
instance GHC.Show.Show Portage.Overlay.Overlay
instance Distribution.Package.Package Portage.Overlay.ExistingEbuild
instance Distribution.Package.HasUnitId Portage.Overlay.ExistingEbuild


-- | Core functionality of the <tt>merge</tt> command of <tt>HackPort</tt>.
module Merge

-- | This function is executed by the <tt>merge</tt> command of
--   <tt>HackPort</tt>. Its functionality is as follows:
--   
--   <ol>
--   <li>Feed user input to <tt>readPackageString</tt></li>
--   <li>Look for a matching package on the <tt>hackage</tt> database</li>
--   <li>Run <a>mergeGenericPackageDescription</a> with the supplied
--   information</li>
--   <li>Generate a coloured diff between the old and new ebuilds.</li>
--   </ol>
--   
--   Various information is printed in between these steps depending on the
--   <a>Verbosity</a>.
merge :: Verbosity -> RepoContext -> [String] -> FilePath -> Maybe String -> IO ()

-- | Generate an ebuild from a <a>GenericPackageDescription</a>.
mergeGenericPackageDescription :: Verbosity -> FilePath -> Category -> GenericPackageDescription -> Bool -> Maybe String -> IO ()

module Status
data FileStatus a
Same :: a -> FileStatus a
Differs :: a -> a -> FileStatus a
OverlayOnly :: a -> FileStatus a
PortageOnly :: a -> FileStatus a
HackageOnly :: a -> FileStatus a
data StatusDirection
PortagePlusOverlay :: StatusDirection
OverlayToPortage :: StatusDirection
HackageToOverlay :: StatusDirection
fromStatus :: FileStatus a -> a
status :: Verbosity -> FilePath -> FilePath -> RepoContext -> IO (Map PackageName [FileStatus ExistingEbuild])
runStatus :: Verbosity -> FilePath -> FilePath -> StatusDirection -> [String] -> RepoContext -> IO ()
instance GHC.Classes.Eq Status.StatusDirection
instance GHC.Classes.Eq a => GHC.Classes.Eq (Status.FileStatus a)
instance GHC.Show.Show a => GHC.Show.Show (Status.FileStatus a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Status.FileStatus a)
instance GHC.Base.Functor Status.FileStatus

module Portage.Host
getInfo :: IO LocalInfo
data LocalInfo
LocalInfo :: String -> [FilePath] -> FilePath -> LocalInfo
[distfiles_dir] :: LocalInfo -> String
[overlay_list] :: LocalInfo -> [FilePath]
[portage_dir] :: LocalInfo -> FilePath
instance GHC.Show.Show Portage.Host.LocalInfo
instance GHC.Read.Read Portage.Host.LocalInfo

module Overlays
getOverlayPath :: Verbosity -> Maybe FilePath -> IO String

module HackPort.GlobalFlags

-- | Type containing global flags.
data GlobalFlags
GlobalFlags :: Flag Bool -> Flag Bool -> Flag (Maybe FilePath) -> Flag (Maybe FilePath) -> GlobalFlags
[globalVersion] :: GlobalFlags -> Flag Bool
[globalNumericVersion] :: GlobalFlags -> Flag Bool
[globalPathToOverlay] :: GlobalFlags -> Flag (Maybe FilePath)
[globalPathToPortage] :: GlobalFlags -> Flag (Maybe FilePath)

-- | Default <a>GlobalFlags</a>.
defaultGlobalFlags :: GlobalFlags
withHackPortContext :: Verbosity -> GlobalFlags -> (RepoContext -> IO a) -> IO a