Package com.tonic.analysis.simulation.state

Class CallStackState

java.lang.Object

com.tonic.analysis.simulation.state.CallStackState

public final class CallStackState
extends Object

Immutable call stack for inter-procedural simulation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CallStackState.CallFrame	Represents a single frame on the call stack.

Method Summary

Modifier and Type	Method	Description
boolean	contains(IRMethod method)	Detects recursion by searching the frames for a method.
int	depth()
static CallStackState	empty()
boolean	equals(Object o)
List<IRMethod>	getCallChain()
String	getCallChainString()	Renders the call chain for debugging.
CallStackState.CallFrame	getFrame(int depth)	Reads a frame by position.
List<CallStackState.CallFrame>	getFrames()
int	hashCode()
boolean	isEmpty()
CallStackState.CallFrame	peek()
CallStackState	pop()	Removes the top frame.
CallStackState	push(CallStackState.CallFrame frame)	Adds a frame on top of the existing ones.
String	toString()
static CallStackState	withFrame(CallStackState.CallFrame frame)	Creates a stack holding a single frame.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

empty

public static CallStackState empty()

Returns:

a call stack with no frames

withFrame

public static CallStackState withFrame(CallStackState.CallFrame frame)

Creates a stack holding a single frame.

Parameters:

frame - the initial frame

Returns:

a stack of depth one

push

public CallStackState push(CallStackState.CallFrame frame)

Adds a frame on top of the existing ones.

Parameters:

frame - the frame to push

Returns:

a new stack ending with that frame

pop

public CallStackState pop()

Removes the top frame.

Returns:

a new stack without the top frame, or this stack if it is already empty

peek

public CallStackState.CallFrame peek()

Returns:

the top frame, or null if the stack is empty

depth

public int depth()

Returns:

the number of frames on the stack

isEmpty

public boolean isEmpty()

Returns:

true if no frame is on the stack

getFrames

public List<CallStackState.CallFrame> getFrames()

Returns:

an unmodifiable view of the frames, bottom to top

getFrame

public CallStackState.CallFrame getFrame(int depth)

Reads a frame by position.

Parameters:

depth - the frame index, 0 being the bottom of the stack

Returns:

the frame, or null if the index is out of range

contains

public boolean contains(IRMethod method)

Detects recursion by searching the frames for a method.

Parameters:

method - the method to look for

Returns:

true if any frame is executing it

getCallChain

public List<IRMethod> getCallChain()

Returns:

the method of every frame, bottom to top

getCallChainString

public String getCallChainString()

Renders the call chain for debugging.

Returns:

the method names bottom to top joined by " -> ", or "<empty>" for an empty stack

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object