Development.Shake.Plus.Core

Documentation

class MonadIO m => MonadAction m where

Monads in which Actions may be embedded.

Methods

liftAction :: Action a -> m a

Instances

MonadAction Action

Defined in Development.Shake.Plus.Core

Methods

liftAction :: Action a -> Action a

MonadAction (RAction r)

Defined in Development.Shake.Plus.Core

Methods

liftAction :: Action a -> RAction r a

MonadAction m => MonadAction (ReaderT r m)

Defined in Development.Shake.Plus.Core

Methods

liftAction :: Action a -> ReaderT r m a

class Monad m => MonadRules m where

Methods

liftRules :: Rules a -> m a

Instances

MonadRules Rules

Defined in Development.Shake.Plus.Core

Methods

liftRules :: Rules a -> Rules a

MonadRules (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

liftRules :: Rules a -> ShakePlus r a

MonadRules m => MonadRules (ReaderT r m)

Defined in Development.Shake.Plus.Core

Methods

liftRules :: Rules a -> ReaderT r m a

newtype UnliftAction m

Constructors

UnliftAction

Fields

• unliftAction :: forall a. m a -> Action a

class MonadAction m => MonadUnliftAction m where

Monads which allow their actions to be run in Action.

For the same reasons as MonadUnliftIO this is limited to ReaderT and IdentityT transformers on top of Action.

Minimal complete definition

Nothing

Methods

withRunInAction :: ((forall a. m a -> Action a) -> Action b) -> m b

Instances

MonadUnliftAction Action

Defined in Development.Shake.Plus.Core

Methods

withRunInAction :: ((forall a. Action a -> Action a) -> Action b) -> Action b

MonadUnliftAction (RAction r)

Defined in Development.Shake.Plus.Core

Methods

withRunInAction :: ((forall a. RAction r a -> Action a) -> Action b) -> RAction r b

MonadUnliftAction m => MonadUnliftAction (ReaderT r m)

Defined in Development.Shake.Plus.Core

Methods

withRunInAction :: ((forall a. ReaderT r m a -> Action a) -> Action b) -> ReaderT r m b

withUnliftAction :: MonadUnliftAction m => (UnliftAction m -> Action a) -> m a

askUnliftAction :: MonadUnliftAction m => m (UnliftAction m)

toAction :: MonadUnliftAction m => m a -> m (Action a)

data RAction r a

Concrete Action runner, hardcoded to `ReaderT r Action a`.

Instances

MonadReader r (RAction r)

Defined in Development.Shake.Plus.Core

Methods

ask :: RAction r r

local :: (r -> r) -> RAction r a -> RAction r a

reader :: (r -> a) -> RAction r a

Monad (RAction r)

Defined in Development.Shake.Plus.Core

Methods

(>>=) :: RAction r a -> (a -> RAction r b) -> RAction r b

(>>) :: RAction r a -> RAction r b -> RAction r b

return :: a -> RAction r a

fail :: String -> RAction r a

Functor (RAction r)

Defined in Development.Shake.Plus.Core

Methods

fmap :: (a -> b) -> RAction r a -> RAction r b

(<$) :: a -> RAction r b -> RAction r a

MonadFail (RAction r)

Defined in Development.Shake.Plus.Core

Methods

fail :: String -> RAction r a

Applicative (RAction r)

Defined in Development.Shake.Plus.Core

Methods

pure :: a -> RAction r a

(<*>) :: RAction r (a -> b) -> RAction r a -> RAction r b

liftA2 :: (a -> b -> c) -> RAction r a -> RAction r b -> RAction r c

(*>) :: RAction r a -> RAction r b -> RAction r b

(<*) :: RAction r a -> RAction r b -> RAction r a

MonadIO (RAction r)

Defined in Development.Shake.Plus.Core

Methods

liftIO :: IO a -> RAction r a

MonadThrow (RAction r)

Defined in Development.Shake.Plus.Core

Methods

throwM :: Exception e => e -> RAction r a

MonadUnliftAction (RAction r)

Defined in Development.Shake.Plus.Core

Methods

withRunInAction :: ((forall a. RAction r a -> Action a) -> Action b) -> RAction r b

MonadAction (RAction r)

Defined in Development.Shake.Plus.Core

Methods

liftAction :: Action a -> RAction r a

data ShakePlus r a

Concrete Rules collector, hardcoded to `ReaderT r Rules a`.

Instances

MonadReader r (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

ask :: ShakePlus r r

local :: (r -> r) -> ShakePlus r a -> ShakePlus r a

reader :: (r -> a) -> ShakePlus r a

Monad (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

(>>=) :: ShakePlus r a -> (a -> ShakePlus r b) -> ShakePlus r b

(>>) :: ShakePlus r a -> ShakePlus r b -> ShakePlus r b

return :: a -> ShakePlus r a

fail :: String -> ShakePlus r a

Functor (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

fmap :: (a -> b) -> ShakePlus r a -> ShakePlus r b

(<$) :: a -> ShakePlus r b -> ShakePlus r a

Applicative (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

pure :: a -> ShakePlus r a

(<*>) :: ShakePlus r (a -> b) -> ShakePlus r a -> ShakePlus r b

liftA2 :: (a -> b -> c) -> ShakePlus r a -> ShakePlus r b -> ShakePlus r c

(*>) :: ShakePlus r a -> ShakePlus r b -> ShakePlus r b

(<*) :: ShakePlus r a -> ShakePlus r b -> ShakePlus r a

MonadIO (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

liftIO :: IO a -> ShakePlus r a

MonadThrow (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

throwM :: Exception e => e -> ShakePlus r a

MonadRules (ShakePlus r)

Defined in Development.Shake.Plus.Core

Methods

liftRules :: Rules a -> ShakePlus r a

runRAction :: MonadAction m => env -> RAction env a -> m a

Run an RAction with an environment, consuming it for a result.

runShakePlus :: MonadRules m => env -> ShakePlus env a -> m a

Run a ShakePlus with an environment, consuming it for some Shake Rules.

data Action a

The Action monad, use liftIO to raise IO actions into it, and need to execute files. Action values are used by addUserRule and action. The Action monad tracks the dependencies of a rule. To raise an exception call error, MonadFail or liftIO . throwIO.

Instances

Monad Action

Defined in Development.Shake.Internal.Core.Types

Methods

(>>=) :: Action a -> (a -> Action b) -> Action b

(>>) :: Action a -> Action b -> Action b

return :: a -> Action a

fail :: String -> Action a

Functor Action

Defined in Development.Shake.Internal.Core.Types

Methods

fmap :: (a -> b) -> Action a -> Action b

(<$) :: a -> Action b -> Action a

MonadFail Action

Defined in Development.Shake.Internal.Core.Types

Methods

fail :: String -> Action a

Applicative Action

Defined in Development.Shake.Internal.Core.Types

Methods

pure :: a -> Action a

(<*>) :: Action (a -> b) -> Action a -> Action b

liftA2 :: (a -> b -> c) -> Action a -> Action b -> Action c

(*>) :: Action a -> Action b -> Action b

(<*) :: Action a -> Action b -> Action a

MonadIO Action

Defined in Development.Shake.Internal.Core.Types

Methods

liftIO :: IO a -> Action a

MonadUnliftAction Action

Defined in Development.Shake.Plus.Core

Methods

withRunInAction :: ((forall a. Action a -> Action a) -> Action b) -> Action b

MonadAction Action

Defined in Development.Shake.Plus.Core

Methods

liftAction :: Action a -> Action a

MonadTempDir Action

Defined in Development.Shake.Command

Methods

runWithTempDir :: (FilePath -> Action a) -> Action a

Semigroup a => Semigroup (Action a)

Defined in Development.Shake.Internal.Core.Types

Methods

(<>) :: Action a -> Action a -> Action a

sconcat :: NonEmpty (Action a) -> Action a

stimes :: Integral b => b -> Action a -> Action a

Monoid a => Monoid (Action a)

Defined in Development.Shake.Internal.Core.Types

Methods

mempty :: Action a

mappend :: Action a -> Action a -> Action a

mconcat :: [Action a] -> Action a

CmdResult r => CmdArguments (Action r)

Defined in Development.Shake.Command

Methods

cmdArguments :: CmdArgument -> Action r

data Rules a

Define a set of rules. Rules can be created with calls to functions such as %> or action. Rules are combined with either the Monoid instance, or (more commonly) the Monad instance and do notation. To define your own custom types of rule, see Development.Shake.Rule.

Instances

Monad Rules

Defined in Development.Shake.Internal.Core.Rules

Methods

(>>=) :: Rules a -> (a -> Rules b) -> Rules b

(>>) :: Rules a -> Rules b -> Rules b

return :: a -> Rules a

fail :: String -> Rules a

Functor Rules

Defined in Development.Shake.Internal.Core.Rules

Methods

fmap :: (a -> b) -> Rules a -> Rules b

(<$) :: a -> Rules b -> Rules a

MonadFix Rules

Defined in Development.Shake.Internal.Core.Rules

Methods

mfix :: (a -> Rules a) -> Rules a

MonadFail Rules

Defined in Development.Shake.Internal.Core.Rules

Methods

fail :: String -> Rules a

Applicative Rules

Defined in Development.Shake.Internal.Core.Rules

Methods

pure :: a -> Rules a

(<*>) :: Rules (a -> b) -> Rules a -> Rules b

liftA2 :: (a -> b -> c) -> Rules a -> Rules b -> Rules c

(*>) :: Rules a -> Rules b -> Rules b

(<*) :: Rules a -> Rules b -> Rules a

MonadIO Rules

Defined in Development.Shake.Internal.Core.Rules

Methods

liftIO :: IO a -> Rules a

MonadRules Rules

Defined in Development.Shake.Plus.Core

Methods

liftRules :: Rules a -> Rules a

Semigroup a => Semigroup (Rules a)

Defined in Development.Shake.Internal.Core.Rules

Methods

(<>) :: Rules a -> Rules a -> Rules a

sconcat :: NonEmpty (Rules a) -> Rules a

stimes :: Integral b => b -> Rules a -> Rules a

(Semigroup a, Monoid a) => Monoid (Rules a)

Defined in Development.Shake.Internal.Core.Rules

Methods

mempty :: Rules a

mappend :: Rules a -> Rules a -> Rules a

mconcat :: [Rules a] -> Rules a

type FilePattern = String

A type synonym for file patterns, containing // and *. For the syntax and semantics of FilePattern see ?==.

Most normaliseExd FilePath values are suitable as FilePattern values which match only that specific file. On Windows \ is treated as equivalent to /.

You can write FilePattern values as a literal string, or build them up using the operators <.>, </> and <//>. However, beware that:

• On Windows, use <.> from Development.Shake.FilePath instead of from System.FilePath - otherwise "//*" <.> exe results in "//*\\.exe".
• If the second argument of </> has a leading path separator (namely /) then the second argument will be returned.

shake :: ShakeOptions -> Rules () -> IO ()

Main entry point for running Shake build systems. For an example see the top of the module Development.Shake. Use ShakeOptions to specify how the system runs, and Rules to specify what to build. The function will throw an exception if the build fails.

To use command line flags to modify ShakeOptions see shakeArgs.

shakeOptions :: ShakeOptions

The default set of ShakeOptions.