chiark / gitweb /
merge disorder.unicode branch
[disorder] / disobedience / disobedience.h
CommitLineData
460b9539 1/*
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
59struct queuelike;
60struct choosenode;
c3df9503 61struct 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 69struct 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 86struct 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
73f1b9f3
RK
93/** @brief Button definitions */
94struct button {
95 const gchar *stock;
96 void (*clicked)(GtkButton *button, gpointer userdata);
97 const char *tip;
98};
99
460b9539 100/* Variables --------------------------------------------------------------- */
101
102extern GMainLoop *mainloop;
103extern GtkWidget *toplevel; /* top level window */
104extern GtkWidget *report_label; /* label for progress indicator */
105extern GtkWidget *tabs; /* main tabs */
106extern disorder_eclient *client; /* main client */
107
108extern unsigned long last_state; /* last reported state */
109extern int playing; /* true if playing some track */
110extern int volume_l, volume_r; /* current volume */
111extern double goesupto; /* volume upper bound */
112extern int choosealpha; /* break up choose by letter */
348ef780 113extern GtkTooltips *tips;
a99c4e9a
RK
114extern int rtp_supported;
115extern int rtp_is_running;
ac6bf2ba 116extern GtkItemFactory *mainmenufactory;
460b9539 117
10e226b3
RK
118extern const disorder_eclient_log_callbacks log_callbacks;
119
00959300 120typedef void monitor_callback(void *u);
186f896b 121
460b9539 122/* Functions --------------------------------------------------------------- */
123
124disorder_eclient *gtkclient(void);
125/* Configure C for use in GTK+ programs */
126
127void popup_protocol_error(int code,
128 const char *msg);
129/* Report an error */
130
16e145a5 131void properties(int ntracks, const char **tracks);
460b9539 132/* Pop up a properties window for a list of tracks */
133
73f1b9f3
RK
134void properties_reset(void);
135
d4ef4132 136GtkWidget *scroll_widget(GtkWidget *child);
460b9539 137/* Wrap a widget up for scrolling */
138
139GdkPixbuf *find_image(const char *name);
140/* Get the pixbuf for an image. Returns a null pointer if it cannot be
141 * found. */
142
043d60b1
RK
143void popup_msg(GtkMessageType mt, const char *msg);
144/* Pop up a message */
460b9539 145
043d60b1 146void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
73f1b9f3 147
c3df9503
RK
148struct progress_window *progress_window_new(const char *title);
149/* Pop up a progress window */
150
151void progress_window_progress(struct progress_window *pw,
152 int progress,
153 int limit);
154/* Report current progress */
155
fcc8b9f7
RK
156GtkWidget *iconbutton(const char *path, const char *tip);
157
73f1b9f3
RK
158GtkWidget *create_buttons(const struct button *buttons,
159 size_t nbuttons);
160
186f896b
RK
161void register_monitor(monitor_callback *callback,
162 void *u,
163 unsigned long mask);
164/* Register a state monitor */
165
73f1b9f3
RK
166/** @brief Type signature for a reset callback */
167typedef void reset_callback(void);
168
169void register_reset(reset_callback *callback);
170/* Register a reset callback */
171
172void reset(void);
173
10e226b3
RK
174void all_update(void);
175/* Update everything */
460b9539 176
177/* Main menu */
178
179GtkWidget *menubar(GtkWidget *w);
180/* Create the menu bar */
181
182void menu_update(int page);
183/* Called whenever the main menu might need to change. PAGE is the current
184 * page if known or -1 otherwise. */
185
186
187/* Controls */
188
189GtkWidget *control_widget(void);
190/* Make the controls widget */
191
6d1302f0
RK
192void volume_update(void);
193/* Called whenever we think the volume control has changed */
460b9539 194
a99c4e9a
RK
195void control_monitor(void *u);
196
fb44b59e
RK
197extern int suppress_actions;
198
4eb1f430 199/* Queue/Recent/Added */
460b9539 200
201GtkWidget *queue_widget(void);
202GtkWidget *recent_widget(void);
4eb1f430
RK
203GtkWidget *added_widget(void);
204/* Create widgets for displaying the queue, the recently played list and the
205 * newly added tracks list */
460b9539 206
207void queue_update(void);
208void recent_update(void);
4eb1f430
RK
209void added_update(void);
210/* Called whenever we think the queue, recent or newly-added list might have
211 * changed */
460b9539 212
213void queue_select_all(struct queuelike *ql);
214/* Select all on some queue */
215
216void queue_properties(struct queuelike *ql);
217/* Pop up properties of selected items in some queue */
218
460b9539 219int queued(const char *track);
220/* Return nonzero iff TRACK is queued or playing */
221
222void namepart_update(const char *track,
223 const char *context,
224 const char *part);
225/* Called when a namepart might have changed */
226
227
228/* Choose */
229
230GtkWidget *choose_widget(void);
231/* Create a widget for choosing tracks */
232
233void choose_update(void);
234/* Called when we think the choose tree might need updating */
235
a99c4e9a
RK
236/* Login details */
237
73f1b9f3
RK
238void login_box(void);
239
13affe66
RK
240/* Help */
241
242void popup_help(void);
243
a99c4e9a
RK
244/* RTP */
245
246int rtp_running(void);
247void start_rtp(void);
248void stop_rtp(void);
249
f486ea18 250/* Settings */
d4ef4132 251
33288048
RK
252void init_styles(void);
253extern GtkStyle *layout_style;
254extern GtkStyle *title_style;
255extern GtkStyle *even_style;
256extern GtkStyle *odd_style;
257extern GtkStyle *active_style;
258extern GtkStyle *tool_style;
259extern GtkStyle *search_style;
260extern GtkStyle *drag_style;
d4ef4132 261
f486ea18
RK
262extern const char *browser;
263
264void save_settings(void);
265void load_settings(void);
d4ef4132 266void set_tool_colors(GtkWidget *w);
d4ef4132 267
e9b70a84 268/* Widget leakage debugging rubbish ---------------------------------------- */
269
270#if MDEBUG
271#define NW(what) do { \
272 if(++current##what % 100 > max##what) { \
273 fprintf(stderr, "%s:%d: %d %s\n", \
274 __FILE__, __LINE__, current##what, #what); \
275 max##what = current##what; \
276 } \
277} while(0)
278#define WT(what) static int current##what, max##what
279#define DW(what) (--current##what)
280#else
1a48886f
RK
281#define NW(what) do { } while(0)
282#define DW(what) do { } while(0)
e9b70a84 283#define WT(what) struct neverused
284#endif
285
e1d4a32b 286#if MTRACK
287extern const char *mtag;
288#define MTAG(x) do { mtag = x; } while(0)
289#define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
290#define MTAG_POP() mtag = save_mtag; } while(0)
291#else
292#define MTAG(x) do { } while(0)
293#define MTAG_PUSH(x) do {} while(0)
294#define MTAG_POP() do {} while(0)
295#endif
296
460b9539 297#endif /* DISOBEDIENCE_H */
298
299/*
300Local Variables:
301c-basic-offset:2
302comment-column:40
303fill-column:79
304indent-tabs-mode:nil
305End:
306*/