chiark / gitweb /
Sorting for Disobedience track chooser. A rewrite: we now do a single
[disorder] / disobedience / choose-search.c
index c82ab59b67b7e7a5ee8c39175eb8f31cac385929..d12a3439ee648e2b90b93fbc0aef7cc61b5251c5 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file disobedience/search.c
+ * @brief Search support
+ *
+ * TODO:
+ * - cleverer focus to implement typeahead find
+ * - don't steal ^A
+ */
 #include "disobedience.h"
 #include "choose.h"
 
@@ -31,6 +38,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;
 
@@ -53,6 +63,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);
 
@@ -60,13 +76,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);
 
@@ -174,14 +183,42 @@ static int choose_compare_references(const void *av, const void *bv) {
   return rc;
 }
 
-/** @brief Move the cursor to @p ref
+/** @brief Make @p path visible
+ * @param path Row reference to make visible
+ * @param row_align Row alignment (or -ve)
  * @return 0 on success, nonzero if @p ref has gone stale
+ *
+ * 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_set_cursor(GtkTreeRowReference *ref) {
+static int choose_make_path_visible(GtkTreePath *path,
+                                    gfloat row_align) {
+  /* Make sure that the target's parents are all expanded */
+  gtk_tree_view_expand_to_path(GTK_TREE_VIEW(choose_view), path);
+  /* Make sure the target is visible */
+  gtk_tree_view_scroll_to_cell(GTK_TREE_VIEW(choose_view), path, NULL,
+                               row_align >= 0.0,
+                               row_align,
+                               0);
+  return 0;
+}
+
+/** @brief Make @p ref visible
+ * @param ref Row reference to make visible
+ * @param row_align Row alignment (or -ve)
+ * @return 0 on success, nonzero if @p ref has gone stale
+ *
+ * If @p row_align is negative no row alignemt is performed.  Otherwise
+ * it must be between 0 (the top) and 1 (the bottom).
+ */
+static int choose_make_ref_visible(GtkTreeRowReference *ref,
+                                   gfloat row_align) {
   GtkTreePath *path = gtk_tree_row_reference_get_path(ref);
   if(!path)
     return -1;
-  gtk_tree_view_set_cursor(GTK_TREE_VIEW(choose_view), path, NULL, FALSE);
+  choose_make_path_visible(path, row_align);
   gtk_tree_path_free(path);
   return 0;
 }
@@ -221,7 +258,7 @@ static void choose_make_visible(const char attribute((unused)) *event,
           choose_n_search_references,
           sizeof (GtkTreeRowReference *),
           choose_compare_references);
-    choose_set_cursor(choose_search_references[0]);
+    choose_make_ref_visible(choose_search_references[0], 0.5);
   }
 }
 
@@ -254,15 +291,18 @@ static void choose_search_completed(void attribute((unused)) *v,
     choose_search_references = xcalloc(nvec, sizeof (GtkTreeRowReference *));
     /* Start making rows visible */
     choose_make_visible(0, 0, 0);
+    gtk_widget_set_sensitive(choose_next, TRUE);
+    gtk_widget_set_sensitive(choose_prev, TRUE);
+  } else {
+    gtk_widget_set_sensitive(choose_next, FALSE);
+    gtk_widget_set_sensitive(choose_prev, FALSE);
   }
   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;
@@ -270,10 +310,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);
@@ -287,14 +335,152 @@ 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
+ * introduced in GTK+ 2.8, and Fink only has 2.6 (which is around three years
+ * out of date at time of writing), and I'm not yet prepared to rule out Fink
+ * support.
+ */
+static gboolean choose_get_visible_range(GtkTreeView *tree_view,
+                                         GtkTreePath **startpathp,
+                                         GtkTreePath **endpathp) {
+  GdkRectangle visible_tc[1];
+
+  /* Get the visible rectangle in tree coordinates */
+  gtk_tree_view_get_visible_rect(tree_view, visible_tc);
+  /*fprintf(stderr, "visible: %dx%x at %dx%d\n",
+          visible_tc->width, visible_tc->height,
+          visible_tc->x, visible_tc->y);*/
+  if(startpathp) {
+    /* Convert top-left visible point to widget coordinates */
+    int x_wc, y_wc;
+    gtk_tree_view_tree_to_widget_coords(tree_view,
+                                        visible_tc->x, visible_tc->y,
+                                        &x_wc, &y_wc);
+    //fprintf(stderr, " start widget coords: %dx%d\n", x_wc, y_wc);
+    gtk_tree_view_get_path_at_pos(tree_view,
+                                  x_wc, y_wc,
+                                  startpathp,
+                                  NULL,
+                                  NULL, NULL);
+  }
+  if(endpathp) {
+    /* Convert bottom-left visible point to widget coordinates */
+    /* Convert top-left visible point to widget coordinates */
+    int x_wc, y_wc;
+    gtk_tree_view_tree_to_widget_coords(tree_view,
+                                        visible_tc->x,
+                                        visible_tc->y + visible_tc->height - 1,
+                                        &x_wc, &y_wc);
+    //fprintf(stderr, " end widget coords: %dx%d\n", x_wc, y_wc);
+    gtk_tree_view_get_path_at_pos(tree_view,
+                                  x_wc, y_wc,
+                                  endpathp,
+                                  NULL,
+                                  NULL, NULL);
+  }
+  return TRUE;
+}
+
 static void choose_next_clicked(GtkButton attribute((unused)) *button,
                                 gpointer attribute((unused)) userdata) {
-  fprintf(stderr, "next\n");            /* TODO */
+  /* Find the last visible row */
+  GtkTreePath *endpath;
+  gboolean endvalid = choose_get_visible_range(GTK_TREE_VIEW(choose_view),
+                                               NULL,
+                                               &endpath);
+  if(!endvalid)
+    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) {
+    GtkTreePath *path
+      = gtk_tree_row_reference_get_path(choose_search_references[n]);
+    if(!path)
+      continue;
+    if(gtk_tree_path_compare(endpath, path) < 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) {
-  fprintf(stderr, "prev\n");            /* TODO */
+  /* 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) {
+    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;
+    }
+    gtk_tree_path_free(path);
+  }
+}
+
+/** @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), "");
+  /* We start things off straight away in this case */
+  initiate_search();
 }
 
 /** @brief Create the search widget */