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 /* The type of a preference is the collection of callbacks needed to get,
65 * display and set it */
67 void (*kickoff
)(struct prefdata
*f
);
68 /* Kick off the request to fetch the pref from the server. */
70 void (*completed
)(struct prefdata
*f
);
71 /* Called when the value comes back in; creates the widget. */
73 const char *(*get_edited
)(struct prefdata
*f
);
74 /* Get the edited value from the widget. */
76 /** @brief Update the edited value */
77 void (*set_edited
)(struct prefdata
*f
, const char *value
);
79 void (*set
)(struct prefdata
*f
, const char *value
);
80 /* Set the new value and (if necessary) arrange for our display to update. */
84 static const struct preftype preftype_namepart
= {
93 static const struct preftype preftype_string
= {
102 static const struct preftype preftype_boolean
= {
110 /* @brief The known prefs for each track */
111 static const struct pref
{
112 const char *label
; /**< @brief user-level description */
113 const char *part
; /**< @brief protocol-level tag */
114 const char *default_value
; /**< @brief default value or NULL */
115 const struct preftype
*type
; /**< @brief underlying data type */
117 { "Artist", "artist", 0, &preftype_namepart
},
118 { "Album", "album", 0, &preftype_namepart
},
119 { "Title", "title", 0, &preftype_namepart
},
120 { "Tags", "tags", "", &preftype_string
},
121 { "Weight", "weight", "90000", &preftype_string
},
122 { "Random", "pick_at_random", "1", &preftype_boolean
},
125 #define NPREFS (int)(sizeof prefs / sizeof *prefs)
127 /* Buttons that appear at the bottom of the window */
128 static struct button buttons
[] = {
139 "Apply all changes and close window",
146 "Discard all changes and close window",
153 "Apply all changes and keep window open",
159 #define NBUTTONS (int)(sizeof buttons / sizeof *buttons)
161 static int prefs_unfilled
; /* Prefs remaining to get */
162 static int prefs_total
; /* Total prefs */
163 static struct prefdata
*prefdatas
; /* Current prefdatas */
164 static GtkWidget
*properties_window
;
165 static GtkWidget
*properties_table
;
166 static struct progress_window
*pw
;
167 static event_handle properties_event
;
169 static void propagate_clicked(GtkButton
attribute((unused
)) *button
,
171 struct prefdata
*f
= (struct prefdata
*)userdata
, *g
;
173 const char *value
= f
->p
->type
->get_edited(f
);
175 for(p
= 0; p
< prefs_total
; ++p
) {
177 if(f
->p
== g
->p
&& f
!= g
)
178 g
->p
->type
->set_edited(g
, value
);
182 /** @brief Keypress handler */
183 static gboolean
properties_keypress(GtkWidget
attribute((unused
)) *widget
,
185 gpointer
attribute((unused
)) user_data
) {
188 switch(event
->keyval
) {
193 properties_cancel(0, 0);
200 void properties(int ntracks
, const char **tracks
,
204 GtkWidget
*buttonbox
, *vbox
, *label
, *entry
, *propagate
;
206 /* If no tracks, do nothign */
209 /* If there is a properties window open then just bring it to the
210 * front. It might not have the right values in... */
211 if(properties_window
) {
213 gtk_window_present(GTK_WINDOW(properties_window
));
216 assert(properties_table
== 0);
217 if(ntracks
> INT_MAX
/ NPREFS
) {
218 popup_msg(GTK_MESSAGE_ERROR
, "Too many tracks selected");
221 properties_event
= event_register("logged-in", properties_logged_in
, 0);
222 /* Create a new properties window */
223 properties_window
= gtk_window_new(GTK_WINDOW_TOPLEVEL
);
224 gtk_widget_set_style(properties_window
, tool_style
);
225 g_signal_connect(properties_window
, "destroy",
226 G_CALLBACK(gtk_widget_destroyed
), &properties_window
);
227 /* Keyboard shortcuts */
228 g_signal_connect(properties_window
, "key-press-event",
229 G_CALLBACK(properties_keypress
), 0);
230 /* Most of the action is the table of preferences */
231 properties_table
= gtk_table_new((NPREFS
+ 1) * ntracks
, 2 + ntracks
> 1,
233 gtk_widget_set_style(properties_table
, tool_style
);
234 g_signal_connect(properties_table
, "destroy",
235 G_CALLBACK(gtk_widget_destroyed
), &properties_table
);
236 gtk_window_set_title(GTK_WINDOW(properties_window
), "Track Properties");
237 /* Create labels for each pref of each track and kick off requests to the
238 * server to fill in the values */
239 prefs_total
= NPREFS
* ntracks
;
240 prefdatas
= xcalloc(prefs_total
, sizeof *prefdatas
);
241 for(n
= 0; n
< ntracks
; ++n
) {
242 /* The track itself */
244 label
= gtk_label_new("Track");
245 gtk_widget_set_style(label
, tool_style
);
246 gtk_misc_set_alignment(GTK_MISC(label
), 1, 0);
247 gtk_table_attach(GTK_TABLE(properties_table
),
250 (NPREFS
+ 1) * n
, (NPREFS
+ 1) * n
+ 1,
254 entry
= gtk_entry_new();
255 gtk_widget_set_style(entry
, tool_style
);
256 gtk_entry_set_text(GTK_ENTRY(entry
), tracks
[n
]);
257 gtk_editable_set_editable(GTK_EDITABLE(entry
), FALSE
);
258 gtk_table_attach(GTK_TABLE(properties_table
),
261 (NPREFS
+ 1) * n
, (NPREFS
+ 1) * n
+ 1,
262 GTK_EXPAND
|GTK_FILL
, 0,
264 /* Each preference */
265 for(m
= 0; m
< NPREFS
; ++m
) {
267 label
= gtk_label_new(prefs
[m
].label
);
268 gtk_widget_set_style(label
, tool_style
);
269 gtk_misc_set_alignment(GTK_MISC(label
), 1, 0);
270 gtk_table_attach(GTK_TABLE(properties_table
),
273 (NPREFS
+ 1) * n
+ 1 + m
, (NPREFS
+ 1) * n
+ 2 + m
,
274 GTK_FILL
/*xoptions*/, 0/*yoptions*/,
276 /* Editing the preference is specific */
277 f
= &prefdatas
[NPREFS
* n
+ m
];
278 f
->track
= tracks
[n
];
279 f
->row
= (NPREFS
+ 1) * n
+ 1 + m
;
281 prefs
[m
].type
->kickoff(f
);
283 /* Propagation button */
284 propagate
= iconbutton("propagate.png", "Copy to other tracks");
285 g_signal_connect(G_OBJECT(propagate
), "clicked",
286 G_CALLBACK(propagate_clicked
), f
);
287 gtk_table_attach(GTK_TABLE(properties_table
),
289 2/*left*/, 3/*right*/,
290 (NPREFS
+ 1) * n
+ 1 + m
, (NPREFS
+ 1) * n
+ 2 + m
,
291 GTK_FILL
/*xoptions*/, 0/*yoptions*/,
292 1/*xpadding*/, 1/*ypadding*/);
296 prefs_unfilled
= prefs_total
;
298 buttonbox
= create_buttons(buttons
, NBUTTONS
);
299 /* Put it all together */
300 vbox
= gtk_vbox_new(FALSE
, 1);
301 gtk_box_pack_start(GTK_BOX(vbox
),
302 scroll_widget(properties_table
),
304 gtk_box_pack_start(GTK_BOX(vbox
), buttonbox
, FALSE
, FALSE
, 1);
305 gtk_container_add(GTK_CONTAINER(properties_window
), frame_widget(vbox
, NULL
));
306 /* The table only really wants to be vertically scrollable */
307 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table
)->parent
->parent
),
309 GTK_POLICY_AUTOMATIC
);
310 /* Zot any pre-existing progress window just in case */
312 progress_window_progress(pw
, 0, 0);
313 /* Pop up a progress bar while we're waiting */
314 while(parent
->parent
)
315 parent
= parent
->parent
;
316 pw
= progress_window_new("Fetching Track Properties", parent
);
319 /* Everything is filled in now */
320 static void prefdata_alldone(void) {
322 progress_window_progress(pw
, 0, 0);
325 /* Default size may be too small */
326 gtk_window_set_default_size(GTK_WINDOW(properties_window
), 480, 512);
327 /* TODO: relate default size to required size more closely */
328 gtk_widget_show_all(properties_window
);
331 /* Namepart preferences ---------------------------------------------------- */
333 static void kickoff_namepart(struct prefdata
*f
) {
334 /* We ask for the display name part. This is a bit bizarre if what we really
335 * wanted was the underlying preference, but in fact it should always match
336 * and will supply a sane default without having to know how to parse tracks
337 * names (which implies knowing collection roots). */
338 disorder_eclient_namepart(client
, prefdata_completed
,
339 f
->track
, "display", f
->p
->part
, f
);
342 static void completed_namepart(struct prefdata
*f
) {
347 f
->widget
= gtk_entry_new();
350 static const char *get_edited_namepart(struct prefdata
*f
) {
351 return gtk_entry_get_text(GTK_ENTRY(f
->widget
));
354 static void set_edited_namepart(struct prefdata
*f
, const char *value
) {
355 gtk_entry_set_text(GTK_ENTRY(f
->widget
), value
);
358 static void set_namepart(struct prefdata
*f
, const char *value
) {
361 byte_xasprintf(&s
, "trackname_display_%s", f
->p
->part
);
362 /* We don't know what the default is so can never unset. This is a bug
363 * relative to the original design, which is supposed to only ever allow for
364 * non-trivial namepart preferences. I suppose the server could spot a
365 * default being set and translate it into an unset. */
366 disorder_eclient_set(client
, set_namepart_completed
, f
->track
, s
, value
,
370 /* Called when we've set a namepart */
371 static void set_namepart_completed(void *v
, const char *err
) {
373 popup_protocol_error(0, err
);
375 struct prefdata
*f
= v
;
377 namepart_update(f
->track
, "display", f
->p
->part
);
381 /* String preferences ------------------------------------------------------ */
383 static void kickoff_string(struct prefdata
*f
) {
384 disorder_eclient_get(client
, prefdata_completed
, f
->track
, f
->p
->part
, f
);
387 static void completed_string(struct prefdata
*f
) {
389 /* No setting, use the default value instead */
390 f
->value
= f
->p
->default_value
;
391 f
->widget
= gtk_entry_new();
394 static const char *get_edited_string(struct prefdata
*f
) {
395 return gtk_entry_get_text(GTK_ENTRY(f
->widget
));
398 static void set_edited_string(struct prefdata
*f
, const char *value
) {
399 gtk_entry_set_text(GTK_ENTRY(f
->widget
), value
);
402 static void set_string_completed(void attribute((unused
)) *v
,
405 popup_protocol_error(0, err
);
408 static void set_string(struct prefdata
*f
, const char *value
) {
409 disorder_eclient_set(client
, set_string_completed
, f
->track
, f
->p
->part
,
413 /* Boolean preferences ----------------------------------------------------- */
415 static void kickoff_boolean(struct prefdata
*f
) {
416 disorder_eclient_get(client
, prefdata_completed
, f
->track
, f
->p
->part
, f
);
419 static void completed_boolean(struct prefdata
*f
) {
420 f
->widget
= gtk_check_button_new();
421 gtk_widget_set_style(f
->widget
, tool_style
);
423 /* Not set, use the default */
424 f
->value
= f
->p
->default_value
;
427 static const char *get_edited_boolean(struct prefdata
*f
) {
428 return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f
->widget
))
432 static void set_edited_boolean(struct prefdata
*f
, const char *value
) {
433 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f
->widget
),
437 #define set_boolean_completed set_string_completed
439 static void set_boolean(struct prefdata
*f
, const char *value
) {
442 byte_xasprintf(&s
, "trackname_display_%s", f
->p
->part
);
443 disorder_eclient_set(client
, set_boolean_completed
,
444 f
->track
, f
->p
->part
, value
, 0/*v*/);
447 /* Querying preferences ---------------------------------------------------- */
449 static void prefdata_completed(void *v
, const char *err
, const char *value
) {
450 struct prefdata
*const f
= v
;
453 popup_protocol_error(0, err
);
455 f
->p
->type
->completed(f
);
456 f
->p
->type
->set_edited(f
, f
->value
);
457 assert(f
->value
!= 0); /* Had better set a default */
458 gtk_table_attach(GTK_TABLE(properties_table
), f
->widget
,
461 GTK_EXPAND
|GTK_FILL
/*xoptions*/, 0/*yoptions*/,
465 progress_window_progress(pw
, prefs_total
- prefs_unfilled
, prefs_total
);
470 /* Button callbacks -------------------------------------------------------- */
472 static void properties_ok(GtkButton
*button
,
474 properties_apply(button
, userdata
);
475 properties_cancel(button
, userdata
);
478 static void properties_apply(GtkButton
attribute((unused
)) *button
,
479 gpointer
attribute((unused
)) userdata
) {
484 /* For each possible property we see if we've changed it and if so tell the
486 for(n
= 0; n
< prefs_total
; ++n
) {
488 edited
= f
->p
->type
->get_edited(f
);
489 if(strcmp(edited
, f
->value
)) {
490 /* The value has changed */
491 f
->p
->type
->set(f
, edited
);
492 f
->value
= xstrdup(edited
);
497 static void properties_cancel(GtkButton
attribute((unused
)) *button
,
498 gpointer
attribute((unused
)) userdata
) {
499 gtk_widget_destroy(properties_window
);
500 event_cancel(properties_event
);
501 properties_event
= 0;
504 static void properties_help(GtkButton
attribute((unused
)) *button
,
505 gpointer
attribute((unused
)) userdata
) {
506 popup_help("properties.html");
509 /** @brief Called when we've just logged in
511 * Destroys the current properties window.
513 static void properties_logged_in(const char attribute((unused
)) *event
,
514 void attribute((unused
)) *eventdata
,
515 void attribute((unused
)) *callbackdata
) {
516 if(properties_window
)
517 gtk_widget_destroy(properties_window
);