62c9e829cdfd5ce1bf2ba57bbcb5ed34ffadf899
[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 inspect(Node*);
119
120     void setFrontend(InspectorFrontend*);
121     InspectorFrontend* frontend() const { return m_frontend; }
122     void disconnectFrontend();
123
124     InstrumentingAgents* instrumentingAgents() const { return m_instrumentingAgents.get(); }
125
126     InspectorAgent* inspectorAgent() { return this; }
127     InspectorConsoleAgent* consoleAgent() { return m_consoleAgent.get(); }
128     InspectorCSSAgent* cssAgent() { return m_cssAgent.get(); }
129     InspectorDOMAgent* domAgent() { return m_domAgent.get(); }
130     InspectorRuntimeAgent* runtimeAgent() { return m_runtimeAgent.get(); }
131     InspectorTimelineAgent* timelineAgent() { return m_timelineAgent.get(); }
132     InspectorResourceAgent* resourceAgent() { return m_resourceAgent.get(); }
133 #if ENABLE(DATABASE)
134     InspectorDatabaseAgent* databaseAgent() { return m_databaseAgent.get(); }
135 #endif
136 #if ENABLE(DOM_STORAGE)
137     InspectorDOMStorageAgent* domStorageAgent() { return m_domStorageAgent.get(); }
138 #endif
139 #if ENABLE(JAVASCRIPT_DEBUGGER)
140     InspectorBrowserDebuggerAgent* browserDebuggerAgent() const { return m_browserDebuggerAgent.get(); }
141     InspectorDebuggerAgent* debuggerAgent() const { return m_debuggerAgent.get(); }
142     InspectorProfilerAgent* profilerAgent() const { return m_profilerAgent.get(); }
143 #endif
144 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
145     InspectorApplicationCacheAgent* applicationCacheAgent() { return m_applicationCacheAgent.get(); }
146 #endif
147
148     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
149
150     void didCommitLoad(DocumentLoader*);
151
152     void getCookies(ErrorString*, RefPtr<InspectorArray>* cookies, WTF::String* cookiesString);
153     void deleteCookie(ErrorString*, const String& cookieName, const String& domain);
154
155     void domContentLoadedEventFired(DocumentLoader*, const KURL&);
156     void loadEventFired(DocumentLoader*, const KURL&);
157
158 #if ENABLE(WORKERS)
159     enum WorkerAction { WorkerCreated, WorkerDestroyed };
160
161     void postWorkerNotificationToFrontend(const InspectorWorkerResource&, WorkerAction);
162     void didCreateWorker(intptr_t, const String& url, bool isSharedWorker);
163     void didDestroyWorker(intptr_t);
164 #endif
165
166     bool hasFrontend() const { return m_frontend; }
167
168     void openInInspectedWindow(ErrorString*, const String& url);
169
170 #if ENABLE(JAVASCRIPT_DEBUGGER)
171     void showProfilesPanel();
172 #endif
173
174     // Generic code called from custom implementations.
175     void evaluateForTestInFrontend(long testCallId, const String& script);
176
177     void addScriptToEvaluateOnLoad(ErrorString*, const String& source);
178     void removeAllScriptsToEvaluateOnLoad(ErrorString*);
179     void setInspectorExtensionAPI(const String& source);
180
181     InspectorState* state() { return m_state.get(); }
182
183     // InspectorAgent API
184     void getInspectorState(RefPtr<InspectorObject>* state);
185     void setMonitoringXHREnabled(bool enabled, bool* newState);
186     // Following are used from InspectorBackend and internally.
187     void didEvaluateForTestInFrontend(ErrorString*, long callId, const String& jsonResult);
188
189     void setUserAgentOverride(ErrorString*, const String& userAgent);
190     void applyUserAgentOverride(String* userAgent) const;
191
192 private:
193     void showPanel(const String& panel);
194     void unbindAllResources();
195
196     void releaseFrontendLifetimeAgents();
197     void createFrontendLifetimeAgents();
198
199 #if ENABLE(JAVASCRIPT_DEBUGGER)
200     void toggleRecordButton(bool);
201 #endif
202
203     PassRefPtr<InspectorObject> buildObjectForCookie(const Cookie&);
204     PassRefPtr<InspectorArray> buildArrayForCookies(ListHashSet<Cookie>&);
205
206     void focusNode();
207     bool isMainResourceLoader(DocumentLoader*, const KURL& requestUrl);
208     void issueEvaluateForTestCommands();
209
210     Page* m_inspectedPage;
211     InspectorClient* m_client;
212     InspectorFrontend* m_frontend;
213     OwnPtr<InstrumentingAgents> m_instrumentingAgents;
214     InjectedScriptManager* m_injectedScriptManager;
215     OwnPtr<InspectorState> m_state;
216     OwnPtr<InspectorDOMAgent> m_domAgent;
217     OwnPtr<InspectorCSSAgent> m_cssAgent;
218
219 #if ENABLE(DATABASE)
220     OwnPtr<InspectorDatabaseAgent> m_databaseAgent;
221 #endif
222
223 #if ENABLE(DOM_STORAGE)
224     OwnPtr<InspectorDOMStorageAgent> m_domStorageAgent;
225 #endif
226
227     OwnPtr<InspectorTimelineAgent> m_timelineAgent;
228
229 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
230     OwnPtr<InspectorApplicationCacheAgent> m_applicationCacheAgent;
231 #endif
232
233     RefPtr<Node> m_nodeToFocus;
234     RefPtr<InspectorResourceAgent> m_resourceAgent;
235     OwnPtr<InspectorRuntimeAgent> m_runtimeAgent;
236
237     OwnPtr<InspectorConsoleAgent> m_consoleAgent;
238
239     Vector<pair<long, String> > m_pendingEvaluateTestCommands;
240     String m_showPanelAfterVisible;
241     Vector<String> m_scriptsToEvaluateOnLoad;
242     String m_inspectorExtensionAPI;
243 #if ENABLE(JAVASCRIPT_DEBUGGER)
244     OwnPtr<InspectorDebuggerAgent> m_debuggerAgent;
245     OwnPtr<InspectorBrowserDebuggerAgent> m_browserDebuggerAgent;
246     OwnPtr<InspectorProfilerAgent> m_profilerAgent;
247 #endif
248     String m_userAgentOverride;
249 #if ENABLE(WORKERS)
250     typedef HashMap<intptr_t, RefPtr<InspectorWorkerResource> > WorkersMap;
251     WorkersMap m_workers;
252 #endif
253     bool m_canIssueEvaluateForTestInFrontend;
254 };
255
256 } // namespace WebCore
257
258 #endif // !defined(InspectorAgent_h)