com.cloudbees.groovy.cps.TransformerConfiguration Maven / Gradle / Ivy

Go to download
package com.cloudbees.groovy.cps;

import com.cloudbees.groovy.cps.impl.CpsClosure;
import groovy.lang.Closure;
import org.codehaus.groovy.ast.ClassNode;

import java.util.ArrayList;
import java.util.List;

/**
 * Switches that affect the behaviour of {@link CpsTransformer}
 *
 * @author Kohsuke Kawaguchi
 * @see CpsTransformer#setConfiguration(TransformerConfiguration)
 */
public class TransformerConfiguration {
    private ClassNode closureType = new ClassNode(CpsClosure.class);
    private List safepoints = new ArrayList();

    public ClassNode getClosureType() {
        return closureType;
    }

    /*package*/ List getSafepoints() {
        return safepoints;
    }

    public TransformerConfiguration withClosureType(ClassNode closureType) {
        this.closureType = closureType;
        return this;
    }

    public TransformerConfiguration withClosureType(Class c) {
        return withClosureType(new ClassNode(c));
    }

    /**
     * Inserts a safepoint into transformed program.
     *
     * 
     * At every loop head and at the entry of a function, CPS-transformed program
     * will call the specified no-arg static public method that returns void.
     * This is useful to pause the execution of un-cooperative CPS transformed programs.
     *
     * 
     * A safepoint method can run some computation and return normally to keep the
     * CPS interpreter going, or it can {@linkplain Continuable#suspend(Object) suspend}
     * the execution of a program.
     */
    public TransformerConfiguration withSafepoint(Class clazz, String methodName) {
        safepoints.add(new Safepoint(clazz,methodName));
        return this;
    }
}