2 * This file is part of DisOrder
3 * Copyright (C) 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 3 of the License, or
8 * (at your option) any later version.
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.
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/>.
18 /** @file disobedience/choose.c
19 * @brief Hierarchical track selection and search
21 * We now use an ordinary GtkTreeStore/GtkTreeView.
23 * We don't want to pull the entire tree in memory, but we want directories to
24 * show up as having children. Therefore we give directories a placeholder
25 * child and replace their children when they are opened. Placeholders have
26 * TRACK_COLUMN="" and ISFILE_COLUMN=FALSE (so that they don't get check boxes,
30 * - sweep up contracted nodes, replacing their content with a placeholder
33 #include "disobedience.h"
35 #include "multidrag.h"
36 #include <gdk/gdkkeysyms.h>
38 /** @brief Drag types */
39 static const GtkTargetEntry choose_targets[] = {
41 (char *)"text/x-disorder-playable-tracks", /* drag type */
42 GTK_TARGET_SAME_APP|GTK_TARGET_OTHER_WIDGET, /* copying between widgets */
47 /** @brief The current selection tree */
48 GtkTreeStore *choose_store;
50 /** @brief The view onto the selection tree */
51 GtkWidget *choose_view;
53 /** @brief The selection tree's selection */
54 GtkTreeSelection *choose_selection;
56 /** @brief Count of file listing operations in flight */
57 static int choose_list_in_flight;
59 /** @brief If nonzero autocollapse column won't be set */
60 static int choose_suppress_set_autocollapse;
62 static char *choose_get_string(GtkTreeIter *iter, int column) {
64 gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
67 char *s = xstrdup(gs);
72 char *choose_get_track(GtkTreeIter *iter) {
73 char *s = choose_get_string(iter, TRACK_COLUMN);
74 return *s ? s : 0; /* Placeholder -> NULL */
77 char *choose_get_sort(GtkTreeIter *iter) {
78 return choose_get_string(iter, SORT_COLUMN);
81 char *choose_get_display(GtkTreeIter *iter) {
82 return choose_get_string(iter, NAME_COLUMN);
85 int choose_is_file(GtkTreeIter *iter) {
87 gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
88 ISFILE_COLUMN, &isfile,
93 int choose_is_dir(GtkTreeIter *iter) {
95 gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
96 ISFILE_COLUMN, &isfile,
100 return !choose_is_placeholder(iter);
103 int choose_is_placeholder(GtkTreeIter *iter) {
104 return choose_get_string(iter, TRACK_COLUMN)[0] == 0;
107 int choose_can_autocollapse(GtkTreeIter *iter) {
108 gboolean autocollapse;
109 gtk_tree_model_get(GTK_TREE_MODEL(choose_store), iter,
110 AUTOCOLLAPSE_COLUMN, &autocollapse,
115 /** @brief Remove node @p it and all its children
116 * @param it Iterator, updated to point to next
117 * @return True if iterator remains valid
119 * TODO is this necessary? gtk_tree_store_remove() does not document what
120 * happens to children.
122 static gboolean choose_remove_node(GtkTreeIter *it) {
123 GtkTreeIter child[1];
124 gboolean childv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
128 childv = choose_remove_node(child);
129 return gtk_tree_store_remove(choose_store, it);
132 /** @brief Update length and state fields */
133 static gboolean choose_set_state_callback(GtkTreeModel attribute((unused)) *model,
134 GtkTreePath attribute((unused)) *path,
136 gpointer attribute((unused)) data) {
137 if(choose_is_file(it)) {
138 const char *track = choose_get_track(it);
139 const long l = namepart_length(track);
142 byte_snprintf(length, sizeof length, "%ld:%02ld", l / 60, l % 60);
145 gtk_tree_store_set(choose_store, it,
146 LENGTH_COLUMN, length,
147 STATE_COLUMN, queued(track),
149 if(choose_is_search_result(track))
150 gtk_tree_store_set(choose_store, it,
151 BG_COLUMN, SEARCH_RESULT_BG,
152 FG_COLUMN, SEARCH_RESULT_FG,
155 gtk_tree_store_set(choose_store, it,
156 BG_COLUMN, (char *)0,
157 FG_COLUMN, (char *)0,
160 return FALSE; /* continue walking */
163 /** @brief Called when the queue or playing track change */
164 static void choose_set_state(const char attribute((unused)) *event,
165 void attribute((unused)) *eventdata,
166 void attribute((unused)) *callbackdata) {
167 gtk_tree_model_foreach(GTK_TREE_MODEL(choose_store),
168 choose_set_state_callback,
172 /** @brief (Re-)populate a node
173 * @param parent_ref Node to populate or NULL to fill root
174 * @param nvec Number of children to add
175 * @param vec Children
176 * @param isfile 1 if children are files, 0 if directories
178 * Adjusts the set of files (or directories) below @p parent_ref to match those
179 * listed in @p nvec and @p vec.
181 * @p parent_ref will be destroyed.
183 static void choose_populate(GtkTreeRowReference *parent_ref,
184 int nvec, char **vec,
186 const char *type = isfile ? "track" : "dir";
187 //fprintf(stderr, "%d new children of type %s\n", nvec, type);
190 /* Compute parent_* */
191 GtkTreeIter pit[1], *parent_it;
192 GtkTreePath *parent_path;
194 parent_path = gtk_tree_row_reference_get_path(parent_ref);
196 gboolean pitv = gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store),
199 /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
201 gtk_tree_path_to_string(parent_path));*/
205 /*fprintf(stderr, "choose_populate %s: populating the root\n",
208 /* Both td[] and the current node set are sorted so we can do a single linear
209 * pass to insert new nodes and remove unwanted ones. The total performance
210 * may be worse than linear depending on the performance of GTK+'s insert and
211 * delete operations. */
212 //fprintf(stderr, "sorting tracks\n");
213 struct tracksort_data *td = tracksort_init(nvec, vec, type);
215 gboolean itv = gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store),
218 int inserted = 0, deleted_placeholder = 0;
219 //fprintf(stderr, "inserting tracks type=%s\n", type);
220 while(nvec > 0 || itv) {
221 /*fprintf(stderr, "td[] = %s, it=%s [%s]\n",
222 nvec > 0 ? td->track : "(none)",
223 itv ? choose_get_track(it) : "(!itv)",
224 itv ? (choose_is_file(it) ? "file" : "dir") : "");*/
225 enum { INSERT, DELETE, SKIP_TREE, SKIP_BOTH } action;
226 const char *track = itv ? choose_get_track(it) : 0;
228 //fprintf(stderr, " placeholder\n");
230 ++deleted_placeholder;
231 } else if(nvec > 0 && itv) {
232 /* There's both a tree row and a td[] entry */
233 const int cmp = compare_tracks(td->sort, choose_get_sort(it),
234 td->display, choose_get_display(it),
236 //fprintf(stderr, " cmp=%d\n", cmp);
238 /* td < it, so we insert td before it */
241 /* td > it, so we must either delete it (if the same type) or skip it */
242 if(choose_is_file(it) == isfile)
247 /* td = it, so we step past both */
249 } else if(nvec > 0) {
250 /* We've reached the end of the tree rows, but new have tracks left in
252 //fprintf(stderr, " inserting\n");
255 /* We've reached the end of the new tracks from td[], but there are
256 * further tracks in the tree */
257 //fprintf(stderr, " deleting\n");
258 if(choose_is_file(it) == isfile)
266 //fprintf(stderr, " INSERT %s\n", td->track);
267 /* Insert a new row from td[] before it, or at the end if it is no longer
269 GtkTreeIter child[1];
270 gtk_tree_store_insert_before(choose_store,
272 parent_it, /* parent */
273 itv ? it : NULL); /* successor */
274 gtk_tree_store_set(choose_store, child,
275 NAME_COLUMN, td->display,
276 ISFILE_COLUMN, isfile,
277 TRACK_COLUMN, td->track,
278 SORT_COLUMN, td->sort,
279 AUTOCOLLAPSE_COLUMN, FALSE,
281 /* Update length and state; we expect this to kick off length lookups
282 * rather than necessarily get the right value the first time round. */
283 choose_set_state_callback(0, 0, child, 0);
284 /* If we inserted a directory, insert a placeholder too, so it appears to
285 * have children; it will be deleted when we expand the directory. */
287 //fprintf(stderr, " inserting a placeholder\n");
288 GtkTreeIter placeholder[1];
290 gtk_tree_store_append(choose_store, placeholder, child);
291 gtk_tree_store_set(choose_store, placeholder,
292 NAME_COLUMN, "Waddling...",
294 ISFILE_COLUMN, FALSE,
303 //fprintf(stderr, " SKIP_BOTH\n");
308 //fprintf(stderr, " SKIP_TREE\n");
309 itv = gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store), it);
312 //fprintf(stderr, " DELETE\n");
313 itv = choose_remove_node(it);
317 /*fprintf(stderr, "inserted=%d deleted_placeholder=%d\n\n",
318 inserted, deleted_placeholder);*/
320 /* If we deleted a placeholder then we must re-expand the row */
321 if(deleted_placeholder) {
322 ++choose_suppress_set_autocollapse;
323 gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view), parent_path, FALSE);
324 --choose_suppress_set_autocollapse;
326 gtk_tree_row_reference_free(parent_ref);
327 gtk_tree_path_free(parent_path);
330 /* We only notify others that we've inserted tracks when there are no more
331 * insertions pending, so that they don't have to keep track of how many
332 * requests they've made. */
333 if(--choose_list_in_flight == 0) {
334 /* Notify interested parties that we inserted some tracks, AFTER making
335 * sure that the row is properly expanded */
336 //fprintf(stderr, "raising choose-more-tracks\n");
337 event_raise("choose-more-tracks", 0);
339 //fprintf(stderr, "choose_list_in_flight -> %d-\n", choose_list_in_flight);
342 static void choose_dirs_completed(void *v,
344 int nvec, char **vec) {
346 popup_protocol_error(0, err);
349 choose_populate(v, nvec, vec, 0/*!isfile*/);
352 static void choose_files_completed(void *v,
354 int nvec, char **vec) {
356 popup_protocol_error(0, err);
359 choose_populate(v, nvec, vec, 1/*isfile*/);
362 void choose_play_completed(void attribute((unused)) *v,
365 popup_protocol_error(0, err);
368 static void choose_state_toggled
369 (GtkCellRendererToggle attribute((unused)) *cell_renderer,
371 gpointer attribute((unused)) user_data) {
373 /* Identify the track */
375 gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(choose_store),
380 if(!choose_is_file(it))
382 const char *track = choose_get_track(it);
385 disorder_eclient_play(client, track, choose_play_completed, 0);
389 /** @brief (Re-)get the children of @p path
390 * @param path Path to target row
391 * @param iter Iterator pointing at target row
393 * Called from choose_row_expanded() to make sure that the contents are present
394 * and from choose_refill_callback() to (re-)synchronize.
396 static void choose_refill_row(GtkTreePath *path,
398 const char *track = choose_get_track(iter);
399 disorder_eclient_files(client, choose_files_completed,
402 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
404 disorder_eclient_dirs(client, choose_dirs_completed,
407 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store),
409 /* The row references are destroyed in the _completed handlers. */
410 choose_list_in_flight += 2;
413 static void choose_row_expanded(GtkTreeView attribute((unused)) *treeview,
416 gpointer attribute((unused)) user_data) {
417 /*fprintf(stderr, "row-expanded path=[%s]\n\n",
418 gtk_tree_path_to_string(path));*/
419 /* We update a node's contents whenever it is expanded, even if it was
420 * already populated; the effect is that contracting and expanding a node
421 * suffices to update it to the latest state on the server. */
422 choose_refill_row(path, iter);
423 if(!choose_suppress_set_autocollapse) {
424 if(choose_auto_expanding) {
425 /* This was an automatic expansion; mark it the row for auto-collapse. */
426 gtk_tree_store_set(choose_store, iter,
427 AUTOCOLLAPSE_COLUMN, TRUE,
429 /*fprintf(stderr, "enable auto-collapse for %s\n",
430 gtk_tree_path_to_string(path));*/
432 /* This was a manual expansion. Inhibit automatic collapse on this row
433 * and all its ancestors. */
436 gtk_tree_store_set(choose_store, iter,
437 AUTOCOLLAPSE_COLUMN, FALSE,
439 /*fprintf(stderr, "suppress auto-collapse for %s\n",
440 gtk_tree_model_get_string_from_iter(GTK_TREE_MODEL(choose_store),
442 GtkTreeIter child = *iter;
443 itv = gtk_tree_model_iter_parent(GTK_TREE_MODEL(choose_store),
447 /* The effect of this is that if you expand a row that's actually a
448 * sibling of the real target of the auto-expansion, it stays expanded
449 * when you clear a search. That's find and good, but it _still_ stays
450 * expanded if you expand it and then collapse it.
452 * An alternative policy would be to only auto-collapse rows that don't
453 * have any expanded children (apart from ones also subject to
454 * auto-collapse). I'm not sure what the most usable policy is.
460 static void choose_auto_collapse_callback(GtkTreeView *tree_view,
462 gpointer attribute((unused)) user_data) {
465 gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store), it, path);
466 if(choose_can_autocollapse(it)) {
467 /*fprintf(stderr, "collapse %s\n",
468 gtk_tree_path_to_string(path));*/
469 gtk_tree_store_set(choose_store, it,
470 AUTOCOLLAPSE_COLUMN, FALSE,
472 gtk_tree_view_collapse_row(tree_view, path);
476 /** @brief Perform automatic collapse after a search is cleared */
477 void choose_auto_collapse(void) {
478 gtk_tree_view_map_expanded_rows(GTK_TREE_VIEW(choose_view),
479 choose_auto_collapse_callback,
483 /** @brief Called from choose_refill() with each expanded row */
484 static void choose_refill_callback(GtkTreeView attribute((unused)) *tree_view,
486 gpointer attribute((unused)) user_data) {
489 gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store), it, path);
490 choose_refill_row(path, it);
493 /** @brief Synchronize all visible data with the server
495 * Called at startup, when a rescan completes, and via periodic_slow().
497 static void choose_refill(const char attribute((unused)) *event,
498 void attribute((unused)) *eventdata,
499 void attribute((unused)) *callbackdata) {
500 //fprintf(stderr, "choose_refill\n");
501 /* Update the root */
502 disorder_eclient_files(client, choose_files_completed, "", NULL, NULL);
503 disorder_eclient_dirs(client, choose_dirs_completed, "", NULL, NULL);
504 choose_list_in_flight += 2;
505 /* Update all expanded rows */
506 gtk_tree_view_map_expanded_rows(GTK_TREE_VIEW(choose_view),
507 choose_refill_callback,
509 //fprintf(stderr, "choose_list_in_flight -> %d+\n", choose_list_in_flight);
512 /** @brief Called for key-*-event on the main view
514 static gboolean choose_key_event(GtkWidget attribute((unused)) *widget,
516 gpointer user_data) {
517 /*fprintf(stderr, "choose_key_event type=%d state=%#x keyval=%#x\n",
518 event->type, event->state, event->keyval);*/
519 switch(event->keyval) {
526 return FALSE; /* We'll take these */
528 /* ^F is expected to start a search. We implement this by focusing the
529 * search entry box. */
530 if((event->state & ~(GDK_LOCK_MASK|GDK_SHIFT_MASK)) == GDK_CONTROL_MASK
531 && event->type == GDK_KEY_PRESS) {
533 return TRUE; /* Handled it */
537 /* ^G is expected to go the next match. We simulate a click on the 'next'
539 if((event->state & ~(GDK_LOCK_MASK|GDK_SHIFT_MASK)) == GDK_CONTROL_MASK
540 && event->type == GDK_KEY_PRESS) {
541 choose_next_clicked(0, 0);
542 return TRUE; /* Handled it */
546 /* Anything not handled we redirected to the search entry field */
547 gtk_widget_event(user_data, (GdkEvent *)event);
548 return TRUE; /* Handled it */
551 static gboolean choose_multidrag_predicate(GtkTreePath attribute((unused)) *path,
553 return choose_is_file(iter);
557 /** @brief Callback to add selected tracks to the selection data
559 * Called from choose_drag_data_get().
561 static void choose_drag_data_get_collect(GtkTreeModel attribute((unused)) *model,
562 GtkTreePath attribute((unused)) *path,
565 struct dynstr *const result = data;
567 if(choose_is_file(iter)) { /* no diretories */
568 dynstr_append_string(result, ""); /* no ID */
569 dynstr_append(result, '\n');
570 dynstr_append_string(result, choose_get_track(iter));
571 dynstr_append(result, '\n');
575 /** @brief Called to extract the dragged data from the choose view
576 * @param w Source widget (the tree view)
577 * @param dc Drag context
578 * @param data Where to put the answer
579 * @param info_ Target @c info parameter
580 * @param time_ Time data requested (for some reason not a @c time_t)
581 * @param user_data The queuelike
583 * Closely analogous to ql_drag_data_get(), and uses the same data format.
584 * IDs are sent as empty strings.
586 static void choose_drag_data_get(GtkWidget *w,
587 GdkDragContext attribute((unused)) *dc,
588 GtkSelectionData *data,
589 guint attribute((unused)) info_,
590 guint attribute((unused)) time_,
591 gpointer attribute((unused)) user_data) {
592 struct dynstr result[1];
593 GtkTreeSelection *sel;
595 sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(w));
597 gtk_tree_selection_selected_foreach(sel,
598 choose_drag_data_get_collect,
600 gtk_selection_data_set(data,
602 8, (guchar *)result->vec, result->nvec);
605 /** @brief Create the choose tab */
606 GtkWidget *choose_widget(void) {
607 /* Create the tree store. */
608 choose_store = gtk_tree_store_new(CHOOSE_COLUMNS,
619 /* Create the view */
620 choose_view = gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store));
621 gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(choose_view), TRUE);
622 /* Suppress built-in typeahead find, we do our own search support. */
623 gtk_tree_view_set_enable_search(GTK_TREE_VIEW(choose_view), FALSE);
625 /* Create cell renderers and columns */
626 /* TODO use a table */
628 GtkCellRenderer *r = gtk_cell_renderer_toggle_new();
629 GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
632 "active", STATE_COLUMN,
633 "visible", ISFILE_COLUMN,
635 gtk_tree_view_column_set_resizable(c, TRUE);
636 gtk_tree_view_column_set_reorderable(c, TRUE);
637 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
638 g_signal_connect(r, "toggled",
639 G_CALLBACK(choose_state_toggled), 0);
642 GtkCellRenderer *r = gtk_cell_renderer_text_new();
643 GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
646 "text", LENGTH_COLUMN,
648 gtk_tree_view_column_set_resizable(c, TRUE);
649 gtk_tree_view_column_set_reorderable(c, TRUE);
650 g_object_set(r, "xalign", (gfloat)1.0, (char *)0);
651 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
654 GtkCellRenderer *r = gtk_cell_renderer_text_new();
655 GtkTreeViewColumn *c = gtk_tree_view_column_new_with_attributes
659 "background", BG_COLUMN,
660 "foreground", FG_COLUMN,
662 gtk_tree_view_column_set_resizable(c, TRUE);
663 gtk_tree_view_column_set_reorderable(c, TRUE);
664 g_object_set(c, "expand", TRUE, (char *)0);
665 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view), c);
666 gtk_tree_view_set_expander_column(GTK_TREE_VIEW(choose_view), c);
669 /* The selection should support multiple things being selected */
670 choose_selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view));
671 gtk_tree_selection_set_mode(choose_selection, GTK_SELECTION_MULTIPLE);
673 /* Catch button presses */
674 g_signal_connect(choose_view, "button-press-event",
675 G_CALLBACK(choose_button_event), 0);
676 g_signal_connect(choose_view, "button-release-event",
677 G_CALLBACK(choose_button_event), 0);
678 /* Catch row expansions so we can fill in placeholders */
679 g_signal_connect(choose_view, "row-expanded",
680 G_CALLBACK(choose_row_expanded), 0);
682 event_register("queue-list-changed", choose_set_state, 0);
683 event_register("playing-track-changed", choose_set_state, 0);
684 event_register("search-results-changed", choose_set_state, 0);
685 event_register("lookups-completed", choose_set_state, 0);
686 event_register("choose-more-tracks", choose_menu_moretracks, 0);
688 /* After a rescan we update the choose tree. We get a rescan-complete
689 * automatically at startup and upon connection too. */
690 event_register("rescan-complete", choose_refill, 0);
692 /* Make the widget scrollable */
693 GtkWidget *scrolled = scroll_widget(choose_view);
695 /* Pack vertically with the search widget */
696 GtkWidget *vbox = gtk_vbox_new(FALSE/*homogenous*/, 1/*spacing*/);
697 gtk_box_pack_start(GTK_BOX(vbox), scrolled,
698 TRUE/*expand*/, TRUE/*fill*/, 0/*padding*/);
699 gtk_box_pack_end(GTK_BOX(vbox), choose_search_widget(),
700 FALSE/*expand*/, FALSE/*fill*/, 0/*padding*/);
702 g_object_set_data(G_OBJECT(vbox), "type", (void *)&choose_tabtype);
704 /* Redirect keyboard activity to the search widget */
705 g_signal_connect(choose_view, "key-press-event",
706 G_CALLBACK(choose_key_event), choose_search_entry);
707 g_signal_connect(choose_view, "key-release-event",
708 G_CALLBACK(choose_key_event), choose_search_entry);
710 /* Enable dragging of tracks out */
711 gtk_drag_source_set(choose_view,
714 sizeof choose_targets / sizeof *choose_targets,
716 g_signal_connect(choose_view, "drag-data-get",
717 G_CALLBACK(choose_drag_data_get), NULL);
718 make_treeview_multidrag(choose_view,
719 choose_multidrag_predicate);