Remember the docked state of the Web Inspector, so it can be reopened docked if it...
[WebKit-https.git] / WebCore / page / 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 "JavaScriptDebugListener.h"
33
34 #include "Console.h"
35 #include "PlatformString.h"
36 #include "StringHash.h"
37 #include <JavaScriptCore/JSContextRef.h>
38 #include <profiler/Profiler.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/HashSet.h>
41 #include <wtf/Vector.h>
42
43 namespace KJS {
44     class Profile;
45     class UString;
46 }
47
48 namespace WebCore {
49
50 class Database;
51 class DocumentLoader;
52 class GraphicsContext;
53 class InspectorClient;
54 class JavaScriptCallFrame;
55 class Node;
56 class Page;
57 class ResourceResponse;
58 class ResourceError;
59 class SharedBuffer;
60
61 struct ConsoleMessage;
62 struct InspectorDatabaseResource;
63 struct InspectorResource;
64 class ResourceRequest;
65
66 class InspectorController : JavaScriptDebugListener, public KJS::ProfilerClient {
67 public:
68     typedef HashMap<long long, RefPtr<InspectorResource> > ResourcesMap;
69     typedef HashMap<RefPtr<Frame>, ResourcesMap*> FrameResourcesMap;
70     typedef HashSet<RefPtr<InspectorDatabaseResource> > DatabaseResourcesSet;
71
72     typedef enum {
73         CurrentPanel,
74         ConsolePanel,
75         DatabasesPanel,
76         ElementsPanel,
77         ProfilesPanel,
78         ResourcesPanel,
79         ScriptsPanel
80     } SpecialPanels;
81
82     InspectorController(Page*, InspectorClient*);
83     ~InspectorController();
84
85     void inspectedPageDestroyed();
86     void pageDestroyed() { m_page = 0; }
87
88     bool enabled() const;
89
90     Page* inspectedPage() const { return m_inspectedPage; }
91
92     String localizedStringsURL();
93
94     void inspect(Node*);
95     void highlight(Node*);
96     void hideHighlight();
97
98     void show();
99     void showPanel(SpecialPanels);
100     void close();
101
102     bool isRecordingUserInitiatedProfile() const { return m_recordingUserInitiatedProfile; }
103     void startUserInitiatedProfiling();
104     void stopUserInitiatedProfiling();
105     void finishedProfiling(PassRefPtr<KJS::Profile>);
106
107     bool windowVisible();
108     void setWindowVisible(bool visible = true, bool attached = false);
109
110     void addMessageToConsole(MessageSource, MessageLevel, KJS::ExecState*, const KJS::ArgList& arguments, unsigned lineNumber, const String& sourceID);
111     void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, const String& sourceID);
112     void clearConsoleMessages();
113     void toggleRecordButton(bool);
114
115     void addProfile(PassRefPtr<KJS::Profile>);
116     void addScriptProfile(KJS::Profile* profile);
117     const Vector<RefPtr<KJS::Profile> >& profiles() const { return m_profiles; }
118
119     void attachWindow();
120     void detachWindow();
121
122     void setAttachedWindow(bool);
123     void setAttachedWindowHeight(unsigned height);
124
125     JSContextRef scriptContext() const { return m_scriptContext; };
126     void setScriptContext(JSContextRef context) { m_scriptContext = context; };
127
128     void inspectedWindowScriptObjectCleared(Frame*);
129     void windowScriptObjectAvailable();
130
131     void scriptObjectReady();
132
133     void populateScriptObjects();
134     void resetScriptObjects();
135
136     void didCommitLoad(DocumentLoader*);
137     void frameDetachedFromParent(Frame*);
138
139     void didLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length);
140
141     void identifierForInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&);
142     void willSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse);
143     void didReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&);
144     void didReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived);
145     void didFinishLoading(DocumentLoader*, unsigned long identifier);
146     void didFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&);
147     void resourceRetrievedByXMLHttpRequest(unsigned long identifier, KJS::UString& sourceString);
148
149 #if ENABLE(DATABASE)
150     void didOpenDatabase(Database*, const String& domain, const String& name, const String& version);
151 #endif
152
153     const ResourcesMap& resources() const { return m_resources; }
154
155     void moveWindowBy(float x, float y) const;
156     void closeWindow();
157
158     void startDebuggingAndReloadInspectedPage();
159     void stopDebugging();
160     bool debuggerAttached() const { return m_debuggerAttached; }
161
162     JavaScriptCallFrame* currentCallFrame() const;
163
164     void addBreakpoint(int sourceID, unsigned lineNumber);
165     void removeBreakpoint(int sourceID, unsigned lineNumber);
166
167     bool pauseOnExceptions();
168     void setPauseOnExceptions(bool pause);
169
170     void pauseInDebugger();
171     void resumeDebugger();
172
173     void stepOverStatementInDebugger();
174     void stepIntoStatementInDebugger();
175     void stepOutOfFunctionInDebugger();
176
177     void drawNodeHighlight(GraphicsContext&) const;
178     
179     void startTiming(const KJS::UString& title);
180     bool stopTiming(const KJS::UString& title, double& elapsed);
181
182     void startGroup();
183     void endGroup();
184
185 private:
186     void focusNode();
187
188     void addConsoleMessage(ConsoleMessage*);
189     void addScriptConsoleMessage(const ConsoleMessage*);
190
191     void addResource(InspectorResource*);
192     void removeResource(InspectorResource*);
193
194     JSObjectRef addScriptResource(InspectorResource*);
195     void removeScriptResource(InspectorResource*);
196
197     JSObjectRef addAndUpdateScriptResource(InspectorResource*);
198     void updateScriptResourceRequest(InspectorResource*);
199     void updateScriptResourceResponse(InspectorResource*);
200     void updateScriptResourceType(InspectorResource*);
201     void updateScriptResource(InspectorResource*, int length);
202     void updateScriptResource(InspectorResource*, bool finished, bool failed = false);
203     void updateScriptResource(InspectorResource*, double startTime, double responseReceivedTime, double endTime);
204
205     void pruneResources(ResourcesMap*, DocumentLoader* loaderToKeep = 0);
206     void removeAllResources(ResourcesMap* map) { pruneResources(map); }
207
208 #if ENABLE(DATABASE)
209     JSObjectRef addDatabaseScriptResource(InspectorDatabaseResource*);
210     void removeDatabaseScriptResource(InspectorDatabaseResource*);
211 #endif
212
213     JSValueRef callSimpleFunction(JSContextRef, JSObjectRef thisObject, const char* functionName) const;
214     JSValueRef callFunction(JSContextRef, JSObjectRef thisObject, const char* functionName, size_t argumentCount, const JSValueRef arguments[], JSValueRef& exception) const;
215
216     bool handleException(JSContextRef, JSValueRef exception, unsigned lineNumber) const;
217
218     void showWindow();
219
220     virtual void didParseSource(KJS::ExecState*, const KJS::SourceProvider& source, int startingLineNumber, const KJS::UString& sourceURL, int sourceID);
221     virtual void failedToParseSource(KJS::ExecState*, const KJS::SourceProvider& source, int startingLineNumber, const KJS::UString& sourceURL, int errorLine, const KJS::UString& errorMessage);
222     virtual void didPause();
223
224     Page* m_inspectedPage;
225     InspectorClient* m_client;
226     Page* m_page;
227     RefPtr<Node> m_nodeToFocus;
228     RefPtr<InspectorResource> m_mainResource;
229     ResourcesMap m_resources;
230     HashSet<String> m_knownResources;
231     FrameResourcesMap m_frameResources;
232     Vector<ConsoleMessage*> m_consoleMessages;
233     Vector<RefPtr<KJS::Profile> > m_profiles;
234     HashMap<String, double> m_times;
235 #if ENABLE(DATABASE)
236     DatabaseResourcesSet m_databaseResources;
237 #endif
238     JSObjectRef m_scriptObject;
239     JSObjectRef m_controllerScriptObject;
240     JSContextRef m_scriptContext;
241     bool m_windowVisible;
242     bool m_debuggerAttached;
243     bool m_attachDebuggerWhenShown;
244     bool m_recordingUserInitiatedProfile;
245     SpecialPanels m_showAfterVisible;
246     long long m_nextIdentifier;
247     RefPtr<Node> m_highlightedNode;
248     unsigned m_groupLevel;
249 };
250
251 } // namespace WebCore
252
253 #endif // !defined(InspectorController_h)