org.apache.flex.compiler.internal.scopes

Class MXMLFileScope

java.lang.Object

org.apache.flex.compiler.internal.scopes.ASScopeBase

org.apache.flex.compiler.internal.scopes.ASScope

org.apache.flex.compiler.internal.scopes.ASFileScope

org.apache.flex.compiler.internal.scopes.MXMLFileScope

All Implemented Interfaces:

IXMLNameResolver, IASScope, IFileScope

public class MXMLFileScope
extends ASFileScope
implements IXMLNameResolver

Subclass of ASFileScope for MXML file scopes.

It keeps track of the main MXML class definition in an MXML file scope.

It supports creating additional classes defined by <fx:Component> and <fx:Definition> tags in an MXML file.

It keeps track of the mapping from an MXML tag such as <fx:MyDefinition> to the the class defined by <fx:Definition name="MyDefinition">

It has APIs such as isScriptTag() for determining whether an MXML tag is a particular language tag, as determined by the version of MXML being used in the MXML file that created this file scope.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.scopes.ASScopeBase

ASScopeBase.FilteredCollection<T>

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.scopes.ASFileScope

compilationUnitReference, filePath, isEditableFile

Fields inherited from class org.apache.flex.compiler.internal.scopes.ASScope

EMPTY_USE_ARRAY, scopedNodeRef

Fields inherited from class org.apache.flex.compiler.internal.scopes.ASScopeBase

allNamespacesSet, definitionStore

Constructor Summary

Constructors

Constructor and Description
MXMLFileScope(MXMLCompilationUnit compilationUnit, String filePath, IMXMLData mxmlData) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ClassDefinition	addFXComponent(String mainClassQName, int componentTagStart, String componentClassName, String componentBaseClassQName) Creates a new class definition for an <fx:Component> tag and adds it to this scope.
ClassDefinition	addFXDefinition(String mainClassQName, IMXMLTagData definitionTag, String definitionName, String definitionBaseClassQName) Creates a new class definition for an <fx:Definition> tag and adds it to this scope.
void	addSourceDependency(String filename) Add a source file dependency to this file scope
ClassDefinition	getClassDefinitionForComponentTag(IMXMLTagData componentTag) Gets the ClassDefinition for a class defined by a <fx:Component> tag.
ClassDefinition	getClassDefinitionForComponentTagName(XMLName componentTagName) Gets the ClassDefinition for a class defined by a <fx:Component> tag.
ClassDefinition	getClassDefinitionForDefinitionTag(IMXMLTagData definitionTag) Gets the ClassDefinition for a class defined by a <fx:Definition> tag.
ClassDefinition	getClassDefinitionForDefinitionTagName(XMLName definitionTagName) Gets the ClassDefinition for a class defined by a <fx:Definition> tag.
IClassDefinition[]	getLibraryDefinitions() Gets the class definitions for all the <fx:Definition> tags in this scope.
XMLName[]	getLibraryDefinitionTagNames() Returns all the XMLName's that refer to <fx:Definition>'s in this file scope.
ClassDefinition	getMainClassDefinition() Returns the main class definition in this file scope.
com.google.common.collect.ImmutableSet<String>	getSourceDependencies()
boolean	isBindingTag(IMXMLTagData tag)
boolean	isComponentTag(IMXMLTagData tag)
boolean	isDeclarationsTag(IMXMLTagData tag)
boolean	isDefinitionTag(IMXMLTagData tag)
boolean	isLibraryTag(IMXMLTagData tag)
boolean	isMetadataTag(IMXMLTagData tag)
boolean	isModelTag(IMXMLTagData tag)
boolean	isPrivateTag(IMXMLTagData tag)
boolean	isReparentTag(IMXMLTagData tag)
boolean	isScriptTag(IMXMLTagData tag)
boolean	isScriptTag(IMXMLUnitData unitData)
boolean	isStringTag(IMXMLTagData tag)
boolean	isStyleTag(IMXMLTagData tag)
boolean	isXMLListTag(IMXMLTagData tag)
boolean	isXMLTag(IMXMLTagData tag)
IDefinition	resolveTagToDefinition(IMXMLTagData tag) Resolves an MXML tag such as to a class definition that the manifest information has associated with the tag.
String	resolveTagToQualifiedName(IMXMLTagData tag) Resolves an MXMLTagData to the fully qualified AS3 class name the tag refers to.
IReference	resolveTagToReference(IMXMLTagData tag) Resolves an MXMLTagData to the IReference class the tag refers to.
IDefinition	resolveXMLNameToDefinition(XMLName tagXMLName, MXMLDialect mxmlDialect) Resolves an XMLName such as to a class definition that the manifest information has associated with the tag.
String	resolveXMLNameToQualifiedName(XMLName tagName, MXMLDialect mxmlDialect) Resolves an XML name, such as ("library://ns.adobe.com/flex/spark", "Button") for an <s:Button> tag, to a fully-qualified ActionScript class name such as "spark.components.Button" that the manifest information has associated with the XML name.
void	setMainClassDefinition(ClassDefinition mainClassDefinition) Called by the MXML scope-building code to set the main class definition in this file scope.

Methods inherited from class org.apache.flex.compiler.internal.scopes.ASFileScope

addDependencyOnBuiltinType, addImplicitOpenNamespaces, addParsedFunctionBodies, collectExternallyVisibleDefinitions, getCompilationUnit, getContainingDefinition, getContainingPath, getContainingSourcePath, getFilePrivateNamespaceReference, getImplicitImportsForAS, getNode, getOffsetLookup, getWorkspace, isEditableFile, isPackageName, isSWC, namespaceSetSameAsContainingScopeNamespaceSet, removeParsedFunctionBodies, reparseFile, setCompilationUnit, setOffsetLookup, toStringHeader

Methods inherited from class org.apache.flex.compiler.internal.scopes.ASScope

addImport, addLocalImportsToNamespaceSet, addNamespaceDirective, addNamespacesFromContainingScope, addUseDirective, adjustNamespaceSetForSuper, canDelegateLookupToContainingScope, compact, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findProperty, findPropertyQualified, findPropertyQualified, findPropertyQualified, findPropertyQualified, getAllPropertiesForMemberAccess, getAllPropertiesForScopeChain, getContainingClass, getContainingScope, getContainingScopeExplicitImports, getDefinition, getExplicitImportQualifiers, getFileScope, getFirstNamespaceDirective, getImports, getNamespaceSet, getNamespaceSetForName, getNamespaceSetForSuper, getPropertiesByNameForMemberAccess, getPropertyByNameForMemberAccess, getPropertyForMemberAccess, getPropertyForMemberAccess, getPropertyForScopeChain, getPropertyFromDef, getPropertyFromDef, getQualifiedPropertyFromDef, getQualifiedPropertyFromDef, getScopeNode, getUsedNamespaces, hasAnyBindableDefinitions, isInWith, reconnectScopeNode, setAsContainingScopeOfAnonymousFunction, setContainingDefinition, setContainingScope

Methods inherited from class org.apache.flex.compiler.internal.scopes.ASScopeBase

addDefinition, addDefinitionToStore, getAllLocalDefinitions, getAllLocalDefinitionSets, getAllLocalNames, getAllLocalProperties, getLocalDefinitionSetByName, getLocalProperty, getLocalProperty, getLocalProperty, isContingentDefinitionNeeded, removeDefinition, removeDefinitionFromStore, toString, verify

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.scopes.IASScope

getAllLocalDefinitions, getAllLocalDefinitionSets, getAllLocalNames, getContainingScope, getDefinition, getLocalDefinitionSetByName, getScopeNode

Constructor Detail

MXMLFileScope

public MXMLFileScope(MXMLCompilationUnit compilationUnit,
             String filePath,
             IMXMLData mxmlData)

Constructor.

Parameters:

compilationUnit - The MXMLCompilationUnit in which the new file scope resides.

filePath - The path of the MXML file for which this file scope is being constructed.

mxmlData - The IMXMLData that built this file scope. This is used to determine which version of MXML is being used.

Method Detail

getMainClassDefinition

public ClassDefinition getMainClassDefinition()

Returns the main class definition in this file scope.

Returns:

The main class definition in this file scope.

setMainClassDefinition

public void setMainClassDefinition(ClassDefinition mainClassDefinition)

Called by the MXML scope-building code to set the main class definition in this file scope.

Parameters:

mainClassDefinition - The main class definition in this file scope.

getSourceDependencies

public com.google.common.collect.ImmutableSet<String> getSourceDependencies()

Returns:

a Collection of source files included in this file scope

addSourceDependency

public void addSourceDependency(String filename)

Add a source file dependency to this file scope

Parameters:

filename - Source dependency filename

addFXComponent

public ClassDefinition addFXComponent(String mainClassQName,
                             int componentTagStart,
                             String componentClassName,
                             String componentBaseClassQName)

Creates a new class definition for an <fx:Component> tag and adds it to this scope.

Parameters:

mainClassQName - The fully-qualified class name of the main class for the entire MXML document (e.g., "MyApp").

componentTagStart - The starting offset of the <fx:Component> tag.

componentClassName - The class name for the component, as specified by the className attribute on the <fx:Component> tag, or null if there was no such attribute.

componentBaseClassQName - The fully-qualified class name of the base class for the component class.

Returns:

The newly-added ClassDefinition for the component class.

getClassDefinitionForComponentTag

public ClassDefinition getClassDefinitionForComponentTag(IMXMLTagData componentTag)

Gets the ClassDefinition for a class defined by a <fx:Component> tag.

Parameters:

componentTag - The MXMLTagData for the <fx:Component> tag.

Returns:

The ClassDefinition associated with the <fx:Component> tag.

addFXDefinition

public ClassDefinition addFXDefinition(String mainClassQName,
                              IMXMLTagData definitionTag,
                              String definitionName,
                              String definitionBaseClassQName)

Creates a new class definition for an <fx:Definition> tag and adds it to this scope.

Parameters:

mainClassQName - The fully-qualified class name of the main class for the entire MXML document (e.g., "MyApp").

definitionTag - the MXMLTagData representing the <fx:Definition> tag

definitionName - The definition name as specified by the name attribute on the <fx:Definition> tag.

definitionBaseClassQName - The fully-qualified class name of the base class for the definition class.

Returns:

The newly-added ClassDefinition for the definition class.

resolveTagToQualifiedName

public String resolveTagToQualifiedName(IMXMLTagData tag)

Resolves an MXMLTagData to the fully qualified AS3 class name the tag refers to.

TODO This method should return a name object instead of a string.

Parameters:

tag - An MXMLTagData whose name potentially refers to a AS3 class name via manifest or <fx:Definition> tags.

Returns:

Fully qualified AS3 class name the specified tag refers to.

resolveXMLNameToQualifiedName

public String resolveXMLNameToQualifiedName(XMLName tagName,
                                   MXMLDialect mxmlDialect)

Description copied from interface: IXMLNameResolver

Resolves an XML name, such as ("library://ns.adobe.com/flex/spark", "Button") for an <s:Button> tag, to a fully-qualified ActionScript class name such as "spark.components.Button" that the manifest information has associated with the XML name.

This method handles both manifest namespaces (such as in the above example) and package namespaces such as . Note: This method should only be called when resolving a tag outside the context of an MXML file. Normally resolveTagToQualifiedName(IMXMLTagData) should be used instead.

Specified by:

resolveXMLNameToQualifiedName in interface IXMLNameResolver

Parameters:

tagName - An XMLName to resolve to a fully-qualified ActionScript class name.

mxmlDialect - The MXMLDialect of the document in which the specified XMLName was encountered.

Returns:

The qname of the ActionScript class, or null if the tag has a manifest namespace and isn't found in the MXMLManifestManager.

resolveTagToReference

public IReference resolveTagToReference(IMXMLTagData tag)

Resolves an MXMLTagData to the IReference class the tag refers to.

Parameters:

tag - An MXMLTagData whose name potentially refers to a AS3 class name via manifest or <fx:Definition> tags.

Returns:

IReference to the specified tag refers to.

resolveTagToDefinition

public IDefinition resolveTagToDefinition(IMXMLTagData tag)

Resolves an MXML tag such as to a class definition that the manifest information has associated with the tag.

This method handles both manifest namespaces (such as in the above example) and package namespaces such as .

Parameters:

tag - An MXML tag.

Returns:

The definition of the ActionScript class, or null if the tag has a manifest namespace and isn't found in the MXMLManifestManager.

resolveXMLNameToDefinition

public IDefinition resolveXMLNameToDefinition(XMLName tagXMLName,
                                     MXMLDialect mxmlDialect)

Resolves an XMLName such as to a class definition that the manifest information has associated with the tag.

This method handles both manifest namespaces (such as in the above example) and package namespaces such as .

Specified by:

resolveXMLNameToDefinition in interface IXMLNameResolver

Parameters:

tagXMLName - XMLName of a tag.

mxmlDialect - Knowledge about dialect-specific resolution strategies.

Returns:

The definition of the ActionScript class, or null if the tag has a manifest namespace and isn't found in the MXMLManifestManager.

getClassDefinitionForComponentTagName

public ClassDefinition getClassDefinitionForComponentTagName(XMLName componentTagName)

Gets the ClassDefinition for a class defined by a <fx:Component> tag.

Parameters:

componentTagName - XMLName that refers to the <fx:Component>. The name of the tag is determined by the className attribute of the <fx:Component> tag.

getClassDefinitionForDefinitionTag

public ClassDefinition getClassDefinitionForDefinitionTag(IMXMLTagData definitionTag)

Gets the ClassDefinition for a class defined by a <fx:Definition> tag.

Parameters:

definitionTag - The MXMLTagData for the <fx:Definition> tag.

Returns:

The ClassDefinition associated with the <fx:Definition> tag.

getClassDefinitionForDefinitionTagName

public ClassDefinition getClassDefinitionForDefinitionTagName(XMLName definitionTagName)

Gets the ClassDefinition for a class defined by a <fx:Definition> tag.

Parameters:

definitionTagName - XMLName that refers to the <fx:Definition>. The name of the tag is determined by the name attribute of the <fx:Definition> tag.

getLibraryDefinitions

public IClassDefinition[] getLibraryDefinitions()

Gets the class definitions for all the <fx:Definition> tags in this scope.

Returns:

The class definitions for all the <fx:Definition> tags in this scope.

getLibraryDefinitionTagNames

public XMLName[] getLibraryDefinitionTagNames()

Returns all the XMLName's that refer to <fx:Definition>'s in this file scope.

Returns:

All the XMLName's that refer to <fx:Definition>'s in this file scope.

isBindingTag

public boolean isBindingTag(IMXMLTagData tag)

isComponentTag

public boolean isComponentTag(IMXMLTagData tag)

isDeclarationsTag

public boolean isDeclarationsTag(IMXMLTagData tag)

isDefinitionTag

public boolean isDefinitionTag(IMXMLTagData tag)

isLibraryTag

public boolean isLibraryTag(IMXMLTagData tag)

isMetadataTag

public boolean isMetadataTag(IMXMLTagData tag)

isModelTag

public boolean isModelTag(IMXMLTagData tag)

isPrivateTag

public boolean isPrivateTag(IMXMLTagData tag)

isReparentTag

public boolean isReparentTag(IMXMLTagData tag)

isScriptTag

public boolean isScriptTag(IMXMLUnitData unitData)

isScriptTag

public boolean isScriptTag(IMXMLTagData tag)

isStringTag

public boolean isStringTag(IMXMLTagData tag)

isStyleTag

public boolean isStyleTag(IMXMLTagData tag)

isXMLTag

public boolean isXMLTag(IMXMLTagData tag)

isXMLListTag

public boolean isXMLListTag(IMXMLTagData tag)