Class IRBuildHelper

src/main/java/pascal/taie/ir/IRBuildHelper.java:42–157

Helper for building IR for a method from scratch. Given a JMethod, this helper automatically creates this variable (for instance method), parameters, and return variable (if method return type is not void) for the method.

 * return type is not {@code void}) for the method.
 */
public class IRBuildHelper {

    private static final String THIS = "%this";

    private static final String PARAM = "%param";

    private static final String TEMP = "%temp";

    private static final String RETURN = "%return";

    private final JMethod method;

    private final Var thisVar;

    private final List<Var> params;

    private final Var returnVar;

    private final Set<Var> returnVars;

    private final List<Var> vars;

    /**
     * Counter for indexing all variables.
     */
    private int varCounter = 0;

    /**
     * Counter for naming temporary variables.
     */
    private int tempCounter = 0;

    public IRBuildHelper(JMethod method) {
        this.method = method;
        // build this variable
        vars = new ArrayList<>();
        thisVar = method.isStatic() ? null :
                newVar(THIS, method.getDeclaringClass().getType());
        // build parameters
        params = new ArrayList<>(method.getParamCount());
        for (int i = 0; i < method.getParamCount(); ++i) {
            params.add(newVar(PARAM + i, method.getParamType(i)));
        }
        // build return variable
        Type retType = method.getReturnType();
        if (!retType.equals(VoidType.VOID)) {
            returnVar = newVar(RETURN, retType);
            returnVars = Set.of(returnVar);
        } else {
            returnVar = null;
            returnVars = Set.of();
        }
    }

    /**
     * @return {@code this} variable of the IR being built.
     * @throws AssertionError if the method is not an instance method.
     */