Import TestRunner library into chromium.

content/public/test/layout_tests/WebTestDelegate.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.
+
+/*
+ * Copyright (C) 2012 Google Inc. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above
+ * copyright notice, this list of conditions and the following disclaimer
+ * in the documentation and/or other materials provided with the
+ * distribution.
+ *     * Neither the name of Google Inc. nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef WebTestDelegate_h
+#define WebTestDelegate_h
+
+#include <string>
+
+#include "third_party/WebKit/public/platform/WebString.h"
+#include "third_party/WebKit/public/platform/WebURL.h"
+#include "third_party/WebKit/public/platform/WebVector.h"
+
+#define WEBTESTRUNNER_NEW_HISTORY_CAPTURE
+
+namespace blink {
+class WebDeviceMotionData;
+class WebDeviceOrientationData;
+class WebFrame;
+class WebGamepads;
+class WebHistoryItem;
+struct WebRect;
+struct WebSize;
+struct WebURLError;
+}
+
+namespace WebTestRunner {
+
+struct WebPreferences;
+class WebTask;
+class WebTestProxyBase;
+
+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;
+
+    // Set the gamepads to return from Platform::sampleGamepads().
+    virtual void setGamepadData(const blink::WebGamepads&) = 0;
+
+    // Set data to return when registering via Platform::setDeviceMotionListener().
+    virtual void setDeviceMotionData(const blink::WebDeviceMotionData&) = 0;
+    // Set data to return when registering via Platform::setDeviceOrientationListener().
+    virtual void setDeviceOrientationData(const blink::WebDeviceOrientationData&) = 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*) = 0;
+    virtual void postDelayedTask(WebTask*, 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>& absoluteFilenames) = 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&) = 0;
+
+    // Replaces file:///tmp/LayoutTests/ with the actual path to the
+    // LayoutTests directory.
+    virtual blink::WebURL rewriteLayoutTestsURL(const std::string& utf8URL) = 0;
+
+    // Manages the settings to used for layout tests.
+    virtual WebPreferences* 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) = 0;
+
+    // Controls auto resize mode.
+    virtual void enableAutoResizeMode(const blink::WebSize& minSize, const blink::WebSize& maxSize) = 0;
+    virtual void disableAutoResizeMode(const blink::WebSize&) = 0;
+
+    // Opens and closes the inspector.
+    virtual void showDevTools() = 0;
+    virtual void closeDevTools() = 0;
+
+    // Evaluate the given script in the DevTools agent.
+    virtual void evaluateInWebInspector(long callID, const std::string& script) = 0;
+
+    // Controls WebSQL databases.
+    virtual void clearAllDatabases() = 0;
+    virtual void setDatabaseQuota(int) = 0;
+
+    // Controls the device scale factor of the main WebView for hidpi tests.
+    virtual void setDeviceScaleFactor(float) = 0;
+
+    // Controls which WebView should be focused.
+    virtual void setFocus(WebTestProxyBase*, bool) = 0;
+
+    // Controls whether all cookies should be accepted or writing cookies in a
+    // third-party context is blocked.
+    virtual void setAcceptAllCookies(bool) = 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&) = 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&, const std::string& frameName) = 0;
+
+    // Returns true if resource requests to external URLs should be permitted.
+    virtual bool allowExternalPages() = 0;
+
+    // Returns the back/forward history for the WebView associated with the
+    // given WebTestProxyBase as well as the index of the current entry.
+    virtual void captureHistoryForWindow(WebTestProxyBase*, blink::WebVector<blink::WebHistoryItem>*, size_t* currentEntryIndex) = 0;
+};
+
+}
+
+#endif // WebTestDelegate_h