Unreviewed, rolling out r224863.
[WebKit-https.git] / Source / WebCore / inspector / InspectorController.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2015 Apple 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 are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "InspectorOverlay.h"
35 #include "PageScriptDebugServer.h"
36 #include <inspector/InspectorAgentRegistry.h>
37 #include <inspector/InspectorEnvironment.h>
38 #include <wtf/Forward.h>
39 #include <wtf/Noncopyable.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace Inspector {
43 class BackendDispatcher;
44 class FrontendChannel;
45 class FrontendRouter;
46 class InspectorAgent;
47
48 namespace Protocol {
49 namespace OverlayTypes {
50 class NodeHighlightData;
51 }
52 }
53 }
54
55 namespace WebCore {
56
57 class DOMWrapperWorld;
58 class Frame;
59 class GraphicsContext;
60 class InspectorClient;
61 class InspectorDOMAgent;
62 class InspectorFrontendClient;
63 class InspectorInstrumentation;
64 class InspectorPageAgent;
65 class InstrumentingAgents;
66 class Node;
67 class Page;
68 class WebInjectedScriptManager;
69 struct PageAgentContext;
70
71 class InspectorController final : public Inspector::InspectorEnvironment {
72     WTF_MAKE_NONCOPYABLE(InspectorController);
73     WTF_MAKE_FAST_ALLOCATED;
74 public:
75     InspectorController(Page&, InspectorClient*);
76     virtual ~InspectorController();
77
78     void inspectedPageDestroyed();
79
80     bool enabled() const;
81     Page& inspectedPage() const;
82
83     WEBCORE_EXPORT void show();
84
85     WEBCORE_EXPORT void setInspectorFrontendClient(InspectorFrontendClient*);
86     unsigned inspectionLevel() const;
87     void didClearWindowObjectInWorld(Frame&, DOMWrapperWorld&);
88
89     WEBCORE_EXPORT void dispatchMessageFromFrontend(const String& message);
90
91     bool hasLocalFrontend() const;
92     bool hasRemoteFrontend() const;
93
94     WEBCORE_EXPORT void connectFrontend(Inspector::FrontendChannel*, bool isAutomaticInspection = false, bool immediatelyPause = false);
95     WEBCORE_EXPORT void disconnectFrontend(Inspector::FrontendChannel*);
96     WEBCORE_EXPORT void disconnectAllFrontends();
97     void setProcessId(long);
98
99     void inspect(Node*);
100     WEBCORE_EXPORT void drawHighlight(GraphicsContext&) const;
101     WEBCORE_EXPORT void getHighlight(Highlight&, InspectorOverlay::CoordinateSystem) const;
102     void hideHighlight();
103     Node* highlightedNode() const;
104
105     void setIndicating(bool);
106
107     WEBCORE_EXPORT Ref<Inspector::Protocol::Array<Inspector::Protocol::OverlayTypes::NodeHighlightData>> buildObjectForHighlightedNodes() const;
108
109     WEBCORE_EXPORT void didComposite(Frame&);
110
111     bool isUnderTest() const { return m_isUnderTest; }
112     WEBCORE_EXPORT void setIsUnderTest(bool);
113     WEBCORE_EXPORT void evaluateForTestInFrontend(const String& script);
114
115     InspectorClient* inspectorClient() const { return m_inspectorClient; }
116     InspectorFrontendClient* inspectorFrontendClient() const { return m_inspectorFrontendClient; }
117     InspectorPageAgent* pageAgent() const { return m_pageAgent; }
118
119     // InspectorEnvironment
120     bool developerExtrasEnabled() const override;
121     bool canAccessInspectedScriptState(JSC::ExecState*) const override;
122     Inspector::InspectorFunctionCallHandler functionCallHandler() const override;
123     Inspector::InspectorEvaluateHandler evaluateHandler() const override;
124     void frontendInitialized() override;
125     Ref<WTF::Stopwatch> executionStopwatch() override;
126     PageScriptDebugServer& scriptDebugServer() override;
127     JSC::VM& vm() override;
128
129 private:
130     friend class InspectorInstrumentation;
131
132     PageAgentContext pageAgentContext();
133     void createLazyAgents();
134
135     Ref<InstrumentingAgents> m_instrumentingAgents;
136     std::unique_ptr<WebInjectedScriptManager> m_injectedScriptManager;
137     Ref<Inspector::FrontendRouter> m_frontendRouter;
138     Ref<Inspector::BackendDispatcher> m_backendDispatcher;
139     std::unique_ptr<InspectorOverlay> m_overlay;
140     Ref<WTF::Stopwatch> m_executionStopwatch;
141     PageScriptDebugServer m_scriptDebugServer;
142     Inspector::AgentRegistry m_agents;
143
144     Page& m_page;
145     InspectorClient* m_inspectorClient;
146     InspectorFrontendClient* m_inspectorFrontendClient { nullptr };
147
148     Inspector::InspectorAgent* m_inspectorAgent { nullptr };
149     InspectorDOMAgent* m_domAgent { nullptr };
150     InspectorPageAgent* m_pageAgent { nullptr };
151
152     bool m_isUnderTest { false };
153     bool m_isAutomaticInspection { false };
154     bool m_pauseAfterInitialization = { false };
155     bool m_didCreateLazyAgents { false };
156 };
157
158 } // namespace WebCore