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