pascal.taie.analysis.pta.plugin.util.CSObjs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tai-e Show documentation
An easy-to-learn/use static analysis framework for Java
The newest version!
/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan 
 * Copyright (C) 2022 Yue Li 
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e is distributed in the hope that it will be useful,but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see .
 */

package pascal.taie.analysis.pta.plugin.util;

import pascal.taie.World;
import pascal.taie.analysis.pta.core.cs.element.CSObj;
import pascal.taie.analysis.pta.core.heap.Descriptor;
import pascal.taie.analysis.pta.core.heap.MockObj;
import pascal.taie.ir.exp.ClassLiteral;
import pascal.taie.ir.exp.MethodHandle;
import pascal.taie.ir.exp.MethodType;
import pascal.taie.ir.exp.StringLiteral;
import pascal.taie.language.annotation.Annotation;
import pascal.taie.language.classes.ClassNames;
import pascal.taie.language.classes.JClass;
import pascal.taie.language.classes.JField;
import pascal.taie.language.classes.JMethod;
import pascal.taie.language.type.ArrayType;
import pascal.taie.language.type.ClassType;
import pascal.taie.language.type.Type;

import javax.annotation.Nullable;

/**
 * Static utility methods for {@link CSObjs}.
 */
public final class CSObjs {

    private CSObjs() {
    }

    /**
     * @return {@code true} if {@code csObj} is {@link MockObj} and it has
     * descriptor {@code desc}.
     */
    public static boolean hasDescriptor(CSObj csObj, Descriptor desc) {
        return csObj.getObject() instanceof MockObj mockObj &&
                mockObj.getDescriptor().equals(desc);
    }

    /**
     * Converts a CSObj of string constant to corresponding String.
     * If the object is not a string constant, then return null.
     */
    @Nullable
    public static String toString(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return alloc instanceof StringLiteral str ? str.getString() : null;
    }

    /**
     * Converts a CSObj of class to corresponding JClass. If the object is
     * not a class constant, then return null.
     */
    @Nullable
    public static JClass toClass(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        if (alloc instanceof ClassLiteral cls) {
            Type type = cls.getTypeValue();
            if (type instanceof ClassType clsType) {
                return clsType.getJClass();
            } else if (type instanceof ArrayType) {
                return World.get().getClassHierarchy()
                        .getJREClass(ClassNames.OBJECT);
            }
        }
        return null;
    }

    /**
     * Converts a CSObj of java.lang.reflect.Constructor to corresponding JMethod.
     * If the object does not represent a Constructor, then return null.
     */
    @Nullable
    public static JMethod toConstructor(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return (alloc instanceof JMethod m && m.isConstructor()) ? m : null;
    }

    /**
     * Converts a CSObj of java.lang.reflect.Method to corresponding JMethod.
     * If the object does not represent a Method, then return null.
     */
    @Nullable
    public static JMethod toMethod(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return (alloc instanceof JMethod m && !m.isConstructor()) ? m : null;
    }

    /**
     * Converts a CSObj of java.lang.reflect.Method to corresponding JMethod.
     * If the object does not represent a Method, then return null.
     */
    @Nullable
    public static JField toField(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return alloc instanceof JField field ? field : null;
    }

    /**
     * Converts a CSObj of class to corresponding type. If the object is
     * not a class constant, then return null.
     */
    @Nullable
    public static Type toType(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return alloc instanceof ClassLiteral cls ? cls.getTypeValue() : null;
    }

    /**
     * Converts a CSObj of MethodType to corresponding MethodType.
     * If the object is not a MethodType, then return null.
     */
    @Nullable
    public static MethodType toMethodType(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return alloc instanceof MethodType mt ? mt : null;
    }

    /**
     * Converts a CSObj of MethodHandle constant to corresponding MethodHandle.
     * If the object is not a MethodHandle constant, then return null.
     */
    @Nullable
    public static MethodHandle toMethodHandle(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return alloc instanceof MethodHandle mh ? mh : null;
    }

    /**
     * Converts a CSObj of an Annotation to the Annotation.
     * If the object is not an Annotation object, then return null.
     */
    public static Annotation toAnnotation(CSObj csObj) {
        Object alloc = csObj.getObject().getAllocation();
        return alloc instanceof Annotation a ? a : null;
    }

    /**
     * @return {@code true} if given csObj is an array object.
     */
    public static boolean isArray(CSObj csObj) {
        return csObj.getObject().getType() instanceof ArrayType;
    }
}