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

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2006-2009 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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file disobedience/queue-generic.c
  19  * @brief Disobedience queue widgets
  20  *
  21  * This file provides contains code shared between all the queue-like
  22  * widgets - the queue, the recent list and the added tracks list.
  23  *
  24  * This code is in the process of being rewritten to use the native list
  25  * widget.
  26  *
  27  * There are three @ref queuelike objects: @ref ql_queue, @ref
  28  * ql_recent and @ref ql_added.  Each has an associated queue linked
  29  * list and a list store containing the contents.
  30  *
  31  * When new contents turn up we rearrange the list store accordingly.
  32  *
  33  * NB that while in the server the playing track is not in the queue, in
  34  * Disobedience, the playing does live in @c ql_queue.q, despite its different
  35  * status to everything else found in that list.
  36  *
  37  * To do:
  38  * - display playing row in a different color?
  39  */
  40 #include "disobedience.h"
  41 #include "popup.h"
  42 #include "queue-generic.h"
  43
  44 static const GtkTargetEntry queuelike_targets[] = {
  45   {
  46     (char *)"text/x-disorder-queued-tracks", /* drag type */
  47     GTK_TARGET_SAME_WIDGET,             /* rearrangement within a widget */
  48     0                                   /* ID value */
  49   },
  50   {
  51     (char *)"text/x-disorder-playable-tracks", /* drag type */
  52     GTK_TARGET_SAME_APP|GTK_TARGET_OTHER_WIDGET, /* copying between widgets */
  53     1                                     /* ID value */
  54   },
  55 };
  56
  57 /* Track detail lookup ----------------------------------------------------- */
  58
  59 static void queue_lookups_completed(const char attribute((unused)) *event,
  60                                    void attribute((unused)) *eventdata,
  61                                    void *callbackdata) {
  62   struct queuelike *ql = callbackdata;
  63   ql_update_list_store(ql);
  64 }
  65
  66 /* Column formatting -------------------------------------------------------- */
  67
  68 /** @brief Format the 'when' column */
  69 const char *column_when(const struct queue_entry *q,
  70                         const char attribute((unused)) *data) {
  71   char when[64];
  72   struct tm tm;
  73   time_t t;
  74
  75   D(("column_when"));
  76   switch(q->state) {
  77   case playing_isscratch:
  78   case playing_unplayed:
  79   case playing_random:
  80     t = q->expected;
  81     break;
  82   case playing_failed:
  83   case playing_no_player:
  84   case playing_ok:
  85   case playing_scratched:
  86   case playing_started:
  87   case playing_paused:
  88   case playing_quitting:
  89     t = q->played;
  90     break;
  91   default:
  92     t = 0;
  93     break;
  94   }
  95   if(t)
  96     strftime(when, sizeof when, "%H:%M", localtime_r(&t, &tm));
  97   else
  98     when[0] = 0;
  99   return xstrdup(when);
 100 }
 101
 102 /** @brief Format the 'who' column */
 103 const char *column_who(const struct queue_entry *q,
 104                        const char attribute((unused)) *data) {
 105   D(("column_who"));
 106   return q->submitter ? q->submitter : "";
 107 }
 108
 109 /** @brief Format one of the track name columns */
 110 const char *column_namepart(const struct queue_entry *q,
 111                             const char *data) {
 112   D(("column_namepart"));
 113   return namepart(q->track, "display", data);
 114 }
 115
 116 /** @brief Format the length column */
 117 const char *column_length(const struct queue_entry *q,
 118                           const char attribute((unused)) *data) {
 119   D(("column_length"));
 120   long l;
 121   time_t now;
 122   char *played = 0, *length = 0;
 123
 124   /* Work out what to say for the length */
 125   l = namepart_length(q->track);
 126   if(l > 0)
 127     byte_xasprintf(&length, "%ld:%02ld", l / 60, l % 60);
 128   else
 129     byte_xasprintf(&length, "?:??");
 130   /* For the currently playing track we want to report how much of the track
 131    * has been played */
 132   if(q == playing_track) {
 133     /* log_state() arranges that we re-get the playing data whenever the
 134      * pause/resume state changes */
 135     if(last_state & DISORDER_TRACK_PAUSED)
 136       l = playing_track->sofar;
 137     else {
 138       if(!last_playing)
 139         return NULL;
 140       xtime(&now);
 141       l = playing_track->sofar + (now - last_playing);
 142     }
 143     byte_xasprintf(&played, "%ld:%02ld/%s", l / 60, l % 60, length);
 144     return played;
 145   } else
 146     return length;
 147 }
 148
 149 /* List store maintenance -------------------------------------------------- */
 150
 151 /** @brief Return the @ref queue_entry corresponding to @p iter
 152  * @param model Model that owns @p iter
 153  * @param iter Tree iterator
 154  * @return Pointer to queue entry
 155  */
 156 struct queue_entry *ql_iter_to_q(GtkTreeModel *model,
 157                                  GtkTreeIter *iter) {
 158   struct queuelike *ql = g_object_get_data(G_OBJECT(model), "ql");
 159   GValue v[1];
 160   memset(v, 0, sizeof v);
 161   gtk_tree_model_get_value(model, iter, ql->ncolumns + QUEUEPOINTER_COLUMN, v);
 162   assert(G_VALUE_TYPE(v) == G_TYPE_POINTER);
 163   struct queue_entry *const q = g_value_get_pointer(v);
 164   g_value_unset(v);
 165   return q;
 166 }
 167
 168 /** @brief Return the @ref queue_entry corresponding to @p path
 169  * @param model Model to query
 170  * @param path Path into tree
 171  * @return Pointer to queue entry or NULL
 172  */
 173 struct queue_entry *ql_path_to_q(GtkTreeModel *model,
 174                                  GtkTreePath *path) {
 175   GtkTreeIter iter[1];
 176   if(!gtk_tree_model_get_iter(model, iter, path))
 177     return NULL;
 178   return ql_iter_to_q(model, iter);
 179 }
 180
 181 /** @brief Update one row of a list store
 182  * @param q Queue entry
 183  * @param iter Iterator referring to row or NULL to work it out
 184  */
 185 void ql_update_row(struct queue_entry *q,
 186                    GtkTreeIter *iter) {
 187   const struct queuelike *const ql = q->ql;
 188
 189   D(("ql_update_row"));
 190   /* If no iter was supplied, work it out */
 191   GtkTreeIter my_iter[1];
 192   if(!iter) {
 193     gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store), my_iter);
 194     struct queue_entry *qq;
 195     for(qq = ql->q; qq && q != qq; qq = qq->next)
 196       gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), my_iter);
 197     if(!qq)
 198       return;
 199     iter = my_iter;
 200   }
 201   /* Update all the columns */
 202   for(int col = 0; col < ql->ncolumns; ++col) {
 203     const char *const v = ql->columns[col].value(q,
 204                                                  ql->columns[col].data);
 205     if(v)
 206       gtk_list_store_set(ql->store, iter,
 207                          col, v,
 208                          -1);
 209   }
 210   gtk_list_store_set(ql->store, iter,
 211                      ql->ncolumns + QUEUEPOINTER_COLUMN, q,
 212                      -1);
 213   if(q == playing_track)
 214     gtk_list_store_set(ql->store, iter,
 215                        ql->ncolumns + BACKGROUND_COLUMN, BG_PLAYING,
 216                        ql->ncolumns + FOREGROUND_COLUMN, FG_PLAYING,
 217                        -1);
 218   else
 219     gtk_list_store_set(ql->store, iter,
 220                        ql->ncolumns + BACKGROUND_COLUMN, (char *)0,
 221                        ql->ncolumns + FOREGROUND_COLUMN, (char *)0,
 222                        -1);
 223 }
 224
 225 /** @brief Update the list store
 226  * @param ql Queuelike to update
 227  *
 228  * Called when new namepart data is available (and initially).  Doesn't change
 229  * the rows, just updates the cell values.
 230  */
 231 void ql_update_list_store(struct queuelike *ql) {
 232   D(("ql_update_list_store"));
 233   GtkTreeIter iter[1];
 234   gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store), iter);
 235   for(struct queue_entry *q = ql->q; q; q = q->next) {
 236     ql_update_row(q, iter);
 237     gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
 238   }
 239 }
 240
 241 struct newqueue_data {
 242   struct queue_entry *old, *new;
 243 };
 244
 245 static void record_queue_map(hash *h,
 246                              const char *id,
 247                              struct queue_entry *old,
 248                              struct queue_entry *new) {
 249   struct newqueue_data *nqd;
 250
 251   if(!(nqd = hash_find(h, id))) {
 252     static const struct newqueue_data empty[1];
 253     hash_add(h, id, empty, HASH_INSERT);
 254     nqd = hash_find(h, id);
 255   }
 256   if(old)
 257     nqd->old = old;
 258   if(new)
 259     nqd->new = new;
 260 }
 261
 262 #if 0
 263 static void dump_queue(struct queue_entry *head, struct queue_entry *mark) {
 264   for(struct queue_entry *q = head; q; q = q->next) {
 265     if(q == mark)
 266       fprintf(stderr, "!");
 267     fprintf(stderr, "%s", q->id);
 268     if(q->next)
 269       fprintf(stderr, " ");
 270   }
 271   fprintf(stderr, "\n");
 272 }
 273
 274 static void dump_rows(struct queuelike *ql) {
 275   GtkTreeIter iter[1];
 276   gboolean it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
 277                                               iter);
 278   while(it) {
 279     struct queue_entry *q = ql_iter_to_q(GTK_TREE_MODEL(ql->store), iter);
 280     it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
 281     fprintf(stderr, "%s", q->id);
 282     if(it)
 283       fprintf(stderr, " ");
 284   }
 285   fprintf(stderr, "\n");
 286 }
 287 #endif
 288
 289 /** @brief Reset the list store
 290  * @param ql Queuelike to reset
 291  * @param newq New queue contents/ordering
 292  *
 293  * Updates the queue to match @p newq
 294  */
 295 void ql_new_queue(struct queuelike *ql,
 296                   struct queue_entry *newq) {
 297   D(("ql_new_queue"));
 298   ++suppress_actions;
 299
 300   /* Tell every queue entry which queue owns it */
 301   //fprintf(stderr, "%s: filling in q->ql\n", ql->name);
 302   for(struct queue_entry *q = newq; q; q = q->next)
 303     q->ql = ql;
 304
 305   //fprintf(stderr, "%s: constructing h\n", ql->name);
 306   /* Construct map from id to new and old structures */
 307   hash *h = hash_new(sizeof(struct newqueue_data));
 308   for(struct queue_entry *q = ql->q; q; q = q->next)
 309     record_queue_map(h, q->id, q, NULL);
 310   for(struct queue_entry *q = newq; q; q = q->next)
 311     record_queue_map(h, q->id, NULL, q);
 312
 313   /* The easy bit: delete rows not present any more.  In the same pass we
 314    * update the secret column containing the queue_entry pointer. */
 315   //fprintf(stderr, "%s: deleting rows...\n", ql->name);
 316   GtkTreeIter iter[1];
 317   gboolean it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
 318                                               iter);
 319   int inserted = 0, deleted = 0, kept = 0;
 320   while(it) {
 321     struct queue_entry *q = ql_iter_to_q(GTK_TREE_MODEL(ql->store), iter);
 322     const struct newqueue_data *nqd = hash_find(h, q->id);
 323     if(nqd->new) {
 324       /* Tell this row that it belongs to the new version of the queue */
 325       gtk_list_store_set(ql->store, iter,
 326                          ql->ncolumns + QUEUEPOINTER_COLUMN, nqd->new,
 327                          -1);
 328       it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
 329       ++kept;
 330     } else {
 331       /* Delete this row (and move iter to the next one) */
 332       //fprintf(stderr, " delete %s", q->id);
 333       it = gtk_list_store_remove(ql->store, iter);
 334       ++deleted;
 335     }
 336   }
 337
 338   /* Now every row's secret column is right, but we might be missing new rows
 339    * and they might be in the wrong order */
 340
 341   /* We're going to have to support arbitrary rearrangements, so we might as
 342    * well add new elements at the end. */
 343   //fprintf(stderr, "%s: adding rows...\n", ql->name);
 344   struct queue_entry *after = 0;
 345   for(struct queue_entry *q = newq; q; q = q->next) {
 346     const struct newqueue_data *nqd = hash_find(h, q->id);
 347     if(!nqd->old) {
 348       if(after) {
 349         /* Try to insert at the right sort of place */
 350         GtkTreeIter where[1];
 351         gboolean wit = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
 352                                                      where);
 353         while(wit && ql_iter_to_q(GTK_TREE_MODEL(ql->store), where) != after)
 354           wit = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), where);
 355         if(wit)
 356           gtk_list_store_insert_after(ql->store, iter, where);
 357         else
 358           gtk_list_store_append(ql->store, iter);
 359       } else
 360         gtk_list_store_prepend(ql->store, iter);
 361       gtk_list_store_set(ql->store, iter,
 362                          ql->ncolumns + QUEUEPOINTER_COLUMN, q,
 363                          -1);
 364       //fprintf(stderr, " add %s", q->id);
 365       ++inserted;
 366     }
 367     after = newq;
 368   }
 369
 370   /* Now exactly the right set of rows are present, and they have the right
 371    * queue_entry pointers in their secret column, but they may be in the wrong
 372    * order.
 373    *
 374    * The current code is simple but amounts to a bubble-sort - we might easily
 375    * called gtk_tree_model_iter_next a couple of thousand times.
 376    */
 377   //fprintf(stderr, "%s: rearranging rows\n", ql->name);
 378   //fprintf(stderr, "%s: queue state: ", ql->name);
 379   //dump_queue(newq, 0);
 380   //fprintf(stderr, "%s: row state: ", ql->name);
 381   //dump_rows(ql);
 382   it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
 383                                               iter);
 384   struct queue_entry *rq = newq;        /* r for 'right, correct' */
 385   int swaps = 0, searches = 0;
 386   while(it) {
 387     struct queue_entry *q = ql_iter_to_q(GTK_TREE_MODEL(ql->store), iter);
 388     //fprintf(stderr, " rq = %p, q = %p\n", rq, q);
 389     //fprintf(stderr, " rq->id = %s, q->id = %s\n", rq->id, q->id);
 390
 391     if(q != rq) {
 392       //fprintf(stderr, "  mismatch\n");
 393       GtkTreeIter next[1] = { *iter };
 394       gboolean nit = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), next);
 395       while(nit) {
 396         struct queue_entry *nq = ql_iter_to_q(GTK_TREE_MODEL(ql->store), next);
 397         //fprintf(stderr, "   candidate: %s\n", nq->id);
 398         if(nq == rq)
 399           break;
 400         nit = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), next);
 401         ++searches;
 402       }
 403       assert(nit);
 404       //fprintf(stderr, "  found it\n");
 405       gtk_list_store_swap(ql->store, iter, next);
 406       *iter = *next;
 407       //fprintf(stderr, "%s: new row state: ", ql->name);
 408       //dump_rows(ql);
 409       ++swaps;
 410     }
 411     /* ...and onto the next one */
 412     it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
 413     rq = rq->next;
 414   }
 415 #if 0
 416   fprintf(stderr, "%6s: %3d kept %3d inserted %3d deleted %3d swaps %4d searches\n", ql->name,
 417           kept, inserted, deleted, swaps, searches);
 418 #endif
 419   //fprintf(stderr, "done\n");
 420   ql->q = newq;
 421   /* Set the rest of the columns in new rows */
 422   ql_update_list_store(ql);
 423   --suppress_actions;
 424 }
 425
 426 /** @brief State for ql_drag_begin() and its callbacks */
 427 struct ql_drag_begin_state {
 428   struct queuelike *ql;
 429   int rows;
 430   int index;
 431   GdkPixmap **pixmaps;
 432 };
 433
 434 /** @brief Callback to construct a row pixmap */
 435 static void ql_drag_make_row_pixmaps(GtkTreeModel attribute((unused)) *model,
 436                                      GtkTreePath *path,
 437                                      GtkTreeIter attribute((unused)) *iter,
 438                                      gpointer data) {
 439   struct ql_drag_begin_state *qdbs = data;
 440
 441   qdbs->pixmaps[qdbs->index++]
 442     = gtk_tree_view_create_row_drag_icon(GTK_TREE_VIEW(qdbs->ql->view),
 443                                          path);
 444 }
 445
 446 /** @brief Called when a drag operation from this queuelike begins
 447  * @param w Source widget (the tree view)
 448  * @param dc Drag context
 449  * @param user_data The queuelike
 450  */
 451 static void ql_drag_begin(GtkWidget attribute((unused)) *w,
 452                           GdkDragContext attribute((unused)) *dc,
 453                           gpointer user_data) {
 454   struct queuelike *const ql = user_data;
 455   struct ql_drag_begin_state qdbs[1];
 456   GdkPixmap *icon;
 457
 458   //fprintf(stderr, "drag-begin\n");
 459   memset(qdbs, 0, sizeof *qdbs);
 460   qdbs->ql = ql;
 461   /* Find out how many rows there are */
 462   if(!(qdbs->rows = gtk_tree_selection_count_selected_rows(ql->selection)))
 463     return;                             /* doesn't make sense */
 464   /* Generate a pixmap for each row */
 465   qdbs->pixmaps = xcalloc(qdbs->rows, sizeof *qdbs->pixmaps);
 466   gtk_tree_selection_selected_foreach(ql->selection,
 467                                       ql_drag_make_row_pixmaps,
 468                                       qdbs);
 469   /* Determine the size of the final icon */
 470   int height = 0, width = 0;
 471   for(int n = 0; n < qdbs->rows; ++n) {
 472     int pxw, pxh;
 473     gdk_drawable_get_size(qdbs->pixmaps[n], &pxw, &pxh);
 474     if(pxw > width)
 475       width = pxw;
 476     height += pxh;
 477   }
 478   if(!width || !height)
 479     return;                             /* doesn't make sense */
 480   /* Construct the icon */
 481   icon = gdk_pixmap_new(qdbs->pixmaps[0], width, height, -1);
 482   GdkGC *gc = gdk_gc_new(icon);
 483   gdk_gc_set_colormap(gc, gtk_widget_get_colormap(ql->view));
 484   int y = 0;
 485   for(int n = 0; n < qdbs->rows; ++n) {
 486     int pxw, pxh;
 487     gdk_drawable_get_size(qdbs->pixmaps[n], &pxw, &pxh);
 488     gdk_draw_drawable(icon,
 489                       gc,
 490                       qdbs->pixmaps[n],
 491                       0, 0,             /* source coords */
 492                       0, y,             /* dest coords */
 493                       pxw, pxh);        /* size */
 494     y += pxh;
 495     gdk_drawable_unref(qdbs->pixmaps[n]);
 496     qdbs->pixmaps[n] = NULL;
 497   }
 498   // TODO scale down a bit, the resulting icons are currently a bit on the
 499   // large side.
 500   gtk_drag_source_set_icon(ql->view,
 501                            gtk_widget_get_colormap(ql->view),
 502                            icon,
 503                            NULL);
 504 }
 505
 506 /** @brief Called when a drag moves within a candidate destination
 507  * @param w Destination widget
 508  * @param dc Drag context
 509  * @param x Current pointer location
 510  * @param y Current pointer location
 511  * @param time_ Current time
 512  * @param user_data Pointer to queuelike
 513  * @return TRUE in a dropzone, otherwise FALSE
 514  */
 515 static gboolean ql_drag_motion(GtkWidget *w,
 516                                GdkDragContext *dc,
 517                                gint x,
 518                                gint y,
 519                                guint time_,
 520                                gpointer attribute((unused)) user_data) {
 521   //struct queuelike *const ql = user_data;
 522   GdkDragAction action = 0;
 523
 524   // GTK_DEST_DEFAULT_MOTION vets actions as follows:
 525   // 1) if dc->suggested_action is in the gtk_drag_dest_set actions
 526   //    then dc->suggested_action is taken as the action.
 527   // 2) otherwise if dc->actions intersects the gtk_drag_dest_set actions
 528   //    then the lowest-numbered member of the intersection is chosen.
 529   // 3) otherwise no member is chosen and gdk_drag_status() is called
 530   //    with action=0 to refuse the drop.
 531   if(dc->suggested_action) {
 532     if(dc->suggested_action & (GDK_ACTION_MOVE|GDK_ACTION_COPY))
 533       action = dc->suggested_action;
 534   } else if(dc->actions & GDK_ACTION_MOVE)
 535     action = GDK_ACTION_MOVE;
 536   else if(dc->actions & GDK_ACTION_COPY)
 537     action = GDK_ACTION_COPY;
 538   /*fprintf(stderr, "suggested %#x actions %#x result %#x\n",
 539     dc->suggested_action, dc->actions, action);*/
 540   if(action) {
 541     // If the action is acceptable then we see if this widget is acceptable
 542     if(gtk_drag_dest_find_target(w, dc, NULL) == GDK_NONE)
 543       action = 0;
 544   }
 545   // Report the status
 546   gdk_drag_status(dc, action, time_);
 547   if(action) {
 548     // Highlight the drop area
 549     GtkTreePath *path;
 550     GtkTreeViewDropPosition pos;
 551
 552     if(gtk_tree_view_get_dest_row_at_pos(GTK_TREE_VIEW(w),
 553                                          x, y,
 554                                          &path,
 555                                          &pos)) {
 556       //fprintf(stderr, "gtk_tree_view_get_dest_row_at_pos() -> TRUE\n");
 557       // Normalize drop position
 558       switch(pos) {
 559       case GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
 560         pos = GTK_TREE_VIEW_DROP_BEFORE;
 561         break;
 562       case GTK_TREE_VIEW_DROP_INTO_OR_AFTER:
 563         pos = GTK_TREE_VIEW_DROP_AFTER;
 564         break;
 565       default: break;
 566       }
 567       // Highlight drop target
 568       gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(w), path, pos);
 569     } else {
 570       //fprintf(stderr, "gtk_tree_view_get_dest_row_at_pos() -> FALSE\n");
 571       gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(w), NULL, 0);
 572     }
 573   }
 574   return TRUE;
 575 }
 576
 577 /** @brief Called when a drag moves leaves a candidate destination
 578  * @param w Destination widget
 579  * @param dc Drag context
 580  * @param time_ Current time
 581  * @param user_data Pointer to queuelike
 582  */
 583 static void ql_drag_leave(GtkWidget *w,
 584                           GdkDragContext attribute((unused)) *dc,
 585                           guint attribute((unused)) time_,
 586                           gpointer attribute((unused)) user_data) {
 587   //struct queuelike *const ql = user_data;
 588
 589   gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW(w), NULL, 0);
 590 }
 591
 592 /** @brief Callback to add selected tracks to the selection data
 593  *
 594  * Called from ql_drag_data_get().
 595  */
 596 static void ql_drag_data_get_collect(GtkTreeModel *model,
 597                                      GtkTreePath attribute((unused)) *path,
 598                                      GtkTreeIter *iter,
 599                                      gpointer data) {
 600   struct dynstr *const result = data;
 601   struct queue_entry *const q = ql_iter_to_q(model, iter);
 602
 603   dynstr_append_string(result, q->id);
 604   dynstr_append(result, '\n');
 605   dynstr_append_string(result, q->track);
 606   dynstr_append(result, '\n');
 607 }
 608
 609 /** @brief Called to extract the dragged data from the source queuelike
 610  * @param w Source widget (the tree view)
 611  * @param dc Drag context
 612  * @param data Where to put the answer
 613  * @param info_ Target @c info parameter
 614  * @param time_ Time data requested (for some reason not a @c time_t)
 615  * @param user_data The queuelike
 616  */
 617 static void ql_drag_data_get(GtkWidget attribute((unused)) *w,
 618                              GdkDragContext attribute((unused)) *dc,
 619                              GtkSelectionData *data,
 620                              guint attribute((unused)) info_,
 621                              guint attribute((unused)) time_,
 622                              gpointer user_data) {
 623   struct queuelike *const ql = user_data;
 624   struct dynstr result[1];
 625
 626   /* The list of tracks is converted into a single string, consisting of IDs
 627    * and track names.  Each is terminated by a newline.  Including both ID and
 628    * track name means that the receiver can use whichever happens to be more
 629    * convenient. */
 630   dynstr_init(result);
 631   gtk_tree_selection_selected_foreach(ql->selection,
 632                                       ql_drag_data_get_collect,
 633                                       result);
 634   // TODO must not be able to drag playing track!
 635   //fprintf(stderr, "drag-data-get: %.*s\n",
 636   //        result->nvec, result->vec);
 637   /* gtk_selection_data_set_text() insists that data->target is one of a
 638    * variety of stringy atoms.  TODO: where does this value actually come
 639    * from?  */
 640   gtk_selection_data_set(data,
 641                          GDK_TARGET_STRING,
 642                          8, (guchar *)result->vec, result->nvec);
 643 }
 644
 645 /** @brief Called when drag data is received
 646  * @param w Target widget (the tree view)
 647  * @param dc Drag context
 648  * @param x The drop location
 649  * @param y The drop location
 650  * @param data The selection data
 651  * @param info_ The target type that was chosen
 652  * @param time_ Time data received (for some reason not a @c time_t)
 653  * @param user_data The queuelike
 654  */
 655 static void ql_drag_data_received(GtkWidget attribute((unused)) *w,
 656                                   GdkDragContext attribute((unused)) *dc,
 657                                   gint x,
 658                                   gint y,
 659                                   GtkSelectionData *data,
 660                                   guint attribute((unused)) info_,
 661                                   guint attribute((unused)) time_,
 662                                   gpointer user_data) {
 663   struct queuelike *const ql = user_data;
 664   char *result, *p;
 665   struct vector ids[1], tracks[1];
 666   int parity = 0;
 667
 668   //fprintf(stderr, "drag-data-received: %d,%d info_=%u\n", x, y, info_);
 669   /* Get the selection string */
 670   p = result = (char *)gtk_selection_data_get_text(data);
 671   if(!result) {
 672     //fprintf(stderr, "gtk_selection_data_get_text() returned NULL\n");
 673     return;
 674   }
 675   //fprintf(stderr, "%s--\n", result);
 676   /* Parse it back into IDs and track names */
 677   vector_init(ids);
 678   vector_init(tracks);
 679   while(*p) {
 680     char *nl = strchr(p, '\n');
 681     if(!nl)
 682       break;
 683     *nl = 0;
 684     //fprintf(stderr, "  %s\n", p);
 685     vector_append(parity++ & 1 ? tracks : ids, xstrdup(p));
 686     p = nl + 1;
 687   }
 688   g_free(result);
 689   if(ids->nvec != tracks->nvec) {
 690     //fprintf(stderr, "  inconsistent drag data!\n");
 691     return;
 692   }
 693   vector_terminate(ids);
 694   vector_terminate(tracks);
 695   /* Figure out which row the drop precedes (if any) */
 696   GtkTreePath *path;
 697   GtkTreeViewDropPosition pos;
 698   struct queue_entry *q;
 699   if(!gtk_tree_view_get_dest_row_at_pos(GTK_TREE_VIEW(ql->view), x, y,
 700                                         &path, &pos)) {
 701     //fprintf(stderr, "gtk_tree_view_get_dest_row_at_pos returned FALSE\n");
 702     /* This generally means a drop past the end of the queue.  We find the last
 703      * element in the queue and ask to move after that. */
 704     for(q = ql->q; q && q->next; q = q->next)
 705       ;
 706   } else {
 707     /* Convert the path to a queue entry pointer. */
 708     q = ql_path_to_q(GTK_TREE_MODEL(ql->store), path);
 709     //fprintf(stderr, "  tree view likes to drop near %s\n",
 710     //        q->id ? q->id : "NULL");
 711     /* TODO interpretation of q=NULL */
 712     /* Q should point to the entry just before the insertion point, so that
 713      * moveafter works, or NULL to insert right at the start.  We don't support
 714      * dropping into a row, since that doesn't make sense for us. */
 715     switch(pos) {
 716     case GTK_TREE_VIEW_DROP_BEFORE:
 717     case GTK_TREE_VIEW_DROP_INTO_OR_BEFORE:
 718       if(q) {
 719         q = q->prev;
 720         //fprintf(stderr, "  ...but we like to drop near %s\n",
 721         //        q ? q->id : "NULL");
 722       }
 723       break;
 724     default:
 725       break;
 726     }
 727   }
 728   /* Guarantee we never drop an empty list */
 729   if(!tracks->nvec)
 730     return;
 731   /* Note that q->id can match one of ids[].  This doesn't matter for
 732    * moveafter but TODO may matter for playlist support. */
 733   switch(info_) {
 734   case 0:
 735     /* Rearrangement.  Send ID and track data. */
 736     ql->drop(ql, tracks->nvec, tracks->vec, ids->vec, q);
 737     break;
 738   case 1:
 739     /* Copying between widgets.  IDs mean nothing so don't send them. */
 740     ql->drop(ql, tracks->nvec, tracks->vec, NULL, q);
 741     break;
 742   }
 743 }
 744
 745 /** @brief Initialize a @ref queuelike */
 746 GtkWidget *init_queuelike(struct queuelike *ql) {
 747   D(("init_queuelike"));
 748   /* Create the list store.  We add an extra column to hold a pointer to the
 749    * queue_entry. */
 750   GType *types = xcalloc(ql->ncolumns + EXTRA_COLUMNS, sizeof (GType));
 751   for(int n = 0; n < ql->ncolumns + EXTRA_COLUMNS; ++n)
 752     types[n] = G_TYPE_STRING;
 753   types[ql->ncolumns + QUEUEPOINTER_COLUMN] = G_TYPE_POINTER;
 754   ql->store = gtk_list_store_newv(ql->ncolumns + EXTRA_COLUMNS, types);
 755   g_object_set_data(G_OBJECT(ql->store), "ql", (void *)ql);
 756
 757   /* Create the view */
 758   ql->view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(ql->store));
 759   gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(ql->view), TRUE);
 760
 761   /* Create cell renderers and label columns */
 762   for(int n = 0; n < ql->ncolumns; ++n) {
 763     GtkCellRenderer *r = gtk_cell_renderer_text_new();
 764     if(ql->columns[n].flags & COL_ELLIPSIZE)
 765       g_object_set(r, "ellipsize", PANGO_ELLIPSIZE_END, (char *)0);
 766     if(ql->columns[n].flags & COL_RIGHT)
 767       g_object_set(r, "xalign", (gfloat)1.0, (char *)0);
 768     GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
 769       (ql->columns[n].name,
 770        r,
 771        "text", n,
 772        "background", ql->ncolumns + BACKGROUND_COLUMN,
 773        "foreground", ql->ncolumns + FOREGROUND_COLUMN,
 774        (char *)0);
 775     gtk_tree_view_column_set_resizable(c, TRUE);
 776     gtk_tree_view_column_set_reorderable(c, TRUE);
 777     if(ql->columns[n].flags & COL_EXPAND)
 778       g_object_set(c, "expand", TRUE, (char *)0);
 779     gtk_tree_view_append_column(GTK_TREE_VIEW(ql->view), c);
 780   }
 781
 782   /* The selection should support multiple things being selected */
 783   ql->selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(ql->view));
 784   gtk_tree_selection_set_mode(ql->selection, GTK_SELECTION_MULTIPLE);
 785
 786   /* Catch button presses */
 787   g_signal_connect(ql->view, "button-press-event",
 788                    G_CALLBACK(ql_button_release), ql);
 789
 790   /* Drag+drop*/
 791   if(ql->drop) {
 792     /* Originally this was:
 793      *
 794      *   gtk_tree_view_set_reorderable(GTK_TREE_VIEW(ql->view), TRUE);
 795      *
 796      * However this has a two deficiencies:
 797      *
 798      *   1) Only one row can be dragged at once.  It would be nice
 799      *      to be able to do bulk rearrangements since the server
 800      *      can cope with that well.
 801      *   2) Dragging between windows is not possible.  When playlist
 802      *      support appears, it should be possible to drag tracks
 803      *      from the choose tag into the playlist.
 804      *
 805      * At the time of writing neither of these problems are fully solved, the
 806      * code as it stands is just a stepping stone in that direction.
 807      */
 808
 809     /* This view will act as a drag source */
 810     gtk_drag_source_set(ql->view,
 811                         GDK_BUTTON1_MASK,
 812                         queuelike_targets,
 813                         sizeof queuelike_targets / sizeof *queuelike_targets,
 814                         GDK_ACTION_MOVE);
 815     /* This view will act as a drag destination */
 816     gtk_drag_dest_set(ql->view,
 817                       GTK_DEST_DEFAULT_HIGHLIGHT|GTK_DEST_DEFAULT_DROP,
 818                       queuelike_targets,
 819                       sizeof queuelike_targets / sizeof *queuelike_targets,
 820                       GDK_ACTION_MOVE|GDK_ACTION_COPY);
 821     g_signal_connect(ql->view, "drag-begin",
 822                      G_CALLBACK(ql_drag_begin), ql);
 823     g_signal_connect(ql->view, "drag-motion",
 824                      G_CALLBACK(ql_drag_motion), ql);
 825     g_signal_connect(ql->view, "drag-leave",
 826                      G_CALLBACK(ql_drag_leave), ql);
 827     g_signal_connect(ql->view, "drag-data-get",
 828                      G_CALLBACK(ql_drag_data_get), ql);
 829     g_signal_connect(ql->view, "drag-data-received",
 830                      G_CALLBACK(ql_drag_data_received), ql);
 831     make_treeview_multidrag(ql->view);
 832   } else {
 833     /* For queues that cannot accept a drop we still accept a copy out */
 834     gtk_drag_source_set(ql->view,
 835                         GDK_BUTTON1_MASK,
 836                         queuelike_targets,
 837                         sizeof queuelike_targets / sizeof *queuelike_targets,
 838                         GDK_ACTION_COPY);
 839     g_signal_connect(ql->view, "drag-begin",
 840                      G_CALLBACK(ql_drag_begin), ql);
 841     g_signal_connect(ql->view, "drag-data-get",
 842                      G_CALLBACK(ql_drag_data_get), ql);
 843     make_treeview_multidrag(ql->view);
 844   }
 845
 846   /* TODO style? */
 847
 848   ql->init(ql);
 849
 850   /* Update display text when lookups complete */
 851   event_register("lookups-completed", queue_lookups_completed, ql);
 852
 853   GtkWidget *scrolled = scroll_widget(ql->view);
 854   g_object_set_data(G_OBJECT(scrolled), "type", (void *)ql_tabtype(ql));
 855   return scrolled;
 856 }
 857
 858 /*
 859 Local Variables:
 860 c-basic-offset:2
 861 comment-column:40
 862 fill-column:79
 863 indent-tabs-mode:nil
 864 End:
 865 */