2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007 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 { "Weight", "weight", "90000", &preftype_string },
125 { "Random", "pick_at_random", "1", &preftype_boolean },
128 #define NPREFS (int)(sizeof prefs / sizeof *prefs)
130 /* Buttons that appear at the bottom of the window */
131 static const struct button buttons[] = {
135 "Apply all changes and close window"
140 "Apply all changes and keep window open"
145 "Discard all changes and close window"
149 #define NBUTTONS (int)(sizeof buttons / sizeof *buttons)
151 static int prefs_unfilled; /* Prefs remaining to get */
152 static int prefs_total; /* Total prefs */
153 static struct prefdata *prefdatas; /* Current prefdatas */
154 static GtkWidget *properties_window;
155 static GtkWidget *properties_table;
156 static struct progress_window *pw;
158 static void propagate_clicked(GtkButton attribute((unused)) *button,
160 struct prefdata *f = (struct prefdata *)userdata, *g;
162 const char *value = f->p->type->get_edited(f);
164 for(p = 0; p < prefs_total; ++p) {
166 if(f->p == g->p && f != g)
167 g->p->type->set_edited(g, value);
171 void properties(int ntracks, const char **tracks) {
174 GtkWidget *buttonbox, *vbox, *label, *entry, *propagate;
176 /* If no tracks, do nothign */
179 /* If there is a properties window open then just bring it to the
180 * front. It might not have the right values in... */
181 if(properties_window) {
183 gtk_window_present(GTK_WINDOW(properties_window));
186 assert(properties_table == 0);
187 if(ntracks > INT_MAX / NPREFS) {
188 popup_msg(GTK_MESSAGE_ERROR, "Too many tracks selected");
191 /* Create a new properties window */
192 properties_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
193 gtk_widget_set_style(properties_window, tool_style);
194 g_signal_connect(properties_window, "destroy",
195 G_CALLBACK(gtk_widget_destroyed), &properties_window);
196 /* Most of the action is the table of preferences */
197 properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1,
199 gtk_widget_set_style(properties_table, tool_style);
200 g_signal_connect(properties_table, "destroy",
201 G_CALLBACK(gtk_widget_destroyed), &properties_table);
202 gtk_window_set_title(GTK_WINDOW(properties_window), "Track Properties");
203 /* Create labels for each pref of each track and kick off requests to the
204 * server to fill in the values */
205 prefs_total = NPREFS * ntracks;
206 prefdatas = xcalloc(prefs_total, sizeof *prefdatas);
207 for(n = 0; n < ntracks; ++n) {
208 /* The track itself */
210 label = gtk_label_new("Track");
211 gtk_widget_set_style(label, tool_style);
212 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
213 gtk_table_attach(GTK_TABLE(properties_table),
216 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
220 entry = gtk_entry_new();
221 gtk_widget_set_style(entry, tool_style);
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_widget_set_style(label, tool_style);
235 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
236 gtk_table_attach(GTK_TABLE(properties_table),
239 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
240 GTK_FILL/*xoptions*/, 0/*yoptions*/,
242 /* Editing the preference is specific */
243 f = &prefdatas[NPREFS * n + m];
244 f->track = tracks[n];
245 f->row = (NPREFS + 1) * n + 1 + m;
247 prefs[m].type->kickoff(f);
249 /* Propagation button */
250 propagate = iconbutton("propagate.png", "Copy to other tracks");
251 g_signal_connect(G_OBJECT(propagate), "clicked",
252 G_CALLBACK(propagate_clicked), f);
253 gtk_table_attach(GTK_TABLE(properties_table),
255 2/*left*/, 3/*right*/,
256 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
257 GTK_FILL/*xoptions*/, 0/*yoptions*/,
258 1/*xpadding*/, 1/*ypadding*/);
262 prefs_unfilled = prefs_total;
264 buttonbox = create_buttons(buttons, NBUTTONS);
265 /* Put it all together */
266 vbox = gtk_vbox_new(FALSE, 1);
267 gtk_box_pack_start(GTK_BOX(vbox),
268 scroll_widget(properties_table),
270 gtk_box_pack_start(GTK_BOX(vbox), buttonbox, FALSE, FALSE, 1);
271 gtk_container_add(GTK_CONTAINER(properties_window), vbox);
272 /* The table only really wants to be vertically scrollable */
273 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table)->parent->parent),
275 GTK_POLICY_AUTOMATIC);
276 /* Zot any pre-existing progress window just in case */
278 progress_window_progress(pw, 0, 0);
279 /* Pop up a progress bar while we're waiting */
280 pw = progress_window_new("Fetching Track Properties");
283 /* Everything is filled in now */
284 static void prefdata_alldone(void) {
286 progress_window_progress(pw, 0, 0);
289 /* Default size may be too small */
290 gtk_window_set_default_size(GTK_WINDOW(properties_window), 480, 512);
291 /* TODO: relate default size to required size more closely */
292 gtk_widget_show_all(properties_window);
295 /* Namepart preferences ---------------------------------------------------- */
297 static void kickoff_namepart(struct prefdata *f) {
298 /* We ask for the display name part. This is a bit bizarre if what we really
299 * wanted was the underlying preference, but in fact it should always match
300 * and will supply a sane default without having to know how to parse tracks
301 * names (which implies knowing collection roots). */
302 disorder_eclient_namepart(client, prefdata_completed, f->track, "display", f->p->part,
303 make_callbackdata(f));
306 static void completed_namepart(struct prefdata *f) {
311 f->widget = gtk_entry_new();
314 static const char *get_edited_namepart(struct prefdata *f) {
315 return gtk_entry_get_text(GTK_ENTRY(f->widget));
318 static void set_edited_namepart(struct prefdata *f, const char *value) {
319 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
322 static void set_namepart(struct prefdata *f, const char *value) {
324 struct callbackdata *cbd = xmalloc(sizeof *cbd);
327 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
328 /* We don't know what the default is so can never unset. This is a bug
329 * relative to the original design, which is supposed to only ever allow for
330 * non-trivial namepart preferences. I suppose the server could spot a
331 * default being set and translate it into an unset. */
332 disorder_eclient_set(client, set_namepart_completed, f->track, s, value,
336 /* Called when we've set a namepart */
337 static void set_namepart_completed(void *v) {
338 struct callbackdata *cbd = v;
339 struct prefdata *f = cbd->u.f;
341 namepart_update(f->track, "display", f->p->part);
344 /* String preferences ------------------------------------------------------ */
346 static void kickoff_string(struct prefdata *f) {
347 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
348 make_callbackdata(f));
351 static void completed_string(struct prefdata *f) {
353 /* No setting, use the default value instead */
354 f->value = f->p->default_value;
355 f->widget = gtk_entry_new();
358 static const char *get_edited_string(struct prefdata *f) {
359 return gtk_entry_get_text(GTK_ENTRY(f->widget));
362 static void set_edited_string(struct prefdata *f, const char *value) {
363 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
366 static void set_string(struct prefdata *f, const char *value) {
367 if(strcmp(f->p->default_value, value))
368 /* Different from default, set it */
369 disorder_eclient_set(client, 0/*completed*/, f->track, f->p->part,
372 /* Same as default, just unset */
373 disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part,
377 /* Boolean preferences ----------------------------------------------------- */
379 static void kickoff_boolean(struct prefdata *f) {
380 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
381 make_callbackdata(f));
384 static void completed_boolean(struct prefdata *f) {
385 f->widget = gtk_check_button_new();
386 gtk_widget_set_style(f->widget, tool_style);
388 /* Not set, use the default */
389 f->value = f->p->default_value;
392 static const char *get_edited_boolean(struct prefdata *f) {
393 return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f->widget))
397 static void set_edited_boolean(struct prefdata *f, const char *value) {
398 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget),
402 static void set_boolean(struct prefdata *f, const char *value) {
405 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
406 if(strcmp(value, f->p->default_value))
407 disorder_eclient_set(client, 0/*completed*/, f->track, f->p->part, value,
410 /* If default value then delete the pref */
411 disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part,
415 /* Querying preferences ---------------------------------------------------- */
417 /* Make a suitable callbackdata */
418 static struct callbackdata *make_callbackdata(struct prefdata *f) {
419 struct callbackdata *cbd = xmalloc(sizeof *cbd);
421 cbd->onerror = prefdata_onerror;
426 /* No pref was set */
427 static void prefdata_onerror(struct callbackdata *cbd,
428 int attribute((unused)) code,
429 const char attribute((unused)) *msg) {
430 prefdata_completed_common(cbd->u.f, 0);
433 /* Got the value of a pref */
434 static void prefdata_completed(void *v, const char *value) {
435 struct callbackdata *cbd = v;
437 prefdata_completed_common(cbd->u.f, value);
440 static void prefdata_completed_common(struct prefdata *f,
443 f->p->type->completed(f);
444 f->p->type->set_edited(f, f->value);
445 assert(f->value != 0); /* Had better set a default */
446 gtk_table_attach(GTK_TABLE(properties_table), f->widget,
449 GTK_EXPAND|GTK_FILL/*xoptions*/, 0/*yoptions*/,
453 progress_window_progress(pw, prefs_total - prefs_unfilled, prefs_total);
458 /* Button callbacks -------------------------------------------------------- */
460 static void properties_ok(GtkButton *button,
462 properties_apply(button, userdata);
463 properties_cancel(button, userdata);
466 static void properties_apply(GtkButton attribute((unused)) *button,
467 gpointer attribute((unused)) userdata) {
472 /* For each possible property we see if we've changed it and if so tell the
474 for(n = 0; n < prefs_total; ++n) {
476 edited = f->p->type->get_edited(f);
477 if(strcmp(edited, f->value)) {
478 /* The value has changed */
479 f->p->type->set(f, edited);
480 f->value = xstrdup(edited);
485 static void properties_cancel(GtkButton attribute((unused)) *button,
486 gpointer attribute((unused)) userdata) {
487 gtk_widget_destroy(properties_window);
490 /** @brief Called on client reset
492 * Destroys the current properties window.
494 void properties_reset(void) {
495 if(properties_window)
496 gtk_widget_destroy(properties_window);