2 * This file is part of DisOrder
3 * Copyright (C) 2006-2008 Richard Kettlewell
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.
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.
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
20 /** @file disobedience/queue-generic.c
21 * @brief Queue widgets
23 * This file provides contains code shared between all the queue-like
24 * widgets - the queue, the recent list and the added tracks list.
26 * This code is in the process of being rewritten to use the native list
29 * There are three @ref queuelike objects: @ref ql_queue, @ref
30 * ql_recent and @ref ql_added. Each has an associated queue linked
31 * list and a list store containing the contents.
33 * When new contents turn up we rearrange the list store accordingly.
35 * NB that while in the server the playing track is not in the queue, in
36 * Disobedience, the playing does live in @c ql_queue.q, despite its different
37 * status to everything else found in that list.
40 * - display playing row in a different color?
42 #include "disobedience.h"
44 #include "queue-generic.h"
46 static struct queuelike *const queuelikes[] = {
47 &ql_queue, &ql_recent, &ql_added
49 #define NQUEUELIKES (sizeof queuelikes / sizeof *queuelikes)
51 /* Track detail lookup ----------------------------------------------------- */
53 static void queue_lookups_completed(const char attribute((unused)) *event,
54 void attribute((unused)) *eventdata,
56 struct queuelike *ql = callbackdata;
57 ql_update_list_store(ql);
60 /* Column formatting -------------------------------------------------------- */
62 /** @brief Format the 'when' column */
63 const char *column_when(const struct queue_entry *q,
64 const char attribute((unused)) *data) {
71 case playing_isscratch:
72 case playing_unplayed:
77 case playing_no_player:
79 case playing_scratched:
82 case playing_quitting:
90 strftime(when, sizeof when, "%H:%M", localtime_r(&t, &tm));
96 /** @brief Format the 'who' column */
97 const char *column_who(const struct queue_entry *q,
98 const char attribute((unused)) *data) {
100 return q->submitter ? q->submitter : "";
103 /** @brief Format one of the track name columns */
104 const char *column_namepart(const struct queue_entry *q,
106 D(("column_namepart"));
107 return namepart(q->track, "display", data);
110 /** @brief Format the length column */
111 const char *column_length(const struct queue_entry *q,
112 const char attribute((unused)) *data) {
113 D(("column_length"));
116 char *played = 0, *length = 0;
118 /* Work out what to say for the length */
119 l = namepart_length(q->track);
121 byte_xasprintf(&length, "%ld:%02ld", l / 60, l % 60);
123 byte_xasprintf(&length, "?:??");
124 /* For the currently playing track we want to report how much of the track
126 if(q == playing_track) {
127 /* log_state() arranges that we re-get the playing data whenever the
128 * pause/resume state changes */
129 if(last_state & DISORDER_TRACK_PAUSED)
130 l = playing_track->sofar;
133 l = playing_track->sofar + (now - last_playing);
135 byte_xasprintf(&played, "%ld:%02ld/%s", l / 60, l % 60, length);
141 /* List store maintenance -------------------------------------------------- */
143 /** @brief Return the @ref queue_entry corresponding to @p iter
144 * @param model Model that owns @p iter
145 * @param iter Tree iterator
148 struct queue_entry *ql_iter_to_q(GtkTreeModel *model,
150 struct queuelike *ql = g_object_get_data(G_OBJECT(model), "ql");
152 memset(v, 0, sizeof v);
153 gtk_tree_model_get_value(model, iter, ql->ncolumns + QUEUEPOINTER_COLUMN, v);
154 assert(G_VALUE_TYPE(v) == G_TYPE_POINTER);
155 struct queue_entry *const q = g_value_get_pointer(v);
160 /** @brief Update one row of a list store
161 * @param q Queue entry
162 * @param iter Iterator referring to row or NULL to work it out
164 void ql_update_row(struct queue_entry *q,
166 const struct queuelike *const ql = q->ql;
168 D(("ql_update_row"));
169 /* If no iter was supplied, work it out */
170 GtkTreeIter my_iter[1];
172 gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store), my_iter);
173 struct queue_entry *qq;
174 for(qq = ql->q; qq && q != qq; qq = qq->next)
175 gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), my_iter);
180 /* Update all the columns */
181 for(int col = 0; col < ql->ncolumns; ++col)
182 gtk_list_store_set(ql->store, iter,
183 col, ql->columns[col].value(q,
184 ql->columns[col].data),
186 gtk_list_store_set(ql->store, iter,
187 ql->ncolumns + QUEUEPOINTER_COLUMN, q,
189 if(q == playing_track)
190 gtk_list_store_set(ql->store, iter,
191 ql->ncolumns + BACKGROUND_COLUMN, BG_PLAYING,
192 ql->ncolumns + FOREGROUND_COLUMN, FG_PLAYING,
195 gtk_list_store_set(ql->store, iter,
196 ql->ncolumns + BACKGROUND_COLUMN, (char *)0,
197 ql->ncolumns + FOREGROUND_COLUMN, (char *)0,
201 /** @brief Update the list store
202 * @param ql Queuelike to update
204 * Called when new namepart data is available (and initially). Doesn't change
205 * the rows, just updates the cell values.
207 void ql_update_list_store(struct queuelike *ql) {
208 D(("ql_update_list_store"));
210 gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store), iter);
211 for(struct queue_entry *q = ql->q; q; q = q->next) {
212 ql_update_row(q, iter);
213 gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
217 struct newqueue_data {
218 struct queue_entry *old, *new;
221 static void record_queue_map(hash *h,
223 struct queue_entry *old,
224 struct queue_entry *new) {
225 struct newqueue_data *nqd;
227 if(!(nqd = hash_find(h, id))) {
228 static const struct newqueue_data empty[1];
229 hash_add(h, id, empty, HASH_INSERT);
230 nqd = hash_find(h, id);
239 static void dump_queue(struct queue_entry *head, struct queue_entry *mark) {
240 for(struct queue_entry *q = head; q; q = q->next) {
242 fprintf(stderr, "!");
243 fprintf(stderr, "%s", q->id);
245 fprintf(stderr, " ");
247 fprintf(stderr, "\n");
250 static void dump_rows(struct queuelike *ql) {
252 gboolean it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
255 struct queue_entry *q = ql_iter_to_q(GTK_TREE_MODEL(ql->store), iter);
256 it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
257 fprintf(stderr, "%s", q->id);
259 fprintf(stderr, " ");
261 fprintf(stderr, "\n");
265 /** @brief Reset the list store
266 * @param ql Queuelike to reset
267 * @param newq New queue contents/ordering
269 * Updates the queue to match @p newq
271 void ql_new_queue(struct queuelike *ql,
272 struct queue_entry *newq) {
276 /* Tell every queue entry which queue owns it */
277 //fprintf(stderr, "%s: filling in q->ql\n", ql->name);
278 for(struct queue_entry *q = newq; q; q = q->next)
281 //fprintf(stderr, "%s: constructing h\n", ql->name);
282 /* Construct map from id to new and old structures */
283 hash *h = hash_new(sizeof(struct newqueue_data));
284 for(struct queue_entry *q = ql->q; q; q = q->next)
285 record_queue_map(h, q->id, q, NULL);
286 for(struct queue_entry *q = newq; q; q = q->next)
287 record_queue_map(h, q->id, NULL, q);
289 /* The easy bit: delete rows not present any more. In the same pass we
290 * update the secret column containing the queue_entry pointer. */
291 //fprintf(stderr, "%s: deleting rows...\n", ql->name);
293 gboolean it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
295 int inserted = 0, deleted = 0, kept = 0;
297 struct queue_entry *q = ql_iter_to_q(GTK_TREE_MODEL(ql->store), iter);
298 const struct newqueue_data *nqd = hash_find(h, q->id);
300 /* Tell this row that it belongs to the new version of the queue */
301 gtk_list_store_set(ql->store, iter,
302 ql->ncolumns + QUEUEPOINTER_COLUMN, nqd->new,
304 it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
307 /* Delete this row (and move iter to the next one) */
308 //fprintf(stderr, " delete %s", q->id);
309 it = gtk_list_store_remove(ql->store, iter);
314 /* Now every row's secret column is right, but we might be missing new rows
315 * and they might be in the wrong order */
317 /* We're going to have to support arbitrary rearrangements, so we might as
318 * well add new elements at the end. */
319 //fprintf(stderr, "%s: adding rows...\n", ql->name);
320 struct queue_entry *after = 0;
321 for(struct queue_entry *q = newq; q; q = q->next) {
322 const struct newqueue_data *nqd = hash_find(h, q->id);
325 /* Try to insert at the right sort of place */
326 GtkTreeIter where[1];
327 gboolean wit = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
329 while(wit && ql_iter_to_q(GTK_TREE_MODEL(ql->store), where) != after)
330 wit = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), where);
332 gtk_list_store_insert_after(ql->store, iter, where);
334 gtk_list_store_append(ql->store, iter);
336 gtk_list_store_prepend(ql->store, iter);
337 gtk_list_store_set(ql->store, iter,
338 ql->ncolumns + QUEUEPOINTER_COLUMN, q,
340 //fprintf(stderr, " add %s", q->id);
346 /* Now exactly the right set of rows are present, and they have the right
347 * queue_entry pointers in their secret column, but they may be in the wrong
350 * The current code is simple but amounts to a bubble-sort - we might easily
351 * called gtk_tree_model_iter_next a couple of thousand times.
353 //fprintf(stderr, "%s: rearranging rows\n", ql->name);
354 //fprintf(stderr, "%s: queue state: ", ql->name);
355 //dump_queue(newq, 0);
356 //fprintf(stderr, "%s: row state: ", ql->name);
358 it = gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql->store),
360 struct queue_entry *rq = newq; /* r for 'right, correct' */
361 int swaps = 0, searches = 0;
363 struct queue_entry *q = ql_iter_to_q(GTK_TREE_MODEL(ql->store), iter);
364 //fprintf(stderr, " rq = %p, q = %p\n", rq, q);
365 //fprintf(stderr, " rq->id = %s, q->id = %s\n", rq->id, q->id);
368 //fprintf(stderr, " mismatch\n");
369 GtkTreeIter next[1] = { *iter };
370 gboolean nit = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), next);
372 struct queue_entry *nq = ql_iter_to_q(GTK_TREE_MODEL(ql->store), next);
373 //fprintf(stderr, " candidate: %s\n", nq->id);
376 nit = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), next);
380 //fprintf(stderr, " found it\n");
381 gtk_list_store_swap(ql->store, iter, next);
383 //fprintf(stderr, "%s: new row state: ", ql->name);
387 /* ...and onto the next one */
388 it = gtk_tree_model_iter_next(GTK_TREE_MODEL(ql->store), iter);
392 fprintf(stderr, "%6s: %3d kept %3d inserted %3d deleted %3d swaps %4d searches\n", ql->name,
393 kept, inserted, deleted, swaps, searches);
395 //fprintf(stderr, "done\n");
397 /* Set the rest of the columns in new rows */
398 ql_update_list_store(ql);
402 /** @brief Initialize a @ref queuelike */
403 GtkWidget *init_queuelike(struct queuelike *ql) {
404 D(("init_queuelike"));
405 /* Create the list store. We add an extra column to hold a pointer to the
407 GType *types = xcalloc(ql->ncolumns + EXTRA_COLUMNS, sizeof (GType));
408 for(int n = 0; n < ql->ncolumns + EXTRA_COLUMNS; ++n)
409 types[n] = G_TYPE_STRING;
410 types[ql->ncolumns + QUEUEPOINTER_COLUMN] = G_TYPE_POINTER;
411 ql->store = gtk_list_store_newv(ql->ncolumns + EXTRA_COLUMNS, types);
412 g_object_set_data(G_OBJECT(ql->store), "ql", (void *)ql);
414 /* Create the view */
415 ql->view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(ql->store));
416 gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(ql->view), TRUE);
418 /* Create cell renderers and label columns */
419 for(int n = 0; n < ql->ncolumns; ++n) {
420 GtkCellRenderer *r = gtk_cell_renderer_text_new();
421 if(ql->columns[n].flags & COL_ELLIPSIZE)
422 g_object_set(r, "ellipsize", PANGO_ELLIPSIZE_END, (char *)0);
423 if(ql->columns[n].flags & COL_RIGHT)
424 g_object_set(r, "xalign", (gfloat)1.0, (char *)0);
425 GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
426 (ql->columns[n].name,
429 "background", ql->ncolumns + BACKGROUND_COLUMN,
430 "foreground", ql->ncolumns + FOREGROUND_COLUMN,
432 gtk_tree_view_column_set_resizable(c, TRUE);
433 gtk_tree_view_column_set_reorderable(c, TRUE);
434 if(ql->columns[n].flags & COL_EXPAND)
435 g_object_set(c, "expand", TRUE, (char *)0);
436 gtk_tree_view_append_column(GTK_TREE_VIEW(ql->view), c);
439 /* The selection should support multiple things being selected */
440 ql->selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(ql->view));
441 gtk_tree_selection_set_mode(ql->selection, GTK_SELECTION_MULTIPLE);
443 /* Catch button presses */
444 g_signal_connect(ql->view, "button-press-event",
445 G_CALLBACK(ql_button_release), ql);
451 /* Update display text when lookups complete */
452 event_register("lookups-completed", queue_lookups_completed, ql);
454 GtkWidget *scrolled = scroll_widget(ql->view);
455 g_object_set_data(G_OBJECT(scrolled), "type", (void *)ql_tabtype(ql));