v8-debug.h

// Copyright 2008 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_V8_DEBUG_H_
#define V8_V8_DEBUG_H_

#include "v8.h"

namespace v8 {

// Debug events which can occur in the V8 JavaScript engine.
enum DebugEvent {
  Break = 1,
  Exception = 2,
  NewFunction = 3,
  BeforeCompile = 4,
  AfterCompile  = 5,
  CompileError = 6,
  PromiseEvent = 7,
  AsyncTaskEvent = 8,
};


class V8_EXPORT Debug {
 public:
  class ClientData {
   public:
    virtual ~ClientData() {}
  };


  class Message {
   public:
    virtual bool IsEvent() const = 0;
    virtual bool IsResponse() const = 0;
    virtual DebugEvent GetEvent() const = 0;

    virtual bool WillStartRunning() const = 0;

    virtual Handle<Object> GetExecutionState() const = 0;
    virtual Handle<Object> GetEventData() const = 0;

    virtual Handle<String> GetJSON() const = 0;

    virtual Handle<Context> GetEventContext() const = 0;

    virtual ClientData* GetClientData() const = 0;

    virtual Isolate* GetIsolate() const = 0;

    virtual ~Message() {}
  };


  class EventDetails {
   public:
    virtual DebugEvent GetEvent() const = 0;

    virtual Handle<Object> GetExecutionState() const = 0;
    virtual Handle<Object> GetEventData() const = 0;

    virtual Handle<Context> GetEventContext() const = 0;

    virtual Handle<Value> GetCallbackData() const = 0;

    virtual ClientData* GetClientData() const = 0;

    virtual ~EventDetails() {}
  };

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

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

  typedef void (*DebugMessageDispatchHandler)();

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

  // Schedule a debugger break to happen when JavaScript code is run
  // in the given isolate.
  static void DebugBreak(Isolate* isolate);

  // Remove scheduled debugger break in given isolate if it has not
  // happened yet.
  static void CancelDebugBreak(Isolate* isolate);

  // Check if a debugger break is scheduled in the given isolate.
  static bool CheckDebugBreak(Isolate* isolate);

  // Message based interface. The message protocol is JSON.
  static void SetMessageHandler(MessageHandler handler);

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

  static V8_DEPRECATE_SOON(
      "Use maybe version",
      Local<Value> Call(v8::Handle<v8::Function> fun,
                        Handle<Value> data = Handle<Value>()));
  // TODO(dcarney): data arg should be a MaybeLocal
  static MaybeLocal<Value> Call(Local<Context> context,
                                v8::Handle<v8::Function> fun,
                                Handle<Value> data = Handle<Value>());

  static V8_DEPRECATE_SOON("Use maybe version",
                           Local<Value> GetMirror(v8::Handle<v8::Value> obj));
  static MaybeLocal<Value> GetMirror(Local<Context> context,
                                     v8::Handle<v8::Value> obj);

  static void ProcessDebugMessages();

  static Local<Context> GetDebugContext();


  static void SetLiveEditEnabled(Isolate* isolate, bool enable);
};


}  // namespace v8


#undef EXPORT


#endif  // V8_V8_DEBUG_H_