Highlight.Common.Monad

Documentation

newtype CommonHighlightM r s e a

This is the common monad for both highlight and hrep. It has been kept polymorphic here so it can be easily specialized by highlight and hrep.

r is the options or config type. s is the state. e is the error.

Constructors

CommonHighlightM

Fields

• unCommonHighlightM :: ReaderT r (StateT s (ExceptT e IO)) a

Instances

MonadState s (CommonHighlightM r s e)

Methods

get :: CommonHighlightM r s e s

put :: s -> CommonHighlightM r s e ()

state :: (s -> (a, s)) -> CommonHighlightM r s e a

MonadReader r (CommonHighlightM r s e)

Methods

ask :: CommonHighlightM r s e r

local :: (r -> r) -> CommonHighlightM r s e a -> CommonHighlightM r s e a

reader :: (r -> a) -> CommonHighlightM r s e a

MonadError e (CommonHighlightM r s e)

Methods

throwError :: e -> CommonHighlightM r s e a

catchError :: CommonHighlightM r s e a -> (e -> CommonHighlightM r s e a) -> CommonHighlightM r s e a

Monad (CommonHighlightM r s e)

Methods

(>>=) :: CommonHighlightM r s e a -> (a -> CommonHighlightM r s e b) -> CommonHighlightM r s e b

(>>) :: CommonHighlightM r s e a -> CommonHighlightM r s e b -> CommonHighlightM r s e b

return :: a -> CommonHighlightM r s e a

fail :: String -> CommonHighlightM r s e a

Functor (CommonHighlightM r s e)

Methods

fmap :: (a -> b) -> CommonHighlightM r s e a -> CommonHighlightM r s e b

(<$) :: a -> CommonHighlightM r s e b -> CommonHighlightM r s e a

Applicative (CommonHighlightM r s e)

Methods

pure :: a -> CommonHighlightM r s e a

(<*>) :: CommonHighlightM r s e (a -> b) -> CommonHighlightM r s e a -> CommonHighlightM r s e b

(*>) :: CommonHighlightM r s e a -> CommonHighlightM r s e b -> CommonHighlightM r s e b

(<*) :: CommonHighlightM r s e a -> CommonHighlightM r s e b -> CommonHighlightM r s e a

MonadIO (CommonHighlightM r s e)

Methods

liftIO :: IO a -> CommonHighlightM r s e a

runCommonHighlightM :: r -> s -> CommonHighlightM r s e a -> IO (Either e a)

Given an r and s, run CommonHighlightM.

getIgnoreCaseM :: (HasIgnoreCase r, MonadReader r m) => m IgnoreCase

Get the IgnoreCase option.

getRecursiveM :: (HasRecursive r, MonadReader r m) => m Recursive

Get the Recursive option.

getRawRegexM :: (HasRawRegex r, MonadReader r m) => m RawRegex

Get the RawRegex option.

getInputFilenamesM :: (HasInputFilenames r, MonadReader r m) => m [InputFilename]

Get a list of the InputFilename.

throwHighlightErr :: HighlightErr -> CommonHighlightM r s HighlightErr a

Throw a HighlightErr.

throwRegexCompileErr :: RawRegex -> CommonHighlightM r s HighlightErr a

Throw a HighlightRegexCompileErr.

compileHighlightRegexWithErr :: (HasIgnoreCase r, HasRawRegex r) => CommonHighlightM r s HighlightErr RE

Call compileHighlightRegex. Throw a HighlightErr if the regex cannot be compiled.

compileHighlightRegex :: IgnoreCase -> RawRegex -> Maybe RE

Try compiling a RawRegex into a RE.

Setup for examples:

>>> import Data.Maybe (isJust)

Return Just for a proper regex:

>>> isJust $ compileHighlightRegex IgnoreCase (RawRegex "good regex")
True

Return Nothing for an improper regex:

>>> isJust $ compileHighlightRegex IgnoreCase (RawRegex "bad regex (")
False

module Highlight.Common.Monad.Input

module Highlight.Common.Monad.Output