chiark / gitweb /
Switch to GPL v3
[disorder] / disobedience / choose-search.c
index d12a3439ee648e2b90b93fbc0aef7cc61b5251c5..e27640c67df60e0f3fa3bac6217ffd240210ba85 100644 (file)
@@ -2,32 +2,28 @@
  * This file is part of DisOrder
  * Copyright (C) 2008 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY 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, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /** @file disobedience/search.c
  * @brief Search support
- *
- * TODO:
- * - cleverer focus to implement typeahead find
- * - don't steal ^A
  */
 #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;
@@ -71,6 +67,9 @@ static guint choose_search_timeout_id;
 
 static void choose_search_entry_changed(GtkEditable *editable,
                                         gpointer user_data);
+static gboolean choose_get_visible_range(GtkTreeView *tree_view,
+                                         GtkTreePath **startpathp,
+                                         GtkTreePath **endpathp);
 
 int choose_is_search_result(const char *track) {
   return choose_search_hash && hash_find(choose_search_hash, track);
@@ -125,7 +124,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) {
@@ -147,14 +146,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
@@ -190,18 +191,23 @@ 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) {
   /* Make sure that the target's parents are all expanded */
   gtk_tree_view_expand_to_path(GTK_TREE_VIEW(choose_view), path);
+  /* Find out what's currently visible */
+  GtkTreePath *startpath, *endpath;
+  choose_get_visible_range(GTK_TREE_VIEW(choose_view), &startpath, &endpath);
   /* 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);
+  if(gtk_tree_path_compare(path, startpath) < 0
+     || gtk_tree_path_compare(path, endpath) > 0) 
+    gtk_tree_view_scroll_to_cell(GTK_TREE_VIEW(choose_view), path, NULL,
+                                 row_align >= 0.0,
+                                 row_align,
+                                 0);
+  gtk_tree_path_free(startpath);
+  gtk_tree_path_free(endpath);
   return 0;
 }
 
@@ -246,7 +252,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 */
@@ -264,11 +270,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;
@@ -279,6 +285,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)
@@ -296,6 +305,10 @@ 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);
 }
@@ -424,65 +437,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;
+  /* 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 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) {
+  /* 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) {