flash.tools.debugger

Interface SourceFile

All Known Implementing Classes:

DModule, ThreadSafeSourceFile

public interface SourceFile

A SourceFile contains information about a specific segment of ActionScript source code. The source code could be derived from a number of locations; an ActionScript file, a snip-it of code from a frame, compiler generated code, etc.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBasePath() Base path for this filename, without the package-name portion.
String	getFullPath() Full path and file name, if its exists, for this SourceFile.
String	getFunctionNameForLine(Session s, int lineNum) Return the function name for a given line number, or null if not known or if the line matches more than one function.
String[]	getFunctionNames(Session s) Get a list of all function names for this SourceFile
int	getId() Return a unique identifier for this SourceFile.
String	getLine(int lineNum) Obtains the textual content of the given line from within a source file.
int	getLineCount() Returns the number of source lines in the given file
int	getLineForFunctionName(Session s, String name) Return the line number for the given function name if it doesn't exists -1 is returned
String	getName() File name of this SourceFile.
int	getOffsetForLine(int lineNum) Return the offset within the SWF for a given line number.
String	getPackageName() Get the package name portion of the path for this file.
String	getRawName() Raw, unprocessed file name for this SourceFile.

Method Detail

getBasePath

String getBasePath()

Base path for this filename, without the package-name portion. For example, if class mx.controls.Button.as was in C:\flex\sdk\frameworks\mx\controls\Button.as, then getBasePath() would return "C:\flex\sdk\frameworks" (note that the "mx\controls" part would NOT be returned).

Returns:

base path, or null

getPackageName

String getPackageName()

Get the package name portion of the path for this file. For example, if class mx.controls.Button.as was in C:\flex\sdk\frameworks\mx\controls\Button.as, then getPackageName() would return "mx\controls".

Returns:

package name, or "" (never null)

getName

String getName()

File name of this SourceFile. In the case of a disk-based SourceFile, this is the same as the filename with no path, e.g. 'myfile.as'

Returns:

filename, or "" (never null)

getFullPath

String getFullPath()

Full path and file name, if its exists, for this SourceFile. For disk-based SourceFiles, this is equivalent to getBasePath + slash + getPackageName() + slash + getName() where "slash" is a platform-specific slash character.

Returns:

path, never null

getRawName

String getRawName()

Raw, unprocessed file name for this SourceFile.

Since:

As of Version 2

getLineCount

int getLineCount()

Returns the number of source lines in the given file

Returns:

-1 indicates an error. Call getError() to obtain specific reason code.

getId

int getId()

Return a unique identifier for this SourceFile.

getLine

String getLine(int lineNum)

Obtains the textual content of the given line from within a source file. Line numbers start at 1 and go to getLineCount().

Returns:

the line of source of the file. Any carriage return and/or line feed are stripped from the end of the string.

getFunctionNameForLine

String getFunctionNameForLine(Session s,
                            int lineNum)

Return the function name for a given line number, or null if not known or if the line matches more than one function.

Since:

Version 3.

getLineForFunctionName

int getLineForFunctionName(Session s,
                         String name)

Return the line number for the given function name if it doesn't exists -1 is returned

getFunctionNames

String[] getFunctionNames(Session s)

Get a list of all function names for this SourceFile

getOffsetForLine

int getOffsetForLine(int lineNum)

Return the offset within the SWF for a given line number.