Package it.unive.lisa.program.cfg.statement

Class Ret

java.lang.Object

it.unive.lisa.program.cfg.statement.Statement

it.unive.lisa.program.cfg.statement.Ret

All Implemented Interfaces:

ProgramPoint, CodeElement, CodeNode<CFG,Statement,Edge>, Node<CFG,Statement,Edge>, java.lang.Comparable<Statement>

public class Ret
extends Statement

Terminates the execution of the CFG where this statement lies, without returning anything to the caller. For terminating CFGs that must return a value, use Return.

Constructor Summary

Constructors

Constructor	Description
Ret(CFG cfg, CodeLocation location)	Builds the return, happening at the given location in the program.

Method Summary

Modifier and Type	Method	Description
<V> boolean	accept(GraphVisitor<CFG,Statement,Edge,V> visitor, V tool)	Accepts the given GraphVisitor.
protected int	compareSameClass(Statement o)	Auxiliary method for Statement.compareTo(Statement) that can safely assume that the two statements happen at the same CodeLocation and are instances of the same class.
boolean	equals(java.lang.Object obj)
<A extends AbstractState<A>> AnalysisState<A>	forwardSemantics(AnalysisState<A> entryState, InterproceduralAnalysis<A> interprocedural, StatementStore<A> expressions)	Computes the forward semantics of the statement, expressing how semantic information is transformed by the execution of this statement.
int	hashCode()
boolean	stopsExecution()	Whether or not this statement stops the execution of the containing cfg, either by throwing an error or returning a value.
java.lang.String	toString()

Methods inherited from class it.unive.lisa.program.cfg.statement.Statement

backwardSemantics, compareTo, getCFG, getEvaluationPredecessor, getEvaluationSuccessor, getLocation, getStatementEvaluatedAfter, getStatementEvaluatedBefore, throwsError

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unive.lisa.program.cfg.ProgramPoint

getProgram

Constructor Detail

Ret

public Ret(CFG cfg,
           CodeLocation location)

Builds the return, happening at the given location in the program.

Parameters:

cfg - the cfg that this statement belongs to

location - the location where the statement is defined within the program

Method Detail

stopsExecution

public boolean stopsExecution()

Description copied from class: Statement

Whether or not this statement stops the execution of the containing cfg, either by throwing an error or returning a value. To distinguish error-raising halting statements and normal ones, use Statement.throwsError().

Overrides:

stopsExecution in class Statement

Returns:

true only if that condition holds

hashCode

public int hashCode()

Overrides:

hashCode in class Statement

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Statement

compareSameClass

protected int compareSameClass(Statement o)

Description copied from class: Statement

Auxiliary method for Statement.compareTo(Statement) that can safely assume that the two statements happen at the same CodeLocation and are instances of the same class.

Specified by:

compareSameClass in class Statement

Parameters:

o - the other statement

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object

toString

public final java.lang.String toString()

Specified by:

toString in class Statement

forwardSemantics

public <A extends AbstractState<A>> AnalysisState<A> forwardSemantics(AnalysisState<A> entryState,
                                                                      InterproceduralAnalysis<A> interprocedural,
                                                                      StatementStore<A> expressions)
                                                               throws SemanticException

Description copied from class: Statement

Computes the forward semantics of the statement, expressing how semantic information is transformed by the execution of this statement. This method is also responsible for recursively invoking the Statement.forwardSemantics(AnalysisState, InterproceduralAnalysis, StatementStore) of each nested Expression, saving the result of each call in expressions.

Specified by:

forwardSemantics in class Statement

Type Parameters:

A - the type of AbstractState

Parameters:

entryState - the entry state that represents the abstract values of each program variable and memory location when the execution reaches this statement

interprocedural - the interprocedural analysis of the program to analyze

expressions - the cache where analysis states of intermediate expressions must be stored

Returns:

the AnalysisState representing the abstract result of the execution of this statement

Throws:

SemanticException - if something goes wrong during the computation

accept

public <V> boolean accept(GraphVisitor<CFG,Statement,Edge,V> visitor,
                          V tool)

Description copied from interface: Node

Accepts the given GraphVisitor. Implementors of this method are responsible for invoking GraphVisitor.visit(Object, Graph, Node) on this node after Node.accept(GraphVisitor, Object) has been invoked on all nested nodes, if any. The visiting should stop at the first of such calls that return false.

Type Parameters:

V - the type of auxiliary tool that visitor can use

Parameters:

visitor - the visitor that is visiting the Graph containing this node

tool - the auxiliary tool that visitor can use

Returns:

whether or not the visiting should stop when this call returns, as decided by the visitor itself