2 * This file is part of DisOrder.
3 * Copyright (C) 2006-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 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU 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, see <http://www.gnu.org/licenses/>.
18 /** @file disobedience/properties.c
19 * @brief Track properties editor
21 #include "disobedience.h"
25 static void kickoff_namepart(struct prefdata *f);
26 static void completed_namepart(struct prefdata *f);
27 static const char *get_edited_namepart(struct prefdata *f);
28 static void set_edited_namepart(struct prefdata *f, const char *value);
29 static void set_namepart(struct prefdata *f, const char *value);
30 static void set_namepart_completed(void *v, const char *err);
32 static void kickoff_string(struct prefdata *f);
33 static void completed_string(struct prefdata *f);
34 static const char *get_edited_string(struct prefdata *f);
35 static void set_edited_string(struct prefdata *f, const char *value);
36 static void set_string(struct prefdata *f, const char *value);
38 static void kickoff_boolean(struct prefdata *f);
39 static void completed_boolean(struct prefdata *f);
40 static const char *get_edited_boolean(struct prefdata *f);
41 static void set_edited_boolean(struct prefdata *f, const char *value);
42 static void set_boolean(struct prefdata *f, const char *value);
44 static void prefdata_completed(void *v, const char *err, const char *value);
46 static void properties_ok(GtkButton *button, gpointer userdata);
47 static void properties_apply(GtkButton *button, gpointer userdata);
48 static void properties_cancel(GtkButton *button, gpointer userdata);
49 static void properties_help(GtkButton *button, gpointer userdata);
51 static void properties_logged_in(const char *event,
55 /** @brief Data for a single preference */
59 const struct pref *p; /**< @brief kind of preference */
60 const char *value; /**< @brief value from server */
64 /** @brief Type of a track preference
66 * The type of a preference is the collection of callbacks needed to get,
70 /** @brief Kick off the request to fetch the pref from the server. */
71 void (*kickoff)(struct prefdata *f);
73 /** @brief Called when the value comes back in; creates the widget. */
74 void (*completed)(struct prefdata *f);
76 /** @brief Get the edited value from the widget. */
77 const char *(*get_edited)(struct prefdata *f);
79 /** @brief Update the edited value */
80 void (*set_edited)(struct prefdata *f, const char *value);
82 /** @brief Set the new value and (if necessary) arrange for our display to update. */
83 void (*set)(struct prefdata *f, const char *value);
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 struct button buttons[] = {
142 "Apply all changes and close window",
149 "Discard all changes and close window",
156 "Apply all changes and keep window open",
162 #define NBUTTONS (int)(sizeof buttons / sizeof *buttons)
164 static int prefs_unfilled; /* Prefs remaining to get */
165 static int prefs_total; /* Total prefs */
166 static struct prefdata *prefdatas; /* Current prefdatas */
167 static GtkWidget *properties_window;
168 static GtkWidget *properties_table;
169 static struct progress_window *pw;
170 static event_handle properties_event;
172 static void propagate_clicked(GtkButton attribute((unused)) *button,
174 struct prefdata *f = (struct prefdata *)userdata, *g;
176 const char *value = f->p->type->get_edited(f);
178 for(p = 0; p < prefs_total; ++p) {
180 if(f->p == g->p && f != g)
181 g->p->type->set_edited(g, value);
185 /** @brief Keypress handler */
186 static gboolean properties_keypress(GtkWidget attribute((unused)) *widget,
188 gpointer attribute((unused)) user_data) {
191 switch(event->keyval) {
196 properties_cancel(0, 0);
203 void properties(int ntracks, const char **tracks,
207 GtkWidget *buttonbox, *vbox, *label, *entry, *propagate;
209 /* If no tracks, do nothign */
212 /* If there is a properties window open then just bring it to the
213 * front. It might not have the right values in... */
214 if(properties_window) {
216 gtk_window_present(GTK_WINDOW(properties_window));
219 assert(properties_table == 0);
220 if(ntracks > INT_MAX / NPREFS) {
221 popup_msg(GTK_MESSAGE_ERROR, "Too many tracks selected");
224 properties_event = event_register("logged-in", properties_logged_in, 0);
225 /* Create a new properties window */
226 properties_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
227 gtk_widget_set_style(properties_window, tool_style);
228 g_signal_connect(properties_window, "destroy",
229 G_CALLBACK(gtk_widget_destroyed), &properties_window);
230 /* Keyboard shortcuts */
231 g_signal_connect(properties_window, "key-press-event",
232 G_CALLBACK(properties_keypress), 0);
233 /* Most of the action is the table of preferences */
234 properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1,
236 gtk_widget_set_style(properties_table, tool_style);
237 g_signal_connect(properties_table, "destroy",
238 G_CALLBACK(gtk_widget_destroyed), &properties_table);
239 gtk_window_set_title(GTK_WINDOW(properties_window), "Track Properties");
240 /* Create labels for each pref of each track and kick off requests to the
241 * server to fill in the values */
242 prefs_total = NPREFS * ntracks;
243 prefdatas = xcalloc(prefs_total, sizeof *prefdatas);
244 for(n = 0; n < ntracks; ++n) {
245 /* The track itself */
247 label = gtk_label_new("Track");
248 gtk_widget_set_style(label, tool_style);
249 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
250 gtk_table_attach(GTK_TABLE(properties_table),
253 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
257 entry = gtk_entry_new();
258 gtk_widget_set_style(entry, tool_style);
259 gtk_entry_set_text(GTK_ENTRY(entry), tracks[n]);
260 gtk_editable_set_editable(GTK_EDITABLE(entry), FALSE);
261 gtk_table_attach(GTK_TABLE(properties_table),
264 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
265 GTK_EXPAND|GTK_FILL, 0,
267 /* Each preference */
268 for(m = 0; m < NPREFS; ++m) {
270 label = gtk_label_new(prefs[m].label);
271 gtk_widget_set_style(label, tool_style);
272 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
273 gtk_table_attach(GTK_TABLE(properties_table),
276 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
277 GTK_FILL/*xoptions*/, 0/*yoptions*/,
279 /* Editing the preference is specific */
280 f = &prefdatas[NPREFS * n + m];
281 f->track = tracks[n];
282 f->row = (NPREFS + 1) * n + 1 + m;
284 prefs[m].type->kickoff(f);
286 /* Propagation button */
287 propagate = iconbutton("propagate.png", "Copy to other tracks");
288 g_signal_connect(G_OBJECT(propagate), "clicked",
289 G_CALLBACK(propagate_clicked), f);
290 gtk_table_attach(GTK_TABLE(properties_table),
292 2/*left*/, 3/*right*/,
293 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
294 GTK_FILL/*xoptions*/, 0/*yoptions*/,
295 1/*xpadding*/, 1/*ypadding*/);
299 prefs_unfilled = prefs_total;
301 buttonbox = create_buttons(buttons, NBUTTONS);
302 /* Put it all together */
303 vbox = gtk_vbox_new(FALSE, 1);
304 gtk_box_pack_start(GTK_BOX(vbox),
305 scroll_widget(properties_table),
307 gtk_box_pack_start(GTK_BOX(vbox), buttonbox, FALSE, FALSE, 1);
308 gtk_container_add(GTK_CONTAINER(properties_window), frame_widget(vbox, NULL));
309 /* The table only really wants to be vertically scrollable */
310 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table)->parent->parent),
312 GTK_POLICY_AUTOMATIC);
313 /* Zot any pre-existing progress window just in case */
315 progress_window_progress(pw, 0, 0);
316 /* Pop up a progress bar while we're waiting */
317 while(parent->parent)
318 parent = parent->parent;
319 pw = progress_window_new("Fetching Track Properties", parent);
322 /* Everything is filled in now */
323 static void prefdata_alldone(void) {
325 progress_window_progress(pw, 0, 0);
328 /* Default size may be too small */
329 gtk_window_set_default_size(GTK_WINDOW(properties_window), 480, 512);
330 /* TODO: relate default size to required size more closely */
331 gtk_widget_show_all(properties_window);
334 /* Namepart preferences ---------------------------------------------------- */
336 static void kickoff_namepart(struct prefdata *f) {
337 /* We ask for the display name part. This is a bit bizarre if what we really
338 * wanted was the underlying preference, but in fact it should always match
339 * and will supply a sane default without having to know how to parse tracks
340 * names (which implies knowing collection roots). */
341 disorder_eclient_part(client, prefdata_completed,
342 f->track, "display", f->p->part, f);
345 static void completed_namepart(struct prefdata *f) {
350 f->widget = gtk_entry_new();
353 static const char *get_edited_namepart(struct prefdata *f) {
354 return gtk_entry_get_text(GTK_ENTRY(f->widget));
357 static void set_edited_namepart(struct prefdata *f, const char *value) {
358 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
361 static void set_namepart(struct prefdata *f, const char *value) {
364 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
365 /* We don't know what the default is so can never unset. This is a bug
366 * relative to the original design, which is supposed to only ever allow for
367 * non-trivial namepart preferences. I suppose the server could spot a
368 * default being set and translate it into an unset. */
369 disorder_eclient_set(client, set_namepart_completed, f->track, s, value,
373 /* Called when we've set a namepart */
374 static void set_namepart_completed(void *v, const char *err) {
376 popup_protocol_error(0, err);
378 struct prefdata *f = v;
380 namepart_update(f->track, "display", f->p->part);
384 /* String preferences ------------------------------------------------------ */
386 static void kickoff_string(struct prefdata *f) {
387 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part, f);
390 static void completed_string(struct prefdata *f) {
392 /* No setting, use the default value instead */
393 f->value = f->p->default_value;
394 f->widget = gtk_entry_new();
397 static const char *get_edited_string(struct prefdata *f) {
398 return gtk_entry_get_text(GTK_ENTRY(f->widget));
401 static void set_edited_string(struct prefdata *f, const char *value) {
402 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
405 static void set_string_completed(void attribute((unused)) *v,
408 popup_protocol_error(0, err);
411 static void set_string(struct prefdata *f, const char *value) {
412 disorder_eclient_set(client, set_string_completed, f->track, f->p->part,
416 /* Boolean preferences ----------------------------------------------------- */
418 static void kickoff_boolean(struct prefdata *f) {
419 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part, f);
422 static void completed_boolean(struct prefdata *f) {
423 f->widget = gtk_check_button_new();
424 gtk_widget_set_style(f->widget, tool_style);
426 /* Not set, use the default */
427 f->value = f->p->default_value;
430 static const char *get_edited_boolean(struct prefdata *f) {
431 return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f->widget))
435 static void set_edited_boolean(struct prefdata *f, const char *value) {
436 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget),
440 #define set_boolean_completed set_string_completed
442 static void set_boolean(struct prefdata *f, const char *value) {
445 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
446 disorder_eclient_set(client, set_boolean_completed,
447 f->track, f->p->part, value, 0/*v*/);
450 /* Querying preferences ---------------------------------------------------- */
452 static void prefdata_completed(void *v, const char *err, const char *value) {
453 struct prefdata *const f = v;
456 popup_protocol_error(0, err);
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*/,
468 progress_window_progress(pw, prefs_total - prefs_unfilled, prefs_total);
473 /* Button callbacks -------------------------------------------------------- */
475 static void properties_ok(GtkButton *button,
477 properties_apply(button, userdata);
478 properties_cancel(button, userdata);
481 static void properties_apply(GtkButton attribute((unused)) *button,
482 gpointer attribute((unused)) userdata) {
487 /* For each possible property we see if we've changed it and if so tell the
489 for(n = 0; n < prefs_total; ++n) {
491 edited = f->p->type->get_edited(f);
492 if(strcmp(edited, f->value)) {
493 /* The value has changed */
494 f->p->type->set(f, edited);
495 f->value = xstrdup(edited);
500 static void properties_cancel(GtkButton attribute((unused)) *button,
501 gpointer attribute((unused)) userdata) {
502 gtk_widget_destroy(properties_window);
503 event_cancel(properties_event);
504 properties_event = 0;
507 static void properties_help(GtkButton attribute((unused)) *button,
508 gpointer attribute((unused)) userdata) {
509 popup_help("properties.html");
512 /** @brief Called when we've just logged in
514 * Destroys the current properties window.
516 static void properties_logged_in(const char attribute((unused)) *event,
517 void attribute((unused)) *eventdata,
518 void attribute((unused)) *callbackdata) {
519 if(properties_window)
520 gtk_widget_destroy(properties_window);