org.apache.flex.compiler.internal.parsing.as

Class IncludeHandler

java.lang.Object

org.apache.flex.compiler.internal.parsing.as.IncludeHandler

public class IncludeHandler
extends Object

Handler for include processing. Each source file has one IncludeHandler.

IncludeHandler responsibilities:

• Produce a IFileSpecification from an include statement.
• Track include chain to prevent cyclic include.
• Track and store a tree of include relationships.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IncludeHandler.Tree Tree node type for storing include relationships.

Constructor Summary

Constructors

Constructor and Description
IncludeHandler(IFileSpecificationGetter fileSpecGetter) Create an IncludeHandler.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Reset the state of the include handler by clearing the include chain and collection of included files.
static IncludeHandler	creatDefaultIncludeHandler() Create an IncludeHandler that does not interception of requests to open included files.
static IncludeHandler	create(IFileSpecificationGetter fileSpecGetter, int startAbsoluteOffset) Create an IncludeHandler with a given starting absolute offset.
static IncludeHandler	createForASTBuilding(IFileSpecificationGetter fileSpecGetter, String sourcePath, int localOffset, int absoluteOffset) Create an IncludeHandler with a given starting absolute offset.
void	enterFile(String filename) Enter an included file.
protected int	getAbsoluteOffset()
protected IFileSpecification	getFileSpecificationForInclude(String includer, String includeString) Given an the canonical path of a file that contains an include directive with the specified string, return an IFileSpecification for the file the include directive references.
com.google.common.collect.ImmutableSet<String>	getIncludedFiles()
protected String	getIncludeStackTop() Get the file on top of the include chain stack.
protected IncludeHandler.Tree	getIncludeTree() Get a tree of include relationship.
long	getLastModified() This timestamp will be the latest modification time of all the root source and all included files
com.google.common.collect.ImmutableList<OffsetCue>	getOffsetCueList() Get all the OffsetCue's.
void	handleFileNotFound(IFileSpecification fileSpec) When a client catches a file not found, they should call us back and let us know.
protected boolean	isCyclicInclude(String filename) Check if the file is already on the include chain.
void	leaveFile() Leave the included file.
void	leaveFile(int endOffset) Extend the end offset of the current file and leave the file.
void	onNextMXMLUnitData(IMXMLUnitData unitData) Update the IncludeHandler's current offset counter with the next IMXMLUnitData
protected void	onNextToken(ASToken token) Set the absolute offset on an ASToken.
void	propagateLastModified(IncludeHandler childIncludeHandler) propagates the lastModified timestamp from a IncludeHandler from a child node to this one.
void	setProjectAndCompilationUnit(IASProject project, ICompilationUnit compilationUnit) Set project reference.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeHandler

public IncludeHandler(IFileSpecificationGetter fileSpecGetter)

Create an IncludeHandler. The workspace is used to find a file specification from the workspace file specification pool. If the workspace is null, getFileSpecificationForInclude(String, String) will always create a new IFileSpecification result.

Parameters:

fileSpecGetter - IFileSpecificationGetter that should be used by the include hander to open included files.

Method Detail

create

public static IncludeHandler create(IFileSpecificationGetter fileSpecGetter,
                    int startAbsoluteOffset)

Create an IncludeHandler with a given starting absolute offset. This is useful for creating MXML AST nodes, because MXML node construction routine doesn't track absolute offsets. Instead, it uses the OffsetLookup created by MXMLScopeBuilder to recover the absolute offset, and create a "one-time" IncludeHandler in order to get the nodes with the same absolute offsets and the definitions.

Parameters:

fileSpecGetter - IFileSpecificationGetter that should be used by the include hander to open included files.

startAbsoluteOffset - starting absolute offset

Returns:

IncludeHandler

creatDefaultIncludeHandler

public static IncludeHandler creatDefaultIncludeHandler()

Create an IncludeHandler that does not interception of requests to open included files.

Returns:

An IncludeHandler that does not interception of requests to open included files.

createForASTBuilding

public static IncludeHandler createForASTBuilding(IFileSpecificationGetter fileSpecGetter,
                                  String sourcePath,
                                  int localOffset,
                                  int absoluteOffset)

Create an IncludeHandler with a given starting absolute offset. This is useful for building MXML AST nodes, because MXML node construction routine doesn't track absolute offsets. Instead, it uses the OffsetLookup in MXMLScopeBuilder to recover the absolute offset, and mock a "one-time" IncludeHandler in order to get the nodes with the same absolute offsets and the definitions.

Parameters:

sourcePath - enter this file

localOffset - starting local offset

absoluteOffset - starting absolute offset

Returns:

IncludeHandler IncludeHander

getFileSpecificationForInclude

protected IFileSpecification getFileSpecificationForInclude(String includer,
                                                String includeString)

Given an the canonical path of a file that contains an include directive with the specified string, return an IFileSpecification for the file the include directive references.

1. If includeString is an absolute path, a IFileSpecification for that location will be returned.
2. Otherwise, if this object has a reference to IASProject, the included file path will be resolved firstly in the current directory of the including file, then in each of the source folders on the project until the first existing file is found.
3. If no on-disk file is found for the included file, a IFileSpecification pointing to the intended default location will be returned.

Parameters:

includer - The canonical path of a file that contains the include directive.

includeString - Unquoted string that refers to a file to be included.

Returns:

An IFileSpecification for the included file, or null if can't resolve.

getIncludedFiles

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

Returns:

Set of all files included by this file.

clear

public void clear()

Reset the state of the include handler by clearing the include chain and collection of included files.

getIncludeStackTop

protected String getIncludeStackTop()

Get the file on top of the include chain stack.

Returns:

The file on top of the include chain stack.

enterFile

public void enterFile(String filename)

Enter an included file. Push the filename to the include chain.

Parameters:

filename - Included file name.

propagateLastModified

public void propagateLastModified(IncludeHandler childIncludeHandler)

propagates the lastModified timestamp from a IncludeHandler from a child node to this one.

Parameters:

childIncludeHandler - The include-handler whose timestamp will be used to set the time stap of this include-handler.

getLastModified

public long getLastModified()

This timestamp will be the latest modification time of all the root source and all included files

Returns:

The timestamp of the root include file

leaveFile

public void leaveFile()

Leave the included file.

leaveFile

public void leaveFile(int endOffset)

Extend the end offset of the current file and leave the file.

Parameters:

endOffset - Local end offset of the current file, including all trailing white spaces.

isCyclicInclude

protected boolean isCyclicInclude(String filename)

Check if the file is already on the include chain. If true, including it again will cause cyclic include problem.

Parameters:

filename - file name

Returns:

True if including the file causes cyclic include problem.

getIncludeTree

protected IncludeHandler.Tree getIncludeTree()

Get a tree of include relationship.

Returns:

A tree of include relationship.

onNextToken

protected void onNextToken(ASToken token)

Set the absolute offset on an ASToken. The absolute offset is the token's "local" start offset translated into the absolute space.

Advance absolute offset recorded in the handler by one token.

Parameters:

token - The token to update.

onNextMXMLUnitData

public void onNextMXMLUnitData(IMXMLUnitData unitData)

Update the IncludeHandler's current offset counter with the next IMXMLUnitData

Parameters:

unitData - Next IMXMLUnitData object.

getAbsoluteOffset

protected int getAbsoluteOffset()

Returns:

Absolute offset.

getOffsetCueList

public com.google.common.collect.ImmutableList<OffsetCue> getOffsetCueList()

Get all the OffsetCue's.

Returns:

All the OffsetCue objects.

toString

public String toString()

Overrides:

toString in class Object

setProjectAndCompilationUnit

public final void setProjectAndCompilationUnit(IASProject project,
                                ICompilationUnit compilationUnit)

Set project reference. The project reference is used to resolve included files in other source folders in the project.

Parameters:

project - Current project.

handleFileNotFound

public void handleFileNotFound(IFileSpecification fileSpec)

When a client catches a file not found, they should call us back and let us know. Only important in an incremental compilation workflow (like Flash Buildler). NOt needed for command line compiles any most unit tests.

Parameters:

fileSpec - A file specification.