chiark - git - mdw - disorder/blob - disobedience/choose.c

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2006-2008 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file disobedience/choose.c
  21  * @brief Hierarchical track selection and search
  22  *
  23  * We don't use the built-in tree widgets because they require that you know
  24  * the children of a node on demand, and we have to wait for the server to tell
  25  * us.
  26  */
  27
  28 #include "disobedience.h"
  29 #include "timeval.h"
  30
  31 /* Choose track ------------------------------------------------------------ */
  32
  33 #if TDEBUG
  34 /* Timing */
  35 static struct {
  36   struct timeval total;
  37   struct timeval gtkbits;
  38   struct timeval menuupdate;
  39   struct timeval new_widgets;
  40   struct timeval undisplay;
  41   struct timeval colors;
  42   struct timeval markers;
  43   struct timeval location;
  44   struct timeval selection;
  45 } times;
  46
  47 #define BEGIN(WHAT) do {                        \
  48   struct timeval started##WHAT, finished##WHAT; \
  49   xgettimeofday(&started##WHAT, 0)
  50
  51 #define END(WHAT)                                                       \
  52   xgettimeofday(&finished##WHAT, 0);                                    \
  53   times.WHAT = tvadd(times.WHAT, tvsub(finished##WHAT, started##WHAT)); \
  54 } while(0)
  55
  56 #define INIT() memset(&times, 0, sizeof times)
  57
  58 #define REPORT() do {                           \
  59   fprintf(stderr, "total=%g\n"                  \
  60           "gtkbits=%g\n"                        \
  61           "menuupdate=%g\n"                     \
  62           "new_widgets=%g\n"                    \
  63           "undisplay=%g\n"                      \
  64           "colors=%g\n"                         \
  65           "markers=%g\n"                        \
  66           "location=%g\n"                       \
  67           "selection=%g\n"                      \
  68           "accumulation=%g\n"                   \
  69           "\n",                                 \
  70           tvdouble(times.total),                \
  71           tvdouble(times.gtkbits),              \
  72           tvdouble(times.menuupdate),           \
  73           tvdouble(times.new_widgets),          \
  74           tvdouble(times.undisplay),            \
  75           tvdouble(times.colors),               \
  76           tvdouble(times.markers),              \
  77           tvdouble(times.location),             \
  78           tvdouble(times.selection),            \
  79           (tvdouble(times.gtkbits)              \
  80            + tvdouble(times.menuupdate)         \
  81            + tvdouble(times.new_widgets)        \
  82            + tvdouble(times.undisplay)          \
  83            + tvdouble(times.colors)             \
  84            + tvdouble(times.markers)            \
  85            + tvdouble(times.location)           \
  86            + tvdouble(times.selection)));       \
  87 } while(0)
  88 #else
  89 #define BEGIN(WHAT) do {
  90 #define END(WHAT) } while(0)
  91 #define INIT() ((void)0)
  92 #define REPORT() ((void)0)
  93 #endif
  94
  95 WT(label);
  96 WT(event_box);
  97 WT(menu);
  98 WT(menu_item);
  99 WT(layout);
 100 WT(vbox);
 101 WT(arrow);
 102 WT(hbox);
 103 WT(button);
 104 WT(image);
 105 WT(entry);
 106
 107 /* Types */
 108
 109 struct choosenode;
 110
 111 /** @brief Accumulated information about the tree widget */
 112 struct displaydata {
 113   /** @brief Maximum width required */
 114   guint width;
 115   /** @brief Maximum height required */
 116   guint height;
 117 };
 118
 119 /* instantiate the node vector type */
 120
 121 VECTOR_TYPE(nodevector, struct choosenode *, xrealloc);
 122
 123 /** @brief Signature of function called when a choosenode is filled */
 124 typedef void (when_filled_callback)(struct choosenode *cn,
 125                                     void *wfu);
 126
 127 /** @brief One node in the virtual filesystem */
 128 struct choosenode {
 129   struct choosenode *parent;            /**< @brief parent node */
 130   const char *path;                     /**< @brief full path or 0  */
 131   const char *sort;                     /**< @brief sort key */
 132   const char *display;                  /**< @brief display name */
 133   int pending;                          /**< @brief pending resolve queries */
 134   unsigned flags;
 135 #define CN_EXPANDABLE 0x0001            /**< @brief node is expandable */
 136 #define CN_EXPANDED 0x0002              /**< @brief node is expanded
 137                                          *
 138                                          * Expandable items are directories;
 139                                          * non-expandable ones are files. */
 140 #define CN_DISPLAYED 0x0004             /**< @brief widget is displayed in layout */
 141 #define CN_SELECTED 0x0008              /**< @brief node is selected */
 142 #define CN_GETTING_FILES 0x0010         /**< @brief files inbound */
 143 #define CN_RESOLVING_FILES 0x0020       /**< @brief resolved files inbound */
 144 #define CN_GETTING_DIRS 0x0040          /**< @brief directories inbound */
 145 #define CN_GETTING_ANY 0x0070           /**< @brief getting something */
 146 #define CN_CONTINGENT 0x0080            /**< @brief expansion contingent on search */
 147   struct nodevector children;           /**< @brief vector of children */
 148   void (*fill)(struct choosenode *);    /**< @brief request child fill or 0 for leaf */
 149   GtkWidget *container;                 /**< @brief the container for this row */
 150   GtkWidget *hbox;                      /**< @brief the hbox for this row */
 151   GtkWidget *arrow;                     /**< @brief arrow widget or 0 */
 152   GtkWidget *label;                     /**< @brief text label for this node */
 153   GtkWidget *marker;                    /**< @brief queued marker */
 154
 155   when_filled_callback *whenfilled;     /**< @brief called when filled or 0 */
 156   void *wfu;                            /**< @brief passed to @c whenfilled */
 157   int ymin;                             /**< @brief least Y value */
 158   int ymax;                             /**< @brief greatest Y value */
 159 };
 160
 161 /** @brief One item in the popup menu */
 162 struct choose_menuitem {
 163   /* Parameters */
 164   const char *name;                     /**< @brief name */
 165
 166   /* Callbacks */
 167   void (*activate)(GtkMenuItem *menuitem, gpointer user_data);
 168   /**< @brief Called to activate the menu item.
 169    *
 170    * @p user_data is the choosenode the mouse pointer is over. */
 171
 172   gboolean (*sensitive)(struct choosenode *cn);
 173   /* @brief Called to determine whether the menu item should be sensitive.
 174    *
 175    * TODO? */
 176
 177   /* State */
 178   gulong handlerid;                     /**< @brief signal handler ID */
 179   GtkWidget *w;                         /**< @brief menu item widget */
 180 };
 181
 182 /* Variables */
 183
 184 static GtkWidget *chooselayout;
 185 static GtkAdjustment *vadjust;
 186 static GtkWidget *searchentry;          /**< @brief search terms */
 187 static GtkWidget *nextsearch;           /**< @brief next search result */
 188 static GtkWidget *prevsearch;           /**< @brief previous search result */
 189 static struct choosenode *root;
 190 static GtkWidget *track_menu;           /**< @brief track popup menu */
 191 static GtkWidget *dir_menu;             /**< @brief directory popup menu */
 192 static struct choosenode *last_click;   /**< @brief last clicked node for selection */
 193 static int files_visible;               /**< @brief total files visible */
 194 static int files_selected;              /**< @brief total files selected */
 195 static int gets_in_flight;              /**< @brief total gets in flight */
 196 static int search_in_flight;            /**< @brief a search is underway */
 197 static int search_obsolete;             /**< @brief the current search is void */
 198 static char **searchresults;            /**< @brief search results */
 199 static int nsearchresults;              /**< @brief number of results */
 200 static int nsearchvisible;      /**< @brief number of search results visible */
 201 static struct hash *searchhash;         /**< @brief hash of search results */
 202 static struct progress_window *spw;     /**< @brief progress window */
 203 static struct choosenode **searchnodes; /**< @brief choosenodes of search results */
 204 static int suppress_redisplay;          /**< @brief suppress redisplay */
 205
 206 /* Forward Declarations */
 207
 208 static void clear_children(struct choosenode *cn);
 209 static struct choosenode *newnode(struct choosenode *parent,
 210                                   const char *path,
 211                                   const char *display,
 212                                   const char *sort,
 213                                   unsigned flags,
 214                                   void (*fill)(struct choosenode *));
 215 static void fill_root_node(struct choosenode *cn);
 216 static void fill_directory_node(struct choosenode *cn);
 217 static void got_files(void *v, int nvec, char **vec);
 218 static void got_resolved_file(void *v, const char *error, const char *track);
 219 static void got_dirs(void *v, int nvec, char **vec);
 220
 221 static void expand_node(struct choosenode *cn, int contingent);
 222 static void contract_node(struct choosenode *cn);
 223 static void updated_node(struct choosenode *cn, int redisplay,
 224                          const char *why);
 225
 226 static void display_selection(struct choosenode *cn);
 227 static void clear_selection(struct choosenode *cn);
 228
 229 static void redisplay_tree(const char *why);
 230 static struct displaydata display_tree(struct choosenode *cn, int x, int y);
 231 static void undisplay_tree(struct choosenode *cn);
 232 static void initiate_search(void);
 233 static void delete_widgets(struct choosenode *cn);
 234 static void expand_from(struct choosenode *cn);
 235 static struct choosenode *first_search_result(struct choosenode *cn);
 236
 237 static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
 238                                GdkEventButton *event,
 239                                gpointer user_data);
 240
 241 static void activate_track_play(GtkMenuItem *menuitem, gpointer user_data);
 242 static void activate_track_properties(GtkMenuItem *menuitem, gpointer user_data);
 243
 244 static gboolean sensitive_track_play(struct choosenode *cn);
 245 static gboolean sensitive_track_properties(struct choosenode *cn);
 246
 247 static void activate_dir_play(GtkMenuItem *menuitem, gpointer user_data);
 248 static void activate_dir_properties(GtkMenuItem *menuitem, gpointer user_data);
 249 static void activate_dir_select(GtkMenuItem *menuitem, gpointer user_data);
 250
 251 static gboolean sensitive_dir_play(struct choosenode *cn);
 252 static gboolean sensitive_dir_properties(struct choosenode *cn);
 253 static gboolean sensitive_dir_select(struct choosenode *cn);
 254
 255 /** @brief Track menu items */
 256 static struct choose_menuitem track_menuitems[] = {
 257   { "Play track", activate_track_play, sensitive_track_play, 0, 0 },
 258   { "Track properties", activate_track_properties, sensitive_track_properties, 0, 0 },
 259   { 0, 0, 0, 0, 0 }
 260 };
 261
 262 /** @brief Directory menu items */
 263 static struct choose_menuitem dir_menuitems[] = {
 264   { "Play all tracks", activate_dir_play, sensitive_dir_play, 0, 0 },
 265   { "Track properties", activate_dir_properties, sensitive_dir_properties, 0, 0 },
 266   { "Select all tracks", activate_dir_select, sensitive_dir_select, 0, 0 },
 267   { 0, 0, 0, 0, 0 }
 268 };
 269
 270 /* Maintaining the data structure ------------------------------------------ */
 271
 272 static char *cnflags(const struct choosenode *cn) {
 273   unsigned f = cn->flags, n;
 274   struct dynstr d[1];
 275
 276   static const char *bits[] = {
 277     "expandable",
 278     "expanded",
 279     "displayed",
 280     "selected",
 281     "getting_files",
 282     "resolving_files",
 283     "getting_dirs",
 284     "contingent"
 285   };
 286 #define NBITS (sizeof bits / sizeof *bits)
 287
 288   dynstr_init(d);
 289   if(!f)
 290     dynstr_append(d, '0');
 291   else {
 292     for(n = 0; n < NBITS; ++n) {
 293       const unsigned bit = 1 << n;
 294       if(f & bit) {
 295         if(d->nvec)
 296           dynstr_append(d, '|');
 297         dynstr_append_string(d, bits[n]);
 298         f ^= bit;
 299       }
 300     }
 301     if(f) {
 302       char buf[32];
 303       if(d->nvec)
 304         dynstr_append(d, '|');
 305       sprintf(buf, "%#x", f);
 306       dynstr_append_string(d, buf);
 307     }
 308   }
 309   dynstr_terminate(d);
 310   return d->vec;
 311 }
 312
 313 /** @brief Create a new node */
 314 static struct choosenode *newnode(struct choosenode *parent,
 315                                   const char *path,
 316                                   const char *display,
 317                                   const char *sort,
 318                                   unsigned flags,
 319                                   void (*fill)(struct choosenode *)) {
 320   struct choosenode *const n = xmalloc(sizeof *n);
 321
 322   D(("newnode %s %s", path, display));
 323   if(flags & CN_EXPANDABLE)
 324     assert(fill);
 325   else
 326     assert(!fill);
 327   n->parent = parent;
 328   n->path = path;
 329   n->display = display;
 330   n->sort = sort;
 331   n->flags = flags;
 332   nodevector_init(&n->children);
 333   n->fill = fill;
 334   if(parent)
 335     nodevector_append(&parent->children, n);
 336   return n;
 337 }
 338
 339 /** @brief Called when a node has been filled
 340  *
 341  * Response for calling @c whenfilled.
 342  */
 343 static void filled(struct choosenode *cn) {
 344   when_filled_callback *const whenfilled = cn->whenfilled;
 345
 346   if(whenfilled) {
 347     cn->whenfilled = 0;
 348     whenfilled(cn, cn->wfu);
 349   }
 350   if(nsearchvisible < nsearchresults) {
 351     /* There is still search expansion work to do */
 352     D(("filled %s %d/%d", cn->path, nsearchvisible, nsearchresults));
 353     expand_from(cn);
 354   }
 355   if(gets_in_flight == 0 && nsearchvisible < nsearchresults)
 356     expand_from(root);
 357 }
 358
 359 /** @brief Fill the root */
 360 static void fill_root_node(struct choosenode *cn) {
 361   struct callbackdata *cbd;
 362
 363   D(("fill_root_node"));
 364   clear_children(cn);
 365   /* More de-duping possible here */
 366   if(cn->flags & CN_GETTING_ANY)
 367     return;
 368   gtk_label_set_text(GTK_LABEL(report_label), "getting files");
 369   cbd = xmalloc(sizeof *cbd);
 370   cbd->u.choosenode = cn;
 371   disorder_eclient_dirs(client, got_dirs, "", 0, cbd);
 372   cbd = xmalloc(sizeof *cbd);
 373   cbd->u.choosenode = cn;
 374   disorder_eclient_files(client, got_files, "", 0, cbd);
 375   cn->flags |= CN_GETTING_FILES|CN_GETTING_DIRS;
 376   gets_in_flight += 2;
 377 }
 378
 379 /** @brief Delete all the widgets owned by @p cn */
 380 static void delete_cn_widgets(struct choosenode *cn) {
 381   if(cn->arrow) {
 382     DW(arrow);
 383     gtk_widget_destroy(cn->arrow);
 384     cn->arrow = 0;
 385   }
 386   if(cn->label) {
 387     DW(label);
 388     gtk_widget_destroy(cn->label);
 389     cn->label = 0;
 390   }
 391   if(cn->marker) {
 392     DW(image);
 393     gtk_widget_destroy(cn->marker);
 394     cn->marker = 0;
 395   }
 396   if(cn->hbox) {
 397     DW(hbox);
 398     gtk_widget_destroy(cn->hbox);
 399     cn->hbox = 0;
 400   }
 401   if(cn->container) {
 402     DW(event_box);
 403     gtk_widget_destroy(cn->container);
 404     cn->container = 0;
 405   }
 406 }
 407
 408 /** @brief Recursively clear all the children of @p cn
 409  *
 410  * All the widgets at or below @p cn are deleted.  All choosenodes below
 411  * it are emptied. i.e. we prune the tree at @p cn.
 412  */
 413 static void clear_children(struct choosenode *cn) {
 414   int n;
 415
 416   D(("clear_children %s", cn->path));
 417   /* Recursively clear subtrees */
 418   for(n = 0; n < cn->children.nvec; ++n) {
 419     clear_children(cn->children.vec[n]);
 420     delete_cn_widgets(cn->children.vec[n]);
 421   }
 422   cn->children.nvec = 0;
 423 }
 424
 425 /** @brief Called with a list of files just below some node */
 426 static void got_files(void *v, int nvec, char **vec) {
 427   struct callbackdata *cbd = v;
 428   struct choosenode *cn = cbd->u.choosenode;
 429   int n;
 430
 431   D(("got_files %d files for %s %s", nvec, cn->path, cnflags(cn)));
 432   /* Complicated by the need to resolve aliases. */
 433   cn->flags &= ~CN_GETTING_FILES;
 434   --gets_in_flight;
 435   if((cn->pending = nvec)) {
 436     cn->flags |= CN_RESOLVING_FILES;
 437     for(n = 0; n < nvec; ++n) {
 438       disorder_eclient_resolve(client, got_resolved_file, vec[n], cn);
 439       ++gets_in_flight;
 440     }
 441   }
 442   /* If there are no files and the directories are all read by now, we're
 443    * done */
 444   if(!(cn->flags & CN_GETTING_ANY))
 445     filled(cn);
 446   if(!gets_in_flight)
 447     redisplay_tree("got_files");
 448 }
 449
 450 /** @brief Called with an alias resolved filename */
 451 static void got_resolved_file(void *v, const char *error, const char *track) {
 452   struct choosenode *const cn = v, *file_cn;
 453
 454   if(error) {
 455     popup_protocol_error(0, error);
 456   } else {
 457     D(("resolved %s %s %d left", cn->path, cnflags(cn), cn->pending - 1));
 458     /* TODO as below */
 459     file_cn = newnode(cn, track,
 460                       trackname_transform("track", track, "display"),
 461                       trackname_transform("track", track, "sort"),
 462                       0/*flags*/, 0/*fill*/);
 463     --gets_in_flight;
 464     /* Only bother updating when we've got the lot */
 465     if(--cn->pending == 0) {
 466       cn->flags &= ~CN_RESOLVING_FILES;
 467       updated_node(cn, gets_in_flight == 0, "got_resolved_file");
 468       if(!(cn->flags & CN_GETTING_ANY))
 469         filled(cn);
 470     }
 471   }
 472 }
 473
 474 /** @brief Called with a list of directories just below some node */
 475 static void got_dirs(void *v, int nvec, char **vec) {
 476   struct callbackdata *cbd = v;
 477   struct choosenode *cn = cbd->u.choosenode;
 478   int n;
 479
 480   D(("got_dirs %d dirs for %s %s", nvec, cn->path, cnflags(cn)));
 481   /* TODO this depends on local configuration for trackname_transform().
 482    * This will work, since the defaults are now built-in, but it'll be
 483    * (potentially) different to the server's configured settings.
 484    *
 485    * Really we want a variant of files/dirs that produces both the
 486    * raw filename and the transformed name for a chosen context.
 487    */
 488   --gets_in_flight;
 489   for(n = 0; n < nvec; ++n)
 490     newnode(cn, vec[n],
 491             trackname_transform("dir", vec[n], "display"),
 492             trackname_transform("dir", vec[n], "sort"),
 493             CN_EXPANDABLE, fill_directory_node);
 494   updated_node(cn, gets_in_flight == 0, "got_dirs");
 495   cn->flags &= ~CN_GETTING_DIRS;
 496   if(!(cn->flags & CN_GETTING_ANY))
 497     filled(cn);
 498 }
 499
 500 /** @brief Fill a child node */
 501 static void fill_directory_node(struct choosenode *cn) {
 502   struct callbackdata *cbd;
 503
 504   D(("fill_directory_node %s", cn->path));
 505   /* TODO: caching */
 506   if(cn->flags & CN_GETTING_ANY)
 507     return;
 508   assert(report_label != 0);
 509   gtk_label_set_text(GTK_LABEL(report_label), "getting files");
 510   clear_children(cn);
 511   cbd = xmalloc(sizeof *cbd);
 512   cbd->u.choosenode = cn;
 513   disorder_eclient_dirs(client, got_dirs, cn->path, 0, cbd);
 514   cbd = xmalloc(sizeof *cbd);
 515   cbd->u.choosenode = cn;
 516   disorder_eclient_files(client, got_files, cn->path, 0, cbd);
 517   cn->flags |= CN_GETTING_FILES|CN_GETTING_DIRS;
 518   gets_in_flight += 2;
 519 }
 520
 521 /** @brief Expand a node */
 522 static void expand_node(struct choosenode *cn, int contingent) {
 523   D(("expand_node %s %d %s", cn->path, contingent, cnflags(cn)));
 524   assert(cn->flags & CN_EXPANDABLE);
 525   /* If node is already expanded do nothing. */
 526   if(cn->flags & CN_EXPANDED) return;
 527   /* We mark the node as expanded and request that it fill itself.  When it has
 528    * completed it will called updated_node() and we can redraw at that
 529    * point. */
 530   cn->flags |= CN_EXPANDED;
 531   if(contingent)
 532     cn->flags |= CN_CONTINGENT;
 533   else
 534     cn->flags &= ~CN_CONTINGENT;
 535   /* If this node is not contingently expanded, mark all its parents back to
 536    * the root as not contingent either, so they won't be contracted when the
 537    * search results change */
 538   if(!contingent) {
 539     struct choosenode *cnp;
 540
 541     for(cnp = cn->parent; cnp; cnp = cnp->parent)
 542       cnp->flags &= ~CN_CONTINGENT;
 543   }
 544   /* TODO: visual feedback */
 545   cn->fill(cn);
 546 }
 547
 548 /** @brief Make sure all the search results below @p cn are expanded
 549  * @param cn Node to start at
 550  */
 551 static void expand_from(struct choosenode *cn) {
 552   int n;
 553
 554   if(nsearchvisible == nsearchresults)
 555     /* We're done */
 556     return;
 557   /* Are any of the search tracks at/below this point? */
 558   if(!(cn == root || hash_find(searchhash, cn->path)))
 559     return;
 560   D(("expand_from %d/%d visible %s",
 561      nsearchvisible, nsearchresults, cn->path));
 562   if(cn->flags & CN_EXPANDABLE) {
 563     if(cn->flags & CN_EXPANDED)
 564       /* This node is marked as expanded already.  children.nvec might be 0,
 565        * indicating that expansion is still underway.  We should get another
 566        * callback when it is expanded. */
 567       for(n = 0; n < cn->children.nvec && gets_in_flight < 10; ++n)
 568         expand_from(cn->children.vec[n]);
 569     else {
 570       /* This node is not expanded yet */
 571       expand_node(cn, 1);
 572     }
 573   } else {
 574     /* This is an actual search result */
 575     ++nsearchvisible;
 576     progress_window_progress(spw, nsearchvisible, nsearchresults);
 577     if(nsearchvisible == nsearchresults) {
 578       if(suppress_redisplay) {
 579         suppress_redisplay = 0;
 580         redisplay_tree("all search results visible");
 581       }
 582       /* We've got the lot.  We make sure the first result is visible. */
 583       cn = first_search_result(root);
 584       gtk_adjustment_clamp_page(vadjust, cn->ymin, cn->ymax);
 585     }
 586   }
 587 }
 588
 589 /** @brief Contract all contingently expanded nodes below @p cn */
 590 static void contract_contingent(struct choosenode *cn) {
 591   int n;
 592
 593   if(cn->flags & CN_CONTINGENT)
 594     contract_node(cn);
 595   else
 596     for(n = 0; n < cn->children.nvec; ++n)
 597       contract_contingent(cn->children.vec[n]);
 598 }
 599
 600 /** @brief Contract a node */
 601 static void contract_node(struct choosenode *cn) {
 602   D(("contract_node %s", cn->path));
 603   assert(cn->flags & CN_EXPANDABLE);
 604   /* If node is already contracted do nothing. */
 605   if(!(cn->flags & CN_EXPANDED)) return;
 606   cn->flags &= ~(CN_EXPANDED|CN_CONTINGENT);
 607   /* Clear selection below this node */
 608   clear_selection(cn);
 609   /* Zot children.  We never used to do this but the result would be that over
 610    * time you'd end up with the entire tree pulled into memory.  If the server
 611    * is over a slow network it will make interactivity slightly worse; if
 612    * anyone complains we can make it an option. */
 613   clear_children(cn);
 614   /* We can contract a node immediately. */
 615   redisplay_tree("contract_node");
 616 }
 617
 618 /** @brief qsort() callback for ordering choosenodes */
 619 static int compare_choosenode(const void *av, const void *bv) {
 620   const struct choosenode *const *aa = av, *const *bb = bv;
 621   const struct choosenode *a = *aa, *b = *bb;
 622
 623   return compare_tracks(a->sort, b->sort,
 624                         a->display, b->display,
 625                         a->path, b->path);
 626 }
 627
 628 /** @brief Called when an expandable node is updated.   */
 629 static void updated_node(struct choosenode *cn, int redisplay,
 630                          const char *why) {
 631   D(("updated_node %s", cn->path));
 632   assert(cn->flags & CN_EXPANDABLE);
 633   /* It might be that the node has been de-expanded since we requested the
 634    * update.  In that case we ignore this notification. */
 635   if(!(cn->flags & CN_EXPANDED)) return;
 636   /* Sort children */
 637   qsort(cn->children.vec, cn->children.nvec, sizeof (struct choosenode *),
 638         compare_choosenode);
 639   if(redisplay) {
 640     char whywhy[1024];
 641
 642     snprintf(whywhy, sizeof whywhy, "updated_node %s", why);
 643     redisplay_tree(whywhy);
 644   }
 645 }
 646
 647 /* Searching --------------------------------------------------------------- */
 648
 649 /** @brief Return true if @p track is a search result
 650  *
 651  * In particular the return value is one more than the index of the track
 652  * @p searchresults.
 653  */
 654 static int is_search_result(const char *track) {
 655   void *r;
 656
 657   if(searchhash && (r = hash_find(searchhash, track)))
 658     return 1 + *(int *)r;
 659   else
 660     return 0;
 661 }
 662
 663 /** @brief Return the first search result at or below @p cn */
 664 static struct choosenode *first_search_result(struct choosenode *cn) {
 665   int n;
 666   struct choosenode *r;
 667
 668   if(cn->flags & CN_EXPANDABLE) {
 669     for(n = 0; n < cn->children.nvec; ++n)
 670       if((r = first_search_result(cn->children.vec[n])))
 671         return r;
 672   } else if(is_search_result(cn->path))
 673     return cn;
 674   return 0;
 675 }
 676
 677 /** @brief Called with a list of search results
 678  *
 679  * This is called from eclient with a (possibly empty) list of search results,
 680  * and also from initiate_seatch with an always empty list to indicate that
 681  * we're not searching for anything in particular. */
 682 static void search_completed(void attribute((unused)) *v,
 683                              int nvec, char **vec) {
 684   int n;
 685   char *s;
 686
 687   search_in_flight = 0;
 688   /* Contract any choosenodes that were only expanded to show search
 689    * results */
 690   suppress_redisplay = 1;
 691   contract_contingent(root);
 692   suppress_redisplay = 0;
 693   if(search_obsolete) {
 694     /* This search has been obsoleted by user input since it started.
 695      * Therefore we throw away the result and search again. */
 696     search_obsolete = 0;
 697     initiate_search();
 698   } else {
 699     /* Stash the search results */
 700     searchresults = vec;
 701     nsearchresults = nvec;
 702     if(nvec) {
 703       /* Create a new search hash for fast identification of results */
 704       searchhash = hash_new(sizeof(int));
 705       for(n = 0; n < nvec; ++n) {
 706         int *const ip = xmalloc(sizeof (int *));
 707         static const int minus_1 = -1;
 708         *ip = n;
 709         /* The filename itself lives in the hash */
 710         hash_add(searchhash, vec[n], ip, HASH_INSERT_OR_REPLACE);
 711         /* So do its ancestor directories */
 712         for(s = vec[n] + 1; *s; ++s) {
 713           if(*s == '/') {
 714             *s = 0;
 715             hash_add(searchhash, vec[n], &minus_1, HASH_INSERT_OR_REPLACE);
 716             *s = '/';
 717           }
 718         }
 719       }
 720       /* We don't yet know that the results are visible */
 721       nsearchvisible = 0;
 722       if(spw) {
 723         progress_window_progress(spw, 0, 0);
 724         spw = 0;
 725       }
 726       if(nsearchresults > 50)
 727         spw = progress_window_new("Fetching search results");
 728       /* Initiate expansion */
 729       expand_from(root);
 730       /* The search results buttons are usable */
 731       gtk_widget_set_sensitive(nextsearch, 1);
 732       gtk_widget_set_sensitive(prevsearch, 1);
 733       suppress_redisplay = 1;           /* avoid lots of redisplays */
 734     } else {
 735       searchhash = 0;                   /* for the gc */
 736       redisplay_tree("no search results"); /* remove search markers */
 737       /* The search results buttons are not usable */
 738       gtk_widget_set_sensitive(nextsearch, 0);
 739       gtk_widget_set_sensitive(prevsearch, 0);
 740     }
 741   }
 742 }
 743
 744 /** @brief Initiate a search
 745  *
 746  * If a search is underway we set @ref search_obsolete and restart the search
 747  * in search_completed() above.
 748  */
 749 static void initiate_search(void) {
 750   char *terms, *e;
 751
 752   /* Find out what the user is after */
 753   terms = xstrdup(gtk_entry_get_text(GTK_ENTRY(searchentry)));
 754   /* Strip leading and trailing space */
 755   while(*terms == ' ') ++terms;
 756   e = terms + strlen(terms);
 757   while(e > terms && e[-1] == ' ') --e;
 758   *e = 0;
 759   /* If a search is already underway then mark it as obsolete.  We'll revisit
 760    * when it returns. */
 761   if(search_in_flight) {
 762     search_obsolete = 1;
 763     return;
 764   }
 765   if(*terms) {
 766     /* There's still something left.  Initiate the search. */
 767     if(disorder_eclient_search(client, search_completed, terms, 0)) {
 768       /* The search terms are bad!  We treat this as if there were no search
 769        * terms at all.  Some kind of feedback would be handy. */
 770       fprintf(stderr, "bad terms [%s]\n", terms); /* TODO */
 771       search_completed(0, 0, 0);
 772     } else {
 773       search_in_flight = 1;
 774     }
 775   } else {
 776     /* No search terms - we want to see all tracks */
 777     search_completed(0, 0, 0);
 778   }
 779 }
 780
 781 /** @brief Called when the cancel search button is clicked */
 782 static void clearsearch_clicked(GtkButton attribute((unused)) *button,
 783                                 gpointer attribute((unused)) userdata) {
 784   gtk_entry_set_text(GTK_ENTRY(searchentry), "");
 785 }
 786
 787 /** @brief Called when the 'next search result' button is clicked */
 788 static void next_clicked(GtkButton attribute((unused)) *button,
 789                          gpointer attribute((unused)) userdata) {
 790   /* We want to find the highest (lowest ymax) track that is below the current
 791    * visible range */
 792   int n;
 793   const gdouble bottom = gtk_adjustment_get_value(vadjust) + vadjust->page_size;
 794   const struct choosenode *candidate = 0;
 795
 796   for(n = 0; n < nsearchresults; ++n) {
 797     const struct choosenode *const cn = searchnodes[n];
 798
 799     if(cn
 800        && cn->ymax > bottom
 801        && (candidate == 0
 802            || cn->ymax < candidate->ymax))
 803       candidate = cn;
 804   }
 805   if(candidate)
 806     gtk_adjustment_clamp_page(vadjust, candidate->ymin, candidate->ymax);
 807 }
 808
 809 /** @brief Called when the 'previous search result' button is clicked */
 810 static void prev_clicked(GtkButton attribute((unused)) *button,
 811                          gpointer attribute((unused)) userdata) {
 812   /* We want to find the lowest (greated ymax) track that is above the current
 813    * visible range */
 814   int n;
 815   const gdouble top = gtk_adjustment_get_value(vadjust);
 816   const struct choosenode *candidate = 0;
 817
 818   for(n = 0; n < nsearchresults; ++n) {
 819     const struct choosenode *const cn = searchnodes[n];
 820
 821     if(cn
 822        && cn->ymin  < top
 823        && (candidate == 0
 824            || cn->ymax > candidate->ymax))
 825       candidate = cn;
 826   }
 827   if(candidate)
 828     gtk_adjustment_clamp_page(vadjust, candidate->ymin, candidate->ymax);
 829 }
 830
 831 /* Display functions ------------------------------------------------------- */
 832
 833 /** @brief Delete all the widgets in the tree */
 834 static void delete_widgets(struct choosenode *cn) {
 835   int n;
 836
 837   delete_cn_widgets(cn);
 838   for(n = 0; n < cn->children.nvec; ++n)
 839     delete_widgets(cn->children.vec[n]);
 840   cn->flags &= ~(CN_DISPLAYED|CN_SELECTED);
 841   files_selected = 0;
 842 }
 843
 844 /** @brief Update the display */
 845 static void redisplay_tree(const char *why) {
 846   struct displaydata d;
 847   guint oldwidth, oldheight;
 848
 849   D(("redisplay_tree %s", why));
 850   if(suppress_redisplay) {
 851     /*fprintf(stderr, "redisplay_tree %s suppressed\n", why);*/
 852     return;
 853   }
 854   if(gets_in_flight) {
 855     /*fprintf(stderr, "redisplay_tree %s suppressed (gets_in_flight)\n", why);*/
 856     return;
 857   }
 858   INIT();
 859   BEGIN(total);
 860   /*fprintf(stderr, "redisplay_tree %s   *** NOT SUPPRESSED ***\n", why);*/
 861   /* We'll count these up empirically each time */
 862   files_selected = 0;
 863   files_visible = 0;
 864   /* Correct the layout and find out how much space it uses */
 865   MTAG_PUSH("display_tree");
 866   searchnodes = nsearchresults ? xcalloc(nsearchresults,
 867                                          sizeof (struct choosenode *)) : 0;
 868   d = display_tree(root, 0, 0);
 869   MTAG_POP();
 870
 871   BEGIN(gtkbits);
 872   /* We must set the total size or scrolling will not work (it wouldn't be hard
 873    * for GtkLayout to figure it out for itself but presumably you're supposed
 874    * to be able to have widgets off the edge of the layuot.)
 875    *
 876    * There is a problem: if we shrink the size then the part of the screen that
 877    * is outside the new size but inside the old one is not updated.  I think
 878    * this is arguably bug in GTK+ but it's easy to force a redraw if this
 879    * region is nonempty.
 880    */
 881   gtk_layout_get_size(GTK_LAYOUT(chooselayout), &oldwidth, &oldheight);
 882   if(oldwidth > d.width || oldheight > d.height)
 883     gtk_widget_queue_draw(chooselayout);
 884   gtk_layout_set_size(GTK_LAYOUT(chooselayout), d.width, d.height);
 885   END(gtkbits);
 886   /* Notify the main menu of any recent changes */
 887   BEGIN(menuupdate);
 888   menu_update(-1);
 889   END(menuupdate);
 890   END(total);
 891   REPORT();
 892 }
 893
 894 /** @brief Recursive step for redisplay_tree()
 895  * @param cn Node to display
 896  * @param x X coordinate for @p cn
 897  * @param y Y coordinate for @p cn
 898  *
 899  * Makes sure all displayed widgets from CN down exist and are in their proper
 900  * place and return the maximum space used.
 901  */
 902 static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
 903   int n, aw;
 904   GtkRequisition req;
 905   struct displaydata d, cd;
 906   GdkPixbuf *pb;
 907   const int search_result = is_search_result(cn->path);
 908
 909   D(("display_tree %s %d,%d", cn->path, x, y));
 910
 911   /* An expandable item contains an arrow and a text label.  When you press the
 912    * button it flips its expand state.
 913    *
 914    * A non-expandable item has just a text label and no arrow.
 915    */
 916   if(!cn->container) {
 917     BEGIN(new_widgets);
 918     MTAG_PUSH("make_widgets_1");
 919     /* Widgets need to be created */
 920     NW(hbox);
 921     cn->hbox = gtk_hbox_new(FALSE, 1);
 922     if(cn->flags & CN_EXPANDABLE) {
 923       NW(arrow);
 924       cn->arrow = gtk_arrow_new(cn->flags & CN_EXPANDED ? GTK_ARROW_DOWN
 925                                                         : GTK_ARROW_RIGHT,
 926                                 GTK_SHADOW_NONE);
 927       cn->marker = 0;
 928     } else {
 929       cn->arrow = 0;
 930       if((pb = find_image("notes.png"))) {
 931         NW(image);
 932         cn->marker = gtk_image_new_from_pixbuf(pb);
 933       }
 934     }
 935     MTAG_POP();
 936     MTAG_PUSH("make_widgets_2");
 937     NW(label);
 938     cn->label = gtk_label_new(cn->display);
 939     if(cn->arrow)
 940       gtk_container_add(GTK_CONTAINER(cn->hbox), cn->arrow);
 941     gtk_container_add(GTK_CONTAINER(cn->hbox), cn->label);
 942     if(cn->marker)
 943       gtk_container_add(GTK_CONTAINER(cn->hbox), cn->marker);
 944     MTAG_POP();
 945     MTAG_PUSH("make_widgets_3");
 946     NW(event_box);
 947     cn->container = gtk_event_box_new();
 948     gtk_container_add(GTK_CONTAINER(cn->container), cn->hbox);
 949     g_signal_connect(cn->container, "button-release-event",
 950                      G_CALLBACK(clicked_choosenode), cn);
 951     g_signal_connect(cn->container, "button-press-event",
 952                      G_CALLBACK(clicked_choosenode), cn);
 953     g_object_ref(cn->container);
 954     /* Show everything by default */
 955     gtk_widget_show_all(cn->container);
 956     MTAG_POP();
 957     END(new_widgets);
 958   }
 959   assert(cn->container);
 960   /* Set colors */
 961   BEGIN(colors);
 962   if(search_result) {
 963     gtk_widget_set_style(cn->container, search_style);
 964     gtk_widget_set_style(cn->label, search_style);
 965   } else {
 966     gtk_widget_set_style(cn->container, layout_style);
 967     gtk_widget_set_style(cn->label, layout_style);
 968   }
 969   END(colors);
 970   /* Make sure the icon is right */
 971   BEGIN(markers);
 972   if(cn->flags & CN_EXPANDABLE)
 973     gtk_arrow_set(GTK_ARROW(cn->arrow),
 974                   cn->flags & CN_EXPANDED ? GTK_ARROW_DOWN : GTK_ARROW_RIGHT,
 975                   GTK_SHADOW_NONE);
 976   else if(cn->marker)
 977     /* Make sure the queued marker is right */
 978     /* TODO: doesn't always work */
 979     (queued(cn->path) ? gtk_widget_show : gtk_widget_hide)(cn->marker);
 980   END(markers);
 981   /* Put the widget in the right place */
 982   BEGIN(location);
 983   if(cn->flags & CN_DISPLAYED)
 984     gtk_layout_move(GTK_LAYOUT(chooselayout), cn->container, x, y);
 985   else {
 986     gtk_layout_put(GTK_LAYOUT(chooselayout), cn->container, x, y);
 987     cn->flags |= CN_DISPLAYED;
 988     /* Now chooselayout has a ref to the container */
 989     g_object_unref(cn->container);
 990   }
 991   END(location);
 992   /* Set the widget's selection status */
 993   BEGIN(selection);
 994   if(!(cn->flags & CN_EXPANDABLE))
 995     display_selection(cn);
 996   END(selection);
 997   /* Find the size used so we can get vertical positioning right. */
 998   gtk_widget_size_request(cn->container, &req);
 999   d.width = x + req.width;
1000   d.height = y + req.height;
1001   cn->ymin = y;
1002   cn->ymax = d.height;
1003   if(cn->flags & CN_EXPANDED) {
1004     /* We'll offset children by the size of the arrow whatever it might be. */
1005     assert(cn->arrow);
1006     gtk_widget_size_request(cn->arrow, &req);
1007     aw = req.width;
1008     for(n = 0; n < cn->children.nvec; ++n) {
1009       cd = display_tree(cn->children.vec[n], x + aw, d.height);
1010       if(cd.width > d.width)
1011         d.width = cd.width;
1012       d.height = cd.height;
1013     }
1014   } else {
1015     BEGIN(undisplay);
1016     for(n = 0; n < cn->children.nvec; ++n)
1017       undisplay_tree(cn->children.vec[n]);
1018     END(undisplay);
1019   }
1020   if(!(cn->flags & CN_EXPANDABLE)) {
1021     ++files_visible;
1022     if(cn->flags & CN_SELECTED)
1023       ++files_selected;
1024   }
1025   /* update the search results array */
1026   if(search_result)
1027     searchnodes[search_result - 1] = cn;
1028   /* report back how much space we used */
1029   D(("display_tree %s %d,%d total size %dx%d", cn->path, x, y,
1030      d.width, d.height));
1031   return d;
1032 }
1033
1034 /** @brief Remove widgets for newly hidden nodes */
1035 static void undisplay_tree(struct choosenode *cn) {
1036   int n;
1037
1038   D(("undisplay_tree %s", cn->path));
1039   /* Remove this widget from the display */
1040   if(cn->flags & CN_DISPLAYED) {
1041     gtk_container_remove(GTK_CONTAINER(chooselayout), cn->container);
1042     cn->flags ^= CN_DISPLAYED;
1043   }
1044   /* Remove children too */
1045   for(n = 0; n < cn->children.nvec; ++n)
1046     undisplay_tree(cn->children.vec[n]);
1047 }
1048
1049 /* Selection --------------------------------------------------------------- */
1050
1051 /** @brief Mark the widget @p cn according to its selection state */
1052 static void display_selection(struct choosenode *cn) {
1053   /* Need foreground and background colors */
1054   gtk_widget_set_state(cn->label, (cn->flags & CN_SELECTED
1055                                    ? GTK_STATE_SELECTED : GTK_STATE_NORMAL));
1056   gtk_widget_set_state(cn->container, (cn->flags & CN_SELECTED
1057                                        ? GTK_STATE_SELECTED : GTK_STATE_NORMAL));
1058 }
1059
1060 /** @brief Set the selection state of a widget
1061  *
1062  * Directories can never be selected, we just ignore attempts to do so. */
1063 static void set_selection(struct choosenode *cn, int selected) {
1064   unsigned f = selected ? CN_SELECTED : 0;
1065
1066   D(("set_selection %d %s", selected, cn->path));
1067   if(!(cn->flags & CN_EXPANDABLE) && (cn->flags & CN_SELECTED) != f) {
1068     cn->flags ^= CN_SELECTED;
1069     /* Maintain selection count */
1070     if(selected)
1071       ++files_selected;
1072     else
1073       --files_selected;
1074     display_selection(cn);
1075     /* Update main menu sensitivity */
1076     menu_update(-1);
1077   }
1078 }
1079
1080 /** @brief Recursively clear all selection bits from CN down */
1081 static void clear_selection(struct choosenode *cn) {
1082   int n;
1083
1084   set_selection(cn, 0);
1085   for(n = 0; n < cn->children.nvec; ++n)
1086     clear_selection(cn->children.vec[n]);
1087 }
1088
1089 /* User actions ------------------------------------------------------------ */
1090
1091 /** @brief Called when disorder_eclient_play completes */
1092 void play_completed(void attribute((unused)) *v,
1093                     const char *error) {
1094   if(error)
1095     popup_protocol_error(0, error);
1096 }
1097
1098 /** @brief Clicked on something
1099  *
1100  * This implements playing, all the modifiers for selection, etc.
1101  */
1102 static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
1103                                GdkEventButton *event,
1104                                gpointer user_data) {
1105   struct choosenode *cn = user_data;
1106   int ind, last_ind, n;
1107
1108   D(("clicked_choosenode %s", cn->path));
1109   if(event->type == GDK_BUTTON_RELEASE
1110      && event->button == 1) {
1111     /* Left click */
1112     if(cn->flags & CN_EXPANDABLE) {
1113       /* This is a directory.  Flip its expansion status. */
1114       if(cn->flags & CN_EXPANDED)
1115         contract_node(cn);
1116       else
1117         expand_node(cn, 0/*!contingent*/);
1118       last_click = 0;
1119     } else {
1120       /* This is a file.  Adjust selection status */
1121       /* TODO the basic logic here is essentially the same as that in queue.c.
1122        * Can we share code at all? */
1123       switch(event->state & (GDK_SHIFT_MASK|GDK_CONTROL_MASK)) {
1124       case 0:
1125         clear_selection(root);
1126         set_selection(cn, 1);
1127         last_click = cn;
1128         break;
1129       case GDK_CONTROL_MASK:
1130         set_selection(cn, !(cn->flags & CN_SELECTED));
1131         last_click = cn;
1132         break;
1133       case GDK_SHIFT_MASK:
1134       case GDK_SHIFT_MASK|GDK_CONTROL_MASK:
1135         if(last_click && last_click->parent == cn->parent) {
1136           /* Figure out where the current and last clicks are in the list */
1137           ind = last_ind = -1;
1138           for(n = 0; n < cn->parent->children.nvec; ++n) {
1139             if(cn->parent->children.vec[n] == cn)
1140               ind = n;
1141             if(cn->parent->children.vec[n] == last_click)
1142               last_ind = n;
1143           }
1144           /* Test shouldn't ever fail, but still */
1145           if(ind >= 0 && last_ind >= 0) {
1146             if(!(event->state & GDK_CONTROL_MASK)) {
1147               for(n = 0; n < cn->parent->children.nvec; ++n)
1148                 set_selection(cn->parent->children.vec[n], 0);
1149             }
1150             if(ind > last_ind)
1151               for(n = last_ind; n <= ind; ++n)
1152                 set_selection(cn->parent->children.vec[n], 1);
1153             else
1154               for(n = ind; n <= last_ind; ++n)
1155                 set_selection(cn->parent->children.vec[n], 1);
1156             if(event->state & GDK_CONTROL_MASK)
1157               last_click = cn;
1158           }
1159         }
1160         /* TODO trying to select a range that doesn't share a single parent
1161          * currently does not work, but it ought to. */
1162         break;
1163       }
1164     }
1165   } else if(event->type == GDK_BUTTON_RELEASE
1166      && event->button == 2) {
1167     /* Middle click - play the pointed track */
1168     if(!(cn->flags & CN_EXPANDABLE)) {
1169       clear_selection(root);
1170       set_selection(cn, 1);
1171       gtk_label_set_text(GTK_LABEL(report_label), "adding track to queue");
1172       disorder_eclient_play(client, cn->path, play_completed, 0);
1173       last_click = 0;
1174     }
1175   } else if(event->type == GDK_BUTTON_PRESS
1176      && event->button == 3) {
1177     struct choose_menuitem *const menuitems =
1178       (cn->flags & CN_EXPANDABLE ? dir_menuitems : track_menuitems);
1179     GtkWidget *const menu =
1180       (cn->flags & CN_EXPANDABLE ? dir_menu : track_menu);
1181     /* Right click.  Pop up a menu. */
1182     /* If the current file isn't selected, switch the selection to just that.
1183      * (If we're looking at a directory then leave the selection alone.) */
1184     if(!(cn->flags & CN_EXPANDABLE) && !(cn->flags & CN_SELECTED)) {
1185       clear_selection(root);
1186       set_selection(cn, 1);
1187       last_click = cn;
1188     }
1189     /* Set the item sensitivity and callbacks */
1190     for(n = 0; menuitems[n].name; ++n) {
1191       if(menuitems[n].handlerid)
1192         g_signal_handler_disconnect(menuitems[n].w,
1193                                     menuitems[n].handlerid);
1194       gtk_widget_set_sensitive(menuitems[n].w,
1195                                menuitems[n].sensitive(cn));
1196       menuitems[n].handlerid = g_signal_connect
1197         (menuitems[n].w, "activate", G_CALLBACK(menuitems[n].activate), cn);
1198     }
1199     set_tool_colors(menu);
1200     /* Pop up the menu */
1201     gtk_widget_show_all(menu);
1202     gtk_menu_popup(GTK_MENU(menu), 0, 0, 0, 0,
1203                    event->button, event->time);
1204   }
1205 }
1206
1207 /** @brief Called BY GTK+ to tell us the search entry box has changed */
1208 static void searchentry_changed(GtkEditable attribute((unused)) *editable,
1209                                 gpointer attribute((unused)) user_data) {
1210   initiate_search();
1211 }
1212
1213 /* Track menu items -------------------------------------------------------- */
1214
1215 /** @brief Recursive step for gather_selected() */
1216 static void recurse_selected(struct choosenode *cn, struct vector *v) {
1217   int n;
1218
1219   if(cn->flags & CN_EXPANDABLE) {
1220     if(cn->flags & CN_EXPANDED)
1221       for(n = 0; n < cn->children.nvec; ++n)
1222         recurse_selected(cn->children.vec[n], v);
1223   } else {
1224     if((cn->flags & CN_SELECTED) && cn->path)
1225       vector_append(v, (char *)cn->path);
1226   }
1227 }
1228
1229 /*** @brief Get a list of all the selected tracks */
1230 static const char **gather_selected(int *ntracks) {
1231   struct vector v;
1232
1233   vector_init(&v);
1234   recurse_selected(root, &v);
1235   vector_terminate(&v);
1236   if(ntracks) *ntracks = v.nvec;
1237   return (const char **)v.vec;
1238 }
1239
1240 /** @brief Called when the track menu's play option is activated */
1241 static void activate_track_play(GtkMenuItem attribute((unused)) *menuitem,
1242                                 gpointer attribute((unused)) user_data) {
1243   const char **tracks = gather_selected(0);
1244   int n;
1245
1246   gtk_label_set_text(GTK_LABEL(report_label), "adding track to queue");
1247   for(n = 0; tracks[n]; ++n)
1248     disorder_eclient_play(client, tracks[n], play_completed, 0);
1249 }
1250
1251 /** @brief Called when the menu's properties option is activated */
1252 static void activate_track_properties(GtkMenuItem attribute((unused)) *menuitem,
1253                                       gpointer attribute((unused)) user_data) {
1254   int ntracks;
1255   const char **tracks = gather_selected(&ntracks);
1256
1257   properties(ntracks, tracks);
1258 }
1259
1260 /** @brief Determine whether the menu's play option should be sensitive */
1261 static gboolean sensitive_track_play(struct choosenode attribute((unused)) *cn) {
1262   return (!!files_selected
1263           && (disorder_eclient_state(client) & DISORDER_CONNECTED));
1264 }
1265
1266 /** @brief Determine whether the menu's properties option should be sensitive */
1267 static gboolean sensitive_track_properties(struct choosenode attribute((unused)) *cn) {
1268   return !!files_selected && (disorder_eclient_state(client) & DISORDER_CONNECTED);
1269 }
1270
1271 /* Directory menu items ---------------------------------------------------- */
1272
1273 /** @brief Return the file children of @p cn
1274  *
1275  * The list is terminated by a null pointer.
1276  */
1277 static const char **dir_files(struct choosenode *cn, int *nfiles) {
1278   const char **files = xcalloc(cn->children.nvec + 1, sizeof (char *));
1279   int n, m;
1280
1281   for(n = m = 0; n < cn->children.nvec; ++n)
1282     if(!(cn->children.vec[n]->flags & CN_EXPANDABLE))
1283       files[m++] = cn->children.vec[n]->path;
1284   files[m] = 0;
1285   if(nfiles) *nfiles = m;
1286   return files;
1287 }
1288
1289 static void play_dir(struct choosenode *cn,
1290                      void attribute((unused)) *wfu) {
1291   int ntracks, n;
1292   const char **tracks = dir_files(cn, &ntracks);
1293
1294   gtk_label_set_text(GTK_LABEL(report_label), "adding track to queue");
1295   for(n = 0; n < ntracks; ++n)
1296     disorder_eclient_play(client, tracks[n], play_completed, 0);
1297 }
1298
1299 static void properties_dir(struct choosenode *cn,
1300                            void attribute((unused)) *wfu) {
1301   int ntracks;
1302   const char **tracks = dir_files(cn, &ntracks);
1303
1304   properties(ntracks, tracks);
1305 }
1306
1307 static void select_dir(struct choosenode *cn,
1308                        void attribute((unused)) *wfu) {
1309   int n;
1310
1311   clear_selection(root);
1312   for(n = 0; n < cn->children.nvec; ++n)
1313     set_selection(cn->children.vec[n], 1);
1314 }
1315
1316 /** @brief Ensure @p cn is expanded and then call @p callback */
1317 static void call_with_dir(struct choosenode *cn,
1318                           when_filled_callback *whenfilled,
1319                           void *wfu) {
1320   if(!(cn->flags & CN_EXPANDABLE))
1321     return;                             /* something went wrong */
1322   if(cn->flags & CN_EXPANDED)
1323     /* @p cn is already open */
1324     whenfilled(cn, wfu);
1325   else {
1326     /* @p cn is not open, arrange for the callback to go off when it is
1327      * opened */
1328     cn->whenfilled = whenfilled;
1329     cn->wfu = wfu;
1330     expand_node(cn, 0/*not contingnet upon search*/);
1331   }
1332 }
1333
1334 /** @brief Called when the directory menu's play option is activated */
1335 static void activate_dir_play(GtkMenuItem attribute((unused)) *menuitem,
1336                               gpointer user_data) {
1337   struct choosenode *const cn = (struct choosenode *)user_data;
1338
1339   call_with_dir(cn, play_dir, 0);
1340 }
1341
1342 /** @brief Called when the directory menu's properties option is activated */
1343 static void activate_dir_properties(GtkMenuItem attribute((unused)) *menuitem,
1344                                     gpointer user_data) {
1345   struct choosenode *const cn = (struct choosenode *)user_data;
1346
1347   call_with_dir(cn, properties_dir, 0);
1348 }
1349
1350 /** @brief Called when the directory menu's select option is activated */
1351 static void activate_dir_select(GtkMenuItem attribute((unused)) *menuitem,
1352                                 gpointer user_data) {
1353   struct choosenode *const cn = (struct choosenode *)user_data;
1354
1355   call_with_dir(cn, select_dir,  0);
1356 }
1357
1358 /** @brief Determine whether the directory menu's play option should be sensitive */
1359 static gboolean sensitive_dir_play(struct choosenode attribute((unused)) *cn) {
1360   return !!(disorder_eclient_state(client) & DISORDER_CONNECTED);
1361 }
1362
1363 /** @brief Determine whether the directory menu's properties option should be sensitive */
1364 static gboolean sensitive_dir_properties(struct choosenode attribute((unused)) *cn) {
1365   return !!(disorder_eclient_state(client) & DISORDER_CONNECTED);
1366 }
1367
1368 /** @brief Determine whether the directory menu's select option should be sensitive */
1369 static gboolean sensitive_dir_select(struct choosenode attribute((unused)) *cn) {
1370   return TRUE;
1371 }
1372
1373
1374
1375 /* Main menu plumbing ------------------------------------------------------ */
1376
1377 /** @brief Determine whether the edit menu's properties option should be sensitive */
1378 static int choose_properties_sensitive(GtkWidget attribute((unused)) *w) {
1379   return !!files_selected && (disorder_eclient_state(client) & DISORDER_CONNECTED);
1380 }
1381
1382 /** @brief Determine whether the edit menu's select all option should be sensitive
1383  *
1384  * TODO not implemented,  see also choose_selectall_activate()
1385  */
1386 static int choose_selectall_sensitive(GtkWidget attribute((unused)) *w) {
1387   return FALSE;
1388 }
1389
1390 /** @brief Determine whether the edit menu's select none option should be sensitive
1391  *
1392  * TODO not implemented,  see also choose_selectnone_activate()
1393  */
1394 static int choose_selectnone_sensitive(GtkWidget attribute((unused)) *w) {
1395   return FALSE;
1396 }
1397
1398 /** @brief Called when the edit menu's properties option is activated */
1399 static void choose_properties_activate(GtkWidget attribute((unused)) *w) {
1400   activate_track_properties(0, 0);
1401 }
1402
1403 /** @brief Called when the edit menu's select all option is activated
1404  *
1405  * TODO not implemented, see choose_selectall_sensitive() */
1406 static void choose_selectall_activate(GtkWidget attribute((unused)) *w) {
1407 }
1408
1409 /** @brief Called when the edit menu's select none option is activated
1410  *
1411  * TODO not implemented, see choose_selectnone_sensitive() */
1412 static void choose_selectnone_activate(GtkWidget attribute((unused)) *w) {
1413 }
1414
1415 /** @brief Main menu callbacks for Choose screen */
1416 static const struct tabtype tabtype_choose = {
1417   choose_properties_sensitive,
1418   choose_selectall_sensitive,
1419   choose_selectnone_sensitive,
1420   choose_properties_activate,
1421   choose_selectall_activate,
1422   choose_selectnone_activate,
1423 };
1424
1425 /* Public entry points ----------------------------------------------------- */
1426
1427 /** @brief Called to entirely reset the choose screen */
1428 static void choose_reset(void) {
1429   if(root)
1430     undisplay_tree(root);
1431   root = newnode(0/*parent*/, "<root>", "All files", "",
1432                  CN_EXPANDABLE, fill_root_node);
1433   expand_node(root, 0);                 /* will call redisplay_tree */
1434 }
1435
1436 /** @brief Create a track choice widget */
1437 GtkWidget *choose_widget(void) {
1438   int n;
1439   GtkWidget *scrolled;
1440   GtkWidget *vbox, *hbox, *clearsearch;
1441
1442   /*
1443    *   +--vbox-------------------------------------------------------+
1444    *   | +-hbox----------------------------------------------------+ |
1445    *   | | searchentry                               | clearsearch | |
1446    *   | +---------------------------------------------------------+ |
1447    *   | +-scrolled------------------------------------------------+ |
1448    *   | | +-chooselayout------------------------------------++--+ | |
1449    *   | | | Tree structure is manually layed out in here    ||^^| | |
1450    *   | | |                                                 ||  | | |
1451    *   | | |                                                 ||  | | |
1452    *   | | |                                                 ||  | | |
1453    *   | | |                                                 ||vv| | |
1454    *   | | +-------------------------------------------------++--+ | |
1455    *   | | +-------------------------------------------------+     | |
1456    *   | | |<                                               >|     | |
1457    *   | | +-------------------------------------------------+     | |
1458    *   | +---------------------------------------------------------+ |
1459    *   +-------------------------------------------------------------+
1460    */
1461
1462   /* Text entry box for search terms */
1463   NW(entry);
1464   searchentry = gtk_entry_new();
1465   gtk_widget_set_style(searchentry, tool_style);
1466   g_signal_connect(searchentry, "changed", G_CALLBACK(searchentry_changed), 0);
1467   gtk_tooltips_set_tip(tips, searchentry, "Enter search terms here; search is automatic", "");
1468
1469   /* Cancel button to clear the search */
1470   NW(button);
1471   clearsearch = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
1472   gtk_widget_set_style(clearsearch, tool_style);
1473   g_signal_connect(G_OBJECT(clearsearch), "clicked",
1474                    G_CALLBACK(clearsearch_clicked), 0);
1475   gtk_tooltips_set_tip(tips, clearsearch, "Clear search terms", "");
1476
1477   /* Up and down buttons to find previous/next results; initially they are not
1478    * usable as there are no search results. */
1479   prevsearch = iconbutton("up.png", "Previous search result");
1480   g_signal_connect(G_OBJECT(prevsearch), "clicked",
1481                    G_CALLBACK(prev_clicked), 0);
1482   gtk_widget_set_style(prevsearch, tool_style);
1483   gtk_widget_set_sensitive(prevsearch, 0);
1484   nextsearch = iconbutton("down.png", "Next search result");
1485   g_signal_connect(G_OBJECT(nextsearch), "clicked",
1486                    G_CALLBACK(next_clicked), 0);
1487   gtk_widget_set_style(nextsearch, tool_style);
1488   gtk_widget_set_sensitive(nextsearch, 0);
1489
1490   /* hbox packs the search tools button together on a line */
1491   NW(hbox);
1492   hbox = gtk_hbox_new(FALSE/*homogeneous*/, 1/*spacing*/);
1493   gtk_box_pack_start(GTK_BOX(hbox), searchentry,
1494                      TRUE/*expand*/, TRUE/*fill*/, 0/*padding*/);
1495   gtk_box_pack_start(GTK_BOX(hbox), prevsearch,
1496                      FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
1497   gtk_box_pack_start(GTK_BOX(hbox), nextsearch,
1498                      FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
1499   gtk_box_pack_start(GTK_BOX(hbox), clearsearch,
1500                      FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
1501
1502   /* chooselayout contains the currently visible subset of the track
1503    * namespace */
1504   NW(layout);
1505   chooselayout = gtk_layout_new(0, 0);
1506   gtk_widget_set_style(chooselayout, layout_style);
1507   choose_reset();
1508   register_reset(choose_reset);
1509   /* Create the popup menus */
1510   NW(menu);
1511   track_menu = gtk_menu_new();
1512   g_signal_connect(track_menu, "destroy", G_CALLBACK(gtk_widget_destroyed),
1513                    &track_menu);
1514   for(n = 0; track_menuitems[n].name; ++n) {
1515     NW(menu_item);
1516     track_menuitems[n].w =
1517       gtk_menu_item_new_with_label(track_menuitems[n].name);
1518     gtk_menu_attach(GTK_MENU(track_menu), track_menuitems[n].w,
1519                     0, 1, n, n + 1);
1520   }
1521   NW(menu);
1522   dir_menu = gtk_menu_new();
1523   g_signal_connect(dir_menu, "destroy", G_CALLBACK(gtk_widget_destroyed),
1524                    &dir_menu);
1525   for(n = 0; dir_menuitems[n].name; ++n) {
1526     NW(menu_item);
1527     dir_menuitems[n].w =
1528       gtk_menu_item_new_with_label(dir_menuitems[n].name);
1529     gtk_menu_attach(GTK_MENU(dir_menu), dir_menuitems[n].w,
1530                     0, 1, n, n + 1);
1531   }
1532   /* The layout is scrollable */
1533   scrolled = scroll_widget(chooselayout);
1534   vadjust = gtk_layout_get_vadjustment(GTK_LAYOUT(chooselayout));
1535
1536   /* The scrollable layout and the search hbox go together in a vbox */
1537   NW(vbox);
1538   vbox = gtk_vbox_new(FALSE/*homogenous*/, 1/*spacing*/);
1539   gtk_box_pack_start(GTK_BOX(vbox), hbox,
1540                      FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
1541   gtk_box_pack_end(GTK_BOX(vbox), scrolled,
1542                    TRUE/*expand*/, TRUE/*fill*/, 0/*padding*/);
1543
1544   g_object_set_data(G_OBJECT(vbox), "type", (void *)&tabtype_choose);
1545   return vbox;
1546 }
1547
1548 /** @brief Called when something we care about here might have changed */
1549 void choose_update(void) {
1550   redisplay_tree("choose_update");
1551 }
1552
1553 /*
1554 Local Variables:
1555 c-basic-offset:2
1556 comment-column:40
1557 fill-column:79
1558 indent-tabs-mode:nil
1559 End:
1560 */