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

-- | A carrier for the 'Control.Effect.Trace' effect that ignores all traced results. Useful when you wish to disable tracing without removing all trace statements.
--
-- @since 1.0.0.0
module Control.Carrier.Trace.Ignoring
( -- * Trace carrier
  runTrace
, TraceC(..)
  -- * Trace effect
, module Control.Effect.Trace
) where

import Control.Algebra
import Control.Applicative (Alternative(..))
import Control.Effect.Trace
import Control.Monad (MonadPlus(..))
import qualified Control.Monad.Fail as Fail
import Control.Monad.Fix
import Control.Monad.IO.Class
import Control.Monad.Trans.Class

-- | Run a 'Trace' effect, ignoring all traces.
--
-- @
-- 'runTrace' ('trace' s) = 'pure' ()
-- @
-- @
-- 'runTrace' ('pure' a) = 'pure' a
-- @
--
-- @since 1.0.0.0
runTrace :: TraceC m a -> m a
runTrace :: TraceC m a -> m a
runTrace (TraceC m :: m a
m) = m a
m

-- | @since 1.0.0.0
newtype TraceC m a = TraceC (m a)
  deriving (Applicative (TraceC m)
TraceC m a
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)
TraceC m a -> TraceC m a -> TraceC m a
TraceC m a -> TraceC m [a]
TraceC m a -> TraceC m [a]
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 => Applicative (TraceC m)
forall (m :: * -> *) a. Alternative m => TraceC m a
forall (m :: * -> *) a. Alternative m => TraceC m a -> TraceC m [a]
forall (m :: * -> *) a.
Alternative m =>
TraceC m a -> TraceC m a -> TraceC m a
many :: TraceC m a -> TraceC m [a]
$cmany :: forall (m :: * -> *) a. Alternative m => TraceC m a -> TraceC m [a]
some :: TraceC m a -> TraceC m [a]
$csome :: forall (m :: * -> *) a. Alternative m => TraceC m a -> TraceC m [a]
<|> :: TraceC m a -> TraceC m a -> TraceC m a
$c<|> :: forall (m :: * -> *) a.
Alternative m =>
TraceC m a -> TraceC m a -> TraceC m a
empty :: TraceC m a
$cempty :: forall (m :: * -> *) a. Alternative m => TraceC m a
$cp1Alternative :: forall (m :: * -> *). Alternative m => Applicative (TraceC m)
Alternative, Functor (TraceC m)
a -> TraceC m a
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)
TraceC m a -> TraceC m b -> TraceC m b
TraceC m a -> TraceC m b -> TraceC m a
TraceC m (a -> b) -> TraceC m a -> TraceC m b
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
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 (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
forall (m :: * -> *). Applicative m => Functor (TraceC m)
forall (m :: * -> *) a. Applicative m => a -> TraceC m a
forall (m :: * -> *) a b.
Applicative m =>
TraceC m a -> TraceC m b -> TraceC m a
forall (m :: * -> *) a b.
Applicative m =>
TraceC m a -> TraceC m b -> TraceC m b
forall (m :: * -> *) a b.
Applicative m =>
TraceC m (a -> b) -> TraceC m a -> TraceC m b
forall (m :: * -> *) a b c.
Applicative m =>
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
<* :: TraceC m a -> TraceC m b -> TraceC m a
$c<* :: forall (m :: * -> *) a b.
Applicative m =>
TraceC m a -> TraceC m b -> TraceC m a
*> :: TraceC m a -> TraceC m b -> TraceC m b
$c*> :: forall (m :: * -> *) a b.
Applicative m =>
TraceC m a -> TraceC m b -> TraceC m b
liftA2 :: (a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
$cliftA2 :: forall (m :: * -> *) a b c.
Applicative m =>
(a -> b -> c) -> TraceC m a -> TraceC m b -> TraceC m c
<*> :: TraceC m (a -> b) -> TraceC m a -> TraceC m b
$c<*> :: forall (m :: * -> *) a b.
Applicative m =>
TraceC m (a -> b) -> TraceC m a -> TraceC m b
pure :: a -> TraceC m a
$cpure :: forall (m :: * -> *) a. Applicative m => a -> TraceC m a
$cp1Applicative :: forall (m :: * -> *). Applicative m => Functor (TraceC m)
Applicative, a -> TraceC m b -> TraceC m a
(a -> b) -> TraceC m a -> TraceC m b
(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
<$ :: a -> TraceC m b -> TraceC m a
$c<$ :: forall (m :: * -> *) a b.
Functor m =>
a -> TraceC m b -> TraceC m a
fmap :: (a -> b) -> TraceC m a -> TraceC m b
$cfmap :: forall (m :: * -> *) a b.
Functor m =>
(a -> b) -> TraceC m a -> TraceC m b
Functor, Applicative (TraceC m)
a -> TraceC m a
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)
TraceC m a -> (a -> TraceC m b) -> TraceC m b
TraceC m a -> TraceC m b -> TraceC m b
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
return :: a -> TraceC m a
$creturn :: forall (m :: * -> *) a. Monad m => a -> TraceC m a
>> :: TraceC m a -> TraceC m b -> TraceC m b
$c>> :: forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> TraceC m b -> TraceC m b
>>= :: TraceC m a -> (a -> TraceC m b) -> TraceC m b
$c>>= :: forall (m :: * -> *) a b.
Monad m =>
TraceC m a -> (a -> TraceC m b) -> TraceC m b
$cp1Monad :: forall (m :: * -> *). Monad m => Applicative (TraceC m)
Monad, Monad (TraceC m)
Monad (TraceC m) =>
(forall a. String -> TraceC m a) -> MonadFail (TraceC m)
String -> TraceC m a
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
fail :: String -> TraceC m a
$cfail :: forall (m :: * -> *) a. MonadFail m => String -> TraceC m a
$cp1MonadFail :: forall (m :: * -> *). MonadFail m => Monad (TraceC m)
Fail.MonadFail, Monad (TraceC m)
Monad (TraceC m) =>
(forall a. (a -> TraceC m a) -> TraceC m a) -> MonadFix (TraceC m)
(a -> TraceC m a) -> TraceC m a
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
mfix :: (a -> TraceC m a) -> TraceC m a
$cmfix :: forall (m :: * -> *) a.
MonadFix m =>
(a -> TraceC m a) -> TraceC m a
$cp1MonadFix :: forall (m :: * -> *). MonadFix m => Monad (TraceC m)
MonadFix, Monad (TraceC m)
Monad (TraceC m) =>
(forall a. IO a -> TraceC m a) -> MonadIO (TraceC m)
IO a -> TraceC m a
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
liftIO :: IO a -> TraceC m a
$cliftIO :: forall (m :: * -> *) a. MonadIO m => IO a -> TraceC m a
$cp1MonadIO :: forall (m :: * -> *). MonadIO m => Monad (TraceC m)
MonadIO, Monad (TraceC m)
Alternative (TraceC m)
TraceC m a
(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)
TraceC m a -> TraceC m a -> TraceC m a
forall a. TraceC m a
forall a. TraceC m a -> TraceC m a -> TraceC m a
forall (m :: * -> *).
(Alternative m, Monad m) =>
(forall a. m a) -> (forall a. m a -> m a -> m a) -> MonadPlus m
forall (m :: * -> *). MonadPlus m => Monad (TraceC m)
forall (m :: * -> *). MonadPlus m => Alternative (TraceC m)
forall (m :: * -> *) a. MonadPlus m => TraceC m a
forall (m :: * -> *) a.
MonadPlus m =>
TraceC m a -> TraceC m a -> TraceC m a
mplus :: TraceC m a -> TraceC m a -> TraceC m a
$cmplus :: forall (m :: * -> *) a.
MonadPlus m =>
TraceC m a -> TraceC m a -> TraceC m a
mzero :: TraceC m a
$cmzero :: forall (m :: * -> *) a. MonadPlus m => TraceC m a
$cp2MonadPlus :: forall (m :: * -> *). MonadPlus m => Monad (TraceC m)
$cp1MonadPlus :: forall (m :: * -> *). MonadPlus m => Alternative (TraceC m)
MonadPlus)

instance MonadTrans TraceC where
  lift :: m a -> TraceC m a
lift = m a -> TraceC m a
forall (m :: * -> *) a. m a -> TraceC m a
TraceC
  {-# INLINE lift #-}

instance Algebra sig m => Algebra (Trace :+: sig) (TraceC m) where
  alg :: (:+:) Trace sig (TraceC m) a -> TraceC m a
alg (L trace :: Trace (TraceC m) a
trace) = Trace (TraceC m) a -> TraceC m a
forall (m :: * -> *) k. Trace m k -> m k
traceCont Trace (TraceC m) a
trace
  alg (R other :: sig (TraceC m) a
other) = m a -> TraceC m a
forall (m :: * -> *) a. m a -> TraceC m a
TraceC (sig m a -> m a
forall (sig :: (* -> *) -> * -> *) (m :: * -> *) a.
Algebra sig m =>
sig m a -> m a
alg (sig (TraceC m) a -> sig m a
forall (sig :: (* -> *) -> * -> *) (f :: * -> *) (g :: * -> *) a.
(HFunctor sig, Functor f, Coercible f g) =>
sig f a -> sig g a
handleCoercible sig (TraceC m) a
other))
  {-# INLINE alg #-}