com.ibm.wala.ssa
Class SSAReturnInstruction

java.lang.Object
  extended by com.ibm.wala.ssa.SSAInstruction
      extended by com.ibm.wala.ssa.SSAReturnInstruction

public class SSAReturnInstruction
extends SSAInstruction

A return instruction.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.wala.ssa.SSAInstruction
SSAInstruction.IVisitor, SSAInstruction.Visitor
 
Constructor Summary
SSAReturnInstruction()
           
SSAReturnInstruction(int result, boolean isPrimitive)
           
 
Method Summary
 SSAInstruction copyForSSA(SSAInstructionFactory insts, int[] defs, int[] uses)
          This method is meant to be used during SSA conversion for an IR that is not in SSA form.
 int getNumberOfUses()
           
 int getResult()
           
 int getUse(int j)
           
 int hashCode()
           
 boolean isFallThrough()
           
 boolean returnsPrimitiveType()
           
 boolean returnsVoid()
           
 java.lang.String toString(SymbolTable table)
           
 void visit(SSAInstruction.IVisitor v)
          Apply an IVisitor to this instruction.
 
Methods inherited from class com.ibm.wala.ssa.SSAInstruction
equals, getDef, getDef, getExceptionTypes, getNumberOfDefs, getValueString, hasDef, isPEI, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SSAReturnInstruction

public SSAReturnInstruction(int result,
                            boolean isPrimitive)

SSAReturnInstruction

public SSAReturnInstruction()
Method Detail

copyForSSA

public SSAInstruction copyForSSA(SSAInstructionFactory insts,
                                 int[] defs,
                                 int[] uses)
Description copied from class: SSAInstruction
This method is meant to be used during SSA conversion for an IR that is not in SSA form. It creates a new SSAInstruction of the same type as the receiver, with a combination of the receiver's uses and defs and those from the method parameters. In particular, if the 'defs' parameter is null, then the new instruction has the same defs as the receiver. If 'defs' is not null, it must be an array with a size equal to the number of defs that the receiver instruction has. In this case, the new instruction has defs taken from the array. The uses of the new instruction work in the same way with the 'uses' parameter. Note that this only applies to CAst-based IR translation, since Java bytecode-based IR generation uses a different SSA construction mechanism. TODO: move this into the SSAInstructionFactory

Specified by:
copyForSSA in class SSAInstruction

toString

public java.lang.String toString(SymbolTable table)
Specified by:
toString in class SSAInstruction

visit

public void visit(SSAInstruction.IVisitor v)
Description copied from class: SSAInstruction
Apply an IVisitor to this instruction. We invoke the appropriate IVisitor method according to the type of this instruction.

Specified by:
visit in class SSAInstruction
Throws:
java.lang.IllegalArgumentException - if v is null
See Also:
SSAInstruction.visit(IVisitor)

getNumberOfUses

public int getNumberOfUses()
Overrides:
getNumberOfUses in class SSAInstruction
See Also:
SSAInstruction.getNumberOfUses()

getUse

public int getUse(int j)
Overrides:
getUse in class SSAInstruction
Returns:
value number representing the jth use in this instruction. -1 means TOP (i.e., the value doesn't matter)
See Also:
SSAInstruction.getUse(int)

returnsPrimitiveType

public boolean returnsPrimitiveType()
Returns:
true iff this return instruction returns a primitive value

getResult

public int getResult()

returnsVoid

public boolean returnsVoid()

hashCode

public int hashCode()
Specified by:
hashCode in class SSAInstruction

isFallThrough

public boolean isFallThrough()
Specified by:
isFallThrough in class SSAInstruction
Returns:
true iff this instruction may fall through to the next