23787ea7c91b1393b7a48ad1501402573a90a26c
[WebKit-https.git] / Source / JavaScriptCore / inspector / JSGlobalObjectInspectorController.h
1 /*
2  * Copyright (C) 2014, 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "InspectorAgentRegistry.h"
29 #include "InspectorEnvironment.h"
30 #include "InspectorFrontendRouter.h"
31 #include "JSGlobalObjectScriptDebugServer.h"
32 #include <wtf/Forward.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/text/WTFString.h>
35
36 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
37 #include "AugmentableInspectorController.h"
38 #endif
39
40 namespace JSC {
41 class CallFrame;
42 class ConsoleClient;
43 class Exception;
44 class JSGlobalObject;
45 using ExecState = CallFrame;
46 }
47
48 namespace Inspector {
49
50 class BackendDispatcher;
51 class FrontendChannel;
52 class InjectedScriptManager;
53 class InspectorAgent;
54 class InspectorConsoleAgent;
55 class InspectorDebuggerAgent;
56 class InspectorScriptProfilerAgent;
57 class JSGlobalObjectConsoleClient;
58 class ScriptCallStack;
59 struct JSAgentContext;
60
61 class JSGlobalObjectInspectorController final
62     : public InspectorEnvironment
63 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
64     , public AugmentableInspectorController
65 #endif
66 {
67     WTF_MAKE_NONCOPYABLE(JSGlobalObjectInspectorController);
68     WTF_MAKE_FAST_ALLOCATED;
69 public:
70     JSGlobalObjectInspectorController(JSC::JSGlobalObject&);
71     ~JSGlobalObjectInspectorController();
72
73     void connectFrontend(FrontendChannel&, bool isAutomaticInspection, bool immediatelyPause);
74     void disconnectFrontend(FrontendChannel&);
75
76     void dispatchMessageFromFrontend(const String&);
77
78     void globalObjectDestroyed();
79
80     bool includesNativeCallStackWhenReportingExceptions() const { return m_includeNativeCallStackWithExceptions; }
81     void setIncludesNativeCallStackWhenReportingExceptions(bool includesNativeCallStack) { m_includeNativeCallStackWithExceptions = includesNativeCallStack; }
82
83     void reportAPIException(JSC::ExecState*, JSC::Exception*);
84
85     JSC::ConsoleClient* consoleClient() const;
86
87     bool developerExtrasEnabled() const override;
88     bool canAccessInspectedScriptState(JSC::ExecState*) const override { return true; }
89     InspectorFunctionCallHandler functionCallHandler() const override;
90     InspectorEvaluateHandler evaluateHandler() const override;
91     void frontendInitialized() override;
92     Ref<WTF::Stopwatch> executionStopwatch() override;
93     JSGlobalObjectScriptDebugServer& scriptDebugServer() override;
94     JSC::VM& vm() override;
95
96 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
97     AugmentableInspectorControllerClient* augmentableInspectorControllerClient() const override { return m_augmentingClient; } 
98     void setAugmentableInspectorControllerClient(AugmentableInspectorControllerClient* client) override { m_augmentingClient = client; }
99
100     const FrontendRouter& frontendRouter() const override { return m_frontendRouter.get(); }
101     BackendDispatcher& backendDispatcher() override { return m_backendDispatcher.get(); }
102     void appendExtraAgent(std::unique_ptr<InspectorAgentBase>) override;
103 #endif
104
105 private:
106     void appendAPIBacktrace(ScriptCallStack&);
107
108     InspectorAgent& ensureInspectorAgent();
109     InspectorDebuggerAgent& ensureDebuggerAgent();
110
111     JSAgentContext jsAgentContext();
112     void createLazyAgents();
113
114     JSC::JSGlobalObject& m_globalObject;
115     std::unique_ptr<InjectedScriptManager> m_injectedScriptManager;
116     std::unique_ptr<JSGlobalObjectConsoleClient> m_consoleClient;
117     Ref<WTF::Stopwatch> m_executionStopwatch;
118     JSGlobalObjectScriptDebugServer m_scriptDebugServer;
119
120     AgentRegistry m_agents;
121     InspectorConsoleAgent* m_consoleAgent { nullptr };
122
123     // Lazy, but also on-demand agents.
124     InspectorAgent* m_inspectorAgent { nullptr };
125     InspectorDebuggerAgent* m_debuggerAgent { nullptr };
126
127     Ref<FrontendRouter> m_frontendRouter;
128     Ref<BackendDispatcher> m_backendDispatcher;
129
130     // Used to keep the JSGlobalObject and VM alive while we are debugging it.
131     JSC::Strong<JSC::JSGlobalObject> m_strongGlobalObject;
132     RefPtr<JSC::VM> m_strongVM;
133
134     bool m_includeNativeCallStackWithExceptions { true };
135     bool m_isAutomaticInspection { false };
136     bool m_pauseAfterInitialization { false };
137     bool m_didCreateLazyAgents { false };
138
139 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
140     AugmentableInspectorControllerClient* m_augmentingClient { nullptr };
141 #endif
142 };
143
144 } // namespace Inspector