Web Inspector: introduce Page.captureScreenshot
[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 "Frame.h"
38 #include "GeolocationPosition.h"
39 #include "InspectorBaseAgent.h"
40 #include "InspectorFrontend.h"
41 #include <wtf/HashMap.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/Vector.h>
44 #include <wtf/text/WTFString.h>
45
46 namespace WebCore {
47
48 class CachedResource;
49 class DOMWrapperWorld;
50 class DocumentLoader;
51 class Frame;
52 class Frontend;
53 class InjectedScriptManager;
54 class InspectorAgent;
55 class InspectorArray;
56 class InspectorClient;
57 class InspectorObject;
58 class InspectorOverlay;
59 class InspectorState;
60 class InstrumentingAgents;
61 class KURL;
62 class Page;
63 class RegularExpression;
64 class SharedBuffer;
65 class TextResourceDecoder;
66
67 typedef String ErrorString;
68
69 class InspectorPageAgent : public InspectorBaseAgent<InspectorPageAgent>, public InspectorBackendDispatcher::PageCommandHandler {
70     WTF_MAKE_NONCOPYABLE(InspectorPageAgent);
71 public:
72     enum ResourceType {
73         DocumentResource,
74         StylesheetResource,
75         ImageResource,
76         FontResource,
77         ScriptResource,
78         XHRResource,
79         WebSocketResource,
80         OtherResource
81     };
82
83     static PassOwnPtr<InspectorPageAgent> create(InstrumentingAgents*, Page*, InspectorAgent*, InspectorState*, InjectedScriptManager*, InspectorClient*, InspectorOverlay*);
84
85     static bool cachedResourceContent(CachedResource*, String* result, bool* base64Encoded);
86     static bool sharedBufferContent(PassRefPtr<SharedBuffer>, const String& textEncodingName, bool withBase64Encode, String* result);
87     static void resourceContent(ErrorString*, Frame*, const KURL&, String* result, bool* base64Encoded);
88
89     static PassRefPtr<SharedBuffer> resourceData(Frame*, const KURL&, String* textEncodingName);
90     static CachedResource* cachedResource(Frame*, const KURL&);
91     static TypeBuilder::Page::ResourceType::Enum resourceTypeJson(ResourceType);
92     static ResourceType cachedResourceType(const CachedResource&);
93     static TypeBuilder::Page::ResourceType::Enum cachedResourceTypeJson(const CachedResource&);
94
95     // Page API for InspectorFrontend
96     virtual void enable(ErrorString*);
97     virtual void disable(ErrorString*);
98     virtual void addScriptToEvaluateOnLoad(ErrorString*, const String& source, String* result);
99     virtual void removeScriptToEvaluateOnLoad(ErrorString*, const String& identifier);
100     virtual void reload(ErrorString*, const bool* optionalIgnoreCache, const String* optionalScriptToEvaluateOnLoad, const String* optionalScriptPreprocessor);
101     virtual void navigate(ErrorString*, const String& url);
102     virtual void getCookies(ErrorString*, RefPtr<TypeBuilder::Array<TypeBuilder::Page::Cookie> >& cookies, WTF::String* cookiesString);
103     virtual void deleteCookie(ErrorString*, const String& cookieName, const String& domain);
104     virtual void getResourceTree(ErrorString*, RefPtr<TypeBuilder::Page::FrameResourceTree>&);
105     virtual void getResourceContent(ErrorString*, const String& frameId, const String& url, String* content, bool* base64Encoded);
106     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> >&);
107     virtual void searchInResources(ErrorString*, const String&, const bool* caseSensitive, const bool* isRegex, RefPtr<TypeBuilder::Array<TypeBuilder::Page::SearchResult> >&);
108     virtual void setDocumentContent(ErrorString*, const String& frameId, const String& html);
109     virtual void canOverrideDeviceMetrics(ErrorString*, bool*);
110     virtual void setDeviceMetricsOverride(ErrorString*, int width, int height, double fontScaleFactor, bool fitWindow);
111     virtual void setShowPaintRects(ErrorString*, bool show);
112     virtual void canShowFPSCounter(ErrorString*, bool*);
113     virtual void setShowFPSCounter(ErrorString*, bool show);
114     virtual void getScriptExecutionStatus(ErrorString*, PageCommandHandler::Result::Enum*);
115     virtual void setScriptExecutionDisabled(ErrorString*, bool);
116     virtual void setGeolocationOverride(ErrorString*, const double*, const double*, const double*);
117     virtual void clearGeolocationOverride(ErrorString*);
118     virtual void canOverrideGeolocation(ErrorString*, bool* out_param);
119     virtual void setDeviceOrientationOverride(ErrorString*, double, double, double);
120     virtual void clearDeviceOrientationOverride(ErrorString*);
121     virtual void canOverrideDeviceOrientation(ErrorString*, bool*);
122     virtual void setTouchEmulationEnabled(ErrorString*, bool);
123     virtual void setEmulatedMedia(ErrorString*, const String&);
124     virtual void getCompositingBordersVisible(ErrorString*, bool* out_param);
125     virtual void setCompositingBordersVisible(ErrorString*, bool);
126     virtual void captureScreenshot(ErrorString*, String* data);
127
128     // Geolocation override helpers.
129     GeolocationPosition* overrideGeolocationPosition(GeolocationPosition*);
130
131     // DeviceOrientation helper
132     DeviceOrientationData* overrideDeviceOrientation(DeviceOrientationData*);
133
134     // InspectorInstrumentation API
135     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
136     void domContentEventFired();
137     void loadEventFired();
138     void frameNavigated(DocumentLoader*);
139     void frameDetached(Frame*);
140     void loaderDetachedFromFrame(DocumentLoader*);
141     void applyScreenWidthOverride(long*);
142     void applyScreenHeightOverride(long*);
143     void applyEmulatedMedia(String*);
144     void didPaint(GraphicsContext*, const LayoutRect&);
145     void didLayout();
146     void didScroll();
147     void didRecalculateStyle();
148
149     // Inspector Controller API
150     virtual void setFrontend(InspectorFrontend*);
151     virtual void clearFrontend();
152     virtual void restore();
153
154     void webViewResized(const IntSize&);
155
156     // Cross-agents API
157     Page* page() { return m_page; }
158     Frame* mainFrame();
159     String createIdentifier();
160     Frame* frameForId(const String& frameId);
161     String frameId(Frame*);
162     String loaderId(DocumentLoader*);
163     Frame* assertFrame(ErrorString*, String frameId);
164     String scriptPreprocessor() { return m_scriptPreprocessor; }
165     static DocumentLoader* assertDocumentLoader(ErrorString*, Frame*);
166
167 private:
168     InspectorPageAgent(InstrumentingAgents*, Page*, InspectorAgent*, InspectorState*, InjectedScriptManager*, InspectorClient*, InspectorOverlay*);
169     void updateViewMetrics(int, int, double, bool);
170 #if ENABLE(TOUCH_EVENTS)
171     void updateTouchEventEmulationInPage(bool);
172 #endif
173
174     static bool mainResourceContent(Frame*, bool withBase64Encode, String* result);
175     static bool dataContent(const char* data, unsigned size, const String& textEncodingName, bool withBase64Encode, String* result);
176
177     PassRefPtr<TypeBuilder::Page::Frame> buildObjectForFrame(Frame*);
178     PassRefPtr<TypeBuilder::Page::FrameResourceTree> buildObjectForFrameTree(Frame*);
179     Page* m_page;
180     InspectorAgent* m_inspectorAgent;
181     InjectedScriptManager* m_injectedScriptManager;
182     InspectorClient* m_client;
183     InspectorFrontend::Page* m_frontend;
184     InspectorOverlay* m_overlay;
185     long m_lastScriptIdentifier;
186     String m_pendingScriptToEvaluateOnLoadOnce;
187     String m_scriptToEvaluateOnLoadOnce;
188     String m_pendingScriptPreprocessor;
189     String m_scriptPreprocessor;
190     HashMap<Frame*, String> m_frameToIdentifier;
191     HashMap<String, Frame*> m_identifierToFrame;
192     HashMap<DocumentLoader*, String> m_loaderToIdentifier;
193     bool m_enabled;
194     bool m_isFirstLayoutAfterOnLoad;
195     bool m_geolocationOverridden;
196     RefPtr<GeolocationPosition> m_geolocationPosition;
197     RefPtr<GeolocationPosition> m_platformGeolocationPosition;
198     RefPtr<DeviceOrientationData> m_deviceOrientation;
199 };
200
201
202 } // namespace WebCore
203
204 #endif // ENABLE(INSPECTOR)
205
206 #endif // !defined(InspectorPagerAgent_h)