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