Merge lp:~desrt/indicator-appmenu/hud-rewrite-wip into lp:indicator-appmenu/0.4

[Allison Karlitskaya]

Add support for XUL be emitting "Opened" signals when a query is active.

Fix a few leaks as well.

[lp:~desrt/indicator-appmenu/hud-rewrite-wip]

227. By Allison Karlitskaya on 2012-03-15

hud-service: HudQuery: add some logging

228. By Allison Karlitskaya on 2012-03-15

hud-service: HudQuery: don't leak queries

Change the strategy for dealing with the HudQuery being unreffed in the
middle of a pending update in order to avoid leaking queries.

229. By Allison Karlitskaya on 2012-03-15

hud-service: Give OPENED event for menuitems that change into submenus while a query is in effect

230. By Allison Karlitskaya on 2012-03-15

Add some paranoid checking

We don't want dbusmenu delivering signals to us while we're iterating
our hashtable, so add an assert about that. It doesn't do so now, but
this will make it easier to detect the problem if it should start doing
so in the future.

231. By Allison Karlitskaya on 2012-03-15

hud-service: on startup, set the focus window as active

We were waiting for the first active-window-changed signal before we
started tracking window menus. Do it as soon as we start, using the
currently-active-window.

232. By Allison Karlitskaya on 2012-03-15

add a "debug" source for testing the update signal

we could use this for other testing purposes later on as well

[Charles Kerr (charlesk)]

Could you fix the text conflict?

review: Needs Fixing

[Charles Kerr (charlesk)]

* About the text conflict, we could use <glib/gi18n.h> instead of locale.h and libintl.h

* In hud_indicator_source_name_vanished(), I think you meant to invoke hud_source_unuse()?

* I think the answer is probably no, but wanted to ask if hud_window_source's dispose or finalize need to do anything about active_collector or its "changed" signal that hud_window_source connected to.

[Allison Karlitskaya (desrt)]

> * About the text conflict, we could use <glib/gi18n.h> instead of locale.h and
> libintl.h

How do I resolve conflicts that only exist in merge requests? Do I have to merge up my branch? I guess that's what I'll try...

The intl headers are from Seb's earlier unrelated patch -- they only conflict because I also added a header at the same place. He's not using _() so the glib header is not really required...

> * In hud_indicator_source_name_vanished(), I think you meant to invoke
> hud_source_unuse()?

Yes! Good catch. Thanks :)

> * I think the answer is probably no, but wanted to ask if hud_window_source's
> dispose or finalize need to do anything about active_collector or its
> "changed" signal that hud_window_source connected to.

Strictly speaking, the answer is that I should be doing this. At the same time, though, it's not a bug, because the window source finalizer is never run (since the hud service runs forever and quits by exiting, without freeing the sources). I was already planning to do a bit of a finalizer cleanup so that we could add support for freeing things on exit (to increase valgrindability) so I'll make this change now as well. Thanks.

[Allison Karlitskaya (desrt)]

Ah. Sorry. Haven't had my coffee yet.

The signal connection does _not_ need to be removed from finalize. If you use g_signal_connect_object() then the signal handler won't fire after the object that you connected it to is disposed. There is an ancient bug in glib where you lose a bit of memory when this happens but .. well, that's a bug in glib (and I hope we fix it some day).

The memory loss is not a leak -- you gain it back again when the object emitting the signal is destroyed.

[lp:~desrt/indicator-appmenu/hud-rewrite-wip]

233. By Allison Karlitskaya on 2012-03-16

hud-service: indicatorsource: on indicator disappearance *unuse* the dbusmenu instead of using it extra

Probably this has absolutely zero impact since the source is going to be
destroyed one line later anyway, but it reads really badly (and strictly
speaking, the menus should be closed if they've been opened).

234. By Allison Karlitskaya on 2012-03-16

merge trunk

235. By Allison Karlitskaya on 2012-03-16

hud-service: add some debug output to the dbus front-end (to help debug unity issues)

236. By Allison Karlitskaya on 2012-03-16

add hud-gtk to the build system

This introduces a mandatory build-time dependency on Vala 0.15 and gtk3 (both needed for GtkApplication).

237. By Allison Karlitskaya on 2012-03-16

hud-service: delay dropping of query by 1 second

Unity sends a 'CloseQuery' followed immediately by a 'StartQuery' on
each keystroke in the search field. This results in a bunch of extra
dbusmenu messages being sent as the use count drops briefly to 0 only to
go immediately back to 1.

We can prevent that by delaying the destruction of the query.

This decreases the number of dbus messages resulting from a short search
by a factor of about 4 (on a number that measures in the 100s).

[Charles Kerr (charlesk)]

review: Approve

[lp:~desrt/indicator-appmenu/hud-rewrite-wip]

238. By Allison Karlitskaya on 2012-03-17

hud-service: dbusmenu collector: hold a reference on the root menu item

In the root-changed case, the DbusmenuClient drops the reference on the
root item before alerting us that it has changed. We then go iterating
over our own (now-dead) copy of that item in order to remove it from our
internal hashtable.

Keep our own reference to it to ensure that this is safe.

This could explain lp:955937.

=== modified file 'configure.ac'
--- configure.ac	2012-03-14 19:39:48 +0000
+++ configure.ac	2012-03-17 16:16:19 +0000
@@ -20,6 +20,7 @@
 # Check for programs
 AC_PROG_CC
 AM_PROG_CC_C_O
+AM_PROG_VALAC([0.15.2])
 
 # Initialize libtool
 LT_PREREQ([2.2.6])
@@ -86,6 +87,8 @@
       [AC_MSG_FAILURE([Value for --with-gtk was neither 2 nor 3])]
 )
 
+PKG_CHECK_MODULES(gtk, gtk+-3.0 >= $GTK3_REQUIRED_VERSION)
+
 AC_SUBST(INDICATOR_CFLAGS)
 AC_SUBST(INDICATOR_LIBS)
 

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2012-03-05 04:51:36 +0000
+++ src/Makefile.am	2012-03-17 16:16:19 +0000
@@ -6,7 +6,8 @@
 
 bin_PROGRAMS = \
 	hud-dump-application \
-	hud-verify-app-info
+	hud-verify-app-info \
+	hud-gtk
 
 bin_SCRIPTS = \
 	hud-list-applications
@@ -104,6 +105,8 @@
 	hudindicatorsource.c	\
 	hudwindowsource.h	\
 	hudwindowsource.c	\
+	huddebugsource.h	\
+	huddebugsource.c	\
 	hudsourcelist.h		\
 	hudsourcelist.c		\
 	hudsource.h		\
@@ -177,6 +180,25 @@
 	$(hud_cli_SOURCES)
 endif
 
+####################
+# hud-gtk
+####################
+
+hudgtkdatadir = $(datadir)/hud-gtk
+hudgtkdata_DATA = hud-gtk.ui
+EXTRA_DIST += hud-gtk.ui
+
+hud_gtk_SOURCES = \
+	hud-gtk.vala
+
+hud_gtk_VALAFLAGS = --pkg gtk+-3.0
+hud_gtk_CFLAGS = \
+	-DHUD_GTK_DATADIR=\""$(hudgtkdatadir)"\"	\
+	$(gtk_CFLAGS)
+
+hud_gtk_LDADD = \
+	$(gtk_LIBS)
+
 #######################
 # HUD Dump Application
 #######################

=== modified file 'src/hud-gtk.vala'
--- src/hud-gtk.vala	2012-02-28 15:22:00 +0000
+++ src/hud-gtk.vala	2012-03-17 16:16:19 +0000
@@ -1,3 +1,5 @@
+extern const string HUD_GTK_DATADIR;
+
 namespace HudGtk {
 	public class CellRendererVariant : Gtk.CellRendererText {
 		public Variant value {
@@ -85,7 +87,7 @@
 			try {
 				new CellRendererVariant ();
 				session = Bus.get_sync (BusType.SESSION, null);
-				builder.add_from_file ("hud-gtk.ui");
+				builder.add_from_file (HUD_GTK_DATADIR + "/hud-gtk.ui");
 			} catch (Error e) {
 				error (e.message);
 			}

=== modified file 'src/hud-service.c'
--- src/hud-service.c	2012-03-15 18:34:44 +0000
+++ src/hud-service.c	2012-03-17 16:16:19 +0000
@@ -16,16 +16,20 @@
  * Author: Ryan Lortie <[e-mail]>
  */
 
+#define G_LOG_DOMAIN "hud-service"
+
 #include "config.h"
 
 #include <glib.h>
 #include <gio/gio.h>
+#include <stdlib.h>
 #include <locale.h>
 #include <libintl.h>
 
 #include "hudappindicatorsource.h"
 #include "hudindicatorsource.h"
 #include "hudwindowsource.h"
+#include "huddebugsource.h"
 #include "hudsourcelist.h"
 #include "hudsettings.h"
 
@@ -79,6 +83,8 @@
 {
   GDBusConnection *connection = user_data;
 
+  g_debug ("emit UpdatedQuery signal");
+
   g_dbus_connection_emit_signal (connection, NULL, DBUS_PATH,
                                  DBUS_IFACE, "UpdatedQuery",
                                  describe_query (query), NULL);
@@ -99,6 +105,14 @@
   return g_variant_ref_sink (platform_data);
 }
 
+static gboolean
+drop_query_timeout (gpointer user_data)
+{
+  g_object_unref (user_data);
+
+  return G_SOURCE_REMOVE;
+}
+
 static void
 bus_method (GDBusConnection       *connection,
             const gchar           *sender,
@@ -118,6 +132,7 @@
       HudQuery *query;
 
       g_variant_get (parameters, "(&si)", &search_string, &num_results);
+      g_debug ("'StartQuery' from %s: '%s', %d", sender, search_string, num_results);
       query = hud_query_new (source, search_string, num_results);
       g_signal_connect_object (query, "changed", G_CALLBACK (query_changed), connection, 0);
       g_dbus_method_invocation_return_value (invocation, describe_query (query));
@@ -128,21 +143,26 @@
     {
       GVariant *platform_data;
       GVariant *item_key;
+      guint64 key_value;
       HudItem *item;
 
       g_variant_get_child (parameters, 0, "v", &item_key);
 
       if (!g_variant_is_of_type (item_key, G_VARIANT_TYPE_UINT64))
         {
+          g_debug ("'ExecuteQuery' from %s: incorrect item key (not uint64)", sender);
           g_dbus_method_invocation_return_error (invocation, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
                                                  "item key has invalid format");
           g_variant_unref (item_key);
           return;
         }
 
-      item = hud_item_lookup (g_variant_get_uint64 (item_key));
+      key_value = g_variant_get_uint64 (item_key);
       g_variant_unref (item_key);
 
+      item = hud_item_lookup (key_value);
+      g_debug ("'ExecuteQuery' from %s, item #%"G_GUINT64_FORMAT": %p", sender, key_value, item);
+
       if (item == NULL)
         {
           g_dbus_method_invocation_return_error (invocation, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
@@ -162,6 +182,8 @@
       GVariant *query_key;
       HudQuery *query;
 
+      g_debug ("Got 'CloseQuery' from %s", sender);
+
       g_variant_get (parameters, "(v)", &query_key);
       query = hud_query_lookup (query_key);
       g_variant_unref (query_key);
@@ -169,6 +191,16 @@
       if (query != NULL)
         {
           g_signal_handlers_disconnect_by_func (query, query_changed, connection);
+          /* Unity does 'CloseQuery' immediately followed by
+           * 'StartQuery' on every keystroke.  Delay the destruction of
+           * the query for a moment just in case a 'StartQuery' is on the
+           * way.
+           *
+           * That way we can avoid allowing the use count to drop to
+           * zero only to be increased again back to 1.  This prevents a
+           * bunch of dbusmenu "closed"/"opened" calls being sent.
+           */
+          g_timeout_add (1000, drop_query_timeout, g_object_ref (query));
           hud_query_close (query);
         }
 
@@ -209,6 +241,8 @@
   };
   GError *error = NULL;
 
+  g_debug ("Bus acquired (guid %s)", g_dbus_connection_get_guid (connection));
+
   if (!g_dbus_connection_register_object (connection, DBUS_PATH, get_iface_info (), &vtable, source, NULL, &error))
     {
       g_warning ("Unable to register path '"DBUS_PATH"': %s", error->message);
@@ -218,6 +252,14 @@
 }
 
 static void
+name_acquired_cb (GDBusConnection *connection,
+                  const gchar     *name,
+                  gpointer         user_data)
+{
+  g_debug ("Acquired bus name '%s'", name);
+}
+
+static void
 name_lost_cb (GDBusConnection *connection,
               const gchar     *name,
               gpointer         user_data)
@@ -262,8 +304,17 @@
     g_object_unref (source);
   }
 
+  if (getenv ("HUD_DEBUG_SOURCE"))
+    {
+      HudDebugSource *source;
+
+      source = hud_debug_source_new ();
+      hud_source_list_add (source_list, HUD_SOURCE (source));
+      g_object_unref (source);
+    }
+
   g_bus_own_name (G_BUS_TYPE_SESSION, DBUS_NAME, G_BUS_NAME_OWNER_FLAGS_NONE,
-                  bus_acquired_cb, NULL, name_lost_cb, source_list, NULL);
+                  bus_acquired_cb, name_acquired_cb, name_lost_cb, source_list, NULL);
 
   mainloop = g_main_loop_new (NULL, FALSE);
   g_main_loop_run (mainloop);

=== modified file 'src/hudappindicatorsource.c'
--- src/hudappindicatorsource.c	2012-03-12 16:25:31 +0000
+++ src/hudappindicatorsource.c	2012-03-17 16:16:19 +0000
@@ -55,6 +55,7 @@
   GSequence    *indicators;
   guint         subscription;
   GCancellable *cancellable;
+  gint          use_count;
   gboolean      ready;
 };
 
@@ -107,6 +108,10 @@
                                                        dbus_name, dbus_path);
   g_signal_connect (collector, "changed", G_CALLBACK (hud_app_indicator_source_collector_changed), source);
 
+  /* If query is active, mark new app indicator as used. */
+  if (source->use_count)
+    hud_source_use (HUD_SOURCE (collector));
+
   iter = g_sequence_get_iter_at_pos (source->indicators, position);
   g_sequence_insert_before (iter, collector);
   g_free (title);
@@ -130,6 +135,9 @@
 
       collector = g_sequence_get (iter);
       g_signal_handlers_disconnect_by_func (collector, hud_app_indicator_source_collector_changed, source);
+      /* Drop use count if we added one... */
+      if (source->use_count)
+        hud_source_unuse (HUD_SOURCE (collector));
       g_sequence_remove (iter);
     }
 }
@@ -313,6 +321,30 @@
 }
 
 static void
+hud_app_indicator_source_use (HudSource *hud_source)
+{
+  HudAppIndicatorSource *source = HUD_APP_INDICATOR_SOURCE (hud_source);
+
+  if (source->use_count == 0)
+    g_sequence_foreach (source->indicators, (GFunc) hud_source_use, NULL);
+
+  source->use_count++;
+}
+
+static void
+hud_app_indicator_source_unuse (HudSource *hud_source)
+{
+  HudAppIndicatorSource *source = HUD_APP_INDICATOR_SOURCE (hud_source);
+
+  g_return_if_fail (source->use_count > 0);
+
+  source->use_count--;
+
+  if (source->use_count == 0)
+    g_sequence_foreach (source->indicators, (GFunc) hud_source_unuse, NULL);
+}
+
+static void
 hud_app_indicator_source_search (HudSource   *hud_source,
                                  GPtrArray   *results_array,
                                  const gchar *search_string)
@@ -327,8 +359,6 @@
       hud_source_search (g_sequence_get (iter), results_array, search_string);
       iter = g_sequence_iter_next (iter);
     }
-
-
 }
 
 static void
@@ -351,6 +381,8 @@
 static void
 hud_app_indicator_source_iface_init (HudSourceInterface *iface)
 {
+  iface->use = hud_app_indicator_source_use;
+  iface->unuse = hud_app_indicator_source_unuse;
   iface->search = hud_app_indicator_source_search;
 }
 

=== modified file 'src/huddbusmenucollector.c'
--- src/huddbusmenucollector.c	2012-03-13 14:33:02 +0000
+++ src/huddbusmenucollector.c	2012-03-17 16:16:19 +0000
@@ -61,6 +61,7 @@
   HudItem parent_instance;
 
   DbusmenuMenuitem *menuitem;
+  gboolean is_opened;
 } HudDbusmenuItem;
 
 typedef HudItemClass HudDbusmenuItemClass;
@@ -155,7 +156,7 @@
 }
 
 
-static HudItem *
+static HudDbusmenuItem *
 hud_dbusmenu_item_new (HudStringList    *context,
                        const gchar      *desktop_file,
                        DbusmenuMenuitem *menuitem)
@@ -199,7 +200,7 @@
 
   hud_string_list_unref (tokens);
 
-  return HUD_ITEM (item);
+  return item;
 }
 
 struct _HudDbusmenuCollector
@@ -214,6 +215,8 @@
   guint penalty;
   guint xid;
   gboolean alive;
+  gint use_count;
+  gboolean reentrance_check;
 };
 
 typedef GObjectClass HudDbusmenuCollectorClass;
@@ -223,6 +226,68 @@
                          G_IMPLEMENT_INTERFACE (HUD_TYPE_SOURCE, hud_dbusmenu_collector_iface_init))
 
 static void
+hud_dbusmenu_collector_open_submenu (gpointer key,
+                                     gpointer value,
+                                     gpointer user_data)
+{
+  DbusmenuMenuitem *menuitem = key;
+  HudDbusmenuItem *item = value;
+
+  if (dbusmenu_menuitem_property_exist (menuitem, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY))
+    {
+      dbusmenu_menuitem_handle_event (menuitem, DBUSMENU_MENUITEM_EVENT_OPENED, NULL, 0);
+      item->is_opened = TRUE;
+    }
+}
+
+static void
+hud_dbusmenu_collector_close_submenu (gpointer key,
+                                      gpointer value,
+                                      gpointer user_data)
+{
+  DbusmenuMenuitem *menuitem = key;
+  HudDbusmenuItem *item = value;
+
+  if (item->is_opened)
+    {
+      dbusmenu_menuitem_handle_event (menuitem, DBUSMENU_MENUITEM_EVENT_CLOSED, NULL, 0);
+      item->is_opened = FALSE;
+    }
+}
+
+static void
+hud_dbusmenu_collector_use (HudSource *source)
+{
+  HudDbusmenuCollector *collector = HUD_DBUSMENU_COLLECTOR (source);
+
+  collector->reentrance_check = TRUE;
+
+  if (collector->use_count == 0)
+    g_hash_table_foreach (collector->items, hud_dbusmenu_collector_open_submenu, NULL);
+
+  collector->use_count++;
+
+  collector->reentrance_check = FALSE;
+}
+
+static void
+hud_dbusmenu_collector_unuse (HudSource *source)
+{
+  HudDbusmenuCollector *collector = HUD_DBUSMENU_COLLECTOR (source);
+
+  g_return_if_fail (collector->use_count > 0);
+
+  collector->reentrance_check = TRUE;
+
+  collector->use_count--;
+
+  if (collector->use_count == 0)
+    g_hash_table_foreach (collector->items, hud_dbusmenu_collector_close_submenu, NULL);
+
+  collector->reentrance_check = FALSE;
+}
+
+static void
 hud_dbusmenu_collector_search (HudSource   *source,
                                GPtrArray   *results_array,
                                const gchar *search_string)
@@ -260,6 +325,8 @@
   HudStringList *context;
   HudItem *item;
 
+  g_assert (!collector->reentrance_check);
+
   item = g_hash_table_lookup (collector->items, menuitem);
   g_assert (item != NULL);
 
@@ -275,6 +342,8 @@
 {
   HudDbusmenuCollector *collector = user_data;
 
+  g_assert (!collector->reentrance_check);
+
   hud_dbusmenu_collector_remove_item (collector, child);
 }
 
@@ -287,7 +356,9 @@
   HudDbusmenuCollector *collector = user_data;
   DbusmenuMenuitem *parent;
   HudStringList *context;
-  HudItem *item;
+  HudDbusmenuItem *item;
+
+  g_assert (!collector->reentrance_check);
 
   parent = dbusmenu_menuitem_get_parent (menuitem);
 
@@ -303,6 +374,13 @@
 
   item = hud_dbusmenu_item_new (context, collector->application_id, menuitem);
   g_hash_table_remove (collector->items, menuitem);
+
+  if (collector->use_count && dbusmenu_menuitem_property_exist (menuitem, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY))
+    {
+      dbusmenu_menuitem_handle_event (menuitem, DBUSMENU_MENUITEM_EVENT_OPENED, NULL, 0);
+      item->is_opened = TRUE;
+    }
+
   g_hash_table_insert (collector->items, menuitem, item);
 
   hud_source_changed (HUD_SOURCE (collector));
@@ -313,15 +391,23 @@
                                  HudStringList        *context,
                                  DbusmenuMenuitem     *menuitem)
 {
-  HudItem *item;
+  HudDbusmenuItem *item;
   GList *child;
 
   item = hud_dbusmenu_item_new (context, NULL, menuitem);
-  context = hud_item_get_tokens (item);
+  context = hud_item_get_tokens (HUD_ITEM (item));
 
   g_signal_connect (menuitem, "property-changed", G_CALLBACK (hud_dbusmenu_collector_property_changed), collector);
   g_signal_connect (menuitem, "child-added", G_CALLBACK (hud_dbusmenu_collector_child_added), collector);
   g_signal_connect (menuitem, "child-removed", G_CALLBACK (hud_dbusmenu_collector_child_removed), collector);
+
+  /* If we're actively being queried and we add a new submenu item, open it. */
+  if (collector->use_count && dbusmenu_menuitem_property_exist (menuitem, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY))
+    {
+      dbusmenu_menuitem_handle_event (menuitem, DBUSMENU_MENUITEM_EVENT_OPENED, NULL, 0);
+      item->is_opened = TRUE;
+    }
+
   g_hash_table_insert (collector->items, menuitem, item);
 
   for (child = dbusmenu_menuitem_get_children (menuitem); child; child = child->next)
@@ -355,14 +441,21 @@
 {
   if (collector->root)
     {
+      /* If the collector has the submenus opened, close them before we
+       * remove them all.  The use_count being non-zero will cause them
+       * to be reopened as they are added back below (if they will be).
+       */
+      if (collector->use_count > 0)
+        g_hash_table_foreach (collector->items, hud_dbusmenu_collector_close_submenu, NULL);
+
       hud_dbusmenu_collector_remove_item (collector, collector->root);
-      collector->root = NULL;
+      g_clear_object (&collector->root);
     }
 
   if (root)
     {
       hud_dbusmenu_collector_add_item (collector, collector->prefix, root);
-      collector->root = root;
+      collector->root = g_object_ref (root);
     }
 }
 
@@ -373,6 +466,8 @@
 {
   HudDbusmenuCollector *collector = user_data;
 
+  g_assert (!collector->reentrance_check);
+
   hud_dbusmenu_collector_setup_root (collector, root);
 }
 
@@ -429,6 +524,8 @@
   g_assert (g_hash_table_size (collector->items) == 0);
   g_hash_table_unref (collector->items);
 
+  g_free (collector->application_id);
+
   hud_string_list_unref (collector->prefix);
   g_clear_object (&collector->client);
 
@@ -445,6 +542,8 @@
 static void
 hud_dbusmenu_collector_iface_init (HudSourceInterface *iface)
 {
+  iface->use = hud_dbusmenu_collector_use;
+  iface->unuse = hud_dbusmenu_collector_unuse;
   iface->search = hud_dbusmenu_collector_search;
 }
 
@@ -515,7 +614,6 @@
                                        const gchar *desktop_file)
 {
   HudDbusmenuCollector *collector;
-  BamfApplication *application;
 
   collector = g_object_new (HUD_TYPE_DBUSMENU_COLLECTOR, NULL);
   collector->application_id = g_strdup (desktop_file);
@@ -524,10 +622,6 @@
   hud_app_menu_registrar_add_observer (hud_app_menu_registrar_get (), collector->xid,
                                        hud_dbusmenu_collector_registrar_observer_func, collector);
 
-  application = bamf_matcher_get_application_for_window (bamf_matcher_get_default (), window);
-  if (application != NULL)
-    collector->application_id = g_strdup (bamf_application_get_desktop_file (application));
-
   collector->alive = TRUE;
 
   return collector;
@@ -549,10 +643,5 @@
 {
   hud_string_list_unref (collector->prefix);
   collector->prefix = hud_string_list_cons (prefix, NULL);
-
-  if (collector->root)
-    {
-      hud_dbusmenu_collector_remove_item (collector, collector->root);
-      hud_dbusmenu_collector_add_item (collector, collector->prefix, collector->root);
-    }
+  hud_dbusmenu_collector_setup_root (collector, collector->root);
 }

=== added file 'src/huddebugsource.c'
--- src/huddebugsource.c	1970-01-01 00:00:00 +0000
+++ src/huddebugsource.c	2012-03-17 16:16:19 +0000
@@ -0,0 +1,168 @@
+/*
+ * Copyright © 2012 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/>.
+ *
+ * Author: Ryan Lortie <[e-mail]>
+ */
+
+#include "huddebugsource.h"
+
+#include "hudsource.h"
+#include "hudresult.h"
+
+/**
+ * SECTION:huddebugsource
+ * @title: HudDebugSource
+ * @short_description: a source to assist with debugging
+ *
+ * #HudDebugSource is a source for debugging purposes.  It is not
+ * enabled by default but you can have it added to the global list of
+ * sources by setting the HUD_DEBUG_SOURCE environment variable.
+ *
+ * Presently it creates a #HudItem corresponding to the current date and
+ * time (and updates it as the time changes).
+ **/
+
+/**
+ * HudDebugSource:
+ *
+ * This is an opaque structure type.
+ **/
+
+struct _HudDebugSource
+{
+  GObject parent_instance;
+
+  HudItem *item;
+  gint use_count;
+  gint timeout;
+};
+
+typedef GObjectClass HudDebugSourceClass;
+
+static void hud_debug_source_iface_init (HudSourceInterface *iface);
+G_DEFINE_TYPE_WITH_CODE (HudDebugSource, hud_debug_source, G_TYPE_OBJECT,
+                         G_IMPLEMENT_INTERFACE (HUD_TYPE_SOURCE, hud_debug_source_iface_init))
+
+static gboolean
+hud_debug_source_timeout (gpointer user_data)
+{
+  HudDebugSource *source = user_data;
+  HudStringList *tokens;
+  GDateTime *now;
+  gchar *time;
+
+  g_clear_object (&source->item);
+
+  now = g_date_time_new_now_local ();
+  time = g_date_time_format (now, "hud-debug time: %c");
+  tokens = hud_string_list_cons (time, NULL);
+  g_date_time_unref (now);
+  g_free (time);
+
+  source->item = hud_item_new (tokens, NULL, TRUE);
+  hud_string_list_unref (tokens);
+
+  hud_source_changed (HUD_SOURCE (source));
+
+  return TRUE;
+}
+
+static void
+hud_debug_source_use (HudSource *hud_source)
+{
+  HudDebugSource *source = HUD_DEBUG_SOURCE (hud_source);
+
+  if (source->use_count == 0)
+    source->timeout = g_timeout_add (1000, hud_debug_source_timeout, source);
+
+  source->use_count++;
+}
+
+static void
+hud_debug_source_unuse (HudSource *hud_source)
+{
+  HudDebugSource *source = HUD_DEBUG_SOURCE (hud_source);
+
+  source->use_count--;
+
+  if (source->use_count == 0)
+    {
+      g_source_remove (source->timeout);
+      source->timeout = 0;
+    }
+}
+
+static void
+hud_debug_source_search (HudSource   *hud_source,
+                         GPtrArray   *results_array,
+                         const gchar *search_string)
+{
+  HudDebugSource *source = HUD_DEBUG_SOURCE (hud_source);
+
+  if (source->item)
+    {
+      HudResult *result;
+
+      result = hud_result_get_if_matched (source->item, search_string, 0);
+      if (result != NULL)
+        g_ptr_array_add (results_array, result);
+    }
+}
+
+static void
+hud_debug_source_finalize (GObject *object)
+{
+  HudDebugSource *source = HUD_DEBUG_SOURCE (object);
+
+  g_clear_object (&source->item);
+
+  if (source->timeout)
+    g_source_remove (source->timeout);
+
+  G_OBJECT_CLASS (hud_debug_source_parent_class)
+    ->finalize (object);
+}
+
+static void
+hud_debug_source_init (HudDebugSource *source)
+{
+}
+
+static void
+hud_debug_source_iface_init (HudSourceInterface *iface)
+{
+  iface->use = hud_debug_source_use;
+  iface->unuse = hud_debug_source_unuse;
+  iface->search = hud_debug_source_search;
+}
+
+static void
+hud_debug_source_class_init (HudDebugSourceClass *class)
+{
+  class->finalize = hud_debug_source_finalize;
+}
+
+/**
+ * hud_debug_source_new:
+ *
+ * Creates a #HudDebugSource.
+ *
+ * Returns: a new empty #HudDebugSource
+ **/
+HudDebugSource *
+hud_debug_source_new (void)
+{
+  return g_object_new (HUD_TYPE_DEBUG_SOURCE, NULL);
+}

=== added file 'src/huddebugsource.h'
--- src/huddebugsource.h	1970-01-01 00:00:00 +0000
+++ src/huddebugsource.h	2012-03-17 16:16:19 +0000
@@ -0,0 +1,36 @@
+/*
+ * Copyright © 2012 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/>.
+ *
+ * Author: Ryan Lortie <[e-mail]>
+ */
+
+#ifndef __HUD_DEBUG_SOURCE_H__
+#define __HUD_DEBUG_SOURCE_H__
+
+#include <glib-object.h>
+
+#define HUD_TYPE_DEBUG_SOURCE                               (hud_debug_source_get_type ())
+#define HUD_DEBUG_SOURCE(inst)                              (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
+                                                             HUD_TYPE_DEBUG_SOURCE, HudDebugSource))
+#define HUD_IS_DEBUG_SOURCE(inst)                           (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
+                                                             HUD_TYPE_DEBUG_SOURCE))
+
+typedef struct _HudDebugSource                              HudDebugSource;
+
+GType                   hud_debug_source_get_type                   (void);
+
+HudDebugSource *        hud_debug_source_new                        (void);
+
+#endif /* __HUD_DEBUG_SOURCE_H__ */

=== modified file 'src/hudindicatorsource.c'
--- src/hudindicatorsource.c	2012-03-12 16:25:31 +0000
+++ src/hudindicatorsource.c	2012-03-17 16:16:19 +0000
@@ -92,7 +92,7 @@
 typedef struct
 {
   const IndicatorInfo *info;
-  HudSource *source;
+  HudIndicatorSource *source;
   HudSource *collector;
 } HudIndicatorSourceIndicator;
 
@@ -102,6 +102,7 @@
 
   HudIndicatorSourceIndicator *indicators;
   gint n_indicators;
+  gint use_count;
 };
 
 typedef GObjectClass HudIndicatorSourceClass;
@@ -111,6 +112,40 @@
                          G_IMPLEMENT_INTERFACE (HUD_TYPE_SOURCE, hud_indicator_source_iface_init))
 
 static void
+hud_indicator_source_use (HudSource *hud_source)
+{
+  HudIndicatorSource *source = HUD_INDICATOR_SOURCE (hud_source);
+  gint i;
+
+  if (source->use_count == 0)
+    {
+      for (i = 0; i < source->n_indicators; i++)
+        if (source->indicators[i].collector)
+          hud_source_use (source->indicators[i].collector);
+    }
+
+  source->use_count++;
+}
+
+static void
+hud_indicator_source_unuse (HudSource *hud_source)
+{
+  HudIndicatorSource *source = HUD_INDICATOR_SOURCE (hud_source);
+  gint i;
+
+  g_return_if_fail (source->use_count > 0);
+
+  source->use_count--;
+
+  if (source->use_count == 0)
+    {
+      for (i = 0; i < source->n_indicators; i++)
+        if (source->indicators[i].collector)
+          hud_source_unuse (source->indicators[i].collector);
+    }
+}
+
+static void
 hud_indicator_source_search (HudSource   *hud_source,
                              GPtrArray   *results_array,
                              const gchar *search_string)
@@ -135,7 +170,7 @@
 {
   HudIndicatorSourceIndicator *indicator = user_data;
 
-  hud_source_changed (indicator->source);
+  hud_source_changed (HUD_SOURCE (indicator->source));
 }
 
 static void
@@ -154,7 +189,11 @@
   g_signal_connect (collector, "changed", G_CALLBACK (hud_indicator_source_collector_changed), indicator);
   indicator->collector = HUD_SOURCE (collector);
 
-  hud_source_changed (indicator->source);
+  /* Set initial use count on new indicator if query is active. */
+  if (indicator->source->use_count)
+    hud_source_use (indicator->collector);
+
+  hud_source_changed (HUD_SOURCE (indicator->source));
 }
 
 static void
@@ -167,10 +206,13 @@
   if (indicator->collector)
     {
       g_signal_handlers_disconnect_by_func (indicator->collector, hud_indicator_source_collector_changed, indicator);
+      /* Drop our use count on dying indicator (if any) */
+      if (indicator->source->use_count)
+        hud_source_unuse (indicator->collector);
       g_clear_object (&indicator->collector);
     }
 
-  hud_source_changed (indicator->source);
+  hud_source_changed (HUD_SOURCE (indicator->source));
 }
 
 static void
@@ -186,7 +228,7 @@
       HudIndicatorSourceIndicator *indicator = &source->indicators[i];
 
       indicator->info = &indicator_info[i];
-      indicator->source = HUD_SOURCE (source);
+      indicator->source = source;
 
       g_bus_watch_name (G_BUS_TYPE_SESSION, indicator->info->dbus_name, G_BUS_NAME_WATCHER_FLAGS_NONE,
                         hud_indicator_source_name_appeared, hud_indicator_source_name_vanished, indicator, NULL);
@@ -196,6 +238,8 @@
 static void
 hud_indicator_source_iface_init (HudSourceInterface *iface)
 {
+  iface->use = hud_indicator_source_use;
+  iface->unuse = hud_indicator_source_unuse;
   iface->search = hud_indicator_source_search;
 }
 

=== modified file 'src/huditem.c'
--- src/huditem.c	2012-03-13 13:32:36 +0000
+++ src/huditem.c	2012-03-17 16:16:19 +0000
@@ -69,6 +69,7 @@
   g_hash_table_remove (hud_item_table, &item->priv->id);
   hud_string_list_unref (item->priv->tokens);
   g_free (item->priv->desktop_file);
+  g_free (item->priv->usage_tag);
 
   G_OBJECT_CLASS (hud_item_parent_class)
     ->finalize (object);

=== modified file 'src/hudmenumodelcollector.c'
--- src/hudmenumodelcollector.c	2012-03-12 16:25:31 +0000
+++ src/hudmenumodelcollector.c	2012-03-17 16:16:19 +0000
@@ -61,9 +61,9 @@
 
   gchar *desktop_file;
   GPtrArray *items;
+  gint use_count;
 };
 
-
 typedef struct
 {
   HudItem parent_instance;
@@ -329,6 +329,22 @@
 }
 
 static void
+hud_menu_model_collector_use (HudSource *source)
+{
+  HudMenuModelCollector *collector = HUD_MENU_MODEL_COLLECTOR (source);
+
+  collector->use_count++;
+}
+
+static void
+hud_menu_model_collector_unuse (HudSource *source)
+{
+  HudMenuModelCollector *collector = HUD_MENU_MODEL_COLLECTOR (source);
+
+  collector->use_count--;
+}
+
+static void
 hud_menu_model_collector_search (HudSource   *source,
                                  GPtrArray   *results_array,
                                  const gchar *search_string)
@@ -381,6 +397,8 @@
 static void
 hud_menu_model_collector_iface_init (HudSourceInterface *iface)
 {
+  iface->use = hud_menu_model_collector_use;
+  iface->unuse = hud_menu_model_collector_unuse;
   iface->search = hud_menu_model_collector_search;
 }
 

=== modified file 'src/hudquery.c'
--- src/hudquery.c	2012-03-07 21:55:41 +0000
+++ src/hudquery.c	2012-03-17 16:16:19 +0000
@@ -16,6 +16,8 @@
  * Author: Ryan Lortie <[e-mail]>
  */
 
+#define G_LOG_DOMAIN "hudquery"
+
 #include "hudquery.h"
 
 #include "hudresult.h"
@@ -138,7 +140,7 @@
   HudQuery *query = user_data;
 
   if (!query->refresh_id)
-    query->refresh_id = g_idle_add (hud_query_dispatch_refresh, g_object_ref (query));
+    query->refresh_id = g_idle_add (hud_query_dispatch_refresh, query);
 }
 
 static void
@@ -146,6 +148,13 @@
 {
   HudQuery *query = HUD_QUERY (object);
 
+  g_debug ("Destroyed query '%s'", query->search_string);
+
+  if (query->refresh_id)
+    g_source_remove (query->refresh_id);
+
+  hud_source_unuse (query->source);
+
   g_object_unref (query->source);
   g_free (query->search_string);
   g_ptr_array_unref (query->results);
@@ -199,12 +208,16 @@
 {
   HudQuery *query;
 
+  g_debug ("Created query '%s'", search_string);
+
   query = g_object_new (HUD_TYPE_QUERY, NULL);
   query->source = g_object_ref (source);
   query->results = g_ptr_array_new_with_free_func (g_object_unref);
   query->search_string = g_strdup (search_string);
   query->num_results = num_results;
 
+  hud_source_use (query->source);
+
   hud_query_refresh (query);
 
   g_signal_connect_object (source, "changed", G_CALLBACK (hud_query_source_changed), query, 0);

=== modified file 'src/hudsource.c'
--- src/hudsource.c	2012-02-29 15:48:43 +0000
+++ src/hudsource.c	2012-03-17 16:16:19 +0000
@@ -85,6 +85,52 @@
 }
 
 /**
+ * hud_source_use:
+ * @source; a #HudSource
+ *
+ * Mark a #HudSource as "in use" (ie: actively being queried).
+ *
+ * The source maintains a use count.  You must call hud_source_unuse()
+ * for as many times as you called hud_source_use().
+ *
+ * The source may not emit change signals unless it is marked as being
+ * used (although it is free to ignore this hint and emit them anyway).
+ * Some data in the source may also be out of date.  It is therefore
+ * recommended that calls to hud_source_search() be preceeded by a call
+ * to this function.
+ **/
+void
+hud_source_use (HudSource *source)
+{
+  g_return_if_fail (HUD_IS_SOURCE (source));
+
+  g_debug ("use on %s %p", G_OBJECT_TYPE_NAME (source), source);
+
+  HUD_SOURCE_GET_IFACE (source)
+    ->use (source);
+}
+
+/**
+ * hud_source_unuse:
+ * @source; a #HudSource
+ *
+ * Reverses the effect of a previous call to hud_source_use().
+ *
+ * The source maintains a use count.  You must call hud_source_unuse()
+ * for as many times as you called hud_source_use().
+ **/
+void
+hud_source_unuse (HudSource *source)
+{
+  g_return_if_fail (HUD_IS_SOURCE (source));
+
+  g_debug ("unuse on %s %p", G_OBJECT_TYPE_NAME (source), source);
+
+  HUD_SOURCE_GET_IFACE (source)
+    ->unuse (source);
+}
+
+/**
  * hud_source_search:
  * @source: a #HudSource
  * @results_array: (element-type HudResult): array to append results to

=== modified file 'src/hudsource.h'
--- src/hudsource.h	2012-02-28 18:29:03 +0000
+++ src/hudsource.h	2012-03-17 16:16:19 +0000
@@ -36,6 +36,8 @@
 {
   GTypeInterface g_iface;
 
+  void (* use)    (HudSource   *source);
+  void (* unuse)  (HudSource   *source);
   void (* search) (HudSource   *source,
                    GPtrArray   *results_array,
                    const gchar *search_string);
@@ -43,6 +45,9 @@
 
 GType                   hud_source_get_type                             (void);
 
+void                    hud_source_use                                  (HudSource   *source);
+void                    hud_source_unuse                                (HudSource   *source);
+
 void                    hud_source_search                               (HudSource   *source,
                                                                          GPtrArray   *results_array,
                                                                          const gchar *search_string);

=== modified file 'src/hudsourcelist.c'
--- src/hudsourcelist.c	2012-02-28 18:29:03 +0000
+++ src/hudsourcelist.c	2012-03-17 16:16:19 +0000
@@ -63,6 +63,26 @@
 }
 
 static void
+hud_source_list_use (HudSource *source)
+{
+  HudSourceList *list = HUD_SOURCE_LIST (source);
+  GSList *node;
+
+  for (node = list->list; node; node = node->next)
+    hud_source_use (node->data);
+}
+
+static void
+hud_source_list_unuse (HudSource *source)
+{
+  HudSourceList *list = HUD_SOURCE_LIST (source);
+  GSList *node;
+
+  for (node = list->list; node; node = node->next)
+    hud_source_unuse (node->data);
+}
+
+static void
 hud_source_list_search (HudSource   *source,
                         GPtrArray   *results_array,
                         const gchar *search_string)
@@ -94,6 +114,8 @@
 static void
 hud_source_list_iface_init (HudSourceInterface *iface)
 {
+  iface->use = hud_source_list_use;
+  iface->unuse = hud_source_list_unuse;
   iface->search = hud_source_list_search;
 }
 

=== modified file 'src/hudwindowsource.c'
--- src/hudwindowsource.c	2012-03-13 13:39:30 +0000
+++ src/hudwindowsource.c	2012-03-17 16:16:19 +0000
@@ -67,6 +67,8 @@
   BamfWindow *active_window;
   BamfApplication *active_application;
   const gchar *active_desktop_file;
+  HudSource *active_collector;
+  gint use_count;
 };
 
 typedef GObjectClass HudWindowSourceClass;
@@ -194,7 +196,6 @@
                                          gpointer     user_data)
 {
   HudWindowSource *source = user_data;
-  HudSource *collector;
   BamfWindow *window;
   BamfApplication *application;
   const gchar *desktop_file;
@@ -239,34 +240,65 @@
 
   g_debug ("new active window (xid %u)", bamf_window_get_xid (window));
 
-  collector = hud_window_source_get_collector (source);
-  if (collector)
-    g_signal_handlers_disconnect_by_func (collector, hud_window_source_collector_changed, source);
-
+
+  if (source->active_collector)
+    {
+      g_signal_handlers_disconnect_by_func (source->active_collector, hud_window_source_collector_changed, source);
+      if (source->use_count)
+        hud_source_unuse (source->active_collector);
+    }
+
+  g_clear_object (&source->active_collector);
   g_clear_object (&source->active_application);
   g_clear_object (&source->active_window);
   source->active_window = g_object_ref (window);
   source->active_application = g_object_ref (application);
   source->active_desktop_file = desktop_file;
+  source->active_collector = g_object_ref (hud_window_source_get_collector (source));
 
-  collector = hud_window_source_get_collector (source);
-  g_signal_connect_object (collector, "changed", G_CALLBACK (hud_window_source_collector_changed), source, 0);
+  if (source->use_count)
+    hud_source_use (source->active_collector);
+  g_signal_connect_object (source->active_collector, "changed",
+                           G_CALLBACK (hud_window_source_collector_changed), source, 0);
 
   hud_source_changed (HUD_SOURCE (source));
 }
 
 static void
+hud_window_source_use (HudSource *hud_source)
+{
+  HudWindowSource *source = HUD_WINDOW_SOURCE (hud_source);
+
+  if (source->use_count == 0)
+    if (source->active_collector)
+      hud_source_use (source->active_collector);
+
+  source->use_count++;
+}
+
+static void
+hud_window_source_unuse (HudSource *hud_source)
+{
+  HudWindowSource *source = HUD_WINDOW_SOURCE (hud_source);
+
+  g_return_if_fail (source->use_count > 0);
+
+  source->use_count--;
+
+  if (source->use_count == 0)
+    if (source->active_collector)
+      hud_source_unuse (source->active_collector);
+}
+
+static void
 hud_window_source_search (HudSource   *hud_source,
                           GPtrArray   *results_array,
                           const gchar *search_string)
 {
   HudWindowSource *source = HUD_WINDOW_SOURCE (hud_source);
-  HudSource *collector;
-
-  collector = hud_window_source_get_collector (source);
-
-  if (collector)
-    hud_source_search (collector, results_array, search_string);
+
+  if (source->active_collector)
+    hud_source_search (source->active_collector, results_array, search_string);
 }
 
 static void
@@ -285,15 +317,22 @@
 static void
 hud_window_source_init (HudWindowSource *source)
 {
+  BamfWindow *window;
+
   source->matcher = bamf_matcher_get_default ();
 
   g_signal_connect_object (source->matcher, "active-window-changed",
                            G_CALLBACK (hud_window_source_active_window_changed), source, 0);
+  window = bamf_matcher_get_active_window (source->matcher);
+  if (window != NULL)
+    hud_window_source_active_window_changed (source->matcher, NULL, BAMF_VIEW (window), source);
 }
 
 static void
 hud_window_source_iface_init (HudSourceInterface *iface)
 {
+  iface->use = hud_window_source_use;
+  iface->unuse = hud_window_source_unuse;
   iface->search = hud_window_source_search;
 }