proguard.analysis.cpa.jvm.state

Class JvmFrameAbstractState<StateT extends AbstractState<StateT>>

java.lang.Object

proguard.analysis.cpa.jvm.state.JvmFrameAbstractState<StateT>

All Implemented Interfaces:

AbstractState<JvmFrameAbstractState<StateT>>

public class JvmFrameAbstractState<StateT extends AbstractState<StateT>>
extends java.lang.Object
implements AbstractState<JvmFrameAbstractState<StateT>>

The JvmFrameAbstractState combines the operand stack as the StackAbstractState and the local variable array as the ListAbstractState. This abstract state does not restrict the way one models values, i.e., one abstract state may correspond to a byte sequence of arbitrary length.

Field Summary

Fields

Modifier and Type	Field and Description
protected ListAbstractState<StateT>	localVariables
protected StackAbstractState<StateT>	operandStack

Constructor Summary

Constructors

Constructor and Description
JvmFrameAbstractState() Create an empty frame.
JvmFrameAbstractState(ListAbstractState<StateT> localVariables, StackAbstractState<StateT> operandStack) Create a frame from a local variable array and an operand stack.

Method Summary

Modifier and Type	Method and Description
JvmFrameAbstractState<StateT>	copy() Creates a copy of itself.
boolean	equals(java.lang.Object obj)
ListAbstractState<StateT>	getLocalVariables() Returns the variable array.
StackAbstractState<StateT>	getOperandStack() Returns the operand stack.
StateT	getVariableOrDefault(int index, StateT defaultState) Returns an abstract state at the indexth position of the variable array or defaultState if there is no entry.
int	hashCode()
boolean	isLessOrEqual(JvmFrameAbstractState<StateT> abstractState) Compares itself to the abstractState (i.e., compare the states on the partial order provided by the domain of the analysis).
JvmFrameAbstractState<StateT>	join(JvmFrameAbstractState<StateT> abstractState) Computes a join over itself and another abstract state abstractState (i.e., finds the least upper bound on the semilattice).
StateT	peek(int index) Returns the indexth element from the top of the operand stack.
StateT	peekOrDefault(int index, StateT defaultState) Returns the indexth element from the top of the operand stack or returns defaultState if the stack does not have enough elements.
StateT	pop() Removes the top element of the operand stack end returns it.
StateT	popOrDefault(StateT defaultState) Removes the top element of the operand stack end returns it.
StateT	push(StateT state) Inserts state to the top of the operand stack and returns it.
java.util.List<StateT>	pushAll(java.util.List<StateT> states) Sequentially inserts elements of states to the top of the operand stack and returns states.
StateT	setVariable(int index, StateT state, StateT defaultState) Sets the indexth position of the variable array to state and returns state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface proguard.analysis.cpa.interfaces.AbstractState

getPrecision, isLess

Field Detail

localVariables

protected final ListAbstractState<StateT extends AbstractState<StateT>> localVariables

operandStack

protected final StackAbstractState<StateT extends AbstractState<StateT>> operandStack

Constructor Detail

JvmFrameAbstractState

public JvmFrameAbstractState()

Create an empty frame.

JvmFrameAbstractState

public JvmFrameAbstractState(ListAbstractState<StateT> localVariables,
                             StackAbstractState<StateT> operandStack)

Create a frame from a local variable array and an operand stack.

Parameters:

localVariables - a local variable array

operandStack - an operand stack

Method Detail

join

public JvmFrameAbstractState<StateT> join(JvmFrameAbstractState<StateT> abstractState)

Description copied from interface: AbstractState

Computes a join over itself and another abstract state abstractState (i.e., finds the least upper bound on the semilattice).

Specified by:

join in interface AbstractState<JvmFrameAbstractState<StateT extends AbstractState<StateT>>>

isLessOrEqual

public boolean isLessOrEqual(JvmFrameAbstractState<StateT> abstractState)

Description copied from interface: AbstractState

Compares itself to the abstractState (i.e., compare the states on the partial order provided by the domain of the analysis).

Specified by:

isLessOrEqual in interface AbstractState<JvmFrameAbstractState<StateT extends AbstractState<StateT>>>

copy

public JvmFrameAbstractState<StateT> copy()

Description copied from interface: AbstractState

Creates a copy of itself.

Specified by:

copy in interface AbstractState<JvmFrameAbstractState<StateT extends AbstractState<StateT>>>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface AbstractState<JvmFrameAbstractState<StateT extends AbstractState<StateT>>>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface AbstractState<JvmFrameAbstractState<StateT extends AbstractState<StateT>>>

Overrides:

hashCode in class java.lang.Object

peekOrDefault

public StateT peekOrDefault(int index,
                            StateT defaultState)

Returns the indexth element from the top of the operand stack or returns defaultState if the stack does not have enough elements.

peek

public StateT peek(int index)

Returns the indexth element from the top of the operand stack.

pop

public StateT pop()

Removes the top element of the operand stack end returns it.

popOrDefault

public StateT popOrDefault(StateT defaultState)

Removes the top element of the operand stack end returns it. Returns defaultState if the stack is empty.

push

public StateT push(StateT state)

Inserts state to the top of the operand stack and returns it.

pushAll

public java.util.List<StateT> pushAll(java.util.List<StateT> states)

Sequentially inserts elements of states to the top of the operand stack and returns states.

getVariableOrDefault

public StateT getVariableOrDefault(int index,
                                   StateT defaultState)

Returns an abstract state at the indexth position of the variable array or defaultState if there is no entry.

setVariable

public StateT setVariable(int index,
                          StateT state,
                          StateT defaultState)

Sets the indexth position of the variable array to state and returns state. If the array has to be extended, the added cells are padded with defaultState.

getLocalVariables

public ListAbstractState<StateT> getLocalVariables()

Returns the variable array.

getOperandStack

public StackAbstractState<StateT> getOperandStack()

Returns the operand stack.