de.uka.ilkd.key.speclang

Class SimpleBlockContract

java.lang.Object

de.uka.ilkd.key.speclang.SimpleBlockContract

All Implemented Interfaces:

BlockContract, SpecificationElement

public final class SimpleBlockContract
extends Object
implements BlockContract

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SimpleBlockContract.Combinator
static class	SimpleBlockContract.Creator
private static class	SimpleBlockContract.ReplacementMap<S extends Sorted>
private static class	SimpleBlockContract.TermReplacementMap
private static class	SimpleBlockContract.VariableReplacementMap

Nested classes/interfaces inherited from interface de.uka.ilkd.key.speclang.BlockContract

BlockContract.Terms, BlockContract.Variables, BlockContract.VariablesCreator

Field Summary

Fields

Modifier and Type	Field and Description
private StatementBlock	block
private Map<LocationVariable,Boolean>	hasMod
private ImmutableList<InfFlowSpec>	infFlowSpecs
private Term	instantiationSelf
private JoinProcedure	joinProcedure
private List<Label>	labels
private IProgramMethod	method
private Modality	modality
private Map<LocationVariable,Term>	modifiesClauses
private Map<LocationVariable,Term>	postconditions
private Map<LocationVariable,Term>	preconditions
private boolean	transactionApplicable
private BlockContract.Variables	variables

Constructor Summary

Constructors

Constructor and Description

SimpleBlockContract(StatementBlock block, List<Label> labels, IProgramMethod method, Modality modality, Map<LocationVariable,Term> preconditions, Map<LocationVariable,Term> postconditions, Map<LocationVariable,Term> modifiesClauses, ImmutableList<InfFlowSpec> infFlowSpecs, JoinProcedure joinProcedure, BlockContract.Variables variables, boolean transactionApplicable, Map<LocationVariable,Boolean> hasMod)

Method Summary

Modifier and Type	Method and Description
static BlockContract	combine(ImmutableSet<BlockContract> contracts, Services services)
private Map<ProgramVariable,ProgramVariable>	createReplacementMap(BlockContract.Variables newVariables, Services services)
private Map<Term,Term>	createReplacementMap(Term newHeap, BlockContract.Terms newTerms, Services services)
boolean	equals(Object obj)
Term	getAssignable(LocationVariable heap)
StatementBlock	getBlock()
String	getDisplayName() Returns the displayed name.
Term	getEnsures(LocationVariable heap)
String	getHtmlText(Services services)
ImmutableList<InfFlowSpec>	getInfFlowSpecs() Returns the original information flow specification clause of the contract.
Term	getInstantiationSelfTerm(TermServices services) Returns the term internally used for self or a newly instantiated one.
JoinProcedure	getJoinProcedure()
KeYJavaType	getKJT() Returns the KeYJavaType representing the class/interface to which the specification element belongs.
List<Label>	getLabels()
IProgramMethod	getMethod()
Term	getMod(Services services) Returns the original modifies clause of the contract.
Modality	getModality()
Term	getModifiesClause(LocationVariable heap, ProgramVariable self, Services services)
Term	getModifiesClause(LocationVariable heap, Services services)
Term	getModifiesClause(LocationVariable heapVariable, Term heap, Term self, Services services)
String	getName() Returns the unique internal name of the specification element.
Contract.OriginalVariables	getOrigVars()
BlockContract.Variables	getPlaceholderVariables()
String	getPlainText(Services services, BlockContract.Terms terms)
Term	getPost(Services services) Returns the original postcondition of the contract.
Term	getPostcondition(LocationVariable heap, BlockContract.Variables variables, Services services)
Term	getPostcondition(LocationVariable heap, Services services)
Term	getPostcondition(LocationVariable heapVariable, Term heap, BlockContract.Terms terms, Services services)
Term	getPre(Services services) Returns the original precondition of the contract.
Term	getPrecondition(LocationVariable heap, ProgramVariable self, Map<LocationVariable,LocationVariable> remembranceHeaps, Services services)
Term	getPrecondition(LocationVariable heap, Services services)
Term	getPrecondition(LocationVariable heapVariable, Term heap, Term self, Map<LocationVariable,Term> remembranceHeaps, Services services)
Term	getRequires(LocationVariable heap)
IProgramMethod	getTarget() Returns the method in which the block is located.
String	getUniqueName()
BlockContract.Variables	getVariables() Returns the original used variables like self, result etc..
BlockContract.Terms	getVariablesAsTerms(Services services) Returns the original used variables like self, result etc.
VisibilityModifier	getVisibility() Returns the visibility of the invariant (null for default visibility)
int	hashCode()
boolean	hasInfFlowSpecs()
boolean	hasJoinProcedure()
boolean	hasMby() Tells whether the contract contains a measured_by clause.
boolean	hasModifiesClause(LocationVariable heap) Returns true iff the method (according to the contract) does not modify the heap at all, i.e., iff it is "strictly pure."
boolean	isReadOnly(Services services)
boolean	isTransactionApplicable()
BlockContract	setBlock(StatementBlock newBlock)
void	setInstantiationSelf(Term selfInstantiation)
BlockContract	setTarget(KeYJavaType newKJT, IObserverFunction newPM)
String	toString()
BlockContract	update(StatementBlock newBlock, Map<LocationVariable,Term> newPreconditions, Map<LocationVariable,Term> newPostconditions, Map<LocationVariable,Term> newModifiesClauses, ImmutableList<InfFlowSpec> newinfFlowSpecs, JoinProcedure newJoinProcedure, BlockContract.Variables newVariables)
void	visit(Visitor visitor)

Methods inherited from class java.lang.Object

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

Field Detail

block

private final StatementBlock block

labels

private final List<Label> labels

method

private final IProgramMethod method

modality

private final Modality modality

instantiationSelf

private Term instantiationSelf

preconditions

private final Map<LocationVariable,Term> preconditions

postconditions

private final Map<LocationVariable,Term> postconditions

modifiesClauses

private final Map<LocationVariable,Term> modifiesClauses

infFlowSpecs

private ImmutableList<InfFlowSpec> infFlowSpecs

joinProcedure

private JoinProcedure joinProcedure

variables

private final BlockContract.Variables variables

transactionApplicable

private final boolean transactionApplicable

hasMod

private final Map<LocationVariable,Boolean> hasMod

Constructor Detail

SimpleBlockContract

public SimpleBlockContract(StatementBlock block,
                           List<Label> labels,
                           IProgramMethod method,
                           Modality modality,
                           Map<LocationVariable,Term> preconditions,
                           Map<LocationVariable,Term> postconditions,
                           Map<LocationVariable,Term> modifiesClauses,
                           ImmutableList<InfFlowSpec> infFlowSpecs,
                           JoinProcedure joinProcedure,
                           BlockContract.Variables variables,
                           boolean transactionApplicable,
                           Map<LocationVariable,Boolean> hasMod)

Method Detail

combine

public static BlockContract combine(ImmutableSet<BlockContract> contracts,
                                    Services services)

getBlock

public StatementBlock getBlock()

Specified by:

getBlock in interface BlockContract

getLabels

public List<Label> getLabels()

Specified by:

getLabels in interface BlockContract

getMethod

public IProgramMethod getMethod()

Specified by:

getMethod in interface BlockContract

getKJT

public KeYJavaType getKJT()

Description copied from interface: SpecificationElement

Returns the KeYJavaType representing the class/interface to which the specification element belongs.

Specified by:

getKJT in interface SpecificationElement

getModality

public Modality getModality()

Specified by:

getModality in interface BlockContract

getPlaceholderVariables

public BlockContract.Variables getPlaceholderVariables()

Specified by:

getPlaceholderVariables in interface BlockContract

isTransactionApplicable

public boolean isTransactionApplicable()

Specified by:

isTransactionApplicable in interface BlockContract

isReadOnly

public boolean isReadOnly(Services services)

Specified by:

isReadOnly in interface BlockContract

hasModifiesClause

public boolean hasModifiesClause(LocationVariable heap)

Description copied from interface: BlockContract

Returns true iff the method (according to the contract) does not modify the heap at all, i.e., iff it is "strictly pure."

Specified by:

hasModifiesClause in interface BlockContract

Returns:

whether this contract is strictly pure.

getVariables

public BlockContract.Variables getVariables()

Description copied from interface: BlockContract

Returns the original used variables like self, result etc..

Specified by:

getVariables in interface BlockContract

getVariablesAsTerms

public BlockContract.Terms getVariablesAsTerms(Services services)

Description copied from interface: BlockContract

Returns the original used variables like self, result etc. as terms.

Specified by:

getVariablesAsTerms in interface BlockContract

getPrecondition

public Term getPrecondition(LocationVariable heap,
                            ProgramVariable self,
                            Map<LocationVariable,LocationVariable> remembranceHeaps,
                            Services services)

Specified by:

getPrecondition in interface BlockContract

getPrecondition

public Term getPrecondition(LocationVariable heapVariable,
                            Term heap,
                            Term self,
                            Map<LocationVariable,Term> remembranceHeaps,
                            Services services)

Specified by:

getPrecondition in interface BlockContract

getPrecondition

public Term getPrecondition(LocationVariable heap,
                            Services services)

Specified by:

getPrecondition in interface BlockContract

getPostcondition

public Term getPostcondition(LocationVariable heap,
                             BlockContract.Variables variables,
                             Services services)

Specified by:

getPostcondition in interface BlockContract

getPostcondition

public Term getPostcondition(LocationVariable heapVariable,
                             Term heap,
                             BlockContract.Terms terms,
                             Services services)

Specified by:

getPostcondition in interface BlockContract

getPostcondition

public Term getPostcondition(LocationVariable heap,
                             Services services)

Specified by:

getPostcondition in interface BlockContract

getModifiesClause

public Term getModifiesClause(LocationVariable heap,
                              ProgramVariable self,
                              Services services)

Specified by:

getModifiesClause in interface BlockContract

getModifiesClause

public Term getModifiesClause(LocationVariable heapVariable,
                              Term heap,
                              Term self,
                              Services services)

Specified by:

getModifiesClause in interface BlockContract

getModifiesClause

public Term getModifiesClause(LocationVariable heap,
                              Services services)

Specified by:

getModifiesClause in interface BlockContract

getPre

public Term getPre(Services services)

Description copied from interface: BlockContract

Returns the original precondition of the contract.

Specified by:

getPre in interface BlockContract

getRequires

public Term getRequires(LocationVariable heap)

Specified by:

getRequires in interface BlockContract

getPost

public Term getPost(Services services)

Description copied from interface: BlockContract

Returns the original postcondition of the contract.

Specified by:

getPost in interface BlockContract

getEnsures

public Term getEnsures(LocationVariable heap)

Specified by:

getEnsures in interface BlockContract

getMod

public Term getMod(Services services)

Description copied from interface: BlockContract

Returns the original modifies clause of the contract.

Specified by:

getMod in interface BlockContract

getInfFlowSpecs

public ImmutableList<InfFlowSpec> getInfFlowSpecs()

Description copied from interface: BlockContract

Returns the original information flow specification clause of the contract.

Specified by:

getInfFlowSpecs in interface BlockContract

getAssignable

public Term getAssignable(LocationVariable heap)

Specified by:

getAssignable in interface BlockContract

getJoinProcedure

public JoinProcedure getJoinProcedure()

Specified by:

getJoinProcedure in interface BlockContract

visit

public void visit(Visitor visitor)

Specified by:

visit in interface BlockContract

getName

public String getName()

Description copied from interface: SpecificationElement

Returns the unique internal name of the specification element.

Specified by:

getName in interface SpecificationElement

getUniqueName

public String getUniqueName()

Specified by:

getUniqueName in interface BlockContract

getDisplayName

public String getDisplayName()

Description copied from interface: SpecificationElement

Returns the displayed name.

Specified by:

getDisplayName in interface SpecificationElement

getHtmlText

public String getHtmlText(Services services)

Specified by:

getHtmlText in interface BlockContract

getPlainText

public String getPlainText(Services services,
                           BlockContract.Terms terms)

Specified by:

getPlainText in interface BlockContract

getVisibility

public VisibilityModifier getVisibility()

Description copied from interface: SpecificationElement

Returns the visibility of the invariant (null for default visibility)

Specified by:

getVisibility in interface SpecificationElement

update

public BlockContract update(StatementBlock newBlock,
                            Map<LocationVariable,Term> newPreconditions,
                            Map<LocationVariable,Term> newPostconditions,
                            Map<LocationVariable,Term> newModifiesClauses,
                            ImmutableList<InfFlowSpec> newinfFlowSpecs,
                            JoinProcedure newJoinProcedure,
                            BlockContract.Variables newVariables)

Specified by:

update in interface BlockContract

setBlock

public BlockContract setBlock(StatementBlock newBlock)

Specified by:

setBlock in interface BlockContract

setTarget

public BlockContract setTarget(KeYJavaType newKJT,
                               IObserverFunction newPM)

Specified by:

setTarget in interface BlockContract

getOrigVars

public Contract.OriginalVariables getOrigVars()

Specified by:

getOrigVars in interface BlockContract

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createReplacementMap

private Map<ProgramVariable,ProgramVariable> createReplacementMap(BlockContract.Variables newVariables,
                                                                  Services services)

createReplacementMap

private Map<Term,Term> createReplacementMap(Term newHeap,
                                            BlockContract.Terms newTerms,
                                            Services services)

hasMby

public boolean hasMby()

Description copied from interface: BlockContract

Tells whether the contract contains a measured_by clause.

Specified by:

hasMby in interface BlockContract

hasInfFlowSpecs

public boolean hasInfFlowSpecs()

Specified by:

hasInfFlowSpecs in interface BlockContract

hasJoinProcedure

public boolean hasJoinProcedure()

Specified by:

hasJoinProcedure in interface BlockContract

Returns:

True iff a join procedure has been specified for this block contract.

setInstantiationSelf

public void setInstantiationSelf(Term selfInstantiation)

Specified by:

setInstantiationSelf in interface BlockContract

getInstantiationSelfTerm

public Term getInstantiationSelfTerm(TermServices services)

Description copied from interface: BlockContract

Returns the term internally used for self or a newly instantiated one. Use with care - it is likely that this is *not* the right "self" for you.

Specified by:

getInstantiationSelfTerm in interface BlockContract

getTarget

public IProgramMethod getTarget()

Description copied from interface: BlockContract

Returns the method in which the block is located.

Specified by:

getTarget in interface BlockContract