[disorder] / disobedience / properties.c

/*
 * This file is part of DisOrder.
 * Copyright (C) 2006-2008 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
 * the Free Software Foundation; either version 2 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.
 *
 * 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
 */
/** @file disobedience/properties.c
 * @brief Track properties editor
 */
#include "disobedience.h"

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, const char *err);

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 *err, 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 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_logged_in(const char *event,
                                 void *eventdata,
                                 void *callbackdata);

/** @brief Data for a single preference */
struct prefdata {
  const char *track;
  int row;
  const struct pref *p;                 /**< @brief kind of preference */
  const char *value;                    /**< @brief value from server  */
  GtkWidget *widget;
};

/* The type of a preference is the collection of callbacks needed to get,
 * display and set it */
struct preftype {
  void (*kickoff)(struct prefdata *f);
  /* Kick off the request to fetch the pref from the server. */

  void (*completed)(struct prefdata *f);
  /* Called when the value comes back in; creates 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);

  void (*set)(struct prefdata *f, const char *value);
  /* Set the new value and (if necessary) arrange for our display to update. */
};

/* A namepart pref */
static const struct preftype preftype_namepart = {
  kickoff_namepart,
  completed_namepart,
  get_edited_namepart,
  set_edited_namepart,
  set_namepart
};

/* A string pref */
static const struct preftype preftype_string = {
  kickoff_string,
  completed_string,
  get_edited_string,
  set_edited_string,
  set_string
};

/* A boolean pref */
static const struct preftype preftype_boolean = {
  kickoff_boolean,
  completed_boolean,
  get_edited_boolean,
  set_edited_boolean,
  set_boolean
};

/* @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 */
  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 },
  { "Title", "title", 0, &preftype_namepart },
  { "Tags", "tags", "", &preftype_string },
  { "Weight", "weight", "90000", &preftype_string },
  { "Random", "pick_at_random", "1", &preftype_boolean },
};

#define NPREFS (int)(sizeof prefs / sizeof *prefs)

/* Buttons that appear at the bottom of the window */
static struct button buttons[] = {
  {
    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
  },
  {
    GTK_STOCK_CANCEL,
    properties_cancel,
    "Discard all changes and close window",
    0
  },
};

#define NBUTTONS (int)(sizeof buttons / sizeof *buttons)

static int prefs_unfilled;              /* Prefs remaining to get */
static int prefs_total;                 /* Total prefs */
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) {
  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);
  }
}

/** @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) {
  int n, m;
  struct prefdata *f;
  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) {
    if(!prefs_unfilled)
      gtk_window_present(GTK_WINDOW(properties_window));
    return;
  }
  assert(properties_table == 0);
  if(ntracks > INT_MAX / NPREFS) {
    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);
  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");
  /* Create labels for each pref of each track and kick off requests to the
   * server to fill in the values */
  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,
		     0, 1,
		     (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),
                     entry,
		     1, 2,
		     (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,
		       0, 1,
		       (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 */
  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),
                     TRUE, TRUE, 1);
  gtk_box_pack_start(GTK_BOX(vbox), buttonbox, FALSE, FALSE, 1);
  gtk_container_add(GTK_CONTAINER(properties_window), frame_widget(vbox, NULL));
  /* 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 */
  pw = progress_window_new("Fetching Track Properties");
}

/* Everything is filled in now */
static void prefdata_alldone(void) {
  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 */
  gtk_widget_show_all(properties_window);
}

/* Namepart preferences ---------------------------------------------------- */

static void kickoff_namepart(struct prefdata *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 */
    f->value = "";
  }
  f->widget = gtk_entry_new();
}

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;

  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,
                       f);
}

/* Called when we've set a namepart */
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));
}

static void completed_string(struct prefdata *f) {
  if(!f->value)
    /* No setting, use the default value instead */
    f->value = f->p->default_value;
  f->widget = gtk_entry_new();
}

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_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) {
  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));
}

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;
}

static const char *get_edited_boolean(struct prefdata *f) {
  return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f->widget))
          ? "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"));
}

#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);
  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);

  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 *err, const char *value) {
  if(err) {
  } else {
    struct callbackdata *cbd = v;
    
    prefdata_completed_common(cbd->u.f, value);
  }
}

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,
                   f->row, f->row + 1,
                   GTK_EXPAND|GTK_FILL/*xoptions*/, 0/*yoptions*/,
                   1, 1);
  --prefs_unfilled;
  if(prefs_total)
    progress_window_progress(pw, prefs_total - prefs_unfilled, prefs_total);
  if(!prefs_unfilled)
    prefdata_alldone();
}

/* Button callbacks -------------------------------------------------------- */

static void properties_ok(GtkButton *button, 
                          gpointer userdata) {
  properties_apply(button, userdata);
  properties_cancel(button, userdata);
}

static void properties_apply(GtkButton attribute((unused)) *button, 
                             gpointer attribute((unused)) userdata) {
  int n;
  const char *edited;
  struct prefdata *f;

  /* For each possible property we see if we've changed it and if so tell the
   * server */
  for(n = 0; n < prefs_total; ++n) {
    f = &prefdatas[n];
    edited = f->p->type->get_edited(f);
    if(strcmp(edited, f->value)) {
      /* The value has changed */
      f->p->type->set(f, edited);
      f->value = xstrdup(edited);
    }
  }
}

static void properties_cancel(GtkButton attribute((unused)) *button,
                              gpointer attribute((unused)) userdata) {
  gtk_widget_destroy(properties_window);
  event_cancel(properties_event);
  properties_event = 0;
}

/** @brief Called when we've just logged in
 *
 * Destroys the current properties window.
 */
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);
}

/*
Local Variables:
c-basic-offset:2
comment-column:40
fill-column:79
indent-tabs-mode:nil
End:
*/
Commit	Line	Data
460b9539	1	/*
460b9539	2	* This file is part of DisOrder.
d62c03cd	3	* Copyright (C) 2006-2008 Richard Kettlewell
460b9539	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	*/
d62c03cd RK	20	/** @file disobedience/properties.c
d62c03cd RK	21	* @brief Track properties editor
d62c03cd	22	*/
460b9539	23	#include "disobedience.h"
460b9539	24
460b9539	25	struct prefdata;
	26
	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);
348ef780	30	static void set_edited_namepart(struct prefdata f, const char value);
460b9539	31	static void set_namepart(struct prefdata f, const char value);
e2717131	32	static void set_namepart_completed(void v, const char err);
460b9539	33
	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);
348ef780	37	static void set_edited_string(struct prefdata f, const char value);
460b9539	38	static void set_string(struct prefdata f, const char value);
	39
	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);
348ef780	43	static void set_edited_boolean(struct prefdata f, const char value);
460b9539	44	static void set_boolean(struct prefdata f, const char value);
460b9539	45
e2717131	46	static void prefdata_completed(void v, const char err, const char *value);
460b9539	47	static void prefdata_onerror(struct callbackdata *cbd,
	48	int code,
	49	const char *msg);
	50	static struct callbackdata make_callbackdata(struct prefdata f);
	51	static void prefdata_completed_common(struct prefdata *f,
	52	const char *value);
	53
	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);
	57
7c30fc75 RK	58	static void properties_logged_in(const char *event,
	59	void *eventdata,
	60	void *callbackdata);
	61
13aba192	62	/** @brief Data for a single preference */
460b9539	63	struct prefdata {
	64	const char *track;
	65	int row;
13aba192	66	const struct pref p; /< @brief kind of preference /
13aba192	67	const char value; /< @brief value from server /
460b9539	68	GtkWidget *widget;
	69	};
	70
	71	/* The type of a preference is the collection of callbacks needed to get,
	72	* display and set it */
	73	struct preftype {
	74	void (kickoff)(struct prefdata f);
	75	/* Kick off the request to fetch the pref from the server. */
	76
	77	void (completed)(struct prefdata f);
	78	/* Called when the value comes back in; creates the widget. */
	79
	80	const char (get_edited)(struct prefdata *f);
	81	/* Get the edited value from the widget. */
	82
348ef780 RK	83	/** @brief Update the edited value */
	84	void (set_edited)(struct prefdata f, const char *value);
	85
460b9539	86	void (set)(struct prefdata f, const char *value);
	87	/* Set the new value and (if necessary) arrange for our display to update. */
	88	};
	89
	90	/* A namepart pref */
	91	static const struct preftype preftype_namepart = {
	92	kickoff_namepart,
	93	completed_namepart,
	94	get_edited_namepart,
348ef780	95	set_edited_namepart,
460b9539	96	set_namepart
	97	};
	98
	99	/* A string pref */
	100	static const struct preftype preftype_string = {
	101	kickoff_string,
	102	completed_string,
	103	get_edited_string,
348ef780	104	set_edited_string,
460b9539	105	set_string
	106	};
	107
	108	/* A boolean pref */
	109	static const struct preftype preftype_boolean = {
	110	kickoff_boolean,
	111	completed_boolean,
	112	get_edited_boolean,
348ef780	113	set_edited_boolean,
460b9539	114	set_boolean
	115	};
	116
13aba192	117	/* @brief The known prefs for each track */
460b9539	118	static const struct pref {
13aba192	119	const char label; /< @brief user-level description /
	120	const char part; /< @brief protocol-level tag /
	121	const char default_value; /< @brief default value or NULL /
	122	const struct preftype type; /< @brief underlying data type /
460b9539	123	} prefs[] = {
	124	{ "Artist", "artist", 0, &preftype_namepart },
	125	{ "Album", "album", 0, &preftype_namepart },
	126	{ "Title", "title", 0, &preftype_namepart },
	127	{ "Tags", "tags", "", &preftype_string },
6a881c39	128	{ "Weight", "weight", "90000", &preftype_string },
460b9539	129	{ "Random", "pick_at_random", "1", &preftype_boolean },
	130	};
	131
	132	#define NPREFS (int)(sizeof prefs / sizeof *prefs)
	133
	134	/* Buttons that appear at the bottom of the window */
f44417cf	135	static struct button buttons[] = {
f4f5a474 RK	136	{
	137	GTK_STOCK_OK,
	138	properties_ok,
f44417cf RK	139	"Apply all changes and close window",
f44417cf RK	140	0
f4f5a474 RK	141	},
	142	{
	143	GTK_STOCK_APPLY,
	144	properties_apply,
f44417cf RK	145	"Apply all changes and keep window open",
f44417cf RK	146	0
f4f5a474 RK	147	},
	148	{
	149	GTK_STOCK_CANCEL,
	150	properties_cancel,
f44417cf RK	151	"Discard all changes and close window",
f44417cf RK	152	0
f4f5a474	153	},
460b9539	154	};
	155
	156	#define NBUTTONS (int)(sizeof buttons / sizeof *buttons)
	157
	158	static int prefs_unfilled; /* Prefs remaining to get */
	159	static int prefs_total; /* Total prefs */
	160	static struct prefdata prefdatas; / Current prefdatas */
	161	static GtkWidget *properties_window;
	162	static GtkWidget *properties_table;
c3df9503	163	static struct progress_window *pw;
7c30fc75	164	static event_handle properties_event;
460b9539	165
348ef780 RK	166	static void propagate_clicked(GtkButton attribute((unused)) *button,
	167	gpointer userdata) {
	168	struct prefdata f = (struct prefdata )userdata, *g;
	169	int p;
	170	const char *value = f->p->type->get_edited(f);
	171
	172	for(p = 0; p < prefs_total; ++p) {
	173	g = &prefdatas[p];
	174	if(f->p == g->p && f != g)
	175	g->p->type->set_edited(g, value);
	176	}
	177	}
	178
65b42b2b RK	179	/** @brief Keypress handler */
	180	static gboolean properties_keypress(GtkWidget attribute((unused)) *widget,
	181	GdkEventKey *event,
	182	gpointer attribute((unused)) user_data) {
	183	if(event->state)
	184	return FALSE;
	185	switch(event->keyval) {
	186	case GDK_Return:
	187	properties_ok(0, 0);
	188	return TRUE;
	189	case GDK_Escape:
	190	properties_cancel(0, 0);
	191	return TRUE;
	192	default:
	193	return FALSE;
	194	}
	195	}
	196
16e145a5	197	void properties(int ntracks, const char **tracks) {
460b9539	198	int n, m;
460b9539	199	struct prefdata *f;
33288048	200	GtkWidget buttonbox, vbox, label, entry, *propagate;
5459347d RK	201
	202	/* If no tracks, do nothign */
	203	if(!ntracks)
	204	return;
460b9539	205	/* If there is a properties window open then just bring it to the
	206	* front. It might not have the right values in... */
	207	if(properties_window) {
	208	if(!prefs_unfilled)
	209	gtk_window_present(GTK_WINDOW(properties_window));
	210	return;
	211	}
	212	assert(properties_table == 0);
	213	if(ntracks > INT_MAX / NPREFS) {
043d60b1	214	popup_msg(GTK_MESSAGE_ERROR, "Too many tracks selected");
460b9539	215	return;
460b9539	216	}
7c30fc75	217	properties_event = event_register("logged-in", properties_logged_in, 0);
460b9539	218	/* Create a new properties window */
460b9539	219	properties_window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
33288048	220	gtk_widget_set_style(properties_window, tool_style);
460b9539	221	g_signal_connect(properties_window, "destroy",
460b9539	222	G_CALLBACK(gtk_widget_destroyed), &properties_window);
65b42b2b RK	223	/* Keyboard shortcuts */
	224	g_signal_connect(properties_window, "key-press-event",
	225	G_CALLBACK(properties_keypress), 0);
460b9539	226	/* Most of the action is the table of preferences */
348ef780 RK	227	properties_table = gtk_table_new((NPREFS + 1) * ntracks, 2 + ntracks > 1,
348ef780 RK	228	FALSE);
33288048	229	gtk_widget_set_style(properties_table, tool_style);
460b9539	230	g_signal_connect(properties_table, "destroy",
	231	G_CALLBACK(gtk_widget_destroyed), &properties_table);
	232	gtk_window_set_title(GTK_WINDOW(properties_window), "Track Properties");
	233	/* Create labels for each pref of each track and kick off requests to the
	234	* server to fill in the values */
	235	prefs_total = NPREFS * ntracks;
	236	prefdatas = xcalloc(prefs_total, sizeof *prefdatas);
	237	for(n = 0; n < ntracks; ++n) {
348ef780 RK	238	/* The track itself */
348ef780 RK	239	/* Caption */
460b9539	240	label = gtk_label_new("Track");
33288048	241	gtk_widget_set_style(label, tool_style);
460b9539	242	gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
	243	gtk_table_attach(GTK_TABLE(properties_table),
	244	label,
	245	0, 1,
	246	(NPREFS + 1) * n, (NPREFS + 1) * n + 1,
	247	GTK_FILL, 0,
	248	1, 1);
348ef780	249	/* The track name */
460b9539	250	entry = gtk_entry_new();
33288048	251	gtk_widget_set_style(entry, tool_style);
460b9539	252	gtk_entry_set_text(GTK_ENTRY(entry), tracks[n]);
	253	gtk_editable_set_editable(GTK_EDITABLE(entry), FALSE);
	254	gtk_table_attach(GTK_TABLE(properties_table),
	255	entry,
	256	1, 2,
	257	(NPREFS + 1) * n, (NPREFS + 1) * n + 1,
	258	GTK_EXPAND\|GTK_FILL, 0,
	259	1, 1);
348ef780	260	/* Each preference */
460b9539	261	for(m = 0; m < NPREFS; ++m) {
348ef780	262	/* Caption */
460b9539	263	label = gtk_label_new(prefs[m].label);
33288048	264	gtk_widget_set_style(label, tool_style);
460b9539	265	gtk_misc_set_alignment(GTK_MISC(label), 1, 0);
	266	gtk_table_attach(GTK_TABLE(properties_table),
	267	label,
	268	0, 1,
	269	(NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
	270	GTK_FILL/xoptions/, 0/yoptions/,
	271	1, 1);
348ef780	272	/* Editing the preference is specific */
460b9539	273	f = &prefdatas[NPREFS * n + m];
	274	f->track = tracks[n];
	275	f->row = (NPREFS + 1) * n + 1 + m;
	276	f->p = &prefs[m];
	277	prefs[m].type->kickoff(f);
348ef780 RK	278	if(ntracks > 1) {
348ef780 RK	279	/* Propagation button */
33288048	280	propagate = iconbutton("propagate.png", "Copy to other tracks");
348ef780 RK	281	g_signal_connect(G_OBJECT(propagate), "clicked",
	282	G_CALLBACK(propagate_clicked), f);
	283	gtk_table_attach(GTK_TABLE(properties_table),
	284	propagate,
	285	2/left/, 3/right/,
	286	(NPREFS + 1) * n + 1 + m, (NPREFS + 1) * n + 2 + m,
	287	GTK_FILL/xoptions/, 0/yoptions/,
	288	1/xpadding/, 1/ypadding/);
	289	}
460b9539	290	}
	291	}
	292	prefs_unfilled = prefs_total;
	293	/* Buttons */
73f1b9f3	294	buttonbox = create_buttons(buttons, NBUTTONS);
460b9539	295	/* Put it all together */
	296	vbox = gtk_vbox_new(FALSE, 1);
	297	gtk_box_pack_start(GTK_BOX(vbox),
d4ef4132	298	scroll_widget(properties_table),
460b9539	299	TRUE, TRUE, 1);
73f1b9f3	300	gtk_box_pack_start(GTK_BOX(vbox), buttonbox, FALSE, FALSE, 1);
e18c4734	301	gtk_container_add(GTK_CONTAINER(properties_window), frame_widget(vbox, NULL));
460b9539	302	/* The table only really wants to be vertically scrollable */
	303	gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(GTK_WIDGET(properties_table)->parent->parent),
	304	GTK_POLICY_NEVER,
	305	GTK_POLICY_AUTOMATIC);
c3df9503 RK	306	/* Zot any pre-existing progress window just in case */
	307	if(pw)
	308	progress_window_progress(pw, 0, 0);
460b9539	309	/* Pop up a progress bar while we're waiting */
c3df9503	310	pw = progress_window_new("Fetching Track Properties");
460b9539	311	}
	312
	313	/* Everything is filled in now */
	314	static void prefdata_alldone(void) {
c3df9503 RK	315	if(pw) {
	316	progress_window_progress(pw, 0, 0);
	317	pw = 0;
	318	}
460b9539	319	/* Default size may be too small */
	320	gtk_window_set_default_size(GTK_WINDOW(properties_window), 480, 512);
	321	/* TODO: relate default size to required size more closely */
	322	gtk_widget_show_all(properties_window);
	323	}
	324
	325	/* Namepart preferences ---------------------------------------------------- */
	326
	327	static void kickoff_namepart(struct prefdata *f) {
13aba192	328	/* We ask for the display name part. This is a bit bizarre if what we really
	329	* wanted was the underlying preference, but in fact it should always match
	330	* and will supply a sane default without having to know how to parse tracks
	331	* names (which implies knowing collection roots). */
	332	disorder_eclient_namepart(client, prefdata_completed, f->track, "display", f->p->part,
	333	make_callbackdata(f));
460b9539	334	}
	335
	336	static void completed_namepart(struct prefdata *f) {
13aba192	337	if(!f->value) {
	338	/* No setting */
	339	f->value = "";
	340	}
460b9539	341	f->widget = gtk_entry_new();
460b9539	342	}
	343
	344	static const char get_edited_namepart(struct prefdata f) {
	345	return gtk_entry_get_text(GTK_ENTRY(f->widget));
	346	}
	347
348ef780 RK	348	static void set_edited_namepart(struct prefdata f, const char value) {
	349	gtk_entry_set_text(GTK_ENTRY(f->widget), value);
	350	}
	351
460b9539	352	static void set_namepart(struct prefdata f, const char value) {
460b9539	353	char *s;
460b9539	354
460b9539	355	byte_xasprintf(&s, "trackname_display_%s", f->p->part);
13aba192	356	/* We don't know what the default is so can never unset. This is a bug
	357	* relative to the original design, which is supposed to only ever allow for
	358	* non-trivial namepart preferences. I suppose the server could spot a
	359	* default being set and translate it into an unset. */
	360	disorder_eclient_set(client, set_namepart_completed, f->track, s, value,
53fa91bb	361	f);
460b9539	362	}
	363
	364	/* Called when we've set a namepart */
abf99697 RK	365	static void set_namepart_completed(void v, const char err) {
	366	if(err)
	367	popup_protocol_error(0, err);
53fa91bb RK	368	else {
	369	struct prefdata *f = v;
	370
	371	namepart_update(f->track, "display", f->p->part);
	372	}
460b9539	373	}
	374
	375	/* String preferences ------------------------------------------------------ */
	376
	377	static void kickoff_string(struct prefdata *f) {
	378	disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
	379	make_callbackdata(f));
	380	}
	381
	382	static void completed_string(struct prefdata *f) {
	383	if(!f->value)
	384	/* No setting, use the default value instead */
	385	f->value = f->p->default_value;
	386	f->widget = gtk_entry_new();
460b9539	387	}
	388
	389	static const char get_edited_string(struct prefdata f) {
	390	return gtk_entry_get_text(GTK_ENTRY(f->widget));
	391	}
	392
348ef780 RK	393	static void set_edited_string(struct prefdata f, const char value) {
	394	gtk_entry_set_text(GTK_ENTRY(f->widget), value);
	395	}
	396
53fa91bb	397	static void set_string_completed(void attribute((unused)) *v,
abf99697 RK	398	const char *err) {
	399	if(err)
	400	popup_protocol_error(0, err);
53fa91bb RK	401	}
53fa91bb RK	402
460b9539	403	static void set_string(struct prefdata f, const char value) {
53fa91bb RK	404	disorder_eclient_set(client, set_string_completed, f->track, f->p->part,
53fa91bb RK	405	value, 0/v/);
460b9539	406	}
	407
	408	/* Boolean preferences ----------------------------------------------------- */
	409
	410	static void kickoff_boolean(struct prefdata *f) {
	411	disorder_eclient_get(client, prefdata_completed, f->track, f->p->part,
	412	make_callbackdata(f));
	413	}
	414
	415	static void completed_boolean(struct prefdata *f) {
	416	f->widget = gtk_check_button_new();
33288048	417	gtk_widget_set_style(f->widget, tool_style);
460b9539	418	if(!f->value)
	419	/* Not set, use the default */
	420	f->value = f->p->default_value;
460b9539	421	}
	422
	423	static const char get_edited_boolean(struct prefdata f) {
	424	return (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(f->widget))
	425	? "1" : "0");
	426	}
	427
348ef780 RK	428	static void set_edited_boolean(struct prefdata f, const char value) {
	429	gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(f->widget),
	430	strcmp(value, "0"));
	431	}
	432
53fa91bb RK	433	#define set_boolean_completed set_string_completed
53fa91bb RK	434
460b9539	435	static void set_boolean(struct prefdata f, const char value) {
	436	char *s;
	437
	438	byte_xasprintf(&s, "trackname_display_%s", f->p->part);
53fa91bb RK	439	disorder_eclient_set(client, set_boolean_completed,
53fa91bb RK	440	f->track, f->p->part, value, 0/v/);
460b9539	441	}
	442
	443	/* Querying preferences ---------------------------------------------------- */
	444
	445	/* Make a suitable callbackdata */
	446	static struct callbackdata make_callbackdata(struct prefdata f) {
	447	struct callbackdata cbd = xmalloc(sizeof cbd);
	448
	449	cbd->onerror = prefdata_onerror;
	450	cbd->u.f = f;
	451	return cbd;
	452	}
	453
	454	/* No pref was set */
	455	static void prefdata_onerror(struct callbackdata *cbd,
	456	int attribute((unused)) code,
	457	const char attribute((unused)) *msg) {
	458	prefdata_completed_common(cbd->u.f, 0);
	459	}
	460
	461	/* Got the value of a pref */
abf99697 RK	462	static void prefdata_completed(void v, const char err, const char *value) {
abf99697 RK	463	if(err) {
06bfbba4 RK	464	} else {
	465	struct callbackdata *cbd = v;
	466
	467	prefdata_completed_common(cbd->u.f, value);
	468	}
460b9539	469	}
	470
	471	static void prefdata_completed_common(struct prefdata *f,
	472	const char *value) {
	473	f->value = value;
	474	f->p->type->completed(f);
348ef780	475	f->p->type->set_edited(f, f->value);
460b9539	476	assert(f->value != 0); /* Had better set a default */
	477	gtk_table_attach(GTK_TABLE(properties_table), f->widget,
	478	1, 2,
	479	f->row, f->row + 1,
	480	GTK_EXPAND\|GTK_FILL/xoptions/, 0/yoptions/,
	481	1, 1);
	482	--prefs_unfilled;
c3df9503 RK	483	if(prefs_total)
c3df9503 RK	484	progress_window_progress(pw, prefs_total - prefs_unfilled, prefs_total);
460b9539	485	if(!prefs_unfilled)
	486	prefdata_alldone();
	487	}
	488
	489	/* Button callbacks -------------------------------------------------------- */
	490
	491	static void properties_ok(GtkButton *button,
	492	gpointer userdata) {
	493	properties_apply(button, userdata);
	494	properties_cancel(button, userdata);
	495	}
	496
	497	static void properties_apply(GtkButton attribute((unused)) *button,
	498	gpointer attribute((unused)) userdata) {
	499	int n;
	500	const char *edited;
	501	struct prefdata *f;
	502
	503	/* For each possible property we see if we've changed it and if so tell the
	504	* server */
	505	for(n = 0; n < prefs_total; ++n) {
	506	f = &prefdatas[n];
	507	edited = f->p->type->get_edited(f);
	508	if(strcmp(edited, f->value)) {
	509	/* The value has changed */
	510	f->p->type->set(f, edited);
	511	f->value = xstrdup(edited);
	512	}
	513	}
	514	}
	515
	516	static void properties_cancel(GtkButton attribute((unused)) *button,
	517	gpointer attribute((unused)) userdata) {
	518	gtk_widget_destroy(properties_window);
7c30fc75 RK	519	event_cancel(properties_event);
7c30fc75 RK	520	properties_event = 0;
460b9539	521	}
460b9539	522
7c30fc75	523	/** @brief Called when we've just logged in
73f1b9f3 RK	524	*
	525	* Destroys the current properties window.
	526	*/
7c30fc75 RK	527	static void properties_logged_in(const char attribute((unused)) *event,
	528	void attribute((unused)) *eventdata,
	529	void attribute((unused)) *callbackdata) {
73f1b9f3 RK	530	if(properties_window)
	531	gtk_widget_destroy(properties_window);
	532	}
	533
460b9539	534	/*
	535	Local Variables:
	536	c-basic-offset:2
	537	comment-column:40
	538	fill-column:79
	539	indent-tabs-mode:nil
	540	End:
	541	*/