Package org.antlr.v4.automata

Class LexerATNFactory

java.lang.Object

org.antlr.v4.automata.ParserATNFactory

org.antlr.v4.automata.LexerATNFactory

All Implemented Interfaces:

ATNFactory

public class LexerATNFactory
extends ParserATNFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.antlr.v4.automata.ATNFactory

ATNFactory.Handle

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<LexerAction,Integer>	actionToIndexMap	Maps from a LexerAction object to the action index.
org.stringtemplate.v4.STGroup	codegenTemplates
static Map<String,Integer>	COMMON_CONSTANTS	Provides a map of names of predefined constants which are likely to appear as the argument for lexer commands.
protected Map<Integer,LexerAction>	indexToActionMap	Maps from an action index to a LexerAction object.

Fields inherited from class org.antlr.v4.automata.ParserATNFactory

atn, currentOuterAlt, currentRule, g, preventEpsilonClosureBlocks, preventEpsilonOptionalBlocks

Constructor Summary

Constructors

Constructor	Description
LexerATNFactory(LexerGrammar g)
LexerATNFactory(LexerGrammar g, CodeGenerator codeGenerator)

Method Summary

Modifier and Type	Method	Description
ATNFactory.Handle	action(String action)
ATNFactory.Handle	action(ActionAST action)	Build what amounts to an epsilon transition with an action.
protected ATNFactory.Handle	action(GrammarAST node, LexerAction lexerAction)
ATNFactory.Handle	charSetLiteral(GrammarAST charSetAST)	[Aa\t ሴa-z\]\p{Letter}\-] char sets
protected boolean	checkRange(GrammarAST leftNode, GrammarAST rightNode, int leftValue, int rightValue)
ATN	createATN()
static Set<String>	getCommonConstants()
protected int	getLexerActionIndex(LexerAction lexerAction)
IntervalSet	getSetFromCharSetLiteral(GrammarAST charSetAST)
ATNFactory.Handle	lexerAltCommands(ATNFactory.Handle alt, ATNFactory.Handle cmds)
ATNFactory.Handle	lexerCallCommand(GrammarAST ID, GrammarAST arg)
ATNFactory.Handle	lexerCommand(GrammarAST ID)
ATNFactory.Handle	range(GrammarAST a, GrammarAST b)	Not valid for non-lexers.
ATNFactory.Handle	rule(GrammarAST ruleAST, String name, ATNFactory.Handle blk)
ATNFactory.Handle	set(GrammarAST associatedAST, List<GrammarAST> alts, boolean invert)	From set build single edge graph o->o-set->o.
ATNFactory.Handle	stringLiteral(TerminalAST stringLiteralAST)	For a lexer, a string is a sequence of char to match.
ATNFactory.Handle	tokenRef(TerminalAST node)	From label A build graph o-A->o.

Methods inherited from class org.antlr.v4.automata.ParserATNFactory

_createATN, _ruleRef, addEOFTransitionToStartRules, addFollowLink, addRuleFollowLinks, alt, block, blockHasWildcardAlt, checkEpsilonClosure, elemList, epsilon, epsilon, epsilon, expectNonGreedy, getTokenType, label, listLabel, makeBlock, newState, newState, newState, optional, plus, ruleRef, sempred, setCurrentOuterAlt, setCurrentRuleName, star, wildcard

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

codegenTemplates

public org.stringtemplate.v4.STGroup codegenTemplates

COMMON_CONSTANTS

public static final Map<String,Integer> COMMON_CONSTANTS

Provides a map of names of predefined constants which are likely to appear as the argument for lexer commands. These names would be resolved by the Java compiler for lexer commands that are translated to embedded actions, but are required during code generation for creating LexerAction instances that are usable by a lexer interpreter.

indexToActionMap

protected Map<Integer,LexerAction> indexToActionMap

Maps from an action index to a LexerAction object.

actionToIndexMap

protected Map<LexerAction,Integer> actionToIndexMap

Maps from a LexerAction object to the action index.

Constructor Detail

LexerATNFactory

public LexerATNFactory(LexerGrammar g)

LexerATNFactory

public LexerATNFactory(LexerGrammar g,
                       CodeGenerator codeGenerator)

Method Detail

getCommonConstants

public static Set<String> getCommonConstants()

createATN

public ATN createATN()

Specified by:

createATN in interface ATNFactory

Overrides:

createATN in class ParserATNFactory

rule

public ATNFactory.Handle rule(GrammarAST ruleAST,
                              String name,
                              ATNFactory.Handle blk)

Specified by:

rule in interface ATNFactory

Overrides:

rule in class ParserATNFactory

action

public ATNFactory.Handle action(ActionAST action)

Description copied from class: ParserATNFactory

Build what amounts to an epsilon transition with an action. The action goes into ATN though it is ignored during prediction if actionIndex<0.

Specified by:

action in interface ATNFactory

Overrides:

action in class ParserATNFactory

getLexerActionIndex

protected int getLexerActionIndex(LexerAction lexerAction)

action

public ATNFactory.Handle action(String action)

Specified by:

action in interface ATNFactory

Overrides:

action in class ParserATNFactory

action

protected ATNFactory.Handle action(GrammarAST node,
                                   LexerAction lexerAction)

lexerAltCommands

public ATNFactory.Handle lexerAltCommands(ATNFactory.Handle alt,
                                          ATNFactory.Handle cmds)

Specified by:

lexerAltCommands in interface ATNFactory

Overrides:

lexerAltCommands in class ParserATNFactory

lexerCallCommand

public ATNFactory.Handle lexerCallCommand(GrammarAST ID,
                                          GrammarAST arg)

Specified by:

lexerCallCommand in interface ATNFactory

Overrides:

lexerCallCommand in class ParserATNFactory

lexerCommand

public ATNFactory.Handle lexerCommand(GrammarAST ID)

Specified by:

lexerCommand in interface ATNFactory

Overrides:

lexerCommand in class ParserATNFactory

range

public ATNFactory.Handle range(GrammarAST a,
                               GrammarAST b)

Description copied from class: ParserATNFactory

Not valid for non-lexers.

Specified by:

range in interface ATNFactory

Overrides:

range in class ParserATNFactory

set

public ATNFactory.Handle set(GrammarAST associatedAST,
                             List<GrammarAST> alts,
                             boolean invert)

Description copied from class: ParserATNFactory

From set build single edge graph o->o-set->o. To conform to what an alt block looks like, must have extra state on left. This also handles ~A, converted to ~{A} set.

Specified by:

set in interface ATNFactory

Overrides:

set in class ParserATNFactory

checkRange

protected boolean checkRange(GrammarAST leftNode,
                             GrammarAST rightNode,
                             int leftValue,
                             int rightValue)

stringLiteral

public ATNFactory.Handle stringLiteral(TerminalAST stringLiteralAST)

For a lexer, a string is a sequence of char to match. That is, "fog" is treated as 'f' 'o' 'g' not as a single transition in the DFA. Machine== o-'f'->o-'o'->o-'g'->o and has n+1 states for n characters. if "caseInsensitive" option is enabled, "fog" will be treated as o-('f'|'F') -> o-('o'|'O') -> o-('g'|'G')

Specified by:

stringLiteral in interface ATNFactory

Overrides:

stringLiteral in class ParserATNFactory

charSetLiteral

public ATNFactory.Handle charSetLiteral(GrammarAST charSetAST)

[Aa\t ሴa-z\]\p{Letter}\-] char sets

Specified by:

charSetLiteral in interface ATNFactory

Overrides:

charSetLiteral in class ParserATNFactory

getSetFromCharSetLiteral

public IntervalSet getSetFromCharSetLiteral(GrammarAST charSetAST)

tokenRef

public ATNFactory.Handle tokenRef(TerminalAST node)

Description copied from class: ParserATNFactory

From label A build graph o-A->o.

Specified by:

tokenRef in interface ATNFactory

Overrides:

tokenRef in class ParserATNFactory