Development.Cake3.Monad

Documentation

type Location = String

data MakeState

MakeState describes the state of the EDSL synthesizers during the the program execution.

Constructors

MS

Fields

• prebuilds :: Recipe

  Prebuild commands. targets/prerequsites of the recipe are ignored, commands are executed before any target

• postbuilds :: Recipe

  Postbuild commands.

• prebuildsS :: Set Command

  Prebuild commands stored in a Set. Reactive-style-friendly.

• postbuildsS :: Set Command

  Postbuild commands stored in a Set. Reactive-style-friendly.

• recipes :: Set Recipe

  The set of recipes, to be checked and renderd as a Makefile

• sloc :: Location

  Current location. FIXME: fix or remove

• makeDeps :: Set File

  Set of files which the Makefile depends on

• placement :: [File]

  Placement list is the order of targets to be placed in the output file

• includes :: Set File

  Set of files to include in the output file (Makefile specific thing)

• errors :: String

  Errors found so far

• warnings :: String

  Warnings found so far

• outputFile :: File

  Name of the Makefile being generated , tmpIndex :: Int ^ Index to build temp names

• extraClean :: Set File

  extra clean files

Instances

Monad m => MonadState MakeState (Make' m)

Methods

get :: Make' m MakeState

put :: MakeState -> Make' m ()

state :: (MakeState -> (a, MakeState)) -> Make' m a

initialMakeState :: File -> MakeState

defr :: Recipe

getPlacementPos :: Make Int

addPlacement :: Int -> File -> Make ()

addMakeDep :: File -> Make ()

tmp_file :: String -> File

prebuild :: MonadMake m => CommandGen -> m ()

Add prebuild command

postbuild :: MonadMake m => CommandGen -> m ()

Add postbuild command

prebuildS :: MonadMake m => CommandGen -> m ()

postbuildS :: MonadMake m => CommandGen -> m ()

checkForEmptyTarget :: Foldable f => f Recipe -> String

Find recipes without targets. Empty result means 'No errors'

checkForTargetConflicts :: Foldable f => f Recipe -> String

Find recipes sharing a target. Empty result means 'No errors'

class Monad m => MonadMake m where

A Monad providing access to MakeState. TODO: not mention IO here.

Minimal complete definition

liftMake

Methods

liftMake :: Make' IO a -> m a

Instances

MonadMake m => MonadMake (A' m)

Methods

liftMake :: Make' IO a -> A' m a

MonadMake (Make' IO)

Methods

liftMake :: Make' IO a -> Make' IO a

MonadMake m => MonadMake (UrpGen m)

Methods

liftMake :: Make' IO a -> UrpGen m a

MonadMake m => MonadMake (StateT s m)

Methods

liftMake :: Make' IO a -> StateT s m a

newtype Make' m a

Constructors

Make

Fields

• unMake :: StateT MakeState m a

Instances

Monad m => MonadState MakeState (Make' m)

Methods

get :: Make' m MakeState

put :: MakeState -> Make' m ()

state :: (MakeState -> (a, MakeState)) -> Make' m a

(RefInput a x, MonadMake a) => RefInput a (Make x)

Methods

refInput :: Make x -> a Command

Monad m => Monad (Make' m)

Methods

(>>=) :: Make' m a -> (a -> Make' m b) -> Make' m b

(>>) :: Make' m a -> Make' m b -> Make' m b

return :: a -> Make' m a

fail :: String -> Make' m a

Functor m => Functor (Make' m)

Methods

fmap :: (a -> b) -> Make' m a -> Make' m b

(<$) :: a -> Make' m b -> Make' m a

MonadFix m => MonadFix (Make' m)

Methods

mfix :: (a -> Make' m a) -> Make' m a

Monad m => Applicative (Make' m)

Methods

pure :: a -> Make' m a

(<*>) :: Make' m (a -> b) -> Make' m a -> Make' m b

(*>) :: Make' m a -> Make' m b -> Make' m b

(<*) :: Make' m a -> Make' m b -> Make' m a

MonadIO m => MonadIO (Make' m)

Methods

liftIO :: IO a -> Make' m a

Monad m => MonadLoc (Make' m)

Methods

withLoc :: String -> Make' m a -> Make' m a

MonadMake (Make' IO)

Methods

liftMake :: Make' IO a -> Make' IO a

EmbedDecl x => EmbedDecl (Make x)

Methods

embed :: MonadMake m => Make x -> UrpGen m ()

SrcDecl x => SrcDecl (Make x)

Methods

src :: MonadMake m => Make x -> UrpGen m ()

LinkDecl x => LinkDecl (Make' IO x)

Methods

link :: MonadMake m => Make' IO x -> UrpGen m ()

type Make a = Make' IO a

evalMake :: Monad m => File -> Make' m a -> m MakeState

Evaluate the Make monad mf, return MakeState containing the result. Name mf is used for self-referencing recipes.

modifyLoc :: MonadState MakeState m => (Location -> Location) -> m ()

addRecipe :: Recipe -> Make ()

getLoc :: Make String

includeMakefile :: Foldable t => t File -> Make ()

Add 'include ...' directive to the final Makefile for each input file.

newtype A' m a

A here stands for Action. It is a State monad carrying a Recipe as its state. Various monadic actions add targets, prerequisites and shell commands to this recipe. After that, rule function records it to the MakeState. After the recording, no modification is allowed for this recipe.

Constructors

A'

Fields

• unA' :: StateT Recipe m a

Instances

Monad m => MonadState Recipe (A' m)

Methods

get :: A' m Recipe

put :: Recipe -> A' m ()

state :: (Recipe -> (a, Recipe)) -> A' m a

Monad m => Monad (A' m)

Methods

(>>=) :: A' m a -> (a -> A' m b) -> A' m b

(>>) :: A' m a -> A' m b -> A' m b

return :: a -> A' m a

fail :: String -> A' m a

Functor m => Functor (A' m)

Methods

fmap :: (a -> b) -> A' m a -> A' m b

(<$) :: a -> A' m b -> A' m a

MonadFix m => MonadFix (A' m)

Methods

mfix :: (a -> A' m a) -> A' m a

Monad m => Applicative (A' m)

Methods

pure :: a -> A' m a

(<*>) :: A' m (a -> b) -> A' m a -> A' m b

(*>) :: A' m a -> A' m b -> A' m b

(<*) :: A' m a -> A' m b -> A' m a

MonadIO m => MonadIO (A' m)

Methods

liftIO :: IO a -> A' m a

MonadMake m => MonadMake (A' m)

Methods

liftMake :: Make' IO a -> A' m a

Monad m => RefInput (A' m) CakeString

Methods

refInput :: CakeString -> A' m Command

Monad m => RefInput (A' m) Tool

Methods

refInput :: Tool -> A' m Command

Monad m => RefInput (A' m) Variable

Methods

refInput :: Variable -> A' m Command

Monad m => RefInput (A' m) Recipe

Methods

refInput :: Recipe -> A' m Command

Monad m => RefInput (A' m) File

Methods

refInput :: File -> A' m Command

Monad m => RefInput (A' m) UWExe

Methods

refInput :: UWExe -> A' m Command

Monad m => RefInput (A' m) UWLib

Methods

refInput :: UWLib -> A' m Command

Monad m => RefInput (A' m) (CommandGen' m)

Methods

refInput :: CommandGen' m -> A' m Command

type A a = A' (Make' IO) a

Verison of Action monad with fixed parents

runA' :: Monad m => Recipe -> A' m a -> m (Recipe, a)

A class of monads providing access to the underlying A monad. It tells Haskell how to do a convertion: given a . (A' m) -> a class (Monad m, Monad a) => MonadAction a m | a -> m where liftAction :: A' m x -> a x

Fill recipe r using the action act by running the action monad

runA

Arguments

:: Monad m

=> String

Location string (in the Cakefile.hs)

-> A' m a

Recipe builder

-> m (Recipe, a)

Create an empty recipe, fill it using action @act

runA_ :: Monad m => String -> A' m a -> m Recipe

Version of runA discarding the result of computation

targets :: (Applicative m, Monad m) => A' m (Set File)

Get a list of targets added so far

prerequisites :: (Applicative m, Monad m) => A' m (Set File)

Get a list of prerequisites added so far

markPhony :: Monad m => A' m ()

Mark the recipe as PHONY i.e. claim that all it's targets are not real files. Makefile-specific.

phony

Arguments

:: Monad m

=> String

A name of phony target

-> A' m ()

Adds the phony target for a rule. Typical usage:

rule $ do
 phony "clean"
 unsafeShell [cmd|rm $elf $os $d|]

markIntermediate :: Monad m => A' m ()

Mark the recipe as INTERMEDIATE i.e. claim that all it's targets may be removed after the build process. Makefile-specific.

readFileForMake

Arguments

:: MonadMake m

=> File

File to read contents of

-> m ByteString

Obtain the contents of a File. Note, that this generally means, that Makefile should be regenerated each time the File is changed.

newtype CommandGen' m

CommandGen is a recipe-builder packed in the newtype to prevent partial expansion of it's commands

Constructors

CommandGen'

Fields

• unCommand :: A' m Command

Instances

Monad m => RefInput (A' m) (CommandGen' m)

Methods

refInput :: CommandGen' m -> A' m Command

type CommandGen = CommandGen' (Make' IO)

commandGen :: A Command -> CommandGen

Pack the command builder into a CommandGen

ignoreDepends :: Monad m => A' m a -> A' m a

Modifie the recipe builder: ignore all the dependencies

shell

Arguments

:: Monad m

=> CommandGen' m

Command builder as returned by cmd quasi-quoter

-> A' m [File]

Apply the recipe builder to the current recipe state. Return the list of targets of the current Recipe under construction

shell1 :: Monad m => CommandGen' m -> A' m File

Version of @shell returning a single file

unsafeShell :: Monad m => CommandGen' m -> A' m [File]

Version of shell which doesn't track it's dependencies

newtype CakeString

Simple wrapper for strings, a target for various typeclass instances.

Constructors

CakeString String

Instances

Eq CakeString

Methods

(==) :: CakeString -> CakeString -> Bool

(/=) :: CakeString -> CakeString -> Bool

Ord CakeString

Methods

compare :: CakeString -> CakeString -> Ordering

(<) :: CakeString -> CakeString -> Bool

(<=) :: CakeString -> CakeString -> Bool

(>) :: CakeString -> CakeString -> Bool

(>=) :: CakeString -> CakeString -> Bool

max :: CakeString -> CakeString -> CakeString

min :: CakeString -> CakeString -> CakeString

Show CakeString

Methods

showsPrec :: Int -> CakeString -> ShowS

show :: CakeString -> String

showList :: [CakeString] -> ShowS

Monad m => RefInput (A' m) CakeString

Methods

refInput :: CakeString -> A' m Command

string :: String -> CakeString

An alias to CakeString constructor

class Monad m => RefOutput m x where

Class of things which may be referenced using '@(expr)' syntax of the quasi-quoted shell expressions.

Minimal complete definition

refOutput

Methods

refOutput :: x -> A' m Command

Instances

Monad m => RefOutput m File

Methods

refOutput :: File -> A' m Command

RefOutput m File => RefOutput m (m File)

Methods

refOutput :: m File -> A' m Command

RefOutput m x => RefOutput m (Maybe x)

Methods

refOutput :: Maybe x -> A' m Command

Monad m => RefOutput m (Set File)

Methods

refOutput :: Set File -> A' m Command

Monad m => RefOutput m [File]

Methods

refOutput :: [File] -> A' m Command

inbetween :: (Foldable t, Monad m) => a -> m (t [a]) -> m [a]

spacify :: (Monad m, Foldable t) => m (t [CommandPiece]) -> m [CommandPiece]

class Monad a => RefInput a x where

Class of things which may be referenced using '$(expr)' syntax of the quasy-quoted shell expressions

Minimal complete definition

refInput

Methods

refInput :: x -> a Command

Register the input item, return it's shell-script representation

Instances

RefInput a x => RefInput a (Maybe x)

Methods

refInput :: Maybe x -> a Command

(MonadIO a, RefInput a x) => RefInput a (IO x)

Methods

refInput :: IO x -> a Command

RefInput a x => RefInput a (Set x)

Methods

refInput :: Set x -> a Command

RefInput a x => RefInput a [x]

Methods

refInput :: [x] -> a Command

(RefInput a x, MonadMake a) => RefInput a (Make x)

Methods

refInput :: Make x -> a Command

Monad m => RefInput (A' m) CakeString

Methods

refInput :: CakeString -> A' m Command

Monad m => RefInput (A' m) Tool

Methods

refInput :: Tool -> A' m Command

Monad m => RefInput (A' m) Variable

Methods

refInput :: Variable -> A' m Command

Monad m => RefInput (A' m) Recipe

Methods

refInput :: Recipe -> A' m Command

Monad m => RefInput (A' m) File

Methods

refInput :: File -> A' m Command

Monad m => RefInput (A' m) UWExe

Methods

refInput :: UWExe -> A' m Command

Monad m => RefInput (A' m) UWLib

Methods

refInput :: UWLib -> A' m Command

Monad m => RefInput (UrpGen m) File

Methods

refInput :: File -> UrpGen m Command

Monad m => RefInput (A' m) (CommandGen' m)

Methods

refInput :: CommandGen' m -> A' m Command

depend

Arguments

:: RefInput a x

=> x

File or [File] or (Set File) or other form of dependency.

-> a ()

Add it's argument to the list of dependencies (prerequsites) of a current recipe under construction

produce

Arguments

:: RefOutput m x

=> x

File or [File] or other form of target.

-> A' m ()

Declare that current recipe produces item x.

variables

Arguments

:: (Foldable t, Monad m)

=> t Variable

A set of variables to depend the recipe on

-> A' m ()

Add variables vs to tracking list of the current recipe

tools

Arguments

:: (Foldable t, Monad m)

=> t Tool

A set of tools used by this recipe

-> A' m ()

Add tools ts to the tracking list of the current recipe

commands :: Monad m => [Command] -> A' m ()

Add commands to the list of commands of a current recipe under construction. Warning: this function behaves like unsafeShell i.e. it doesn't analyze the command text

location :: Monad m => String -> A' m ()

Set the recipe's location in the Cakefile.hs

flags :: Monad m => Set Flag -> A' m ()

Set additional flags

cmd :: QuasiQuoter

Has effect of a function QQ -> CommandGen where QQ is a string supporting the following syntax:

• $(expr) evaluates to expr and adds it to the list of dependencies (prerequsites)
• @(expr) evaluates to expr and adds it to the list of targets
• $$ and @@ evaluates to $ and @

Example

[cmd|gcc $flags -o @file|]

is equivalent to

  return $ CommandGen $ do
    s1 <- refInput "gcc "
    s2 <- refInput (flags :: Variable)
    s3 <- refInput " -o "
    s4 <- refOutput (file :: File)
    return (s1 ++ s2 ++ s3 ++ s4)

Later, this command may be examined or passed to the shell function to apply it to the recipe