Distribution.Package

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

Documentation

data AbiHash

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

Eq AbiHash

Defined in Distribution.Types.AbiHash

Methods

(==) :: AbiHash -> AbiHash -> Bool

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

Read AbiHash

Defined in Distribution.Types.AbiHash

Methods

readsPrec :: Int -> ReadS AbiHash

readList :: ReadS [AbiHash]

readPrec :: ReadPrec AbiHash

readListPrec :: ReadPrec [AbiHash]

Show AbiHash

Defined in Distribution.Types.AbiHash

Methods

showsPrec :: Int -> AbiHash -> ShowS

show :: AbiHash -> String

showList :: [AbiHash] -> ShowS

IsString AbiHash

mkAbiHash

Since: 2.0.0.2

Defined in Distribution.Types.AbiHash

Methods

fromString :: String -> AbiHash

Generic AbiHash

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

Defined in Distribution.Types.AbiHash

Methods

put :: AbiHash -> Put

get :: Get AbiHash

putList :: [AbiHash] -> Put

NFData AbiHash

Defined in Distribution.Types.AbiHash

Methods

rnf :: AbiHash -> ()

Structured AbiHash

Defined in Distribution.Types.AbiHash

Methods

structure :: Proxy AbiHash -> Structure

structureHash' :: Tagged AbiHash MD5

Pretty AbiHash

Defined in Distribution.Types.AbiHash

Methods

pretty :: AbiHash -> Doc

prettyVersioned :: CabalSpecVersion -> AbiHash -> Doc

Parsec AbiHash

Defined in Distribution.Types.AbiHash

Methods

parsec :: CabalParsing m => m AbiHash

type Rep AbiHash

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

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

Convert AbiHash to String

Since: 2.0.0.2

module Distribution.Types.ComponentId

module Distribution.Types.PackageId

module Distribution.Types.UnitId

data Module

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

Eq Module

Defined in Distribution.Types.Module

Methods

(==) :: Module -> Module -> Bool

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

Data Module

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

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

Defined in Distribution.Types.Module

Methods

readsPrec :: Int -> ReadS Module

readList :: ReadS [Module]

readPrec :: ReadPrec Module

readListPrec :: ReadPrec [Module]

Show Module

Defined in Distribution.Types.Module

Methods

showsPrec :: Int -> Module -> ShowS

show :: Module -> String

showList :: [Module] -> ShowS

Generic Module

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

Defined in Distribution.Types.Module

Methods

put :: Module -> Put

get :: Get Module

putList :: [Module] -> Put

NFData Module

Defined in Distribution.Types.Module

Methods

rnf :: Module -> ()

Structured Module

Defined in Distribution.Types.Module

Methods

structure :: Proxy Module -> Structure

structureHash' :: Tagged Module MD5

Pretty Module

Defined in Distribution.Types.Module

Methods

pretty :: Module -> Doc

prettyVersioned :: CabalSpecVersion -> Module -> Doc

Parsec Module

Defined in Distribution.Types.Module

Methods

parsec :: CabalParsing m => m Module

type Rep Module

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

A pkg-config library name

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

Since: 2.0.0.2

Instances

Eq PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

(==) :: PkgconfigName -> PkgconfigName -> Bool

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

Data PkgconfigName

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

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

Defined in Distribution.Types.PkgconfigName

Methods

readsPrec :: Int -> ReadS PkgconfigName

readList :: ReadS [PkgconfigName]

readPrec :: ReadPrec PkgconfigName

readListPrec :: ReadPrec [PkgconfigName]

Show PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

showsPrec :: Int -> PkgconfigName -> ShowS

show :: PkgconfigName -> String

showList :: [PkgconfigName] -> ShowS

IsString PkgconfigName

mkPkgconfigName

Since: 2.0.0.2

Defined in Distribution.Types.PkgconfigName

Methods

fromString :: String -> PkgconfigName

Generic PkgconfigName

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

Defined in Distribution.Types.PkgconfigName

Methods

put :: PkgconfigName -> Put

get :: Get PkgconfigName

putList :: [PkgconfigName] -> Put

NFData PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

rnf :: PkgconfigName -> ()

Structured PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

structure :: Proxy PkgconfigName -> Structure

structureHash' :: Tagged PkgconfigName MD5

Pretty PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

pretty :: PkgconfigName -> Doc

prettyVersioned :: CabalSpecVersion -> PkgconfigName -> Doc

Parsec PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

parsec :: CabalParsing m => m PkgconfigName

type Rep PkgconfigName

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

Convert PkgconfigName to String

Since: 2.0.0.2

mkPkgconfigName :: String -> PkgconfigName

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

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

Instances

Package PackageIdentifier

Defined in Distribution.Package

Methods

packageId :: PackageIdentifier -> PackageIdentifier

Package InstalledPackageInfo

Defined in Distribution.Types.InstalledPackageInfo

Methods

packageId :: InstalledPackageInfo -> PackageIdentifier

Package PackageDescription

Defined in Distribution.Types.PackageDescription

Methods

packageId :: PackageDescription -> PackageIdentifier

Package GenericPackageDescription

Defined in Distribution.Types.GenericPackageDescription

Methods

packageId :: GenericPackageDescription -> PackageIdentifier

Package (AnnotatedId id)

Defined in Distribution.Types.AnnotatedId

Methods

packageId :: AnnotatedId id -> PackageIdentifier

packageName :: Package pkg => pkg -> PackageName

packageVersion :: Package pkg => pkg -> Version

class HasMungedPackageId pkg where

Methods

mungedId :: pkg -> MungedPackageId

Instances

HasMungedPackageId MungedPackageId

Defined in Distribution.Package

Methods

mungedId :: MungedPackageId -> MungedPackageId

HasMungedPackageId InstalledPackageInfo

Defined in Distribution.Types.InstalledPackageInfo

Methods

mungedId :: InstalledPackageInfo -> MungedPackageId

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

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

class Package pkg => HasUnitId pkg where

Packages that have an installed unit ID

Methods

installedUnitId :: pkg -> UnitId

Instances

HasUnitId InstalledPackageInfo

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedUnitId :: InstalledPackageInfo -> UnitId

class HasUnitId pkg => PackageInstalled pkg where

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]

Instances

PackageInstalled InstalledPackageInfo

Defined in Distribution.Types.InstalledPackageInfo

Methods

installedDepends :: InstalledPackageInfo -> [UnitId]