2 * This file is part of DisOrder.
3 * Copyright (C) 2006 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
21 #include "disobedience.h"
23 /* Track properties -------------------------------------------------------- */
27 static void kickoff_namepart(struct prefdata *f);
28 static void completed_namepart(struct prefdata *f);
29 static const char *get_edited_namepart(struct prefdata *f);
30 static void set_edited_namepart(struct prefdata *f, const char *value);
31 static void set_namepart(struct prefdata *f, const char *value);
32 static void set_namepart_completed(void *v);
34 static void kickoff_string(struct prefdata *f);
35 static void completed_string(struct prefdata *f);
36 static const char *get_edited_string(struct prefdata *f);
37 static void set_edited_string(struct prefdata *f, const char *value);
38 static void set_string(struct prefdata *f, const char *value);
40 static void kickoff_boolean(struct prefdata *f);
41 static void completed_boolean(struct prefdata *f);
42 static const char *get_edited_boolean(struct prefdata *f);
43 static void set_edited_boolean(struct prefdata *f, const char *value);
44 static void set_boolean(struct prefdata *f, const char *value);
46 static void prefdata_completed(void *v, const char *value);
47 static void prefdata_onerror(struct callbackdata *cbd,
50 static struct callbackdata *make_callbackdata(struct prefdata *f);
51 static void prefdata_completed_common(struct prefdata *f,
54 static void properties_ok(GtkButton *button, gpointer userdata);
55 static void properties_apply(GtkButton *button, gpointer userdata);
56 static void properties_cancel(GtkButton *button, gpointer userdata);
58 /** @brief Data for a single preference */
62 const struct pref *p; /**< @brief kind of preference */
63 const char *value; /**< @brief value from server */
67 /* The type of a preference is the collection of callbacks needed to get,
68 * display and set it */
70 void (*kickoff)(struct prefdata *f);
71 /* Kick off the request to fetch the pref from the server. */
73 void (*completed)(struct prefdata *f);
74 /* Called when the value comes back in; creates the widget. */
76 const char *(*get_edited)(struct prefdata *f);
77 /* Get the edited value from the widget. */
79 /** @brief Update the edited value */
80 void (*set_edited)(struct prefdata *f, const char *value);
82 void (*set)(struct prefdata *f, const char *value);
83 /* Set the new value and (if necessary) arrange for our display to update. */
87 static const struct preftype preftype_namepart = {
96 static const struct preftype preftype_string = {
105 static const struct preftype preftype_boolean = {
113 /* @brief The known prefs for each track */
114 static const struct pref {
115 const char *label; /**< @brief user-level description */
116 const char *part; /**< @brief protocol-level tag */
117 const char *default_value; /**< @brief default value or NULL */
118 const struct preftype *type; /**< @brief underlying data type */
120 { "Artist", "artist", 0, &preftype_namepart },
121 { "Album", "album", 0, &preftype_namepart },
122 { "Title", "title", 0, &preftype_namepart },
123 { "Tags", "tags", "", &preftype_string },
124 { "Random", "pick_at_random", "1", &preftype_boolean },
127 #define NPREFS (int)(sizeof prefs / sizeof *prefs)
129 /* Buttons that appear at the bottom of the window */
130 static const struct button {
132 void (*clicked)(GtkButton *button, gpointer userdata);
138 "Apply all changes and close window"
143 "Apply all changes and keep window open"
148 "Discard all changes and close window"
152 #define NBUTTONS (int)(sizeof buttons / sizeof *buttons)
154 static int prefs_unfilled; /* Prefs remaining to get */
155 static int prefs_total; /* Total prefs */
156 static struct prefdata *prefdatas; /* Current prefdatas */
157 static GtkWidget *properties_window;
158 static GtkWidget *properties_table;
159 static GtkWidget *progress_window, *progress_bar;
161 static void propagate_clicked(GtkButton attribute((unused)) *button,
163 struct prefdata *f = (struct prefdata *)userdata, *g;
165 const char *value = f->p->type->get_edited(f);
167 for(p = 0; p < prefs_total; ++p) {
169 if(f->p == g->p && f != g)
170 g->p->type->set_edited(g, value);
174 void properties(int ntracks, const char **tracks) {
177 GtkWidget *hbox, *vbox, *button, *label, *entry, *propagate, *content;
180 /* If no tracks, do nothign */
183 /* If there is a properties window open then just bring it to the
184 * front. It might not have the right values in... */
185 if(properties_window) {
187 gtk_window_present(GTK_WINDOW(properties_window));
190 assert(properties_table == 0);
191 if(ntracks > INT_MAX / NPREFS) {
192 popup_error("Too many tracks selected");
195 /* Create a new properties window */
196 properties_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
197 g_signal_connect(properties_window, "destroy",
198 G_CALLBACK(gtk_widget_destroyed), &properties_window);
199 /* Most of the action is the table of preferences */
200 properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1,
202 g_signal_connect(properties_table, "destroy",
203 G_CALLBACK(gtk_widget_destroyed), &properties_table);
204 gtk_window_set_title(GTK_WINDOW(properties_window), "Track Properties");
205 /* Create labels for each pref of each track and kick off requests to the
206 * server to fill in the values */
207 prefs_total = NPREFS * ntracks;
208 prefdatas = xcalloc(prefs_total, sizeof *prefdatas);
209 for(n = 0; n < ntracks; ++n) {
210 /* The track itself */
212 label = gtk_label_new("Track");
213 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
214 gtk_table_attach(GTK_TABLE(properties_table),
217 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
221 entry = gtk_entry_new();
222 gtk_entry_set_text(GTK_ENTRY(entry), tracks[n]);
223 gtk_editable_set_editable(GTK_EDITABLE(entry), FALSE);
224 gtk_table_attach(GTK_TABLE(properties_table),
227 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
228 GTK_EXPAND|GTK_FILL, 0,
230 /* Each preference */
231 for(m = 0; m < NPREFS; ++m) {
233 label = gtk_label_new(prefs[m].label);
234 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
235 gtk_table_attach(GTK_TABLE(properties_table),
238 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
239 GTK_FILL/*xoptions*/, 0/*yoptions*/,
241 /* Editing the preference is specific */
242 f = &prefdatas[NPREFS * n + m];
243 f->track = tracks[n];
244 f->row = (NPREFS + 1) * n + 1 + m;
246 prefs[m].type->kickoff(f);
248 /* Propagation button */
249 propagate = gtk_button_new();
250 if((pb = find_image("propagate.png")))
251 content = gtk_image_new_from_pixbuf(pb);
253 content = gtk_label_new("propagate.png");
254 gtk_container_add(GTK_CONTAINER(propagate), content);
255 gtk_tooltips_set_tip(tips, propagate, "Copy to other tracks", "");
256 g_signal_connect(G_OBJECT(propagate), "clicked",
257 G_CALLBACK(propagate_clicked), f);
258 gtk_table_attach(GTK_TABLE(properties_table),
260 2/*left*/, 3/*right*/,
261 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
262 GTK_FILL/*xoptions*/, 0/*yoptions*/,
263 1/*xpadding*/, 1/*ypadding*/);
267 prefs_unfilled = prefs_total;
269 hbox = gtk_hbox_new(FALSE, 1);
270 for(n = 0; n < NBUTTONS; ++n) {
271 button = gtk_button_new_from_stock(buttons[n].stock);
272 g_signal_connect(G_OBJECT(button), "clicked",
273 G_CALLBACK(buttons[n].clicked), 0);
274 gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 1);
275 gtk_tooltips_set_tip(tips, button, buttons[n].tip, "");
277 /* Put it all together */
278 vbox = gtk_vbox_new(FALSE, 1);
279 gtk_box_pack_start(GTK_BOX(vbox),
280 scroll_widget(properties_table,
283 gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 1);
284 gtk_container_add(GTK_CONTAINER(properties_window), vbox);
285 /* The table only really wants to be vertically scrollable */
286 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table)->parent->parent),
288 GTK_POLICY_AUTOMATIC);
289 /* Pop up a progress bar while we're waiting */
290 progress_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
291 g_signal_connect(progress_window, "destroy",
292 G_CALLBACK(gtk_widget_destroyed), &progress_window);
293 gtk_window_set_default_size(GTK_WINDOW(progress_window), 360, -1);
294 gtk_window_set_title(GTK_WINDOW(progress_window),
295 "Fetching Track Properties");
296 progress_bar = gtk_progress_bar_new();
297 gtk_container_add(GTK_CONTAINER(progress_window), progress_bar);
298 gtk_widget_show_all(progress_window);
301 /* Everything is filled in now */
302 static void prefdata_alldone(void) {
304 gtk_widget_destroy(progress_window);
305 /* Default size may be too small */
306 gtk_window_set_default_size(GTK_WINDOW(properties_window), 480, 512);
307 /* TODO: relate default size to required size more closely */
308 gtk_widget_show_all(properties_window);
311 /* Namepart preferences ---------------------------------------------------- */
313 static void kickoff_namepart(struct prefdata *f) {
314 /* We ask for the display name part. This is a bit bizarre if what we really
315 * wanted was the underlying preference, but in fact it should always match
316 * and will supply a sane default without having to know how to parse tracks
317 * names (which implies knowing collection roots). */
318 disorder_eclient_namepart(client, prefdata_completed, f->track, "display", f->p->part,
319 make_callbackdata(f));
322 static void completed_namepart(struct prefdata *f) {
327 f->widget = gtk_entry_new();
330 static const char *get_edited_namepart(struct prefdata *f) {
331 return gtk_entry_get_text(GTK_ENTRY(f->widget));
334 static void set_edited_namepart(struct prefdata *f, const char *value) {
335 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
338 static void set_namepart(struct prefdata *f, const char *value) {
340 struct callbackdata *cbd = xmalloc(sizeof *cbd);
343 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
344 /* We don't know what the default is so can never unset. This is a bug
345 * relative to the original design, which is supposed to only ever allow for
346 * non-trivial namepart preferences. I suppose the server could spot a
347 * default being set and translate it into an unset. */
348 disorder_eclient_set(client, set_namepart_completed, f->track, s, value,
352 /* Called when we've set a namepart */
353 static void set_namepart_completed(void *v) {
354 struct callbackdata *cbd = v;
355 struct prefdata *f = cbd->u.f;
357 namepart_update(f->track, "display", f->p->part);
360 /* String preferences ------------------------------------------------------ */
362 static void kickoff_string(struct prefdata *f) {
363 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
364 make_callbackdata(f));
367 static void completed_string(struct prefdata *f) {
369 /* No setting, use the default value instead */
370 f->value = f->p->default_value;
371 f->widget = gtk_entry_new();
374 static const char *get_edited_string(struct prefdata *f) {
375 return gtk_entry_get_text(GTK_ENTRY(f->widget));
378 static void set_edited_string(struct prefdata *f, const char *value) {
379 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
382 static void set_string(struct prefdata *f, const char *value) {
383 if(strcmp(f->p->default_value, value))
384 /* Different from default, set it */
385 disorder_eclient_set(client, 0/*completed*/, f->track, f->p->part,
388 /* Same as default, just unset */
389 disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part,
393 /* Boolean preferences ----------------------------------------------------- */
395 static void kickoff_boolean(struct prefdata *f) {
396 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
397 make_callbackdata(f));
400 static void completed_boolean(struct prefdata *f) {
401 f->widget = gtk_check_button_new();
403 /* Not set, use the default */
404 f->value = f->p->default_value;
407 static const char *get_edited_boolean(struct prefdata *f) {
408 return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f->widget))
412 static void set_edited_boolean(struct prefdata *f, const char *value) {
413 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget),
417 static void set_boolean(struct prefdata *f, const char *value) {
420 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
421 if(strcmp(value, f->p->default_value))
422 disorder_eclient_set(client, 0/*completed*/, f->track, f->p->part, value,
425 /* If default value then delete the pref */
426 disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part,
430 /* Querying preferences ---------------------------------------------------- */
432 /* Make a suitable callbackdata */
433 static struct callbackdata *make_callbackdata(struct prefdata *f) {
434 struct callbackdata *cbd = xmalloc(sizeof *cbd);
436 cbd->onerror = prefdata_onerror;
441 /* No pref was set */
442 static void prefdata_onerror(struct callbackdata *cbd,
443 int attribute((unused)) code,
444 const char attribute((unused)) *msg) {
445 prefdata_completed_common(cbd->u.f, 0);
448 /* Got the value of a pref */
449 static void prefdata_completed(void *v, const char *value) {
450 struct callbackdata *cbd = v;
452 prefdata_completed_common(cbd->u.f, value);
455 static void prefdata_completed_common(struct prefdata *f,
458 f->p->type->completed(f);
459 f->p->type->set_edited(f, f->value);
460 assert(f->value != 0); /* Had better set a default */
461 gtk_table_attach(GTK_TABLE(properties_table), f->widget,
464 GTK_EXPAND|GTK_FILL/*xoptions*/, 0/*yoptions*/,
467 if(prefs_total && progress_window)
468 gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(progress_bar),
469 1.0 - (double)prefs_unfilled / prefs_total);
474 /* Button callbacks -------------------------------------------------------- */
476 static void properties_ok(GtkButton *button,
478 properties_apply(button, userdata);
479 properties_cancel(button, userdata);
482 static void properties_apply(GtkButton attribute((unused)) *button,
483 gpointer attribute((unused)) userdata) {
488 /* For each possible property we see if we've changed it and if so tell the
490 for(n = 0; n < prefs_total; ++n) {
492 edited = f->p->type->get_edited(f);
493 if(strcmp(edited, f->value)) {
494 /* The value has changed */
495 f->p->type->set(f, edited);
496 f->value = xstrdup(edited);
501 static void properties_cancel(GtkButton attribute((unused)) *button,
502 gpointer attribute((unused)) userdata) {
503 gtk_widget_destroy(properties_window);