d15c1eb3719bae1a835394bbbe3a90790596c201
[WebKit-https.git] / Source / WebCore / inspector / InspectorAgent.h
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef InspectorAgent_h
30 #define InspectorAgent_h
31
32 #include "CharacterData.h"
33 #include "Console.h"
34 #include "Cookie.h"
35 #include "Page.h"
36 #include "PlatformString.h"
37 #include <wtf/HashMap.h>
38 #include <wtf/HashSet.h>
39 #include <wtf/ListHashSet.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/Vector.h>
42 #include <wtf/text/StringHash.h>
43
44 namespace WebCore {
45
46 class CachedResource;
47 class CharacterData;
48 class Database;
49 class DOMWrapperWorld;
50 class Document;
51 class DocumentLoader;
52 class FloatRect;
53 class GraphicsContext;
54 class HTTPHeaderMap;
55 class HitTestResult;
56 class InjectedScript;
57 class InjectedScriptHost;
58 class InspectorArray;
59 class InspectorBrowserDebuggerAgent;
60 class InspectorClient;
61 class InspectorConsoleAgent;
62 class InspectorCSSAgent;
63 class InspectorDOMAgent;
64 class InspectorDOMStorageAgent;
65 class InspectorDOMStorageResource;
66 class InspectorDatabaseAgent;
67 class InspectorDatabaseResource;
68 class InspectorDebuggerAgent;
69 class InspectorFrontend;
70 class InspectorFrontendClient;
71 class InspectorObject;
72 class InspectorProfilerAgent;
73 class InspectorResourceAgent;
74 class InspectorRuntimeAgent;
75 class InspectorState;
76 class InspectorStorageAgent;
77 class InspectorTimelineAgent;
78 class InspectorValue;
79 class InspectorWorkerResource;
80 class IntRect;
81 class KURL;
82 class Node;
83 class Page;
84 class ResourceRequest;
85 class ResourceResponse;
86 class ResourceError;
87 class ScriptArguments;
88 class ScriptCallStack;
89 class ScriptProfile;
90 class SharedBuffer;
91 class StorageArea;
92
93 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
94 class InspectorApplicationCacheAgent;
95 #endif
96
97 #if ENABLE(FILE_SYSTEM)
98 class InspectorFileSystemAgent;
99 #endif
100
101 #if ENABLE(WEB_SOCKETS)
102 class WebSocketHandshakeRequest;
103 class WebSocketHandshakeResponse;
104 #endif
105
106 class InspectorAgent {
107     WTF_MAKE_NONCOPYABLE(InspectorAgent);
108     WTF_MAKE_FAST_ALLOCATED;
109 public:
110     InspectorAgent(Page*, InspectorClient*);
111     virtual ~InspectorAgent();
112
113     InspectorClient* inspectorClient() { return m_client; }
114     InjectedScriptHost* injectedScriptHost() { return m_injectedScriptHost.get(); }
115
116     void inspectedPageDestroyed();
117
118     bool enabled() const;
119
120     Page* inspectedPage() const { return m_inspectedPage; }
121     KURL inspectedURL() const;
122     KURL inspectedURLWithoutFragment() const;
123     void reloadPage(bool ignoreCache);
124     void showConsole();
125
126     void restoreInspectorStateFromCookie(const String& inspectorCookie);
127
128     void highlight(Node*);
129     void hideHighlight();
130     void inspect(Node*);
131     void highlightDOMNode(long nodeId);
132     void hideDOMNodeHighlight() { hideHighlight(); }
133
134     void highlightFrame(unsigned long frameId);
135     void hideFrameHighlight() { hideHighlight(); }
136
137     void setFrontend(InspectorFrontend*);
138     InspectorFrontend* frontend() const { return m_frontend; }
139     void disconnectFrontend();
140
141     InspectorResourceAgent* resourceAgent();
142
143     InspectorAgent* inspectorAgent() { return this; }
144     InspectorConsoleAgent* consoleAgent() { return m_consoleAgent.get(); }
145     InspectorCSSAgent* cssAgent() { return m_cssAgent.get(); }
146     InspectorDOMAgent* domAgent() { return m_domAgent.get(); }
147     InjectedScriptHost* injectedScriptAgent() { return m_injectedScriptHost.get(); }
148     InspectorRuntimeAgent* runtimeAgent() { return m_runtimeAgent.get(); }
149     InspectorTimelineAgent* timelineAgent() { return m_timelineAgent.get(); }
150 #if ENABLE(DATABASE)
151     InspectorDatabaseAgent* databaseAgent() { return m_databaseAgent.get(); }
152 #endif
153 #if ENABLE(DOM_STORAGE)
154     InspectorDOMStorageAgent* domStorageAgent() { return m_domStorageAgent.get(); }
155 #endif
156 #if ENABLE(FILE_SYSTEM)
157     InspectorFileSystemAgent* fileSystemAgent() { return m_fileSystemAgent.get(); }
158 #endif
159 #if ENABLE(JAVASCRIPT_DEBUGGER)
160     InspectorBrowserDebuggerAgent* browserDebuggerAgent() const { return m_browserDebuggerAgent.get(); }
161     InspectorDebuggerAgent* debuggerAgent() const { return m_debuggerAgent.get(); }
162     InspectorProfilerAgent* profilerAgent() const { return m_profilerAgent.get(); }
163 #endif
164 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
165     InspectorApplicationCacheAgent* applicationCacheAgent() { return m_applicationCacheAgent.get(); }
166 #endif
167
168     bool handleMousePress();
169     bool searchingForNodeInPage() const;
170     void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
171
172     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
173
174     void didCommitLoad(DocumentLoader*);
175
176     void startTimelineProfiler();
177     void stopTimelineProfiler();
178
179     void getCookies(RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
180     void deleteCookie(const String& cookieName, const String& domain);
181
182     void mainResourceFiredLoadEvent(DocumentLoader*, const KURL&);
183     void mainResourceFiredDOMContentEvent(DocumentLoader*, const KURL&);
184
185 #if ENABLE(WORKERS)
186     enum WorkerAction { WorkerCreated, WorkerDestroyed };
187
188     void postWorkerNotificationToFrontend(const InspectorWorkerResource&, WorkerAction);
189     void didCreateWorker(intptr_t, const String& url, bool isSharedWorker);
190     void didDestroyWorker(intptr_t);
191 #endif
192
193 #if ENABLE(DATABASE)
194     void didOpenDatabase(PassRefPtr<Database>, const String& domain, const String& name, const String& version);
195 #endif
196
197 #if ENABLE(DOM_STORAGE)
198     void didUseDOMStorage(StorageArea*, bool isLocalStorage, Frame*);
199 #endif
200
201 #if ENABLE(WEB_SOCKETS)
202     void didCreateWebSocket(unsigned long identifier, const KURL& requestURL, const KURL& documentURL);
203     void willSendWebSocketHandshakeRequest(unsigned long identifier, const WebSocketHandshakeRequest&);
204     void didReceiveWebSocketHandshakeResponse(unsigned long identifier, const WebSocketHandshakeResponse&);
205     void didCloseWebSocket(unsigned long identifier);
206 #endif
207
208     bool hasFrontend() const { return m_frontend; }
209
210     void drawNodeHighlight(GraphicsContext&) const;
211     void openInInspectedWindow(const String& url);
212     void drawElementTitle(GraphicsContext&, const IntRect& boundingBox, const FloatRect& overlayRect, WebCore::Settings*) const;
213
214 #if ENABLE(JAVASCRIPT_DEBUGGER)
215     bool isRecordingUserInitiatedProfile() const;
216     void startProfiling() { startUserInitiatedProfiling(); }
217     void startUserInitiatedProfiling();
218     void stopProfiling() { stopUserInitiatedProfiling(); }
219     void stopUserInitiatedProfiling();
220     void enableProfiler();
221     void disableProfiler();
222     bool profilerEnabled() const;
223
224     void showAndEnableDebugger();
225     void enableDebugger() { enableDebugger(false); }
226     void enableDebugger(bool eraseStickyBreakpoints);
227     void disableDebugger();
228     bool debuggerEnabled() const { return m_debuggerAgent; }
229     void resume();
230 #endif
231
232     // Generic code called from custom implementations.
233     void evaluateForTestInFrontend(long testCallId, const String& script);
234
235     void addScriptToEvaluateOnLoad(const String& source);
236     void removeAllScriptsToEvaluateOnLoad();
237     void setInspectorExtensionAPI(const String& source);
238
239     InspectorState* state() { return m_state.get(); }
240
241     // InspectorAgent API
242     void getInspectorState(RefPtr<InspectorObject>* state);
243     void setMonitoringXHREnabled(bool enabled, bool* newState);
244     void populateScriptObjects();
245     // Following are used from InspectorBackend and internally.
246     void setSearchingForNode(bool enabled, bool* newState);
247     void didEvaluateForTestInFrontend(long callId, const String& jsonResult);
248
249     void setUserAgentOverride(const String& userAgent);
250     void applyUserAgentOverride(String* userAgent) const;
251
252 private:
253     void showPanel(const String& panel);
254     void pushDataCollectedOffline();
255     void restoreDebugger(bool eraseStickyBreakpoints);
256     enum ProfilerRestoreAction {
257         ProfilerRestoreNoAction = 0,
258         ProfilerRestoreResetAgent = 1
259     };
260     void restoreProfiler(ProfilerRestoreAction);
261     void unbindAllResources();
262     void setSearchingForNode(bool enabled);
263
264     void releaseFrontendLifetimeAgents();
265     void createFrontendLifetimeAgents();
266
267 #if ENABLE(JAVASCRIPT_DEBUGGER)
268     void toggleRecordButton(bool);
269 #endif
270
271     PassRefPtr<InspectorObject> buildObjectForCookie(const Cookie&);
272     PassRefPtr<InspectorArray> buildArrayForCookies(ListHashSet<Cookie>&);
273
274     void focusNode();
275     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
276
277     Page* m_inspectedPage;
278     InspectorClient* m_client;
279     InspectorFrontend* m_frontend;
280     OwnPtr<InspectorCSSAgent> m_cssAgent;
281     RefPtr<InspectorDOMAgent> m_domAgent;
282
283 #if ENABLE(DATABASE)
284     RefPtr<InspectorDatabaseAgent> m_databaseAgent;
285 #endif
286
287 #if ENABLE(DOM_STORAGE)
288     RefPtr<InspectorDOMStorageAgent> m_domStorageAgent;
289 #endif
290
291     OwnPtr<InspectorTimelineAgent> m_timelineAgent;
292     OwnPtr<InspectorState> m_state;
293
294 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
295     OwnPtr<InspectorApplicationCacheAgent> m_applicationCacheAgent;
296 #endif
297
298 #if ENABLE(FILE_SYSTEM)
299     RefPtr<InspectorFileSystemAgent> m_fileSystemAgent;
300 #endif
301
302     RefPtr<Node> m_highlightedNode;
303     RefPtr<Node> m_nodeToFocus;
304     RefPtr<InspectorResourceAgent> m_resourceAgent;
305     OwnPtr<InspectorRuntimeAgent> m_runtimeAgent;
306
307 #if ENABLE(DATABASE)
308     typedef HashMap<int, RefPtr<InspectorDatabaseResource> > DatabaseResourcesMap;
309     DatabaseResourcesMap m_databaseResources;
310 #endif
311 #if ENABLE(DOM_STORAGE)
312     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
313     DOMStorageResourcesMap m_domStorageResources;
314 #endif
315
316     RefPtr<InjectedScriptHost> m_injectedScriptHost;
317     OwnPtr<InspectorConsoleAgent> m_consoleAgent;
318
319     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
320     String m_requiredPanel;
321     Vector<String> m_scriptsToEvaluateOnLoad;
322     String m_inspectorExtensionAPI;
323 #if ENABLE(JAVASCRIPT_DEBUGGER)
324     OwnPtr<InspectorDebuggerAgent> m_debuggerAgent;
325     OwnPtr<InspectorBrowserDebuggerAgent> m_browserDebuggerAgent;
326     OwnPtr<InspectorProfilerAgent> m_profilerAgent;
327 #endif
328     String m_userAgentOverride;
329 #if ENABLE(WORKERS)
330     typedef HashMap<intptr_t, RefPtr<InspectorWorkerResource> > WorkersMap;
331
332     WorkersMap m_workers;
333 #endif
334 };
335
336 } // namespace WebCore
337
338 #endif // !defined(InspectorAgent_h)