BuildEnv.Utils

Various utilities:

• Spawning of processes in particular environments; see callProcessInIO.
• Semaphores.

Call a process in a given environment

data ProgPath from

The path of a program to run.

Constructors

AbsPath

An absolute path, or an executable in PATH.

Fields

• absProgPath :: !(AbsolutePath File)

RelPath

A relative path, relative to the from abstract location.

Fields

• relProgPath :: !(SymbolicPath from File)

data CallProcess dir

Arguments to callProcess.

Constructors

CP

Fields

• cwd :: !(SymbolicPath CWD (Dir dir))

  Working directory.

• extraPATH :: ![FilePath]

  Absolute filepaths to add to PATH.

• extraEnvVars :: ![(String, String)]

  Extra environment variables to add before running the command.

• prog :: !(ProgPath dir)

  The program to run.

  If it's a relative path, it should be relative to the cwd field.

• args :: !Args

  Arguments to the program.

• logBasePath :: !(Maybe (AbsolutePath File))

  Log stdout to basePath.stdout and stderr to basePath.stderr.

• sem :: !AbstractSem

  Lock to take when calling the process and waiting for it to return, to avoid contention in concurrent situations.

callProcessInIO

Arguments

:: HasCallStack

=> Maybe Counter

Optional counter. Used when the command fails, to report the progress that has been made so far.

-> CallProcess dir

-> IO ()

Run a command and wait for it to complete.

Crashes if the process returns with non-zero exit code.

See CallProcess for a description of the options.

Create 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

withTempDir

Arguments

:: TempDirPermanence

whether to delete the temporary directory after the action completes

-> String

directory name template

-> (AbsolutePath (Dir Tmp) -> IO a)

action to perform

-> IO a

Perform an action with a fresh temporary directory.

Abstract semaphores

newtype AbstractSem

Abstract acquire/release mechanism.

Constructors

AbstractSem

Fields

• withAbstractSem :: forall r. IO r -> IO r

withNewAbstractSem

Arguments

:: AsyncSem

-> (AbstractSem -> Args -> IO r)

the abstract semaphore to use, and extra arguments to pass to Setup configure for ghc

-> IO r

Create a semaphore-based acquire/release mechanism.

noSem :: AbstractSem

No acquire/release mechanism required.

abstractQSem :: QSem -> AbstractSem

Abstract acquire/release mechanism controlled by the given QSem.

Other utilities

splitOn :: Char -> String -> [String]

Utility list splitOn function.