cco-0.0.3: Utilities for compiler construction Contents Index

CCO.Feedback Portability portable Stability provisional Maintainer stefan@cs.uu.nl

Contents Messages The Feedback monad

Description

A monad for keeping track of log, warning, and error messages.

Synopsis

data Message = Log Int Doc | Warning Int Doc | Error Doc isError :: Message -> Bool fromMessage :: Message -> Doc data Feedback a trace :: Int -> String -> Feedback () trace_ :: String -> Feedback () warn :: Int -> String -> Feedback () warn_ :: String -> Feedback () errorMessage :: Doc -> Feedback a message :: Message -> Feedback () messages :: [Message] -> Feedback () wError :: Feedback a -> Feedback a succeeding :: Feedback a -> Bool failing :: Feedback a -> Bool runFeedback :: Feedback a -> Int -> Int -> Handle -> IO (Maybe a)

Messages

data Message

Type of messages. Each Message holds a pretty-printable document in which the text for the message is stored. Constructors Log Int Doc A log message at a specified verbosity level, the default level being 1. Warning Int Doc A warning message at a specified severity level, the default level being 1. Error Doc An error message.

isError :: Message -> Bool

Indicates whether a Message is an Error message.

fromMessage :: Message -> Doc

Retrieves the Doc stored in a Message.

The Feedback monad

data Feedback a

The Feedback monad. Keeps track of Messages, failing if an Error message is encountered. Instances Monad Feedback Functor Feedback

trace :: Int -> String -> Feedback ()

Issues a Log message at a specified verbosity level containing a specified text.

trace_ :: String -> Feedback ()

Issues a Log message at the default verbosity level 1 containing a specified text.

warn :: Int -> String -> Feedback ()

Issues a Warning message at a specified severity level containing a specified text.

warn_ :: String -> Feedback ()

Issues a Warning message at the default severity level 1 containing a specified text.

errorMessage :: Doc -> Feedback a

Issues an Error message.

message :: Message -> Feedback ()

Issues a Message. Fails if an Error message is issued.

messages :: [Message] -> Feedback ()

Issues a list of Messages. Fails if the list contains an Error message.

wError :: Feedback a -> Feedback a

Turns all Warning messages into Error messages.

succeeding :: Feedback a -> Bool

Retrieves whether a Feedback computation will succeed.

failing :: Feedback a -> Bool

Retrieves whether a Feedback computation will fail.

runFeedback :: Feedback a -> Int -> Int -> Handle -> IO (Maybe a)

Runs a Feedback computation at a specified verbosity and severity level, pretty printing messages onto a specified Handle.

Produced by Haddock version 2.3.0