06398ba9ea5a1ec1af4582c21a8fed08f2558296
[WebKit.git] / Source / WebKit2 / 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 using namespace WebCore;
48
49 namespace WebKit {
50
51 static void contextMenuItemActivatedCallback(GAction* action, GVariant*, WebPageProxy* page)
52 {
53     auto* stateType = g_action_get_state_type(action);
54     gboolean isToggle = stateType && g_variant_type_equal(stateType, G_VARIANT_TYPE_BOOLEAN);
55     GRefPtr<GVariant> state = isToggle ? adoptGRef(g_action_get_state(action)) : nullptr;
56     WebContextMenuItemData item(isToggle ? CheckableActionType : ActionType,
57         static_cast<ContextMenuAction>(GPOINTER_TO_INT(g_object_get_data(G_OBJECT(action), gContextMenuActionId))),
58         String::fromUTF8(static_cast<const char*>(g_object_get_data(G_OBJECT(action), gContextMenuTitle))), g_action_get_enabled(action),
59         state ? g_variant_get_boolean(state.get()) : false);
60     if (isToggle)
61         g_action_change_state(action, g_variant_new_boolean(!g_variant_get_boolean(state.get())));
62     page->contextMenuItemSelected(item);
63 }
64
65 void WebContextMenuProxyGtk::append(GMenu* menu, const WebContextMenuItemGtk& menuItem)
66 {
67     unsigned long signalHandlerId;
68     GRefPtr<GMenuItem> gMenuItem;
69     GAction* action = menuItem.gAction();
70     ASSERT(action);
71 #if GTK_CHECK_VERSION(3, 16, 0)
72     g_action_map_add_action(G_ACTION_MAP(gtk_widget_get_action_group(GTK_WIDGET(m_menu), gContextMenuItemGroup)), action);
73 #else
74     g_action_map_add_action(G_ACTION_MAP(g_object_get_data(G_OBJECT(m_menu), gContextMenuItemGroup)), action);
75 #endif
76
77     switch (menuItem.type()) {
78     case ActionType:
79     case CheckableActionType: {
80         GUniquePtr<char> actionName(g_strdup_printf("%s.%s", gContextMenuItemGroup, g_action_get_name(action)));
81         gMenuItem = adoptGRef(g_menu_item_new(menuItem.title().utf8().data(), nullptr));
82         g_menu_item_set_action_and_target_value(gMenuItem.get(), actionName.get(), menuItem.gActionTarget());
83
84         if (menuItem.action() < ContextMenuItemBaseApplicationTag) {
85             g_object_set_data(G_OBJECT(action), gContextMenuActionId, GINT_TO_POINTER(menuItem.action()));
86             g_object_set_data_full(G_OBJECT(action), gContextMenuTitle, g_strdup(menuItem.title().utf8().data()), g_free);
87             signalHandlerId = g_signal_connect(action, "activate", G_CALLBACK(contextMenuItemActivatedCallback), m_page);
88             m_signalHandlers.set(signalHandlerId, action);
89         }
90         break;
91     }
92     case SubmenuType: {
93         GRefPtr<GMenu> submenu = buildMenu(menuItem.submenuItems());
94         gMenuItem = adoptGRef(g_menu_item_new_submenu(menuItem.title().utf8().data(), G_MENU_MODEL(submenu.get())));
95         break;
96     }
97     case SeparatorType:
98         ASSERT_NOT_REACHED();
99         break;
100     }
101
102     g_menu_append_item(menu, gMenuItem.get());
103 }
104
105 GRefPtr<GMenu> WebContextMenuProxyGtk::buildMenu(const Vector<WebContextMenuItemGtk>& items)
106 {
107     GRefPtr<GMenu> menu = adoptGRef(g_menu_new());
108     GMenu* sectionMenu = menu.get();
109     for (const auto& item : items) {
110         if (item.type() == SeparatorType) {
111             GRefPtr<GMenu> section = adoptGRef(g_menu_new());
112             g_menu_append_section(menu.get(), nullptr, G_MENU_MODEL(section.get()));
113             sectionMenu = section.get();
114         } else
115             append(sectionMenu, item);
116     }
117
118     return menu;
119 }
120
121 void WebContextMenuProxyGtk::populate(const Vector<WebContextMenuItemGtk>& items)
122 {
123     GRefPtr<GMenu> menu = buildMenu(items);
124     gtk_menu_shell_bind_model(GTK_MENU_SHELL(m_menu), G_MENU_MODEL(menu.get()), nullptr, TRUE);
125 }
126
127 void WebContextMenuProxyGtk::populate(const Vector<RefPtr<WebContextMenuItem>>& items)
128 {
129     GRefPtr<GMenu> menu = adoptGRef(g_menu_new());
130     GMenu* sectionMenu = menu.get();
131     for (const auto& item : items) {
132         if (item->data().type() == SeparatorType) {
133             GRefPtr<GMenu> section = adoptGRef(g_menu_new());
134             g_menu_append_section(menu.get(), nullptr, G_MENU_MODEL(section.get()));
135             sectionMenu = section.get();
136         } else {
137             WebContextMenuItemGtk menuitem(item->data());
138             append(sectionMenu, menuitem);
139         }
140     }
141     gtk_menu_shell_bind_model(GTK_MENU_SHELL(m_menu), G_MENU_MODEL(menu.get()), nullptr, TRUE);
142 }
143
144 void WebContextMenuProxyGtk::show()
145 {
146     Vector<RefPtr<WebContextMenuItem>> proposedAPIItems;
147     for (auto& item : m_context.menuItems()) {
148         if (item.action() != ContextMenuItemTagShareMenu)
149             proposedAPIItems.append(WebContextMenuItem::create(item));
150     }
151
152     Vector<RefPtr<WebContextMenuItem>> clientItems;
153     bool useProposedItems = true;
154
155     if (m_page->contextMenuClient().getContextMenuFromProposedMenu(*m_page, proposedAPIItems, clientItems, m_context.webHitTestResultData(), m_page->process().transformHandlesToObjects(m_userData.object()).get()))
156         useProposedItems = false;
157
158     const Vector<RefPtr<WebContextMenuItem>>& items = useProposedItems ? proposedAPIItems : clientItems;
159
160     if (!items.isEmpty())
161         populate(items);
162
163     unsigned childCount = 0;
164     gtk_container_foreach(GTK_CONTAINER(m_menu), [](GtkWidget*, gpointer data) { (*static_cast<unsigned*>(data))++; }, &childCount);
165     if (!childCount)
166         return;
167
168     m_popupPosition = convertWidgetPointToScreenPoint(m_webView, m_context.menuLocation());
169
170     // Display menu initiated by right click (mouse button pressed = 3).
171     NativeWebMouseEvent* mouseEvent = m_page->currentlyProcessedMouseDownEvent();
172     const GdkEvent* event = mouseEvent ? mouseEvent->nativeEvent() : 0;
173     gtk_menu_attach_to_widget(m_menu, GTK_WIDGET(m_webView), nullptr);
174
175 #if GTK_CHECK_VERSION(3, 22, 0)
176     gtk_menu_popup_at_pointer(m_menu, event);
177 #else
178     gtk_menu_popup(m_menu, nullptr, nullptr, reinterpret_cast<GtkMenuPositionFunc>(menuPositionFunction), this,
179                    event ? event->button.button : 3, event ? event->button.time : GDK_CURRENT_TIME);
180 #endif
181 }
182
183 void WebContextMenuProxyGtk::showContextMenuWithItems(const Vector<WebContextMenuItemData>& items)
184 {
185 }
186
187 WebContextMenuProxyGtk::WebContextMenuProxyGtk(GtkWidget* webView, WebPageProxy& page, const ContextMenuContextData& context, const UserData& userData)
188     : WebContextMenuProxy(context, userData)
189     , m_webView(webView)
190     , m_page(&page)
191     , m_menu(GTK_MENU(gtk_menu_new()))
192 {
193     GRefPtr<GSimpleActionGroup> group = adoptGRef(g_simple_action_group_new());
194     gtk_widget_insert_action_group(GTK_WIDGET(m_menu), gContextMenuItemGroup, G_ACTION_GROUP(group.get()));
195 #if !GTK_CHECK_VERSION(3, 16, 0)
196     g_object_set_data(G_OBJECT(m_menu), gContextMenuItemGroup, group.get());
197 #endif
198     webkitWebViewBaseSetActiveContextMenuProxy(WEBKIT_WEB_VIEW_BASE(m_webView), this);
199 }
200
201 WebContextMenuProxyGtk::~WebContextMenuProxyGtk()
202 {
203     gtk_menu_popdown(m_menu);
204
205     for (auto& handler : m_signalHandlers)
206         g_signal_handler_disconnect(handler.value, handler.key);
207     m_signalHandlers.clear();
208
209     gtk_widget_insert_action_group(GTK_WIDGET(m_menu), gContextMenuItemGroup, nullptr);
210 #if !GTK_CHECK_VERSION(3, 16, 0)
211     g_object_set_data(G_OBJECT(m_menu), gContextMenuItemGroup, nullptr);
212 #endif
213     gtk_widget_destroy(GTK_WIDGET(m_menu));
214 }
215
216 #if !GTK_CHECK_VERSION(3, 22, 0)
217 void WebContextMenuProxyGtk::menuPositionFunction(GtkMenu* menu, gint* x, gint* y, gboolean* pushIn, WebContextMenuProxyGtk* popupMenu)
218 {
219     GtkRequisition menuSize;
220     gtk_widget_get_preferred_size(GTK_WIDGET(menu), &menuSize, 0);
221
222     GdkScreen* screen = gtk_widget_get_screen(popupMenu->m_webView);
223     *x = popupMenu->m_popupPosition.x();
224     if ((*x + menuSize.width) >= gdk_screen_get_width(screen))
225         *x -= menuSize.width;
226
227     *y = popupMenu->m_popupPosition.y();
228     if ((*y + menuSize.height) >= gdk_screen_get_height(screen))
229         *y -= menuSize.height;
230
231     *pushIn = FALSE;
232 }
233 #endif
234
235 } // namespace WebKit
236 #endif // ENABLE(CONTEXT_MENUS)