Portage.PackageId

Portage package identifiers, which unlike Cabal ones include a category.

Documentation

newtype Category

Constructors

Category

Fields

• unCategory :: String

Instances

Eq Category

Defined in Portage.PackageId

Methods

(==) :: Category -> Category -> Bool

(/=) :: Category -> Category -> Bool

Ord Category

Defined in Portage.PackageId

Methods

compare :: Category -> Category -> Ordering

(<) :: Category -> Category -> Bool

(<=) :: Category -> Category -> Bool

(>) :: Category -> Category -> Bool

(>=) :: Category -> Category -> Bool

max :: Category -> Category -> Category

min :: Category -> Category -> Category

Read Category

Defined in Portage.PackageId

Methods

readsPrec :: Int -> ReadS Category

readList :: ReadS [Category]

readPrec :: ReadPrec Category

readListPrec :: ReadPrec [Category]

Show Category

Defined in Portage.PackageId

Methods

showsPrec :: Int -> Category -> ShowS

show :: Category -> String

showList :: [Category] -> ShowS

NFData Category

Defined in Portage.PackageId

Methods

rnf :: Category -> ()

Pretty Category

Defined in Portage.PackageId

Methods

pretty :: Category -> Doc

prettyVersioned :: CabalSpecVersion -> Category -> Doc

Parsec Category

Defined in Portage.PackageId

Methods

parsec :: CabalParsing m => m Category

data PackageName

Portage-style PackageName, containing a Category and a PackageName.

Constructors

PackageName

Fields

• category :: Category
• cabalPkgName :: PackageName

Instances

Eq PackageName

Defined in Portage.PackageId

Methods

(==) :: PackageName -> PackageName -> Bool

(/=) :: PackageName -> PackageName -> Bool

Ord PackageName

Defined in Portage.PackageId

Methods

compare :: PackageName -> PackageName -> Ordering

(<) :: PackageName -> PackageName -> Bool

(<=) :: PackageName -> PackageName -> Bool

(>) :: PackageName -> PackageName -> Bool

(>=) :: PackageName -> PackageName -> Bool

max :: PackageName -> PackageName -> PackageName

min :: PackageName -> PackageName -> PackageName

Read PackageName

Defined in Portage.PackageId

Methods

readsPrec :: Int -> ReadS PackageName

readList :: ReadS [PackageName]

readPrec :: ReadPrec PackageName

readListPrec :: ReadPrec [PackageName]

Show PackageName

Defined in Portage.PackageId

Methods

showsPrec :: Int -> PackageName -> ShowS

show :: PackageName -> String

showList :: [PackageName] -> ShowS

NFData PackageName

Defined in Portage.PackageId

Methods

rnf :: PackageName -> ()

Pretty PackageName

Defined in Portage.PackageId

Methods

pretty :: PackageName -> Doc

prettyVersioned :: CabalSpecVersion -> PackageName -> Doc

Parsec PackageName

Defined in Portage.PackageId

Methods

parsec :: CabalParsing m => m PackageName

data PackageId

Portage-style PackageId, containing a PackageName and a Version.

Constructors

PackageId

Fields

• packageId :: PackageName
• pkgVersion :: Version

Instances

Eq PackageId

Defined in Portage.PackageId

Methods

(==) :: PackageId -> PackageId -> Bool

(/=) :: PackageId -> PackageId -> Bool

Ord PackageId

Defined in Portage.PackageId

Methods

compare :: PackageId -> PackageId -> Ordering

(<) :: PackageId -> PackageId -> Bool

(<=) :: PackageId -> PackageId -> Bool

(>) :: PackageId -> PackageId -> Bool

(>=) :: PackageId -> PackageId -> Bool

max :: PackageId -> PackageId -> PackageId

min :: PackageId -> PackageId -> PackageId

Read PackageId

Defined in Portage.PackageId

Methods

readsPrec :: Int -> ReadS PackageId

readList :: ReadS [PackageId]

readPrec :: ReadPrec PackageId

readListPrec :: ReadPrec [PackageId]

Show PackageId

Defined in Portage.PackageId

Methods

showsPrec :: Int -> PackageId -> ShowS

show :: PackageId -> String

showList :: [PackageId] -> ShowS

NFData PackageId

Defined in Portage.PackageId

Methods

rnf :: PackageId -> ()

Pretty PackageId

Defined in Portage.PackageId

Methods

pretty :: PackageId -> Doc

prettyVersioned :: CabalSpecVersion -> PackageId -> Doc

Parsec PackageId

Defined in Portage.PackageId

Methods

parsec :: CabalParsing m => m PackageId

data Version

Portage-style version type.

Constructors

Version

Fields

• versionNumber :: [Int]

  [1,42,3] ~= 1.42.3

• versionChar :: Maybe Char

  optional letter

• versionSuffix :: [Suffix]
• versionRevision :: Int

  revision, 0 means none

Instances

Eq Version

Defined in Portage.Version

Methods

(==) :: Version -> Version -> Bool

(/=) :: Version -> Version -> Bool

Ord Version

Defined in Portage.Version

Methods

compare :: Version -> Version -> Ordering

(<) :: Version -> Version -> Bool

(<=) :: Version -> Version -> Bool

(>) :: Version -> Version -> Bool

(>=) :: Version -> Version -> Bool

max :: Version -> Version -> Version

min :: Version -> Version -> Version

Read Version

Defined in Portage.Version

Methods

readsPrec :: Int -> ReadS Version

readList :: ReadS [Version]

readPrec :: ReadPrec Version

readListPrec :: ReadPrec [Version]

Show Version

Defined in Portage.Version

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

NFData Version

Defined in Portage.Version

Methods

rnf :: Version -> ()

Pretty Version

Prints a valid Portage Version string.

Defined in Portage.Version

Methods

pretty :: Version -> Doc

prettyVersioned :: CabalSpecVersion -> Version -> Doc

Parsec Version

Version parser using Parsec.

Defined in Portage.Version

Methods

parsec :: CabalParsing m => m Version

mkPackageName :: String -> String -> PackageName

Create a PackageName from supplied category and package name Strings.

fromCabalPackageId :: Category -> PackageIdentifier -> PackageId

Create a PackageId from a Category and PackageIdentifier.

toCabalPackageId :: PackageId -> Maybe PackageIdentifier

Convert a PackageId into a Maybe PackageIdentifier.

parseFriendlyPackage :: String -> Either String (Maybe Category, PackageName, Maybe Version)

Parse a String as a package in the form of [category/]name[-version]:

Note that we cannot use the parsec function to parse the PackageName, since it fails the entire parse if it tries to parse a Version. See parseCabalPackageName below.

If parsing a valid package string:

>>> 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}))

If malformed, return an error string:

>>> parseFriendlyPackage "category-name/package-name-1-0.0.0.1a_beta2-r4"
Left ...

normalizeCabalPackageName :: PackageName -> PackageName

Convert a PackageName into lowercase. Internally uses cabal_pn_to_PN.

>>> normalizeCabalPackageName (Cabal.mkPackageName "FooBar1")
PackageName "foobar1"

normalizeCabalPackageId :: PackageIdentifier -> PackageIdentifier

Apply normalizeCabalPackageName to the PackageName of a supplied PackageIdentifier.

filePathToPackageId :: Category -> FilePath -> Maybe PackageId

Maybe generate a PackageId from a FilePath. Note that the FilePath must have its file extension stripped before being passed to filePathToPackageId.

>>> 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}})

packageIdToFilePath :: PackageId -> FilePath

Transform a PackageId into a FilePath.

>>> 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"

cabal_pn_to_PN :: PackageName -> String

Pretty-print a lowercase PackageName.

Note the difference between this function and normalizeCabalPackageName: this function returns a String, the other a PackageName.

>>> cabal_pn_to_PN (Cabal.mkPackageName "FooBar1")
"foobar1"