public interface

IDImm

implements IDExpression
com.pnfsoftware.jeb.core.units.code.android.ir.IDImm

Class Overview

This dual-purpose dexdec IR element serves to encode immediate values (primitives and pooled strings) and evaluated values (primitives and objects).

They can be:
- primitives
- null objects
- pooled java.lang.String objects
- references to live objects (including arrays) living in an IR state

Examples:

 String s = a == 1 ? "hello": null;
                 ^   ^^^^^^^  ^^^^
 

Summary

[Expand]
Inherited Constants
From interface com.pnfsoftware.jeb.core.units.code.android.ir.IDElement
Public Methods
abstract IDImm duplicateWithDifferentType(IJavaType type)
Duplicate this immediate and assign it a different type.
abstract Object getImmediateAsJavaObject(IDGlobalContext gctx)
Resolve this primitive or pooled string immediate to a Java object: either the effective String value if it is a string, or one of boxed primitive object type if it is a primitive.
abstract int getObjectReferenceId()
Get the reference object id.
abstract long getRawValue()
Retrieve the raw value encoded by this immediate.
abstract int getStringIndex()
Retrieve the pool index of a pooled string immediate.
abstract String getStringValue(IDGlobalContext gctx)
Resolve the pooled string constant to its effective value.
abstract boolean isNonNullRef()
Determine whether this immediate is considered a reference and is not the null reference.
abstract boolean isNullRef()
Determine whether this immediate is considered a reference and is the null reference.
abstract boolean isRef()
Determine whether this immediate is a reference.
abstract boolean isString()
Determine whether this immediate is a pooled string.
abstract boolean isZeroEquivalent()
Determine whether the immediate encodes zero (e.g.
abstract double toDouble()
Evaluate this immediate as a double-precision float.
abstract float toFloat()
Evaluate this immediate as a single-precision float.
abstract long toLong()
Evaluate this immediate as a signed long primitive.
abstract long toLong(boolean treatSregAsInt)
Evaluate this immediate as a signed long primitive.
abstract long toUnsignedLong()
Evaluate this immediate as an unsigned long.
[Expand]
Inherited Methods
From interface com.pnfsoftware.jeb.core.units.code.IInstructionOperand
From interface com.pnfsoftware.jeb.core.units.code.android.ir.IDElement
From interface com.pnfsoftware.jeb.core.units.code.android.ir.IDExpression

Public Methods

public abstract IDImm duplicateWithDifferentType (IJavaType type)

Duplicate this immediate and assign it a different type.

Parameters
type type of the duplicated immediate; note for String constants: although type update is allowed, it must be a type implementing java.lang.CharSequence
Returns
  • the duplicated immediate

public abstract Object getImmediateAsJavaObject (IDGlobalContext gctx)

Resolve this primitive or pooled string immediate to a Java object: either the effective String value if it is a string, or one of boxed primitive object type if it is a primitive.

public abstract int getObjectReferenceId ()

Get the reference object id. The value returned by this method is moot unless isRef() is true.

public abstract long getRawValue ()

Retrieve the raw value encoded by this immediate. All values (primitives, pool indices, object references) can fit on a long; hence this method's return type.

public abstract int getStringIndex ()

Retrieve the pool index of a pooled string immediate. This method will fail unless isString() is true.

public abstract String getStringValue (IDGlobalContext gctx)

Resolve the pooled string constant to its effective value.

public abstract boolean isNonNullRef ()

Determine whether this immediate is considered a reference and is not the null reference.

public abstract boolean isNullRef ()

Determine whether this immediate is considered a reference and is the null reference.

public abstract boolean isRef ()

Determine whether this immediate is a reference. IMPORTANT NOTE: pooled strings are not treated as references by this method; they are always treated as immediates.

public abstract boolean isString ()

Determine whether this immediate is a pooled string.

public abstract boolean isZeroEquivalent ()

Determine whether the immediate encodes zero (e.g. integer/float:0, boolean:false, ref:null)

public abstract double toDouble ()

Evaluate this immediate as a double-precision float. The immediate must be of type float or double.@return

public abstract float toFloat ()

Evaluate this immediate as a single-precision float. The immediate must be of type float.@return

public abstract long toLong ()

Evaluate this immediate as a signed long primitive.

Note: if this constant is an object reference, the reference id is returned.@return

public abstract long toLong (boolean treatSregAsInt)

Evaluate this immediate as a signed long primitive.

Note: if this constant is an object reference, the reference id is returned.@return

Parameters
treatSregAsInt if true, and if this object is typed as a single-slot wildcard, it is treated as a signed immediate (and sign-extension is applied)

public abstract long toUnsignedLong ()

Evaluate this immediate as an unsigned long.

Note: if this constant is an object reference, the reference id is returned.@return

Throws
DexDecEvaluationException the type of this immediate does not permit its resolution to a long primitive