Text.Chatty.Printer

Provides a typeclass for all monads that may print text.

Documentation

class Monad m => MonadPrinter m where

A typeclass for all monads that may output strings.

Methods

mprint :: String -> m ()

Just print it!

mnoecho :: String -> m ()

Print it, except you are IO.

mflush :: m ()

Flush the buffer.

Instances

MonadPrinter IO

MonadPrinter m0 => MonadPrinter (HandleCloserT m0)

MonadPrinter m0 => MonadPrinter (InRedirT m0)

MonadPrinter m0 => MonadPrinter (QuietT m0)

MonadPrinter m0 => MonadPrinter (HereStringT m0)

Monad m => MonadPrinter (RecorderT m)

MonadIO m => MonadPrinter (OutRedirT m)

Monad m => MonadPrinter (DeafT m)

MonadPrinter m0 => MonadPrinter (SpawnOverlayT m0)

MonadPrinter m => MonadPrinter (HtmlPrinterT m)

MonadPrinter m => MonadPrinter (AnsiPrinterT m)

MonadPrinter m0 => MonadPrinter (NullExpanderT m0)

MonadPrinter m0 => MonadPrinter (ExpanderT m0)

MonadPrinter m0 => MonadPrinter (HistoryT m0)

Monad m => MonadPrinter (StateT String m)

(Eq c, MonadPrinter m) => MonadPrinter (FilterT c m)

(Eq c, Monad m) => MonadPrinter (ArchiverT c m)

newtype DeafT m a

DeafT discards all output (much like >/dev/null in the shell)

Constructors

Deaf

Fields

runDeafT :: m a

Instances

MonadTrans DeafT

RedirectionTarget DiscardO DeafT a a

Monad m => Monad (DeafT m)

Functor m => Functor (DeafT m)

MonadIO m => MonadIO (DeafT m)

MonadRandom m0 => MonadRandom (DeafT m0)

MonadClock m0 => MonadClock (DeafT m0)

MonadFinalizer m0 => MonadFinalizer (DeafT m0)

MonadScanner m0 => MonadScanner (DeafT m0)

Monad m => MonadPrinter (DeafT m)

MonadSpawn m0 => MonadSpawn (DeafT m0)

MonadExpand m0 => MonadExpand (DeafT m0)

ExpanderEnv m0 => ExpanderEnv (DeafT m0)

HistoryEnv m0 => HistoryEnv (DeafT m0)

newtype OutRedirT m a

Redirects all output to a given handle (much like >filename in the shell)

Constructors

OutRedir

Fields

runOutRedirT' :: Handle -> m (a, Handle)

Instances

MonadTrans OutRedirT

RedirectionTarget FilePath OutRedirT a a

Monad m => Monad (OutRedirT m)

Monad m => Functor (OutRedirT m)

MonadIO m => MonadIO (OutRedirT m)

MonadRandom m0 => MonadRandom (OutRedirT m0)

MonadClock m0 => MonadClock (OutRedirT m0)

MonadFinalizer m0 => MonadFinalizer (OutRedirT m0)

MonadScanner m0 => MonadScanner (OutRedirT m0)

MonadIO m => MonadPrinter (OutRedirT m)

MonadSpawn m0 => MonadSpawn (OutRedirT m0)

MonadExpand m0 => MonadExpand (OutRedirT m0)

ExpanderEnv m0 => ExpanderEnv (OutRedirT m0)

HistoryEnv m0 => HistoryEnv (OutRedirT m0)

type OutRedir = OutRedirT IO

OutRedirT on a blank IO monad

runOutRedirT :: Functor m => OutRedirT m a -> Handle -> m a

Run OutRedirT with a Handle

runOutRedir :: OutRedir a -> Handle -> IO a

Run OutRedir with a Handle

runOutRedirFT :: (Functor m, MonadIO m) => OutRedirT m a -> FilePath -> IOMode -> m a

Run OutRedirT with a FilePath

runOutRedirF :: OutRedir a -> FilePath -> IOMode -> IO a

Run OutRedir with a FilePath

newtype RecorderT m a

Catches all output (much like VAR=$(...) in the shell)

Constructors

Recorder

Fields

runRecorderT' :: [String] -> m (a, [String])

Instances

MonadTrans RecorderT

RedirectionTarget RecordO RecorderT a (a, Replayable)

Monad m => Monad (RecorderT m)

Monad m => Functor (RecorderT m)

MonadIO m => MonadIO (RecorderT m)

MonadRandom m0 => MonadRandom (RecorderT m0)

MonadClock m0 => MonadClock (RecorderT m0)

MonadFinalizer m0 => MonadFinalizer (RecorderT m0)

MonadScanner m0 => MonadScanner (RecorderT m0)

Monad m => MonadPrinter (RecorderT m)

MonadSpawn m0 => MonadSpawn (RecorderT m0)

MonadExpand m0 => MonadExpand (RecorderT m0)

ExpanderEnv m0 => ExpanderEnv (RecorderT m0)

HistoryEnv m0 => HistoryEnv (RecorderT m0)

type Recorder = RecorderT Identity

RecorderT on the Identity

newtype Replayable

The recorder state. Use this together with replay, replayM or replay_.

Constructors

Replayable [String]

Instances

Show Replayable

RedirectionTarget RecordO RecorderT a (a, Replayable)

replayM :: Monad m => m Replayable -> m String

Replay a recorder state inside a Monad.

replay :: Replayable -> String

Replay a recorder state in a pure context.

replay_ :: Monad m => RecorderT m String

Replay the current recorder state without leaving the recorder.

runRecorder :: Recorder a -> (a, Replayable)

Run Recorder and also return its state.

runRecorderT :: (Functor m, Monad m) => RecorderT m a -> m (a, Replayable)

Run RecorderT and also return its state.

mprintLn :: MonadPrinter m => String -> m ()

Line-terminating alternative to mprint

data DiscardO

Redirection target that discards input.

Constructors

DiscardO

Instances

RedirectionTarget DiscardO DeafT a a

data RecordO

Redirection target that records input.

Constructors

RecordO

Instances

RedirectionTarget RecordO RecorderT a (a, Replayable)

class RedirectionTarget t mt a r | t -> mt, t a -> r where

Class for all redirection targets.

Methods

(.>.) :: (Functor m, MonadIO m, MonadPrinter (mt m)) => mt m a -> t -> m r

Overwriting redirection.

(.>>.) :: (Functor m, MonadIO m, MonadPrinter (mt m)) => mt m a -> t -> m r

Appending redirection.

Instances

RedirectionTarget FilePath OutRedirT a a

RedirectionTarget DiscardO DeafT a a

RedirectionTarget RecordO RecorderT a (a, Replayable)