[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 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.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/** @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 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,
                GtkWidget *parent) {
  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 */
  while(parent->parent)
    parent = parent->parent;
  pw = progress_window_new("Fetching Track Properties", parent);
}

/* 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, 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, 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, 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 ---------------------------------------------------- */

static void prefdata_completed(void *v, const char *err, const char *value) {
  struct prefdata *const f = v;

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