Package proguard.evaluation

Class ReferenceTracingValueFactory

java.lang.Object

proguard.evaluation.ReferenceTracingValueFactory

All Implemented Interfaces:

InstructionVisitor, ValueFactory

public class ReferenceTracingValueFactory
extends Object
implements InstructionVisitor, ValueFactory

This ValueFactory tags newly created reference values so they can be traced throughout the execution of a method.

See Also:

• TracedReferenceValue
• InstructionOffsetValue

Constructor Summary

Constructors

Constructor	Description
ReferenceTracingValueFactory(ValueFactory valueFactory)	Creates a new ReferenceTracingValueFactory that attaches instruction offset values based on being used as an instruction visitor.
ReferenceTracingValueFactory(ValueFactory valueFactory, boolean preserveTraceValueOnCasts)	Creates a new ReferenceTracingValueFactory that attaches instruction offset values based on being used as an instruction visitor.

Method Summary

Modifier and Type	Method	Description
TracedReferenceValue	cast(TracedReferenceValue referenceValue, String type, Clazz referencedClass, boolean alwaysCast)	Casts a given traced reference value to the given type, either keeping its trace value or setting a new one.
ReferenceValue	createArrayReferenceValue(String type, Clazz referencedClass, IntegerValue arrayLength)	Creates a new ReferenceValue that represents a non-null array with elements of the given type, with the given length.
ReferenceValue	createArrayReferenceValue(String type, Clazz referencedClass, IntegerValue arrayLength, Object elementValues)	Creates a new ReferenceValue that represents an array with elements of the given type, with the given length and initial element values.
DoubleValue	createDoubleValue()	Creates a new DoubleValue with an undefined value.
DoubleValue	createDoubleValue(double value)	Creates a new DoubleValue with a given particular value.
FloatValue	createFloatValue()	Creates a new FloatValue with an undefined value.
FloatValue	createFloatValue(float value)	Creates a new FloatValue with a given particular value.
IntegerValue	createIntegerValue()	Creates a new IntegerValue with an undefined value.
IntegerValue	createIntegerValue(int value)	Creates a new IntegerValue with a given particular value.
IntegerValue	createIntegerValue(int min, int max)	Creates a new IntegerValue with a given possible range.
LongValue	createLongValue()	Creates a new LongValue with an undefined value.
LongValue	createLongValue(long value)	Creates a new LongValue with a given particular value.
ReferenceValue	createReferenceValue()	Creates a new ReferenceValue of an undefined type.
ReferenceValue	createReferenceValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull)	Creates a new ReferenceValue that represents the given type.
ReferenceValue	createReferenceValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, Object value)	Deprecated.
ReferenceValue	createReferenceValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, CodeLocation creationLocation)	Creates a new ReferenceValue that represents the given type, created at the specified code location.
ReferenceValue	createReferenceValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, Clazz creationClass, Method creationMethod, int creationOffset)	Deprecated.
ReferenceValue	createReferenceValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, Clazz creationClass, Method creationMethod, int creationOffset, Object value)	Deprecated.
ReferenceValue	createReferenceValue(Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, @NotNull AnalyzedObject value)	Creates a new ReferenceValue that represents the given type.
ReferenceValue	createReferenceValue(Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, CodeLocation creationLocation, @NotNull AnalyzedObject value)	Creates a new ReferenceValue that represents the given type, created at the specified code location.
ReferenceValue	createReferenceValueForId(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, Object id)	Creates a new ReferenceValue that represents the given type with a specified ID.
ReferenceValue	createReferenceValueForId(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, Object id, Object value)	Deprecated.
ReferenceValue	createReferenceValueForId(Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull, Object id, @NotNull AnalyzedObject value)	Creates a new ReferenceValue that represents the given type with a specified ID.
ReferenceValue	createReferenceValueNull()	Creates a new ReferenceValue that represents null.
Value	createValue(String type, Clazz referencedClass, boolean mayBeExtension, boolean mayBeNull)	Creates a new Value of the given type.
void	setTraceValue(Value traceValue)
ReferenceValue	trace(ReferenceValue referenceValue)	Attaches the current trace value to given reference value.
Value	trace(Value value)	Attaches the current trace value to given value, if it is a reference value.
void	visitAnyInstruction(Clazz clazz, Method method, CodeAttribute codeAttribute, int offset, Instruction instruction)	Visits any Instruction instance.
void	visitConstantInstruction(Clazz clazz, Method method, CodeAttribute codeAttribute, int offset, ConstantInstruction constantInstruction)
void	visitSimpleInstruction(Clazz clazz, Method method, CodeAttribute codeAttribute, int offset, SimpleInstruction simpleInstruction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface proguard.classfile.instruction.visitor.InstructionVisitor

visitAnySwitchInstruction, visitBranchInstruction, visitLookUpSwitchInstruction, visitTableSwitchInstruction, visitVariableInstruction

Methods inherited from interface proguard.evaluation.value.ValueFactory

createReferenceValue, createReferenceValue, createReferenceValue

Constructor Details

ReferenceTracingValueFactory

public ReferenceTracingValueFactory(ValueFactory valueFactory)

Creates a new ReferenceTracingValueFactory that attaches instruction offset values based on being used as an instruction visitor. This instance preserves trace values in the cast(proguard.evaluation.value.TracedReferenceValue, java.lang.String, proguard.classfile.Clazz, boolean) method.

Parameters:

valueFactory - the value factory that creates the actual values.

ReferenceTracingValueFactory

public ReferenceTracingValueFactory(ValueFactory valueFactory,
 boolean preserveTraceValueOnCasts)

Creates a new ReferenceTracingValueFactory that attaches instruction offset values based on being used as an instruction visitor.

Parameters:

valueFactory - the value factory that creates the actual values.

preserveTraceValueOnCasts - specifies whether to preserve the trace value for reference values that are passed to the cast(proguard.evaluation.value.TracedReferenceValue, java.lang.String, proguard.classfile.Clazz, boolean) method.

Method Details

setTraceValue

public void setTraceValue(Value traceValue)

cast

public TracedReferenceValue cast(TracedReferenceValue referenceValue,
 String type,
 Clazz referencedClass,
 boolean alwaysCast)

Casts a given traced reference value to the given type, either keeping its trace value or setting a new one.

visitAnyInstruction

public void visitAnyInstruction(Clazz clazz,
 Method method,
 CodeAttribute codeAttribute,
 int offset,
 Instruction instruction)

Description copied from interface: InstructionVisitor

Visits any Instruction instance. The more specific default implementations of this interface delegate to this method.

Specified by:

visitAnyInstruction in interface InstructionVisitor

visitSimpleInstruction

public void visitSimpleInstruction(Clazz clazz,
 Method method,
 CodeAttribute codeAttribute,
 int offset,
 SimpleInstruction simpleInstruction)

Specified by:

visitSimpleInstruction in interface InstructionVisitor

visitConstantInstruction

public void visitConstantInstruction(Clazz clazz,
 Method method,
 CodeAttribute codeAttribute,
 int offset,
 ConstantInstruction constantInstruction)

Specified by:

visitConstantInstruction in interface InstructionVisitor

createValue

public Value createValue(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull)

Description copied from interface: ValueFactory

Creates a new Value of the given type. The type must be a fully specified internal type for primitives, classes, or arrays.

Specified by:

createValue in interface ValueFactory

createIntegerValue

public IntegerValue createIntegerValue()

Description copied from interface: ValueFactory

Creates a new IntegerValue with an undefined value.

Specified by:

createIntegerValue in interface ValueFactory

createIntegerValue

public IntegerValue createIntegerValue(int value)

Description copied from interface: ValueFactory

Creates a new IntegerValue with a given particular value.

Specified by:

createIntegerValue in interface ValueFactory

createIntegerValue

public IntegerValue createIntegerValue(int min,
 int max)

Description copied from interface: ValueFactory

Creates a new IntegerValue with a given possible range.

Specified by:

createIntegerValue in interface ValueFactory

createLongValue

public LongValue createLongValue()

Description copied from interface: ValueFactory

Creates a new LongValue with an undefined value.

Specified by:

createLongValue in interface ValueFactory

createLongValue

public LongValue createLongValue(long value)

Description copied from interface: ValueFactory

Creates a new LongValue with a given particular value.

Specified by:

createLongValue in interface ValueFactory

createFloatValue

public FloatValue createFloatValue()

Description copied from interface: ValueFactory

Creates a new FloatValue with an undefined value.

Specified by:

createFloatValue in interface ValueFactory

createFloatValue

public FloatValue createFloatValue(float value)

Description copied from interface: ValueFactory

Creates a new FloatValue with a given particular value.

Specified by:

createFloatValue in interface ValueFactory

createDoubleValue

public DoubleValue createDoubleValue()

Description copied from interface: ValueFactory

Creates a new DoubleValue with an undefined value.

Specified by:

createDoubleValue in interface ValueFactory

createDoubleValue

public DoubleValue createDoubleValue(double value)

Description copied from interface: ValueFactory

Creates a new DoubleValue with a given particular value.

Specified by:

createDoubleValue in interface ValueFactory

createReferenceValue

public ReferenceValue createReferenceValue()

Description copied from interface: ValueFactory

Creates a new ReferenceValue of an undefined type.

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValueNull

public ReferenceValue createReferenceValueNull()

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents null.

Specified by:

createReferenceValueNull in interface ValueFactory

createReferenceValue

public ReferenceValue createReferenceValue(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents the given type. The type must be an internal class name or an array type. If the type is null, the ReferenceValue represents null.

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValue

@Deprecated
public ReferenceValue createReferenceValue(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 Object value)

Deprecated.

Deprecated, use createReferenceValue(Clazz, boolean, boolean, AnalyzedObject).

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValue

public ReferenceValue createReferenceValue(Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 @NotNull
 @NotNull AnalyzedObject value)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents the given type. The type must be an internal class name or an array type. If the type is null, the ReferenceValue represents null.

The object wrapped by AnalyzedObject is either the value of the reference during execution or a Model of it.

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValue

@Deprecated
public ReferenceValue createReferenceValue(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 Clazz creationClass,
 Method creationMethod,
 int creationOffset)

Deprecated.

Deprecated, use createReferenceValue(String, Clazz, boolean, boolean, CodeLocation)

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValue

public ReferenceValue createReferenceValue(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 CodeLocation creationLocation)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents the given type, created at the specified code location. The type must be an internal class name or an array type. If the type is null , the ReferenceValue represents null.

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValue

@Deprecated
public ReferenceValue createReferenceValue(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 Clazz creationClass,
 Method creationMethod,
 int creationOffset,
 Object value)

Deprecated.

Deprecated, use createReferenceValue(Clazz, boolean, boolean, CodeLocation, AnalyzedObject)

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValue

public ReferenceValue createReferenceValue(Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 CodeLocation creationLocation,
 @NotNull
 @NotNull AnalyzedObject value)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents the given type, created at the specified code location. The type must be an internal class name or an array type. If the type is null , the ReferenceValue represents null.

The object wrapped by AnalyzedObject is either the value of the reference during execution or a Model of it.

Specified by:

createReferenceValue in interface ValueFactory

createReferenceValueForId

public ReferenceValue createReferenceValueForId(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 Object id)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents the given type with a specified ID. The type must be an internal class name or an array type. If the type is null, the ReferenceValue represents null.

Specified by:

createReferenceValueForId in interface ValueFactory

createReferenceValueForId

@Deprecated
public ReferenceValue createReferenceValueForId(String type,
 Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 Object id,
 Object value)

Deprecated.

Deprecated, use createReferenceValueForId(Clazz, boolean, boolean, Object, AnalyzedObject).

Specified by:

createReferenceValueForId in interface ValueFactory

createReferenceValueForId

public ReferenceValue createReferenceValueForId(Clazz referencedClass,
 boolean mayBeExtension,
 boolean mayBeNull,
 Object id,
 @NotNull
 @NotNull AnalyzedObject value)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents the given type with a specified ID. The type must be an internal class name or an array type. If the type is null, the ReferenceValue represents null.

The object wrapped by AnalyzedObject is either the value of the reference during execution or a Model of it.

Specified by:

createReferenceValueForId in interface ValueFactory

createArrayReferenceValue

public ReferenceValue createArrayReferenceValue(String type,
 Clazz referencedClass,
 IntegerValue arrayLength)

Description copied from interface: ValueFactory

Creates a new ReferenceValue that represents a non-null array with elements of the given type, with the given length.

Specified by:

createArrayReferenceValue in interface ValueFactory

createArrayReferenceValue

public ReferenceValue createArrayReferenceValue(String type,
 Clazz referencedClass,
 IntegerValue arrayLength,
 Object elementValues)

Creates a new ReferenceValue that represents an array with elements of the given type, with the given length and initial element values.

Specified by:

createArrayReferenceValue in interface ValueFactory

trace

public Value trace(Value value)

Attaches the current trace value to given value, if it is a reference value.

trace

public ReferenceValue trace(ReferenceValue referenceValue)

Attaches the current trace value to given reference value.