Package org.antlr.runtime
Class RecognizerSharedState
java.lang.Object
org.antlr.runtime.RecognizerSharedState
The set of fields needed by an abstract recognizer to recognize input
and recover from errors etc... As a separate state object, it can be
shared among multiple grammars; e.g., when one grammar imports another.
These fields are publically visible but the actual state pointer per
parser is protected.
-
Field Summary
FieldsModifier and TypeFieldDescriptionint
int
If 0, no backtracking is going on.int
The channel number for the current tokenboolean
This is true when we see an error and before having successfully matched a token.boolean
In lieu of a return value, this indicates that a rule or token has failed to match.BitSet[]
Track the set of token types that can follow any rule invocation.int
The index into the input stream where the last error occurred.Map[]
An array[size num rules] of Map<Integer,Integer> that tracks the stop token index for each rule.int
Did the recognizer encounter a syntax error? Track how many.You can set the text for the current token to override what is in the input char buffer.The goal of all lexer rules/methods is to create a token object.int
What character index in the stream did the current token start at? Needed, for example, to get the text for current token.int
The character position of first character within the lineint
The line on which the first character of the token residesint
The token type for the current token -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
following
Track the set of token types that can follow any rule invocation. Stack grows upwards. When it hits the max, it grows 2x in size and keeps going. -
_fsp
public int _fsp -
errorRecovery
public boolean errorRecoveryThis is true when we see an error and before having successfully matched a token. Prevents generation of more than one error message per error. -
lastErrorIndex
public int lastErrorIndexThe index into the input stream where the last error occurred. This is used to prevent infinite loops where an error is found but no token is consumed during recovery...another error is found, ad naseum. This is a failsafe mechanism to guarantee that at least one token/tree node is consumed for two errors. -
failed
public boolean failedIn lieu of a return value, this indicates that a rule or token has failed to match. Reset to false upon valid token match. -
syntaxErrors
public int syntaxErrorsDid the recognizer encounter a syntax error? Track how many. -
backtracking
public int backtrackingIf 0, no backtracking is going on. Safe to exec actions etc... If >0 then it's the level of backtracking. -
ruleMemo
An array[size num rules] of Map<Integer,Integer> that tracks the stop token index for each rule. ruleMemo[ruleIndex] is the memoization table for ruleIndex. For key ruleStartIndex, you get back the stop token for associated rule or MEMO_RULE_FAILED. This is only used if rule memoization is on (which it is by default). -
token
The goal of all lexer rules/methods is to create a token object. This is an instance variable as multiple rules may collaborate to create a single token. nextToken will return this object after matching lexer rule(s). If you subclass to allow multiple token emissions, then set this to the last token to be matched or something nonnull so that the auto token emit mechanism will not emit another token. -
tokenStartCharIndex
public int tokenStartCharIndexWhat character index in the stream did the current token start at? Needed, for example, to get the text for current token. Set at the start of nextToken. -
tokenStartLine
public int tokenStartLineThe line on which the first character of the token resides -
tokenStartCharPositionInLine
public int tokenStartCharPositionInLineThe character position of first character within the line -
channel
public int channelThe channel number for the current token -
type
public int typeThe token type for the current token -
text
You can set the text for the current token to override what is in the input char buffer. Use setText() or can set this instance var.
-
-
Constructor Details
-
RecognizerSharedState
public RecognizerSharedState()
-