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