Part 2 of removing PlatformString.h, remove PlatformString.h
[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);
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 getScriptExecutionStatus(ErrorString*, PageCommandHandler::Result::Enum*);
113     virtual void setScriptExecutionDisabled(ErrorString*, bool);
114     virtual void setGeolocationOverride(ErrorString*, const double*, const double*, const double*);
115     virtual void clearGeolocationOverride(ErrorString*);
116     virtual void canOverrideGeolocation(ErrorString*, bool* out_param);
117     virtual void setDeviceOrientationOverride(ErrorString*, double, double, double);
118     virtual void clearDeviceOrientationOverride(ErrorString*);
119     virtual void canOverrideDeviceOrientation(ErrorString*, bool*);
120     virtual void setTouchEmulationEnabled(ErrorString*, bool);
121
122     // Geolocation override helpers.
123     GeolocationPosition* overrideGeolocationPosition(GeolocationPosition*);
124
125     // DeviceOrientation helper
126     DeviceOrientationData* overrideDeviceOrientation(DeviceOrientationData*);
127
128     // InspectorInstrumentation API
129     void didClearWindowObjectInWorld(Frame*, DOMWrapperWorld*);
130     void domContentEventFired();
131     void loadEventFired();
132     void frameNavigated(DocumentLoader*);
133     void frameDetached(Frame*);
134     void loaderDetachedFromFrame(DocumentLoader*);
135     void applyScreenWidthOverride(long*);
136     void applyScreenHeightOverride(long*);
137     void willPaint(GraphicsContext*, const LayoutRect&);
138     void didPaint();
139     void didLayout();
140     void didScroll();
141
142     // Inspector Controller API
143     virtual void setFrontend(InspectorFrontend*);
144     virtual void clearFrontend();
145     virtual void restore();
146
147     // Cross-agents API
148     Frame* mainFrame();
149     String createIdentifier();
150     Frame* frameForId(const String& frameId);
151     String frameId(Frame*);
152     String loaderId(DocumentLoader*);
153     Frame* assertFrame(ErrorString*, String frameId);
154     static DocumentLoader* assertDocumentLoader(ErrorString*, Frame*);
155
156 private:
157     InspectorPageAgent(InstrumentingAgents*, Page*, InspectorAgent*, InspectorState*, InjectedScriptManager*, InspectorClient*, InspectorOverlay*);
158     void updateViewMetrics(int, int, double, bool);
159 #if ENABLE(TOUCH_EVENTS)
160     void updateTouchEventEmulationInPage(bool);
161 #endif
162
163     PassRefPtr<TypeBuilder::Page::Frame> buildObjectForFrame(Frame*);
164     PassRefPtr<TypeBuilder::Page::FrameResourceTree> buildObjectForFrameTree(Frame*);
165     Page* m_page;
166     InspectorAgent* m_inspectorAgent;
167     InjectedScriptManager* m_injectedScriptManager;
168     InspectorClient* m_client;
169     InspectorFrontend::Page* m_frontend;
170     InspectorOverlay* m_overlay;
171     long m_lastScriptIdentifier;
172     String m_pendingScriptToEvaluateOnLoadOnce;
173     String m_scriptToEvaluateOnLoadOnce;
174     HashMap<Frame*, String> m_frameToIdentifier;
175     HashMap<String, Frame*> m_identifierToFrame;
176     HashMap<DocumentLoader*, String> m_loaderToIdentifier;
177     GraphicsContext* m_lastPaintContext;
178     LayoutRect m_lastPaintRect;
179     bool m_didLoadEventFire;
180     bool m_geolocationOverridden;
181     RefPtr<GeolocationPosition> m_geolocationPosition;
182     RefPtr<GeolocationPosition> m_platformGeolocationPosition;
183     RefPtr<DeviceOrientationData> m_deviceOrientation;
184 };
185
186
187 } // namespace WebCore
188
189 #endif // ENABLE(INSPECTOR)
190
191 #endif // !defined(InspectorPagerAgent_h)