2011-01-12 Ilya Tikhonovsky <loislo@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 ConsoleMessage;
49 class Database;
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 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 InspectorState;
75 class InspectorStorageAgent;
76 class InspectorTimelineAgent;
77 class InspectorValue;
78 class InspectorWorkerResource;
79 class IntRect;
80 class KURL;
81 class Node;
82 class Page;
83 class ResourceRequest;
84 class ResourceResponse;
85 class ResourceError;
86 class ScriptArguments;
87 class ScriptCallStack;
88 class ScriptProfile;
89 class SharedBuffer;
90 class StorageArea;
91
92 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
93 class InspectorApplicationCacheAgent;
94 #endif
95
96 #if ENABLE(FILE_SYSTEM)
97 class InspectorFileSystemAgent;
98 #endif
99
100 #if ENABLE(WEB_SOCKETS)
101 class WebSocketHandshakeRequest;
102 class WebSocketHandshakeResponse;
103 #endif
104
105 class InspectorController : public Noncopyable {
106 public:
107     static const char* const ConsolePanel;
108     static const char* const ElementsPanel;
109     static const char* const ProfilesPanel;
110     static const char* const ScriptsPanel;
111
112     InspectorController(Page*, InspectorClient*);
113     ~InspectorController();
114
115     InspectorBackendDispatcher* inspectorBackendDispatcher() { return m_inspectorBackendDispatcher.get(); }
116     InspectorClient* inspectorClient() { return m_client; }
117     InjectedScriptHost* injectedScriptHost() { return m_injectedScriptHost.get(); }
118
119     void inspectedPageDestroyed();
120
121     bool enabled() const;
122
123     Page* inspectedPage() const { return m_inspectedPage; }
124     void reloadPage();
125
126     void restoreInspectorStateFromCookie(const String& inspectorCookie);
127
128     void inspect(Node*);
129     void highlight(Node*);
130     void hideHighlight();
131     void highlightDOMNode(long nodeId);
132     void hideDOMNodeHighlight() { hideHighlight(); }
133
134     void highlightFrame(unsigned long frameId);
135     void hideFrameHighlight() { hideHighlight(); }
136
137     void show();
138     void showPanel(const String&);
139     void close();
140
141     void connectFrontend();
142     void reuseFrontend();
143     void disconnectFrontend();
144
145     void setConsoleMessagesEnabled(bool enabled, bool* newState);
146     void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, PassRefPtr<ScriptArguments> arguments, PassRefPtr<ScriptCallStack>);
147     void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, unsigned lineNumber, const String&);
148     void clearConsoleMessages();
149     const Vector<OwnPtr<ConsoleMessage> >& consoleMessages() const { return m_consoleMessages; }
150
151     bool searchingForNodeInPage() const;
152     void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
153     void handleMousePress();
154
155     void setInspectorFrontendClient(PassOwnPtr<InspectorFrontendClient> client);
156     bool hasInspectorFrontendClient() const { return m_inspectorFrontendClient; }
157
158     void inspectedWindowScriptObjectCleared(Frame*);
159
160     void didCommitLoad(DocumentLoader*);
161     void frameDetachedFromParent(Frame*);
162
163     void setExtraHeaders(PassRefPtr<InspectorObject>);
164
165     void startTimelineProfiler();
166     void stopTimelineProfiler();
167     InspectorTimelineAgent* timelineAgent() { return m_timelineAgent.get(); }
168
169     void getCookies(RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
170     void deleteCookie(const String& cookieName, const String& domain);
171
172 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
173     InspectorApplicationCacheAgent* applicationCacheAgent() { return m_applicationCacheAgent.get(); }
174 #endif
175
176     void mainResourceFiredLoadEvent(DocumentLoader*, const KURL&);
177     void mainResourceFiredDOMContentEvent(DocumentLoader*, const KURL&);
178
179 #if ENABLE(WORKERS)
180     enum WorkerAction { WorkerCreated, WorkerDestroyed };
181
182     void postWorkerNotificationToFrontend(const InspectorWorkerResource&, WorkerAction);
183     void didCreateWorker(intptr_t, const String& url, bool isSharedWorker);
184     void didDestroyWorker(intptr_t);
185 #endif
186
187 #if ENABLE(DATABASE)
188     void didOpenDatabase(PassRefPtr<Database>, const String& domain, const String& name, const String& version);
189 #endif
190
191 #if ENABLE(DOM_STORAGE)
192     void didUseDOMStorage(StorageArea* storageArea, bool isLocalStorage, Frame* frame);
193 #endif
194
195 #if ENABLE(WEB_SOCKETS)
196     void didCreateWebSocket(unsigned long identifier, const KURL& requestURL, const KURL& documentURL);
197     void willSendWebSocketHandshakeRequest(unsigned long identifier, const WebSocketHandshakeRequest&);
198     void didReceiveWebSocketHandshakeResponse(unsigned long identifier, const WebSocketHandshakeResponse&);
199     void didCloseWebSocket(unsigned long identifier);
200 #endif
201
202     bool hasFrontend() const { return m_frontend; }
203
204     void drawNodeHighlight(GraphicsContext&) const;
205     void openInInspectedWindow(const String& url);
206     void drawElementTitle(GraphicsContext&, const IntRect& boundingBox, const FloatRect& overlayRect, WebCore::Settings*) const;
207
208     void count(const String& title, unsigned lineNumber, const String& sourceID);
209
210     void startTiming(const String& title);
211     bool stopTiming(const String& title, double& elapsed);
212
213     void startGroup(PassRefPtr<ScriptArguments>, PassRefPtr<ScriptCallStack> callFrame, bool collapsed = false);
214     void endGroup(MessageSource source, unsigned lineNumber, const String& sourceURL);
215
216     void markTimeline(const String& message);
217
218 #if ENABLE(JAVASCRIPT_DEBUGGER)
219     void addProfile(PassRefPtr<ScriptProfile>, unsigned lineNumber, const String& sourceURL);
220     void addProfileFinishedMessageToConsole(PassRefPtr<ScriptProfile>, unsigned lineNumber, const String& sourceURL);
221     void addStartProfilingMessageToConsole(const String& title, unsigned lineNumber, const String& sourceURL);
222     bool isRecordingUserInitiatedProfile() const;
223     String getCurrentUserInitiatedProfileName(bool incrementProfileNumber = false);
224     void startProfiling() { startUserInitiatedProfiling(); }
225     void startUserInitiatedProfiling();
226     void stopProfiling() { stopUserInitiatedProfiling(); }
227     void stopUserInitiatedProfiling();
228     void enableProfiler(bool always = false, bool skipRecompile = false);
229     void disableProfiler(bool always = false);
230     bool profilerEnabled() const;
231
232     void enableDebugger();
233     void disableDebugger(bool always = false);
234     bool debuggerEnabled() const { return m_debuggerAgent; }
235     void resume();
236
237     void setStickyBreakpoints(PassRefPtr<InspectorObject> breakpoints);
238 #endif
239
240     void setInjectedScriptSource(const String& source);
241     void dispatchOnInjectedScript(long injectedScriptId, const String& methodName, const String& arguments, RefPtr<InspectorValue>* result, bool* hadException);
242
243     // Generic code called from custom implementations.
244     void releaseWrapperObjectGroup(long injectedScriptId, const String& objectGroup);
245
246     void evaluateForTestInFrontend(long testCallId, const String& script);
247
248     InjectedScript injectedScriptForNodeId(long id);
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     int inspectorAttachedHeight() const;
258
259     static const unsigned defaultAttachedHeight;
260
261 private:
262     friend class InspectorBackend;
263     friend class InspectorBackendDispatcher;
264     friend class InspectorBrowserDebuggerAgent;
265     friend class InspectorInstrumentation;
266     friend class InjectedScriptHost;
267
268     void willSendRequest(ResourceRequest&);
269     void didReceiveResponse(unsigned long identifier, const ResourceResponse&);
270     void didFailLoading(unsigned long identifier, const ResourceError&);
271     void resourceRetrievedByXMLHttpRequest(const String& url, const String& sendURL, unsigned sendLineNumber);
272
273     void ensureSettingsLoaded();
274
275     void getInspectorState(RefPtr<InspectorObject>* state);
276     void setConsoleMessagesEnabled(bool);
277
278     void populateScriptObjects();
279     void restoreDebugger();
280     enum ProfilerRestoreAction {
281         ProfilerRestoreNoAction = 0,
282         ProfilerRestoreResetAgent = 1
283     };
284     void restoreProfiler(ProfilerRestoreAction action);
285     void unbindAllResources();
286     void setSearchingForNode(bool enabled);
287
288     // Following are used from InspectorBackend and internally.
289     void setSearchingForNode(bool enabled, bool* newState);
290
291     void setMonitoringXHREnabled(bool enabled, bool* newState);
292     void releaseFrontendLifetimeAgents();
293
294 #if ENABLE(JAVASCRIPT_DEBUGGER)
295     void toggleRecordButton(bool);
296     void enableDebuggerFromFrontend(bool always);
297     void restoreStickyBreakpoints();
298     void restoreStickyBreakpoint(PassRefPtr<InspectorObject> breakpoint);
299 #endif
300
301     PassRefPtr<InspectorObject> buildObjectForCookie(const Cookie&);
302     PassRefPtr<InspectorArray> buildArrayForCookies(ListHashSet<Cookie>&);
303
304     void focusNode();
305
306     void addConsoleMessage(PassOwnPtr<ConsoleMessage>);
307
308     bool isMainResourceLoader(DocumentLoader* loader, const KURL& requestUrl);
309
310     void didEvaluateForTestInFrontend(long callId, const String& jsonResult);
311
312     Page* m_inspectedPage;
313     InspectorClient* m_client;
314     OwnPtr<InspectorFrontendClient> m_inspectorFrontendClient;
315     bool m_openingFrontend;
316     OwnPtr<InspectorFrontend> m_frontend;
317     OwnPtr<InspectorCSSAgent> m_cssAgent;
318     RefPtr<InspectorDOMAgent> m_domAgent;
319
320 #if ENABLE(DATABASE)
321     RefPtr<InspectorDatabaseAgent> m_databaseAgent;
322 #endif
323
324 #if ENABLE(DOM_STORAGE)
325     RefPtr<InspectorDOMStorageAgent> m_domStorageAgent;
326 #endif
327
328     OwnPtr<InspectorTimelineAgent> m_timelineAgent;
329     OwnPtr<InspectorState> m_state;
330
331 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
332     OwnPtr<InspectorApplicationCacheAgent> m_applicationCacheAgent;
333 #endif
334     
335 #if ENABLE(FILE_SYSTEM)
336     RefPtr<InspectorFileSystemAgent> m_fileSystemAgent;
337 #endif 
338
339     RefPtr<Node> m_nodeToFocus;
340     RefPtr<InspectorResourceAgent> m_resourceAgent;
341     Vector<OwnPtr<ConsoleMessage> > m_consoleMessages;
342     unsigned m_expiredConsoleMessageCount;
343     HashMap<String, double> m_times;
344     HashMap<String, unsigned> m_counts;
345
346 #if ENABLE(DATABASE)
347     typedef HashMap<int, RefPtr<InspectorDatabaseResource> > DatabaseResourcesMap;
348     DatabaseResourcesMap m_databaseResources;
349 #endif
350 #if ENABLE(DOM_STORAGE)
351     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
352     DOMStorageResourcesMap m_domStorageResources;
353 #endif
354
355     String m_showAfterVisible;
356     RefPtr<Node> m_highlightedNode;
357     ConsoleMessage* m_previousMessage;
358     bool m_settingsLoaded;
359     OwnPtr<InspectorBackendDispatcher> m_inspectorBackendDispatcher;
360     RefPtr<InjectedScriptHost> m_injectedScriptHost;
361
362     typedef HashMap<String, String> Settings;
363     mutable Settings m_settings;
364
365     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
366     Vector<String> m_scriptsToEvaluateOnLoad;
367     String m_inspectorExtensionAPI;
368 #if ENABLE(JAVASCRIPT_DEBUGGER)
369     bool m_attachDebuggerWhenShown;
370     OwnPtr<InspectorDebuggerAgent> m_debuggerAgent;
371     OwnPtr<InspectorBrowserDebuggerAgent> m_browserDebuggerAgent;
372
373     OwnPtr<InspectorProfilerAgent> m_profilerAgent;
374 #endif
375     OwnPtr<HTTPHeaderMap> m_extraHeaders;
376 #if ENABLE(WORKERS)
377     typedef HashMap<intptr_t, RefPtr<InspectorWorkerResource> > WorkersMap;
378
379     WorkersMap m_workers;
380 #endif
381 };
382
383 } // namespace WebCore
384
385 #endif // !defined(InspectorController_h)