Safe Haskell	Safe-Inferred
Language	Haskell2010

BuildEnv.Config

Contents

Build strategy
Passing arguments
ghc and cabal-install executables
Directory structure
- Handling of temporary directories
Logging verbosity
Reporting progress
OS specifics

Description

Configuration options for build-env

Synopsis

data BuildStrategy
- = Execute RunStrategy
- | Script {
  - scriptPath :: !FilePath
  - useVariables :: !Bool
  }
data RunStrategy
- = TopoSort
- | Async AsyncSem
data AsyncSem
- = NoSem
- | NewQSem !Word16
semDescription :: AsyncSem -> Text
type Args = [String]
data UnitArgs = UnitArgs {
- configureArgs :: !Args
- mbHaddockArgs :: !(Maybe Args)
- registerArgs :: !Args
}
data Compiler = Compiler {
- ghcPath :: !FilePath
- ghcPkgPath :: !FilePath
}
data Cabal = Cabal {
- cabalPath :: !FilePath
- globalCabalArgs :: !Args
}
data Paths use = Paths {
- fetchDir :: !FilePath
- buildPaths :: BuildPaths use
}
data family BuildPaths use
data PathUsability
- = Raw
- | ForPrep
- | ForBuild
canonicalizePaths :: Compiler -> BuildStrategy -> Paths Raw -> IO (Paths ForPrep, Paths ForBuild)
data TempDirPermanence
- = DeleteTempDirs
- | Don'tDeleteTempDirs
newtype Verbosity where
- Verbosity Int
- pattern Quiet :: Verbosity
- pattern Normal :: Verbosity
- pattern Verbose :: Verbosity
- pattern Debug :: 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
data Counter = Counter {
- counterRef :: !(IORef Word)
- counterMax :: !Word
}
data Style
- = PosixStyle
- | WinStyle
hostStyle :: Style
pATHSeparator :: Style -> String

Build strategy

data BuildStrategy Source #

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 :: !FilePath 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

Instances details

Show BuildStrategy Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> BuildStrategy -> ShowS # show :: BuildStrategy -> String # showList :: [BuildStrategy] -> ShowS #

data RunStrategy Source #

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

Instances details

Show RunStrategy Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> RunStrategy -> ShowS # show :: RunStrategy -> String # showList :: [RunStrategy] -> ShowS #

data AsyncSem Source #

What kind of semaphore to use in buildPlan?

NB: this datatype depends on whether the jsem flag was enabled when building the build-env package.

Constructors

NoSem	Don't use any semaphore (not recommended).
NewQSem !Word16	Create a new `QSem` semaphore with the given number of tokens.

Instances

Instances details

Show AsyncSem Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> AsyncSem -> ShowS # show :: AsyncSem -> String # showList :: [AsyncSem] -> ShowS #

semDescription :: AsyncSem -> Text Source #

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

Passing arguments

type Args = [String] Source #

A type synonym for command-line arguments.

data UnitArgs Source #

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

Instances details

Show UnitArgs Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> UnitArgs -> ShowS # show :: UnitArgs -> String # showList :: [UnitArgs] -> ShowS #

`ghc` and `cabal-install` executables

data Compiler Source #

Paths to the ghc and ghc-pkg executables.

Constructors

Compiler
Fields ghcPath :: !FilePath ghcPkgPath :: !FilePath

Instances

Instances details

Show Compiler Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> Compiler -> ShowS # show :: Compiler -> String # showList :: [Compiler] -> ShowS #

data Cabal Source #

Path to the cabal-install executable.

Constructors

Cabal
Fields cabalPath :: !FilePath globalCabalArgs :: !Args Arguments to pass to all `cabal` invocations, before any `cabal` command.

Instances

Instances details

Show Cabal Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> Cabal -> ShowS # show :: Cabal -> String # showList :: [Cabal] -> ShowS #

Directory structure

data Paths use Source #

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

Constructors

Paths
Fields fetchDir :: !FilePath 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.

data family BuildPaths use Source #

The directory structure relevant to executing a build plan.

Instances

Instances details

data BuildPaths 'ForBuild Source #
Instance details Defined in BuildEnv.Config data BuildPaths 'ForBuild = BuildPaths { compiler :: !Compiler destDir :: !FilePath prefix :: !FilePath installDir :: !FilePath logDir :: !FilePath }
data BuildPaths 'ForPrep Source #
Instance details Defined in BuildEnv.Config data BuildPaths 'ForPrep = BuildPathsForPrep { compilerForPrep :: !Compiler installDir :: !FilePath }
data BuildPaths 'Raw Source #
Instance details Defined in BuildEnv.Config data BuildPaths 'Raw = RawBuildPaths { rawDestDir :: !FilePath rawPrefix :: !FilePath }

data PathUsability Source #

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 -> Paths Raw -> IO (Paths ForPrep, Paths ForBuild) Source #

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

Handling of temporary directories

data TempDirPermanence Source #

How to handle deletion of temporary directories.

Constructors

DeleteTempDirs
Don'tDeleteTempDirs

Instances

Instances details

Show TempDirPermanence Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> TempDirPermanence -> ShowS # show :: TempDirPermanence -> String # showList :: [TempDirPermanence] -> ShowS #

Logging verbosity

newtype Verbosity Source #

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

Instances details

Num Verbosity Source #
Instance details 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 Source #
Instance details Defined in BuildEnv.Config Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #
Eq Verbosity Source #
Instance details Defined in BuildEnv.Config Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Instance details 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 #