• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef V8_INSPECTOR_V8_DEBUGGER_SCRIPT_H_
31 #define V8_INSPECTOR_V8_DEBUGGER_SCRIPT_H_
32 
33 #include <memory>
34 
35 #include "include/v8-local-handle.h"
36 #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 namespace v8 {
43 class Isolate;
44 }
45 
46 namespace v8_inspector {
47 
48 class V8DebuggerAgentImpl;
49 class V8InspectorClient;
50 
51 class V8DebuggerScript {
52  public:
53   enum class Language { JavaScript, WebAssembly };
54   static std::unique_ptr<V8DebuggerScript> Create(
55       v8::Isolate* isolate, v8::Local<v8::debug::Script> script,
56       bool isLiveEdit, V8DebuggerAgentImpl* agent, V8InspectorClient* client);
57 
58   virtual ~V8DebuggerScript();
59   V8DebuggerScript(const V8DebuggerScript&) = delete;
60   V8DebuggerScript& operator=(const V8DebuggerScript&) = delete;
61 
62   v8::Local<v8::debug::ScriptSource> scriptSource();
scriptId()63   const String16& scriptId() const { return m_id; }
hasSourceURLComment()64   bool hasSourceURLComment() const { return m_hasSourceURLComment; }
sourceURL()65   const String16& sourceURL() const { return m_url; }
embedderName()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   virtual int startLine() const = 0;
73   virtual int startColumn() const = 0;
74   virtual int endLine() const = 0;
75   virtual int endColumn() const = 0;
76   virtual int codeOffset() const = 0;
executionContextId()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   virtual bool getPossibleBreakpoints(
88       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   static const int kNoOffset = -1;
94   virtual int offset(int lineNumber, int columnNumber) const = 0;
95   virtual v8::debug::Location location(int offset) const = 0;
96 
97   virtual bool setBreakpoint(const String16& condition,
98                              v8::debug::Location* location, int* id) const = 0;
99   virtual void MakeWeak() = 0;
100   virtual bool setInstrumentationBreakpoint(int* id) const = 0;
101 
102 #if V8_ENABLE_WEBASSEMBLY
103   virtual v8::Maybe<v8::MemorySpan<const uint8_t>> wasmBytecode() const = 0;
104   virtual v8::Maybe<v8::debug::WasmScript::DebugSymbolsType>
105   getDebugSymbolsType() const = 0;
106   virtual v8::Maybe<String16> getExternalDebugSymbolsURL() const = 0;
107   void removeWasmBreakpoint(int id);
108 #endif  // V8_ENABLE_WEBASSEMBLY
109 
110  protected:
111   V8DebuggerScript(v8::Isolate*, String16 id, String16 url,
112                    String16 embedderName);
113 
114   virtual v8::Local<v8::debug::Script> script() const = 0;
115 
116   String16 m_id;
117   String16 m_url;
118   bool m_hasSourceURLComment = false;
119   int m_executionContextId = 0;
120 
121   v8::Isolate* m_isolate;
122   String16 m_embedderName;
123 };
124 
125 }  // namespace v8_inspector
126 
127 #endif  // V8_INSPECTOR_V8_DEBUGGER_SCRIPT_H_
128