{-# LANGUAGE InstanceSigs #-}

{- |
Copyright:  (c) 2018-2022 Kowainik
SPDX-License-Identifier: MPL-2.0
Maintainer: Kowainik <xrom.xkov@gmail.com>

Core of the @mtl@ implementation.
-}

module Colog.Monad
       ( LoggerT (..)
       , HasLog (..)
       , WithLog
       , logMsg
       , logMsgs
       , withLog
       , liftLogAction
       , usingLoggerT
       ) where

import Prelude hiding (log)

import Control.Monad.IO.Class (MonadIO (..))
import Control.Monad.Reader (MonadReader (..), ReaderT (..), asks)
import Control.Monad.Trans.Class (MonadTrans (..))
import Data.Foldable (traverse_)
import GHC.Stack (HasCallStack)

import Colog.Core (HasLog (..), LogAction (..), hoistLogAction, overLogAction)


{- | @newtype@ wrapper 'ReaderT' that keeps 'LogAction' in its context.
-}
newtype LoggerT msg m a = LoggerT
    { LoggerT msg m a -> ReaderT (LogAction (LoggerT msg m) msg) m a
runLoggerT :: ReaderT (LogAction (LoggerT msg m) msg) m a
    } deriving newtype ( a -> LoggerT msg m b -> LoggerT msg m a
(a -> b) -> LoggerT msg m a -> LoggerT msg m b
(forall a b. (a -> b) -> LoggerT msg m a -> LoggerT msg m b)
-> (forall a b. a -> LoggerT msg m b -> LoggerT msg m a)
-> Functor (LoggerT msg m)
forall a b. a -> LoggerT msg m b -> LoggerT msg m a
forall a b. (a -> b) -> LoggerT msg m a -> LoggerT msg m b
forall msg (m :: * -> *) a b.
Functor m =>
a -> LoggerT msg m b -> LoggerT msg m a
forall msg (m :: * -> *) a b.
Functor m =>
(a -> b) -> LoggerT msg m a -> LoggerT msg m b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
<$ :: a -> LoggerT msg m b -> LoggerT msg m a
$c<$ :: forall msg (m :: * -> *) a b.
Functor m =>
a -> LoggerT msg m b -> LoggerT msg m a
fmap :: (a -> b) -> LoggerT msg m a -> LoggerT msg m b
$cfmap :: forall msg (m :: * -> *) a b.
Functor m =>
(a -> b) -> LoggerT msg m a -> LoggerT msg m b
Functor, Functor (LoggerT msg m)
a -> LoggerT msg m a
Functor (LoggerT msg m)
-> (forall a. a -> LoggerT msg m a)
-> (forall a b.
    LoggerT msg m (a -> b) -> LoggerT msg m a -> LoggerT msg m b)
-> (forall a b c.
    (a -> b -> c)
    -> LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m c)
-> (forall a b.
    LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b)
-> (forall a b.
    LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m a)
-> Applicative (LoggerT msg m)
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m a
LoggerT msg m (a -> b) -> LoggerT msg m a -> LoggerT msg m b
(a -> b -> c)
-> LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m c
forall a. a -> LoggerT msg m a
forall a b. LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m a
forall a b. LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
forall a b.
LoggerT msg m (a -> b) -> LoggerT msg m a -> LoggerT msg m b
forall a b c.
(a -> b -> c)
-> LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m c
forall msg (m :: * -> *). Applicative m => Functor (LoggerT msg m)
forall msg (m :: * -> *) a. Applicative m => a -> LoggerT msg m a
forall msg (m :: * -> *) a b.
Applicative m =>
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m a
forall msg (m :: * -> *) a b.
Applicative m =>
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
forall msg (m :: * -> *) a b.
Applicative m =>
LoggerT msg m (a -> b) -> LoggerT msg m a -> LoggerT msg m b
forall msg (m :: * -> *) a b c.
Applicative m =>
(a -> b -> c)
-> LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m c
forall (f :: * -> *).
Functor f
-> (forall a. a -> f a)
-> (forall a b. f (a -> b) -> f a -> f b)
-> (forall a b c. (a -> b -> c) -> f a -> f b -> f c)
-> (forall a b. f a -> f b -> f b)
-> (forall a b. f a -> f b -> f a)
-> Applicative f
<* :: LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m a
$c<* :: forall msg (m :: * -> *) a b.
Applicative m =>
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m a
*> :: LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
$c*> :: forall msg (m :: * -> *) a b.
Applicative m =>
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
liftA2 :: (a -> b -> c)
-> LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m c
$cliftA2 :: forall msg (m :: * -> *) a b c.
Applicative m =>
(a -> b -> c)
-> LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m c
<*> :: LoggerT msg m (a -> b) -> LoggerT msg m a -> LoggerT msg m b
$c<*> :: forall msg (m :: * -> *) a b.
Applicative m =>
LoggerT msg m (a -> b) -> LoggerT msg m a -> LoggerT msg m b
pure :: a -> LoggerT msg m a
$cpure :: forall msg (m :: * -> *) a. Applicative m => a -> LoggerT msg m a
$cp1Applicative :: forall msg (m :: * -> *). Applicative m => Functor (LoggerT msg m)
Applicative, Applicative (LoggerT msg m)
a -> LoggerT msg m a
Applicative (LoggerT msg m)
-> (forall a b.
    LoggerT msg m a -> (a -> LoggerT msg m b) -> LoggerT msg m b)
-> (forall a b.
    LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b)
-> (forall a. a -> LoggerT msg m a)
-> Monad (LoggerT msg m)
LoggerT msg m a -> (a -> LoggerT msg m b) -> LoggerT msg m b
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
forall a. a -> LoggerT msg m a
forall a b. LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
forall a b.
LoggerT msg m a -> (a -> LoggerT msg m b) -> LoggerT msg m b
forall msg (m :: * -> *). Monad m => Applicative (LoggerT msg m)
forall msg (m :: * -> *) a. Monad m => a -> LoggerT msg m a
forall msg (m :: * -> *) a b.
Monad m =>
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
forall msg (m :: * -> *) a b.
Monad m =>
LoggerT msg m a -> (a -> LoggerT msg m b) -> LoggerT msg m b
forall (m :: * -> *).
Applicative m
-> (forall a b. m a -> (a -> m b) -> m b)
-> (forall a b. m a -> m b -> m b)
-> (forall a. a -> m a)
-> Monad m
return :: a -> LoggerT msg m a
$creturn :: forall msg (m :: * -> *) a. Monad m => a -> LoggerT msg m a
>> :: LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
$c>> :: forall msg (m :: * -> *) a b.
Monad m =>
LoggerT msg m a -> LoggerT msg m b -> LoggerT msg m b
>>= :: LoggerT msg m a -> (a -> LoggerT msg m b) -> LoggerT msg m b
$c>>= :: forall msg (m :: * -> *) a b.
Monad m =>
LoggerT msg m a -> (a -> LoggerT msg m b) -> LoggerT msg m b
$cp1Monad :: forall msg (m :: * -> *). Monad m => Applicative (LoggerT msg m)
Monad, Monad (LoggerT msg m)
Monad (LoggerT msg m)
-> (forall a. IO a -> LoggerT msg m a) -> MonadIO (LoggerT msg m)
IO a -> LoggerT msg m a
forall a. IO a -> LoggerT msg m a
forall msg (m :: * -> *). MonadIO m => Monad (LoggerT msg m)
forall msg (m :: * -> *) a. MonadIO m => IO a -> LoggerT msg m a
forall (m :: * -> *).
Monad m -> (forall a. IO a -> m a) -> MonadIO m
liftIO :: IO a -> LoggerT msg m a
$cliftIO :: forall msg (m :: * -> *) a. MonadIO m => IO a -> LoggerT msg m a
$cp1MonadIO :: forall msg (m :: * -> *). MonadIO m => Monad (LoggerT msg m)
MonadIO
                       , MonadReader (LogAction (LoggerT msg m) msg)
                       )

instance MonadTrans (LoggerT msg) where
    lift :: Monad m => m a -> LoggerT msg m a
    lift :: m a -> LoggerT msg m a
lift = ReaderT (LogAction (LoggerT msg m) msg) m a -> LoggerT msg m a
forall msg (m :: * -> *) a.
ReaderT (LogAction (LoggerT msg m) msg) m a -> LoggerT msg m a
LoggerT (ReaderT (LogAction (LoggerT msg m) msg) m a -> LoggerT msg m a)
-> (m a -> ReaderT (LogAction (LoggerT msg m) msg) m a)
-> m a
-> LoggerT msg m a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. m a -> ReaderT (LogAction (LoggerT msg m) msg) m a
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift
    {-# INLINE lift #-}

{- | Type alias for constraint for:

1. Monad @m@ have access to environment @env@.
2. Environment @env@ contains 'LogAction' that can log messages of type @msg@.
3. Function call stack.

If you use this constraint, function call stack will be propagated and
you will have access to code lines that log messages.
-}
type WithLog env msg m = (MonadReader env m, HasLog env msg m, HasCallStack)

{- | Perform logging action with given message @msg@. This function works for
monads that have access to 'LogAction'.

You can use this function like this:

@
example :: 'WithLog' env 'String' m => m ()
example = __do__
    'logMsg' "First message..."
    'logMsg' "Second message..."
@
-}
logMsg :: forall msg env m . WithLog env msg m => msg -> m ()
logMsg :: msg -> m ()
logMsg msg
msg = do
    LogAction msg -> m ()
log <- (env -> LogAction m msg) -> m (LogAction m msg)
forall r (m :: * -> *) a. MonadReader r m => (r -> a) -> m a
asks env -> LogAction m msg
forall env msg (m :: * -> *).
HasLog env msg m =>
env -> LogAction m msg
getLogAction
    msg -> m ()
log msg
msg
{-# INLINE logMsg #-}

-- | Logs multiple messages.
logMsgs :: forall msg env f m . (Foldable f, WithLog env msg m) => f msg -> m ()
logMsgs :: f msg -> m ()
logMsgs = (msg -> m ()) -> f msg -> m ()
forall (t :: * -> *) (f :: * -> *) a b.
(Foldable t, Applicative f) =>
(a -> f b) -> t a -> f ()
traverse_ msg -> m ()
forall msg env (m :: * -> *). WithLog env msg m => msg -> m ()
logMsg
{-# INLINE logMsgs #-}

{- | Performs given monadic logging action by applying function to every logging record.

@
app :: 'WithLog' env 'String' m => m ()
app = 'withLog' ('cmap' ("app:" ++)) $ __do__
    'logMsg' "First message..."
    'logMsg' "Second message..."
@
-}
withLog :: WithLog env msg m => (LogAction m msg -> LogAction m msg) -> m a -> m a
withLog :: (LogAction m msg -> LogAction m msg) -> m a -> m a
withLog = (env -> env) -> m a -> m a
forall r (m :: * -> *) a. MonadReader r m => (r -> r) -> m a -> m a
local ((env -> env) -> m a -> m a)
-> ((LogAction m msg -> LogAction m msg) -> env -> env)
-> (LogAction m msg -> LogAction m msg)
-> m a
-> m a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (LogAction m msg -> LogAction m msg) -> env -> env
forall env msg (m :: * -> *).
HasLog env msg m =>
(LogAction m msg -> LogAction m msg) -> env -> env
overLogAction
{-# INLINE withLog #-}

{- | Lifts 'LogAction' by allowing to log in a transformed monad.
-}
liftLogAction :: (Monad m, MonadTrans t) => LogAction m msg -> LogAction (t m) msg
liftLogAction :: LogAction m msg -> LogAction (t m) msg
liftLogAction = (forall x. m x -> t m x) -> LogAction m msg -> LogAction (t m) msg
forall (m :: * -> *) (n :: * -> *) a.
(forall x. m x -> n x) -> LogAction m a -> LogAction n a
hoistLogAction forall x. m x -> t m x
forall (t :: (* -> *) -> * -> *) (m :: * -> *) a.
(MonadTrans t, Monad m) =>
m a -> t m a
lift
{-# INLINE liftLogAction #-}

{- | Runner for 'LoggerT' monad. Let's consider one simple example of monadic
action you have:

@
app :: 'WithLog' env 'String' m => m ()
app = __do__
    'logMsg' "Starting application..."
    'withLog' ('cmap' ("app:" ++)) $ __do__
        'logMsg' "Application started."
        'logMsg' "Application finished."
@

You can use the following way of running such example:

@
'usingLoggerT' ('LogAction' 'putStrLn') app
@

And you will see this output:

@
Starting application...
app:Application started.
app:Application finished.
@
-}
usingLoggerT :: Monad m => LogAction m msg -> LoggerT msg m a -> m a
usingLoggerT :: LogAction m msg -> LoggerT msg m a -> m a
usingLoggerT LogAction m msg
action = (ReaderT (LogAction (LoggerT msg m) msg) m a
 -> LogAction (LoggerT msg m) msg -> m a)
-> LogAction (LoggerT msg m) msg
-> ReaderT (LogAction (LoggerT msg m) msg) m a
-> m a
forall a b c. (a -> b -> c) -> b -> a -> c
flip ReaderT (LogAction (LoggerT msg m) msg) m a
-> LogAction (LoggerT msg m) msg -> m a
forall r (m :: * -> *) a. ReaderT r m a -> r -> m a
runReaderT (LogAction m msg -> LogAction (LoggerT msg m) msg
forall (m :: * -> *) (t :: (* -> *) -> * -> *) msg.
(Monad m, MonadTrans t) =>
LogAction m msg -> LogAction (t m) msg
liftLogAction LogAction m msg
action) (ReaderT (LogAction (LoggerT msg m) msg) m a -> m a)
-> (LoggerT msg m a -> ReaderT (LogAction (LoggerT msg m) msg) m a)
-> LoggerT msg m a
-> m a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. LoggerT msg m a -> ReaderT (LogAction (LoggerT msg m) msg) m a
forall msg (m :: * -> *) a.
LoggerT msg m a -> ReaderT (LogAction (LoggerT msg m) msg) m a
runLoggerT
{-# INLINE usingLoggerT #-}