4f9c7c922405f5046d191ebdb0bc01256d1d369d
[WebKit-https.git] / Tools / DumpRenderTree / chromium / WebViewHost.h
1 /*
2  * Copyright (C) 2012 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 WebViewHost_h
32 #define WebViewHost_h
33
34 #include "TestNavigationController.h"
35 #include "WebCursorInfo.h"
36 #include "WebFrameClient.h"
37 #include "WebPrerendererClient.h"
38 #include "WebTask.h"
39 #include "WebTestDelegate.h"
40 #include "WebTestProxy.h"
41 #include "WebViewClient.h"
42 #include <wtf/HashMap.h>
43 #include <wtf/HashSet.h>
44 #include <wtf/Vector.h>
45 #include <wtf/text/WTFString.h>
46
47 class MockWebSpeechInputController;
48 class MockWebSpeechRecognizer;
49 class SkCanvas;
50 class TestShell;
51
52 namespace WebKit {
53 class WebFrame;
54 class WebDeviceOrientationClient;
55 class WebDeviceOrientationClientMock;
56 class WebGeolocationClient;
57 class WebGeolocationClientMock;
58 class WebGeolocationServiceMock;
59 class WebSerializedScriptValue;
60 class WebSharedWorkerClient;
61 class WebSpeechInputController;
62 class WebSpeechInputListener;
63 class WebURL;
64 struct WebRect;
65 struct WebURLError;
66 struct WebWindowFeatures;
67 }
68
69 namespace webkit_support {
70 class MediaStreamUtil;
71 class TestMediaStreamClient;
72 }
73
74 namespace WebTestRunner {
75 class WebTestRunner;
76 }
77
78 class WebViewHost : public WebKit::WebViewClient, public WebKit::WebFrameClient, public NavigationHost, public WebKit::WebPrerendererClient, public WebTestRunner::WebTestDelegate {
79  public:
80     WebViewHost(TestShell*);
81     virtual ~WebViewHost();
82     void shutdown();
83     void setWebWidget(WebKit::WebWidget*);
84     WebKit::WebView* webView() const;
85     WebKit::WebWidget* webWidget() const;
86     WebTestRunner::WebTestProxyBase* proxy() const;
87     void setProxy(WebTestRunner::WebTestProxyBase*);
88     void reset();
89     void setPendingExtraData(PassOwnPtr<TestShellExtraData>);
90
91     TestNavigationController* navigationController() { return m_navigationController.get(); }
92
93     void closeWidget();
94
95 #if ENABLE(INPUT_SPEECH)
96     MockWebSpeechInputController* speechInputControllerMock() { return m_speechInputControllerMock.get(); }
97 #endif
98
99 #if ENABLE(SCRIPTED_SPEECH)
100     MockWebSpeechRecognizer* mockSpeechRecognizer() { return m_mockSpeechRecognizer.get(); }
101 #endif
102
103     // WebTestDelegate.
104     virtual void setEditCommand(const std::string& name, const std::string& value) OVERRIDE;
105     virtual void clearEditCommand() OVERRIDE;
106     virtual void setGamepadData(const WebKit::WebGamepads&) OVERRIDE;
107     virtual void printMessage(const std::string& message) OVERRIDE;
108     virtual void postTask(WebTestRunner::WebTask*) OVERRIDE;
109     virtual void postDelayedTask(WebTestRunner::WebTask*, long long ms) OVERRIDE;
110     virtual WebKit::WebString registerIsolatedFileSystem(const WebKit::WebVector<WebKit::WebString>& absoluteFilenames) OVERRIDE;
111     virtual long long getCurrentTimeInMillisecond() OVERRIDE;
112     virtual WebKit::WebString getAbsoluteWebStringFromUTF8Path(const std::string& path) OVERRIDE;
113     virtual WebKit::WebURL localFileToDataURL(const WebKit::WebURL&) OVERRIDE;
114     virtual WebKit::WebURL rewriteLayoutTestsURL(const std::string&) OVERRIDE;
115     virtual WebTestRunner::WebPreferences* preferences() OVERRIDE;
116     virtual void applyPreferences() OVERRIDE;
117     virtual std::string makeURLErrorDescription(const WebKit::WebURLError&) OVERRIDE;
118     virtual void setClientWindowRect(const WebKit::WebRect&) OVERRIDE;
119     virtual void showDevTools() OVERRIDE;
120     virtual void closeDevTools() OVERRIDE;
121     virtual void evaluateInWebInspector(long, const std::string&) OVERRIDE;
122     virtual void clearAllDatabases() OVERRIDE;
123     virtual void setDatabaseQuota(int) OVERRIDE;
124     virtual void setDeviceScaleFactor(float) OVERRIDE;
125     virtual void setFocus(bool) OVERRIDE;
126     virtual void setAcceptAllCookies(bool) OVERRIDE;
127     virtual std::string pathToLocalResource(const std::string& url) OVERRIDE;
128     virtual void setLocale(const std::string&) OVERRIDE;
129     virtual void setDeviceOrientation(WebKit::WebDeviceOrientation&) OVERRIDE;
130 #if ENABLE(POINTER_LOCK)
131     virtual void didAcquirePointerLock() OVERRIDE;
132     virtual void didNotAcquirePointerLock() OVERRIDE;
133     virtual void didLosePointerLock() OVERRIDE;
134     virtual void setPointerLockWillRespondAsynchronously() OVERRIDE { m_pointerLockPlannedResult = PointerLockWillRespondAsync; }
135     virtual void setPointerLockWillFailSynchronously() OVERRIDE { m_pointerLockPlannedResult = PointerLockWillFailSync; }
136 #endif
137     virtual int numberOfPendingGeolocationPermissionRequests() OVERRIDE;
138     virtual void setGeolocationPermission(bool) OVERRIDE;
139     virtual void setMockGeolocationPosition(double, double, double) OVERRIDE;
140     virtual void setMockGeolocationPositionUnavailableError(const std::string&) OVERRIDE;
141 #if ENABLE(INPUT_SPEECH)
142     virtual void addMockSpeechInputResult(const std::string&, double, const std::string&) OVERRIDE;
143     virtual void setMockSpeechInputDumpRect(bool) OVERRIDE;
144 #endif
145 #if ENABLE(SCRIPTED_SPEECH)
146     virtual void addMockSpeechRecognitionResult(const std::string&, double) OVERRIDE;
147     virtual void setMockSpeechRecognitionError(const std::string&, const std::string&) OVERRIDE;
148     virtual bool wasMockSpeechRecognitionAborted() OVERRIDE;
149 #endif
150     virtual void testFinished() OVERRIDE;
151     virtual void testTimedOut() OVERRIDE;
152     virtual bool isBeingDebugged() OVERRIDE;
153     virtual int layoutTestTimeout() OVERRIDE;
154     virtual void closeRemainingWindows() OVERRIDE;
155     virtual int navigationEntryCount() OVERRIDE;
156     virtual int windowCount() OVERRIDE;
157     virtual void goToOffset(int) OVERRIDE;
158     virtual void reload() OVERRIDE;
159     virtual void loadURLForFrame(const WebKit::WebURL&, const std::string& frameName) OVERRIDE;
160     virtual bool allowExternalPages() OVERRIDE;
161     virtual void captureHistoryForWindow(size_t windowIndex, WebKit::WebVector<WebKit::WebHistoryItem>*, size_t* currentEntryIndex) OVERRIDE;
162
163     // NavigationHost
164     virtual bool navigate(const TestNavigationEntry&, bool reload);
165
166     // WebKit::WebPrerendererClient
167     virtual void willAddPrerender(WebKit::WebPrerender*) OVERRIDE;
168
169     // WebKit::WebViewClient
170     virtual WebKit::WebView* createView(WebKit::WebFrame*, const WebKit::WebURLRequest&, const WebKit::WebWindowFeatures&, const WebKit::WebString&, WebKit::WebNavigationPolicy);
171     virtual WebKit::WebWidget* createPopupMenu(WebKit::WebPopupType);
172     virtual WebKit::WebWidget* createPopupMenu(const WebKit::WebPopupMenuInfo&);
173     virtual WebKit::WebStorageNamespace* createSessionStorageNamespace(unsigned quota);
174     virtual WebKit::WebCompositorOutputSurface* createOutputSurface();
175     virtual void didAddMessageToConsole(const WebKit::WebConsoleMessage&, const WebKit::WebString& sourceName, unsigned sourceLine);
176     virtual void didStartLoading();
177     virtual void didStopLoading();
178     virtual bool shouldBeginEditing(const WebKit::WebRange&);
179     virtual bool shouldEndEditing(const WebKit::WebRange&);
180     virtual bool shouldInsertNode(const WebKit::WebNode&, const WebKit::WebRange&, WebKit::WebEditingAction);
181     virtual bool shouldInsertText(const WebKit::WebString&, const WebKit::WebRange&, WebKit::WebEditingAction);
182     virtual bool shouldChangeSelectedRange(const WebKit::WebRange& from, const WebKit::WebRange& to, WebKit::WebTextAffinity, bool stillSelecting);
183     virtual bool shouldDeleteRange(const WebKit::WebRange&);
184     virtual bool shouldApplyStyle(const WebKit::WebString& style, const WebKit::WebRange&);
185     virtual bool isSmartInsertDeleteEnabled();
186     virtual bool isSelectTrailingWhitespaceEnabled();
187     virtual bool handleCurrentKeyboardEvent();
188     virtual void runModalAlertDialog(WebKit::WebFrame*, const WebKit::WebString&);
189     virtual bool runModalConfirmDialog(WebKit::WebFrame*, const WebKit::WebString&);
190     virtual bool runModalPromptDialog(WebKit::WebFrame*, const WebKit::WebString& message, const WebKit::WebString& defaultValue, WebKit::WebString* actualValue);
191     virtual void showContextMenu(WebKit::WebFrame*, const WebKit::WebContextMenuData&);
192     virtual void didUpdateLayout();
193     virtual void navigateBackForwardSoon(int offset);
194     virtual int historyBackListCount();
195     virtual int historyForwardListCount();
196     virtual WebKit::WebGeolocationClient* geolocationClient();
197 #if ENABLE(INPUT_SPEECH)
198     virtual WebKit::WebSpeechInputController* speechInputController(WebKit::WebSpeechInputListener*);
199 #endif
200 #if ENABLE(SCRIPTED_SPEECH)
201     virtual WebKit::WebSpeechRecognizer* speechRecognizer() OVERRIDE;
202 #endif
203     virtual WebKit::WebDeviceOrientationClient* deviceOrientationClient() OVERRIDE;
204
205     // WebKit::WebWidgetClient
206     virtual void didAutoResize(const WebKit::WebSize& newSize);
207     virtual void initializeLayerTreeView(WebKit::WebLayerTreeViewClient*, const WebKit::WebLayer& rootLayer, const WebKit::WebLayerTreeView::Settings&);
208     virtual WebKit::WebLayerTreeView* layerTreeView();
209     virtual void scheduleAnimation();
210     virtual void didFocus();
211     virtual void didBlur();
212     virtual void didChangeCursor(const WebKit::WebCursorInfo&);
213     virtual void closeWidgetSoon();
214     virtual void show(WebKit::WebNavigationPolicy);
215     virtual void runModal();
216     virtual bool enterFullScreen();
217     virtual void exitFullScreen();
218     virtual WebKit::WebRect windowRect();
219     virtual void setWindowRect(const WebKit::WebRect&);
220     virtual WebKit::WebRect rootWindowRect();
221     virtual WebKit::WebRect windowResizerRect();
222     virtual WebKit::WebScreenInfo screenInfo();
223 #if ENABLE(POINTER_LOCK)
224     virtual bool requestPointerLock();
225     virtual void requestPointerUnlock();
226     virtual bool isPointerLocked();
227 #endif
228
229     // WebKit::WebFrameClient
230     virtual WebKit::WebPlugin* createPlugin(WebKit::WebFrame*, const WebKit::WebPluginParams&);
231     virtual WebKit::WebMediaPlayer* createMediaPlayer(WebKit::WebFrame*, const WebKit::WebURL&, WebKit::WebMediaPlayerClient*);
232     virtual WebKit::WebApplicationCacheHost* createApplicationCacheHost(WebKit::WebFrame*, WebKit::WebApplicationCacheHostClient*);
233     virtual void loadURLExternally(WebKit::WebFrame*, const WebKit::WebURLRequest&, WebKit::WebNavigationPolicy);
234     virtual void loadURLExternally(WebKit::WebFrame*, const WebKit::WebURLRequest&, WebKit::WebNavigationPolicy, const WebKit::WebString& downloadName);
235     virtual WebKit::WebNavigationPolicy decidePolicyForNavigation(
236         WebKit::WebFrame*, const WebKit::WebURLRequest&,
237         WebKit::WebNavigationType, const WebKit::WebNode&,
238         WebKit::WebNavigationPolicy, bool isRedirect);
239     virtual bool canHandleRequest(WebKit::WebFrame*, const WebKit::WebURLRequest&);
240     virtual WebKit::WebURLError cancelledError(WebKit::WebFrame*, const WebKit::WebURLRequest&);
241     virtual void unableToImplementPolicyWithError(WebKit::WebFrame*, const WebKit::WebURLError&);
242     virtual void didCreateDataSource(WebKit::WebFrame*, WebKit::WebDataSource*);
243     virtual void didCommitProvisionalLoad(WebKit::WebFrame*, bool isNewNavigation);
244     virtual void didClearWindowObject(WebKit::WebFrame*);
245     virtual void didReceiveTitle(WebKit::WebFrame*, const WebKit::WebString&, WebKit::WebTextDirection);
246     virtual void didNavigateWithinPage(WebKit::WebFrame*, bool isNewNavigation);
247     virtual void willSendRequest(WebKit::WebFrame*, unsigned identifier, WebKit::WebURLRequest&, const WebKit::WebURLResponse&);
248     virtual void openFileSystem(WebKit::WebFrame*, WebKit::WebFileSystem::Type, long long size, bool create, WebKit::WebFileSystemCallbacks*);
249     virtual void deleteFileSystem(WebKit::WebFrame*, WebKit::WebFileSystem::Type, WebKit::WebFileSystemCallbacks*);
250     virtual bool willCheckAndDispatchMessageEvent(
251         WebKit::WebFrame* sourceFrame, WebKit::WebFrame* targetFrame, 
252         WebKit::WebSecurityOrigin target, WebKit::WebDOMMessageEvent);
253
254     WebKit::WebDeviceOrientationClientMock* deviceOrientationClientMock();
255
256     // Geolocation client mocks for DRTTestRunner
257     WebKit::WebGeolocationClientMock* geolocationClientMock();
258
259     // Pending task list, Note taht the method is referred from WebMethodTask class.
260     WebTestRunner::WebTaskList* taskList() { return &m_taskList; }
261
262 private:
263
264     class HostMethodTask : public WebTestRunner::WebMethodTask<WebViewHost> {
265     public:
266         typedef void (WebViewHost::*CallbackMethodType)();
267         HostMethodTask(WebViewHost* object, CallbackMethodType callback)
268             : WebTestRunner::WebMethodTask<WebViewHost>(object)
269             , m_callback(callback)
270         { }
271
272         virtual void runIfValid() { (m_object->*m_callback)(); }
273
274     private:
275         CallbackMethodType m_callback;
276     };
277
278     // Called the title of the page changes.
279     // Can be used to update the title of the window.
280     void setPageTitle(const WebKit::WebString&);
281
282     void enterFullScreenNow();
283     void exitFullScreenNow();
284
285     void updateForCommittedLoad(WebKit::WebFrame*, bool isNewNavigation);
286     void updateURL(WebKit::WebFrame*);
287     void updateSessionHistory(WebKit::WebFrame*);
288
289     // Dumping a frame to the console.
290     void printFrameDescription(WebKit::WebFrame*);
291
292     bool hasWindow() const { return m_hasWindow; }
293
294 #if ENABLE(MEDIA_STREAM)
295     webkit_support::TestMediaStreamClient* testMediaStreamClient();
296 #endif
297
298     // Non-owning pointer. The WebViewHost instance is owned by this TestShell instance.
299     TestShell* m_shell;
300
301     // Non-owning pointer. This class needs to be wrapped in a WebTestProxy. This is the pointer to the WebTestProxyBase.
302     WebTestRunner::WebTestProxyBase* m_proxy;
303
304     // This delegate works for the following widget.
305     WebKit::WebWidget* m_webWidget;
306
307     // For tracking session history. See RenderView.
308     int m_pageId;
309     int m_lastPageIdUpdated;
310
311     OwnPtr<TestShellExtraData> m_pendingExtraData;
312
313     WebKit::WebCursorInfo m_currentCursor;
314
315     bool m_hasWindow;
316     bool m_inModalLoop;
317
318     bool m_shutdownWasInvoked;
319
320     WebKit::WebRect m_windowRect;
321
322     // Edit command associated to the current keyboard event.
323     std::string m_editCommandName;
324     std::string m_editCommandValue;
325
326
327     OwnPtr<WebKit::WebContextMenuData> m_lastContextMenuData;
328
329     // Geolocation
330     OwnPtr<WebKit::WebGeolocationClientMock> m_geolocationClientMock;
331
332     OwnPtr<WebKit::WebDeviceOrientationClientMock> m_deviceOrientationClientMock;
333 #if ENABLE(INPUT_SPEECH)
334     OwnPtr<MockWebSpeechInputController> m_speechInputControllerMock;
335 #endif
336
337 #if ENABLE(SCRIPTED_SPEECH)
338     OwnPtr<MockWebSpeechRecognizer> m_mockSpeechRecognizer;
339 #endif
340
341 #if ENABLE(MEDIA_STREAM)
342     OwnPtr<webkit_support::TestMediaStreamClient> m_testMediaStreamClient;
343 #endif
344
345     OwnPtr<TestNavigationController> m_navigationController;
346
347     WebTestRunner::WebTaskList m_taskList;
348     Vector<WebKit::WebWidget*> m_popupmenus;
349
350 #if ENABLE(POINTER_LOCK)
351     bool m_pointerLocked;
352     enum {
353         PointerLockWillSucceed,
354         PointerLockWillRespondAsync,
355         PointerLockWillFailSync
356     } m_pointerLockPlannedResult;
357 #endif
358
359     OwnPtr<WebKit::WebLayerTreeView> m_layerTreeView;
360 };
361
362 #endif // WebViewHost_h