Stack.Build.ExecuteEnv

Provides all the necessary types and functions for running cabal Setup.hs commands. Only used in the Execute and ExecutePackage modules

Documentation

data ExecuteEnv

Constructors

ExecuteEnv

Fields

• installLock :: !(MVar ())
• buildOpts :: !BuildOpts
• buildOptsCLI :: !BuildOptsCLI
• baseConfigOpts :: !BaseConfigOpts
• ghcPkgIds :: !(TVar (Map PackageIdentifier Installed))
• tempDir :: !(Path Abs Dir)
• setupHs :: !(Path Abs File)

  Temporary Setup.hs for simple builds

• setupShimHs :: !(Path Abs File)

  Temporary SetupShim.hs, to provide access to initial-build-steps

• setupExe :: !(Maybe (Path Abs File))

  Compiled version of eeSetupHs

• cabalPkgVer :: !Version
• totalWanted :: !Int
• locals :: ![LocalPackage]
• globalDB :: !(Path Abs Dir)
• globalDumpPkgs :: !(Map GhcPkgId DumpPackage)
• snapshotDumpPkgs :: !(TVar (Map GhcPkgId DumpPackage))
• localDumpPkgs :: !(TVar (Map GhcPkgId DumpPackage))
• logFiles :: !(TChan (Path Abs Dir, Path Abs File))
• customBuilt :: !(IORef (Set PackageName))

  Stores which packages with custom-setup have already had their Setup.hs built.

• largestPackageName :: !(Maybe Int)

  For nicer interleaved output: track the largest package name size

• pathEnvVar :: !Text

  Value of the PATH environment variable

withExecuteEnv

Arguments

:: forall env a. HasEnvConfig env

=> BuildOpts

-> BuildOptsCLI

-> BaseConfigOpts

-> [LocalPackage]

-> [DumpPackage]

global packages

-> [DumpPackage]

snapshot packages

-> [DumpPackage]

local packages

-> Maybe Int

largest package name, for nicer interleaved output

-> (ExecuteEnv -> RIO env a)

-> RIO env a

Execute a function that takes an ExecuteEnv.

withSingleContext

Arguments

:: forall env a. HasEnvConfig env

=> ActionContext

-> ExecuteEnv

-> TaskType

-> Map PackageIdentifier GhcPkgId

All dependencies' package ids to provide to Setup.hs.

-> Maybe String

-> (Package -> Path Abs File -> Path Abs Dir -> (KeepOutputOpen -> ExcludeTHLoading -> [String] -> RIO env ()) -> (Utf8Builder -> RIO env ()) -> OutputType -> RIO env a)

-> RIO env a

This sets up a context for executing build steps which need to run Cabal (via a compiled Setup.hs). In particular it does the following:

• Ensures the package exists in the file system, downloading if necessary.
• Opens a log file if the built output shouldn't go to stderr.
• Ensures that either a simple Setup.hs is built, or the package's custom setup is built.
• Provides the user a function with which run the Cabal process.

data ExcludeTHLoading

Constructors

ExcludeTHLoading

KeepTHLoading

data KeepOutputOpen

special marker for expected failures in curator builds, using those we need to keep log handle open as build continues further even after a failure

Constructors

KeepOpen

CloseOnException

Instances

Eq KeepOutputOpen

Defined in Stack.Types.Build

Methods

(==) :: KeepOutputOpen -> KeepOutputOpen -> Bool

(/=) :: KeepOutputOpen -> KeepOutputOpen -> Bool

data ExecutableBuildStatus

Has an executable been built or not?

Constructors

ExecutableBuilt

ExecutableNotBuilt

Instances

Show ExecutableBuildStatus

Defined in Stack.Build.ExecuteEnv

Methods

showsPrec :: Int -> ExecutableBuildStatus -> ShowS

show :: ExecutableBuildStatus -> String

showList :: [ExecutableBuildStatus] -> ShowS

Eq ExecutableBuildStatus

Defined in Stack.Build.ExecuteEnv

Methods

(==) :: ExecutableBuildStatus -> ExecutableBuildStatus -> Bool

(/=) :: ExecutableBuildStatus -> ExecutableBuildStatus -> Bool

Ord ExecutableBuildStatus

Defined in Stack.Build.ExecuteEnv

Methods

compare :: ExecutableBuildStatus -> ExecutableBuildStatus -> Ordering

(<) :: ExecutableBuildStatus -> ExecutableBuildStatus -> Bool

(<=) :: ExecutableBuildStatus -> ExecutableBuildStatus -> Bool

(>) :: ExecutableBuildStatus -> ExecutableBuildStatus -> Bool

(>=) :: ExecutableBuildStatus -> ExecutableBuildStatus -> Bool

max :: ExecutableBuildStatus -> ExecutableBuildStatus -> ExecutableBuildStatus

min :: ExecutableBuildStatus -> ExecutableBuildStatus -> ExecutableBuildStatus

data OutputType

How we deal with output from GHC, either dumping to a log file or the console (with some prefix).

Constructors

OTLogFile !(Path Abs File) !Handle

OTConsole !(Maybe Utf8Builder)