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 struct button buttons
[] = {
135 "Apply all changes and close window",
141 "Apply all changes and keep window open",
147 "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 struct progress_window
*pw
;
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
*buttonbox
, *vbox
, *label
, *entry
, *propagate
;
179 /* If no tracks, do nothign */
182 /* If there is a properties window open then just bring it to the
183 * front. It might not have the right values in... */
184 if(properties_window
) {
186 gtk_window_present(GTK_WINDOW(properties_window
));
189 assert(properties_table
== 0);
190 if(ntracks
> INT_MAX
/ NPREFS
) {
191 popup_msg(GTK_MESSAGE_ERROR
, "Too many tracks selected");
194 /* Create a new properties window */
195 properties_window
= gtk_window_new(GTK_WINDOW_TOPLEVEL
);
196 gtk_widget_set_style(properties_window
, tool_style
);
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 gtk_widget_set_style(properties_table
, tool_style
);
203 g_signal_connect(properties_table
, "destroy",
204 G_CALLBACK(gtk_widget_destroyed
), &properties_table
);
205 gtk_window_set_title(GTK_WINDOW(properties_window
), "Track Properties");
206 /* Create labels for each pref of each track and kick off requests to the
207 * server to fill in the values */
208 prefs_total
= NPREFS
* ntracks
;
209 prefdatas
= xcalloc(prefs_total
, sizeof *prefdatas
);
210 for(n
= 0; n
< ntracks
; ++n
) {
211 /* The track itself */
213 label
= gtk_label_new("Track");
214 gtk_widget_set_style(label
, tool_style
);
215 gtk_misc_set_alignment(GTK_MISC(label
), 1, 0);
216 gtk_table_attach(GTK_TABLE(properties_table
),
219 (NPREFS
+ 1) * n
, (NPREFS
+ 1) * n
+ 1,
223 entry
= gtk_entry_new();
224 gtk_widget_set_style(entry
, tool_style
);
225 gtk_entry_set_text(GTK_ENTRY(entry
), tracks
[n
]);
226 gtk_editable_set_editable(GTK_EDITABLE(entry
), FALSE
);
227 gtk_table_attach(GTK_TABLE(properties_table
),
230 (NPREFS
+ 1) * n
, (NPREFS
+ 1) * n
+ 1,
231 GTK_EXPAND
|GTK_FILL
, 0,
233 /* Each preference */
234 for(m
= 0; m
< NPREFS
; ++m
) {
236 label
= gtk_label_new(prefs
[m
].label
);
237 gtk_widget_set_style(label
, tool_style
);
238 gtk_misc_set_alignment(GTK_MISC(label
), 1, 0);
239 gtk_table_attach(GTK_TABLE(properties_table
),
242 (NPREFS
+ 1) * n
+ 1 + m
, (NPREFS
+ 1) * n
+ 2 + m
,
243 GTK_FILL
/*xoptions*/, 0/*yoptions*/,
245 /* Editing the preference is specific */
246 f
= &prefdatas
[NPREFS
* n
+ m
];
247 f
->track
= tracks
[n
];
248 f
->row
= (NPREFS
+ 1) * n
+ 1 + m
;
250 prefs
[m
].type
->kickoff(f
);
252 /* Propagation button */
253 propagate
= iconbutton("propagate.png", "Copy to other tracks");
254 g_signal_connect(G_OBJECT(propagate
), "clicked",
255 G_CALLBACK(propagate_clicked
), f
);
256 gtk_table_attach(GTK_TABLE(properties_table
),
258 2/*left*/, 3/*right*/,
259 (NPREFS
+ 1) * n
+ 1 + m
, (NPREFS
+ 1) * n
+ 2 + m
,
260 GTK_FILL
/*xoptions*/, 0/*yoptions*/,
261 1/*xpadding*/, 1/*ypadding*/);
265 prefs_unfilled
= prefs_total
;
267 buttonbox
= create_buttons(buttons
, NBUTTONS
);
268 /* Put it all together */
269 vbox
= gtk_vbox_new(FALSE
, 1);
270 gtk_box_pack_start(GTK_BOX(vbox
),
271 scroll_widget(properties_table
),
273 gtk_box_pack_start(GTK_BOX(vbox
), buttonbox
, FALSE
, FALSE
, 1);
274 gtk_container_add(GTK_CONTAINER(properties_window
), frame_widget(vbox
, NULL
));
275 /* The table only really wants to be vertically scrollable */
276 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table
)->parent
->parent
),
278 GTK_POLICY_AUTOMATIC
);
279 /* Zot any pre-existing progress window just in case */
281 progress_window_progress(pw
, 0, 0);
282 /* Pop up a progress bar while we're waiting */
283 pw
= progress_window_new("Fetching Track Properties");
286 /* Everything is filled in now */
287 static void prefdata_alldone(void) {
289 progress_window_progress(pw
, 0, 0);
292 /* Default size may be too small */
293 gtk_window_set_default_size(GTK_WINDOW(properties_window
), 480, 512);
294 /* TODO: relate default size to required size more closely */
295 gtk_widget_show_all(properties_window
);
298 /* Namepart preferences ---------------------------------------------------- */
300 static void kickoff_namepart(struct prefdata
*f
) {
301 /* We ask for the display name part. This is a bit bizarre if what we really
302 * wanted was the underlying preference, but in fact it should always match
303 * and will supply a sane default without having to know how to parse tracks
304 * names (which implies knowing collection roots). */
305 disorder_eclient_namepart(client
, prefdata_completed
, f
->track
, "display", f
->p
->part
,
306 make_callbackdata(f
));
309 static void completed_namepart(struct prefdata
*f
) {
314 f
->widget
= gtk_entry_new();
317 static const char *get_edited_namepart(struct prefdata
*f
) {
318 return gtk_entry_get_text(GTK_ENTRY(f
->widget
));
321 static void set_edited_namepart(struct prefdata
*f
, const char *value
) {
322 gtk_entry_set_text(GTK_ENTRY(f
->widget
), value
);
325 static void set_namepart(struct prefdata
*f
, const char *value
) {
327 struct callbackdata
*cbd
= xmalloc(sizeof *cbd
);
330 byte_xasprintf(&s
, "trackname_display_%s", f
->p
->part
);
331 /* We don't know what the default is so can never unset. This is a bug
332 * relative to the original design, which is supposed to only ever allow for
333 * non-trivial namepart preferences. I suppose the server could spot a
334 * default being set and translate it into an unset. */
335 disorder_eclient_set(client
, set_namepart_completed
, f
->track
, s
, value
,
339 /* Called when we've set a namepart */
340 static void set_namepart_completed(void *v
) {
341 struct callbackdata
*cbd
= v
;
342 struct prefdata
*f
= cbd
->u
.f
;
344 namepart_update(f
->track
, "display", f
->p
->part
);
347 /* String preferences ------------------------------------------------------ */
349 static void kickoff_string(struct prefdata
*f
) {
350 disorder_eclient_get(client
, prefdata_completed
, f
->track
, f
->p
->part
,
351 make_callbackdata(f
));
354 static void completed_string(struct prefdata
*f
) {
356 /* No setting, use the default value instead */
357 f
->value
= f
->p
->default_value
;
358 f
->widget
= gtk_entry_new();
361 static const char *get_edited_string(struct prefdata
*f
) {
362 return gtk_entry_get_text(GTK_ENTRY(f
->widget
));
365 static void set_edited_string(struct prefdata
*f
, const char *value
) {
366 gtk_entry_set_text(GTK_ENTRY(f
->widget
), value
);
369 static void set_string(struct prefdata
*f
, const char *value
) {
370 if(strcmp(f
->p
->default_value
, value
))
371 /* Different from default, set it */
372 disorder_eclient_set(client
, 0/*completed*/, f
->track
, f
->p
->part
,
375 /* Same as default, just unset */
376 disorder_eclient_unset(client
, 0/*completed*/, f
->track
, f
->p
->part
,
380 /* Boolean preferences ----------------------------------------------------- */
382 static void kickoff_boolean(struct prefdata
*f
) {
383 disorder_eclient_get(client
, prefdata_completed
, f
->track
, f
->p
->part
,
384 make_callbackdata(f
));
387 static void completed_boolean(struct prefdata
*f
) {
388 f
->widget
= gtk_check_button_new();
389 gtk_widget_set_style(f
->widget
, tool_style
);
391 /* Not set, use the default */
392 f
->value
= f
->p
->default_value
;
395 static const char *get_edited_boolean(struct prefdata
*f
) {
396 return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f
->widget
))
400 static void set_edited_boolean(struct prefdata
*f
, const char *value
) {
401 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f
->widget
),
405 static void set_boolean(struct prefdata
*f
, const char *value
) {
408 byte_xasprintf(&s
, "trackname_display_%s", f
->p
->part
);
409 if(strcmp(value
, f
->p
->default_value
))
410 disorder_eclient_set(client
, 0/*completed*/, f
->track
, f
->p
->part
, value
,
413 /* If default value then delete the pref */
414 disorder_eclient_unset(client
, 0/*completed*/, f
->track
, f
->p
->part
,
418 /* Querying preferences ---------------------------------------------------- */
420 /* Make a suitable callbackdata */
421 static struct callbackdata
*make_callbackdata(struct prefdata
*f
) {
422 struct callbackdata
*cbd
= xmalloc(sizeof *cbd
);
424 cbd
->onerror
= prefdata_onerror
;
429 /* No pref was set */
430 static void prefdata_onerror(struct callbackdata
*cbd
,
431 int attribute((unused
)) code
,
432 const char attribute((unused
)) *msg
) {
433 prefdata_completed_common(cbd
->u
.f
, 0);
436 /* Got the value of a pref */
437 static void prefdata_completed(void *v
, const char *value
) {
438 struct callbackdata
*cbd
= v
;
440 prefdata_completed_common(cbd
->u
.f
, value
);
443 static void prefdata_completed_common(struct prefdata
*f
,
446 f
->p
->type
->completed(f
);
447 f
->p
->type
->set_edited(f
, f
->value
);
448 assert(f
->value
!= 0); /* Had better set a default */
449 gtk_table_attach(GTK_TABLE(properties_table
), f
->widget
,
452 GTK_EXPAND
|GTK_FILL
/*xoptions*/, 0/*yoptions*/,
456 progress_window_progress(pw
, prefs_total
- prefs_unfilled
, prefs_total
);
461 /* Button callbacks -------------------------------------------------------- */
463 static void properties_ok(GtkButton
*button
,
465 properties_apply(button
, userdata
);
466 properties_cancel(button
, userdata
);
469 static void properties_apply(GtkButton
attribute((unused
)) *button
,
470 gpointer
attribute((unused
)) userdata
) {
475 /* For each possible property we see if we've changed it and if so tell the
477 for(n
= 0; n
< prefs_total
; ++n
) {
479 edited
= f
->p
->type
->get_edited(f
);
480 if(strcmp(edited
, f
->value
)) {
481 /* The value has changed */
482 f
->p
->type
->set(f
, edited
);
483 f
->value
= xstrdup(edited
);
488 static void properties_cancel(GtkButton
attribute((unused
)) *button
,
489 gpointer
attribute((unused
)) userdata
) {
490 gtk_widget_destroy(properties_window
);
493 /** @brief Called on client reset
495 * Destroys the current properties window.
497 void properties_reset(void) {
498 if(properties_window
)
499 gtk_widget_destroy(properties_window
);