org.checkerframework.dataflow.analysis.ForwardTransferFunction 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.analysis;

import org.checkerframework.dataflow.cfg.UnderlyingAST;
import org.checkerframework.dataflow.cfg.node.LocalVariableNode;

import java.util.List;

/**
 * Interface of a forward transfer function for the abstract interpretation used for the forward
 * flow analysis.
 *
 * Important: The individual transfer functions ( {@code visit*}) are allowed to use
 * (and modify) the stores contained in the argument passed; the ownership is transferred from the
 * caller to that function.
 *
 * @param  the abstract value type to be tracked by the analysis
 * @param  the store type used in the analysis
 */
public interface ForwardTransferFunction, S extends Store>
        extends TransferFunction {

    /**
     * Returns the initial store to be used by the org.checkerframework.dataflow analysis.
     *
     * @param underlyingAST an abstract syntax tree
     * @param parameters a list of local variable nodes representing formal parameters (if any)
     * @return the initial store
     */
    S initialStore(UnderlyingAST underlyingAST, List parameters);
}