RecognizerSharedState Fields

If 0, no backtracking is going on. Safe to exec actions etc... If >0 then it's the level of backtracking.

The channel number for the current token

This is true when we see an error and before having successfully matched a token. Prevents generation of more than one error message per error.

In lieu of a return value, this indicates that a rule or token has failed to match. Reset to false upon valid token match.

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.

The 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.

An array[size num rules] of dictionaries 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.

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. Use setText() or can set this instance var.

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.

What 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.

The character position of first character within the line

The line on which the first character of the token resides

The token type for the current token