BuildEnv.Config

Configuration options for build-env

Build strategy

data BuildStrategy

Build strategy for buildPlan.

Constructors

Execute RunStrategy

Execute the build plan in-place.

Script

Output a build script that can be run later.

Fields

• scriptPath :: !(SymbolicPath CWD File)

  Output path at which to write the build script.

• useVariables :: !Bool

  Should the output shell script use variables, or baked in paths?

  The shell script will use the following variables:

  • GHC, GHCPKG, SOURCES, PREFIX, DESTDIR.

Instances

Show BuildStrategy

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> BuildStrategy -> ShowS

show :: BuildStrategy -> String

showList :: [BuildStrategy] -> ShowS

data RunStrategy

How to execute a build plan.

Constructors

TopoSort

Topologically sort the cabal build plan, and build the packages in sequence.

Async

Asynchronously build all the packages, with each package waiting on its dependencies.

Fields

• AsyncSem

  The kind of semaphore to use to control concurrency.

Instances

Show RunStrategy

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> RunStrategy -> ShowS

show :: RunStrategy -> String

showList :: [RunStrategy] -> ShowS

data AsyncSem

What kind of semaphore to use in buildPlan?

Constructors

NewQSem !Word16

Create a new QSem semaphore with the given number of tokens.

NewJSem !Word16

Create a new system semaphore with the given number of tokens, passing it to ghc invocations.

ExistingJSem !String

Use an existing system semaphore, passing it to ghc invocations.

Instances

Show AsyncSem

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> AsyncSem -> ShowS

show :: AsyncSem -> String

showList :: [AsyncSem] -> ShowS

semDescription :: AsyncSem -> Text

A description of the kind of semaphore we are using to control concurrency.

Passing arguments

type Args = [String]

A type synonym for command-line arguments.

data UnitArgs

Arguments specific to a unit.

Constructors

UnitArgs

Fields

• configureArgs :: !Args

  Arguments to Setup configure.

• mbHaddockArgs :: !(Maybe Args)

  Arguments to Setup haddock. Nothing means: skip Setup haddock.

• registerArgs :: !Args

  Arguments to ghc-pkg register.

Instances

Show UnitArgs

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> UnitArgs -> ShowS

show :: UnitArgs -> String

showList :: [UnitArgs] -> ShowS

ghc and cabal-install executables

data Compiler

Paths to the ghc and ghc-pkg executables.

Constructors

Compiler

Fields

• ghcPath :: !(AbsolutePath File)
• ghcPkgPath :: !(AbsolutePath File)

Instances

Show Compiler

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> Compiler -> ShowS

show :: Compiler -> String

showList :: [Compiler] -> ShowS

data Cabal

Path to the cabal-install executable.

Constructors

Cabal

Fields

• cabalPath :: !(AbsolutePath File)
• globalCabalArgs :: !Args

  Arguments to pass to all cabal invocations, before any cabal command.

Instances

Show Cabal

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> Cabal -> ShowS

show :: Cabal -> String

showList :: [Cabal] -> ShowS

Hackage index state

newtype IndexState

Hackage index-state specification, e.g. 2022-12-25T00:00:00Z.

Constructors

IndexState Text

Instances

Show IndexState

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> IndexState -> ShowS

show :: IndexState -> String

showList :: [IndexState] -> ShowS

Eq IndexState

Defined in BuildEnv.Config

Methods

(==) :: IndexState -> IndexState -> Bool

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

Directory structure

data Paths use

The directory structure relevant to preparing and carrying out a build plan.

Constructors

Paths

Fields

• fetchDir :: !(SymbolicPath Project (Dir Fetch))

  Input fetched sources directory.

• buildPaths :: BuildPaths use

  Output build directory structure.

  NB: this will be bottom in the case that we are outputing a shell script that uses variables.

Instances

Show (BuildPaths use) => Show (Paths use)

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> Paths use -> ShowS

show :: Paths use -> String

showList :: [Paths use] -> ShowS

data family BuildPaths use

The directory structure relevant to executing a build plan.

Instances

Show (BuildPaths 'ForBuild)

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> BuildPaths 'ForBuild -> ShowS

show :: BuildPaths 'ForBuild -> String

showList :: [BuildPaths 'ForBuild] -> ShowS

Show (BuildPaths 'ForPrep)

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> BuildPaths 'ForPrep -> ShowS

show :: BuildPaths 'ForPrep -> String

showList :: [BuildPaths 'ForPrep] -> ShowS

Show (BuildPaths 'Raw)

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> BuildPaths 'Raw -> ShowS

show :: BuildPaths 'Raw -> String

showList :: [BuildPaths 'Raw] -> ShowS

data BuildPaths 'ForBuild

Defined in BuildEnv.Config

data BuildPaths 'ForBuild = BuildPaths {

• compiler :: !Compiler
• prefix :: !(AbsolutePath ('Dir Prefix))
• installDir :: !(AbsolutePath ('Dir Install))
• logDir :: !(AbsolutePath ('Dir Logs))

}

data BuildPaths 'ForPrep

Defined in BuildEnv.Config

data BuildPaths 'ForPrep = BuildPathsForPrep {

• compilerForPrep :: !Compiler
• installDir :: !(AbsolutePath ('Dir Install))

}

data BuildPaths 'Raw

Defined in BuildEnv.Config

data BuildPaths 'Raw = RawBuildPaths {

• rawDestDir :: !(SymbolicPath Project ('Dir Install))
• rawPrefix :: !(SymbolicPath Project ('Dir Prefix))

}

data PathUsability

The appropriate stage at which to use a filepath.

Constructors

Raw

We have just parsed filepaths. They need to be canonicalised before they can be used.

ForPrep

The filepaths have been canonicalised.

They are now suitable for preparatory build instructions, but not for performing the build.

ForBuild

The paths are suitable for performing the build.

canonicalizePaths :: Compiler -> BuildStrategy -> SymbolicPath CWD (Dir Project) -> Paths Raw -> IO (Paths ForPrep, Paths ForBuild)

Canonicalise raw Paths, computing the appropriate directory structure for preparing and executing a build, respectively.

Handling of temporary directories

data TempDirPermanence

How to handle deletion of temporary directories.

Constructors

DeleteTempDirs

Don'tDeleteTempDirs

Instances

Show TempDirPermanence

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> TempDirPermanence -> ShowS

show :: TempDirPermanence -> String

showList :: [TempDirPermanence] -> ShowS

Logging verbosity

newtype Verbosity

Verbosity level for the build-env package.

The default verbosity level is Normal (1).

Constructors

Verbosity Int

Bundled Patterns

pattern Quiet :: Verbosity

pattern Normal :: Verbosity

pattern Verbose :: Verbosity

pattern Debug :: Verbosity

Instances

Num Verbosity

Defined in BuildEnv.Config

Methods

(+) :: Verbosity -> Verbosity -> Verbosity

(-) :: Verbosity -> Verbosity -> Verbosity

(*) :: Verbosity -> Verbosity -> Verbosity

negate :: Verbosity -> Verbosity

abs :: Verbosity -> Verbosity

signum :: Verbosity -> Verbosity

fromInteger :: Integer -> Verbosity

Show Verbosity

Defined in BuildEnv.Config

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS

Eq Verbosity

Defined in BuildEnv.Config

Methods

(==) :: Verbosity -> Verbosity -> Bool

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

Ord Verbosity

Defined in BuildEnv.Config

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

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

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

quietMsg :: Verbosity -> Text -> IO ()

normalMsg :: Verbosity -> Text -> IO ()

verboseMsg :: Verbosity -> Text -> IO ()

debugMsg :: Verbosity -> Text -> IO ()

ghcVerbosity :: Verbosity -> String

ghcPkgVerbosity :: Verbosity -> String

cabalVerbosity :: Verbosity -> String

setupVerbosity :: Verbosity -> String

Reporting progress

data Counter

A counter to measure progress, as units are compiled.

Constructors

Counter

Fields

• counterRef :: !(IORef Word)

  The running count.

• counterMax :: !Word

  The maximum that we're counting up to.

OS specifics

data Style

Whether to use Posix or Windows style:

• for executables, ./prog vs prog.exe,
• for the path separator, : vs ;.

Constructors

PosixStyle

WinStyle

hostStyle :: Style

The style associated with the OS the program is currently running on.

pATHSeparator :: Style -> String

OS-dependent separator for the PATH environment variable.