<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[278682] trunk/Source/WebKit</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/278682">278682</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2021-06-09 16:44:40 -0700 (Wed, 09 Jun 2021)</dd>
</dl>

<h3>Log Message</h3>
<pre>[GTK] Duplicate WebKitWebView::show-option-menu confuses introspection, should use --warn-error when building gir
https://bugs.webkit.org/show_bug.cgi?id=222985

Patch by Michael Catanzaro <mcatanzaro@gnome.org> on 2021-06-09
Reviewed by Adrian Perez de Castro.

WebKitWebView::show-option-menu has different parameters for GTK than it does for WPE. It
seems g-ir-scanner is taking the WPE documentation and merging it with the GTK parameters.
We can fix this by moving the introspection comment into platform-specific files.

Additionally, let's use --warn-error to turn warnings into errors to prevent this from ever
happening again, as we already do when generating introspection for JavaScriptCore.

* PlatformGTK.cmake:
* UIProcess/API/glib/WebKitWebView.cpp:
(webkit_web_view_class_init):
* UIProcess/API/glib/WebKitWebViewPrivate.h:
* UIProcess/API/gtk/WebKitWebViewGtk.cpp:
(createShowOptionMenuSignal):
* UIProcess/API/wpe/WebKitWebViewWPE.cpp:
(createShowOptionMenuSignal):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKitChangeLog">trunk/Source/WebKit/ChangeLog</a></li>
<li><a href="#trunkSourceWebKitPlatformGTKcmake">trunk/Source/WebKit/PlatformGTK.cmake</a></li>
<li><a href="#trunkSourceWebKitUIProcessAPIglibWebKitWebViewcpp">trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp</a></li>
<li><a href="#trunkSourceWebKitUIProcessAPIglibWebKitWebViewPrivateh">trunk/Source/WebKit/UIProcess/API/glib/WebKitWebViewPrivate.h</a></li>
<li><a href="#trunkSourceWebKitUIProcessAPIgtkWebKitWebViewGtkcpp">trunk/Source/WebKit/UIProcess/API/gtk/WebKitWebViewGtk.cpp</a></li>
<li><a href="#trunkSourceWebKitUIProcessAPIwpeWebKitWebViewWPEcpp">trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKitChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/ChangeLog (278681 => 278682)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/ChangeLog    2021-06-09 23:41:30 UTC (rev 278681)
+++ trunk/Source/WebKit/ChangeLog       2021-06-09 23:44:40 UTC (rev 278682)
</span><span class="lines">@@ -1,3 +1,26 @@
</span><ins>+2021-06-09  Michael Catanzaro  <mcatanzaro@gnome.org>
+
+        [GTK] Duplicate WebKitWebView::show-option-menu confuses introspection, should use --warn-error when building gir
+        https://bugs.webkit.org/show_bug.cgi?id=222985
+
+        Reviewed by Adrian Perez de Castro.
+
+        WebKitWebView::show-option-menu has different parameters for GTK than it does for WPE. It
+        seems g-ir-scanner is taking the WPE documentation and merging it with the GTK parameters.
+        We can fix this by moving the introspection comment into platform-specific files.
+
+        Additionally, let's use --warn-error to turn warnings into errors to prevent this from ever
+        happening again, as we already do when generating introspection for JavaScriptCore.
+
+        * PlatformGTK.cmake:
+        * UIProcess/API/glib/WebKitWebView.cpp:
+        (webkit_web_view_class_init):
+        * UIProcess/API/glib/WebKitWebViewPrivate.h:
+        * UIProcess/API/gtk/WebKitWebViewGtk.cpp:
+        (createShowOptionMenuSignal):
+        * UIProcess/API/wpe/WebKitWebViewWPE.cpp:
+        (createShowOptionMenuSignal):
+
</ins><span class="cx"> 2021-06-09  Peng Liu  <peng.liu6@apple.com>
</span><span class="cx"> 
</span><span class="cx">         [iOS] UIDelegate::UIClient::fullscreenMayReturnToInline() is not called when a video exits fullscreen
</span></span></pre></div>
<a id="trunkSourceWebKitPlatformGTKcmake"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/PlatformGTK.cmake (278681 => 278682)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/PlatformGTK.cmake    2021-06-09 23:41:30 UTC (rev 278681)
+++ trunk/Source/WebKit/PlatformGTK.cmake       2021-06-09 23:44:40 UTC (rev 278682)
</span><span class="lines">@@ -664,6 +664,7 @@
</span><span class="cx">             ${INTROSPECTION_SCANNER}
</span><span class="cx">             --quiet
</span><span class="cx">             --warn-all
</span><ins>+            --warn-error
</ins><span class="cx">             --symbol-prefix=webkit
</span><span class="cx">             --identifier-prefix=WebKit
</span><span class="cx">             --namespace=WebKit2
</span><span class="lines">@@ -710,6 +711,7 @@
</span><span class="cx">             ${INTROSPECTION_SCANNER}
</span><span class="cx">             --quiet
</span><span class="cx">             --warn-all
</span><ins>+            --warn-error
</ins><span class="cx">             --symbol-prefix=webkit
</span><span class="cx">             --identifier-prefix=WebKit
</span><span class="cx">             --namespace=WebKit2WebExtension
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessAPIglibWebKitWebViewcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp (278681 => 278682)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp 2021-06-09 23:41:30 UTC (rev 278681)
+++ trunk/Source/WebKit/UIProcess/API/glib/WebKitWebView.cpp    2021-06-09 23:44:40 UTC (rev 278682)
</span><span class="lines">@@ -2170,72 +2170,11 @@
</span><span class="cx">         g_cclosure_marshal_generic,
</span><span class="cx">         G_TYPE_BOOLEAN, 1,
</span><span class="cx">         WEBKIT_TYPE_COLOR_CHOOSER_REQUEST);
</span><del>-
-    /**
-     * WebKitWebView::show-option-menu:
-     * @web_view: the #WebKitWebView on which the signal is emitted
-     * @menu: the #WebKitOptionMenu
-     * @event: the #GdkEvent that triggered the menu, or %NULL
-     * @rectangle: the option element area
-     *
-     * This signal is emitted when a select element in @web_view needs to display a
-     * dropdown menu. This signal can be used to show a custom menu, using @menu to get
-     * the details of all items that should be displayed. The area of the element in the
-     * #WebKitWebView is given as @rectangle parameter, it can be used to position the
-     * menu. If this was triggered by a user interaction, like a mouse click,
-     * @event parameter provides the #GdkEvent.
-     * To handle this signal asynchronously you should keep a ref of the @menu.
-     *
-     * The default signal handler will pop up a #GtkMenu.
-     *
-     * Returns: %TRUE to stop other handlers from being invoked for the event.
-     *   %FALSE to propagate the event further.
-     *
-     * Since: 2.18
-     */
-    signals[SHOW_OPTION_MENU] = g_signal_new(
-        "show-option-menu",
-        G_TYPE_FROM_CLASS(webViewClass),
-        G_SIGNAL_RUN_LAST,
-        G_STRUCT_OFFSET(WebKitWebViewClass, show_option_menu),
-        g_signal_accumulator_true_handled, nullptr,
-        g_cclosure_marshal_generic,
-        G_TYPE_BOOLEAN, 3,
-        WEBKIT_TYPE_OPTION_MENU,
-        GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE,
-        GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
</del><span class="cx"> #endif // PLATFORM(GTK)
</span><span class="cx"> 
</span><del>-#if PLATFORM(WPE)
-    /**
-     * WebKitWebView::show-option-menu:
-     * @web_view: the #WebKitWebView on which the signal is emitted
-     * @menu: the #WebKitOptionMenu
-     * @rectangle: the option element area
-     *
-     * This signal is emitted when a select element in @web_view needs to display a
-     * dropdown menu. This signal can be used to show a custom menu, using @menu to get
-     * the details of all items that should be displayed. The area of the element in the
-     * #WebKitWebView is given as @rectangle parameter, it can be used to position the
-     * menu.
-     * To handle this signal asynchronously you should keep a ref of the @menu.
-     *
-     * Returns: %TRUE to stop other handlers from being invoked for the event.
-     *   %FALSE to propagate the event further.
-     *
-     * Since: 2.28
-     */
-    signals[SHOW_OPTION_MENU] = g_signal_new(
-        "show-option-menu",
-        G_TYPE_FROM_CLASS(webViewClass),
-        G_SIGNAL_RUN_LAST,
-        G_STRUCT_OFFSET(WebKitWebViewClass, show_option_menu),
-        g_signal_accumulator_true_handled, nullptr,
-        g_cclosure_marshal_generic,
-        G_TYPE_BOOLEAN, 2,
-        WEBKIT_TYPE_OPTION_MENU,
-        WEBKIT_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
-#endif
</del><ins>+    // This signal is different for WPE and GTK, so it's declared in
+    // WebKitWebView[Gtk,WPE].cpp to ensure we don't break the introspection.
+    signals[SHOW_OPTION_MENU] = createShowOptionMenuSignal(webViewClass);
</ins><span class="cx"> 
</span><span class="cx">     /**
</span><span class="cx">      * WebKitWebView::user-message-received:
</span></span></pre></div>
<a id="trunkSourceWebKitUIProcessAPIglibWebKitWebViewPrivateh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/API/glib/WebKitWebViewPrivate.h (278681 => 278682)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/API/glib/WebKitWebViewPrivate.h    2021-06-09 23:41:30 UTC (rev 278681)
+++ trunk/Source/WebKit/UIProcess/API/glib/WebKitWebViewPrivate.h       2021-06-09 23:44:40 UTC (rev 278682)
</span><span class="lines">@@ -121,3 +121,5 @@
</span><span class="cx"> void webkitWebViewCancelComposition(WebKitWebView*, const String&);
</span><span class="cx"> void webkitWebViewDeleteSurrounding(WebKitWebView*, int offset, unsigned characterCount);
</span><span class="cx"> void webkitWebViewSetIsWebProcessResponsive(WebKitWebView*, bool);
</span><ins>+
+guint createShowOptionMenuSignal(WebKitWebViewClass*);
</ins></span></pre></div>
<a id="trunkSourceWebKitUIProcessAPIgtkWebKitWebViewGtkcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/API/gtk/WebKitWebViewGtk.cpp (278681 => 278682)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/API/gtk/WebKitWebViewGtk.cpp       2021-06-09 23:41:30 UTC (rev 278681)
+++ trunk/Source/WebKit/UIProcess/API/gtk/WebKitWebViewGtk.cpp  2021-06-09 23:44:40 UTC (rev 278682)
</span><span class="lines">@@ -465,3 +465,40 @@
</span><span class="cx">     auto& page = *webkitWebViewBaseGetPage(reinterpret_cast<WebKitWebViewBase*>(webView));
</span><span class="cx">     *rgba = page.backgroundColor().value_or(WebCore::Color::white);
</span><span class="cx"> }
</span><ins>+
+guint createShowOptionMenuSignal(WebKitWebViewClass* webViewClass)
+{
+    /**
+     * WebKitWebView::show-option-menu:
+     * @web_view: the #WebKitWebView on which the signal is emitted
+     * @menu: the #WebKitOptionMenu
+     * @event: the #GdkEvent that triggered the menu, or %NULL
+     * @rectangle: the option element area
+     *
+     * This signal is emitted when a select element in @web_view needs to display a
+     * dropdown menu. This signal can be used to show a custom menu, using @menu to get
+     * the details of all items that should be displayed. The area of the element in the
+     * #WebKitWebView is given as @rectangle parameter, it can be used to position the
+     * menu. If this was triggered by a user interaction, like a mouse click,
+     * @event parameter provides the #GdkEvent.
+     * To handle this signal asynchronously you should keep a ref of the @menu.
+     *
+     * The default signal handler will pop up a #GtkMenu.
+     *
+     * Returns: %TRUE to stop other handlers from being invoked for the event.
+     *   %FALSE to propagate the event further.
+     *
+     * Since: 2.18
+     */
+    return g_signal_new(
+        "show-option-menu",
+        G_TYPE_FROM_CLASS(webViewClass),
+        G_SIGNAL_RUN_LAST,
+        G_STRUCT_OFFSET(WebKitWebViewClass, show_option_menu),
+        g_signal_accumulator_true_handled, nullptr,
+        g_cclosure_marshal_generic,
+        G_TYPE_BOOLEAN, 3,
+        WEBKIT_TYPE_OPTION_MENU,
+        GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE,
+        GDK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
+}
</ins></span></pre></div>
<a id="trunkSourceWebKitUIProcessAPIwpeWebKitWebViewWPEcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp (278681 => 278682)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp       2021-06-09 23:41:30 UTC (rev 278681)
+++ trunk/Source/WebKit/UIProcess/API/wpe/WebKitWebViewWPE.cpp  2021-06-09 23:44:40 UTC (rev 278682)
</span><span class="lines">@@ -227,3 +227,35 @@
</span><span class="cx">     auto& webCoreColor = page.backgroundColor();
</span><span class="cx">     webkitColorFillFromWebCoreColor(webCoreColor.value_or(WebCore::Color::white), color);
</span><span class="cx"> }
</span><ins>+
+guint createShowOptionMenuSignal(WebKitWebViewClass* webViewClass)
+{
+    /**
+     * WebKitWebView::show-option-menu:
+     * @web_view: the #WebKitWebView on which the signal is emitted
+     * @menu: the #WebKitOptionMenu
+     * @rectangle: the option element area
+     *
+     * This signal is emitted when a select element in @web_view needs to display a
+     * dropdown menu. This signal can be used to show a custom menu, using @menu to get
+     * the details of all items that should be displayed. The area of the element in the
+     * #WebKitWebView is given as @rectangle parameter, it can be used to position the
+     * menu.
+     * To handle this signal asynchronously you should keep a ref of the @menu.
+     *
+     * Returns: %TRUE to stop other handlers from being invoked for the event.
+     *   %FALSE to propagate the event further.
+     *
+     * Since: 2.28
+     */
+    return g_signal_new(
+        "show-option-menu",
+        G_TYPE_FROM_CLASS(webViewClass),
+        G_SIGNAL_RUN_LAST,
+        G_STRUCT_OFFSET(WebKitWebViewClass, show_option_menu),
+        g_signal_accumulator_true_handled, nullptr,
+        g_cclosure_marshal_generic,
+        G_TYPE_BOOLEAN, 2,
+        WEBKIT_TYPE_OPTION_MENU,
+        WEBKIT_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
+}
</ins></span></pre>
</div>
</div>

</body>
</html>