Adds a debugger toggle button to the scripts status bar that will start
[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 <JavaScriptCore/JSContextRef.h>
36 #include <wtf/HashMap.h>
37 #include <wtf/HashSet.h>
38 #include <wtf/Vector.h>
39
40 namespace KJS {
41     class UString;
42 }
43
44 namespace WebCore {
45
46 class Database;
47 class DocumentLoader;
48 class GraphicsContext;
49 class InspectorClient;
50 class Node;
51 class Page;
52 class ResourceResponse;
53 class ResourceError;
54 class SharedBuffer;
55
56 struct ConsoleMessage;
57 struct InspectorDatabaseResource;
58 struct InspectorResource;
59 class ResourceRequest;
60
61 class InspectorController : JavaScriptDebugListener {
62 public:
63     typedef HashMap<long long, RefPtr<InspectorResource> > ResourcesMap;
64     typedef HashMap<RefPtr<Frame>, ResourcesMap*> FrameResourcesMap;
65     typedef HashSet<RefPtr<InspectorDatabaseResource> > DatabaseResourcesSet;
66
67     typedef enum {
68         FocusedNodeDocumentPanel,
69         ConsolePanel,
70         TimelinePanel
71     } SpecialPanels;
72
73     InspectorController(Page*, InspectorClient*);
74     ~InspectorController();
75
76     void pageDestroyed() { m_page = 0; }
77
78     bool enabled() const;
79
80     Page* inspectedPage() const { return m_inspectedPage; }
81
82     String localizedStringsURL();
83
84     void inspect(Node*);
85     void highlight(Node*);
86     void hideHighlight();
87
88     void show();
89     void showConsole();
90     void showTimeline();
91     void close();
92
93     bool windowVisible();
94     void setWindowVisible(bool visible = true);
95
96     void addMessageToConsole(MessageSource, MessageLevel, KJS::ExecState*, const KJS::List& arguments, unsigned lineNumber, const String& sourceID);
97     void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, const String& sourceID);
98
99     void attachWindow();
100     void detachWindow();
101
102     JSContextRef scriptContext() const { return m_scriptContext; };
103     void setScriptContext(JSContextRef context) { m_scriptContext = context; };
104
105     void windowScriptObjectAvailable();
106
107     void scriptObjectReady();
108
109     void populateScriptObjects();
110     void resetScriptObjects();
111
112     void didCommitLoad(DocumentLoader*);
113     void frameDetachedFromParent(Frame*);
114
115     void didLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length);
116
117     void identifierForInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&);
118     void willSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse);
119     void didReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&);
120     void didReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived);
121     void didFinishLoading(DocumentLoader*, unsigned long identifier);
122     void didFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&);
123     void resourceRetrievedByXMLHttpRequest(unsigned long identifier, KJS::UString& sourceString);
124
125 #if ENABLE(DATABASE)
126     void didOpenDatabase(Database*, const String& domain, const String& name, const String& version);
127 #endif
128
129     const ResourcesMap& resources() const { return m_resources; }
130
131     void moveWindowBy(float x, float y) const;
132
133     void startDebuggingAndReloadInspectedPage();
134     void stopDebugging();
135     bool debuggerAttached() const { return m_debuggerAttached; }
136
137     void drawNodeHighlight(GraphicsContext&) const;
138
139 private:
140     void focusNode();
141
142     void addConsoleMessage(ConsoleMessage*);
143     void addScriptConsoleMessage(const ConsoleMessage*);
144
145     void addResource(InspectorResource*);
146     void removeResource(InspectorResource*);
147
148     JSObjectRef addScriptResource(InspectorResource*);
149     void removeScriptResource(InspectorResource*);
150
151     JSObjectRef addAndUpdateScriptResource(InspectorResource*);
152     void updateScriptResourceRequest(InspectorResource*);
153     void updateScriptResourceResponse(InspectorResource*);
154     void updateScriptResource(InspectorResource*, int length);
155     void updateScriptResource(InspectorResource*, bool finished, bool failed = false);
156     void updateScriptResource(InspectorResource*, double startTime, double responseReceivedTime, double endTime);
157
158     void pruneResources(ResourcesMap*, DocumentLoader* loaderToKeep = 0);
159     void removeAllResources(ResourcesMap* map) { pruneResources(map); }
160
161 #if ENABLE(DATABASE)
162     JSObjectRef addDatabaseScriptResource(InspectorDatabaseResource*);
163     void removeDatabaseScriptResource(InspectorDatabaseResource*);
164 #endif
165
166     JSValueRef callSimpleFunction(JSContextRef, JSObjectRef thisObject, const char* functionName) const;
167
168     bool handleException(JSValueRef exception, unsigned lineNumber) const;
169
170     void showWindow();
171     void closeWindow();
172
173     virtual void didParseSource(KJS::ExecState*, const KJS::UString& source, int startingLineNumber, const KJS::UString& sourceURL, int sourceID);
174     virtual void failedToParseSource(KJS::ExecState*, const KJS::UString& source, int startingLineNumber, const KJS::UString& sourceURL, int errorLine, const KJS::UString& errorMessage);
175     virtual void didEnterCallFrame(KJS::ExecState*, int sourceID, int lineNumber);
176     virtual void willExecuteStatement(KJS::ExecState*, int sourceID, int lineNumber);
177     virtual void willLeaveCallFrame(KJS::ExecState*, int sourceID, int lineNumber);
178     virtual void exceptionWasRaised(KJS::ExecState*, int sourceID, int lineNumber);
179
180     Page* m_inspectedPage;
181     InspectorClient* m_client;
182     Page* m_page;
183     RefPtr<Node> m_nodeToFocus;
184     RefPtr<InspectorResource> m_mainResource;
185     ResourcesMap m_resources;
186     FrameResourcesMap m_frameResources;
187     Vector<ConsoleMessage*> m_consoleMessages;
188 #if ENABLE(DATABASE)
189     DatabaseResourcesSet m_databaseResources;
190 #endif
191     JSObjectRef m_scriptObject;
192     JSObjectRef m_controllerScriptObject;
193     JSContextRef m_scriptContext;
194     bool m_windowVisible;
195     bool m_debuggerAttached;
196     SpecialPanels m_showAfterVisible;
197     long long m_nextIdentifier;
198     RefPtr<Node> m_highlightedNode;
199 };
200
201 } // namespace WebCore
202
203 #endif // !defined(InspectorController_h)