Fields

• configFlags :: ConfigFlags

  Options passed to the configuration step. Needed to re-run configuration when .cabal is out of date

• flagAssignment :: FlagAssignment

  The final set of flags which were picked for this package

• componentEnabledSpec :: ComponentRequestedSpec

  What components were enabled during configuration, and why.

• extraConfigArgs :: [String]

  Extra args on the command line for the configuration step. Needed to re-run configuration when .cabal is out of date

• installDirTemplates :: InstallDirTemplates

  The installation directories for the various different kinds of files TODO: inplaceDirTemplates :: InstallDirs FilePath

• compiler :: Compiler

  The compiler we're building with

• hostPlatform :: Platform

  The platform we're building for

• buildDir :: FilePath

  Where to build the package.

• cabalFilePath :: Maybe FilePath

  Path to the cabal file, if given during configuration.

• componentGraph :: Graph ComponentLocalBuildInfo

  All the components to build, ordered by topological sort, and with their INTERNAL dependencies over the intrapackage dependency graph. TODO: this is assumed to be short; otherwise we want some sort of ordered map.

• componentNameMap :: Map ComponentName [ComponentLocalBuildInfo]

  A map from component name to all matching components. These coincide with componentGraph

• promisedPkgs :: Map (PackageName, ComponentName) ComponentId

  The packages we were promised, but aren't already installed. MP: Perhaps this just needs to be a Set UnitId at this stage.

• installedPkgs :: InstalledPackageIndex

  All the info about the installed packages that the current package depends on (directly or indirectly). The copy saved on disk does NOT include internal dependencies (because we just don't have enough information at this point to have an InstalledPackageInfo for an internal dep), but we will often update it with the internal dependencies; see for example build. (This admonition doesn't apply for per-component builds.)

• pkgDescrFile :: Maybe FilePath

  the filename containing the .cabal file, if available

• localPkgDescr :: PackageDescription

  WARNING WARNING WARNING Be VERY careful about using this function; we haven't deprecated it but using it could introduce subtle bugs related to HookedBuildInfo.

  In principle, this is supposed to contain the resolved package description, that does not contain any conditionals. However, it MAY NOT contain the description with a HookedBuildInfo applied to it; see HookedBuildInfo for the whole sordid saga. As much as possible, Cabal library should avoid using this parameter.

• withPrograms :: ProgramDb

  Location and args for all programs

• withPackageDB :: PackageDBStack

  What package database to use, global/user

• withVanillaLib :: Bool

  Whether to build normal libs.

• withProfLib :: Bool

  Whether to build profiling versions of libs.

• withSharedLib :: Bool

  Whether to build shared versions of libs.

• withStaticLib :: Bool

  Whether to build static versions of libs (with all other libs rolled in)

• withDynExe :: Bool

  Whether to link executables dynamically

• withFullyStaticExe :: Bool

  Whether to link executables fully statically

• withProfExe :: Bool

  Whether to build executables for profiling.

• withProfLibDetail :: ProfDetailLevel

  Level of automatic profile detail.

• withProfExeDetail :: ProfDetailLevel

  Level of automatic profile detail.

• withOptimization :: OptimisationLevel

  Whether to build with optimization (if available).

• withDebugInfo :: DebugInfoLevel

  Whether to emit debug info (if available).

• withGHCiLib :: Bool

  Whether to build libs suitable for use with GHCi.

• splitSections :: Bool

  Use -split-sections with GHC, if available

• splitObjs :: Bool

  Use -split-objs with GHC, if available

• stripExes :: Bool

  Whether to strip executables during install

• stripLibs :: Bool

  Whether to strip libraries during install

• exeCoverage :: Bool

  Whether to enable executable program coverage

• libCoverage :: Bool

  Whether to enable library program coverage

• progPrefix :: PathTemplate

  Prefix to be prepended to installed executables

• progSuffix :: PathTemplate

  Suffix to be appended to installed executables

• relocatable :: Bool
   

Fields

• 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.

Fields

• 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!

Fields

• 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!

Fields

• 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!

Fields

• 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!

Fields

• 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