Fields

• elabUnitId :: UnitId

  The UnitId which uniquely identifies this item in a build plan

• elabComponentId :: ComponentId
   
• elabInstantiatedWith :: Map ModuleName Module
   
• elabLinkedInstantiatedWith :: Map ModuleName OpenModule
   
• elabIsCanonical :: Bool

  This is true if this is an indefinite package, or this is a package with no signatures. (Notably, it's not true for instantiated packages.) The motivation for this is if you ask to build foo-indef, this probably means that you want to typecheck it, NOT that you want to rebuild all of the various instantiations of it.

• elabPkgSourceId :: PackageId

  The PackageId of the originating package

• elabModuleShape :: ModuleShape

  Shape of the package/component, for Backpack.

• elabFlagAssignment :: FlagAssignment

  A total flag assignment for the package. TODO: Actually this can be per-component if we drop all flags that don't affect a component.

• elabFlagDefaults :: FlagAssignment

  The original default flag assignment, used only for reporting.

• elabPkgDescription :: PackageDescription
   
• elabPkgSourceLocation :: PackageLocation (Maybe FilePath)

  Where the package comes from, e.g. tarball, local dir etc. This is not the same as where it may be unpacked to for the build.

• elabPkgSourceHash :: Maybe PackageSourceHash

  The hash of the source, e.g. the tarball. We don't have this for local source dir packages.

• elabLocalToProject :: Bool

  Is this package one of the ones specified by location in the project file? (As opposed to a dependency, or a named package pulled in)

• elabBuildStyle :: BuildStyle

  Are we going to build and install this package to the store, or are we going to build it and register it locally.

• elabEnabledSpec :: ComponentRequestedSpec

  Another way of phrasing pkgStanzasAvailable.

• elabStanzasAvailable :: OptionalStanzaSet

  Which optional stanzas (ie testsuites, benchmarks) can be built. This means the solver produced a plan that has them available. This doesn't necessary mean we build them by default.

• elabStanzasRequested :: OptionalStanzaMap (Maybe Bool)

  Which optional stanzas the user explicitly asked to enable or to disable. This tells us which ones we build by default, and helps with error messages when the user asks to build something they explicitly disabled.

  TODO: The Bool here should be refined into an ADT with three cases: NotRequested, ExplicitlyRequested and ImplicitlyRequested. A stanza is explicitly requested if the user asked, for this *specific* package, that the stanza be enabled; it's implicitly requested if the user asked for all global packages to have this stanza enabled. The difference between an explicit and implicit request is error reporting behavior: if a user asks for tests to be enabled for a specific package that doesn't have any tests, we should warn them about it, but we shouldn't complain that a user enabled tests globally, and some local packages just happen not to have any tests. (But perhaps we should warn if ALL local packages don't have any tests.)

• elabPackageDbs :: [Maybe PackageDBCWD]
   
• elabSetupPackageDBStack :: PackageDBStackCWD
   
• elabBuildPackageDBStack :: PackageDBStackCWD
   
• elabRegisterPackageDBStack :: PackageDBStackCWD
   
• elabInplaceSetupPackageDBStack :: PackageDBStackCWD
   
• elabInplaceBuildPackageDBStack :: PackageDBStackCWD
   
• elabInplaceRegisterPackageDBStack :: PackageDBStackCWD
   
• elabPkgDescriptionOverride :: Maybe CabalFileText
   
• elabBuildOptions :: BuildOptions
   
• elabDumpBuildInfo :: DumpBuildInfo
   
• elabProgramPaths :: Map String FilePath
   
• elabProgramArgs :: Map String [String]
   
• elabProgramPathExtra :: [FilePath]
   
• elabConfiguredPrograms :: [ConfiguredProgram]
   
• elabConfigureScriptArgs :: [String]
   
• elabExtraLibDirs :: [FilePath]
   
• elabExtraLibDirsStatic :: [FilePath]
   
• elabExtraFrameworkDirs :: [FilePath]
   
• elabExtraIncludeDirs :: [FilePath]
   
• elabProgPrefix :: Maybe PathTemplate
   
• elabProgSuffix :: Maybe PathTemplate
   
• elabInstallDirs :: InstallDirs FilePath
   
• elabHaddockHoogle :: Bool
   
• elabHaddockHtml :: Bool
   
• elabHaddockHtmlLocation :: Maybe String
   
• elabHaddockForeignLibs :: Bool
   
• elabHaddockForHackage :: HaddockTarget
   
• elabHaddockExecutables :: Bool
   
• elabHaddockTestSuites :: Bool
   
• elabHaddockBenchmarks :: Bool
   
• elabHaddockInternal :: Bool
   
• elabHaddockCss :: Maybe FilePath
   
• elabHaddockLinkedSource :: Bool
   
• elabHaddockQuickJump :: Bool
   
• elabHaddockHscolourCss :: Maybe FilePath
   
• elabHaddockContents :: Maybe PathTemplate
   
• elabHaddockIndex :: Maybe PathTemplate
   
• elabHaddockBaseUrl :: Maybe String
   
• elabHaddockResourcesDir :: Maybe String
   
• elabHaddockOutputDir :: Maybe FilePath
   
• elabHaddockUseUnicode :: Bool
   
• elabTestMachineLog :: Maybe PathTemplate
   
• elabTestHumanLog :: Maybe PathTemplate
   
• elabTestShowDetails :: Maybe TestShowDetails
   
• elabTestKeepTix :: Bool
   
• elabTestWrapper :: Maybe FilePath
   
• elabTestFailWhenNoTestSuites :: Bool
   
• elabTestTestOptions :: [PathTemplate]
   
• elabBenchmarkOptions :: [PathTemplate]
   
• elabSetupScriptStyle :: SetupScriptStyle

  One of four modes for how we build and interact with the Setup.hs script, based on whether it's a build-type Custom, with or without explicit deps and the cabal spec version the .cabal file needs.

• elabSetupScriptCliVersion :: Version

  The version of the Cabal command line interface that we are using for this package. This is typically the version of the Cabal lib that the Setup.hs is built against.

  TODO: We might want to turn this into a enum, yet different enum than CabalSpecVersion.

• elabConfigureTargets :: [ComponentTarget]
   
• elabBuildTargets :: [ComponentTarget]
   
• elabTestTargets :: [ComponentTarget]
   
• elabBenchTargets :: [ComponentTarget]
   
• elabReplTarget :: [ComponentTarget]
   
• elabHaddockTargets :: [ComponentTarget]
   
• elabBuildHaddocks :: Bool
   
• elabPkgOrComp :: ElaboratedPackageOrComponent

  Component/package specific information

Fields

• compSolverName :: Component

  The name of the component to be built according to the solver

• compComponentName :: Maybe ComponentName

  The name of the component to be built. Nothing if it's a setup dep.

• compLibDependencies :: [(ConfiguredId, Bool)]

  The *external* library dependencies of this component. We pass this to the configure script. The Bool indicates whether the dependency is a promised dependency (True) or not (False).

• compLinkedLibDependencies :: [OpenUnitId]

  In a component prior to instantiation, this list specifies the OpenUnitIds which, after instantiation, are the actual dependencies of this package. Note that this does NOT include signature packages, which do not turn into real ordering dependencies when we instantiate. This is intended to be a purely temporary field, to carry some information to the instantiation phase. It's more precise than compLibDependencies, and also stores information about internal dependencies.

• compExeDependencies :: [ConfiguredId]

  The executable dependencies of this component (including internal executables).

• compPkgConfigDependencies :: [(PkgconfigName, Maybe PkgconfigVersion)]

  The pkg-config dependencies of the component

• compExeDependencyPaths :: [(ConfiguredId, FilePath)]

  The paths all our executable dependencies will be installed to once they are installed.

• compOrderLibDependencies :: [UnitId]

  The UnitIds of the libraries (identifying elaborated packages/ components) that must be built before this project. This is used purely for ordering purposes. It can contain both references to definite and indefinite packages; an indefinite UnitId indicates that we must typecheck that indefinite package before we can build this one.

Fields

• pkgInstalledId :: InstalledPackageId
   
• pkgLibDependencies :: ComponentDeps [(ConfiguredId, Bool)]

  The exact dependencies (on other plan packages) The boolean value indicates whether the dependency is a promised dependency or not.

• pkgDependsOnSelfLib :: ComponentDeps [()]

  Components which depend (transitively) on an internally defined library. These are used by elabRequiresRegistration, to determine if a user-requested build is going to need a library registration

• pkgExeDependencies :: ComponentDeps [ConfiguredId]

  Dependencies on executable packages.

• pkgExeDependencyPaths :: ComponentDeps [(ConfiguredId, FilePath)]

  Paths where executable dependencies live.

• pkgPkgConfigDependencies :: [(PkgconfigName, Maybe PkgconfigVersion)]

  Dependencies on pkg-config packages. NB: this is NOT per-component (although it could be) because Cabal library does not track per-component pkg-config depends; it always does them all at once.

• pkgStanzasEnabled :: OptionalStanzaSet

  Which optional stanzas (ie testsuites, benchmarks) will actually be enabled during the package configure step.

• pkgWhyNotPerComponent :: NonEmpty NotPerComponentReason

  Why is this not a per-component build?

Fields

• pkgConfigPlatform :: Platform
   
• pkgConfigCompiler :: Compiler
   
• pkgConfigCompilerProgs :: ProgramDb

  The programs that the compiler configured (e.g. for GHC, the progs ghc & ghc-pkg). Once constructed, only the configuredPrograms are used.

• pkgConfigReplOptions :: ReplOptions