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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
/*
* Copyright (C) 2010, 2013, 2015-2016 Apple Inc. All rights reserved.
* Copyright (C) 2010, 2011 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 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.
*/
#pragma once
#include "InspectorBackendDispatchers.h"
#include "InspectorFrontendDispatchers.h"
#include "bindings/ScriptValue.h"
#include "debugger/Debugger.h"
#include "inspector/InspectorAgentBase.h"
#include "inspector/ScriptBreakpoint.h"
#include "inspector/ScriptCallStack.h"
#include "inspector/ScriptDebugListener.h"
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/Noncopyable.h>
#include <wtf/Vector.h>
namespace Inspector {
class AsyncStackTrace;
class InjectedScript;
class InjectedScriptManager;
class InspectorArray;
class InspectorObject;
class ScriptDebugServer;
typedef String ErrorString;
class JS_EXPORT_PRIVATE InspectorDebuggerAgent : public InspectorAgentBase, public ScriptDebugListener, public DebuggerBackendDispatcherHandler {
WTF_MAKE_NONCOPYABLE(InspectorDebuggerAgent);
WTF_MAKE_FAST_ALLOCATED;
public:
static const char* backtraceObjectGroup;
virtual ~InspectorDebuggerAgent();
void didCreateFrontendAndBackend(FrontendRouter*, BackendDispatcher*) final;
void willDestroyFrontendAndBackend(DisconnectReason) final;
void enable(ErrorString&) final;
void disable(ErrorString&) final;
void setAsyncStackTraceDepth(ErrorString&, int depth) final;
void setBreakpointsActive(ErrorString&, bool active) final;
void setBreakpointByUrl(ErrorString&, int lineNumber, const String* const optionalURL, const String* const optionalURLRegex, const int* const optionalColumnNumber, const Inspector::InspectorObject* options, Inspector::Protocol::Debugger::BreakpointId*, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Debugger::Location>>& locations) final;
void setBreakpoint(ErrorString&, const Inspector::InspectorObject& location, const Inspector::InspectorObject* options, Inspector::Protocol::Debugger::BreakpointId*, RefPtr<Inspector::Protocol::Debugger::Location>& actualLocation) final;
void removeBreakpoint(ErrorString&, const String& breakpointIdentifier) final;
void continueUntilNextRunLoop(ErrorString&) final;
void continueToLocation(ErrorString&, const InspectorObject& location) final;
void searchInContent(ErrorString&, const String& scriptID, const String& query, const bool* const optionalCaseSensitive, const bool* const optionalIsRegex, RefPtr<Inspector::Protocol::Array<Inspector::Protocol::GenericTypes::SearchMatch>>&) final;
void getScriptSource(ErrorString&, const String& scriptID, String* scriptSource) final;
void getFunctionDetails(ErrorString&, const String& functionId, RefPtr<Inspector::Protocol::Debugger::FunctionDetails>&) final;
void pause(ErrorString&) final;
void resume(ErrorString&) final;
void stepOver(ErrorString&) final;
void stepInto(ErrorString&) final;
void stepOut(ErrorString&) final;
void setPauseOnExceptions(ErrorString&, const String& pauseState) final;
void setPauseOnAssertions(ErrorString&, bool enabled) final;
void evaluateOnCallFrame(ErrorString&, const String& callFrameId, const String& expression, const String* const objectGroup, const bool* const includeCommandLineAPI, const bool* const doNotPauseOnExceptionsAndMuteConsole, const bool* const returnByValue, const bool* const generatePreview, const bool* const saveResult, RefPtr<Inspector::Protocol::Runtime::RemoteObject>& result, Inspector::Protocol::OptOutput<bool>* wasThrown, Inspector::Protocol::OptOutput<int>* savedResultIndex) final;
void setOverlayMessage(ErrorString&, const String* const) override;
bool isPaused() const;
bool breakpointsActive() const;
void setSuppressAllPauses(bool);
void handleConsoleAssert(const String& message);
void didScheduleAsyncCall(JSC::ExecState*, int asyncCallType, int callbackIdentifier, bool singleShot);
void didCancelAsyncCall(int asyncCallType, int callbackIdentifier);
void willDispatchAsyncCall(int asyncCallType, int callbackIdentifier);
void didDispatchAsyncCall();
void schedulePauseOnNextStatement(DebuggerFrontendDispatcher::Reason breakReason, RefPtr<InspectorObject>&& data);
void cancelPauseOnNextStatement();
bool pauseOnNextStatementEnabled() const { return m_javaScriptPauseScheduled; }
void breakProgram(DebuggerFrontendDispatcher::Reason breakReason, RefPtr<InspectorObject>&& data);
void scriptExecutionBlockedByCSP(const String& directiveText);
class Listener {
public:
virtual ~Listener() { }
virtual void debuggerWasEnabled() = 0;
virtual void debuggerWasDisabled() = 0;
};
void setListener(Listener* listener) { m_listener = listener; }
protected:
InspectorDebuggerAgent(AgentContext&);
InjectedScriptManager& injectedScriptManager() const { return m_injectedScriptManager; }
virtual InjectedScript injectedScriptForEval(ErrorString&, const int* executionContextId) = 0;
ScriptDebugServer& scriptDebugServer() { return m_scriptDebugServer; }
virtual void muteConsole() = 0;
virtual void unmuteConsole() = 0;
virtual void enable();
virtual void disable(bool skipRecompile);
void didPause(JSC::ExecState&, JSC::JSValue callFrames, JSC::JSValue exceptionOrCaughtValue) final;
void didContinue() final;
virtual String sourceMapURLForScript(const Script&);
void didClearGlobalObject();
private:
Ref<Inspector::Protocol::Array<Inspector::Protocol::Debugger::CallFrame>> currentCallFrames(const InjectedScript&);
void didParseSource(JSC::SourceID, const Script&) final;
void failedToParseSource(const String& url, const String& data, int firstLine, int errorLine, const String& errorMessage) final;
void breakpointActionSound(int breakpointActionIdentifier) final;
void breakpointActionProbe(JSC::ExecState&, const ScriptBreakpointAction&, unsigned batchId, unsigned sampleId, JSC::JSValue sample) final;
void resolveBreakpoint(const Script&, JSC::Breakpoint&);
void setBreakpoint(JSC::Breakpoint&, bool& existing);
void didSetBreakpoint(const JSC::Breakpoint&, const String&, const ScriptBreakpoint&);
bool assertPaused(ErrorString&);
void clearDebuggerBreakpointState();
void clearInspectorBreakpointState();
void clearBreakDetails();
void clearExceptionValue();
void clearAsyncStackTraceData();
enum class ShouldDispatchResumed { No, WhenIdle, WhenContinued };
void registerIdleHandler();
void willStepAndMayBecomeIdle();
void didBecomeIdle();
RefPtr<InspectorObject> buildBreakpointPauseReason(JSC::BreakpointID);
RefPtr<InspectorObject> buildExceptionPauseReason(JSC::JSValue exception, const InjectedScript&);
bool breakpointActionsFromProtocol(ErrorString&, RefPtr<InspectorArray>& actions, BreakpointActions* result);
typedef std::pair<int, int> AsyncCallIdentifier;
typedef HashMap<JSC::SourceID, Script> ScriptsMap;
typedef HashMap<String, Vector<JSC::BreakpointID>> BreakpointIdentifierToDebugServerBreakpointIDsMap;
typedef HashMap<String, RefPtr<InspectorObject>> BreakpointIdentifierToBreakpointMap;
typedef HashMap<JSC::BreakpointID, String> DebugServerBreakpointIDToBreakpointIdentifier;
InjectedScriptManager& m_injectedScriptManager;
std::unique_ptr<DebuggerFrontendDispatcher> m_frontendDispatcher;
RefPtr<DebuggerBackendDispatcher> m_backendDispatcher;
ScriptDebugServer& m_scriptDebugServer;
Listener* m_listener { nullptr };
JSC::ExecState* m_pausedScriptState { nullptr };
Deprecated::ScriptValue m_currentCallStack;
ScriptsMap m_scripts;
BreakpointIdentifierToDebugServerBreakpointIDsMap m_breakpointIdentifierToDebugServerBreakpointIDs;
BreakpointIdentifierToBreakpointMap m_javaScriptBreakpoints;
DebugServerBreakpointIDToBreakpointIdentifier m_debuggerBreakpointIdentifierToInspectorBreakpointIdentifier;
JSC::BreakpointID m_continueToLocationBreakpointID;
DebuggerFrontendDispatcher::Reason m_breakReason;
RefPtr<InspectorObject> m_breakAuxData;
ShouldDispatchResumed m_conditionToDispatchResumed { ShouldDispatchResumed::No };
bool m_enablePauseWhenIdle { false };
HashMap<AsyncCallIdentifier, RefPtr<AsyncStackTrace>> m_pendingAsyncCalls;
std::optional<AsyncCallIdentifier> m_currentAsyncCallIdentifier { std::nullopt };
bool m_enabled { false };
bool m_javaScriptPauseScheduled { false };
bool m_hasExceptionValue { false };
bool m_didPauseStopwatch { false };
bool m_pauseOnAssertionFailures { false };
bool m_registeredIdleCallback { false };
int m_asyncStackTraceDepth { 0 };
};
} // namespace Inspector
|
