de.uka.ilkd.key.java.statement

Class MethodFrame

java.lang.Object

de.uka.ilkd.key.java.JavaSourceElement

de.uka.ilkd.key.java.JavaProgramElement

de.uka.ilkd.key.java.JavaNonTerminalProgramElement

de.uka.ilkd.key.java.statement.JavaStatement

de.uka.ilkd.key.java.statement.MethodFrame

All Implemented Interfaces:

ModelElement, NonTerminalProgramElement, ProgramElement, SourceElement, Statement, StatementContainer, SVSubstitute, ProgramPrefix

public class MethodFrame
extends JavaStatement
implements Statement, StatementContainer, ProgramPrefix

The statement inserted by KeY if a method call is executed.

Field Summary

Fields

Modifier and Type	Field and Description
private StatementBlock	body Body.
private IExecutionContext	execContext
private PosInProgram	firstActiveChildPos
private MethodFrame	innerMostMethodFrame
private int	prefixLength
private IProgramVariable	resultVar result

Constructor Summary

Constructors

Constructor and Description
MethodFrame(IProgramVariable resultVar, IExecutionContext execContext, StatementBlock body) Labeled statement.
MethodFrame(IProgramVariable resultVar, IExecutionContext execContext, StatementBlock body, PositionInfo pos) Labeled statement.

Method Summary

Modifier and Type	Method and Description
StatementBlock	getBody() Get body.
ProgramElement	getChildAt(int index) Returns the child at the specified index in this node's "virtual" child array
int	getChildCount() Returns the number of children of this node.
IExecutionContext	getExecutionContext() returns the execution context for the elements in the method frame's body
PosInProgram	getFirstActiveChildPos() returns the position of the first active child
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
MethodFrame	getInnerMostMethodFrame() returns the inner most MethodFrame
SourceElement	getLastElement() Finds the source element that occurs last in the source.
ProgramPrefix	getLastPrefixElement() return the last prefix element
ProgramPrefix	getNextPrefixElement() return the next prefix element if no next prefix element is available an IndexOutOfBoundsException is thrown
ImmutableArray<ProgramPrefix>	getPrefixElements() returns an array with all prefix elements starting at this element
int	getPrefixLength() returns the length of the prefix
IProgramMethod	getProgramMethod() Get method.
IProgramVariable	getProgramVariable() Get the method call header.
Statement	getStatementAt(int index) Return the statement at the specified index in this node's "virtual" statement array.
int	getStatementCount() Get the number of statements in this container.
boolean	hasNextPrefixElement() return true if there is a next prefix element
void	prettyPrint(PrettyPrinter p) Pretty printing the source element.
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Methods inherited from class de.uka.ilkd.key.java.JavaNonTerminalProgramElement

compatibleBlockSize, computeHashCode, equals, equalsModRenaming, getArrayPos, match, matchChildren

Methods inherited from class de.uka.ilkd.key.java.JavaProgramElement

getComments, hashCode, prettyPrintMain, reuseSignature

Methods inherited from class de.uka.ilkd.key.java.JavaSourceElement

getEndPosition, getParentClass, getPositionInfo, getRelativePosition, getStartPosition, setParentClass, toSource, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uka.ilkd.key.java.ProgramElement

getComments, match

Methods inherited from interface de.uka.ilkd.key.java.SourceElement

equalsModRenaming, getEndPosition, getPositionInfo, getRelativePosition, getStartPosition

Field Detail

resultVar

private final IProgramVariable resultVar

result

body

private final StatementBlock body

Body.

execContext

private final IExecutionContext execContext

firstActiveChildPos

private final PosInProgram firstActiveChildPos

prefixLength

private final int prefixLength

innerMostMethodFrame

private final MethodFrame innerMostMethodFrame

Constructor Detail

MethodFrame

public MethodFrame(IProgramVariable resultVar,
                   IExecutionContext execContext,
                   StatementBlock body)

Labeled statement.

Parameters:

resultVar - the ProgramVariable the return value is assigned to

body - a Statement containing the method body of the called method

MethodFrame

public MethodFrame(IProgramVariable resultVar,
                   IExecutionContext execContext,
                   StatementBlock body,
                   PositionInfo pos)

Labeled statement.

Parameters:

resultVar - the ProgramVariable the return value is assigned to

body - a Statement containing the method body of the called method

Method Detail

hasNextPrefixElement

public boolean hasNextPrefixElement()

Description copied from interface: ProgramPrefix

return true if there is a next prefix element

Specified by:

hasNextPrefixElement in interface ProgramPrefix

getNextPrefixElement

public ProgramPrefix getNextPrefixElement()

Description copied from interface: ProgramPrefix

return the next prefix element if no next prefix element is available an IndexOutOfBoundsException is thrown

Specified by:

getNextPrefixElement in interface ProgramPrefix

getLastPrefixElement

public ProgramPrefix getLastPrefixElement()

Description copied from interface: ProgramPrefix

return the last prefix element

Specified by:

getLastPrefixElement in interface ProgramPrefix

getPrefixLength

public int getPrefixLength()

Description copied from interface: ProgramPrefix

returns the length of the prefix

Specified by:

getPrefixLength in interface ProgramPrefix

getInnerMostMethodFrame

public MethodFrame getInnerMostMethodFrame()

Description copied from interface: ProgramPrefix

returns the inner most MethodFrame

Specified by:

getInnerMostMethodFrame in interface ProgramPrefix

getPrefixElements

public ImmutableArray<ProgramPrefix> getPrefixElements()

Description copied from interface: ProgramPrefix

returns an array with all prefix elements starting at this element

Specified by:

getPrefixElements in interface ProgramPrefix

getFirstActiveChildPos

public PosInProgram getFirstActiveChildPos()

Description copied from interface: ProgramPrefix

returns the position of the first active child

Specified by:

getFirstActiveChildPos in interface ProgramPrefix

getFirstElement

public SourceElement getFirstElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs first in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getFirstElement in interface SourceElement

Overrides:

getFirstElement in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getStartPosition()

getFirstElementIncludingBlocks

public SourceElement getFirstElementIncludingBlocks()

Description copied from interface: SourceElement

Finds the source element that occurs first in the source.

Specified by:

getFirstElementIncludingBlocks in interface SourceElement

Overrides:

getFirstElementIncludingBlocks in class JavaSourceElement

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

SourceElement.getStartPosition()

getLastElement

public SourceElement getLastElement()

Description copied from class: JavaSourceElement

Finds the source element that occurs last in the source. The default implementation returns this element, which is correct for all terminal program elements, and many non terminals such as statements and prefixed operators.

Specified by:

getLastElement in interface SourceElement

Overrides:

getLastElement in class JavaSourceElement

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

JavaSourceElement.toSource(), JavaSourceElement.getEndPosition()

getProgramVariable

public IProgramVariable getProgramVariable()

Get the method call header.

Returns:

the MethodCallHeader

getExecutionContext

public IExecutionContext getExecutionContext()

returns the execution context for the elements in the method frame's body

getBody

public StatementBlock getBody()

Get body.

Returns:

the Statement

getProgramMethod

public IProgramMethod getProgramMethod()

Get method.

Returns:

the method

getChildCount

public int getChildCount()

Returns the number of children of this node.

Specified by:

getChildCount in interface NonTerminalProgramElement

Returns:

an int giving the number of children of this node

getChildAt

public ProgramElement getChildAt(int index)

Returns the child at the specified index in this node's "virtual" child array

Specified by:

getChildAt in interface NonTerminalProgramElement

Parameters:

index - an index into this node's "virtual" child array

Returns:

the program element at the given position

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds

getStatementCount

public int getStatementCount()

Get the number of statements in this container.

Specified by:

getStatementCount in interface StatementContainer

Returns:

the number of statements.

getStatementAt

public Statement getStatementAt(int index)

Return the statement at the specified index in this node's "virtual" statement array.

Specified by:

getStatementAt in interface StatementContainer

Parameters:

index - an index for a statement.

Returns:

the statement with the given index.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index is out of bounds.

visit

public void visit(Visitor v)

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Specified by:

visit in interface SourceElement

Parameters:

v - the Visitor

prettyPrint

public void prettyPrint(PrettyPrinter p)
                 throws java.io.IOException

Description copied from class: JavaSourceElement

Pretty printing the source element.

Specified by:

prettyPrint in interface SourceElement

Overrides:

prettyPrint in class JavaProgramElement

Parameters:

p - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.