org.antlr.v4.runtime

Class Recognizer<Symbol,ATNInterpreter extends ATNSimulator>

java.lang.Object

org.antlr.v4.runtime.Recognizer<Symbol,ATNInterpreter>

Direct Known Subclasses:

Lexer, Parser

public abstract class Recognizer<Symbol,ATNInterpreter extends ATNSimulator>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ATNInterpreter	_interp
static int	EOF

Constructor Summary

Constructors

Constructor and Description
Recognizer()

Method Summary

Methods

Modifier and Type	Method and Description
void	action(RuleContext _localctx, int ruleIndex, int actionIndex)
void	addErrorListener(ANTLRErrorListener listener)
abstract ATN	getATN()
String	getErrorHeader(RecognitionException e) What is the error header, normally line/character position information?
ANTLRErrorListener	getErrorListenerDispatch()
List<? extends ANTLRErrorListener>	getErrorListeners()
abstract String	getGrammarFileName() For debugging and other purposes, might want the grammar name.
abstract IntStream	getInputStream()
ATNInterpreter	getInterpreter()
abstract String[]	getRuleNames()
int	getState()
String	getTokenErrorDisplay(Token t) How should a token be displayed in an error message? The default is to display just the text, but during development you might want to have a lot of information spit out.
abstract String[]	getTokenNames() Used to print out token names like ID during debugging and error reporting.
void	removeErrorListener(ANTLRErrorListener listener)
void	removeErrorListeners()
boolean	sempred(RuleContext _localctx, int ruleIndex, int actionIndex)
abstract void	setInputStream(IntStream input)
void	setInterpreter(ATNInterpreter interpreter)
void	setState(int atnState) Indicate that the recognizer has changed internal state that is consistent with the ATN state passed in.
abstract void	setTokenFactory(TokenFactory<?> input)

Methods inherited from class java.lang.Object

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

Field Detail

EOF

public static final int EOF

See Also:

Constant Field Values

_interp

protected ATNInterpreter extends ATNSimulator _interp

Constructor Detail

Recognizer

public Recognizer()

Method Detail

getTokenNames

public abstract String[] getTokenNames()

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.

getRuleNames

public abstract String[] getRuleNames()

getGrammarFileName

public abstract String getGrammarFileName()

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

getATN

public abstract ATN getATN()

getInterpreter

public ATNInterpreter getInterpreter()

setInterpreter

public void setInterpreter(ATNInterpreter interpreter)

getErrorHeader

public String getErrorHeader(RecognitionException e)

What is the error header, normally line/character position information?

getTokenErrorDisplay

public String getTokenErrorDisplay(Token t)

How should a token be displayed in an error message? The default is to display just the text, but during development you might want to have a lot of information spit out. Override in that case to use t.toString() (which, for CommonToken, dumps everything about the token). This is better than forcing you to override a method in your token objects because you don't have to go modify your lexer so that it creates a new Java type.

addErrorListener

public void addErrorListener(@NotNull
                    ANTLRErrorListener listener)

Throws:

NullPointerException - if listener is null.

removeErrorListener

public void removeErrorListener(@NotNull
                       ANTLRErrorListener listener)

removeErrorListeners

public void removeErrorListeners()

getErrorListeners

@NotNull
public List<? extends ANTLRErrorListener> getErrorListeners()

getErrorListenerDispatch

public ANTLRErrorListener getErrorListenerDispatch()

sempred

public boolean sempred(@Nullable
              RuleContext _localctx,
              int ruleIndex,
              int actionIndex)

action

public void action(@Nullable
          RuleContext _localctx,
          int ruleIndex,
          int actionIndex)

getState

public final int getState()

setState

public final void setState(int atnState)

Indicate that the recognizer has changed internal state that is consistent with the ATN state passed in. This way we always know where we are in the ATN as the parser goes along. The rule context objects form a stack that lets us see the stack of invoking rules. Combine this and we have complete ATN configuration information.

getInputStream

public abstract IntStream getInputStream()

setInputStream

public abstract void setInputStream(IntStream input)

setTokenFactory

public abstract void setTokenFactory(TokenFactory<?> input)