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 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/choose.c
21 * @brief Hierarchical track selection and search
23 * We now use an ordinary GtkTreeStore/GtkTreeView.
25 * We don't want to pull the entire tree in memory, but we want directories to
26 * show up as having children. Therefore we give directories a placeholder
27 * child and replace their children when they are opened. Placeholders have
28 * TRACK_COLUMN="" and ISFILE_COLUMN=FALSE (so that they don't get check boxes,
31 * TODO We do a period sweep which kills contracted nodes, putting back
32 * placeholders, and updating expanded nodes to keep up with server-side
33 * changes. (We could trigger the latter off rescan complete notifications?)
36 * - sweep up contracted nodes
37 * - update when content may have changed (e.g. after a rescan)
42 #include "disobedience.h"
45 /** @brief The current selection tree */
46 GtkTreeStore
*choose_store
;
48 /** @brief The view onto the selection tree */
49 GtkWidget
*choose_view
;
51 /** @brief The selection tree's selection */
52 GtkTreeSelection
*choose_selection
;
54 /** @brief Count of file listing operations in flight */
55 static int choose_list_in_flight
;
57 /** @brief Count of files inserted in current batch of listing operations */
58 static int choose_inserted
;
60 static char *choose_get_string(GtkTreeIter
*iter
, int column
) {
62 gtk_tree_model_get(GTK_TREE_MODEL(choose_store
), iter
,
65 char *s
= xstrdup(gs
);
70 char *choose_get_track(GtkTreeIter
*iter
) {
71 char *s
= choose_get_string(iter
, TRACK_COLUMN
);
72 return *s ? s
: 0; /* Placeholder -> NULL */
75 char *choose_get_sort(GtkTreeIter
*iter
) {
76 return choose_get_string(iter
, SORT_COLUMN
);
79 int choose_is_file(GtkTreeIter
*iter
) {
81 gtk_tree_model_get(GTK_TREE_MODEL(choose_store
), iter
,
82 ISFILE_COLUMN
, &isfile
,
87 int choose_is_dir(GtkTreeIter
*iter
) {
89 gtk_tree_model_get(GTK_TREE_MODEL(choose_store
), iter
,
90 ISFILE_COLUMN
, &isfile
,
94 return !choose_is_placeholder(iter
);
97 int choose_is_placeholder(GtkTreeIter
*iter
) {
98 return choose_get_string(iter
, TRACK_COLUMN
)[0] == 0;
101 /** @brief Remove node @p it and all its children
102 * @param Iterator, updated to point to next
103 * @return True if iterator remains valid
105 static gboolean
choose_remove_node(GtkTreeIter
*it
) {
106 GtkTreeIter child
[1];
107 gboolean childv
= gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store
),
111 childv
= choose_remove_node(child
);
112 return gtk_tree_store_remove(choose_store
, it
);
115 /** @brief Update length and state fields */
116 static gboolean
choose_set_state_callback(GtkTreeModel
attribute((unused
)) *model
,
117 GtkTreePath
attribute((unused
)) *path
,
119 gpointer
attribute((unused
)) data
) {
120 if(choose_is_file(it
)) {
121 const char *track
= choose_get_track(it
);
122 const long l
= namepart_length(track
);
125 byte_snprintf(length
, sizeof length
, "%ld:%02ld", l
/ 60, l
% 60);
128 gtk_tree_store_set(choose_store
, it
,
129 LENGTH_COLUMN
, length
,
130 STATE_COLUMN
, queued(track
),
132 if(choose_is_search_result(track
))
133 gtk_tree_store_set(choose_store
, it
,
138 gtk_tree_store_set(choose_store
, it
,
139 BG_COLUMN
, (char *)0,
140 FG_COLUMN
, (char *)0,
143 return FALSE
; /* continue walking */
146 /** @brief Called when the queue or playing track change */
147 static void choose_set_state(const char attribute((unused
)) *event
,
148 void attribute((unused
)) *eventdata
,
149 void attribute((unused
)) *callbackdata
) {
150 gtk_tree_model_foreach(GTK_TREE_MODEL(choose_store
),
151 choose_set_state_callback
,
155 /** @brief (Re-)populate a node
156 * @param parent_ref Node to populate or NULL to fill root
157 * @param nvec Number of children to add
158 * @param vec Children
159 * @param files 1 if children are files, 0 if directories
161 * Adjusts the set of files (or directories) below @p parent_ref to match those
162 * listed in @p nvec and @p vec.
164 * @parent_ref will be destroyed.
166 static void choose_populate(GtkTreeRowReference
*parent_ref
,
167 int nvec
, char **vec
,
169 /* Compute parent_* */
170 GtkTreeIter pit
[1], *parent_it
;
171 GtkTreePath
*parent_path
;
173 parent_path
= gtk_tree_row_reference_get_path(parent_ref
);
175 gboolean pitv
= gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store
),
178 /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
179 choose_type_map[type],
180 gtk_tree_path_to_string(parent_path));*/
184 /*fprintf(stderr, "choose_populate %s: populating the root\n",
185 choose_type_map[type]);*/
187 /* Remove unwanted nodes and find out which we must add */
188 //fprintf(stderr, " trimming unwanted %s nodes\n", choose_type_map[type]);
189 char *found
= xmalloc(nvec
);
191 gboolean itv
= gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store
),
195 const char *track
= choose_get_track(it
);
199 /* Always kill placeholders */
200 //fprintf(stderr, " kill a placeholder\n");
202 } else if(choose_is_file(it
) == isfile
) {
203 /* This is the type we care about */
204 //fprintf(stderr, " %s is a %s\n", track, isfile ? "file" : "dir");
206 for(n
= 0; n
< nvec
&& strcmp(vec
[n
], track
); ++n
)
209 //fprintf(stderr, " ... and survives\n");
213 //fprintf(stderr, " ... and is to be removed\n");
217 /* Keep wrong-type entries */
218 //fprintf(stderr, " %s has wrong type\n", track);
222 itv
= gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store
), it
);
224 itv
= choose_remove_node(it
);
226 /* Add nodes we don't have */
228 //fprintf(stderr, " inserting new %s nodes\n", isfile ? "track" : "dir");
229 const char *typename
= isfile ?
"track" : "dir";
230 for(int n
= 0; n
< nvec
; ++n
) {
232 //fprintf(stderr, " %s was not found\n", vec[n]);
233 gtk_tree_store_append(choose_store
, it
, parent_it
);
234 gtk_tree_store_set(choose_store
, it
,
235 NAME_COLUMN
, trackname_transform(typename
,
238 ISFILE_COLUMN
, isfile
,
239 TRACK_COLUMN
, vec
[n
],
240 SORT_COLUMN
, trackname_transform(typename
,
244 /* Update length and state; we expect this to kick off length lookups
245 * rather than necessarily get the right value the first time round. */
246 choose_set_state_callback(0, 0, it
, 0);
248 /* If we inserted a directory, insert a placeholder too, so it appears to
249 * have children; it will be deleted when we expand the directory. */
251 //fprintf(stderr, " inserting a placeholder\n");
252 GtkTreeIter placeholder
[1];
254 gtk_tree_store_append(choose_store
, placeholder
, it
);
255 gtk_tree_store_set(choose_store
, placeholder
,
256 NAME_COLUMN
, "Waddling...",
258 ISFILE_COLUMN
, FALSE
,
263 //fprintf(stderr, " %d nodes inserted\n", inserted);
265 /* TODO sort the children */
268 /* If we deleted a placeholder then we must re-expand the row */
269 gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view
), parent_path
, FALSE
);
270 gtk_tree_row_reference_free(parent_ref
);
271 gtk_tree_path_free(parent_path
);
273 /* We only notify others that we've inserted tracks when there are no more
274 * insertions pending, so that they don't have to keep track of how many
275 * requests they've made. */
276 choose_inserted
+= inserted
;
277 if(--choose_list_in_flight
== 0) {
278 /* Notify interested parties that we inserted some tracks, AFTER making
279 * sure that the row is properly expanded */
280 if(choose_inserted
) {
281 event_raise("choose-inserted-tracks", parent_it
);
287 static void choose_dirs_completed(void *v
,
289 int nvec
, char **vec
) {
291 popup_protocol_error(0, error
);
294 choose_populate(v
, nvec
, vec
, 0/*!isfile*/);
297 static void choose_files_completed(void *v
,
299 int nvec
, char **vec
) {
301 popup_protocol_error(0, error
);
304 choose_populate(v
, nvec
, vec
, 1/*isfile*/);
307 void choose_play_completed(void attribute((unused
)) *v
,
310 popup_protocol_error(0, error
);
313 static void choose_state_toggled
314 (GtkCellRendererToggle
attribute((unused
)) *cell_renderer
,
316 gpointer
attribute((unused
)) user_data
) {
318 /* Identify the track */
320 gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(choose_store
),
325 if(!choose_is_file(it
))
327 const char *track
= choose_get_track(it
);
330 disorder_eclient_play(client
, track
, choose_play_completed
, 0);
334 static void choose_row_expanded(GtkTreeView
attribute((unused
)) *treeview
,
337 gpointer
attribute((unused
)) user_data
) {
338 /*fprintf(stderr, "row-expanded path=[%s]\n",
339 gtk_tree_path_to_string(path));*/
340 /* We update a node's contents whenever it is expanded, even if it was
341 * already populated; the effect is that contracting and expanding a node
342 * suffices to update it to the latest state on the server. */
343 const char *track
= choose_get_track(iter
);
344 disorder_eclient_files(client
, choose_files_completed
,
347 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
),
349 disorder_eclient_dirs(client
, choose_dirs_completed
,
352 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
),
354 /* The row references are destroyed in the _completed handlers. */
355 choose_list_in_flight
+= 2;
358 /** @brief Create the choose tab */
359 GtkWidget
*choose_widget(void) {
360 /* Create the tree store. */
361 choose_store
= gtk_tree_store_new(CHOOSE_COLUMNS
,
371 /* Create the view */
372 choose_view
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store
));
373 gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(choose_view
), TRUE
);
375 /* Create cell renderers and columns */
376 /* TODO use a table */
378 GtkCellRenderer
*r
= gtk_cell_renderer_text_new();
379 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
383 "background", BG_COLUMN
,
384 "foreground", FG_COLUMN
,
386 gtk_tree_view_column_set_resizable(c
, TRUE
);
387 gtk_tree_view_column_set_reorderable(c
, TRUE
);
388 g_object_set(c
, "expand", TRUE
, (char *)0);
389 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
392 GtkCellRenderer
*r
= gtk_cell_renderer_text_new();
393 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
396 "text", LENGTH_COLUMN
,
398 gtk_tree_view_column_set_resizable(c
, TRUE
);
399 gtk_tree_view_column_set_reorderable(c
, TRUE
);
400 g_object_set(r
, "xalign", (gfloat
)1.0, (char *)0);
401 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
404 GtkCellRenderer
*r
= gtk_cell_renderer_toggle_new();
405 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
408 "active", STATE_COLUMN
,
409 "visible", ISFILE_COLUMN
,
411 gtk_tree_view_column_set_resizable(c
, TRUE
);
412 gtk_tree_view_column_set_reorderable(c
, TRUE
);
413 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
414 g_signal_connect(r
, "toggled",
415 G_CALLBACK(choose_state_toggled
), 0);
418 /* The selection should support multiple things being selected */
419 choose_selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view
));
420 gtk_tree_selection_set_mode(choose_selection
, GTK_SELECTION_MULTIPLE
);
422 /* Catch button presses */
423 g_signal_connect(choose_view
, "button-press-event",
424 G_CALLBACK(choose_button_event
), 0);
425 g_signal_connect(choose_view
, "button-release-event",
426 G_CALLBACK(choose_button_event
), 0);
427 /* Catch row expansions so we can fill in placeholders */
428 g_signal_connect(choose_view
, "row-expanded",
429 G_CALLBACK(choose_row_expanded
), 0);
431 event_register("queue-list-changed", choose_set_state
, 0);
432 event_register("playing-track-changed", choose_set_state
, 0);
433 event_register("search-results-changed", choose_set_state
, 0);
436 disorder_eclient_files(client
, choose_files_completed
, "", NULL
, NULL
);
437 disorder_eclient_dirs(client
, choose_dirs_completed
, "", NULL
, NULL
);
439 /* Make the widget scrollable */
440 GtkWidget
*scrolled
= scroll_widget(choose_view
);
442 /* Pack vertically with the search widget */
443 GtkWidget
*vbox
= gtk_vbox_new(FALSE
/*homogenous*/, 1/*spacing*/);
444 gtk_box_pack_start(GTK_BOX(vbox
), scrolled
,
445 TRUE
/*expand*/, TRUE
/*fill*/, 0/*padding*/);
446 gtk_box_pack_end(GTK_BOX(vbox
), choose_search_widget(),
447 FALSE
/*expand*/, FALSE
/*fill*/, 0/*padding*/);
449 g_object_set_data(G_OBJECT(vbox
), "type", (void *)&choose_tabtype
);