chiark / gitweb /
0-track edges cases for the last changes
[disorder] / disobedience / choose.c
index cc9f3acdc94efef4419b59370af14ae7d05eeda3..4cdb90f7b01e7721f09b19cad8c3d76d85b84162 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file disobedience/choose.c
+ * @brief Hierarchical track selection and search
+ *
+ * We don't use the built-in tree widgets because they require that you know
+ * the children of a node on demand, and we have to wait for the server to tell
+ * us.
+ */
 
 #include "disobedience.h"
 
@@ -34,75 +41,93 @@ WT(button);
 WT(image);
 WT(entry);
 
-/* We don't use the built-in tree widgets because they require that you know
- * the children of a node on demand, and we have to wait for the server to tell
- * us. */
-
 /* Types */
 
 struct choosenode;
 
+/** @brief Accumulated information about the tree widget */
 struct displaydata {
-  guint width;                          /* total width required */
-  guint height;                         /* total height required */
+  /** @brief Maximum width required */
+  guint width;
+  /** @brief Maximum height required */
+  guint height;
 };
 
 /* instantiate the node vector type */
 
 VECTOR_TYPE(nodevector, struct choosenode *, xrealloc);
 
+/** @brief Signature of function called when a choosenode is filled */
+typedef void (when_filled_callback)(struct choosenode *cn,
+                                    void *wfu);
+
+/** @brief One node in the virtual filesystem */
 struct choosenode {
-  struct choosenode *parent;            /* parent node */
-  const char *path;                     /* full path or 0  */
-  const char *sort;                     /* sort key */
-  const char *display;                  /* display name */
-  int pending;                          /* pending resolve queries */
+  struct choosenode *parent;            /**< @brief parent node */
+  const char *path;                     /**< @brief full path or 0  */
+  const char *sort;                     /**< @brief sort key */
+  const char *display;                  /**< @brief display name */
+  int pending;                          /**< @brief pending resolve queries */
   unsigned flags;
-#define CN_EXPANDABLE 0x0001            /* node is expandable */
-#define CN_EXPANDED 0x0002              /* node is expanded */
-/* Expandable items are directories; non-expandable ones are files */
-#define CN_DISPLAYED 0x0004             /* widget is displayed in layout */
-#define CN_SELECTED 0x0008              /* node is selected */
-  struct nodevector children;           /* vector of children */
-  void (*fill)(struct choosenode *);    /* request child fill or 0 for leaf */
-  GtkWidget *container;                 /* the container for this row */
-  GtkWidget *hbox;                      /* the hbox for this row */
-  GtkWidget *arrow;                     /* arrow widget or 0 */
-  GtkWidget *label;                     /* text label for this node */
-  GtkWidget *marker;                    /* queued marker */
+#define CN_EXPANDABLE 0x0001            /**< @brief node is expandable */
+#define CN_EXPANDED 0x0002              /**< @brief node is expanded
+                                         *
+                                         * Expandable items are directories;
+                                         * non-expandable ones are files. */
+#define CN_DISPLAYED 0x0004             /**< @brief widget is displayed in layout */
+#define CN_SELECTED 0x0008              /**< @brief node is selected */
+#define CN_GETTING_FILES 0x0010         /**< @brief files inbound */
+#define CN_RESOLVING_FILES 0x0020       /**< @brief resolved files inbound */
+#define CN_GETTING_DIRS 0x0040          /**< @brief directories inbound */
+#define CN_GETTING_ANY 0x0070           /**< @brief getting something */
+  struct nodevector children;           /**< @brief vector of children */
+  void (*fill)(struct choosenode *);    /**< @brief request child fill or 0 for leaf */
+  GtkWidget *container;                 /**< @brief the container for this row */
+  GtkWidget *hbox;                      /**< @brief the hbox for this row */
+  GtkWidget *arrow;                     /**< @brief arrow widget or 0 */
+  GtkWidget *label;                     /**< @brief text label for this node */
+  GtkWidget *marker;                    /**< @brief queued marker */
+
+  when_filled_callback *whenfilled;     /**< @brief called when filled or 0 */
+  void *wfu;                            /**< @brief passed to @c whenfilled */
 };
 
-struct menuitem {
+/** @brief One item in the popup menu */
+struct choose_menuitem {
   /* Parameters */
-  const char *name;                     /* name */
+  const char *name;                     /**< @brief name */
 
   /* Callbacks */
   void (*activate)(GtkMenuItem *menuitem, gpointer user_data);
-  /* Called to activate the menu item.  The user data is the choosenode the
-   * pointer is over. */
+  /**< @brief Called to activate the menu item.
+   *
+   * @p user_data is the choosenode the mouse pointer is over. */
 
   gboolean (*sensitive)(struct choosenode *cn);
-  /* Called to determine whether the menu item should be sensitive.  TODO */
+  /* @brief Called to determine whether the menu item should be sensitive.
+   *
+   * TODO? */
 
   /* State */
-  gulong handlerid;                     /* signal handler ID */
-  GtkWidget *w;                         /* menu item widget */
+  gulong handlerid;                     /**< @brief signal handler ID */
+  GtkWidget *w;                         /**< @brief menu item widget */
 };
 
 /* Variables */
 
 static GtkWidget *chooselayout;
-static GtkWidget *searchentry;          /* search terms */
+static GtkWidget *searchentry;          /**< @brief search terms */
 static struct choosenode *root;
 static struct choosenode *realroot;
-static GtkWidget *menu;                 /* our popup menu */
-static struct choosenode *last_click;   /* last clicked node for selection */
-static int files_visible;               /* total files visible */
-static int files_selected;              /* total files selected */
-static int search_in_flight;            /* a search is underway */
-static int search_obsolete;             /* the current search is void */
-static char **searchresults;            /* search results */
-static int nsearchresults;              /* number of results */
+static GtkWidget *track_menu;           /**< @brief track popup menu */
+static GtkWidget *dir_menu;             /**< @brief directory popup menu */
+static struct choosenode *last_click;   /**< @brief last clicked node for selection */
+static int files_visible;               /**< @brief total files visible */
+static int files_selected;              /**< @brief total files selected */
+static int search_in_flight;            /**< @brief a search is underway */
+static int search_obsolete;             /**< @brief the current search is void */
+static char **searchresults;            /**< @brief search results */
+static int nsearchresults;              /**< @brief number of results */
 
 /* Forward Declarations */
 
@@ -137,32 +162,39 @@ static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
                                GdkEventButton *event,
                                gpointer user_data);
 
-static void activate_play(GtkMenuItem *menuitem, gpointer user_data);
-#if 0
-static void activate_remove(GtkMenuItem *menuitem, gpointer user_data);
-#endif
-static void activate_properties(GtkMenuItem *menuitem, gpointer user_data);
-
-static gboolean sensitive_play(struct choosenode *cn);
-#if 0
-static gboolean sensitive_remove(struct choosenode *cn);
-#endif
-static gboolean sensitive_properties(struct choosenode *cn);
-
-static struct menuitem menuitems[] = {
-  { "Play track", activate_play, sensitive_play, 0, 0 },
-#if 0
-  /* Not implemented yet */
-  { "Remove", activate_remove, sensitive_remove, 0, 0 },
-#endif
-  { "Track properties", activate_properties, sensitive_properties, 0, 0 },
+static void activate_track_play(GtkMenuItem *menuitem, gpointer user_data);
+static void activate_track_properties(GtkMenuItem *menuitem, gpointer user_data);
+
+static gboolean sensitive_track_play(struct choosenode *cn);
+static gboolean sensitive_track_properties(struct choosenode *cn);
+
+static void activate_dir_play(GtkMenuItem *menuitem, gpointer user_data);
+static void activate_dir_properties(GtkMenuItem *menuitem, gpointer user_data);
+static void activate_dir_select(GtkMenuItem *menuitem, gpointer user_data);
+
+static gboolean sensitive_dir_play(struct choosenode *cn);
+static gboolean sensitive_dir_properties(struct choosenode *cn);
+static gboolean sensitive_dir_select(struct choosenode *cn);
+
+/** @brief Track menu items */
+static struct choose_menuitem track_menuitems[] = {
+  { "Play track", activate_track_play, sensitive_track_play, 0, 0 },
+  { "Track properties", activate_track_properties, sensitive_track_properties, 0, 0 },
+  { 0, 0, 0, 0, 0 }
+};
+
+/** @brief Directory menu items */
+static struct choose_menuitem dir_menuitems[] = {
+  { "Play all tracks", activate_dir_play, sensitive_dir_play, 0, 0 },
+  { "Track properties", activate_dir_properties, sensitive_dir_properties, 0, 0 },
+  { "Select all tracks", activate_dir_select, sensitive_dir_select, 0, 0 },
+  { 0, 0, 0, 0, 0 }
 };
 
-#define NMENUITEMS (int)(sizeof menuitems / sizeof *menuitems)
 
 /* Maintaining the data structure ------------------------------------------ */
 
-/* Create a new node */
+/** @brief Create a new node */
 static struct choosenode *newnode(struct choosenode *parent,
                                   const char *path,
                                   const char *display,
@@ -188,7 +220,20 @@ static struct choosenode *newnode(struct choosenode *parent,
   return n;
 }
 
-/* Fill the root */
+/** @brief Called when a node has been filled
+ *
+ * Response for calling @c whenfilled.
+ */
+static void filled(struct choosenode *cn) {
+  when_filled_callback *const whenfilled = cn->whenfilled;
+
+  if(whenfilled) {
+    cn->whenfilled = 0;
+    whenfilled(cn, cn->wfu);
+  }
+}
+
+/** @brief Fill the root */
 static void fill_root_node(struct choosenode *cn) {
   int ch;
   char *name;
@@ -205,8 +250,11 @@ static void fill_root_node(struct choosenode *cn) {
       newnode(cn, "<letter>", "*", "~", CN_EXPANDABLE, fill_letter_node);
     }
     updated_node(cn, 1);
+    filled(cn);
   } else {
     /* More de-duping possible here */
+    if(cn->flags & CN_GETTING_ANY)
+      return;
     gtk_label_set_text(GTK_LABEL(report_label), "getting files");
     cbd = xmalloc(sizeof *cbd);
     cbd->u.choosenode = cn;
@@ -214,9 +262,11 @@ static void fill_root_node(struct choosenode *cn) {
     cbd = xmalloc(sizeof *cbd);
     cbd->u.choosenode = cn;
     disorder_eclient_files(client, got_files, "", 0, cbd);
+    cn->flags |= CN_GETTING_FILES|CN_GETTING_DIRS;
   }
 }
 
+/** @brief Delete all the widgets owned by @p cn */
 static void delete_cn_widgets(struct choosenode *cn) {
   if(cn->arrow) {
     DW(arrow);
@@ -245,7 +295,11 @@ static void delete_cn_widgets(struct choosenode *cn) {
   }
 }
 
-/* Clear all the children of CN */
+/** @brief Recursively clear all the children of @p cn
+ *
+ * All the widgets at or below @p cn are deleted.  All choosenodes below
+ * it are emptied. i.e. we prune the tree at @p cn.
+ */
 static void clear_children(struct choosenode *cn) {
   int n;
 
@@ -258,12 +312,14 @@ static void clear_children(struct choosenode *cn) {
   cn->children.nvec = 0;
 }
 
-/* Fill a child node */
+/** @brief Fill a letter node */
 static void fill_letter_node(struct choosenode *cn) {
   const char *regexp;
   struct callbackdata *cbd;
 
   D(("fill_letter_node %s", cn->display));
+  if(cn->flags & CN_GETTING_ANY)
+    return;
   switch(cn->display[0]) {
   default:
     byte_xasprintf((char **)&regexp, "^(the )?%c", tolower(cn->display[0]));
@@ -285,9 +341,10 @@ static void fill_letter_node(struct choosenode *cn) {
   cbd = xmalloc(sizeof *cbd);
   cbd->u.choosenode = cn;
   disorder_eclient_files(client, got_files, "", regexp, cbd);
+  cn->flags |= CN_GETTING_FILES|CN_GETTING_DIRS;
 }
 
-/* Called with a list of files just below some node */
+/** @brief Called with a list of files just below some node */
 static void got_files(void *v, int nvec, char **vec) {
   struct callbackdata *cbd = v;
   struct choosenode *cn = cbd->u.choosenode;
@@ -296,46 +353,67 @@ static void got_files(void *v, int nvec, char **vec) {
   D(("got_files %d files for %s", nvec, cn->path));
   /* Complicated by the need to resolve aliases.  We can save a bit of effort
    * by re-using cbd though. */
-  cn->pending = nvec;
-  for(n = 0; n < nvec; ++n)
-    disorder_eclient_resolve(client, got_resolved_file, vec[n], cbd);
+  cn->flags &= ~CN_GETTING_FILES;
+  if((cn->pending = nvec)) {
+    cn->flags |= CN_RESOLVING_FILES;
+    for(n = 0; n < nvec; ++n)
+      disorder_eclient_resolve(client, got_resolved_file, vec[n], cbd);
+  }
 }
 
+/** @brief Called with an alias resolved filename */
 static void got_resolved_file(void *v, const char *track) {
   struct callbackdata *cbd = v;
   struct choosenode *cn = cbd->u.choosenode, *file_cn;
 
+  /* TODO as below */
   file_cn = newnode(cn, track,
                     trackname_transform("track", track, "display"),
                     trackname_transform("track", track, "sort"),
                     0/*flags*/, 0/*fill*/);
   /* Only bother updating when we've got the lot */
-  if(--cn->pending == 0)
+  if(--cn->pending == 0) {
+    cn->flags &= ~CN_RESOLVING_FILES;
     updated_node(cn, 1);
+    if(!(cn->flags & CN_GETTING_ANY))
+      filled(cn);
+  }
 }
 
-/* Called with a list of directories just below some node */
+/** @brief Called with a list of directories just below some node */
 static void got_dirs(void *v, int nvec, char **vec) {
   struct callbackdata *cbd = v;
   struct choosenode *cn = cbd->u.choosenode;
   int n;
 
   D(("got_dirs %d dirs for %s", nvec, cn->path));
+  /* TODO this depends on local configuration for trackname_transform().
+   * This will work, since the defaults are now built-in, but it'll be
+   * (potentially) different to the server's configured settings.
+   *
+   * Really we want a variant of files/dirs that produces both the
+   * raw filename and the transformed name for a chosen context.
+   */
   for(n = 0; n < nvec; ++n)
     newnode(cn, vec[n],
             trackname_transform("dir", vec[n], "display"),
             trackname_transform("dir", vec[n], "sort"),
             CN_EXPANDABLE, fill_directory_node);
   updated_node(cn, 1);
+  cn->flags &= ~CN_GETTING_DIRS;
+  if(!(cn->flags & CN_GETTING_ANY))
+    filled(cn);
 }
   
-/* Fill a child node */
+/** @brief Fill a child node */
 static void fill_directory_node(struct choosenode *cn) {
   struct callbackdata *cbd;
 
   D(("fill_directory_node %s", cn->path));
   /* TODO: caching */
   /* TODO: de-dupe against fill_letter_node */
+  if(cn->flags & CN_GETTING_ANY)
+    return;
   assert(report_label != 0);
   gtk_label_set_text(GTK_LABEL(report_label), "getting files");
   clear_children(cn);
@@ -345,9 +423,10 @@ static void fill_directory_node(struct choosenode *cn) {
   cbd = xmalloc(sizeof *cbd);
   cbd->u.choosenode = cn;
   disorder_eclient_files(client, got_files, cn->path, 0, cbd);
+  cn->flags |= CN_GETTING_FILES|CN_GETTING_DIRS;
 }
 
-/* Expand a node */
+/** @brief Expand a node */
 static void expand_node(struct choosenode *cn) {
   D(("expand_node %s", cn->path));
   assert(cn->flags & CN_EXPANDABLE);
@@ -361,7 +440,7 @@ static void expand_node(struct choosenode *cn) {
   cn->fill(cn);
 }
 
-/* Contract a node */
+/** @brief Contract a node */
 static void contract_node(struct choosenode *cn) {
   D(("contract_node %s", cn->path));
   assert(cn->flags & CN_EXPANDABLE);
@@ -379,7 +458,7 @@ static void contract_node(struct choosenode *cn) {
   redisplay_tree();
 }
 
-/* qsort callback for ordering choosenodes */
+/** @brief qsort() callback for ordering choosenodes */
 static int compare_choosenode(const void *av, const void *bv) {
   const struct choosenode *const *aa = av, *const *bb = bv;
   const struct choosenode *a = *aa, *b = *bb;
@@ -389,7 +468,7 @@ static int compare_choosenode(const void *av, const void *bv) {
                        a->path, b->path);
 }
 
-/* Called when an expandable node is updated.   */
+/** @brief Called when an expandable node is updated.   */
 static void updated_node(struct choosenode *cn, int redisplay) {
   D(("updated_node %s", cn->path));
   assert(cn->flags & CN_EXPANDABLE);
@@ -405,11 +484,12 @@ static void updated_node(struct choosenode *cn, int redisplay) {
 
 /* Searching --------------------------------------------------------------- */
 
+/** @brief qsort() callback for ordering tracks */
 static int compare_track_for_qsort(const void *a, const void *b) {
   return compare_path(*(char **)a, *(char **)b);
 }
 
-/* Return true iff FILE is a child of DIR */
+/** @brief Return true iff @p file is a child of @p dir */
 static int is_child(const char *dir, const char *file) {
   const size_t dlen = strlen(dir);
 
@@ -418,14 +498,14 @@ static int is_child(const char *dir, const char *file) {
           && strchr(file + dlen + 1, '/') == 0);
 }
 
-/* Return true iff FILE is a descendant of DIR */
+/** @brief Return true iff @p file is a descendant of @p dir */
 static int is_descendant(const char *dir, const char *file) {
   const size_t dlen = strlen(dir);
 
   return !strncmp(file, dir, dlen) && file[dlen] == '/';
 }
 
-/* Called to fill a node in the search results tree */
+/** @brief Called to fill a node in the search results tree */
 static void fill_search_node(struct choosenode *cn) {
   int n;
   const size_t plen = strlen(cn->path);
@@ -462,7 +542,9 @@ static void fill_search_node(struct choosenode *cn) {
   updated_node(cn, 1);
 }
 
-/* This is called from eclient with a (possibly empty) list of search results,
+/** @brief Called with a list of search results
+ *
+ * This is called from eclient with a (possibly empty) list of search results,
  * and also from initiate_seatch with an always empty list to indicate that
  * we're not searching for anything in particular. */
 static void search_completed(void attribute((unused)) *v,
@@ -536,6 +618,11 @@ static void search_completed(void attribute((unused)) *v,
   }
 }
 
+/** @brief Initiate a search 
+ *
+ * If a search is underway we set @ref search_obsolete and restart the search
+ * in search_completed() above.
+ */
 static void initiate_search(void) {
   char *terms, *e;
 
@@ -568,7 +655,7 @@ static void initiate_search(void) {
   }
 }
 
-/* Called when the cancel search button is clicked */
+/** @brief Called when the cancel search button is clicked */
 static void clearsearch_clicked(GtkButton attribute((unused)) *button,
                                 gpointer attribute((unused)) userdata) {
   gtk_entry_set_text(GTK_ENTRY(searchentry), "");
@@ -576,7 +663,7 @@ static void clearsearch_clicked(GtkButton attribute((unused)) *button,
 
 /* Display functions ------------------------------------------------------- */
 
-/* Delete all the widgets in the tree */
+/** @brief Delete all the widgets in the tree */
 static void delete_widgets(struct choosenode *cn) {
   int n;
 
@@ -587,7 +674,7 @@ static void delete_widgets(struct choosenode *cn) {
   files_selected = 0;
 }
 
-/* Update the display */
+/** @brief Update the display */
 static void redisplay_tree(void) {
   struct displaydata d;
   guint oldwidth, oldheight;
@@ -617,8 +704,11 @@ static void redisplay_tree(void) {
   menu_update(-1);
 }
 
-/* Make sure all displayed widgets from CN down exist and are in their proper
- * place and return the vertical space used. */
+/** @brief Recursive step for redisplay_tree()
+ *
+ * Makes sure all displayed widgets from CN down exist and are in their proper
+ * place and return the maximum space used.
+ */
 static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
   int n, aw;
   GtkRequisition req;
@@ -727,7 +817,7 @@ static struct displaydata display_tree(struct choosenode *cn, int x, int y) {
   return d;
 }
 
-/* Remove widgets for newly hidden nodes */
+/** @brief Remove widgets for newly hidden nodes */
 static void undisplay_tree(struct choosenode *cn) {
   int n;
 
@@ -744,6 +834,7 @@ static void undisplay_tree(struct choosenode *cn) {
 
 /* Selection --------------------------------------------------------------- */
 
+/** @brief Mark the widget @p cn according to its selection state */
 static void display_selection(struct choosenode *cn) {
   /* Need foreground and background colors */
   gtk_widget_set_state(cn->label, (cn->flags & CN_SELECTED
@@ -752,8 +843,9 @@ static void display_selection(struct choosenode *cn) {
                                        ? GTK_STATE_SELECTED : GTK_STATE_NORMAL));
 }
 
-/* Set the selection state of a widget.  Directories can never be selected, we
- * just ignore attempts to do so. */
+/** @brief Set the selection state of a widget
+ *
+ * Directories can never be selected, we just ignore attempts to do so. */
 static void set_selection(struct choosenode *cn, int selected) {
   unsigned f = selected ? CN_SELECTED : 0;
 
@@ -771,7 +863,7 @@ static void set_selection(struct choosenode *cn, int selected) {
   }
 }
 
-/* Recursively clear all selection bits from CN down */
+/** @brief Recursively clear all selection bits from CN down */
 static void clear_selection(struct choosenode *cn) {
   int n;
 
@@ -782,7 +874,10 @@ static void clear_selection(struct choosenode *cn) {
 
 /* User actions ------------------------------------------------------------ */
 
-/* Clicked on something */
+/** @brief Clicked on something
+ *
+ * This implements playing, all the modifiers for selection, etc.
+ */
 static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
                                GdkEventButton *event,
                                gpointer user_data) {
@@ -841,6 +936,8 @@ static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
               last_click = cn;
           }
         }
+        /* TODO trying to select a range that doesn't share a single parent
+         * currently does not work, but it ought to. */
         break;
       }
     }
@@ -856,6 +953,10 @@ static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
     }
   } else if(event->type == GDK_BUTTON_PRESS
      && event->button == 3) {
+    struct choose_menuitem *const menuitems =
+      (cn->flags & CN_EXPANDABLE ? dir_menuitems : track_menuitems);
+    GtkWidget *const menu =
+      (cn->flags & CN_EXPANDABLE ? dir_menu : track_menu);
     /* Right click.  Pop up a menu. */
     /* If the current file isn't selected, switch the selection to just that.
      * (If we're looking at a directory then leave the selection alone.) */
@@ -865,7 +966,7 @@ static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
       last_click = cn;
     }
     /* Set the item sensitivity and callbacks */
-    for(n = 0; n < NMENUITEMS; ++n) {
+    for(n = 0; menuitems[n].name; ++n) {
       if(menuitems[n].handlerid)
         g_signal_handler_disconnect(menuitems[n].w,
                                     menuitems[n].handlerid);
@@ -881,13 +982,15 @@ static void clicked_choosenode(GtkWidget attribute((unused)) *widget,
   }
 }
 
+/** @brief Called BY GTK+ to tell us the search entry box has changed */
 static void searchentry_changed(GtkEditable attribute((unused)) *editable,
                                 gpointer attribute((unused)) user_data) {
   initiate_search();
 }
 
-/* Menu items -------------------------------------------------------------- */
+/* Track menu items -------------------------------------------------------- */
 
+/** @brief Recursive step for gather_selected() */
 static void recurse_selected(struct choosenode *cn, struct vector *v) {
   int n;
 
@@ -901,19 +1004,21 @@ static void recurse_selected(struct choosenode *cn, struct vector *v) {
   }
 }
 
-static char **gather_selected(int *ntracks) {
+/*** @brief Get a list of all the selected tracks */
+static const char **gather_selected(int *ntracks) {
   struct vector v;
 
   vector_init(&v);
   recurse_selected(root, &v);
   vector_terminate(&v);
   if(ntracks) *ntracks = v.nvec;
-  return v.vec;
+  return (const char **)v.vec;
 }
 
-static void activate_play(GtkMenuItem attribute((unused)) *menuitem,
-                          gpointer attribute((unused)) user_data) {
-  char **tracks = gather_selected(0);
+/** @brief Called when the track menu's play option is activated */
+static void activate_track_play(GtkMenuItem attribute((unused)) *menuitem,
+                                gpointer attribute((unused)) user_data) {
+  const char **tracks = gather_selected(0);
   int n;
   
   gtk_label_set_text(GTK_LABEL(report_label), "adding track to queue");
@@ -921,54 +1026,157 @@ static void activate_play(GtkMenuItem attribute((unused)) *menuitem,
     disorder_eclient_play(client, tracks[n], 0, 0);
 }
 
-#if 0
-static void activate_remove(GtkMenuItem attribute((unused)) *menuitem,
-                            gpointer attribute((unused)) user_data) {
-  /* TODO remove all selected tracks */
-}
-#endif
-
-static void activate_properties(GtkMenuItem attribute((unused)) *menuitem,
-                                gpointer attribute((unused)) user_data) {
+/** @brief Called when the menu's properties option is activated */
+static void activate_track_properties(GtkMenuItem attribute((unused)) *menuitem,
+                                      gpointer attribute((unused)) user_data) {
   int ntracks;
-  char **tracks = gather_selected(&ntracks);
+  const char **tracks = gather_selected(&ntracks);
 
   properties(ntracks, tracks);
 }
 
-static gboolean sensitive_play(struct choosenode attribute((unused)) *cn) {
+/** @brief Determine whether the menu's play option should be sensitive */
+static gboolean sensitive_track_play(struct choosenode attribute((unused)) *cn) {
   return (!!files_selected
           && (disorder_eclient_state(client) & DISORDER_CONNECTED));
 }
 
-#if 0
-static gboolean sensitive_remove(struct choosenode attribute((unused)) *cn) {
-  return FALSE;                         /* not implemented yet */
+/** @brief Determine whether the menu's properties option should be sensitive */
+static gboolean sensitive_track_properties(struct choosenode attribute((unused)) *cn) {
+  return !!files_selected && (disorder_eclient_state(client) & DISORDER_CONNECTED);
 }
-#endif
 
-static gboolean sensitive_properties(struct choosenode attribute((unused)) *cn) {
-  return !!files_selected && (disorder_eclient_state(client) & DISORDER_CONNECTED);
+/* Directory menu items ---------------------------------------------------- */
+
+/** @brief Return the file children of @p cn
+ *
+ * The list is terminated by a null pointer.
+ */
+static const char **dir_files(struct choosenode *cn, int *nfiles) {
+  const char **files = xcalloc(cn->children.nvec + 1, sizeof (char *));
+  int n, m;
+
+  for(n = m = 0; n < cn->children.nvec; ++n) 
+    if(!(cn->children.vec[n]->flags & CN_EXPANDABLE))
+      files[m++] = cn->children.vec[n]->path;
+  files[m] = 0;
+  if(nfiles) *nfiles = m;
+  return files;
+}
+
+static void play_dir(struct choosenode *cn,
+                     void attribute((unused)) *wfu) {
+  int ntracks, n;
+  const char **tracks = dir_files(cn, &ntracks);
+  
+  gtk_label_set_text(GTK_LABEL(report_label), "adding track to queue");
+  for(n = 0; n < ntracks; ++n)
+    disorder_eclient_play(client, tracks[n], 0, 0);
+}
+
+static void properties_dir(struct choosenode *cn,
+                           void attribute((unused)) *wfu) {
+  int ntracks;
+  const char **tracks = dir_files(cn, &ntracks);
+  
+  properties(ntracks, tracks);
+}
+
+static void select_dir(struct choosenode *cn,
+                       void attribute((unused)) *wfu) {
+  int n;
+
+  clear_selection(root);
+  for(n = 0; n < cn->children.nvec; ++n) 
+    set_selection(cn->children.vec[n], 1);
+}
+
+/** @brief Ensure @p cn is expanded and then call @p callback */
+static void call_with_dir(struct choosenode *cn,
+                          when_filled_callback *whenfilled,
+                          void *wfu) {
+  if(!(cn->flags & CN_EXPANDABLE))
+    return;                             /* something went wrong */
+  if(cn->flags & CN_EXPANDED)
+    /* @p cn is already open */
+    whenfilled(cn, wfu);
+  else {
+    /* @p cn is not open, arrange for the callback to go off when it is
+     * opened */
+    cn->whenfilled = whenfilled;
+    cn->wfu = wfu;
+    expand_node(cn);
+  }
+}
+
+/** @brief Called when the directory menu's play option is activated */
+static void activate_dir_play(GtkMenuItem attribute((unused)) *menuitem,
+                              gpointer user_data) {
+  struct choosenode *const cn = (struct choosenode *)user_data;
+
+  call_with_dir(cn, play_dir, 0);
+}
+
+/** @brief Called when the directory menu's properties option is activated */
+static void activate_dir_properties(GtkMenuItem attribute((unused)) *menuitem,
+                                    gpointer user_data) {
+  struct choosenode *const cn = (struct choosenode *)user_data;
+
+  call_with_dir(cn, properties_dir, 0);
+}
+
+/** @brief Called when the directory menu's select option is activated */
+static void activate_dir_select(GtkMenuItem attribute((unused)) *menuitem,
+                                gpointer user_data) {
+  struct choosenode *const cn = (struct choosenode *)user_data;
+
+  call_with_dir(cn, select_dir,  0);
+}
+
+/** @brief Determine whether the directory menu's play option should be sensitive */
+static gboolean sensitive_dir_play(struct choosenode attribute((unused)) *cn) {
+  return !!(disorder_eclient_state(client) & DISORDER_CONNECTED);
+}
+
+/** @brief Determine whether the directory menu's properties option should be sensitive */
+static gboolean sensitive_dir_properties(struct choosenode attribute((unused)) *cn) {
+  return !!(disorder_eclient_state(client) & DISORDER_CONNECTED);
 }
 
+/** @brief Determine whether the directory menu's select option should be sensitive */
+static gboolean sensitive_dir_select(struct choosenode attribute((unused)) *cn) {
+  return TRUE;
+}
+
+
+
 /* Main menu plumbing ------------------------------------------------------ */
 
+/** @brief Determine whether the edit menu's properties option should be sensitive */
 static int choose_properties_sensitive(GtkWidget attribute((unused)) *w) {
   return !!files_selected && (disorder_eclient_state(client) & DISORDER_CONNECTED);
 }
 
+/** @brief Determine whether the edit menu's select all option should be sensitive
+ *
+ * TODO not implemented,  see also choose_selectall_activate()
+ */
 static int choose_selectall_sensitive(GtkWidget attribute((unused)) *w) {
-  return FALSE;                         /* TODO */
+  return FALSE;
 }
 
+/** @brief Called when the edit menu's properties option is activated */
 static void choose_properties_activate(GtkWidget attribute((unused)) *w) {
-  activate_properties(0, 0);
+  activate_track_properties(0, 0);
 }
 
+/** @brief Called when the edit menu's select all option is activated
+ *
+ * TODO not implemented, see choose_selectall_sensitive() */
 static void choose_selectall_activate(GtkWidget attribute((unused)) *w) {
-  /* TODO */
 }
 
+/** @brief Main menu callbacks for Choose screen */
 static const struct tabtype tabtype_choose = {
   choose_properties_sensitive,
   choose_selectall_sensitive,
@@ -978,7 +1186,7 @@ static const struct tabtype tabtype_choose = {
 
 /* Public entry points ----------------------------------------------------- */
 
-/* Create a track choice widget */
+/** @brief Create a track choice widget */
 GtkWidget *choose_widget(void) {
   int n;
   GtkWidget *scrolled;
@@ -1008,12 +1216,15 @@ GtkWidget *choose_widget(void) {
   NW(entry);
   searchentry = gtk_entry_new();
   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);
   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 */
   NW(hbox);
@@ -1031,14 +1242,28 @@ GtkWidget *choose_widget(void) {
                  CN_EXPANDABLE, fill_root_node);
   realroot = root;
   expand_node(root);                    /* will call redisplay_tree */
-  /* Create the popup menu */
+  /* Create the popup menus */
+  NW(menu);
+  track_menu = gtk_menu_new();
+  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_menu_attach(GTK_MENU(track_menu), track_menuitems[n].w,
+                    0, 1, n, n + 1);
+  }
   NW(menu);
-  menu = gtk_menu_new();
-  g_signal_connect(menu, "destroy", G_CALLBACK(gtk_widget_destroyed), &menu);
-  for(n = 0; n < NMENUITEMS; ++n) {
+  dir_menu = gtk_menu_new();
+  g_signal_connect(dir_menu, "destroy", G_CALLBACK(gtk_widget_destroyed),
+                   &dir_menu);
+  for(n = 0; dir_menuitems[n].name; ++n) {
     NW(menu_item);
-    menuitems[n].w = gtk_menu_item_new_with_label(menuitems[n].name);
-    gtk_menu_attach(GTK_MENU(menu), menuitems[n].w, 0, 1, n, n + 1);
+    dir_menuitems[n].w = 
+      gtk_menu_item_new_with_label(dir_menuitems[n].name);
+    gtk_menu_attach(GTK_MENU(dir_menu), dir_menuitems[n].w,
+                    0, 1, n, n + 1);
   }
   /* The layout is scrollable */
   scrolled = scroll_widget(GTK_WIDGET(chooselayout), "choose");
@@ -1055,7 +1280,7 @@ GtkWidget *choose_widget(void) {
   return vbox;
 }
 
-/* Called when something we care about here might have changed */
+/** @brief Called when something we care about here might have changed */
 void choose_update(void) {
   redisplay_tree();
 }