-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Re-export of Shake using well-typed paths and ReaderT.
--   
--   Re-export of Shake using well-typed paths and ReaderT. This is an
--   early release so some things may be missing or broken but so far the
--   conveniences have been worth it.
@package shake-plus
@version 0.0.1.2

module Development.Shake.Plus.Core

-- | Monads in which <a>Action</a>s may be embedded.
class Monad m => MonadAction m
liftAction :: MonadAction m => Action a -> m a
class Monad m => MonadRules m
liftRules :: MonadRules m => Rules a -> m a
newtype UnliftAction m
UnliftAction :: (forall a. m a -> Action a) -> UnliftAction m
[unliftAction] :: UnliftAction m -> forall a. m a -> Action a

-- | Monads which allow their actions to be run in <a>Action</a>.
--   
--   For the same reasons as <a>MonadUnliftIO</a> this is limited to
--   <a>ReaderT</a> and <tt>IdentityT</tt> transformers on top of
--   <a>Action</a>.
class MonadAction m => MonadUnliftAction m
withRunInAction :: MonadUnliftAction m => ((forall a. m a -> Action a) -> Action b) -> 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)

-- | Concrete <a>Action</a> runner, hardcoded to `ReaderT r Action a`.
data RAction r a

-- | Concrete <a>Rules</a> collector, hardcoded to `ReaderT r Rules a`.
data ShakePlus r a

-- | Run an <a>RAction</a> with an environment, consuming it for a result.
runRAction :: MonadAction m => env -> RAction env a -> m a

-- | Run a <a>ShakePlus</a> with an environment, consuming it for some
--   Shake <a>Rules</a>.
runShakePlus :: MonadRules m => env -> ShakePlus env a -> m a
instance Development.Shake.Plus.Core.MonadRules (Development.Shake.Plus.Core.ShakePlus r)
instance Control.Monad.IO.Class.MonadIO (Development.Shake.Plus.Core.ShakePlus r)
instance Control.Monad.Reader.Class.MonadReader r (Development.Shake.Plus.Core.ShakePlus r)
instance GHC.Base.Monad (Development.Shake.Plus.Core.ShakePlus r)
instance GHC.Base.Applicative (Development.Shake.Plus.Core.ShakePlus r)
instance GHC.Base.Functor (Development.Shake.Plus.Core.ShakePlus r)
instance Development.Shake.Plus.Core.MonadUnliftAction (Development.Shake.Plus.Core.RAction r)
instance Development.Shake.Plus.Core.MonadAction (Development.Shake.Plus.Core.RAction r)
instance Control.Monad.IO.Class.MonadIO (Development.Shake.Plus.Core.RAction r)
instance Control.Monad.Reader.Class.MonadReader r (Development.Shake.Plus.Core.RAction r)
instance GHC.Base.Monad (Development.Shake.Plus.Core.RAction r)
instance GHC.Base.Applicative (Development.Shake.Plus.Core.RAction r)
instance GHC.Base.Functor (Development.Shake.Plus.Core.RAction r)
instance Control.Monad.Catch.MonadThrow (Development.Shake.Plus.Core.ShakePlus r)
instance Control.Monad.Catch.MonadThrow (Development.Shake.Plus.Core.RAction r)
instance Development.Shake.Plus.Core.MonadRules Development.Shake.Internal.Core.Rules.Rules
instance Development.Shake.Plus.Core.MonadRules m => Development.Shake.Plus.Core.MonadRules (Control.Monad.Trans.Reader.ReaderT r m)
instance Development.Shake.Plus.Core.MonadUnliftAction Development.Shake.Internal.Core.Types.Action
instance Development.Shake.Plus.Core.MonadUnliftAction m => Development.Shake.Plus.Core.MonadUnliftAction (Control.Monad.Trans.Reader.ReaderT r m)
instance Development.Shake.Plus.Core.MonadAction Development.Shake.Internal.Core.Types.Action
instance Development.Shake.Plus.Core.MonadAction m => Development.Shake.Plus.Core.MonadAction (Control.Monad.Trans.Reader.ReaderT r m)

module Development.Shake.Plus.Config

-- | Lifted <a>readConfigFile</a> with well-typed path.
readConfigFile :: MonadIO m => Path a File -> m (HashMap String String)

-- | Lifted <a>readConfigFileWithEnv</a> with well-typed path.
readConfigFileWithEnv :: MonadIO m => [(String, String)] -> Path a File -> m (HashMap String String)

-- | Lifted <a>usingConfigFile</a> with well-typed path.
usingConfigFile :: MonadRules m => Path a File -> m ()

-- | Lifted <a>usingConfig</a>.
usingConfig :: MonadRules m => HashMap String String -> m ()

-- | Lifted <a>getConfig</a>.
getConfig :: MonadAction m => String -> m (Maybe String)

-- | Lifted <a>getConfigKeys</a>.
getConfigKeys :: MonadAction m => m [String]

module Development.Shake.Plus.Cache

-- | Lifted version of <a>newCache</a> using <a>RAction</a>.
newCache :: (MonadRules m, MonadReader r m, Eq k, Hashable k) => (k -> RAction r v) -> m (k -> RAction r v)

-- | Lifted version of <a>newCacheIO</a> using <a>RAction</a>.
newCacheIO :: (MonadIO m, MonadReader r m, Eq k, Hashable k) => (k -> RAction r v) -> m (k -> RAction r v)

module Development.Shake.Plus.Database

-- | The type of an open Shake database. Created with
--   <a>shakeOpenDatabase</a> or <a>shakeWithDatabase</a>. Used with
--   <a>shakeRunDatabase</a>. You may not execute simultaneous calls using
--   <a>ShakeDatabase</a> on separate threads (it will raise an error).
data ShakeDatabase

-- | Lifted <a>shakeOpenDatabase</a>
shakeOpenDatabase :: MonadIO m => ShakeOptions -> Rules () -> m (IO ShakeDatabase, IO ())

-- | Unlifted <a>shakeWithDatabase</a>
shakeWithDatabase :: MonadUnliftIO m => ShakeOptions -> Rules () -> (ShakeDatabase -> m a) -> m a

-- | Lifted <a>shakeOneShotDatabase</a>
shakeOneShotDatabase :: MonadIO m => ShakeDatabase -> m ()

-- | Lifted <a>shakeRunDatabase</a>
shakeRunDatabase :: MonadIO m => ShakeDatabase -> [Action a] -> m ([a], [IO ()])

-- | Lifted <a>shakeLiveFilesDatabase</a>
shakeLiveFilesDatabase :: MonadIO m => ShakeDatabase -> m [FilePath]

-- | Lifted <a>shakeProfileDatabase</a> with well-typed path.
shakeProfileDatabase :: MonadIO m => ShakeDatabase -> Path a File -> m ()

-- | Lifted <a>shakeErrorsDatabase</a>
shakeErrorsDatabase :: MonadIO m => ShakeDatabase -> m [(String, SomeException)]

-- | Unlifted <a>shakeRunAfter</a>
shakeRunAfter :: MonadUnliftIO m => ShakeOptions -> [m ()] -> m ()

module Development.Shake.Plus.Directory

-- | Lifted version of <a>doesFileExist</a> using well-typed <a>Path</a>s.
doesFileExist :: MonadAction m => Path b File -> m Bool

-- | Lifted version of <a>doesDirectoryExist</a> using well-typed
--   <a>Path</a>s.
doesDirectoryExist :: MonadAction m => Path b Dir -> m Bool

-- | Lifted version of <a>getDirectoryFiles</a> using well-typed
--   <a>Path</a>s.
getDirectoryFiles :: MonadAction m => Path b Dir -> [FilePattern] -> m [Path Rel File]

-- | Lifted version of <a>getDirectoryDirs</a> using well-typed
--   <a>Path</a>s.
getDirectoryDirs :: MonadAction m => Path b Dir -> m [Path Rel Dir]

-- | Lifted version of <a>getDirectoryFilesIO</a> using well-typed
--   <a>Path</a>s.
getDirectoryFilesIO :: MonadIO m => Path b Dir -> [FilePattern] -> m [Path Rel File]

module Development.Shake.Plus.File

-- | Lifted version of <a>copyFile</a> with well-typed <a>Path</a>s.
copyFile' :: (MonadAction m, Partial) => Path Rel File -> Path Rel File -> m ()

-- | Lifted version of <a>copyFileChanged'</a> with well-typed
--   <a>Path</a>s.
copyFileChanged :: (MonadAction m, Partial) => Path Rel File -> Path Rel File -> m ()

-- | Lifted version of <a>readFile'</a> with well-typed <a>Path</a>.
readFile' :: (MonadAction m, Partial) => Path Rel File -> m Text

-- | Lifted version of <a>readFileLines</a> with well-typed <a>Path</a>.
readFileLines :: (MonadAction m, Partial) => Path Rel File -> m [Text]

-- | Lifted version of <a>writeFile</a> with well-typed <a>Path</a>.
writeFile' :: (MonadAction m, Partial) => Path Rel File -> Text -> m ()

-- | Lifted version of <a>writeFileLines</a> with well-typed <a>Path</a>.
writeFileLines :: (MonadAction m, Partial) => Path Rel File -> [Text] -> m ()

-- | Lifted version of <a>writeFileChanged</a> with well-typed <a>Path</a>.
writeFileChanged :: (MonadAction m, Partial) => Path b File -> Text -> m ()

-- | Lifted version of <a>removeFiles</a> with well-typed <a>Path</a>.
removeFiles :: MonadAction m => Path b File -> [FilePattern] -> m ()

-- | Lifted version of <a>removeFilesAfter</a> with well-typed <a>Path</a>.
removeFilesAfter :: MonadAction m => Path Rel Dir -> [FilePattern] -> m ()

module Development.Shake.Plus.FileRules

-- | Lifted version of <a>need</a> using well-typed <a>Path</a>s
need :: (MonadAction m, Partial) => [Path Rel File] -> m ()

-- | Lifted version of <a>%&gt;</a> using well-typed <a>Path</a>s
(%>) :: (Partial, MonadReader r m, MonadRules m) => FilePattern -> (Path Rel File -> RAction r ()) -> m ()

-- | Lifted version of <a>|%&gt;</a> using well-typed <a>Path</a>s
(|%>) :: (Partial, MonadReader r m, MonadRules m) => [FilePattern] -> (Path Rel File -> RAction r ()) -> m ()

-- | Lifted version of <a>phony</a> using well-typed <a>Path</a>s
phony :: (MonadReader r m, MonadRules m) => String -> RAction r () -> m ()

module Development.Shake.Plus.Oracle

-- | Lifted version of <a>addOracle</a> using <a>RAction</a> runner.
addOracle :: (MonadRules m, MonadReader r m, RuleResult q ~ a, ShakeValue q, ShakeValue a, Partial) => (q -> RAction r a) -> m (q -> RAction r a)

-- | Lifted version of <a>addOracleCache</a> using <a>RAction</a> runner.
addOracleCache :: (MonadRules m, MonadReader r m, RuleResult q ~ a, ShakeValue q, ShakeValue a, Partial) => (q -> RAction r a) -> m (q -> RAction r a)

-- | Lifted version of <a>addOracleHash</a> using <a>RAction</a> runner.
addOracleHash :: (MonadRules m, MonadReader r m, RuleResult q ~ a, ShakeValue q, ShakeValue a, Partial) => (q -> RAction r a) -> m (q -> RAction r a)

-- | Lifted version of <a>askOracle</a>.
askOracle :: (MonadAction m, RuleResult q ~ a, ShakeValue q, ShakeValue a) => q -> m a

-- | Lifted version of <a>askOracles</a>.
askOracles :: (MonadAction m, RuleResult q ~ a, ShakeValue q, ShakeValue a) => [q] -> m [a]

module Development.Shake.Plus

module Development.Shake.Plus.Env

-- | Lifted version of <a>getEnv</a>
getEnv :: MonadAction m => String -> m (Maybe String)

-- | Lifted version of <a>getEnvWithDefault</a>
getEnvWithDefault :: MonadAction m => String -> String -> m String

-- | Lifted version of <a>getEnvError</a>
getEnvError :: (Partial, MonadAction m) => String -> m String

module Development.Shake.Plus.Temp

-- | Unlifted version of <a>withTempFile</a> with well-typed <a>Path</a>.
withTempFile :: (MonadUnliftAction m, MonadThrow m) => (Path Rel File -> m a) -> m a

-- | Unlifted version of <a>withTempFile</a> with well-typed <a>Path</a>.
withTempDir :: (MonadUnliftAction m, MonadThrow m) => (Path Rel Dir -> m a) -> m a

-- | Unlifted version of <a>withTempFileWithin</a> with well-typed
--   <a>Path</a>s.
withTempFileWithin :: (MonadUnliftAction m, MonadThrow m) => Path b Dir -> (Path Rel File -> m a) -> m a

-- | Unlifted version of <a>withTempDirWithin</a> with well-typed
--   <a>Path</a>s.
withTempDirWithin :: (MonadUnliftAction m, MonadThrow m) => Path b Dir -> (Path Rel Dir -> m a) -> m a