com.opera.core.systems.scope.services

Interface Debugger

All Superinterfaces:

Service

All Known Subinterfaces:

Ecmascript, EcmascriptDebugger

All Known Implementing Classes:

AbstractEcmascriptService, MockEcmascriptDebugger, ScopeEcmascriptDebugger, ScopeEcmascriptDebugger6, ScopeEcmascriptService

public interface Debugger
extends Service

Method Summary

Methods

Modifier and Type	Method and Description
void	addRuntime(EsdbgProtos.RuntimeInfo info) Adds a runtime to the list of runtimes maintained in the service (STP/1 only)
String	callFunctionOnObject(String using, int objectId) The script to be executed on/using an object
Object	callFunctionOnObject(String using, int objectId, boolean responseExpected)
void	changeRuntime(int index) Changes the frame by index
void	changeRuntime(String frameName) Changes the frame by frame name address nested frames by dot (first.second)
void	cleanUpRuntimes() Cleanup runtimes with the active window id
void	cleanUpRuntimes(int windowId) Cleanup possible dead/suspended runtimes on runtime-started or window-closed
List<Integer>	examineObjects(Integer id) Request additional information about an object, such as its prototype or its properties.
Object	examineScriptResult(Integer id) Recursively iterates through the property hierarchies of underneath the given object and unwraps the node elements into suitable types.
String	executeJavascript(String using) Execute a script and wait for response
String	executeJavascript(String using, boolean responseExpected) Execute a script, this method allows fine tuning of responses, we are not interested in return value in some injections
String	executeJavascript(String using, Integer windowId) Executes an arbitrary block of JavaScript on a given window, and returns the result of the evaluation.
Object	executeScript(String using, boolean responseExpected) Executes a script and returns the response (based on responseExpected)
Integer	executeScriptOnObject(String using, int objectId)
Integer	getObject(String using) Gets the object id using a script
int	getRuntimeId() Get the current runtime ID.
boolean	isScriptInjectable() Queries the current runtime to see if it's script injectable.
List<String>	listFramePaths() Lists the frame paths of available runtimes
void	readyStateChanged(EcmascriptProtos.ReadyStateChange change) Triggered on the ecmascript service when the state of a runtime changes
void	releaseObject(int objectId) Releases a specific object
void	releaseObjects() Makes objects available to gc, this doesn't free the objects immediately
void	removeRuntime(int runtimeId) Removes a runtime from the list, doesnt get called often due to runtime-stopped being sent late (runtimes get suspended)
void	resetFramePath() Resets the frame path context to the top level frame and reinitializes the debugger runtime.
void	resetRuntimesList() Resets the list of runtimes and fetches a fresh list from Opera, this can be used to recover in cases where runtimes go out of sync
Object	scriptExecutor(String script, Object... params) Executes the given javascript via eval call
void	setDriver(OperaDriver driver) Set the driver this service belongs to.
void	setFormElementValue(int objectId, String value) Set value of a form element.
void	setRuntime(EsdbgProtos.RuntimeInfo runtime) Sets the runtime to be used in injection required for event handler (STP/1 only)
boolean	updateRuntime() Finds a valid runtime and updates the runtime reference (active runtime)

Methods inherited from interface com.opera.core.systems.scope.Service

getServiceName, getServiceVersion, init

Method Detail

setDriver

void setDriver(OperaDriver driver)

Set the driver this service belongs to. Needed so that we can create OperaWebElements in this service.

getRuntimeId

int getRuntimeId()

Get the current runtime ID.

Returns:

runtime ID

setRuntime

void setRuntime(EsdbgProtos.RuntimeInfo runtime)

Sets the runtime to be used in injection required for event handler (STP/1 only)

removeRuntime

void removeRuntime(int runtimeId)

Removes a runtime from the list, doesnt get called often due to runtime-stopped being sent late (runtimes get suspended)

addRuntime

void addRuntime(EsdbgProtos.RuntimeInfo info)

Adds a runtime to the list of runtimes maintained in the service (STP/1 only)

scriptExecutor

Object scriptExecutor(String script,
                    Object... params)

Executes the given javascript via eval call

Parameters:

script - the script to be executed on host

params - array of params, can be string, long or web element(s)

executeJavascript

String executeJavascript(String using)

Execute a script and wait for response

Parameters:

using - script to execute

executeJavascript

String executeJavascript(String using,
                       boolean responseExpected)

Execute a script, this method allows fine tuning of responses, we are not interested in return value in some injections

Parameters:

using - script to execute

responseExpected - if true parse the response

Returns:

string representation of the response

executeScript

Object executeScript(String using,
                   boolean responseExpected)

Executes a script and returns the response (based on responseExpected)

Parameters:

using - the script to be injected

responseExpected - the flag to enable/disable parsing response

Returns:

the raw result object if response is expected, null otherwise

getObject

Integer getObject(String using)

Gets the object id using a script

Parameters:

using - the script to find the object

Returns:

object id with the result

callFunctionOnObject

String callFunctionOnObject(String using,
                          int objectId)

The script to be executed on/using an object

Parameters:

using - script with reference to the object "locator"

objectId - the object to be used for injection

Returns:

the string value returned by the executed Javascript

callFunctionOnObject

Object callFunctionOnObject(String using,
                          int objectId,
                          boolean responseExpected)

executeScriptOnObject

Integer executeScriptOnObject(String using,
                            int objectId)

changeRuntime

void changeRuntime(int index)

Changes the frame by index

changeRuntime

void changeRuntime(String frameName)

Changes the frame by frame name address nested frames by dot (first.second)

cleanUpRuntimes

void cleanUpRuntimes(int windowId)

Cleanup possible dead/suspended runtimes on runtime-started or window-closed

cleanUpRuntimes

void cleanUpRuntimes()

Cleanup runtimes with the active window id

examineObjects

List<Integer> examineObjects(Integer id)

Request additional information about an object, such as its prototype or its properties.

Parameters:

id - object ID previously returned from an eval call to the debugger

Returns:

list of ID's of object's which are considered web elements

listFramePaths

List<String> listFramePaths()

Lists the frame paths of available runtimes

Returns:

a List of String framepaths

releaseObjects

void releaseObjects()

Makes objects available to gc, this doesn't free the objects immediately

updateRuntime

boolean updateRuntime()

Finds a valid runtime and updates the runtime reference (active runtime)

Returns:

true if a runtime is found and updated

resetRuntimesList

void resetRuntimesList()

Resets the list of runtimes and fetches a fresh list from Opera, this can be used to recover in cases where runtimes go out of sync

readyStateChanged

void readyStateChanged(EcmascriptProtos.ReadyStateChange change)

Triggered on the ecmascript service when the state of a runtime changes

Parameters:

change - EcmascriptProtos.ReadyStateChange object with runtime info

releaseObject

void releaseObject(int objectId)

Releases a specific object

Parameters:

objectId - Id of the object to be released

resetFramePath

void resetFramePath()

Resets the frame path context to the top level frame and reinitializes the debugger runtime.

executeJavascript

String executeJavascript(String using,
                       Integer windowId)

Executes an arbitrary block of JavaScript on a given window, and returns the result of the evaluation.

Parameters:

using - the code to evaluate

windowId - the runtime ID, previously retrieved from the WindowManager

Returns:

the result of the evaluation

examineScriptResult

Object examineScriptResult(Integer id)

Recursively iterates through the property hierarchies of underneath the given object and unwraps the node elements into suitable types. DOM elements will be coerced into OperaWebElement's, arrays into Java List's, hashes into Map's, numbers into Integer's, and the remaining properties into String's.

Parameters:

id - the object to examine the hierarchy of

Returns:

the unwrapped object tree

setFormElementValue

void setFormElementValue(int objectId,
                       String value)

Set value of a form element.

Parameters:

objectId - the ID of the object to set value

value - the value to set

isScriptInjectable

boolean isScriptInjectable()

Queries the current runtime to see if it's script injectable.

Returns:

true if runtime is script injectable, false otherwise