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