BuildBox.Build

Defines the main Build monad and common utils.

Documentation

module BuildBox.Build.Testable

data BuildState

Global builder configuration.

Constructors

BuildState

Fields

• buildStateLogSystem :: Maybe Handle

  Log all system commands executed to this file handle.

• buildStateSeq :: Integer

  Sequence number for generating fresh file names.

• buildStateScratchDir :: FilePath

  Scratch directory for making temp files.

buildStateDefault :: FilePath -> BuildState

The default build config.

type Build a = StateT BuildState IO a

The builder monad encapsulates and IO action that can fail with an error, and also read some global configuration info.

Building

runBuild :: FilePath -> Build a -> IO (Either BuildError a)

Run a build command. The first argument is a directory that can be used for temporary files (like "/tmp")

runBuildWithState :: BuildState -> Build a -> IO (Maybe a)

Like runBuild but also takes a BuildState.

runBuildPrint :: FilePath -> Build a -> IO (Maybe a)

Like runBuild, but report whether it succeeded to the console. If it succeeded then return Just the result, else Nothing.

runBuildPrintWithState :: BuildState -> Build a -> IO (Maybe a)

Like runBuildPrint but also takes a BuildState.

successfully :: IO a -> IO ()

Discard the resulting value of a compuation. Used like successfully . runBuild ...

Errors

data BuildError

The errors we recognise.

Constructors

ErrorOther String

Some generic error

ErrorSystemCmdFailed

Some system command fell over, and it barfed out the given stdout and stderr.

Fields

• buildErrorCmd :: String
• buildErrorCode :: ExitCode
• buildErrorStdout :: Log
• buildErrorStderr :: Log

ErrorIOError IOError

Some miscellanous IO action failed.

Show prop => ErrorCheckFailed Bool prop

Some property check was supposed to return the given boolean value, but it didn't.

ErrorNeeds FilePath

A build command needs the following file to continue. This can be used for writing make-like bots.

Instances

Show BuildError

Methods

showsPrec :: Int -> BuildError -> ShowS

show :: BuildError -> String

showList :: [BuildError] -> ShowS

Exception BuildError

Methods

toException :: BuildError -> SomeException

fromException :: SomeException -> Maybe BuildError

displayException :: BuildError -> String

Pretty BuildError

Methods

ppr :: BuildError -> Doc

throw :: (MonadThrow m, Exception e) => e -> m a

Alias for throwM from Control.Monad.Catch.

catch :: MonadCatch m => forall e a. Exception e => m a -> (e -> m a) -> m a

Provide a handler for exceptions thrown during execution of the first action. Note that type of the type of the argument to the handler will constrain which exceptions are caught. See Control.Exception's catch.

needs :: FilePath -> Build ()

Throw a needs error saying we needs the given file. A catcher could then usefully create the file, or defer the compuation until it has been created.

Utils

io :: IO a -> Build a

Lift an IO action into the build monad. If the action throws any exceptions they get caught and turned into ErrorIOError exceptions in our Build monad.

whenM :: Monad m => m Bool -> m () -> m ()

Like when, but with teh monadz.

Output

out :: Pretty a => a -> Build ()

Print some text to stdout.

outLn :: Pretty a => a -> Build ()

Print some text to stdout followed by a newline.

outBlank :: Build ()

Print a blank line to stdout

outLine :: Build ()

Print a ----- line to stdout

outLINE :: Build ()

Print a ===== line to stdout

logSystem :: String -> Build ()

Log a system command to the handle in our BuildConfig, if any.