Merge lp:~larsu/indicator-appmenu/lp1042824 into lp:indicator-appmenu/12.10

[Lars Karlitski]

[lp:~larsu/indicator-appmenu/lp1042824]

212. By Lars Karlitski on 2012-09-26

hudmenumodelcollector: only install a single qdata models

213. By Lars Karlitski on 2012-09-27

hudmenumodelcollector: introduce explicit application mode

Previously, indicator actions prefixed with "win." would be ignored.

214. By Lars Karlitski on 2012-09-27

hudmenumodelcollector: get rid of conditional free

215. By Lars Karlitski on 2012-09-27

hudmenumodelcollector: move context and namespace logic into hud_item_context_new

216. By Allison Karlitskaya on 2012-09-30

Clean up HudMenuModelCollector a bit

Mostly, add some functionality to HudMenuModelContext (formerly
HudItemContext) and HudModelItem in order to reduce the growing
complexity of hud_menu_model_context_model_changed().

Add some comments.

217. By Allison Karlitskaya on 2012-09-30

HudMenuModelCollector: store the prefix in the instance

When the menu is refreshed (which can happen any time an item is
removed) the menus are rebuilt and we need to know the prefix in order
to handle that.

218. By Allison Karlitskaya on 2012-09-30

HudMenuModelCollector: untangle code a bit (no functional changes)

Move some functions around so that all of HudMenuModelContext is grouped
together, at the top.

219. By Lars Karlitski on 2012-10-01

hudmenumodelcollector: call add_model after the collector is initialized

220. By Lars Karlitski on 2012-10-01

hudmenumodelcollector: don't show underscores in the hud

[Allison Karlitskaya (desrt)]

review: Approve

=== modified file 'src/hudindicatorsource.c'
--- src/hudindicatorsource.c	2012-03-30 13:32:40 +0000
+++ src/hudindicatorsource.c	2012-10-01 14:06:35 +0000
@@ -24,6 +24,7 @@
 
 #include "hudsettings.h"
 #include "huddbusmenucollector.h"
+#include "hudmenumodelcollector.h"
 #include "hudsource.h"
 
 /**
@@ -49,6 +50,7 @@
   const gchar *indicator_name;
   const gchar *user_visible_name;
   const gchar *icon;
+  gboolean     uses_gmenumodel;
 } IndicatorInfo;
 
 static const IndicatorInfo indicator_info[] = {
@@ -85,7 +87,8 @@
     .dbus_menu_path    = "/com/canonical/indicator/messages/menu",
     .indicator_name    = "indicator-messages",
     .user_visible_name = N_("Messages"),
-    .icon              = "indicator-messages"
+    .icon              = "indicator-messages",
+    .uses_gmenumodel   = TRUE
   }
 };
 
@@ -180,15 +183,34 @@
                                     gpointer         user_data)
 {
   HudIndicatorSourceIndicator *indicator = user_data;
-  HudDbusmenuCollector *collector;
-
-  collector = hud_dbusmenu_collector_new_for_endpoint (indicator->info->indicator_name,
-                                                       _(indicator->info->user_visible_name),
-                                                       indicator->info->icon,
-                                                       hud_settings.indicator_penalty,
-                                                       name_owner, indicator->info->dbus_menu_path);
-  g_signal_connect (collector, "changed", G_CALLBACK (hud_indicator_source_collector_changed), indicator);
-  indicator->collector = HUD_SOURCE (collector);
+
+  if (indicator->info->uses_gmenumodel)
+    {
+      HudMenuModelCollector *collector;
+
+      collector = hud_menu_model_collector_new_for_endpoint (indicator->info->indicator_name,
+                                                             _(indicator->info->user_visible_name),
+                                                             indicator->info->icon,
+                                                             hud_settings.indicator_penalty,
+                                                             name_owner,
+                                                             indicator->info->dbus_menu_path);
+
+      indicator->collector = HUD_SOURCE (collector);
+    }
+  else
+    {
+      HudDbusmenuCollector *collector;
+
+      collector = hud_dbusmenu_collector_new_for_endpoint (indicator->info->indicator_name,
+                                                           _(indicator->info->user_visible_name),
+                                                           indicator->info->icon,
+                                                           hud_settings.indicator_penalty,
+                                                           name_owner, indicator->info->dbus_menu_path);
+      indicator->collector = HUD_SOURCE (collector);
+    }
+
+  g_signal_connect (indicator->collector, "changed",
+                    G_CALLBACK (hud_indicator_source_collector_changed), indicator);
 
   /* Set initial use count on new indicator if query is active. */
   if (indicator->source->use_count)

=== modified file 'src/hudmenumodelcollector.c'
--- src/hudmenumodelcollector.c	2012-03-30 13:32:40 +0000
+++ src/hudmenumodelcollector.c	2012-10-01 14:06:35 +0000
@@ -47,6 +47,15 @@
  * This is an opaque structure type.
  **/
 
+typedef struct _HudMenuModelContext HudMenuModelContext;
+
+struct _HudMenuModelContext
+{
+  HudStringList *tokens;
+  gchar *action_namespace;
+  gint ref_count;
+};
+
 struct _HudMenuModelCollector
 {
   GObject parent_instance;
@@ -59,10 +68,14 @@
   GDBusActionGroup *application;
   GDBusActionGroup *window;
 
+  gboolean is_application;
+
+  gchar *prefix;
   gchar *desktop_file;
   gchar *icon;
   GPtrArray *items;
   gint use_count;
+  guint penalty;
 };
 
 typedef struct
@@ -76,6 +89,71 @@
 
 typedef HudItemClass HudModelItemClass;
 
+static gchar *
+hud_menu_model_context_get_action_name (HudMenuModelContext *context,
+                                        const gchar         *action_name)
+{
+  if (context && context->action_namespace)
+    /* Note: this will (intentionally) work if action_name is NULL */
+    return g_strjoin (".", context->action_namespace, action_name, NULL);
+  else
+    return g_strdup (action_name);
+}
+
+static HudStringList *
+hud_menu_model_context_get_label (HudMenuModelContext *context,
+                                  const gchar         *label)
+{
+  HudStringList *parent_tokens = context ? context->tokens : NULL;
+
+  if (label)
+    return hud_string_list_cons_label (label, parent_tokens);
+  else
+    return hud_string_list_ref (parent_tokens);
+}
+
+static HudMenuModelContext *
+hud_menu_model_context_ref (HudMenuModelContext *context)
+{
+  if (context)
+    g_atomic_int_inc (&context->ref_count);
+
+  return context;
+}
+
+static void
+hud_menu_model_context_unref (HudMenuModelContext *context)
+{
+  if (context && g_atomic_int_dec_and_test (&context->ref_count))
+    {
+      hud_string_list_unref (context->tokens);
+      g_free (context->action_namespace);
+      g_slice_free (HudMenuModelContext, context);
+    }
+}
+
+static HudMenuModelContext *
+hud_menu_model_context_new (HudMenuModelContext *parent,
+                            const gchar         *namespace,
+                            const gchar         *label)
+{
+  HudMenuModelContext *context;
+
+  /* If we would be an unmodified copy of the parent, just take a ref */
+  if (!namespace && !label)
+    return hud_menu_model_context_ref (parent);
+
+  context = g_slice_new (HudMenuModelContext);
+  context->action_namespace = hud_menu_model_context_get_action_name (parent, namespace);
+  context->tokens = hud_menu_model_context_get_label (parent, label);
+  context->ref_count = 1;
+
+  return context;
+}
+
+
+
+
 G_DEFINE_TYPE (HudModelItem, hud_model_item, HUD_TYPE_ITEM)
 
 static void
@@ -118,20 +196,58 @@
 }
 
 static HudItem *
-hud_model_item_new (HudStringList      *tokens,
-                    const gchar        *desktop_file,
-                    const gchar        *icon,
-                    GRemoteActionGroup *action_group,
-                    const gchar        *action_name,
-                    GVariant           *target)
+hud_model_item_new (HudMenuModelCollector *collector,
+                    HudMenuModelContext   *context,
+                    const gchar           *label,
+                    const gchar           *action_name,
+                    GVariant              *target)
 {
   HudModelItem *item;
-
-  item = hud_item_construct (hud_model_item_get_type (), tokens, desktop_file, icon, TRUE);
-  item->group = g_object_ref (action_group);
-  item->action_name = g_strdup (action_name);
+  const gchar *stripped_action_name;
+  gchar *full_action_name;
+  GDBusActionGroup *group = NULL;
+  HudStringList *full_label;
+
+  full_action_name = hud_menu_model_context_get_action_name (context, action_name);
+
+  if (collector->is_application)
+    {
+      /* For applications we support "app." and "win." actions and
+       * deliver them to the application or the window, with the prefix
+       * removed.
+       */
+      if (g_str_has_prefix (full_action_name, "app."))
+        group = collector->application;
+      else if (g_str_has_prefix (full_action_name, "win."))
+        group = collector->window;
+
+      stripped_action_name = full_action_name + 4;
+    }
+  else
+    {
+      /* For indicators, we deliver directly to the (one) action group
+       * that we were given the object path for at construction.
+       */
+      stripped_action_name = full_action_name;
+      group = collector->application;
+    }
+
+  if (!group)
+    {
+      g_free (full_action_name);
+      return NULL;
+    }
+
+  full_label = hud_menu_model_context_get_label (context, label);
+
+  item = hud_item_construct (hud_model_item_get_type (), full_label, collector->desktop_file, collector->icon, TRUE);
+  item->group = g_object_ref (group);
+  item->action_name = g_strdup (stripped_action_name);
   item->target = target ? g_variant_ref_sink (target) : NULL;
 
+  hud_string_list_unref (full_label);
+  g_free (full_action_name);
+
   return HUD_ITEM (item);
 }
 
@@ -151,7 +267,10 @@
  * though.
  */
 static void hud_menu_model_collector_add_model  (HudMenuModelCollector *collector,
-                                                 GMenuModel            *model);
+                                                 GMenuModel            *model,
+                                                 HudMenuModelContext   *parent_context,
+                                                 const gchar           *action_namespace,
+                                                 const gchar           *label);
 static void hud_menu_model_collector_disconnect (gpointer               data,
                                                  gpointer               user_data);
 
@@ -166,9 +285,9 @@
   collector->models = NULL;
 
   if (collector->app_menu)
-    hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->app_menu));
+    hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->app_menu), NULL, NULL, collector->prefix);
   if (collector->menubar)
-    hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->menubar));
+    hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->menubar), NULL, NULL, collector->prefix);
 
   g_slist_foreach (free_list, hud_menu_model_collector_disconnect, collector);
   g_slist_free_full (free_list, g_object_unref);
@@ -176,6 +295,17 @@
   return G_SOURCE_REMOVE;
 }
 
+static GQuark
+hud_menu_model_collector_context_quark ()
+{
+  static GQuark context_quark;
+
+  if (!context_quark)
+    context_quark = g_quark_from_string ("menu item context");
+
+  return context_quark;
+}
+
 static void
 hud_menu_model_collector_model_changed (GMenuModel *model,
                                         gint        position,
@@ -184,8 +314,7 @@
                                         gpointer    user_data)
 {
   HudMenuModelCollector *collector = user_data;
-  static GQuark context_quark;
-  HudStringList *context;
+  HudMenuModelContext *context;
   gboolean changed;
   gint i;
 
@@ -205,77 +334,39 @@
       return;
     }
 
-  if (!context_quark)
-    context_quark = g_quark_from_string ("menu item context");
-
-  /* The 'context' is the list of strings that got us up to where we are
-   * now, like "View > Toolbars".  We hang this on the GMenuModel with
-   * qdata.
-   *
-   * Strictly speaking, GMenuModel structures are DAGs, but we more or
-   * less assume that they are trees here and replace the data
-   * unconditionally when we visit it the second time (which will be
-   * more or less never, because really, a menu is a tree).
-   */
-  context = g_object_get_qdata (G_OBJECT (model), context_quark);
+  context = g_object_get_qdata (G_OBJECT (model), hud_menu_model_collector_context_quark ());
 
   changed = FALSE;
   for (i = position; i < position + added; i++)
     {
-      HudStringList *tokens;
       GMenuModel *link;
-      gchar *value;
+      gchar *label = NULL;
+      gchar *action_namespace = NULL;
+      gchar *action = NULL;
 
-      /* If this item has a label then we add it onto the context to get
-       * our 'tokens'.  For example, if context is 'File' then we will
-       * have 'File > New'.
-       *
-       * If there is no label (which only really makes sense for
-       * sections) then we just reuse the existing context by taking a
-       * ref to it.
-       *
-       * Either way, we need to free it at the end of the loop.
-       */
-      if (g_menu_model_get_item_attribute (model, i, G_MENU_ATTRIBUTE_LABEL, "s", &value))
-        {
-          tokens = hud_string_list_cons_label (value, context);
-          g_free (value);
-        }
-      else
-        tokens = hud_string_list_ref (context);
+      g_menu_model_get_item_attribute (model, i, "action-namespace", "s", &action_namespace);
+      g_menu_model_get_item_attribute (model, i, G_MENU_ATTRIBUTE_ACTION, "s", &action);
+      g_menu_model_get_item_attribute (model, i, G_MENU_ATTRIBUTE_LABEL, "s", &label);
 
       /* Check if this is an action.  Here's where we may end up
        * creating a HudItem.
        */
-      if (g_menu_model_get_item_attribute (model, i, G_MENU_ATTRIBUTE_ACTION, "s", &value))
+      if (action && label)
         {
-          GDBusActionGroup *action_group = NULL;
-
-          /* It's an action, so add it. */
-          if (g_str_has_prefix (value, "app."))
-            action_group = collector->application;
-          else if (g_str_has_prefix (value, "win."))
-            action_group = collector->window;
-
-          if (action_group)
-            {
-              GVariant *target;
-              HudItem *item;
-
-              target = g_menu_model_get_item_attribute_value (model, i, G_MENU_ATTRIBUTE_TARGET, NULL);
-
-              item = hud_model_item_new (tokens, collector->desktop_file, collector->icon,
-                                         G_REMOTE_ACTION_GROUP (action_group),
-                                         value + 4, target);
-              g_ptr_array_add (collector->items, item);
-
-              if (target)
-                g_variant_unref (target);
-
-              changed = TRUE;
-            }
-
-          g_free (value);
+          GVariant *target;
+          HudItem *item;
+
+          target = g_menu_model_get_item_attribute_value (model, i, G_MENU_ATTRIBUTE_TARGET, NULL);
+
+          item = hud_model_item_new (collector, context, label, action, target);
+
+          if (item)
+            g_ptr_array_add (collector->items, item);
+
+          if (target)
+            g_variant_unref (target);
+
+          changed = TRUE;
         }
 
       /* For 'section' and 'submenu' links, we should recurse.  This is
@@ -284,24 +375,19 @@
        */
       if ((link = g_menu_model_get_item_link (model, i, G_MENU_LINK_SECTION)))
         {
-          g_object_set_qdata_full (G_OBJECT (link), context_quark,
-                                   hud_string_list_ref (tokens),
-                                   (GDestroyNotify) hud_string_list_unref);
-          hud_menu_model_collector_add_model (collector, link);
+          hud_menu_model_collector_add_model (collector, link, context, action_namespace, label);
           g_object_unref (link);
         }
 
       if ((link = g_menu_model_get_item_link (model, i, G_MENU_LINK_SUBMENU)))
         {
-          /* for submenus, we add the submenu label to the context */
-          g_object_set_qdata_full (G_OBJECT (link), context_quark,
-                                   hud_string_list_ref (tokens),
-                                   (GDestroyNotify) hud_string_list_unref);
-          hud_menu_model_collector_add_model (collector, link);
+          hud_menu_model_collector_add_model (collector, link, context, action_namespace, label);
           g_object_unref (link);
         }
 
-      hud_string_list_unref (tokens);
+      g_free (action_namespace);
+      g_free (action);
+      g_free (label);
     }
 
   if (changed)
@@ -309,17 +395,33 @@
 }
 
 static void
-hud_menu_model_collector_add_model (HudMenuModelCollector *search_data,
-                                    GMenuModel            *model)
+hud_menu_model_collector_add_model (HudMenuModelCollector *collector,
+                                    GMenuModel            *model,
+                                    HudMenuModelContext   *parent_context,
+                                    const gchar           *action_namespace,
+                                    const gchar           *label)
 {
   gint n_items;
 
-  g_signal_connect (model, "items-changed", G_CALLBACK (hud_menu_model_collector_model_changed), search_data);
-  search_data->models = g_slist_prepend (search_data->models, g_object_ref (model));
+  g_signal_connect (model, "items-changed", G_CALLBACK (hud_menu_model_collector_model_changed), collector);
+  collector->models = g_slist_prepend (collector->models, g_object_ref (model));
+
+  /* The tokens in 'context' are the list of strings that got us up to
+   * where we are now, like "View > Toolbars".
+   *
+   * Strictly speaking, GMenuModel structures are DAGs, but we more or
+   * less assume that they are trees here and replace the data
+   * unconditionally when we visit it the second time (which will be
+   * more or less never, because really, a menu is a tree).
+   */
+  g_object_set_qdata_full (G_OBJECT (model),
+                           hud_menu_model_collector_context_quark (),
+                           hud_menu_model_context_new (parent_context, action_namespace, label),
+                           (GDestroyNotify) hud_menu_model_context_unref);
 
   n_items = g_menu_model_get_n_items (model);
   if (n_items > 0)
-    hud_menu_model_collector_model_changed (model, 0, 0, n_items, search_data);
+    hud_menu_model_collector_model_changed (model, 0, 0, n_items, collector);
 }
 
 static void
@@ -362,7 +464,7 @@
       HudItem *item;
 
       item = g_ptr_array_index (items, i);
-      result = hud_result_get_if_matched (item, search_string, 0);
+      result = hud_result_get_if_matched (item, search_string, collector->penalty);
       if (result)
         g_ptr_array_add (results_array, result);
     }
@@ -381,6 +483,7 @@
   g_clear_object (&collector->application);
   g_clear_object (&collector->window);
 
+  g_free (collector->prefix);
   g_free (collector->desktop_file);
   g_free (collector->icon);
 
@@ -454,13 +557,13 @@
   if (app_menu_object_path)
     {
       collector->app_menu = g_dbus_menu_model_get (session, unique_bus_name, app_menu_object_path);
-      hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->app_menu));
+      hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->app_menu), NULL, NULL, NULL);
     }
 
   if (menubar_object_path)
     {
       collector->menubar = g_dbus_menu_model_get (session, unique_bus_name, menubar_object_path);
-      hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->menubar));
+      hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->menubar), NULL, NULL, NULL);
     }
 
   if (application_object_path)
@@ -469,6 +572,7 @@
   if (window_object_path)
     collector->window = g_dbus_action_group_get (session, unique_bus_name, window_object_path);
 
+  collector->is_application = TRUE;
   collector->desktop_file = g_strdup (desktop_file);
   collector->icon = g_strdup (icon);
 
@@ -486,3 +590,57 @@
 
   return collector;
 }
+
+/**
+ * hud_menu_model_collector_new_for_endpoint:
+ * @application_id: a unique identifier for the application
+ * @prefix: the title to prefix to all items
+ * @icon: the icon for the appliction
+ * @penalty: the penalty to apply to all results
+ * @bus_name: a D-Bus bus name
+ * @object_path: an object path at the destination given by @bus_name
+ *
+ * Creates a new #HudMenuModelCollector for the specified endpoint.
+ *
+ * This call is intended to be used for indicators.
+ *
+ * If @prefix is non-%NULL (which, for indicators, it ought to be), then
+ * it is prefixed to every item created by the collector.
+ *
+ * If @penalty is non-zero then all results returned from the collector
+ * have their distance increased by a percentage equal to the penalty.
+ * This allows items from indicators to score lower than they would
+ * otherwise.
+ *
+ * Returns: a new #HudMenuModelCollector
+ */
+HudMenuModelCollector *
+hud_menu_model_collector_new_for_endpoint (const gchar *application_id,
+                                           const gchar *prefix,
+                                           const gchar *icon,
+                                           guint        penalty,
+                                           const gchar *bus_name,
+                                           const gchar *object_path)
+{
+  HudMenuModelCollector *collector;
+  GDBusConnection *session;
+
+  collector = g_object_new (HUD_TYPE_MENU_MODEL_COLLECTOR, NULL);
+
+  session = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, NULL);
+
+  collector->app_menu = g_dbus_menu_model_get (session, bus_name, object_path);
+  collector->application = g_dbus_action_group_get (session, bus_name, object_path);
+
+  collector->is_application = FALSE;
+  collector->prefix = g_strdup (prefix);
+  collector->desktop_file = g_strdup (application_id);
+  collector->icon = g_strdup (icon);
+  collector->penalty = penalty;
+
+  hud_menu_model_collector_add_model (collector, G_MENU_MODEL (collector->app_menu), NULL, NULL, prefix);
+
+  g_object_unref (session);
+
+  return collector;
+}

=== modified file 'src/hudmenumodelcollector.h'
--- src/hudmenumodelcollector.h	2012-03-23 15:35:01 +0000
+++ src/hudmenumodelcollector.h	2012-10-01 14:06:35 +0000
@@ -36,4 +36,11 @@
                                                                          const gchar *desktop_file,
                                                                          const gchar *icon);
 
+HudMenuModelCollector * hud_menu_model_collector_new_for_endpoint       (const gchar *application_id,
+                                                                         const gchar *prefix,
+                                                                         const gchar *icon,
+                                                                         guint        penalty,
+                                                                         const gchar *bus_name,
+                                                                         const gchar *object_path);
+
 #endif /* __HUD_MENU_MODEL_COLLECTOR_H__ */