Safe Haskell	None

Text.RichReports

Description

RichReports

Text/RichReports.hs

A library that supports the manual and automated assembly of modules for building interactive HTML reports consisting of abstract syntax trees as concrete syntax annotated with the results of static analysis and abstract interpretation algorithms.

Web: richreports.org Version: 0.0.3.0

Synopsis

Documentation

type Message = Report Source

Rich report data structure definitions.

data Highlight Source

Constructors

HighlightUnbound
HighlightUnreachable
HighlightDuplicate
HighlightError
Highlight [Class]

Instances

Eq Highlight
Show Highlight

data Entity Source

Constructors

Lt
Gt
Space
Ampersand

Instances

Eq Entity
Show Entity

data Report Source

Constructors

Entity Entity
Text String
Symbol String
Punctuation String
Keyword String
Literal String
Konstant String
Operator String
Builtin String
Library String
Variable String
Error String
Atom [Highlight] [Message] [Report]
Span [Highlight] [Message] [Report]
Line [Report]
Block [Highlight] [Message] [Report]
Concat [Report]
Intersperse Report [Report]
Field [Report]
Row [Report]
Table [Report]
Page Report

Instances

Eq Report
Show Report
ToHTML Report

class ToReport a whereSource

Rich report class declaration (typically, abstract syntax data structures would be members).

Methods

report :: a -> Report Source

Instances

ToReport a => ToReport [a]	Default class memberships for polymorphic types.
ToReport a => ToReport (Maybe a)

class ToHighlights a whereSource

Rich report highlight and message class declaration (typically, static analysis results data structures would be members).

Methods

highlights :: a -> [Highlight]Source

class ToMessages a whereSource

Methods

messages :: a -> [Message]Source

highlightsStr :: [Highlight] -> [Class]Source

Generation of an interactive HTML version of the report.

highlightStr :: Highlight -> [Class]Source

entityStr :: Entity -> String Source

messagesToAttr :: [Message] -> (Property, Value)Source