org.apache.flex.compiler.internal.mxml

Class MXMLData

java.lang.Object

org.apache.flex.compiler.internal.mxml.MXMLData

All Implemented Interfaces:

IMXMLData

public class MXMLData
extends Object
implements IMXMLData

Encapsulation of an MXML file, with individual units for each open tag, close tag, and block of text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MXMLData.Cursor A cursor represents the offset into the document and the index of the MXML unit that contains that offset

Constructor Summary

Constructors

Constructor and Description
MXMLData(IFileSpecification specification) Constructor
MXMLData(int startOffset, Reader mxmlText, IFileSpecification fileSpec) Constructor
MXMLData(int startOffset, Reader mxmlText, String path, boolean fullContent) Constructor
MXMLData(List<MXMLToken> tokens, PrefixMap map, IFileSpecification fileSpec) Constructor
MXMLData(List<MXMLToken> tokens, PrefixMap map, IFileSpecification fileSpec, boolean shouldRepair)
MXMLData(Reader mxmlText, IFileSpecification fileSpec)
MXMLData(Reader mxmlText, String path)

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	contains(int start, int end, int offset) Test whether the offset is contained within the range from start to end.
IMXMLTagData	findAttributeListContainingOffset(int offset) Get the open or empty tag whose attribute list contains this offset.
IMXMLUnitData	findContainmentReferenceUnit(int offset) Get the unit that should be referenced when looking at what tags contain this offset (i.e. tags that are opened and not closed before this offset)
protected IMXMLUnitData	findNearestUnit(int offset) If the offset is contained within an MXML unit, get that unit.
IMXMLTagData	findTagContainingOffset(int offset) Get the open, close, or empty tag that contains this offset.
IMXMLTagData	findTagOrSurroundingTagContainingOffset(int offset) Similar to findTagContainingOffset, but if the unit inside offset is a text node, will return the surrounding tag instead.
IMXMLUnitData	findUnitContainingOffset(int offset) Get the unit that contains this offset
MXMLData.Cursor	getCursor()
PrefixMap	getDocumentPrefixMap() Returns a collection of prefix->namespaces mappings found within this document.
int	getEnd() Gets the ending offset of the last unit.
IFileSpecification	getFileSpecification() Gets the file on disk that created this MXMLData.
MXMLDialect	getMXMLDialect() Gets the MXML dialect being used.
int	getNumUnits() Gets the number of MXML "units".
String	getPath() Gets the path to the file on disk that created this MXMLData.
PrefixMap	getPrefixMapForData(IMXMLTagData data) Returns the PrefixMap for the given IMXMLTagData.
Collection<ICompilerProblem>	getProblems() Gets the compiler problems found during the creation of this MXMLData.
static PrefixMap	getRootNamespaces(Reader reader) Get the namespaces defined on the root tag
IMXMLTagData	getRootTag() Gets the root tag.
PrefixMap	getRootTagPrefixMap() Returns the PrefixMap for the root tag of this MXMLData object
Map<IMXMLTagData,PrefixMap>	getTagToPrefixMap()
protected org.apache.flex.compiler.internal.mxml.MXMLData.TokenizerPayload	getTokens(int startOffset, Reader reader)
protected org.apache.flex.compiler.internal.mxml.MXMLData.TokenizerPayload	getTokens(Reader reader)
IMXMLUnitData	getUnit(int i) Gets an MXML unit by index.
Iterator<IMXMLUnitData>	getUnitIterator()
IMXMLUnitData[]	getUnits() Get the MXML units found in this IMXMLData.
boolean	hasProblems()
protected void	initializeFromTokens(List<MXMLToken> tokens) Common code from the two constructors
boolean	isDataRepaired() Determines if this data was built from a source that was repaired
static void	main(String[] args)
void	refreshPositionData() Used to rebuild the structures inside of the MXMLData, refreshing prefix maps, depth and position data.
void	setPath(String path) API to change the path after MXMLData creation.
void	setPrefixMappings(HashMap<IMXMLTagData,PrefixMap> map)
void	setUnits(IMXMLUnitData[] units) Replace the list of units in this MXMLData.
void	setWasRepaired(boolean wasRepaired)
String	toString() For debugging only.
void	updateMXMLVersion(PrefixMap map) Update the version of the mxml data
boolean	verify() Verifies that all units (plus all attributes on units that are tags) have their source location information set.

Methods inherited from class java.lang.Object

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

Constructor Detail

MXMLData

public MXMLData(List<MXMLToken> tokens,
        PrefixMap map,
        IFileSpecification fileSpec)

Constructor

Parameters:

tokens - MXML tokens to build the MXMLData object from

map - the PrefixMap for the document, containing the namespace/prefix mappings

MXMLData

public MXMLData(List<MXMLToken> tokens,
        PrefixMap map,
        IFileSpecification fileSpec,
        boolean shouldRepair)

MXMLData

public MXMLData(int startOffset,
        Reader mxmlText,
        IFileSpecification fileSpec)

Constructor

Parameters:

mxmlText - input build our MXMLData from

MXMLData

public MXMLData(int startOffset,
        Reader mxmlText,
        String path,
        boolean fullContent)

Constructor

Parameters:

mxmlText - input build our MXMLData from

MXMLData

public MXMLData(Reader mxmlText,
        IFileSpecification fileSpec)

MXMLData

public MXMLData(Reader mxmlText,
        String path)

MXMLData

public MXMLData(IFileSpecification specification)

Constructor

Parameters:

specification - input build our MXMLData from

Method Detail

updateMXMLVersion

public void updateMXMLVersion(PrefixMap map)

Update the version of the mxml data

Parameters:

map - the prefix map

getRootNamespaces

public static PrefixMap getRootNamespaces(Reader reader)
                                   throws IOException

Get the namespaces defined on the root tag

Parameters:

reader - The reader which would provide the root tag information

Returns:

PrefixMap for the root tag

Throws:

IOException - error

getTokens

protected org.apache.flex.compiler.internal.mxml.MXMLData.TokenizerPayload getTokens(Reader reader)

getTokens

protected org.apache.flex.compiler.internal.mxml.MXMLData.TokenizerPayload getTokens(int startOffset,
                                                                         Reader reader)

getMXMLDialect

public MXMLDialect getMXMLDialect()

Description copied from interface: IMXMLData

Gets the MXML dialect being used.

Specified by:

getMXMLDialect in interface IMXMLData

Returns:

An MXMLDialect.

getPrefixMapForData

public PrefixMap getPrefixMapForData(IMXMLTagData data)

Description copied from interface: IMXMLData

Returns the PrefixMap for the given IMXMLTagData. This will not walk up the chain of prefix maps if this tag does not physically have uri->namespace mappings.

Specified by:

getPrefixMapForData in interface IMXMLData

Parameters:

data - the IMXMLTagData to find the PrefixMap for

Returns:

a PrefixMap or null

setPrefixMappings

public void setPrefixMappings(HashMap<IMXMLTagData,PrefixMap> map)

getTagToPrefixMap

public Map<IMXMLTagData,PrefixMap> getTagToPrefixMap()

getDocumentPrefixMap

public PrefixMap getDocumentPrefixMap()

Returns a collection of prefix->namespaces mappings found within this document. This map DOES NOT maintain order, and for more fine-grained information, the getPrefixMap call on individual IMXMLTagData and IMXMLTagAttributeData objects should be called

Returns:

a prefix map

getRootTagPrefixMap

public PrefixMap getRootTagPrefixMap()

Returns the PrefixMap for the root tag of this MXMLData object

Returns:

a PrefixMap or null

getProblems

public Collection<ICompilerProblem> getProblems()

Description copied from interface: IMXMLData

Gets the compiler problems found during the creation of this MXMLData.

Specified by:

getProblems in interface IMXMLData

Returns:

A collection of ICompilerProblem objects.

hasProblems

public boolean hasProblems()

isDataRepaired

public boolean isDataRepaired()

Determines if this data was built from a source that was repaired

Returns:

true if the underlying source was repaired

setWasRepaired

public void setWasRepaired(boolean wasRepaired)

getFileSpecification

public IFileSpecification getFileSpecification()

Description copied from interface: IMXMLData

Gets the file on disk that created this MXMLData.

Specified by:

getFileSpecification in interface IMXMLData

Returns:

The file as an IFileSpecification.

getPath

public String getPath()

Description copied from interface: IMXMLData

Gets the path to the file on disk that created this MXMLData.

Specified by:

getPath in interface IMXMLData

Returns:

The path as a String.

setPath

public void setPath(String path)

API to change the path after MXMLData creation. An MXMLDocument makes an MXMLData before the actual location is known.

Parameters:

path - is the absolute path to the backing source file

initializeFromTokens

protected void initializeFromTokens(List<MXMLToken> tokens)

Common code from the two constructors

Parameters:

tokens - A list of MXML tokens.

refreshPositionData

public void refreshPositionData()

Used to rebuild the structures inside of the MXMLData, refreshing prefix maps, depth and position data. Should only be used after calls that rebuild the internal structure are called

getUnits

public IMXMLUnitData[] getUnits()

Description copied from interface: IMXMLData

Get the MXML units found in this IMXMLData.

Specified by:

getUnits in interface IMXMLData

Returns:

An array of the IMXMLUnitData.

getUnitIterator

public Iterator<IMXMLUnitData> getUnitIterator()

setUnits

public void setUnits(IMXMLUnitData[] units)

Replace the list of units in this MXMLData.

Parameters:

units - units to add

getUnit

public IMXMLUnitData getUnit(int i)

Description copied from interface: IMXMLData

Gets an MXML unit by index.

Specified by:

getUnit in interface IMXMLData

Parameters:

i - The index into the list of MXML units.

Returns:

The specified MXML unit, or null if the index is out of range.

getNumUnits

public int getNumUnits()

Description copied from interface: IMXMLData

Gets the number of MXML "units".

Each unit represents an open tag, a close tag, a block of text, etc.

Specified by:

getNumUnits in interface IMXMLData

Returns:

The number of MXMLUnitData objects you can retrieve with getUnit().

findNearestUnit

protected IMXMLUnitData findNearestUnit(int offset)

If the offset is contained within an MXML unit, get that unit. If it's not, then get the first unit that follows the offset.

Parameters:

offset - test offset

Returns:

unit that contains (or immediately follows) the offset A few subtleties: In Falcon we have endeavored to preserve the existing definition of "nearest", so that for a given MXML file, falcon will find the same "nearest" unit.

findContainmentReferenceUnit

public IMXMLUnitData findContainmentReferenceUnit(int offset)

Get the unit that should be referenced when looking at what tags contain this offset (i.e. tags that are opened and not closed before this offset)

Parameters:

offset - test offset

Returns:

reference unit for containment searches

findUnitContainingOffset

public IMXMLUnitData findUnitContainingOffset(int offset)

Get the unit that contains this offset

Parameters:

offset - test offset

Returns:

the containing unit (or null if no unit contains this offset)

findTagContainingOffset

public IMXMLTagData findTagContainingOffset(int offset)

Get the open, close, or empty tag that contains this offset. Note that if offset is inside a text node, this returns null. If you want the surrounding tag in that case, use findTagOrSurroundingTagContainingOffset.

Parameters:

offset - test offset

Returns:

the containing tag (or null, if no tag contains this offset)

findTagOrSurroundingTagContainingOffset

public IMXMLTagData findTagOrSurroundingTagContainingOffset(int offset)

Description copied from interface: IMXMLData

Similar to findTagContainingOffset, but if the unit inside offset is a text node, will return the surrounding tag instead.

Specified by:

findTagOrSurroundingTagContainingOffset in interface IMXMLData

Parameters:

offset - offset

Returns:

the containing/surrounding tag, or null if one can not be found

findAttributeListContainingOffset

public IMXMLTagData findAttributeListContainingOffset(int offset)

Get the open or empty tag whose attribute list contains this offset. A tag's attribute list extends from after the tag name + first whitespace until before the closing ">" or "/>".

Parameters:

offset - test offset

Returns:

tag whose attribute list contains this offset (or null, if the offset isn't in any attribute lists

contains

public static boolean contains(int start,
               int end,
               int offset)

Test whether the offset is contained within the range from start to end. This test excludes the start position and includes the end position, which is how you want things to work for code hints.

Parameters:

start - start of the range (excluded)

end - end of the range (included)

offset - test offset

Returns:

true iff the offset is contained in the range

getRootTag

public IMXMLTagData getRootTag()

Description copied from interface: IMXMLData

Gets the root tag.

Specified by:

getRootTag in interface IMXMLData

Returns:

An MXMLTagData for the root tag.

getEnd

public int getEnd()

Description copied from interface: IMXMLData

Gets the ending offset of the last unit.

Specified by:

getEnd in interface IMXMLData

getCursor

public MXMLData.Cursor getCursor()

verify

public boolean verify()

Verifies that all units (plus all attributes on units that are tags) have their source location information set.

This is used only in asserts.

toString

public String toString()

For debugging only.

Overrides:

toString in class Object

main

public static void main(String[] args)