Html.SyntaxColoring

This module arranges the tokens of the module into different code categories for HTML presentation. The parsed and qualified module is used to establish links between used identifiers and their definitions.

The fully qualified module is traversed to generate a list of code elements. Code elements representing identifiers are distinguished by their kind (type constructor, data constructor, function, (type) variable). They include information about their usage (i.e., declaration, call etc.) and whether the identifier occurs fully qualified in the source code or not. Initially, all identifier codes are fully qualified.

In a next step, the token stream of the given program and the code list are traversed sequentially (see encodeToks). The information in the token stream is used to:

• add code elements for newlines, spaces and pragmas
• update the qualification information of identifiers in the code list.

Documentation

data Code

Type of codes which are distinguished for HTML output the boolean flags indicate whether the corresponding identifier occurs qualified in the source module

Constructors

Keyword String

Space Int

NewLine

Pragma String

TypeCons TypeUsage Bool QualIdent

DataCons ConsUsage Bool QualIdent

Function FuncUsage Bool QualIdent

Identifier IdentUsage Bool QualIdent

ModuleName ModuleIdent

Commentary String

NumberCode String

StringCode String

CharCode String

Symbol String

Instances

Show Code

Defined in Html.SyntaxColoring

Methods

showsPrec :: Int -> Code -> ShowS

show :: Code -> String

showList :: [Code] -> ShowS

data TypeUsage

Constructors

TypeDeclare

TypeRefer

TypeExport

TypeImport

Instances

Show TypeUsage

Defined in Html.SyntaxColoring

Methods

showsPrec :: Int -> TypeUsage -> ShowS

show :: TypeUsage -> String

showList :: [TypeUsage] -> ShowS

data ConsUsage

Constructors

ConsDeclare

ConsPattern

ConsCall

ConsInfix

ConsExport

ConsImport

Instances

Show ConsUsage

Defined in Html.SyntaxColoring

Methods

showsPrec :: Int -> ConsUsage -> ShowS

show :: ConsUsage -> String

showList :: [ConsUsage] -> ShowS

data IdentUsage

Constructors

IdDeclare

IdRefer

IdUnknown

Instances

Show IdentUsage

Defined in Html.SyntaxColoring

Methods

showsPrec :: Int -> IdentUsage -> ShowS

show :: IdentUsage -> String

showList :: [IdentUsage] -> ShowS

data FuncUsage

Constructors

FuncDeclare

FuncTypeSig

FuncCall

FuncInfix

FuncExport

FuncImport

Instances

Show FuncUsage

Defined in Html.SyntaxColoring

Methods

showsPrec :: Int -> FuncUsage -> ShowS

show :: FuncUsage -> String

showList :: [FuncUsage] -> ShowS

genProgram :: Module a -> [(Position, Token)] -> [Code]

code2string :: Code -> String

getQualIdent :: Code -> Maybe QualIdent