ghc-8.2.2: The GHC API

Safe Haskell | None
Language | Haskell2010

PackageConfig

Contents

- UnitId
- The PackageConfig type: information about a package

Description

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

(c) The University of Glasgow, 2004

Synopsis

- packageConfigId :: PackageConfig -> UnitId
- expandedPackageConfigId :: PackageConfig -> UnitId
- definitePackageConfigId :: PackageConfig -> Maybe DefUnitId
- installedPackageConfigId :: PackageConfig -> InstalledUnitId
- type PackageConfig = InstalledPackageInfo ComponentId SourcePackageId PackageName InstalledUnitId UnitId ModuleName Module
- data InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod :: * -> * -> * -> * -> * -> * -> * -> * = InstalledPackageInfo {
  - unitId :: instunitid
  - componentId :: compid
  - instantiatedWith :: [(modulename, mod)]
  - sourcePackageId :: srcpkgid
  - packageName :: srcpkgname
  - packageVersion :: Version
  - sourceLibName :: Maybe srcpkgname
  - abiHash :: String
  - depends :: [instunitid]
  - abiDepends :: [(instunitid, String)]
  - 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
  }
- newtype ComponentId = ComponentId FastString
- newtype SourcePackageId = SourcePackageId FastString
- newtype PackageName = PackageName FastString
- data Version :: * = Version {
  - versionBranch :: [Int]
  - versionTags :: [String]
  }
- defaultPackageConfig :: PackageConfig
- sourcePackageIdString :: PackageConfig -> String
- packageNameString :: PackageConfig -> String
- pprPackageConfig :: PackageConfig -> SDoc

# Documentation

Mostly the compiler deals in terms of `UnitId`s, 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 :: * -> * -> * -> * -> * -> * -> * -> * Source #

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 srcpkgname, Eq srcpkgid, Eq mod, Eq modulename, Eq compid, Eq instunitid) => Eq (InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod) |
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 srcpkgname, Show srcpkgid, Show mod, Show modulename, Show compid, Show instunitid) => Show (InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod) |
Methods showsPrec :: Int -> InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> ShowS Source # show :: InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod -> String Source # showList :: [InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod] -> ShowS Source #
RepInstalledPackageInfo a b c d e f g => Binary (InstalledPackageInfo a b c d e f g) |
Methods put :: InstalledPackageInfo a b c d e f g -> Put Source # get :: Get (InstalledPackageInfo a b c d e f g) Source # putList :: [InstalledPackageInfo a b c d e f g] -> Put Source #

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 # |
Methods (==) :: ComponentId -> ComponentId -> Bool # (/=) :: ComponentId -> ComponentId -> Bool #
Ord ComponentId # |
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 # |
Methods fromStringRep :: ByteString -> ComponentId Source # toStringRep :: ComponentId -> ByteString Source #
Outputable ComponentId # |
Methods ppr :: ComponentId -> SDoc # pprPrec :: Rational -> ComponentId -> SDoc #
Uniquable ComponentId # |
Methods getUnique :: ComponentId -> Unique #
Binary ComponentId # |
Methods put_ :: BinHandle -> ComponentId -> IO () # put :: BinHandle -> ComponentId -> IO (Bin * ComponentId) # get :: BinHandle -> IO ComponentId #
DbUnitIdModuleRep InstalledUnitId ComponentId UnitId ModuleName Module # |
Methods fromDbModule :: DbModule InstalledUnitId ComponentId UnitId ModuleName Module -> Module Source # toDbModule :: Module -> DbModule InstalledUnitId ComponentId UnitId ModuleName Module Source # fromDbUnitId :: DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module -> UnitId Source # toDbUnitId :: UnitId -> DbUnitId InstalledUnitId ComponentId UnitId ModuleName Module Source #

newtype SourcePackageId #

Constructors

SourcePackageId FastString |

Instances

Eq SourcePackageId # |
Methods (==) :: SourcePackageId -> SourcePackageId -> Bool # (/=) :: SourcePackageId -> SourcePackageId -> Bool #
Ord SourcePackageId # |

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 # |
Methods fromStringRep :: ByteString -> SourcePackageId Source # toStringRep :: SourcePackageId -> ByteString Source #
Outputable SourcePackageId # |
Methods ppr :: SourcePackageId -> SDoc # pprPrec :: Rational -> SourcePackageId -> SDoc #
Uniquable SourcePackageId # |
Methods getUnique :: SourcePackageId -> Unique #

newtype PackageName #

Constructors

PackageName FastString |

Instances

Eq PackageName # |
Methods (==) :: PackageName -> PackageName -> Bool # (/=) :: PackageName -> PackageName -> Bool #
Ord PackageName # |
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 # |
Methods fromStringRep :: ByteString -> PackageName Source # toStringRep :: PackageName -> ByteString Source #
Outputable PackageName # |
Methods ppr :: PackageName -> SDoc # pprPrec :: Rational -> PackageName -> SDoc #
Uniquable PackageName # |
Methods getUnique :: PackageName -> Unique #

data Version :: * Source #

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: 4.8.0.0
Associated Types type Item Version :: * Source # Methods fromList :: [Item Version] -> Version Source # fromListN :: Int -> [Item Version] -> Version Source # toList :: Version -> [Item Version] Source #
Eq Version | Since: 2.1
Methods (==) :: Version -> Version -> Bool # (/=) :: Version -> Version -> Bool #
Data Version | Since: 4.7.0.0

Methods

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

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

toConstr :: Version -> Constr Source #

dataTypeOf :: Version -> DataType Source #

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

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

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

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

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

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

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

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

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

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

Ord Version | Since: 2.1
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 |
Methods readsPrec :: Int -> ReadS Version Source # readList :: ReadS [Version] Source # readPrec :: ReadPrec Version Source # readListPrec :: ReadPrec [Version] Source #
Show Version |
Methods showsPrec :: Int -> Version -> ShowS Source # show :: Version -> String Source # showList :: [Version] -> ShowS Source #
Generic Version |
Associated Types type Rep Version :: * -> * Source # Methods from :: Version -> Rep Version x Source # to :: Rep Version x -> Version Source #
NFData Version | Since: 1.3.0.0
Methods rnf :: Version -> () Source #
Binary Version | Since: 0.8.0.0
Methods put :: Version -> Put Source # get :: Get Version Source # putList :: [Version] -> Put Source #
type Rep Version |
type Rep Version = D1 * (MetaData "Version" "Data.Version" "base" False) (C1 * (MetaCons "Version" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "versionBranch") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Int])) (S1 * (MetaSel (Just Symbol "versionTags") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [String]))))
type Item Version |
type Item Version = Int

defaultPackageConfig :: PackageConfig #

sourcePackageIdString :: PackageConfig -> String #

packageNameString :: PackageConfig -> String #

pprPackageConfig :: PackageConfig -> SDoc #