| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
PackageConfig
Description
Package configuration information: essentially the interface to Cabal, with some utilities
(c) The University of Glasgow, 2004
- 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 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
installedPackageConfigId :: PackageConfig -> InstalledUnitId Source #
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 Source #
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
| |
Instances
| (Eq srcpkgname, Eq srcpkgid, Eq mod, Eq modulename, Eq compid, Eq instunitid) => Eq (InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod) | |
| (Show srcpkgname, Show srcpkgid, Show mod, Show modulename, Show compid, Show instunitid) => Show (InstalledPackageInfo compid srcpkgid srcpkgname instunitid unitid modulename mod) | |
| RepInstalledPackageInfo a b c d e f g => Binary (InstalledPackageInfo a b c d e f g) | |
newtype ComponentId Source #
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 |
newtype SourcePackageId Source #
Constructors
| SourcePackageId FastString |
newtype PackageName Source #
Constructors
| PackageName FastString |
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
| |
pprPackageConfig :: PackageConfig -> SDoc Source #