chiark / gitweb /
sync with disorder.dev
[disorder] / disobedience / choose.c
index cb68bb5b67cabaf63954a18fd1733bb0066c2525..aabc215b1e567cdcc87ad617a9a6313853813683 100644 (file)
  */
 
 #include "disobedience.h"
+#include "timeval.h"
 
 /* Choose track ------------------------------------------------------------ */
 
+#if TDEBUG
+/* Timing */
+static struct {
+  struct timeval total;
+  struct timeval gtkbits;
+  struct timeval menuupdate;
+  struct timeval new_widgets;
+  struct timeval undisplay;
+  struct timeval colors;
+  struct timeval markers;
+  struct timeval location;
+  struct timeval selection;
+} times;
+
+#define BEGIN(WHAT) do {                        \
+  struct timeval started##WHAT, finished##WHAT; \
+  xgettimeofday(&started##WHAT, 0)
+
+#define END(WHAT)                                                       \
+  xgettimeofday(&finished##WHAT, 0);                                    \
+  times.WHAT = tvadd(times.WHAT, tvsub(finished##WHAT, started##WHAT)); \
+} while(0)
+
+#define INIT() memset(&times, 0, sizeof times)
+
+#define REPORT() do {                           \
+  fprintf(stderr, "total=%g\n"                  \
+          "gtkbits=%g\n"                        \
+          "menuupdate=%g\n"                     \
+          "new_widgets=%g\n"                    \
+          "undisplay=%g\n"                      \
+          "colors=%g\n"                         \
+          "markers=%g\n"                        \
+          "location=%g\n"                       \
+          "selection=%g\n"                      \
+          "accumulation=%g\n"                   \
+          "\n",                                 \
+          tvdouble(times.total),                \
+          tvdouble(times.gtkbits),              \
+          tvdouble(times.menuupdate),           \
+          tvdouble(times.new_widgets),          \
+          tvdouble(times.undisplay),            \
+          tvdouble(times.colors),               \
+          tvdouble(times.markers),              \
+          tvdouble(times.location),             \
+          tvdouble(times.selection),            \
+          (tvdouble(times.gtkbits)              \
+           + tvdouble(times.menuupdate)         \
+           + tvdouble(times.new_widgets)        \
+           + tvdouble(times.undisplay)          \
+           + tvdouble(times.colors)             \
+           + tvdouble(times.markers)            \
+           + tvdouble(times.location)           \
+           + tvdouble(times.selection)));       \
+} while(0)
+#else
+#define BEGIN(WHAT) do {
+#define END(WHAT) } while(0)
+#define INIT() ((void)0)
+#define REPORT() ((void)0)
+#endif
+
 WT(label);
 WT(event_box);
 WT(menu);
@@ -121,6 +184,8 @@ struct choose_menuitem {
 static GtkWidget *chooselayout;
 static GtkAdjustment *vadjust;
 static GtkWidget *searchentry;          /**< @brief search terms */
+static GtkWidget *nextsearch;           /**< @brief next search result */
+static GtkWidget *prevsearch;           /**< @brief previous search result */
 static struct choosenode *root;
 static GtkWidget *track_menu;           /**< @brief track popup menu */
 static GtkWidget *dir_menu;             /**< @brief directory popup menu */
@@ -134,7 +199,9 @@ static char **searchresults;            /**< @brief search results */
 static int nsearchresults;              /**< @brief number of results */
 static int nsearchvisible;      /**< @brief number of search results visible */
 static struct hash *searchhash;         /**< @brief hash of search results */
-struct progress_window *spw;            /**< @brief progress window */
+static struct progress_window *spw;     /**< @brief progress window */
+static struct choosenode **searchnodes; /**< @brief choosenodes of search results */
+static int suppress_redisplay;          /**< @brief suppress redisplay */
 
 /* Forward Declarations */
 
@@ -153,17 +220,19 @@ static void got_dirs(void *v, int nvec, char **vec);
 
 static void expand_node(struct choosenode *cn, int contingent);
 static void contract_node(struct choosenode *cn);
-static void updated_node(struct choosenode *cn, int redisplay);
+static void updated_node(struct choosenode *cn, int redisplay,
+                         const char *why);
 
 static void display_selection(struct choosenode *cn);
 static void clear_selection(struct choosenode *cn);
 
-static void redisplay_tree(void);
+static void redisplay_tree(const char *why);
 static struct displaydata display_tree(struct choosenode *cn, int x, int y);
 static void undisplay_tree(struct choosenode *cn);
 static void initiate_search(void);
 static void delete_widgets(struct choosenode *cn);
 static void expand_from(struct choosenode *cn);
+static struct choosenode *first_search_result(struct choosenode *cn);
 
 static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
                                GdkEventButton *event,
@@ -375,6 +444,8 @@ static void got_files(void *v, int nvec, char **vec) {
    * done */
   if(!(cn->flags & CN_GETTING_ANY))
     filled(cn);
+  if(!gets_in_flight)
+    redisplay_tree("got_files");
 }
 
 /** @brief Called with an alias resolved filename */
@@ -392,7 +463,7 @@ static void got_resolved_file(void *v, const char *track) {
   /* Only bother updating when we've got the lot */
   if(--cn->pending == 0) {
     cn->flags &= ~CN_RESOLVING_FILES;
-    updated_node(cn, 1);
+    updated_node(cn, gets_in_flight == 0, "got_resolved_file");
     if(!(cn->flags & CN_GETTING_ANY))
       filled(cn);
   }
@@ -418,7 +489,7 @@ static void got_dirs(void *v, int nvec, char **vec) {
             trackname_transform("dir", vec[n], "display"),
             trackname_transform("dir", vec[n], "sort"),
             CN_EXPANDABLE, fill_directory_node);
-  updated_node(cn, 1);
+  updated_node(cn, gets_in_flight == 0, "got_dirs");
   cn->flags &= ~CN_GETTING_DIRS;
   if(!(cn->flags & CN_GETTING_ANY))
     filled(cn);
@@ -501,10 +572,15 @@ static void expand_from(struct choosenode *cn) {
     /* This is an actual search result */
     ++nsearchvisible;
     progress_window_progress(spw, nsearchvisible, nsearchresults);
-    if(nsearchvisible == nsearchresults)
-      /* This is the last track to become visible, we'll make sure it's in
-       * range so that at least one is. */
-      gtk_adjustment_clamp_page(vadjust, cn->ymax, cn->ymin);
+    if(nsearchvisible == nsearchresults) {
+      if(suppress_redisplay) {
+        suppress_redisplay = 0;
+        redisplay_tree("all search results visible");
+      }
+      /* We've got the lot.  We make sure the first result is visible. */
+      cn = first_search_result(root);
+      gtk_adjustment_clamp_page(vadjust, cn->ymin, cn->ymax);
+    }
   }
 }
 
@@ -534,7 +610,7 @@ static void contract_node(struct choosenode *cn) {
    * anyone complains we can make it an option. */
   clear_children(cn);
   /* We can contract a node immediately. */
-  redisplay_tree();
+  redisplay_tree("contract_node");
 }
 
 /** @brief qsort() callback for ordering choosenodes */
@@ -548,7 +624,8 @@ static int compare_choosenode(const void *av, const void *bv) {
 }
 
 /** @brief Called when an expandable node is updated.   */
-static void updated_node(struct choosenode *cn, int redisplay) {
+static void updated_node(struct choosenode *cn, int redisplay,
+                         const char *why) {
   D(("updated_node %s", cn->path));
   assert(cn->flags & CN_EXPANDABLE);
   /* It might be that the node has been de-expanded since we requested the
@@ -557,15 +634,42 @@ static void updated_node(struct choosenode *cn, int redisplay) {
   /* Sort children */
   qsort(cn->children.vec, cn->children.nvec, sizeof (struct choosenode *),
         compare_choosenode);
-  if(redisplay)
-    redisplay_tree();
+  if(redisplay) {
+    char whywhy[1024];
+
+    snprintf(whywhy, sizeof whywhy, "updated_node %s", why);
+    redisplay_tree(whywhy);
+  }
 }
 
 /* Searching --------------------------------------------------------------- */
 
-/** @brief Return true if @p track is a search result */
+/** @brief Return true if @p track is a search result
+ *
+ * In particular the return value is one more than the index of the track
+ * @p searchresults.
+ */
 static int is_search_result(const char *track) {
-  return searchhash && hash_find(searchhash, track);
+  void *r;
+
+  if(searchhash && (r = hash_find(searchhash, track)))
+    return 1 + *(int *)r;
+  else
+    return 0;
+}
+
+/** @brief Return the first search result at or below @p cn */
+static struct choosenode *first_search_result(struct choosenode *cn) {
+  int n;
+  struct choosenode *r;
+
+  if(cn->flags & CN_EXPANDABLE) {
+    for(n = 0; n < cn->children.nvec; ++n)
+      if((r = first_search_result(cn->children.vec[n])))
+        return r;
+  } else if(is_search_result(cn->path))
+    return cn;
+  return 0;
 }
 
 /** @brief Called with a list of search results
@@ -581,7 +685,9 @@ static void search_completed(void attribute((unused)) *v,
   search_in_flight = 0;
   /* Contract any choosenodes that were only expanded to show search
    * results */
+  suppress_redisplay = 1;
   contract_contingent(root);
+  suppress_redisplay = 0;
   if(search_obsolete) {
     /* This search has been obsoleted by user input since it started.
      * Therefore we throw away the result and search again. */
@@ -593,15 +699,18 @@ static void search_completed(void attribute((unused)) *v,
     nsearchresults = nvec;
     if(nvec) {
       /* Create a new search hash for fast identification of results */
-      searchhash = hash_new(1);
+      searchhash = hash_new(sizeof(int));
       for(n = 0; n < nvec; ++n) {
+        int *const ip = xmalloc(sizeof (int *));
+        static const int minus_1 = -1;
+        *ip = n;
         /* The filename itself lives in the hash */
-        hash_add(searchhash, vec[n], "", HASH_INSERT_OR_REPLACE);
+        hash_add(searchhash, vec[n], ip, HASH_INSERT_OR_REPLACE);
         /* So do its ancestor directories */
         for(s = vec[n] + 1; *s; ++s) {
           if(*s == '/') {
             *s = 0;
-            hash_add(searchhash, vec[n], "", HASH_INSERT_OR_REPLACE);
+            hash_add(searchhash, vec[n], &minus_1, HASH_INSERT_OR_REPLACE);
             *s = '/';
           }
         }
@@ -616,9 +725,16 @@ static void search_completed(void attribute((unused)) *v,
         spw = progress_window_new("Fetching search results");
       /* Initiate expansion */
       expand_from(root);
+      /* The search results buttons are usable */
+      gtk_widget_set_sensitive(nextsearch, 1);
+      gtk_widget_set_sensitive(prevsearch, 1);
+      suppress_redisplay = 1;           /* avoid lots of redisplays */
     } else {
       searchhash = 0;                   /* for the gc */
-      redisplay_tree();                 /* remove search markers */
+      redisplay_tree("no search results"); /* remove search markers */
+      /* The search results buttons are not usable */
+      gtk_widget_set_sensitive(nextsearch, 0);
+      gtk_widget_set_sensitive(prevsearch, 0);
     }
   }
 }
@@ -666,6 +782,50 @@ static void clearsearch_clicked(GtkButton attribute((unused)) *button,
   gtk_entry_set_text(GTK_ENTRY(searchentry), "");
 }
 
+/** @brief Called when the 'next search result' button is clicked */
+static void next_clicked(GtkButton attribute((unused)) *button,
+                         gpointer attribute((unused)) userdata) {
+  /* We want to find the highest (lowest ymax) track that is below the current
+   * visible range */
+  int n;
+  const gdouble bottom = gtk_adjustment_get_value(vadjust) + vadjust->page_size;
+  const struct choosenode *candidate = 0;
+
+  for(n = 0; n < nsearchresults; ++n) {
+    const struct choosenode *const cn = searchnodes[n];
+
+    if(cn
+       && cn->ymax > bottom
+       && (candidate == 0
+           || cn->ymax < candidate->ymax))
+      candidate = cn;
+  }
+  if(candidate)
+    gtk_adjustment_clamp_page(vadjust, candidate->ymin, candidate->ymax);
+}
+
+/** @brief Called when the 'previous search result' button is clicked */
+static void prev_clicked(GtkButton attribute((unused)) *button,
+                         gpointer attribute((unused)) userdata) {
+  /* We want to find the lowest (greated ymax) track that is above the current
+   * visible range */
+  int n;
+  const gdouble top = gtk_adjustment_get_value(vadjust);
+  const struct choosenode *candidate = 0;
+
+  for(n = 0; n < nsearchresults; ++n) {
+    const struct choosenode *const cn = searchnodes[n];
+
+    if(cn
+       && cn->ymin  < top
+       && (candidate == 0
+           || cn->ymax > candidate->ymax))
+      candidate = cn;
+  }
+  if(candidate)
+    gtk_adjustment_clamp_page(vadjust, candidate->ymin, candidate->ymax);
+}
+
 /* Display functions ------------------------------------------------------- */
 
 /** @brief Delete all the widgets in the tree */
@@ -680,18 +840,33 @@ static void delete_widgets(struct choosenode *cn) {
 }
 
 /** @brief Update the display */
-static void redisplay_tree(void) {
+static void redisplay_tree(const char *why) {
   struct displaydata d;
   guint oldwidth, oldheight;
 
-  D(("redisplay_tree"));
+  D(("redisplay_tree %s", why));
+  if(suppress_redisplay) {
+    /*fprintf(stderr, "redisplay_tree %s suppressed\n", why);*/
+    return;
+  }
+  if(gets_in_flight) {
+    /*fprintf(stderr, "redisplay_tree %s suppressed (gets_in_flight)\n", why);*/
+    return;
+  }
+  INIT();
+  BEGIN(total);
+  /*fprintf(stderr, "redisplay_tree %s   *** NOT SUPPRESSED ***\n", why);*/
   /* We'll count these up empirically each time */
   files_selected = 0;
   files_visible = 0;
   /* Correct the layout and find out how much space it uses */
   MTAG_PUSH("display_tree");
+  searchnodes = nsearchresults ? xcalloc(nsearchresults, 
+                                         sizeof (struct choosenode *)) : 0;
   d = display_tree(root, 0, 0);
   MTAG_POP();
+
+  BEGIN(gtkbits);
   /* We must set the total size or scrolling will not work (it wouldn't be hard
    * for GtkLayout to figure it out for itself but presumably you're supposed
    * to be able to have widgets off the edge of the layuot.)
@@ -705,11 +880,19 @@ static void redisplay_tree(void) {
   if(oldwidth > d.width || oldheight > d.height)
     gtk_widget_queue_draw(chooselayout);
   gtk_layout_set_size(GTK_LAYOUT(chooselayout), d.width, d.height);
+  END(gtkbits);
   /* Notify the main menu of any recent changes */
+  BEGIN(menuupdate);
   menu_update(-1);
+  END(menuupdate);
+  END(total);
+  REPORT();
 }
 
 /** @brief Recursive step for redisplay_tree()
+ * @param cn Node to display
+ * @param x X coordinate for @p cn
+ * @param y Y coordinate for @p cn
  *
  * Makes sure all displayed widgets from CN down exist and are in their proper
  * place and return the maximum space used.
@@ -719,7 +902,7 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
   GtkRequisition req;
   struct displaydata d, cd;
   GdkPixbuf *pb;
-  const char *name;
+  const int search_result = is_search_result(cn->path);
   
   D(("display_tree %s %d,%d", cn->path, x, y));
 
@@ -729,6 +912,7 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
    * A non-expandable item has just a text label and no arrow.
    */
   if(!cn->container) {
+    BEGIN(new_widgets);
     MTAG_PUSH("make_widgets_1");
     /* Widgets need to be created */
     NW(hbox);
@@ -768,15 +952,21 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
     /* Show everything by default */
     gtk_widget_show_all(cn->container);
     MTAG_POP();
+    END(new_widgets);
   }
   assert(cn->container);
-  /* Make sure the widget name is right */
-  name = (cn->flags & CN_EXPANDABLE
-          ? "choose-dir"
-          : is_search_result(cn->path) ? "choose-search" : "choose");
-  gtk_widget_set_name(cn->label, name);
-  gtk_widget_set_name(cn->container, name);
+  /* Set colors */
+  BEGIN(colors);
+  if(search_result) {
+    gtk_widget_set_style(cn->container, search_style);
+    gtk_widget_set_style(cn->label, search_style);
+  } else {
+    gtk_widget_set_style(cn->container, layout_style);
+    gtk_widget_set_style(cn->label, layout_style);
+  }
+  END(colors);
   /* Make sure the icon is right */
+  BEGIN(markers);
   if(cn->flags & CN_EXPANDABLE)
     gtk_arrow_set(GTK_ARROW(cn->arrow),
                   cn->flags & CN_EXPANDED ? GTK_ARROW_DOWN : GTK_ARROW_RIGHT,
@@ -785,7 +975,9 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
     /* Make sure the queued marker is right */
     /* TODO: doesn't always work */
     (queued(cn->path) ? gtk_widget_show : gtk_widget_hide)(cn->marker);
+  END(markers);
   /* Put the widget in the right place */
+  BEGIN(location);
   if(cn->flags & CN_DISPLAYED)
     gtk_layout_move(GTK_LAYOUT(chooselayout), cn->container, x, y);
   else {
@@ -794,9 +986,12 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
     /* Now chooselayout has a ref to the container */
     g_object_unref(cn->container);
   }
+  END(location);
   /* Set the widget's selection status */
+  BEGIN(selection);
   if(!(cn->flags & CN_EXPANDABLE))
     display_selection(cn);
+  END(selection);
   /* Find the size used so we can get vertical positioning right. */
   gtk_widget_size_request(cn->container, &req);
   d.width = x + req.width;
@@ -815,14 +1010,19 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
       d.height = cd.height;
     }
   } else {
+    BEGIN(undisplay);
     for(n = 0; n < cn->children.nvec; ++n)
       undisplay_tree(cn->children.vec[n]);
+    END(undisplay);
   }
   if(!(cn->flags & CN_EXPANDABLE)) {
     ++files_visible;
     if(cn->flags & CN_SELECTED)
       ++files_selected;
   }
+  /* update the search results array */
+  if(search_result)
+    searchnodes[search_result - 1] = cn;
   /* report back how much space we used */
   D(("display_tree %s %d,%d total size %dx%d", cn->path, x, y,
      d.width, d.height));
@@ -987,6 +1187,7 @@ static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
       menuitems[n].handlerid = g_signal_connect
         (menuitems[n].w, "activate", G_CALLBACK(menuitems[n].activate), cn);
     }
+    set_tool_colors(menu);
     /* Pop up the menu */
     gtk_widget_show_all(menu);
     gtk_menu_popup(GTK_MENU(menu), 0, 0, 0, 0,
@@ -1198,6 +1399,15 @@ static const struct tabtype tabtype_choose = {
 
 /* Public entry points ----------------------------------------------------- */
 
+/** @brief Called to entirely reset the choose screen */
+static void choose_reset(void) {
+  if(root)
+    undisplay_tree(root);
+  root = newnode(0/*parent*/, "<root>", "All files", "",
+                 CN_EXPANDABLE, fill_root_node);
+  expand_node(root, 0);                 /* will call redisplay_tree */
+}
+
 /** @brief Create a track choice widget */
 GtkWidget *choose_widget(void) {
   int n;
@@ -1227,57 +1437,79 @@ GtkWidget *choose_widget(void) {
   /* Text entry box for search terms */
   NW(entry);
   searchentry = gtk_entry_new();
+  gtk_widget_set_style(searchentry, tool_style);
   g_signal_connect(searchentry, "changed", G_CALLBACK(searchentry_changed), 0);
   gtk_tooltips_set_tip(tips, searchentry, "Enter search terms here; search is automatic", "");
 
   /* Cancel button to clear the search */
   NW(button);
   clearsearch = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
+  gtk_widget_set_style(clearsearch, tool_style);
   g_signal_connect(G_OBJECT(clearsearch), "clicked",
                    G_CALLBACK(clearsearch_clicked), 0);
   gtk_tooltips_set_tip(tips, clearsearch, "Clear search terms", "");
 
-
-  /* hbox packs the search box and the cancel button together on a line */
+  /* Up and down buttons to find previous/next results; initially they are not
+   * usable as there are no search results. */
+  prevsearch = iconbutton("up.png", "Previous search result");
+  g_signal_connect(G_OBJECT(prevsearch), "clicked",
+                   G_CALLBACK(prev_clicked), 0);
+  gtk_widget_set_style(prevsearch, tool_style);
+  gtk_widget_set_sensitive(prevsearch, 0);
+  nextsearch = iconbutton("down.png", "Next search result");
+  g_signal_connect(G_OBJECT(nextsearch), "clicked",
+                   G_CALLBACK(next_clicked), 0);
+  gtk_widget_set_style(nextsearch, tool_style);
+  gtk_widget_set_sensitive(nextsearch, 0);
+
+  /* hbox packs the search tools button together on a line */
   NW(hbox);
   hbox = gtk_hbox_new(FALSE/*homogeneous*/, 1/*spacing*/);
   gtk_box_pack_start(GTK_BOX(hbox), searchentry,
                      TRUE/*expand*/, TRUE/*fill*/, 0/*padding*/);
-  gtk_box_pack_end(GTK_BOX(hbox), clearsearch,
-                   FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
+  gtk_box_pack_start(GTK_BOX(hbox), prevsearch,
+                     FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
+  gtk_box_pack_start(GTK_BOX(hbox), nextsearch,
+                     FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
+  gtk_box_pack_start(GTK_BOX(hbox), clearsearch,
+                     FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
   
   /* chooselayout contains the currently visible subset of the track
    * namespace */
   NW(layout);
   chooselayout = gtk_layout_new(0, 0);
-  root = newnode(0/*parent*/, "<root>", "All files", "",
-                 CN_EXPANDABLE, fill_root_node);
-  expand_node(root, 0);                 /* will call redisplay_tree */
+  gtk_widget_set_style(chooselayout, layout_style);
+  choose_reset();
+  register_reset(choose_reset);
   /* Create the popup menus */
   NW(menu);
   track_menu = gtk_menu_new();
+  gtk_widget_set_style(track_menu, tool_style);
   g_signal_connect(track_menu, "destroy", G_CALLBACK(gtk_widget_destroyed),
                    &track_menu);
   for(n = 0; track_menuitems[n].name; ++n) {
     NW(menu_item);
     track_menuitems[n].w = 
       gtk_menu_item_new_with_label(track_menuitems[n].name);
+    gtk_widget_set_style(track_menuitems[n].w, tool_style);
     gtk_menu_attach(GTK_MENU(track_menu), track_menuitems[n].w,
                     0, 1, n, n + 1);
   }
   NW(menu);
   dir_menu = gtk_menu_new();
+  gtk_widget_set_style(dir_menu, tool_style);
   g_signal_connect(dir_menu, "destroy", G_CALLBACK(gtk_widget_destroyed),
                    &dir_menu);
   for(n = 0; dir_menuitems[n].name; ++n) {
     NW(menu_item);
     dir_menuitems[n].w = 
       gtk_menu_item_new_with_label(dir_menuitems[n].name);
+    gtk_widget_set_style(dir_menuitems[n].w, tool_style);
     gtk_menu_attach(GTK_MENU(dir_menu), dir_menuitems[n].w,
                     0, 1, n, n + 1);
   }
   /* The layout is scrollable */
-  scrolled = scroll_widget(chooselayout, "choose");
+  scrolled = scroll_widget(chooselayout);
   vadjust = gtk_layout_get_vadjustment(GTK_LAYOUT(chooselayout));
 
   /* The scrollable layout and the search hbox go together in a vbox */
@@ -1294,7 +1526,7 @@ GtkWidget *choose_widget(void) {
 
 /** @brief Called when something we care about here might have changed */
 void choose_update(void) {
-  redisplay_tree();
+  redisplay_tree("choose_update");
 }
 
 /*