Reviewed by Mark Rowe.
[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 "Chrome.h"
33 #include <JavaScriptCore/JSContextRef.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/HashSet.h>
36 #include <wtf/Vector.h>
37
38 namespace WebCore {
39
40 class Database;
41 class DocumentLoader;
42 class InspectorClient;
43 class Node;
44 class ResourceResponse;
45 class ResourceError;
46
47 struct ConsoleMessage;
48 struct InspectorDatabaseResource;
49 struct InspectorResource;
50 struct ResourceRequest;
51
52 class InspectorController {
53 public:
54     typedef HashMap<long long, RefPtr<InspectorResource> > ResourcesMap;
55     typedef HashMap<RefPtr<Frame>, ResourcesMap*> FrameResourcesMap;
56     typedef HashSet<RefPtr<InspectorDatabaseResource> > DatabaseResourcesSet;
57
58     typedef enum {
59         FocusedNodeDocumentPanel,
60         ConsolePanel,
61         TimelinePanel
62     } SpecialPanels;
63
64     InspectorController(Page*, InspectorClient*);
65     ~InspectorController();
66
67     void pageDestroyed() { m_page = 0; }
68
69     bool enabled() const;
70
71     Page* inspectedPage() const { return m_inspectedPage; }
72
73     String localizedStringsURL();
74
75     void inspect(Node*);
76     void highlight(Node*);
77     void hideHighlight();
78
79     void show();
80     void showConsole();
81     void showTimeline();
82     void close();
83
84     bool windowVisible();
85     void setWindowVisible(bool visible = true);
86
87     void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, const String& sourceID);
88
89     void attachWindow();
90     void detachWindow();
91
92     JSContextRef scriptContext() const { return m_scriptContext; };
93     void setScriptContext(JSContextRef context) { m_scriptContext = context; };
94
95     void windowScriptObjectAvailable();
96
97     void scriptObjectReady();
98
99     void populateScriptResources();
100     void clearScriptResources();
101
102     void didCommitLoad(DocumentLoader*);
103     void frameDetachedFromParent(Frame*);
104
105     void didLoadResourceFromMemoryCache(DocumentLoader*, const ResourceRequest&, const ResourceResponse&, int length);
106
107     void identifierForInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&);
108     void willSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse);
109     void didReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&);
110     void didReceiveContentLength(DocumentLoader*, unsigned long identifier, int lengthReceived);
111     void didFinishLoading(DocumentLoader*, unsigned long identifier);
112     void didFailLoading(DocumentLoader*, unsigned long identifier, const ResourceError&);
113
114 #if ENABLE(DATABASE)
115     void didOpenDatabase(Database*, const String& domain, const String& name, const String& version);
116 #endif
117
118     const ResourcesMap& resources() const { return m_resources; }
119
120     void moveWindowBy(float x, float y) const;
121
122 private:
123     void focusNode();
124
125     void addScriptConsoleMessage(const ConsoleMessage*);
126     void clearScriptConsoleMessages();
127
128     void clearNetworkTimeline();
129     void clearDatabaseScriptResources();
130
131     void addResource(InspectorResource*);
132     void removeResource(InspectorResource*);
133
134     JSObjectRef addScriptResource(InspectorResource*);
135     void removeScriptResource(InspectorResource*);
136
137     JSObjectRef addAndUpdateScriptResource(InspectorResource*);
138     void updateScriptResourceRequest(InspectorResource*);
139     void updateScriptResourceResponse(InspectorResource*);
140     void updateScriptResource(InspectorResource*, int length);
141     void updateScriptResource(InspectorResource*, bool finished, bool failed = false);
142     void updateScriptResource(InspectorResource*, double startTime, double responseReceivedTime, double endTime);
143
144     void pruneResources(ResourcesMap*, DocumentLoader* loaderToKeep = 0);
145     void removeAllResources(ResourcesMap* map) { pruneResources(map); }
146
147 #if ENABLE(DATABASE)
148     JSObjectRef addDatabaseScriptResource(InspectorDatabaseResource*);
149     void removeDatabaseScriptResource(InspectorDatabaseResource*);
150 #endif
151
152     Page* m_inspectedPage;
153     InspectorClient* m_client;
154     Page* m_page;
155     RefPtr<Node> m_nodeToFocus;
156     RefPtr<InspectorResource> m_mainResource;
157     ResourcesMap m_resources;
158     FrameResourcesMap m_frameResources;
159     Vector<ConsoleMessage*> m_consoleMessages;
160 #if ENABLE(DATABASE)
161     DatabaseResourcesSet m_databaseResources;
162 #endif
163     JSObjectRef m_scriptObject;
164     JSObjectRef m_controllerScriptObject;
165     JSContextRef m_scriptContext;
166     bool m_windowVisible;
167     SpecialPanels m_showAfterVisible;
168     long long m_nextIdentifier;
169 };
170
171 } // namespace WebCore
172
173 #endif // !defined(InspectorController_h)