Game.GoreAndAsh.Logging

The module contains all API for Gore&Ash logging module. The module doesn't depends on others core modules and could be place in any place in game monad stack.

The core module is not pure on it first phase and could be used with IO as end monad. See ModuleStack documentation.

Example of embedding:

-- | Application monad is monad stack build from given list of modules over base monad (IO)
type AppStack = ModuleStack [LoggingT, ... other modules ... ] IO
newtype AppState = AppState (ModuleState AppStack)
  deriving (Generic)

instance NFData AppState

-- | Wrapper around type family
newtype AppMonad a = AppMonad (AppStack a)
  deriving (Functor, Applicative, Monad, MonadFix, MonadIO, LoggingMonad, ... other modules monads ... )

instance GameModule AppMonad AppState where
  type ModuleState AppMonad = AppState
  runModule (AppMonad m) (AppState s) = do
    (a, s') <- runModule m s
    return (a, AppState s')
  newModuleState = AppState $ newModuleState
  withModule _ = withModule (Proxy :: Proxy AppStack)
  cleanupModule (AppState s) = cleanupModule s

-- | Arrow that is build over the monad stack
type AppWire a b = GameWire AppMonad a b

playerActor :: ActorMonad m => (PlayerId -> Player) -> GameActor m PlayerId Game Player playerActor initialPlayer = makeActor $ i -> stateWire (initialPlayer i) $ mainController i where mainController i = proc (g, p) -> do

@

Low-level API

data LoggingState s

Inner state of logger.

s

next state, states of modules are chained via nesting

Instances

Generic (LoggingState s)

NFData s => NFData (LoggingState s)

Monad m => MonadState (LoggingState s) (LoggingT s m)

type Rep (LoggingState s)

data LoggingT s m a

Monad transformer of logging core module.

s

- State of next core module in modules chain;

m

- Next monad in modules monad stack;

a

- Type of result value;

How to embed module:

type AppStack = ModuleStack [LoggingT, ... other modules ... ] IO

newtype AppMonad a = AppMonad (AppStack a)
  deriving (Functor, Applicative, Monad, MonadFix, MonadIO, LoggingMonad)

The module is pure within first phase (see ModuleStack docs) and could be used with Identity end monad.

Instances

MonadBase IO m => MonadBase IO (LoggingT s m)

MonadError e m => MonadError e (LoggingT s m)

MonadTrans (LoggingT s)

Monad m => MonadState (LoggingState s) (LoggingT s m)

Monad m => Monad (LoggingT s m)

Functor m => Functor (LoggingT s m)

MonadFix m => MonadFix (LoggingT s m)

Monad m => Applicative (LoggingT s m)

MonadIO m => MonadIO (LoggingT s m)

MonadThrow m => MonadThrow (LoggingT s m)

MonadMask m => MonadMask (LoggingT s m)

MonadCatch m => MonadCatch (LoggingT s m)

MonadResource m => MonadResource (LoggingT s m)

MonadIO m => LoggingMonad (LoggingT s m)

type ModuleState (LoggingT s m) = LoggingState s

data LoggingLevel

Describes important of logging message

Constructors

LogDebug

Used for detailed logging

LogInfo

Used for messages about normal operation of application

LogWarn

Used for recoverable errors or defaulting to fallback behavior

LogError

Used before throwing an exception or fatal fales

LogMuted

Special case of message, that never goes to console, but saved into file

Instances

Bounded LoggingLevel

Eq LoggingLevel

Ord LoggingLevel

Read LoggingLevel

Show LoggingLevel

Generic LoggingLevel

NFData LoggingLevel

Hashable LoggingLevel

type Rep LoggingLevel

data LoggingSink

Distanation of logging

Constructors

LoggingConsole

Putting to user terminal

LoggingFile

Putting into file

Instances

Bounded LoggingSink

Eq LoggingSink

Ord LoggingSink

Read LoggingSink

Show LoggingSink

Generic LoggingSink

NFData LoggingSink

Hashable LoggingSink

type Rep LoggingSink

class MonadIO m => LoggingMonad m where

Low level API for module

Methods

putMsgM :: LoggingLevel -> Text -> m ()

Put message to the console.

putMsgLnM :: LoggingLevel -> Text -> m ()

Put message and new line to the console.

loggingSetHandle :: Handle -> m ()

Setting current logging file handler

loggingSetFilter :: LoggingLevel -> [LoggingSink] -> m ()

Setting allowed sinks for given logging level.

By default all messages are passed into file and console.

Instances

(MonadIO (mt m), LoggingMonad m, MonadTrans mt) => LoggingMonad (mt m)

MonadIO m => LoggingMonad (LoggingT s m)

loggingSetFile

Arguments

:: LoggingMonad m

=> FilePath

Path to logging file

-> Bool

If False, rewrites contents of the file, if True opens in append mode

-> m ()

Helper to set logging file as local path

Arrow API

logA :: LoggingMonad m => LoggingLevel -> GameWire m Text ()

Put message to console on every frame without newline

logALn :: LoggingMonad m => LoggingLevel -> GameWire m Text ()

Put message to console on every frame

logE :: LoggingMonad m => LoggingLevel -> GameWire m (Event Text) (Event ())

Put message to console on event without newline

logELn :: LoggingMonad m => LoggingLevel -> GameWire m (Event Text) (Event ())

Put message to console on event

Every frame

logDebugA :: LoggingMonad m => GameWire m Text ()

Put info msg to console

logInfoA :: LoggingMonad m => GameWire m Text ()

Put info msg to console

logWarnA :: LoggingMonad m => GameWire m Text ()

Put warn msg to console

logErrorA :: LoggingMonad m => GameWire m Text ()

Put error msg to console

Event based

logDebugE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put info msg to console on event

logInfoE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put info msg to console on event

logWarnE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put warn msg to console on event

logErrorE :: LoggingMonad m => GameWire m (Event Text) (Event ())

Put error msg to console on event

Event tracing

traceEvent :: LoggingMonad m => (a -> Text) -> GameWire m (Event a) (Event ())

Prints event with given function

traceEventShow :: (TextShow a, LoggingMonad m) => GameWire m (Event a) (Event ())

Prints event