Abstract class WebTestDelegate to chromium c++ style.

content/shell/renderer/test_runner/web_test_delegate.h

+// Copyright 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CONTENT_SHELL_RENDERER_TEST_RUNNER_WEB_TEST_DELEGATE_H_
+#define CONTENT_SHELL_RENDERER_TEST_RUNNER_WEB_TEST_DELEGATE_H_
+
+#include <string>
+
+#include "third_party/WebKit/public/platform/WebScreenOrientationType.h"
+#include "third_party/WebKit/public/platform/WebString.h"
+#include "third_party/WebKit/public/platform/WebURL.h"
+#include "third_party/WebKit/public/platform/WebVector.h"
+#include "third_party/WebKit/public/web/WebNotificationPresenter.h"
+
+#define WEBTESTRUNNER_NEW_HISTORY_CAPTURE
+
+namespace blink {
+class WebBatteryStatus;
+class WebDeviceMotionData;
+class WebDeviceOrientationData;
+class WebFrame;
+class WebGamepad;
+class WebGamepads;
+class WebHistoryItem;
+struct WebRect;
+struct WebSize;
+struct WebURLError;
+}
+
+namespace content {
+
+class DeviceLightData;
+class RendererGamepadProvider;
+class WebTask;
+class WebTestProxyBase;
+struct TestPreferences;
+
+class WebTestDelegate {
+ public:
+  // Set and clear the edit command to execute on the next call to
+  // WebViewClient::handleCurrentKeyboardEvent().
+  virtual void ClearEditCommand() = 0;
+  virtual void SetEditCommand(const std::string& name,
+                              const std::string& value) = 0;
+
+  // Sets gamepad provider to be used for tests.
+  virtual void SetGamepadProvider(
+      scoped_ptr<RendererGamepadProvider> provider) = 0;
+
+  // Set data to return when registering via
+  // Platform::setDeviceLightListener().
+  virtual void SetDeviceLightData(const double data) = 0;
+  // Set data to return when registering via
+  // Platform::setDeviceMotionListener().
+  virtual void SetDeviceMotionData(const blink::WebDeviceMotionData& data) = 0;
+  // Set data to return when registering via
+  // Platform::setDeviceOrientationListener().
+  virtual void SetDeviceOrientationData(
+      const blink::WebDeviceOrientationData& data) = 0;
+
+  // Set orientation to set when registering via
+  // Platform::setScreenOrientationListener().
+  virtual void SetScreenOrientation(
+      const blink::WebScreenOrientationType& orientation) = 0;
+
+  // Reset the screen orientation data used for testing.
+  virtual void ResetScreenOrientation() = 0;
+
+  // Notifies blink about a change in battery status.
+  virtual void DidChangeBatteryStatus(
+      const blink::WebBatteryStatus& status) = 0;
+
+  // Add a message to the text dump for the layout test.
+  virtual void PrintMessage(const std::string& message) = 0;
+
+  // The delegate takes ownership of the WebTask objects and is responsible
+  // for deleting them.
+  virtual void PostTask(WebTask* task) = 0;
+  virtual void PostDelayedTask(WebTask* task, long long ms) = 0;
+
+  // Register a new isolated filesystem with the given files, and return the
+  // new filesystem id.
+  virtual blink::WebString RegisterIsolatedFileSystem(
+      const blink::WebVector<blink::WebString>& absolute_filenames) = 0;
+
+  // Gets the current time in milliseconds since the UNIX epoch.
+  virtual long long GetCurrentTimeInMillisecond() = 0;
+
+  // Convert the provided relative path into an absolute path.
+  virtual blink::WebString GetAbsoluteWebStringFromUTF8Path(
+      const std::string& path) = 0;
+
+  // Reads in the given file and returns its contents as data URL.
+  virtual blink::WebURL LocalFileToDataURL(const blink::WebURL& file_url) = 0;
+
+  // Replaces file:///tmp/LayoutTests/ with the actual path to the
+  // LayoutTests directory.
+  virtual blink::WebURL RewriteLayoutTestsURL(const std::string& utf8_url) = 0;
+
+  // Manages the settings to used for layout tests.
+  virtual TestPreferences* Preferences() = 0;
+  virtual void ApplyPreferences() = 0;
+
+  // Enables or disables synchronous resize mode. When enabled, all
+  // window-sizing machinery is
+  // short-circuited inside the renderer. This mode is necessary for some tests
+  // that were written
+  // before browsers had multi-process architecture and rely on window resizes
+  // to happen synchronously.
+  // The function has "unfortunate" it its name because we must strive to remove
+  // all tests
+  // that rely on this... well, unfortunate behavior. See
+  // http://crbug.com/309760 for the plan.
+  virtual void UseUnfortunateSynchronousResizeMode(bool enable) = 0;
+
+  // Controls auto resize mode.
+  virtual void EnableAutoResizeMode(const blink::WebSize& min_size,
+                                    const blink::WebSize& max_size) = 0;
+  virtual void DisableAutoResizeMode(const blink::WebSize& new_size) = 0;
+
+  // Clears DevTools' localStorage when an inspector test is started.
+  virtual void ClearDevToolsLocalStorage() = 0;
+
+  // Opens and closes the inspector.
+  virtual void ShowDevTools(const std::string& settings,
+                            const std::string& frontend_url) = 0;
+  virtual void CloseDevTools() = 0;
+
+  // Evaluate the given script in the DevTools agent.
+  virtual void EvaluateInWebInspector(long call_id,
+                                      const std::string& script) = 0;
+
+  // Controls WebSQL databases.
+  virtual void ClearAllDatabases() = 0;
+  virtual void SetDatabaseQuota(int quota) = 0;
+
+  // Controls Web Notification permissions.
+  virtual blink::WebNotificationPresenter::Permission
+      CheckWebNotificationPermission(const GURL& origin) = 0;
+  virtual void GrantWebNotificationPermission(const GURL& origin,
+                                              bool permission_granted) = 0;
+  virtual void ClearWebNotificationPermissions() = 0;
+
+  // Controls the device scale factor of the main WebView for hidpi tests.
+  virtual void SetDeviceScaleFactor(float factor) = 0;
+
+  // Change the device color profile while running a layout test.
+  virtual void SetDeviceColorProfile(const std::string& name) = 0;
+
+  // Controls which WebView should be focused.
+  virtual void SetFocus(WebTestProxyBase* proxy, bool focus) = 0;
+
+  // Controls whether all cookies should be accepted or writing cookies in a
+  // third-party context is blocked.
+  virtual void SetAcceptAllCookies(bool accept) = 0;
+
+  // The same as RewriteLayoutTestsURL unless the resource is a path starting
+  // with /tmp/, then return a file URL to a temporary file.
+  virtual std::string PathToLocalResource(const std::string& resource) = 0;
+
+  // Sets the POSIX locale of the current process.
+  virtual void SetLocale(const std::string& locale) = 0;
+
+  // Invoked when the test finished.
+  virtual void TestFinished() = 0;
+
+  // Invoked when the embedder should close all but the main WebView.
+  virtual void CloseRemainingWindows() = 0;
+
+  virtual void DeleteAllCookies() = 0;
+
+  // Returns the length of the back/forward history of the main WebView.
+  virtual int NavigationEntryCount() = 0;
+
+  // The following trigger navigations on the main WebViwe.
+  virtual void GoToOffset(int offset) = 0;
+  virtual void Reload() = 0;
+  virtual void LoadURLForFrame(const blink::WebURL& url,
+                               const std::string& frame_name) = 0;
+
+  // Returns true if resource requests to external URLs should be permitted.
+  virtual bool AllowExternalPages() = 0;
+
+  // Returns a text dump the back/forward history for the WebView associated
+  // with the given WebTestProxyBase.
+  virtual std::string DumpHistoryForWindow(WebTestProxyBase* proxy) = 0;
+};
+
+}  // namespace content
+
+#endif  // CONTENT_SHELL_RENDERER_TEST_RUNNER_WEB_TEST_DELEGATE_H_