[GLib] Add webkit_context_menu_get_position API

kate-k-lee · carlosgcampos · commit d585739018e6 · 2026-01-12T02:32:28.000-08:00
https://bugs.webkit.org/show_bug.cgi?id=305137 Reviewed by Carlos Garcia Campos. Added webkit_context_menu_get_position() to retrieve the click coordinates (x, y) in view coordinates when a context menu is triggered. This allows applications to know the exact position where the user right-clicked. * Source/WebKit/Shared/API/glib/WebKitContextMenu.cpp: * Source/WebKit/Shared/API/glib/WebKitContextMenuPrivate.h: * Source/WebKit/UIProcess/API/glib/WebKitContextMenu.h.in: * Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp: * Source/WebKit/UIProcess/WebContextMenuProxy.h: * Tools/TestWebKitAPI/Tests/WebKitGtk/TestContextMenu.cpp:" Canonical link: https://commits.webkit.org/305444@main
diff --git a/Source/WebKit/Shared/API/glib/WebKitContextMenu.cpp b/Source/WebKit/Shared/API/glib/WebKitContextMenu.cpp
@@ -25,6 +25,7 @@
 #include "WebKitContextMenuItem.h"
 #include "WebKitContextMenuItemPrivate.h"
 #include "WebKitContextMenuPrivate.h"
+#include <WebCore/IntPoint.h>
 #include <wtf/glib/GRefPtr.h>
 #include <wtf/glib/WTFGType.h>
 
@@ -67,6 +68,7 @@ struct _WebKitContextMenuPrivate {
     GUniquePtr<GdkEvent> event;
 #endif
 #endif
+    std::optional<WebCore::IntPoint> position;
 };
 
 WEBKIT_DEFINE_FINAL_TYPE(WebKitContextMenu, webkit_context_menu, G_TYPE_OBJECT, GObject)
@@ -130,6 +132,11 @@ WebKitContextMenuItem* webkitContextMenuGetParentItem(WebKitContextMenu* menu)
 {
     return menu->priv->parentItem;
 }
+
+void webkitContextMenuSetPosition(WebKitContextMenu* menu, const WebCore::IntPoint& position)
+{
+    menu->priv->position = position;
+}
 #endif // ENABLE(CONTEXT_MENUS)
 
 /**
@@ -434,3 +441,33 @@ GdkEvent* webkit_context_menu_get_event(WebKitContextMenu* menu)
     return menu->priv->event.get();
 }
 #endif
+
+/**
+ * webkit_context_menu_get_position:
+ * @menu: a #WebKitContextMenu
+ * @x: (out) (optional): return location for the x coordinate
+ * @y: (out) (optional): return location for the y coordinate
+ *
+ * Gets the position in view coordinates where the context menu was triggered.
+ *
+ * This function only returns valid coordinates when called for a #WebKitContextMenu
+ * passed to #WebKitWebView::context-menu signal.
+ *
+ * Returns: %TRUE if valid position coordinates are available, %FALSE otherwise
+ *
+ * Since: 2.52
+ */
+gboolean webkit_context_menu_get_position(WebKitContextMenu* menu, gint* x, gint* y)
+{
+    g_return_val_if_fail(WEBKIT_IS_CONTEXT_MENU(menu), FALSE);
+
+    if (!menu->priv->position)
+        return FALSE;
+
+    if (x)
+        *x = menu->priv->position->x();
+    if (y)
+        *y = menu->priv->position->y();
+
+    return TRUE;
+}
diff --git a/Source/WebKit/Shared/API/glib/WebKitContextMenuPrivate.h b/Source/WebKit/Shared/API/glib/WebKitContextMenuPrivate.h
@@ -22,6 +22,7 @@
 #if ENABLE(CONTEXT_MENUS)
 #include "WebContextMenuItemGlib.h"
 #include "WebKitContextMenu.h"
+#include <WebCore/IntPoint.h>
 
 #if PLATFORM(GTK)
 #include "GRefPtrGtk.h"
@@ -33,6 +34,7 @@ void webkitContextMenuPopulate(WebKitContextMenu*, Vector<WebKit::WebContextMenu
 void webkitContextMenuPopulate(WebKitContextMenu*, Vector<WebKit::WebContextMenuItemData>&);
 void webkitContextMenuSetParentItem(WebKitContextMenu*, WebKitContextMenuItem*);
 WebKitContextMenuItem* webkitContextMenuGetParentItem(WebKitContextMenu*);
+void webkitContextMenuSetPosition(WebKitContextMenu*, const WebCore::IntPoint&);
 #if PLATFORM(GTK)
 #if USE(GTK4)
 void webkitContextMenuSetEvent(WebKitContextMenu*, GRefPtr<GdkEvent>&&);
diff --git a/Source/WebKit/UIProcess/API/glib/WebKitContextMenu.h.in b/Source/WebKit/UIProcess/API/glib/WebKitContextMenu.h.in
@@ -111,6 +111,11 @@ WEBKIT_API GdkEvent *
 webkit_context_menu_get_event            (WebKitContextMenu     *menu);
 #endif
 
+WEBKIT_API gboolean
+webkit_context_menu_get_position         (WebKitContextMenu     *menu,
+                                          gint                  *x,
+                                          gint                  *y);
+
 G_END_DECLS
 
 #endif
diff --git a/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp b/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp
@@ -111,6 +111,7 @@
 #include "WPEUtilities.h"
 #include "WPEWebViewLegacy.h"
 #include "WPEWebViewPlatform.h"
+#include "WebContextMenuProxy.h"
 #include "WebKitOptionMenuPrivate.h"
 #include "WebKitWebViewBackendPrivate.h"
 #include "WebKitWebViewClient.h"
@@ -3017,6 +3018,7 @@ void webkitWebViewPopulateContextMenu(WebKitWebView* webView, const Vector<WebCo
     if (userData)
         webkit_context_menu_set_user_data(WEBKIT_CONTEXT_MENU(contextMenu.get()), userData);
     webkitContextMenuSetEvent(contextMenu.get(), webkitWebViewBaseTakeContextMenuEvent(webViewBase));
+    webkitContextMenuSetPosition(contextMenu.get(), contextMenuProxy->menuLocation());
 
     GRefPtr<WebKitHitTestResult> hitTestResult = adoptGRef(webkitHitTestResultCreate(hitTestResultData));
     gboolean returnValue;
@@ -3045,6 +3047,9 @@ void webkitWebViewPopulateContextMenu(WebKitWebView* webView, const Vector<WebCo
     GRefPtr<WebKitContextMenu> contextMenu = adoptGRef(webkitContextMenuCreate(proposedMenu));
     if (userData)
         webkit_context_menu_set_user_data(WEBKIT_CONTEXT_MENU(contextMenu.get()), userData);
+    if (auto* contextMenuProxy = getPage(webView).activeContextMenu())
+        webkitContextMenuSetPosition(contextMenu.get(), contextMenuProxy->menuLocation());
+
     GRefPtr<WebKitHitTestResult> hitTestResult = adoptGRef(webkitHitTestResultCreate(hitTestResultData));
     gboolean returnValue;
     g_signal_emit(webView, signals[CONTEXT_MENU], 0, contextMenu.get(),
diff --git a/Source/WebKit/UIProcess/WebContextMenuProxy.h b/Source/WebKit/UIProcess/WebContextMenuProxy.h
@@ -55,6 +55,7 @@ class WebContextMenuProxy : public RefCounted<WebContextMenuProxy>, public WebCo
     WebPageProxy* page() const { return m_page.get(); }
     RefPtr<WebPageProxy> protectedPage() const;
     const FrameInfoData& frameInfo() const { return m_frameInfo; }
+    const WebCore::IntPoint& menuLocation() const { return m_context.menuLocation(); }
 
 #if PLATFORM(COCOA)
     virtual NSMenu *platformMenu() const = 0;
diff --git a/Tools/TestWebKitAPI/Tests/WebKitGtk/TestContextMenu.cpp b/Tools/TestWebKitAPI/Tests/WebKitGtk/TestContextMenu.cpp
@@ -61,12 +61,22 @@ class ContextMenuTest: public WebViewTest {
 #endif
     }
 
+    void checkContextMenuPosition(WebKitContextMenu* contextMenu)
+    {
+        gint x, y;
+        gboolean hasPosition = webkit_context_menu_get_position(contextMenu, &x, &y);
+        g_assert_true(hasPosition);
+        g_assert_cmpint(x, ==, static_cast<gint>(m_menuPositionX));
+        g_assert_cmpint(y, ==, static_cast<gint>(m_menuPositionY));
+    }
+
     static gboolean contextMenuCallback(WebKitWebView* webView, WebKitContextMenu* contextMenu, GdkEvent* event, WebKitHitTestResult* hitTestResult, ContextMenuTest* test)
     {
         g_assert_true(WEBKIT_IS_CONTEXT_MENU(contextMenu));
         test->assertObjectIsDeletedWhenTestFinishes(G_OBJECT(contextMenu));
         g_assert_true(webkit_context_menu_get_event(contextMenu) == event);
         test->checkContextMenuEvent(event);
+        test->checkContextMenuPosition(contextMenu);
         g_assert_true(WEBKIT_IS_HIT_TEST_RESULT(hitTestResult));
         test->assertObjectIsDeletedWhenTestFinishes(G_OBJECT(hitTestResult));
 
