Tools/TestWebKitAPI/glib/WebKitGLib/WebViewTest.h

/*
 * Copyright (C) 2011, 2017 Igalia S.L.
 * Portions Copyright (c) 2011 Motorola Mobility, Inc.  All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#pragma once

#include "TestMain.h"
#include <optional>
#include <wtf/OptionSet.h>
#include <wtf/text/CString.h>

class WebViewTest: public Test {
public:
    MAKE_GLIB_TEST_FIXTURE(WebViewTest);
    WebViewTest();
    virtual ~WebViewTest();

    static bool shouldInitializeWebViewInConstructor;
    static bool shouldCreateEphemeralWebView;
    void initializeWebView();
    WebKitWebView* webView() const { return m_webView.get(); }

    void platformDestroy();

    virtual void loadURI(const char* uri);
    virtual void loadHtml(const char* html, const char* baseURI, WebKitWebView* = nullptr);
    virtual void loadPlainText(const char* plainText);
    virtual void loadRequest(WebKitURIRequest*);
    virtual void loadBytes(GBytes*, const char* mimeType, const char* encoding, const char* baseURI);
    void loadAlternateHTML(const char* html, const char* contentURI, const char* baseURI);
    void goBack();
    void goForward();
    void goToBackForwardListItem(WebKitBackForwardListItem*);

    void quitMainLoop();
    void quitMainLoopAfterProcessingPendingEvents();
    void wait(double seconds);
    void waitUntilLoadFinished(WebKitWebView* = nullptr);
    void waitUntilTitleChangedTo(const char* expectedTitle);
    void waitUntilTitleChanged();
    void waitUntilIsWebProcessResponsiveChanged();
    void assertFileIsCreated(const char*);
    void assertFileIsNotCreated(const char*);
    void assertJavaScriptBecomesTrue(const char*);
    void resizeView(int width, int height);
    void hideView();
    void selectAll();
    const char* mainResourceData(size_t& mainResourceDataSize);

    bool isEditable();
    void setEditable(bool);

    enum class MouseButton : uint8_t {
        Primary,
        Middle,
        Secondary
    };

    enum class Modifiers : uint8_t {
        Shift   = 1 << 0,
        Control = 1 << 1,
        Alt     = 1 << 2,
        Meta    = 1 << 3
    };

    void mouseMoveTo(int x, int y, OptionSet<Modifiers> = OptionSet<Modifiers>());
    void clickMouseButton(int x, int y, MouseButton = MouseButton::Primary, OptionSet<Modifiers> = OptionSet<Modifiers>());
    void keyStroke(unsigned keyVal, OptionSet<Modifiers> = OptionSet<Modifiers>());

    void showInWindow(int width = 0, int height = 0);

#if PLATFORM(GTK)
    void emitPopupMenuSignal();
#endif

    JSCValue* runJavaScriptAndWaitUntilFinished(const char* javascript, GError**, WebKitWebView* = nullptr);
    JSCValue* runJavaScriptAndWaitUntilFinished(const char* javascript, gsize, GError**);
    JSCValue* runJavaScriptFromGResourceAndWaitUntilFinished(const char* resource, GError**);
    JSCValue* runJavaScriptInWorldAndWaitUntilFinished(const char* javascript, const char* world, const char* sourceURI, GError**);
    JSCValue* runAsyncJavaScriptFunctionInWorldAndWaitUntilFinished(const char* body, GVariant* arguments, const char* world, GError**);
    JSCValue* runJavaScriptWithoutForcedUserGesturesAndWaitUntilFinished(const char* javascript, GError**);
    void runJavaScriptAndWait(const char* javascript);

    // Javascript result helpers.
    static char* javascriptResultToCString(JSCValue*);
    static double javascriptResultToNumber(JSCValue*);
    static bool javascriptResultToBoolean(JSCValue*);
    static bool javascriptResultIsNull(JSCValue*);
    static bool javascriptResultIsUndefined(JSCValue*);
#if !ENABLE(2022_GLIB_API)
    static char* javascriptResultToCString(WebKitJavascriptResult*);
    static double javascriptResultToNumber(WebKitJavascriptResult*);
    static bool javascriptResultToBoolean(WebKitJavascriptResult*);
    static bool javascriptResultIsNull(WebKitJavascriptResult*);
    static bool javascriptResultIsUndefined(WebKitJavascriptResult*);
#endif

#if PLATFORM(GTK)
    cairo_surface_t* getSnapshotAndWaitUntilReady(WebKitSnapshotRegion, WebKitSnapshotOptions);
#endif

    bool runWebProcessTest(const char* suiteName, const char* testName, const char* contents = nullptr, const char* contentType = nullptr);

    // Prohibit overrides because this is called when the web view is created
    // in our constructor, before a derived class's vtable is ready.
    void initializeWebProcessExtensions() final { Test::initializeWebProcessExtensions(); }

    static gboolean webProcessTerminated(WebKitWebView*, WebKitWebProcessTerminationReason, WebViewTest*);

    GRefPtr<GDBusProxy> extensionProxy();

    class NetworkPolicyGuard {
    public:
        NetworkPolicyGuard(WebViewTest*, WebKitTLSErrorsPolicy);
        ~NetworkPolicyGuard();

        void setErrorPolicy(WebKitTLSErrorsPolicy);

    private:
        WebKitTLSErrorsPolicy m_originalPolicy;
#if ENABLE(2022_GLIB_API)
        WebViewTest* m_test;
#else
        WebKitWebsiteDataManager* m_manager;
#endif
    };

    GRefPtr<WebKitUserContentManager> m_userContentManager;
    GRefPtr<WebKitWebView> m_webView;
    GMainLoop* m_mainLoop;
    CString m_activeURI;
    CString m_expectedTitle;
    GRefPtr<JSCValue> m_javascriptResult;
    GError** m_javascriptError { nullptr };
    GUniquePtr<char> m_resourceData { nullptr };
    size_t m_resourceDataSize { 0 };
    bool m_expectedWebProcessCrash { false };

#if PLATFORM(GTK)
    GtkWidget* m_parentWindow { nullptr };
#endif
};