Text.RichReports

Rich Reports

Text/RichReports.hs

Definitions for the representation and construction of a data structure corresponding to a structured representation of the concrete syntax of a programming language, with annotations corresponding to static analysis results. Includes support for generation of ASCII text, as well as formatted HTML with interactive messages.

Documentation

type Message = Report

Data structures (also used for report construction process) and classes.

data Highlight

Constructors

HighlightUnbound

HighlightUnreachable

HighlightDuplicate

HighlightError

Highlight [Class]

Instances

Eq Highlight

Show Highlight

data Category

Constructors

Keyword

Literal

Constant

Variable

Error

Instances

Eq Category

Show Category

data Report

Constructors

Text String

C Category [Highlight] [Message] String

Space

Lt

Gt

Conc [Report]

Field Report

Row [Report]

Table [Report]

Indent Report

Line [String] [Report]

LineIfFlat [String] Report

Atom [Highlight] [Message] [Report]

Span [Highlight] [Message] [Report]

Block [Highlight] [Message] [Report]

BlockIndent [Highlight] [Message] [Report]

Intersperse Report [Report]

Finalize Report

Instances

Eq Report

Show Report

ToHTML Report

class ToReport a where

Methods

report :: a -> Report

Instances

ToReport a => ToReport [a]

Default class members.

ToReport a => ToReport (Maybe a)

class ToHighlights a where

Methods

highlights :: a -> [Highlight]

class ToMessages a where

Methods

messages :: a -> [Message]

keyword :: String -> Report

Concise synonyms.

keyword_ :: [Highlight] -> [Message] -> String -> Report

key :: String -> Report

key_ :: [Highlight] -> [Message] -> String -> Report

literal :: String -> Report

literal_ :: [Highlight] -> [Message] -> String -> Report

lit :: String -> Report

lit_ :: [Highlight] -> [Message] -> String -> Report

constant :: String -> Report

constant_ :: [Highlight] -> [Message] -> String -> Report

const :: String -> Report

const_ :: [Highlight] -> [Message] -> String -> Report

variable :: String -> Report

variable_ :: [Highlight] -> [Message] -> String -> Report

var :: String -> Report

var_ :: [Highlight] -> [Message] -> String -> Report

error :: String -> Report

error_ :: [Highlight] -> [Message] -> String -> Report

err :: String -> Report

err_ :: [Highlight] -> [Message] -> String -> Report

highlight :: Highlight -> [Class]

Generation of an interactive HTML version of the report.

messageToAttr :: [Message] -> (Property, Value)