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 SkCanvas;
  48 class TestShell;
  49
  50 namespace WebKit {
  51 class WebFrame;
  52 class WebSerializedScriptValue;
  53 class WebSharedWorkerClient;
  54 class WebURL;
  55 struct WebRect;
  56 struct WebURLError;
  57 struct WebWindowFeatures;
  58 }
  59
  60 namespace webkit_support {
  61 class DRTLayerTreeViewClient;
  62 class MediaStreamUtil;
  63 class TestMediaStreamClient;
  64 }
  65
  66 namespace WebTestRunner {
  67 class WebTestRunner;
  68 }
  69
  70 class WebViewHost : public WebKit::WebViewClient, public WebKit::WebFrameClient, public NavigationHost, public WebKit::WebPrerendererClient, public WebTestRunner::WebTestDelegate {
  71  public:
  72     WebViewHost(TestShell*);
  73     virtual ~WebViewHost();
  74     void shutdown();
  75     void setWebWidget(WebKit::WebWidget*);
  76     WebKit::WebView* webView() const;
  77     WebKit::WebWidget* webWidget() const;
  78     WebTestRunner::WebTestProxyBase* proxy() const;
  79     void setProxy(WebTestRunner::WebTestProxyBase*);
  80     void reset();
  81     void setPendingExtraData(PassOwnPtr<TestShellExtraData>);
  82
  83     TestNavigationController* navigationController() { return m_navigationController.get(); }
  84
  85     void closeWidget();
  86
  87     // WebTestDelegate.
  88     virtual void setEditCommand(const std::string& name, const std::string& value) OVERRIDE;
  89     virtual void clearEditCommand() OVERRIDE;
  90     virtual void setGamepadData(const WebKit::WebGamepads&) OVERRIDE;
  91     virtual void printMessage(const std::string& message) OVERRIDE;
  92     virtual void postTask(WebTestRunner::WebTask*) OVERRIDE;
  93     virtual void postDelayedTask(WebTestRunner::WebTask*, long long ms) OVERRIDE;
  94     virtual WebKit::WebString registerIsolatedFileSystem(const WebKit::WebVector<WebKit::WebString>& absoluteFilenames) OVERRIDE;
  95     virtual long long getCurrentTimeInMillisecond() OVERRIDE;
  96     virtual WebKit::WebString getAbsoluteWebStringFromUTF8Path(const std::string& path) OVERRIDE;
  97     virtual WebKit::WebURL localFileToDataURL(const WebKit::WebURL&) OVERRIDE;
  98     virtual WebKit::WebURL rewriteLayoutTestsURL(const std::string&) OVERRIDE;
  99     virtual WebTestRunner::WebPreferences* preferences() OVERRIDE;
 100     virtual void applyPreferences() OVERRIDE;
 101     virtual std::string makeURLErrorDescription(const WebKit::WebURLError&) OVERRIDE;
 102     virtual void setClientWindowRect(const WebKit::WebRect&) OVERRIDE;
 103     virtual void showDevTools() OVERRIDE;
 104     virtual void closeDevTools() OVERRIDE;
 105     virtual void evaluateInWebInspector(long, const std::string&) OVERRIDE;
 106     virtual void clearAllDatabases() OVERRIDE;
 107     virtual void setDatabaseQuota(int) OVERRIDE;
 108     virtual void setDeviceScaleFactor(float) OVERRIDE;
 109     virtual void setFocus(WebTestRunner::WebTestProxyBase*, bool) OVERRIDE;
 110     virtual void setAcceptAllCookies(bool) OVERRIDE;
 111     virtual std::string pathToLocalResource(const std::string& url) OVERRIDE;
 112     virtual void setLocale(const std::string&) OVERRIDE;
 113     virtual void testFinished() OVERRIDE;
 114     virtual void testTimedOut() OVERRIDE;
 115     virtual bool isBeingDebugged() OVERRIDE;
 116     virtual int layoutTestTimeout() OVERRIDE;
 117     virtual void closeRemainingWindows() OVERRIDE;
 118     virtual int navigationEntryCount() OVERRIDE;
 119     virtual void goToOffset(int) OVERRIDE;
 120     virtual void reload() OVERRIDE;
 121     virtual void loadURLForFrame(const WebKit::WebURL&, const std::string& frameName) OVERRIDE;
 122     virtual bool allowExternalPages() OVERRIDE;
 123     virtual void captureHistoryForWindow(WebTestRunner::WebTestProxyBase*, WebKit::WebVector<WebKit::WebHistoryItem>*, size_t* currentEntryIndex) OVERRIDE;
 124
 125     // NavigationHost
 126     virtual bool navigate(const TestNavigationEntry&, bool reload);
 127
 128     // WebKit::WebPrerendererClient
 129     virtual void willAddPrerender(WebKit::WebPrerender*) OVERRIDE;
 130
 131     // WebKit::WebViewClient
 132     virtual WebKit::WebView* createView(WebKit::WebFrame*, const WebKit::WebURLRequest&, const WebKit::WebWindowFeatures&, const WebKit::WebString&, WebKit::WebNavigationPolicy);
 133     virtual WebKit::WebWidget* createPopupMenu(WebKit::WebPopupType);
 134     virtual WebKit::WebWidget* createPopupMenu(const WebKit::WebPopupMenuInfo&);
 135     virtual WebKit::WebStorageNamespace* createSessionStorageNamespace(unsigned quota);
 136     virtual void didAddMessageToConsole(const WebKit::WebConsoleMessage&, const WebKit::WebString& sourceName, unsigned sourceLine);
 137     virtual void didStartLoading();
 138     virtual void didStopLoading();
 139     virtual bool shouldBeginEditing(const WebKit::WebRange&);
 140     virtual bool shouldEndEditing(const WebKit::WebRange&);
 141     virtual bool shouldInsertNode(const WebKit::WebNode&, const WebKit::WebRange&, WebKit::WebEditingAction);
 142     virtual bool shouldInsertText(const WebKit::WebString&, const WebKit::WebRange&, WebKit::WebEditingAction);
 143     virtual bool shouldChangeSelectedRange(const WebKit::WebRange& from, const WebKit::WebRange& to, WebKit::WebTextAffinity, bool stillSelecting);
 144     virtual bool shouldDeleteRange(const WebKit::WebRange&);
 145     virtual bool shouldApplyStyle(const WebKit::WebString& style, const WebKit::WebRange&);
 146     virtual bool isSmartInsertDeleteEnabled();
 147     virtual bool isSelectTrailingWhitespaceEnabled();
 148     virtual bool handleCurrentKeyboardEvent();
 149     virtual void runModalAlertDialog(WebKit::WebFrame*, const WebKit::WebString&);
 150     virtual bool runModalConfirmDialog(WebKit::WebFrame*, const WebKit::WebString&);
 151     virtual bool runModalPromptDialog(WebKit::WebFrame*, const WebKit::WebString& message, const WebKit::WebString& defaultValue, WebKit::WebString* actualValue);
 152     virtual void showContextMenu(WebKit::WebFrame*, const WebKit::WebContextMenuData&);
 153     virtual void didUpdateLayout();
 154     virtual void navigateBackForwardSoon(int offset);
 155     virtual int historyBackListCount();
 156     virtual int historyForwardListCount();
 157
 158     // WebKit::WebWidgetClient
 159     virtual void didAutoResize(const WebKit::WebSize& newSize);
 160     virtual void initializeLayerTreeView(WebKit::WebLayerTreeViewClient*, const WebKit::WebLayer& rootLayer, const WebKit::WebLayerTreeView::Settings&);
 161     virtual WebKit::WebLayerTreeView* layerTreeView();
 162     virtual void scheduleAnimation();
 163     virtual void didFocus();
 164     virtual void didBlur();
 165     virtual void didChangeCursor(const WebKit::WebCursorInfo&);
 166     virtual void closeWidgetSoon();
 167     virtual void show(WebKit::WebNavigationPolicy);
 168     virtual void runModal();
 169     virtual bool enterFullScreen();
 170     virtual void exitFullScreen();
 171     virtual WebKit::WebRect windowRect();
 172     virtual void setWindowRect(const WebKit::WebRect&);
 173     virtual WebKit::WebRect rootWindowRect();
 174     virtual WebKit::WebRect windowResizerRect();
 175     virtual WebKit::WebScreenInfo screenInfo();
 176
 177     // WebKit::WebFrameClient
 178     virtual WebKit::WebPlugin* createPlugin(WebKit::WebFrame*, const WebKit::WebPluginParams&);
 179     virtual WebKit::WebMediaPlayer* createMediaPlayer(WebKit::WebFrame*, const WebKit::WebURL&, WebKit::WebMediaPlayerClient*);
 180     virtual WebKit::WebApplicationCacheHost* createApplicationCacheHost(WebKit::WebFrame*, WebKit::WebApplicationCacheHostClient*);
 181     virtual void loadURLExternally(WebKit::WebFrame*, const WebKit::WebURLRequest&, WebKit::WebNavigationPolicy);
 182     virtual void loadURLExternally(WebKit::WebFrame*, const WebKit::WebURLRequest&, WebKit::WebNavigationPolicy, const WebKit::WebString& downloadName);
 183     virtual WebKit::WebNavigationPolicy decidePolicyForNavigation(
 184         WebKit::WebFrame*, const WebKit::WebURLRequest&,
 185         WebKit::WebNavigationType, const WebKit::WebNode&,
 186         WebKit::WebNavigationPolicy, bool isRedirect);
 187     virtual bool canHandleRequest(WebKit::WebFrame*, const WebKit::WebURLRequest&);
 188     virtual WebKit::WebURLError cancelledError(WebKit::WebFrame*, const WebKit::WebURLRequest&);
 189     virtual void unableToImplementPolicyWithError(WebKit::WebFrame*, const WebKit::WebURLError&);
 190     virtual void didCreateDataSource(WebKit::WebFrame*, WebKit::WebDataSource*);
 191     virtual void didCommitProvisionalLoad(WebKit::WebFrame*, bool isNewNavigation);
 192     virtual void didClearWindowObject(WebKit::WebFrame*);
 193     virtual void didReceiveTitle(WebKit::WebFrame*, const WebKit::WebString&, WebKit::WebTextDirection);
 194     virtual void didNavigateWithinPage(WebKit::WebFrame*, bool isNewNavigation);
 195     virtual void willSendRequest(WebKit::WebFrame*, unsigned identifier, WebKit::WebURLRequest&, const WebKit::WebURLResponse&);
 196     virtual void openFileSystem(WebKit::WebFrame*, WebKit::WebFileSystem::Type, long long size, bool create, WebKit::WebFileSystemCallbacks*);
 197     virtual void deleteFileSystem(WebKit::WebFrame*, WebKit::WebFileSystem::Type, WebKit::WebFileSystemCallbacks*);
 198     virtual bool willCheckAndDispatchMessageEvent(
 199         WebKit::WebFrame* sourceFrame, WebKit::WebFrame* targetFrame,
 200         WebKit::WebSecurityOrigin target, WebKit::WebDOMMessageEvent);
 201
 202     // Pending task list, Note taht the method is referred from WebMethodTask class.
 203     WebTestRunner::WebTaskList* taskList() { return &m_taskList; }
 204
 205 private:
 206
 207     class HostMethodTask : public WebTestRunner::WebMethodTask<WebViewHost> {
 208     public:
 209         typedef void (WebViewHost::*CallbackMethodType)();
 210         HostMethodTask(WebViewHost* object, CallbackMethodType callback)
 211             : WebTestRunner::WebMethodTask<WebViewHost>(object)
 212             , m_callback(callback)
 213         { }
 214
 215         virtual void runIfValid() { (m_object->*m_callback)(); }
 216
 217     private:
 218         CallbackMethodType m_callback;
 219     };
 220
 221     // Called the title of the page changes.
 222     // Can be used to update the title of the window.
 223     void setPageTitle(const WebKit::WebString&);
 224
 225     void enterFullScreenNow();
 226     void exitFullScreenNow();
 227
 228     void updateForCommittedLoad(WebKit::WebFrame*, bool isNewNavigation);
 229     void updateURL(WebKit::WebFrame*);
 230     void updateSessionHistory(WebKit::WebFrame*);
 231
 232     // Dumping a frame to the console.
 233     void printFrameDescription(WebKit::WebFrame*);
 234
 235     bool hasWindow() const { return m_hasWindow; }
 236
 237     void updateViewportSize();
 238
 239 #if ENABLE(MEDIA_STREAM)
 240     webkit_support::TestMediaStreamClient* testMediaStreamClient();
 241 #endif
 242
 243     // Non-owning pointer. The WebViewHost instance is owned by this TestShell instance.
 244     TestShell* m_shell;
 245
 246     // Non-owning pointer. This class needs to be wrapped in a WebTestProxy. This is the pointer to the WebTestProxyBase.
 247     WebTestRunner::WebTestProxyBase* m_proxy;
 248
 249     // This delegate works for the following widget.
 250     WebKit::WebWidget* m_webWidget;
 251
 252     // For tracking session history. See RenderView.
 253     int m_pageId;
 254     int m_lastPageIdUpdated;
 255
 256     OwnPtr<TestShellExtraData> m_pendingExtraData;
 257
 258     WebKit::WebCursorInfo m_currentCursor;
 259
 260     bool m_hasWindow;
 261     bool m_inModalLoop;
 262
 263     bool m_shutdownWasInvoked;
 264
 265     WebKit::WebRect m_windowRect;
 266
 267     // Edit command associated to the current keyboard event.
 268     std::string m_editCommandName;
 269     std::string m_editCommandValue;
 270
 271
 272     OwnPtr<WebKit::WebContextMenuData> m_lastContextMenuData;
 273
 274
 275 #if ENABLE(MEDIA_STREAM)
 276     OwnPtr<webkit_support::TestMediaStreamClient> m_testMediaStreamClient;
 277 #endif
 278
 279     OwnPtr<TestNavigationController> m_navigationController;
 280
 281     WebTestRunner::WebTaskList m_taskList;
 282     Vector<WebKit::WebWidget*> m_popupmenus;
 283
 284     OwnPtr<webkit_support::DRTLayerTreeViewClient> m_layerTreeViewClient;
 285     OwnPtr<WebKit::WebLayerTreeView> m_layerTreeView;
 286 };
 287
 288 #endif // WebViewHost_h