Package com.tonic.analysis.ssa.ir

Class ReturnInstruction

java.lang.Object

com.tonic.analysis.ssa.ir.IRInstruction

com.tonic.analysis.ssa.ir.ReturnInstruction

public class ReturnInstruction
extends IRInstruction

A method return, with or without a value.

Constructor Summary

Constructors

Constructor	Description
ReturnInstruction()	Creates a void return.
ReturnInstruction(Value returnValue)	Creates a value return and registers a use of an SSA return value.

Method Summary

Modifier and Type	Method	Description
<T> T	accept(IRVisitor<T> visitor)	Accepts a visitor for this instruction.
IRInstruction	copyWithNewOperands(SSAValue newResult, List<Value> newOperands)	Creates a copy of this instruction with new result and operands.
List<Value>	getOperands()	Gets the operands used by this instruction.
Value	getReturnValue()
boolean	isTerminator()	Checks if this instruction terminates a basic block.
boolean	isVoidReturn()	Checks if this is a void return.
void	replaceOperand(Value oldValue, Value newValue)	Replaces an operand value with a new value.
String	toString()

Methods inherited from class com.tonic.analysis.ssa.ir.IRInstruction

equals, getBlock, getBytecodeOffset, getId, getResult, getResultType, hashCode, hasResult, isPhi, replaceTarget, resetIdCounter, setBlock, setBytecodeOffset, setResult

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReturnInstruction

public ReturnInstruction()

Creates a void return.

ReturnInstruction

public ReturnInstruction(Value returnValue)

Creates a value return and registers a use of an SSA return value.

Parameters:

returnValue - the value to return

Method Detail

getReturnValue

public Value getReturnValue()

Returns:

the return value

isVoidReturn

public boolean isVoidReturn()

Checks if this is a void return.

Returns:

true if returning void

getOperands

public List<Value> getOperands()

Description copied from class: IRInstruction

Gets the operands used by this instruction.

Specified by:

getOperands in class IRInstruction

Returns:

list of operand values

replaceOperand

public void replaceOperand(Value oldValue,
                           Value newValue)

Description copied from class: IRInstruction

Replaces an operand value with a new value.

Specified by:

replaceOperand in class IRInstruction

Parameters:

oldValue - the value to replace

newValue - the replacement value

accept

public <T> T accept(IRVisitor<T> visitor)

Description copied from class: IRInstruction

Accepts a visitor for this instruction.

Specified by:

accept in class IRInstruction

Type Parameters:

T - the return type

Parameters:

visitor - the visitor to accept

Returns:

the visitor result

isTerminator

public boolean isTerminator()

Description copied from class: IRInstruction

Checks if this instruction terminates a basic block.

Overrides:

isTerminator in class IRInstruction

Returns:

true if this is a terminator instruction

copyWithNewOperands

public IRInstruction copyWithNewOperands(SSAValue newResult,
                                         List<Value> newOperands)

Description copied from class: IRInstruction

Creates a copy of this instruction with new result and operands.

Overrides:

copyWithNewOperands in class IRInstruction

Parameters:

newResult - the new result value (may be null)

newOperands - the new operand values

Returns:

a copy of this instruction, or null if copying not supported

toString

public String toString()

Overrides:

toString in class Object