v8-debug.h

Go to the documentation of this file.

// 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"  // NOLINT(build/include)
 
namespace v8 {
 
// Debug events which can occur in the V8 JavaScript engine.
enum DebugEvent {
  Break = 1,
  Exception = 2,
  AfterCompile = 3,
  CompileError = 4,
  AsyncTaskEvent = 5,
};
 
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 Local<Object> GetExecutionState() const = 0;
    virtual Local<Object> GetEventData() const = 0;
 
    virtual Local<String> GetJSON() const = 0;
 
    virtual Local<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 Local<Object> GetExecutionState() const = 0;
    virtual Local<Object> GetEventData() const = 0;
 
    virtual Local<Context> GetEventContext() const = 0;
 
    virtual Local<Value> GetCallbackData() const = 0;
 
    virtual ClientData* GetClientData() const = 0;
 
    virtual Isolate* GetIsolate() const = 0;
 
    virtual ~EventDetails() {}
  };
 
  typedef void (*EventCallback)(const EventDetails& event_details);
 
  typedef void (*MessageHandler)(const Message& message);
 
  V8_DEPRECATED("No longer supported", static bool SetDebugEventListener(
                                           Isolate* isolate, EventCallback that,
                                           Local<Value> data = Local<Value>()));
 
  // Schedule a debugger break to happen when JavaScript code is run
  // in the given isolate.
  V8_DEPRECATED("No longer supported",
                static void DebugBreak(Isolate* isolate));
 
  // Remove scheduled debugger break in given isolate if it has not
  // happened yet.
  V8_DEPRECATED("No longer supported",
                static void CancelDebugBreak(Isolate* isolate));
 
  // Check if a debugger break is scheduled in the given isolate.
  V8_DEPRECATED("No longer supported",
                static bool CheckDebugBreak(Isolate* isolate));
 
  // This is now a no-op.
  V8_DEPRECATED("No longer supported",
                static void SetMessageHandler(Isolate* isolate,
                                              MessageHandler handler));
 
  // This is now a no-op.
  V8_DEPRECATED("No longer supported",
                static void SendCommand(Isolate* isolate,
                                        const uint16_t* command, int length,
                                        ClientData* client_data = NULL));
 
  V8_DEPRECATED("No longer supported",
                static MaybeLocal<Value> Call(
                    Local<Context> context, v8::Local<v8::Function> fun,
                    Local<Value> data = Local<Value>()));
 
  // This is now a no-op.
  V8_DEPRECATED("No longer supported",
                static void ProcessDebugMessages(Isolate* isolate));
 
  V8_DEPRECATED("Use v8-inspector",
                static Local<Context> GetDebugContext(Isolate* isolate));
 
  V8_DEPRECATED(
      "No longer supported",
      static MaybeLocal<Context> GetDebuggedContext(Isolate* isolate));
 
  V8_DEPRECATED("No longer supported",
                static void SetLiveEditEnabled(Isolate* isolate, bool enable));
 
  V8_DEPRECATED("No longer supported",
                static MaybeLocal<Array> GetInternalProperties(
                    Isolate* isolate, Local<Value> value));
 
  V8_DEPRECATED("No longer supported",
                static bool IsTailCallEliminationEnabled(Isolate* isolate));
  V8_DEPRECATED("No longer supported",
                static void SetTailCallEliminationEnabled(Isolate* isolate,
                                                          bool enabled));
};
 
 
}  // namespace v8
 
 
#undef EXPORT
 
 
#endif  // V8_V8_DEBUG_H_