ModuleCabal-syntax-3.12.1.0Haskell2010

Distribution.InstalledPackageInfo

This is the information about an installed package that is communicated to the ghc-pkg program in order to register a package. ghc-pkg now consumes this package format (as of version 6.4). This is specific to GHC at the moment.

The .cabal file format is for describing a package that is not yet installed. It has a lot of flexibility, like conditionals and dependency ranges. As such, that format is not at all suitable for describing a package that has already been built and installed. By the time we get to that stage, we have resolved all conditionals and resolved dependency version constraints to exact versions of dependent packages. So, this module defines the InstalledPackageInfo data structure that contains all the info we keep about an installed package. There is a parser and pretty printer. The textual format is rather simpler than the .cabal format: there are no sections, for example.

3 types
10 values

PackageCabal-syntax-3.12.1.0
Exports13
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInstalledPackageInfo.hs

datadata InstalledPackageInfo

Constructors

InstalledPackageInfo
- sourcePackageId :: PackageId
- sourceLibName :: LibraryName
- installedComponentId_ :: ComponentId
- libVisibility :: LibraryVisibility
- installedUnitId :: UnitId
- instantiatedWith :: [(ModuleName, OpenModule)]
- compatPackageKey :: String
- license :: Either License License
- copyright :: !ShortText
- maintainer :: !ShortText
- author :: !ShortText
- stability :: !ShortText
- homepage :: !ShortText
- pkgUrl :: !ShortText
- synopsis :: !ShortText
- description :: !ShortText
- category :: !ShortText
- abiHash :: AbiHash
- indefinite :: Bool
- exposed :: Bool
- exposedModules :: [ExposedModule]
- hiddenModules :: [ModuleName]
- trusted :: Bool
- importDirs :: [FilePath]
- libraryDirs :: [FilePath]
- libraryDirsStatic :: [FilePath]
- libraryDynDirs :: [FilePath]
  overrides libraryDirs
- dataDir :: FilePath
- hsLibraries :: [String]
- extraLibraries :: [String]
- extraLibrariesStatic :: [String]
- extraGHCiLibraries :: [String]
- includeDirs :: [FilePath]
- includes :: [String]
- depends :: [UnitId]
- abiDepends :: [AbiDependency]
- ccOptions :: [String]
- cxxOptions :: [String]
- ldOptions :: [String]
- frameworkDirs :: [FilePath]
- frameworks :: [String]
- haddockInterfaces :: [FilePath]
- haddockHTMLs :: [FilePath]
- pkgRoot :: Maybe FilePath

Instances14Eq, Read, Show, Generic, NFData, Binary, …

Eq InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Read InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Show InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Generic InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
NFData InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Binary InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Structured InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
IsNode InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
HasMungedPackageId InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
HasUnitId InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
Package InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
PackageInstalled InstalledPackageInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
type Rep InstalledPackageInfo = D1 ('MetaData "InstalledPackageInfo" "Distribution.Types.InstalledPackageInfo" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "InstalledPackageInfo" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "sourcePackageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageId) :*: S1 ('MetaSel ('Just "sourceLibName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryName)) :*: (S1 ('MetaSel ('Just "installedComponentId_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentId) :*: (S1 ('MetaSel ('Just "libVisibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryVisibility) :*: S1 ('MetaSel ('Just "installedUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId)))) :*: ((S1 ('MetaSel ('Just "instantiatedWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(ModuleName, OpenModule)]) :*: (S1 ('MetaSel ('Just "compatPackageKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "license") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either License License)))) :*: (S1 ('MetaSel ('Just "copyright") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText) :*: (S1 ('MetaSel ('Just "maintainer") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText))))) :*: (((S1 ('MetaSel ('Just "stability") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText) :*: S1 ('MetaSel ('Just "homepage") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText)) :*: (S1 ('MetaSel ('Just "pkgUrl") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText) :*: (S1 ('MetaSel ('Just "synopsis") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText)))) :*: ((S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ShortText) :*: (S1 ('MetaSel ('Just "abiHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AbiHash) :*: S1 ('MetaSel ('Just "indefinite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "exposed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "exposedModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ExposedModule]) :*: S1 ('MetaSel ('Just "hiddenModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName])))))) :*: ((((S1 ('MetaSel ('Just "trusted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "importDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])) :*: (S1 ('MetaSel ('Just "libraryDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "libraryDirsStatic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: S1 ('MetaSel ('Just "libraryDynDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])))) :*: ((S1 ('MetaSel ('Just "dataDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "hsLibraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Just "extraLibraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))) :*: (S1 ('MetaSel ('Just "extraLibrariesStatic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: (S1 ('MetaSel ('Just "extraGHCiLibraries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Just "includeDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]))))) :*: (((S1 ('MetaSel ('Just "includes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Just "depends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId])) :*: (S1 ('MetaSel ('Just "abiDepends") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [AbiDependency]) :*: (S1 ('MetaSel ('Just "ccOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: S1 ('MetaSel ('Just "cxxOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))) :*: ((S1 ('MetaSel ('Just "ldOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :*: (S1 ('MetaSel ('Just "frameworkDirs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: S1 ('MetaSel ('Just "frameworks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]))) :*: (S1 ('MetaSel ('Just "haddockInterfaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "haddockHTMLs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: S1 ('MetaSel ('Just "pkgRoot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath)))))))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo
type Key InstalledPackageInfo = UnitIdDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo

valueinstalledComponentId :: InstalledPackageInfo -> ComponentId

valueinstalledOpenUnitId :: InstalledPackageInfo -> OpenUnitId

Get the indefinite unit identity representing this package. This IS NOT guaranteed to give you a substitution; for instantiated packages you will get DefiniteUnitId (installedUnitId ipi). For indefinite libraries, however, you will correctly get an OpenUnitId with the appropriate OpenModuleSubst.

valuesourceComponentName :: InstalledPackageInfo -> ComponentName

valuerequiredSignatures :: InstalledPackageInfo -> Set ModuleName

Returns the set of module names which need to be filled for an indefinite package, or the empty set if the package is definite.

datadata ExposedModule

Constructors

ExposedModule
- exposedName :: ModuleName
- exposedReexport :: Maybe OpenModule

Instances11Eq, Read, Show, Generic, NFData, Binary, …

Eq ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Read ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Show ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Generic ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
NFData ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Binary ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Parsec ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Pretty ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Structured ExposedModuleDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule
Newtype [ExposedModule] ExposedModulesDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.InstalledPackageInfo.FieldGrammar
type Rep ExposedModule = D1 ('MetaData "ExposedModule" "Distribution.Types.ExposedModule" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "ExposedModule" 'PrefixI 'True) (S1 ('MetaSel ('Just "exposedName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName) :*: S1 ('MetaSel ('Just "exposedReexport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe OpenModule))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.ExposedModule

datadata AbiDependency

An ABI dependency is a dependency on a library which also records the ABI hash (abiHash) of the library it depends on.

The primary utility of this is to enable an extra sanity when GHC loads libraries: it can check if the dependency has a matching ABI and if not, refuse to load this library. This information is critical if we are shadowing libraries; differences in the ABI hash let us know what packages get shadowed by the new version of a package.

Constructors

AbiDependency
- depUnitId :: UnitId
- depAbiHash :: AbiHash

Instances10Eq, Read, Show, Generic, NFData, Binary, …

Eq AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Read AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Show AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Generic AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
NFData AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Binary AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Parsec AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Pretty AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
Structured AbiDependencyDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency
type Rep AbiDependency = D1 ('MetaData "AbiDependency" "Distribution.Types.AbiDependency" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "AbiDependency" 'PrefixI 'True) (S1 ('MetaSel ('Just "depUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId) :*: S1 ('MetaSel ('Just "depAbiHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AbiHash)))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.AbiDependency

valueemptyInstalledPackageInfo :: InstalledPackageInfo

valueparseInstalledPackageInfo

:: ByteString
-> Either (NonEmpty String) ([String], InstalledPackageInfo)

Return either errors, or IPI with list of warnings

valueshowInstalledPackageInfo :: InstalledPackageInfo -> String

Pretty print InstalledPackageInfo.

pkgRoot isn't printed, as ghc-pkg prints it manually (as GHC-8.4).

valueshowFullInstalledPackageInfo :: InstalledPackageInfo -> String

The variant of showInstalledPackageInfo which outputs pkgroot field too.

valueshowInstalledPackageInfoField

:: String
-> Maybe (InstalledPackageInfo -> String)

Example2 expressions

>>> let ipi = emptyInstalledPackageInfo { maintainer = fromString "Tester" }>>> fmap ($ ipi) $ showInstalledPackageInfoField "maintainer"Just "maintainer: Tester"

valueshowSimpleInstalledPackageInfoField

:: String
-> Maybe (InstalledPackageInfo -> String)