2011-03-29 Ilya Tikhonovsky <loislo@chromium.org>
[WebKit-https.git] / Source / WebCore / inspector / InspectorAgent.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 InspectorAgent_h
30 #define InspectorAgent_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 HTTPHeaderMap;
54 class InjectedScript;
55 class InjectedScriptManager;
56 class InspectorArray;
57 class InspectorBrowserDebuggerAgent;
58 class InspectorClient;
59 class InspectorConsoleAgent;
60 class InspectorCSSAgent;
61 class InspectorDOMAgent;
62 class InspectorDOMStorageAgent;
63 class InspectorDatabaseAgent;
64 class InspectorDatabaseResource;
65 class InspectorDebuggerAgent;
66 class InspectorFrontend;
67 class InspectorFrontendClient;
68 class InspectorObject;
69 class InspectorProfilerAgent;
70 class InspectorResourceAgent;
71 class InspectorRuntimeAgent;
72 class InspectorState;
73 class InspectorStorageAgent;
74 class InspectorTimelineAgent;
75 class InspectorValue;
76 class InspectorWorkerResource;
77 class InstrumentingAgents;
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 typedef String ErrorString;
96
97 class InspectorAgent {
98     WTF_MAKE_NONCOPYABLE(InspectorAgent);
99     WTF_MAKE_FAST_ALLOCATED;
100 public:
101     InspectorAgent(Page*, InspectorClient*, InjectedScriptManager*);
102     virtual ~InspectorAgent();
103
104     InspectorClient* inspectorClient() { return m_client; }
105
106     void inspectedPageDestroyed();
107
108     bool enabled() const;
109
110     Page* inspectedPage() const { return m_inspectedPage; }
111     KURL inspectedURL() const;
112     KURL inspectedURLWithoutFragment() const;
113     void reloadPage(ErrorString*, bool ignoreCache);
114     void showConsole();
115
116     void restoreInspectorStateFromCookie(const String& inspectorCookie);
117
118     void setFrontend(InspectorFrontend*);
119     InspectorFrontend* frontend() const { return m_frontend; }
120     void disconnectFrontend();
121
122     InstrumentingAgents* instrumentingAgents() const { return m_instrumentingAgents.get(); }
123
124     InspectorAgent* inspectorAgent() { return this; }
125     InspectorConsoleAgent* consoleAgent() { return m_consoleAgent.get(); }
126     InspectorCSSAgent* cssAgent() { return m_cssAgent.get(); }
127     InspectorDOMAgent* domAgent() { return m_domAgent.get(); }
128     InspectorRuntimeAgent* runtimeAgent() { return m_runtimeAgent.get(); }
129     InspectorTimelineAgent* timelineAgent() { return m_timelineAgent.get(); }
130     InspectorResourceAgent* resourceAgent() { return m_resourceAgent.get(); }
131 #if ENABLE(DATABASE)
132     InspectorDatabaseAgent* databaseAgent() { return m_databaseAgent.get(); }
133 #endif
134 #if ENABLE(DOM_STORAGE)
135     InspectorDOMStorageAgent* domStorageAgent() { return m_domStorageAgent.get(); }
136 #endif
137 #if ENABLE(JAVASCRIPT_DEBUGGER)
138     InspectorBrowserDebuggerAgent* browserDebuggerAgent() const { return m_browserDebuggerAgent.get(); }
139     InspectorDebuggerAgent* debuggerAgent() const { return m_debuggerAgent.get(); }
140     InspectorProfilerAgent* profilerAgent() const { return m_profilerAgent.get(); }
141 #endif
142 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
143     InspectorApplicationCacheAgent* applicationCacheAgent() { return m_applicationCacheAgent.get(); }
144 #endif
145
146     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
147
148     void didCommitLoad(DocumentLoader*);
149
150     void getCookies(ErrorString*, RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
151     void deleteCookie(ErrorString*, const String& cookieName, const String& domain);
152
153     void domContentLoadedEventFired(DocumentLoader*, const KURL&);
154     void loadEventFired(DocumentLoader*, const KURL&);
155
156 #if ENABLE(WORKERS)
157     enum WorkerAction { WorkerCreated, WorkerDestroyed };
158
159     void postWorkerNotificationToFrontend(const InspectorWorkerResource&, WorkerAction);
160     void didCreateWorker(intptr_t, const String& url, bool isSharedWorker);
161     void didDestroyWorker(intptr_t);
162 #endif
163
164     bool hasFrontend() const { return m_frontend; }
165
166     void openInInspectedWindow(ErrorString*, const String& url);
167
168 #if ENABLE(JAVASCRIPT_DEBUGGER)
169     void showProfilesPanel();
170 #endif
171
172     // Generic code called from custom implementations.
173     void evaluateForTestInFrontend(long testCallId, const String& script);
174
175     void addScriptToEvaluateOnLoad(ErrorString*, const String& source);
176     void removeAllScriptsToEvaluateOnLoad(ErrorString*);
177     void setInspectorExtensionAPI(const String& source);
178
179     InspectorState* state() { return m_state.get(); }
180
181     // InspectorAgent API
182     void getInspectorState(RefPtr<InspectorObject>* state);
183     void setMonitoringXHREnabled(bool enabled, bool* newState);
184     // Following are used from InspectorBackend and internally.
185     void didEvaluateForTestInFrontend(ErrorString*, long callId, const String& jsonResult);
186
187     void setUserAgentOverride(ErrorString*, const String& userAgent);
188     void applyUserAgentOverride(String* userAgent) const;
189
190 private:
191     void showPanel(const String& panel);
192     void unbindAllResources();
193
194     void releaseFrontendLifetimeAgents();
195     void createFrontendLifetimeAgents();
196
197 #if ENABLE(JAVASCRIPT_DEBUGGER)
198     void toggleRecordButton(bool);
199 #endif
200
201     PassRefPtr<InspectorObject> buildObjectForCookie(const Cookie&);
202     PassRefPtr<InspectorArray> buildArrayForCookies(ListHashSet<Cookie>&);
203
204     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
205     void issueEvaluateForTestCommands();
206
207     Page* m_inspectedPage;
208     InspectorClient* m_client;
209     InspectorFrontend* m_frontend;
210     OwnPtr<InstrumentingAgents> m_instrumentingAgents;
211     InjectedScriptManager* m_injectedScriptManager;
212     OwnPtr<InspectorState> m_state;
213     OwnPtr<InspectorDOMAgent> m_domAgent;
214     OwnPtr<InspectorCSSAgent> m_cssAgent;
215
216 #if ENABLE(DATABASE)
217     OwnPtr<InspectorDatabaseAgent> m_databaseAgent;
218 #endif
219
220 #if ENABLE(DOM_STORAGE)
221     OwnPtr<InspectorDOMStorageAgent> m_domStorageAgent;
222 #endif
223
224     OwnPtr<InspectorTimelineAgent> m_timelineAgent;
225
226 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
227     OwnPtr<InspectorApplicationCacheAgent> m_applicationCacheAgent;
228 #endif
229
230     RefPtr<InspectorResourceAgent> m_resourceAgent;
231     OwnPtr<InspectorRuntimeAgent> m_runtimeAgent;
232
233     OwnPtr<InspectorConsoleAgent> m_consoleAgent;
234
235     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
236     String m_showPanelAfterVisible;
237     Vector<String> m_scriptsToEvaluateOnLoad;
238     String m_inspectorExtensionAPI;
239 #if ENABLE(JAVASCRIPT_DEBUGGER)
240     OwnPtr<InspectorDebuggerAgent> m_debuggerAgent;
241     OwnPtr<InspectorBrowserDebuggerAgent> m_browserDebuggerAgent;
242     OwnPtr<InspectorProfilerAgent> m_profilerAgent;
243 #endif
244     String m_userAgentOverride;
245 #if ENABLE(WORKERS)
246     typedef HashMap<intptr_t, RefPtr<InspectorWorkerResource> > WorkersMap;
247     WorkersMap m_workers;
248 #endif
249     bool m_canIssueEvaluateForTestInFrontend;
250 };
251
252 } // namespace WebCore
253
254 #endif // !defined(InspectorAgent_h)