de.uka.ilkd.key.symbolic_execution.model.impl

Class ExecutionMethodReturn

java.lang.Object

de.uka.ilkd.key.symbolic_execution.model.impl.AbstractExecutionElement

de.uka.ilkd.key.symbolic_execution.model.impl.AbstractExecutionNode<S>

de.uka.ilkd.key.symbolic_execution.model.impl.AbstractExecutionMethodReturn<SourceElement>

de.uka.ilkd.key.symbolic_execution.model.impl.ExecutionMethodReturn

All Implemented Interfaces:

IExecutionBaseMethodReturn<SourceElement>, IExecutionElement, IExecutionMethodReturn, IExecutionNode<SourceElement>

public class ExecutionMethodReturn
extends AbstractExecutionMethodReturn<SourceElement>
implements IExecutionMethodReturn

The default implementation of IExecutionMethodReturn.

Author:

Martin Hentschel

Field Summary

Fields

Modifier and Type	Field and Description
private String	nameIncludingReturnValue The node name including the return value.
private IExecutionMethodReturnValue[]	returnValues The possible return values.
private String	signatureIncludingReturnValue The node name with signature including the return value.

Fields inherited from interface de.uka.ilkd.key.symbolic_execution.model.IExecutionNode

INTERNAL_NODE_NAME_END, INTERNAL_NODE_NAME_START

Constructor Summary

Constructors

Constructor and Description
ExecutionMethodReturn(ITreeSettings settings, Node proofNode, ExecutionMethodCall methodCall) Constructor.

Method Summary

Modifier and Type	Method and Description
protected String	computeCalledMethodName() Computes the name of the called method.
protected String	computeCalledMethodSignature() Computes the signature of the called method.
static String	createMethodReturnName(Object returnValue, String methodName) Creates the human readable name which is shown in IExecutionMethodReturn instances.
protected Node	findMethodReturnNode(Node node) Searches from the given Node the parent which applies the rule "methodCallReturn" in the same modality.
String	getElementType() Returns a human readable element type name.
String	getNameIncludingReturnValue() Returns the human readable node name including the return value (IExecutionMethodReturn.getReturnValues()).
IExecutionMethodReturnValue[]	getReturnValues() Returns the possible return values.
String	getSignatureIncludingReturnValue() Returns the human readable signature including the return value (IExecutionMethodReturn.getReturnValues()).
boolean	isReturnValuesComputed() Checks if the values of IExecutionMethodReturn.getReturnValues() are already computed.
protected IExecutionConstraint[]	lazyComputeConstraints() Computes the constraints lazily when AbstractExecutionNode.getConstraints() is called the first time.
protected String	lazyComputeName() Computes the name of this node lazily when AbstractExecutionElement.getName() is called the first time.
protected String	lazyComputeNameIncludingReturnValue() Computes the name including the return value lazily when getNameIncludingReturnValue() is called the first time.
protected IExecutionMethodReturnValue[]	lazyComputeReturnValues() Computes the return value lazily when #getReturnValue() is called the first time.
protected String	lazyComputeSignature() Computes the signature lazily when AbstractExecutionMethodReturn.getSignature() is called the first time.
protected String	lazyComputeSigntureIncludingReturnValue() Computes the signature including the return value lazily when getNameIncludingReturnValue() is called the first time.

Methods inherited from class de.uka.ilkd.key.symbolic_execution.model.impl.AbstractExecutionMethodReturn

getCallStateVariables, getFormatedMethodReturnCondition, getMethodCall, getMethodReturnCondition, getSignature, lazyComputeCallStateVariables, lazyComputeMethodReturnCondition

Methods inherited from class de.uka.ilkd.key.symbolic_execution.model.impl.AbstractExecutionNode

addChild, addCompletedBlock, getActivePositionInfo, getActiveStatement, getBlockCompletionCondition, getCallStack, getChildren, getCompletedBlocks, getConstraints, getCurrentLayout, getFormatedBlockCompletionCondition, getFormatedPathCondition, getInitialLayout, getLayoutExtractor, getLayoutsCount, getLayoutsEquivalenceClasses, getModalityPIO, getParent, getPathCondition, getVariables, getVariables, isPathConditionChanged, lazyComputeBlockCompletionCondition, lazyComputeLayoutExtractor, lazyComputeModalityPIO, lazyComputeVariables, lazyComputeVariables, removeChild, removeCompletedBlock, setCallStack, setParent

Methods inherited from class de.uka.ilkd.key.symbolic_execution.model.impl.AbstractExecutionElement

formatTerm, getAppliedRuleApp, getInitConfig, getName, getProof, getProofNode, getProofNodeInfo, getServices, getSettings, isDisposed, isNameComputed, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.uka.ilkd.key.symbolic_execution.model.IExecutionBaseMethodReturn

getCallStateVariables, getFormatedMethodReturnCondition, getMethodCall, getMethodReturnCondition, getSignature

Methods inherited from interface de.uka.ilkd.key.symbolic_execution.model.IExecutionNode

getActivePositionInfo, getActiveStatement, getBlockCompletionCondition, getCallStack, getChildren, getCompletedBlocks, getConstraints, getCurrentLayout, getFormatedBlockCompletionCondition, getFormatedPathCondition, getInitialLayout, getLayoutsCount, getLayoutsEquivalenceClasses, getParent, getPathCondition, getVariables, getVariables, isPathConditionChanged

Methods inherited from interface de.uka.ilkd.key.symbolic_execution.model.IExecutionElement

getAppliedRuleApp, getInitConfig, getModalityPIO, getName, getProof, getProofNode, getProofNodeInfo, getServices, getSettings, isDisposed

Field Detail

signatureIncludingReturnValue

private String signatureIncludingReturnValue

The node name with signature including the return value.

nameIncludingReturnValue

private String nameIncludingReturnValue

The node name including the return value.

returnValues

private IExecutionMethodReturnValue[] returnValues

The possible return values.

Constructor Detail

ExecutionMethodReturn

public ExecutionMethodReturn(ITreeSettings settings,
                             Node proofNode,
                             ExecutionMethodCall methodCall)

Constructor.

Parameters:

settings - The ITreeSettings to use.

proofNode - The Node of KeY's proof tree which is represented by this IExecutionNode.

methodCall - The IExecutionMethodCall which is now returned.

Method Detail

lazyComputeName

protected String lazyComputeName()
                          throws ProofInputException

Computes the name of this node lazily when AbstractExecutionElement.getName() is called the first time.

Specified by:

lazyComputeName in class AbstractExecutionElement

Returns:

The human readable name of this IExecutionNode.

Throws:

ProofInputException

computeCalledMethodName

protected String computeCalledMethodName()

Computes the name of the called method.

Returns:

The name of the called method.

lazyComputeSignature

protected String lazyComputeSignature()
                               throws ProofInputException

Computes the signature lazily when AbstractExecutionMethodReturn.getSignature() is called the first time.

Specified by:

lazyComputeSignature in class AbstractExecutionMethodReturn<SourceElement>

Returns:

The name including the return value.

Throws:

ProofInputException

computeCalledMethodSignature

protected String computeCalledMethodSignature()
                                       throws ProofInputException

Computes the signature of the called method.

Returns:

The signature of the called method.

Throws:

ProofInputException

getNameIncludingReturnValue

public String getNameIncludingReturnValue()
                                   throws ProofInputException

Returns the human readable node name including the return value (IExecutionMethodReturn.getReturnValues()).

Specified by:

getNameIncludingReturnValue in interface IExecutionMethodReturn

Returns:

The human readable node name including the return value.

Throws:

ProofInputException - Occurred Exception.

lazyComputeNameIncludingReturnValue

protected String lazyComputeNameIncludingReturnValue()
                                              throws ProofInputException

Computes the name including the return value lazily when getNameIncludingReturnValue() is called the first time.

Returns:

The name including the return value.

Throws:

Occurred - Exception.

ProofInputException

getSignatureIncludingReturnValue

public String getSignatureIncludingReturnValue()
                                        throws ProofInputException

Returns the human readable signature including the return value (IExecutionMethodReturn.getReturnValues()).

Specified by:

getSignatureIncludingReturnValue in interface IExecutionMethodReturn

Returns:

The human readable signature including the return value.

Throws:

ProofInputException - Occurred Exception.

lazyComputeSigntureIncludingReturnValue

protected String lazyComputeSigntureIncludingReturnValue()
                                                  throws ProofInputException

Computes the signature including the return value lazily when getNameIncludingReturnValue() is called the first time.

Returns:

The name including the return value.

Throws:

Occurred - Exception.

ProofInputException

getReturnValues

public IExecutionMethodReturnValue[] getReturnValues()
                                              throws ProofInputException

Returns the possible return values.

Specified by:

getReturnValues in interface IExecutionMethodReturn

Returns:

The possible return values.

Throws:

ProofInputException - Occurred Exception.

isReturnValuesComputed

public boolean isReturnValuesComputed()

Checks if the values of IExecutionMethodReturn.getReturnValues() are already computed.

Specified by:

isReturnValuesComputed in interface IExecutionMethodReturn

Returns:

true value of IExecutionMethodReturn.getReturnValues() are already computed, false values of IExecutionMethodReturn.getReturnValues() needs to be computed.

lazyComputeReturnValues

protected IExecutionMethodReturnValue[] lazyComputeReturnValues()
                                                         throws ProofInputException

Computes the return value lazily when #getReturnValue() is called the first time.

Returns:

The return value.

Throws:

ProofInputException - Occurred Exception.

findMethodReturnNode

protected Node findMethodReturnNode(Node node)

Searches from the given Node the parent which applies the rule "methodCallReturn" in the same modality.

Parameters:

node - The Node to start search from.

Returns:

The found Node with rule "methodCallReturn" or null if no node was found.

createMethodReturnName

public static String createMethodReturnName(Object returnValue,
                                            String methodName)

Creates the human readable name which is shown in IExecutionMethodReturn instances.

Parameters:

returnValue - The return value.

methodName - The name of the method that is completely executed.

Returns:

The created human readable name.

lazyComputeConstraints

protected IExecutionConstraint[] lazyComputeConstraints()

Computes the constraints lazily when AbstractExecutionNode.getConstraints() is called the first time.

Specified by:

lazyComputeConstraints in class AbstractExecutionNode<SourceElement>

Returns:

The IExecutionConstraints of the current state.

getElementType

public String getElementType()

Returns a human readable element type name.

Specified by:

getElementType in interface IExecutionElement

Returns:

The human readable element type.