Merge lp:~ted/libdbusmenu/parse-serializable-menuitem into lp:libdbusmenu/0.5

[Ted Gould]

Makes the parser look at serializable menuitems. This is also dependent on the serializable menuitem branch, but I can't be dependent on two. Please ignore that file :)

Resubmitting so it's dependent on serializable-menuitem as the parser is now in trunk. Hopefully will create a better diff.

[Mikkel Kamstrup Erlandsen (kamstrup)]

How does this branch relate to https://code.launchpad.net/~ted/dbusmenu/serializable-menuitem/+merge/47604 ? They look identical?

review: Needs Information

[lp:~ted/libdbusmenu/parse-serializable-menuitem]

196. By Ted Gould on 2011-01-27

Updating to serializeable menuitem branch. Some function prototype changes.

197. By Ted Gould on 2011-01-27

Fix changing prototypes.

Unmerged revisions

=== modified file '.bzrignore'
--- .bzrignore	2011-01-27 15:48:01 +0000
+++ .bzrignore	2011-01-27 15:48:01 +0000
@@ -223,3 +223,7 @@
 libdbusmenu-gtk/libdbusmenu_gtk_la-serializablemenuitem.lo
 docs/libdbusmenu-gtk/reference/html/DbusmenuGtkSerializableMenuItem.html
 docs/libdbusmenu-gtk/reference/tmpl/serializablemenuitem.sgml
+libdbusmenu-gtk/libdbusmenu_gtk_la-parser.lo
+test-gtk-parser
+test-gtk-parser-test
+test-gtk-parser.xml

=== modified file 'libdbusmenu-glib/client.h'
--- libdbusmenu-glib/client.h	2011-01-27 15:48:01 +0000
+++ libdbusmenu-glib/client.h	2011-01-27 15:48:01 +0000
@@ -110,7 +110,28 @@
 	DbusmenuClientPrivate * priv;
 };
 
+/**
+	DbusmenuClientTypeHandler:
+	@newitem: The #DbusmenuMenuitem that was created
+	@parent: The parent of @newitem or #NULL if none
+	@client: A pointer to the #DbusmenuClient
+	@user_data: The data you gave us
+
+	The type handler is called when a dbusmenu item is created
+	with a matching type as setup in #dbusmenu_client_add_type_handler
+*/
 typedef gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem * newitem, DbusmenuMenuitem * parent, DbusmenuClient * client, gpointer user_data);
+
+/**
+	DbusmenuClientTypeDestroyHandler:
+	@client: A pointer to the #DbusmenuClient
+	@type: The type that this handler was registered with
+	@user_data: The data you gave us
+
+	This handler is called when the type becomes unregistered by the
+	client.  This is usally caused by the #DbusmenuClient being destroyed
+	and should free memory or unref objects in @user_data.
+*/
 typedef void (*DbusmenuClientTypeDestroyHandler) (DbusmenuClient * client, const gchar * type, gpointer user_data);
 
 GType                dbusmenu_client_get_type          (void);

=== modified file 'libdbusmenu-gtk/Makefile.am'
--- libdbusmenu-gtk/Makefile.am	2011-01-27 15:48:01 +0000
+++ libdbusmenu-gtk/Makefile.am	2011-01-27 15:48:01 +0000
@@ -24,6 +24,7 @@
 	client.h \
 	menu.h \
 	menuitem.h \
+	parser.h \
 	serializablemenuitem.h
 
 libdbusmenu_gtk_la_SOURCES = \
@@ -35,6 +36,8 @@
 	menu.c \
 	menuitem.h \
 	menuitem.c \
+	parser.h \
+	parser.c \
 	serializablemenuitem.h \
 	serializablemenuitem.c
 

=== added file 'libdbusmenu-gtk/parser.c'
--- libdbusmenu-gtk/parser.c	1970-01-01 00:00:00 +0000
+++ libdbusmenu-gtk/parser.c	2011-01-27 15:48:01 +0000
@@ -0,0 +1,698 @@
+/*
+Parse to take a set of GTK Menus and turn them into something that can
+be sent over the wire.
+
+Copyright 2011 Canonical Ltd.
+
+Authors:
+	Numerous (check Bazaar)
+
+This program is free software: you can redistribute it and/or modify it 
+under the terms of either or both of the following licenses:
+
+1) the GNU Lesser General Public License version 3, as published by the 
+Free Software Foundation; and/or
+2) the GNU Lesser General Public License version 2.1, 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 applicable version of the GNU Lesser General Public 
+License for more details.
+
+You should have received a copy of both the GNU Lesser General Public 
+License version 3 and version 2.1 along with this program.  If not, see 
+<http://www.gnu.org/licenses/>
+*/
+
+#include "parser.h"
+#include "menuitem.h"
+#include "serializablemenuitem.h"
+
+#define CACHED_MENUITEM  "dbusmenu-gtk-parser-cached-item"
+
+typedef struct _RecurseContext
+{
+  GtkWidget * toplevel;
+  gint count;
+  DbusmenuMenuitem *stack[30];
+} RecurseContext;
+
+static void parse_menu_structure_helper (GtkWidget * widget, RecurseContext * recurse);
+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 GtkWidget *    find_menu_label          (GtkWidget *         widget);
+static void           label_notify_cb          (GtkWidget *         widget,
+                                                GParamSpec *        pspec,
+                                                gpointer            data);
+static void           action_notify_cb         (GtkAction *         action,
+                                                GParamSpec *        pspec,
+                                                gpointer            data);
+static void           item_activated           (DbusmenuMenuitem *  item,
+                                                guint               timestamp,
+                                                gpointer            user_data);
+static gboolean       item_about_to_show       (DbusmenuMenuitem *  item,
+                                                gpointer            user_data);
+static void           widget_notify_cb         (GtkWidget  *        widget,
+                                                GParamSpec *        pspec,
+                                                gpointer            data);
+static gboolean       should_show_image        (GtkImage *          image);
+static void           menuitem_notify_cb       (GtkWidget *         widget,
+                                                GParamSpec *        pspec,
+                                                gpointer            data);
+
+DbusmenuMenuitem *
+dbusmenu_gtk_parse_menu_structure (GtkWidget * widget)
+{
+  RecurseContext recurse = {0};
+
+  recurse.count = -1;
+  recurse.toplevel = gtk_widget_get_toplevel(widget);
+
+  parse_menu_structure_helper(widget, &recurse);
+
+  if (recurse.stack[0] != NULL && DBUSMENU_IS_MENUITEM(recurse.stack[0])) {
+  	return recurse.stack[0];
+  }
+
+  return NULL;
+}
+
+static void
+dbusmenu_cache_freed (gpointer data, GObject * obj)
+{
+	/* If the dbusmenu item is killed we don't need to remove
+	   the weak ref as well. */
+	g_object_steal_data(G_OBJECT(data), CACHED_MENUITEM);
+	return;
+}
+
+static void
+object_cache_freed (gpointer data)
+{
+	g_object_weak_unref(G_OBJECT(data), dbusmenu_cache_freed, data);
+	return;
+}
+
+static void
+parse_menu_structure_helper (GtkWidget * widget, RecurseContext * recurse)
+{
+  if (GTK_IS_CONTAINER (widget))
+    {
+      gboolean increment = GTK_IS_MENU_SHELL (widget) || GTK_IS_MENU_ITEM (widget);
+
+      if (increment)
+        recurse->count++;
+
+      /* Okay, this is a little janky and all.. but some applications update some
+       * menuitem properties such as sensitivity on the activate callback.  This
+       * seems a little weird, but it's not our place to judge when all this code
+       * is so crazy.  So we're going to get ever crazier and activate all the
+       * menus that are directly below the menubar and force the applications to
+       * update their sensitivity.  The menus won't actually popup in the app
+       * window due to our gtk+ patches.
+       *
+       * Note that this will not force menuitems in submenus to be updated as well.
+       */
+      if (recurse->count == 0 && GTK_IS_MENU_BAR (widget))
+        {
+          GList *children = gtk_container_get_children (GTK_CONTAINER (widget));
+
+          for (; children != NULL; children = children->next)
+            {
+              gtk_menu_shell_activate_item (GTK_MENU_SHELL (widget),
+                                            children->data,
+                                            TRUE);
+            }
+
+          g_list_free (children);
+        }
+
+      if (recurse->count > -1 && increment)
+        {
+		  gpointer pmi = g_object_get_data(G_OBJECT(widget), CACHED_MENUITEM);
+          DbusmenuMenuitem *dmi = NULL;
+		  if (pmi != NULL) dmi = DBUSMENU_MENUITEM(pmi);
+
+          if (dmi != NULL)
+            {
+              if (increment)
+                recurse->count--;
+
+              return;
+            }
+          else
+            {
+              recurse->stack[recurse->count] = construct_dbusmenu_for_widget (widget);
+			  g_object_set_data_full(G_OBJECT(widget), CACHED_MENUITEM, recurse->stack[recurse->count], object_cache_freed);
+			  g_object_weak_ref(G_OBJECT(recurse->stack[recurse->count]), dbusmenu_cache_freed, widget);
+            }
+
+          if (!gtk_widget_get_visible (widget))
+            {
+              g_signal_connect (G_OBJECT (widget),
+                                "notify::visible",
+                                G_CALLBACK (menuitem_notify_cb),
+                                recurse->toplevel);
+            }
+
+          if (GTK_IS_TEAROFF_MENU_ITEM (widget))
+            {
+              dbusmenu_menuitem_property_set_bool (recurse->stack[recurse->count],
+                                                   DBUSMENU_MENUITEM_PROP_VISIBLE,
+                                                   FALSE);
+            }
+
+          if (recurse->count > 0)
+            {
+              GList *children = NULL;
+              GList *peek = NULL;
+
+              if (recurse->stack[recurse->count - 1])
+                {
+                  children = dbusmenu_menuitem_get_children (recurse->stack[recurse->count - 1]);
+
+                  if (children)
+                    {
+                      peek = g_list_find (children, recurse->stack[recurse->count]);
+                    }
+
+                  if (!peek)
+                    {
+                      /* Should we set a weak ref on the parent? */
+                      g_object_set_data (G_OBJECT (recurse->stack[recurse->count]),
+                                         "dbusmenu-parent",
+                                         recurse->stack[recurse->count - 1]);
+                      dbusmenu_menuitem_child_append (recurse->stack[recurse->count - 1],
+                                                      recurse->stack[recurse->count]);
+                    }
+                }
+              else
+                {
+                  DbusmenuMenuitem *item = NULL; /* g_hash_table_lookup (recurse->context->lookup,
+                                                                gtk_widget_get_parent (widget)); */
+
+                  if (item)
+                    {
+                      children = dbusmenu_menuitem_get_children (item);
+
+                      if (children)
+                        {
+                          peek = g_list_find (children, recurse->stack[recurse->count]);
+                        }
+
+                      if (!peek)
+                        {
+                          g_object_set_data (G_OBJECT (recurse->stack[recurse->count]),
+                                             "dbusmenu-parent",
+                                             recurse->stack[recurse->count - 1]);
+
+                          dbusmenu_menuitem_child_append (item, recurse->stack[recurse->count]);
+                        }
+                    }
+                }
+            }
+        }
+
+      gtk_container_foreach (GTK_CONTAINER (widget),
+                             (GtkCallback)parse_menu_structure_helper,
+                             recurse);
+
+      if (GTK_IS_MENU_ITEM (widget))
+        {
+          GtkWidget *menu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (widget));
+
+          if (menu != NULL)
+            {
+              parse_menu_structure_helper (menu, recurse);
+            }
+        }
+
+      if (increment)
+        recurse->count--;
+    }
+}
+
+/* Turn a widget into a dbusmenu item depending on the type of GTK
+   object that it is. */
+static DbusmenuMenuitem *
+construct_dbusmenu_for_widget (GtkWidget * widget)
+{
+	/* If it's a subclass of our serializable menu item then we can
+	   use its own build function */
+	if (DBUSMENU_IS_GTK_SERIALIZABLE_MENU_ITEM(widget)) {
+		DbusmenuGtkSerializableMenuItem * smi = DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM(widget);
+		return dbusmenu_gtk_serializable_menu_item_build_menuitem(smi);
+	}
+
+  /* If it's a standard GTK Menu Item we need to do some of our own work */
+  if (GTK_IS_MENU_ITEM (widget))
+    {
+      DbusmenuMenuitem *mi = dbusmenu_menuitem_new ();
+
+      gboolean visible = FALSE;
+      gboolean sensitive = FALSE;
+      if (GTK_IS_SEPARATOR_MENU_ITEM (widget))
+        {
+          dbusmenu_menuitem_property_set (mi,
+                                          "type",
+                                          "separator");
+
+          visible = gtk_widget_get_visible (widget);
+          sensitive = gtk_widget_get_sensitive (widget);
+        }
+      else
+        {
+          gboolean label_set = FALSE;
+
+          g_signal_connect (widget,
+                            "accel-closures-changed",
+                            G_CALLBACK (accel_changed),
+                            mi);
+
+          if (GTK_IS_CHECK_MENU_ITEM (widget))
+            {
+              dbusmenu_menuitem_property_set (mi,
+                                              DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE,
+                                              gtk_check_menu_item_get_draw_as_radio (GTK_CHECK_MENU_ITEM (widget)) ? DBUSMENU_MENUITEM_TOGGLE_RADIO : DBUSMENU_MENUITEM_TOGGLE_CHECK);
+
+              dbusmenu_menuitem_property_set_int (mi,
+                                                  DBUSMENU_MENUITEM_PROP_TOGGLE_STATE,
+                                                  gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)) ? DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED : DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED);
+
+              g_signal_connect (widget,
+                                "activate",
+                                G_CALLBACK (checkbox_toggled),
+                                mi);
+            }
+
+          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)));
+                    }
+                }
+            }
+
+          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.
+              g_signal_connect (G_OBJECT (label),
+                                "notify",
+                                G_CALLBACK (label_notify_cb),
+                                mi);
+            }
+
+          if (GTK_IS_ACTIVATABLE (widget))
+            {
+              GtkActivatable *activatable = GTK_ACTIVATABLE (widget);
+
+              if (gtk_activatable_get_use_action_appearance (activatable))
+                {
+                  GtkAction *action = gtk_activatable_get_related_action (activatable);
+
+                  if (action)
+                    {
+                      visible = gtk_action_is_visible (action);
+                      sensitive = gtk_action_is_sensitive (action);
+
+                      g_signal_connect_object (action, "notify",
+                                               G_CALLBACK (action_notify_cb),
+                                               mi,
+                                               G_CONNECT_AFTER);
+                    }
+                }
+            }
+
+          if (!g_object_get_data (G_OBJECT (widget), "gtk-empty-menu-item") && !GTK_IS_TEAROFF_MENU_ITEM (widget))
+            {
+              visible = gtk_widget_get_visible (widget);
+              sensitive = gtk_widget_get_sensitive (widget);
+            }
+
+          dbusmenu_menuitem_property_set_shortcut_menuitem (mi, GTK_MENU_ITEM (widget));
+
+          g_signal_connect (G_OBJECT (mi),
+                            DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED,
+                            G_CALLBACK (item_activated),
+                            widget);
+
+          g_signal_connect (G_OBJECT (mi),
+                            DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW,
+                            G_CALLBACK (item_about_to_show),
+                            widget);
+        }
+
+      dbusmenu_menuitem_property_set_bool (mi,
+                                           DBUSMENU_MENUITEM_PROP_VISIBLE,
+                                           visible);
+
+      dbusmenu_menuitem_property_set_bool (mi,
+                                           DBUSMENU_MENUITEM_PROP_ENABLED,
+                                           sensitive);
+
+      g_signal_connect (widget,
+                        "notify",
+                        G_CALLBACK (widget_notify_cb),
+                        mi);
+      return mi;
+    }
+
+	/* If it's none of those we're going to just create a
+	   generic menuitem as a place holder for it. */
+	return dbusmenu_menuitem_new();
+}
+
+static void
+menuitem_notify_cb (GtkWidget  *widget,
+                    GParamSpec *pspec,
+                    gpointer    data)
+{
+  if (pspec->name == g_intern_static_string ("visible"))
+    {
+      GtkWidget * new_toplevel = gtk_widget_get_toplevel (widget);
+	  GtkWidget * old_toplevel = GTK_WIDGET(data);
+
+      if (new_toplevel == old_toplevel) {
+          /* TODO: Figure this out -> rebuild (context->bridge, window); */
+      }
+
+      /* We only care about this once, so let's disconnect now. */
+      g_signal_handlers_disconnect_by_func (widget,
+                                            G_CALLBACK (menuitem_notify_cb),
+                                            data);
+    }
+}
+
+static void
+accel_changed (GtkWidget *widget,
+               gpointer   data)
+{
+  DbusmenuMenuitem *mi = (DbusmenuMenuitem *)data;
+  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)
+{
+  dbusmenu_menuitem_property_set_int (mi,
+                                      DBUSMENU_MENUITEM_PROP_TOGGLE_STATE,
+                                      gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (widget)) ? DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED : DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED);
+}
+
+static void
+update_icon_name (DbusmenuMenuitem *menuitem,
+                  GtkWidget        *widget)
+{
+  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);
+    dbusmenu_menuitem_property_set (menuitem,
+                                    DBUSMENU_MENUITEM_PROP_ICON_NAME,
+                                    icon_name);
+  } else {
+    dbusmenu_menuitem_property_remove (menuitem,
+                                       DBUSMENU_MENUITEM_PROP_ICON_NAME);
+  }
+}
+
+static GtkWidget *
+find_menu_label (GtkWidget *widget)
+{
+  GtkWidget *label = NULL;
+
+  if (GTK_IS_LABEL (widget))
+    return widget;
+
+  if (GTK_IS_CONTAINER (widget))
+    {
+      GList *children;
+      GList *l;
+
+      children = gtk_container_get_children (GTK_CONTAINER (widget));
+
+      for (l = children; l; l = l->next)
+        {
+          label = find_menu_label (l->data);
+
+          if (label)
+            break;
+        }
+
+      g_list_free (children);
+    }
+
+  return label;
+}
+
+static void
+label_notify_cb (GtkWidget  *widget,
+                 GParamSpec *pspec,
+                 gpointer    data)
+{
+  DbusmenuMenuitem *child = (DbusmenuMenuitem *)data;
+
+  if (pspec->name == g_intern_static_string ("label"))
+    {
+      dbusmenu_menuitem_property_set (child,
+                                      DBUSMENU_MENUITEM_PROP_LABEL,
+                                      gtk_label_get_text (GTK_LABEL (widget)));
+    }
+}
+
+static void
+action_notify_cb (GtkAction  *action,
+                  GParamSpec *pspec,
+                  gpointer    data)
+{
+  DbusmenuMenuitem *mi = (DbusmenuMenuitem *)data;
+
+  if (pspec->name == g_intern_static_string ("sensitive"))
+    {
+      dbusmenu_menuitem_property_set_bool (mi,
+                                           DBUSMENU_MENUITEM_PROP_ENABLED,
+                                           gtk_action_is_sensitive (action));
+    }
+  else if (pspec->name == g_intern_static_string ("visible"))
+    {
+      dbusmenu_menuitem_property_set_bool (mi,
+                                           DBUSMENU_MENUITEM_PROP_VISIBLE,
+                                           gtk_action_is_visible (action));
+    }
+  else if (pspec->name == g_intern_static_string ("active"))
+    {
+      dbusmenu_menuitem_property_set_bool (mi,
+                                           DBUSMENU_MENUITEM_PROP_TOGGLE_STATE,
+                                           gtk_toggle_action_get_active (GTK_TOGGLE_ACTION (action)));
+    }
+  else if (pspec->name == g_intern_static_string ("label"))
+    {
+      dbusmenu_menuitem_property_set (mi,
+                                      DBUSMENU_MENUITEM_PROP_LABEL,
+                                      gtk_action_get_label (action));
+    }
+}
+
+static void
+item_activated (DbusmenuMenuitem *item, guint timestamp, gpointer user_data)
+{
+  GtkWidget *child;
+
+  if (user_data != NULL)
+    {
+      child = (GtkWidget *)user_data;
+
+      if (GTK_IS_MENU_ITEM (child))
+        {
+          gtk_menu_item_activate (GTK_MENU_ITEM (child));
+        }
+    }
+}
+
+static gboolean
+item_about_to_show (DbusmenuMenuitem *item, gpointer user_data)
+{
+  GtkWidget *child;
+
+  if (user_data != NULL)
+    {
+      child = (GtkWidget *)user_data;
+
+      if (GTK_IS_MENU_ITEM (child))
+        {
+          // Only called for items with submens.  So we activate it here in
+          // case the program dynamically creates menus (like empathy does)
+          gtk_menu_item_activate (GTK_MENU_ITEM (child));
+        }
+    }
+
+  return TRUE;
+}
+
+static void
+widget_notify_cb (GtkWidget  *widget,
+                  GParamSpec *pspec,
+                  gpointer    data)
+{
+  DbusmenuMenuitem *child = (DbusmenuMenuitem *)data;
+
+  if (pspec->name == g_intern_static_string ("sensitive"))
+    {
+      dbusmenu_menuitem_property_set_bool (child,
+                                           DBUSMENU_MENUITEM_PROP_ENABLED,
+                                           gtk_widget_get_sensitive (widget));
+    }
+  else if (pspec->name == g_intern_static_string ("label"))
+    {
+      dbusmenu_menuitem_property_set (child,
+                                      DBUSMENU_MENUITEM_PROP_LABEL,
+                                      gtk_menu_item_get_label (GTK_MENU_ITEM (widget)));
+    }
+  else if (pspec->name == g_intern_static_string ("visible"))
+    {
+      dbusmenu_menuitem_property_set_bool (child,
+                                           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 ("parent"))
+    {
+      /*
+        * We probably should have added a 'remove' method to the
+        * UbuntuMenuProxy early on, but it's late in the cycle now.
+        */
+      if (gtk_widget_get_parent (widget) == NULL)
+        {
+          g_signal_handlers_disconnect_by_func (widget,
+                                                G_CALLBACK (widget_notify_cb),
+                                                child);
+
+          DbusmenuMenuitem *parent = g_object_get_data (G_OBJECT (child), "dbusmenu-parent");
+
+          if (DBUSMENU_IS_MENUITEM (parent) && DBUSMENU_IS_MENUITEM (child))
+            {
+              dbusmenu_menuitem_child_delete (parent, child);
+            }
+        }
+    }
+}
+
+static gboolean
+should_show_image (GtkImage *image)
+{
+  GtkWidget *item;
+
+  item = gtk_widget_get_ancestor (GTK_WIDGET (image),
+                                  GTK_TYPE_IMAGE_MENU_ITEM);
+
+  if (item)
+    {
+      GtkSettings *settings;
+      gboolean gtk_menu_images;
+
+      settings = gtk_widget_get_settings (item);
+
+      g_object_get (settings, "gtk-menu-images", &gtk_menu_images, NULL);
+
+      if (gtk_menu_images)
+        return TRUE;
+
+      return gtk_image_menu_item_get_always_show_image (GTK_IMAGE_MENU_ITEM (item));
+    }
+
+  return FALSE;
+}
+

=== added file 'libdbusmenu-gtk/parser.h'
--- libdbusmenu-gtk/parser.h	1970-01-01 00:00:00 +0000
+++ libdbusmenu-gtk/parser.h	2011-01-27 15:48:01 +0000
@@ -0,0 +1,37 @@
+/*
+Parse to take a set of GTK Menus and turn them into something that can
+be sent over the wire.
+
+Copyright 2011 Canonical Ltd.
+
+Authors:
+    Ted Gould <[e-mail]>
+
+This program is free software: you can redistribute it and/or modify it 
+under the terms of either or both of the following licenses:
+
+1) the GNU Lesser General Public License version 3, as published by the 
+Free Software Foundation; and/or
+2) the GNU Lesser General Public License version 2.1, 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 applicable version of the GNU Lesser General Public 
+License for more details.
+
+You should have received a copy of both the GNU Lesser General Public 
+License version 3 and version 2.1 along with this program.  If not, see 
+<http://www.gnu.org/licenses/>
+*/
+
+#ifndef DBUSMENU_GTK_PARSER_H__
+#define DBUSMENU_GTK_PARSER_H__
+
+#include <libdbusmenu-glib/menuitem.h>
+#include <gtk/gtk.h>
+
+DbusmenuMenuitem * dbusmenu_gtk_parse_menu_structure (GtkWidget * widget);
+
+#endif /* DBUSMENU_GTK_PARSER_H__ */

=== modified file 'libdbusmenu-gtk/serializablemenuitem.c'
--- libdbusmenu-gtk/serializablemenuitem.c	2011-01-27 15:48:01 +0000
+++ libdbusmenu-gtk/serializablemenuitem.c	2011-01-27 15:48:01 +0000
@@ -166,7 +166,7 @@
 }
 
 /**
-	dbusmenu_gtk_serializable_menu_item_build_dbusmenu_menuitem:
+	dbusmenu_gtk_serializable_menu_item_build_menuitem:
 	@smi: #DbusmenuGtkSerializableMenuItem to build a #DbusmenuMenuitem mirroring
 
 	This function is for menu items that are instanciated from
@@ -179,7 +179,7 @@
 		set by this object.
 */
 DbusmenuMenuitem *
-dbusmenu_gtk_serializable_menu_item_build_dbusmenu_menuitem (DbusmenuGtkSerializableMenuItem * smi)
+dbusmenu_gtk_serializable_menu_item_build_menuitem (DbusmenuGtkSerializableMenuItem * smi)
 {
 	g_return_val_if_fail(DBUSMENU_IS_GTK_SERIALIZABLE_MENU_ITEM(smi), NULL);
 
@@ -207,7 +207,7 @@
 	DbusmenuGtkSerializableMenuItem * smi = DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM(g_object_new(th->type, NULL));
 	g_return_val_if_fail(smi != NULL, FALSE);
 
-	dbusmenu_gtk_serializable_menu_item_set_dbusmenu_menuitem(smi, newitem);
+	dbusmenu_gtk_serializable_menu_item_set_menuitem(smi, newitem);
 	dbusmenu_gtkclient_newitem_base(DBUSMENU_GTKCLIENT(client), newitem, GTK_MENU_ITEM(smi), parent);
 
 	return TRUE;
@@ -265,7 +265,7 @@
 }
 
 /**
-	dbusmenu_gtk_serializable_menu_item_set_dbusmenu_menuitem:
+	dbusmenu_gtk_serializable_menu_item_set_menuitem:
 	@smi: #DbusmenuGtkSerializableMenuItem to set the @DbusmenuGtkSerializableMenuItem::dbusmenu-menuitem of
 	@mi: Menuitem to get the properties from
 
@@ -276,7 +276,7 @@
 	pick up this property being set.
 */
 void
-dbusmenu_gtk_serializable_menu_item_set_dbusmenu_menuitem (DbusmenuGtkSerializableMenuItem * smi, DbusmenuMenuitem * mi)
+dbusmenu_gtk_serializable_menu_item_set_menuitem (DbusmenuGtkSerializableMenuItem * smi, DbusmenuMenuitem * mi)
 {
 	g_return_if_fail(DBUSMENU_IS_GTK_SERIALIZABLE_MENU_ITEM(smi));
 	g_return_if_fail(mi != NULL);

=== modified file 'libdbusmenu-gtk/serializablemenuitem.h'
--- libdbusmenu-gtk/serializablemenuitem.h	2011-01-27 15:48:01 +0000
+++ libdbusmenu-gtk/serializablemenuitem.h	2011-01-27 15:48:01 +0000
@@ -90,6 +90,13 @@
 	DbusmenuGtkSerializableMenuItem:
 	@parent: Inherit from GtkMenuItem
 	@priv: Blind structure of private variables
+
+	The Serializable Menuitem provides a way for menu items to be created
+	that can easily be picked up by the Dbusmenu GTK Parser.  This way
+	you can create custom items, and transport them across dbusmenu to
+	your menus or the appmenu on the other side of the bus.  By providing
+	these function the parser has enough information to both serialize, and
+	deserialize on the other side, the menuitem you've so carefully created.
 */
 struct _DbusmenuGtkSerializableMenuItem {
 	GtkMenuItem parent;
@@ -99,9 +106,9 @@
 
 GType dbusmenu_gtk_serializable_menu_item_get_type (void);
 
-DbusmenuMenuitem *  dbusmenu_gtk_serializable_menu_item_build_dbusmenu_menuitem (DbusmenuGtkSerializableMenuItem * smi);
+DbusmenuMenuitem *  dbusmenu_gtk_serializable_menu_item_build_menuitem (DbusmenuGtkSerializableMenuItem * smi);
 void                dbusmenu_gtk_serializable_menu_item_register_to_client (DbusmenuClient * client, GType item_type);
-void                dbusmenu_gtk_serializable_menu_item_set_dbusmenu_menuitem (DbusmenuGtkSerializableMenuItem * smi, DbusmenuMenuitem * mi);
+void                dbusmenu_gtk_serializable_menu_item_set_menuitem (DbusmenuGtkSerializableMenuItem * smi, DbusmenuMenuitem * mi);
 
 G_END_DECLS
 

=== modified file 'tests/Makefile.am'
--- tests/Makefile.am	2010-12-08 03:17:43 +0000
+++ tests/Makefile.am	2011-01-27 15:48:01 +0000
@@ -16,7 +16,8 @@
 	test-gtk-label \
 	test-gtk-shortcut \
 	test-gtk-reorder \
-	test-gtk-submenu
+	test-gtk-submenu \
+	test-gtk-parser-test
 
 check_PROGRAMS = \
 	glib-server-nomenu \
@@ -42,7 +43,8 @@
 	test-json-client \
 	test-json-server \
 	test-gtk-submenu-server \
-	test-gtk-submenu-client
+	test-gtk-submenu-client \
+	test-gtk-parser
 
 XVFB_RUN=". $(srcdir)/run-xvfb.sh"
 
@@ -384,6 +386,35 @@
 	$(DBUSMENUGLIB_LIBS) \
 	$(DBUSMENUGTK_LIBS)
 
+######################
+# Test GTK Parser
+######################
+
+GTK_PARSER_XML_REPORT = test-gtk-parser.xml
+
+test-gtk-parser-test: test-gtk-parser Makefile.am
+	@echo "#!/bin/bash" > $@
+	@echo $(XVFB_RUN) >> $@
+	@echo gtester --verbose -k -o $(GTK_PARSER_XML_REPORT) ./test-gtk-parser >> $@
+	@chmod +x $@
+
+test_gtk_parser_SOURCES = \
+	test-gtk-parser.c
+
+test_gtk_parser_CFLAGS = \
+	-I $(srcdir)/.. \
+	$(DBUSMENUGLIB_CFLAGS) \
+	$(DBUSMENUGTK_CFLAGS) \
+	-DSRCDIR="\"$(srcdir)\"" \
+	-Wall -Werror
+
+test_gtk_parser_LDADD = \
+	../libdbusmenu-glib/libdbusmenu-glib.la \
+	../libdbusmenu-gtk/libdbusmenu-gtk.la \
+	$(DBUSMENUGLIB_LIBS) \
+	$(DBUSMENUGTK_LIBS)
+
+
 #########################
 # Test GTK Label
 #########################

=== added file 'tests/test-gtk-parser.c'
--- tests/test-gtk-parser.c	1970-01-01 00:00:00 +0000
+++ tests/test-gtk-parser.c	2011-01-27 15:48:01 +0000
@@ -0,0 +1,115 @@
+/*
+Testing for the various objects just by themselves.
+
+Copyright 2011 Canonical Ltd.
+
+Authors:
+    Ted Gould <[e-mail]>
+
+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/>.
+*/
+
+#include <libdbusmenu-glib/menuitem-private.h>
+#include <libdbusmenu-gtk/parser.h>
+
+/* Just makes sure we can connect here people */
+static void
+test_parser_runs (void)
+{
+	GtkWidget * gmi = gtk_menu_item_new_with_label("Test Item");
+	g_assert(gmi != NULL);
+	DbusmenuMenuitem * mi = dbusmenu_gtk_parse_menu_structure(gmi);
+	g_assert(mi != NULL);
+
+	g_object_unref(gmi);
+	g_object_unref(mi);
+
+	return;
+}
+
+const gchar * test_parser_children_builder =
+"<?xml version=\"1.0\"?>"
+"<interface>"
+"<requires lib=\"gtk+\" version=\"2.16\"/>"
+/* Start menu bar */
+"<object class=\"GtkMenuBar\" id=\"menubar\"><property name=\"visible\">True</property>"
+/* Child 1 */
+"<child><object class=\"GtkMenuItem\" id=\"child_one\"><property name=\"visible\">True</property><property name=\"label\">Child One</property></object></child>"
+/* Child 2 */
+"<child><object class=\"GtkMenuItem\" id=\"child_two\"><property name=\"visible\">True</property><property name=\"label\">Child Two</property></object></child>"
+/* Child 3 */
+"<child><object class=\"GtkMenuItem\" id=\"child_three\"><property name=\"visible\">True</property><property name=\"label\">Child Three</property></object></child>"
+/* Child 4 */
+"<child><object class=\"GtkMenuItem\" id=\"child_four\"><property name=\"visible\">True</property><property name=\"label\">Child Four</property></object></child>"
+/* Stop menubar */
+"</object>"
+"</interface>";
+
+/* Ensure the parser can find children */
+static void
+test_parser_children (void) {
+	GtkBuilder * builder = gtk_builder_new();
+	g_assert(builder != NULL);
+
+	GError * error = NULL;
+	gtk_builder_add_from_string(builder, test_parser_children_builder, -1, &error);
+	if (error != NULL) {
+		g_error("Unable to parse UI definition: %s", error->message);
+		g_error_free(error);
+		error = NULL;
+	}
+
+	GtkWidget * menu = GTK_WIDGET(gtk_builder_get_object(builder, "menubar"));
+	g_assert(menu != NULL);
+
+	DbusmenuMenuitem * mi = dbusmenu_gtk_parse_menu_structure(menu);
+	g_assert(mi != NULL);
+
+/*
+	GPtrArray * xmlarray = g_ptr_array_new();
+	dbusmenu_menuitem_buildxml(mi, xmlarray);
+	g_debug("XML: %s", g_strjoinv("", (gchar **)xmlarray->pdata));
+*/
+
+	GList * children = dbusmenu_menuitem_get_children(mi);
+	g_assert(children != NULL);
+
+	g_assert(g_list_length(children) == 4);
+
+	g_object_unref(mi);
+	g_object_unref(menu);
+
+	return;
+}
+
+/* Build the test suite */
+static void
+test_gtk_parser_suite (void)
+{
+	g_test_add_func ("/dbusmenu/gtk/parser/base",          test_parser_runs);
+	g_test_add_func ("/dbusmenu/gtk/parser/children",      test_parser_children);
+	return;
+}
+
+gint
+main (gint argc, gchar * argv[])
+{
+	gtk_init(&argc, &argv);
+	g_test_init(&argc, &argv, NULL);
+
+	/* Test suites */
+	test_gtk_parser_suite();
+
+
+	return g_test_run ();
+}