405e69385571d55f0f9cf32efb1b580dce3f562f
[WebKit-https.git] / Source / WebCore / inspector / InspectorController.h
1 /*
2  * Copyright (C) 2011 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef InspectorController_h
32 #define InspectorController_h
33
34 #if ENABLE(INSPECTOR)
35
36 #include "InspectorInstrumentationCookie.h"
37 #include <inspector/InspectorAgentRegistry.h>
38 #include <inspector/InspectorEnvironment.h>
39 #include <wtf/Forward.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/Noncopyable.h>
42 #include <wtf/Vector.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace Inspector {
46 class InspectorAgent;
47 class InspectorObject;
48 class InspectorFrontendChannel;
49 class InspectorBackendDispatcher;
50 }
51
52 namespace WebCore {
53
54 class DOMWrapperWorld;
55 class Frame;
56 class GraphicsContext;
57 class InspectorApplicationCacheAgent;
58 class InspectorClient;
59 class InspectorDOMAgent;
60 class InspectorDOMDebuggerAgent;
61 class InspectorDebuggerAgent;
62 class InspectorFrontendClient;
63 class InspectorMemoryAgent;
64 class InspectorOverlay;
65 class InspectorPageAgent;
66 class InspectorProfilerAgent;
67 class InspectorResourceAgent;
68 class InstrumentingAgents;
69 class IntSize;
70 class Page;
71 class PageInjectedScriptManager;
72 class Node;
73
74 struct Highlight;
75
76 class InspectorController final : public Inspector::InspectorEnvironment {
77     WTF_MAKE_NONCOPYABLE(InspectorController);
78     WTF_MAKE_FAST_ALLOCATED;
79 public:
80     InspectorController(Page&, InspectorClient*);
81     virtual ~InspectorController();
82
83     void inspectedPageDestroyed();
84
85     bool enabled() const;
86     Page& inspectedPage() const;
87
88     void show();
89     void close();
90
91     void setInspectorFrontendClient(std::unique_ptr<InspectorFrontendClient>);
92     bool hasInspectorFrontendClient() const;
93     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld&);
94
95     void dispatchMessageFromFrontend(const String& message);
96
97     bool hasFrontend() const { return !!m_inspectorFrontendChannel; }
98     bool hasLocalFrontend() const;
99     bool hasRemoteFrontend() const;
100
101     void connectFrontend(Inspector::InspectorFrontendChannel*);
102     void disconnectFrontend(Inspector::InspectorDisconnectReason);
103     void setProcessId(long);
104
105 #if ENABLE(REMOTE_INSPECTOR)
106     void setHasRemoteFrontend(bool hasRemote) { m_hasRemoteFrontend = hasRemote; }
107 #endif
108
109     void inspect(Node*);
110     void drawHighlight(GraphicsContext&) const;
111     void getHighlight(Highlight*) const;
112     void hideHighlight();
113     Node* highlightedNode() const;
114
115     void setIndicating(bool);
116
117     PassRefPtr<Inspector::InspectorObject> buildObjectForHighlightedNode() const;
118
119     bool isUnderTest();
120     void evaluateForTestInFrontend(long callId, const String& script);
121
122 #if ENABLE(JAVASCRIPT_DEBUGGER)
123     bool profilerEnabled() const;
124     void setProfilerEnabled(bool);
125
126     void resume();
127 #endif
128
129     void setResourcesDataSizeLimitsFromInternals(int maximumResourcesContentSize, int maximumSingleResourceContentSize);
130
131     InspectorClient* inspectorClient() const { return m_inspectorClient; }
132     InspectorPageAgent* pageAgent() const { return m_pageAgent; }
133
134     void didBeginFrame();
135     void didCancelFrame();
136     void willComposite();
137     void didComposite();
138
139     virtual bool developerExtrasEnabled() const override;
140     virtual bool canAccessInspectedScriptState(JSC::ExecState*) const override;
141     virtual Inspector::InspectorFunctionCallHandler functionCallHandler() const override;
142     virtual Inspector::InspectorEvaluateHandler evaluateHandler() const override;
143     virtual void willCallInjectedScriptFunction(JSC::ExecState*, const String& scriptName, int scriptLine) override;
144     virtual void didCallInjectedScriptFunction() override;
145
146 private:
147     friend InstrumentingAgents* instrumentationForPage(Page*);
148
149     RefPtr<InstrumentingAgents> m_instrumentingAgents;
150     std::unique_ptr<PageInjectedScriptManager> m_injectedScriptManager;
151     std::unique_ptr<InspectorOverlay> m_overlay;
152
153     Inspector::InspectorAgent* m_inspectorAgent;
154     InspectorDOMAgent* m_domAgent;
155     InspectorResourceAgent* m_resourceAgent;
156     InspectorPageAgent* m_pageAgent;
157     InspectorMemoryAgent* m_memoryAgent;
158 #if ENABLE(JAVASCRIPT_DEBUGGER)
159     InspectorDebuggerAgent* m_debuggerAgent;
160     InspectorDOMDebuggerAgent* m_domDebuggerAgent;
161     InspectorProfilerAgent* m_profilerAgent;
162 #endif
163
164     RefPtr<Inspector::InspectorBackendDispatcher> m_inspectorBackendDispatcher;
165     std::unique_ptr<InspectorFrontendClient> m_inspectorFrontendClient;
166     Inspector::InspectorFrontendChannel* m_inspectorFrontendChannel;
167     Page& m_page;
168     InspectorClient* m_inspectorClient;
169     Inspector::InspectorAgentRegistry m_agents;
170     Vector<InspectorInstrumentationCookie, 2> m_injectedScriptInstrumentationCookies;
171     bool m_isUnderTest;
172
173 #if ENABLE(REMOTE_INSPECTOR)
174     bool m_hasRemoteFrontend;
175 #endif
176 };
177
178 }
179
180 #endif // ENABLE(INSPECTOR)
181
182 #endif // !defined(InspectorController_h)