root/org.axdt.as3/src/org/axdt/as3/imp/builders/AS3Builder.java @ 69d1ca8cf4ab8b63f93d4467f3d504c0ffdfabb7

package org.axdt.as3.imp.builders;

import java.util.HashMap;

import org.axdt.as3.AS3Plugin;
import org.axdt.as3.imp.parser.AS3ParseController;
import org.axdt.as3.preferences.AS3Preferences;
import org.axdt.as3.util.AS3Util;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.content.IContentDescription;
import org.eclipse.imp.builder.BuilderBase;
import org.eclipse.imp.builder.BuilderUtils;
import org.eclipse.imp.builder.MarkerCreator;
import org.eclipse.imp.language.Language;
import org.eclipse.imp.language.LanguageRegistry;
import org.eclipse.imp.model.ISourceProject;
import org.eclipse.imp.model.ModelFactory;
import org.eclipse.imp.model.ModelFactory.ModelException;
import org.eclipse.imp.runtime.PluginBase;
import org.eclipse.jface.preference.IPreferenceStore;

/**
 * A builder may be activated on a file containin AS3 code every time it has
 * changed (when "Build automatically" is on), or when the programmer chooses to
 * "Build" a project.
 */
public class AS3Builder extends BuilderBase {

        public static final String BUILDER_ID = AS3Plugin.PLUGIN_ID + ".imp.builder";
        public static final String PROBLEM_MARKER_ID = AS3Plugin.PLUGIN_ID + ".imp.builder.problem";
        public static final Language LANGUAGE = LanguageRegistry.findLanguage(AS3Plugin.LANGUAGE);
        private HashMap<IPath, AS3ParseController> files;

        public AS3Builder() {
                super();
                files = new HashMap<IPath, AS3ParseController>();
        }

        protected PluginBase getPlugin() {
                return AS3Plugin.getDefault();
        }

        protected String getErrorMarkerID() {
                return PROBLEM_MARKER_ID;
        }

        protected String getWarningMarkerID() {
                return PROBLEM_MARKER_ID;
        }

        protected String getInfoMarkerID() {
                return PROBLEM_MARKER_ID;
        }

        /**
         * Decide whether a file needs to be build using this builder. Note that
         * <code>isNonRootSourceFile()</code> and <code>isSourceFile()</code>
         * should never return true for the same file.
         * 
         * @return true if an arbitrary file is a AS3 source file.
         */
        protected boolean isSourceFile(IFile file) {
                IPath path = file.getRawLocation();
                if (path == null) return false;
                IContainer sourceFolder = AS3Util.getSourceFolder(file);

                if (sourceFolder == null) return false;

                return LANGUAGE.hasExtension(path.getFileExtension());
        }

        /**
         * Decide whether or not to scan a file for dependencies. Note:
         * <code>isNonRootSourceFile()</code> and <code>isSourceFile()</code>
         * should never return true for the same file.
         * 
         * @return true if the given file is a source file that this builder should
         *         scan for dependencies, but not compile as a top-level compilation
         *         unit.
         */
        protected boolean isNonRootSourceFile(IFile resource) {
                return false;
        }

        /**
         * Collects compilation-unit dependencies for the given file, and records
         * them via calls to <code>fDependency.addDependency()</code>.
         */
        protected void collectDependencies(IFile file) {
                // TODO: implement dependency collector
                // fDependencyInfo.addDependency(fromPath, uponPath);
        }

        /**
         * @return true if this resource identifies the output folder
         */
        protected boolean isOutputFolder(IResource resource) {
                IPreferenceStore store = AS3Preferences.getInstance().getProjectStore(resource);
                String deployPart = store.getString(AS3Preferences.DEPLOY_PATH);
                IPath fullPath = resource.getFullPath();
                return fullPath.toPortableString().endsWith(deployPart);
        }

        /**
         * Compile one AS3 file.
         * It will not actually compile, but analyze and index the model.
         */
        protected void compile(final IFile file, IProgressMonitor monitor) {
                try {
                        
                        AS3ParseController parse = getParseController(file);

                        MarkerCreator marker = new MarkerCreator(file, parse, PROBLEM_MARKER_ID);
                        parse.getAnnotationTypeInfo().addProblemMarkerType(getErrorMarkerID());

                        ISourceProject sourceProject = ModelFactory.open(file.getProject());
                        IPath path = file.getProjectRelativePath();
                        parse.initialize(path, sourceProject, marker);
                        boolean hasBom = false;
                        try {
                                IContentDescription info = file.getContentDescription();
                                hasBom = info != null && null != info.getProperty(IContentDescription.BYTE_ORDER_MARK);   
                        } catch (Exception e) { /* ignore */}
                        String contents = BuilderUtils.getFileContents(file);
                        if (hasBom) {
                                // file info says there is a bom
                                if (contents.charAt(0)==0xfeff) {
                                        // first char is misread utf8 char
                                        contents = contents.substring(1);
                                }
                        }
                        parse.parse(contents, true, monitor);

                } catch (ModelException e) {
                        getPlugin().logException(
                                        "Example builder returns without parsing due to a ModelException", e);
                }
        }

        private AS3ParseController getParseController(IFile file) {
                IPath path = file.getFullPath();
                AS3ParseController controller = files.get(path);
                if (controller == null) {
                        controller = new AS3ParseController();
                        files.put(path, controller);
                } else {
                        AS3Plugin.getDefault().debug("reusing builder parse controller for "+ path);
                }
                return controller;
        }
}