flash.tools.debugger

Class DefaultDebuggerCallbacks

java.lang.Object

flash.tools.debugger.DefaultDebuggerCallbacks

All Implemented Interfaces:

IDebuggerCallbacks

public class DefaultDebuggerCallbacks
extends Object
implements IDebuggerCallbacks

Author:

mmorearty

Constructor Summary

Constructors

Constructor and Description
DefaultDebuggerCallbacks()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	extractExenameFromCommandString(String cmd) Given a command string of the form "path_to_exe" args or path_to_exe args return the path_to_exe.
int[]	getAppVersion(File application) Default implementation does not know how to get the version of an application.
String[]	getBrowserParameters(String uri) Default application does not have any extra arguments for the browser.
File	getHttpExe() Returns the executable of the browser to launch for http: URLs, or null if not known.
String	getHttpExeName() Returns a name such as "firefox" or "Web browser", the name of the browser, useful for error messages.
File	getPlayerExe() Returns the executable for the standalone Flash player, or null if not known.
String	getPlayerExeName() Returns a name such as "SAFlashPlayer.exe" or "gflashplayer" or "Flash player", the name of the standalone player, useful for error messages.
Process	launchDebugTarget(String[] cmd) Launches a debug target.
Process	launchDebugTarget(String[] cmd, ILauncher launcher) Launches a debug target using the launcher instanceILauncher.launch(cmd).
String	queryWindowsRegistry(String key, String value) Query the Windows registry.
String	queryWindowsRegistry(String key, String value, int registryBitMode) This implementation of queryWindowsRegistry() does not make any native calls.
void	recomputeExeLocations() Tells the debugger to recompute the values which will be returned by getHttpExe() and getPlayerExe().
void	terminateDebugTarget(Process process) Terminates a debug target process.
void	terminateDebugTarget(Process process, ILauncher launcher) Terminates a debug target process by invoking ILauncher.terminate(process)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDebuggerCallbacks

public DefaultDebuggerCallbacks()

Method Detail

getHttpExe

public File getHttpExe()

Description copied from interface: IDebuggerCallbacks

Returns the executable of the browser to launch for http: URLs, or null if not known.

Specified by:

getHttpExe in interface IDebuggerCallbacks

getPlayerExe

public File getPlayerExe()

Description copied from interface: IDebuggerCallbacks

Returns the executable for the standalone Flash player, or null if not known.

Specified by:

getPlayerExe in interface IDebuggerCallbacks

recomputeExeLocations

public void recomputeExeLocations()

Description copied from interface: IDebuggerCallbacks

Tells the debugger to recompute the values which will be returned by getHttpExe() and getPlayerExe(). This does NOT need to be called before the first call to either of those functions. The intent of this function is to allow the debugger to cache any expensive calculations, but still allow for the possibility of recalculating the values from time to time (e.g. when a new launch is going to happen).

Specified by:

recomputeExeLocations in interface IDebuggerCallbacks

getHttpExeName

public String getHttpExeName()

Description copied from interface: IDebuggerCallbacks

Returns a name such as "firefox" or "Web browser", the name of the browser, useful for error messages. Never returns null.

Specified by:

getHttpExeName in interface IDebuggerCallbacks

getPlayerExeName

public String getPlayerExeName()

Description copied from interface: IDebuggerCallbacks

Returns a name such as "SAFlashPlayer.exe" or "gflashplayer" or "Flash player", the name of the standalone player, useful for error messages. Never returns null.

Specified by:

getPlayerExeName in interface IDebuggerCallbacks

extractExenameFromCommandString

protected String extractExenameFromCommandString(String cmd)

Given a command string of the form "path_to_exe" args or path_to_exe args return the path_to_exe. Note that path_to_exe may contain spaces.

launchDebugTarget

public Process launchDebugTarget(String[] cmd)
                          throws IOException

Description copied from interface: IDebuggerCallbacks

Launches a debug target. The arguments are the same as those of Runtime.exec().

Specified by:

launchDebugTarget in interface IDebuggerCallbacks

Throws:

IOException

launchDebugTarget

public Process launchDebugTarget(String[] cmd,
                        ILauncher launcher)
                          throws IOException

Description copied from interface: IDebuggerCallbacks

Launches a debug target using the launcher instanceILauncher.launch(cmd).

Specified by:

launchDebugTarget in interface IDebuggerCallbacks

Throws:

IOException

terminateDebugTarget

public void terminateDebugTarget(Process process)
                          throws IOException

Description copied from interface: IDebuggerCallbacks

Terminates a debug target process.

Specified by:

terminateDebugTarget in interface IDebuggerCallbacks

Throws:

IOException

terminateDebugTarget

public void terminateDebugTarget(Process process,
                        ILauncher launcher)
                          throws IOException

Description copied from interface: IDebuggerCallbacks

Terminates a debug target process by invoking ILauncher.terminate(process)

Specified by:

terminateDebugTarget in interface IDebuggerCallbacks

Throws:

IOException

queryWindowsRegistry

public String queryWindowsRegistry(String key,
                          String value)
                            throws IOException

Description copied from interface: IDebuggerCallbacks

Query the Windows registry.

Specified by:

queryWindowsRegistry in interface IDebuggerCallbacks

Parameters:

key - The registry key, in a format suitable for the REG.EXE program. You must use full key names such as HKEY_LOCAL_MACHINE rather the shorter abbreviations such as HKLM.

value - The value within that key, or null for the unnamed ("empty") value

Returns:

the value stored at the location, or null if key or value was not found

Throws:

IOException - indicates the registry query failed -- warning, this can really happen! Some implementations of this function don't work on Windows 2000. So, this function should not be counted on too heavily -- you should have a backup plan.

queryWindowsRegistry

public String queryWindowsRegistry(String key,
                          String value,
                          int registryBitMode)
                            throws IOException

This implementation of queryWindowsRegistry() does not make any native calls. I had to do it this way because it is too hard, at this point, to add native code to the Flex code tree.

Specified by:

queryWindowsRegistry in interface IDebuggerCallbacks

Throws:

IOException

getAppVersion

public int[] getAppVersion(File application)
                    throws IOException

Default implementation does not know how to get the version of an application.

Specified by:

getAppVersion in interface IDebuggerCallbacks

Parameters:

application - the application whose version number is desired. On Windows, this will typically be a path to a .exe file. On Mac, it may point to a .app directory such as "/Applications/Safari.app", or it may point to the underlying binary, such as "/Applications/Safari.app/Contents/MacOS/Safari".

Returns:

an array of two integers if the version can be determined, or null if it cannot be determined. The first integer is the major version number, and the second integer is the minor version number. More detailed information cannot be provided, because this function needs to be cross- platform, and the format of version information tends to vary widely from one platform to another.

Throws:

IOException - e.g. for file not found, etc.

getBrowserParameters

public String[] getBrowserParameters(String uri)

Default application does not have any extra arguments for the browser.

Specified by:

getBrowserParameters in interface IDebuggerCallbacks