[disorder] / disobedience / disobedience.h

/*
 * This file is part of DisOrder.
 * 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
 * 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/disobedience.h
 * @brief Header file for Disobedience, the DisOrder GTK+ client
 */

#ifndef DISOBEDIENCE_H
#define DISOBEDIENCE_H

#include <config.h>
#include "types.h"

#include <stdio.h>
#include <time.h>
#include <string.h>
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <math.h>

#include "mem.h"
#include "log.h"
#include "eclient.h"
#include "printf.h"
#include "cache.h"
#include "queue.h"
#include "printf.h"
#include "vector.h"
#include "trackname.h"
#include "syscalls.h"
#include "defs.h"
#include "configuration.h"
#include "hash.h"
#include "selection.h"

#include <glib.h>
#include <gtk/gtk.h>
#include <gdk-pixbuf/gdk-pixbuf.h>

/* Types ------------------------------------------------------------------- */

struct queuelike;
struct choosenode;
struct progress_window;

/** @brief Callback data structure
 *
 * This program is extremely heavily callback-driven.  Rather than have
 * numerous different callback structures we have a single one which can be
 * interpreted adequately both by success and error handlers.
 */
struct callbackdata {
  void (*onerror)(struct callbackdata *cbd,
                  int code,
		  const char *msg);     /* called on error */
  union {
    const char *key;                    /* gtkqueue.c op_part_lookup */
    struct choosenode *choosenode;      /* gtkchoose.c got_files/got_dirs */
    struct queuelike *ql;               /* gtkqueue.c queuelike_completed */
    struct prefdata *f;                 /* properties.c */
  } u;
};

/** @brief Per-tab callbacks
 *
 * Some of the options in the main menu depend on which tab is displayed, so we
 * have some callbacks to set them appropriately.
 */
struct tabtype {
  int (*properties_sensitive)(GtkWidget *tab);
  int (*selectall_sensitive)(GtkWidget *tab);
  void (*properties_activate)(GtkWidget *tab);
  void (*selectall_activate)(GtkWidget *tab);
};

/* Variables --------------------------------------------------------------- */

extern GMainLoop *mainloop;
extern GtkWidget *toplevel;             /* top level window */
extern GtkWidget *report_label;         /* label for progress indicator */
extern GtkWidget *tabs;                 /* main tabs */
extern disorder_eclient *client;        /* main client */

extern unsigned long last_state;        /* last reported state */
extern int playing;                     /* true if playing some track */
extern int volume_l, volume_r;          /* current volume */
extern double goesupto;                 /* volume upper bound */
extern int choosealpha;                 /* break up choose by letter */
extern GtkTooltips *tips;

extern const disorder_eclient_log_callbacks log_callbacks;

typedef void monitor_callback(void *u);

/* Functions --------------------------------------------------------------- */

disorder_eclient *gtkclient(void);
/* Configure C for use in GTK+ programs */

void popup_protocol_error(int code,
                          const char *msg);
/* Report an error */

void properties(int ntracks, const char **tracks);
/* Pop up a properties window for a list of tracks */

GtkWidget *scroll_widget(GtkWidget *child, const char *name);
/* Wrap a widget up for scrolling */

GdkPixbuf *find_image(const char *name);
/* Get the pixbuf for an image.  Returns a null pointer if it cannot be
 * found. */

void popup_error(const char *msg);
/* Pop up an error message */

struct progress_window *progress_window_new(const char *title);
/* Pop up a progress window */

void progress_window_progress(struct progress_window *pw,
			      int progress,
			      int limit);
/* Report current progress */

GtkWidget *iconbutton(const char *path, const char *tip);

void register_monitor(monitor_callback *callback,
                      void *u,
                      unsigned long mask);
/* Register a state monitor */

void all_update(void);
/* Update everything */

/* Main menu */

GtkWidget *menubar(GtkWidget *w);
/* Create the menu bar */
     
void menu_update(int page);
/* Called whenever the main menu might need to change.  PAGE is the current
 * page if known or -1 otherwise. */


/* Controls */

GtkWidget *control_widget(void);
/* Make the controls widget */

void volume_update(void);
/* Called whenever we think the volume control has changed */

/* Queue/Recent/Added */

GtkWidget *queue_widget(void);
GtkWidget *recent_widget(void);
GtkWidget *added_widget(void);
/* Create widgets for displaying the queue, the recently played list and the
 * newly added tracks list */

void queue_update(void);
void recent_update(void);
void added_update(void);
/* Called whenever we think the queue, recent or newly-added list might have
 * changed */

void queue_select_all(struct queuelike *ql);
/* Select all on some queue */

void queue_properties(struct queuelike *ql);
/* Pop up properties of selected items in some queue */

int queued(const char *track);
/* Return nonzero iff TRACK is queued or playing */

void namepart_update(const char *track,
                     const char *context,
                     const char *part);
/* Called when a namepart might have changed */


/* Choose */

GtkWidget *choose_widget(void);
/* Create a widget for choosing tracks */

void choose_update(void);
/* Called when we think the choose tree might need updating */

/* Widget leakage debugging rubbish ---------------------------------------- */

#if MDEBUG
#define NW(what) do {                                   \
  if(++current##what % 100 > max##what) {               \
    fprintf(stderr, "%s:%d: %d %s\n",                   \
            __FILE__, __LINE__, current##what, #what);  \
    max##what = current##what;                          \
  }                                                     \
} while(0)
#define WT(what) static int current##what, max##what
#define DW(what) (--current##what)
#else
#define NW(what) do { } while(0)
#define DW(what) do { } while(0)
#define WT(what) struct neverused
#endif

#if MTRACK
extern const char *mtag;
#define MTAG(x) do { mtag = x; } while(0)
#define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
#define MTAG_POP() mtag = save_mtag; } while(0)
#else
#define MTAG(x) do { } while(0)
#define MTAG_PUSH(x) do {} while(0)
#define MTAG_POP() do {} while(0)
#endif

#endif /* DISOBEDIENCE_H */

/*
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.
348ef780	3	* Copyright (C) 2006, 2007 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	*/
2c348789 RK	20	/** @file disobedience/disobedience.h
	21	* @brief Header file for Disobedience, the DisOrder GTK+ client
	22	*/
460b9539	23
	24	#ifndef DISOBEDIENCE_H
	25	#define DISOBEDIENCE_H
	26
	27	#include <config.h>
	28	#include "types.h"
	29
	30	#include <stdio.h>
	31	#include <time.h>
	32	#include <string.h>
	33	#include <assert.h>
	34	#include <ctype.h>
	35	#include <errno.h>
	36	#include <math.h>
	37
	38	#include "mem.h"
	39	#include "log.h"
	40	#include "eclient.h"
	41	#include "printf.h"
	42	#include "cache.h"
	43	#include "queue.h"
	44	#include "printf.h"
	45	#include "vector.h"
	46	#include "trackname.h"
	47	#include "syscalls.h"
	48	#include "defs.h"
	49	#include "configuration.h"
	50	#include "hash.h"
	51	#include "selection.h"
	52
	53	#include <glib.h>
	54	#include <gtk/gtk.h>
	55	#include <gdk-pixbuf/gdk-pixbuf.h>
	56
	57	/* Types ------------------------------------------------------------------- */
	58
	59	struct queuelike;
	60	struct choosenode;
c3df9503	61	struct progress_window;
460b9539	62
2c348789 RK	63	/** @brief Callback data structure
	64	*
	65	* This program is extremely heavily callback-driven. Rather than have
	66	* numerous different callback structures we have a single one which can be
	67	* interpreted adequately both by success and error handlers.
	68	*/
460b9539	69	struct callbackdata {
	70	void (onerror)(struct callbackdata cbd,
	71	int code,
	72	const char msg); / called on error */
	73	union {
	74	const char key; / gtkqueue.c op_part_lookup */
	75	struct choosenode choosenode; / gtkchoose.c got_files/got_dirs */
	76	struct queuelike ql; / gtkqueue.c queuelike_completed */
	77	struct prefdata f; / properties.c */
	78	} u;
	79	};
	80
2c348789 RK	81	/** @brief Per-tab callbacks
	82	*
	83	* Some of the options in the main menu depend on which tab is displayed, so we
	84	* have some callbacks to set them appropriately.
	85	*/
460b9539	86	struct tabtype {
	87	int (properties_sensitive)(GtkWidget tab);
	88	int (selectall_sensitive)(GtkWidget tab);
	89	void (properties_activate)(GtkWidget tab);
	90	void (selectall_activate)(GtkWidget tab);
	91	};
	92
	93	/* Variables --------------------------------------------------------------- */
	94
	95	extern GMainLoop *mainloop;
	96	extern GtkWidget toplevel; / top level window */
	97	extern GtkWidget report_label; / label for progress indicator */
	98	extern GtkWidget tabs; / main tabs */
	99	extern disorder_eclient client; / main client */
	100
	101	extern unsigned long last_state; /* last reported state */
	102	extern int playing; /* true if playing some track */
	103	extern int volume_l, volume_r; /* current volume */
	104	extern double goesupto; /* volume upper bound */
	105	extern int choosealpha; /* break up choose by letter */
348ef780	106	extern GtkTooltips *tips;
460b9539	107
10e226b3 RK	108	extern const disorder_eclient_log_callbacks log_callbacks;
10e226b3 RK	109
00959300	110	typedef void monitor_callback(void *u);
186f896b	111
460b9539	112	/* Functions --------------------------------------------------------------- */
	113
	114	disorder_eclient *gtkclient(void);
	115	/* Configure C for use in GTK+ programs */
	116
	117	void popup_protocol_error(int code,
	118	const char *msg);
	119	/* Report an error */
	120
16e145a5	121	void properties(int ntracks, const char **tracks);
460b9539	122	/* Pop up a properties window for a list of tracks */
	123
	124	GtkWidget scroll_widget(GtkWidget child, const char *name);
	125	/* Wrap a widget up for scrolling */
	126
	127	GdkPixbuf find_image(const char name);
	128	/* Get the pixbuf for an image. Returns a null pointer if it cannot be
	129	* found. */
	130
	131	void popup_error(const char *msg);
	132	/* Pop up an error message */
	133
c3df9503 RK	134	struct progress_window progress_window_new(const char title);
	135	/* Pop up a progress window */
	136
	137	void progress_window_progress(struct progress_window *pw,
	138	int progress,
	139	int limit);
	140	/* Report current progress */
	141
fcc8b9f7 RK	142	GtkWidget iconbutton(const char path, const char *tip);
fcc8b9f7 RK	143
186f896b RK	144	void register_monitor(monitor_callback *callback,
	145	void *u,
	146	unsigned long mask);
	147	/* Register a state monitor */
	148
10e226b3 RK	149	void all_update(void);
10e226b3 RK	150	/* Update everything */
460b9539	151
	152	/* Main menu */
	153
	154	GtkWidget menubar(GtkWidget w);
	155	/* Create the menu bar */
	156
	157	void menu_update(int page);
	158	/* Called whenever the main menu might need to change. PAGE is the current
	159	* page if known or -1 otherwise. */
	160
	161
	162	/* Controls */
	163
	164	GtkWidget *control_widget(void);
	165	/* Make the controls widget */
	166
6d1302f0 RK	167	void volume_update(void);
6d1302f0 RK	168	/* Called whenever we think the volume control has changed */
460b9539	169
4eb1f430	170	/* Queue/Recent/Added */
460b9539	171
	172	GtkWidget *queue_widget(void);
	173	GtkWidget *recent_widget(void);
4eb1f430 RK	174	GtkWidget *added_widget(void);
	175	/* Create widgets for displaying the queue, the recently played list and the
	176	* newly added tracks list */
460b9539	177
	178	void queue_update(void);
	179	void recent_update(void);
4eb1f430 RK	180	void added_update(void);
	181	/* Called whenever we think the queue, recent or newly-added list might have
	182	* changed */
460b9539	183
	184	void queue_select_all(struct queuelike *ql);
	185	/* Select all on some queue */
	186
	187	void queue_properties(struct queuelike *ql);
	188	/* Pop up properties of selected items in some queue */
	189
460b9539	190	int queued(const char *track);
	191	/* Return nonzero iff TRACK is queued or playing */
	192
	193	void namepart_update(const char *track,
	194	const char *context,
	195	const char *part);
	196	/* Called when a namepart might have changed */
	197
	198
	199	/* Choose */
	200
	201	GtkWidget *choose_widget(void);
	202	/* Create a widget for choosing tracks */
	203
	204	void choose_update(void);
	205	/* Called when we think the choose tree might need updating */
	206
e9b70a84	207	/* Widget leakage debugging rubbish ---------------------------------------- */
	208
	209	#if MDEBUG
	210	#define NW(what) do { \
	211	if(++current##what % 100 > max##what) { \
	212	fprintf(stderr, "%s:%d: %d %s\n", \
	213	__FILE__, __LINE__, current##what, #what); \
	214	max##what = current##what; \
	215	} \
	216	} while(0)
	217	#define WT(what) static int current##what, max##what
	218	#define DW(what) (--current##what)
	219	#else
1a48886f RK	220	#define NW(what) do { } while(0)
1a48886f RK	221	#define DW(what) do { } while(0)
e9b70a84	222	#define WT(what) struct neverused
	223	#endif
	224
e1d4a32b	225	#if MTRACK
	226	extern const char *mtag;
	227	#define MTAG(x) do { mtag = x; } while(0)
	228	#define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
	229	#define MTAG_POP() mtag = save_mtag; } while(0)
	230	#else
	231	#define MTAG(x) do { } while(0)
	232	#define MTAG_PUSH(x) do {} while(0)
	233	#define MTAG_POP() do {} while(0)
	234	#endif
	235
460b9539	236	#endif /* DISOBEDIENCE_H */
	237
	238	/*
	239	Local Variables:
	240	c-basic-offset:2
	241	comment-column:40
	242	fill-column:79
	243	indent-tabs-mode:nil
	244	End:
	245	*/