Cake.Core

Patterns and rules.

type Rule = P (Act ())

Rules map names of files to actions building them.

type P = Parser Char

(==>) :: P x -> (x -> Act a) -> Rule

Primitve for rule construction. The given action must produce files matched by the pattern.

High-level interface

data Act a

Instances

Monad Act

Functor Act

Applicative Act

MonadIO Act

MonadError Failure Act

cake :: Rule -> Act () -> IO ()

Run an action in the context of a set of rules.

need :: FilePath -> Act ()

Try to build a file using known rules; then mark it as used.

needs :: [FilePath] -> Act ()

list :: FilePath -> [Char] -> Act [String]

List directory contents by extension

Mid-level interface

produce :: FilePath -> Act () -> Act ()

produces :: [FilePath] -> Act () -> Act ()

Produce a file, using the given action.

cut :: Act () -> Act ()

Run the action in only in a clobbered state

independently :: [Act a] -> Act ()

Low-level interface

debug :: String -> Act ()

distill :: Question -> Act Answer -> Act Answer

Answer a question using the action given. The action is encapsulated by the answer. That is, clobbering done by the action will be hidden if the answer to the question turns out the same as in a previous run.

fileStamp :: FilePath -> Act Answer

Return a stamp (hash) for a file

shielded :: Act a -> Act a

Run the argument in a clean context, and do not clobber the state even if the argument does that. To use when the construction of the argument actually does not depend on the previous questions asked, and the constructed thing is "atomic" for the environment.

use :: FilePath -> Act Answer

Mark that a file is used. Do not chase dependencies on this file though. (To be used eg. if a command uses an optional file).

updates :: [FilePath] -> Act () -> Act ()

Produce a file, using with the given action. BUT: no problem to produce the same file multiple times.

data Question

Constructors

FileContents FilePath

Listing FilePath String

Custom [String]

Instances

Eq Question

Ord Question

Show Question

Binary Question

data Answer

Constructors

Stamp (Maybe MD5Digest)

Text [String]

Failed Failure

Instances

Eq Answer

Show Answer

Binary Answer

data Failure

Constructors

CakeError String

Panic

ProcessError ExitCode

Instances

Eq Failure

Show Failure

Binary Failure

Error Failure

MonadError Failure Act

Re-exports

module Control.Applicative

throwError :: MonadError e m => forall a. e -> m a

Is used within a monadic computation to begin exception processing.