All Downloads are FREE. Search and download functionalities are using the official Maven repository.

proguard.evaluation.value.ReferenceValue Maven / Gradle / Ivy

Go to download

ProGuardCORE is a free library to read, analyze, modify, and write Java class files.

There is a newer version: 9.1.6
Show newest version
/*
 * ProGuardCORE -- library to process Java bytecode.
 *
 * Copyright (c) 2002-2020 Guardsquare NV
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package proguard.evaluation.value;

import proguard.classfile.Clazz;

/**
 * Representation of a partially evaluated reference value.
 *
 * @author Eric Lafortune
 */
public abstract class ReferenceValue extends Category1Value
{
    // Basic unary methods.

    /**
     * Returns the value.
     */
    public Object value()
    {
        return null;
    }

    /**
     * Returns the type.
     */
    public abstract String getType();


    /**
     * Returns the class that is referenced by the type.
     */
    public abstract Clazz getReferencedClass();


    /**
     * Returns whether the actual type of this ReferenceValue may be an
     * extension of its type.
     */
    public abstract boolean mayBeExtension();


    /**
     * Returns whether this ReferenceValue is null.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public abstract int isNull();


    /**
     * Returns whether the type is an instance of the given type.
     */
    public abstract int instanceOf(String otherType, Clazz otherReferencedClass);


    /**
     * Returns this ReferenceValue, cast to the given type.
     */
    public abstract ReferenceValue cast(String type, Clazz referencedClass, ValueFactory valueFactory, boolean alwaysCast);


    /**
     * Returns the length of the array, assuming this type is an array.
     */
    public IntegerValue arrayLength(ValueFactory valueFactory)
    {
        return valueFactory.createIntegerValue();
    }


    /**
     * Returns the value of the array at the given index, assuming this type
     * is an integer array.
     */
    public IntegerValue integerArrayLoad(IntegerValue indexValue, ValueFactory valueFactory)
    {
        return valueFactory.createIntegerValue();
    }


    /**
     * Returns the value of the array at the given index, assuming this type
     * is an long array.
     */
    public LongValue longArrayLoad(IntegerValue indexValue, ValueFactory valueFactory)
    {
        return valueFactory.createLongValue();
    }


    /**
     * Returns the value of the array at the given index, assuming this type
     * is an float array.
     */
    public FloatValue floatArrayLoad(IntegerValue indexValue, ValueFactory valueFactory)
    {
        return valueFactory.createFloatValue();
    }


    /**
     * Returns the value of the array at the given index, assuming this type
     * is an double array.
     */
    public DoubleValue doubleArrayLoad(IntegerValue indexValue, ValueFactory valueFactory)
    {
        return valueFactory.createDoubleValue();
    }


    /**
     * Returns the value of the array at the given index, assuming this type
     * is a reference array.
     */
    public ReferenceValue referenceArrayLoad(IntegerValue indexValue, ValueFactory valueFactory)
    {
        return valueFactory.createReferenceValue();
    }


    /**
     * Stores the given value at the given index in the given array, assuming
     * this type is an array.
     */
    public void arrayStore(IntegerValue indexValue, Value value)
    {
    }


    // Basic binary methods.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * ReferenceValue.
     */
    public abstract ReferenceValue generalize(ReferenceValue other);


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * ReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public abstract int equal(ReferenceValue other);


    // Derived unary methods.

    /**
     * Returns whether this ReferenceValue is not null.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public final int isNotNull()
    {
        return -isNull();
    }


    // Derived binary methods.

    /**
     * Returns whether this ReferenceValue and the given ReferenceValue are different.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public final int notEqual(ReferenceValue other)
    {
        return -equal(other);
    }


    // Similar binary methods, but this time with unknown arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * UnknownReferenceValue.
     */
    public ReferenceValue generalize(UnknownReferenceValue other)
    {
        return other;
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * UnknownReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(UnknownReferenceValue other)
    {
        return MAYBE;
    }


    // Similar binary methods, but this time with typed reference arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * TypedReferenceValue.
     */
    public ReferenceValue generalize(TypedReferenceValue other)
    {
        return generalize((ReferenceValue)other);
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * TypedReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(TypedReferenceValue other)
    {
        return equal((ReferenceValue)other);
    }

    // Similar binary methods, but this time with reference arguments that can have multiple possible types.
    /**
     * Returns the generalization of this {@link ReferenceValue} and the given other
     * {@link MultiTypedReferenceValue}.
     */
    public ReferenceValue generalize(MultiTypedReferenceValue other)
    {
        return generalize((ReferenceValue) other);
    }

    /**
     * Returns whether this {@link ReferenceValue} is equal to the given other
     * {@link MultiTypedReferenceValue}.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(MultiTypedReferenceValue other)
    {
        return equal((ReferenceValue) other);
    }


    // Similar binary methods, but this time with identified reference
    // arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * IdentifiedReferenceValue.
     */
    public ReferenceValue generalize(IdentifiedReferenceValue other)
    {
        return generalize((TypedReferenceValue)other);
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * IdentifiedReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(IdentifiedReferenceValue other)
    {
        return equal((TypedReferenceValue)other);
    }


    // Similar binary methods, but this time with array reference arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * ArrayReferenceValue.
     */
    public ReferenceValue generalize(ArrayReferenceValue other)
    {
        return generalize((TypedReferenceValue)other);
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * ArrayReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(ArrayReferenceValue other)
    {
        return equal((TypedReferenceValue)other);
    }


    // Similar binary methods, but this time with identified array reference
    // arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * IdentifiedArrayReferenceValue.
     */
    public ReferenceValue generalize(IdentifiedArrayReferenceValue other)
    {
        return generalize((ArrayReferenceValue)other);
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * IdentifiedArrayReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(IdentifiedArrayReferenceValue other)
    {
        return equal((ArrayReferenceValue)other);
    }


    // Similar binary methods, but this time with detailed array reference
    // arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * DetailedArrayReferenceValue.
     */
    public ReferenceValue generalize(DetailedArrayReferenceValue other)
    {
        return generalize((IdentifiedArrayReferenceValue)other);
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * DetailedArrayReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(DetailedArrayReferenceValue other)
    {
        return equal((IdentifiedArrayReferenceValue)other);
    }


    // Similar binary methods, but this time with traced arguments.

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * TracedReferenceValue.
     */
    public ReferenceValue generalize(TracedReferenceValue other)
    {
        return generalize((ReferenceValue)other);
    }


    /**
     * Returns whether this ReferenceValue is equal to the given other
     * TracedReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(TracedReferenceValue other)
    {
        return equal((ReferenceValue)other);
    }

    /**
     * Returns the generalization of this ReferenceValue and the given other
     * ParticularReferenceValue.
     */
    public ReferenceValue generalize(ParticularReferenceValue other)
    {
        return generalize((ReferenceValue) other);
    }

    /**
     * Returns whether this ReferenceValue is equal to the given other
     * ParticularReferenceValue.
     * @return NEVER, MAYBE, or ALWAYS.
     */
    public int equal(ParticularReferenceValue other)
    {
        return equal((ReferenceValue)other);
    }

    // Implementations for Value.

    public final ReferenceValue referenceValue()
    {
        return this;
    }

    public final Value generalize(Value other)
    {
        return this.generalize(other.referenceValue());
    }

    public final int computationalType()
    {
        return TYPE_REFERENCE;
    }


    // Implementations for Object.

    public boolean equals(Object object)
    {
        return object != null &&
               this.getClass() == object.getClass();
    }


    public int hashCode()
    {
        return this.getClass().hashCode();
    }


    public String toString()
    {
        return "a";
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy