Copyright	Isaac Jones 2003-2004
License	BSD3
Maintainer	[email protected]
Portability	portable
Safe Haskell	None
Language	Haskell2010

Distribution.Package

Description

Defines a package identifier along with a parser and pretty printer for it. PackageIdentifiers consist of a name and an exact version. It also defines a Dependency data type. A dependency is a package name and a version range, like "foo >= 1.2 && < 2".

Synopsis

data AbiHash
unAbiHash :: AbiHash -> String
mkAbiHash :: String -> AbiHash
module Distribution.Types.ComponentId
module Distribution.Types.PackageId
module Distribution.Types.UnitId
data Module = Module DefUnitId ModuleName
module Distribution.Types.PackageName
data PkgconfigName
unPkgconfigName :: PkgconfigName -> String
mkPkgconfigName :: String -> PkgconfigName
module Distribution.Types.Dependency
class Package pkg where
- packageId :: pkg -> PackageIdentifier
packageName :: Package pkg => pkg -> PackageName
packageVersion :: Package pkg => pkg -> Version
class HasMungedPackageId pkg where
- mungedId :: pkg -> MungedPackageId
mungedName' :: HasMungedPackageId pkg => pkg -> MungedPackageName
mungedVersion' :: HasMungedPackageId munged => munged -> Version
class Package pkg => HasUnitId pkg where
- installedUnitId :: pkg -> UnitId
class HasUnitId pkg => PackageInstalled pkg where
- installedDepends :: pkg -> [UnitId]

Documentation

data AbiHash Source #

ABI Hashes

Use mkAbiHash and unAbiHash to convert from/to a String.

This type is opaque since Cabal-2.0

Since: 2.0.0.2

Instances

Instances details

Eq AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods (==) :: AbiHash -> AbiHash -> Bool # (/=) :: AbiHash -> AbiHash -> Bool #
Read AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods readsPrec :: Int -> ReadS AbiHash # readList :: ReadS [AbiHash] # readPrec :: ReadPrec AbiHash # readListPrec :: ReadPrec [AbiHash] #
Show AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods showsPrec :: Int -> AbiHash -> ShowS # show :: AbiHash -> String # showList :: [AbiHash] -> ShowS #
IsString AbiHash Source #	`mkAbiHash` Since: 2.0.0.2
Instance details Defined in Distribution.Types.AbiHash Methods fromString :: String -> AbiHash #
Generic AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Associated Types type Rep AbiHash :: Type -> Type # Methods from :: AbiHash -> Rep AbiHash x # to :: Rep AbiHash x -> AbiHash #
Binary AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods put :: AbiHash -> Put # get :: Get AbiHash # putList :: [AbiHash] -> Put #
NFData AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods rnf :: AbiHash -> () #
Structured AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods structure :: Proxy AbiHash -> Structure Source # structureHash' :: Tagged AbiHash MD5
Pretty AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods pretty :: AbiHash -> Doc Source # prettyVersioned :: CabalSpecVersion -> AbiHash -> Doc Source #
Parsec AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods parsec :: CabalParsing m => m AbiHash Source #
type Rep AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash type Rep AbiHash = D1 ('MetaData "AbiHash" "Distribution.Types.AbiHash" "hackport-0.7.2.2-Jf8zaDrP5aANzq8F6jTnI-hackport-external-libs-Cabal" 'True) (C1 ('MetaCons "AbiHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

unAbiHash :: AbiHash -> String Source #

Construct a AbiHash from a String

mkAbiHash is the inverse to unAbiHash

Note: No validations are performed to ensure that the resulting AbiHash is valid

Since: 2.0.0.2

mkAbiHash :: String -> AbiHash Source #

Convert AbiHash to String

Since: 2.0.0.2

module Distribution.Types.ComponentId

module Distribution.Types.PackageId

module Distribution.Types.UnitId

data Module Source #

A module identity uniquely identifies a Haskell module by qualifying a ModuleName with the UnitId which defined it. This type distinguishes between two packages which provide a module with the same name, or a module from the same package compiled with different dependencies. There are a few cases where Cabal needs to know about module identities, e.g., when writing out reexported modules in the InstalledPackageInfo.

Constructors

Module DefUnitId ModuleName

Instances

Instances details

Eq Module Source #
Instance details Defined in Distribution.Types.Module Methods (==) :: Module -> Module -> Bool # (/=) :: Module -> Module -> Bool #
Data Module Source #
Instance details Defined in Distribution.Types.Module Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Module -> c Module # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Module # toConstr :: Module -> Constr # dataTypeOf :: Module -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Module) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Module) # gmapT :: (forall b. Data b => b -> b) -> Module -> Module # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Module -> r # gmapQ :: (forall d. Data d => d -> u) -> Module -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Module -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Module -> m Module # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Module -> m Module #
Ord Module Source #
Instance details Defined in Distribution.Types.Module Methods compare :: Module -> Module -> Ordering # (<) :: Module -> Module -> Bool # (<=) :: Module -> Module -> Bool # (>) :: Module -> Module -> Bool # (>=) :: Module -> Module -> Bool # max :: Module -> Module -> Module # min :: Module -> Module -> Module #
Read Module Source #
Instance details Defined in Distribution.Types.Module Methods readsPrec :: Int -> ReadS Module # readList :: ReadS [Module] # readPrec :: ReadPrec Module # readListPrec :: ReadPrec [Module] #
Show Module Source #
Instance details Defined in Distribution.Types.Module Methods showsPrec :: Int -> Module -> ShowS # show :: Module -> String # showList :: [Module] -> ShowS #
Generic Module Source #
Instance details Defined in Distribution.Types.Module Associated Types type Rep Module :: Type -> Type # Methods from :: Module -> Rep Module x # to :: Rep Module x -> Module #
Binary Module Source #
Instance details Defined in Distribution.Types.Module Methods put :: Module -> Put # get :: Get Module # putList :: [Module] -> Put #
NFData Module Source #
Instance details Defined in Distribution.Types.Module Methods rnf :: Module -> () #
Structured Module Source #
Instance details Defined in Distribution.Types.Module Methods structure :: Proxy Module -> Structure Source # structureHash' :: Tagged Module MD5
Pretty Module Source #
Instance details Defined in Distribution.Types.Module Methods pretty :: Module -> Doc Source # prettyVersioned :: CabalSpecVersion -> Module -> Doc Source #
Parsec Module Source #
Instance details Defined in Distribution.Types.Module Methods parsec :: CabalParsing m => m Module Source #
type Rep Module Source #
Instance details Defined in Distribution.Types.Module type Rep Module = D1 ('MetaData "Module" "Distribution.Types.Module" "hackport-0.7.2.2-Jf8zaDrP5aANzq8F6jTnI-hackport-external-libs-Cabal" 'False) (C1 ('MetaCons "Module" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DefUnitId) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)))

module Distribution.Types.PackageName

data PkgconfigName Source #

A pkg-config library name

This is parsed as any valid argument to the pkg-config utility.

Since: 2.0.0.2

Instances

Instances details

Eq PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods (==) :: PkgconfigName -> PkgconfigName -> Bool # (/=) :: PkgconfigName -> PkgconfigName -> Bool #
Data PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PkgconfigName -> c PkgconfigName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PkgconfigName # toConstr :: PkgconfigName -> Constr # dataTypeOf :: PkgconfigName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PkgconfigName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PkgconfigName) # gmapT :: (forall b. Data b => b -> b) -> PkgconfigName -> PkgconfigName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PkgconfigName -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PkgconfigName -> r # gmapQ :: (forall d. Data d => d -> u) -> PkgconfigName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PkgconfigName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PkgconfigName -> m PkgconfigName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgconfigName -> m PkgconfigName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PkgconfigName -> m PkgconfigName #
Ord PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods compare :: PkgconfigName -> PkgconfigName -> Ordering # (<) :: PkgconfigName -> PkgconfigName -> Bool # (<=) :: PkgconfigName -> PkgconfigName -> Bool # (>) :: PkgconfigName -> PkgconfigName -> Bool # (>=) :: PkgconfigName -> PkgconfigName -> Bool # max :: PkgconfigName -> PkgconfigName -> PkgconfigName # min :: PkgconfigName -> PkgconfigName -> PkgconfigName #
Read PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods readsPrec :: Int -> ReadS PkgconfigName # readList :: ReadS [PkgconfigName] # readPrec :: ReadPrec PkgconfigName # readListPrec :: ReadPrec [PkgconfigName] #
Show PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods showsPrec :: Int -> PkgconfigName -> ShowS # show :: PkgconfigName -> String # showList :: [PkgconfigName] -> ShowS #
IsString PkgconfigName Source #	`mkPkgconfigName` Since: 2.0.0.2
Instance details Defined in Distribution.Types.PkgconfigName Methods fromString :: String -> PkgconfigName #
Generic PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Associated Types type Rep PkgconfigName :: Type -> Type # Methods from :: PkgconfigName -> Rep PkgconfigName x # to :: Rep PkgconfigName x -> PkgconfigName #
Binary PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods put :: PkgconfigName -> Put # get :: Get PkgconfigName # putList :: [PkgconfigName] -> Put #
NFData PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods rnf :: PkgconfigName -> () #
Structured PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods structure :: Proxy PkgconfigName -> Structure Source # structureHash' :: Tagged PkgconfigName MD5
Pretty PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods pretty :: PkgconfigName -> Doc Source # prettyVersioned :: CabalSpecVersion -> PkgconfigName -> Doc Source #
Parsec PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods parsec :: CabalParsing m => m PkgconfigName Source #
type Rep PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName type Rep PkgconfigName = D1 ('MetaData "PkgconfigName" "Distribution.Types.PkgconfigName" "hackport-0.7.2.2-Jf8zaDrP5aANzq8F6jTnI-hackport-external-libs-Cabal" 'True) (C1 ('MetaCons "PkgconfigName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

unPkgconfigName :: PkgconfigName -> String Source #

Convert PkgconfigName to String

Since: 2.0.0.2

mkPkgconfigName :: String -> PkgconfigName Source #

Construct a PkgconfigName from a String

mkPkgconfigName is the inverse to unPkgconfigName

Note: No validations are performed to ensure that the resulting PkgconfigName is valid

Since: 2.0.0.2

module Distribution.Types.Dependency

class Package pkg where Source #

Class of things that have a PackageIdentifier

Types in this class are all notions of a package. This allows us to have different types for the different phases that packages go though, from simple name/id, package description, configured or installed packages.

Not all kinds of packages can be uniquely identified by a PackageIdentifier. In particular, installed packages cannot, there may be many installed instances of the same source package.

Methods

packageId :: pkg -> PackageIdentifier Source #

Instances

Instances details

Package PackageIdentifier Source #
Instance details Defined in Distribution.Package Methods packageId :: PackageIdentifier -> PackageIdentifier Source #
Package InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods packageId :: InstalledPackageInfo -> PackageIdentifier Source #
Package PackageDescription Source #
Instance details Defined in Distribution.Types.PackageDescription Methods packageId :: PackageDescription -> PackageIdentifier Source #
Package GenericPackageDescription Source #
Instance details Defined in Distribution.Types.GenericPackageDescription Methods packageId :: GenericPackageDescription -> PackageIdentifier Source #
Package (AnnotatedId id) Source #
Instance details Defined in Distribution.Types.AnnotatedId Methods packageId :: AnnotatedId id -> PackageIdentifier Source #

packageName :: Package pkg => pkg -> PackageName Source #

packageVersion :: Package pkg => pkg -> Version Source #

class HasMungedPackageId pkg where Source #

Methods

mungedId :: pkg -> MungedPackageId Source #

Instances

Instances details

HasMungedPackageId MungedPackageId Source #
Instance details Defined in Distribution.Package Methods mungedId :: MungedPackageId -> MungedPackageId Source #
HasMungedPackageId InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods mungedId :: InstalledPackageInfo -> MungedPackageId Source #

mungedName' :: HasMungedPackageId pkg => pkg -> MungedPackageName Source #

mungedVersion' :: HasMungedPackageId munged => munged -> Version Source #

class Package pkg => HasUnitId pkg where Source #

Packages that have an installed unit ID

Methods

installedUnitId :: pkg -> UnitId Source #

Instances

Instances details

HasUnitId InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods installedUnitId :: InstalledPackageInfo -> UnitId Source #

class HasUnitId pkg => PackageInstalled pkg where Source #

Class of installed packages.

The primary data type which is an instance of this package is InstalledPackageInfo, but when we are doing install plans in Cabal install we may have other, installed package-like things which contain more metadata. Installed packages have exact dependencies installedDepends.

Methods

installedDepends :: pkg -> [UnitId] Source #

Instances

Instances details

PackageInstalled InstalledPackageInfo Source #
Instance details Defined in Distribution.Types.InstalledPackageInfo Methods installedDepends :: InstalledPackageInfo -> [UnitId] Source #