Merge lp:~mterry/libdbusmenu/handle-icons-better into lp:libdbusmenu/0.5

[Michael Terry]

This branch does several things:

 * Consolidates the various update_*_icon methods into one giant update_icon method that handles any type of icon. This makes it easier to handle when images switch icon types and just generally keeps similar logic in one place.

 * Handles GIcon images

 * Watches always-show-image status of the GtkMenuItem

 * Watches lots of properties of the embedded GtkImage in a GtkMenuItem for changes

This was spurred on by bug 715864 and in particular, the menus of nautilus. They should now show up excellently.

[Ted Gould (ted)]

On Thu, 2011-02-10 at 23:32 +0000, Michael Terry wrote:
> + if (icon_name != NULL) {
> dbusmenu_menuitem_property_set (menuitem,
> DBUSMENU_MENUITEM_PROP_ICON_NAME,
> icon_name);
> - } else {
> + }
> + else if (pixbuf != NULL) {
> + dbusmenu_menuitem_property_set_image (menuitem,
> + DBUSMENU_MENUITEM_PROP_ICON_DATA,
> + pixbuf);
> + }
> + else {
> dbusmenu_menuitem_property_remove (menuitem,
> DBUSMENU_MENUITEM_PROP_ICON_NAME);
> + dbusmenu_menuitem_property_remove (menuitem,
> + DBUSMENU_MENUITEM_PROP_ICON_DATA);
> + }

I think in this statement it should remove the opposite property so that
we know only one is set in the end.

  review needsfixing

review: Needs Fixing

[lp:~mterry/libdbusmenu/handle-icons-better]

209. By Michael Terry on 2011-02-17

make sure other icon property is removed when setting one

[Michael Terry (mterry)]

OK, done.

[Ted Gould (ted)]

review: Approve

=== modified file 'libdbusmenu-gtk/parser.c'
--- libdbusmenu-gtk/parser.c	2011-02-04 19:31:59 +0000
+++ libdbusmenu-gtk/parser.c	2011-02-17 12:52:44 +0000
@@ -39,6 +39,7 @@
   GtkAction *action;
   GtkWidget *widget;
   GtkWidget *shell;
+  GtkWidget *image;
 } ParserData;
 
 typedef struct _RecurseContext
@@ -51,22 +52,25 @@
 static DbusmenuMenuitem * construct_dbusmenu_for_widget (GtkWidget * widget);
 static void           accel_changed            (GtkWidget *         widget,
                                                 gpointer            data);
-static gboolean       update_stock_item        (DbusmenuMenuitem *  menuitem,
-                                                GtkWidget *         widget);
 static void           checkbox_toggled         (GtkWidget *         widget,
                                                 DbusmenuMenuitem *  mi);
-static void           update_icon_name         (DbusmenuMenuitem *  menuitem,
-                                                GtkWidget *         widget);
+static void           update_icon              (DbusmenuMenuitem *  menuitem,
+                                                GtkImage *          image);
 static GtkWidget *    find_menu_label          (GtkWidget *         widget);
 static void           label_notify_cb          (GtkWidget *         widget,
                                                 GParamSpec *        pspec,
                                                 gpointer            data);
+static void           image_notify_cb          (GtkWidget *         widget,
+                                                GParamSpec *        pspec,
+                                                gpointer            data);
 static void           action_notify_cb         (GtkAction *         action,
                                                 GParamSpec *        pspec,
                                                 gpointer            data);
 static void           child_added_cb           (GtkContainer *      menu,
                                                 GtkWidget *         widget,
                                                 gpointer            data);
+static void           theme_changed_cb         (GtkIconTheme *      theme,
+                                                gpointer            data);
 static void           item_activated           (DbusmenuMenuitem *  item,
                                                 guint               timestamp,
                                                 gpointer            user_data);
@@ -136,6 +140,11 @@
 		g_object_remove_weak_pointer(G_OBJECT(pdata->shell), (gpointer*)&pdata->shell);
 	}
 
+	if (pdata != NULL && pdata->image != NULL) {
+		g_signal_handlers_disconnect_by_func(pdata->image, G_CALLBACK(image_notify_cb), obj);
+		g_object_remove_weak_pointer(G_OBJECT(pdata->image), (gpointer*)&pdata->image);
+	}
+
 	return;
 }
 
@@ -148,6 +157,9 @@
 	//if (!G_IS_OBJECT(obj)) return;
 	//g_object_weak_unref(G_OBJECT(obj), dbusmenu_cache_freed, data);
 	//dbusmenu_cache_freed(data, obj);
+
+	g_signal_handlers_disconnect_by_func(gtk_icon_theme_get_default(), G_CALLBACK(theme_changed_cb), data);
+
 	return;
 }
 
@@ -347,8 +359,6 @@
         }
       else
         {
-          gboolean label_set = FALSE;
-
           g_signal_connect (widget,
                             "accel-closures-changed",
                             G_CALLBACK (accel_changed),
@@ -373,41 +383,37 @@
           if (GTK_IS_IMAGE_MENU_ITEM (widget))
             {
               GtkWidget *image;
-              GtkImageType image_type;
 
               image = gtk_image_menu_item_get_image (GTK_IMAGE_MENU_ITEM (widget));
 
               if (GTK_IS_IMAGE (image))
                 {
-                  image_type = gtk_image_get_storage_type (GTK_IMAGE (image));
-
-                  if (image_type == GTK_IMAGE_STOCK)
-                    {
-                      label_set = update_stock_item (mi, image);
-                    }
-                  else if (image_type == GTK_IMAGE_ICON_NAME)
-                    {
-                      update_icon_name (mi, image);
-                    }
-                  else if (image_type == GTK_IMAGE_PIXBUF)
-                    {
-                      dbusmenu_menuitem_property_set_image (mi,
-                                                            DBUSMENU_MENUITEM_PROP_ICON_DATA,
-                                                            gtk_image_get_pixbuf (GTK_IMAGE (image)));
-                    }
+                  update_icon (mi, GTK_IMAGE (image));
+
+                  /* Watch for theme changes because if gicon changes, we want to send a
+                     different pixbuf. */
+                  g_signal_connect(G_OBJECT(gtk_icon_theme_get_default()),
+                                   "changed", G_CALLBACK(theme_changed_cb), widget);
+
+                  pdata->image = image;
+                  g_signal_connect (G_OBJECT (image),
+                                    "notify",
+                                    G_CALLBACK (image_notify_cb),
+                                    mi);
+                  g_object_add_weak_pointer(G_OBJECT (image), (gpointer*)&pdata->image);
                 }
             }
 
           GtkWidget *label = find_menu_label (widget);
 
-          dbusmenu_menuitem_property_set (mi,
-                                          "label",
-                                          label ? gtk_label_get_text (GTK_LABEL (label)) : NULL);
-
           if (label)
             {
               // Sometimes, an app will directly find and modify the label
               // (like empathy), so watch the label especially for that.
+              dbusmenu_menuitem_property_set (mi,
+                                              "label",
+                                              gtk_label_get_text (GTK_LABEL (label)));
+
               pdata->label = label;
               g_signal_connect (G_OBJECT (label),
                                 "notify",
@@ -510,48 +516,6 @@
   dbusmenu_menuitem_property_set_shortcut_menuitem (mi, GTK_MENU_ITEM (widget));
 }
 
-static gboolean
-update_stock_item (DbusmenuMenuitem *menuitem,
-                   GtkWidget        *widget)
-{
-  GtkStockItem stock;
-  GtkImage *image;
-
-  g_return_val_if_fail (GTK_IS_IMAGE (widget), FALSE);
-
-  image = GTK_IMAGE (widget);
-
-  if (gtk_image_get_storage_type (image) != GTK_IMAGE_STOCK)
-    return FALSE;
-
-  gchar * stock_id = NULL;
-  gtk_image_get_stock(image, &stock_id, NULL);
-
-  gtk_stock_lookup (stock_id, &stock);
-
-  if (should_show_image (image))
-    dbusmenu_menuitem_property_set (menuitem,
-                                    DBUSMENU_MENUITEM_PROP_ICON_NAME,
-                                    stock_id);
-  else
-    dbusmenu_menuitem_property_remove (menuitem,
-                                       DBUSMENU_MENUITEM_PROP_ICON_NAME);
-
-  const gchar *label = dbusmenu_menuitem_property_get (menuitem,
-                                                       DBUSMENU_MENUITEM_PROP_LABEL);
-
-  if (stock.label != NULL && label != NULL)
-    {
-      dbusmenu_menuitem_property_set (menuitem,
-                                      DBUSMENU_MENUITEM_PROP_LABEL,
-                                      stock.label);
-
-      return TRUE;
-    }
-
-  return FALSE;
-}
-
 static void
 checkbox_toggled (GtkWidget *widget, DbusmenuMenuitem *mi)
 {
@@ -561,27 +525,86 @@
 }
 
 static void
-update_icon_name (DbusmenuMenuitem *menuitem,
-                  GtkWidget        *widget)
+update_icon (DbusmenuMenuitem *menuitem, GtkImage *image)
 {
-  GtkImage *image;
-
-  g_return_if_fail (GTK_IS_IMAGE (widget));
-
-  image = GTK_IMAGE (widget);
-
-  if (gtk_image_get_storage_type (image) != GTK_IMAGE_ICON_NAME)
-    return;
-
-  if (should_show_image (image)) {
-    const gchar * icon_name = NULL;
-	gtk_image_get_icon_name(image, &icon_name, NULL);
+  GdkPixbuf * pixbuf = NULL;
+  const gchar * icon_name = NULL;
+  GtkStockItem stock;
+  GIcon * gicon;
+  GtkIconInfo * info;
+  gint width;
+
+  if (image != NULL && should_show_image (image)) {
+    switch (gtk_image_get_storage_type (image)) {
+    case GTK_IMAGE_PIXBUF:
+      pixbuf = g_object_ref (gtk_image_get_pixbuf (image));
+      break;
+
+    case GTK_IMAGE_ICON_NAME:
+      gtk_image_get_icon_name (image, &icon_name, NULL);
+      break;
+
+    case GTK_IMAGE_STOCK:
+      gtk_image_get_stock (image, (gchar **) &icon_name, NULL);
+      if (gtk_stock_lookup (icon_name, &stock)) {
+        /* Now set label too */
+        const gchar * label = NULL;
+        label = dbusmenu_menuitem_property_get (menuitem,
+                                                DBUSMENU_MENUITEM_PROP_LABEL);
+        if (stock.label != NULL && label != NULL) {
+          dbusmenu_menuitem_property_set (menuitem,
+                                          DBUSMENU_MENUITEM_PROP_LABEL,
+                                          stock.label);
+        }
+      }
+      break;
+
+    case GTK_IMAGE_GICON:
+      /* Load up a pixbuf and send that over.  We don't bother differentiating
+         between icon-name gicons and pixbuf gicons because even when given a
+         icon-name gicon, there's no easy way to lookup which icon-name among
+         its set is present and should be used among the icon themes available.
+         So instead, we render to a pixbuf and watch icon theme changes. */
+      gtk_image_get_gicon (image, &gicon, NULL);
+		  gtk_icon_size_lookup(GTK_ICON_SIZE_MENU, &width, NULL);
+      info = gtk_icon_theme_lookup_by_gicon (gtk_icon_theme_get_default (),
+                                             gicon, width, 
+                                             GTK_ICON_LOOKUP_FORCE_SIZE);
+      if (info != NULL) {
+        pixbuf = gtk_icon_info_load_icon (info, NULL);
+        gtk_icon_info_free (info);
+      }
+      break;
+
+    default:
+      g_debug ("Could not handle image type %i\n", gtk_image_get_storage_type (image));
+      break;
+    }
+  }
+
+  if (icon_name != NULL) {
     dbusmenu_menuitem_property_set (menuitem,
                                     DBUSMENU_MENUITEM_PROP_ICON_NAME,
                                     icon_name);
-  } else {
-    dbusmenu_menuitem_property_remove (menuitem,
-                                       DBUSMENU_MENUITEM_PROP_ICON_NAME);
+    dbusmenu_menuitem_property_remove (menuitem,
+                                       DBUSMENU_MENUITEM_PROP_ICON_DATA);
+  }
+  else if (pixbuf != NULL) {
+    dbusmenu_menuitem_property_remove (menuitem,
+                                       DBUSMENU_MENUITEM_PROP_ICON_NAME);
+    dbusmenu_menuitem_property_set_image (menuitem,
+                                          DBUSMENU_MENUITEM_PROP_ICON_DATA,
+                                          pixbuf);
+  }
+  else {
+    dbusmenu_menuitem_property_remove (menuitem,
+                                       DBUSMENU_MENUITEM_PROP_ICON_NAME);
+    dbusmenu_menuitem_property_remove (menuitem,
+                                       DBUSMENU_MENUITEM_PROP_ICON_DATA);
+  }
+
+  if (pixbuf != NULL) {
+    g_object_unref (pixbuf);
   }
 }
 
@@ -630,6 +653,29 @@
 }
 
 static void
+image_notify_cb (GtkWidget  *widget,
+                 GParamSpec *pspec,
+                 gpointer    data)
+{
+  DbusmenuMenuitem *mi = (DbusmenuMenuitem *)data;
+
+  if (pspec->name == g_intern_static_string ("file") ||
+      pspec->name == g_intern_static_string ("gicon") ||
+      pspec->name == g_intern_static_string ("icon-name") ||
+      pspec->name == g_intern_static_string ("icon-set") ||
+      pspec->name == g_intern_static_string ("image") ||
+      pspec->name == g_intern_static_string ("mask") ||
+      pspec->name == g_intern_static_string ("pixbuf") ||
+      pspec->name == g_intern_static_string ("pixbuf-animation") ||
+      pspec->name == g_intern_static_string ("pixmap") ||
+      pspec->name == g_intern_static_string ("stock") ||
+      pspec->name == g_intern_static_string ("storage-type"))
+    {
+      update_icon (mi, GTK_IMAGE (widget));
+    }
+}
+
+static void
 action_notify_cb (GtkAction  *action,
                   GParamSpec *pspec,
                   gpointer    data)
@@ -723,13 +769,12 @@
                                            DBUSMENU_MENUITEM_PROP_VISIBLE,
                                            gtk_widget_get_visible (widget));
     }
-  else if (pspec->name == g_intern_static_string ("stock"))
-    {
-      update_stock_item (child, widget);
-    }
-  else if (pspec->name == g_intern_static_string ("icon-name"))
-    {
-      update_icon_name (child, widget);
+  else if (pspec->name == g_intern_static_string ("image") ||
+           pspec->name == g_intern_static_string ("always-show-image"))
+    {
+      GtkWidget *image;
+      image = gtk_image_menu_item_get_image (GTK_IMAGE_MENU_ITEM (widget));
+      update_icon (child, GTK_IMAGE (image));
     }
   else if (pspec->name == g_intern_static_string ("parent"))
     {
@@ -797,6 +842,23 @@
 	parse_menu_structure_helper(widget, &recurse);
 }
 
+static void
+theme_changed_cb (GtkIconTheme *theme, gpointer data)
+{
+  GtkWidget *image;
+
+  image = gtk_image_menu_item_get_image (GTK_IMAGE_MENU_ITEM (data));
+
+  gpointer pmi = g_object_get_data(G_OBJECT(data), CACHED_MENUITEM);
+  if (pmi != NULL) {
+    update_icon(DBUSMENU_MENUITEM(pmi), GTK_IMAGE(image));
+  }
+
+  /* Switch signal to new theme */
+  g_signal_handlers_disconnect_by_func(theme, G_CALLBACK(theme_changed_cb), data);
+  g_signal_connect(gtk_icon_theme_get_default(), "changed", G_CALLBACK(theme_changed_cb), data);
+}
+
 static gboolean
 should_show_image (GtkImage *image)
 {