Safe Haskell	Safe-Inferred
Language	Haskell98

Development.Cake3.Types

Synopsis

Documentation

data Variable Source

The representation of Makefile variable.

Constructors

Variable
Fields vname :: String The name of a variable vval :: Maybe String Nothing means that variable is defined elsewhere (eg. borrowed from the environment)

Instances

Eq Variable
Data Variable
Ord Variable
Show Variable
Typeable * Variable
MonadAction a m => RefInput a m Variable

data Tool Source

The representation a tool used by the Makefile's recipe. Typical example are gcc or bison

Constructors

Tool
Fields tname :: String Name of tool.

Instances

Eq Tool
Data Tool
Ord Tool
Show Tool
Typeable * Tool
MonadAction a m => RefInput a m Tool

type Command = [CommandPiece] Source

Command represents OS command line and consists of a list of fragments. Each fragment is either text (may contain spaces) or FilePath (spaces should be escaped)

data CommandPiece Source

Constructors

CmdStr String
CmdFile File

Instances

Eq CommandPiece
Data CommandPiece
Ord CommandPiece
Show CommandPiece
Typeable * CommandPiece

return_text :: Monad m => String -> m [CommandPiece] Source

return_file :: Monad m => File -> m [CommandPiece] Source

data Flag Source

Constructors

Phony
Intermediate

Instances

Eq Flag
Data Flag
Ord Flag
Show Flag
Typeable * Flag

data Recipe Source

Recipe answers to the question 'How to build the targets'. Internally, it contains sets of targets and prerequisites, as well as shell commands required to build former from latter

Constructors

Recipe

Fields

rtgt :: Set File: Targets
rsrc :: Set File: Prerequisites
rcmd :: [Command]: A list of shell commands
rvars :: Set Variable: A set of variables employed in the recipe. The target Makefile should notice changes in those variables and rebuild the targets
rtools :: Set Tool: A set of tools employed in the recipe. Make
rloc :: String: Location (probably, doesn't function)
rflags :: Set Flag: Set of flags (Makefile-specific)

Instances

Eq Recipe
Data Recipe
Ord Recipe
Show Recipe
Typeable * Recipe
MonadAction a m => RefInput a m Recipe
(MonadAction a m, MonadMake a) => RefInput a m (Make Recipe)
Monad m => MonadState Recipe (A' m)

emptyRecipe :: String -> Recipe Source

addPrerequisites :: Set File -> Recipe -> Recipe Source

addPrerequisite :: File -> Recipe -> Recipe Source

type Target = Set File Source

groupSet :: (Ord k, Ord x, Foldable t) => (x -> Set k) -> t x -> Map k (Set x) Source

groupRecipes :: Foldable t => t Recipe -> Map File (Set Recipe) Source

flattern :: [Set x] -> [x] Source

applyPlacement' :: Eq x => [File] -> Map File x -> [x] Source

filterRecipesByTools :: Foldable t => [Tool] -> t Recipe -> Set Recipe Source

filterRecipesByTargets :: (Foldable t, Foldable t2) => t2 File -> t Recipe -> Set Recipe Source

filterRecipesByToolsDeep :: [Tool] -> Set Recipe -> Set Recipe Source

applyPlacement :: Foldable t => [File] -> t Recipe -> [Recipe] Source

transformRecipes :: Applicative m => (Recipe -> m (Set Recipe)) -> Set Recipe -> m (Set Recipe) Source

transformRecipesM_ :: (Monad m, Foldable t) => (Recipe -> m ()) -> t Recipe -> m () Source

queryVariables :: Foldable t => t Recipe -> Set Variable Source

queryVariablesE :: Foldable t => t Recipe -> Either String (Set Variable) Source

queryTargets :: Foldable t => t Recipe -> Set File Source

queryPrereq :: Foldable t => t Recipe -> Set File Source

var :: String -> Maybe String -> Variable Source

intermediateFiles :: Foldable t => t Recipe -> Set File Source

tool :: String -> Tool Source

makevar Source

Arguments

:: String	Variable name
-> String	Default value
-> Variable

Define the Makefile-level variable. Rules, referring to a variable, notice it's changes.

extvar :: String -> Variable Source

Declare the variable defined elsewhere. Typycally, environment variables may be decalred with this functions. Variables are tracked by the cake3. Rules, referring to a variable, notice it's changes.

make :: Variable Source

Reref to special variable $(MAKE)