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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dataflow-shaded Show documentation

dataflow-shaded is a dataflow framework based on the javac compiler. It differs from the org.checkerframework:dataflow artifact in two ways. First, the packages in this artifact have been renamed to org.checkerframework.shaded.*. Second, unlike the dataflow artifact, this artifact contains the dependencies it requires.

There is a newer version: 3.42.0-eisop5

Show newest version

package org.checkerframework.dataflow.cfg.node;

import com.sun.source.tree.Tree;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.javacutil.BugInCF;
import org.checkerframework.javacutil.SystemUtil;

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

import javax.lang.model.type.TypeMirror;

/** A node for a switch expression. */
public class SwitchExpressionNode extends Node {

    /** The {@code SwitchExpressionTree} corresponding to this node. */
    private final Tree switchExpressionTree;

    /**
     * This is a variable created by dataflow to which each result expression of the switch
     * expression is assigned. Its value should be used for the value of the switch expression.
     */
    private final LocalVariableNode switchExpressionVar;

    /**
     * Creates a new SwitchExpressionNode.
     *
     * @param type the type of the node
     * @param switchExpressionTree the {@code SwitchExpressionTree} for this node
     * @param switchExpressionVar a variable created by dataflow to which each result expression of
     *     the switch expression is assigned. Its value should be used for the value of the switch
     *     expression
     */
    public SwitchExpressionNode(
            TypeMirror type, Tree switchExpressionTree, LocalVariableNode switchExpressionVar) {
        super(type);

        // TODO: use JCP to add version-specific behavior
        if (SystemUtil.jreVersion < 14
                || !switchExpressionTree.getKind().name().equals("SWITCH_EXPRESSION")) {
            throw new BugInCF(
                    "switchExpressionTree is not a SwitchExpressionTree found tree with kind %s"
                            + " instead.",
                    switchExpressionTree.getKind());
        }

        this.switchExpressionTree = switchExpressionTree;
        this.switchExpressionVar = switchExpressionVar;
    }

    @Override
    public Tree getTree() {
        return switchExpressionTree;
    }

    /**
     * This is a variable created by dataflow to which each result expression of the switch
     * expression is assigned. Its value should be used for the value of the switch expression.
     *
     * @return the variable for this switch expression
     */
    public LocalVariableNode getSwitchExpressionVar() {
        return switchExpressionVar;
    }

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

    @Override
    @SideEffectFree
    public Collection getOperands() {
        return Collections.singleton(switchExpressionVar);
    }

    @Override
    public String toString() {
        return "SwitchExpressionNode{"
                + "switchExpressionTree="
                + switchExpressionTree
                + ", switchExpressionVar="
                + switchExpressionVar
                + '}';
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (!(obj instanceof SwitchExpressionNode)) {
            return false;
        }
        SwitchExpressionNode other = (SwitchExpressionNode) obj;
        return getTree().equals(other.getTree())
                && getSwitchExpressionVar().equals(other.getSwitchExpressionVar());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getTree(), getSwitchExpressionVar());
    }
}