v8-debugger-script.h 4.85 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/*
 * Copyright (C) 2008 Apple Inc. All rights reserved.
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

30 31
#ifndef V8_INSPECTOR_V8_DEBUGGER_SCRIPT_H_
#define V8_INSPECTOR_V8_DEBUGGER_SCRIPT_H_
32

33 34
#include <memory>

35 36
#include "include/v8-local-handle.h"
#include "include/v8-maybe.h"
37
#include "src/base/macros.h"
38
#include "src/debug/debug-interface.h"
39
#include "src/inspector/string-16.h"
40
#include "src/inspector/string-util.h"
41

42 43 44
namespace v8 {
class Isolate;
}
45 46 47

namespace v8_inspector {

48
class V8DebuggerAgentImpl;
49
class V8InspectorClient;
50

51 52
class V8DebuggerScript {
 public:
53
  enum class Language { JavaScript, WebAssembly };
54 55
  static std::unique_ptr<V8DebuggerScript> Create(
      v8::Isolate* isolate, v8::Local<v8::debug::Script> script,
56
      bool isLiveEdit, V8DebuggerAgentImpl* agent, V8InspectorClient* client);
57 58

  virtual ~V8DebuggerScript();
59 60
  V8DebuggerScript(const V8DebuggerScript&) = delete;
  V8DebuggerScript& operator=(const V8DebuggerScript&) = delete;
61

62
  v8::Local<v8::debug::ScriptSource> scriptSource();
63
  const String16& scriptId() const { return m_id; }
64 65
  bool hasSourceURLComment() const { return m_hasSourceURLComment; }
  const String16& sourceURL() const { return m_url; }
66
  const String16& embedderName() const { return m_embedderName; }
67

68
  virtual const String16& sourceMappingURL() const = 0;
69
  virtual String16 source(size_t pos, size_t len = UINT_MAX) const = 0;
70
  virtual Language getLanguage() const = 0;
71
  virtual const String16& hash() const = 0;
72 73 74 75
  virtual int startLine() const = 0;
  virtual int startColumn() const = 0;
  virtual int endLine() const = 0;
  virtual int endColumn() const = 0;
76
  virtual int codeOffset() const = 0;
77
  int executionContextId() const { return m_executionContextId; }
78
  virtual bool isLiveEdit() const = 0;
79
  virtual bool isModule() const = 0;
80
  virtual int length() const = 0;
81 82

  void setSourceURL(const String16&);
83
  virtual void setSourceMappingURL(const String16&) = 0;
84
  virtual void setSource(const String16& source, bool preview,
85
                         v8::debug::LiveEditResult* result) = 0;
86

87 88
  virtual bool getPossibleBreakpoints(
      const v8::debug::Location& start, const v8::debug::Location& end,
89
      bool ignoreNestedFunctions,
90
      std::vector<v8::debug::BreakLocation>* locations) = 0;
91
  virtual void resetBlackboxedStateCache() = 0;
92

93
  virtual v8::Maybe<int> offset(int lineNumber, int columnNumber) const = 0;
94 95
  virtual v8::debug::Location location(int offset) const = 0;

96 97
  virtual bool setBreakpoint(const String16& condition,
                             v8::debug::Location* location, int* id) const = 0;
98
  virtual void MakeWeak() = 0;
99
  virtual bool setInstrumentationBreakpoint(int* id) const = 0;
100

101 102 103 104 105 106 107 108
#if V8_ENABLE_WEBASSEMBLY
  virtual v8::Maybe<v8::MemorySpan<const uint8_t>> wasmBytecode() const = 0;
  virtual v8::Maybe<v8::debug::WasmScript::DebugSymbolsType>
  getDebugSymbolsType() const = 0;
  virtual v8::Maybe<String16> getExternalDebugSymbolsURL() const = 0;
  void removeWasmBreakpoint(int id);
#endif  // V8_ENABLE_WEBASSEMBLY

109
 protected:
110 111
  V8DebuggerScript(v8::Isolate*, String16 id, String16 url,
                   String16 embedderName);
112

113 114
  virtual v8::Local<v8::debug::Script> script() const = 0;

115 116
  String16 m_id;
  String16 m_url;
117
  bool m_hasSourceURLComment = false;
118
  int m_executionContextId = 0;
119

120
  v8::Isolate* m_isolate;
121
  String16 m_embedderName;
122 123 124 125
};

}  // namespace v8_inspector

126
#endif  // V8_INSPECTOR_V8_DEBUGGER_SCRIPT_H_