de.uka.ilkd.key.proof.init

Class FunctionalOperationContractPO

java.lang.Object

de.uka.ilkd.key.proof.init.AbstractPO

de.uka.ilkd.key.proof.init.AbstractOperationPO

de.uka.ilkd.key.proof.init.FunctionalOperationContractPO

All Implemented Interfaces:

ContractPO, IPersistablePO, ProofOblInput

public class FunctionalOperationContractPO
extends AbstractOperationPO
implements ContractPO

The proof obligation for operation contracts.

The generated Sequent has the following form:

 
 ==>
 <generalAssumptions> &
 <preconditions>
 ->
 <updatesToStoreInitialValues>
 <modalityStart>
 exc=null;try {<methodBodyExpand>}catch(java.lang.Throwable e) {exc = e}
 <modalityEnd>
 (exc = null & <postconditions > & <optionalUninterpretedPredicate>)
 
 

Nested Class Summary

Nested classes/interfaces inherited from class de.uka.ilkd.key.proof.init.AbstractPO

AbstractPO.Vertex

Nested classes/interfaces inherited from interface de.uka.ilkd.key.proof.init.IPersistablePO

IPersistablePO.LoadedPOContainer

Field Summary

Fields

Modifier and Type	Field and Description
private FunctionalOperationContract	contract
protected Term	mbyAtPre
static java.util.Map<java.lang.Boolean,java.lang.String>	TRANSACTION_TAGS

Fields inherited from class de.uka.ilkd.key.proof.init.AbstractOperationPO

proofConfig

Fields inherited from class de.uka.ilkd.key.proof.init.AbstractPO

environmentConfig, environmentServices, heapLDT, javaInfo, name, poNames, poTerms, specRepos, taclets, tb

Fields inherited from interface de.uka.ilkd.key.proof.init.IPersistablePO

PROPERTY_ADD_SYMBOLIC_EXECUTION_LABEL, PROPERTY_ADD_UNINTERPRETED_PREDICATE, PROPERTY_CLASS, PROPERTY_FILENAME, PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
FunctionalOperationContractPO(InitConfig initConfig, FunctionalOperationContract contract) Constructor.
FunctionalOperationContractPO(InitConfig initConfig, FunctionalOperationContract contract, boolean addUninterpretedPredicate, boolean addSymbolicExecutionLabel) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Term	buildFrameClause(java.util.List<LocationVariable> modHeaps, java.util.Map<Term,Term> heapToAtPre, ProgramVariable selfVar, ImmutableList<ProgramVariable> paramVars, Services services) Builds the frame clause including the modifies clause.
protected ImmutableList<StatementBlock>	buildOperationBlocks(ImmutableList<LocationVariable> formalParVars, ProgramVariable selfVar, ProgramVariable resultVar, Services services) Builds the code to execute in different statement blocks. 1. code to execute before the try block 2. code to execute in the try block 3. code to execute in the catch block 4. code to execute in the finally block
protected java.lang.String	buildPOName(boolean transactionFlag) Returns the name of the Proof based on the given transaction flag.
protected Term	buildUpdate(ImmutableList<ProgramVariable> paramVars, ImmutableList<LocationVariable> formalParamVars, java.util.Map<LocationVariable,LocationVariable> atPreVars, Services services) Builds the initial updates.
boolean	equals(java.lang.Object o)
void	fillSaveProperties(java.util.Properties properties) This method is called by a ProofSaver to store the proof specific settings in the given Properties.
protected Term	generateMbyAtPreDef(ProgramVariable selfVar, ImmutableList<ProgramVariable> paramVars, Services services)
protected KeYJavaType	getCalleeKeYJavaType() Returns the KeYJavaType which contains AbstractOperationPO.getProgramMethod().
KeYJavaType	getContainerType() Returns the KeYJavaType in which the proven element is contained in.
FunctionalOperationContract	getContract()
protected Term	getGlobalDefs(LocationVariable heap, Term heapTerm, Term selfTerm, ImmutableList<Term> paramTerms, Services services)
Term	getMbyAtPre()
protected Term	getPost(java.util.List<LocationVariable> modHeaps, ProgramVariable selfVar, ImmutableList<ProgramVariable> paramVars, ProgramVariable resultVar, ProgramVariable exceptionVar, java.util.Map<LocationVariable,LocationVariable> atPreVars, Services services) Creates the postcondition.
protected Term	getPre(java.util.List<LocationVariable> modHeaps, ProgramVariable selfVar, ImmutableList<ProgramVariable> paramVars, java.util.Map<LocationVariable,LocationVariable> atPreVars, Services services) Creates the precondition.
protected IProgramMethod	getProgramMethod() Returns the IProgramMethod to call.
protected Modality	getTerminationMarker() Returns the Modality to use as termination marker.
int	hashCode()
boolean	implies(ProofOblInput po) If true, then this PO implies the passed one.
protected boolean	isTransactionApplicable() Checks if transactions are applicable.
static IPersistablePO.LoadedPOContainer	loadFrom(InitConfig initConfig, java.util.Properties properties) Instantiates a new proof obligation with the given settings.

Methods inherited from class de.uka.ilkd.key.proof.init.AbstractOperationPO

addAdditionalUninterpretedPredicateIfRequired, addUninterpretedPredicateIfRequired, buildFreePre, buildJavaBlock, buildProgramTerm, createUninterpretedPredicate, ensureUninterpretedPredicateExists, generateParamsOK, generateParamsOK2, getAdditionalUninterpretedPredicates, getAdditionalUninterpretedPredicates, getBaseHeap, getCreatedInitConfigForSingleProof, getInitialTaclets, getSavedHeap, getUninterpretedPredicate, getUninterpretedPredicate, getUninterpretedPredicateName, isAddSymbolicExecutionLabel, isAddSymbolicExecutionLabel, isAddUninterpretedPredicate, isAddUninterpretedPredicate, isCopyOfMethodArgumentsUsed, isMakeNamesUnique, modifyPostTerm, newAdditionalUninterpretedPredicate, postInit, readProblem

Methods inherited from class de.uka.ilkd.key.proof.init.AbstractPO

assignPOTerms, collectClassAxioms, createProof, createProofObject, generateSelfCreated, generateSelfExactType, generateSelfExactType, generateSelfNotNull, generateWdTaclets, getName, getPO, name, register, register, register, selectClassAxioms

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uka.ilkd.key.proof.init.ProofOblInput

getPO, name, readProblem

Field Detail

TRANSACTION_TAGS

public static java.util.Map<java.lang.Boolean,java.lang.String> TRANSACTION_TAGS

contract

private FunctionalOperationContract contract

mbyAtPre

protected Term mbyAtPre

Constructor Detail

FunctionalOperationContractPO

public FunctionalOperationContractPO(InitConfig initConfig,
                                     FunctionalOperationContract contract)

Constructor.

Parameters:

initConfig - The InitConfig to use.

contract - The FunctionalOperationContractPO to prove.

FunctionalOperationContractPO

public FunctionalOperationContractPO(InitConfig initConfig,
                                     FunctionalOperationContract contract,
                                     boolean addUninterpretedPredicate,
                                     boolean addSymbolicExecutionLabel)

Constructor.

Parameters:

initConfig - The InitConfig to use.

contract - The FunctionalOperationContractPO to prove.

addUninterpretedPredicate - true postcondition contains uninterpreted predicate, false uninterpreted predicate is not contained in postcondition.

addSymbolicExecutionLabel - true to add the SymbolicExecutionTermLabel to the modality, false to not label the modality.

Method Detail

getProgramMethod

protected IProgramMethod getProgramMethod()

Returns the IProgramMethod to call.

Specified by:

getProgramMethod in class AbstractOperationPO

Returns:

The IProgramMethod to call.

isTransactionApplicable

protected boolean isTransactionApplicable()

Checks if transactions are applicable.

Specified by:

isTransactionApplicable in class AbstractOperationPO

Returns:

Transactions are applicable?

getCalleeKeYJavaType

protected KeYJavaType getCalleeKeYJavaType()

Returns the KeYJavaType which contains AbstractOperationPO.getProgramMethod().

Specified by:

getCalleeKeYJavaType in class AbstractOperationPO

Returns:

The KeYJavaType which contains AbstractOperationPO.getProgramMethod().

buildOperationBlocks

protected ImmutableList<StatementBlock> buildOperationBlocks(ImmutableList<LocationVariable> formalParVars,
                                                             ProgramVariable selfVar,
                                                             ProgramVariable resultVar,
                                                             Services services)

Builds the code to execute in different statement blocks. 1. code to execute before the try block 2. code to execute in the try block 3. code to execute in the catch block 4. code to execute in the finally block

Specified by:

buildOperationBlocks in class AbstractOperationPO

Parameters:

formalParVars - Arguments from formal parameters for method call.

selfVar - The self variable.

resultVar - The result variable.

services - services instance

Returns:

operation blocks as statement blocks

generateMbyAtPreDef

protected Term generateMbyAtPreDef(ProgramVariable selfVar,
                                   ImmutableList<ProgramVariable> paramVars,
                                   Services services)

Specified by:

generateMbyAtPreDef in class AbstractOperationPO

getPre

protected Term getPre(java.util.List<LocationVariable> modHeaps,
                      ProgramVariable selfVar,
                      ImmutableList<ProgramVariable> paramVars,
                      java.util.Map<LocationVariable,LocationVariable> atPreVars,
                      Services services)

Creates the precondition.

Specified by:

getPre in class AbstractOperationPO

Parameters:

modHeaps - The heaps.

selfVar - The self variable.

paramVars - The parameters ProgramVariables.

atPreVars - Mapping of LocationVariable to the LocationVariable which contains the initial value.

services - The Services to use.

Returns:

The Term representing the precondition.

getPost

protected Term getPost(java.util.List<LocationVariable> modHeaps,
                       ProgramVariable selfVar,
                       ImmutableList<ProgramVariable> paramVars,
                       ProgramVariable resultVar,
                       ProgramVariable exceptionVar,
                       java.util.Map<LocationVariable,LocationVariable> atPreVars,
                       Services services)

Creates the postcondition.

Specified by:

getPost in class AbstractOperationPO

Parameters:

modHeaps - The heaps.

selfVar - The self variable.

paramVars - The parameters ProgramVariables.

resultVar - The result variable.

exceptionVar - The exception variable.

atPreVars - Mapping of LocationVariable to the LocationVariable which contains the initial value.

services - The Services to use.

Returns:

The Term representing the postcondition.

getGlobalDefs

protected Term getGlobalDefs(LocationVariable heap,
                             Term heapTerm,
                             Term selfTerm,
                             ImmutableList<Term> paramTerms,
                             Services services)

Specified by:

getGlobalDefs in class AbstractOperationPO

buildFrameClause

protected Term buildFrameClause(java.util.List<LocationVariable> modHeaps,
                                java.util.Map<Term,Term> heapToAtPre,
                                ProgramVariable selfVar,
                                ImmutableList<ProgramVariable> paramVars,
                                Services services)

Builds the frame clause including the modifies clause.

Specified by:

buildFrameClause in class AbstractOperationPO

Parameters:

modHeaps - The heaps.

heapToAtPre - The previous heap before execution.

selfVar - The self variable.

paramVars - The parameters ProgramVariables.

services - services instance

Returns:

The created Term representing the frame clause.

getTerminationMarker

protected Modality getTerminationMarker()

Returns the Modality to use as termination marker.

Specified by:

getTerminationMarker in class AbstractOperationPO

Returns:

The Modality to use as termination marker.

buildUpdate

protected Term buildUpdate(ImmutableList<ProgramVariable> paramVars,
                           ImmutableList<LocationVariable> formalParamVars,
                           java.util.Map<LocationVariable,LocationVariable> atPreVars,
                           Services services)

Builds the initial updates.

Overrides:

buildUpdate in class AbstractOperationPO

Parameters:

paramVars - Formal parameters of method call.

formalParamVars - Arguments from formal parameters for method call.

atPreVars - Mapping of LocationVariable to the LocationVariable which contains the initial value.

services - The services instance.

Returns:

The Term representing the initial updates.

buildPOName

protected java.lang.String buildPOName(boolean transactionFlag)

Returns the name of the Proof based on the given transaction flag.

Specified by:

buildPOName in class AbstractOperationPO

Parameters:

transactionFlag - The transaction flag.

Returns:

The proof name to use.

getContract

public FunctionalOperationContract getContract()

Specified by:

getContract in interface ContractPO

getMbyAtPre

public Term getMbyAtPre()

Specified by:

getMbyAtPre in interface ContractPO

implies

public boolean implies(ProofOblInput po)

If true, then this PO implies the passed one.

Specified by:

implies in interface ProofOblInput

Overrides:

implies in class AbstractPO

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fillSaveProperties

public void fillSaveProperties(java.util.Properties properties)
                        throws java.io.IOException

This method is called by a ProofSaver to store the proof specific settings in the given Properties. The stored settings have to contain all information required to instantiate the proof obligation again and this instance should create the same Sequent (if code and specifications are unchanged).

Specified by:

fillSaveProperties in interface IPersistablePO

Overrides:

fillSaveProperties in class AbstractOperationPO

Parameters:

properties - The Properties to fill with the proof obligation specific settings.

Throws:

java.io.IOException - Occurred Exception.

loadFrom

public static IPersistablePO.LoadedPOContainer loadFrom(InitConfig initConfig,
                                                        java.util.Properties properties)
                                                 throws java.io.IOException

Instantiates a new proof obligation with the given settings.

Parameters:

initConfig - The already load InitConfig.

properties - The settings of the proof obligation to instantiate.

Returns:

The instantiated proof obligation.

Throws:

java.io.IOException - Occurred Exception.

getContainerType

public KeYJavaType getContainerType()

Returns the KeYJavaType in which the proven element is contained in.

Specified by:

getContainerType in interface ProofOblInput

Overrides:

getContainerType in class AbstractPO

Returns:

The KeYJavaType in which the proven element is contained in or null if not available.