Text.Chatty.Scanner

Provides a typeclass for all monads that may scan text.

Documentation

class Monad m => ChScanner m where

A typeclass for all monads that may read input.

Minimal complete definition

mscan1, mscanL, mscannable, mready

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

ChScanner IO

Methods

mscan1 :: IO Char

mscanL :: IO String

mscannable :: IO Bool

mscanh :: IO (Maybe Handle)

mready :: IO Bool

MonadIO m => ChScanner (InRedirT m)

Methods

mscan1 :: InRedirT m Char

mscanL :: InRedirT m String

mscannable :: InRedirT m Bool

mscanh :: InRedirT m (Maybe Handle)

mready :: InRedirT m Bool

Monad m => ChScanner (QuietT m)

Methods

mscan1 :: QuietT m Char

mscanL :: QuietT m String

mscannable :: QuietT m Bool

mscanh :: QuietT m (Maybe Handle)

mready :: QuietT m Bool

Monad m => ChScanner (HereStringT m)

Methods

mscan1 :: HereStringT m Char

mscanL :: HereStringT m String

mscannable :: HereStringT m Bool

mscanh :: HereStringT m (Maybe Handle)

mready :: HereStringT m Bool

ChScanner m => ChScanner (ScannerBufferT m)

Methods

mscan1 :: ScannerBufferT m Char

mscanL :: ScannerBufferT m String

mscannable :: ScannerBufferT m Bool

mscanh :: ScannerBufferT m (Maybe Handle)

mready :: ScannerBufferT m Bool

ChAtoms m => ChScanner (FileScannerT m)

Methods

mscan1 :: FileScannerT m Char

mscanL :: FileScannerT m String

mscannable :: FileScannerT m Bool

mscanh :: FileScannerT m (Maybe Handle)

mready :: FileScannerT m Bool

Monad m => ChScanner (StateT String m)

Methods

mscan1 :: StateT String m Char

mscanL :: StateT String m String

mscannable :: StateT String m Bool

mscanh :: StateT String m (Maybe Handle)

mready :: StateT String m Bool

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

Methods

lift :: Monad m => m a -> HereStringT m a

RedirectionHeredoc String HereStringT a a

Methods

(.<<.) :: (Functor m, ChScanner (HereStringT m)) => HereStringT m a -> String -> m a

Monad m => Monad (HereStringT m)

Methods

(>>=) :: HereStringT m a -> (a -> HereStringT m b) -> HereStringT m b

(>>) :: HereStringT m a -> HereStringT m b -> HereStringT m b

return :: a -> HereStringT m a

fail :: String -> HereStringT m a

Monad m => Functor (HereStringT m)

Methods

fmap :: (a -> b) -> HereStringT m a -> HereStringT m b

(<$) :: a -> HereStringT m b -> HereStringT m a

Monad m => Applicative (HereStringT m)

Methods

pure :: a -> HereStringT m a

(<*>) :: HereStringT m (a -> b) -> HereStringT m a -> HereStringT m b

(*>) :: HereStringT m a -> HereStringT m b -> HereStringT m b

(<*) :: HereStringT m a -> HereStringT m b -> HereStringT m a

MonadIO m => MonadIO (HereStringT m)

Methods

liftIO :: IO a -> HereStringT m a

ChFinalizer m => ChFinalizer (HereStringT m)

Methods

mqfh :: Handle -> HereStringT m ()

mqfhs :: [Handle] -> HereStringT m ()

mfin :: HereStringT m ()

Monad m => ChScanner (HereStringT m)

Methods

mscan1 :: HereStringT m Char

mscanL :: HereStringT m String

mscannable :: HereStringT m Bool

mscanh :: HereStringT m (Maybe Handle)

mready :: HereStringT m Bool

Monad m => ChBufferedScanner (HereStringT m)

Methods

mpeek1 :: HereStringT m Char

mprepend :: String -> HereStringT m ()

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

Methods

lift :: Monad m => m a -> QuietT m a

RedirectionSource EmptyI QuietT a a

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (QuietT m)) => QuietT m a -> EmptyI -> m a

Monad m => Monad (QuietT m)

Methods

(>>=) :: QuietT m a -> (a -> QuietT m b) -> QuietT m b

(>>) :: QuietT m a -> QuietT m b -> QuietT m b

return :: a -> QuietT m a

fail :: String -> QuietT m a

Functor m => Functor (QuietT m)

Methods

fmap :: (a -> b) -> QuietT m a -> QuietT m b

(<$) :: a -> QuietT m b -> QuietT m a

(Functor m, Monad m) => Applicative (QuietT m)

Methods

pure :: a -> QuietT m a

(<*>) :: QuietT m (a -> b) -> QuietT m a -> QuietT m b

(*>) :: QuietT m a -> QuietT m b -> QuietT m b

(<*) :: QuietT m a -> QuietT m b -> QuietT m a

Monad m => ChScanner (QuietT m)

Methods

mscan1 :: QuietT m Char

mscanL :: QuietT m String

mscannable :: QuietT m Bool

mscanh :: QuietT m (Maybe Handle)

mready :: QuietT m Bool

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

Instances

MonadTrans InRedirT

Methods

lift :: Monad m => m a -> InRedirT m a

RedirectionSource Handle InRedirT a a

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (InRedirT m)) => InRedirT m a -> Handle -> m a

RedirectionSource FilePath InRedirT a a

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (InRedirT m)) => InRedirT m a -> FilePath -> m a

Monad m => Monad (InRedirT m)

Methods

(>>=) :: InRedirT m a -> (a -> InRedirT m b) -> InRedirT m b

(>>) :: InRedirT m a -> InRedirT m b -> InRedirT m b

return :: a -> InRedirT m a

fail :: String -> InRedirT m a

Monad m => Functor (InRedirT m)

Methods

fmap :: (a -> b) -> InRedirT m a -> InRedirT m b

(<$) :: a -> InRedirT m b -> InRedirT m a

Monad m => Applicative (InRedirT m)

Methods

pure :: a -> InRedirT m a

(<*>) :: InRedirT m (a -> b) -> InRedirT m a -> InRedirT m b

(*>) :: InRedirT m a -> InRedirT m b -> InRedirT m b

(<*) :: InRedirT m a -> InRedirT m b -> InRedirT m a

MonadIO m => MonadIO (InRedirT m)

Methods

liftIO :: IO a -> InRedirT m a

ChFinalizer m => ChFinalizer (InRedirT m)

Methods

mqfh :: Handle -> InRedirT m ()

mqfhs :: [Handle] -> InRedirT m ()

mfin :: InRedirT m ()

MonadIO m => ChScanner (InRedirT m)

Methods

mscan1 :: InRedirT m Char

mscanL :: InRedirT m String

mscannable :: InRedirT m Bool

mscanh :: InRedirT m (Maybe Handle)

mready :: InRedirT m Bool

type InRedir = InRedirT (HandleCloserT IO)

InRedirT on an IO monad

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

Run InRedir with handle

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

Run InRedirT with a filename

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

Run InRedir with a filename

mscanLn :: ChScanner m => m String

Line-scanning alternative to mscan1/L

mscanN :: ChScanner 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

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (QuietT m)) => QuietT m a -> EmptyI -> m a

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

Class for all primitive redirection sources.

Minimal complete definition

(.<.)

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (mt m)) => mt m a -> t -> m r

Redirection

Instances

RedirectionSource Handle InRedirT a a

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (InRedirT m)) => InRedirT m a -> Handle -> m a

RedirectionSource FilePath InRedirT a a

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (InRedirT m)) => InRedirT m a -> FilePath -> m a

RedirectionSource EmptyI QuietT a a

Methods

(.<.) :: (ChFinalizer m, Functor m, MonadIO m, ChScanner (QuietT m)) => QuietT m a -> EmptyI -> m a

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

Class for all Here-Documents

Minimal complete definition

(.<<.)

Methods

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

Redirection

Instances

RedirectionHeredoc String HereStringT a a

Methods

(.<<.) :: (Functor m, ChScanner (HereStringT m)) => HereStringT m a -> String -> m a