Merge lp:~larsu/gtk/custom-menu-items-v2 into lp:~ubuntu-desktop/gtk/ubuntugtk3

[Lars Karlitski]

Update custom menu items patch

The previous version simply interpreted the value of the "x-canonical-type"
attribute on a menu item as a GType string and instantiated an instance of
that. We need something more sophisticated now, because GMenuModel is used by
things that don't integrate with glib's type system. (In particular, the next
unity will be a consumer of the indicator services.)

This new patch adds an extension point to gtk. Libraries or programs can
register to implement this extension point and supply an object with the
GtkMenuItemFactory interface. Gtk will ask those factories to create menu items
whenever it stumbles on a "x-canonical-type" attribute.

[lp:~larsu/gtk/custom-menu-items-v2]

269. By Lars Karlitski on 2013-05-24

GtkMenuItemFactory -> UbuntuMenuItemFactory

Also moves the header from gtk.h to ubuntu-private.h, to make more explicit
that this should not be used from anyone except unity.

[William Hua (attente)]

The patch also needs to update gtk/gtk.symbols with the new functions in order to build the packaging properly.

See:

5935 --- expected-abi 2013-05-27 11:42:17.616520780 -0400
5936 +++ actual-abi 2013-05-27 11:42:17.652520780 -0400
5937 @@ -4022,6 +4022,8 @@
5938 gtk_wrap_mode_get_type
5939 ubuntu_gtk_menu_shell_activate_first
5940 ubuntu_gtk_menu_shell_activate_mnemonic
5941 +ubuntu_menu_item_factory_create_menu_item
5942 +ubuntu_menu_item_factory_get_type
5943 ubuntu_menu_proxy_activate_menu
5944 ubuntu_menu_proxy_get
5945 ubuntu_menu_proxy_get_type
5946 FAIL: abicheck.sh

[lp:~larsu/gtk/custom-menu-items-v2]

270. By Lars Karlitski on 2013-05-29

Add UbuntuMenuItemFactory symbols to gtk/gtk.symbols

[Sebastien Bacher (seb128)]

Thanks Lars, I merged that with the corresponding packaging change and I'm upload to Ubuntu

review: Approve

=== modified file 'debian/patches/ubuntu_gtk_custom_menu_items.patch'
--- debian/patches/ubuntu_gtk_custom_menu_items.patch	2012-09-19 01:20:28 +0000
+++ debian/patches/ubuntu_gtk_custom_menu_items.patch	2013-05-29 14:48:24 +0000
@@ -1,64 +1,171 @@
-# Description: gtk_menu_new_from_model doesn't support custom menu items
-# Ubuntu: https://bugs.launchpad.net/ubuntu/+source/gtk+3.0/+bug/1039476
-#
-Index: gtk+-3.5.18/gtk/gtkmodelmenu.c
-===================================================================
---- gtk+-3.5.18.orig/gtk/gtkmodelmenu.c	2012-09-19 03:34:42.000000000 +1200
-+++ gtk+-3.5.18/gtk/gtkmodelmenu.c	2012-09-19 12:18:50.524724208 +1200
-@@ -28,6 +28,7 @@
+From 311cf9c2fd6bbc303c816585cfc4986cdee2db52 Mon Sep 17 00:00:00 2001
+From: Lars Uebernickel <[e-mail]>
+Date: Wed, 8 May 2013 13:21:55 -0700
+Subject: [PATCH] Allow custom menu items from gtk_menu_new_from_model
+
+Provide UbuntuMenuItemFactory, an interface that can be implemented by
+extension points. It has one function: create a GtkMenuItem for a
+GMenuItem and a GActionGroup, keyed by the type given in the
+x-canonical-type attribute.
+
+This is not considered to be public API.
+---
+ gtk/Makefile.am             |   3 +
+ gtk/gtk.symbols             |   2 +
+ gtk/gtkmodelmenu.c          | 147 +++++++++++++++++++++++++++++++++++++++++++-
+ gtk/ubuntu-private.h        |  32 ++++++++++
+ gtk/ubuntumenuitemfactory.c |  38 ++++++++++++
+ gtk/ubuntumenuitemfactory.h |  57 +++++++++++++++++
+ 6 files changed, 278 insertions(+), 1 deletion(-)
+ create mode 100644 gtk/ubuntu-private.h
+ create mode 100644 gtk/ubuntumenuitemfactory.c
+ create mode 100644 gtk/ubuntumenuitemfactory.h
+
+diff --git a/gtk/Makefile.am b/gtk/Makefile.am
+index e164c90..304e252 100644
+--- a/gtk/Makefile.am
++++ b/gtk/Makefile.am
+@@ -175,6 +175,7 @@ deprecated_private_h_sources =			\
+ 
+ gtk_public_h_sources = 		\
+ 	gtk.h			\
++	ubuntu-private.h	\
+ 	gtkx.h			\
+ 	gtk-a11y.h		\
+ 	gtkaboutdialog.h	\
+@@ -277,6 +278,7 @@ gtk_public_h_sources = 		\
+ 	gtklockbutton.h		\
+ 	gtkmain.h		\
+ 	gtkmenu.h		\
++	ubuntumenuitemfactory.h	\
+ 	gtkmenubar.h		\
+ 	gtkmenubutton.h		\
+ 	gtkmenuitem.h		\
+@@ -765,6 +767,7 @@ gtk_base_c_sources = 		\
+ 	gtkmisc.c		\
+ 	gtkmnemonichash.c	\
+ 	gtkmodelmenu.c		\
++	ubuntumenuitemfactory.c	\
+ 	gtkmodelmenuitem.c	\
+ 	gtkmodifierstyle.c	\
+ 	gtkmodules.c		\
+diff --git a/gtk/gtk.symbols b/gtk/gtk.symbols
+index 030a06c..711b6ba 100644
+--- a/gtk/gtk.symbols
++++ b/gtk/gtk.symbols
+@@ -4055,3 +4055,5 @@ gtk_window_unfullscreen
+ gtk_window_unmaximize
+ gtk_window_unstick
+ gtk_wrap_mode_get_type
++ubuntu_menu_item_factory_get_type
++ubuntu_menu_item_factory_create_menu_item
+diff --git a/gtk/gtkmodelmenu.c b/gtk/gtkmodelmenu.c
+index 0c3cc5e..2b6899b 100644
+--- a/gtk/gtkmodelmenu.c
++++ b/gtk/gtkmodelmenu.c
+@@ -28,6 +28,8 @@
  #include "gtkseparatormenuitem.h"
  #include "gtkmodelmenuitem.h"
  #include "gtkapplicationprivate.h"
 +#include "gtkwidgetprivate.h"
++#include "ubuntumenuitemfactory.h"
  
  #define MODEL_MENU_WIDGET_DATA "gtk-model-menu-widget-data"
  
-@@ -72,6 +73,80 @@
+@@ -72,6 +74,146 @@ gtk_model_menu_binding_free (gpointer data)
    g_slice_free (GtkModelMenuBinding, binding);
  }
  
++static gboolean
++object_class_has_property (GObjectClass *class,
++                           const gchar  *name,
++                           GType         type)
++{
++  GParamSpec *pspec;
++
++  pspec = g_object_class_find_property (class, name);
++  return pspec != NULL && G_PARAM_SPEC_VALUE_TYPE (pspec) == type;
++}
++
++static GtkMenuItem *
++gtk_model_menu_create_item_from_type (GType      type,
++                                      GMenuItem *menuitem)
++{
++  GObjectClass *class;
++  GtkMenuItem *item = NULL;
++
++  class = g_type_class_ref (type);
++
++  if (g_type_is_a (type, GTK_TYPE_MENU_ITEM) &&
++      object_class_has_property (class, "menu-item", G_TYPE_MENU_ITEM) &&
++      object_class_has_property (class, "action-group", G_TYPE_ACTION_GROUP))
++    {
++      item = g_object_new (type,
++                           "menu-item", menuitem,
++                           NULL);
++
++      g_object_set (item,
++                    "action-group", _gtk_widget_get_action_muxer (GTK_WIDGET (item)),
++                    NULL);
++    }
++  else
++    {
++      g_warning ("gtk_menu_new_from_model: cannot create menu item from type '%s'.\n"
++                 "  Does it derive from GtkMenuItem and have 'menu-item' and 'action-group' properties?",
++                 g_type_name (type));
++    }
++
++  g_type_class_unref (class);
++  return item;
++}
++
++static GtkMenuItem *
++gtk_model_menu_create_custom_item_from_factory (const gchar  *typename,
++                                                GMenuItem    *menuitem,
++                                                GActionGroup *actions)
++{
++  GList *it;
++  static GList *factories = NULL;
++
++  if (factories == NULL)
++    {
++      GIOExtensionPoint *ep;
++
++      g_type_ensure (UBUNTU_TYPE_MENU_ITEM_FACTORY);
++      ep = g_io_extension_point_lookup (UBUNTU_MENU_ITEM_FACTORY_EXTENSION_POINT_NAME);
++      for (it = g_io_extension_point_get_extensions (ep); it != NULL; it = it->next)
++        {
++          GIOExtension *ext = it->data;
++          UbuntuMenuItemFactory *factory;
++
++          factory = g_object_new (g_io_extension_get_type (ext), NULL);
++          factories = g_list_prepend (factories, factory);
++        }
++      factories = g_list_reverse (factories);
++    }
++
++  for (it = factories; it != NULL; it = it->next)
++    {
++      UbuntuMenuItemFactory *factory = it->data;
++      GtkMenuItem *item;
++
++      item = ubuntu_menu_item_factory_create_menu_item (factory, typename, menuitem, actions);
++      if (item)
++        return item;
++    }
++
++  return NULL;
++}
++
 +static GtkMenuItem *
 +gtk_model_menu_create_custom_item (GMenuModel  *menu,
 +                                   gint         item_index,
-+                                   const gchar *action_namespace)
++                                   const gchar *action_namespace,
++                                   GtkWidget   *parent)
 +{
++  GMenuItem *menuitem;
++  gchar *typename;
 +  GtkMenuItem *item = NULL;
-+  gchar *typename = NULL;
-+  GType type;
-+  GObjectClass *class = NULL;
-+  GParamSpec *pspec;
-+  GMenuItem *menuitem = NULL;
-+
-+  if (!g_menu_model_get_item_attribute (menu, item_index, "x-canonical-type", "s", &typename))
-+      return NULL;
-+
-+  type = g_type_from_name (typename);
-+  if (type == 0)
-+    {
-+      g_warning ("gtk_menu_new_from_model: cannot find type '%s'", typename);
-+      goto out;
-+    }
-+  if (!g_type_is_a (type, GTK_TYPE_MENU_ITEM))
-+    {
-+      g_warning ("gtk_menu_new_from_model: '%s' is not derived from GtkMenuItem", typename);
-+      goto out;
-+    }
-+
-+  class = g_type_class_ref (type);
-+
-+  pspec = g_object_class_find_property (class, "menu-item");
-+  if (pspec == NULL || G_PARAM_SPEC_VALUE_TYPE (pspec) != G_TYPE_MENU_ITEM)
-+    {
-+      g_warning ("gtk_menu_new_from_model: '%s' does not have a 'menu-item' property", typename);
-+      goto out;
-+    }
-+
-+  pspec = g_object_class_find_property (class, "action-group");
-+  if (pspec == NULL || G_PARAM_SPEC_VALUE_TYPE (pspec) != G_TYPE_ACTION_GROUP)
-+    {
-+      g_warning ("gtk_menu_new_from_model: '%s' does not have an 'action-group' property", typename);
-+      goto out;
-+    }
 +
 +  menuitem = g_menu_item_new_from_model (menu, item_index);
 +  if (action_namespace)
@@ -74,35 +181,201 @@
 +      g_free (fullname);
 +    }
 +
-+  item = g_object_new (type,
-+                       "menu-item", menuitem,
-+                       NULL);
-+
-+  g_object_set (item,
-+                "action-group", _gtk_widget_get_action_muxer (GTK_WIDGET (item)),
-+                NULL);
-+
-+out:
-+  if (menuitem)
-+    g_object_unref (menuitem);
-+  if (class)
-+    g_type_class_unref (class);
-+  g_free (typename);
++  if (g_menu_model_get_item_attribute (menu, item_index, "x-canonical-type", "s", &typename))
++    {
++      GActionGroup *actions;
++
++      /* Passing the parent muxer is wrong, but we'll only have access
++       * to the menuitem's muxer after the widget has been created.
++       * Thus we'd need some other form of passing the action group to
++       * the widget, which would complicate things for no practical
++       * reason: the panel service is the only consumer of this API and
++       * it will never call gtk_widget_insert_action_group() on the
++       * returned menu item.
++       */
++      actions = G_ACTION_GROUP (_gtk_widget_get_action_muxer (parent));
++      item = gtk_model_menu_create_custom_item_from_factory (typename, menuitem, actions);
++
++      /* continue supporting GTypes for now (the "old" behavior) */
++      if (item == NULL)
++        {
++          GType type;
++
++          type = g_type_from_name (typename);
++          if (type > 0)
++            item = gtk_model_menu_create_item_from_type (type, menuitem);
++        }
++
++      if (item == NULL)
++        g_warning ("gtk_menu_new_from_model: cannot find type '%s'", typename);
++
++      g_free (typename);
++    }
++
++  g_object_unref (menuitem);
 +  return item;
 +}
 +
  static void
  gtk_model_menu_binding_append_item (GtkModelMenuBinding  *binding,
                                      GMenuModel           *model,
-@@ -106,7 +181,10 @@
+@@ -106,7 +248,10 @@ gtk_model_menu_binding_append_item (GtkModelMenuBinding  *binding,
      {
        GtkMenuItem *item;
  
 -      item = gtk_model_menu_item_new (model, item_index, action_namespace);
-+      item = gtk_model_menu_create_custom_item (model, item_index, action_namespace);
++      item = gtk_model_menu_create_custom_item (model, item_index, action_namespace, GTK_WIDGET (binding->shell));
 +      if (item == NULL)
 +        item = gtk_model_menu_item_new (model, item_index, action_namespace);
 +
        gtk_menu_shell_append (binding->shell, GTK_WIDGET (item));
        gtk_widget_show (GTK_WIDGET (item));
        binding->n_items++;
+diff --git a/gtk/ubuntu-private.h b/gtk/ubuntu-private.h
+new file mode 100644
+index 0000000..3ed366f
+--- /dev/null
++++ b/gtk/ubuntu-private.h
+@@ -0,0 +1,32 @@
++/*
++* Copyright 2013 Canonical Ltd.
++*
++* This program is free software: you can redistribute it and/or modify it
++* under the terms of the GNU General Public License version 3, as published
++* by the Free Software Foundation.
++*
++* This program is distributed in the hope that it will be useful, but
++* WITHOUT ANY WARRANTY; without even the implied warranties of
++* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
++* PURPOSE.  See the GNU General Public License for more details.
++*
++* You should have received a copy of the GNU General Public License along
++* with this program.  If not, see <http://www.gnu.org/licenses/>.
++*
++* Authors:
++*     Lars Uebernickel <[e-mail]>
++*/
++
++/*
++ * Warning: this file is not part of gtk+, but an Ubuntu-specific extension.
++ * The API provided here is meant to be used only from Unity.
++ *
++ * Applications should not use this.
++ */
++
++#ifndef __UBUNTU_PRIVATE_H__
++#define __UBUNTU_PRIVATE_H__
++
++#include "ubuntumenuitemfactory.h"
++
++#endif
+diff --git a/gtk/ubuntumenuitemfactory.c b/gtk/ubuntumenuitemfactory.c
+new file mode 100644
+index 0000000..65de84a
+--- /dev/null
++++ b/gtk/ubuntumenuitemfactory.c
+@@ -0,0 +1,38 @@
++/*
++* Copyright 2013 Canonical Ltd.
++*
++* This program is free software: you can redistribute it and/or modify it
++* under the terms of the GNU General Public License version 3, as published
++* by the Free Software Foundation.
++*
++* This program is distributed in the hope that it will be useful, but
++* WITHOUT ANY WARRANTY; without even the implied warranties of
++* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
++* PURPOSE.  See the GNU General Public License for more details.
++*
++* You should have received a copy of the GNU General Public License along
++* with this program.  If not, see <http://www.gnu.org/licenses/>.
++*
++* Authors:
++*     Lars Uebernickel <[e-mail]>
++*/
++
++#include "ubuntumenuitemfactory.h"
++
++G_DEFINE_INTERFACE_WITH_CODE (UbuntuMenuItemFactory, ubuntu_menu_item_factory, G_TYPE_OBJECT,
++  GIOExtensionPoint *ep = g_io_extension_point_register (UBUNTU_MENU_ITEM_FACTORY_EXTENSION_POINT_NAME);
++  g_io_extension_point_set_required_type (ep, g_define_type_id);)
++
++static void
++ubuntu_menu_item_factory_default_init (UbuntuMenuItemFactoryInterface *iface)
++{
++}
++
++GtkMenuItem *
++ubuntu_menu_item_factory_create_menu_item (UbuntuMenuItemFactory *factory,
++                                           const gchar           *type,
++                                           GMenuItem             *menuitem,
++                                           GActionGroup          *actions)
++{
++  return UBUNTU_MENU_ITEM_FACTORY_GET_IFACE (factory)->create_menu_item (factory, type, menuitem, actions);
++}
+diff --git a/gtk/ubuntumenuitemfactory.h b/gtk/ubuntumenuitemfactory.h
+new file mode 100644
+index 0000000..e6f93c0
+--- /dev/null
++++ b/gtk/ubuntumenuitemfactory.h
+@@ -0,0 +1,57 @@
++/*
++* Copyright 2013 Canonical Ltd.
++*
++* This program is free software: you can redistribute it and/or modify it
++* under the terms of the GNU General Public License version 3, as published
++* by the Free Software Foundation.
++*
++* This program is distributed in the hope that it will be useful, but
++* WITHOUT ANY WARRANTY; without even the implied warranties of
++* MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
++* PURPOSE.  See the GNU General Public License for more details.
++*
++* You should have received a copy of the GNU General Public License along
++* with this program.  If not, see <http://www.gnu.org/licenses/>.
++*
++* Authors:
++*     Lars Uebernickel <[e-mail]>
++*/
++
++#ifndef __UBUNTU_MENU_ITEM_FACTORY_H__
++#define __UBUNTU_MENU_ITEM_FACTORY_H__
++
++#include <gio/gio.h>
++#include "gtkmenuitem.h"
++
++G_BEGIN_DECLS
++
++#define UBUNTU_TYPE_MENU_ITEM_FACTORY         (ubuntu_menu_item_factory_get_type ())
++#define UBUNTU_MENU_ITEM_FACTORY(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), UBUNTU_TYPE_MENU_ITEM_FACTORY, UbuntuMenuItemFactory))
++#define UBUNTU_IS_MENU_ITEM_FACTORY(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), UBUNTU_TYPE_MENU_ITEM_FACTORY))
++#define UBUNTU_MENU_ITEM_FACTORY_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), UBUNTU_TYPE_MENU_ITEM_FACTORY, UbuntuMenuItemFactoryInterface))
++
++#define UBUNTU_MENU_ITEM_FACTORY_EXTENSION_POINT_NAME "ubuntu-menu-item-factory"
++
++typedef struct _UbuntuMenuItemFactoryInterface UbuntuMenuItemFactoryInterface;
++typedef struct _UbuntuMenuItemFactory          UbuntuMenuItemFactory;
++
++struct _UbuntuMenuItemFactoryInterface
++{
++  GTypeInterface iface;
++
++  GtkMenuItem * (*create_menu_item)  (UbuntuMenuItemFactory *factory,
++                                      const gchar           *type,
++                                      GMenuItem             *menuitem,
++                                      GActionGroup          *actions);
++};
++
++GType                   ubuntu_menu_item_factory_get_type      (void);
++
++GtkMenuItem *           ubuntu_menu_item_factory_create_menu_item (UbuntuMenuItemFactory *factory,
++                                                                   const gchar           *type,
++                                                                   GMenuItem             *menuitem,
++                                                                   GActionGroup          *actions);
++
++G_END_DECLS
++
++#endif
+-- 
+1.8.1.2
+