| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
PackageConfig
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 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 instunitid, Eq compid, Eq modulename, Eq mod, Eq srcpkgid, Eq srcpkgname) => 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 instunitid, Show compid, Show modulename, Show mod, Show srcpkgid, Show srcpkgname) => 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 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 |
Instances
newtype SourcePackageId Source #
Constructors
| SourcePackageId FastString |
Instances
| Eq SourcePackageId Source # | |
Methods (==) :: SourcePackageId -> SourcePackageId -> Bool # (/=) :: SourcePackageId -> SourcePackageId -> Bool # | |
| Ord SourcePackageId Source # | |
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 Source # | |
Methods | |
| Outputable SourcePackageId Source # | |
| Uniquable SourcePackageId Source # | |
Methods getUnique :: SourcePackageId -> Unique Source # | |
newtype PackageName Source #
Constructors
| PackageName FastString |
Instances
| Eq PackageName Source # | |
| Ord PackageName Source # | |
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 Source # | |
Methods fromStringRep :: ByteString -> PackageName Source # toStringRep :: PackageName -> ByteString Source # | |
| Outputable PackageName Source # | |
| Uniquable PackageName Source # | |
Methods getUnique :: PackageName -> Unique 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
| |
Instances
| IsList Version | Since: 4.8.0.0 |
| Eq Version | Since: 2.1 |
| 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 |
| Read Version | |
| Show Version | |
| Generic Version | |
| NFData Version | Since: 1.3.0.0 |
| Binary Version | Since: 0.8.0.0 |
| type Rep 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 | |
pprPackageConfig :: PackageConfig -> SDoc Source #