Package com.pnfsoftware.jeb.core.units.code.android.ir

Interface IDImm

All Superinterfaces:
IDElement, IDExpression, IInstructionOperand
@Ser public interface IDImm extends IDExpression
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;
                 ^   ^^^^^^^  ^^^^

  • Method Details

    • duplicateWithDifferentType

      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

    • isZeroEquivalent

      boolean isZeroEquivalent()
      Deprecated.
      use isZero() instead
      Returns:
      true if this immediate is equivalent to zero

    • isZero

      boolean isZero()
      Determine whether this immediate has all its bits set to 0.

      Note: do not mix this up with a zero-value equality check. That works if the underlying value is to be interpreted as an 2-complement integer, but may not work if the imm is to be understood as an ieee754 float value, for example.

      Returns:
      true if all bits are 0

    • isOnes

      boolean isOnes()
      Determine whether this immediate has all its bits set to 1.

      Note: do not mix this up with a zero-value equality check. That works if the underlying value is to be interpreted as an 2-complement integer, but may not work if the imm is to be understood as an ieee754 float value, for example.

      Returns:
      true if all bits are 1

    • isString

      boolean isString()
      Determine whether this immediate is a pooled string.
      Returns:
      true if this immediate is a pooled string

    • getStringIndex

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

    • getStringValue

      String getStringValue(IDGlobalContext gctx)
      Resolve the pooled string constant to its effective value. This method will throw if this immediate is not a string constant.
      Parameters:
      gctx - global IR context used to resolve the string
      Returns:
      effective string value

    • getRawValue

      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.
      Returns:
      raw encoded value

    • getImmediateAsJavaObject

      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.
      Parameters:
      gctx - global IR context used to resolve pooled strings
      Returns:
      Java object representation

    • toUnsignedLong

      long toUnsignedLong() throws DexDecEvaluationException
      Evaluate this immediate as an unsigned long.

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

      Returns:
      unsigned long value
      Throws:
      DexDecEvaluationException - the type of this immediate does not permit its resolution to a long primitive

    • toLong

      long toLong() throws DexDecEvaluationException
      Evaluate this immediate as a signed long primitive.

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

      Returns:
      signed long value
      Throws:
      DexDecEvaluationException - if the value cannot be read as a long

    • toLong

      long toLong(boolean treatSregAsInt) throws DexDecEvaluationException
      Evaluate this immediate as a signed long primitive.

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

      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)
      Returns:
      signed long value
      Throws:
      DexDecEvaluationException - if the value cannot be read as a long

    • toFloat

      float toFloat() throws DexDecEvaluationException
      Evaluate this immediate as a single-precision float. The immediate must be of type float.
      Returns:
      float value
      Throws:
      DexDecEvaluationException - if the value cannot be read as a float

    • toDouble

      double toDouble() throws DexDecEvaluationException
      Evaluate this immediate as a double-precision float. The immediate must be of type float or double.
      Returns:
      double value
      Throws:
      DexDecEvaluationException - if the value cannot be read as a double

    • isRef

      boolean isRef()
      Determine whether this immediate is a reference.

      Note: pooled strings are not treated as references by this method.

      Returns:
      true if this immediate is a reference

    • isNullRef

      boolean isNullRef()
      Determine whether this immediate is a null reference. Beware: if the immediate is not typed as an object, this method will return false in all case.
      Returns:
      true if this immediate is a null reference

    • isNonNullRef

      boolean isNonNullRef()
      Determine whether this immediate is a non-null reference. Beware: if the immediate is not typed as an object, this method will return false in all case.
      Returns:
      true if this immediate is a non-null reference

    • maybeRef

      boolean maybeRef()
      Determine whether this immediate may be a reference.

      Note: pooled strings are not treated as references by this method.

      Returns:
      true if this immediate may be a reference

    • maybeNullRef

      boolean maybeNullRef()
      Determine whether this immediate may be a reference that is the null reference.
      Returns:
      true if this immediate may be a null reference

    • maybeNonNullRef

      boolean maybeNonNullRef()
      Determine whether this immediate may be a reference that is not the null reference.
      Returns:
      true if this immediate may be a non-null reference

    • getObjectReferenceId

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

    • duplicate

      IDImm duplicate()
      Description copied from interface: IDElement
      Duplicate this element.
      Specified by:
      duplicate in interface IDElement
      Specified by:
      duplicate in interface IDExpression
      Returns:
      a deep copy of this element; the type of the duplicated element should be the same as this element's type

    • canReadAsLong

      boolean canReadAsLong()
      Determine whether this immediate can be read as a long value.
      Returns:
      true if this immediate can be read as a long value

    • getValueAsLong

      long getValueAsLong()
      Read this immediate as a long value.
      Returns:
      long value

    • _add

      IDImm _add(IDImm o)
      Perform an integer addition.
      Parameters:
      o - addend
      Returns:
      the resulting immediate

    • _sub

      IDImm _sub(IDImm o)
      Perform an integer subtraction.
      Parameters:
      o - subtrahend
      Returns:
      the resulting immediate

    • _mul

      IDImm _mul(IDImm o)
      Perform an integer multiplication.
      Parameters:
      o - multiplier
      Returns:
      the resulting immediate

    • _div

      IDImm _div(IDImm o)
      Perform an integer division.
      Parameters:
      o - divisor
      Returns:
      the resulting immediate

    • _rem

      IDImm _rem(IDImm o)
      Perform an integer modulo operation.
      Parameters:
      o - divisor
      Returns:
      the resulting immediate

    • _neg

      IDImm _neg()
      Perform an integer negation.
      Returns:
      the resulting immediate

    • _not

      IDImm _not()
      Perform a bitwise not operation.
      Returns:
      the resulting immediate

    • _and

      IDImm _and(IDImm o)
      Perform a bitwise and operation.
      Parameters:
      o - other immediate
      Returns:
      the resulting immediate

    • _or

      IDImm _or(IDImm o)
      Perform a bitwise or operation.
      Parameters:
      o - other immediate
      Returns:
      the resulting immediate

    • _xor

      IDImm _xor(IDImm o)
      Perform a bitwise xor operation.
      Parameters:
      o - other immediate
      Returns:
      the resulting immediate

    • _testbit

      boolean _testbit(int pos)
      Test if a given bit is set.
      Parameters:
      pos - bit position
      Returns:
      true if set, false if unset

    • _shl

      IDImm _shl(int cnt)
      Perform a left-shift operation. The effective count is computed modulo-positive 32 or 64, depending on the type of this integer.
      Parameters:
      cnt - shift count
      Returns:
      the resulting immediate

    • _shr

      IDImm _shr(int cnt)
      Perform a regular right-shift operation. The effective count is computed modulo-positive 32 or 64, depending on the type of this integer.
      Parameters:
      cnt - shift count
      Returns:
      the resulting immediate

    • _sar

      IDImm _sar(int cnt)
      Perform an arithmetic right-shift operation (sign bit is maintained). The effective count is computed modulo-positive 32 or 64, depending on the type of this integer.
      Parameters:
      cnt - shift count
      Returns:
      the resulting immediate

    • _pow

      IDImm _pow(int exponent)
      Perform an exponentiation.
      Parameters:
      exponent - must be positive or zero
      Returns:
      the resulting immediate

    • _cmp

      int _cmp(IDImm o)
      Perform a signed operand comparison.
      Parameters:
      o - other immediate
      Returns:
      0, 1, or -1

    • _cmpU

      int _cmpU(IDImm o)
      Perform an unsigned operand comparison.
      Parameters:
      o - other immediate
      Returns:
      0, 1, or -1

    • _isPowerOf2

      boolean _isPowerOf2()
      Determine whether this immediate (treated as an unsigned integer) is a power of 2.
      Returns:
      true if this immediate is a power of 2

    • _log2

      Integer _log2()
      Perform an exact log2 on this immediate treated as an unsigned integer. If the immediate is not a power of 2, a null value is returned.
      Returns:
      a non-null log2 of this immediate