Stack.Types.Build.ConstructPlan

A module providing types and related helper functions used in module Stack.Build.ConstructPlan.

Documentation

data PackageInfo

Type representing information about packages, namely information about whether or not a package is already installed and, unless the package is not to be built (global packages), where its source code is located.

Constructors

PIOnlyInstalled InstallLocation Installed

This indicates that the package is already installed, and that we shouldn't build it from source. This is only the case for global packages.

PIOnlySource PackageSource

This indicates that the package isn't installed, and we know where to find its source.

PIBoth PackageSource Installed

This indicates that the package is installed and we know where to find its source. We may want to reinstall from source.

Instances

Show PackageInfo

Defined in Stack.Types.Build.ConstructPlan

Methods

showsPrec :: Int -> PackageInfo -> ShowS

show :: PackageInfo -> String

showList :: [PackageInfo] -> ShowS

type CombinedMap = Map PackageName PackageInfo

A type synonym representing dictionaries of package names, and combined information about the package in respect of whether or not it is already installed and, unless the package is not to be built (global packages), where its source code is located.

type M = WriterT W (StateT (Map PackageName (Either ConstructPlanException AddDepRes)) (RIO Ctx))

Type synonym representing values used during the construction of a build plan. The type is an instance of Monad, hence its name.

data W

Type representing values used as the output to be collected during the construction of a build plan.

Constructors

W

Fields

• wFinals :: !(Map PackageName (Either ConstructPlanException Task))

  A dictionary of package names, and either a final task to perform when building the package or an exception.

• wInstall :: !(Map Text InstallLocation)

  A dictionary of executables to be installed, and location where the executable's binary is placed.

• wDirty :: !(Map PackageName Text)

  A dictionary of local packages, and the reason why the local package is considered dirty.

• wWarnings :: !([StyleDoc] -> [StyleDoc])

  Warnings.

• wParents :: !ParentMap

  A dictionary of package names, and a list of pairs of the identifier of a package depending on the package and the version range specified for the dependency by that package. Used in the reporting of failure to construct a build plan.

Instances

Monoid W

Defined in Stack.Types.Build.ConstructPlan

Methods

mempty :: W

mappend :: W -> W -> W

mconcat :: [W] -> W

Semigroup W

Defined in Stack.Types.Build.ConstructPlan

Methods

(<>) :: W -> W -> W

sconcat :: NonEmpty W -> W

stimes :: Integral b => b -> W -> W

Generic W

Defined in Stack.Types.Build.ConstructPlan

Associated Types

type Rep W :: Type -> Type

Methods

from :: W -> Rep W x

to :: Rep W x -> W

type Rep W

Defined in Stack.Types.Build.ConstructPlan

type Rep W = D1 ('MetaData "W" "Stack.Types.Build.ConstructPlan" "stack-2.15.1-BDsvBT8AtC4AOYQNYrK19c" 'False) (C1 ('MetaCons "W" 'PrefixI 'True) ((S1 ('MetaSel ('Just "wFinals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName (Either ConstructPlanException Task))) :*: S1 ('MetaSel ('Just "wInstall") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map Text InstallLocation))) :*: (S1 ('MetaSel ('Just "wDirty") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map PackageName Text)) :*: (S1 ('MetaSel ('Just "wWarnings") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ([StyleDoc] -> [StyleDoc])) :*: S1 ('MetaSel ('Just "wParents") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ParentMap)))))

data AddDepRes

Type representing results of addDep.

Constructors

ADRToInstall Task

A task must be performed to provide the package name.

ADRFound InstallLocation Installed

An existing installation provides the package name.

Instances

Show AddDepRes

Defined in Stack.Types.Build.ConstructPlan

Methods

showsPrec :: Int -> AddDepRes -> ShowS

show :: AddDepRes -> String

showList :: [AddDepRes] -> ShowS

toTask :: AddDepRes -> Maybe Task

adrVersion :: AddDepRes -> Version

adrHasLibrary :: AddDepRes -> Bool

data Ctx

Type representing values used as the environment to be read from during the construction of a build plan (the 'context').

Constructors

Ctx

Fields

• baseConfigOpts :: !BaseConfigOpts

  Basic information used to determine configure options

• loadPackage :: !(PackageLocationImmutable -> Map FlagName Bool -> [Text] -> [Text] -> M Package)
• combinedMap :: !CombinedMap

  A dictionary of package names, and combined information about the package in respect of whether or not it is already installed and, unless the package is not to be built (global packages), where its source code is located.

• ctxEnvConfig :: !EnvConfig

  Configuration after the environment has been setup.

• callStack :: ![PackageName]
• wanted :: !(Set PackageName)
• localNames :: !(Set PackageName)
• curator :: !(Maybe Curator)
• pathEnvVar :: !Text

Instances

HasPantryConfig Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

pantryConfigL :: Lens' Ctx PantryConfig

HasLogFunc Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

logFuncL :: Lens' Ctx LogFunc

HasProcessContext Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

processContextL :: Lens' Ctx ProcessContext

HasTerm Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

useColorL :: Lens' Ctx Bool

termWidthL :: Lens' Ctx Int

HasStylesUpdate Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

stylesUpdateL :: Lens' Ctx StylesUpdate

HasBuildConfig Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

buildConfigL :: Lens' Ctx BuildConfig

HasCompiler Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

compilerPathsL :: SimpleGetter Ctx CompilerPaths

HasConfig Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

configL :: Lens' Ctx Config

HasEnvConfig Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

envConfigL :: Lens' Ctx EnvConfig

HasSourceMap Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

sourceMapL :: Lens' Ctx SourceMap

HasGHCVariant Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

ghcVariantL :: SimpleGetter Ctx GHCVariant

HasPlatform Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

platformL :: Lens' Ctx Platform

platformVariantL :: Lens' Ctx PlatformVariant

HasRunner Ctx

Defined in Stack.Types.Build.ConstructPlan

Methods

runnerL :: Lens' Ctx Runner

data UnregisterState

State to be maintained during the calculation of local packages to unregister.

Constructors

UnregisterState

Fields

• toUnregister :: !(Map GhcPkgId (PackageIdentifier, Text))
• toKeep :: ![DumpPackage]
• anyAdded :: !Bool

data ToolWarning

Warn about tools in the snapshot definition. States the tool name expected and the package name using it.

Constructors

ToolWarning ExeName PackageName

Instances

Show ToolWarning

Defined in Stack.Types.Build.ConstructPlan

Methods

showsPrec :: Int -> ToolWarning -> ShowS

show :: ToolWarning -> String

showList :: [ToolWarning] -> ShowS