chiark / gitweb /
relax config file checking for non-server programs
[disorder] / disobedience / properties.c
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
3 * Copyright (C) 2006 Richard Kettlewell
4 *
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.
9 *
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.
14 *
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
18 * USA
19 */
20
21#include "disobedience.h"
22
23/* Track properties -------------------------------------------------------- */
24
25struct prefdata;
26
27static void kickoff_namepart(struct prefdata *f);
28static void completed_namepart(struct prefdata *f);
29static const char *get_edited_namepart(struct prefdata *f);
348ef780 30static void set_edited_namepart(struct prefdata *f, const char *value);
460b9539 31static void set_namepart(struct prefdata *f, const char *value);
32static void set_namepart_completed(void *v);
33
34static void kickoff_string(struct prefdata *f);
35static void completed_string(struct prefdata *f);
36static const char *get_edited_string(struct prefdata *f);
348ef780 37static void set_edited_string(struct prefdata *f, const char *value);
460b9539 38static void set_string(struct prefdata *f, const char *value);
39
40static void kickoff_boolean(struct prefdata *f);
41static void completed_boolean(struct prefdata *f);
42static const char *get_edited_boolean(struct prefdata *f);
348ef780 43static void set_edited_boolean(struct prefdata *f, const char *value);
460b9539 44static void set_boolean(struct prefdata *f, const char *value);
45
46static void prefdata_completed(void *v, const char *value);
47static void prefdata_onerror(struct callbackdata *cbd,
48 int code,
49 const char *msg);
50static struct callbackdata *make_callbackdata(struct prefdata *f);
51static void prefdata_completed_common(struct prefdata *f,
52 const char *value);
53
54static void properties_ok(GtkButton *button, gpointer userdata);
55static void properties_apply(GtkButton *button, gpointer userdata);
56static void properties_cancel(GtkButton *button, gpointer userdata);
57
13aba192 58/** @brief Data for a single preference */
460b9539 59struct prefdata {
60 const char *track;
61 int row;
13aba192 62 const struct pref *p; /**< @brief kind of preference */
63 const char *value; /**< @brief value from server */
460b9539 64 GtkWidget *widget;
65};
66
67/* The type of a preference is the collection of callbacks needed to get,
68 * display and set it */
69struct preftype {
70 void (*kickoff)(struct prefdata *f);
71 /* Kick off the request to fetch the pref from the server. */
72
73 void (*completed)(struct prefdata *f);
74 /* Called when the value comes back in; creates the widget. */
75
76 const char *(*get_edited)(struct prefdata *f);
77 /* Get the edited value from the widget. */
78
348ef780
RK
79 /** @brief Update the edited value */
80 void (*set_edited)(struct prefdata *f, const char *value);
81
460b9539 82 void (*set)(struct prefdata *f, const char *value);
83 /* Set the new value and (if necessary) arrange for our display to update. */
84};
85
86/* A namepart pref */
87static const struct preftype preftype_namepart = {
88 kickoff_namepart,
89 completed_namepart,
90 get_edited_namepart,
348ef780 91 set_edited_namepart,
460b9539 92 set_namepart
93};
94
95/* A string pref */
96static const struct preftype preftype_string = {
97 kickoff_string,
98 completed_string,
99 get_edited_string,
348ef780 100 set_edited_string,
460b9539 101 set_string
102};
103
104/* A boolean pref */
105static const struct preftype preftype_boolean = {
106 kickoff_boolean,
107 completed_boolean,
108 get_edited_boolean,
348ef780 109 set_edited_boolean,
460b9539 110 set_boolean
111};
112
13aba192 113/* @brief The known prefs for each track */
460b9539 114static const struct pref {
13aba192 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 */
460b9539 119} prefs[] = {
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 },
125};
126
127#define NPREFS (int)(sizeof prefs / sizeof *prefs)
128
129/* Buttons that appear at the bottom of the window */
130static const struct button {
131 const gchar *stock;
132 void (*clicked)(GtkButton *button, gpointer userdata);
f4f5a474 133 const char *tip;
460b9539 134} buttons[] = {
f4f5a474
RK
135 {
136 GTK_STOCK_OK,
137 properties_ok,
138 "Apply all changes and close window"
139 },
140 {
141 GTK_STOCK_APPLY,
142 properties_apply,
143 "Apply all changes and keep window open"
144 },
145 {
146 GTK_STOCK_CANCEL,
147 properties_cancel,
148 "Discard all changes and close window"
149 },
460b9539 150};
151
152#define NBUTTONS (int)(sizeof buttons / sizeof *buttons)
153
154static int prefs_unfilled; /* Prefs remaining to get */
155static int prefs_total; /* Total prefs */
156static struct prefdata *prefdatas; /* Current prefdatas */
157static GtkWidget *properties_window;
158static GtkWidget *properties_table;
159static GtkWidget *progress_window, *progress_bar;
160
348ef780
RK
161static void propagate_clicked(GtkButton attribute((unused)) *button,
162 gpointer userdata) {
163 struct prefdata *f = (struct prefdata *)userdata, *g;
164 int p;
165 const char *value = f->p->type->get_edited(f);
166
167 for(p = 0; p < prefs_total; ++p) {
168 g = &prefdatas[p];
169 if(f->p == g->p && f != g)
170 g->p->type->set_edited(g, value);
171 }
172}
173
16e145a5 174void properties(int ntracks, const char **tracks) {
460b9539 175 int n, m;
176 struct prefdata *f;
348ef780
RK
177 GtkWidget *hbox, *vbox, *button, *label, *entry, *propagate, *content;
178 GdkPixbuf *pb;
5459347d
RK
179
180 /* If no tracks, do nothign */
181 if(!ntracks)
182 return;
460b9539 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) {
186 if(!prefs_unfilled)
187 gtk_window_present(GTK_WINDOW(properties_window));
188 return;
189 }
190 assert(properties_table == 0);
191 if(ntracks > INT_MAX / NPREFS) {
192 popup_error("Too many tracks selected");
193 return;
194 }
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 */
348ef780
RK
200 properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1,
201 FALSE);
460b9539 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) {
348ef780
RK
210 /* The track itself */
211 /* Caption */
460b9539 212 label = gtk_label_new("Track");
213 gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
214 gtk_table_attach(GTK_TABLE(properties_table),
215 label,
216 0, 1,
217 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
218 GTK_FILL, 0,
219 1, 1);
348ef780 220 /* The track name */
460b9539 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),
225 entry,
226 1, 2,
227 (NPREFS + 1) * n, (NPREFS + 1) * n + 1,
228 GTK_EXPAND|GTK_FILL, 0,
229 1, 1);
348ef780 230 /* Each preference */
460b9539 231 for(m = 0; m < NPREFS; ++m) {
348ef780 232 /* Caption */
460b9539 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),
236 label,
237 0, 1,
238 (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
239 GTK_FILL/*xoptions*/, 0/*yoptions*/,
240 1, 1);
348ef780 241 /* Editing the preference is specific */
460b9539 242 f = &prefdatas[NPREFS * n + m];
243 f->track = tracks[n];
244 f->row = (NPREFS + 1) * n + 1 + m;
245 f->p = &prefs[m];
246 prefs[m].type->kickoff(f);
348ef780
RK
247 if(ntracks > 1) {
248 /* Propagation button */
249 propagate = gtk_button_new();
250 if((pb = find_image("propagate.png")))
251 content = gtk_image_new_from_pixbuf(pb);
252 else
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),
259 propagate,
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*/);
264 }
460b9539 265 }
266 }
267 prefs_unfilled = prefs_total;
268 /* Buttons */
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);
f4f5a474 275 gtk_tooltips_set_tip(tips, button, buttons[n].tip, "");
460b9539 276 }
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,
281 "properties"),
282 TRUE, TRUE, 1);
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),
287 GTK_POLICY_NEVER,
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);
299}
300
301/* Everything is filled in now */
302static void prefdata_alldone(void) {
303 if(progress_window)
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);
309}
310
311/* Namepart preferences ---------------------------------------------------- */
312
313static void kickoff_namepart(struct prefdata *f) {
13aba192 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));
460b9539 320}
321
322static void completed_namepart(struct prefdata *f) {
13aba192 323 if(!f->value) {
324 /* No setting */
325 f->value = "";
326 }
460b9539 327 f->widget = gtk_entry_new();
460b9539 328}
329
330static const char *get_edited_namepart(struct prefdata *f) {
331 return gtk_entry_get_text(GTK_ENTRY(f->widget));
332}
333
348ef780
RK
334static void set_edited_namepart(struct prefdata *f, const char *value) {
335 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
336}
337
460b9539 338static void set_namepart(struct prefdata *f, const char *value) {
339 char *s;
340 struct callbackdata *cbd = xmalloc(sizeof *cbd);
341
342 cbd->u.f = f;
343 byte_xasprintf(&s, "trackname_display_%s", f->p->part);
13aba192 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,
349 cbd);
460b9539 350}
351
352/* Called when we've set a namepart */
353static void set_namepart_completed(void *v) {
354 struct callbackdata *cbd = v;
355 struct prefdata *f = cbd->u.f;
356
357 namepart_update(f->track, "display", f->p->part);
358}
359
360/* String preferences ------------------------------------------------------ */
361
362static void kickoff_string(struct prefdata *f) {
363 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
364 make_callbackdata(f));
365}
366
367static void completed_string(struct prefdata *f) {
368 if(!f->value)
369 /* No setting, use the default value instead */
370 f->value = f->p->default_value;
371 f->widget = gtk_entry_new();
460b9539 372}
373
374static const char *get_edited_string(struct prefdata *f) {
375 return gtk_entry_get_text(GTK_ENTRY(f->widget));
376}
377
348ef780
RK
378static void set_edited_string(struct prefdata *f, const char *value) {
379 gtk_entry_set_text(GTK_ENTRY(f->widget), value);
380}
381
460b9539 382static 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,
386 value, 0/*v*/);
387 else
388 /* Same as default, just unset */
389 disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part,
390 0/*v*/);
391}
392
393/* Boolean preferences ----------------------------------------------------- */
394
395static void kickoff_boolean(struct prefdata *f) {
396 disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
397 make_callbackdata(f));
398}
399
400static void completed_boolean(struct prefdata *f) {
401 f->widget = gtk_check_button_new();
402 if(!f->value)
403 /* Not set, use the default */
404 f->value = f->p->default_value;
460b9539 405}
406
407static const char *get_edited_boolean(struct prefdata *f) {
408 return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f->widget))
409 ? "1" : "0");
410}
411
348ef780
RK
412static void set_edited_boolean(struct prefdata *f, const char *value) {
413 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget),
414 strcmp(value, "0"));
415}
416
460b9539 417static void set_boolean(struct prefdata *f, const char *value) {
418 char *s;
419
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,
423 0/*v*/);
424 else
425 /* If default value then delete the pref */
426 disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part,
427 0/*v*/);
428}
429
430/* Querying preferences ---------------------------------------------------- */
431
432/* Make a suitable callbackdata */
433static struct callbackdata *make_callbackdata(struct prefdata *f) {
434 struct callbackdata *cbd = xmalloc(sizeof *cbd);
435
436 cbd->onerror = prefdata_onerror;
437 cbd->u.f = f;
438 return cbd;
439}
440
441/* No pref was set */
442static 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);
446}
447
448/* Got the value of a pref */
449static void prefdata_completed(void *v, const char *value) {
450 struct callbackdata *cbd = v;
451
452 prefdata_completed_common(cbd->u.f, value);
453}
454
455static void prefdata_completed_common(struct prefdata *f,
456 const char *value) {
457 f->value = value;
458 f->p->type->completed(f);
348ef780 459 f->p->type->set_edited(f, f->value);
460b9539 460 assert(f->value != 0); /* Had better set a default */
461 gtk_table_attach(GTK_TABLE(properties_table), f->widget,
462 1, 2,
463 f->row, f->row + 1,
464 GTK_EXPAND|GTK_FILL/*xoptions*/, 0/*yoptions*/,
465 1, 1);
466 --prefs_unfilled;
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);
470 if(!prefs_unfilled)
471 prefdata_alldone();
472}
473
474/* Button callbacks -------------------------------------------------------- */
475
476static void properties_ok(GtkButton *button,
477 gpointer userdata) {
478 properties_apply(button, userdata);
479 properties_cancel(button, userdata);
480}
481
482static void properties_apply(GtkButton attribute((unused)) *button,
483 gpointer attribute((unused)) userdata) {
484 int n;
485 const char *edited;
486 struct prefdata *f;
487
488 /* For each possible property we see if we've changed it and if so tell the
489 * server */
490 for(n = 0; n < prefs_total; ++n) {
491 f = &prefdatas[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);
497 }
498 }
499}
500
501static void properties_cancel(GtkButton attribute((unused)) *button,
502 gpointer attribute((unused)) userdata) {
503 gtk_widget_destroy(properties_window);
504}
505
506/*
507Local Variables:
508c-basic-offset:2
509comment-column:40
510fill-column:79
511indent-tabs-mode:nil
512End:
513*/