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 Map choosedata types to names */
55 static const char *const choose_type_map
[] = { "track", "dir" };
57 static char *choose_get_string(GtkTreeIter
*iter
, int column
) {
59 gtk_tree_model_get(GTK_TREE_MODEL(choose_store
), iter
,
62 char *s
= xstrdup(gs
);
67 char *choose_get_track(GtkTreeIter
*iter
) {
68 char *s
= choose_get_string(iter
, TRACK_COLUMN
);
69 return *s ? s
: 0; /* Placeholder -> NULL */
72 char *choose_get_sort(GtkTreeIter
*iter
) {
73 return choose_get_string(iter
, SORT_COLUMN
);
76 int choose_is_file(GtkTreeIter
*iter
) {
78 gtk_tree_model_get(GTK_TREE_MODEL(choose_store
), iter
,
79 ISFILE_COLUMN
, &isfile
,
84 int choose_is_dir(GtkTreeIter
*iter
) {
86 gtk_tree_model_get(GTK_TREE_MODEL(choose_store
), iter
,
87 ISFILE_COLUMN
, &isfile
,
91 return !choose_is_placeholder(iter
);
94 int choose_is_placeholder(GtkTreeIter
*iter
) {
95 return choose_get_string(iter
, TRACK_COLUMN
)[0] == 0;
98 /** @brief Remove node @p it and all its children
99 * @param Iterator, updated to point to next
100 * @return True if iterator remains valid
102 static gboolean
choose_remove_node(GtkTreeIter
*it
) {
103 GtkTreeIter child
[1];
104 gboolean childv
= gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store
),
108 childv
= choose_remove_node(child
);
109 return gtk_tree_store_remove(choose_store
, it
);
112 /** @brief Update length and state fields */
113 static gboolean
choose_set_state_callback(GtkTreeModel
attribute((unused
)) *model
,
114 GtkTreePath
attribute((unused
)) *path
,
116 gpointer
attribute((unused
)) data
) {
117 if(choose_is_file(it
)) {
118 const char *track
= choose_get_track(it
);
119 const long l
= namepart_length(track
);
122 byte_snprintf(length
, sizeof length
, "%ld:%02ld", l
/ 60, l
% 60);
125 gtk_tree_store_set(choose_store
, it
,
126 LENGTH_COLUMN
, length
,
127 STATE_COLUMN
, queued(track
),
130 return FALSE
; /* continue walking */
133 /** @brief Called when the queue or playing track change */
134 static void choose_set_state(const char attribute((unused
)) *event
,
135 void attribute((unused
)) *eventdata
,
136 void attribute((unused
)) *callbackdata
) {
137 gtk_tree_model_foreach(GTK_TREE_MODEL(choose_store
),
138 choose_set_state_callback
,
142 /** @brief (Re-)populate a node
143 * @param parent_ref Node to populate or NULL to fill root
144 * @param nvec Number of children to add
145 * @param vec Children
146 * @param files 1 if children are files, 0 if directories
148 * Adjusts the set of files (or directories) below @p parent_ref to match those
149 * listed in @p nvec and @p vec.
151 * @parent_ref will be destroyed.
153 static void choose_populate(GtkTreeRowReference
*parent_ref
,
154 int nvec
, char **vec
,
156 /* Compute parent_* */
157 GtkTreeIter pit
[1], *parent_it
;
158 GtkTreePath
*parent_path
;
160 parent_path
= gtk_tree_row_reference_get_path(parent_ref
);
162 gboolean pitv
= gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store
),
165 /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
166 choose_type_map[type],
167 gtk_tree_path_to_string(parent_path));*/
171 /*fprintf(stderr, "choose_populate %s: populating the root\n",
172 choose_type_map[type]);*/
174 /* Remove unwanted nodes and find out which we must add */
175 //fprintf(stderr, " trimming unwanted %s nodes\n", choose_type_map[type]);
176 char *found
= xmalloc(nvec
);
178 gboolean itv
= gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store
),
182 const char *track
= choose_get_track(it
);
186 /* Always kill placeholders */
187 //fprintf(stderr, " kill a placeholder\n");
189 } else if(choose_is_file(it
) == isfile
) {
190 /* This is the type we care about */
191 //fprintf(stderr, " %s is a %s\n", track, isfile ? "file" : "dir");
193 for(n
= 0; n
< nvec
&& strcmp(vec
[n
], track
); ++n
)
196 //fprintf(stderr, " ... and survives\n");
200 //fprintf(stderr, " ... and is to be removed\n");
204 /* Keep wrong-type entries */
205 //fprintf(stderr, " %s has wrong type\n", track);
209 itv
= gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store
), it
);
211 itv
= choose_remove_node(it
);
213 /* Add nodes we don't have */
215 //fprintf(stderr, " inserting new %s nodes\n", choose_type_map[type]);
216 const char *typename
= isfile ?
"track" : "dir";
217 for(int n
= 0; n
< nvec
; ++n
) {
219 //fprintf(stderr, " %s was not found\n", vec[n]);
220 gtk_tree_store_append(choose_store
, it
, parent_it
);
221 gtk_tree_store_set(choose_store
, it
,
222 NAME_COLUMN
, trackname_transform(typename
,
225 ISFILE_COLUMN
, isfile
,
226 TRACK_COLUMN
, vec
[n
],
227 SORT_COLUMN
, trackname_transform(typename
,
231 /* Update length and state; we expect this to kick off length lookups
232 * rather than necessarily get the right value the first time round. */
233 choose_set_state_callback(0, 0, it
, 0);
235 /* If we inserted a directory, insert a placeholder too, so it appears to
236 * have children; it will be deleted when we expand the directory. */
238 //fprintf(stderr, " inserting a placeholder\n");
239 GtkTreeIter placeholder
[1];
241 gtk_tree_store_append(choose_store
, placeholder
, it
);
242 gtk_tree_store_set(choose_store
, placeholder
,
243 NAME_COLUMN
, "Waddling...",
245 ISFILE_COLUMN
, FALSE
,
250 //fprintf(stderr, " %d nodes inserted\n", inserted);
252 /* TODO sort the children */
255 /* If we deleted a placeholder then we must re-expand the row */
256 gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view
), parent_path
, FALSE
);
257 gtk_tree_row_reference_free(parent_ref
);
258 gtk_tree_path_free(parent_path
);
262 static void choose_dirs_completed(void *v
,
264 int nvec
, char **vec
) {
266 popup_protocol_error(0, error
);
269 choose_populate(v
, nvec
, vec
, 0/*!isfile*/);
272 static void choose_files_completed(void *v
,
274 int nvec
, char **vec
) {
276 popup_protocol_error(0, error
);
279 choose_populate(v
, nvec
, vec
, 1/*isfile*/);
282 void choose_play_completed(void attribute((unused
)) *v
,
285 popup_protocol_error(0, error
);
288 static void choose_state_toggled
289 (GtkCellRendererToggle
attribute((unused
)) *cell_renderer
,
291 gpointer
attribute((unused
)) user_data
) {
293 /* Identify the track */
295 gtk_tree_model_get_iter_from_string(GTK_TREE_MODEL(choose_store
),
300 if(!choose_is_file(it
))
302 const char *track
= choose_get_track(it
);
305 disorder_eclient_play(client
, track
, choose_play_completed
, 0);
309 static void choose_row_expanded(GtkTreeView
attribute((unused
)) *treeview
,
312 gpointer
attribute((unused
)) user_data
) {
313 /*fprintf(stderr, "row-expanded path=[%s]\n",
314 gtk_tree_path_to_string(path));*/
315 /* We update a node's contents whenever it is expanded, even if it was
316 * already populated; the effect is that contracting and expanding a node
317 * suffices to update it to the latest state on the server. */
318 const char *track
= choose_get_track(iter
);
319 disorder_eclient_files(client
, choose_files_completed
,
322 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
),
324 disorder_eclient_dirs(client
, choose_dirs_completed
,
327 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
),
329 /* The row references are destroyed in the _completed handlers. */
332 /** @brief Create the choose tab */
333 GtkWidget
*choose_widget(void) {
334 /* Create the tree store. */
335 choose_store
= gtk_tree_store_new(CHOOSE_COLUMNS
,
343 /* Create the view */
344 choose_view
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store
));
345 gtk_tree_view_set_rules_hint(GTK_TREE_VIEW(choose_view
), TRUE
);
347 /* Create cell renderers and columns */
348 /* TODO use a table */
350 GtkCellRenderer
*r
= gtk_cell_renderer_text_new();
351 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
356 gtk_tree_view_column_set_resizable(c
, TRUE
);
357 gtk_tree_view_column_set_reorderable(c
, TRUE
);
358 g_object_set(c
, "expand", TRUE
, (char *)0);
359 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
362 GtkCellRenderer
*r
= gtk_cell_renderer_text_new();
363 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
366 "text", LENGTH_COLUMN
,
368 gtk_tree_view_column_set_resizable(c
, TRUE
);
369 gtk_tree_view_column_set_reorderable(c
, TRUE
);
370 g_object_set(r
, "xalign", (gfloat
)1.0, (char *)0);
371 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
374 GtkCellRenderer
*r
= gtk_cell_renderer_toggle_new();
375 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
378 "active", STATE_COLUMN
,
379 "visible", ISFILE_COLUMN
,
381 gtk_tree_view_column_set_resizable(c
, TRUE
);
382 gtk_tree_view_column_set_reorderable(c
, TRUE
);
383 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
384 g_signal_connect(r
, "toggled",
385 G_CALLBACK(choose_state_toggled
), 0);
388 /* The selection should support multiple things being selected */
389 choose_selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view
));
390 gtk_tree_selection_set_mode(choose_selection
, GTK_SELECTION_MULTIPLE
);
392 /* Catch button presses */
393 g_signal_connect(choose_view
, "button-press-event",
394 G_CALLBACK(choose_button_event
), 0);
395 g_signal_connect(choose_view
, "button-release-event",
396 G_CALLBACK(choose_button_event
), 0);
397 /* Catch row expansions so we can fill in placeholders */
398 g_signal_connect(choose_view
, "row-expanded",
399 G_CALLBACK(choose_row_expanded
), 0);
401 event_register("queue-list-changed", choose_set_state
, 0);
402 event_register("playing-track-changed", choose_set_state
, 0);
405 disorder_eclient_files(client
, choose_files_completed
, "", NULL
, NULL
);
406 disorder_eclient_dirs(client
, choose_dirs_completed
, "", NULL
, NULL
);
408 /* Make the widget scrollable */
409 GtkWidget
*scrolled
= scroll_widget(choose_view
);
410 g_object_set_data(G_OBJECT(scrolled
), "type", (void *)&choose_tabtype
);