org.apache.flex.compiler.internal.abc

Class ClassGeneratorHelper

java.lang.Object

org.apache.flex.compiler.internal.abc.ClassGeneratorHelper

public class ClassGeneratorHelper
extends Object

Utility class for writing a class definition into an IABCVisitor.

After construction:

• Instance trait's can be added to the class by calling getITraitsVisitor() and visiting each trait to be added.
• Class trait's can be added to the class by calling getCTraitsVisitor() and visiting each trait to be added.
• Instance methods can be added to the class by calling addITraitsMethod(Name, Collection, Name, Collection, boolean, boolean, boolean, InstructionList) .

After all the trait's and instructions have been added to the class, either finishClass(InstructionList) or finishScript() must be called.

Constructor Summary

Constructors

Constructor and Description
ClassGeneratorHelper(ICompilerProject project, IABCVisitor visitor, Name className, ClassDefinition baseClass, Collection<Name> implementedInterfaces, Collection<Name> constructorParamTypes, InstructionList constructorInstructions, boolean hasProtectedMembers) Generate an ABC class with constructor instructions.
ClassGeneratorHelper(ICompilerProject project, IABCVisitor visitor, Name className, ClassDefinition baseClass, Collection<Name> implementedInterfaces, Collection<Name> iinitParameterTypes, InstructionList iinitInstructions, InstructionList cinitInstructions, boolean hasProtectedMembers) Constructor
ClassGeneratorHelper(ICompilerProject project, IABCVisitor visitor, Name className, ClassDefinition baseClass, Collection<Name> implementedInterfaces, InstructionList constructorInstructions) Constuctor that thunks to ClassGeneratorHelper(ICompilerProject, IABCVisitor, Name, ClassDefinition, Collection, Collection, InstructionList, boolean).
ClassGeneratorHelper(ICompilerProject project, IABCVisitor visitor, Name className, ClassDefinition baseClass, InstructionList constructorInstructions) Constuctor that thunks to ClassGeneratorHelper(ICompilerProject, IABCVisitor, Name, ClassDefinition, Collection, Collection, InstructionList, boolean).

Method Summary

Methods

Modifier and Type	Method and Description
void	addCTraitsGetter(Name getterName, Name returnType, InstructionList body) Utility method to add a static getter to the generated class.
void	addCTraitsMethod(Name methodName, Collection<Name> parameterTypes, Name returnType, Collection<Object> defaultParameterValues, boolean needsRest, InstructionList body) Utility method to add a static method to the generated class.
void	addITraitsGetter(Name getterName, Name returnType, InstructionList body) Utility method to add an instance getter to the generated class.
void	addITraitsMethod(Name methodName, Collection<Name> parameterTypes, Name returnType, Collection<Object> defaultParameterValues, boolean needsRest, boolean isFinal, boolean isOverride, InstructionList body) Utility method to add an instance method to the generated class.
void	addITraitsMethod(Name methodName, Collection<Name> parameterTypes, Name returnType, Collection<Object> defaultParameterValues, boolean needsRest, boolean isFinal, boolean isOverride, InstructionList body, int functionKindTrait) Utility method to add an instance method to the generated class.
void	addMemberVariable(Name variableName, Name type) Utility method to add a member variable to a class.
void	finishClass(InstructionList scriptInitInstructions) Generates the instructions to create the class closure and adds them to the specified InstructionList.
void	finishScript() Adds a new script to the ABC with a trait for the class closure and an init with instructions to create the class closure for the generated class.
ITraitsVisitor	getCTraitsVisitor()
ITraitsVisitor	getITraitsVisitor()
Namespace	getProtectedNamespace()
static InstructionList	returnVoid()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassGeneratorHelper

public ClassGeneratorHelper(ICompilerProject project,
                    IABCVisitor visitor,
                    Name className,
                    ClassDefinition baseClass,
                    InstructionList constructorInstructions)

Constuctor that thunks to ClassGeneratorHelper(ICompilerProject, IABCVisitor, Name, ClassDefinition, Collection, Collection, InstructionList, boolean).

Parameters:

project - A compiler project.

visitor - An ABC visitor.

className - The ABC name of the new class.

baseClass - The definition of the class being extended.

ClassGeneratorHelper

public ClassGeneratorHelper(ICompilerProject project,
                    IABCVisitor visitor,
                    Name className,
                    ClassDefinition baseClass,
                    Collection<Name> implementedInterfaces,
                    InstructionList constructorInstructions)

Constuctor that thunks to ClassGeneratorHelper(ICompilerProject, IABCVisitor, Name, ClassDefinition, Collection, Collection, InstructionList, boolean).

Parameters:

project - A compiler project.

visitor - An ABC visitor.

className - The ABC name of the new class.

baseClass - The definition of the class being extended.

implementedInterfaces - The ABC name of the interfaces being implemented.

ClassGeneratorHelper

public ClassGeneratorHelper(ICompilerProject project,
                    IABCVisitor visitor,
                    Name className,
                    ClassDefinition baseClass,
                    Collection<Name> implementedInterfaces,
                    Collection<Name> constructorParamTypes,
                    InstructionList constructorInstructions,
                    boolean hasProtectedMembers)

Generate an ABC class with constructor instructions.

See Also:

ClassGeneratorHelper(ICompilerProject, IABCVisitor, Name, ClassDefinition, Collection, Collection, InstructionList, InstructionList, boolean)

ClassGeneratorHelper

public ClassGeneratorHelper(ICompilerProject project,
                    IABCVisitor visitor,
                    Name className,
                    ClassDefinition baseClass,
                    Collection<Name> implementedInterfaces,
                    Collection<Name> iinitParameterTypes,
                    InstructionList iinitInstructions,
                    InstructionList cinitInstructions,
                    boolean hasProtectedMembers)

Constructor

Parameters:

project - ICompilerProject project for which ABC is being generated.

visitor - IABCVisitor to write the new class into.

className - Name of the class to generate

baseClass - ClassDefinition for the base class the generated class extends.

implementedInterfaces - Collection of Name's that at runtime will refer to interfaces the generated class implement.

iinitParameterTypes - Collection of Name's that at runtime will refer to the types of the constructor arguments.

iinitInstructions - Instructions for the constructor.

cinitInstructions - Instructions for the cinit() method.

hasProtectedMembers - whether or not this class has protected members There must be one returnvoid instruction.

Method Detail

returnVoid

public static InstructionList returnVoid()

Returns:

An instruction list with only one "returnvoid" instruction.

finishScript

public void finishScript()

Adds a new script to the ABC with a trait for the class closure and an init with instructions to create the class closure for the generated class.

After this method is called no other methods on this class should be called.

finishClass

public void finishClass(InstructionList scriptInitInstructions)

Generates the instructions to create the class closure and adds them to the specified InstructionList.

Parameters:

scriptInitInstructions - InstructionList to add the instructions that create the class closure to.

getITraitsVisitor

public ITraitsVisitor getITraitsVisitor()

Returns:

The ITraitsVisitor for the instance trait's of the generated class.

getCTraitsVisitor

public ITraitsVisitor getCTraitsVisitor()

Returns:

The ITraitsVisitor for the class trait's of the generated class.

addITraitsMethod

public void addITraitsMethod(Name methodName,
                    Collection<Name> parameterTypes,
                    Name returnType,
                    Collection<Object> defaultParameterValues,
                    boolean needsRest,
                    boolean isFinal,
                    boolean isOverride,
                    InstructionList body)

Utility method to add an instance method to the generated class.

Parameters:

methodName - Name of the method to add.

parameterTypes - Collection of Name's of the parameters to the method.

returnType - Name of the return type of the method.

defaultParameterValues - Collection of object's that can be converted to ABC constants for the default values of parameters.

needsRest - true if the method needs the rest parameter, false otherwise

isFinal - true if the method is final, false otherwise

isOverride - true if the method is an override of another method, false otherwise

body - An InstructionList for the body of the method.

addITraitsMethod

public void addITraitsMethod(Name methodName,
                    Collection<Name> parameterTypes,
                    Name returnType,
                    Collection<Object> defaultParameterValues,
                    boolean needsRest,
                    boolean isFinal,
                    boolean isOverride,
                    InstructionList body,
                    int functionKindTrait)

Utility method to add an instance method to the generated class.

Parameters:

methodName - Name of the method to add.

parameterTypes - Collection of Name's of the parameters to the method.

returnType - Name of the return type of the method.

defaultParameterValues - Collection of object's that can be converted to ABC constants for the default values of parameters.

needsRest - true if the method needs the rest parameter, false otherwise

isFinal - true if the method is final, false otherwise

isOverride - true if the method is an override of another method, false otherwise

body - An InstructionList for the body of the method.

functionKindTrait - One of ABCConstants, TRAIT_Method, TRAIT_Getter, TRAIT_Setter.

addCTraitsMethod

public void addCTraitsMethod(Name methodName,
                    Collection<Name> parameterTypes,
                    Name returnType,
                    Collection<Object> defaultParameterValues,
                    boolean needsRest,
                    InstructionList body)

Utility method to add a static method to the generated class.

Parameters:

methodName - Name of the method to add.

parameterTypes - Collection of Name's of the parameters to the method.

returnType - Name of the return type of the method.

defaultParameterValues - Collection of object's that can be converted to ABC constants for the default values of parameters.

needsRest - true if the method needs the rest parameter, false otherwise

body - An InstructionList for the body of the method.

addITraitsGetter

public void addITraitsGetter(Name getterName,
                    Name returnType,
                    InstructionList body)

Utility method to add an instance getter to the generated class.

Parameters:

getterName - Name of the method to add.

returnType - Name of the return type of the method.

body - An InstructionList for the body of the method.

addCTraitsGetter

public void addCTraitsGetter(Name getterName,
                    Name returnType,
                    InstructionList body)

Utility method to add a static getter to the generated class.

Parameters:

getterName - Name of the method to add.

returnType - Name of the return type of the method.

body - An InstructionList for the body of the method.

addMemberVariable

public void addMemberVariable(Name variableName,
                     Name type)

Utility method to add a member variable to a class.

Parameters:

variableName - Name of the member variable to add.

getProtectedNamespace

public Namespace getProtectedNamespace()

Returns:

protected namespace if it is asked for while creating this helper class