chiark / gitweb /
De-dupe choose_{next,prev}_clicked.
[disorder] / disobedience / choose-search.c
index 9b842856b4895ff8b25daab99795a4cb9d0f85b4..d8222505c795782580d07f55f941ad392bc80967 100644 (file)
  */
 /** @file disobedience/search.c
  * @brief Search support
- *
- * TODO:
- * - cleverer focus to implement typeahead find
- * - don't steal ^A
- * - make arrow buttons work
- * - delay search initiation until keyboard goes quiet for a bit
- *   (so that you don't get all the 'lo' tracks when you search for 'love')
  */
 #include "disobedience.h"
 #include "choose.h"
 
-static GtkWidget *choose_search_entry;
+int choose_auto_expanding;
+
+GtkWidget *choose_search_entry;
 static GtkWidget *choose_next;
 static GtkWidget *choose_prev;
 static GtkWidget *choose_clear;
@@ -41,6 +36,9 @@ static int choose_searching;
 /** @brief True if in-flight search is now known to be obsolete */
 static int choose_search_obsolete;
 
+/** @brief Current search terms */
+static char *choose_search_terms;
+
 /** @brief Hash of all search result */
 static hash *choose_search_hash;
 
@@ -63,6 +61,12 @@ static int choose_n_search_references;
 /** @brief Event handle for monitoring newly inserted tracks */
 static event_handle choose_inserted_handle;
 
+/** @brief Time of last search entry keypress (or 0.0) */
+static struct timeval choose_search_last_keypress;
+
+/** @brief Timeout ID for search delay */
+static guint choose_search_timeout_id;
+
 static void choose_search_entry_changed(GtkEditable *editable,
                                         gpointer user_data);
 
@@ -70,13 +74,6 @@ int choose_is_search_result(const char *track) {
   return choose_search_hash && hash_find(choose_search_hash, track);
 }
 
-/** @brief Called when the cancel search button is clicked */
-static void choose_clear_clicked(GtkButton attribute((unused)) *button,
-                                 gpointer attribute((unused)) userdata) {
-  gtk_entry_set_text(GTK_ENTRY(choose_search_entry), "");
-  /* The changed signal will do the rest of the work for us */
-}
-
 static int is_prefix(const char *dir, const char *track) {
   size_t nd = strlen(dir);
 
@@ -126,7 +123,7 @@ static int choose_make_one_visible(const char *track) {
     }
     if(is_prefix(dir, track)) {
       /* We found a prefix of the target track. */
-      //fprintf(stderr, "   is a prefix\n");
+      //fprintf(stderr, "   %s is a prefix\n", dir);
       const gboolean expanded
         = gtk_tree_view_row_expanded(GTK_TREE_VIEW(choose_view), path);
       if(expanded) {
@@ -148,14 +145,16 @@ static int choose_make_one_visible(const char *track) {
       } else {
         //fprintf(stderr, "   requesting expansion of %s\n", dir);
         /* Track is below a non-expanded directory.  So let's expand it.
-         * choose_make_visible() will arrange a revisit in due course. */
+         * choose_make_visible() will arrange a revisit in due course.
+         *
+         * We mark the row as auto-expanded.
+         */
+        ++choose_auto_expanding;
         gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view),
                                  path,
                                  FALSE/*open_all*/);
         gtk_tree_path_free(path);
-        /* TODO: the old version would remember which rows had been expanded
-         * just to show search results and collapse them again.  We should
-         * probably do that. */
+        --choose_auto_expanding;
         return 0;
       }
     } else
@@ -191,6 +190,8 @@ static int choose_compare_references(const void *av, const void *bv) {
  *
  * If @p row_align is negative no row alignemt is performed.  Otherwise
  * it must be between 0 (the top) and 1 (the bottom).
+ *
+ * TODO: if the row is already visible do nothing.
  */
 static int choose_make_path_visible(GtkTreePath *path,
                                     gfloat row_align) {
@@ -245,7 +246,7 @@ static void choose_make_visible(const char attribute((unused)) *event,
     /* If there's work left to be done make sure we get a callback when
      * something changes */
     if(!choose_inserted_handle)
-      choose_inserted_handle = event_register("choose-inserted-tracks",
+      choose_inserted_handle = event_register("choose-more-tracks",
                                               choose_make_visible, 0);
   } else {
     /* Suppress callbacks if there's nothing more to do */
@@ -263,11 +264,11 @@ static void choose_make_visible(const char attribute((unused)) *event,
 
 /** @brief Called with search results */
 static void choose_search_completed(void attribute((unused)) *v,
-                                    const char *error,
+                                    const char *err,
                                     int nvec, char **vec) {
   //fprintf(stderr, "choose_search_completed\n");
-  if(error) {
-    popup_protocol_error(0, error);
+  if(err) {
+    popup_protocol_error(0, err);
     return;
   }
   choose_searching = 0;
@@ -278,6 +279,9 @@ static void choose_search_completed(void attribute((unused)) *v,
     return;
   }
   //fprintf(stderr, "*** %d search results\n", nvec);
+  /* We're actually going to use these search results.  Autocollapse anything
+   * left over from the old search. */
+  choose_auto_collapse();
   choose_search_hash = hash_new(1);
   if(nvec) {
     for(int n = 0; n < nvec; ++n)
@@ -295,15 +299,17 @@ static void choose_search_completed(void attribute((unused)) *v,
   } else {
     gtk_widget_set_sensitive(choose_next, FALSE);
     gtk_widget_set_sensitive(choose_prev, FALSE);
+    choose_n_search_results = 0;
+    choose_search_results = 0;
+    choose_n_search_references = 0;
+    choose_search_references = 0;
   }
   event_raise("search-results-changed", 0);
 }
 
-/** @brief Called when the search entry changes */
-static void choose_search_entry_changed
-    (GtkEditable attribute((unused)) *editable,
-     gpointer attribute((unused)) user_data) {
-  //fprintf(stderr, "choose_search_entry_changed\n");
+/** @brief Actually initiate a search */
+static void initiate_search(void) {
+  //fprintf(stderr, "initiate_search\n");
   /* If a search is in flight don't initiate a new one until it comes back */
   if(choose_searching) {
     choose_search_obsolete = 1;
@@ -311,10 +317,18 @@ static void choose_search_entry_changed
   }
   char *terms = xstrdup(gtk_entry_get_text(GTK_ENTRY(choose_search_entry)));
   /* Strip leading and trailing space */
-  while(*terms == ' ') ++terms;
+  while(*terms == ' ')
+    ++terms;
   char *e = terms + strlen(terms);
-  while(e > terms && e[-1] == ' ') --e;
+  while(e > terms && e[-1] == ' ')
+    --e;
   *e = 0;
+  if(choose_search_terms && !strcmp(terms, choose_search_terms)) {
+    /* Search terms have not actually changed in any way that matters */
+    return;
+  }
+  /* Remember the current terms */
+  choose_search_terms = terms;
   if(!*terms) {
     /* Nothing to search for.  Fake a completion call. */
     choose_search_completed(0, 0, 0, 0);
@@ -328,6 +342,47 @@ static void choose_search_entry_changed
   choose_searching = 1;
 }
 
+static gboolean choose_search_timeout(gpointer attribute((unused)) data) {
+  struct timeval now;
+  xgettimeofday(&now, NULL);
+  /*fprintf(stderr, "%ld.%06d choose_search_timeout\n",
+          now.tv_sec, now.tv_usec);*/
+  if(tvdouble(now) - tvdouble(choose_search_last_keypress)
+         < SEARCH_DELAY_MS / 1000.0) {
+    //fprintf(stderr, " ... too soon\n");
+    return TRUE;                        /* Call me again later */
+  }
+  //fprintf(stderr, " ... let's go\n");
+  choose_search_last_keypress.tv_sec = 0;
+  choose_search_last_keypress.tv_usec = 0;
+  choose_search_timeout_id = 0;
+  initiate_search();
+  return FALSE;
+}
+
+/** @brief Called when the search entry changes */
+static void choose_search_entry_changed
+    (GtkEditable attribute((unused)) *editable,
+     gpointer attribute((unused)) user_data) {
+  xgettimeofday(&choose_search_last_keypress, NULL);
+  /*fprintf(stderr, "%ld.%06d choose_search_entry_changed\n",
+          choose_search_last_keypress.tv_sec,
+          choose_search_last_keypress.tv_usec);*/
+  /* If there's already a timeout, remove it */
+  if(choose_search_timeout_id) {
+    g_source_remove(choose_search_timeout_id);
+    choose_search_timeout_id = 0;
+  }
+  /* Add a new timeout */
+  choose_search_timeout_id = g_timeout_add(SEARCH_DELAY_MS / 10,
+                                           choose_search_timeout,
+                                           0);
+  /* We really wanted to tell Glib what time we wanted the callback at rather
+   * than asking for calls at given intervals.  But there's no interface for
+   * that, and defining a new source for it seems like overkill if we can
+   * reasonably avoid it. */
+}
+
 /** @brief Identify first and last visible paths
  *
  * We'd like to use gtk_tree_view_get_visible_range() for this, but that was
@@ -376,57 +431,76 @@ static gboolean choose_get_visible_range(GtkTreeView *tree_view,
   return TRUE;
 }
 
-static void choose_next_clicked(GtkButton attribute((unused)) *button,
-                                gpointer attribute((unused)) userdata) {
 /* Find the last visible row */
-  GtkTreePath *endpath;
-  gboolean endvalid = choose_get_visible_range(GTK_TREE_VIEW(choose_view),
-                                               NULL,
-                                               &endpath);
-  if(!endvalid)
+/** @brief Move to the next/prev match
+ * @param direction -1 for prev, +1 for next
+ */
+static void choose_move(int direction) {
+  /* Refocus the main view so typahead find continues to work */
+  gtk_widget_grab_focus(choose_view);
+  /* If there's no results we have nothing to do */
+  if(!choose_n_search_results)
     return;
-  /* Find a the first search result later than it.  They're sorted so we could
-   * actually do much better than this if necessary. */
-  for(int n = 0; n < choose_n_search_references; ++n) {
+  /* Compute bounds for searching over the array in the right direction */
+  const int first = direction > 0 ? 0 : choose_n_search_references - 1;
+  const int limit = direction > 0 ? choose_n_search_references : -1;
+  /* Find the first/last currently visible row */
+  GtkTreePath *limitpath;
+  if(!choose_get_visible_range(GTK_TREE_VIEW(choose_view),
+                               direction < 0 ? &limitpath : 0,
+                               direction > 0 ? &limitpath : 0))
+    return;
+  /* Find a the first search result later/earlier than it.  They're sorted so
+   * we could actually do much better than this if necessary. */
+  for(int n = first; n != limit; n += direction) {
     GtkTreePath *path
       = gtk_tree_row_reference_get_path(choose_search_references[n]);
     if(!path)
       continue;
-    if(gtk_tree_path_compare(endpath, path) < 0) {
+    /* gtk_tree_path_compare returns -1, 0 or 1 so we compare naively with
+     * direction */
+    if(gtk_tree_path_compare(limitpath, path) + direction == 0) {
       choose_make_path_visible(path, 0.5);
       gtk_tree_path_free(path);
       return;
     }
     gtk_tree_path_free(path);
   }
-}
-
-static void choose_prev_clicked(GtkButton attribute((unused)) *button,
-                                gpointer attribute((unused)) userdata) {
-  /* TODO can we de-dupe with choose_next_clicked?  Probably yes. */
-  /* Find the first visible row */
-  GtkTreePath *startpath;
-  gboolean startvalid = choose_get_visible_range(GTK_TREE_VIEW(choose_view),
-                                                 &startpath,
-                                                 NULL);
-  if(!startvalid)
-    return;
-  /* Find a the last search result earlier than it.  They're sorted so we could
-   * actually do much better than this if necessary. */
-  for(int n = choose_n_search_references - 1; n >= 0; --n) {
+  /* We didn't find one.  Loop back to the first/las. */
+  for(int n = first; n != limit; n += direction) {
     GtkTreePath *path
       = gtk_tree_row_reference_get_path(choose_search_references[n]);
     if(!path)
       continue;
-    if(gtk_tree_path_compare(startpath, path) > 0) {
-      choose_make_path_visible(path, 0.5);
-      gtk_tree_path_free(path);
-      return;
-    }
+    choose_make_path_visible(path, 0.5);
     gtk_tree_path_free(path);
+    return;
   }
 }
 
+void choose_next_clicked(GtkButton attribute((unused)) *button,
+                         gpointer attribute((unused)) userdata) {
+  choose_move(1);
+}
+
+void choose_prev_clicked(GtkButton attribute((unused)) *button,
+                         gpointer attribute((unused)) userdata) {
+  choose_move(-1);
+}
+
+/** @brief Called when the cancel search button is clicked */
+static void choose_clear_clicked(GtkButton attribute((unused)) *button,
+                                 gpointer attribute((unused)) userdata) {
+  gtk_entry_set_text(GTK_ENTRY(choose_search_entry), "");
+  gtk_widget_grab_focus(choose_view);
+  /* We start things off straight away in this case */
+  initiate_search();
+}
+
+/** @brief Called when the user hits ^F to start a new search */
+void choose_search_new(void) {
+  gtk_editable_select_region(GTK_EDITABLE(choose_search_entry), 0, -1);
+}
+
 /** @brief Create the search widget */
 GtkWidget *choose_search_widget(void) {