org.checkerframework.dataflow.cfg.node.InstanceOfNode Maven / Gradle / Ivy

Go to download
package org.checkerframework.dataflow.cfg.node;

import com.sun.source.tree.InstanceOfTree;

import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.javacutil.TypesUtils;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.Types;

/**
 * A node for the instanceof operator:
 *
 * x instanceof Point
 */
public class InstanceOfNode extends Node {

    /** The value being tested. */
    protected final Node operand;

    /** The reference type being tested against. */
    protected final TypeMirror refType;

    /** The tree associated with this node. */
    protected final InstanceOfTree tree;

    /** The node of the pattern if one exists. */
    protected final @Nullable Node patternNode;

    /** For Types.isSameType. */
    protected final Types types;

    /**
     * Create an InstanceOfNode.
     *
     * @param tree instanceof tree
     * @param operand the expression in the instanceof tree
     * @param refType the type in the instanceof
     * @param types types util
     */
    public InstanceOfNode(InstanceOfTree tree, Node operand, TypeMirror refType, Types types) {
        this(tree, operand, null, refType, types);
    }

    /**
     * Create an InstanceOfNode.
     *
     * @param tree instanceof tree
     * @param operand the expression in the instanceof tree
     * @param patternNode the pattern node or null if there is none
     * @param refType the type in the instanceof
     * @param types types util
     */
    public InstanceOfNode(
            InstanceOfTree tree,
            Node operand,
            @Nullable Node patternNode,
            TypeMirror refType,
            Types types) {
        super(types.getPrimitiveType(TypeKind.BOOLEAN));
        this.tree = tree;
        this.operand = operand;
        this.refType = refType;
        this.types = types;
        this.patternNode = patternNode;
    }

    public Node getOperand() {
        return operand;
    }

    /**
     * Returns the binding variable for this instanceof, or null if one does not exist.
     *
     * @return the binding variable for this instanceof, or null if one does not exist
     * @deprecated Use {@link #getPatternNode()} or {@link #getBindingVariables()} instead.
     */
    @Deprecated // 2023-09-24
    public @Nullable LocalVariableNode getBindingVariable() {
        if (patternNode instanceof LocalVariableNode) {
            return (LocalVariableNode) patternNode;
        }
        return null;
    }

    /**
     * A list of all binding variables in this instanceof. This is lazily initialized, use {@link
     * #getBindingVariables()}.
     */
    protected @MonotonicNonNull List bindingVariables = null;

    /**
     * Return all the binding variables in this instanceof.
     *
     * @return all the binding variables in this instanceof
     */
    public List getBindingVariables() {
        if (bindingVariables == null) {
            if (patternNode instanceof DeconstructorPatternNode) {
                bindingVariables = ((DeconstructorPatternNode) patternNode).getBindingVariables();
            } else if (patternNode instanceof LocalVariableNode) {
                bindingVariables = Collections.singletonList((LocalVariableNode) patternNode);
            } else {
                bindingVariables = Collections.emptyList();
            }
        }
        return bindingVariables;
    }

    /**
     * Returns the pattern for this instanceof, or null if one does not exist.
     *
     * @return the pattern for this instanceof, or null if one does not exist
     */
    public @Nullable Node getPatternNode() {
        return patternNode;
    }

    /**
     * The reference type being tested against.
     *
     * @return the reference type
     */
    public TypeMirror getRefType() {
        return refType;
    }

    @Override
    public InstanceOfTree getTree() {
        return tree;
    }

    @Override
    public  R accept(NodeVisitor visitor, P p) {
        return visitor.visitInstanceOf(this, p);
    }

    @Override
    public String toString() {
        return "("
                + getOperand()
                + " instanceof "
                + TypesUtils.simpleTypeName(getRefType())
                + (patternNode == null ? "" : " " + getPatternNode())
                + ")";
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (!(obj instanceof InstanceOfNode)) {
            return false;
        }
        InstanceOfNode other = (InstanceOfNode) obj;
        // TODO: TypeMirror.equals may be too restrictive.
        // Check whether Types.isSameType is the better comparison.
        return getOperand().equals(other.getOperand())
                && types.isSameType(getRefType(), other.getRefType());
    }

    @Override
    public int hashCode() {
        return Objects.hash(InstanceOfNode.class, getOperand());
    }

    @Override
    @SideEffectFree
    public Collection getOperands() {
        return Collections.singletonList(getOperand());
    }
}