flash.tools.debugger

Interface SwfInfo

All Known Implementing Classes:

DSwfInfo, ThreadSafeSwfInfo

public interface SwfInfo

The SwfInfo object contains information relating to a particular swf file that was loaded by the Player. Each SWF file contains a list of actionscript source files from which execution is performed. It is important to note 2 or more SWF files may contain multiple copies of the same source code. From the Player's perspective and the API perspective these copies are unique and it is up to the user of the API to detect these 'duplicate' files and either filter them from the user and/or present an appropriate disambiguous representation of the file names. Also internally they are treated as two distinct files and thus breakpoints will most likely need to be set on both files independently.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsSource(SourceFile f) Returns true if the given source file is contained within this SWF.
int	getIsolateId() Return the worker ID to which this SWF belongs.
String	getPath() The full path of the SWF.
int	getSourceCount(Session s) Number of source files in this SWF.
SourceFile[]	getSourceList(Session s) List of source files that are contained within this SWF.
int	getSwdSize(Session s) The size of the debug SWD file, if any This may also be zero if the SWD load is in progress
int	getSwfSize() The size of this SWF in bytes
String	getUrl() The URL for the SWF.
boolean	isProcessingComplete() Indicates whether the contents of the SWF file have been completely processed.
boolean	isUnloaded() Indication that this SWF, which was previously loaded into the Player, is now currently unloaded.

Method Detail

getPath

String getPath()

The full path of the SWF.

getUrl

String getUrl()

The URL for the SWF. Includes any options at the end of the URL. For example ?debug=true

getSwfSize

int getSwfSize()

The size of this SWF in bytes

getSwdSize

int getSwdSize(Session s)
               throws InProgressException

The size of the debug SWD file, if any This may also be zero if the SWD load is in progress

Throws:

InProgressException - if the SWD has not yet been loaded

isUnloaded

boolean isUnloaded()

Indication that this SWF, which was previously loaded into the Player, is now currently unloaded. All breakpoints set on any of the files contained within this SWF will be inactive. These breakpoints will still exist in the list returned by Session.getBreakpointList()

isProcessingComplete

boolean isProcessingComplete()

Indicates whether the contents of the SWF file have been completely processed. Completely processed means that calls to getSwdSize and other calls that may throw an InProgressException will not throw this exception. Additionally the function and offset related calls within SourceFile will return non-null values once this call returns true.

Since:

Version 2

getSourceCount

int getSourceCount(Session s)
                   throws InProgressException

Number of source files in this SWF. May be zero if no debug

Throws:

InProgressException - if the SWD has not yet been loaded

getSourceList

SourceFile[] getSourceList(Session s)
                           throws InProgressException

List of source files that are contained within this SWF.

Throws:

InProgressException - if the SWD has not yet been loaded

Since:

Version 2

containsSource

boolean containsSource(SourceFile f)

Returns true if the given source file is contained within this SWF.

Since:

Version 2

getIsolateId

int getIsolateId()

Return the worker ID to which this SWF belongs.