TreeLifecycleListener.java

package com.redhat.ceylon.eclipse.code.parse;

import org.eclipse.core.runtime.IProgressMonitor;

/**
 * A language service that needs to be notified in order to 
 * update in response to source code changes.
 * 
 * @author Claffra
 * @author rfuhrer@watson.ibm.com
 */
public interface TreeLifecycleListener  {

    public enum Stage { NONE, LEXICAL_ANALYSIS, SYNTACTIC_ANALYSIS, FOR_OUTLINE, TYPE_ANALYSIS }

    /**
     * @return The stage at which the listener should be
     *         notified
     */
    public Stage getStage();
    
    /**
     * Notify the listener that the document has been updated 
     * and a new AST has been computed
     * 
     * @param parseController the parse controller that, among 
     *        other things, provides the most recent AST
     * @param monitor the progress monitor; listener should 
     *        cancel when monitor.isCanceled() is true
     */
    public void update(CeylonParseController parseController, 
            IProgressMonitor monitor);
    
}