[WPE][GTK] Bump minimum versions of GLib, GTK, libsoup, ATK, GStreamer, and Cairo
[WebKit-https.git] / Source / WebKit / UIProcess / gtk / WebContextMenuProxyGtk.cpp
1 /*
2  * Copyright (C) 2011 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "WebContextMenuProxyGtk.h"
28
29 #if ENABLE(CONTEXT_MENUS)
30
31 #include "APIContextMenuClient.h"
32 #include "NativeWebMouseEvent.h"
33 #include "WebContextMenuItem.h"
34 #include "WebContextMenuItemData.h"
35 #include "WebKitWebViewBasePrivate.h"
36 #include "WebPageProxy.h"
37 #include "WebProcessProxy.h"
38 #include <WebCore/GtkUtilities.h>
39 #include <gio/gio.h>
40 #include <gtk/gtk.h>
41 #include <wtf/text/CString.h>
42
43 static const char* gContextMenuActionId = "webkit-context-menu-action";
44 static const char* gContextMenuTitle = "webkit-context-menu-title";
45 static const char* gContextMenuItemGroup = "webkitContextMenu";
46
47 namespace WebKit {
48 using namespace WebCore;
49
50 static void contextMenuItemActivatedCallback(GAction* action, GVariant*, WebPageProxy* page)
51 {
52     auto* stateType = g_action_get_state_type(action);
53     gboolean isToggle = stateType && g_variant_type_equal(stateType, G_VARIANT_TYPE_BOOLEAN);
54     GRefPtr<GVariant> state = isToggle ? adoptGRef(g_action_get_state(action)) : nullptr;
55     WebContextMenuItemData item(isToggle ? CheckableActionType : ActionType,
56         static_cast<ContextMenuAction>(GPOINTER_TO_INT(g_object_get_data(G_OBJECT(action), gContextMenuActionId))),
57         String::fromUTF8(static_cast<const char*>(g_object_get_data(G_OBJECT(action), gContextMenuTitle))), g_action_get_enabled(action),
58         state ? g_variant_get_boolean(state.get()) : false);
59     if (isToggle)
60         g_action_change_state(action, g_variant_new_boolean(!g_variant_get_boolean(state.get())));
61     page->contextMenuItemSelected(item);
62 }
63
64 void WebContextMenuProxyGtk::append(GMenu* menu, const WebContextMenuItemGlib& menuItem)
65 {
66     unsigned long signalHandlerId;
67     GRefPtr<GMenuItem> gMenuItem;
68     GAction* action = menuItem.gAction();
69     ASSERT(action);
70     g_action_map_add_action(G_ACTION_MAP(gtk_widget_get_action_group(GTK_WIDGET(m_menu), gContextMenuItemGroup)), action);
71
72     switch (menuItem.type()) {
73     case ActionType:
74     case CheckableActionType: {
75         GUniquePtr<char> actionName(g_strdup_printf("%s.%s", gContextMenuItemGroup, g_action_get_name(action)));
76         gMenuItem = adoptGRef(g_menu_item_new(menuItem.title().utf8().data(), nullptr));
77         g_menu_item_set_action_and_target_value(gMenuItem.get(), actionName.get(), menuItem.gActionTarget());
78
79         if (menuItem.action() < ContextMenuItemBaseApplicationTag) {
80             g_object_set_data(G_OBJECT(action), gContextMenuActionId, GINT_TO_POINTER(menuItem.action()));
81             g_object_set_data_full(G_OBJECT(action), gContextMenuTitle, g_strdup(menuItem.title().utf8().data()), g_free);
82             signalHandlerId = g_signal_connect(action, "activate", G_CALLBACK(contextMenuItemActivatedCallback), m_page);
83             m_signalHandlers.set(signalHandlerId, action);
84         }
85         break;
86     }
87     case SubmenuType: {
88         GRefPtr<GMenu> submenu = buildMenu(menuItem.submenuItems());
89         gMenuItem = adoptGRef(g_menu_item_new_submenu(menuItem.title().utf8().data(), G_MENU_MODEL(submenu.get())));
90         break;
91     }
92     case SeparatorType:
93         ASSERT_NOT_REACHED();
94         break;
95     }
96
97     g_menu_append_item(menu, gMenuItem.get());
98 }
99
100 GRefPtr<GMenu> WebContextMenuProxyGtk::buildMenu(const Vector<WebContextMenuItemGlib>& items)
101 {
102     GRefPtr<GMenu> menu = adoptGRef(g_menu_new());
103     GMenu* sectionMenu = menu.get();
104     for (const auto& item : items) {
105         if (item.type() == SeparatorType) {
106             GRefPtr<GMenu> section = adoptGRef(g_menu_new());
107             g_menu_append_section(menu.get(), nullptr, G_MENU_MODEL(section.get()));
108             sectionMenu = section.get();
109         } else
110             append(sectionMenu, item);
111     }
112
113     return menu;
114 }
115
116 Vector<WebContextMenuItemGlib> WebContextMenuProxyGtk::populateSubMenu(const WebContextMenuItemData& subMenuItemData)
117 {
118     Vector<WebContextMenuItemGlib> items;
119     for (const auto& itemData : subMenuItemData.submenu()) {
120         if (itemData.type() == SubmenuType)
121             items.append(WebContextMenuItemGlib(itemData, populateSubMenu(itemData)));
122         else
123             items.append(itemData);
124     }
125     return items;
126 }
127
128 void WebContextMenuProxyGtk::populate(const Vector<WebContextMenuItemGlib>& items)
129 {
130     GRefPtr<GMenu> menu = buildMenu(items);
131     gtk_menu_shell_bind_model(GTK_MENU_SHELL(m_menu), G_MENU_MODEL(menu.get()), nullptr, TRUE);
132 }
133
134 void WebContextMenuProxyGtk::populate(const Vector<Ref<WebContextMenuItem>>& items)
135 {
136     GRefPtr<GMenu> menu = adoptGRef(g_menu_new());
137     GMenu* sectionMenu = menu.get();
138     for (const auto& item : items) {
139         switch (item->data().type()) {
140         case SeparatorType: {
141             GRefPtr<GMenu> section = adoptGRef(g_menu_new());
142             g_menu_append_section(menu.get(), nullptr, G_MENU_MODEL(section.get()));
143             sectionMenu = section.get();
144             break;
145         }
146         case SubmenuType: {
147             WebContextMenuItemGlib menuitem(item->data(), populateSubMenu(item->data()));
148             append(sectionMenu, menuitem);
149             break;
150         }
151         case ActionType:
152         case CheckableActionType: {
153             WebContextMenuItemGlib menuitem(item->data());
154             append(sectionMenu, menuitem);
155             break;
156         }
157         }
158     }
159     gtk_menu_shell_bind_model(GTK_MENU_SHELL(m_menu), G_MENU_MODEL(menu.get()), nullptr, TRUE);
160 }
161
162 void WebContextMenuProxyGtk::show()
163 {
164     Vector<Ref<WebContextMenuItem>> proposedAPIItems;
165     for (auto& item : m_context.menuItems()) {
166         if (item.action() != ContextMenuItemTagShareMenu)
167             proposedAPIItems.append(WebContextMenuItem::create(item));
168     }
169
170     m_page->contextMenuClient().getContextMenuFromProposedMenu(*m_page, WTFMove(proposedAPIItems), WebContextMenuListenerProxy::create(this).get(), m_context.webHitTestResultData(), m_page->process().transformHandlesToObjects(m_userData.object()).get());
171 }
172
173 void WebContextMenuProxyGtk::showContextMenuWithItems(Vector<Ref<WebContextMenuItem>>&& items)
174 {
175     if (!items.isEmpty())
176         populate(items);
177
178     unsigned childCount = 0;
179     gtk_container_foreach(GTK_CONTAINER(m_menu), [](GtkWidget*, gpointer data) { (*static_cast<unsigned*>(data))++; }, &childCount);
180     if (!childCount)
181         return;
182
183     m_popupPosition = convertWidgetPointToScreenPoint(m_webView, m_context.menuLocation());
184
185     // Display menu initiated by right click (mouse button pressed = 3).
186     NativeWebMouseEvent* mouseEvent = m_page->currentlyProcessedMouseDownEvent();
187     const GdkEvent* event = mouseEvent ? mouseEvent->nativeEvent() : 0;
188     gtk_menu_attach_to_widget(m_menu, GTK_WIDGET(m_webView), nullptr);
189     gtk_menu_popup(m_menu, nullptr, nullptr, reinterpret_cast<GtkMenuPositionFunc>(menuPositionFunction), this, event ? event->button.button : 3, event ? event->button.time : GDK_CURRENT_TIME);
190 }
191
192 WebContextMenuProxyGtk::WebContextMenuProxyGtk(GtkWidget* webView, WebPageProxy& page, ContextMenuContextData&& context, const UserData& userData)
193     : WebContextMenuProxy(WTFMove(context), userData)
194     , m_webView(webView)
195     , m_page(&page)
196     , m_menu(GTK_MENU(gtk_menu_new()))
197 {
198     GRefPtr<GSimpleActionGroup> group = adoptGRef(g_simple_action_group_new());
199     gtk_widget_insert_action_group(GTK_WIDGET(m_menu), gContextMenuItemGroup, G_ACTION_GROUP(group.get()));
200     webkitWebViewBaseSetActiveContextMenuProxy(WEBKIT_WEB_VIEW_BASE(m_webView), this);
201 }
202
203 WebContextMenuProxyGtk::~WebContextMenuProxyGtk()
204 {
205     gtk_menu_popdown(m_menu);
206
207     for (auto& handler : m_signalHandlers)
208         g_signal_handler_disconnect(handler.value, handler.key);
209     m_signalHandlers.clear();
210
211     gtk_widget_insert_action_group(GTK_WIDGET(m_menu), gContextMenuItemGroup, nullptr);
212     gtk_widget_destroy(GTK_WIDGET(m_menu));
213 }
214
215 void WebContextMenuProxyGtk::menuPositionFunction(GtkMenu* menu, gint* x, gint* y, gboolean* pushIn, WebContextMenuProxyGtk* popupMenu)
216 {
217     GtkRequisition menuSize;
218     gtk_widget_get_preferred_size(GTK_WIDGET(menu), &menuSize, 0);
219
220     GdkScreen* screen = gtk_widget_get_screen(popupMenu->m_webView);
221     *x = popupMenu->m_popupPosition.x();
222     if ((*x + menuSize.width) >= gdk_screen_get_width(screen))
223         *x -= menuSize.width;
224
225     *y = popupMenu->m_popupPosition.y();
226     if ((*y + menuSize.height) >= gdk_screen_get_height(screen))
227         *y -= menuSize.height;
228
229     *pushIn = FALSE;
230 }
231
232 } // namespace WebKit
233 #endif // ENABLE(CONTEXT_MENUS)