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 checker Show documentation

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0-eisop4

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);
}