Safe Haskell | None |
---|---|
Language | Haskell98 |
PackageConfig
Description
Package configuration information: essentially the interface to Cabal, with some utilities
(c) The University of Glasgow, 2004
- mkPackageId :: PackageIdentifier -> PackageId
- packageConfigId :: PackageConfig -> PackageId
- type PackageConfig = InstalledPackageInfo_ ModuleName
- data InstalledPackageInfo_ m = InstalledPackageInfo {
- installedPackageId :: InstalledPackageId
- sourcePackageId :: PackageId
- license :: License
- copyright :: String
- maintainer :: String
- author :: String
- stability :: String
- homepage :: String
- pkgUrl :: String
- synopsis :: String
- description :: String
- category :: String
- exposed :: Bool
- exposedModules :: [m]
- hiddenModules :: [m]
- trusted :: Bool
- importDirs :: [FilePath]
- libraryDirs :: [FilePath]
- hsLibraries :: [String]
- extraLibraries :: [String]
- extraGHCiLibraries :: [String]
- includeDirs :: [FilePath]
- includes :: [String]
- depends :: [InstalledPackageId]
- hugsOptions :: [String]
- ccOptions :: [String]
- ldOptions :: [String]
- frameworkDirs :: [FilePath]
- frameworks :: [String]
- haddockInterfaces :: [FilePath]
- haddockHTMLs :: [FilePath]
- display :: Text a => a -> String
- data Version = Version {
- versionBranch :: [Int]
- versionTags :: [String]
- data PackageIdentifier = PackageIdentifier {}
- defaultPackageConfig :: PackageConfig
- packageConfigToInstalledPackageInfo :: PackageConfig -> InstalledPackageInfo
- installedPackageInfoToPackageConfig :: InstalledPackageInfo_ String -> PackageConfig
Documentation
Mostly the compiler deals in terms of PackageName
s, which don't
have the version suffix. This is so that we don't need to know the
version for the -package-name
flag, or know the versions of
wired-in packages like base
& rts
. Versions are confined to the
package sub-system.
This means that in theory you could have multiple base packages installed
(for example), and switch between them using -package
/-hide-package
.
PackageId
mkPackageId :: PackageIdentifier -> PackageIdSource
Turn a Cabal PackageIdentifier
into a GHC PackageId
packageConfigId :: PackageConfig -> PackageIdSource
Get the GHC PackageId
right out of a Cabalish PackageConfig
The PackageConfig type: information about a package
data InstalledPackageInfo_ mSource
Constructors
InstalledPackageInfo | |
Fields
|
Instances
Read m => Read (InstalledPackageInfo_ m) | |
Show m => Show (InstalledPackageInfo_ m) | |
Package (InstalledPackageInfo_ str) | |
Binary m => Binary (InstalledPackageInfo_ m) |
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
|
The name and version of a package.
Constructors
PackageIdentifier | |
Fields
|
packageConfigToInstalledPackageInfo :: PackageConfig -> InstalledPackageInfoSource
Turn a PackageConfig
, which contains GHC ModuleName
s into a Cabal specific
InstalledPackageInfo
which contains Cabal ModuleName
s
installedPackageInfoToPackageConfig :: InstalledPackageInfo_ String -> PackageConfigSource
Turn an InstalledPackageInfo
, which contains Cabal ModuleName
s
into a GHC specific PackageConfig
which contains GHC ModuleName
s