Debug Class Reference

#include <v8-debug.h>

Data Structures
class	ClientData
class	EventDetails
class	Message

Public Types
typedef void(*	EventCallback) (const EventDetails &event_details)
typedef void(*	MessageHandler) (const Message &message)
typedef void(*	DebugMessageDispatchHandler) ()

Static Public Member Functions
static bool	SetDebugEventListener (EventCallback that, Handle< Value > data=Handle< Value >())
static void	DebugBreak (Isolate *isolate)
static void	CancelDebugBreak (Isolate *isolate)
static void	DebugBreakForCommand (Isolate *isolate, ClientData *data)
static void	SetMessageHandler (MessageHandler handler)
static void	SendCommand (Isolate *isolate, const uint16_t *command, int length, ClientData *client_data=NULL)
static Local< Value >	Call (v8::Handle< v8::Function > fun, Handle< Value > data=Handle< Value >())
static Local< Value >	GetMirror (v8::Handle< v8::Value > obj)
static void	ProcessDebugMessages ()
static Local< Context >	GetDebugContext ()
static void	SetLiveEditEnabled (Isolate *isolate, bool enable)

Detailed Description

Definition at line 29 of file v8-debug.h.

Member Typedef Documentation

DebugMessageDispatchHandler

typedef void(* DebugMessageDispatchHandler) ()

Callback function for the host to ensure debug messages are processed.

Definition at line 157 of file v8-debug.h.

EventCallback

typedef void(* EventCallback) (const EventDetails &event_details)

Debug event callback function.

Parameters

event_details

object providing information about the debug event

A EventCallback2 does not take possession of the event data, and must not rely on the data persisting after the handler returns.

Definition at line 142 of file v8-debug.h.

MessageHandler

typedef void(* MessageHandler) (const Message &message)

Debug message callback function.

Parameters

message

the debug message handler message object

A MessageHandler2 does not take possession of the message data, and must not rely on the data persisting after the handler returns.

Definition at line 152 of file v8-debug.h.

Member Function Documentation

Call()

static Local<Value> Call ( v8::Handle< v8::Function >  fun, Handle< Value >  data = Handle< Value >()  )

static

Run a JavaScript function in the debugger.

Parameters

fun

the function to call

data

passed as second argument to the function With this call the debugger is entered and the function specified is called with the execution state as the first argument. This makes it possible to get access to information otherwise not available during normal JavaScript execution e.g. details on stack frames. Receiver of the function call will be the debugger context global object, however this is a subject to change. The following example shows a JavaScript function which when passed to v8::Debug::Call will return the current line of JavaScript execution.

function frame_source_line(exec_state) {
  return exec_state.frame(0).sourceLine();
}

CancelDebugBreak()

static void CancelDebugBreak ( Isolate *  isolate )

static

DebugBreak()

static void DebugBreak ( Isolate *  isolate )

static

DebugBreakForCommand()

static void DebugBreakForCommand ( Isolate *  isolate, ClientData *  data  )

static

GetDebugContext()

static Local<Context> GetDebugContext ( )

static

Debugger is running in its own context which is entered while debugger messages are being dispatched. This is an explicit getter for this debugger context. Note that the content of the debugger context is subject to change.

GetMirror()

static Local<Value> GetMirror ( v8::Handle< v8::Value >  obj )

static

Returns a mirror object for the given object.

ProcessDebugMessages()

static void ProcessDebugMessages ( )

static

Makes V8 process all pending debug messages.

From V8 point of view all debug messages come asynchronously (e.g. from remote debugger) but they all must be handled synchronously: V8 cannot do 2 things at one time so normal script execution must be interrupted for a while.

Generally when message arrives V8 may be in one of 3 states:

1. V8 is running script; V8 will automatically interrupt and process all pending messages;
2. V8 is suspended on debug breakpoint; in this state V8 is dedicated to reading and processing debug messages;
3. V8 is not running at all or has called some long-working C++ function; by default it means that processing of all debug messages will be deferred until V8 gets control again; however, embedding application may improve this by manually calling this method.

Technically this method in many senses is equivalent to executing empty script:

1. It does nothing except for processing all pending debug messages.
2. It should be invoked with the same precautions and from the same context as V8 script would be invoked from, because: a. with "evaluate" command it can do whatever normal script can do, including all native calls; b. no other thread should call V8 while this method is running (v8::Locker may be used here).

"Evaluate" debug command behavior currently is not specified in scope of this method.

SendCommand()

static void SendCommand ( Isolate *  isolate, const uint16_t *  command, int  length, ClientData *  client_data = NULL  )

static

SetDebugEventListener()

static bool SetDebugEventListener ( EventCallback  that, Handle< Value >  data = Handle< Value >()  )

static

SetLiveEditEnabled()

static void SetLiveEditEnabled ( Isolate *  isolate, bool  enable  )

static

Enable/disable LiveEdit functionality for the given Isolate (default Isolate if not provided). V8 will abort if LiveEdit is unexpectedly used. LiveEdit is enabled by default.

SetMessageHandler()

static void SetMessageHandler ( MessageHandler  handler )

static

---

The documentation for this class was generated from the following file:

• include/v8-debug.h