org.antlr.v4.runtime.atn

Class ATNConfig

java.lang.Object

org.antlr.v4.runtime.atn.ATNConfig

public class ATNConfig
extends Object

A tuple: (ATN state, predicted alt, syntactic, semantic context). The syntactic context is a graph-structured stack node whose path(s) to the root is the rule invocation(s) chain used to arrive at the state. The semantic context is the tree of semantic predicates encountered before reaching an ATN state.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ATNConfig(ATNConfig c, ATNState state, PredictionContext context)
protected	ATNConfig(ATNState state, int alt, PredictionContext context)

Method Summary

Methods

Modifier and Type	Method and Description
ATNConfig	appendContext(int context, PredictionContextCache contextCache)
ATNConfig	appendContext(PredictionContext context, PredictionContextCache contextCache)
ATNConfig	clone()
boolean	contains(ATNConfig subconfig)
static ATNConfig	create(ATNState state, int alt, PredictionContext context)
static ATNConfig	create(ATNState state, int alt, PredictionContext context, SemanticContext semanticContext)
static ATNConfig	create(ATNState state, int alt, PredictionContext context, SemanticContext semanticContext, LexerActionExecutor lexerActionExecutor)
boolean	equals(ATNConfig other)
boolean	equals(Object o) An ATN configuration is equal to another if both have the same state, they predict the same alternative, and syntactic/semantic contexts are the same.
int	getAlt() What alt (or lexer rule) is predicted by this configuration
PredictionContext	getContext()
LexerActionExecutor	getLexerActionExecutor()
int	getOuterContextDepth() We cannot execute predicates dependent upon local context unless we know for sure we are in the correct context.
boolean	getReachesIntoOuterContext()
SemanticContext	getSemanticContext()
ATNState	getState() Gets the ATN state associated with this configuration
int	hashCode()
boolean	hasPassedThroughNonGreedyDecision()
boolean	isPrecedenceFilterSuppressed()
void	setContext(PredictionContext context)
void	setOuterContextDepth(int outerContextDepth)
void	setPrecedenceFilterSuppressed(boolean value)
String	toDotString()
String	toString()
String	toString(Recognizer<?,?> recog, boolean showAlt)
String	toString(Recognizer<?,?> recog, boolean showAlt, boolean showContext)
ATNConfig	transform(ATNState state, boolean checkNonGreedy)
ATNConfig	transform(ATNState state, LexerActionExecutor lexerActionExecutor, boolean checkNonGreedy)
ATNConfig	transform(ATNState state, PredictionContext context, boolean checkNonGreedy)
ATNConfig	transform(ATNState state, SemanticContext semanticContext, boolean checkNonGreedy)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ATNConfig

protected ATNConfig(@NotNull
         ATNState state,
         int alt,
         @NotNull
         PredictionContext context)

ATNConfig

protected ATNConfig(@NotNull
         ATNConfig c,
         @NotNull
         ATNState state,
         @NotNull
         PredictionContext context)

Method Detail

create

public static ATNConfig create(@NotNull
               ATNState state,
               int alt,
               @Nullable
               PredictionContext context)

create

public static ATNConfig create(@NotNull
               ATNState state,
               int alt,
               @Nullable
               PredictionContext context,
               @NotNull
               SemanticContext semanticContext)

create

public static ATNConfig create(@NotNull
               ATNState state,
               int alt,
               @Nullable
               PredictionContext context,
               @NotNull
               SemanticContext semanticContext,
               LexerActionExecutor lexerActionExecutor)

getState

@NotNull
public final ATNState getState()

Gets the ATN state associated with this configuration

getAlt

public final int getAlt()

What alt (or lexer rule) is predicted by this configuration

getContext

@NotNull
public final PredictionContext getContext()

setContext

public void setContext(@NotNull
              PredictionContext context)

getReachesIntoOuterContext

public final boolean getReachesIntoOuterContext()

getOuterContextDepth

public final int getOuterContextDepth()

We cannot execute predicates dependent upon local context unless we know for sure we are in the correct context. Because there is no way to do this efficiently, we simply cannot evaluate dependent predicates unless we are in the rule that initially invokes the ATN simulator.

closure() tracks the depth of how far we dip into the outer context: depth > 0. Note that it may not be totally accurate depth since I don't ever decrement. TODO: make it a boolean then

setOuterContextDepth

public void setOuterContextDepth(int outerContextDepth)

getLexerActionExecutor

@Nullable
public LexerActionExecutor getLexerActionExecutor()

getSemanticContext

@NotNull
public SemanticContext getSemanticContext()

hasPassedThroughNonGreedyDecision

public boolean hasPassedThroughNonGreedyDecision()

clone

public final ATNConfig clone()

Overrides:

clone in class Object

transform

public final ATNConfig transform(@NotNull
                  ATNState state,
                  boolean checkNonGreedy)

transform

public final ATNConfig transform(@NotNull
                  ATNState state,
                  @NotNull
                  SemanticContext semanticContext,
                  boolean checkNonGreedy)

transform

public final ATNConfig transform(@NotNull
                  ATNState state,
                  @Nullable
                  PredictionContext context,
                  boolean checkNonGreedy)

transform

public final ATNConfig transform(@NotNull
                  ATNState state,
                  LexerActionExecutor lexerActionExecutor,
                  boolean checkNonGreedy)

appendContext

public ATNConfig appendContext(int context,
                      PredictionContextCache contextCache)

appendContext

public ATNConfig appendContext(PredictionContext context,
                      PredictionContextCache contextCache)

contains

public boolean contains(ATNConfig subconfig)

isPrecedenceFilterSuppressed

public final boolean isPrecedenceFilterSuppressed()

setPrecedenceFilterSuppressed

public final void setPrecedenceFilterSuppressed(boolean value)

equals

public boolean equals(Object o)

An ATN configuration is equal to another if both have the same state, they predict the same alternative, and syntactic/semantic contexts are the same.

Overrides:

equals in class Object

equals

public boolean equals(ATNConfig other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toDotString

public String toDotString()

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(@Nullable
              Recognizer<?,?> recog,
              boolean showAlt)

toString

public String toString(@Nullable
              Recognizer<?,?> recog,
              boolean showAlt,
              boolean showContext)