org.apache.royale.compiler.driver

Interface IBackend

All Known Subinterfaces:

IJSBackend

All Known Implementing Classes:

AMDBackend, ASBackend, GoogBackend, JSBackend, JSCBackend, MXMLBackend, MXMLJSCJSBackend, MXMLJSCJSSWCBackend, MXMLRoyaleASDocBackend, MXMLRoyaleASDocDITABackend, MXMLRoyaleBackend, MXMLRoyaleCordovaBackend, MXMLRoyaleSWCBackend, NodeBackend, NodeModuleBackend, RoyaleBackend

public interface IBackend

The backend strategy for the MXMLJSC javascript compiler.

Author:

Michael Schmalle

Method Summary

Modifier and Type	Method and Description
Configurator	createConfigurator() Creates a Configurator for the specific compile session.
IDocEmitter	createDocEmitter(IASEmitter emitter)
IASEmitter	createEmitter(FilterWriter writer)
IMXMLEmitter	createMXMLEmitter(FilterWriter writer)
IMXMLBlockWalker	createMXMLWalker(RoyaleJSProject project, List<ICompilerProblem> errors, IMXMLEmitter mxmlEmitter, IASEmitter asEmitter, IBlockWalker asBlockWalker) Creates an AST walker capable of traversing MXML AST and calling back to the IASBlockWalker for ActionScript source code production.
IASWriter	createMXMLWriter(RoyaleJSProject project, List<ICompilerProblem> errors, ICompilationUnit compilationUnit, boolean enableDebug)
IPublisher	createPublisher(RoyaleJSProject project, List<ICompilerProblem> errors, Configuration config)
ITarget	createTarget(RoyaleJSProject project, ITargetSettings settings, ITargetProgressMonitor monitor) Creates a javascript target that will be used to build the compiled javascript source file.
IASBlockWalker	createWalker(RoyaleJSProject project, List<ICompilerProblem> errors, IASEmitter emitter)
IASWriter	createWriter(RoyaleJSProject project, List<ICompilerProblem> errors, ICompilationUnit compilationUnit, boolean enableDebug)
ASFilterWriter	createWriterBuffer(RoyaleJSProject project)
String	getOutputExtension() Returns the File extension used when saving compiled code.
org.apache.royale.compiler.internal.projects.ISourceFileHandler	getSourceFileHandlerInstance() Returns the instance that is used to manage what type of ICompilationUnit is created during parsing.

Method Detail

getSourceFileHandlerInstance

org.apache.royale.compiler.internal.projects.ISourceFileHandler getSourceFileHandlerInstance()

Returns the instance that is used to manage what type of ICompilationUnit is created during parsing.

Returns:

The implemented ISourceFileHandler.

getOutputExtension

String getOutputExtension()

Returns the File extension used when saving compiled code.

createConfigurator

Configurator createConfigurator()

Creates a Configurator for the specific compile session.

createTarget

ITarget createTarget(RoyaleJSProject project,
                     ITargetSettings settings,
                     ITargetProgressMonitor monitor)

Creates a javascript target that will be used to build the compiled javascript source file.

Parameters:

project - The current RoyaleJSProject.

settings - The target's custom settings.

monitor - The compilation monitor used during asynchronous parsing of ICompilationUnits.

Returns:

A new JSTarget used during compilation.

createDocEmitter

IDocEmitter createDocEmitter(IASEmitter emitter)

createEmitter

IASEmitter createEmitter(FilterWriter writer)

createMXMLEmitter

IMXMLEmitter createMXMLEmitter(FilterWriter writer)

createWriterBuffer

ASFilterWriter createWriterBuffer(RoyaleJSProject project)

createWriter

IASWriter createWriter(RoyaleJSProject project,
                       List<ICompilerProblem> errors,
                       ICompilationUnit compilationUnit,
                       boolean enableDebug)

createMXMLWriter

IASWriter createMXMLWriter(RoyaleJSProject project,
                           List<ICompilerProblem> errors,
                           ICompilationUnit compilationUnit,
                           boolean enableDebug)

createWalker

IASBlockWalker createWalker(RoyaleJSProject project,
                            List<ICompilerProblem> errors,
                            IASEmitter emitter)

createPublisher

IPublisher createPublisher(RoyaleJSProject project,
                           List<ICompilerProblem> errors,
                           Configuration config)

createMXMLWalker

IMXMLBlockWalker createMXMLWalker(RoyaleJSProject project,
                                  List<ICompilerProblem> errors,
                                  IMXMLEmitter mxmlEmitter,
                                  IASEmitter asEmitter,
                                  IBlockWalker asBlockWalker)

Creates an AST walker capable of traversing MXML AST and calling back to the IASBlockWalker for ActionScript source code production.

Use the #createWalker(RoyaleJSProject, List, ASFilterWriter) method first and pass that instance into this method's walker parameter.

Parameters:

project - The current RoyaleJSProject.

errors - The current ICompilerProblem list.

emitter - The current IASEmitter that is used for it's emitter and is available for callbacks to it's visit methods.