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