2 * This file is part of DisOrder.
3 * Copyright (C) 2006-2008 Richard Kettlewell
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.
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.
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
20 /** @file disobedience/disobedience.h
21 * @brief Header file for Disobedience, the DisOrder GTK+ client
24 #ifndef DISOBEDIENCE_H
25 #define DISOBEDIENCE_H
42 #include "trackname.h"
45 #include "configuration.h"
47 #include "selection.h"
51 #include <gdk-pixbuf/gdk-pixbuf.h>
53 /* Types ------------------------------------------------------------------- */
57 struct progress_window;
59 /** @brief Callback data structure
61 * This program is extremely heavily callback-driven. Rather than have
62 * numerous different callback structures we have a single one which can be
63 * interpreted adequately both by success and error handlers.
66 void (*onerror)(struct callbackdata *cbd,
68 const char *msg); /* called on error */
70 const char *key; /* gtkqueue.c op_part_lookup */
71 struct choosenode *choosenode; /* gtkchoose.c got_files/got_dirs */
72 struct queuelike *ql; /* gtkqueue.c queuelike_completed */
73 struct prefdata *f; /* properties.c */
74 const char *user; /* users.c */
76 const char *user, *email; /* users.c */
81 /** @brief Per-tab callbacks
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.
87 int (*properties_sensitive)(GtkWidget *tab);
88 int (*selectall_sensitive)(GtkWidget *tab);
89 int (*selectnone_sensitive)(GtkWidget *tab);
90 void (*properties_activate)(GtkWidget *tab);
91 void (*selectall_activate)(GtkWidget *tab);
92 void (*selectnone_activate)(GtkWidget *tab);
95 /** @brief Button definitions */
98 void (*clicked)(GtkButton *button, gpointer userdata);
103 /* Variables --------------------------------------------------------------- */
105 extern GMainLoop *mainloop;
106 extern GtkWidget *toplevel; /* top level window */
107 extern GtkWidget *report_label; /* label for progress indicator */
108 extern GtkWidget *tabs; /* main tabs */
109 extern disorder_eclient *client; /* main client */
111 extern unsigned long last_state; /* last reported state */
112 extern int playing; /* true if playing some track */
113 extern int volume_l, volume_r; /* current volume */
114 extern double goesupto; /* volume upper bound */
115 extern int choosealpha; /* break up choose by letter */
116 extern GtkTooltips *tips;
117 extern int rtp_supported;
118 extern int rtp_is_running;
119 extern GtkItemFactory *mainmenufactory;
121 extern const disorder_eclient_log_callbacks log_callbacks;
123 typedef void monitor_callback(void *u);
125 /* Functions --------------------------------------------------------------- */
127 disorder_eclient *gtkclient(void);
128 /* Configure C for use in GTK+ programs */
130 void popup_protocol_error(int code,
132 /* Report an error */
134 void properties(int ntracks, const char **tracks);
135 /* Pop up a properties window for a list of tracks */
137 void properties_reset(void);
139 GtkWidget *scroll_widget(GtkWidget *child);
140 /* Wrap a widget up for scrolling */
142 GtkWidget *frame_widget(GtkWidget *w, const char *title);
144 GdkPixbuf *find_image(const char *name);
145 /* Get the pixbuf for an image. Returns a null pointer if it cannot be
148 void popup_msg(GtkMessageType mt, const char *msg);
149 void popup_submsg(GtkWidget *parent, GtkMessageType mt, const char *msg);
151 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
153 struct progress_window *progress_window_new(const char *title);
154 /* Pop up a progress window */
156 void progress_window_progress(struct progress_window *pw,
159 /* Report current progress */
161 GtkWidget *iconbutton(const char *path, const char *tip);
163 GtkWidget *create_buttons(struct button *buttons,
165 GtkWidget *create_buttons_box(struct button *buttons,
169 void register_monitor(monitor_callback *callback,
172 /* Register a state monitor */
174 /** @brief Type signature for a reset callback */
175 typedef void reset_callback(void);
177 void register_reset(reset_callback *callback);
178 /* Register a reset callback */
182 void all_update(void);
183 /* Update everything */
187 GtkWidget *menubar(GtkWidget *w);
188 /* Create the menu bar */
190 void menu_update(int page);
191 /* Called whenever the main menu might need to change. PAGE is the current
192 * page if known or -1 otherwise. */
194 void users_set_sensitive(int sensitive);
198 GtkWidget *control_widget(void);
199 /* Make the controls widget */
201 void volume_update(void);
202 /* Called whenever we think the volume control has changed */
204 void control_monitor(void *u);
206 extern int suppress_actions;
208 /* Queue/Recent/Added */
210 GtkWidget *queue_widget(void);
211 GtkWidget *recent_widget(void);
212 GtkWidget *added_widget(void);
213 /* Create widgets for displaying the queue, the recently played list and the
214 * newly added tracks list */
216 void queue_update(void);
217 void recent_update(void);
218 void added_update(void);
219 /* Called whenever we think the queue, recent or newly-added list might have
222 void queue_select_all(struct queuelike *ql);
223 void queue_select_none(struct queuelike *ql);
224 /* Select all/none on some queue */
226 void queue_properties(struct queuelike *ql);
227 /* Pop up properties of selected items in some queue */
229 int queued(const char *track);
230 /* Return nonzero iff TRACK is queued or playing */
232 void namepart_update(const char *track,
235 /* Called when a namepart might have changed */
240 GtkWidget *choose_widget(void);
241 /* Create a widget for choosing tracks */
243 void choose_update(void);
244 /* Called when we think the choose tree might need updating */
248 void login_box(void);
250 GtkWidget *login_window;
252 /* User management */
254 void manage_users(void);
258 void popup_help(void);
262 int rtp_running(void);
263 void start_rtp(void);
268 void init_styles(void);
269 extern GtkStyle *layout_style;
270 extern GtkStyle *title_style;
271 extern GtkStyle *even_style;
272 extern GtkStyle *odd_style;
273 extern GtkStyle *active_style;
274 extern GtkStyle *tool_style;
275 extern GtkStyle *search_style;
276 extern GtkStyle *drag_style;
278 extern const char *browser;
280 void save_settings(void);
281 void load_settings(void);
282 void set_tool_colors(GtkWidget *w);
283 void popup_settings(void);
285 /* Widget leakage debugging rubbish ---------------------------------------- */
288 #define NW(what) do { \
289 if(++current##what % 100 > max##what) { \
290 fprintf(stderr, "%s:%d: %d %s\n", \
291 __FILE__, __LINE__, current##what, #what); \
292 max##what = current##what; \
295 #define WT(what) static int current##what, max##what
296 #define DW(what) (--current##what)
298 #define NW(what) do { } while(0)
299 #define DW(what) do { } while(0)
300 #define WT(what) struct neverused
304 extern const char *mtag;
305 #define MTAG(x) do { mtag = x; } while(0)
306 #define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
307 #define MTAG_POP() mtag = save_mtag; } while(0)
309 #define MTAG(x) do { } while(0)
310 #define MTAG_PUSH(x) do {} while(0)
311 #define MTAG_POP() do {} while(0)
314 #endif /* DISOBEDIENCE_H */