PackageConfig

Package configuration information: essentially the interface to Cabal, with some utilities

(c) The University of Glasgow, 2004

Documentation

Mostly the compiler deals in terms of UnitIds, which are md5 hashes of a package ID, keys of its dependencies, and Cabal flags. You're expected to pass in the unit id in the -this-unit-id flag. However, for wired-in packages like base & rts, we don't necessarily know what the version is, so these are handled specially; see .

UnitId

packageConfigId :: PackageConfig -> UnitId

expandedPackageConfigId :: PackageConfig -> UnitId

definitePackageConfigId :: PackageConfig -> Maybe DefUnitId

installedPackageConfigId :: PackageConfig -> InstalledUnitId

Get the GHC UnitId right out of a Cabalish PackageConfig

The PackageConfig type: information about a package

type PackageConfig = InstalledPackageInfo ComponentId SourcePackageId PackageName InstalledUnitId UnitId ModuleName Module

data InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod

This is a subset of Cabal's InstalledPackageInfo, with just the bits that GHC is interested in. See Cabal's documentation for a more detailed description of all of the fields.

Constructors

InstalledPackageInfo

Fields

• unitId :: instunitid
• componentId :: compid
• instantiatedWith :: [(modulename, mod)]
• sourcePackageId :: srcpkgid
• packageName :: srcpkgname
• packageVersion :: Version
• sourceLibName :: Maybe srcpkgname
• abiHash :: String
• depends :: [instunitid]
• abiDepends :: [(instunitid, String)]

  Like depends, but each dependency is annotated with the ABI hash we expect the dependency to respect.

• importDirs :: [FilePath]
• hsLibraries :: [String]
• extraLibraries :: [String]
• extraGHCiLibraries :: [String]
• libraryDirs :: [FilePath]
• libraryDynDirs :: [FilePath]
• frameworks :: [String]
• frameworkDirs :: [FilePath]
• ldOptions :: [String]
• ccOptions :: [String]
• includes :: [String]
• includeDirs :: [FilePath]
• haddockInterfaces :: [FilePath]
• haddockHTMLs :: [FilePath]
• exposedModules :: [(modulename, Maybe mod)]
• hiddenModules :: [modulename]
• indefinite :: Bool
• exposed :: Bool
• trusted :: Bool

Instances

(Eq instunitid, Eq compid, Eq modulename, Eq mod, Eq srcpkgid, Eq srcpkgname) => Eq (InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod)

Defined in GHC.PackageDb

Methods

(==) :: InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> Bool

(/=) :: InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> Bool

(Show instunitid, Show compid, Show modulename, Show mod, Show srcpkgid, Show srcpkgname) => Show (InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod)

Defined in GHC.PackageDb

Methods

showsPrec :: Int -> InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> ShowS

show :: InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> String

showList :: [InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod] -> ShowS

RepInstalledPackageInfo a b c d e f g => Binary (InstalledPackageInfo a b c d e f g)

Defined in GHC.PackageDb

Methods

put :: InstalledPackageInfo a b c d e f g -> Put

get :: Get (InstalledPackageInfo a b c d e f g)

putList :: [InstalledPackageInfo a b c d e f g] -> Put

newtype ComponentId

A ComponentId consists of the package name, package version, component ID, the transitive dependencies of the component, and other information to uniquely identify the source code and build configuration of a component.

This used to be known as an InstalledPackageId, but a package can contain multiple components and a ComponentId uniquely identifies a component within a package. When a package only has one component, the ComponentId coincides with the InstalledPackageId

Constructors

ComponentId FastString

Instances

Eq ComponentId

Defined in Module

Methods

(==) :: ComponentId -> ComponentId -> Bool

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

Ord ComponentId

Defined in Module

Methods

compare :: ComponentId -> ComponentId -> Ordering

(<) :: ComponentId -> ComponentId -> Bool

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

(>) :: ComponentId -> ComponentId -> Bool

(>=) :: ComponentId -> ComponentId -> Bool

max :: ComponentId -> ComponentId -> ComponentId

min :: ComponentId -> ComponentId -> ComponentId

BinaryStringRep ComponentId

Defined in Module

Methods

fromStringRep :: ByteString -> ComponentId

toStringRep :: ComponentId -> ByteString

Outputable ComponentId

Defined in Module

Methods

ppr :: ComponentId -> SDoc

pprPrec :: Rational -> ComponentId -> SDoc

Uniquable ComponentId

Defined in Module

Methods

getUnique :: ComponentId -> Unique

Binary ComponentId

Defined in Module

Methods

put_ :: BinHandle -> ComponentId -> IO ()

put :: BinHandle -> ComponentId -> IO (Bin ComponentId)

get :: BinHandle -> IO ComponentId

DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module

Defined in Module

Methods

fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module

toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module

fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId

toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module

newtype SourcePackageId

Constructors

SourcePackageId FastString

Instances

Eq SourcePackageId

Defined in PackageConfig

Methods

(==) :: SourcePackageId -> SourcePackageId -> Bool

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

Ord SourcePackageId

Defined in PackageConfig

Methods

compare :: SourcePackageId -> SourcePackageId -> Ordering

(<) :: SourcePackageId -> SourcePackageId -> Bool

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

(>) :: SourcePackageId -> SourcePackageId -> Bool

(>=) :: SourcePackageId -> SourcePackageId -> Bool

max :: SourcePackageId -> SourcePackageId -> SourcePackageId

min :: SourcePackageId -> SourcePackageId -> SourcePackageId

BinaryStringRep SourcePackageId

Defined in PackageConfig

Methods

fromStringRep :: ByteString -> SourcePackageId

toStringRep :: SourcePackageId -> ByteString

Outputable SourcePackageId

Defined in PackageConfig

Methods

ppr :: SourcePackageId -> SDoc

pprPrec :: Rational -> SourcePackageId -> SDoc

Uniquable SourcePackageId

Defined in PackageConfig

Methods

getUnique :: SourcePackageId -> Unique

newtype PackageName

Constructors

PackageName FastString

Instances

Eq PackageName

Defined in PackageConfig

Methods

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

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

Ord PackageName

Defined in PackageConfig

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

BinaryStringRep PackageName

Defined in PackageConfig

Methods

fromStringRep :: ByteString -> PackageName

toStringRep :: PackageName -> ByteString

Outputable PackageName

Defined in PackageConfig

Methods

ppr :: PackageName -> SDoc

pprPrec :: Rational -> PackageName -> SDoc

Uniquable PackageName

Defined in PackageConfig

Methods

getUnique :: PackageName -> Unique

data Version

A Version represents the version of a software entity.

An instance of Eq is provided, which implements exact equality modulo reordering of the tags in the versionTags field.

An instance of Ord is also provided, which gives lexicographic ordering on the versionBranch fields (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.). This is expected to be sufficient for many uses, but note that you may need to use a more specific ordering for your versioning scheme. For example, some versioning schemes may include pre-releases which have tags "pre1", "pre2", and so on, and these would need to be taken into account when determining ordering. In some cases, date ordering may be more appropriate, so the application would have to look for date tags in the versionTags field and compare those. The bottom line is, don't always assume that compare and other Ord operations are the right thing for every Version.

Similarly, concrete representations of versions may differ. One possible concrete representation is provided (see showVersion and parseVersion), but depending on the application a different concrete representation may be more appropriate.

Constructors

Version

Fields

• versionBranch :: [Int]

  The numeric branch for this version. This reflects the fact that most software versions are tree-structured; there is a main trunk which is tagged with versions at various points (1,2,3...), and the first branch off the trunk after version 3 is 3.1, the second branch off the trunk after version 3 is 3.2, and so on. The tree can be branched arbitrarily, just by adding more digits.

  We represent the branch as a list of Int, so version 3.2.1 becomes [3,2,1]. Lexicographic ordering (i.e. the default instance of Ord for [Int]) gives the natural ordering of branches.

• versionTags :: [String]

  A version can be tagged with an arbitrary list of strings. The interpretation of the list of tags is entirely dependent on the entity that this version applies to.

Instances

IsList Version

Since: base-4.8.0.0

Defined in GHC.Exts

Associated Types

type Item Version

Methods

fromList :: [Item Version] -> Version

fromListN :: Int -> [Item Version] -> Version

toList :: Version -> [Item Version]

Eq Version

Since: base-2.1

Defined in Data.Version

Methods

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

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

Data Version

Since: base-4.7.0.0

Defined in Data.Data

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Version -> c Version

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Version

toConstr :: Version -> Constr

dataTypeOf :: Version -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Version)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Version)

gmapT :: (forall b. Data b => b -> b) -> Version -> Version

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Version -> r

gmapQ :: (forall d. Data d => d -> u) -> Version -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Version -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Version -> m Version

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Version -> m Version

Ord Version

Since: base-2.1

Defined in Data.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

Since: base-2.1

Defined in Data.Version

Methods

readsPrec :: Int -> ReadS Version

readList :: ReadS [Version]

readPrec :: ReadPrec Version

readListPrec :: ReadPrec [Version]

Show Version

Since: base-2.1

Defined in Data.Version

Methods

showsPrec :: Int -> Version -> ShowS

show :: Version -> String

showList :: [Version] -> ShowS

Generic Version

Since: base-4.9.0.0

Defined in Data.Version

Associated Types

type Rep Version :: Type -> Type

Methods

from :: Version -> Rep Version x

to :: Rep Version x -> Version

Binary Version

Since: binary-0.8.0.0

Defined in Data.Binary.Class

Methods

put :: Version -> Put

get :: Get Version

putList :: [Version] -> Put

NFData Version

Since: deepseq-1.3.0.0

Defined in Control.DeepSeq

Methods

rnf :: Version -> ()

type Rep Version

Defined in Data.Version

type Rep Version = D1 ('MetaData "Version" "Data.Version" "base" 'False) (C1 ('MetaCons "Version" 'PrefixI 'True) (S1 ('MetaSel ('Just "versionBranch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int]) :*: S1 ('MetaSel ('Just "versionTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))

type Item Version

Defined in GHC.Exts

type Item Version = Int

defaultPackageConfig :: PackageConfig

sourcePackageIdString :: PackageConfig -> String

packageNameString :: PackageConfig -> String

pprPackageConfig :: PackageConfig -> SDoc