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