f66ebe36b1e9ba7974794fa8fa656f2a11c44cae
[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 #ifndef JSGlobalObjectInspectorController_h
27 #define JSGlobalObjectInspectorController_h
28
29 #include "InspectorAgentRegistry.h"
30 #include "InspectorEnvironment.h"
31 #include "InspectorFrontendRouter.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 WTF {
41 class Stopwatch;
42 }
43
44 namespace JSC {
45 class ConsoleClient;
46 class Exception;
47 class ExecState;
48 class JSGlobalObject;
49 class JSValue;
50 }
51
52 namespace Inspector {
53
54 class BackendDispatcher;
55 class FrontendChannel;
56 class InjectedScriptManager;
57 class InspectorAgent;
58 class InspectorConsoleAgent;
59 class InspectorDebuggerAgent;
60 class InspectorHeapAgent;
61 class JSGlobalObjectConsoleClient;
62 class ScriptCallStack;
63
64 class JSGlobalObjectInspectorController final
65     : public InspectorEnvironment
66 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
67     , public AugmentableInspectorController
68 #endif
69 {
70     WTF_MAKE_NONCOPYABLE(JSGlobalObjectInspectorController);
71     WTF_MAKE_FAST_ALLOCATED;
72 public:
73     JSGlobalObjectInspectorController(JSC::JSGlobalObject&);
74     ~JSGlobalObjectInspectorController();
75
76     void connectFrontend(FrontendChannel*, bool isAutomaticInspection);
77     void disconnectFrontend(FrontendChannel*);
78     void disconnectAllFrontends();
79
80     void dispatchMessageFromFrontend(const String&);
81
82     void globalObjectDestroyed();
83
84     bool includesNativeCallStackWhenReportingExceptions() const { return m_includeNativeCallStackWithExceptions; }
85     void setIncludesNativeCallStackWhenReportingExceptions(bool includesNativeCallStack) { m_includeNativeCallStackWithExceptions = includesNativeCallStack; }
86
87     void pause();
88     void reportAPIException(JSC::ExecState*, JSC::Exception*);
89
90     JSC::ConsoleClient* consoleClient() const;
91
92     virtual bool developerExtrasEnabled() const override;
93     virtual bool canAccessInspectedScriptState(JSC::ExecState*) const override { return true; }
94     virtual InspectorFunctionCallHandler functionCallHandler() const override;
95     virtual InspectorEvaluateHandler evaluateHandler() const override;
96     virtual void willCallInjectedScriptFunction(JSC::ExecState*, const String&, int) override { }
97     virtual void didCallInjectedScriptFunction(JSC::ExecState*) override { }
98     virtual void frontendInitialized() override;
99     virtual Ref<WTF::Stopwatch> executionStopwatch() override;
100     virtual JSC::VM& vm() override;
101
102 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
103     virtual AugmentableInspectorControllerClient* augmentableInspectorControllerClient() const override { return m_augmentingClient; } 
104     virtual void setAugmentableInspectorControllerClient(AugmentableInspectorControllerClient* client) override { m_augmentingClient = client; }
105
106     virtual const FrontendRouter& frontendRouter() const override { return m_frontendRouter.get(); }
107     virtual BackendDispatcher& backendDispatcher() override { return m_backendDispatcher.get(); }
108     virtual void appendExtraAgent(std::unique_ptr<InspectorAgentBase>) override;
109 #endif
110
111 private:
112     void appendAPIBacktrace(ScriptCallStack* callStack);
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
119     AgentRegistry m_agents;
120     InspectorAgent* m_inspectorAgent { nullptr };
121     InspectorConsoleAgent* m_consoleAgent { nullptr };
122     InspectorDebuggerAgent* m_debuggerAgent { nullptr };
123     InspectorHeapAgent* m_heapAgent { nullptr };
124
125     Ref<FrontendRouter> m_frontendRouter;
126     Ref<BackendDispatcher> m_backendDispatcher;
127
128     bool m_includeNativeCallStackWithExceptions { false };
129     bool m_isAutomaticInspection { false };
130
131 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
132     AugmentableInspectorControllerClient* m_augmentingClient { nullptr };
133 #endif
134 };
135
136 } // namespace Inspector
137
138 #endif // !defined(JSGlobalObjectInspectorController_h)