forgetest1
/
antlr
forked from jasder/antlr
1
0
Fork 0
Code Issues Pull Requests 1 Releases Wiki Activity

Updated ATN documentation

This commit is contained in:
Sam Harwell 2013-03-21 12:32:10 -05:00
parent f6ad977e0d
commit 4f29c2fe3d
1 changed files with 31 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
runtime/Java/src/org/antlr/v4/runtime/atn/ATN.java
View File

@ -31,6 +31,7 @@
package org.antlr.v4.runtime.atn; package org.antlr.v4.runtime.atn;
import org.antlr.v4.runtime.RuleContext; import org.antlr.v4.runtime.RuleContext;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.misc.IntervalSet; import org.antlr.v4.runtime.misc.IntervalSet;
import org.antlr.v4.runtime.misc.NotNull; import org.antlr.v4.runtime.misc.NotNull;
import org.antlr.v4.runtime.misc.Nullable; import org.antlr.v4.runtime.misc.Nullable;
@ -54,7 +55,14 @@ public class ATN {
@NotNull @NotNull
public final List<DecisionState> decisionToState = new ArrayList<DecisionState>(); public final List<DecisionState> decisionToState = new ArrayList<DecisionState>();
/**
* Maps from rule index to starting state number.
*/
public RuleStartState[] ruleToStartState; public RuleStartState[] ruleToStartState;
/**
* Maps from rule index to stop state number.
*/
public RuleStopState[] ruleToStopState; public RuleStopState[] ruleToStopState;
@NotNull @NotNull
@ -66,10 +74,24 @@ public class ATN {
*/ */
public final ATNType grammarType; public final ATNType grammarType;
/**
* The maximum value for any symbol recognized by a transition in the ATN.
*/
public final int maxTokenType; public final int maxTokenType;
// runtime for lexer only /**
* For lexer ATNs, this maps the rule index to the resulting token type.
* <p/>
* This is {@code null} for parser ATNs.
*/
public int[] ruleToTokenType; public int[] ruleToTokenType;
/**
* For lexer ATNs, this maps the rule index to the action which should be
* executed following a match.
* <p/>
* This is {@code null} for parser ATNs.
*/
public int[] ruleToActionIndex; public int[] ruleToActionIndex;
@NotNull @NotNull
@ -81,10 +103,10 @@ public class ATN {
this.maxTokenType = maxTokenType; this.maxTokenType = maxTokenType;
} }
/** Compute the set of valid tokens that can occur starting in s. /** Compute the set of valid tokens that can occur starting in state {@code s}.
* If ctx is null, the set of tokens will not include what can follow * If {@code ctx} is null, the set of tokens will not include what can follow
* the rule surrounding s. In other words, the set will be * the rule surrounding {@code s}. In other words, the set will be
* restricted to tokens reachable staying within s's rule. * restricted to tokens reachable staying within {@code s}'s rule.
*/ */
public IntervalSet nextTokens(ATNState s, RuleContext ctx) { public IntervalSet nextTokens(ATNState s, RuleContext ctx) {
LL1Analyzer anal = new LL1Analyzer(this); LL1Analyzer anal = new LL1Analyzer(this);
@ -92,8 +114,10 @@ public class ATN {
return next; return next;
} }
/** Compute the set of valid tokens that can occur starting in s and staying in same rule. /**
* EPSILON is in set if we reach end of rule. * Compute the set of valid tokens that can occur starting in {@code s} and
* staying in same rule. {@link Token#EPSILON} is in set if we reach end of
* rule.
*/ */
public IntervalSet nextTokens(ATNState s) { public IntervalSet nextTokens(ATNState s) {
if ( s.nextTokenWithinRule != null ) return s.nextTokenWithinRule; if ( s.nextTokenWithinRule != null ) return s.nextTokenWithinRule;