org.apache.royale.compiler.clients.MXMLJSC Maven / Gradle / Ivy
The newest version!
/*
*
* 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.royale.compiler.clients;
import java.io.OutputStream;
import java.util.*;
import org.apache.royale.compiler.clients.problems.CompilerProblemCategorizer;
import org.apache.royale.compiler.clients.problems.ProblemPrinter;
import org.apache.royale.compiler.clients.problems.ProblemQuery;
import org.apache.royale.compiler.clients.problems.ProblemQueryProvider;
import org.apache.royale.compiler.clients.problems.WorkspaceProblemFormatter;
import org.apache.royale.compiler.common.VersionInfo;
import org.apache.royale.compiler.config.CommandLineConfigurator;
import org.apache.royale.compiler.config.CompilerDiagnosticsConstants;
import org.apache.royale.compiler.config.Configuration;
import org.apache.royale.compiler.config.ConfigurationBuffer;
import org.apache.royale.compiler.config.ConfigurationValue;
import org.apache.royale.compiler.config.Configurator;
import org.apache.royale.compiler.config.ICompilerProblemSettings;
import org.apache.royale.compiler.config.ICompilerSettingsConstants;
import org.apache.royale.compiler.driver.js.IJSApplication;
import org.apache.royale.compiler.internal.config.FlashBuilderConfigurator;
import org.apache.royale.compiler.internal.config.localization.LocalizationManager;
import org.apache.royale.compiler.internal.definitions.DefinitionBase;
import org.apache.royale.compiler.internal.driver.js.goog.JSGoogConfiguration;
import org.apache.royale.compiler.internal.parsing.as.RoyaleASDocDelegate;
import org.apache.royale.compiler.internal.projects.RoyaleJSProject;
import org.apache.royale.compiler.internal.projects.RoyaleProjectConfigurator;
import org.apache.royale.compiler.internal.projects.ISourceFileHandler;
import org.apache.royale.compiler.internal.workspaces.Workspace;
import org.apache.royale.compiler.problems.ConfigurationProblem;
import org.apache.royale.compiler.problems.ICompilerProblem;
import org.apache.royale.compiler.problems.UnexpectedExceptionProblem;
import org.apache.royale.compiler.projects.ICompilerProject;
import org.apache.royale.compiler.targets.ITarget;
import org.apache.royale.compiler.targets.ITarget.TargetType;
import org.apache.royale.compiler.targets.ITargetSettings;
import org.apache.royale.compiler.units.ICompilationUnit;
import org.apache.royale.swf.ISWF;
import org.apache.royale.swf.SWF;
import org.apache.royale.swf.types.RGB;
import org.apache.royale.swf.types.Rect;
import org.apache.flex.tools.FlexTool;
import org.apache.royale.utils.ArgumentUtil;
/**
* @author Erik de Bruin
* @author Michael Schmalle
*/
public class MXMLJSC implements JSCompilerEntryPoint, ProblemQueryProvider,
FlexTool
{
@Override
public ProblemQuery getProblemQuery()
{
return problems;
}
static final String NEWLINE = System.getProperty("line.separator");
private static final String DEFAULT_VAR = "file-specs";
private static final String L10N_CONFIG_PREFIX = "org.apache.royale.compiler.internal.config.configuration";
/*
* JS output type enumerations.
*/
public enum JSTargetType
{
SWF("SWF"),
JS_ROYALE("JSRoyale"),
JS_ROYALE_CORDOVA("JSRoyaleCordova"),
//JS without the Royale framework
JS_NATIVE("JS"),
//Node.js application
JS_NODE("JSNode"),
//Node.js module
JS_NODE_MODULE("JSNodeModule");
private String text;
JSTargetType(String text)
{
this.text = text;
}
public String getText()
{
return this.text;
}
public static JSTargetType fromString(String text)
{
for (JSTargetType jsTargetType : JSTargetType.values())
{
if (text.equalsIgnoreCase(jsTargetType.text))
return jsTargetType;
}
return null;
}
}
/*
* Exit code enumerations.
*/
static enum ExitCode
{
SUCCESS(0),
PRINT_HELP(1),
FAILED_WITH_ERRORS(2),
FAILED_WITH_EXCEPTIONS(3),
FAILED_WITH_CONFIG_PROBLEMS(4),
WATCHING(1000);
ExitCode(int code)
{
this.code = code;
}
final int code;
int getCode()
{
return code;
}
}
@Override
public String getName()
{
return FLEX_TOOL_MXMLC;
}
/**
* Get my program name.
*
* @return always "mxmlc".
*/
protected String getProgramName()
{
return "mxmljsc";
}
@Override
public int execute(String[] args)
{
final List problems = new ArrayList();
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);
if (exitCode != ExitCode.WATCHING.getCode())
{
System.exit(exitCode);
}
}
/**
* Entry point for the {@code } Ant task.
*
* @param args Command line arguments.
* @return An exit code.
*/
public static int staticMainNoExit(final String[] args)
{
long startTime = System.nanoTime();
System.out.println("MXMLJSC");
for (String arg : args)
System.out.println(arg);
final MXMLJSC mxmlc = new MXMLJSC();
final List problems = new ArrayList();
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 RoyaleJSProject project;
protected ProblemQuery problems;
protected ISourceFileHandler asFileHandler;
public JSConfiguration config;
protected Configurator projectConfigurator;
private ConfigurationBuffer configBuffer;
protected ITarget target;
protected ITargetSettings targetSettings;
protected IJSApplication jsTarget;
protected MXMLC mxmlc;
protected JSCompilerEntryPoint lastCompiler;
public boolean noLink;
public OutputStream err;
public Class configurationClass = JSGoogConfiguration.class;
public MXMLJSC()
{
workspace = new Workspace();
workspace.setASDocDelegate(new RoyaleASDocDelegate());
project = new RoyaleJSProject(workspace, null);
}
@Override
public int mainNoExit(final String[] args, List 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, createProblemCategorizer());
final ProblemPrinter printer = new ProblemPrinter(formatter);
printer.printProblems(problems);
}
}
}
return exitCode;
}
/**
* Entry point that doesn't call System.exit(). This is for
* unit testing.
*
* @param args command line arguments
* @return exit code
*/
private int _mainNoExit(final String[] args,
List outProblems)
{
ExitCode exitCode = ExitCode.SUCCESS;
try
{
final boolean continueCompilation = configure(args);
CompilerDiagnosticsConstants.diagnostics = config.getDiagnosticsLevel();
/* if (outProblems != null && !config.isVerbose())
JSSharedData.STDOUT = JSSharedData.STDERR = null;*/
if (continueCompilation)
{
targetloop:
for (String target : config.getCompilerTargets())
{
int result = 0;
switch (JSTargetType.fromString(target))
{
case SWF:
mxmlc = new MXMLC();
mxmlc.configurationClass = configurationClass;
if (noLink)
result = mxmlc.mainCompileOnly(removeJSArgs(args), err);
else
result = mxmlc.mainNoExit(removeJSArgs(args));
if (result != MXMLC.ExitCode.SUCCESS.getCode() && result != MXMLC.ExitCode.WATCHING.getCode())
{
problems.addAll(mxmlc.problems.getProblems());
break targetloop;
}
break;
case JS_ROYALE:
MXMLJSCRoyale royale = new MXMLJSCRoyale();
lastCompiler = royale;
result = royale.mainNoExit(removeASArgs(args), problems.getProblems(), false);
if (result != MXMLJSCRoyale.ExitCode.SUCCESS.getCode() && result != MXMLJSCRoyale.ExitCode.WATCHING.getCode())
{
break targetloop;
}
break;
case JS_ROYALE_CORDOVA:
MXMLJSCRoyaleCordova royaleCordova = new MXMLJSCRoyaleCordova();
lastCompiler = royaleCordova;
result = royaleCordova.mainNoExit(removeASArgs(args), problems.getProblems(), false);
if (result != MXMLJSCRoyaleCordova.ExitCode.SUCCESS.getCode() && result != MXMLJSCRoyaleCordova.ExitCode.WATCHING.getCode())
{
break targetloop;
}
break;
case JS_NODE:
MXMLJSCNode node = new MXMLJSCNode();
lastCompiler = node;
result = node.mainNoExit(removeASArgs(args), problems.getProblems(), false);
if (result != MXMLJSCNode.ExitCode.SUCCESS.getCode() && result != MXMLJSCNode.ExitCode.WATCHING.getCode())
{
break targetloop;
}
break;
case JS_NODE_MODULE:
MXMLJSCNodeModule nodeModule = new MXMLJSCNodeModule();
lastCompiler = nodeModule;
result = nodeModule.mainNoExit(removeASArgs(args), problems.getProblems(), false);
if (result != MXMLJSCNodeModule.ExitCode.SUCCESS.getCode() && result != MXMLJSCNodeModule.ExitCode.WATCHING.getCode())
{
break targetloop;
}
break;
case JS_NATIVE:
MXMLJSCNative jsc = new MXMLJSCNative();
lastCompiler = jsc;
result = jsc.mainNoExit(removeASArgs(args), problems.getProblems(), false);
if (result != MXMLJSCNative.ExitCode.SUCCESS.getCode() && result != MXMLJSCNative.ExitCode.WATCHING.getCode())
{
break targetloop;
}
break;
// if you add a new target here, don't forget to also add it
// to flex2.tools.MxmlJSC in flex-compiler-oem for IDE support
}
}
if (problems.hasFilteredProblems())
{
if (problems.hasErrors())
exitCode = ExitCode.FAILED_WITH_ERRORS;
// no exit code for warnings because anything except 0 is
// detected as a failure by various build tools
}
}
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
{
if (!config.getWatch() || !ExitCode.SUCCESS.equals(exitCode))
{
waitAndClose();
}
if (outProblems != null && problems.hasFilteredProblems())
{
for (ICompilerProblem problem : problems.getFilteredProblems())
{
outProblems.add(problem);
}
}
}
if (config.getWatch() && ExitCode.SUCCESS.equals(exitCode))
{
exitCode = ExitCode.WATCHING;
}
return exitCode.getCode();
}
protected String[] removeJSArgs(String[] args)
{
ArrayList list = new ArrayList();
for (String arg : args)
{
if (!(arg.startsWith("-compiler.targets") ||
arg.startsWith("-closure-lib") ||
arg.startsWith("-remove-circulars") ||
arg.startsWith("-compiler.js-external-library-path") ||
arg.startsWith("-compiler.js-library-path") ||
arg.startsWith("-compiler.js-define") ||
arg.startsWith("-js-output") ||
arg.startsWith("-js-vector-emulation-class") ||
arg.startsWith("-externs-report") ||
arg.startsWith("-js-load-config") ||
arg.startsWith("-warn-public-vars") ||
arg.startsWith("-export-protected-symbols") ||
arg.startsWith("-source-map")))
list.add(arg);
}
return list.toArray(new String[0]);
}
protected String[] removeASArgs(String[] args)
{
ArrayList list = new ArrayList();
boolean hasJSLoadConfig = false;
for (String arg : args)
{
if (arg.startsWith("-js-load-config"))
hasJSLoadConfig = true;
}
if (!hasJSLoadConfig)
return args;
for (String arg : args)
{
if (!arg.startsWith("-load-config"))
{
if (arg.startsWith("-js-load-config"))
arg = arg.substring(3);
list.add(arg);
}
}
return list.toArray(new String[0]);
}
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.
*/
public boolean configure(final String[] args)
{
projectConfigurator = new RoyaleProjectConfigurator(configurationClass);
try
{
if (args.length == 0)
{
final String usage = CommandLineConfigurator.brief(
getProgramName(),
DEFAULT_VAR,
LocalizationManager.get(),
L10N_CONFIG_PREFIX);
println(getStartMessage());
if (usage != null)
println(usage);
}
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);
// getCompilerProblemSettings initializes the configuration
problems = new ProblemQuery(projectConfigurator.getCompilerProblemSettings());
problems.addAll(projectConfigurator.getConfigurationProblems());
config = (JSConfiguration) projectConfigurator.getConfiguration();
configBuffer = projectConfigurator.getConfigurationBuffer();
if (configBuffer.getVar("version") != null) //$NON-NLS-1$
{
System.out.println(VersionInfo.buildMessage());
return false;
}
// Print help if "-help" is present.
final List helpVar = configBuffer.getVar("help");
if (helpVar != null)
{
processHelp(helpVar);
return false;
}
if (config.getWatch() && !config.debug())
{
final ICompilerProblem problem = new ConfigurationProblem(null, -1,
-1, -1, -1, "configuration variable 'debug' must be true if configuration variable 'watch' is true");
problems.add(problem);
}
for(String target : config.getCompilerTargets())
{
JSTargetType jsTargetType = JSTargetType.fromString(target);
if (jsTargetType == null)
{
String message = "configuration variable 'targets' must be one of the following: ";
for (JSTargetType type : JSTargetType.values())
{
message += "'" + type.text + "', ";
}
message += "got '" + target + "'";
final ICompilerProblem problem = new ConfigurationProblem(null, -1,
-1, -1, -1, message);
problems.add(problem);
}
}
if (problems.hasErrors())
return false;
DefinitionBase.setPerformanceCachingEnabled(!config.getWatch());
return true;
}
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 JSConfiguration();
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;
}
/**
* Print a message.
*
* @param msg Message text.
*/
public void println(final String msg)
{
System.out.println(msg);
}
/**
* Get the start up message that contains the program name
* with the copyright notice.
*
* @return The startup message.
*/
protected String getStartMessage()
{
// This message should not be localized.
String message = "Apache Royale MXML and ActionScript Compiler (mxmlc)" + NEWLINE +
VersionInfo.buildMessage() + NEWLINE;
return message;
}
/**
* Print detailed help information if -help is provided.
*/
private void processHelp(final List helpVar)
{
final Set keywords = new LinkedHashSet();
for (final ConfigurationValue val : helpVar)
{
for (final Object element : val.getArgs())
{
String keyword = (String)element;
while (keyword.startsWith("-"))
keyword = keyword.substring(1);
keywords.add(keyword);
}
}
if (keywords.size() == 0)
keywords.add("help");
final String usages = CommandLineConfigurator.usage(
getProgramName(),
DEFAULT_VAR,
configBuffer,
keywords,
LocalizationManager.get(),
L10N_CONFIG_PREFIX);
println(getStartMessage());
println(usages);
}
protected TargetType getTargetType()
{
return TargetType.SWF;
}
/**
* Wait till the workspace to finish compilation and close.
*/
protected void waitAndClose()
{
workspace.startIdleState();
try
{
workspace.close();
}
finally
{
workspace.endIdleState(Collections.> emptyMap());
}
}
/**
* Force terminate the compilation process.
*/
protected void close()
{
workspace.close();
}
public List getSourceList()
{
if (lastCompiler != null)
return lastCompiler.getSourceList();
if (mxmlc != null)
return mxmlc.getSourceList();
return null;
}
public String getMainSource()
{
if (lastCompiler != null)
return lastCompiler.getMainSource();
if (mxmlc != null)
return mxmlc.getMainSource();
return null;
}
/**
* return a data structure for FB integration
* @return
*/
public ISWF getSWFTarget()
{
SWF swf = new SWF();
Rect rect = new Rect(getTargetSettings().getDefaultWidth(),
getTargetSettings().getDefaultHeight());
swf.setFrameSize(rect);
// we might need to report actual color some day
swf.setBackgroundColor(new RGB(255, 255, 255));
swf.setTopLevelClass(config.getTargetFile());
return swf;
}
public long writeSWF(OutputStream output)
{
if (mxmlc != null)
return mxmlc.writeSWF(output);
return 0;
}
/**
* Determines whether an exit code should be considered
* a fatal failure, such as for an Ant task.
*
* @param code A numeric exit code.
* @return true if the Ant task failed.
*/
public static boolean isFatalFailure(final int code)
{
// This method really belongs in ExitCode
// but that would complicate RoyaleTask.
return code == ExitCode.FAILED_WITH_ERRORS.getCode() ||
code == ExitCode.FAILED_WITH_EXCEPTIONS.getCode() ||
code == ExitCode.FAILED_WITH_CONFIG_PROBLEMS.getCode();
}
/**
* Set up any user defines customization of the problem severities.
*
*/
private CompilerProblemCategorizer createProblemCategorizer()
{
ICompilerProblemSettings problemSettings = null;
try
{
problemSettings = projectConfigurator.getCompilerProblemSettings();
}
catch (Exception e)
{
// Create a categorizer that will only use default settings.
}
return new CompilerProblemCategorizer(problemSettings);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy