Web Inspector: Remove InspectorState
[WebKit-https.git] / Source / WebCore / inspector / InspectorPageAgent.h
1 /*
2  * Copyright (C) 2011 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef InspectorPageAgent_h
32 #define InspectorPageAgent_h
33
34 #if ENABLE(INSPECTOR)
35
36 #include "DeviceOrientationData.h"
37 #include "GeolocationPosition.h"
38 #include "InspectorBaseAgent.h"
39 #include "InspectorFrontend.h"
40 #include "IntSize.h"
41 #include "LayoutRect.h"
42 #include <wtf/HashMap.h>
43 #include <wtf/RefCounted.h>
44 #include <wtf/Vector.h>
45 #include <wtf/text/WTFString.h>
46
47 namespace WebCore {
48
49 class CachedResource;
50 class DOMWrapperWorld;
51 class DocumentLoader;
52 class Frame;
53 class Frontend;
54 class GraphicsContext;
55 class InjectedScriptManager;
56 class InspectorAgent;
57 class InspectorArray;
58 class InspectorClient;
59 class InspectorObject;
60 class InspectorOverlay;
61 class InstrumentingAgents;
62 class URL;
63 class Page;
64 class RegularExpression;
65 class SharedBuffer;
66 class TextResourceDecoder;
67
68 typedef String ErrorString;
69
70 class InspectorPageAgent : public InspectorBaseAgent<InspectorPageAgent>, public InspectorBackendDispatcher::PageCommandHandler {
71     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
72 public:
73     enum ResourceType {
74         DocumentResource,
75         StylesheetResource,
76         ImageResource,
77         FontResource,
78         ScriptResource,
79         XHRResource,
80         WebSocketResource,
81         OtherResource
82     };
83
84     static PassOwnPtr<InspectorPageAgent> create(InstrumentingAgents*, Page*, InspectorAgent*, InjectedScriptManager*, InspectorClient*, InspectorOverlay*);
85
86     static bool cachedResourceContent(CachedResource*, String* result, bool* base64Encoded);
87     static bool sharedBufferContent(PassRefPtr<SharedBuffer>, const String& textEncodingName, bool withBase64Encode, String* result);
88     static void resourceContent(ErrorString*, Frame*, const URL&, String* result, bool* base64Encoded);
89     static String sourceMapURLForResource(CachedResource*);
90
91     static PassRefPtr<SharedBuffer> resourceData(Frame*, const URL&, String* textEncodingName);
92     static CachedResource* cachedResource(Frame*, const URL&);
93     static TypeBuilder::Page::ResourceType::Enum resourceTypeJson(ResourceType);
94     static ResourceType cachedResourceType(const CachedResource&);
95     static TypeBuilder::Page::ResourceType::Enum cachedResourceTypeJson(const CachedResource&);
96
97     // Page API for InspectorFrontend
98     virtual void enable(ErrorString*);
99     virtual void disable(ErrorString*);
100     virtual void addScriptToEvaluateOnLoad(ErrorString*, const String& source, String* result);
101     virtual void removeScriptToEvaluateOnLoad(ErrorString*, const String& identifier);
102     virtual void reload(ErrorString*, const bool* optionalIgnoreCache, const String* optionalScriptToEvaluateOnLoad, const String* optionalScriptPreprocessor);
103     virtual void navigate(ErrorString*, const String& url);
104     virtual void getCookies(ErrorString*, RefPtr<TypeBuilder::Array<TypeBuilder::Page::Cookie>>& cookies, WTF::String* cookiesString);
105     virtual void deleteCookie(ErrorString*, const String& cookieName, const String& url);
106     virtual void getResourceTree(ErrorString*, RefPtr<TypeBuilder::Page::FrameResourceTree>&);
107     virtual void getResourceContent(ErrorString*, const String& frameId, const String& url, String* content, bool* base64Encoded);
108     virtual void searchInResource(ErrorString*, const String& frameId, const String& url, const String& query, const bool* optionalCaseSensitive, const bool* optionalIsRegex, RefPtr<TypeBuilder::Array<TypeBuilder::Page::SearchMatch>>&);
109     virtual void searchInResources(ErrorString*, const String&, const bool* caseSensitive, const bool* isRegex, RefPtr<TypeBuilder::Array<TypeBuilder::Page::SearchResult>>&);
110     virtual void setDocumentContent(ErrorString*, const String& frameId, const String& html);
111     virtual void canOverrideDeviceMetrics(ErrorString*, bool*);
112     virtual void setDeviceMetricsOverride(ErrorString*, int width, int height, double fontScaleFactor, bool fitWindow);
113     virtual void setShowPaintRects(ErrorString*, bool show);
114     virtual void canShowDebugBorders(ErrorString*, bool*);
115     virtual void setShowDebugBorders(ErrorString*, bool show);
116     virtual void canShowFPSCounter(ErrorString*, bool*);
117     virtual void setShowFPSCounter(ErrorString*, bool show);
118     virtual void canContinuouslyPaint(ErrorString*, bool*);
119     virtual void setContinuousPaintingEnabled(ErrorString*, bool enabled);
120     virtual void getScriptExecutionStatus(ErrorString*, PageCommandHandler::Result::Enum*);
121     virtual void setScriptExecutionDisabled(ErrorString*, bool);
122     virtual void setGeolocationOverride(ErrorString*, const double*, const double*, const double*);
123     virtual void clearGeolocationOverride(ErrorString*);
124     virtual void canOverrideGeolocation(ErrorString*, bool* out_param);
125     virtual void setDeviceOrientationOverride(ErrorString*, double, double, double);
126     virtual void clearDeviceOrientationOverride(ErrorString*);
127     virtual void canOverrideDeviceOrientation(ErrorString*, bool*);
128     virtual void setTouchEmulationEnabled(ErrorString*, bool);
129     virtual void setEmulatedMedia(ErrorString*, const String&);
130     virtual void getCompositingBordersVisible(ErrorString*, bool* out_param);
131     virtual void setCompositingBordersVisible(ErrorString*, bool);
132     virtual void captureScreenshot(ErrorString*, String* data);
133     virtual void handleJavaScriptDialog(ErrorString*, bool accept, const String* promptText);
134     virtual void archive(ErrorString*, String* data);
135
136     // Geolocation override helpers.
137     GeolocationPosition* overrideGeolocationPosition(GeolocationPosition*);
138
139     // DeviceOrientation helper
140     DeviceOrientationData* overrideDeviceOrientation(DeviceOrientationData*);
141
142     // InspectorInstrumentation API
143     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld&);
144     void domContentEventFired();
145     void loadEventFired();
146     void frameNavigated(DocumentLoader*);
147     void frameDetached(Frame*);
148     void loaderDetachedFromFrame(DocumentLoader*);
149     void frameStartedLoading(Frame*);
150     void frameStoppedLoading(Frame*);
151     void frameScheduledNavigation(Frame*, double delay);
152     void frameClearedScheduledNavigation(Frame*);
153     void willRunJavaScriptDialog(const String& message);
154     void didRunJavaScriptDialog();
155     void applyScreenWidthOverride(long*);
156     void applyScreenHeightOverride(long*);
157     void applyEmulatedMedia(String*);
158     void didPaint(GraphicsContext*, const LayoutRect&);
159     void didLayout();
160     void didScroll();
161     void didRecalculateStyle();
162     void scriptsEnabled(bool isEnabled);
163
164     // Inspector Controller API
165     virtual void setFrontend(InspectorFrontend*);
166     virtual void clearFrontend();
167
168     void webViewResized(const IntSize&);
169
170     // Cross-agents API
171     Page* page() { return m_page; }
172     Frame* mainFrame();
173     String createIdentifier();
174     Frame* frameForId(const String& frameId);
175     String frameId(Frame*);
176     bool hasIdForFrame(Frame*) const;
177     String loaderId(DocumentLoader*);
178     Frame* findFrameWithSecurityOrigin(const String& originRawString);
179     Frame* assertFrame(ErrorString*, const String& frameId);
180     String scriptPreprocessor() { return m_scriptPreprocessor; }
181     static DocumentLoader* assertDocumentLoader(ErrorString*, Frame*);
182
183 private:
184     InspectorPageAgent(InstrumentingAgents*, Page*, InspectorAgent*, InjectedScriptManager*, InspectorClient*, InspectorOverlay*);
185     bool deviceMetricsChanged(int width, int height, double fontScaleFactor, bool fitWindow);
186     void updateViewMetrics(int, int, double, bool);
187 #if ENABLE(TOUCH_EVENTS)
188     void updateTouchEventEmulationInPage(bool);
189 #endif
190
191     static bool mainResourceContent(Frame*, bool withBase64Encode, String* result);
192     static bool dataContent(const char* data, unsigned size, const String& textEncodingName, bool withBase64Encode, String* result);
193
194     PassRefPtr<TypeBuilder::Page::Frame> buildObjectForFrame(Frame*);
195     PassRefPtr<TypeBuilder::Page::FrameResourceTree> buildObjectForFrameTree(Frame*);
196     Page* m_page;
197     InspectorAgent* m_inspectorAgent;
198     InjectedScriptManager* m_injectedScriptManager;
199     InspectorClient* m_client;
200     InspectorFrontend::Page* m_frontend;
201     InspectorOverlay* m_overlay;
202     long m_lastScriptIdentifier;
203     String m_pendingScriptToEvaluateOnLoadOnce;
204     String m_scriptToEvaluateOnLoadOnce;
205     String m_pendingScriptPreprocessor;
206     String m_scriptPreprocessor;
207     HashMap<Frame*, String> m_frameToIdentifier;
208     HashMap<String, Frame*> m_identifierToFrame;
209     HashMap<DocumentLoader*, String> m_loaderToIdentifier;
210     int m_screenWidthOverride;
211     int m_screenHeightOverride;
212     double m_fontScaleFactorOverride;
213     bool m_fitWindowOverride;
214     bool m_enabled;
215     bool m_isFirstLayoutAfterOnLoad;
216     bool m_originalScriptExecutionDisabled;
217     bool m_geolocationOverridden;
218     bool m_ignoreScriptsEnabledNotification;
219     bool m_showPaintRects;
220     String m_emulatedMedia;
221     RefPtr<InspectorObject> m_scriptsToEvaluateOnLoad;
222     RefPtr<GeolocationPosition> m_geolocationPosition;
223     RefPtr<GeolocationPosition> m_platformGeolocationPosition;
224     RefPtr<DeviceOrientationData> m_deviceOrientation;
225 };
226
227
228 } // namespace WebCore
229
230 #endif // ENABLE(INSPECTOR)
231
232 #endif // !defined(InspectorPagerAgent_h)