Copyright	Copyright (C) 2008 John MacFarlane
License	GNU GPL, version 2 or above
Maintainer	John MacFarlane <jgm@berkeley.edu>
Stability	alpha
Portability	portable
Safe Haskell	Safe
Language	Haskell98

Text.Highlighting.Kate.Types

Description

Definitions for data structures needed by highlighting-kate.

Synopsis

Documentation

type Context = (String, String) Source

A context: pair of syntax name and context name.

type ContextStack = [Context] Source

A stack of contexts. (Language-specific context stacks must be maintained because of IncludeRules.)

data SyntaxState Source

State for syntax parser.

Constructors

SyntaxState

Fields

synStContexts :: ContextStack: Stack of contexts
synStLineNumber :: Int: Number of current line
synStPrevChar :: Char: Last character parsed
synStPrevNonspace :: Bool: True if we've parsed a nonspace
synStContinuation :: Bool: True if last thing parsed is a LineContinue
synStCaseSensitive :: Bool: Language is case-sensitive
synStKeywordCaseSensitive :: Bool: Keywords are case-sensitive
synStCaptures :: [String]: List of regex captures from last capturing match

Instances

Show SyntaxState Source

defaultSyntaxState :: SyntaxState Source

type Token = (TokenType, String) Source

A pair consisting of a list of attributes and some text.

type SourceLine = [Token] Source

A line of source, list of labeled source items.

type KateParser = GenParser Char SyntaxState Source

data TokenStyle Source

Constructors

TokenStyle
Fields tokenColor :: Maybe Color tokenBackground :: Maybe Color tokenBold :: Bool tokenItalic :: Bool tokenUnderline :: Bool

Instances

Data TokenStyle Source
Read TokenStyle Source
Show TokenStyle Source

defStyle :: TokenStyle Source

data Color Source

Constructors

RGB Word8 Word8 Word8

Instances

Data Color Source
Read Color Source
Show Color Source

class ToColor a where Source

Methods

toColor :: a -> Maybe Color Source

Instances

ToColor Int Source
ToColor String Source
ToColor (Double, Double, Double) Source
ToColor (Word8, Word8, Word8) Source

class FromColor a where Source

Methods

fromColor :: Color -> a Source

Instances

FromColor String Source
FromColor (Double, Double, Double) Source
FromColor (Word8, Word8, Word8) Source

data Style Source

Constructors

Style
Fields tokenStyles :: [(TokenType, TokenStyle)] defaultColor :: Maybe Color backgroundColor :: Maybe Color lineNumberColor :: Maybe Color lineNumberBackgroundColor :: Maybe Color

Instances

Data Style Source
Read Style Source
Show Style Source

data FormatOptions Source

Options for formatting source code.

Constructors

FormatOptions
Fields numberLines :: Bool Number lines startNumber :: Int Number of first line lineAnchors :: Bool Anchors on each line number titleAttributes :: Bool Html titles with token types codeClasses :: [String] Additional classes for Html code tag containerClasses :: [String] Additional classes for Html container tag (pre or table depending on numberLines)

Instances

Eq FormatOptions Source
Read FormatOptions Source
Show FormatOptions Source

defaultFormatOpts :: FormatOptions Source

KeywordTok
DataTypeTok
DecValTok
BaseNTok
FloatTok
ConstantTok
CharTok
SpecialCharTok
StringTok
VerbatimStringTok
SpecialStringTok
ImportTok
CommentTok
DocumentationTok
AnnotationTok
CommentVarTok
OtherTok
FunctionTok
VariableTok
ControlFlowTok
OperatorTok
BuiltInTok
ExtensionTok
PreprocessorTok
AttributeTok
RegionMarkerTok
InformationTok
WarningTok
AlertTok
ErrorTok
NormalTok

Enum TokenType Source
Eq TokenType Source
Data TokenType Source
Read TokenType Source
Show TokenType Source