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