org.apache.flex.compiler.internal.tree.mxml

Class MXMLNodeBase

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.tree.as.NodeBase

org.apache.flex.compiler.internal.tree.mxml.MXMLNodeBase

All Implemented Interfaces:

ISourceLocation, IASNode, IMXMLNode

Direct Known Subclasses:

MXMLClassDefinitionNode, MXMLFileNode, MXMLRepeaterNode

public abstract class MXMLNodeBase
extends NodeBase
implements IMXMLNode

MXMLNodeBase is the abstract base class for all MXML nodes in an AST.

Although the MXML node interfaces (i.e., IMXMLNode and its subinterfaces) support only read-only operations on the MXML AST, the MXML node class contain the logic for building the tree node-by-node from the MXML DOM.

For example, the processing of the <Script> tag is handled by the MXMLScriptNode class, which encapsulates the logic that a <Script> tag can only have namespace attributes and a source attribute, and that it cannot have any child tags.

This base class handles some analysis that must be done on every kind of MXML tag:

• Walking the tag's attributes and its child units.
• Noticing whether a namespace attribute defines an illegal language namespace.
• Noticing whether any tag or attribute uses an illegal language namespace.
• Noticing any private attributes. We will report a problem for these, since developers who don't use them may prefer to catch them as warnings.

Problems at the level of incorrect XML are noticed before tree construction, during MXML parsing. Such problems include:

• Using an undefined prefix on a tag or attribute.
• Using an unrecognized entity.

The default behavior implemented in this base class reports a problem for every attribute (except for namespace and private ones) and every non-whitespace text unit. In other words, by default it implements "you can't put that here". It is the responsibility then of subclasses to allow particular attributes and content units rather than disallow them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MXMLNodeBase.MXMLNodeInfo MXML node classes can choose to create this object in createNodeInfo().

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

emptyNodeArray, parent

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
protected void	accumulateTextFragments(MXMLTreeBuilder builder, IMXMLTextData text, MXMLNodeBase.MXMLNodeInfo info) Accumulates source fragments that are produced by a text unit for later processing.
void	adjustOffsets(MXMLTreeBuilder builder) Translates the node's start and end offset from local to absolute offsets.
protected MXMLNodeBase.MXMLNodeInfo	createNodeInfo(MXMLTreeBuilder builder)
IASNode	getChild(int i) Get a particular child of this node
int	getChildCount() Get the number of children
IMXMLClassDefinitionNode	getClassDefinitionNode() Gets the closest ancestor node that defines a class.
IMXMLDocumentNode	getDocumentNode() Gets the closest ancestor node that is the root node of the MXML file.
IMXMLFileNode	getFileNode() Gets the root file node.
protected void	initializationComplete(MXMLTreeBuilder builder, IMXMLTagData tag, MXMLNodeBase.MXMLNodeInfo info) This method gives subclasses a chance to do final processing after considering each attribute and content unit.
protected void	initializeFromTag(MXMLTreeBuilder builder, IMXMLTagData tag) Initializes this MXML node from an MXML tag by processing the attribute and content units of the tag.
protected static boolean	isValidASIdentifier(String identifier) Determines whether the specified String is a single valid ActionScript identifier, by tokenizing it.
boolean	isValidForCodeGen() Indicates whether code should be generated for this node.
protected static boolean	isValidXMLTagName(String tagName) Determines whether the specified String is a valid XML tag name by appending it to "<" and tokenizing it.
protected void	processChildNonWhitespaceUnit(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTextData text, MXMLNodeBase.MXMLNodeInfo info) Processes a single child text unit which is not all whitespace.
protected void	processChildTag(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTagData childTag, MXMLNodeBase.MXMLNodeInfo info) Processes a single child tag.
protected void	processChildWhitespaceUnit(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTextData text, MXMLNodeBase.MXMLNodeInfo info) Processes a single child text unit which is all whitespace.
protected String[]	processIncludeInOrExcludeFromAttribute(MXMLTreeBuilder builder, IMXMLTagAttributeData attribute) Processes an includeIn="..."
protected void	processTagSpecificAttribute(MXMLTreeBuilder builder, IMXMLTagData tag, IMXMLTagAttributeData attribute, MXMLNodeBase.MXMLNodeInfo info) Processes a single tag-specific attribute (i.e., one that isn't allowed on every tag, unlike a namespace attribute or a private attribute).
static List<ScopedBlockNode>	processUnitAsAS(MXMLTreeBuilder builder, IMXMLTagData tag, String sourcePath, ASScope containingScope, PostProcessStep buildOrReconnect, IMXMLFileNode ancestorFileNode) Processes all the children of the given IMXMLTagData unit that are IMXMLTextData nodes.
static String	resolveSourceAttributePath(MXMLTreeBuilder builder, IMXMLTagAttributeData attribute, MXMLNodeBase.MXMLNodeInfo info) Resolves the path specified in an MXML tag's source attribute.
protected void	setLocation(IMXMLTagAttributeData attribute) Sets the start/end/line/column location information for this node.
protected void	setLocation(IMXMLUnitData unit) Sets the start/end/line/column location information for this node.
void	setLocation(ISourceLocation location) Sets the start/end/line/column location information for this node.
protected void	setLocation(MXMLTreeBuilder builder, List<IMXMLUnitData> units) Sets the start/end/line/column location information for this node so that it spans a list of MXML content units.
void	setLocation(String sourcePath, int start, int end, int line, int column) Sets the start/end/line/column location information for this node.

Methods inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

analyze, buildInnerString, buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getASScope, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getFileSpecification, getInnerString, getNodeKind, getPackageName, getParent, getScopeNode, getSpanningStart, getStart, getSucceedingNode, getWorkspace, isTerminal, isTransparent, looselyContains, normalize, replaceChild, runPostProcess, setChildren, setParent, span, span, span, startAfter, startAfter, startBefore, startBefore, swapChildren, toString, tryGetOffsetLookup, verify

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getColumn, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flex.compiler.tree.mxml.IMXMLNode

getName

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

contains, getAncestorOfType, getContainingNode, getContainingScope, getFileSpecification, getNodeID, getPackageName, getParent, getSpanningStart, getSucceedingNode, isTerminal

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Method Detail

resolveSourceAttributePath

public static String resolveSourceAttributePath(MXMLTreeBuilder builder,
                                IMXMLTagAttributeData attribute,
                                MXMLNodeBase.MXMLNodeInfo info)

Resolves the path specified in an MXML tag's source attribute.

Parameters:

builder - The MXMLTreeBuilder object which is building this MXML tree.

attribute - The source attribute.

Returns:

A resolved and normalized path to the external file.

isValidASIdentifier

protected static boolean isValidASIdentifier(String identifier)

Determines whether the specified String is a single valid ActionScript identifier, by tokenizing it.

Parameters:

identifier - A String to be tokenized.

Returns:

true if the String tokenizes to a single identifier token.

isValidXMLTagName

protected static boolean isValidXMLTagName(String tagName)

Determines whether the specified String is a valid XML tag name by appending it to "<" and tokenizing it.

Parameters:

tagName - A String proposed as a tag name.

Returns:

true if the String is a valid tag name.

isValidForCodeGen

public boolean isValidForCodeGen()

Description copied from interface: IMXMLNode

Indicates whether code should be generated for this node.

If this method returns false, there is something invalid about this node, or one of its descendants, that prevents code generation.

Specified by:

isValidForCodeGen in interface IMXMLNode

initializeFromTag

protected void initializeFromTag(MXMLTreeBuilder builder,
                     IMXMLTagData tag)

Initializes this MXML node from an MXML tag by processing the attribute and content units of the tag. This processing sets the properties of this node and creates the children of this node. The child nodes will themselves be initialized from attributes or child tags; in this way, the MXML AST will get constructed from the MXML DOM.

Parameters:

builder - The MXMLTreeBuilder object which is building this MXML tree.

tag - The MXML tag from which this MXML node is being created.

createNodeInfo

protected MXMLNodeBase.MXMLNodeInfo createNodeInfo(MXMLTreeBuilder builder)

initializationComplete

protected void initializationComplete(MXMLTreeBuilder builder,
                          IMXMLTagData tag,
                          MXMLNodeBase.MXMLNodeInfo info)

This method gives subclasses a chance to do final processing after considering each attribute and content unit.

The base class version calls adjustOffset to translate the node start and end offset from local to absolute offsets.

adjustOffsets

public void adjustOffsets(MXMLTreeBuilder builder)

Translates the node's start and end offset from local to absolute offsets.

getChild

public IASNode getChild(int i)

Description copied from interface: IASNode

Get a particular child of this node

Specified by:

getChild in interface IASNode

Overrides:

getChild in class NodeBase

Parameters:

i - the child's index

Returns:

the specified child

getChildCount

public int getChildCount()

Description copied from interface: IASNode

Get the number of children

Specified by:

getChildCount in interface IASNode

Overrides:

getChildCount in class NodeBase

Returns:

the number of children

getClassDefinitionNode

public IMXMLClassDefinitionNode getClassDefinitionNode()

Description copied from interface: IMXMLNode

Gets the closest ancestor node that defines a class.

Specified by:

getClassDefinitionNode in interface IMXMLNode

Returns:

An IMXMLClassDefinitionNode object.

getDocumentNode

public IMXMLDocumentNode getDocumentNode()

Description copied from interface: IMXMLNode

Gets the closest ancestor node that is the root node of the MXML file.

Specified by:

getDocumentNode in interface IMXMLNode

Returns:

An IMXMLDocumentNode object.

getFileNode

public IMXMLFileNode getFileNode()

Description copied from interface: IMXMLNode

Gets the root file node.

Specified by:

getFileNode in interface IMXMLNode

Returns:

An IOldMXMLFileNode object.

processTagSpecificAttribute

protected void processTagSpecificAttribute(MXMLTreeBuilder builder,
                               IMXMLTagData tag,
                               IMXMLTagAttributeData attribute,
                               MXMLNodeBase.MXMLNodeInfo info)

Processes a single tag-specific attribute (i.e., one that isn't allowed on every tag, unlike a namespace attribute or a private attribute).

The attribute might be specifying a property, event, or style; or it might be a special compile-time attribute such as 'id', 'includeIn', 'excludeFrom', 'source', etc. A property/event/style attribute will cause a child node to be added to this node; a compile-time attribute typically will simply set a property of the node.

The default behavior implemented in this base class is to report each tag-specific attribute as a problem.

Subclasses must override this method in order to allow tag-specific attributes.

Parameters:

attribute - An MXMLTagAttributeData object representing the attribute.

processChildTag

protected void processChildTag(MXMLTreeBuilder builder,
                   IMXMLTagData tag,
                   IMXMLTagData childTag,
                   MXMLNodeBase.MXMLNodeInfo info)

Processes a single child tag.

Parameters:

tag - An MXMLTagData object representing the child tag.

The default behavior implemented in this base class is to report each child tag as a problem.

Subclasses must override this method in order to allow the child tags that they recognize.

processChildWhitespaceUnit

protected void processChildWhitespaceUnit(MXMLTreeBuilder builder,
                              IMXMLTagData tag,
                              IMXMLTextData text,
                              MXMLNodeBase.MXMLNodeInfo info)

Processes a single child text unit which is all whitespace.

The default behavior implemented in this base class is to ignore whitespace.

Subclasses must override this method in order to disallow whitespace text units.

Parameters:

text - An MXMLTextData object representing the child text unit.

processChildNonWhitespaceUnit

protected void processChildNonWhitespaceUnit(MXMLTreeBuilder builder,
                                 IMXMLTagData tag,
                                 IMXMLTextData text,
                                 MXMLNodeBase.MXMLNodeInfo info)

Processes a single child text unit which is not all whitespace.

The default behavior implemented in this base class is to report each unit of non-whitespace as a problem.

Subclasses must override this method in order to allow the non-whitespace text unit.

Parameters:

text - An MXMLTextData object representing the child text unit.

processUnitAsAS

public static List<ScopedBlockNode> processUnitAsAS(MXMLTreeBuilder builder,
                                    IMXMLTagData tag,
                                    String sourcePath,
                                    ASScope containingScope,
                                    PostProcessStep buildOrReconnect,
                                    IMXMLFileNode ancestorFileNode)

Processes all the children of the given IMXMLTagData unit that are IMXMLTextData nodes. Each node will be processes separately, in the order in which the appear in the document.

This method is only used by MXML AST building. To parse an ActionScript block for scope building, see MXMLScopeBuilder.processScriptTag(org.apache.flex.compiler.mxml.IMXMLTagData).

Parameters:

tag - the IMXMLTagData to process

Returns:

a List of ScopedBlockNodes for each IMXMLTextData we encountered.

setLocation

public void setLocation(String sourcePath,
               int start,
               int end,
               int line,
               int column)

Sets the start/end/line/column location information for this node.

Parameters:

start - The starting offset of this node.

end - The ending offset of this node.

line - The number of the line on which this node starts.

column - This number of the column at which this node starts.

setLocation

public void setLocation(ISourceLocation location)

Sets the start/end/line/column location information for this node.

Parameters:

location - A SourceLocation object.

setLocation

protected void setLocation(IMXMLUnitData unit)

Sets the start/end/line/column location information for this node.

Parameters:

unit - The MXML unit from which this node was created.

setLocation

protected void setLocation(IMXMLTagAttributeData attribute)

Sets the start/end/line/column location information for this node.

Parameters:

attribute - The MXML attribute from which this node was created.

setLocation

protected void setLocation(MXMLTreeBuilder builder,
               List<IMXMLUnitData> units)

Sets the start/end/line/column location information for this node so that it spans a list of MXML content units.

Parameters:

units - A list of MXML content units.

accumulateTextFragments

protected void accumulateTextFragments(MXMLTreeBuilder builder,
                           IMXMLTextData text,
                           MXMLNodeBase.MXMLNodeInfo info)

Accumulates source fragments that are produced by a text unit for later processing.

processIncludeInOrExcludeFromAttribute

protected String[] processIncludeInOrExcludeFromAttribute(MXMLTreeBuilder builder,
                                              IMXMLTagAttributeData attribute)

Processes an includeIn="..." or excludeFrom"..." attribute on an instance tag or a <Reparent> tag.