2011-02-09 Pavel Feldman <pfeldman@chromium.org>
[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 InspectorController;
63 class InspectorCSSAgent;
64 class InspectorDOMAgent;
65 class InspectorDOMStorageAgent;
66 class InspectorDOMStorageResource;
67 class InspectorDatabaseAgent;
68 class InspectorDatabaseResource;
69 class InspectorDebuggerAgent;
70 class InspectorFrontend;
71 class InspectorFrontendClient;
72 class InspectorObject;
73 class InspectorProfilerAgent;
74 class InspectorResourceAgent;
75 class InspectorRuntimeAgent;
76 class InspectorState;
77 class InspectorStorageAgent;
78 class InspectorTimelineAgent;
79 class InspectorValue;
80 class InspectorWorkerResource;
81 class IntRect;
82 class KURL;
83 class Node;
84 class Page;
85 class ResourceRequest;
86 class ResourceResponse;
87 class ResourceError;
88 class ScriptArguments;
89 class ScriptCallStack;
90 class ScriptProfile;
91 class SharedBuffer;
92 class StorageArea;
93
94 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
95 class InspectorApplicationCacheAgent;
96 #endif
97
98 #if ENABLE(FILE_SYSTEM)
99 class InspectorFileSystemAgent;
100 #endif
101
102 #if ENABLE(WEB_SOCKETS)
103 class WebSocketHandshakeRequest;
104 class WebSocketHandshakeResponse;
105 #endif
106
107 class InspectorAgent {
108     WTF_MAKE_NONCOPYABLE(InspectorAgent);
109     WTF_MAKE_FAST_ALLOCATED;
110 public:
111     InspectorAgent(InspectorController*, Page*, InspectorClient*);
112     virtual ~InspectorAgent();
113
114     InspectorClient* inspectorClient() { return m_client; }
115     InjectedScriptHost* injectedScriptHost() { return m_injectedScriptHost.get(); }
116
117     void inspectedPageDestroyed();
118
119     bool enabled() const;
120
121     Page* inspectedPage() const { return m_inspectedPage; }
122     KURL inspectedURL() const;
123     KURL inspectedURLWithoutFragment() const;
124     void reloadPage(bool ignoreCache);
125     void showConsole();
126
127     void restoreInspectorStateFromCookie(const String& inspectorCookie);
128
129     void highlight(Node*);
130     void hideHighlight();
131     void inspect(Node*);
132     void highlightDOMNode(long nodeId);
133     void hideDOMNodeHighlight() { hideHighlight(); }
134
135     void highlightFrame(unsigned long frameId);
136     void hideFrameHighlight() { hideHighlight(); }
137
138     void setFrontend(InspectorFrontend*);
139     InspectorFrontend* frontend() const { return m_frontend; }
140     void disconnectFrontend();
141
142     InspectorResourceAgent* resourceAgent();
143
144     InspectorController* inspectorController() { return m_inspectorController; };
145     InspectorAgent* inspectorAgent() { return this; }
146     InspectorConsoleAgent* consoleAgent() { return m_consoleAgent.get(); }
147     InspectorCSSAgent* cssAgent() { return m_cssAgent.get(); }
148     InspectorDOMAgent* domAgent() { return m_domAgent.get(); }
149     InjectedScriptHost* injectedScriptAgent() { return m_injectedScriptHost.get(); }
150     InspectorRuntimeAgent* runtimeAgent() { return m_runtimeAgent.get(); }
151     InspectorTimelineAgent* timelineAgent() { return m_timelineAgent.get(); }
152 #if ENABLE(DATABASE)
153     InspectorDatabaseAgent* databaseAgent() { return m_databaseAgent.get(); }
154 #endif
155 #if ENABLE(DOM_STORAGE)
156     InspectorDOMStorageAgent* domStorageAgent() { return m_domStorageAgent.get(); }
157 #endif
158 #if ENABLE(FILE_SYSTEM)
159     InspectorFileSystemAgent* fileSystemAgent() { return m_fileSystemAgent.get(); }
160 #endif
161 #if ENABLE(JAVASCRIPT_DEBUGGER)
162     InspectorBrowserDebuggerAgent* browserDebuggerAgent() const { return m_browserDebuggerAgent.get(); }
163     InspectorDebuggerAgent* debuggerAgent() const { return m_debuggerAgent.get(); }
164     InspectorProfilerAgent* profilerAgent() const { return m_profilerAgent.get(); }
165 #endif
166 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
167     InspectorApplicationCacheAgent* applicationCacheAgent() { return m_applicationCacheAgent.get(); }
168 #endif
169
170     bool handleMousePress();
171     bool searchingForNodeInPage() const;
172     void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
173
174     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
175
176     void didCommitLoad(DocumentLoader*);
177
178     void startTimelineProfiler();
179     void stopTimelineProfiler();
180
181     void getCookies(RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
182     void deleteCookie(const String& cookieName, const String& domain);
183
184     void mainResourceFiredLoadEvent(DocumentLoader*, const KURL&);
185     void mainResourceFiredDOMContentEvent(DocumentLoader*, const KURL&);
186
187 #if ENABLE(WORKERS)
188     enum WorkerAction { WorkerCreated, WorkerDestroyed };
189
190     void postWorkerNotificationToFrontend(const InspectorWorkerResource&, WorkerAction);
191     void didCreateWorker(intptr_t, const String& url, bool isSharedWorker);
192     void didDestroyWorker(intptr_t);
193 #endif
194
195 #if ENABLE(DATABASE)
196     void didOpenDatabase(PassRefPtr<Database>, const String& domain, const String& name, const String& version);
197 #endif
198
199 #if ENABLE(DOM_STORAGE)
200     void didUseDOMStorage(StorageArea*, bool isLocalStorage, Frame*);
201 #endif
202
203 #if ENABLE(WEB_SOCKETS)
204     void didCreateWebSocket(unsigned long identifier, const KURL& requestURL, const KURL& documentURL);
205     void willSendWebSocketHandshakeRequest(unsigned long identifier, const WebSocketHandshakeRequest&);
206     void didReceiveWebSocketHandshakeResponse(unsigned long identifier, const WebSocketHandshakeResponse&);
207     void didCloseWebSocket(unsigned long identifier);
208 #endif
209
210     bool hasFrontend() const { return m_frontend; }
211
212     void drawNodeHighlight(GraphicsContext&) const;
213     void openInInspectedWindow(const String& url);
214     void drawElementTitle(GraphicsContext&, const IntRect& boundingBox, const FloatRect& overlayRect, WebCore::Settings*) const;
215
216 #if ENABLE(JAVASCRIPT_DEBUGGER)
217     bool isRecordingUserInitiatedProfile() const;
218     void startProfiling() { startUserInitiatedProfiling(); }
219     void startUserInitiatedProfiling();
220     void stopProfiling() { stopUserInitiatedProfiling(); }
221     void stopUserInitiatedProfiling();
222     void enableProfiler();
223     void disableProfiler();
224     bool profilerEnabled() const;
225
226     void showAndEnableDebugger();
227     void enableDebugger() { enableDebugger(false); }
228     void enableDebugger(bool eraseStickyBreakpoints);
229     void disableDebugger();
230     bool debuggerEnabled() const { return m_debuggerAgent; }
231     void resume();
232 #endif
233
234     // Generic code called from custom implementations.
235     void evaluateForTestInFrontend(long testCallId, const String& script);
236
237     void addScriptToEvaluateOnLoad(const String& source);
238     void removeAllScriptsToEvaluateOnLoad();
239     void setInspectorExtensionAPI(const String& source);
240
241     InspectorState* state() { return m_state.get(); }
242
243     // InspectorAgent API
244     void getInspectorState(RefPtr<InspectorObject>* state);
245     void setMonitoringXHREnabled(bool enabled, bool* newState);
246     void populateScriptObjects();
247     // Following are used from InspectorBackend and internally.
248     void setSearchingForNode(bool enabled, bool* newState);
249     void didEvaluateForTestInFrontend(long callId, const String& jsonResult);
250
251     void setUserAgentOverride(const String& userAgent);
252     void applyUserAgentOverride(String* userAgent) const;
253
254 private:
255     void showPanel(const String& panel);
256     void pushDataCollectedOffline();
257     void restoreDebugger(bool eraseStickyBreakpoints);
258     enum ProfilerRestoreAction {
259         ProfilerRestoreNoAction = 0,
260         ProfilerRestoreResetAgent = 1
261     };
262     void restoreProfiler(ProfilerRestoreAction);
263     void unbindAllResources();
264     void setSearchingForNode(bool enabled);
265
266     void releaseFrontendLifetimeAgents();
267     void createFrontendLifetimeAgents();
268
269 #if ENABLE(JAVASCRIPT_DEBUGGER)
270     void toggleRecordButton(bool);
271 #endif
272
273     PassRefPtr<InspectorObject> buildObjectForCookie(const Cookie&);
274     PassRefPtr<InspectorArray> buildArrayForCookies(ListHashSet<Cookie>&);
275
276     void focusNode();
277     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
278
279     InspectorController* m_inspectorController;
280     Page* m_inspectedPage;
281     InspectorClient* m_client;
282     InspectorFrontend* m_frontend;
283     OwnPtr<InspectorCSSAgent> m_cssAgent;
284     RefPtr<InspectorDOMAgent> m_domAgent;
285
286 #if ENABLE(DATABASE)
287     RefPtr<InspectorDatabaseAgent> m_databaseAgent;
288 #endif
289
290 #if ENABLE(DOM_STORAGE)
291     RefPtr<InspectorDOMStorageAgent> m_domStorageAgent;
292 #endif
293
294     OwnPtr<InspectorTimelineAgent> m_timelineAgent;
295     OwnPtr<InspectorState> m_state;
296
297 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
298     OwnPtr<InspectorApplicationCacheAgent> m_applicationCacheAgent;
299 #endif
300
301 #if ENABLE(FILE_SYSTEM)
302     RefPtr<InspectorFileSystemAgent> m_fileSystemAgent;
303 #endif
304
305     RefPtr<Node> m_highlightedNode;
306     RefPtr<Node> m_nodeToFocus;
307     RefPtr<InspectorResourceAgent> m_resourceAgent;
308     OwnPtr<InspectorRuntimeAgent> m_runtimeAgent;
309
310 #if ENABLE(DATABASE)
311     typedef HashMap<int, RefPtr<InspectorDatabaseResource> > DatabaseResourcesMap;
312     DatabaseResourcesMap m_databaseResources;
313 #endif
314 #if ENABLE(DOM_STORAGE)
315     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
316     DOMStorageResourcesMap m_domStorageResources;
317 #endif
318
319     RefPtr<InjectedScriptHost> m_injectedScriptHost;
320     OwnPtr<InspectorConsoleAgent> m_consoleAgent;
321
322     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
323     String m_requiredPanel;
324     Vector<String> m_scriptsToEvaluateOnLoad;
325     String m_inspectorExtensionAPI;
326 #if ENABLE(JAVASCRIPT_DEBUGGER)
327     OwnPtr<InspectorDebuggerAgent> m_debuggerAgent;
328     OwnPtr<InspectorBrowserDebuggerAgent> m_browserDebuggerAgent;
329     OwnPtr<InspectorProfilerAgent> m_profilerAgent;
330 #endif
331     String m_userAgentOverride;
332 #if ENABLE(WORKERS)
333     typedef HashMap<intptr_t, RefPtr<InspectorWorkerResource> > WorkersMap;
334
335     WorkersMap m_workers;
336 #endif
337 };
338
339 } // namespace WebCore
340
341 #endif // !defined(InspectorAgent_h)