2008-07-26 Keishi Hattori <casey.hattori@gmail.com>
[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);
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
113     void addProfile(PassRefPtr<KJS::Profile>);
114     void addScriptProfile(KJS::Profile* profile);
115     const Vector<RefPtr<KJS::Profile> >& profiles() const { return m_profiles; }
116
117     void attachWindow();
118     void detachWindow();
119
120     JSContextRef scriptContext() const { return m_scriptContext; };
121     void setScriptContext(JSContextRef context) { m_scriptContext = context; };
122
123     void inspectedWindowScriptObjectCleared(Frame*);
124     void windowScriptObjectAvailable();
125
126     void scriptObjectReady();
127
128     void populateScriptObjects();
129     void resetScriptObjects();
130
131     void didCommitLoad(DocumentLoader*);
132     void frameDetachedFromParent(Frame*);
133
134     void didLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length);
135
136     void identifierForInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&);
137     void willSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse);
138     void didReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&);
139     void didReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived);
140     void didFinishLoading(DocumentLoader*, unsigned long identifier);
141     void didFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&);
142     void resourceRetrievedByXMLHttpRequest(unsigned long identifier, KJS::UString& sourceString);
143
144 #if ENABLE(DATABASE)
145     void didOpenDatabase(Database*, const String& domain, const String& name, const String& version);
146 #endif
147
148     const ResourcesMap& resources() const { return m_resources; }
149
150     void moveWindowBy(float x, float y) const;
151
152     void startDebuggingAndReloadInspectedPage();
153     void stopDebugging();
154     bool debuggerAttached() const { return m_debuggerAttached; }
155
156     JavaScriptCallFrame* currentCallFrame() const;
157
158     void addBreakpoint(int sourceID, unsigned lineNumber);
159     void removeBreakpoint(int sourceID, unsigned lineNumber);
160
161     bool pauseOnExceptions();
162     void setPauseOnExceptions(bool pause);
163
164     void pauseInDebugger();
165     void resumeDebugger();
166
167     void stepOverStatementInDebugger();
168     void stepIntoStatementInDebugger();
169     void stepOutOfFunctionInDebugger();
170
171     void drawNodeHighlight(GraphicsContext&) const;
172     
173     void startTiming(const KJS::UString& title);
174     bool stopTiming(const KJS::UString& title, double& elapsed);
175
176 private:
177     void focusNode();
178
179     void addConsoleMessage(ConsoleMessage*);
180     void addScriptConsoleMessage(const ConsoleMessage*);
181
182     void addResource(InspectorResource*);
183     void removeResource(InspectorResource*);
184
185     JSObjectRef addScriptResource(InspectorResource*);
186     void removeScriptResource(InspectorResource*);
187
188     JSObjectRef addAndUpdateScriptResource(InspectorResource*);
189     void updateScriptResourceRequest(InspectorResource*);
190     void updateScriptResourceResponse(InspectorResource*);
191     void updateScriptResourceType(InspectorResource*);
192     void updateScriptResource(InspectorResource*, int length);
193     void updateScriptResource(InspectorResource*, bool finished, bool failed = false);
194     void updateScriptResource(InspectorResource*, double startTime, double responseReceivedTime, double endTime);
195
196     void pruneResources(ResourcesMap*, DocumentLoader* loaderToKeep = 0);
197     void removeAllResources(ResourcesMap* map) { pruneResources(map); }
198
199 #if ENABLE(DATABASE)
200     JSObjectRef addDatabaseScriptResource(InspectorDatabaseResource*);
201     void removeDatabaseScriptResource(InspectorDatabaseResource*);
202 #endif
203
204     JSValueRef callSimpleFunction(JSContextRef, JSObjectRef thisObject, const char* functionName) const;
205     JSValueRef callFunction(JSContextRef, JSObjectRef thisObject, const char* functionName, size_t argumentCount, const JSValueRef arguments[], JSValueRef& exception) const;
206
207     bool handleException(JSContextRef, JSValueRef exception, unsigned lineNumber) const;
208
209     void showWindow();
210     void closeWindow();
211
212     virtual void didParseSource(KJS::ExecState*, const KJS::SourceProvider& source, int startingLineNumber, const KJS::UString& sourceURL, int sourceID);
213     virtual void failedToParseSource(KJS::ExecState*, const KJS::SourceProvider& source, int startingLineNumber, const KJS::UString& sourceURL, int errorLine, const KJS::UString& errorMessage);
214     virtual void didPause();
215
216     Page* m_inspectedPage;
217     InspectorClient* m_client;
218     Page* m_page;
219     RefPtr<Node> m_nodeToFocus;
220     RefPtr<InspectorResource> m_mainResource;
221     ResourcesMap m_resources;
222     HashSet<String> m_knownResources;
223     FrameResourcesMap m_frameResources;
224     Vector<ConsoleMessage*> m_consoleMessages;
225     Vector<RefPtr<KJS::Profile> > m_profiles;
226     HashMap<String, double> m_times;
227 #if ENABLE(DATABASE)
228     DatabaseResourcesSet m_databaseResources;
229 #endif
230     JSObjectRef m_scriptObject;
231     JSObjectRef m_controllerScriptObject;
232     JSContextRef m_scriptContext;
233     bool m_windowVisible;
234     bool m_debuggerAttached;
235     bool m_attachDebuggerWhenShown;
236     bool m_recordingUserInitiatedProfile;
237     SpecialPanels m_showAfterVisible;
238     long long m_nextIdentifier;
239     RefPtr<Node> m_highlightedNode;
240 };
241
242 } // namespace WebCore
243
244 #endif // !defined(InspectorController_h)