Text.Chatty.Scanner

Provides a typeclass for all monads that may scan text.

Documentation

class Monad m => MonadScanner m where

A typeclass for all monads that may read input.

Methods

mscan1 :: m Char

Read one single character

mscanL :: m String

Lazily read all the input.

mscannable :: m Bool

Input readable? (not EOF)

mscanh :: m (Maybe Handle)

Return FD handle, if available

mready :: m Bool

Input available yet?

Instances

MonadScanner IO

MonadScanner m0 => MonadScanner (HandleCloserT m0)

MonadIO m => MonadScanner (InRedirT m)

Monad m => MonadScanner (QuietT m)

Monad m => MonadScanner (HereStringT m)

MonadScanner m0 => MonadScanner (RecorderT m0)

MonadScanner m0 => MonadScanner (OutRedirT m0)

MonadScanner m0 => MonadScanner (DeafT m0)

MonadScanner m0 => MonadScanner (SpawnOverlayT m0)

MonadScanner m0 => MonadScanner (JoinerT m0)

MonadScanner m0 => MonadScanner (HandleFilterT m0)

MonadScanner m0 => MonadScanner (BoolFilterT m0)

MonadScanner m0 => MonadScanner (IntFilterT m0)

MonadScanner m0 => MonadScanner (HandleArchiverT m0)

MonadScanner m0 => MonadScanner (BoolArchiverT m0)

MonadScanner m0 => MonadScanner (IntArchiverT m0)

MonadScanner m0 => MonadScanner (NullExpanderT m0)

MonadScanner m0 => MonadScanner (ExpanderT m0)

MonadScanner m0 => MonadScanner (HistoryT m0)

MonadScanner m0 => MonadScanner (HtmlPrinterT m0)

MonadScanner m0 => MonadScanner (AnsiPrinterT m0)

Monad m => MonadScanner (StateT String m)

newtype HereStringT m a

HereStringT holds a given string and uses it as input for the function (much like here-strings in the shell)

Constructors

HereString

Fields

runHereStringT :: String -> m (a, String)

Instances

MonadTrans HereStringT

RedirectionHeredoc String HereStringT a a

ChannelPrinter Bool m0 => ChannelPrinter Bool (HereStringT m0)

ChannelPrinter Int m0 => ChannelPrinter Int (HereStringT m0)

ChannelPrinter Handle m0 => ChannelPrinter Handle (HereStringT m0)

Monad m => Monad (HereStringT m)

Monad m => Functor (HereStringT m)

MonadIO m => MonadIO (HereStringT m)

MonadRandom m0 => MonadRandom (HereStringT m0)

MonadClock m0 => MonadClock (HereStringT m0)

MonadFinalizer m => MonadFinalizer (HereStringT m)

Monad m => MonadScanner (HereStringT m)

MonadPrinter m0 => MonadPrinter (HereStringT m0)

MonadSpawn m0 => MonadSpawn (HereStringT m0)

ExtendedPrinter m0 => ExtendedPrinter (HereStringT m0)

MonadExpand m0 => MonadExpand (HereStringT m0)

ExpanderEnv m0 => ExpanderEnv (HereStringT m0)

HistoryEnv m0 => HistoryEnv (HereStringT m0)

newtype QuietT m a

QuietT does not convey any input (much like <devnull in the shell)

Constructors

Quiet

Fields

runQuietT :: m a

Instances

MonadTrans QuietT

RedirectionSource EmptyI QuietT a a

ChannelPrinter Bool m0 => ChannelPrinter Bool (QuietT m0)

ChannelPrinter Int m0 => ChannelPrinter Int (QuietT m0)

ChannelPrinter Handle m0 => ChannelPrinter Handle (QuietT m0)

Monad m => Monad (QuietT m)

Functor m => Functor (QuietT m)

MonadRandom m0 => MonadRandom (QuietT m0)

MonadClock m0 => MonadClock (QuietT m0)

Monad m => MonadScanner (QuietT m)

MonadPrinter m0 => MonadPrinter (QuietT m0)

MonadSpawn m0 => MonadSpawn (QuietT m0)

ExtendedPrinter m0 => ExtendedPrinter (QuietT m0)

MonadExpand m0 => MonadExpand (QuietT m0)

ExpanderEnv m0 => ExpanderEnv (QuietT m0)

HistoryEnv m0 => HistoryEnv (QuietT m0)

newtype InRedirT m a

InRedirT redirects all input to a given handle (much like <filename in the shell)

Constructors

InRedir

Fields

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

Instances

MonadTrans InRedirT

RedirectionSource FilePath InRedirT a a

ChannelPrinter Bool m0 => ChannelPrinter Bool (InRedirT m0)

ChannelPrinter Int m0 => ChannelPrinter Int (InRedirT m0)

ChannelPrinter Handle m0 => ChannelPrinter Handle (InRedirT m0)

Monad m => Monad (InRedirT m)

Monad m => Functor (InRedirT m)

MonadIO m => MonadIO (InRedirT m)

MonadRandom m0 => MonadRandom (InRedirT m0)

MonadClock m0 => MonadClock (InRedirT m0)

MonadFinalizer m => MonadFinalizer (InRedirT m)

MonadIO m => MonadScanner (InRedirT m)

MonadPrinter m0 => MonadPrinter (InRedirT m0)

MonadSpawn m0 => MonadSpawn (InRedirT m0)

ExtendedPrinter m0 => ExtendedPrinter (InRedirT m0)

MonadExpand m0 => MonadExpand (InRedirT m0)

ExpanderEnv m0 => ExpanderEnv (InRedirT m0)

HistoryEnv m0 => HistoryEnv (InRedirT m0)

type InRedir = InRedirT (HandleCloserT IO)

InRedirT on an IO monad

runInRedirT :: Functor m => InRedirT m a -> Handle -> m a

Run InRedirT with handle

runInRedir :: InRedir a -> Handle -> IO a

Run InRedir with handle

runInRedirFT :: (Functor m, MonadIO m, MonadFinalizer m) => InRedirT m a -> FilePath -> m a

Run InRedirT with a filename

runInRedirF :: InRedir a -> FilePath -> IO a

Run InRedir with a filename

mscanLn :: MonadScanner m => m String

Line-scanning alternative to mscan1/L

mscanN :: MonadScanner m => Int -> m String

Scan a fixed number of chars

data EmptyI

Redirection source that does not provide any output

Constructors

EmptyI

Instances

RedirectionSource EmptyI QuietT a a

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

Class for all primitive redirection sources.

Methods

(.<.) :: (MonadFinalizer m, Functor m, MonadIO m, MonadScanner (mt m)) => mt m a -> t -> m a

Redirection

Instances

RedirectionSource FilePath InRedirT a a

RedirectionSource EmptyI QuietT a a

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

Class for all Here-Documents

Methods

(.<<.) :: (Functor m, MonadScanner (mt m)) => mt m a -> t -> m a

Redirection

Instances

RedirectionHeredoc String HereStringT a a