[WPE] Implement theme color retrieval API

https://bugs.webkit.org/show_bug.cgi?id=273747

Reviewed by Adrian Perez de Castro and Carlos Garcia Campos.

Implements a property "theme-color" and a getter function webkit_web_view_get_theme_color()
for retrieving the web view's page theme color, with property changes for notification.

Combined changes:

* Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp:
(WebKitWebViewClient::themeColorDidChange):
(webkitWebViewGetProperty):
(webkit_web_view_class_init):
* Source/WebKit/UIProcess/API/glib/WebKitWebView.h.in:
* Source/WebKit/UIProcess/API/wpe/APIViewClient.h:
(API::ViewClient::themeColorDidChange):
* Source/WebKit/UIProcess/API/wpe/PageClientImpl.cpp:
(WebKit::PageClientImpl::themeColorDidChange):
* Source/WebKit/UIProcess/API/wpe/PageClientImpl.h:
* Source/WebKit/UIProcess/API/wpe/WPEWebView.cpp:
(WKWPE::View::themeColorDidChange):
* Source/WebKit/UIProcess/API/wpe/WPEWebView.h:
* Source/WebKit/UIProcess/API/wpe/WebKitWebViewClient.h:
* Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp:
(webkit_web_view_get_theme_color):
* Source/WebKit/UIProcess/WebPageProxy.messages.in:
* Source/WebKit/WebProcess/WebPage/CoordinatedGraphics/LayerTreeHost.cpp:
(WebKit::LayerTreeHost::flushLayers):
* Source/WebKit/WebProcess/WebPage/WebPage.cpp:
* Source/WebKit/WebProcess/WebPage/WebPage.h:
* Tools/TestWebKitAPI/Tests/WebKitGLib/TestWebKitWebView.cpp:
(ThemeColorWebViewTest::themeColorChanged):
(ThemeColorWebViewTest::testThemeColorResult):
(ThemeColorWebViewTest::waitUntilThemeColorChanged):
(testWebViewThemeColor):
(beforeAll):

Canonical link: https://commits.webkit.org/296035@main

Author: fredldotme

Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp

@@ -116,6 +116,7 @@
 #if ENABLE(WPE_PLATFORM)
 #include "WebKitInputMethodContextImplWPE.h"
 #endif
+#include "WebKitColor.h"
 #endif
 
 #if ENABLE(2022_GLIB_API)
@@ -244,6 +245,10 @@ enum {
     PROP_WEB_EXTENSION_MODE,
     PROP_DEFAULT_CONTENT_SECURITY_POLICY,
 
+#if PLATFORM(WPE)
+    PROP_THEME_COLOR,
+#endif
+
     N_PROPERTIES,
 };
 
@@ -557,6 +562,13 @@ WebKitWebResourceLoadManager* WebKitWebViewClient::webResourceLoadManager()
     return webkitWebViewGetWebResourceLoadManager(m_webView);
 }
 
+void WebKitWebViewClient::themeColorDidChange()
+{
+#if PLATFORM(WPE)
+    g_object_notify_by_pspec(G_OBJECT(m_webView), sObjProperties[PROP_THEME_COLOR]);
+#endif
+}
+
 #if ENABLE(FULLSCREEN_API)
 bool WebKitWebViewClient::enterFullScreen(WKWPE::View&)
 {
@@ -1177,6 +1189,14 @@ static void webkitWebViewGetProperty(GObject* object, guint propId, GValue* valu
     case PROP_DEFAULT_CONTENT_SECURITY_POLICY:
         g_value_set_string(value, webkit_web_view_get_default_content_security_policy(webView));
         break;
+#if PLATFORM(WPE)
+    case PROP_THEME_COLOR: {
+        auto* color = static_cast<WebKitColor*>(fastMalloc(sizeof(WebKitColor)));
+        webkit_web_view_get_theme_color(webView, color);
+        g_value_take_boxed(value, static_cast<gconstpointer>(color));
+        break;
+    }
+#endif
     default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propId, paramSpec);
     }
@@ -1710,6 +1730,21 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
         nullptr,
         static_cast<GParamFlags>(WEBKIT_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 
+#if PLATFORM(WPE)
+    /**
+     * WebKitWebView:theme-color:
+     *
+     * The theme color of the WebView's current page.
+     *
+     * Since: 2.50
+     */
+    sObjProperties[PROP_THEME_COLOR] = g_param_spec_boxed(
+        "theme-color",
+        nullptr, nullptr,
+        WEBKIT_TYPE_COLOR,
+        WEBKIT_PARAM_READABLE);
+#endif
+
     g_object_class_install_properties(gObjectClass, N_PROPERTIES, sObjProperties.data());
 
     /**

Source/WebKit/UIProcess/API/glib/WebKitWebView.h.in

@@ -908,6 +908,12 @@ webkit_web_view_get_web_extension_mode               (WebKitWebView
 WEBKIT_API const gchar*
 webkit_web_view_get_default_content_security_policy  (WebKitWebView             *web_view);
 
+#if PLATFORM(WPE)
+WEBKIT_API gboolean
+webkit_web_view_get_theme_color                      (WebKitWebView             *web_view,
+                                                      WebKitColor               *color);
+#endif
+
 #if USE(GI_FINISH_FUNC_ANNOTATION)
 /**
  * webkit_web_view_run_async_javascript_function_in_world: (finish-func webkit_web_view_run_javascript_in_world_finish)

Source/WebKit/UIProcess/API/wpe/APIViewClient.h

@@ -54,6 +54,7 @@ class ViewClient {
     virtual void didChangePageID(WKWPE::View&) { }
     virtual void didReceiveUserMessage(WKWPE::View&, WebKit::UserMessage&&, CompletionHandler<void(WebKit::UserMessage&&)>&& completionHandler) { completionHandler(WebKit::UserMessage()); }
     virtual WebKit::WebKitWebResourceLoadManager* webResourceLoadManager() { return nullptr; }
+    virtual void themeColorDidChange() { }
 
 #if ENABLE(FULLSCREEN_API)
     virtual bool enterFullScreen(WKWPE::View&) { return false; };

Source/WebKit/UIProcess/API/wpe/PageClientImpl.cpp

@@ -396,6 +396,11 @@ void PageClientImpl::didChangeBackgroundColor()
 {
 }
 
+void PageClientImpl::themeColorDidChange()
+{
+    m_view.themeColorDidChange();
+}
+
 void PageClientImpl::refView()
 {
 }

Source/WebKit/UIProcess/API/wpe/PageClientImpl.h

@@ -153,6 +153,7 @@ class PageClientImpl final : public PageClient
     void didSameDocumentNavigationForMainFrame(SameDocumentNavigationType) override;
 
     void didChangeBackgroundColor() override;
+    void themeColorDidChange() override;
     void isPlayingAudioWillChange() final { }
     void isPlayingAudioDidChange() final { }
 

Source/WebKit/UIProcess/API/wpe/WPEWebView.cpp

@@ -119,6 +119,11 @@ void View::selectionDidChange()
     }
 }
 
+void View::themeColorDidChange()
+{
+    m_client->themeColorDidChange();
+}
+
 void View::setSize(const WebCore::IntSize& size)
 {
     m_size = size;

Source/WebKit/UIProcess/API/wpe/WPEWebView.h

@@ -73,6 +73,8 @@ class View : public API::ObjectImpl<API::Object::Type::View> {
     WebKitInputMethodContext* inputMethodContext() const;
     void setInputMethodState(std::optional<WebKit::InputMethodState>&&);
 
+    void themeColorDidChange();
+
 #if ENABLE(FULLSCREEN_API)
     bool isFullScreen() const;
     void willEnterFullScreen(CompletionHandler<void(bool)>&&);

Source/WebKit/UIProcess/API/wpe/WebKitWebViewClient.h

@@ -55,6 +55,7 @@ class WebKitWebViewClient final : public API::ViewClient {
     void didChangePageID(WKWPE::View&) override;
     void didReceiveUserMessage(WKWPE::View&, WebKit::UserMessage&&, CompletionHandler<void(WebKit::UserMessage&&)>&&) override;
     WebKit::WebKitWebResourceLoadManager* webResourceLoadManager() override;
+    void themeColorDidChange() override;
 
 #if ENABLE(FULLSCREEN_API)
     bool enterFullScreen(WKWPE::View&) override;

Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp

@@ -327,3 +327,31 @@ void webkit_web_view_toggle_inspector(WebKitWebView* webView)
         inspector->show();
 }
 #endif
+
+/**
+ * webkit_web_view_get_theme_color:
+ * @web_view: a #WebKitWebView
+ * @color: (out): a #WebKitColor to fill in with the theme color
+ *
+ * Gets the theme color that is specified by the content in the @web_view.
+ * If the @web_view doesn't have a theme color it will fill the @color
+ * with transparent black content.
+ *
+ * Returns: Whether the currently loaded page defines a theme color.
+ *
+ * Since: 2.50
+ */
+gboolean webkit_web_view_get_theme_color(WebKitWebView* webView, WebKitColor* color)
+{
+    g_return_val_if_fail(WEBKIT_IS_WEB_VIEW(webView), FALSE);
+    auto& page = webkitWebViewGetPage(webView);
+
+    if (!page.themeColor().isValid()) {
+        WebCore::Color tmpColor(WebCore::Color::transparentBlack);
+        webkitColorFillFromWebCoreColor(tmpColor, color);
+        return FALSE;
+    }
+
+    webkitColorFillFromWebCoreColor(page.themeColor(), color);
+    return TRUE;
+}

Source/WebKit/UIProcess/WebPageProxy.messages.in

@@ -87,7 +87,7 @@ messages -> WebPageProxy {
     DidChangeScrollbarsForMainFrame(bool hasHorizontalScrollbar, bool hasVerticalScrollbar)
     DidChangeScrollOffsetPinningForMainFrame(WebCore::RectEdges<bool> pinnedState)
     DidChangePageCount(unsigned pageCount)
-#if PLATFORM(MAC)
+#if PLATFORM(MAC) || PLATFORM(WPE)
     ThemeColorChanged(WebCore::Color themeColor)
 #endif
 #if ENABLE(WEB_PAGE_SPATIAL_BACKDROP)