Merge lp:~mterry/libdbusmenu/unref-gtkmenuitems into lp:libdbusmenu/0.5

[Michael Terry]

Another result of my investigations into bug 835646. I don't think this is the last leak, but it should help a bit.

GtkMenuItems weren't necessarily being finalized, because we would still hold a reference to them.

dbusmenu_gtkclient_newitem_base would always call g_object_ref_sink, owning the initial floating ref. Then the menu item would often be added to a menu, which would call ref_sink again, adding a normal ref (total of 2 now).

When the corresponding DbusmenuMenuitem would die, we used to just be calling gtk_widget_destroy, which removes the item from any containers and does some other cleanups. Being unparented would reduce the ref count to 1, where it would remain.

So I've added another g_object_unref call to match our initial ref_sink. And some comments to explain why.

[Ted Gould (ted)]

review: Approve

=== modified file 'libdbusmenu-gtk/client.c'
--- libdbusmenu-gtk/client.c	2011-08-22 19:54:42 +0000
+++ libdbusmenu-gtk/client.c	2011-10-04 20:21:15 +0000
@@ -823,14 +823,22 @@
 	return;
 }
 
+static void
+destroy_gmi (GtkMenuItem * gmi)
+{
 #ifdef MASSIVEDEBUGGING
-static void
-destroy_gmi (GtkMenuItem * gmi, DbusmenuMenuitem * mi)
-{
-	g_debug("Destorying GTK Menuitem for %d", dbusmenu_menuitem_get_id(mi));
+	g_debug("Destroying GTK Menuitem %d", gmi);
+#endif
+
+	/* Call gtk_widget_destroy to remove from any containers and cleanup */
+	gtk_widget_destroy(GTK_WIDGET(gmi));
+
+	/* Now remove last ref that we are holding (due to g_object_ref_sink in
+	   dbusmenu_gtkclient_newitem_base).  This should finalize the object */
+	g_object_unref(G_OBJECT(gmi));
+
 	return;
 }
-#endif
 
 /**
  * dbusmenu_gtkclient_newitem_base:
@@ -857,7 +865,7 @@
 
 	/* Attach these two */
 	g_object_ref_sink(G_OBJECT(gmi));
-	g_object_set_data_full(G_OBJECT(item), data_menuitem, gmi, (GDestroyNotify)gtk_widget_destroy);
+	g_object_set_data_full(G_OBJECT(item), data_menuitem, gmi, (GDestroyNotify)destroy_gmi);
 
 	/* DbusmenuMenuitem signals */
 	g_signal_connect(G_OBJECT(item), DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED, G_CALLBACK(menu_prop_change_cb), client);