Unreviewed, rolling out r190520, some tests assert / crash.
[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
45 namespace JSC {
46 class ConsoleClient;
47 class Exception;
48 class ExecState;
49 class JSGlobalObject;
50 class JSValue;
51 }
52
53 namespace Inspector {
54
55 class BackendDispatcher;
56 class FrontendChannel;
57 class InjectedScriptManager;
58 class InspectorAgent;
59 class InspectorConsoleAgent;
60 class InspectorDebuggerAgent;
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
101 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
102     virtual AugmentableInspectorControllerClient* augmentableInspectorControllerClient() const override { return m_augmentingClient; } 
103     virtual void setAugmentableInspectorControllerClient(AugmentableInspectorControllerClient* client) override { m_augmentingClient = client; }
104
105     virtual const FrontendRouter& frontendRouter() const override { return m_frontendRouter.get(); }
106     virtual BackendDispatcher& backendDispatcher() override { return m_backendDispatcher.get(); }
107     virtual void appendExtraAgent(std::unique_ptr<InspectorAgentBase>) override;
108 #endif
109
110 private:
111     void appendAPIBacktrace(ScriptCallStack* callStack);
112
113     std::unique_ptr<InjectedScriptManager> m_injectedScriptManager;
114     std::unique_ptr<JSGlobalObjectConsoleClient> m_consoleClient;
115     Ref<WTF::Stopwatch> m_executionStopwatch;
116
117     AgentRegistry m_agents;
118     InspectorAgent* m_inspectorAgent { nullptr };
119     InspectorConsoleAgent* m_consoleAgent { nullptr };
120     InspectorDebuggerAgent* m_debuggerAgent { nullptr };
121
122     Ref<FrontendRouter> m_frontendRouter;
123     Ref<BackendDispatcher> m_backendDispatcher;
124
125     bool m_includeNativeCallStackWithExceptions { false };
126     bool m_isAutomaticInspection { false };
127
128 #if ENABLE(REMOTE_INSPECTOR)
129     JSC::JSGlobalObject& m_globalObject;
130 #endif
131
132 #if ENABLE(INSPECTOR_ALTERNATE_DISPATCHERS)
133     AugmentableInspectorControllerClient* m_augmentingClient { nullptr };
134 #endif
135 };
136
137 } // namespace Inspector
138
139 #endif // !defined(JSGlobalObjectInspectorController_h)