org.apache.flex.compiler.internal.as.codegen

Interface ICodeGenerator

All Known Implementing Classes:

ABCGenerator

public interface ICodeGenerator

Interface for the code generator. Different code generation targets (e.g. ABC bytecode or JavaScript) implement these methods to emit suitable object code for their target.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ICodeGenerator.IConstantValue Represents the result of generateConstantValue(org.apache.flex.compiler.tree.as.IASNode, org.apache.flex.compiler.projects.ICompilerProject)(}.

Method Summary

Methods

Modifier and Type	Method and Description
MethodInfo	createMethodInfo(LexicalScope scope, FunctionNode func, Name alternate_name) Creates a MethodInfo specifying the signature of a method declared by a FunctionNode.
MethodInfo	createMethodInfoWithDefaultArgumentValues(LexicalScope scope, FunctionNode func) Creates a MethodInfo specifying the signature of a method declared by a FunctionNode, and adds in the information for any default argument values.
ABCBytesRequestResult	generate(ExecutorService executorService, boolean useParallelCodegen, String synthetic_name_prefix, IASNode root_node, ICompilerProject project, boolean inInvisibleCompilationUnit, Map<String,String> encodedDebugFiles) Generate an ABC file equivalent to the input syntax tree.
ABCBytesRequestResult	generate(String synthetic_name_prefix, IASNode root_node, ICompilerProject project) Generate an ABC file equivalent to the input syntax tree.
ICodeGenerator.IConstantValue	generateConstantValue(IASNode subtree, ICompilerProject project) Helper method to expose the constant folding code to clients outside of the burm, such as org.apache.flex.compiler.internal.as.definitions.ConstantDefinition.
MethodInfo	generateFunction(FunctionNode func, LexicalScope enclosing_scope, InstructionList instance_init_insns, Name alternateName) Generate code for a function declaration, and put its initialization code on the relevant instruction list.
GenerateFunctionInParallelResult	generateFunctionInParallel(ExecutorService executorService, FunctionNode func, LexicalScope enclosing_scope) Generate code for a function declaration, using a background thread provided by the specified ExecutorService.
InstructionList	generateInstructions(IASNode subtree, int goal_state, LexicalScope scope) Translate an AST into ABC instructions.
void	generateMethodBodyForFunction(MethodInfo mi, IASNode node, LexicalScope enclosing_scope, InstructionList instance_init_insns) Helper method used by generateFunction() (and also by generateEventHandler() in MXMLDocumentDirectiveProcessor).
void	generateMXMLDataBindingGetterFunction(MethodInfo mi, List<IExpressionNode> nodes, LexicalScope enclosing_scope) Helper method used by databinding codegen to emit an anonymous function based on a list of IExpressionNode's.
void	generateMXMLDataBindingSetterFunction(MethodInfo mi, IExpressionNode setterExpression, LexicalScope enclosing_scope) Helper method used by mxml databinding codegen to emit an anonymous function used by an mxml data binding destination function.
Object	reduceSubtree(IASNode subtree, LexicalScope scope, int goal) Reduce an AST to its equivalent ABC structures.

Method Detail

generate

ABCBytesRequestResult generate(String synthetic_name_prefix,
                             IASNode root_node,
                             ICompilerProject project)
                               throws InterruptedException

Generate an ABC file equivalent to the input syntax tree.

Parameters:

synthetic_name_prefix - Prefix to prepend to all synthetic names

root_node - the root of the syntax tree.

project - ICompilerProject whose symbol table is used to resolve references to definitions.

Returns:

An ABCBytesRequestResult that can provide the generated code

Throws:

InterruptedException

generate

ABCBytesRequestResult generate(ExecutorService executorService,
                             boolean useParallelCodegen,
                             String synthetic_name_prefix,
                             IASNode root_node,
                             ICompilerProject project,
                             boolean inInvisibleCompilationUnit,
                             Map<String,String> encodedDebugFiles)
                               throws InterruptedException

Generate an ABC file equivalent to the input syntax tree.

Parameters:

executorService - ExecutorService used by the code generator when parallel code generation is enabled.

useParallelCodegen - If true, some method bodies are generated in background threads. If false all method bodies are generated on the calling thread.

synthetic_name_prefix - Prefix to prepend to all synthetic names

root_node - the root of the syntax tree.

project - ICompilerProject whose symbol table is used to resolve references to definitions.

inInvisibleCompilationUnit - Indicates whether or not we are generating code for an IInvisibleCompilationUnit.

encodedDebugFiles - - a mapping between the absolute path of a file, and the encoded path that is used by OP_debugfile

Returns:

An ABCBytesRequestResult that can provide the generated code

Throws:

InterruptedException

generateInstructions

InstructionList generateInstructions(IASNode subtree,
                                   int goal_state,
                                   LexicalScope scope)

Translate an AST into ABC instructions.

Parameters:

subtree - - the CM subtree.

goal_state - - the desired goal state. One of the nonterminal states in CmcEmitter, or 0 if you're feeling lucky and are willing to accept whatever instruction sequence the BURM decides is optimal.

scope - - the active lexical scope.

Returns:

a list of ABC instructions.

generateFunction

MethodInfo generateFunction(FunctionNode func,
                          LexicalScope enclosing_scope,
                          InstructionList instance_init_insns,
                          Name alternateName)

Generate code for a function declaration, and put its initialization code on the relevant instruction list.

Parameters:

func - the function declaration node.

enclosing_scope - the lexical scope in which the function was defined.

instance_init_insns - a list of instance initialization instructions collected outside a constructor body that must be included in the constructor.

Returns:

MethodInfo created for the function.

generateFunctionInParallel

GenerateFunctionInParallelResult generateFunctionInParallel(ExecutorService executorService,
                                                          FunctionNode func,
                                                          LexicalScope enclosing_scope)

Generate code for a function declaration, using a background thread provided by the specified ExecutorService.

Parameters:

executorService - ExecutorService used to do work in other threads.

func - the function declaration node.

enclosing_scope - the lexical scope in which the function was defined.

Returns:

GenerateFunctionInParallelResult which can be used to wait for code generation of the specified function to complete and to extract the MethodInfo created for the specified function. The MethodInfo may be extracted immediately after this method completes ( you don't have to wait for code generation of the specified function complete ).

generateMXMLDataBindingSetterFunction

void generateMXMLDataBindingSetterFunction(MethodInfo mi,
                                         IExpressionNode setterExpression,
                                         LexicalScope enclosing_scope)

Helper method used by mxml databinding codegen to emit an anonymous function used by an mxml data binding destination function. Example:

If the expression node is a.b.c, this method will generate a funtion whose source would look something like this:

 function (arg:*):void { a.b.c = arg; }
 

Parameters:

mi - - the MethodInfo describing the signature

setterExpression - IExpressionNode that is the destination expression of a mxml data binding.

enclosing_scope - LexicalScope for the class initializer that encloses the function being generated.

generateMXMLDataBindingGetterFunction

void generateMXMLDataBindingGetterFunction(MethodInfo mi,
                                         List<IExpressionNode> nodes,
                                         LexicalScope enclosing_scope)

Helper method used by databinding codegen to emit an anonymous function based on a list of IExpressionNode's. This method emits a function that contains code that evaluates each expression in the list and adds the expressions together with ABCConstants.OP_add.

Parameters:

mi - - the MethodInfo describing the signature

nodes - - a List of IExpressionNode's to be codegen'd.

enclosing_scope - LexicalScope for the class initializer that encloses the function being generated.

createMethodInfo

MethodInfo createMethodInfo(LexicalScope scope,
                          FunctionNode func,
                          Name alternate_name)

Creates a MethodInfo specifying the signature of a method declared by a FunctionNode.

Parameters:

func - - A FunctionNode representing a method declaration.

Returns:

The MethodInfo specifying the signature of the method.

createMethodInfoWithDefaultArgumentValues

MethodInfo createMethodInfoWithDefaultArgumentValues(LexicalScope scope,
                                                   FunctionNode func)

Creates a MethodInfo specifying the signature of a method declared by a FunctionNode, and adds in the information for any default argument values.

Parameters:

func - - A FunctionNode representing a method declaration.

Returns:

The MethodInfo specifying the signature of the method.

generateMethodBodyForFunction

void generateMethodBodyForFunction(MethodInfo mi,
                                 IASNode node,
                                 LexicalScope enclosing_scope,
                                 InstructionList instance_init_insns)

Helper method used by generateFunction() (and also by generateEventHandler() in MXMLDocumentDirectiveProcessor).

Parameters:

mi - - the MethodInfo describing the signature

node - - the FunctionNode or MXMLEventSpecifierNode.

enclosing_scope - - the lexical scope in which the handler method is autogenerated.

instance_init_insns - - a list of instance initialization instructions collected outside a constructor body that must be included in the constructor.

generateConstantValue

ICodeGenerator.IConstantValue generateConstantValue(IASNode subtree,
                                                  ICompilerProject project)

Helper method to expose the constant folding code to clients outside of the burm, such as org.apache.flex.compiler.internal.as.definitions.ConstantDefinition.

Parameters:

subtree - the tree to generate a constant value for

project - the project to use to evaluate the tree

Returns:

the constant value for the subtree, or null if a constant value can't be determined

reduceSubtree

Object reduceSubtree(IASNode subtree,
                   LexicalScope scope,
                   int goal)
                     throws Exception

Reduce an AST to its equivalent ABC structures.

Parameters:

subtree - - the root of the AST subtree. May be null, in which case this routine returns null.

scope - - the active LexicalScope.

goal - - the BURM's goal state. One of the CmcEmitter.__foo_NT constants.

Returns:

the result of reducing the subtree to the desired goal state, or null if the input subtree was null.

Throws:

Exception - from the BURM if the computation didn't succeed or was interrupted.