org.sonar.javascript.se

Class ProgramState

java.lang.Object

org.sonar.javascript.se.ProgramState

All Implemented Interfaces:

ProgramStateConstraints

public class ProgramState
extends Object
implements ProgramStateConstraints

This class represents the knowledge about the variables values. The same program state may be valid for several program points and at one program point there might be valid several program states (depending on execution path). This class is immutable.

Method Summary

Modifier and Type	Method and Description
ProgramState	addRelation(Relation relation)
void	assertEmptyStack(Tree element)
ProgramState	assignment(Symbol variable)
ProgramState	assignment(Symbol variable, SymbolicValue value)
ProgramState	clearStack(Tree element)
Optional<ProgramState>	constrain(SymbolicValue value, Constraint constraint)
static ProgramState	emptyState()
boolean	equals(Object o)
ProgramState	execute(ExpressionTree expression)
Constraint	getConstraint(Symbol symbol)
Constraint	getConstraint(SymbolicValue value)
ExpressionStack	getStack() Deprecated.
SymbolicValue	getSymbolicValue(IdentifierTree identifier, SymbolicExecution execution)
SymbolicValue	getSymbolicValue(Symbol symbol)
int	hashCode()
ProgramState	newFunctionSymbolicValue(Symbol symbol, FunctionTree functionTree)
ProgramState	newSymbolicValue(Symbol symbol, Constraint constraint)
SymbolicValue	peekStack()
SymbolicValue	peekStack(int n)
ProgramState	pushToStack(SymbolicValue value)
Set<Relation>	relations()
ProgramState	removeLastValue()
ProgramState	removeSymbols(Set<Symbol> symbolsToKeep)
String	toString()
com.google.common.collect.ImmutableMap<Symbol,SymbolicValue>	values()
ProgramState	withStack(ExpressionStack newStack)

Methods inherited from class java.lang.Object

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

Method Detail

values

public com.google.common.collect.ImmutableMap<Symbol,SymbolicValue> values()

emptyState

public static ProgramState emptyState()

newSymbolicValue

public ProgramState newSymbolicValue(Symbol symbol,
                                     @Nullable
                                     Constraint constraint)

newFunctionSymbolicValue

public ProgramState newFunctionSymbolicValue(Symbol symbol,
                                             FunctionTree functionTree)

constrain

public Optional<ProgramState> constrain(@Nullable
                                        SymbolicValue value,
                                        @Nullable
                                        Constraint constraint)

getSymbolicValue

@CheckForNull
public SymbolicValue getSymbolicValue(@Nullable
                                                    Symbol symbol)

getConstraint

public Constraint getConstraint(@Nullable
                                SymbolicValue value)

Specified by:

getConstraint in interface ProgramStateConstraints

getConstraint

public Constraint getConstraint(@Nullable
                                Symbol symbol)

pushToStack

public ProgramState pushToStack(SymbolicValue value)

removeLastValue

public ProgramState removeLastValue()

clearStack

public ProgramState clearStack(Tree element)

assertEmptyStack

public void assertEmptyStack(Tree element)

execute

public ProgramState execute(ExpressionTree expression)

withStack

public ProgramState withStack(ExpressionStack newStack)

assignment

public ProgramState assignment(Symbol variable)

assignment

public ProgramState assignment(Symbol variable,
                               SymbolicValue value)

relations

public Set<Relation> relations()

addRelation

public ProgramState addRelation(Relation relation)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

peekStack

public SymbolicValue peekStack()

peekStack

public SymbolicValue peekStack(int n)

removeSymbols

public ProgramState removeSymbols(Set<Symbol> symbolsToKeep)

getStack

@Deprecated
public ExpressionStack getStack()

Deprecated.

Temporary method

toString

public String toString()

Overrides:

toString in class Object

getSymbolicValue

@Nullable
public SymbolicValue getSymbolicValue(IdentifierTree identifier,
                                                SymbolicExecution execution)