class documentation

class AntlrLexer(RegexLexer):

View In Hierarchy

Generic ANTLR Lexer. Should not be called directly, instead use DelegatingLexer for your target language.

New in version 1.1.
Method analyse​_text No summary
Constant ​_INT Undocumented
Constant ​_RULE​_REF Undocumented
Constant ​_STRING​_LITERAL Undocumented
Constant ​_TOKEN​_REF Undocumented
Class Variable ​_id Undocumented
Class Variable aliases Undocumented
Class Variable filenames Undocumented
Class Variable name Undocumented
Class Variable tokens Undocumented

Inherited from RegexLexer:

Method get​_tokens​_unprocessed Split text into (tokentype, text) pairs.

Inherited from Lexer (via RegexLexer):

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 mimetypes Undocumented
Method __init__ 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 analyse_text(text):

Has to return a float between 0 and 1 that indicates if a lexer wants to highlight this text. Used by guess_lexer. If this method returns 0 it won't highlight it in any case, if it returns 1 highlighting with this lexer is guaranteed.

The LexerMeta metaclass automatically wraps this function so that it works like a static method (no self or cls parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it's the same as if the return values was 0.0.

_INT: str =

Undocumented

Value
'[0-9]+'
_RULE_REF: str =

Undocumented

Value
'[a-z]\\w*'
_STRING_LITERAL: str =

Undocumented

Value
'\\\'(?:\\\\\\\\|\\\\\\\'|[^\\\']*)\\\''
_TOKEN_REF: str =

Undocumented

Value
'[A-Z]\\w*'
_id: str =

Undocumented

aliases: list[str] =

Undocumented

filenames: list =

Undocumented

name: str =

Undocumented

tokens =

Undocumented