pygments.lexers.haskell.LiterateLexer

class documentation

class LiterateLexer(Lexer):

Known subclasses: pygments.lexers.haskell.LiterateAgdaLexer, pygments.lexers.haskell.LiterateCryptolLexer, pygments.lexers.haskell.LiterateHaskellLexer, pygments.lexers.haskell.LiterateIdrisLexer

View In Hierarchy

Base class for lexers of literate file formats based on LaTeX or Bird-style (prefixing each code line with ">").

Additional options accepted:

litstyle: If given, must be "bird" or "latex". If not given, the style is autodetected: if the first non-whitespace character in the source is a backslash or percent character, LaTeX is assumed, else Bird.

Method	`__init__`	Undocumented
Method	`get_tokens_unprocessed`	Return an iterable of (index, tokentype, value) pairs where "index" is the starting position of the token within the input text.
Class Variable	`bird_re`	Undocumented
Instance Variable	`baselexer`	Undocumented

Inherited from Lexer:

Method	`analyse_text`	No summary
Method	`get_tokens`	Return an iterable of (tokentype, value) pairs generated from `text`. If `unfiltered` is set to `True`, the filtering mechanism is bypassed even if filters are defined.
Class Variable	`alias_filenames`	Undocumented
Class Variable	`aliases`	Undocumented
Class Variable	`filenames`	Undocumented
Class Variable	`mimetypes`	Undocumented
Class Variable	`name`	Undocumented
Method	`__repr__`	Undocumented
Method	`add_filter`	Add a new stream filter to this lexer.
Class Variable	`priority`	Undocumented
Instance Variable	`encoding`	Undocumented
Instance Variable	`ensurenl`	Undocumented
Instance Variable	`filters`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`stripall`	Undocumented
Instance Variable	`stripnl`	Undocumented
Instance Variable	`tabsize`	Undocumented

def __init__(self, baselexer, **options):

overrides pygments.lexer.Lexer.__init__

overridden in pygments.lexers.haskell.LiterateAgdaLexer, pygments.lexers.haskell.LiterateCryptolLexer, pygments.lexers.haskell.LiterateHaskellLexer, pygments.lexers.haskell.LiterateIdrisLexer

Undocumented

def get_tokens_unprocessed(self, text):

overrides pygments.lexer.Lexer.get_tokens_unprocessed

Return an iterable of (index, tokentype, value) pairs where "index" is the starting position of the token within the input text.

In subclasses, implement this method as a generator to maximize effectiveness.

bird_re =

Undocumented

baselexer =

Undocumented