X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/7c82ecb820073aa894f9b41442fdf910c19accdb..HEAD:/disobedience/properties.c diff --git a/disobedience/properties.c b/disobedience/properties.c index 96d5c48..ded862b 100644 --- a/disobedience/properties.c +++ b/disobedience/properties.c @@ -1,27 +1,25 @@ /* * This file is part of DisOrder. - * Copyright (C) 2006, 2007 Richard Kettlewell + * Copyright (C) 2006-2008 Richard Kettlewell * - * This program is free software; you can redistribute it and/or modify + * 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 - * the Free Software Foundation; either version 2 of the License, or + * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 - * USA + * along with this program. If not, see . + */ +/** @file disobedience/properties.c + * @brief Track properties editor */ - #include "disobedience.h" -/* Track properties -------------------------------------------------------- */ - struct prefdata; static void kickoff_namepart(struct prefdata *f); @@ -29,7 +27,7 @@ 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 set_namepart_completed(void *v, const char *err); static void kickoff_string(struct prefdata *f); static void completed_string(struct prefdata *f); @@ -43,17 +41,16 @@ 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); -static void prefdata_onerror(struct callbackdata *cbd, - int code, - const char *msg); -static struct callbackdata *make_callbackdata(struct prefdata *f); -static void prefdata_completed_common(struct prefdata *f, - const char *value); +static void prefdata_completed(void *v, const char *err, const char *value); static void properties_ok(GtkButton *button, gpointer userdata); static void properties_apply(GtkButton *button, gpointer userdata); static void properties_cancel(GtkButton *button, gpointer userdata); +static void properties_help(GtkButton *button, gpointer userdata); + +static void properties_logged_in(const char *event, + void *eventdata, + void *callbackdata); /** @brief Data for a single preference */ struct prefdata { @@ -64,23 +61,26 @@ struct prefdata { GtkWidget *widget; }; -/* The type of a preference is the collection of callbacks needed to get, - * display and set it */ +/** @brief Type of a track preference + * + * The type of a preference is the collection of callbacks needed to get, + * display and set it. + */ struct preftype { + /** @brief Kick off the request to fetch the pref from the server. */ void (*kickoff)(struct prefdata *f); - /* Kick off the request to fetch the pref from the server. */ + /** @brief Called when the value comes back in; creates the widget. */ void (*completed)(struct prefdata *f); - /* Called when the value comes back in; creates the widget. */ + /** @brief Get the edited value from the widget. */ 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); + /** @brief Set the new value and (if necessary) arrange for our display to update. */ void (*set)(struct prefdata *f, const char *value); - /* Set the new value and (if necessary) arrange for our display to update. */ }; /* A namepart pref */ @@ -110,7 +110,7 @@ static const struct preftype preftype_boolean = { set_boolean }; -/* @brief The known prefs for each track */ +/** @brief The known prefs for each track */ static const struct pref { const char *label; /**< @brief user-level description */ const char *part; /**< @brief protocol-level tag */ @@ -129,23 +129,33 @@ static const struct pref { /* Buttons that appear at the bottom of the window */ static struct button buttons[] = { + { + GTK_STOCK_HELP, + properties_help, + "Go to manual", + 0, + gtk_box_pack_start, + }, { GTK_STOCK_OK, properties_ok, "Apply all changes and close window", - 0 - }, - { - GTK_STOCK_APPLY, - properties_apply, - "Apply all changes and keep window open", - 0 + 0, + gtk_box_pack_end, }, { GTK_STOCK_CANCEL, properties_cancel, "Discard all changes and close window", - 0 + 0, + gtk_box_pack_end + }, + { + GTK_STOCK_APPLY, + properties_apply, + "Apply all changes and keep window open", + 0, + gtk_box_pack_end, }, }; @@ -157,6 +167,7 @@ static struct prefdata *prefdatas; /* Current prefdatas */ static GtkWidget *properties_window; static GtkWidget *properties_table; static struct progress_window *pw; +static event_handle properties_event; static void propagate_clicked(GtkButton attribute((unused)) *button, gpointer userdata) { @@ -171,7 +182,26 @@ static void propagate_clicked(GtkButton attribute((unused)) *button, } } -void properties(int ntracks, const char **tracks) { +/** @brief Keypress handler */ +static gboolean properties_keypress(GtkWidget attribute((unused)) *widget, + GdkEventKey *event, + gpointer attribute((unused)) user_data) { + if(event->state) + return FALSE; + switch(event->keyval) { + case GDK_Return: + properties_ok(0, 0); + return TRUE; + case GDK_Escape: + properties_cancel(0, 0); + return TRUE; + default: + return FALSE; + } +} + +void properties(int ntracks, const char **tracks, + GtkWidget *parent) { int n, m; struct prefdata *f; GtkWidget *buttonbox, *vbox, *label, *entry, *propagate; @@ -191,11 +221,15 @@ void properties(int ntracks, const char **tracks) { popup_msg(GTK_MESSAGE_ERROR, "Too many tracks selected"); return; } + properties_event = event_register("logged-in", properties_logged_in, 0); /* 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); + /* Keyboard shortcuts */ + g_signal_connect(properties_window, "key-press-event", + G_CALLBACK(properties_keypress), 0); /* Most of the action is the table of preferences */ properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1, FALSE); @@ -280,7 +314,9 @@ void properties(int ntracks, const char **tracks) { if(pw) progress_window_progress(pw, 0, 0); /* Pop up a progress bar while we're waiting */ - pw = progress_window_new("Fetching Track Properties"); + while(parent->parent) + parent = parent->parent; + pw = progress_window_new("Fetching Track Properties", parent); } /* Everything is filled in now */ @@ -302,8 +338,8 @@ static void kickoff_namepart(struct prefdata *f) { * 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)); + disorder_eclient_part(client, prefdata_completed, + f->track, "display", f->p->part, f); } static void completed_namepart(struct prefdata *f) { @@ -324,31 +360,31 @@ static void set_edited_namepart(struct prefdata *f, const char *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); /* 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); + f); } /* Called when we've set a namepart */ -static void set_namepart_completed(void *v) { - struct callbackdata *cbd = v; - struct prefdata *f = cbd->u.f; - - namepart_update(f->track, "display", f->p->part); +static void set_namepart_completed(void *v, const char *err) { + if(err) + popup_protocol_error(0, err); + else { + struct prefdata *f = v; + + namepart_update(f->track, "display", f->p->part); + } } /* String preferences ------------------------------------------------------ */ static void kickoff_string(struct prefdata *f) { - disorder_eclient_get(client, prefdata_completed, f->track, f->p->part, - make_callbackdata(f)); + disorder_eclient_get(client, prefdata_completed, f->track, f->p->part, f); } static void completed_string(struct prefdata *f) { @@ -366,22 +402,21 @@ static void set_edited_string(struct prefdata *f, const char *value) { gtk_entry_set_text(GTK_ENTRY(f->widget), value); } +static void set_string_completed(void attribute((unused)) *v, + const char *err) { + if(err) + popup_protocol_error(0, err); +} + static void set_string(struct prefdata *f, const char *value) { - if(strcmp(f->p->default_value, value)) - /* Different from default, set it */ - disorder_eclient_set(client, 0/*completed*/, f->track, f->p->part, - value, 0/*v*/); - else - /* Same as default, just unset */ - disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part, - 0/*v*/); + disorder_eclient_set(client, set_string_completed, f->track, f->p->part, + value, 0/*v*/); } /* Boolean preferences ----------------------------------------------------- */ static void kickoff_boolean(struct prefdata *f) { - disorder_eclient_get(client, prefdata_completed, f->track, f->p->part, - make_callbackdata(f)); + disorder_eclient_get(client, prefdata_completed, f->track, f->p->part, f); } static void completed_boolean(struct prefdata *f) { @@ -402,46 +437,23 @@ static void set_edited_boolean(struct prefdata *f, const char *value) { strcmp(value, "0")); } +#define set_boolean_completed set_string_completed + static void set_boolean(struct prefdata *f, const char *value) { char *s; byte_xasprintf(&s, "trackname_display_%s", f->p->part); - if(strcmp(value, f->p->default_value)) - disorder_eclient_set(client, 0/*completed*/, f->track, f->p->part, value, - 0/*v*/); - else - /* If default value then delete the pref */ - disorder_eclient_unset(client, 0/*completed*/, f->track, f->p->part, - 0/*v*/); + disorder_eclient_set(client, set_boolean_completed, + f->track, f->p->part, value, 0/*v*/); } /* Querying preferences ---------------------------------------------------- */ -/* Make a suitable callbackdata */ -static struct callbackdata *make_callbackdata(struct prefdata *f) { - struct callbackdata *cbd = xmalloc(sizeof *cbd); +static void prefdata_completed(void *v, const char *err, const char *value) { + struct prefdata *const f = v; - cbd->onerror = prefdata_onerror; - cbd->u.f = f; - return cbd; -} - -/* No pref was set */ -static void prefdata_onerror(struct callbackdata *cbd, - int attribute((unused)) code, - const char attribute((unused)) *msg) { - prefdata_completed_common(cbd->u.f, 0); -} - -/* Got the value of a pref */ -static void prefdata_completed(void *v, const char *value) { - struct callbackdata *cbd = v; - - prefdata_completed_common(cbd->u.f, value); -} - -static void prefdata_completed_common(struct prefdata *f, - const char *value) { + if(err) + popup_protocol_error(0, err); f->value = value; f->p->type->completed(f); f->p->type->set_edited(f, f->value); @@ -488,13 +500,22 @@ static void properties_apply(GtkButton attribute((unused)) *button, static void properties_cancel(GtkButton attribute((unused)) *button, gpointer attribute((unused)) userdata) { gtk_widget_destroy(properties_window); + event_cancel(properties_event); + properties_event = 0; +} + +static void properties_help(GtkButton attribute((unused)) *button, + gpointer attribute((unused)) userdata) { + popup_help("properties.html"); } -/** @brief Called on client reset +/** @brief Called when we've just logged in * * Destroys the current properties window. */ -void properties_reset(void) { +static void properties_logged_in(const char attribute((unused)) *event, + void attribute((unused)) *eventdata, + void attribute((unused)) *callbackdata) { if(properties_window) gtk_widget_destroy(properties_window); }