0dd6fb15b3db88d930f2ef645eb6ed0c3abb9e54
[WebKit-https.git] / WebCore / inspector / InspectorController.h
1 /*
2  * Copyright (C) 2007 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 "Console.h"
33 #include "Cookie.h"
34 #include "PlatformString.h"
35 #include "ScriptArray.h"
36 #include "ScriptObject.h"
37 #include "ScriptState.h"
38 #include "ScriptValue.h"
39 #include "StringHash.h"
40 #include "Timer.h"
41
42 #include <wtf/HashMap.h>
43 #include <wtf/HashSet.h>
44 #include <wtf/ListHashSet.h>
45 #include <wtf/RefCounted.h>
46 #include <wtf/Vector.h>
47
48 #if ENABLE(JAVASCRIPT_DEBUGGER)
49 #include "JavaScriptDebugListener.h"
50
51 namespace JSC {
52     class Profile;
53     class UString;
54 }
55 #endif
56
57 namespace WebCore {
58
59 class CachedResource;
60 class Database;
61 class Document;
62 class DocumentLoader;
63 class GraphicsContext;
64 class HitTestResult;
65 class InjectedScriptHost;
66 class InspectorBackend;
67 class InspectorClient;
68 class InspectorDOMAgent;
69 class InspectorFrontend;
70 class InspectorFrontendHost;
71 class InspectorTimelineAgent;
72 class JavaScriptCallFrame;
73 class KURL;
74 class Node;
75 class Page;
76 class ResourceRequest;
77 class ResourceResponse;
78 class ResourceError;
79 class ScriptCallStack;
80 class ScriptString;
81 class SharedBuffer;
82 class Storage;
83 class StorageArea;
84
85 class ConsoleMessage;
86 class InspectorDatabaseResource;
87 class InspectorDOMStorageResource;
88 class InspectorResource;
89
90 class InspectorController
91 #if ENABLE(JAVASCRIPT_DEBUGGER)
92                           : JavaScriptDebugListener
93 #endif
94                                                     {
95 public:
96     typedef HashMap<unsigned long, RefPtr<InspectorResource> > ResourcesMap;
97     typedef HashMap<RefPtr<Frame>, ResourcesMap*> FrameResourcesMap;
98     typedef HashMap<int, RefPtr<InspectorDatabaseResource> > DatabaseResourcesMap;
99     typedef HashMap<int, RefPtr<InspectorDOMStorageResource> > DOMStorageResourcesMap;
100     typedef HashMap<String, Vector<String> > ObjectGroupsMap;
101
102     typedef enum {
103         CurrentPanel,
104         ConsolePanel,
105         ElementsPanel,
106         ResourcesPanel,
107         ScriptsPanel,
108         TimelinePanel,
109         ProfilesPanel,
110         StoragePanel
111     } SpecialPanels;
112
113     InspectorController(Page*, InspectorClient*);
114     ~InspectorController();
115
116     InspectorBackend* inspectorBackend() { return m_inspectorBackend.get(); }
117     InspectorFrontendHost* inspectorFrontendHost() { return m_inspectorFrontendHost.get(); }
118     InjectedScriptHost* injectedScriptHost() { return m_injectedScriptHost.get(); }
119
120     void inspectedPageDestroyed();
121     void pageDestroyed() { m_page = 0; }
122
123     bool enabled() const;
124
125     Page* inspectedPage() const { return m_inspectedPage; }
126
127     String setting(const String& key) const;
128     void setSetting(const String& key, const String& value);
129
130     void inspect(Node*);
131     void highlight(Node*);
132     void hideHighlight();
133
134     void show();
135     void showPanel(SpecialPanels);
136     void close();
137
138     bool windowVisible();
139     void setWindowVisible(bool visible = true, bool attached = false);
140
141     void addMessageToConsole(MessageSource, MessageType, MessageLevel, ScriptCallStack*);
142     void addMessageToConsole(MessageSource, MessageType, MessageLevel, const String& message, unsigned lineNumber, const String& sourceID);
143     void clearConsoleMessages(bool clearUI);
144     const Vector<ConsoleMessage*>& consoleMessages() const { return m_consoleMessages; }
145
146     void attachWindow();
147     void detachWindow();
148
149     void toggleSearchForNodeInPage();
150     bool searchingForNodeInPage() { return m_searchingForNode; };
151     void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags);
152     void handleMousePressOnNode(Node*);
153
154     void inspectedWindowScriptObjectCleared(Frame*);
155     void windowScriptObjectAvailable();
156
157     void setFrontendProxyObject(ScriptState* state, ScriptObject webInspectorObj, ScriptObject injectedScriptObj = ScriptObject());
158     ScriptState* frontendScriptState() const { return m_scriptState; }
159
160     void populateScriptObjects();
161     void resetScriptObjects();
162
163     void didCommitLoad(DocumentLoader*);
164     void frameDetachedFromParent(Frame*);
165
166     void didLoadResourceFromMemoryCache(DocumentLoader*, const CachedResource*);
167
168     void identifierForInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&);
169     void willSendRequest(unsigned long identifier, const ResourceRequest&, const ResourceResponse& redirectResponse);
170     void didReceiveResponse(unsigned long identifier, const ResourceResponse&);
171     void didReceiveContentLength(unsigned long identifier, int lengthReceived);
172     void didFinishLoading(unsigned long identifier);
173     void didFailLoading(unsigned long identifier, const ResourceError&);
174     void resourceRetrievedByXMLHttpRequest(unsigned long identifier, const ScriptString& sourceString);
175     void scriptImported(unsigned long identifier, const String& sourceString);
176
177     void enableResourceTracking(bool always = false, bool reload = true);
178     void disableResourceTracking(bool always = false);
179     bool resourceTrackingEnabled() const { return m_resourceTrackingEnabled; }
180     void ensureResourceTrackingSettingsLoaded();
181
182     void startTimelineProfiler();
183     void stopTimelineProfiler();
184     InspectorTimelineAgent* timelineAgent() { return m_timelineAgent.get(); }
185
186     void mainResourceFiredLoadEvent(DocumentLoader*, const KURL&);
187     void mainResourceFiredDOMContentEvent(DocumentLoader*, const KURL&);
188                                                         
189     void getCookies(long callId, const String& url);
190
191 #if ENABLE(DATABASE)
192     void didOpenDatabase(Database*, const String& domain, const String& name, const String& version);
193 #endif
194 #if ENABLE(DOM_STORAGE)
195     void didUseDOMStorage(StorageArea* storageArea, bool isLocalStorage, Frame* frame);
196     void selectDOMStorage(Storage* storage);
197     void getDOMStorageEntries(int callId, int storageId);
198     void setDOMStorageItem(long callId, long storageId, const String& key, const String& value);
199     void removeDOMStorageItem(long callId, long storageId, const String& key);
200 #endif
201
202     const ResourcesMap& resources() const { return m_resources; }
203
204     void drawNodeHighlight(GraphicsContext&) const;
205
206     void count(const String& title, unsigned lineNumber, const String& sourceID);
207
208     void startTiming(const String& title);
209     bool stopTiming(const String& title, double& elapsed);
210
211     void startGroup(MessageSource source, ScriptCallStack* callFrame);
212     void endGroup(MessageSource source, unsigned lineNumber, const String& sourceURL);
213
214     void markTimeline(const String& message); 
215
216 #if ENABLE(JAVASCRIPT_DEBUGGER)
217     void addProfile(PassRefPtr<JSC::Profile>, unsigned lineNumber, const JSC::UString& sourceURL);
218     void addProfileFinishedMessageToConsole(PassRefPtr<JSC::Profile>, unsigned lineNumber, const JSC::UString& sourceURL);
219     void addStartProfilingMessageToConsole(const JSC::UString& title, unsigned lineNumber, const JSC::UString& sourceURL);
220
221     bool isRecordingUserInitiatedProfile() const { return m_recordingUserInitiatedProfile; }
222
223     JSC::UString getCurrentUserInitiatedProfileName(bool incrementProfileNumber);
224     void startUserInitiatedProfiling(Timer<InspectorController>* = 0);
225     void stopUserInitiatedProfiling();
226
227     void enableProfiler(bool always = false, bool skipRecompile = false);
228     void disableProfiler(bool always = false);
229     bool profilerEnabled() const { return enabled() && m_profilerEnabled; }
230
231     void enableDebugger();
232     void disableDebugger(bool always = false);
233     bool debuggerEnabled() const { return m_debuggerEnabled; }
234
235     void resumeDebugger();
236
237     virtual void didParseSource(JSC::ExecState*, const JSC::SourceCode&);
238     virtual void failedToParseSource(JSC::ExecState*, const JSC::SourceCode&, int errorLine, const JSC::UString& errorMessage);
239     virtual void didPause();
240     virtual void didContinue();
241 #endif
242
243     void evaluateForTestInFrontend(long callId, const String& script);
244
245 private:
246     friend class InspectorBackend;
247     friend class InspectorFrontendHost;
248     friend class InjectedScriptHost;
249     // Following are used from InspectorBackend and internally.
250     void scriptObjectReady();
251     void moveWindowBy(float x, float y) const;
252     void setAttachedWindow(bool);
253     void setAttachedWindowHeight(unsigned height);
254     void storeLastActivePanel(const String& panelName);
255     void closeWindow();
256     InspectorDOMAgent* domAgent() { return m_domAgent.get(); }
257     void releaseDOMAgent();
258
259     friend class InspectorFrontend;
260     // Following are used from InspectorFrontend only. We don't want to expose them to the
261     // rest of the InspectorController clients.
262     // TODO: extract these into a separate interface.
263     ScriptValue wrapObject(const ScriptValue& object, const String& objectGroup);
264     ScriptValue unwrapObject(const String& objectId);
265     void releaseWrapperObjectGroup(const String& objectGroup);
266     
267     void resetInjectedScript();
268
269     void deleteCookie(const String& cookieName, const String& domain);
270
271 #if ENABLE(JAVASCRIPT_DEBUGGER)
272     typedef HashMap<unsigned int, RefPtr<JSC::Profile> > ProfilesMap;
273
274     void startUserInitiatedProfilingSoon();
275     void toggleRecordButton(bool);
276     void enableDebuggerFromFrontend(bool always);
277     void getProfileHeaders(long callId);
278     void getProfile(long callId, unsigned uid);
279     ScriptObject createProfileHeader(const JSC::Profile& profile);
280 #endif
281 #if ENABLE(DATABASE)
282     void selectDatabase(Database* database);
283     Database* databaseForId(int databaseId);
284 #endif
285 #if ENABLE(DOM_STORAGE)
286     InspectorDOMStorageResource* getDOMStorageResourceForId(int storageId);
287 #endif
288                                                         
289     ScriptObject buildObjectForCookie(const Cookie&);
290     ScriptArray buildArrayForCookies(ListHashSet<Cookie>&);
291
292     void focusNode();
293
294     void addConsoleMessage(ScriptState*, ConsoleMessage*);
295
296     void addResource(InspectorResource*);
297     void removeResource(InspectorResource*);
298     InspectorResource* getTrackedResource(unsigned long identifier);
299
300     void pruneResources(ResourcesMap*, DocumentLoader* loaderToKeep = 0);
301     void removeAllResources(ResourcesMap* map) { pruneResources(map); }
302
303     void showWindow();
304
305     bool isMainResourceLoader(DocumentLoader* loader, const KURL& requestUrl);
306
307     SpecialPanels specialPanelForJSName(const String& panelName);
308
309     void didEvaluateForTestInFrontend(long callId, const String& jsonResult);
310
311     Page* m_inspectedPage;
312     InspectorClient* m_client;
313     OwnPtr<InspectorFrontend> m_frontend;
314     RefPtr<InspectorDOMAgent> m_domAgent;
315     OwnPtr<InspectorTimelineAgent> m_timelineAgent;
316     ScriptObject m_injectedScriptObj;
317     Page* m_page;
318     RefPtr<Node> m_nodeToFocus;
319     RefPtr<InspectorResource> m_mainResource;
320     ResourcesMap m_resources;
321     HashSet<String> m_knownResources;
322     FrameResourcesMap m_frameResources;
323     Vector<ConsoleMessage*> m_consoleMessages;
324     HashMap<String, double> m_times;
325     HashMap<String, unsigned> m_counts;
326 #if ENABLE(DATABASE)
327     DatabaseResourcesMap m_databaseResources;
328 #endif
329 #if ENABLE(DOM_STORAGE)
330     DOMStorageResourcesMap m_domStorageResources;
331 #endif
332     ScriptState* m_scriptState;
333     bool m_windowVisible;
334     SpecialPanels m_showAfterVisible;
335     RefPtr<Node> m_highlightedNode;
336     unsigned m_groupLevel;
337     bool m_searchingForNode;
338     ConsoleMessage* m_previousMessage;
339     bool m_resourceTrackingEnabled;
340     bool m_resourceTrackingSettingsLoaded;
341     RefPtr<InspectorBackend> m_inspectorBackend;
342     RefPtr<InspectorFrontendHost> m_inspectorFrontendHost;
343     RefPtr<InjectedScriptHost> m_injectedScriptHost;
344     HashMap<String, ScriptValue> m_idToWrappedObject;
345     ObjectGroupsMap m_objectGroups;
346     long m_lastBoundObjectId;
347
348     typedef HashMap<String, String> Settings;
349     mutable Settings m_settings;
350
351     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
352 #if ENABLE(JAVASCRIPT_DEBUGGER)
353     bool m_debuggerEnabled;
354     bool m_attachDebuggerWhenShown;
355     bool m_profilerEnabled;
356     bool m_recordingUserInitiatedProfile;
357     int m_currentUserInitiatedProfileNumber;
358     unsigned m_nextUserInitiatedProfileNumber;
359     Timer<InspectorController> m_startProfiling;
360     ProfilesMap m_profiles;
361 #endif
362 };
363
364 } // namespace WebCore
365
366 #endif // !defined(InspectorController_h)