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