{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE UndecidableInstances #-}

-- | A carrier for the 'Trace' effect that aggregates and returns all traced values.
--
-- @since 1.0.0.0
module Control.Carrier.Trace.Returning
( -- * Trace carrier
  runTrace
, TraceC(TraceC)
  -- * Trace effect
, module Control.Effect.Trace
) where

import Control.Algebra
import Control.Applicative (Alternative)
import Control.Carrier.Writer.Strict
import Control.Effect.Trace
import Control.Monad (MonadPlus)
import Control.Monad.Fail as Fail
import Control.Monad.Fix
import Control.Monad.IO.Class
import Control.Monad.Trans.Class
import Data.Bifunctor (first)
import Data.Monoid (Endo(..))

-- | Run a 'Trace' effect, returning all traces as a list.
--
-- @
-- 'runTrace' ('pure' a) = 'pure' ([], a)
-- @
-- @
-- 'runTrace' ('trace' s) = 'pure' ([s], ())
-- @
--
-- @since 1.0.0.0
runTrace :: Functor m => TraceC m a -> m ([String], a)
runTrace :: forall (m :: * -> *) a. Functor m => TraceC m a -> m ([String], a)
runTrace (TraceC WriterC (Endo [String]) m a
m) = (Endo [String] -> [String]) -> (Endo [String], a) -> ([String], a)
forall a b c. (a -> b) -> (a, c) -> (b, c)
forall (p :: * -> * -> *) a b c.
Bifunctor p =>
(a -> b) -> p a c -> p b c
first ((([String] -> [String]) -> [String] -> [String]
forall a b. (a -> b) -> a -> b
$ []) (([String] -> [String]) -> [String])
-> (Endo [String] -> [String] -> [String])
-> Endo [String]
-> [String]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Endo [String] -> [String] -> [String]
forall a. Endo a -> a -> a
appEndo) ((Endo [String], a) -> ([String], a))
-> m (Endo [String], a) -> m ([String], a)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> WriterC (Endo [String]) m a -> m (Endo [String], a)
forall w (m :: * -> *) a. Monoid w => WriterC w m a -> m (w, a)
runWriter WriterC (Endo [String]) m a
m
{-# INLINE runTrace #-}

-- | @since 1.0.0.0
newtype TraceC m a = TraceC { forall (m :: * -> *) a. TraceC m a -> WriterC (Endo [String]) m a
runTraceC :: WriterC (Endo [String]) m a }
  deriving (Applicative (TraceC m)
Applicative (TraceC m) =>
(forall a. TraceC m a)
-> (forall a. TraceC m a -> TraceC m a -> TraceC m a)
-> (forall a. TraceC m a -> TraceC m [a])
-> (forall a. TraceC m a -> TraceC m [a])
-> Alternative (TraceC m)
forall a. TraceC m a
forall a. TraceC m a -> TraceC m [a]
forall a. TraceC m a -> TraceC m a -> TraceC m a
forall (f :: * -> *).
Applicative f =>
(forall a. f a)
-> (forall a. f a -> f a -> f a)
-> (forall a. f a -> f [a])
-> (forall a. f a -> f [a])
-> Alternative f
forall (m :: * -> *).
(Alternative m, Monad m) =>
Applicative (TraceC m)
forall (m :: * -> *) a. (Alternative m, Monad m) => TraceC m a
forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m [a]
forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m a -> TraceC m a
$cempty :: forall (m :: * -> *) a. (Alternative m, Monad m) => TraceC m a
empty :: forall a. TraceC m a
$c<|> :: forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m a -> TraceC m a
<|> :: forall a. TraceC m a -> TraceC m a -> TraceC m a
$csome :: forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m [a]
some :: forall a. TraceC m a -> TraceC m [a]
$cmany :: forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m [a]
many :: forall a. TraceC m a -> TraceC m [a]
Alternative, Functor (TraceC m)
Functor (TraceC m) =>
(forall a. a -> TraceC m a)
-> (forall a b. TraceC m (a -> b) -> TraceC m a -> TraceC m b)
-> (forall a b c.
    (a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c)
-> (forall a b. TraceC m a -> TraceC m b -> TraceC m b)
-> (forall a b. TraceC m a -> TraceC m b -> TraceC m a)
-> Applicative (TraceC m)
forall a. a -> TraceC m a
forall a b. TraceC m a -> TraceC m b -> TraceC m a
forall a b. TraceC m a -> TraceC m b -> TraceC m b
forall a b. TraceC m (a -> b) -> TraceC m a -> TraceC m b
forall a b c.
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
forall (m :: * -> *). Monad m => Functor (TraceC m)
forall (m :: * -> *) a. Monad m => a -> TraceC m a
forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m a
forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m b
forall (m :: * -> *) a b.
Monad m =>
TraceC m (a -> b) -> TraceC m a -> TraceC m b
forall (m :: * -> *) a b c.
Monad m =>
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC 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
$cpure :: forall (m :: * -> *) a. Monad m => a -> TraceC m a
pure :: forall a. a -> TraceC m a
$c<*> :: forall (m :: * -> *) a b.
Monad m =>
TraceC m (a -> b) -> TraceC m a -> TraceC m b
<*> :: forall a b. TraceC m (a -> b) -> TraceC m a -> TraceC m b
$cliftA2 :: forall (m :: * -> *) a b c.
Monad m =>
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
liftA2 :: forall a b c.
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
$c*> :: forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m b
*> :: forall a b. TraceC m a -> TraceC m b -> TraceC m b
$c<* :: forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m a
<* :: forall a b. TraceC m a -> TraceC m b -> TraceC m a
Applicative, (forall a b. (a -> b) -> TraceC m a -> TraceC m b)
-> (forall a b. a -> TraceC m b -> TraceC m a)
-> Functor (TraceC m)
forall a b. a -> TraceC m b -> TraceC m a
forall a b. (a -> b) -> TraceC m a -> TraceC m b
forall (m :: * -> *) a b.
Functor m =>
a -> TraceC m b -> TraceC m a
forall (m :: * -> *) a b.
Functor m =>
(a -> b) -> TraceC m a -> TraceC m b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall (m :: * -> *) a b.
Functor m =>
(a -> b) -> TraceC m a -> TraceC m b
fmap :: forall a b. (a -> b) -> TraceC m a -> TraceC m b
$c<$ :: forall (m :: * -> *) a b.
Functor m =>
a -> TraceC m b -> TraceC m a
<$ :: forall a b. a -> TraceC m b -> TraceC m a
Functor, Applicative (TraceC m)
Applicative (TraceC m) =>
(forall a b. TraceC m a -> (a -> TraceC m b) -> TraceC m b)
-> (forall a b. TraceC m a -> TraceC m b -> TraceC m b)
-> (forall a. a -> TraceC m a)
-> Monad (TraceC m)
forall a. a -> TraceC m a
forall a b. TraceC m a -> TraceC m b -> TraceC m b
forall a b. TraceC m a -> (a -> TraceC m b) -> TraceC m b
forall (m :: * -> *). Monad m => Applicative (TraceC m)
forall (m :: * -> *) a. Monad m => a -> TraceC m a
forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m b
forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> (a -> TraceC m b) -> TraceC 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
$c>>= :: forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> (a -> TraceC m b) -> TraceC m b
>>= :: forall a b. TraceC m a -> (a -> TraceC m b) -> TraceC m b
$c>> :: forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m b
>> :: forall a b. TraceC m a -> TraceC m b -> TraceC m b
$creturn :: forall (m :: * -> *) a. Monad m => a -> TraceC m a
return :: forall a. a -> TraceC m a
Monad, Monad (TraceC m)
Monad (TraceC m) =>
(forall a. String -> TraceC m a) -> MonadFail (TraceC m)
forall a. String -> TraceC m a
forall (m :: * -> *).
Monad m =>
(forall a. String -> m a) -> MonadFail m
forall (m :: * -> *). MonadFail m => Monad (TraceC m)
forall (m :: * -> *) a. MonadFail m => String -> TraceC m a
$cfail :: forall (m :: * -> *) a. MonadFail m => String -> TraceC m a
fail :: forall a. String -> TraceC m a
Fail.MonadFail, Monad (TraceC m)
Monad (TraceC m) =>
(forall a. (a -> TraceC m a) -> TraceC m a) -> MonadFix (TraceC m)
forall a. (a -> TraceC m a) -> TraceC m a
forall (m :: * -> *).
Monad m =>
(forall a. (a -> m a) -> m a) -> MonadFix m
forall (m :: * -> *). MonadFix m => Monad (TraceC m)
forall (m :: * -> *) a.
MonadFix m =>
(a -> TraceC m a) -> TraceC m a
$cmfix :: forall (m :: * -> *) a.
MonadFix m =>
(a -> TraceC m a) -> TraceC m a
mfix :: forall a. (a -> TraceC m a) -> TraceC m a
MonadFix, Monad (TraceC m)
Monad (TraceC m) =>
(forall a. IO a -> TraceC m a) -> MonadIO (TraceC m)
forall a. IO a -> TraceC m a
forall (m :: * -> *).
Monad m =>
(forall a. IO a -> m a) -> MonadIO m
forall (m :: * -> *). MonadIO m => Monad (TraceC m)
forall (m :: * -> *) a. MonadIO m => IO a -> TraceC m a
$cliftIO :: forall (m :: * -> *) a. MonadIO m => IO a -> TraceC m a
liftIO :: forall a. IO a -> TraceC m a
MonadIO, Monad (TraceC m)
Alternative (TraceC m)
(Alternative (TraceC m), Monad (TraceC m)) =>
(forall a. TraceC m a)
-> (forall a. TraceC m a -> TraceC m a -> TraceC m a)
-> MonadPlus (TraceC m)
forall a. TraceC m a
forall a. TraceC m a -> TraceC m a -> TraceC m a
forall (m :: * -> *). (Alternative m, Monad m) => Monad (TraceC m)
forall (m :: * -> *).
(Alternative m, Monad m) =>
Alternative (TraceC m)
forall (m :: * -> *).
(Alternative m, Monad m) =>
(forall a. m a) -> (forall a. m a -> m a -> m a) -> MonadPlus m
forall (m :: * -> *) a. (Alternative m, Monad m) => TraceC m a
forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m a -> TraceC m a
$cmzero :: forall (m :: * -> *) a. (Alternative m, Monad m) => TraceC m a
mzero :: forall a. TraceC m a
$cmplus :: forall (m :: * -> *) a.
(Alternative m, Monad m) =>
TraceC m a -> TraceC m a -> TraceC m a
mplus :: forall a. TraceC m a -> TraceC m a -> TraceC m a
MonadPlus, (forall (m :: * -> *). Monad m => Monad (TraceC m)) =>
(forall (m :: * -> *) a. Monad m => m a -> TraceC m a)
-> MonadTrans TraceC
forall (m :: * -> *). Monad m => Monad (TraceC m)
forall (m :: * -> *) a. Monad m => m a -> TraceC m a
forall (t :: (* -> *) -> * -> *).
(forall (m :: * -> *). Monad m => Monad (t m)) =>
(forall (m :: * -> *) a. Monad m => m a -> t m a) -> MonadTrans t
$clift :: forall (m :: * -> *) a. Monad m => m a -> TraceC m a
lift :: forall (m :: * -> *) a. Monad m => m a -> TraceC m a
MonadTrans)

instance Algebra sig m => Algebra (Trace :+: sig) (TraceC m) where
  alg :: forall (ctx :: * -> *) (n :: * -> *) a.
Functor ctx =>
Handler ctx n (TraceC m)
-> (:+:) Trace sig n a -> ctx () -> TraceC m (ctx a)
alg Handler ctx n (TraceC m)
hdl (:+:) Trace sig n a
sig ctx ()
ctx = case (:+:) Trace sig n a
sig of
    L (Trace String
m) -> ctx a
ctx ()
ctx ctx a -> TraceC m () -> TraceC m (ctx a)
forall a b. a -> TraceC m b -> TraceC m a
forall (f :: * -> *) a b. Functor f => a -> f b -> f a
<$ WriterC (Endo [String]) m () -> TraceC m ()
forall (m :: * -> *) a. WriterC (Endo [String]) m a -> TraceC m a
TraceC (Endo [String] -> WriterC (Endo [String]) m ()
forall w (sig :: (* -> *) -> * -> *) (m :: * -> *).
Has (Writer w) sig m =>
w -> m ()
tell (([String] -> [String]) -> Endo [String]
forall a. (a -> a) -> Endo a
Endo (String
m String -> [String] -> [String]
forall a. a -> [a] -> [a]
:)))
    R sig n a
other     -> WriterC (Endo [String]) m (ctx a) -> TraceC m (ctx a)
forall (m :: * -> *) a. WriterC (Endo [String]) m a -> TraceC m a
TraceC (Handler ctx n (WriterC (Endo [String]) m)
-> (:+:) (Writer (Endo [String])) sig n a
-> ctx ()
-> WriterC (Endo [String]) m (ctx a)
forall (ctx :: * -> *) (n :: * -> *) a.
Functor ctx =>
Handler ctx n (WriterC (Endo [String]) m)
-> (:+:) (Writer (Endo [String])) sig n a
-> ctx ()
-> WriterC (Endo [String]) m (ctx a)
forall (sig :: (* -> *) -> * -> *) (m :: * -> *) (ctx :: * -> *)
       (n :: * -> *) a.
(Algebra sig m, Functor ctx) =>
Handler ctx n m -> sig n a -> ctx () -> m (ctx a)
alg (TraceC m (ctx x) -> WriterC (Endo [String]) m (ctx x)
forall (m :: * -> *) a. TraceC m a -> WriterC (Endo [String]) m a
runTraceC (TraceC m (ctx x) -> WriterC (Endo [String]) m (ctx x))
-> (ctx (n x) -> TraceC m (ctx x))
-> ctx (n x)
-> WriterC (Endo [String]) m (ctx x)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ctx (n x) -> TraceC m (ctx x)
Handler ctx n (TraceC m)
hdl) (sig n a -> (:+:) (Writer (Endo [String])) sig n a
forall (f :: (* -> *) -> * -> *) (g :: (* -> *) -> * -> *)
       (m :: * -> *) k.
g m k -> (:+:) f g m k
R sig n a
other) ctx ()
ctx)
  {-# INLINE alg #-}