License	BSD-3-Clause
Safe Haskell	None
Language	GHC2024

Stack.Types.Plan

Description

Plan-related types and functions.

Synopsis

data Plan = Plan {
- tasks :: !(Map PackageName Task)
- finals :: !(Map PackageName Task)
- unregisterLocal :: !(Map GhcPkgId (PackageIdentifier, Text))
- installExes :: !(Map StackUnqualCompName InstallLocation)
}
data Task = Task {
- taskType :: !TaskType
- configOpts :: !TaskConfigOpts
- buildHaddocks :: !Bool
- present :: !(Map PackageIdentifier GhcPkgId)
- allInOne :: !Bool
- cachePkgSrc :: !CachePkgSrc
- buildTypeConfig :: !Bool
}
data TaskType
- = TTLocalMutable LocalPackage
- | TTRemotePackage IsMutable Package PackageLocationImmutable
data TaskConfigOpts = TaskConfigOpts {
- missing :: !(Set PackageIdentifier)
- envConfig :: !EnvConfig
- baseConfigOpts :: !BaseConfigOpts
- isLocalNonExtraDep :: !Bool
- isMutable :: !IsMutable
- pkgConfigOpts :: PackageConfigureOpts
}
taskAnyMissing :: Task -> Bool
taskIsTarget :: Task -> Bool
taskLocation :: Task -> InstallLocation
taskProvides :: Task -> PackageIdentifier
taskTargetIsMutable :: Task -> IsMutable
taskTypeLocation :: TaskType -> InstallLocation
taskTypePackageIdentifier :: TaskType -> PackageIdentifier
installLocationIsMutable :: InstallLocation -> IsMutable

Documentation

data Plan Source #

A complete plan of what needs to be built and how to do it

Constructors

Plan
Fields tasks :: !(Map PackageName Task) finals :: !(Map PackageName Task) Final actions to be taken (test, benchmark, etc) unregisterLocal :: !(Map GhcPkgId (PackageIdentifier, Text)) Text is reason we're unregistering, for display only installExes :: !(Map StackUnqualCompName InstallLocation) Executables that should be installed after successful building

Instances

Instances details

Show Plan Source #
Instance details Defined in Stack.Types.Plan Methods showsPrec :: Int -> Plan -> ShowS show :: Plan -> String # showList :: [Plan] -> ShowS

data Task Source #

A type representing tasks to perform when building.

Constructors

Task

Fields

taskType :: !TaskType
The task type, telling us how to build this
configOpts :: !TaskConfigOpts
A set of the package identifiers of dependencies for which GhcPkgId are missing and a function which yields configure options, given a dictionary of those identifiers and their GhcPkgId.
buildHaddocks :: !Bool
present :: !(Map PackageIdentifier GhcPkgId)
A dictionary of the package identifiers of already-installed dependencies, and their GhcPkgId.
allInOne :: !Bool
indicates that the package can be built in one step
cachePkgSrc :: !CachePkgSrc
buildTypeConfig :: !Bool
Is the build type of this package Configure. Check out ensureConfigureScript in Stack.Build.Execute for the motivation

Instances

Instances details

Show Task Source #
Instance details Defined in Stack.Types.Plan Methods showsPrec :: Int -> Task -> ShowS show :: Task -> String # showList :: [Task] -> ShowS

data TaskType Source #

Type representing different types of task, depending on what is to be built.

Constructors

TTLocalMutable LocalPackage	Building local source code.
TTRemotePackage IsMutable Package PackageLocationImmutable	Building something from the package index (upstream).

Instances

Instances details

Show TaskType Source #
Instance details Defined in Stack.Types.Plan Methods showsPrec :: Int -> TaskType -> ShowS show :: TaskType -> String # showList :: [TaskType] -> ShowS

data TaskConfigOpts Source #

Given the IDs of any missing packages, produce the configure options

Constructors

TaskConfigOpts
Fields missing :: !(Set PackageIdentifier) Dependencies for which we don't yet have a `GhcPkgId` envConfig :: !EnvConfig baseConfigOpts :: !BaseConfigOpts isLocalNonExtraDep :: !Bool isMutable :: !IsMutable pkgConfigOpts :: PackageConfigureOpts

Instances

Instances details

Show TaskConfigOpts Source #
Instance details Defined in Stack.Types.Plan Methods showsPrec :: Int -> TaskConfigOpts -> ShowS show :: TaskConfigOpts -> String # showList :: [TaskConfigOpts] -> ShowS

taskAnyMissing :: Task -> Bool Source #

Were any of the dependencies missing?

taskIsTarget :: Task -> Bool Source #

taskLocation :: Task -> InstallLocation Source #

A function to yield the relevant database (write-only or mutable) of the given task.

taskProvides :: Task -> PackageIdentifier Source #

A function to yield the package name and version to be built by the given task.

taskTargetIsMutable :: Task -> IsMutable Source #

taskTypeLocation :: TaskType -> InstallLocation Source #

A function to yield the relevant database (write-only or mutable) of a given TaskType value.

taskTypePackageIdentifier :: TaskType -> PackageIdentifier Source #

A function to yield the package name and version of a given TaskType value.

installLocationIsMutable :: InstallLocation -> IsMutable Source #