X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/460b9539a7c15580e41a71bbc0f47ae776238915..e9e8a16d359c900f114853eb0e407a8064e4350c:/disobedience/properties.c diff --git a/disobedience/properties.c b/disobedience/properties.c index ae945be..7ec9042 100644 --- a/disobedience/properties.c +++ b/disobedience/properties.c @@ -1,6 +1,6 @@ /* * This file is part of DisOrder. - * Copyright (C) 2006 Richard Kettlewell + * Copyright (C) 2006, 2007 Richard Kettlewell * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -27,17 +27,20 @@ struct prefdata; static void kickoff_namepart(struct prefdata *f); static void completed_namepart(struct prefdata *f); static const char *get_edited_namepart(struct prefdata *f); +static void set_edited_namepart(struct prefdata *f, const char *value); static void set_namepart(struct prefdata *f, const char *value); static void set_namepart_completed(void *v); static void kickoff_string(struct prefdata *f); static void completed_string(struct prefdata *f); static const char *get_edited_string(struct prefdata *f); +static void set_edited_string(struct prefdata *f, const char *value); static void set_string(struct prefdata *f, const char *value); static void kickoff_boolean(struct prefdata *f); static void completed_boolean(struct prefdata *f); static const char *get_edited_boolean(struct prefdata *f); +static void set_edited_boolean(struct prefdata *f, const char *value); static void set_boolean(struct prefdata *f, const char *value); static void prefdata_completed(void *v, const char *value); @@ -52,12 +55,12 @@ static void properties_ok(GtkButton *button, gpointer userdata); static void properties_apply(GtkButton *button, gpointer userdata); static void properties_cancel(GtkButton *button, gpointer userdata); -/* Data for a single preference */ +/** @brief Data for a single preference */ struct prefdata { const char *track; int row; - const struct pref *p; - const char *value; + const struct pref *p; /**< @brief kind of preference */ + const char *value; /**< @brief value from server */ GtkWidget *widget; }; @@ -73,6 +76,9 @@ struct preftype { const char *(*get_edited)(struct prefdata *f); /* Get the edited value from the widget. */ + /** @brief Update the edited value */ + void (*set_edited)(struct prefdata *f, const char *value); + void (*set)(struct prefdata *f, const char *value); /* Set the new value and (if necessary) arrange for our display to update. */ }; @@ -82,6 +88,7 @@ static const struct preftype preftype_namepart = { kickoff_namepart, completed_namepart, get_edited_namepart, + set_edited_namepart, set_namepart }; @@ -90,6 +97,7 @@ static const struct preftype preftype_string = { kickoff_string, completed_string, get_edited_string, + set_edited_string, set_string }; @@ -98,15 +106,16 @@ static const struct preftype preftype_boolean = { kickoff_boolean, completed_boolean, get_edited_boolean, + set_edited_boolean, set_boolean }; -/* The known prefs for each track */ +/* @brief The known prefs for each track */ static const struct pref { - const char *label; - const char *part; - const char *default_value; - const struct preftype *type; + const char *label; /**< @brief user-level description */ + const char *part; /**< @brief protocol-level tag */ + const char *default_value; /**< @brief default value or NULL */ + const struct preftype *type; /**< @brief underlying data type */ } prefs[] = { { "Artist", "artist", 0, &preftype_namepart }, { "Album", "album", 0, &preftype_namepart }, @@ -118,13 +127,22 @@ static const struct pref { #define NPREFS (int)(sizeof prefs / sizeof *prefs) /* Buttons that appear at the bottom of the window */ -static const struct button { - const gchar *stock; - void (*clicked)(GtkButton *button, gpointer userdata); -} buttons[] = { - { GTK_STOCK_OK, properties_ok }, - { GTK_STOCK_APPLY, properties_apply }, - { GTK_STOCK_CANCEL, properties_cancel }, +static const struct button buttons[] = { + { + GTK_STOCK_OK, + properties_ok, + "Apply all changes and close window" + }, + { + GTK_STOCK_APPLY, + properties_apply, + "Apply all changes and keep window open" + }, + { + GTK_STOCK_CANCEL, + properties_cancel, + "Discard all changes and close window" + }, }; #define NBUTTONS (int)(sizeof buttons / sizeof *buttons) @@ -134,13 +152,29 @@ static int prefs_total; /* Total prefs */ static struct prefdata *prefdatas; /* Current prefdatas */ static GtkWidget *properties_window; static GtkWidget *properties_table; -static GtkWidget *progress_window, *progress_bar; +static struct progress_window *pw; + +static void propagate_clicked(GtkButton attribute((unused)) *button, + gpointer userdata) { + struct prefdata *f = (struct prefdata *)userdata, *g; + int p; + const char *value = f->p->type->get_edited(f); + + for(p = 0; p < prefs_total; ++p) { + g = &prefdatas[p]; + if(f->p == g->p && f != g) + g->p->type->set_edited(g, value); + } +} -void properties(int ntracks, char **tracks) { +void properties(int ntracks, const char **tracks) { int n, m; struct prefdata *f; - GtkWidget *hbox, *vbox, *button, *label, *entry; - + GtkWidget *buttonbox, *vbox, *label, *entry, *propagate; + + /* If no tracks, do nothign */ + if(!ntracks) + return; /* If there is a properties window open then just bring it to the * front. It might not have the right values in... */ if(properties_window) { @@ -150,15 +184,18 @@ void properties(int ntracks, char **tracks) { } assert(properties_table == 0); if(ntracks > INT_MAX / NPREFS) { - popup_error("Too many tracks selected"); + popup_msg(GTK_MESSAGE_ERROR, "Too many tracks selected"); return; } /* Create a new properties window */ properties_window = gtk_window_new(GTK_WINDOW_TOPLEVEL); + gtk_widget_set_style(properties_window, tool_style); g_signal_connect(properties_window, "destroy", G_CALLBACK(gtk_widget_destroyed), &properties_window); /* Most of the action is the table of preferences */ - properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2, FALSE); + properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1, + FALSE); + gtk_widget_set_style(properties_table, tool_style); g_signal_connect(properties_table, "destroy", G_CALLBACK(gtk_widget_destroyed), &properties_table); gtk_window_set_title(GTK_WINDOW(properties_window), "Track Properties"); @@ -167,7 +204,10 @@ void properties(int ntracks, char **tracks) { prefs_total = NPREFS * ntracks; prefdatas = xcalloc(prefs_total, sizeof *prefdatas); for(n = 0; n < ntracks; ++n) { + /* The track itself */ + /* Caption */ label = gtk_label_new("Track"); + gtk_widget_set_style(label, tool_style); gtk_misc_set_alignment(GTK_MISC(label), 1, 0); gtk_table_attach(GTK_TABLE(properties_table), label, @@ -175,7 +215,9 @@ void properties(int ntracks, char **tracks) { (NPREFS + 1) * n, (NPREFS + 1) * n + 1, GTK_FILL, 0, 1, 1); + /* The track name */ entry = gtk_entry_new(); + gtk_widget_set_style(entry, tool_style); gtk_entry_set_text(GTK_ENTRY(entry), tracks[n]); gtk_editable_set_editable(GTK_EDITABLE(entry), FALSE); gtk_table_attach(GTK_TABLE(properties_table), @@ -184,8 +226,11 @@ void properties(int ntracks, char **tracks) { (NPREFS + 1) * n, (NPREFS + 1) * n + 1, GTK_EXPAND|GTK_FILL, 0, 1, 1); + /* Each preference */ for(m = 0; m < NPREFS; ++m) { + /* Caption */ label = gtk_label_new(prefs[m].label); + gtk_widget_set_style(label, tool_style); gtk_misc_set_alignment(GTK_MISC(label), 1, 0); gtk_table_attach(GTK_TABLE(properties_table), label, @@ -193,50 +238,53 @@ void properties(int ntracks, char **tracks) { (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m, GTK_FILL/*xoptions*/, 0/*yoptions*/, 1, 1); + /* Editing the preference is specific */ f = &prefdatas[NPREFS * n + m]; f->track = tracks[n]; f->row = (NPREFS + 1) * n + 1 + m; f->p = &prefs[m]; prefs[m].type->kickoff(f); + if(ntracks > 1) { + /* Propagation button */ + propagate = iconbutton("propagate.png", "Copy to other tracks"); + g_signal_connect(G_OBJECT(propagate), "clicked", + G_CALLBACK(propagate_clicked), f); + gtk_table_attach(GTK_TABLE(properties_table), + propagate, + 2/*left*/, 3/*right*/, + (NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m, + GTK_FILL/*xoptions*/, 0/*yoptions*/, + 1/*xpadding*/, 1/*ypadding*/); + } } } prefs_unfilled = prefs_total; /* Buttons */ - hbox = gtk_hbox_new(FALSE, 1); - for(n = 0; n < NBUTTONS; ++n) { - button = gtk_button_new_from_stock(buttons[n].stock); - g_signal_connect(G_OBJECT(button), "clicked", - G_CALLBACK(buttons[n].clicked), 0); - gtk_box_pack_start(GTK_BOX(hbox), button, FALSE, FALSE, 1); - } + buttonbox = create_buttons(buttons, NBUTTONS); /* Put it all together */ vbox = gtk_vbox_new(FALSE, 1); gtk_box_pack_start(GTK_BOX(vbox), - scroll_widget(properties_table, - "properties"), + scroll_widget(properties_table), TRUE, TRUE, 1); - gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 1); + gtk_box_pack_start(GTK_BOX(vbox), buttonbox, FALSE, FALSE, 1); gtk_container_add(GTK_CONTAINER(properties_window), vbox); /* The table only really wants to be vertically scrollable */ gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table)->parent->parent), GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC); + /* Zot any pre-existing progress window just in case */ + if(pw) + progress_window_progress(pw, 0, 0); /* Pop up a progress bar while we're waiting */ - progress_window = gtk_window_new(GTK_WINDOW_TOPLEVEL); - g_signal_connect(progress_window, "destroy", - G_CALLBACK(gtk_widget_destroyed), &progress_window); - gtk_window_set_default_size(GTK_WINDOW(progress_window), 360, -1); - gtk_window_set_title(GTK_WINDOW(progress_window), - "Fetching Track Properties"); - progress_bar = gtk_progress_bar_new(); - gtk_container_add(GTK_CONTAINER(progress_window), progress_bar); - gtk_widget_show_all(progress_window); + pw = progress_window_new("Fetching Track Properties"); } /* Everything is filled in now */ static void prefdata_alldone(void) { - if(progress_window) - gtk_widget_destroy(progress_window); + if(pw) { + progress_window_progress(pw, 0, 0); + pw = 0; + } /* Default size may be too small */ gtk_window_set_default_size(GTK_WINDOW(properties_window), 480, 512); /* TODO: relate default size to required size more closely */ @@ -246,38 +294,42 @@ static void prefdata_alldone(void) { /* Namepart preferences ---------------------------------------------------- */ static void kickoff_namepart(struct prefdata *f) { - char *s; - - byte_xasprintf(&s, "trackname_display_%s", f->p->part); - disorder_eclient_get(client, prefdata_completed, f->track, s, - make_callbackdata(f)); + /* We ask for the display name part. This is a bit bizarre if what we really + * wanted was the underlying preference, but in fact it should always match + * and will supply a sane default without having to know how to parse tracks + * names (which implies knowing collection roots). */ + disorder_eclient_namepart(client, prefdata_completed, f->track, "display", f->p->part, + make_callbackdata(f)); } static void completed_namepart(struct prefdata *f) { - if(!f->value) - /* No setting, use the computed default value instead */ - f->value = trackname_part(f->track, "display", f->p->part); + if(!f->value) { + /* No setting */ + f->value = ""; + } f->widget = gtk_entry_new(); - gtk_entry_set_text(GTK_ENTRY(f->widget), f->value); } static const char *get_edited_namepart(struct prefdata *f) { return gtk_entry_get_text(GTK_ENTRY(f->widget)); } +static void set_edited_namepart(struct prefdata *f, const char *value) { + gtk_entry_set_text(GTK_ENTRY(f->widget), value); +} + static void set_namepart(struct prefdata *f, const char *value) { char *s; struct callbackdata *cbd = xmalloc(sizeof *cbd); cbd->u.f = f; byte_xasprintf(&s, "trackname_display_%s", f->p->part); - if(strcmp(trackname_part(f->track, "display", f->p->part), value)) - /* Different from default, set it */ - disorder_eclient_set(client, set_namepart_completed, f->track, s, value, - cbd); - else - /* Same as default, just unset */ - disorder_eclient_unset(client, set_namepart_completed, f->track, s, cbd); + /* We don't know what the default is so can never unset. This is a bug + * relative to the original design, which is supposed to only ever allow for + * non-trivial namepart preferences. I suppose the server could spot a + * default being set and translate it into an unset. */ + disorder_eclient_set(client, set_namepart_completed, f->track, s, value, + cbd); } /* Called when we've set a namepart */ @@ -300,13 +352,16 @@ static void completed_string(struct prefdata *f) { /* No setting, use the default value instead */ f->value = f->p->default_value; f->widget = gtk_entry_new(); - gtk_entry_set_text(GTK_ENTRY(f->widget), f->value); } static const char *get_edited_string(struct prefdata *f) { return gtk_entry_get_text(GTK_ENTRY(f->widget)); } +static void set_edited_string(struct prefdata *f, const char *value) { + gtk_entry_set_text(GTK_ENTRY(f->widget), value); +} + static void set_string(struct prefdata *f, const char *value) { if(strcmp(f->p->default_value, value)) /* Different from default, set it */ @@ -327,11 +382,10 @@ static void kickoff_boolean(struct prefdata *f) { static void completed_boolean(struct prefdata *f) { f->widget = gtk_check_button_new(); + gtk_widget_set_style(f->widget, tool_style); if(!f->value) /* Not set, use the default */ f->value = f->p->default_value; - gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget), - strcmp(f->value, "0")); } static const char *get_edited_boolean(struct prefdata *f) { @@ -339,6 +393,11 @@ static const char *get_edited_boolean(struct prefdata *f) { ? "1" : "0"); } +static void set_edited_boolean(struct prefdata *f, const char *value) { + gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget), + strcmp(value, "0")); +} + static void set_boolean(struct prefdata *f, const char *value) { char *s; @@ -381,6 +440,7 @@ static void prefdata_completed_common(struct prefdata *f, const char *value) { f->value = value; f->p->type->completed(f); + f->p->type->set_edited(f, f->value); assert(f->value != 0); /* Had better set a default */ gtk_table_attach(GTK_TABLE(properties_table), f->widget, 1, 2, @@ -388,9 +448,8 @@ static void prefdata_completed_common(struct prefdata *f, GTK_EXPAND|GTK_FILL/*xoptions*/, 0/*yoptions*/, 1, 1); --prefs_unfilled; - if(prefs_total && progress_window) - gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(progress_bar), - 1.0 - (double)prefs_unfilled / prefs_total); + if(prefs_total) + progress_window_progress(pw, prefs_total - prefs_unfilled, prefs_total); if(!prefs_unfilled) prefdata_alldone(); } @@ -427,6 +486,15 @@ static void properties_cancel(GtkButton attribute((unused)) *button, gtk_widget_destroy(properties_window); } +/** @brief Called on client reset + * + * Destroys the current properties window. + */ +void properties_reset(void) { + if(properties_window) + gtk_widget_destroy(properties_window); +} + /* Local Variables: c-basic-offset:2 @@ -435,4 +503,3 @@ fill-column:79 indent-tabs-mode:nil End: */ -/* arch-tag:+COG6p7PaNPZjzknPrKdcw */