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

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