org.apache.royale.compiler.internal.codegen.js.royale

Class JSRoyaleASDocEmitter

java.lang.Object

org.apache.royale.compiler.internal.codegen.as.ASEmitter

org.apache.royale.compiler.internal.codegen.js.JSEmitter

org.apache.royale.compiler.internal.codegen.js.goog.JSGoogEmitter

org.apache.royale.compiler.internal.codegen.js.royale.JSRoyaleASDocEmitter

All Implemented Interfaces:

IASEmitter, IEmitter, INestingEmitter, IJSGoogEmitter, IJSEmitter, IMappingEmitter, IJSRoyaleASDocEmitter, IJSRoyaleEmitter

public class JSRoyaleASDocEmitter
extends JSGoogEmitter
implements IJSRoyaleEmitter, IJSRoyaleASDocEmitter

Concrete implementation of the 'Royale' JavaScript production.

Author:

Michael Schmalle, Erik de Bruin

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.royale.compiler.codegen.js.IMappingEmitter

IMappingEmitter.SourceMapMapping

Field Summary

Fields

Modifier and Type	Field and Description
MXMLRoyaleASDocEmitter	mxmlEmitter

Fields inherited from class org.apache.royale.compiler.internal.codegen.js.goog.JSGoogEmitter

project, propertyNames

Fields inherited from class org.apache.royale.compiler.internal.codegen.js.JSEmitter

blockCloseEmitter, blockOpenEmitter, catchEmitter, doWhileLoopEmitter, dynamicAccessEmitter, forLoopEmitter, functionCallArgumentsEmitter, ifEmitter, interationFlowEmitter, languageIdentifierEmitter, literalContainerEmitter, memberKeywordEmitter, numericLiteralEmitter, objectLiteralValuePairEmitter, parameterEmitter, parametersEmitter, returnEmitter, sourceMapDirectiveEmitter, statementEmitter, switchEmitter, ternaryOperatorEmitter, throwEmitter, tryEmitter, unaryOperatorEmitter, whileLoopEmitter, withEmitter

Constructor Summary

Constructors

Constructor and Description
JSRoyaleASDocEmitter(FilterWriter out)

Method Summary

Modifier and Type	Method and Description
String	convertASTypeToJS(String name)
void	emitAccessors(IAccessorNode node)
void	emitClass(IClassNode node) Emit a Class.
void	emitField(IVariableNode node) Emit a full Class field member.
void	emitGetAccessor(IGetterNode node) Emit a full Class getter member.
void	emitInterface(IInterfaceNode node) Emit an Interface.
void	emitMethod(IFunctionNode node) Emit a full Class or Interface method member.
void	emitNamespace(INamespaceNode node) Emit a namespace member.
void	emitPackageFooter(IPackageDefinition definition)
void	emitPackageHeader(IPackageDefinition definition)
void	emitPackageHeaderContents(IPackageDefinition definition)
void	emitSetAccessor(ISetterNode node) Emit a full Class setter member.
void	emitVarDeclaration(IVariableNode node) Emit a variable declaration found in expression statements within scoped blocks.
String	formatQualifiedName(String name)
String	formatQualifiedName(String name, boolean isDoc)
protected String	getIndent(int numIndent)
boolean	hasCommentaryTags(ASDocComment asDoc)
void	outputClasses(File outputFolder, RoyaleASDocProject project) Outputs the class list.
void	outputIndex(File outputFolder, RoyaleASDocProject project) Outputs the index.
void	outputTags(File outputFolder, RoyaleASDocProject project) Outputs the set of asdoc tags.
String	postProcess(String output)
void	writeASDoc(ASDocComment asDoc, RoyaleASDocProject project)
void	writeCommentaryFile(BufferedWriter commentaryWriter, String qname, ASDocComment asDoc)
void	writeDefinitionAttributes(IDefinition def)
void	writeEventTagNode(IMetaTagNode node)
protected void	writeIndent()

Methods inherited from class org.apache.royale.compiler.internal.codegen.js.goog.JSGoogEmitter

emitAsOperator, emitAssignedValue, emitBinaryOperator, emitClosureEnd, emitClosureStart, emitContainer, emitDefaultParameterCodeBlock, emitDefinePropertyFunction, emitForEachLoop, emitFunctionBlockHeader, emitFunctionCall, emitIdentifier, emitIsOperator, emitNamespaceAccessExpression, emitObjectDefineProperty, emitPackageContents, emitRestParameterCodeBlock, emitSelfReference, emitSuperCall, getDocEmitter

Methods inherited from class org.apache.royale.compiler.internal.codegen.js.JSEmitter

addLineToMappings, emitArguments, emitAssignmentCoercion, emitBlockClose, emitBlockOpen, emitCatch, emitClosureEnd, emitClosureStart, emitDoLoop, emitDynamicAccess, emitForLoop, emitFunctionObject, emitIf, emitImport, emitIterationFlow, emitLanguageIdentifier, emitLiteralContainer, emitLocalNamedFunction, emitMemberKeyword, emitNumericLiteral, emitObjectLiteralValuePair, emitParameter, emitParameters, emitReturn, emitSourceMapDirective, emitStatement, emitSwitch, emitTernaryOperator, emitThrow, emitTry, emitTypedExpression, emitUnaryOperator, emitWhileLoop, emitWith, endMapping, formatPrivateName, formatPrivateName, getGeneratedTypeCheck, getModel, getSourceMapMappings, removeLineFromMappings, startMapping, startMapping, startMapping

Methods inherited from class org.apache.royale.compiler.internal.codegen.as.ASEmitter

emitAccessorKeyword, emitDeclarationName, emitE4XDefaultNamespaceDirective, emitE4XFilter, emitEmbed, emitFieldDocumentation, emitFunctionScope, emitGetAccessorDocumentation, emitKeyword, emitLabelStatement, emitLiteral, emitMemberAccessExpression, emitMemberName, emitMetaTag, emitMethodDocumentation, emitMethodScope, emitModifiers, emitNamespaceIdentifier, emitSetAccessorDocumentation, emitType, emitUseNamespace, emitVariableExpression, findType, findTypeNode, flushBuilder, getBuilder, getConstructor, getCurrentColumn, getCurrentIndent, getCurrentLine, getParentEmitter, getProblems, getWalker, indentPop, indentPush, isBufferWrite, isImplicit, isLastStatement, setBufferWrite, setBuilder, setDocEmitter, setParentEmitter, setWalker, stringifyNode, visitForBody, write, write, writeNewline, writeNewline, writeNewline, writeNewline, writeNewline, writeSymbol, writeToken, writeToken

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.royale.compiler.codegen.js.IJSEmitter

emitAssignmentCoercion, emitClosureEnd, emitClosureStart, emitSourceMapDirective, formatPrivateName, formatPrivateName, getGeneratedTypeCheck, getModel

Methods inherited from interface org.apache.royale.compiler.codegen.as.IASEmitter

emitArguments, emitAsOperator, emitBinaryOperator, emitBlockClose, emitBlockOpen, emitCatch, emitContainer, emitDoLoop, emitDynamicAccess, emitE4XDefaultNamespaceDirective, emitE4XFilter, emitEmbed, emitFieldDocumentation, emitForEachLoop, emitForLoop, emitFunctionBlockHeader, emitFunctionCall, emitFunctionObject, emitGetAccessorDocumentation, emitIdentifier, emitIf, emitImport, emitIsOperator, emitIterationFlow, emitKeyword, emitLabelStatement, emitLanguageIdentifier, emitLiteral, emitLiteralContainer, emitLocalNamedFunction, emitMemberAccessExpression, emitMetaTag, emitMethodDocumentation, emitNamespaceAccessExpression, emitNumericLiteral, emitObjectLiteralValuePair, emitPackageContents, emitParameter, emitReturn, emitSetAccessorDocumentation, emitStatement, emitSwitch, emitTernaryOperator, emitThrow, emitTry, emitTypedExpression, emitUnaryOperator, emitUseNamespace, emitVariableExpression, emitWhileLoop, emitWith, getDocEmitter, getWalker, setDocEmitter, setWalker

Methods inherited from interface org.apache.royale.compiler.codegen.INestingEmitter

getParentEmitter, setParentEmitter

Methods inherited from interface org.apache.royale.compiler.codegen.IEmitter

indentPop, indentPush, stringifyNode, write, write, writeNewline, writeNewline, writeNewline, writeNewline, writeNewline, writeToken, writeToken

Methods inherited from interface org.apache.royale.compiler.codegen.js.IMappingEmitter

endMapping, getSourceMapMappings, startMapping, startMapping, startMapping

Field Detail

mxmlEmitter

public MXMLRoyaleASDocEmitter mxmlEmitter

Constructor Detail

JSRoyaleASDocEmitter

public JSRoyaleASDocEmitter(FilterWriter out)

Method Detail

postProcess

public String postProcess(String output)

Specified by:

postProcess in interface IASEmitter

Overrides:

postProcess in class ASEmitter

writeIndent

protected void writeIndent()

Overrides:

writeIndent in class ASEmitter

getIndent

protected String getIndent(int numIndent)

Overrides:

getIndent in class ASEmitter

emitNamespace

public void emitNamespace(INamespaceNode node)

Description copied from interface: IASEmitter

Emit a namespace member.

Specified by:

emitNamespace in interface IASEmitter

Overrides:

emitNamespace in class ASEmitter

Parameters:

node - The INamespaceNode class member.

formatQualifiedName

public String formatQualifiedName(String name)

Specified by:

formatQualifiedName in interface IJSEmitter

Overrides:

formatQualifiedName in class JSGoogEmitter

formatQualifiedName

public String formatQualifiedName(String name,
                                  boolean isDoc)

convertASTypeToJS

public String convertASTypeToJS(String name)

emitPackageHeader

public void emitPackageHeader(IPackageDefinition definition)

Specified by:

emitPackageHeader in interface IASEmitter

Overrides:

emitPackageHeader in class JSGoogEmitter

emitPackageHeaderContents

public void emitPackageHeaderContents(IPackageDefinition definition)

Specified by:

emitPackageHeaderContents in interface IASEmitter

Overrides:

emitPackageHeaderContents in class JSGoogEmitter

emitPackageFooter

public void emitPackageFooter(IPackageDefinition definition)

Specified by:

emitPackageFooter in interface IASEmitter

Overrides:

emitPackageFooter in class JSGoogEmitter

emitClass

public void emitClass(IClassNode node)

Description copied from interface: IASEmitter

Emit a Class.

Specified by:

emitClass in interface IASEmitter

Overrides:

emitClass in class JSGoogEmitter

Parameters:

node - The IClassNode class.

emitInterface

public void emitInterface(IInterfaceNode node)

Description copied from interface: IASEmitter

Emit an Interface.

Specified by:

emitInterface in interface IASEmitter

Overrides:

emitInterface in class JSGoogEmitter

Parameters:

node - The IInterfaceNode class.

emitGetAccessor

public void emitGetAccessor(IGetterNode node)

Description copied from interface: IASEmitter

Emit a full Class getter member.

Specified by:

emitGetAccessor in interface IASEmitter

Overrides:

emitGetAccessor in class JSGoogEmitter

Parameters:

node - The IVariableNode class getter member.

emitSetAccessor

public void emitSetAccessor(ISetterNode node)

Description copied from interface: IASEmitter

Emit a full Class setter member.

Specified by:

emitSetAccessor in interface IASEmitter

Overrides:

emitSetAccessor in class JSGoogEmitter

Parameters:

node - The ISetterNode class setter member.

emitField

public void emitField(IVariableNode node)

Description copied from interface: IASEmitter

Emit a full Class field member.

Specified by:

emitField in interface IASEmitter

Overrides:

emitField in class JSGoogEmitter

Parameters:

node - The IVariableNode class field member.

emitVarDeclaration

public void emitVarDeclaration(IVariableNode node)

Description copied from interface: IASEmitter

Emit a variable declaration found in expression statements within scoped blocks.

Specified by:

emitVarDeclaration in interface IASEmitter

Overrides:

emitVarDeclaration in class JSGoogEmitter

Parameters:

node - The IVariableNode or chain of variable nodes.

emitAccessors

public void emitAccessors(IAccessorNode node)

Overrides:

emitAccessors in class JSGoogEmitter

emitMethod

public void emitMethod(IFunctionNode node)

Description copied from interface: IASEmitter

Emit a full Class or Interface method member.

Specified by:

emitMethod in interface IASEmitter

Overrides:

emitMethod in class JSGoogEmitter

Parameters:

node - The IFunctionNode class method member.

writeASDoc

public void writeASDoc(ASDocComment asDoc,
                       RoyaleASDocProject project)

writeDefinitionAttributes

public void writeDefinitionAttributes(IDefinition def)

writeEventTagNode

public void writeEventTagNode(IMetaTagNode node)

outputIndex

public void outputIndex(File outputFolder,
                        RoyaleASDocProject project)
                 throws IOException

Description copied from interface: IJSRoyaleASDocEmitter

Outputs the index.

Specified by:

outputIndex in interface IJSRoyaleASDocEmitter

Throws:

IOException

hasCommentaryTags

public boolean hasCommentaryTags(ASDocComment asDoc)

writeCommentaryFile

public void writeCommentaryFile(BufferedWriter commentaryWriter,
                                String qname,
                                ASDocComment asDoc)
                         throws IOException

Throws:

IOException

outputClasses

public void outputClasses(File outputFolder,
                          RoyaleASDocProject project)
                   throws IOException

Description copied from interface: IJSRoyaleASDocEmitter

Outputs the class list.

Specified by:

outputClasses in interface IJSRoyaleASDocEmitter

Throws:

IOException

outputTags

public void outputTags(File outputFolder,
                       RoyaleASDocProject project)
                throws IOException

Description copied from interface: IJSRoyaleASDocEmitter

Outputs the set of asdoc tags.

Specified by:

outputTags in interface IJSRoyaleASDocEmitter

Throws:

IOException