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