chiark - git - mdw - disorder/blob - disobedience/queue.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/queue.c
  21  * @brief Queue widgets
  22  *
  23  * This file provides both the queue widget and the recently-played widget.
  24  *
  25  * A queue layout is structured as follows:
  26  *
  27  * <pre>
  28  *  vbox
  29  *   titlescroll
  30  *    titlelayout
  31  *     titlecells[col]                 eventbox (made by wrap_queue_cell)
  32  *      titlecells[col]->child         label (from columns[])
  33  *   mainscroll
  34  *    mainlayout
  35  *     cells[row * N + c]              eventbox (made by wrap_queue_cell)
  36  *      cells[row * N + c]->child      label (from column constructors)
  37  * </pre>
  38  *
  39  * titlescroll never has any scrollbars.  Instead whenever mainscroll's
  40  * horizontal adjustment is changed, queue_scrolled adjusts titlescroll to
  41  * match, forcing the title and the queue to pan in sync but allowing the queue
  42  * to scroll independently.
  43  *
  44  * Whenever the queue changes everything below mainlayout is thrown away and
  45  * reconstructed from scratch.  Name lookups are cached, so this doesn't imply
  46  * lots of disorder protocol traffic.
  47  *
  48  * The last cell on each row is the padding cell, and this extends ridiculously
  49  * far to the right.  (Can we do better?)
  50  *
  51  * When drag and drop is active we create extra eventboxes to act as dropzones.
  52  * These only exist while the drag proceeds, as otherwise they steal events
  53  * from more deserving widgets.  (It might work to hide them when not in use
  54  * too but this way around the d+d code is a bit more self-contained.)
  55  *
  56  * NB that while in the server the playing track is not in the queue, in
  57  * Disobedience, the playing does live in @c ql_queue.q, despite its different
  58  * status to everything else found in that list.
  59  */
  60
  61 #include "disobedience.h"
  62 #include "charset.h"
  63
  64 /** @brief Horizontal padding for queue cells */
  65 #define HCELLPADDING 4
  66
  67 /** @brief Vertical padding for queue cells */
  68 #define VCELLPADDING 2
  69
  70 /* Queue management -------------------------------------------------------- */
  71
  72 WT(label);
  73 WT(event_box);
  74 WT(menu);
  75 WT(menu_item);
  76 WT(layout);
  77 WT(vbox);
  78
  79 struct queuelike;
  80
  81 static void add_drag_targets(struct queuelike *ql);
  82 static void remove_drag_targets(struct queuelike *ql);
  83 static void redisplay_queue(struct queuelike *ql);
  84 static GtkWidget *column_when(const struct queuelike *ql,
  85                               const struct queue_entry *q,
  86                               const char *data);
  87 static GtkWidget *column_who(const struct queuelike *ql,
  88                              const struct queue_entry *q,
  89                              const char *data);
  90 static GtkWidget *column_namepart(const struct queuelike *ql,
  91                                   const struct queue_entry *q,
  92                                   const char *data);
  93 static GtkWidget *column_length(const struct queuelike *ql,
  94                                 const struct queue_entry *q,
  95                                 const char *data);
  96 static int draggable_row(const struct queue_entry *q);
  97
  98 static const struct tabtype tabtype_queue; /* forward */
  99
 100 static const GtkTargetEntry dragtargets[] = {
 101   { (char *)"disobedience-queue", GTK_TARGET_SAME_APP, 0 }
 102 };
 103 #define NDRAGTARGETS (int)(sizeof dragtargets / sizeof *dragtargets)
 104
 105 /** @brief Definition of a column */
 106 struct column {
 107   const char *name;                     /* Column name */
 108   GtkWidget *(*widget)(const struct queuelike *ql,
 109                        const struct queue_entry *q,
 110                        const char *data); /* Make a label for this column */
 111   const char *data;                     /* Data to pass to widget() */
 112   gfloat xalign;                        /* Alignment of the label */
 113 };
 114
 115 /** @brief Table of columns for queue and recently played list */
 116 static const struct column maincolumns[] = {
 117   { "When",   column_when,     0,        1 },
 118   { "Who",    column_who,      0,        0 },
 119   { "Artist", column_namepart, "artist", 0 },
 120   { "Album",  column_namepart, "album",  0 },
 121   { "Title",  column_namepart, "title",  0 },
 122   { "Length", column_length,   0,        1 }
 123 };
 124
 125 /** @brief Number of columns in queue and recnetly played list */
 126 #define NMAINCOLUMNS (int)(sizeof maincolumns / sizeof *maincolumns)
 127
 128 /** @brief Table of columns for recently added tracks */
 129 static const struct column addedcolumns[] = {
 130   { "Artist", column_namepart, "artist", 0 },
 131   { "Album",  column_namepart, "album",  0 },
 132   { "Title",  column_namepart, "title",  0 },
 133   { "Length", column_length,   0,        1 }
 134 };
 135
 136 /** @brief Number of columns in recently added list */
 137 #define NADDEDCOLUMNS (int)(sizeof addedcolumns / sizeof *addedcolumns)
 138
 139 /** @brief Maximum number of column in any @ref queuelike */
 140 #define MAXCOLUMNS (NMAINCOLUMNS > NADDEDCOLUMNS ? NMAINCOLUMNS : NADDEDCOLUMNS)
 141
 142 /** @brief Data passed to menu item activation handlers */
 143 struct menuiteminfo {
 144   struct queuelike *ql;                 /**< @brief which queue we're dealing with */
 145   struct queue_entry *q;                /**< @brief hovered entry or 0 */
 146 };
 147
 148 /** @brief An item in the queue's popup menu */
 149 struct queue_menuitem {
 150   /** @brief Menu item name */
 151   const char *name;
 152
 153   /** @brief Called to activate the menu item
 154    *
 155    * The user data is the queue entry that the pointer was over when the menu
 156    * popped up. */
 157   void (*activate)(GtkMenuItem *menuitem,
 158                    gpointer user_data);
 159
 160   /** @brief Called to determine whether the menu item is usable.
 161    *
 162    * Returns @c TRUE if it should be sensitive and @c FALSE otherwise.  @p q
 163    * points to the queue entry the pointer is over.
 164    */
 165   int (*sensitive)(struct queuelike *ql,
 166                    struct queue_menuitem *m,
 167                    struct queue_entry *q);
 168
 169   /** @brief Signal handler ID */
 170   gulong handlerid;
 171
 172   /** @brief Widget for menu item */
 173   GtkWidget *w;
 174 };
 175
 176 /** @brief A queue-like object
 177  *
 178  * There are (currently) three of these: @ref ql_queue, @ref ql_recent and @ref
 179  * ql_added.
 180  */
 181 struct queuelike {
 182   /** @brief Called when an update completes */
 183   void (*notify)(void);
 184
 185   /** @brief Called to fix up the queue after update
 186    * @param q The list passed back from the server
 187    * @return Assigned to @c ql->q
 188    */
 189   struct queue_entry *(*fixup)(struct queue_entry *q);
 190
 191   /* Widgets */
 192   GtkWidget *mainlayout;                /**< @brief main layout */
 193   GtkWidget *mainscroll;                /**< @brief scroller for main layout */
 194   GtkWidget *titlelayout;               /**< @brief title layout */
 195   GtkWidget *titlecells[MAXCOLUMNS + 1]; /**< @brief title cells */
 196   GtkWidget **cells;                    /**< @brief all the cells */
 197   GtkWidget *menu;                      /**< @brief popup menu */
 198   struct queue_menuitem *menuitems;     /**< @brief menu items */
 199   GtkWidget *dragmark;                  /**< @brief drag destination marker */
 200   GtkWidget **dropzones;                /**< @brief drag targets */
 201   int ndropzones;                       /**< @brief number of drag targets */
 202
 203   /* State */
 204   struct queue_entry *q;                /**< @brief head of queue */
 205   struct queue_entry *last_click;       /**< @brief last click */
 206   int nrows;                            /**< @brief number of rows */
 207   int mainrowheight;                    /**< @brief height of one row */
 208   hash *selection;                      /**< @brief currently selected items */
 209   int swallow_release;                  /**< @brief swallow button release from drag */
 210
 211   const struct column *columns;         /**< @brief Table of columns */
 212   int ncolumns;                         /**< @brief Number of columns */
 213 };
 214
 215 static struct queuelike ql_queue; /**< @brief The main queue */
 216 static struct queuelike ql_recent; /*< @brief Recently-played tracks */
 217 static struct queuelike ql_added; /*< @brief Newly added tracks */
 218 static struct queue_entry *actual_queue; /**< @brief actual queue */
 219 static struct queue_entry *playing_track;     /**< @brief currenty playing */
 220 static time_t last_playing = (time_t)-1; /**< @brief when last got playing */
 221 static int namepart_lookups_outstanding;
 222 static int  namepart_completions_deferred; /* # of completions not processed */
 223 static const struct cache_type cachetype_string = { 3600 };
 224 static const struct cache_type cachetype_integer = { 3600 };
 225 static GtkWidget *playing_length_label;
 226
 227 /* Debugging --------------------------------------------------------------- */
 228
 229 #if 0
 230 static void describe_widget(const char *name, GtkWidget *w, int indent) {
 231   int ww, wh, wx, wy;
 232
 233   if(name)
 234     fprintf(stderr, "%*s[%s]: '%s'\n", indent, "",
 235             name, gtk_widget_get_name(w));
 236   gdk_window_get_position(w->window, &wx, &wy);
 237   gdk_drawable_get_size(GDK_DRAWABLE(w->window), &ww, &wh);
 238   fprintf(stderr, "%*s window %p: %dx%d at %dx%d\n",
 239           indent, "", w->window, ww, wh, wx, wy);
 240 }
 241
 242 static void dump_layout(const struct queuelike *ql) {
 243   GtkWidget *w;
 244   char s[20];
 245   int row, col;
 246   const struct queue_entry *q;
 247
 248   describe_widget("mainscroll", ql->mainscroll, 0);
 249   describe_widget("mainlayout", ql->mainlayout, 1);
 250   for(q = ql->q, row = 0; q; q = q->next, ++row)
 251     for(col = 0; col < ql->ncolumns + 1; ++col)
 252       if((w = ql->cells[row * (ql->ncolumns + 1) + col])) {
 253         sprintf(s, "%dx%d", row, col);
 254         describe_widget(s, w, 2);
 255         if(GTK_BIN(w)->child)
 256           describe_widget(0, w, 3);
 257       }
 258 }
 259 #endif
 260
 261 /* Track detail lookup ----------------------------------------------------- */
 262
 263 /** @brief Called when a namepart lookup has completed or failed */
 264 static void namepart_completed_or_failed(void) {
 265   D(("namepart_completed_or_failed"));
 266   --namepart_lookups_outstanding;
 267   if(!namepart_lookups_outstanding) {
 268     redisplay_queue(&ql_queue);
 269     redisplay_queue(&ql_recent);
 270     redisplay_queue(&ql_added);
 271     namepart_completions_deferred = 0;
 272   }
 273 }
 274
 275 /** @brief Called when a namepart lookup has completed */
 276 static void namepart_completed(void *v, const char *error, const char *value) {
 277   if(error) {
 278     gtk_label_set_text(GTK_LABEL(report_label), error);
 279   } else {
 280     const char *key = v;
 281
 282     cache_put(&cachetype_string, key, value);
 283     ++namepart_completions_deferred;
 284   }
 285   namepart_completed_or_failed();
 286 }
 287
 288 /** @brief Called when a length lookup has completed */
 289 static void length_completed(void *v, const char *error, long l) {
 290   if(error)
 291     gtk_label_set_text(GTK_LABEL(report_label), error);
 292   else {
 293     const char *key = v;
 294     long *value;
 295
 296     D(("namepart_completed"));
 297     value = xmalloc(sizeof *value);
 298     *value = l;
 299     cache_put(&cachetype_integer, key, value);
 300     ++namepart_completions_deferred;
 301   }
 302   namepart_completed_or_failed();
 303 }
 304
 305 /** @brief Arrange to fill in a namepart cache entry */
 306 static void namepart_fill(const char *track,
 307                           const char *context,
 308                           const char *part,
 309                           const char *key) {
 310   ++namepart_lookups_outstanding;
 311   disorder_eclient_namepart(client, namepart_completed,
 312                             track, context, part, (void *)key);
 313 }
 314
 315 /** @brief Look up a namepart
 316  *
 317  * If it is in the cache then just return its value.  If not then look it up
 318  * and arrange for the queues to be updated when its value is available. */
 319 static const char *namepart(const char *track,
 320                             const char *context,
 321                             const char *part) {
 322   char *key;
 323   const char *value;
 324
 325   D(("namepart %s %s %s", track, context, part));
 326   byte_xasprintf(&key, "namepart context=%s part=%s track=%s",
 327                  context, part, track);
 328   value = cache_get(&cachetype_string, key);
 329   if(!value) {
 330     D(("deferring..."));
 331     /* stick a value in the cache so we don't issue another lookup if we
 332      * revisit */
 333     cache_put(&cachetype_string, key, value = "?");
 334     namepart_fill(track, context, part, key);
 335   }
 336   return value;
 337 }
 338
 339 /** @brief Called from @ref disobedience/properties.c when we know a name part has changed */
 340 void namepart_update(const char *track,
 341                      const char *context,
 342                      const char *part) {
 343   char *key;
 344
 345   byte_xasprintf(&key, "namepart context=%s part=%s track=%s",
 346                  context, part, track);
 347   /* Only refetch if it's actually in the cache */
 348   if(cache_get(&cachetype_string, key))
 349     namepart_fill(track, context, part, key);
 350 }
 351
 352 /** @brief Look up a track length
 353  *
 354  * If it is in the cache then just return its value.  If not then look it up
 355  * and arrange for the queues to be updated when its value is available. */
 356 static long getlength(const char *track) {
 357   char *key;
 358   const long *value;
 359   static const long bogus = -1;
 360
 361   D(("getlength %s", track));
 362   byte_xasprintf(&key, "length track=%s", track);
 363   value = cache_get(&cachetype_integer, key);
 364   if(!value) {
 365     D(("deferring..."));;
 366     cache_put(&cachetype_integer, key, value = &bogus);
 367     ++namepart_lookups_outstanding;
 368     disorder_eclient_length(client, length_completed, track, key);
 369   }
 370   return *value;
 371 }
 372
 373 /* Column constructors ----------------------------------------------------- */
 374
 375 /** @brief Format the 'when' column */
 376 static GtkWidget *column_when(const struct queuelike attribute((unused)) *ql,
 377                               const struct queue_entry *q,
 378                               const char attribute((unused)) *data) {
 379   char when[64];
 380   struct tm tm;
 381   time_t t;
 382
 383   D(("column_when"));
 384   switch(q->state) {
 385   case playing_isscratch:
 386   case playing_unplayed:
 387   case playing_random:
 388     t = q->expected;
 389     break;
 390   case playing_failed:
 391   case playing_no_player:
 392   case playing_ok:
 393   case playing_scratched:
 394   case playing_started:
 395   case playing_paused:
 396   case playing_quitting:
 397     t = q->played;
 398     break;
 399   default:
 400     t = 0;
 401     break;
 402   }
 403   if(t)
 404     strftime(when, sizeof when, "%H:%M", localtime_r(&t, &tm));
 405   else
 406     when[0] = 0;
 407   NW(label);
 408   return gtk_label_new(when);
 409 }
 410
 411 /** @brief Format the 'who' column */
 412 static GtkWidget *column_who(const struct queuelike attribute((unused)) *ql,
 413                              const struct queue_entry *q,
 414                              const char attribute((unused)) *data) {
 415   D(("column_who"));
 416   NW(label);
 417   return gtk_label_new(q->submitter ? q->submitter : "");
 418 }
 419
 420 /** @brief Format one of the track name columns */
 421 static GtkWidget *column_namepart(const struct queuelike
 422                                                attribute((unused)) *ql,
 423                                   const struct queue_entry *q,
 424                                   const char *data) {
 425   D(("column_namepart"));
 426   NW(label);
 427   return gtk_label_new(truncate_for_display(namepart(q->track, "display", data),
 428                                             config->short_display));
 429 }
 430
 431 /** @brief Compute the length field */
 432 static const char *text_length(const struct queue_entry *q) {
 433   long l;
 434   time_t now;
 435   char *played = 0, *length = 0;
 436
 437   /* Work out what to say for the length */
 438   l = getlength(q->track);
 439   if(l > 0)
 440     byte_xasprintf(&length, "%ld:%02ld", l / 60, l % 60);
 441   else
 442     byte_xasprintf(&length, "?:??");
 443   /* For the currently playing track we want to report how much of the track
 444    * has been played */
 445   if(q == playing_track) {
 446     /* log_state() arranges that we re-get the playing data whenever the
 447      * pause/resume state changes */
 448     if(last_state & DISORDER_TRACK_PAUSED)
 449       l = playing_track->sofar;
 450     else {
 451       time(&now);
 452       l = playing_track->sofar + (now - last_playing);
 453     }
 454     byte_xasprintf(&played, "%ld:%02ld/%s", l / 60, l % 60, length);
 455     return played;
 456   } else
 457     return length;
 458 }
 459
 460 /** @brief Format the length column */
 461 static GtkWidget *column_length(const struct queuelike attribute((unused)) *ql,
 462                                 const struct queue_entry *q,
 463                                 const char attribute((unused)) *data) {
 464   D(("column_length"));
 465   if(q == playing_track) {
 466     assert(!playing_length_label);
 467     NW(label);
 468     playing_length_label = gtk_label_new(text_length(q));
 469     /* Zot playing_length_label when it is destroyed */
 470     g_signal_connect(playing_length_label, "destroy",
 471                      G_CALLBACK(gtk_widget_destroyed), &playing_length_label);
 472     return playing_length_label;
 473   } else {
 474     NW(label);
 475     return gtk_label_new(text_length(q));
 476   }
 477
 478 }
 479
 480 /** @brief Apply a new queue contents, transferring the selection from the old value */
 481 static void update_queue(struct queuelike *ql, struct queue_entry *newq) {
 482   struct queue_entry *q;
 483
 484   D(("update_queue"));
 485   /* Propagate last_click across the change */
 486   if(ql->last_click) {
 487     for(q = newq; q; q = q->next) {
 488       if(!strcmp(q->id, ql->last_click->id))
 489         break;
 490       ql->last_click = q;
 491     }
 492   }
 493   /* Tell every queue entry which queue owns it */
 494   for(q = newq; q; q = q->next)
 495     q->ql = ql;
 496   /* Switch to the new queue */
 497   ql->q = newq;
 498   /* Clean up any selected items that have fallen off */
 499   for(q = ql->q; q; q = q->next)
 500     selection_live(ql->selection, q->id);
 501   selection_cleanup(ql->selection);
 502 }
 503
 504 /** @brief Wrap up a widget for putting into the queue or title
 505  * @param label Label to contain
 506  * @param style Pointer to style to use
 507  * @param wp Updated with maximum width (or NULL)
 508  * @return New widget
 509  */
 510 static GtkWidget *wrap_queue_cell(GtkWidget *label,
 511                                   GtkStyle *style,
 512                                   int *wp) {
 513   GtkRequisition req;
 514   GtkWidget *bg;
 515
 516   D(("wrap_queue_cell"));
 517   /* Padding should be in the label so there are no gaps in the
 518    * background */
 519   gtk_misc_set_padding(GTK_MISC(label), HCELLPADDING, VCELLPADDING);
 520   /* Event box is just to hold a background color */
 521   NW(event_box);
 522   bg = gtk_event_box_new();
 523   gtk_container_add(GTK_CONTAINER(bg), label);
 524   if(wp) {
 525     /* Update maximum width */
 526     gtk_widget_size_request(label, &req);
 527     if(req.width > *wp) *wp = req.width;
 528   }
 529   /* Set colors */
 530   gtk_widget_set_style(bg, style);
 531   gtk_widget_set_style(label, style);
 532   return bg;
 533 }
 534
 535 /** @brief Create the wrapped widget for a cell in the queue display */
 536 static GtkWidget *get_queue_cell(struct queuelike *ql,
 537                                  const struct queue_entry *q,
 538                                  int row,
 539                                  int col,
 540                                  GtkStyle *style,
 541                                  int *wp) {
 542   GtkWidget *label;
 543   D(("get_queue_cell %d %d", row, col));
 544   label = ql->columns[col].widget(ql, q, ql->columns[col].data);
 545   gtk_misc_set_alignment(GTK_MISC(label), ql->columns[col].xalign, 0);
 546   return wrap_queue_cell(label, style, wp);
 547 }
 548
 549 /** @brief Add a padding cell to the end of a row */
 550 static GtkWidget *get_padding_cell(GtkStyle *style) {
 551   D(("get_padding_cell"));
 552   NW(label);
 553   return wrap_queue_cell(gtk_label_new(""), style, 0);
 554 }
 555
 556 /* User button press and menu ---------------------------------------------- */
 557
 558 /** @brief Update widget states in order to reflect the selection status */
 559 static void set_widget_states(struct queuelike *ql) {
 560   struct queue_entry *q;
 561   int row, col;
 562
 563   for(q = ql->q, row = 0; q; q = q->next, ++row) {
 564     for(col = 0; col < ql->ncolumns + 1; ++col)
 565       gtk_widget_set_state(ql->cells[row * (ql->ncolumns + 1) + col],
 566                            selection_selected(ql->selection, q->id) ?
 567                            GTK_STATE_SELECTED : GTK_STATE_NORMAL);
 568   }
 569   /* Might need to change sensitivity of 'Properties' in main menu */
 570   menu_update(-1);
 571 }
 572
 573 /** @brief Ordering function for queue entries */
 574 static int queue_before(const struct queue_entry *a,
 575                         const struct queue_entry *b) {
 576   while(a && a != b)
 577     a = a->next;
 578   return !!a;
 579 }
 580
 581 /** @brief A button was pressed and released */
 582 static gboolean queuelike_button_released(GtkWidget attribute((unused)) *widget,
 583                                           GdkEventButton *event,
 584                                           gpointer user_data) {
 585   struct queue_entry *q = user_data, *qq;
 586   struct queuelike *ql = q->ql;
 587   struct menuiteminfo *mii;
 588   int n;
 589
 590   /* Might be a release left over from a drag */
 591   if(ql->swallow_release) {
 592     ql->swallow_release = 0;
 593     return FALSE;                       /* propagate */
 594   }
 595
 596   if(event->type == GDK_BUTTON_PRESS
 597      && event->button == 3) {
 598     /* Right button click.
 599      * If the current item is not selected then switch the selection to just
 600      * this item */
 601     if(q && !selection_selected(ql->selection, q->id)) {
 602       selection_empty(ql->selection);
 603       selection_set(ql->selection, q->id, 1);
 604       ql->last_click = q;
 605       set_widget_states(ql);
 606     }
 607     /* Set the sensitivity of each menu item and (re-)establish the signal
 608      * handlers */
 609     for(n = 0; ql->menuitems[n].name; ++n) {
 610       if(ql->menuitems[n].handlerid)
 611         g_signal_handler_disconnect(ql->menuitems[n].w,
 612                                     ql->menuitems[n].handlerid);
 613       gtk_widget_set_sensitive(ql->menuitems[n].w,
 614                                ql->menuitems[n].sensitive(ql,
 615                                                           &ql->menuitems[n],
 616                                                           q));
 617       mii = xmalloc(sizeof *mii);
 618       mii->ql = ql;
 619       mii->q = q;
 620       ql->menuitems[n].handlerid = g_signal_connect
 621         (ql->menuitems[n].w, "activate",
 622          G_CALLBACK(ql->menuitems[n].activate), mii);
 623     }
 624     /* Update the menu according to context */
 625     gtk_widget_show_all(ql->menu);
 626     gtk_menu_popup(GTK_MENU(ql->menu), 0, 0, 0, 0,
 627                    event->button, event->time);
 628     return TRUE;                        /* hide the click from other widgets */
 629   }
 630   if(event->type == GDK_BUTTON_RELEASE
 631      && event->button == 1) {
 632     /* no modifiers: select this, unselect everything else, set last click
 633      * +ctrl: flip selection of this, set last click
 634      * +shift: select from last click to here, don't set last click
 635      * +ctrl+shift: select from last click to here, set last click
 636      */
 637     switch(event->state & (GDK_SHIFT_MASK|GDK_CONTROL_MASK)) {
 638     case 0:
 639       selection_empty(ql->selection);
 640       selection_set(ql->selection, q->id, 1);
 641       ql->last_click = q;
 642       break;
 643     case GDK_CONTROL_MASK:
 644       selection_flip(ql->selection, q->id);
 645       ql->last_click = q;
 646       break;
 647     case GDK_SHIFT_MASK:
 648     case GDK_SHIFT_MASK|GDK_CONTROL_MASK:
 649       if(ql->last_click) {
 650         if(!(event->state & GDK_CONTROL_MASK))
 651           selection_empty(ql->selection);
 652         selection_set(ql->selection, q->id, 1);
 653         qq = q;
 654         if(queue_before(ql->last_click, q))
 655           while(qq != ql->last_click) {
 656             qq = qq->prev;
 657             selection_set(ql->selection, qq->id, 1);
 658           }
 659         else
 660           while(qq != ql->last_click) {
 661             qq = qq->next;
 662             selection_set(ql->selection, qq->id, 1);
 663           }
 664         if(event->state & GDK_CONTROL_MASK)
 665           ql->last_click = q;
 666       }
 667       break;
 668     }
 669     set_widget_states(ql);
 670     gtk_widget_queue_draw(ql->mainlayout);
 671   }
 672   return FALSE;                         /* propagate */
 673 }
 674
 675 /** @brief A button was pressed or released on the mainlayout
 676  *
 677  * For debugging only at the moment. */
 678 static gboolean mainlayout_button(GtkWidget attribute((unused)) *widget,
 679                                   GdkEventButton attribute((unused)) *event,
 680                                   gpointer attribute((unused)) user_data) {
 681   return FALSE;                         /* propagate */
 682 }
 683
 684 /** @brief Select all entries in a queue */
 685 void queue_select_all(struct queuelike *ql) {
 686   struct queue_entry *qq;
 687
 688   for(qq = ql->q; qq; qq = qq->next)
 689     selection_set(ql->selection, qq->id, 1);
 690   ql->last_click = 0;
 691   set_widget_states(ql);
 692 }
 693
 694 /** @brief Deselect all entries in a queue */
 695 void queue_select_none(struct queuelike *ql) {
 696   struct queue_entry *qq;
 697
 698   for(qq = ql->q; qq; qq = qq->next)
 699     selection_set(ql->selection, qq->id, 0);
 700   ql->last_click = 0;
 701   set_widget_states(ql);
 702 }
 703
 704 /** @brief Pop up properties for selected tracks */
 705 void queue_properties(struct queuelike *ql) {
 706   struct vector v;
 707   const struct queue_entry *qq;
 708
 709   vector_init(&v);
 710   for(qq = ql->q; qq; qq = qq->next)
 711     if(selection_selected(ql->selection, qq->id))
 712       vector_append(&v, (char *)qq->track);
 713   if(v.nvec)
 714     properties(v.nvec, (const char **)v.vec);
 715 }
 716
 717 /* Drag and drop rearrangement --------------------------------------------- */
 718
 719 /** @brief Return nonzero if @p is a draggable row
 720  *
 721  * Only tracks in the main queue are draggable (and the currently playing track
 722  * is not draggable).
 723  */
 724 static int draggable_row(const struct queue_entry *q) {
 725   return q->ql == &ql_queue && q != playing_track;
 726 }
 727
 728 /** @brief Called when a drag begings */
 729 static void queue_drag_begin(GtkWidget attribute((unused)) *widget,
 730                              GdkDragContext attribute((unused)) *dc,
 731                              gpointer data) {
 732   struct queue_entry *q = data;
 733   struct queuelike *ql = q->ql;
 734
 735   /* Make sure the playing track is not selected, since it cannot be dragged */
 736   if(playing_track)
 737     selection_set(ql->selection, playing_track->id, 0);
 738   /* If the dragged item is not in the selection then change the selection to
 739    * just that */
 740   if(!selection_selected(ql->selection, q->id)) {
 741     selection_empty(ql->selection);
 742     selection_set(ql->selection, q->id, 1);
 743     set_widget_states(ql);
 744   }
 745   /* Ignore the eventual button release */
 746   ql->swallow_release = 1;
 747   /* Create dropzones */
 748   add_drag_targets(ql);
 749 }
 750
 751 /** @brief Convert @p id back into a queue entry and a screen row number */
 752 static struct queue_entry *findentry(struct queuelike *ql,
 753                                      const char *id,
 754                                      int *rowp) {
 755   int row;
 756   struct queue_entry *q;
 757
 758   if(id) {
 759     for(q = ql->q, row = 0; q && strcmp(q->id, id); q = q->next, ++row)
 760       ;
 761   } else {
 762     q = 0;
 763     row = playing_track ? 0 : -1;
 764   }
 765   if(rowp) *rowp = row;
 766   return q;
 767 }
 768
 769 static void move_completed(void attribute((unused)) *v,
 770                            const char *error) {
 771   if(error)
 772     popup_protocol_error(0, error);
 773 }
 774
 775 /** @brief Called when data is dropped */
 776 static gboolean queue_drag_drop(GtkWidget attribute((unused)) *widget,
 777                                 GdkDragContext *drag_context,
 778                                 gint attribute((unused)) x,
 779                                 gint attribute((unused)) y,
 780                                 guint when,
 781                                 gpointer user_data) {
 782   struct queuelike *ql = &ql_queue;
 783   const char *id = user_data;
 784   struct vector vec;
 785   struct queue_entry *q;
 786
 787   if(!id || (playing_track && !strcmp(id, playing_track->id)))
 788     id = "";
 789   vector_init(&vec);
 790   for(q = ql->q; q; q = q->next)
 791     if(q != playing_track && selection_selected(ql->selection, q->id))
 792       vector_append(&vec, (char *)q->id);
 793   disorder_eclient_moveafter(client, id, vec.nvec, (const char **)vec.vec,
 794                              move_completed, 0/*v*/);
 795   gtk_drag_finish(drag_context, TRUE, TRUE, when);
 796   /* Destroy dropzones */
 797   remove_drag_targets(ql);
 798   return TRUE;
 799 }
 800
 801 /** @brief Called when we enter, or move within, a drop zone */
 802 static gboolean queue_drag_motion(GtkWidget attribute((unused)) *widget,
 803                                   GdkDragContext *drag_context,
 804                                   gint attribute((unused)) x,
 805                                   gint attribute((unused)) y,
 806                                   guint when,
 807                                   gpointer user_data) {
 808   struct queuelike *ql = &ql_queue;
 809   const char *id = user_data;
 810   int row;
 811   struct queue_entry *q = findentry(ql, id, &row);
 812
 813   if(!id || q) {
 814     if(!ql->dragmark) {
 815       NW(event_box);
 816       ql->dragmark = gtk_event_box_new();
 817       g_signal_connect(ql->dragmark, "destroy",
 818                        G_CALLBACK(gtk_widget_destroyed), &ql->dragmark);
 819       gtk_widget_set_size_request(ql->dragmark, 10240, row ? 4 : 2);
 820       gtk_widget_set_style(ql->dragmark, drag_style);
 821       gtk_layout_put(GTK_LAYOUT(ql->mainlayout), ql->dragmark, 0,
 822                      (row + 1) * ql->mainrowheight - !!row);
 823     } else
 824       gtk_layout_move(GTK_LAYOUT(ql->mainlayout), ql->dragmark, 0,
 825                       (row + 1) * ql->mainrowheight - !!row);
 826     gtk_widget_show(ql->dragmark);
 827     gdk_drag_status(drag_context, GDK_ACTION_MOVE, when);
 828     return TRUE;
 829   } else
 830     /* ID has gone AWOL */
 831     return FALSE;
 832 }
 833
 834 /** @brief Called when we leave a drop zone */
 835 static void queue_drag_leave(GtkWidget attribute((unused)) *widget,
 836                              GdkDragContext attribute((unused)) *drag_context,
 837                              guint attribute((unused)) when,
 838                              gpointer attribute((unused)) user_data) {
 839   struct queuelike *ql = &ql_queue;
 840
 841   if(ql->dragmark)
 842     gtk_widget_hide(ql->dragmark);
 843 }
 844
 845 /** @brief Add a drag target
 846  * @param ql The queue-like (in practice this is always @ref ql_queue)
 847  * @param y The Y coordinate to place the drag target
 848  * @param id Track to insert moved tracks after, or NULL
 849  *
 850  * Adds a drop zone at Y coordinate @p y, which is assumed to lie between two
 851  * tracks (or before the start of the queue or after the end of the queue).  If
 852  * tracks are dragged into this dropzone then they will be moved @em after
 853  * track @p id, or to the start of the queue if @p id is NULL.
 854  *
 855  * We remember all the dropzones in @c ql->dropzones so they can be destroyed
 856  * later.
 857  */
 858 static void add_drag_target(struct queuelike *ql, int y,
 859                             const char *id) {
 860   GtkWidget *eventbox;
 861
 862   NW(event_box);
 863   eventbox = gtk_event_box_new();
 864   /* Make the target zone invisible */
 865   gtk_event_box_set_visible_window(GTK_EVENT_BOX(eventbox), FALSE);
 866   /* Make it large enough */
 867   gtk_widget_set_size_request(eventbox, 10240,
 868                               y ? ql->mainrowheight : ql->mainrowheight / 2);
 869   /* Position it */
 870   gtk_layout_put(GTK_LAYOUT(ql->mainlayout), eventbox, 0,
 871                  y ? y - ql->mainrowheight / 2 : 0);
 872   /* Mark it as capable of receiving drops */
 873   gtk_drag_dest_set(eventbox,
 874                     0,
 875                     dragtargets, NDRAGTARGETS, GDK_ACTION_MOVE);
 876   g_signal_connect(eventbox, "drag-drop",
 877                    G_CALLBACK(queue_drag_drop), (char *)id);
 878   /* Monitor drag motion */
 879   g_signal_connect(eventbox, "drag-motion",
 880                    G_CALLBACK(queue_drag_motion), (char *)id);
 881   g_signal_connect(eventbox, "drag-leave",
 882                    G_CALLBACK(queue_drag_leave), (char *)id);
 883   /* The widget needs to be shown to receive drags */
 884   gtk_widget_show(eventbox);
 885   /* Remember the drag targets */
 886   ql->dropzones[ql->ndropzones] = eventbox;
 887   g_signal_connect(eventbox, "destroy",
 888                    G_CALLBACK(gtk_widget_destroyed),
 889                    &ql->dropzones[ql->ndropzones]);
 890   ++ql->ndropzones;
 891 }
 892
 893 /** @brief Create dropzones for dragging into */
 894 static void add_drag_targets(struct queuelike *ql) {
 895   int y;
 896   struct queue_entry *q;
 897
 898   /* Create an array to store the widgets */
 899   ql->dropzones = xcalloc(ql->nrows, sizeof (GtkWidget *));
 900   ql->ndropzones = 0;
 901   y = 0;
 902   /* Add a drag target before the first row provided it's not the playing
 903    * track */
 904   if(!playing_track || ql->q != playing_track)
 905     add_drag_target(ql, 0, 0);
 906   /* Put a drag target at the bottom of every row */
 907   for(q = ql->q; q; q = q->next) {
 908     y += ql->mainrowheight;
 909     add_drag_target(ql, y, q->id);
 910   }
 911 }
 912
 913 /** @brief Remove the dropzones */
 914 static void remove_drag_targets(struct queuelike *ql) {
 915   int n;
 916
 917   for(n = 0; n < ql->ndropzones; ++n) {
 918     if(ql->dropzones[n]) {
 919       DW(event_box);
 920       gtk_widget_destroy(ql->dropzones[n]);
 921     }
 922     assert(ql->dropzones[n] == 0);
 923   }
 924 }
 925
 926 /* Layout ------------------------------------------------------------------ */
 927
 928 /** @brief Redisplay a queue */
 929 static void redisplay_queue(struct queuelike *ql) {
 930   struct queue_entry *q;
 931   int row, col;
 932   GList *c, *children;
 933   GtkStyle *style;
 934   GtkRequisition req;
 935   GtkWidget *w;
 936   int maxwidths[MAXCOLUMNS], x, y, titlerowheight;
 937   int totalwidth = 10240;               /* TODO: can we be less blunt */
 938
 939   D(("redisplay_queue"));
 940   /* Eliminate all the existing widgets and start from scratch */
 941   for(c = children = gtk_container_get_children(GTK_CONTAINER(ql->mainlayout));
 942       c;
 943       c = c->next) {
 944     /* Destroy both the label and the eventbox */
 945     if(GTK_BIN(c->data)->child) {
 946       DW(label);
 947       gtk_widget_destroy(GTK_BIN(c->data)->child);
 948     }
 949     DW(event_box);
 950     gtk_widget_destroy(GTK_WIDGET(c->data));
 951   }
 952   g_list_free(children);
 953   /* Adjust the row count */
 954   for(q = ql->q, ql->nrows = 0; q; q = q->next)
 955     ++ql->nrows;
 956   /* We need to create all the widgets before we can position them */
 957   ql->cells = xcalloc(ql->nrows * (ql->ncolumns + 1), sizeof *ql->cells);
 958   /* Minimum width is given by the column headings */
 959   for(col = 0; col < ql->ncolumns; ++col) {
 960     /* Reset size so we don't inherit last iteration's maximum size */
 961     gtk_widget_set_size_request(GTK_BIN(ql->titlecells[col])->child, -1, -1);
 962     gtk_widget_size_request(GTK_BIN(ql->titlecells[col])->child, &req);
 963     maxwidths[col] = req.width;
 964   }
 965   /* Find the vertical size of the title bar */
 966   gtk_widget_size_request(GTK_BIN(ql->titlecells[0])->child, &req);
 967   titlerowheight = req.height;
 968   y = 0;
 969   if(ql->nrows) {
 970     /* Construct the widgets */
 971     for(q = ql->q, row = 0; q; q = q->next, ++row) {
 972       /* Figure out the widget name for this row */
 973       if(q == playing_track) style = active_style;
 974       else style = row % 2 ? even_style : odd_style;
 975       /* Make the widget for each column */
 976       for(col = 0; col <= ql->ncolumns; ++col) {
 977         /* Create and store the widget */
 978         if(col < ql->ncolumns)
 979           w = get_queue_cell(ql, q, row, col, style, &maxwidths[col]);
 980         else
 981           w = get_padding_cell(style);
 982         ql->cells[row * (ql->ncolumns + 1) + col] = w;
 983         /* Maybe mark it draggable */
 984         if(draggable_row(q)) {
 985           gtk_drag_source_set(w, GDK_BUTTON1_MASK,
 986                               dragtargets, NDRAGTARGETS, GDK_ACTION_MOVE);
 987           g_signal_connect(w, "drag-begin", G_CALLBACK(queue_drag_begin), q);
 988         }
 989         /* Catch button presses */
 990         g_signal_connect(w, "button-release-event",
 991                          G_CALLBACK(queuelike_button_released), q);
 992         g_signal_connect(w, "button-press-event",
 993                          G_CALLBACK(queuelike_button_released), q);
 994       }
 995     }
 996     /* ...and of each row in the main layout */
 997     gtk_widget_size_request(GTK_BIN(ql->cells[0])->child, &req);
 998     ql->mainrowheight = req.height;
 999     /* Now we know the maximum width of each column we can set the size of
1000      * everything and position it */
1001     for(row = 0, q = ql->q; row < ql->nrows; ++row, q = q->next) {
1002       x = 0;
1003       for(col = 0; col < ql->ncolumns; ++col) {
1004         w = ql->cells[row * (ql->ncolumns + 1) + col];
1005         gtk_widget_set_size_request(GTK_BIN(w)->child,
1006                                     maxwidths[col], -1);
1007         gtk_layout_put(GTK_LAYOUT(ql->mainlayout), w, x, y);
1008         x += maxwidths[col];
1009       }
1010       w = ql->cells[row * (ql->ncolumns + 1) + col];
1011       gtk_widget_set_size_request(GTK_BIN(w)->child,
1012                                   totalwidth - x, -1);
1013       gtk_layout_put(GTK_LAYOUT(ql->mainlayout), w, x, y);
1014       y += ql->mainrowheight;
1015     }
1016   }
1017   /* Titles */
1018   x = 0;
1019   for(col = 0; col < ql->ncolumns; ++col) {
1020     gtk_widget_set_size_request(GTK_BIN(ql->titlecells[col])->child,
1021                                 maxwidths[col], -1);
1022     gtk_layout_move(GTK_LAYOUT(ql->titlelayout), ql->titlecells[col], x, 0);
1023     x += maxwidths[col];
1024   }
1025   gtk_widget_set_size_request(GTK_BIN(ql->titlecells[col])->child,
1026                               totalwidth - x, -1);
1027   gtk_layout_move(GTK_LAYOUT(ql->titlelayout), ql->titlecells[col], x, 0);
1028   /* Set the states */
1029   set_widget_states(ql);
1030   /* Make sure it's all visible */
1031   gtk_widget_show_all(ql->mainlayout);
1032   gtk_widget_show_all(ql->titlelayout);
1033   /* Layouts might shrink to arrange for the area they shrink out of to be
1034    * redrawn */
1035   gtk_widget_queue_draw(ql->mainlayout);
1036   gtk_widget_queue_draw(ql->titlelayout);
1037   /* Adjust the size of the layout */
1038   gtk_layout_set_size(GTK_LAYOUT(ql->mainlayout), x, y);
1039   gtk_layout_set_size(GTK_LAYOUT(ql->titlelayout), x, titlerowheight);
1040   gtk_widget_set_size_request(ql->titlelayout, -1, titlerowheight);
1041 }
1042
1043 /** @brief Called with new queue/recent contents */
1044 static void queuelike_completed(void *v, struct queue_entry *q) {
1045   struct callbackdata *cbd = v;
1046   struct queuelike *ql = cbd->u.ql;
1047
1048   D(("queuelike_complete"));
1049   /* Install the new queue */
1050   update_queue(ql, ql->fixup ? ql->fixup(q) : q);
1051   /* Update the display */
1052   redisplay_queue(ql);
1053   if(ql->notify)
1054     ql->notify();
1055   /* Update sensitivity of main menu items */
1056   menu_update(-1);
1057 }
1058
1059 /** @brief Called with a new currently playing track */
1060 static void playing_completed(void attribute((unused)) *v,
1061                               struct queue_entry *q) {
1062   struct callbackdata cbd;
1063   D(("playing_completed"));
1064   playing_track = q;
1065   /* Record when we got the playing track data so we know how old the 'sofar'
1066    * field is */
1067   time(&last_playing);
1068   cbd.u.ql = &ql_queue;
1069   queuelike_completed(&cbd, actual_queue);
1070 }
1071
1072 /** @brief Called when the queue is scrolled */
1073 static void queue_scrolled(GtkAdjustment *adjustment,
1074                            gpointer user_data) {
1075   GtkAdjustment *titleadj = user_data;
1076
1077   D(("queue_scrolled"));
1078   gtk_adjustment_set_value(titleadj, adjustment->value);
1079 }
1080
1081 /** @brief Create a queuelike thing (queue/recent) */
1082 static GtkWidget *queuelike(struct queuelike *ql,
1083                             struct queue_entry *(*fixup)(struct queue_entry *),
1084                             void (*notify)(void),
1085                             struct queue_menuitem *menuitems,
1086                             const struct column *columns,
1087                             int ncolumns) {
1088   GtkWidget *vbox, *mainscroll, *titlescroll, *label;
1089   GtkAdjustment *mainadj, *titleadj;
1090   int col, n;
1091
1092   D(("queuelike"));
1093   ql->fixup = fixup;
1094   ql->notify = notify;
1095   ql->menuitems = menuitems;
1096   ql->mainrowheight = !0;                /* else division by 0 */
1097   ql->selection = selection_new();
1098   ql->columns = columns;
1099   ql->ncolumns = ncolumns;
1100   /* Create the layouts */
1101   NW(layout);
1102   ql->mainlayout = gtk_layout_new(0, 0);
1103   gtk_widget_set_style(ql->mainlayout, layout_style);
1104   NW(layout);
1105   ql->titlelayout = gtk_layout_new(0, 0);
1106   gtk_widget_set_style(ql->titlelayout, title_style);
1107   /* Scroll the layouts */
1108   ql->mainscroll = mainscroll = scroll_widget(ql->mainlayout);
1109   titlescroll = scroll_widget(ql->titlelayout);
1110   gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(titlescroll),
1111                                  GTK_POLICY_NEVER, GTK_POLICY_NEVER);
1112   mainadj = gtk_scrolled_window_get_hadjustment(GTK_SCROLLED_WINDOW(mainscroll));
1113   titleadj = gtk_scrolled_window_get_hadjustment(GTK_SCROLLED_WINDOW(titlescroll));
1114   g_signal_connect(mainadj, "changed", G_CALLBACK(queue_scrolled), titleadj);
1115   g_signal_connect(mainadj, "value-changed", G_CALLBACK(queue_scrolled), titleadj);
1116   /* Fill the titles and put them anywhere */
1117   for(col = 0; col < ql->ncolumns; ++col) {
1118     NW(label);
1119     label = gtk_label_new(ql->columns[col].name);
1120     gtk_misc_set_alignment(GTK_MISC(label), ql->columns[col].xalign, 0);
1121     ql->titlecells[col] = wrap_queue_cell(label, title_style, 0);
1122     gtk_layout_put(GTK_LAYOUT(ql->titlelayout), ql->titlecells[col], 0, 0);
1123   }
1124   ql->titlecells[col] = get_padding_cell(title_style);
1125   gtk_layout_put(GTK_LAYOUT(ql->titlelayout), ql->titlecells[col], 0, 0);
1126   /* Pack the lot together in a vbox */
1127   NW(vbox);
1128   vbox = gtk_vbox_new(0, 0);
1129   gtk_box_pack_start(GTK_BOX(vbox), titlescroll, 0, 0, 0);
1130   gtk_box_pack_start(GTK_BOX(vbox), mainscroll, 1, 1, 0);
1131   /* Create the popup menu */
1132   NW(menu);
1133   ql->menu = gtk_menu_new();
1134   g_signal_connect(ql->menu, "destroy",
1135                    G_CALLBACK(gtk_widget_destroyed), &ql->menu);
1136   for(n = 0; menuitems[n].name; ++n) {
1137     NW(menu_item);
1138     menuitems[n].w = gtk_menu_item_new_with_label(menuitems[n].name);
1139     gtk_menu_attach(GTK_MENU(ql->menu), menuitems[n].w, 0, 1, n, n + 1);
1140   }
1141   g_object_set_data(G_OBJECT(vbox), "type", (void *)&tabtype_queue);
1142   g_object_set_data(G_OBJECT(vbox), "queue", ql);
1143   /* Catch button presses */
1144   g_signal_connect(ql->mainlayout, "button-release-event",
1145                    G_CALLBACK(mainlayout_button), ql);
1146 #if 0
1147   g_signal_connect(ql->mainlayout, "button-press-event",
1148                    G_CALLBACK(mainlayout_button), ql);
1149 #endif
1150   set_tool_colors(ql->menu);
1151   return vbox;
1152 }
1153
1154 /* Popup menu items -------------------------------------------------------- */
1155
1156 /** @brief Count the number of items selected */
1157 static int queue_count_selected(const struct queuelike *ql) {
1158   return hash_count(ql->selection);
1159 }
1160
1161 /** @brief Count the number of items selected */
1162 static int queue_count_entries(const struct queuelike *ql) {
1163   int nitems = 0;
1164   const struct queue_entry *q;
1165
1166   for(q = ql->q; q; q = q->next)
1167     ++nitems;
1168   return nitems;
1169 }
1170
1171 /** @brief Count the number of items selected, excluding the playing track if
1172  * there is one */
1173 static int count_selected_nonplaying(const struct queuelike *ql) {
1174   int nselected = queue_count_selected(ql);
1175
1176   if(ql->q == playing_track && selection_selected(ql->selection, ql->q->id))
1177     --nselected;
1178   return nselected;
1179 }
1180
1181 /** @brief Determine whether the scratch option should be sensitive */
1182 static int scratch_sensitive(struct queuelike attribute((unused)) *ql,
1183                              struct queue_menuitem attribute((unused)) *m,
1184                              struct queue_entry attribute((unused)) *q) {
1185   /* We can scratch if the playing track is selected */
1186   return (playing_track
1187           && (disorder_eclient_state(client) & DISORDER_CONNECTED)
1188           && selection_selected(ql->selection, playing_track->id));
1189 }
1190
1191 /** @brief Called when disorder_eclient_scratch completes */
1192 static void scratch_completed(void attribute((unused)) *v,
1193                               const char *error) {
1194   if(error)
1195     popup_protocol_error(0, error);
1196 }
1197
1198 /** @brief Scratch the playing track */
1199 static void scratch_activate(GtkMenuItem attribute((unused)) *menuitem,
1200                              gpointer attribute((unused)) user_data) {
1201   if(playing_track)
1202     disorder_eclient_scratch(client, playing_track->id, scratch_completed, 0);
1203 }
1204
1205 /** @brief Determine whether the remove option should be sensitive */
1206 static int remove_sensitive(struct queuelike *ql,
1207                             struct queue_menuitem attribute((unused)) *m,
1208                             struct queue_entry *q) {
1209   /* We can remove if we're hovering over a particular track or any non-playing
1210    * tracks are selected */
1211   return ((disorder_eclient_state(client) & DISORDER_CONNECTED)
1212           && ((q
1213                && q != playing_track)
1214               || count_selected_nonplaying(ql)));
1215 }
1216
1217 static void remove_completed(void attribute((unused)) *v,
1218                              const char *error) {
1219   if(error)
1220     popup_protocol_error(0, error);
1221 }
1222
1223 /** @brief Remove selected track(s) */
1224 static void remove_activate(GtkMenuItem attribute((unused)) *menuitem,
1225                             gpointer user_data) {
1226   const struct menuiteminfo *mii = user_data;
1227   struct queue_entry *q = mii->q;
1228   struct queuelike *ql = mii->ql;
1229
1230   if(count_selected_nonplaying(mii->ql)) {
1231     /* Remove selected tracks */
1232     for(q = ql->q; q; q = q->next)
1233       if(selection_selected(ql->selection, q->id) && q != playing_track)
1234         disorder_eclient_remove(client, q->id, move_completed, 0);
1235   } else if(q)
1236     /* Remove just the hovered track */
1237     disorder_eclient_remove(client, q->id, remove_completed, 0);
1238 }
1239
1240 /** @brief Determine whether the properties menu option should be sensitive */
1241 static int properties_sensitive(struct queuelike *ql,
1242                                 struct queue_menuitem attribute((unused)) *m,
1243                                 struct queue_entry attribute((unused)) *q) {
1244   /* "Properties" is sensitive if at least something is selected */
1245   return (hash_count(ql->selection) > 0
1246           && (disorder_eclient_state(client) & DISORDER_CONNECTED));
1247 }
1248
1249 /** @brief Pop up properties for the selected tracks */
1250 static void properties_activate(GtkMenuItem attribute((unused)) *menuitem,
1251                                 gpointer user_data) {
1252   const struct menuiteminfo *mii = user_data;
1253
1254   queue_properties(mii->ql);
1255 }
1256
1257 /** @brief Determine whether the select all menu option should be sensitive */
1258 static int selectall_sensitive(struct queuelike *ql,
1259                                struct queue_menuitem attribute((unused)) *m,
1260                                struct queue_entry attribute((unused)) *q) {
1261   /* Sensitive if there is anything to select */
1262   return !!ql->q;
1263 }
1264
1265 /** @brief Select all tracks */
1266 static void selectall_activate(GtkMenuItem attribute((unused)) *menuitem,
1267                                gpointer user_data) {
1268   const struct menuiteminfo *mii = user_data;
1269   queue_select_all(mii->ql);
1270 }
1271
1272 /** @brief Determine whether the select none menu option should be sensitive */
1273 static int selectnone_sensitive(struct queuelike *ql,
1274                                 struct queue_menuitem attribute((unused)) *m,
1275                                 struct queue_entry attribute((unused)) *q) {
1276   /* Sensitive if there is anything selected */
1277   return hash_count(ql->selection) != 0;
1278 }
1279
1280 /** @brief Select no tracks */
1281 static void selectnone_activate(GtkMenuItem attribute((unused)) *menuitem,
1282                                gpointer user_data) {
1283   const struct menuiteminfo *mii = user_data;
1284   queue_select_none(mii->ql);
1285 }
1286
1287 /** @brief Determine whether the play menu option should be sensitive */
1288 static int play_sensitive(struct queuelike *ql,
1289                           struct queue_menuitem attribute((unused)) *m,
1290                           struct queue_entry attribute((unused)) *q) {
1291   /* "Play" is sensitive if at least something is selected */
1292   return (hash_count(ql->selection) > 0
1293           && (disorder_eclient_state(client) & DISORDER_CONNECTED));
1294 }
1295
1296 /** @brief Play the selected tracks */
1297 static void play_activate(GtkMenuItem attribute((unused)) *menuitem,
1298                           gpointer user_data) {
1299   const struct menuiteminfo *mii = user_data;
1300   struct queue_entry *q = mii->q;
1301   struct queuelike *ql = mii->ql;
1302
1303   if(queue_count_selected(ql)) {
1304     /* Play selected tracks */
1305     for(q = ql->q; q; q = q->next)
1306       if(selection_selected(ql->selection, q->id))
1307         disorder_eclient_play(client, q->track, play_completed, 0);
1308   } else if(q)
1309     /* Nothing is selected, so play the hovered track */
1310     disorder_eclient_play(client, q->track, play_completed, 0);
1311 }
1312
1313 /* The queue --------------------------------------------------------------- */
1314
1315 /** @brief Fix up the queue by sticking the currently playing track on the front */
1316 static struct queue_entry *fixup_queue(struct queue_entry *q) {
1317   D(("fixup_queue"));
1318   actual_queue = q;
1319   if(playing_track) {
1320     if(actual_queue)
1321       actual_queue->prev = playing_track;
1322     playing_track->next = actual_queue;
1323     return playing_track;
1324   } else
1325     return actual_queue;
1326 }
1327
1328 /** @brief Adjust track played label
1329  *
1330  *  Called regularly to adjust the so-far played label (redrawing the whole
1331  * queue once a second makes disobedience occupy >10% of the CPU on my Athlon
1332  * which is ureasonable expensive) */
1333 static gboolean adjust_sofar(gpointer attribute((unused)) data) {
1334   if(playing_length_label && playing_track)
1335     gtk_label_set_text(GTK_LABEL(playing_length_label),
1336                        text_length(playing_track));
1337   return TRUE;
1338 }
1339
1340 /** @brief Popup menu for the queue
1341  *
1342  * Properties first so that finger trouble is less dangerous. */
1343 static struct queue_menuitem queue_menu[] = {
1344   { "Track properties", properties_activate, properties_sensitive, 0, 0 },
1345   { "Select all tracks", selectall_activate, selectall_sensitive, 0, 0 },
1346   { "Deselect all tracks", selectnone_activate, selectnone_sensitive, 0, 0 },
1347   { "Scratch track", scratch_activate, scratch_sensitive, 0, 0 },
1348   { "Remove track from queue", remove_activate, remove_sensitive, 0, 0 },
1349   { 0, 0, 0, 0, 0 }
1350 };
1351
1352 /** @brief Called whenever @ref DISORDER_PLAYING or @ref DISORDER_TRACK_PAUSED changes
1353  *
1354  * We monitor pause/resume as well as whether the track is playing in order to
1355  * keep the time played so far up to date correctly.  See playing_completed().
1356  */
1357 static void playing_update(void attribute((unused)) *v) {
1358   D(("playing_update"));
1359   gtk_label_set_text(GTK_LABEL(report_label), "updating playing track");
1360   disorder_eclient_playing(client, playing_completed, 0);
1361 }
1362
1363 /** @brief Create the queue widget */
1364 GtkWidget *queue_widget(void) {
1365   D(("queue_widget"));
1366   /* Arrange periodic update of the so-far played field */
1367   g_timeout_add(1000/*ms*/, adjust_sofar, 0);
1368   /* Arrange a callback whenever the playing state changes */
1369   register_monitor(playing_update, 0, DISORDER_PLAYING|DISORDER_TRACK_PAUSED);
1370   register_reset(queue_update);
1371   /* We pass choose_update() as our notify function since the choose screen
1372    * marks tracks that are playing/in the queue. */
1373   return queuelike(&ql_queue, fixup_queue, choose_update, queue_menu,
1374                    maincolumns, NMAINCOLUMNS);
1375 }
1376
1377 /** @brief Arrange an update of the queue widget
1378  *
1379  * Called when a track is added to the queue, removed from the queue (by user
1380  * cmmand or because it is to be played) or moved within the queue
1381  */
1382 void queue_update(void) {
1383   struct callbackdata *cbd;
1384
1385   D(("queue_update"));
1386   cbd = xmalloc(sizeof *cbd);
1387   cbd->onerror = 0;
1388   cbd->u.ql = &ql_queue;
1389   gtk_label_set_text(GTK_LABEL(report_label), "updating queue");
1390   disorder_eclient_queue(client, queuelike_completed, cbd);
1391 }
1392
1393 /* Recently played tracks -------------------------------------------------- */
1394
1395 /** @brief Fix up the recently played list
1396  *
1397  * It's in the wrong order!  TODO fix this globally */
1398 static struct queue_entry *fixup_recent(struct queue_entry *q) {
1399   struct queue_entry *qr = 0,  *qn;
1400
1401   D(("fixup_recent"));
1402   while(q) {
1403     qn = q->next;
1404     /* Swap next/prev pointers */
1405     q->next = q->prev;
1406     q->prev = qn;
1407     /* Remember last node for new head */
1408     qr = q;
1409     /* Next node */
1410     q = qn;
1411   }
1412   return qr;
1413 }
1414
1415 /** @brief Pop-up menu for recently played list */
1416 static struct queue_menuitem recent_menu[] = {
1417   { "Track properties", properties_activate, properties_sensitive,0, 0 },
1418   { "Select all tracks", selectall_activate, selectall_sensitive, 0, 0 },
1419   { "Deselect all tracks", selectnone_activate, selectnone_sensitive, 0, 0 },
1420   { 0, 0, 0, 0, 0 }
1421 };
1422
1423 /** @brief Create the recently-played list */
1424 GtkWidget *recent_widget(void) {
1425   D(("recent_widget"));
1426   register_reset(recent_update);
1427   return queuelike(&ql_recent, fixup_recent, 0, recent_menu,
1428                    maincolumns, NMAINCOLUMNS);
1429 }
1430
1431 /** @brief Update the recently played list
1432  *
1433  * Called whenever a track is added to it or removed from it.
1434  */
1435 void recent_update(void) {
1436   struct callbackdata *cbd;
1437
1438   D(("recent_update"));
1439   cbd = xmalloc(sizeof *cbd);
1440   cbd->onerror = 0;
1441   cbd->u.ql = &ql_recent;
1442   gtk_label_set_text(GTK_LABEL(report_label), "updating recently played list");
1443   disorder_eclient_recent(client, queuelike_completed, cbd);
1444 }
1445
1446 /* Newly added tracks ------------------------------------------------------ */
1447
1448 /** @brief Pop-up menu for recently played list */
1449 static struct queue_menuitem added_menu[] = {
1450   { "Track properties", properties_activate, properties_sensitive, 0, 0 },
1451   { "Play track", play_activate, play_sensitive, 0, 0 },
1452   { "Select all tracks", selectall_activate, selectall_sensitive, 0, 0 },
1453   { "Deselect all tracks", selectnone_activate, selectnone_sensitive, 0, 0 },
1454   { 0, 0, 0, 0, 0 }
1455 };
1456
1457 /** @brief Create the newly-added list */
1458 GtkWidget *added_widget(void) {
1459   D(("added_widget"));
1460   register_reset(added_update);
1461   return queuelike(&ql_added, 0/*fixup*/, 0/*notify*/, added_menu,
1462                    addedcolumns, NADDEDCOLUMNS);
1463 }
1464
1465 /** @brief Called with an updated list of newly-added tracks
1466  *
1467  * This is called with a raw list of track names but the rest of @ref
1468  * disobedience/queue.c requires @ref queue_entry structures with a valid and
1469  * unique @c id field.  This function fakes it.
1470  */
1471 static void new_completed(void *v, int nvec, char **vec) {
1472   struct queue_entry *q, *qh, *qlast = 0, **qq = &qh;
1473   int n;
1474
1475   for(n = 0; n < nvec; ++n) {
1476     q = xmalloc(sizeof *q);
1477     q->prev = qlast;
1478     q->track = vec[n];
1479     q->id = vec[n];
1480     *qq = q;
1481     qq = &q->next;
1482     qlast = q;
1483   }
1484   *qq = 0;
1485   queuelike_completed(v, qh);
1486 }
1487
1488 /** @brief Update the newly-added list */
1489 void added_update(void) {
1490   struct callbackdata *cbd;
1491   D(("added_updae"));
1492
1493   cbd = xmalloc(sizeof *cbd);
1494   cbd->onerror = 0;
1495   cbd->u.ql = &ql_added;
1496   gtk_label_set_text(GTK_LABEL(report_label),
1497                      "updating newly added track list");
1498   disorder_eclient_new_tracks(client, new_completed, 0/*all*/, cbd);
1499 }
1500
1501 /* Main menu plumbing ------------------------------------------------------ */
1502
1503 static int queue_properties_sensitive(GtkWidget *w) {
1504   return (!!queue_count_selected(g_object_get_data(G_OBJECT(w), "queue"))
1505           && (disorder_eclient_state(client) & DISORDER_CONNECTED));
1506 }
1507
1508 static int queue_selectall_sensitive(GtkWidget *w) {
1509   return !!queue_count_entries(g_object_get_data(G_OBJECT(w), "queue"));
1510 }
1511
1512 static int queue_selectnone_sensitive(GtkWidget *w) {
1513   struct queuelike *const ql = g_object_get_data(G_OBJECT(w), "queue");
1514
1515   return hash_count(ql->selection) != 0;
1516 }
1517
1518 static void queue_properties_activate(GtkWidget *w) {
1519   queue_properties(g_object_get_data(G_OBJECT(w), "queue"));
1520 }
1521
1522 static void queue_selectall_activate(GtkWidget *w) {
1523   queue_select_all(g_object_get_data(G_OBJECT(w), "queue"));
1524 }
1525
1526 static void queue_selectnone_activate(GtkWidget *w) {
1527   queue_select_none(g_object_get_data(G_OBJECT(w), "queue"));
1528 }
1529
1530 static const struct tabtype tabtype_queue = {
1531   queue_properties_sensitive,
1532   queue_selectall_sensitive,
1533   queue_selectnone_sensitive,
1534   queue_properties_activate,
1535   queue_selectall_activate,
1536   queue_selectnone_activate,
1537 };
1538
1539 /* Other entry points ------------------------------------------------------ */
1540
1541 /** @brief Return nonzero if @p track is in the queue */
1542 int queued(const char *track) {
1543   struct queue_entry *q;
1544
1545   D(("queued %s", track));
1546   for(q = ql_queue.q; q; q = q->next)
1547     if(!strcmp(q->track, track))
1548       return 1;
1549   return 0;
1550 }
1551
1552 /*
1553 Local Variables:
1554 c-basic-offset:2
1555 comment-column:40
1556 fill-column:79
1557 indent-tabs-mode:nil
1558 End:
1559 */