ModuleCabal-3.18.1.0Haskell2010

Distribution.Types.LocalBuildInfo

1 type
63 values

PackageCabal-3.18.1.0
Exports65
LanguageHaskell2010
LicenceBSD-3-Clause
SourceLocalBuildInfo.hs

The types

39 declarations

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.18.1.0 · Distribution.Types.LocalBuildInfo
Show LocalBuildInfoDefined in Cabal-3.18.1.0 · Distribution.Types.LocalBuildInfo
Generic LocalBuildInfoDefined in Cabal-3.18.1.0 · Distribution.Types.LocalBuildInfo
Binary LocalBuildInfoDefined in Cabal-3.18.1.0 · Distribution.Types.LocalBuildInfo
Structured LocalBuildInfoDefined in Cabal-3.18.1.0 · Distribution.Types.LocalBuildInfo
type Rep LocalBuildInfo = D1 ('MetaData "LocalBuildInfo" "Distribution.Types.LocalBuildInfo" "Cabal-3.18.1.0-cd98" '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.18.1.0 · Distribution.Types.LocalBuildInfo

pattern

pattern LocalBuildInfo :: ConfigFlags -> FlagAssignment -> ComponentRequestedSpec -> [String] -> InstallDirTemplates -> Compiler -> Platform -> Maybe (SymbolicPath Pkg 'File) -> Graph ComponentLocalBuildInfo -> Map ComponentName [ComponentLocalBuildInfo] -> Map (PackageName, ComponentName) PromisedComponent -> InstalledPackageIndex -> PackageDescription -> ProgramDb -> PackageDBStack -> Bool -> Bool -> 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.

valueconfigFlags :: LocalBuildInfo -> ConfigFlags

valueflagAssignment :: LocalBuildInfo -> FlagAssignment

valuecomponentEnabledSpec :: LocalBuildInfo -> ComponentRequestedSpec

valueextraConfigArgs :: LocalBuildInfo -> [String]

valueinstallDirTemplates :: LocalBuildInfo -> InstallDirTemplates

valuecompiler :: LocalBuildInfo -> Compiler

valuehostPlatform :: LocalBuildInfo -> Platform

valuepkgDescrFile :: LocalBuildInfo -> Maybe (SymbolicPath Pkg 'File)

valuecomponentGraph :: LocalBuildInfo -> Graph ComponentLocalBuildInfo

valuecomponentNameMap

:: LocalBuildInfo
-> Map ComponentName [ComponentLocalBuildInfo]

valuepromisedPkgs

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

valueinstalledPkgs :: LocalBuildInfo -> InstalledPackageIndex

valuelocalPkgDescr :: LocalBuildInfo -> PackageDescription

valuewithPrograms :: LocalBuildInfo -> ProgramDb

valuewithPackageDB :: LocalBuildInfo -> PackageDBStack

valuewithVanillaLib :: LocalBuildInfo -> Bool

valuewithProfLib :: LocalBuildInfo -> Bool

valuewithProfLibShared :: LocalBuildInfo -> Bool

valuewithDynExe :: LocalBuildInfo -> Bool

valuewithFullyStaticExe :: LocalBuildInfo -> Bool

valuewithProfExe :: LocalBuildInfo -> Bool

valuewithSharedLib :: LocalBuildInfo -> Bool

valuewithStaticLib :: LocalBuildInfo -> Bool

valuewithBytecodeLib :: LocalBuildInfo -> Bool

valuewithProfLibDetail :: LocalBuildInfo -> ProfDetailLevel

valuewithProfExeDetail :: LocalBuildInfo -> ProfDetailLevel

valuewithOptimization :: LocalBuildInfo -> OptimisationLevel

valuewithDebugInfo :: LocalBuildInfo -> DebugInfoLevel

valuewithGHCiLib :: LocalBuildInfo -> Bool

valuesplitSections :: LocalBuildInfo -> Bool

valuesplitObjs :: LocalBuildInfo -> Bool

valuestripExes :: LocalBuildInfo -> Bool

valuestripLibs :: LocalBuildInfo -> Bool

valueexeCoverage :: LocalBuildInfo -> Bool

valuelibCoverage :: LocalBuildInfo -> Bool

valueextraCoverageFor :: LocalBuildInfo -> [UnitId]

valuerelocatable :: LocalBuildInfo -> Bool

Convenience accessors

11 declarations

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.

valuelocalPackage :: LocalBuildInfo -> PackageId

Extract the PackageIdentifier of a LocalBuildInfo. This is a "safe" use of localPkgDescr

valuebuildDir :: LocalBuildInfo -> SymbolicPath Pkg ('Dir Build)

valuebuildDirPBD :: PackageBuildDescr -> SymbolicPath Pkg ('Dir Build)

valuesetupFlagsBuildDir :: CommonSetupFlags -> SymbolicPath Pkg ('Dir Build)

valuedistPrefLBI :: LocalBuildInfo -> SymbolicPath Pkg ('Dir Dist)

valuepackageRoot :: CommonSetupFlags -> FilePath

The (relative or absolute) path to the package root, based on

the working directory flag
the .cabal path

valueprogPrefix :: LocalBuildInfo -> PathTemplate

valueprogSuffix :: LocalBuildInfo -> PathTemplate

Build targets of the LocalBuildInfo.

9 declarations

valuecomponentNameCLBIs

Return all ComponentLocalBuildInfos associated with ComponentName. In the presence of Backpack there may be more than one!

valuecomponentNameTargets'

Return all TargetInfos associated with ComponentName. In the presence of Backpack there may be more than one! Has a prime because it takes a PackageDescription argument which may disagree with localPkgDescr in LocalBuildInfo.

valueunitIdTarget'

valueallTargetsInBuildOrder'

Return the list of default TargetInfos associated with a configured package, in the order they need to be built. Has a prime because it takes a PackageDescription argument which may disagree with localPkgDescr in LocalBuildInfo.

valuewithAllTargetsInBuildOrder'

:: PackageDescription
-> LocalBuildInfo
-> TargetInfo -> IO ()
-> IO ()

Execute f for every TargetInfo in the package, respecting the build dependency order. (TODO: We should use Shake!) Has a prime because it takes a PackageDescription argument which may disagree with localPkgDescr in LocalBuildInfo.

valueneededTargetsInBuildOrder'

Return the list of all targets needed to build the uids, in the order they need to be built. Has a prime because it takes a PackageDescription argument which may disagree with localPkgDescr in LocalBuildInfo.

valuewithNeededTargetsInBuildOrder'

:: PackageDescription
-> LocalBuildInfo
-> [UnitId]
-> TargetInfo -> IO ()
-> IO ()

Execute f for every TargetInfo needed to build uids, respecting the build dependency order. Has a prime because it takes a PackageDescription argument which may disagree with localPkgDescr in LocalBuildInfo.

valuetestCoverage :: LocalBuildInfo -> Bool

Is coverage enabled for test suites? In practice, this requires library and executable profiling to be enabled.

valuebuildWays

:: LocalBuildInfo
-> (Bool -> [BuildWay], Bool -> BuildWay, BuildWay)

Returns a list of ways, in the order which they should be built, and the way we build executable and foreign library components.

Ideally all this info should be fixed at configure time and not dependent on additional info but LocalBuildInfo is per package (not per component) so it's currently not possible to configure components to be built in certain ways.

Functions you SHOULD NOT USE (yet), but are defined here to

6 declarations

valuecomponentNameTargets :: LocalBuildInfo -> ComponentName -> [TargetInfo]

By using this function, you may be introducing a bug where you retrieve a Component which does not have HookedBuildInfo applied to it. See the documentation for HookedBuildInfo for an explanation of the issue. If you have a PackageDescription handy (NOT from the LocalBuildInfo), try using the primed version of the function, which takes it as an extra argument.

valueunitIdTarget :: LocalBuildInfo -> UnitId -> Maybe TargetInfo

valueallTargetsInBuildOrder :: LocalBuildInfo -> [TargetInfo]

valuewithAllTargetsInBuildOrder

:: LocalBuildInfo
-> TargetInfo -> IO ()
-> IO ()

valueneededTargetsInBuildOrder :: LocalBuildInfo -> [UnitId] -> [TargetInfo]

valuewithNeededTargetsInBuildOrder

:: LocalBuildInfo
-> [UnitId]
-> TargetInfo -> IO ()
-> IO ()