Package org.antlr.v4.runtime.atn

Class PredictionContext

java.lang.Object

org.antlr.v4.runtime.atn.PredictionContext

Direct Known Subclasses:

ArrayPredictionContext, EmptyPredictionContext, SingletonPredictionContext

public abstract class PredictionContext
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PredictionContext.IdentityEqualityComparator
static final class	PredictionContext.IdentityHashMap

Field Summary

Fields

Modifier and Type	Field	Description
private final int	cachedHashCode	Stores the computed hash code of this PredictionContext.
static final PredictionContext	EMPTY_FULL
static final int	EMPTY_FULL_STATE_KEY
static final PredictionContext	EMPTY_LOCAL
static final int	EMPTY_LOCAL_STATE_KEY
private static final int	INITIAL_HASH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PredictionContext(int cachedHashCode)

Method Summary

Modifier and Type	Method	Description
protected abstract PredictionContext	addEmptyContext()
private static PredictionContext	addEmptyContext(PredictionContext context)
PredictionContext	appendContext(int returnContext, PredictionContextCache contextCache)
abstract PredictionContext	appendContext(PredictionContext suffix, PredictionContextCache contextCache)
protected static int	calculateEmptyHashCode()
protected static int	calculateHashCode(PredictionContext[] parents, int[] returnStates)
protected static int	calculateHashCode(PredictionContext parent, int returnState)
abstract boolean	equals(Object o)
abstract int	findReturnState(int returnState)
static PredictionContext	fromRuleContext(ATN atn, RuleContext outerContext)
static PredictionContext	fromRuleContext(ATN atn, RuleContext outerContext, boolean fullContext)
static PredictionContext	getCachedContext(PredictionContext context, ConcurrentMap<PredictionContext,PredictionContext> contextCache, PredictionContext.IdentityHashMap visited)
PredictionContext	getChild(int returnState)
abstract PredictionContext	getParent(int index)
abstract int	getReturnState(int index)
abstract boolean	hasEmpty()
final int	hashCode()
abstract boolean	isEmpty()
static boolean	isEmptyLocal(PredictionContext context)
static PredictionContext	join(PredictionContext context0, PredictionContext context1)
(package private) static PredictionContext	join(PredictionContext context0, PredictionContext context1, PredictionContextCache contextCache)
protected abstract PredictionContext	removeEmptyContext()
private static PredictionContext	removeEmptyContext(PredictionContext context)
abstract int	size()
String[]	toStrings(Recognizer<?,?> recognizer, int currentState)
String[]	toStrings(Recognizer<?,?> recognizer, PredictionContext stop, int currentState)

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_LOCAL

@NotNull
public static final PredictionContext EMPTY_LOCAL

EMPTY_FULL

@NotNull
public static final PredictionContext EMPTY_FULL

EMPTY_LOCAL_STATE_KEY

public static final int EMPTY_LOCAL_STATE_KEY

See Also:

• Constant Field Values

EMPTY_FULL_STATE_KEY

public static final int EMPTY_FULL_STATE_KEY

See Also:

• Constant Field Values

INITIAL_HASH

private static final int INITIAL_HASH

See Also:

• Constant Field Values

cachedHashCode

private final int cachedHashCode

Stores the computed hash code of this PredictionContext. The hash code is computed in parts to match the following reference algorithm.

  private int referenceHashCode() {
      int hash = MurmurHash.initialize(INITIAL_HASH);

      for (int i = 0; i < size(); i++) {
          hash = MurmurHash.update(hash, getParent(i));
      }

      for (int i = 0; i < size(); i++) {
          hash = MurmurHash.update(hash, getReturnState(i));
      }

      hash = MurmurHash.finish(hash, 2 * size());
      return hash;
  }
 

Constructor Details

PredictionContext

protected PredictionContext(int cachedHashCode)

Method Details

calculateEmptyHashCode

protected static int calculateEmptyHashCode()

calculateHashCode

protected static int calculateHashCode(PredictionContext parent,
 int returnState)

calculateHashCode

protected static int calculateHashCode(PredictionContext[] parents,
 int[] returnStates)

size

public abstract int size()

getReturnState

public abstract int getReturnState(int index)

findReturnState

public abstract int findReturnState(int returnState)

getParent

@NotNull
public abstract PredictionContext getParent(int index)

addEmptyContext

protected abstract PredictionContext addEmptyContext()

removeEmptyContext

protected abstract PredictionContext removeEmptyContext()

fromRuleContext

public static PredictionContext fromRuleContext(@NotNull
 ATN atn,
 @NotNull
 RuleContext outerContext)

fromRuleContext

public static PredictionContext fromRuleContext(@NotNull
 ATN atn,
 @NotNull
 RuleContext outerContext,
 boolean fullContext)

addEmptyContext

private static PredictionContext addEmptyContext(PredictionContext context)

removeEmptyContext

private static PredictionContext removeEmptyContext(PredictionContext context)

join

public static PredictionContext join(PredictionContext context0,
 PredictionContext context1)

join

static PredictionContext join(@NotNull
 PredictionContext context0,
 @NotNull
 PredictionContext context1,
 @NotNull
 PredictionContextCache contextCache)

isEmptyLocal

public static boolean isEmptyLocal(PredictionContext context)

getCachedContext

public static PredictionContext getCachedContext(@NotNull
 PredictionContext context,
 @NotNull
 ConcurrentMap<PredictionContext,PredictionContext> contextCache,
 @NotNull
 PredictionContext.IdentityHashMap visited)

appendContext

public PredictionContext appendContext(int returnContext,
 PredictionContextCache contextCache)

appendContext

public abstract PredictionContext appendContext(PredictionContext suffix,
 PredictionContextCache contextCache)

getChild

public PredictionContext getChild(int returnState)

isEmpty

public abstract boolean isEmpty()

hasEmpty

public abstract boolean hasEmpty()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

toStrings

public String[] toStrings(Recognizer<?,?> recognizer,
 int currentState)

toStrings

public String[] toStrings(Recognizer<?,?> recognizer,
 PredictionContext stop,
 int currentState)