/*
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.flex.compiler.clients;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import org.apache.commons.io.FilenameUtils;
import org.apache.flex.compiler.clients.problems.ProblemPrinter;
import org.apache.flex.compiler.clients.problems.ProblemQuery;
import org.apache.flex.compiler.clients.problems.ProblemQueryProvider;
import org.apache.flex.compiler.clients.problems.WorkspaceProblemFormatter;
import org.apache.flex.compiler.codegen.js.IJSPublisher;
import org.apache.flex.compiler.codegen.js.IJSWriter;
import org.apache.flex.compiler.config.Configuration;
import org.apache.flex.compiler.config.ConfigurationBuffer;
import org.apache.flex.compiler.config.Configurator;
import org.apache.flex.compiler.config.ICompilerSettingsConstants;
import org.apache.flex.compiler.driver.IBackend;
import org.apache.flex.compiler.driver.js.IJSApplication;
import org.apache.flex.compiler.exceptions.ConfigurationException;
import org.apache.flex.compiler.exceptions.ConfigurationException.IOError;
import org.apache.flex.compiler.exceptions.ConfigurationException.MustSpecifyTarget;
import org.apache.flex.compiler.exceptions.ConfigurationException.OnlyOneSource;
import org.apache.flex.compiler.internal.config.FlashBuilderConfigurator;
import org.apache.flex.compiler.internal.driver.as.ASBackend;
import org.apache.flex.compiler.internal.driver.js.amd.AMDBackend;
import org.apache.flex.compiler.internal.driver.js.goog.GoogBackend;
import org.apache.flex.compiler.internal.driver.js.goog.JSGoogConfiguration;
import org.apache.flex.compiler.internal.driver.js.jsc.JSCBackend;
import org.apache.flex.compiler.internal.driver.js.node.NodeBackend;
import org.apache.flex.compiler.internal.driver.mxml.flexjs.MXMLFlexJSBackend;
import org.apache.flex.compiler.internal.parsing.as.FlexJSASDocDelegate;
import org.apache.flex.compiler.internal.projects.CompilerProject;
import org.apache.flex.compiler.internal.projects.FlexJSProject;
import org.apache.flex.compiler.internal.projects.ISourceFileHandler;
import org.apache.flex.compiler.internal.targets.FlexJSTarget;
import org.apache.flex.compiler.internal.targets.JSTarget;
import org.apache.flex.compiler.internal.units.ResourceModuleCompilationUnit;
import org.apache.flex.compiler.internal.units.SourceCompilationUnitFactory;
import org.apache.flex.compiler.internal.workspaces.Workspace;
import org.apache.flex.compiler.problems.ConfigurationProblem;
import org.apache.flex.compiler.problems.ICompilerProblem;
import org.apache.flex.compiler.problems.InternalCompilerProblem;
import org.apache.flex.compiler.problems.UnableToBuildSWFProblem;
import org.apache.flex.compiler.problems.UnexpectedExceptionProblem;
import org.apache.flex.compiler.projects.ICompilerProject;
import org.apache.flex.compiler.targets.ITarget;
import org.apache.flex.compiler.targets.ITarget.TargetType;
import org.apache.flex.compiler.targets.ITargetSettings;
import org.apache.flex.compiler.units.ICompilationUnit;
import org.apache.flex.tools.FlexTool;
import org.apache.flex.utils.ArgumentUtil;
import org.apache.flex.utils.FilenameNormalization;
import com.google.common.base.Preconditions;
import com.google.common.collect.Iterables;
/**
* @author Erik de Bruin
* @author Michael Schmalle
*/
public class MXMLJSC implements JSCompilerEntryPoint, ProblemQueryProvider,
FlexTool
{
@Override
public ProblemQuery getProblemQuery()
{
return problems;
}
/*
* JS output type enumerations.
*/
public enum JSOutputType
{
AMD("amd"),
FLEXJS("flexjs"),
GOOG("goog"),
FLEXJS_DUAL("flexjs_dual"),
FLEXJS_DITA("flexjs_dita"),
JSC("jsc"),
NODE("node");
private String text;
JSOutputType(String text)
{
this.text = text;
}
public String getText()
{
return this.text;
}
public static JSOutputType fromString(String text)
{
for (JSOutputType jsOutputType : JSOutputType.values())
{
if (text.equalsIgnoreCase(jsOutputType.text))
return jsOutputType;
}
return GOOG;
}
}
/*
* Exit code enumerations.
*/
static enum ExitCode
{
SUCCESS(0),
PRINT_HELP(1),
FAILED_WITH_PROBLEMS(2),
FAILED_WITH_ERRORS(3),
FAILED_WITH_EXCEPTIONS(4),
FAILED_WITH_CONFIG_PROBLEMS(5);
ExitCode(int code)
{
this.code = code;
}
final int code;
}
public static JSOutputType jsOutputType;
@Override
public String getName()
{
return FLEX_TOOL_MXMLC;
}
@Override
public int execute(String[] args)
{
final List<ICompilerProblem> problems = new ArrayList<ICompilerProblem>();
return mainNoExit(args, problems, true);
}
/**
* Java program entry point.
*
* @param args command line arguments
*/
public static void main(final String[] args)
{
int exitCode = staticMainNoExit(args);
System.exit(exitCode);
}
/**
* Entry point for the {@code <compc>} Ant task.
*
* @param args Command line arguments.
* @return An exit code.
*/
public static int staticMainNoExit(final String[] args)
{
long startTime = System.nanoTime();
IBackend backend = new ASBackend();
String jsOutputTypeString = "";
for (String s : args)
{
String[] kvp = s.split("=");
if (s.contains("-js-output-type"))
{
jsOutputTypeString = kvp[1];
}
}
if (jsOutputTypeString.equals(""))
{
jsOutputTypeString = JSOutputType.FLEXJS.getText();
}
jsOutputType = JSOutputType.fromString(jsOutputTypeString);
switch (jsOutputType)
{
case AMD:
backend = new AMDBackend();
break;
case JSC:
backend = new JSCBackend();
break;
case NODE:
backend = new NodeBackend();
break;
case FLEXJS:
case FLEXJS_DUAL:
backend = new MXMLFlexJSBackend();
break;
case GOOG:
backend = new GoogBackend();
break;
// if you add a new js-output-type here, don't forget to also add it
// to flex2.tools.MxmlJSC in flex-compiler-oem for IDE support
}
final MXMLJSC mxmlc = new MXMLJSC(backend);
final List<ICompilerProblem> problems = new ArrayList<ICompilerProblem>();
final int exitCode = mxmlc.mainNoExit(args, problems, true);
long endTime = System.nanoTime();
System.out.println((endTime - startTime) / 1e9 + " seconds");
return exitCode;
}
protected Workspace workspace;
protected FlexJSProject project;
protected ProblemQuery problems;
protected ISourceFileHandler asFileHandler;
protected Configuration config;
protected Configurator projectConfigurator;
private ConfigurationBuffer configBuffer;
private ICompilationUnit mainCU;
protected ITarget target;
protected ITargetSettings targetSettings;
protected IJSApplication jsTarget;
private IJSPublisher jsPublisher;
public MXMLJSC(IBackend backend)
{
workspace = new Workspace();
workspace.setASDocDelegate(new FlexJSASDocDelegate());
project = new FlexJSProject(workspace, backend);
problems = new ProblemQuery(); // this gets replaced in configure(). Do we need it here?
asFileHandler = backend.getSourceFileHandlerInstance();
}
@Override
public int mainNoExit(final String[] args, List<ICompilerProblem> problems,
Boolean printProblems)
{
int exitCode = -1;
try
{
exitCode = _mainNoExit(ArgumentUtil.fixArgs(args), problems);
}
catch (Exception e)
{
System.err.println(e.toString());
}
finally
{
if (problems != null && !problems.isEmpty())
{
if (printProblems)
{
final WorkspaceProblemFormatter formatter = new WorkspaceProblemFormatter(
workspace);
final ProblemPrinter printer = new ProblemPrinter(formatter);
printer.printProblems(problems);
}
}
}
return exitCode;
}
/**
* Entry point that doesn't call <code>System.exit()</code>. This is for
* unit testing.
*
* @param args command line arguments
* @return exit code
*/
private int _mainNoExit(final String[] args,
List<ICompilerProblem> outProblems)
{
ExitCode exitCode = ExitCode.SUCCESS;
try
{
final boolean continueCompilation = configure(args);
/* if (outProblems != null && !config.isVerbose())
JSSharedData.STDOUT = JSSharedData.STDERR = null;*/
if (continueCompilation)
{
project.setProblems(problems.getProblems());
compile();
if (problems.hasFilteredProblems())
{
if (problems.hasErrors())
exitCode = ExitCode.FAILED_WITH_ERRORS;
else
exitCode = ExitCode.FAILED_WITH_PROBLEMS;
}
}
else if (problems.hasFilteredProblems())
{
exitCode = ExitCode.FAILED_WITH_CONFIG_PROBLEMS;
}
else
{
exitCode = ExitCode.PRINT_HELP;
}
}
catch (Exception e)
{
if (outProblems == null) {
System.err.println(e.getMessage());
} else
{
final ICompilerProblem unexpectedExceptionProblem = new UnexpectedExceptionProblem(
e);
problems.add(unexpectedExceptionProblem);
}
exitCode = ExitCode.FAILED_WITH_EXCEPTIONS;
}
finally
{
waitAndClose();
if (outProblems != null && problems.hasFilteredProblems())
{
for (ICompilerProblem problem : problems.getFilteredProblems())
{
outProblems.add(problem);
}
}
}
return exitCode.code;
}
/**
* Main body of this program. This method is called from the public static
* method's for this program.
*
* @return true if compiler succeeds
* @throws IOException
* @throws InterruptedException
*/
protected boolean compile()
{
JSGoogConfiguration googConfiguration = (JSGoogConfiguration) config;
boolean compilationSuccess = false;
try
{
project.getSourceCompilationUnitFactory().addHandler(asFileHandler);
if (!googConfiguration.getSkipTranspile())
{
if (!setupTargetFile()) {
return false;
}
buildArtifact();
}
if (jsTarget != null || googConfiguration.getSkipTranspile())
{
List<ICompilerProblem> errors = new ArrayList<ICompilerProblem>();
List<ICompilerProblem> warnings = new ArrayList<ICompilerProblem>();
if (!config.getCreateTargetWithErrors())
{
problems.getErrorsAndWarnings(errors, warnings);
if (errors.size() > 0)
return false;
}
jsPublisher = (IJSPublisher) project.getBackend().createPublisher(
project, errors, config);
File outputFolder = jsPublisher.getOutputFolder();
if (!googConfiguration.getSkipTranspile())
{
ArrayList<ICompilationUnit> roots = new ArrayList<ICompilationUnit>();
roots.add(mainCU);
Set<ICompilationUnit> incs = target.getIncludesCompilationUnits();
roots.addAll(incs);
project.mixinClassNames = new TreeSet<String>();
List<ICompilationUnit> reachableCompilationUnits = project.getReachableCompilationUnitsInSWFOrder(roots);
((FlexJSTarget)target).collectMixinMetaData(project.mixinClassNames, reachableCompilationUnits);
for (final ICompilationUnit cu : reachableCompilationUnits)
{
ICompilationUnit.UnitType cuType = cu.getCompilationUnitType();
if (cuType == ICompilationUnit.UnitType.AS_UNIT
|| cuType == ICompilationUnit.UnitType.MXML_UNIT)
{
final File outputClassFile = getOutputClassFile(
cu.getQualifiedNames().get(0), outputFolder);
System.out.println("Compiling file: " + outputClassFile);
ICompilationUnit unit = cu;
IJSWriter writer;
if (cuType == ICompilationUnit.UnitType.AS_UNIT)
{
writer = (IJSWriter) project.getBackend().createWriter(project,
errors, unit, false);
}
else
{
writer = (IJSWriter) project.getBackend().createMXMLWriter(
project, errors, unit, false);
}
BufferedOutputStream out = new BufferedOutputStream(
new FileOutputStream(outputClassFile));
File outputSourceMapFile = null;
if (project.config.getSourceMap())
{
outputSourceMapFile = getOutputSourceMapFile(
cu.getQualifiedNames().get(0), outputFolder);
}
writer.writeTo(out, outputSourceMapFile);
out.flush();
out.close();
writer.close();
}
}
}
if (jsPublisher != null)
{
compilationSuccess = jsPublisher.publish(problems);
}
else
{
compilationSuccess = true;
}
}
}
catch (Exception e)
{
final ICompilerProblem problem = new InternalCompilerProblem(e);
problems.add(problem);
}
return compilationSuccess;
}
/**
* Build target artifact.
*
* @throws InterruptedException threading error
* @throws IOException IO error
* @throws ConfigurationException
*/
protected void buildArtifact() throws InterruptedException, IOException,
ConfigurationException
{
jsTarget = buildJSTarget();
}
private IJSApplication buildJSTarget() throws InterruptedException,
FileNotFoundException, ConfigurationException
{
final List<ICompilerProblem> problemsBuildingSWF = new ArrayList<ICompilerProblem>();
project.mainCU = mainCU;
final IJSApplication app = buildApplication(project,
config.getMainDefinition(), mainCU, problemsBuildingSWF);
problems.addAll(problemsBuildingSWF);
if (app == null)
{
ICompilerProblem problem = new UnableToBuildSWFProblem(
getOutputFilePath());
problems.add(problem);
}
return app;
}
/**
* Replaces FlexApplicationProject::buildSWF()
*
* @param applicationProject
* @param rootClassName
* @param problems
* @return
* @throws InterruptedException
*/
private IJSApplication buildApplication(CompilerProject applicationProject,
String rootClassName, ICompilationUnit mainCU,
Collection<ICompilerProblem> problems) throws InterruptedException,
ConfigurationException, FileNotFoundException
{
Collection<ICompilerProblem> fatalProblems = applicationProject.getFatalProblems();
if (!fatalProblems.isEmpty())
{
problems.addAll(fatalProblems);
return null;
}
return ((JSTarget) target).build(mainCU, problems);
}
/**
* Get the output file path. If {@code -output} is specified, use its value;
* otherwise, use the same base name as the target file.
*
* @return output file path
*/
private String getOutputFilePath()
{
if (config.getOutput() == null)
{
final String extension = "." + project.getBackend().getOutputExtension();
return FilenameUtils.removeExtension(config.getTargetFile()).concat(
extension);
}
else
return config.getOutput();
}
/**
* @author Erik de Bruin
*
* Get the output class file. This includes the (sub)directory in
* which the original class file lives. If the directory structure
* doesn't exist, it is created.
*
* @param qname
* @param outputFolder
* @return output class file path
*/
private File getOutputClassFile(String qname, File outputFolder)
{
String[] cname = qname.split("\\.");
String sdirPath = outputFolder + File.separator;
if (cname.length > 0)
{
for (int i = 0, n = cname.length - 1; i < n; i++)
{
sdirPath += cname[i] + File.separator;
}
File sdir = new File(sdirPath);
if (!sdir.exists())
sdir.mkdirs();
qname = cname[cname.length - 1];
}
return new File(sdirPath + qname + "." + project.getBackend().getOutputExtension());
}
/**
* @param qname
* @param outputFolder
* @return output source map file path
*/
private File getOutputSourceMapFile(String qname, File outputFolder)
{
String[] cname = qname.split("\\.");
String sdirPath = outputFolder + File.separator;
if (cname.length > 0)
{
for (int i = 0, n = cname.length - 1; i < n; i++)
{
sdirPath += cname[i] + File.separator;
}
File sdir = new File(sdirPath);
if (!sdir.exists())
sdir.mkdirs();
qname = cname[cname.length - 1];
}
return new File(sdirPath + qname + "." + project.getBackend().getOutputExtension() + ".map");
}
/**
* Mxmlc uses target file as the main compilation unit and derive the output
* SWF file name from this file.
*
* @return true if successful, false otherwise.
* @throws OnlyOneSource
* @throws InterruptedException
*/
protected boolean setupTargetFile() throws InterruptedException
{
final String mainFileName = config.getTargetFile();
final String normalizedMainFileName = FilenameNormalization.normalize(mainFileName);
final SourceCompilationUnitFactory compilationUnitFactory = project.getSourceCompilationUnitFactory();
File normalizedMainFile = new File(normalizedMainFileName);
if (compilationUnitFactory.canCreateCompilationUnit(normalizedMainFile))
{
project.addIncludeSourceFile(normalizedMainFile);
final List<String> sourcePath = config.getCompilerSourcePath();
String mainQName = null;
if (sourcePath != null && !sourcePath.isEmpty())
{
for (String path : sourcePath)
{
final String otherPath = new File(path).getAbsolutePath();
if (mainFileName.startsWith(otherPath))
{
mainQName = mainFileName.substring(otherPath.length() + 1);
mainQName = mainQName.replaceAll("\\\\", "/");
mainQName = mainQName.replaceAll("\\/", ".");
if (mainQName.endsWith(".as"))
mainQName = mainQName.substring(0,
mainQName.length() - 3);
break;
}
}
}
if (mainQName == null)
mainQName = FilenameUtils.getBaseName(mainFileName);
Collection<ICompilationUnit> mainFileCompilationUnits = workspace.getCompilationUnits(
normalizedMainFileName, project);
mainCU = Iterables.getOnlyElement(mainFileCompilationUnits);
config.setMainDefinition(mainQName);
}
Preconditions.checkNotNull(mainCU,
"Main compilation unit can't be null");
ITargetSettings settings = getTargetSettings();
if (settings != null)
project.setTargetSettings(settings);
target = project.getBackend().createTarget(project,
getTargetSettings(), null);
return true;
}
private ITargetSettings getTargetSettings()
{
if (targetSettings == null)
targetSettings = projectConfigurator.getTargetSettings(null);
return targetSettings;
}
/**
* Create a new Configurator. This method may be overridden to allow
* Configurator subclasses to be created that have custom configurations.
*
* @return a new instance or subclass of {@link Configurator}.
*/
protected Configurator createConfigurator()
{
return project.getBackend().createConfigurator();
}
/**
* Load configurations from all the sources.
*
* @param args command line arguments
* @return True if mxmlc should continue with compilation.
*/
protected boolean configure(final String[] args)
{
project.getSourceCompilationUnitFactory().addHandler(asFileHandler);
project.configurator = projectConfigurator = createConfigurator();
try
{
if (useFlashBuilderProjectFiles(args))
{
projectConfigurator.setConfiguration(
FlashBuilderConfigurator.computeFlashBuilderArgs(args,
getTargetType().getExtension()),
ICompilerSettingsConstants.FILE_SPECS_VAR);
}
else
{
projectConfigurator.setConfiguration(args,
ICompilerSettingsConstants.FILE_SPECS_VAR);
}
projectConfigurator.applyToProject(project);
project.config = (JSGoogConfiguration) projectConfigurator.getConfiguration();
config = projectConfigurator.getConfiguration();
configBuffer = projectConfigurator.getConfigurationBuffer();
problems = new ProblemQuery(projectConfigurator.getCompilerProblemSettings());
problems.addAll(projectConfigurator.getConfigurationProblems());
if (configBuffer.getVar("version") != null) //$NON-NLS-1$
return false;
if (problems.hasErrors())
return false;
validateTargetFile();
return true;
}
catch (ConfigurationException e)
{
final ICompilerProblem problem = new ConfigurationProblem(e);
problems.add(problem);
return false;
}
catch (Exception e)
{
final ICompilerProblem problem = new ConfigurationProblem(null, -1,
-1, -1, -1, e.getMessage());
problems.add(problem);
return false;
}
finally
{
if (config == null)
{
config = new Configuration();
configBuffer = new ConfigurationBuffer(Configuration.class,
Configuration.getAliases());
}
}
}
private boolean useFlashBuilderProjectFiles(String[] args)
{
for (String arg : args)
{
if (arg.equals("-fb")
|| arg.equals("-use-flashbuilder-project-files"))
return true;
}
return false;
}
protected TargetType getTargetType()
{
return TargetType.SWF;
}
/**
* Validate target file.
*
* @throws MustSpecifyTarget
* @throws IOError
*/
protected void validateTargetFile() throws ConfigurationException
{
if (mainCU instanceof ResourceModuleCompilationUnit)
return; //when compiling a Resource Module, no target file is defined.
final String targetFile = config.getTargetFile();
if (targetFile == null)
throw new ConfigurationException.MustSpecifyTarget(null, null, -1);
final File file = new File(targetFile);
if (!file.exists())
throw new ConfigurationException.IOError(targetFile);
}
/**
* Wait till the workspace to finish compilation and close.
*/
protected void waitAndClose()
{
workspace.startIdleState();
try
{
workspace.close();
}
finally
{
workspace.endIdleState(Collections.<ICompilerProject, Set<ICompilationUnit>> emptyMap());
}
}
/**
* Force terminate the compilation process.
*/
protected void close()
{
workspace.close();
}
}