EcmascriptDebugger.5.0

Central data types and how they work:

A "runtime" represents a document context in which threads execute. There is a one-to-one mapping between runtimes and HTML documents.

A "thread" represents a thread of execution in a runtime. A "parent" thread can be preempted by another "child" thread in order to respond to a priority event; the parent thread will not run again until the child thread has finished.

A "script" is a pair (id, source code) where the id is globally unique and the source code is Unicode text.

An "object" is represented by a globally unique ID that is assigned by the debugger.

Globally unique means unique within a running Opera session; that is from starting Opera to stopping it.

The windowID is shared across scope. Notably, it's the same as in the console logger and window manager INTERNAL: The value is from Window::id

AddBreakpoint

command AddBreakpoint(BreakpointPosition)

```
required uint32 breakpointID = 1;
```
A nonzero ID chosen by the client.
```
required string type = 2;
```
"line", "function", "event"
```
optional uint32 scriptID = 3;
```
Present when type is "line"
```
optional uint32 lineNumber = 4;
```
Present when type is "line"
```
optional string eventType = 5;
```
Present when type is "event"

returns (Default)

= 6;

AddEventHandler

Add an event handler. This will generate a OnHandleEvent event every time the XML event defined by the pair (namespace, eventType) reaches the object defined by objectID in the capturing phase. XML events are defined in http://www.w3.org/TR/xml-events

command AddEventHandler(EventHandler)

Add an event handler. This will generate a HANDLE-EVENT event every time the XML event defined by the pair (NAMESPACE, EVENT-TYPE) reaches the object defined by OBJECT-ID in the capturing phase. XML events are defined in http://www.w3.org/TR/xml-events
```
required uint32 handlerID = 1;
```
A nonzero ID chosen by the client. The host may also use this ID to refer to the event handler.
```
required uint32 objectID = 2;
```
```
required string namespace = 3;
```
Namespace of the event. If empty, it will match any namespace.
```
required string eventType = 4;
```
```
required bool preventDefaultHandler = 5;
```
If true it prevents the default event handler from running.
```
required bool stopPropagation = 6;
```
If true it stops propagation of the event beyond this objectID (it will however run for all handlers on the object).

returns (Default)

= 8;

Break

command Break(BreakSelection)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```

returns (Default)

= 12;

ContinueThread

command ContinueThread(ThreadMode)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```
```
required string mode = 3;
```
One of:
- "run"
- "step-into-call"
- "step-next-line"
- "step-out-of-call"

returns (Default)

= 2;

CssGetAllStylesheets

command CssGetAllStylesheets(RuntimeID)

```
required uint32 runtimeID = 1;
```

returns (CssStylesheetList)

 repeated Stylesheet stylesheetList = 1;

```
required uint32 objectID = 1;
```
```
required bool isDisabled = 2;
```
```
required string href = 3;
```
```
required string title = 4;
```
```
required string type = 5;
```
```
repeated string mediaList = 6;
```
```
optional uint32 ownerNodeID = 7;
```
```
optional uint32 ownerRuleID = 8;
```
```
optional uint32 parentStylesheetID = 9;
```

= 23;

CssGetIndexMap

command CssGetIndexMap(Default)

returns (CssIndexMap)

```
repeated string nameList = 1;
```

= 22;

CssGetStyleDeclarations

command CssGetStyleDeclarations(CssElementSelection)

```
required uint32 runtimeID = 1;
```
```
required uint32 objectID = 2;
```

returns (CssStyleDeclarations)

```
repeated string computedStyleList = 1;
```

 repeated NodeStyle nodeStyleList = 2;

```
required uint32 objectID = 1;
```
```
required string elementName = 2;
```

 repeated StyleDeclaration styleList = 3;

Common to all origins:
- indexList
- valueList
- priorityList
- statusList
Common to AUTHOR and LOCAL
- selector
- specificity
For AUTHOR
- stylesheetID
- ruleID
- ruleType
```
required uint32 origin = 1;
```
1 = USER-AGENT, 2=LOCAL, 3=AUTHOR, 4=ELEMENT
```
repeated uint32 indexList = 2;
```
```
repeated string valueList = 3;
```
```
repeated bool priorityList = 4;
```
```
repeated uint32 statusList = 5;
```
```
optional string selector = 6;
```
```
optional uint32 specificity = 7;
```
```
optional uint32 stylesheetID = 8;
```
```
optional uint32 ruleID = 9;
```
```
optional uint32 ruleType = 10;
```

= 25;

CssGetStylesheet

command CssGetStylesheet(CssStylesheetSelection)

```
required uint32 runtimeID = 1;
```
```
required uint32 stylesheetID = 2;
```

returns (CssStylesheetRules)

 repeated StylesheetRule ruleList = 1;

Common to FONT_FACE, PAGE and STYLE is:
- indexList
- valueList
- priorityList
Common to STYLE and PAGE is:
- selectorList
- specificityList
Common to MEDIA and IMPORT
- mediaList
For MEDIA
- ruleList
For IMPORT
- href
- importStylesheetID
For PAGE
- pseudoClass
For CHARSET
- charset
```
required uint32 type = 1;
```
Type values: 0 - UNKNOWN 1 - STYLE 2 - CHARSET 3 - IMPORT 4 - MEDIA 5 - FONT_FACE 6 - PAGE 7 - NAMESPACE // Not supported
```
required uint32 stylesheetID = 2;
```
```
required uint32 ruleID = 3;
```
```
repeated uint32 indexList = 4;
```
```
repeated string valueList = 5;
```
```
repeated bool priorityList = 6;
```
```
repeated string selectorList = 7;
```
0..1 for PAGE and 0..* for STYLE
```
repeated uint32 specificityList = 8;
```
1..1 for PAGE and 0..* for STYLE
```
repeated string mediaList = 9;
```
```
repeated StylesheetRule ruleList = 10;
```
```
optional string href = 11;
```

optional uint32 importStylesheetID = 12;

```
optional uint32 pseudoClass = 13;
```
```
optional string charset = 14;
```

= 24;

Eval

command Eval(EvalData)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```
The ID of the thread to use for executing the script data, or 0 to use the global scope.
```
required uint32 frameIndex = 3;
```
```
required string scriptData = 4;
```
Represents a script to be executed.

 repeated Variable variableList = 5;

Represent variables to set.

```
required string name = 1;
```
```
required uint32 objectID = 2;
```

returns (EvalResult)

```
required string status = 1;
```
If it is "completed" or "unhandled-exception" then type, value and objectValue will be present.
```
required string type = 2;
```
One of:
- "number"
- "boolean"
- "string"
- "null"
- "undefined"
- "object"
```
optional string value = 3;
```
Only present when type is "number", "string" or "boolean"

 optional ObjectValue objectValue = 4;

Only present when type is "object"

```
required uint32 objectID = 1;
```
```
required bool isCallable = 2;
```
```
required bool isFunction = 3;
```
```
required string type = 4;
```
type, function or object
```
optional uint32 prototypeID = 5;
```
```
optional string name = 6;
```
Name of class (object) or function

= 3;

ExamineObjects

command ExamineObjects(ExamineList)

```
required uint32 runtimeID = 1;
```
```
repeated uint32 objectList = 2;
```

returns (ObjectList)

 repeated ObjectInfo objectList = 1;

 required ObjectValue value = 1;

```
required uint32 objectID = 1;
```
```
required bool isCallable = 2;
```
```
required bool isFunction = 3;
```
```
required string type = 4;
```
type, function or object
```
optional uint32 prototypeID = 5;
```
```
optional string name = 6;
```
Name of class (object) or function

 repeated Property propertyList = 2;

If type is ... then ... is present: "object", objectValue "number", value "string", value "boolean", value ("true" or "false") Otherwise ("undefined" or "null"), only type is present.
```
required string name = 1;
```
```
required string type = 2;
```
One of:
- "number"
- "boolean"
- "string"
- "null"
- "undefined"
- "object"
```
optional string value = 3;
```
Only present for "number", "string" or "boolean"

 optional ObjectValue objectValue = 4;

Only present for "object"

```
required uint32 objectID = 1;
```
```
required bool isCallable = 2;
```
```
required bool isFunction = 3;
```
```
required string type = 4;
```
type, function or object
```
optional uint32 prototypeID = 5;
```
```
optional string name = 6;
```
Name of class (object) or function

= 4;

GetBacktrace

command GetBacktrace(BacktraceSelection)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```

optional uint32 maxFrames = 3 [default = 0];

If omitted (or 0) all frames are returned.

returns (BacktraceFrameList)

Frames are in innermost-first order.

 repeated BacktraceFrame frameList = 1;

```
required uint32 functionID = 1;
```
```
required uint32 argumentObject = 2;
```
```
required uint32 variableObject = 3;
```
```
required uint32 thisObject = 4;
```

 optional ObjectValue objectValue = 5;

TODO: Spec says repeated, while the code only assumes one (optional)

```
required uint32 objectID = 1;
```
```
required bool isCallable = 2;
```
```
required bool isFunction = 3;
```
```
required string type = 4;
```
type, function or object
```
optional uint32 prototypeID = 5;
```
```
optional string name = 6;
```
Name of class (object) or function

```
optional uint32 scriptID = 6;
```
```
optional uint32 lineNumber = 7;
```

= 11;

GetSelectedObject

command GetSelectedObject(Default)

returns (ObjectSelection)

```
required uint32 objectID = 1;
```
```
required uint32 windowID = 2;
```
```
optional uint32 runtimeID = 3;
```

= 26;

InspectDom

command InspectDom(DomTraversal)

```
required uint32 objectID = 1;
```
```
required string traversal = 2;
```
traversal on off:
- "parent-node-chain-with-children" take the parent node chain for the target node. add for each node in that chain all children, and for all children there first child, if that is a text node and the only node, starting with the document node.
- "children" get node data for all children in their flow
- `"node" get node data for that node
- "subtree" get node data for the subtree in the flow of it

returns (NodeList)

 repeated NodeInfo nodeList = 1;

```
required uint32 objectID = 1;
```
```
required uint32 type = 2;
```
```
required string name = 3;
```
```
required uint32 depth = 4;
```
```
optional string namespacePrefix = 5;
```
Used if type is 1.

 repeated Attribute attributeList = 6;

Used if type is 1.

```
required string namePrefix = 1;
```
```
required string name = 2;
```
```
required string value = 3;
```

```
optional uint32 childrenLength = 7;
```
Used if type is 1.
```
optional string value = 8;
```
Used if type is 3, 4, 7 or 8.
```
optional string publicID = 9;
```
Used if type is 10.
```
optional string systemID = 10;
```
Used if type is 10.

= 13;

ListRuntimes

command ListRuntimes(RuntimeSelection)

```
repeated uint32 runtimeList = 1;
```
List the ones you want to see, or none if you want all (also set allRuntimes).
```
optional bool allRuntimes = 2;
```
Create runtimes for all documents. Runtimes are normally not created for documents without ECMAScript.

returns (RuntimeList)

 repeated RuntimeInfo runtimeList = 1;

```
required uint32 runtimeID = 1;
```
```
required string htmlFramePath = 2;
```
```
required uint32 windowID = 3;
```
the ID of the window
```
required uint32 objectID = 4;
```
the 'global' object
```
required string uri = 5;
```
the document's URI

= 1;

ReleaseObjects

Release all objects (that is, object received through this protocol as objectIDs), so they can be garbage collected by the ecmascript engine. Note that garbage collection is not necessarily run at this point, so the memory for the given objects might not be freed immediately. IMPORTANT: After this call, no object IDs received earlier are valid! All objects needs to be requested again.

command ReleaseObjects(Default)

returns (Default)

= 29;

RemoveBreakpoint

command RemoveBreakpoint(BreakpointID)

```
required uint32 breakpointID = 1;
```
See BreakpointPosition.breakpointID.

returns (Default)

= 7;

RemoveEventHandler

command RemoveEventHandler(EventHandlerID)

```
required uint32 handlerID = 1;
```
handlerID as specified in EventHandler.handlerID.

returns (Default)

= 9;

SetConfiguration

command SetConfiguration(Configuration)

optional bool stopAtScript = 1 [default = true];

optional bool stopAtException = 2 [default = false];

optional bool stopAtError = 3 [default = false];

optional bool stopAtAbort = 4 [default = false];

optional bool stopAtGc = 5 [default = false];

optional bool stopAtDebuggerStatement = 6 [default = false];

returns (Default)

= 10;

SpotlightObject

command SpotlightObject(SpotlightObjectSelection)

```
required uint32 objectID = 1;
```
Using 0 clears the spotlight.
```
required bool scrollIntoView = 2;
```
Chooses whether the given object should be scrolled into view or not.

returns (Default)

= 5;

SpotlightObjects

command SpotlightObjects(SpotlightSelection)

To highlight elements in the document
```
 repeated SpotlightObject spotlightObjectList = 1;
```
```
{
```
- The drawing order is box, reference-box-frame, box-frame, grid.
- ```
required uint32 objectID = 1;
```
- ```
required bool scrollIntoView = 2;
```
  Chooses whether the given object should be scrolled into view or not.
- ```
 repeated SpotlightBox boxList = 3;
```
```
{
```
  - Colors are encoded as RGBA with 8 bits for each channel. encoded_color = ( red << 24 ) + ( green << 16 ) + ( blue << 8 ) + ( alpha ) with red, green, blue and alpha in a range of 0 - 255 e.g.:
    red 4278190335 green 16711935 blue 65535 yellow 4294902015 cyan 16777215 magenta 4278255615
  - required uint32 boxType = 1;
    
    Valid values: 0: dimension 1: padding 2: border 3: margin
  - optional uint32 fillColor = 2;
  - optional uint32 frameColor = 3;
    
    Drawn with 1px width inside the box
  - optional uint32 gridColor = 4;
    
    Drawn with 1px width inside the box over the whole document
```
}
```
```
}
```

returns (Default)

= 27;

OnHandleEvent

This event is issued for XML events on the host, if a corresponding AddEventHandler has been issued earlier by the client.

event OnHandleEvent returns (DomEvent)

```
required uint32 objectID = 1;
```
Refers to the target of the event.
```
required uint32 handlerID = 2;
```
```
required string eventType = 3;
```
The event type is e.g., "click", "mousemove" More examples are at http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html Exactly which events are implemented depends on the host, and is not defined in this protocol.

= 20;

OnNewScript

event OnNewScript returns (ScriptInfo)

```
required uint32 runtimeID = 1;
```
```
required uint32 scriptID = 2;
```
```
required string scriptType = 3;
```
One of:
- "inline"
- "event"
- "linked"
- "timeout"
- "java"
- "generated"
- "unknown"
```
required string scriptData = 4;
```
```
optional string uri = 5;
```
present if scriptType is Linked

= 16;

OnObjectSelected

Some hosts send this event to indicate that an object was selected for debugging, e.g., if the debugger was started by right-clicking an element and clicking "inspect" in the context menu, this event will be sent right after startup. A client may safely choose to ignore this event.

event OnObjectSelected returns (ObjectSelection)

```
required uint32 objectID = 1;
```
```
required uint32 windowID = 2;
```
```
optional uint32 runtimeID = 3;
```

= 21;

OnParseError

event OnParseError returns (DomParseError)

```
required uint32 runtimeID = 1;
```
```
required uint32 scriptID = 2;
```
```
required uint32 lineNumber = 3;
```
```
required uint32 offset = 4;
```
Represents the character offset in the script where the parse error occured.
```
required string context = 5;
```
Describes in what context the error occured.
```
required string description = 6;
```
Contains the human-readable description of the parse error.

= 28;

OnRuntimeStarted

event OnRuntimeStarted returns (RuntimeInfo)

```
required uint32 runtimeID = 1;
```
```
required string htmlFramePath = 2;
```
```
required uint32 windowID = 3;
```
the ID of the window
```
required uint32 objectID = 4;
```
the 'global' object
```
required string uri = 5;
```
the document's URI

= 14;

OnRuntimeStopped

event OnRuntimeStopped returns (RuntimeID)

```
required uint32 runtimeID = 1;
```

= 15;

OnThreadFinished

event OnThreadFinished returns (ThreadResult)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```
```
required string status = 3;
```
One of:
- "completed"
- "unhandled-exception"
- "aborted"
- "cancelled-by-scheduler"

= 18;

OnThreadStarted

event OnThreadStarted returns (ThreadInfo)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```
```
required uint32 parentThreadID = 3;
```
```
required string threadType = 4;
```
One of:
- "inline"
- "event"
- "linked"
- "timeout"
- "java"
- "unknown"
```
optional string eventNamespace = 5;
```
present if threadType is "event"
```
optional string eventType = 6;
```
present if threadType is "event"

= 17;

OnThreadStoppedAt

event OnThreadStoppedAt returns (ThreadStopInfo)

```
required uint32 runtimeID = 1;
```
```
required uint32 threadID = 2;
```
```
required uint32 scriptID = 3;
```
```
required uint32 lineNumber = 4;
```
```
required string stoppedReason = 5;
```
One of:
- "broken"
- "function-return"
- "exception"
- `"debugger statement"`
- "breakpoint"
- "unknown"
"broken" is sent in response to a Break command. "breakpoint" is sent when the script hits a debugger-set breakpoint.
```
optional uint32 breakpointID = 6;
```
Present if and only if stoppedReason is "breakpoint"

= 19;

EcmascriptDebugger5.0

Commands

Events