org.antlr.v4.runtime

Class ParserInterpreter

java.lang.Object

org.antlr.v4.runtime.Recognizer<Token,ParserATNSimulator>

org.antlr.v4.runtime.Parser

org.antlr.v4.runtime.ParserInterpreter

public class ParserInterpreter
extends Parser

A parser simulator that mimics what ANTLR's generated parser code does. A ParserATNSimulator is used to make predictions via adaptivePredict but this class moves a pointer through the ATN to simulate parsing. ParserATNSimulator just makes us efficient rather than having to backtrack, for example. This properly creates parse trees even for left recursive rules. We rely on the left recursive rule invocation and special predicate transitions to make left recursive rules work. See TestParserInterpreter for examples.

Nested Class Summary

Nested classes/interfaces inherited from class org.antlr.v4.runtime.Parser

Parser.TraceListener, Parser.TrimToSizeListener

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Deque<Pair<ParserRuleContext,java.lang.Integer>>	_parentContextStack
protected ATN	atn
protected DFA[]	decisionToDFA
protected java.lang.String	grammarFileName
protected java.util.BitSet	pushRecursionContextStates
protected java.lang.String[]	ruleNames
protected PredictionContextCache	sharedContextCache
protected java.lang.String[]	tokenNames Deprecated.

Fields inherited from class org.antlr.v4.runtime.Parser

_buildParseTrees, _ctx, _errHandler, _input, _parseListeners, _precedenceStack, _syntaxErrors

Fields inherited from class org.antlr.v4.runtime.Recognizer

_interp, EOF

Constructor Summary

Constructors

Constructor and Description
ParserInterpreter(java.lang.String grammarFileName, java.util.Collection<java.lang.String> tokenNames, java.util.Collection<java.lang.String> ruleNames, ATN atn, TokenStream input) Deprecated. Use ParserInterpreter(String, Vocabulary, Collection, ATN, TokenStream) instead.
ParserInterpreter(java.lang.String grammarFileName, Vocabulary vocabulary, java.util.Collection<java.lang.String> ruleNames, ATN atn, TokenStream input)

Method Summary

Methods

Modifier and Type	Method and Description
void	enterRecursionRule(ParserRuleContext localctx, int state, int ruleIndex, int precedence)
ATN	getATN() Get the ATN used by the recognizer for prediction.
protected ATNState	getATNState()
java.lang.String	getGrammarFileName() For debugging and other purposes, might want the grammar name.
java.lang.String[]	getRuleNames()
java.lang.String[]	getTokenNames() Deprecated.
Vocabulary	getVocabulary() Get the vocabulary used by the recognizer.
ParserRuleContext	parse(int startRuleIndex) Begin parsing at startRuleIndex
protected void	visitRuleStopState(ATNState p)
protected void	visitState(ATNState p)

Methods inherited from class org.antlr.v4.runtime.Parser

addContextToParseTree, addParseListener, compileParseTreePattern, compileParseTreePattern, consume, dumpDFA, enterOuterAlt, enterRecursionRule, enterRule, exitRule, getATNWithBypassAlts, getBuildParseTree, getContext, getCurrentToken, getDFAStrings, getErrorHandler, getExpectedTokens, getExpectedTokensWithinCurrentRule, getInputStream, getInvokingContext, getNumberOfSyntaxErrors, getParseInfo, getParseListeners, getPrecedence, getRuleContext, getRuleIndex, getRuleInvocationStack, getRuleInvocationStack, getSourceName, getTokenFactory, getTokenStream, getTrimParseTree, inContext, isExpectedToken, isTrace, match, matchWildcard, notifyErrorListeners, notifyErrorListeners, precpred, pushNewRecursionContext, removeParseListener, removeParseListeners, reset, setBuildParseTree, setContext, setErrorHandler, setInputStream, setProfile, setTokenFactory, setTokenStream, setTrace, setTrimParseTree, triggerEnterRuleEvent, triggerExitRuleEvent, unrollRecursionContexts

Methods inherited from class org.antlr.v4.runtime.Recognizer

action, addErrorListener, getErrorHeader, getErrorListenerDispatch, getErrorListeners, getInterpreter, getRuleIndexMap, getSerializedATN, getState, getTokenErrorDisplay, getTokenType, getTokenTypeMap, removeErrorListener, removeErrorListeners, sempred, setInterpreter, setState

Methods inherited from class java.lang.Object

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

Field Detail

grammarFileName

protected final java.lang.String grammarFileName

atn

protected final ATN atn

pushRecursionContextStates

protected final java.util.BitSet pushRecursionContextStates

decisionToDFA

protected final DFA[] decisionToDFA

sharedContextCache

protected final PredictionContextCache sharedContextCache

tokenNames

@Deprecated
protected final java.lang.String[] tokenNames

Deprecated.

ruleNames

protected final java.lang.String[] ruleNames

_parentContextStack

protected final java.util.Deque<Pair<ParserRuleContext,java.lang.Integer>> _parentContextStack

Constructor Detail

ParserInterpreter

@Deprecated
public ParserInterpreter(java.lang.String grammarFileName,
                            java.util.Collection<java.lang.String> tokenNames,
                            java.util.Collection<java.lang.String> ruleNames,
                            ATN atn,
                            TokenStream input)

Deprecated. Use ParserInterpreter(String, Vocabulary, Collection, ATN, TokenStream) instead.

ParserInterpreter

public ParserInterpreter(java.lang.String grammarFileName,
                 Vocabulary vocabulary,
                 java.util.Collection<java.lang.String> ruleNames,
                 ATN atn,
                 TokenStream input)

Method Detail

getATN

public ATN getATN()

Description copied from class: Recognizer

Get the ATN used by the recognizer for prediction.

Specified by:

getATN in class Recognizer<Token,ParserATNSimulator>

Returns:

The ATN used by the recognizer for prediction.

getTokenNames

@Deprecated
public java.lang.String[] getTokenNames()

Deprecated.

Description copied from class: Recognizer

Used to print out token names like ID during debugging and error reporting. The generated parsers implement a method that overrides this to point to their String[] tokenNames.

Specified by:

getTokenNames in class Recognizer<Token,ParserATNSimulator>

getVocabulary

public Vocabulary getVocabulary()

Description copied from class: Recognizer

Get the vocabulary used by the recognizer.

Overrides:

getVocabulary in class Recognizer<Token,ParserATNSimulator>

Returns:

A Vocabulary instance providing information about the vocabulary used by the grammar.

getRuleNames

public java.lang.String[] getRuleNames()

Specified by:

getRuleNames in class Recognizer<Token,ParserATNSimulator>

getGrammarFileName

public java.lang.String getGrammarFileName()

Description copied from class: Recognizer

For debugging and other purposes, might want the grammar name. Have ANTLR generate an implementation for this method.

Specified by:

getGrammarFileName in class Recognizer<Token,ParserATNSimulator>

parse

public ParserRuleContext parse(int startRuleIndex)

Begin parsing at startRuleIndex

enterRecursionRule

public void enterRecursionRule(ParserRuleContext localctx,
                      int state,
                      int ruleIndex,
                      int precedence)

Overrides:

enterRecursionRule in class Parser

getATNState

protected ATNState getATNState()

visitState

protected void visitState(ATNState p)

visitRuleStopState

protected void visitRuleStopState(ATNState p)