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


-- | Boot application by using plugins.
--   
--   Boot application.
@package boots
@version 0


-- | This module wrap <tt>salak</tt> into a plugin.
module Boots.Plugin.Salak

-- | Environment providing a configuration parser.
class HasSalak cxt
askSourcePack :: HasSalak cxt => Lens' cxt SourcePack

-- | Plugin used for parse properties.
pluginSalak :: (MonadIO m, MonadCatch m) => String -> Plugin () m SourcePack

-- | Core type class of salak, which provide function to parse properties.
class Monad m => MonadSalak (m :: Type -> Type)

-- | Monad has the ability to get a <a>SourcePack</a> instance.
askSalak :: MonadSalak m => m SourcePack

-- | Get reload action which used for reload profiles
askReload :: MonadSalak m => m (IO ReloadResult)

-- | Parse properties using <a>FromProp</a>. For example:
--   
--   <pre>
--   a :: Bool              &lt;- require "bool.key"
--   b :: Maybe Int         &lt;- require "int.optional.key"
--   c :: Either String Int &lt;- require "int.error.key"
--   d :: IO Int            &lt;- require "int.reloadable.key"
--   </pre>
--   
--   <a>require</a> supports parse <a>IO</a> values, which actually wrap a
--   <a>MVar</a> variable and can be reseted by reloading configurations.
--   Normal value will not be affected by reloading configurations.
require :: (MonadSalak m, MonadThrow m, FromProp m a) => Text -> m a
instance Boots.Plugin.Salak.HasSalak Salak.Internal.Source.SourcePack
instance Boots.Plugin.Salak.HasSalak cxt => Salak.Internal.Prop.MonadSalak (Boots.Internal.Plugin.Plugin cxt m)
instance (GHC.Base.Monad m, Boots.Plugin.Salak.HasSalak cxt) => Salak.Internal.Prop.MonadSalak (Boots.Internal.App.AppT cxt m)


-- | This module wrap a logging function into a plugin.
module Boots.Plugin.Logger

-- | Environment providing a logging function.
class HasLogger cxt
askLogger :: HasLogger cxt => Lens' cxt LogFunc

-- | Logger config.
data LogConfig
LogConfig :: Word16 -> Maybe FilePath -> Word32 -> Word16 -> IO LogLevel -> LogConfig

-- | Logger buffer size.
[bufferSize] :: LogConfig -> Word16

-- | Logger file path.
[file] :: LogConfig -> Maybe FilePath

-- | Max logger file size.
[maxSize] :: LogConfig -> Word32

-- | Max number of logger files should be reserved.
[rotateHistory] :: LogConfig -> Word16

-- | Log level to show.
[level] :: LogConfig -> IO LogLevel
data LogFunc

-- | Add additional trace info into log.
addTrace :: Text -> LogFunc -> LogFunc

-- | Plugin providing a logging function.
pluginLogger :: (MonadIO m, MonadCatch m, HasSalak cxt) => Text -> Plugin cxt m LogFunc

-- | See <a>logDebug</a>
logInfo :: (HasCallStack, MonadLogger m) => Text -> m ()

-- | Logs a message with the location provided by an implicit
--   <a>CallStack</a>.
logDebug :: (HasCallStack, MonadLogger m) => Text -> m ()

-- | See <a>logDebug</a>
logWarn :: (HasCallStack, MonadLogger m) => Text -> m ()

-- | See <a>logDebug</a>
logError :: (HasCallStack, MonadLogger m) => Text -> m ()

-- | See <a>logDebug</a>
logOther :: (HasCallStack, MonadLogger m) => LogLevel -> Text -> m ()
instance Boots.Plugin.Logger.HasLogger Boots.Plugin.Logger.LogFunc
instance (Control.Monad.IO.Class.MonadIO m, Boots.Plugin.Logger.HasLogger cxt) => Control.Monad.Logger.MonadLogger (Boots.Internal.Plugin.Plugin cxt m)
instance (Control.Monad.IO.Class.MonadIO m, Boots.Plugin.Logger.HasLogger cxt) => Control.Monad.Logger.MonadLogger (Boots.Internal.App.AppT cxt m)
instance Data.Default.Class.Default Boots.Plugin.Logger.LogConfig
instance Control.Monad.IO.Class.MonadIO m => Salak.Internal.Prop.FromProp m Boots.Plugin.Logger.LogConfig
instance GHC.Base.Monad m => Salak.Internal.Prop.FromProp m Control.Monad.Logger.LogLevel


-- | This module defines simple application plugin.
module Boots.Plugin.Simple

-- | Simple plugin initialized both configurations <a>pluginSalak</a> and
--   logger <a>pluginLogger</a>.
data Simple
Simple :: SourcePack -> LogFunc -> Simple
[sourcePack] :: Simple -> SourcePack
[logFunc] :: Simple -> LogFunc

-- | Environment values with a configuration parser and logging function.
class HasSimple cxt
askSimple :: HasSimple cxt => Lens' cxt Simple

-- | Simple plugin provides a configuration parser and logging function.
pluginSimple :: (MonadCatch m, MonadIO m) => Text -> Plugin () m Simple
instance Boots.Plugin.Simple.HasSimple Boots.Plugin.Simple.Simple
instance Boots.Plugin.Logger.HasLogger Boots.Plugin.Simple.Simple
instance Boots.Plugin.Salak.HasSalak Boots.Plugin.Simple.Simple


-- | Boot plugins.
module Boots.Plugin


-- | Boot application by using plugins.
--   
--   <pre>
--   &gt;&gt;&gt; booting (pluginSimple "application") (logInfo "hello")
--   2019-07-27 19:35:30  INFO [application] Ghci1 - hello
--   
--   &gt;&gt;&gt; booting (pluginSimple "application") (require "user" &gt;&gt;= logInfo)
--   2019-07-27 19:37:45  INFO [application] Ghci2 - daniel
--   </pre>
module Boots

-- | Run application using a plugin. Context <tt>cxt</tt> can't escape from
--   <tt>m</tt>.
booting :: Plugin () m cxt -> AppT cxt m () -> m ()

-- | Application monad transformation.
data AppT cxt m a

-- | Run application monad transformation.
runAppT :: cxt -> AppT cxt m a -> m a

-- | Lift a computation from the <a>IO</a> monad.
liftIO :: MonadIO m => IO a -> m a

-- | Retrieves the monad environment.
ask :: MonadReader r m => m r

-- | Lift a computation from the argument monad to the constructed monad.
lift :: (MonadTrans t, Monad m) => m a -> t m a

-- | Throw an exception. Note that this throws when this action is run in
--   the monad <tt>m</tt>, not when it is applied. It is a generalization
--   of <a>Control.Exception</a>'s <a>throwIO</a>.
--   
--   Should satisfy the law:
--   
--   <pre>
--   throwM e &gt;&gt; f = throwM e
--   </pre>
throwM :: (MonadThrow m, Exception e) => e -> m a

-- | Plugin generates component <tt>u</tt> with the context of component
--   <tt>i</tt> running in monad <tt>m</tt>.
data Plugin i m u

-- | Run plugin in given context <tt>i</tt>.
runPlugin :: i -> Plugin i m u -> (u -> m ()) -> m ()

-- | Promote a plugin into another.
promote :: i -> Plugin i m u -> Plugin x m u

-- | Convert a plugin into another.
withPlugin :: (i -> j) -> Plugin j m u -> Plugin i m u

-- | Apply a function to transform the result of a continuation-passing
--   computation.
mapPlugin :: (m () -> m ()) -> Plugin i m u -> Plugin i m u

-- | Create bracket style plugin, used for manage resources, which need to
--   open and close.
--   
--   A simple example:
--   
--   <pre>
--   &gt;&gt;&gt; res = bracketP (putStrLn "open") (const $ putStrLn "close")
--   
--   &gt;&gt;&gt; runPlugin () res (const $ putStrLn "using")
--   open
--   using
--   close
--   </pre>
bracketP :: MonadCatch m => m u -> (u -> m ()) -> Plugin i m u