org.antlr.v4.runtime.atn

Class ATNSimulator

java.lang.Object

org.antlr.v4.runtime.atn.ATNSimulator

Direct Known Subclasses:

LexerATNSimulator, ParserATNSimulator

public abstract class ATNSimulator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
ATN	atn
static DFAState	ERROR Must distinguish between missing edge and edge we know leads nowhere
static int	SERIALIZED_VERSION
protected PredictionContextCache	sharedContextCache The context cache maps all PredictionContext objects that are equals() to a single cached copy.

Constructor Summary

Constructors

Constructor and Description
ATNSimulator(ATN atn, PredictionContextCache sharedContextCache)

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkCondition(boolean condition)
static void	checkCondition(boolean condition, String message)
static ATN	deserialize(char[] data)
static Transition	edgeFactory(ATN atn, int type, int src, int trg, int arg1, int arg2, int arg3, List<IntervalSet> sets)
PredictionContext	getCachedContext(PredictionContext context)
abstract void	reset()
static ATNState	stateFactory(int type, int ruleIndex)
static int	toInt(char c)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_VERSION

public static final int SERIALIZED_VERSION

ERROR

@NotNull
public static final DFAState ERROR

Must distinguish between missing edge and edge we know leads nowhere

atn

@NotNull
public final ATN atn

sharedContextCache

protected final PredictionContextCache sharedContextCache

The context cache maps all PredictionContext objects that are equals() to a single cached copy. This cache is shared across all contexts in all ATNConfigs in all DFA states. We rebuild each ATNConfigSet to use only cached nodes/graphs in addDFAState(). We don't want to fill this during closure() since there are lots of contexts that pop up but are not used ever again. It also greatly slows down closure().

This cache makes a huge difference in memory and a little bit in speed. For the Java grammar on java.*, it dropped the memory requirements at the end from 25M to 16M. We don't store any of the full context graphs in the DFA because they are limited to local context only, but apparently there's a lot of repetition there as well. We optimize the config contexts before storing the config set in the DFA states by literally rebuilding them with cached subgraphs only.

I tried a cache for use during closure operations, that was whacked after each adaptivePredict(). It cost a little bit more time I think and doesn't save on the overall footprint so it's not worth the complexity.

Constructor Detail

ATNSimulator

public ATNSimulator(@NotNull
            ATN atn,
            @NotNull
            PredictionContextCache sharedContextCache)

Method Detail

reset

public abstract void reset()

getCachedContext

public PredictionContext getCachedContext(PredictionContext context)

deserialize

public static ATN deserialize(@NotNull
              char[] data)

checkCondition

public static void checkCondition(boolean condition)

checkCondition

public static void checkCondition(boolean condition,
                  String message)

toInt

public static int toInt(char c)

edgeFactory

@NotNull
public static Transition edgeFactory(@NotNull
                             ATN atn,
                             int type,
                             int src,
                             int trg,
                             int arg1,
                             int arg2,
                             int arg3,
                             List<IntervalSet> sets)

stateFactory

public static ATNState stateFactory(int type,
                    int ruleIndex)