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  */
  39
  40 #include "disobedience.h"
  41 #include "choose.h"
  42
  43 /** @brief The current selection tree */
  44 GtkTreeStore *choose_store;
  45
  46 /** @brief The view onto the selection tree */
  47 GtkWidget *choose_view;
  48
  49 /** @brief The selection tree's selection */
  50 GtkTreeSelection *choose_selection;
  51
  52 /** @brief Count of file listing operations in flight */
  53 static int choose_list_in_flight;
  54
  55 /** @brief Count of files inserted in current batch of listing operations */
  56 static int choose_inserted;
  57
  58 static char *choose_get_string(GtkTreeIter *iter, int column) {
  59   gchar *gs;
  60   gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
  61                      column, &gs,
  62                      -1);
  63   char *s = xstrdup(gs);
  64   g_free(gs);
  65   return s;
  66 }
  67
  68 char *choose_get_track(GtkTreeIter *iter) {
  69   char *s = choose_get_string(iter, TRACK_COLUMN);
  70   return *s ? s : 0;                    /* Placeholder -> NULL */
  71 }
  72
  73 char *choose_get_sort(GtkTreeIter *iter) {
  74   return choose_get_string(iter, SORT_COLUMN);
  75 }
  76
  77 char *choose_get_display(GtkTreeIter *iter) {
  78   return choose_get_string(iter, NAME_COLUMN);
  79 }
  80
  81 int choose_is_file(GtkTreeIter *iter) {
  82   gboolean isfile;
  83   gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
  84                      ISFILE_COLUMN, &isfile,
  85                      -1);
  86   return isfile;
  87 }
  88
  89 int choose_is_dir(GtkTreeIter *iter) {
  90   gboolean isfile;
  91   gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
  92                      ISFILE_COLUMN, &isfile,
  93                      -1);
  94   if(isfile)
  95     return FALSE;
  96   return !choose_is_placeholder(iter);
  97 }
  98
  99 int choose_is_placeholder(GtkTreeIter *iter) {
 100   return choose_get_string(iter, TRACK_COLUMN)[0] == 0;
 101 }
 102
 103 /** @brief Remove node @p it and all its children
 104  * @param Iterator, updated to point to next
 105  * @return True if iterator remains valid
 106  *
 107  * TODO is this necessary?  gtk_tree_store_remove() does not document what
 108  * happens to children.
 109  */
 110 static gboolean choose_remove_node(GtkTreeIter *it) {
 111   GtkTreeIter child[1];
 112   gboolean childv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
 113                                                  child,
 114                                                  it);
 115   while(childv)
 116     childv = choose_remove_node(child);
 117   return gtk_tree_store_remove(choose_store, it);
 118 }
 119
 120 /** @brief Update length and state fields */
 121 static gboolean choose_set_state_callback(GtkTreeModel attribute((unused)) *model,
 122                                           GtkTreePath attribute((unused)) *path,
 123                                           GtkTreeIter *it,
 124                                           gpointer attribute((unused)) data) {
 125   if(choose_is_file(it)) {
 126     const char *track = choose_get_track(it);
 127     const long l = namepart_length(track);
 128     char length[64];
 129     if(l > 0)
 130       byte_snprintf(length, sizeof length, "%ld:%02ld", l / 60, l % 60);
 131     else
 132       length[0] = 0;
 133     gtk_tree_store_set(choose_store, it,
 134                        LENGTH_COLUMN, length,
 135                        STATE_COLUMN, queued(track),
 136                        -1);
 137     if(choose_is_search_result(track))
 138       gtk_tree_store_set(choose_store, it,
 139                          BG_COLUMN, SEARCH_RESULT_BG,
 140                          FG_COLUMN, SEARCH_RESULT_FG,
 141                          -1);
 142     else
 143       gtk_tree_store_set(choose_store, it,
 144                          BG_COLUMN, (char *)0,
 145                          FG_COLUMN, (char *)0,
 146                          -1);
 147   }
 148   return FALSE;                         /* continue walking */
 149 }
 150
 151 /** @brief Called when the queue or playing track change */
 152 static void choose_set_state(const char attribute((unused)) *event,
 153                              void attribute((unused)) *eventdata,
 154                              void attribute((unused)) *callbackdata) {
 155   gtk_tree_model_foreach(GTK_TREE_MODEL(choose_store),
 156                          choose_set_state_callback,
 157                          NULL);
 158 }
 159
 160 /** @brief (Re-)populate a node
 161  * @param parent_ref Node to populate or NULL to fill root
 162  * @param nvec Number of children to add
 163  * @param vec Children
 164  * @param files 1 if children are files, 0 if directories
 165  *
 166  * Adjusts the set of files (or directories) below @p parent_ref to match those
 167  * listed in @p nvec and @p vec.
 168  *
 169  * @parent_ref will be destroyed.
 170  */
 171 static void choose_populate(GtkTreeRowReference *parent_ref,
 172                             int nvec, char **vec,
 173                             int isfile) {
 174   if(!nvec)
 175     return;
 176   const char *type = isfile ? "track" : "dir";
 177   /* Compute parent_* */
 178   GtkTreeIter pit[1], *parent_it;
 179   GtkTreePath *parent_path;
 180   if(parent_ref) {
 181     parent_path = gtk_tree_row_reference_get_path(parent_ref);
 182     parent_it = pit;
 183     gboolean pitv = gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store),
 184                                             pit, parent_path);
 185     assert(pitv);
 186     /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
 187             type,
 188             gtk_tree_path_to_string(parent_path));*/
 189   } else {
 190     parent_path = 0;
 191     parent_it = 0;
 192     /*fprintf(stderr, "choose_populate %s: populating the root\n",
 193             type);*/
 194   }
 195   /* Both td[] and the current node set are sorted so we can do a single linear
 196    * pass to insert new nodes and remove unwanted ones.  The total performance
 197    * may be worse than linear depending on the performance of GTK+'s insert and
 198    * delete operations. */
 199   //fprintf(stderr, "sorting tracks\n");
 200   struct tracksort_data *td = tracksort_init(nvec, vec, type);
 201   GtkTreeIter it[1];
 202   gboolean itv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
 203                                               it,
 204                                               parent_it);
 205   int inserted = 0, deleted_placeholder = 0;
 206   //fprintf(stderr, "inserting tracks type=%s\n", type);
 207   while(nvec > 0 || itv) {
 208     /*fprintf(stderr, "td[] = %s, it=%s [%s]\n",
 209             nvec > 0 ? td->track : "(none)",
 210             itv ? choose_get_track(it) : "(!itv)",
 211             itv ? (choose_is_file(it) ? "file" : "dir") : "");*/
 212     enum { INSERT, DELETE, SKIP_TREE, SKIP_BOTH } action;
 213     const char *track = itv ? choose_get_track(it) : 0;
 214     if(itv && !track) {
 215       //fprintf(stderr, " placeholder\n");
 216       action = DELETE;
 217       ++deleted_placeholder;
 218     } else if(nvec > 0 && itv) {
 219       /* There's both a tree row and a td[] entry */
 220       const int cmp = compare_tracks(td->sort, choose_get_sort(it),
 221                                      td->display, choose_get_display(it),
 222                                      td->track, track);
 223       //fprintf(stderr, " cmp=%d\n", cmp);
 224       if(cmp < 0)
 225         /* td < it, so we insert td before it */
 226         action = INSERT;
 227       else if(cmp > 0) {
 228         /* td > it, so we must either delete it (if the same type) or skip it */
 229         if(choose_is_file(it) == isfile)
 230           action = DELETE;
 231         else
 232           action = SKIP_TREE;
 233       } else
 234         /* td = it, so we step past both */
 235         action = SKIP_BOTH;
 236     } else if(nvec > 0) {
 237       /* We've reached the end of the tree rows, but new have tracks left in
 238        * td[] */
 239       //fprintf(stderr, " inserting\n");
 240       action = INSERT;
 241     } else {
 242       /* We've reached the end of the new tracks from td[], but there are
 243        * further tracks in the tree */
 244       //fprintf(stderr, " deleting\n");
 245       action = DELETE;
 246     }
 247
 248     switch(action) {
 249     case INSERT: {
 250       //fprintf(stderr, " INSERT %s\n", td->track);
 251       /* Insert a new row from td[] before it, or at the end if it is no longer
 252        * valid */
 253       GtkTreeIter child[1];
 254       gtk_tree_store_insert_before(choose_store,
 255                                    child, /* new row */
 256                                    parent_it, /* parent */
 257                                    itv ? it : NULL); /* successor */
 258       gtk_tree_store_set(choose_store, child,
 259                          NAME_COLUMN, td->display,
 260                          ISFILE_COLUMN, isfile,
 261                          TRACK_COLUMN, td->track,
 262                          SORT_COLUMN, td->sort,
 263                          -1);
 264       /* Update length and state; we expect this to kick off length lookups
 265        * rather than necessarily get the right value the first time round. */
 266       choose_set_state_callback(0, 0, child, 0);
 267       /* If we inserted a directory, insert a placeholder too, so it appears to
 268        * have children; it will be deleted when we expand the directory. */
 269       if(!isfile) {
 270         //fprintf(stderr, "  inserting a placeholder\n");
 271         GtkTreeIter placeholder[1];
 272
 273         gtk_tree_store_append(choose_store, placeholder, child);
 274         gtk_tree_store_set(choose_store, placeholder,
 275                            NAME_COLUMN, "Waddling...",
 276                            TRACK_COLUMN, "",
 277                            ISFILE_COLUMN, FALSE,
 278                            -1);
 279       }
 280       ++inserted;
 281       ++td;
 282       --nvec;
 283       break;
 284     }
 285     case SKIP_BOTH:
 286       //fprintf(stderr, " SKIP_BOTH\n");
 287       ++td;
 288       --nvec;
 289       /* fall thru */
 290     case SKIP_TREE:
 291       //fprintf(stderr, " SKIP_TREE\n");
 292       itv = gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store), it);
 293       break;
 294     case DELETE:
 295       //fprintf(stderr, " DELETE\n");
 296       itv = choose_remove_node(it);
 297       break;
 298     }
 299   }
 300   /*fprintf(stderr, "inserted=%d deleted_placeholder=%d\n\n",
 301           inserted, deleted_placeholder);*/
 302   if(parent_ref) {
 303     /* If we deleted a placeholder then we must re-expand the row */
 304     if(deleted_placeholder)
 305       gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view), parent_path, FALSE);
 306     gtk_tree_row_reference_free(parent_ref);
 307     gtk_tree_path_free(parent_path);
 308   }
 309   /* We only notify others that we've inserted tracks when there are no more
 310    * insertions pending, so that they don't have to keep track of how many
 311    * requests they've made.  */
 312   choose_inserted += inserted;
 313   if(--choose_list_in_flight == 0) {
 314     /* Notify interested parties that we inserted some tracks, AFTER making
 315      * sure that the row is properly expanded */
 316     if(choose_inserted) {
 317       event_raise("choose-inserted-tracks", parent_it);
 318       choose_inserted = 0;
 319     }
 320   }
 321 }
 322
 323 static void choose_dirs_completed(void *v,
 324                                   const char *error,
 325                                   int nvec, char **vec) {
 326   if(error) {
 327     popup_protocol_error(0, error);
 328     return;
 329   }
 330   choose_populate(v, nvec, vec, 0/*!isfile*/);
 331 }
 332
 333 static void choose_files_completed(void *v,
 334                                    const char *error,
 335                                    int nvec, char **vec) {
 336   if(error) {
 337     popup_protocol_error(0, error);
 338     return;
 339   }
 340   choose_populate(v, nvec, vec, 1/*isfile*/);
 341 }
 342
 343 void choose_play_completed(void attribute((unused)) *v,
 344                            const char *error) {
 345   if(error)
 346     popup_protocol_error(0, error);
 347 }
 348
 349 static void choose_state_toggled
 350     (GtkCellRendererToggle attribute((unused)) *cell_renderer,
 351      gchar *path_str,
 352      gpointer attribute((unused)) user_data) {
 353   GtkTreeIter it[1];
 354   /* Identify the track */
 355   gboolean itv =
 356     gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(choose_store),
 357                                         it,
 358                                         path_str);
 359   if(!itv)
 360     return;
 361   if(!choose_is_file(it))
 362     return;
 363   const char *track = choose_get_track(it);
 364   if(queued(track))
 365     return;
 366   disorder_eclient_play(client, track, choose_play_completed, 0);
 367
 368 }
 369
 370 static void choose_row_expanded(GtkTreeView attribute((unused)) *treeview,
 371                                 GtkTreeIter *iter,
 372                                 GtkTreePath *path,
 373                                 gpointer attribute((unused)) user_data) {
 374   /*fprintf(stderr, "row-expanded path=[%s]\n\n",
 375           gtk_tree_path_to_string(path));*/
 376   /* We update a node's contents whenever it is expanded, even if it was
 377    * already populated; the effect is that contracting and expanding a node
 378    * suffices to update it to the latest state on the server. */
 379   const char *track = choose_get_track(iter);
 380   disorder_eclient_files(client, choose_files_completed,
 381                          track,
 382                          NULL,
 383                          gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
 384                                                     path));
 385   disorder_eclient_dirs(client, choose_dirs_completed,
 386                         track,
 387                         NULL,
 388                         gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
 389                                                    path));
 390   /* The row references are destroyed in the _completed handlers. */
 391   choose_list_in_flight += 2;
 392 }
 393
 394 /** @brief Create the choose tab */
 395 GtkWidget *choose_widget(void) {
 396   /* Create the tree store. */
 397   choose_store = gtk_tree_store_new(CHOOSE_COLUMNS,
 398                                     G_TYPE_BOOLEAN,
 399                                     G_TYPE_STRING,
 400                                     G_TYPE_STRING,
 401                                     G_TYPE_BOOLEAN,
 402                                     G_TYPE_STRING,
 403                                     G_TYPE_STRING,
 404                                     G_TYPE_STRING,
 405                                     G_TYPE_STRING);
 406
 407   /* Create the view */
 408   choose_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store));
 409   gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(choose_view), TRUE);
 410
 411   /* Create cell renderers and columns */
 412   /* TODO use a table */
 413   {
 414     GtkCellRenderer *r = gtk_cell_renderer_toggle_new();
 415     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 416       ("Queued",
 417        r,
 418        "active", STATE_COLUMN,
 419        "visible", ISFILE_COLUMN,
 420        (char *)0);
 421     gtk_tree_view_column_set_resizable(c, TRUE);
 422     gtk_tree_view_column_set_reorderable(c, TRUE);
 423     gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
 424     g_signal_connect(r, "toggled",
 425                      G_CALLBACK(choose_state_toggled), 0);
 426   }
 427   {
 428     GtkCellRenderer *r = gtk_cell_renderer_text_new();
 429     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 430       ("Length",
 431        r,
 432        "text", LENGTH_COLUMN,
 433        (char *)0);
 434     gtk_tree_view_column_set_resizable(c, TRUE);
 435     gtk_tree_view_column_set_reorderable(c, TRUE);
 436     g_object_set(r, "xalign", (gfloat)1.0, (char *)0);
 437     gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
 438   }
 439   {
 440     GtkCellRenderer *r = gtk_cell_renderer_text_new();
 441     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 442       ("Track",
 443        r,
 444        "text", NAME_COLUMN,
 445        "background", BG_COLUMN,
 446        "foreground", FG_COLUMN,
 447        (char *)0);
 448     gtk_tree_view_column_set_resizable(c, TRUE);
 449     gtk_tree_view_column_set_reorderable(c, TRUE);
 450     g_object_set(c, "expand", TRUE, (char *)0);
 451     gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
 452     gtk_tree_view_set_expander_column(GTK_TREE_VIEW(choose_view), c);
 453   }
 454
 455   /* The selection should support multiple things being selected */
 456   choose_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view));
 457   gtk_tree_selection_set_mode(choose_selection, GTK_SELECTION_MULTIPLE);
 458
 459   /* Catch button presses */
 460   g_signal_connect(choose_view, "button-press-event",
 461                    G_CALLBACK(choose_button_event), 0);
 462   g_signal_connect(choose_view, "button-release-event",
 463                    G_CALLBACK(choose_button_event), 0);
 464   /* Catch row expansions so we can fill in placeholders */
 465   g_signal_connect(choose_view, "row-expanded",
 466                    G_CALLBACK(choose_row_expanded), 0);
 467
 468   event_register("queue-list-changed", choose_set_state, 0);
 469   event_register("playing-track-changed", choose_set_state, 0);
 470   event_register("search-results-changed", choose_set_state, 0);
 471   event_register("lookups-completed", choose_set_state, 0);
 472
 473   /* Fill the root */
 474   disorder_eclient_files(client, choose_files_completed, "", NULL, NULL);
 475   disorder_eclient_dirs(client, choose_dirs_completed, "", NULL, NULL);
 476
 477   /* Make the widget scrollable */
 478   GtkWidget *scrolled = scroll_widget(choose_view);
 479
 480   /* Pack vertically with the search widget */
 481   GtkWidget *vbox = gtk_vbox_new(FALSE/*homogenous*/, 1/*spacing*/);
 482   gtk_box_pack_start(GTK_BOX(vbox), scrolled,
 483                      TRUE/*expand*/, TRUE/*fill*/, 0/*padding*/);
 484   gtk_box_pack_end(GTK_BOX(vbox), choose_search_widget(),
 485                    FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
 486
 487   g_object_set_data(G_OBJECT(vbox), "type", (void *)&choose_tabtype);
 488   return vbox;
 489 }
 490
 491 /*
 492 Local Variables:
 493 c-basic-offset:2
 494 comment-column:40
 495 fill-column:79
 496 indent-tabs-mode:nil
 497 End:
 498 */