ModuleCabal-3.12.1.0Haskell2010

Distribution.Simple.LocalBuildInfo

Once a package has been configured we have resolved conditionals and dependencies, configured the compiler and other needed external programs. The LocalBuildInfo is used to hold all this information. It holds the install dirs, the compiler, the exact package dependencies, the configured programs, the package database to use and a bunch of miscellaneous configure flags. It gets saved and reloaded from a file (dist/setup-config). It gets passed in to very many subsequent build actions.

11 types
83 values

PackageCabal-3.12.1.0
Exports99
LanguageHaskell2010
LicenceBSD-3-Clause
SourceLocalBuildInfo.hs

datadata LocalBuildInfo

Data cached after configuration step. See also ConfigFlags.

Constructors

NewLocalBuildInfo
- localBuildDescr :: LocalBuildDescr
  Information about a package determined by Cabal after the configuration step.
- localBuildConfig :: LocalBuildConfig
  Information about a package configuration that can be modified by the user at configuration time.

Instances6Read, Show, Generic, Binary, Structured, Rep

Read LocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.LocalBuildInfo
Show LocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.LocalBuildInfo
Generic LocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.LocalBuildInfo
Binary LocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.LocalBuildInfo
Structured LocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.LocalBuildInfo
type Rep LocalBuildInfo = D1 ('MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-3.12.1.0-fc60" 'False) (C1 ('MetaCons "NewLocalBuildInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "localBuildDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildDescr) :*: S1 ('MetaSel ('Just "localBuildConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildConfig)))Defined in Cabal-3.12.1.0 · Distribution.Types.LocalBuildInfo

pattern

pattern LocalBuildInfo :: ConfigFlags -> FlagAssignment -> ComponentRequestedSpec -> [String] -> InstallDirTemplates -> Compiler -> Platform -> Maybe FilePath -> Graph ComponentLocalBuildInfo -> Map ComponentName [ComponentLocalBuildInfo] -> Map (PackageName, ComponentName) ComponentId -> InstalledPackageIndex -> PackageDescription -> ProgramDb -> PackageDBStack -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> ProfDetailLevel -> ProfDetailLevel -> OptimisationLevel -> DebugInfoLevel -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> [UnitId] -> Bool -> LocalBuildInfo

This pattern synonym is for backwards compatibility, to adapt to LocalBuildInfo being split into LocalBuildDescr and LocalBuildConfig.

valuecomponentGraph :: LocalBuildInfo -> Graph ComponentLocalBuildInfo

valuelocalPkgDescr :: LocalBuildInfo -> PackageDescription

valueinstalledPkgs :: LocalBuildInfo -> InstalledPackageIndex

valuecompiler :: LocalBuildInfo -> Compiler

valuehostPlatform :: LocalBuildInfo -> Platform

valueinstallDirTemplates :: LocalBuildInfo -> InstallDirTemplates

valuecomponentEnabledSpec :: LocalBuildInfo -> ComponentRequestedSpec

valuecomponentNameMap

:: LocalBuildInfo
-> Map ComponentName [ComponentLocalBuildInfo]

valueconfigFlags :: LocalBuildInfo -> ConfigFlags

valueexeCoverage :: LocalBuildInfo -> Bool

valueextraConfigArgs :: LocalBuildInfo -> [String]

valueextraCoverageFor :: LocalBuildInfo -> [UnitId]

valueflagAssignment :: LocalBuildInfo -> FlagAssignment

valuelibCoverage :: LocalBuildInfo -> Bool

valuepkgDescrFile :: LocalBuildInfo -> Maybe FilePath

valuepromisedPkgs

:: LocalBuildInfo
-> Map (PackageName, ComponentName) ComponentId

valuerelocatable :: LocalBuildInfo -> Bool

valuesplitObjs :: LocalBuildInfo -> Bool

valuesplitSections :: LocalBuildInfo -> Bool

valuestripExes :: LocalBuildInfo -> Bool

valuestripLibs :: LocalBuildInfo -> Bool

valuewithDebugInfo :: LocalBuildInfo -> DebugInfoLevel

valuewithDynExe :: LocalBuildInfo -> Bool

valuewithFullyStaticExe :: LocalBuildInfo -> Bool

valuewithGHCiLib :: LocalBuildInfo -> Bool

valuewithOptimization :: LocalBuildInfo -> OptimisationLevel

valuewithPackageDB :: LocalBuildInfo -> PackageDBStack

valuewithProfExe :: LocalBuildInfo -> Bool

valuewithProfExeDetail :: LocalBuildInfo -> ProfDetailLevel

valuewithProfLib :: LocalBuildInfo -> Bool

valuewithProfLibDetail :: LocalBuildInfo -> ProfDetailLevel

valuewithPrograms :: LocalBuildInfo -> ProgramDb

valuewithSharedLib :: LocalBuildInfo -> Bool

valuewithStaticLib :: LocalBuildInfo -> Bool

valuewithVanillaLib :: LocalBuildInfo -> Bool

valuelocalComponentId :: LocalBuildInfo -> ComponentId

Extract the ComponentId from the public library component of a LocalBuildInfo if it exists, or make a fake component ID based on the package ID.

valuelocalUnitId :: LocalBuildInfo -> UnitId

Extract the UnitId from the library component of a LocalBuildInfo if it exists, or make a fake unit ID based on the package ID.

valuelocalCompatPackageKey :: LocalBuildInfo -> String

Extract the compatibility package key from the public library component of a LocalBuildInfo if it exists, or make a fake package key based on the package ID.

Convenience accessors

4 declarations

valuebuildDir :: LocalBuildInfo -> FilePath

valuecabalFilePath :: LocalBuildInfo -> Maybe FilePath

valueprogPrefix :: LocalBuildInfo -> PathTemplate

valueprogSuffix :: LocalBuildInfo -> PathTemplate

Buildable package components

30 declarations

datadata Component

Constructors

Instances9Eq, Read, Show, Generic, Semigroup, Binary, …

Eq ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Read ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Show ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Generic ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Semigroup ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Binary ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
Structured ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
HasBuildInfo ComponentDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component
type Rep Component = D1 ('MetaData "Component" "Distribution.Types.Component" "Cabal-syntax-3.12.1.0-3adc" 'False) ((C1 ('MetaCons "CLib" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Library)) :+: C1 ('MetaCons "CFLib" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForeignLib))) :+: (C1 ('MetaCons "CExe" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Executable)) :+: (C1 ('MetaCons "CTest" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TestSuite)) :+: C1 ('MetaCons "CBench" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Benchmark)))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.Component

datadata ComponentName

Constructors

CLibName LibraryName
CNotLibName NotLibComponentName

Instances10Eq, Ord, Read, Show, Generic, Binary, …

Eq ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Ord ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Read ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Show ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Generic ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Binary ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Parsec ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Pretty ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
Structured ComponentNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName
type Rep ComponentName = D1 ('MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "CLibName" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryName)) :+: C1 ('MetaCons "CNotLibName" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NotLibComponentName)))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.ComponentName

patternpattern CFLibName :: UnqualComponentName -> ComponentName

patternpattern CExeName :: UnqualComponentName -> ComponentName

patternpattern CTestName :: UnqualComponentName -> ComponentName

patternpattern CBenchName :: UnqualComponentName -> ComponentName

datadata LibraryName

Constructors

Instances10Eq, Data, Ord, Read, Show, Generic, …

Eq LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Data LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Ord LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Read LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Show LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Generic LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
NFData LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Binary LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
Structured LibraryNameDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName
type Rep LibraryName = D1 ('MetaData "LibraryName" "Distribution.Types.LibraryName" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "LMainLibName" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LSubLibName" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnqualComponentName)))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.LibraryName

valuedefaultLibName :: LibraryName

valueshowComponentName :: ComponentName -> String

valuecomponentNameString :: ComponentName -> Maybe UnqualComponentName

This gets the underlying unqualified component name. In fact, it is guaranteed to uniquely identify a component, returning Nothing if the ComponentName was for the public library.

datadata ComponentLocalBuildInfo

The first five fields are common across all algebraic variants.

Constructors

LibComponentLocalBuildInfo
- componentLocalName :: ComponentName
  It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo.
- componentComponentId :: ComponentId
  The computed ComponentId of this component.
- componentUnitId :: UnitId
  The computed UnitId which uniquely identifies this component. Might be hashed.
- componentIsIndefinite_ :: Bool
  Is this an indefinite component (i.e. has unfilled holes)?
- componentInstantiatedWith :: [(ModuleName, OpenModule)]
  How the component was instantiated
- componentPackageDeps :: [(UnitId, MungedPackageId)]
  Resolved internal and external package dependencies for this component. The BuildInfo specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler.
- componentIncludes :: [(OpenUnitId, ModuleRenaming)]
  The set of packages that are brought into scope during compilation, including a ModuleRenaming which may used to hide or rename modules. This is what gets translated into -package-id arguments. This is a modernized version of componentPackageDeps, which is kept around for BC purposes.
- componentExeDeps :: [UnitId]
- componentInternalDeps :: [UnitId]
  The internal dependencies which induce a graph on the ComponentLocalBuildInfo of this package. This does NOT coincide with componentPackageDeps because it ALSO records 'build-tool' dependencies on executables. Maybe one day cabal-install will also handle these correctly too!
- componentCompatPackageKey :: String
  Compatibility "package key" that we pass to older versions of GHC.
- componentCompatPackageName :: MungedPackageName
  Compatibility "package name" that we register this component as.
- componentExposedModules :: [ExposedModule]
  A list of exposed modules (either defined in this component, or reexported from another component.)
- componentIsPublic :: Bool
  Convenience field, specifying whether or not this is the "public library" that has the same name as the package.
FLibComponentLocalBuildInfo
- componentLocalName :: ComponentName
  It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo.
- componentComponentId :: ComponentId
  The computed ComponentId of this component.
- componentUnitId :: UnitId
  The computed UnitId which uniquely identifies this component. Might be hashed.
- componentPackageDeps :: [(UnitId, MungedPackageId)]
  Resolved internal and external package dependencies for this component. The BuildInfo specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler.
- componentIncludes :: [(OpenUnitId, ModuleRenaming)]
  The set of packages that are brought into scope during compilation, including a ModuleRenaming which may used to hide or rename modules. This is what gets translated into -package-id arguments. This is a modernized version of componentPackageDeps, which is kept around for BC purposes.
- componentExeDeps :: [UnitId]
- componentInternalDeps :: [UnitId]
  The internal dependencies which induce a graph on the ComponentLocalBuildInfo of this package. This does NOT coincide with componentPackageDeps because it ALSO records 'build-tool' dependencies on executables. Maybe one day cabal-install will also handle these correctly too!
ExeComponentLocalBuildInfo
- componentLocalName :: ComponentName
  It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo.
- componentComponentId :: ComponentId
  The computed ComponentId of this component.
- componentUnitId :: UnitId
  The computed UnitId which uniquely identifies this component. Might be hashed.
- componentPackageDeps :: [(UnitId, MungedPackageId)]
  Resolved internal and external package dependencies for this component. The BuildInfo specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler.
- componentIncludes :: [(OpenUnitId, ModuleRenaming)]
  The set of packages that are brought into scope during compilation, including a ModuleRenaming which may used to hide or rename modules. This is what gets translated into -package-id arguments. This is a modernized version of componentPackageDeps, which is kept around for BC purposes.
- componentExeDeps :: [UnitId]
- componentInternalDeps :: [UnitId]
  The internal dependencies which induce a graph on the ComponentLocalBuildInfo of this package. This does NOT coincide with componentPackageDeps because it ALSO records 'build-tool' dependencies on executables. Maybe one day cabal-install will also handle these correctly too!
TestComponentLocalBuildInfo
- componentLocalName :: ComponentName
  It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo.
- componentComponentId :: ComponentId
  The computed ComponentId of this component.
- componentUnitId :: UnitId
  The computed UnitId which uniquely identifies this component. Might be hashed.
- componentPackageDeps :: [(UnitId, MungedPackageId)]
  Resolved internal and external package dependencies for this component. The BuildInfo specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler.
- componentIncludes :: [(OpenUnitId, ModuleRenaming)]
  The set of packages that are brought into scope during compilation, including a ModuleRenaming which may used to hide or rename modules. This is what gets translated into -package-id arguments. This is a modernized version of componentPackageDeps, which is kept around for BC purposes.
- componentExeDeps :: [UnitId]
- componentInternalDeps :: [UnitId]
  The internal dependencies which induce a graph on the ComponentLocalBuildInfo of this package. This does NOT coincide with componentPackageDeps because it ALSO records 'build-tool' dependencies on executables. Maybe one day cabal-install will also handle these correctly too!
BenchComponentLocalBuildInfo
- componentLocalName :: ComponentName
  It would be very convenient to store the literal Library here, but if we do that, it will get serialized (via the Binary) instance twice. So instead we just provide the ComponentName, which can be used to find the Component in the PackageDescription. NB: eventually, this will NOT uniquely identify the ComponentLocalBuildInfo.
- componentComponentId :: ComponentId
  The computed ComponentId of this component.
- componentUnitId :: UnitId
  The computed UnitId which uniquely identifies this component. Might be hashed.
- componentPackageDeps :: [(UnitId, MungedPackageId)]
  Resolved internal and external package dependencies for this component. The BuildInfo specifies a set of build dependencies that must be satisfied in terms of version ranges. This field fixes those dependencies to the specific versions available on this machine for this compiler.
- componentIncludes :: [(OpenUnitId, ModuleRenaming)]
  The set of packages that are brought into scope during compilation, including a ModuleRenaming which may used to hide or rename modules. This is what gets translated into -package-id arguments. This is a modernized version of componentPackageDeps, which is kept around for BC purposes.
- componentExeDeps :: [UnitId]
- componentInternalDeps :: [UnitId]
  The internal dependencies which induce a graph on the ComponentLocalBuildInfo of this package. This does NOT coincide with componentPackageDeps because it ALSO records 'build-tool' dependencies on executables. Maybe one day cabal-install will also handle these correctly too!

Instances8Read, Show, Generic, Binary, Structured, IsNode, …

Read ComponentLocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
Show ComponentLocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
Generic ComponentLocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
Binary ComponentLocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
Structured ComponentLocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
IsNode ComponentLocalBuildInfoDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
type Rep ComponentLocalBuildInfo = D1 ('MetaData "ComponentLocalBuildInfo" "Distribution.Types.ComponentLocalBuildInfo" "Cabal-3.12.1.0-fc60" 'False) ((C1 ('MetaCons "LibComponentLocalBuildInfo" 'PrefixI 'True) (((S1 ('MetaSel ('Just "componentLocalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: (S1 ('MetaSel ('Just "componentComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentId) :*: S1 ('MetaSel ('Just "componentUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId))) :*: (S1 ('MetaSel ('Just "componentIsIndefinite_") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "componentInstantiatedWith") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(ModuleName, OpenModule)]) :*: S1 ('MetaSel ('Just "componentPackageDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(UnitId, MungedPackageId)])))) :*: ((S1 ('MetaSel ('Just "componentIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)]) :*: (S1 ('MetaSel ('Just "componentExeDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]) :*: S1 ('MetaSel ('Just "componentInternalDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]))) :*: ((S1 ('MetaSel ('Just "componentCompatPackageKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "componentCompatPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MungedPackageName)) :*: (S1 ('MetaSel ('Just "componentExposedModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ExposedModule]) :*: S1 ('MetaSel ('Just "componentIsPublic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))) :+: C1 ('MetaCons "FLibComponentLocalBuildInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "componentLocalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: (S1 ('MetaSel ('Just "componentComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentId) :*: S1 ('MetaSel ('Just "componentUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId))) :*: ((S1 ('MetaSel ('Just "componentPackageDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 ('MetaSel ('Just "componentIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 ('MetaSel ('Just "componentExeDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]) :*: S1 ('MetaSel ('Just "componentInternalDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]))))) :+: (C1 ('MetaCons "ExeComponentLocalBuildInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "componentLocalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: (S1 ('MetaSel ('Just "componentComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentId) :*: S1 ('MetaSel ('Just "componentUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId))) :*: ((S1 ('MetaSel ('Just "componentPackageDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 ('MetaSel ('Just "componentIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 ('MetaSel ('Just "componentExeDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]) :*: S1 ('MetaSel ('Just "componentInternalDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId])))) :+: (C1 ('MetaCons "TestComponentLocalBuildInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "componentLocalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: (S1 ('MetaSel ('Just "componentComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentId) :*: S1 ('MetaSel ('Just "componentUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId))) :*: ((S1 ('MetaSel ('Just "componentPackageDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 ('MetaSel ('Just "componentIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 ('MetaSel ('Just "componentExeDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]) :*: S1 ('MetaSel ('Just "componentInternalDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId])))) :+: C1 ('MetaCons "BenchComponentLocalBuildInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "componentLocalName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: (S1 ('MetaSel ('Just "componentComponentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentId) :*: S1 ('MetaSel ('Just "componentUnitId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnitId))) :*: ((S1 ('MetaSel ('Just "componentPackageDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(UnitId, MungedPackageId)]) :*: S1 ('MetaSel ('Just "componentIncludes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(OpenUnitId, ModuleRenaming)])) :*: (S1 ('MetaSel ('Just "componentExeDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId]) :*: S1 ('MetaSel ('Just "componentInternalDeps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UnitId])))))))Defined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo
type Key ComponentLocalBuildInfo = UnitIdDefined in Cabal-3.12.1.0 · Distribution.Types.ComponentLocalBuildInfo

valuecomponentBuildDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> FilePath

valuefoldComponent

:: Library -> a
-> ForeignLib -> a
-> Executable -> a
-> TestSuite -> a
-> Benchmark -> a
-> Component
-> a

valuecomponentName :: Component -> ComponentName

valuecomponentBuildInfo :: Component -> BuildInfo

valuecomponentBuildable :: Component -> Bool

Is a component buildable (i.e., not marked with buildable: False)? See also this note in Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components.

valuepkgComponents :: PackageDescription -> [Component]

All the components in the package.

valuepkgBuildableComponents :: PackageDescription -> [Component]

A list of all components in the package that are buildable, i.e., were not marked with buildable: False. This does NOT indicate if we are actually going to build the component, see enabledComponents instead.

valuelookupComponent :: PackageDescription -> ComponentName -> Maybe Component

valuegetComponent :: PackageDescription -> ComponentName -> Component

valueallComponentsInBuildOrder :: LocalBuildInfo -> [ComponentLocalBuildInfo]

valuedepLibraryPaths

:: Bool
Building for inplace?
-> Bool
Generate prefix-relative library paths
-> LocalBuildInfo
-> ComponentLocalBuildInfo
Component that is being built
-> IO [FilePath]

Determine the directories containing the dynamic libraries of the transitive dependencies of the component we are building.

When wanted, and possible, returns paths relative to the installDirs prefix

valueallLibModules :: Library -> ComponentLocalBuildInfo -> [ModuleName]

Get all module names that needed to be built by GHC; i.e., all of these ModuleNames have interface files associated with them that need to be installed.

valuewithAllComponentsInBuildOrder

:: PackageDescription
-> LocalBuildInfo
-> Component -> ComponentLocalBuildInfo -> IO ()
-> IO ()

Perform the action on each buildable Library or Executable (Component) in the PackageDescription, subject to the build order specified by the compBuildOrder field of the given LocalBuildInfo

valuewithLibLBI

:: PackageDescription
-> LocalBuildInfo
-> Library -> ComponentLocalBuildInfo -> IO ()
-> IO ()

Perform the action on each enabled library in the package description with the ComponentLocalBuildInfo.

valuewithExeLBI

:: PackageDescription
-> LocalBuildInfo
-> Executable -> ComponentLocalBuildInfo -> IO ()
-> IO ()

Perform the action on each enabled Executable in the package description. Extended version of withExe that also gives corresponding build info.

valuewithBenchLBI

:: PackageDescription
-> LocalBuildInfo
-> Benchmark -> ComponentLocalBuildInfo -> IO ()
-> IO ()

Perform the action on each enabled Benchmark in the package description.

valuewithTestLBI

:: PackageDescription
-> LocalBuildInfo
-> TestSuite -> ComponentLocalBuildInfo -> IO ()
-> IO ()

valueenabledTestLBIs

:: PackageDescription
-> LocalBuildInfo
-> [(TestSuite, ComponentLocalBuildInfo)]

valueenabledBenchLBIs

:: PackageDescription
-> LocalBuildInfo
-> [(Benchmark, ComponentLocalBuildInfo)]

Installation directories

25 declarations

datadata InstallDirs dir

The directories where we will install files for packages.

We have several different directories for different types of files since many systems have conventions whereby different types of files in a package are installed in different directories. This is particularly the case on Unix style systems.

Constructors

InstallDirs
- prefix :: dir
- bindir :: dir
- libdir :: dir
- libsubdir :: dir
- dynlibdir :: dir
- flibdir :: dir
  foreign libraries
- libexecdir :: dir
- libexecsubdir :: dir
- includedir :: dir
- datadir :: dir
- datasubdir :: dir
- docdir :: dir
- mandir :: dir
- htmldir :: dir
- haddockdir :: dir
- sysconfdir :: dir

Instances10Functor, Eq, Read, Show, Generic, Semigroup, …

Functor InstallDirsDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Eq dir => Eq (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Read dir => Read (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Show dir => Show (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Generic (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Semigroup dir => Semigroup (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
(Semigroup dir, Monoid dir) => Monoid (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Binary dir => Binary (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Structured dir => Structured (InstallDirs dir)Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
type Rep (InstallDirs dir) = D1 ('MetaData "InstallDirs" "Distribution.Simple.InstallDirs" "Cabal-3.12.1.0-fc60" 'False) (C1 ('MetaCons "InstallDirs" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "bindir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir)) :*: (S1 ('MetaSel ('Just "libdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "libsubdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir))) :*: ((S1 ('MetaSel ('Just "dynlibdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "flibdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir)) :*: (S1 ('MetaSel ('Just "libexecdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "libexecsubdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir)))) :*: (((S1 ('MetaSel ('Just "includedir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "datadir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir)) :*: (S1 ('MetaSel ('Just "datasubdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "docdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir))) :*: ((S1 ('MetaSel ('Just "mandir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "htmldir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir)) :*: (S1 ('MetaSel ('Just "haddockdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir) :*: S1 ('MetaSel ('Just "sysconfdir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 dir))))))Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs

datadata CopyDest

The location prefix for the copy command.

Constructors

NoCopyDest
CopyTo FilePath
CopyToDb FilePath
when using the ${pkgroot} as prefix. The CopyToDb will adjust the paths to be relative to the provided package database when copying / installing.

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq CopyDestDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Show CopyDestDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Generic CopyDestDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Binary CopyDestDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Structured CopyDestDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
type Rep CopyDest = D1 ('MetaData "CopyDest" "Distribution.Simple.InstallDirs" "Cabal-3.12.1.0-fc60" 'False) (C1 ('MetaCons "NoCopyDest" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "CopyTo" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)) :+: C1 ('MetaCons "CopyToDb" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))))Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs

newtypenewtype PathTemplate

An abstract path, possibly containing variables that need to be substituted for to get a real FilePath.

Instances8Eq, Ord, Read, Show, Generic, Binary, …

Eq PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Ord PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Read PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Show PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Generic PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Binary PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
Structured PathTemplateDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs
type Rep PathTemplate = D1 ('MetaData "PathTemplate" "Distribution.Simple.InstallDirs" "Cabal-3.12.1.0-fc60" 'True) (C1 ('MetaCons "PathTemplate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PathComponent])))Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs

valuefromPathTemplate :: PathTemplate -> FilePath

Convert back to a path, any remaining vars are included

valueinitialPathTemplateEnv

The initial environment has all the static stuff but no paths

typetype InstallDirTemplates = InstallDirs PathTemplate

The installation directories in terms of PathTemplates that contain variables.

The defaults for most of the directories are relative to each other, in particular they are all relative to a single prefix. This makes it convenient for the user to override the default installation directory by only having to specify --prefix=... rather than overriding each individually. This is done by allowing $-style variables in the dirs. These are expanded by textual substitution (see substPathTemplate).

A few of these installation directories are split into two components, the dir and subdir. The full installation path is formed by combining the two together with /. The reason for this is compatibility with other Unix build systems which also support --libdir and --datadir. We would like users to be able to configure --libdir=/usr/lib64 for example but because by default we want to support installing multiple versions of packages and building the same package for multiple compilers we append the libsubdir to get: /usr/lib64/$libname/$compiler.

An additional complication is the need to support relocatable packages on systems which support such things, like Windows.

datadata PathTemplateVariable

Constructors

PrefixVar
The $prefix path variable
BindirVar
The $bindir path variable
LibdirVar
The $libdir path variable
LibsubdirVar
The $libsubdir path variable
DynlibdirVar
The $dynlibdir path variable
DatadirVar
The $datadir path variable
DatasubdirVar
The $datasubdir path variable
DocdirVar
The $docdir path variable
HtmldirVar
The $htmldir path variable
PkgNameVar
The $pkg package name path variable
PkgVerVar
The $version package version path variable
PkgIdVar
The $pkgid package Id path variable, eg foo-1.0
LibNameVar
The $libname path variable
CompilerVar
The compiler name and version, eg ghc-6.6.1
OSVar
The operating system name, eg windows or linux
ArchVar
The CPU architecture name, eg i386 or x86_64
AbiVar
The compiler's ABI identifier,
AbiTagVar
The optional ABI tag for the compiler
ExecutableNameVar
The executable name; used in shell wrappers
TestSuiteNameVar
The name of the test suite being run
TestSuiteResultVar
The result of the test suite being run, eg pass, fail, or error.
BenchmarkNameVar
The name of the benchmark being run

Instances8Eq, Ord, Read, Show, Generic, Binary, …

Eq PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
Ord PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
Read PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
Show PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
Generic PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
Binary PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
Structured PathTemplateVariableDefined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal
type Rep PathTemplateVariable = D1 ('MetaData "PathTemplateVariable" "Distribution.Simple.InstallDirs.Internal" "Cabal-3.12.1.0-fc60" 'False) ((((C1 ('MetaCons "PrefixVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BindirVar" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "LibdirVar" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "LibsubdirVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "DynlibdirVar" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "DatadirVar" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "DatasubdirVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "DocdirVar" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "HtmldirVar" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "PkgNameVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "PkgVerVar" 'PrefixI 'False) U1)))) :+: (((C1 ('MetaCons "PkgIdVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LibNameVar" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "CompilerVar" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "OSVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ArchVar" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "AbiVar" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "AbiTagVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ExecutableNameVar" 'PrefixI 'False) U1)) :+: (C1 ('MetaCons "TestSuiteNameVar" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "TestSuiteResultVar" 'PrefixI 'False) U1 :+: C1 ('MetaCons "BenchmarkNameVar" 'PrefixI 'False) U1)))))Defined in Cabal-3.12.1.0 · Distribution.Simple.InstallDirs.Internal

valueabiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv

valuecombineInstallDirs

:: a -> b -> c
-> InstallDirs a
-> InstallDirs b
-> InstallDirs c

valuecombinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate

valuecompilerTemplateEnv :: CompilerInfo -> PathTemplateEnv

valuedefaultInstallDirs

valuedefaultInstallDirs'

valueinstallDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv

valuepackageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv

valueplatformTemplateEnv :: Platform -> PathTemplateEnv

valuesubstituteInstallDirTemplates

Substitute the install dir templates into each other.

To prevent cyclic substitutions, only some variables are allowed in particular dir templates. If out of scope vars are present, they are not substituted for. Checking for any remaining unsubstituted vars can be done as a subsequent operation.

The reason it is done this way is so that in prefixRelativeInstallDirs we can replace prefix with the PrefixVar and get resulting PathTemplates that still have the PrefixVar in them. Doing this makes it each to check which paths are relative to the $prefix.

valuetoPathTemplate :: FilePath -> PathTemplate

Convert a FilePath to a PathTemplate including any template vars.

typetype PathTemplateEnv = [(PathTemplateVariable, PathTemplate)]

valueabsoluteInstallDirs

Backwards compatibility function which computes the InstallDirs assuming that $libname points to the public library (or some fake package identifier if there is no public library.) IF AT ALL POSSIBLE, please use absoluteComponentInstallDirs instead.

valueprefixRelativeInstallDirs

valueabsoluteInstallCommandDirs

valueabsoluteComponentInstallDirs

See absoluteInstallDirs.

valueprefixRelativeComponentInstallDirs

See prefixRelativeInstallDirs

valuesubstPathTemplate