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

High-level interface

data Act a

Instances

Monad Act

Functor Act

Applicative Act

MonadIO Act

MonadError Failure Act

MonadReader Context Act

MonadState State Act

MonadWriter Written 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.

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

List directory contents by extension

Mid-level interface

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

Produce a file, using the given action. The action should be independent of the context.

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

Produce a file, using with the given action. The action should be independent of the context. BUT: no problem to produce the same file multiple times.

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).

overwrote :: FilePath -> Act Answer

File was modified by some command, but in a way that does not invalidate previous computations. (This is probably only useful for latex processing).

Low-level interface

debug :: String -> Act ()

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

Answer a question using the action given. The action must be independent of the context.

fileStamp :: MonadIO m => FilePath -> m Answer

Return a stamp (hash) for a file

cut :: Act () -> Act ()

Run the action in only in a clobbered state

data Question

Constructors

FileContents FilePath

Listing FilePath String

Custom [String]

Instances

Eq Question

Ord Question

Show Question

Binary Question

MonadWriter Written Act

data Answer

Constructors

Stamp (Maybe MD5Digest)

Text [String]

Failed Failure

Instances

Eq Answer

Show Answer

Binary Answer

MonadWriter Written Act

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.