DexBody (Soot - a J*va Optimization Framework 4.2.1 API)

java.lang.Object
- soot.dexpler.DexBody

```
public class DexBody
extends Object
```
A DexBody contains the code of a DexMethod and is used as a wrapper around JimpleBody in the jimplification process.

Author:

Michael Markert, Frank Hartmann

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class DexBody.RegDbgEntry
An entry of debug information for a register from the dex file.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`DexBody.RegDbgEntry` An entry of debug information for a register from the dex file.

Field Summary

Fields
Modifier and Type	Field and Description
`protected DanglingInstruction`	`dangling`
`protected RefType`	`declaringClassType`
`protected List<DeferableInstruction>`	`deferredInstructions`
`protected org.jf.dexlib2.iface.MultiDexContainer.DexEntry<? extends org.jf.dexlib2.iface.DexFile>`	`dexEntry`
`protected Map<Integer,DexlibAbstractInstruction>`	`instructionAtAddress`
`protected List<DexlibAbstractInstruction>`	`instructions`
`protected Set<RetypeableInstruction>`	`instructionsToRetype`
`protected boolean`	`isStatic`
`protected JimpleBody`	`jBody`
`protected org.jf.dexlib2.iface.Method`	`method`
`protected int`	`numParameterRegisters`
`protected int`	`numRegisters`
`protected List<String>`	`parameterNames`
`protected List<Type>`	`parameterTypes`
`protected List<PseudoInstruction>`	`pseudoInstructionData`
`protected Local[]`	`registerLocals`
`protected Local`	`storeResultLocal`
`protected Set<String>`	`takenLocalNames`
`protected List<? extends org.jf.dexlib2.iface.TryBlock<? extends org.jf.dexlib2.iface.ExceptionHandler>>`	`tries`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DexBody(org.jf.dexlib2.iface.MultiDexContainer.DexEntry<? extends org.jf.dexlib2.iface.DexFile> dexFile, org.jf.dexlib2.iface.Method method, RefType declaringClassType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Unit u)` Add unit to this body.
`void`	`addDeferredJimplification(DeferableInstruction i)` Add a deferred instruction to this body.
`void`	`addRetype(RetypeableInstruction i)` Add a retypeable instruction to this body.
`protected void`	`extractDexInstructions(org.jf.dexlib2.iface.MethodImplementation code)` Extracts the list of dalvik instructions from dexlib and converts them into our own instruction data model
`protected void`	`fixLineNumbers()` Fixes the line numbers.
`protected String`	`freshLocalName(String hint)` Allocate a fresh name for Jimple local
`Body`	`getBody()` Return the associated JimpleBody.
`protected CopyPropagator`	`getCopyPopagator()`
`protected LocalSplitter`	`getLocalSplitter()`
`Local`	`getRegisterLocal(int num)` Return the Local that are associated with the number in the current register state.
`Local[]`	`getRegisterLocals()` Return the Locals that are associated with the current register state.
`Local`	`getStoreResultLocal()`
`protected UnreachableCodeEliminator`	`getUnreachableCodeEliminator()`
`DexlibAbstractInstruction`	`instructionAtAddress(int address)` Return the instruction that is present at the byte code address.
`List<DexlibAbstractInstruction>`	`instructionsAfter(DexlibAbstractInstruction instruction)` Return the instructions that appear (lexically) after the given instruction.
`List<DexlibAbstractInstruction>`	`instructionsBefore(DexlibAbstractInstruction instruction)` Return the instructions that appear (lexically) before the given instruction.
`Body`	`jimplify(Body b, SootMethod m)` Return the jimple equivalent of this body.
`void`	`setDanglingInstruction(DanglingInstruction i)` Set a dangling instruction for this body.
`Set<Type>`	`usedTypes()` Return the types that are used in this body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - instructions
```
protected List<DexlibAbstractInstruction> instructions
```
  - registerLocals
```
protected Local[] registerLocals
```
  - storeResultLocal
```
protected Local storeResultLocal
```
  - instructionAtAddress
```
protected Map<Integer,DexlibAbstractInstruction> instructionAtAddress
```
  - deferredInstructions
```
protected List<DeferableInstruction> deferredInstructions
```
  - instructionsToRetype
```
protected Set<RetypeableInstruction> instructionsToRetype
```
  - dangling
```
protected DanglingInstruction dangling
```
  - numRegisters
```
protected int numRegisters
```
  - numParameterRegisters
```
protected int numParameterRegisters
```
  - parameterTypes
```
protected final List<Type> parameterTypes
```
  - parameterNames
```
protected final List<String> parameterNames
```
  - isStatic
```
protected boolean isStatic
```
  - jBody
```
protected JimpleBody jBody
```
  - tries
```
protected List<? extends org.jf.dexlib2.iface.TryBlock<? extends org.jf.dexlib2.iface.ExceptionHandler>> tries
```
  - declaringClassType
```
protected RefType declaringClassType
```
  - dexEntry
```
protected final org.jf.dexlib2.iface.MultiDexContainer.DexEntry<? extends org.jf.dexlib2.iface.DexFile> dexEntry
```
  - method
```
protected final org.jf.dexlib2.iface.Method method
```
  - pseudoInstructionData
```
protected List<PseudoInstruction> pseudoInstructionData
```
  - takenLocalNames
```
protected Set<String> takenLocalNames
```
- Constructor Detail
  - DexBody
```
protected DexBody(org.jf.dexlib2.iface.MultiDexContainer.DexEntry<? extends org.jf.dexlib2.iface.DexFile> dexFile,
                  org.jf.dexlib2.iface.Method method,
                  RefType declaringClassType)
```
    Parameters:
    
    code - the codeitem that is contained in this body
    
    method - the method that is associated with this body
- Method Detail
  - freshLocalName
```
protected String freshLocalName(String hint)
```
    Allocate a fresh name for Jimple local
    
    Parameters:
    
    hint - A name that the fresh name will look like
  - extractDexInstructions
```
protected void extractDexInstructions(org.jf.dexlib2.iface.MethodImplementation code)
```
    Extracts the list of dalvik instructions from dexlib and converts them into our own instruction data model
    
    Parameters:
    
    code - The dexlib method implementation
  - usedTypes
```
public Set<Type> usedTypes()
```
    Return the types that are used in this body.
  - add
```
public void add(Unit u)
```
    Add unit to this body.
    
    Parameters:
    
    u - Unit to add.
  - addDeferredJimplification
```
public void addDeferredJimplification(DeferableInstruction i)
```
    Add a deferred instruction to this body.
    
    Parameters:
    
    i - the deferred instruction.
  - addRetype
```
public void addRetype(RetypeableInstruction i)
```
    Add a retypeable instruction to this body.
    
    Parameters:
    
    i - the retypeable instruction.
  - getBody
```
public Body getBody()
```
    Return the associated JimpleBody.
    
    Throws:
    
    RuntimeException - if no jimplification happened yet.
  - getRegisterLocals
```
public Local[] getRegisterLocals()
```
    Return the Locals that are associated with the current register state.
  - getRegisterLocal
```
public Local getRegisterLocal(int num)
                       throws InvalidDalvikBytecodeException
```
    Return the Local that are associated with the number in the current register state.
    Handles if the register number actually points to a method parameter.
    
    Parameters:
    
    num - the register number
    
    Throws:
    
    InvalidDalvikBytecodeException
  - getStoreResultLocal
```
public Local getStoreResultLocal()
```
  - instructionAtAddress
```
public DexlibAbstractInstruction instructionAtAddress(int address)
```
    Return the instruction that is present at the byte code address.
    
    Parameters:
    
    address - the byte code address.
    
    Throws:
    
    RuntimeException - if address is not part of this body.
  - jimplify
```
public Body jimplify(Body b,
                     SootMethod m)
```
    Return the jimple equivalent of this body.
    
    Parameters:
    
    m - the SootMethod that contains this body
  - fixLineNumbers
```
protected void fixLineNumbers()
```
    Fixes the line numbers. If there is a unit without a line number, it gets the line number of the last (transitive) predecessor that has a line number.
  - getLocalSplitter
```
protected LocalSplitter getLocalSplitter()
```
  - getUnreachableCodeEliminator
```
protected UnreachableCodeEliminator getUnreachableCodeEliminator()
```
  - getCopyPopagator
```
protected CopyPropagator getCopyPopagator()
```
  - setDanglingInstruction
```
public void setDanglingInstruction(DanglingInstruction i)
```
    Set a dangling instruction for this body.
  - instructionsAfter
```
public List<DexlibAbstractInstruction> instructionsAfter(DexlibAbstractInstruction instruction)
```
    Return the instructions that appear (lexically) after the given instruction.
    
    Parameters:
    
    instruction - the instruction which successors will be returned.
  - instructionsBefore
```
public List<DexlibAbstractInstruction> instructionsBefore(DexlibAbstractInstruction instruction)
```
    Return the instructions that appear (lexically) before the given instruction.
    The instruction immediately before the given is the first instruction and so on.
    
    Parameters:
    
    instruction - the instruction which successors will be returned.

Class DexBody

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

instructions

registerLocals

storeResultLocal

instructionAtAddress

deferredInstructions

instructionsToRetype

dangling

numRegisters

numParameterRegisters

parameterTypes

parameterNames

isStatic

jBody

tries

declaringClassType

dexEntry

method

pseudoInstructionData

takenLocalNames

Constructor Detail

DexBody

Method Detail

freshLocalName

extractDexInstructions

usedTypes

add

addDeferredJimplification

addRetype

getBody

getRegisterLocals

getRegisterLocal

getStoreResultLocal

instructionAtAddress

jimplify

fixLineNumbers

getLocalSplitter

getUnreachableCodeEliminator

getCopyPopagator

setDanglingInstruction

instructionsAfter

instructionsBefore