chiark / gitweb /
Merge branch 'master' of git.distorted.org.uk:~mdw/publish/public-git/disorder
[disorder] / disobedience / choose-search.c
index 44321519e966d5294b76aa752d6c84fc53e7d7a6..83d3f743652578e482d4d2709f24e0708aa1ebcb 100644 (file)
@@ -2,26 +2,21 @@
  * 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
+/** @file disobedience/choose-search.c
+ * @brief Search support for Disobedience choose window
  */
 #include "disobedience.h"
 #include "choose.h"
@@ -72,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);
@@ -193,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;
 }
 
@@ -267,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;
@@ -286,6 +289,11 @@ static void choose_search_completed(void attribute((unused)) *v,
    * left over from the old search. */
   choose_auto_collapse();
   choose_search_hash = hash_new(1);
+  /* If we were still setting up the chooser to show previous search results
+   * then turn that off now.  We'll turn it back on again if necessary. */
+  event_cancel(choose_inserted_handle);
+  choose_inserted_handle = 0;
+  /* Start showing the results of our search. */
   if(nvec) {
     for(int n = 0; n < nvec; ++n)
       hash_add(choose_search_hash, vec[n], "", HASH_INSERT);
@@ -434,33 +442,43 @@ static gboolean choose_get_visible_range(GtkTreeView *tree_view,
   return TRUE;
 }
 
-void choose_next_clicked(GtkButton attribute((unused)) *button,
-                         gpointer attribute((unused)) userdata) {
+/** @brief Move to the next/prev match
+ * @param direction -1 for prev, +1 for next
+ */
+static void choose_move(int direction) {
+  assert(direction);                    /* placate analyzer */
+  /* 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 the last visible row */
-  GtkTreePath *endpath;
-  gboolean endvalid = choose_get_visible_range(GTK_TREE_VIEW(choose_view),
-                                               NULL,
-                                               &endpath);
-  if(!endvalid)
+  /* 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);
   }
-  /* We didn't find one.  Loop back to the first. */
-  for(int n = 0; n < choose_n_search_references; ++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)
@@ -471,48 +489,21 @@ void choose_next_clicked(GtkButton attribute((unused)) *button,
   }
 }
 
+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) {
-  /* TODO can we de-dupe with choose_next_clicked?  Probably yes. */
-  if(!choose_n_search_results)
-    return;
-  /* 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);
-  }
-  /* We didn't find one.  Loop down to the last. */
-  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;
-    choose_make_path_visible(path, 0.5);
-    gtk_tree_path_free(path);
-    return;
-  }
+  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();
 }
@@ -530,15 +521,15 @@ GtkWidget *choose_search_widget(void) {
   gtk_widget_set_style(choose_search_entry, tool_style);
   g_signal_connect(choose_search_entry, "changed",
                    G_CALLBACK(choose_search_entry_changed), 0);
-  gtk_tooltips_set_tip(tips, choose_search_entry,
-                       "Enter search terms here; search is automatic", "");
+  gtk_widget_set_tooltip_text(choose_search_entry,
+                              "Enter search terms here; search is automatic");
 
   /* Cancel button to clear the search */
   choose_clear = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
   gtk_widget_set_style(choose_clear, tool_style);
   g_signal_connect(G_OBJECT(choose_clear), "clicked",
                    G_CALLBACK(choose_clear_clicked), 0);
-  gtk_tooltips_set_tip(tips, choose_clear, "Clear search terms", "");
+  gtk_widget_set_tooltip_text(choose_clear, "Clear search terms");
 
   /* Up and down buttons to find previous/next results; initially they are not
    * usable as there are no search results. */