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
, 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 /* The hidden extra column is the queue entry */
187 gtk_list_store_set(ql
->store
, iter
, ql
->ncolumns
, q
, -1);
190 /** @brief Update the list store
191 * @param ql Queuelike to update
193 * Called when new namepart data is available (and initially). Doesn't change
194 * the rows, just updates the cell values.
196 void ql_update_list_store(struct queuelike
*ql
) {
197 D(("ql_update_list_store"));
199 gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql
->store
), iter
);
200 for(struct queue_entry
*q
= ql
->q
; q
; q
= q
->next
) {
201 ql_update_row(q
, iter
);
202 gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), iter
);
206 struct newqueue_data
{
207 struct queue_entry
*old
, *new;
210 static void record_queue_map(hash
*h
,
212 struct queue_entry
*old
,
213 struct queue_entry
*new) {
214 struct newqueue_data
*nqd
;
216 if(!(nqd
= hash_find(h
, id
))) {
217 static const struct newqueue_data empty
[1];
218 hash_add(h
, id
, empty
, HASH_INSERT
);
219 nqd
= hash_find(h
, id
);
228 static void dump_queue(struct queue_entry
*head
, struct queue_entry
*mark
) {
229 for(struct queue_entry
*q
= head
; q
; q
= q
->next
) {
231 fprintf(stderr
, "!");
232 fprintf(stderr
, "%s", q
->id
);
234 fprintf(stderr
, " ");
236 fprintf(stderr
, "\n");
239 static void dump_rows(struct queuelike
*ql
) {
241 gboolean it
= gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql
->store
),
244 struct queue_entry
*q
= ql_iter_to_q(GTK_TREE_MODEL(ql
->store
), iter
);
245 it
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), iter
);
246 fprintf(stderr
, "%s", q
->id
);
248 fprintf(stderr
, " ");
250 fprintf(stderr
, "\n");
254 /** @brief Reset the list store
255 * @param ql Queuelike to reset
256 * @param newq New queue contents/ordering
258 * Updates the queue to match @p newq
260 void ql_new_queue(struct queuelike
*ql
,
261 struct queue_entry
*newq
) {
265 /* Tell every queue entry which queue owns it */
266 //fprintf(stderr, "%s: filling in q->ql\n", ql->name);
267 for(struct queue_entry
*q
= newq
; q
; q
= q
->next
)
270 //fprintf(stderr, "%s: constructing h\n", ql->name);
271 /* Construct map from id to new and old structures */
272 hash
*h
= hash_new(sizeof(struct newqueue_data
));
273 for(struct queue_entry
*q
= ql
->q
; q
; q
= q
->next
)
274 record_queue_map(h
, q
->id
, q
, NULL
);
275 for(struct queue_entry
*q
= newq
; q
; q
= q
->next
)
276 record_queue_map(h
, q
->id
, NULL
, q
);
278 /* The easy bit: delete rows not present any more. In the same pass we
279 * update the secret column containing the queue_entry pointer. */
280 //fprintf(stderr, "%s: deleting rows...\n", ql->name);
282 gboolean it
= gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql
->store
),
284 int inserted
= 0, deleted
= 0, kept
= 0;
286 struct queue_entry
*q
= ql_iter_to_q(GTK_TREE_MODEL(ql
->store
), iter
);
287 const struct newqueue_data
*nqd
= hash_find(h
, q
->id
);
289 /* Tell this row that it belongs to the new version of the queue */
290 gtk_list_store_set(ql
->store
, iter
, ql
->ncolumns
, nqd
->new, -1);
291 it
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), iter
);
294 /* Delete this row (and move iter to the next one) */
295 //fprintf(stderr, " delete %s", q->id);
296 it
= gtk_list_store_remove(ql
->store
, iter
);
301 /* Now every row's secret column is right, but we might be missing new rows
302 * and they might be in the wrong order */
304 /* We're going to have to support arbitrary rearrangements, so we might as
305 * well add new elements at the end. */
306 //fprintf(stderr, "%s: adding rows...\n", ql->name);
307 struct queue_entry
*after
= 0;
308 for(struct queue_entry
*q
= newq
; q
; q
= q
->next
) {
309 const struct newqueue_data
*nqd
= hash_find(h
, q
->id
);
313 /* Try to insert at the right sort of place */
314 GtkTreeIter where
[1];
315 gboolean wit
= gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql
->store
),
317 while(wit
&& ql_iter_to_q(GTK_TREE_MODEL(ql
->store
), where
) != after
)
318 wit
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), where
);
320 gtk_list_store_insert_after(ql
->store
, iter
, where
);
322 gtk_list_store_append(ql
->store
, iter
);
324 gtk_list_store_prepend(ql
->store
, iter
);
325 gtk_list_store_set(ql
->store
, iter
, ql
->ncolumns
, q
, -1);
326 //fprintf(stderr, " add %s", q->id);
332 /* Now exactly the right set of rows are present, and they have the right
333 * queue_entry pointers in their secret column, but they may be in the wrong
336 * The current code is simple but amounts to a bubble-sort - we might easily
337 * called gtk_tree_model_iter_next a couple of thousand times.
339 //fprintf(stderr, "%s: rearranging rows\n", ql->name);
340 //fprintf(stderr, "%s: queue state: ", ql->name);
341 //dump_queue(newq, 0);
342 //fprintf(stderr, "%s: row state: ", ql->name);
344 it
= gtk_tree_model_get_iter_first(GTK_TREE_MODEL(ql
->store
),
346 struct queue_entry
*rq
= newq
; /* r for 'right, correct' */
347 int swaps
= 0, searches
= 0;
349 struct queue_entry
*q
= ql_iter_to_q(GTK_TREE_MODEL(ql
->store
), iter
);
350 //fprintf(stderr, " rq = %p, q = %p\n", rq, q);
351 //fprintf(stderr, " rq->id = %s, q->id = %s\n", rq->id, q->id);
354 //fprintf(stderr, " mismatch\n");
355 GtkTreeIter next
[1] = { *iter
};
356 gboolean nit
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), next
);
358 struct queue_entry
*nq
= ql_iter_to_q(GTK_TREE_MODEL(ql
->store
), next
);
359 //fprintf(stderr, " candidate: %s\n", nq->id);
362 nit
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), next
);
366 //fprintf(stderr, " found it\n");
367 gtk_list_store_swap(ql
->store
, iter
, next
);
369 //fprintf(stderr, "%s: new row state: ", ql->name);
373 /* ...and onto the next one */
374 it
= gtk_tree_model_iter_next(GTK_TREE_MODEL(ql
->store
), iter
);
378 fprintf(stderr
, "%6s: %3d kept %3d inserted %3d deleted %3d swaps %4d searches\n", ql
->name
,
379 kept
, inserted
, deleted
, swaps
, searches
);
381 //fprintf(stderr, "done\n");
383 /* Set the rest of the columns in new rows */
384 ql_update_list_store(ql
);
388 /** @brief Initialize a @ref queuelike */
389 GtkWidget
*init_queuelike(struct queuelike
*ql
) {
390 D(("init_queuelike"));
391 /* Create the list store. We add an extra column to hold the ID. */
392 GType
*types
= xcalloc(ql
->ncolumns
+ 1, sizeof (GType
));
393 for(int n
= 0; n
< ql
->ncolumns
; ++n
)
394 types
[n
] = G_TYPE_STRING
;
395 types
[ql
->ncolumns
] = G_TYPE_POINTER
;
396 ql
->store
= gtk_list_store_newv(ql
->ncolumns
+ 1, types
);
397 g_object_set_data(G_OBJECT(ql
->store
), "ql", (void *)ql
);
399 /* Create the view */
400 ql
->view
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(ql
->store
));
401 gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(ql
->view
), TRUE
);
403 /* Create cell renderers and label columns */
404 for(int n
= 0; n
< ql
->ncolumns
; ++n
) {
405 GtkCellRenderer
*r
= gtk_cell_renderer_text_new();
406 if(ql
->columns
[n
].flags
& COL_ELLIPSIZE
)
407 g_object_set(r
, "ellipsize", PANGO_ELLIPSIZE_END
, (char *)0);
408 if(ql
->columns
[n
].flags
& COL_RIGHT
)
409 g_object_set(r
, "xalign", (gfloat
)1.0, (char *)0);
410 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
411 (ql
->columns
[n
].name
,
415 gtk_tree_view_column_set_resizable(c
, TRUE
);
416 gtk_tree_view_column_set_reorderable(c
, TRUE
);
417 if(ql
->columns
[n
].flags
& COL_EXPAND
)
418 g_object_set(c
, "expand", TRUE
, (char *)0);
419 gtk_tree_view_append_column(GTK_TREE_VIEW(ql
->view
), c
);
422 /* The selection should support multiple things being selected */
423 ql
->selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(ql
->view
));
424 gtk_tree_selection_set_mode(ql
->selection
, GTK_SELECTION_MULTIPLE
);
426 /* Catch button presses */
427 g_signal_connect(ql
->view
, "button-press-event",
428 G_CALLBACK(ql_button_release
), ql
);
434 /* Update display text when lookups complete */
435 event_register("lookups-completed", queue_lookups_completed
, ql
);
437 GtkWidget
*scrolled
= scroll_widget(ql
->view
);
438 g_object_set_data(G_OBJECT(scrolled
), "type", (void *)ql_tabtype(ql
));