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 have an extra column with per-row data. This isn't referenced from
26 * anywhere the GC can see so explicit memory management is required.
27 * (TODO perhaps we could fix this using a gobject?)
29 * We don't want to pull the entire tree in memory, but we want directories to
30 * show up as having children. Therefore we give directories a placeholder
31 * child and replace their children when they are opened. Placeholders have a
32 * null choosedata pointer.
34 * TODO We do a period sweep which kills contracted nodes, putting back
35 * placeholders, and updating expanded nodes to keep up with server-side
36 * changes. (We could trigger the latter off rescan complete notifications?)
39 * - sweep up contracted nodes
40 * - update when content may have changed (e.g. after a rescan)
43 * - display length of tracks
46 #include "disobedience.h"
48 /** @brief Extra data at each node */
50 /** @brief Node type */
53 /** @brief Full track or directory name */
56 /** @brief Sort key */
60 /** @brief Track name column number */
63 /** @brief Hidden column number */
64 #define CHOOSEDATA_COLUMN 1
66 /** @brief @ref choosedata node is a file */
69 /** @brief @ref choosedata node is a directory */
70 #define CHOOSE_DIRECTORY 1
72 /** @brief The current selection tree */
73 static GtkTreeStore
*choose_store
;
75 /** @brief The view onto the selection tree */
76 static GtkWidget
*choose_view
;
78 /** @brief The selection tree's selection */
79 static GtkTreeSelection
*choose_selection
;
81 /** @brief Popup menu */
82 //static GtkWidget *choose_menu;
84 /** @brief Map choosedata types to names */
85 static const char *const choose_type_map
[] = { "track", "dir" };
87 /** @brief Return the choosedata given an interator */
88 static struct choosedata
*choose_iter_to_data(GtkTreeIter
*iter
) {
90 memset(v
, 0, sizeof v
);
91 gtk_tree_model_get_value(GTK_TREE_MODEL(choose_store
), iter
, CHOOSEDATA_COLUMN
, v
);
92 assert(G_VALUE_TYPE(v
) == G_TYPE_POINTER
);
93 struct choosedata
*const cd
= g_value_get_pointer(v
);
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 struct choosedata
*cd
= choose_iter_to_data(it
);
115 return gtk_tree_store_remove(choose_store
, it
);
118 /** @brief (Re-)populate a node
119 * @param parent_ref Node to populate or NULL to fill root
120 * @param nvec Number of children to add
121 * @param vec Children
122 * @param dirs True if children are directories
124 * Adjusts the set of files (or directories) below @p parent_ref to match those
125 * listed in @p nvec and @p vec.
127 * @parent_ref will be destroyed.
129 static void choose_populate(GtkTreeRowReference
*parent_ref
,
130 int nvec
, char **vec
,
132 /* Compute parent_* */
133 GtkTreeIter pit
[1], *parent_it
;
134 GtkTreePath
*parent_path
;
136 parent_path
= gtk_tree_row_reference_get_path(parent_ref
);
138 gboolean pitv
= gtk_tree_model_get_iter(GTK_TREE_MODEL(choose_store
),
141 /*fprintf(stderr, "choose_populate %s: parent path is [%s]\n",
142 choose_type_map[type],
143 gtk_tree_path_to_string(parent_path));*/
147 /*fprintf(stderr, "choose_populate %s: populating the root\n",
148 choose_type_map[type]);*/
150 /* Remove unwanted nodes and find out which we must add */
151 //fprintf(stderr, " trimming unwanted %s nodes\n", choose_type_map[type]);
152 char *found
= xmalloc(nvec
);
154 gboolean itv
= gtk_tree_model_iter_children(GTK_TREE_MODEL(choose_store
),
158 struct choosedata
*cd
= choose_iter_to_data(it
);
162 /* Always kill placeholders */
163 //fprintf(stderr, " kill a placeholder\n");
165 } else if(cd
->type
== type
) {
166 /* This is the type we care about */
167 //fprintf(stderr, " %s is a %s\n", cd->track, choose_type_map[cd->type]);
169 for(n
= 0; n
< nvec
&& strcmp(vec
[n
], cd
->track
); ++n
)
172 //fprintf(stderr, " ... and survives\n");
176 //fprintf(stderr, " ... and is to be removed\n");
180 /* Keep wrong-type entries */
181 //fprintf(stderr, " %s is a %s\n", cd->track, choose_type_map[cd->type]);
185 itv
= gtk_tree_model_iter_next(GTK_TREE_MODEL(choose_store
), it
);
187 itv
= choose_remove_node(it
);
189 /* Add nodes we don't have */
191 //fprintf(stderr, " inserting new %s nodes\n", choose_type_map[type]);
192 for(int n
= 0; n
< nvec
; ++n
) {
194 //fprintf(stderr, " %s was not found\n", vec[n]);
195 struct choosedata
*cd
= g_malloc0(sizeof *cd
);
197 cd
->track
= g_strdup(vec
[n
]);
198 cd
->sort
= g_strdup(trackname_transform(choose_type_map
[type
],
201 gtk_tree_store_append(choose_store
, it
, parent_it
);
202 gtk_tree_store_set(choose_store
, it
,
203 NAME_COLUMN
, trackname_transform(choose_type_map
[type
],
206 CHOOSEDATA_COLUMN
, cd
,
209 /* If we inserted a directory, insert a placeholder too, so it appears to
210 * have children; it will be deleted when we expand the directory. */
211 if(type
== CHOOSE_DIRECTORY
) {
212 //fprintf(stderr, " inserting a placeholder\n");
213 GtkTreeIter placeholder
[1];
215 gtk_tree_store_append(choose_store
, placeholder
, it
);
216 gtk_tree_store_set(choose_store
, placeholder
,
217 NAME_COLUMN
, "Waddling...",
218 CHOOSEDATA_COLUMN
, (void *)0,
223 //fprintf(stderr, " %d nodes inserted\n", inserted);
225 /* TODO sort the children */
228 /* If we deleted a placeholder then we must re-expand the row */
229 gtk_tree_view_expand_row(GTK_TREE_VIEW(choose_view
), parent_path
, FALSE
);
230 gtk_tree_row_reference_free(parent_ref
);
231 gtk_tree_path_free(parent_path
);
235 static void choose_dirs_completed(void *v
,
237 int nvec
, char **vec
) {
239 popup_protocol_error(0, error
);
242 choose_populate(v
, nvec
, vec
, CHOOSE_DIRECTORY
);
245 static void choose_files_completed(void *v
,
247 int nvec
, char **vec
) {
249 popup_protocol_error(0, error
);
252 choose_populate(v
, nvec
, vec
, CHOOSE_FILE
);
255 static void choose_row_expanded(GtkTreeView
attribute((unused
)) *treeview
,
258 gpointer
attribute((unused
)) user_data
) {
259 /*fprintf(stderr, "row-expanded path=[%s]\n",
260 gtk_tree_path_to_string(path));*/
261 /* We update a node's contents whenever it is expanded, even if it was
262 * already populated; the effect is that contracting and expanding a node
263 * suffices to update it to the latest state on the server. */
264 struct choosedata
*cd
= choose_iter_to_data(iter
);
265 disorder_eclient_files(client
, choose_files_completed
,
268 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
),
270 disorder_eclient_dirs(client
, choose_dirs_completed
,
273 gtk_tree_row_reference_new(GTK_TREE_MODEL(choose_store
),
275 /* The row references are destroyed in the _completed handlers. */
278 static int choose_tab_selectall_sensitive(void attribute((unused
)) *extra
) {
282 static void choose_tab_selectall_activate(void attribute((unused
)) *extra
) {
283 gtk_tree_selection_select_all(choose_selection
);
286 static int choose_tab_selectnone_sensitive(void attribute((unused
)) *extra
) {
287 return gtk_tree_selection_count_selected_rows(choose_selection
) > 0;
290 static void choose_tab_selectnone_activate(void attribute((unused
)) *extra
) {
291 gtk_tree_selection_unselect_all(choose_selection
);
294 static int choose_tab_properties_sensitive(void attribute((unused
)) *extra
) {
298 static void choose_tab_properties_activate(void attribute((unused
)) *extra
) {
299 fprintf(stderr
, "TODO choose_tab_properties_activate\n");
302 static const struct tabtype choose_tabtype
= {
303 choose_tab_properties_sensitive
,
304 choose_tab_selectall_sensitive
,
305 choose_tab_selectnone_sensitive
,
306 choose_tab_properties_activate
,
307 choose_tab_selectall_activate
,
308 choose_tab_selectnone_activate
,
313 /** @brief Create the choose tab */
314 GtkWidget
*choose_widget(void) {
315 /* Create the tree store. */
316 choose_store
= gtk_tree_store_new(1 + CHOOSEDATA_COLUMN
,
320 /* Create the view */
321 choose_view
= gtk_tree_view_new_with_model(GTK_TREE_MODEL(choose_store
));
323 /* Create cell renderers and columns */
324 GtkCellRenderer
*r
= gtk_cell_renderer_text_new();
325 GtkTreeViewColumn
*c
= gtk_tree_view_column_new_with_attributes
330 gtk_tree_view_append_column(GTK_TREE_VIEW(choose_view
), c
);
332 /* The selection should support multiple things being selected */
333 choose_selection
= gtk_tree_view_get_selection(GTK_TREE_VIEW(choose_view
));
334 gtk_tree_selection_set_mode(choose_selection
, GTK_SELECTION_MULTIPLE
);
336 /* Catch button presses */
337 /*g_signal_connect(choose_view, "button-press-event",
338 G_CALLBACK(choose_button_release), 0);*/
339 /* Catch row expansions so we can fill in placeholders */
340 g_signal_connect(choose_view
, "row-expanded",
341 G_CALLBACK(choose_row_expanded
), 0);
344 disorder_eclient_files(client
, choose_files_completed
, "", NULL
, NULL
);
345 disorder_eclient_dirs(client
, choose_dirs_completed
, "", NULL
, NULL
);
347 /* Make the widget scrollable */
348 GtkWidget
*scrolled
= scroll_widget(choose_view
);
349 g_object_set_data(G_OBJECT(scrolled
), "type", (void *)&choose_tabtype
);