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