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

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 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 now use an ordinary GtkTreeStore/GtkTreeView.
  24  *
  25  * We don't want to pull the entire tree in memory, but we want directories to
  26  * show up as having children.  Therefore we give directories a placeholder
  27  * child and replace their children when they are opened.  Placeholders have
  28  * TRACK_COLUMN="" and ISFILE_COLUMN=FALSE (so that they don't get check boxes,
  29  * lengths, etc).
  30  *
  31  * TODO We do a period sweep which kills contracted nodes, putting back
  32  * placeholders, and updating expanded nodes to keep up with server-side
  33  * changes.  (We could trigger the latter off rescan complete notifications?)
  34  *
  35  * TODO:
  36  * - sweep up contracted nodes
  37  * - update when content may have changed (e.g. after a rescan)
  38  * - searching!
  39  * - proper sorting
  40  */
  41
  42 #include "disobedience.h"
  43 #include "choose.h"
  44
  45 /** @brief The current selection tree */
  46 GtkTreeStore *choose_store;
  47
  48 /** @brief The view onto the selection tree */
  49 GtkWidget *choose_view;
  50
  51 /** @brief The selection tree's selection */
  52 GtkTreeSelection *choose_selection;
  53
  54 static char *choose_get_string(GtkTreeIter *iter, int column) {
  55   gchar *gs;
  56   gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
  57                      column, &gs,
  58                      -1);
  59   char *s = xstrdup(gs);
  60   g_free(gs);
  61   return s;
  62 }
  63
  64 char *choose_get_track(GtkTreeIter *iter) {
  65   char *s = choose_get_string(iter, TRACK_COLUMN);
  66   return *s ? s : 0;                    /* Placeholder -> NULL */
  67 }
  68
  69 char *choose_get_sort(GtkTreeIter *iter) {
  70   return choose_get_string(iter, SORT_COLUMN);
  71 }
  72
  73 int choose_is_file(GtkTreeIter *iter) {
  74   gboolean isfile;
  75   gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
  76                      ISFILE_COLUMN, &isfile,
  77                      -1);
  78   return isfile;
  79 }
  80
  81 int choose_is_dir(GtkTreeIter *iter) {
  82   gboolean isfile;
  83   gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
  84                      ISFILE_COLUMN, &isfile,
  85                      -1);
  86   if(isfile)
  87     return FALSE;
  88   return !choose_is_placeholder(iter);
  89 }
  90
  91 int choose_is_placeholder(GtkTreeIter *iter) {
  92   return choose_get_string(iter, TRACK_COLUMN)[0] == 0;
  93 }
  94
  95 /** @brief Remove node @p it and all its children
  96  * @param Iterator, updated to point to next
  97  * @return True if iterator remains valid
  98  */
  99 static gboolean choose_remove_node(GtkTreeIter *it) {
 100   GtkTreeIter child[1];
 101   gboolean childv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
 102                                                  child,
 103                                                  it);
 104   while(childv)
 105     childv = choose_remove_node(child);
 106   return gtk_tree_store_remove(choose_store, it);
 107 }
 108
 109 /** @brief Update length and state fields */
 110 static gboolean choose_set_state_callback(GtkTreeModel attribute((unused)) *model,
 111                                           GtkTreePath attribute((unused)) *path,
 112                                           GtkTreeIter *it,
 113                                           gpointer attribute((unused)) data) {
 114   if(choose_is_file(it)) {
 115     const char *track = choose_get_track(it);
 116     const long l = namepart_length(track);
 117     char length[64];
 118     if(l > 0)
 119       byte_snprintf(length, sizeof length, "%ld:%02ld", l / 60, l % 60);
 120     else
 121       length[0] = 0;
 122     gtk_tree_store_set(choose_store, it,
 123                        LENGTH_COLUMN, length,
 124                        STATE_COLUMN, queued(track),
 125                        -1);
 126     if(choose_is_search_result(track))
 127       gtk_tree_store_set(choose_store, it,
 128                          BG_COLUMN, "yellow",
 129                          FG_COLUMN, "black",
 130                          -1);
 131     else
 132       gtk_tree_store_set(choose_store, it,
 133                          BG_COLUMN, (char *)0,
 134                          FG_COLUMN, (char *)0,
 135                          -1);
 136   }
 137   return FALSE;                         /* continue walking */
 138 }
 139
 140 /** @brief Called when the queue or playing track change */
 141 static void choose_set_state(const char attribute((unused)) *event,
 142                              void attribute((unused)) *eventdata,
 143                              void attribute((unused)) *callbackdata) {
 144   gtk_tree_model_foreach(GTK_TREE_MODEL(choose_store),
 145                          choose_set_state_callback,
 146                          NULL);
 147 }
 148
 149 /** @brief (Re-)populate a node
 150  * @param parent_ref Node to populate or NULL to fill root
 151  * @param nvec Number of children to add
 152  * @param vec Children
 153  * @param files 1 if children are files, 0 if directories
 154  *
 155  * Adjusts the set of files (or directories) below @p parent_ref to match those
 156  * listed in @p nvec and @p vec.
 157  *
 158  * @parent_ref will be destroyed.
 159  */
 160 static void choose_populate(GtkTreeRowReference *parent_ref,
 161                             int nvec, char **vec,
 162                             int isfile) {
 163   /* Compute parent_* */
 164   GtkTreeIter pit[1], *parent_it;
 165   GtkTreePath *parent_path;
 166   if(parent_ref) {
 167     parent_path = gtk_tree_row_reference_get_path(parent_ref);
 168     parent_it = pit;
 169     gboolean pitv = gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store),
 170                                             pit, parent_path);
 171     assert(pitv);
 172     /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
 173             choose_type_map[type],
 174             gtk_tree_path_to_string(parent_path));*/
 175   } else {
 176     parent_path = 0;
 177     parent_it = 0;
 178     /*fprintf(stderr, "choose_populate %s: populating the root\n",
 179             choose_type_map[type]);*/
 180   }
 181   /* Remove unwanted nodes and find out which we must add */
 182   //fprintf(stderr, " trimming unwanted %s nodes\n", choose_type_map[type]);
 183   char *found = xmalloc(nvec);
 184   GtkTreeIter it[1];
 185   gboolean itv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
 186                                               it,
 187                                               parent_it);
 188   while(itv) {
 189     const char *track = choose_get_track(it);
 190     int keep;
 191
 192     if(!track)  {
 193       /* Always kill placeholders */
 194       //fprintf(stderr, "  kill a placeholder\n");
 195       keep = 0;
 196     } else if(choose_is_file(it) == isfile) {
 197       /* This is the type we care about */
 198       //fprintf(stderr, "  %s is a %s\n", track, isfile ? "file" : "dir");
 199       int n;
 200       for(n = 0; n < nvec && strcmp(vec[n], track); ++n)
 201         ;
 202       if(n < nvec) {
 203         //fprintf(stderr, "   ... and survives\n");
 204         found[n] = 1;
 205         keep = 1;
 206       } else {
 207         //fprintf(stderr, "   ... and is to be removed\n");
 208         keep = 0;
 209       }
 210     } else {
 211       /* Keep wrong-type entries */
 212       //fprintf(stderr, "  %s has wrong type\n", track);
 213       keep = 1;
 214     }
 215     if(keep)
 216       itv = gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store), it);
 217     else
 218       itv = choose_remove_node(it);
 219   }
 220   /* Add nodes we don't have */
 221   int inserted = 0;
 222   //fprintf(stderr, " inserting new %s nodes\n", choose_type_map[type]);
 223   const char *typename = isfile ? "track" : "dir";
 224   for(int n = 0; n < nvec; ++n) {
 225     if(!found[n]) {
 226       //fprintf(stderr, "  %s was not found\n", vec[n]);
 227       gtk_tree_store_append(choose_store, it, parent_it);
 228       gtk_tree_store_set(choose_store, it,
 229                          NAME_COLUMN, trackname_transform(typename,
 230                                                           vec[n],
 231                                                           "display"),
 232                          ISFILE_COLUMN, isfile,
 233                          TRACK_COLUMN, vec[n],
 234                          SORT_COLUMN, trackname_transform(typename,
 235                                                           vec[n],
 236                                                           "sort"),
 237                          -1);
 238       /* Update length and state; we expect this to kick off length lookups
 239        * rather than necessarily get the right value the first time round. */
 240       choose_set_state_callback(0, 0, it, 0);
 241       ++inserted;
 242       /* If we inserted a directory, insert a placeholder too, so it appears to
 243        * have children; it will be deleted when we expand the directory. */
 244       if(!isfile) {
 245         //fprintf(stderr, "  inserting a placeholder\n");
 246         GtkTreeIter placeholder[1];
 247
 248         gtk_tree_store_append(choose_store, placeholder, it);
 249         gtk_tree_store_set(choose_store, placeholder,
 250                            NAME_COLUMN, "Waddling...",
 251                            TRACK_COLUMN, "",
 252                            ISFILE_COLUMN, FALSE,
 253                            -1);
 254       }
 255     }
 256   }
 257   //fprintf(stderr, " %d nodes inserted\n", inserted);
 258   if(inserted) {
 259     /* TODO sort the children */
 260   }
 261   if(parent_ref) {
 262     /* If we deleted a placeholder then we must re-expand the row */
 263     gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view), parent_path, FALSE);
 264     gtk_tree_row_reference_free(parent_ref);
 265     gtk_tree_path_free(parent_path);
 266   }
 267 }
 268
 269 static void choose_dirs_completed(void *v,
 270                                   const char *error,
 271                                   int nvec, char **vec) {
 272   if(error) {
 273     popup_protocol_error(0, error);
 274     return;
 275   }
 276   choose_populate(v, nvec, vec, 0/*!isfile*/);
 277 }
 278
 279 static void choose_files_completed(void *v,
 280                                    const char *error,
 281                                    int nvec, char **vec) {
 282   if(error) {
 283     popup_protocol_error(0, error);
 284     return;
 285   }
 286   choose_populate(v, nvec, vec, 1/*isfile*/);
 287 }
 288
 289 void choose_play_completed(void attribute((unused)) *v,
 290                            const char *error) {
 291   if(error)
 292     popup_protocol_error(0, error);
 293 }
 294
 295 static void choose_state_toggled
 296     (GtkCellRendererToggle attribute((unused)) *cell_renderer,
 297      gchar *path_str,
 298      gpointer attribute((unused)) user_data) {
 299   GtkTreeIter it[1];
 300   /* Identify the track */
 301   gboolean itv =
 302     gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(choose_store),
 303                                         it,
 304                                         path_str);
 305   if(!itv)
 306     return;
 307   if(!choose_is_file(it))
 308     return;
 309   const char *track = choose_get_track(it);
 310   if(queued(track))
 311     return;
 312   disorder_eclient_play(client, track, choose_play_completed, 0);
 313
 314 }
 315
 316 static void choose_row_expanded(GtkTreeView attribute((unused)) *treeview,
 317                                 GtkTreeIter *iter,
 318                                 GtkTreePath *path,
 319                                 gpointer attribute((unused)) user_data) {
 320   /*fprintf(stderr, "row-expanded path=[%s]\n",
 321           gtk_tree_path_to_string(path));*/
 322   /* We update a node's contents whenever it is expanded, even if it was
 323    * already populated; the effect is that contracting and expanding a node
 324    * suffices to update it to the latest state on the server. */
 325   const char *track = choose_get_track(iter);
 326   disorder_eclient_files(client, choose_files_completed,
 327                          track,
 328                          NULL,
 329                          gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
 330                                                     path));
 331   disorder_eclient_dirs(client, choose_dirs_completed,
 332                         track,
 333                         NULL,
 334                         gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
 335                                                    path));
 336   /* The row references are destroyed in the _completed handlers. */
 337 }
 338
 339 /** @brief Create the choose tab */
 340 GtkWidget *choose_widget(void) {
 341   /* Create the tree store. */
 342   choose_store = gtk_tree_store_new(CHOOSE_COLUMNS,
 343                                     G_TYPE_BOOLEAN,
 344                                     G_TYPE_STRING,
 345                                     G_TYPE_STRING,
 346                                     G_TYPE_BOOLEAN,
 347                                     G_TYPE_STRING,
 348                                     G_TYPE_STRING,
 349                                     G_TYPE_STRING,
 350                                     G_TYPE_STRING);
 351
 352   /* Create the view */
 353   choose_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store));
 354   gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(choose_view), TRUE);
 355
 356   /* Create cell renderers and columns */
 357   /* TODO use a table */
 358   {
 359     GtkCellRenderer *r = gtk_cell_renderer_text_new();
 360     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 361       ("Track",
 362        r,
 363        "text", NAME_COLUMN,
 364        "background", BG_COLUMN,
 365        "foreground", FG_COLUMN,
 366        (char *)0);
 367     gtk_tree_view_column_set_resizable(c, TRUE);
 368     gtk_tree_view_column_set_reorderable(c, TRUE);
 369     g_object_set(c, "expand", TRUE, (char *)0);
 370     gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
 371   }
 372   {
 373     GtkCellRenderer *r = gtk_cell_renderer_text_new();
 374     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 375       ("Length",
 376        r,
 377        "text", LENGTH_COLUMN,
 378        (char *)0);
 379     gtk_tree_view_column_set_resizable(c, TRUE);
 380     gtk_tree_view_column_set_reorderable(c, TRUE);
 381     g_object_set(r, "xalign", (gfloat)1.0, (char *)0);
 382     gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
 383   }
 384   {
 385     GtkCellRenderer *r = gtk_cell_renderer_toggle_new();
 386     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 387       ("Queued",
 388        r,
 389        "active", STATE_COLUMN,
 390        "visible", ISFILE_COLUMN,
 391        (char *)0);
 392     gtk_tree_view_column_set_resizable(c, TRUE);
 393     gtk_tree_view_column_set_reorderable(c, TRUE);
 394     gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
 395     g_signal_connect(r, "toggled",
 396                      G_CALLBACK(choose_state_toggled), 0);
 397   }
 398
 399   /* The selection should support multiple things being selected */
 400   choose_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view));
 401   gtk_tree_selection_set_mode(choose_selection, GTK_SELECTION_MULTIPLE);
 402
 403   /* Catch button presses */
 404   g_signal_connect(choose_view, "button-press-event",
 405                    G_CALLBACK(choose_button_event), 0);
 406   g_signal_connect(choose_view, "button-release-event",
 407                    G_CALLBACK(choose_button_event), 0);
 408   /* Catch row expansions so we can fill in placeholders */
 409   g_signal_connect(choose_view, "row-expanded",
 410                    G_CALLBACK(choose_row_expanded), 0);
 411
 412   event_register("queue-list-changed", choose_set_state, 0);
 413   event_register("playing-track-changed", choose_set_state, 0);
 414   event_register("search-results-changed", choose_set_state, 0);
 415
 416   /* Fill the root */
 417   disorder_eclient_files(client, choose_files_completed, "", NULL, NULL);
 418   disorder_eclient_dirs(client, choose_dirs_completed, "", NULL, NULL);
 419
 420   /* Make the widget scrollable */
 421   GtkWidget *scrolled = scroll_widget(choose_view);
 422
 423   /* Pack vertically with the search widget */
 424   GtkWidget *vbox = gtk_vbox_new(FALSE/*homogenous*/, 1/*spacing*/);
 425   gtk_box_pack_start(GTK_BOX(vbox), scrolled,
 426                      TRUE/*expand*/, TRUE/*fill*/, 0/*padding*/);
 427   gtk_box_pack_end(GTK_BOX(vbox), choose_search_widget(),
 428                    FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
 429
 430   g_object_set_data(G_OBJECT(vbox), "type", (void *)&choose_tabtype);
 431   return vbox;
 432 }
 433
 434 /*
 435 Local Variables:
 436 c-basic-offset:2
 437 comment-column:40
 438 fill-column:79
 439 indent-tabs-mode:nil
 440 End:
 441 */