chiark - git - mdw - disorder/blob - disobedience/disobedience.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2006-2008 Richard Kettlewell
   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  */
  20 /** @file disobedience/disobedience.h
  21  * @brief Header file for Disobedience, the DisOrder GTK+ client
  22  */
  23
  24 #ifndef DISOBEDIENCE_H
  25 #define DISOBEDIENCE_H
  26
  27 #include "common.h"
  28
  29 #include <time.h>
  30 #include <ctype.h>
  31 #include <errno.h>
  32 #include <math.h>
  33
  34 #include "mem.h"
  35 #include "log.h"
  36 #include "eclient.h"
  37 #include "printf.h"
  38 #include "cache.h"
  39 #include "queue.h"
  40 #include "printf.h"
  41 #include "vector.h"
  42 #include "trackname.h"
  43 #include "syscalls.h"
  44 #include "defs.h"
  45 #include "configuration.h"
  46 #include "hash.h"
  47 #include "selection.h"
  48 #include "kvp.h"
  49 #include "eventdist.h"
  50
  51 #include <glib.h>
  52 #include <gtk/gtk.h>
  53 #include <gdk-pixbuf/gdk-pixbuf.h>
  54
  55 /* Types ------------------------------------------------------------------- */
  56
  57 struct queuelike;
  58 struct choosenode;
  59 struct progress_window;
  60
  61 /** @brief Callback data structure
  62  *
  63  * This program is extremely heavily callback-driven.  Rather than have
  64  * numerous different callback structures we have a single one which can be
  65  * interpreted adequately both by success and error handlers.
  66  */
  67 struct callbackdata {
  68   void (*onerror)(struct callbackdata *cbd,
  69                   int code,
  70                   const char *msg);     /* called on error */
  71   union {
  72     const char *key;                    /* gtkqueue.c op_part_lookup */
  73     struct choosenode *choosenode;      /* gtkchoose.c got_files/got_dirs */
  74     struct queuelike *ql;               /* gtkqueue.c queuelike_completed */
  75     struct prefdata *f;                 /* properties.c */
  76     const char *user;                   /* users.c */
  77     struct {
  78       const char *user, *email;         /* users.c */
  79     } edituser;
  80   } u;
  81 };
  82
  83 /** @brief Per-tab callbacks
  84  *
  85  * Some of the options in the main menu depend on which tab is displayed, so we
  86  * have some callbacks to set them appropriately.
  87  */
  88 struct tabtype {
  89   int (*properties_sensitive)(GtkWidget *tab);
  90   int (*selectall_sensitive)(GtkWidget *tab);
  91   int (*selectnone_sensitive)(GtkWidget *tab);
  92   void (*properties_activate)(GtkWidget *tab);
  93   void (*selectall_activate)(GtkWidget *tab);
  94   void (*selectnone_activate)(GtkWidget *tab);
  95 };
  96
  97 /** @brief Button definitions */
  98 struct button {
  99   const gchar *stock;
 100   void (*clicked)(GtkButton *button, gpointer userdata);
 101   const char *tip;
 102   GtkWidget *widget;
 103 };
 104
 105 /* Variables --------------------------------------------------------------- */
 106
 107 extern GMainLoop *mainloop;
 108 extern GtkWidget *toplevel;             /* top level window */
 109 extern GtkWidget *report_label;         /* label for progress indicator */
 110 extern GtkWidget *tabs;                 /* main tabs */
 111 extern disorder_eclient *client;        /* main client */
 112
 113 extern unsigned long last_state;        /* last reported state */
 114 extern int playing;                     /* true if playing some track */
 115 extern int volume_l, volume_r;          /* current volume */
 116 extern double goesupto;                 /* volume upper bound */
 117 extern int choosealpha;                 /* break up choose by letter */
 118 extern GtkTooltips *tips;
 119 extern int rtp_supported;
 120 extern int rtp_is_running;
 121 extern GtkItemFactory *mainmenufactory;
 122
 123 extern const disorder_eclient_log_callbacks log_callbacks;
 124
 125 typedef void monitor_callback(void *u);
 126
 127 /* Functions --------------------------------------------------------------- */
 128
 129 disorder_eclient *gtkclient(void);
 130 /* Configure C for use in GTK+ programs */
 131
 132 void popup_protocol_error(int code,
 133                           const char *msg);
 134 /* Report an error */
 135
 136 void properties(int ntracks, const char **tracks);
 137 /* Pop up a properties window for a list of tracks */
 138
 139 void properties_reset(void);
 140
 141 GtkWidget *scroll_widget(GtkWidget *child);
 142 /* Wrap a widget up for scrolling */
 143
 144 GtkWidget *frame_widget(GtkWidget *w, const char *title);
 145
 146 GdkPixbuf *find_image(const char *name);
 147 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
 148  * found. */
 149
 150 void popup_msg(GtkMessageType mt, const char *msg);
 151 void popup_submsg(GtkWidget *parent, GtkMessageType mt, const char *msg);
 152
 153 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
 154
 155 struct progress_window *progress_window_new(const char *title);
 156 /* Pop up a progress window */
 157
 158 void progress_window_progress(struct progress_window *pw,
 159                               int progress,
 160                               int limit);
 161 /* Report current progress */
 162
 163 GtkWidget *iconbutton(const char *path, const char *tip);
 164
 165 GtkWidget *create_buttons(struct button *buttons,
 166                           size_t nbuttons);
 167 GtkWidget *create_buttons_box(struct button *buttons,
 168                               size_t nbuttons,
 169                               GtkWidget *box);
 170
 171 void register_monitor(monitor_callback *callback,
 172                       void *u,
 173                       unsigned long mask);
 174 /* Register a state monitor */
 175
 176 /** @brief Type signature for a reset callback */
 177 typedef void reset_callback(void);
 178
 179 void register_reset(reset_callback *callback);
 180 /* Register a reset callback */
 181
 182 void reset(void);
 183
 184 void all_update(void);
 185 /* Update everything */
 186
 187 /* Main menu */
 188
 189 GtkWidget *menubar(GtkWidget *w);
 190 /* Create the menu bar */
 191
 192 void menu_update(int page);
 193 /* Called whenever the main menu might need to change.  PAGE is the current
 194  * page if known or -1 otherwise. */
 195
 196 void users_set_sensitive(int sensitive);
 197
 198 /* Controls */
 199
 200 GtkWidget *control_widget(void);
 201 /* Make the controls widget */
 202
 203 void control_monitor(void *u);
 204
 205 extern int suppress_actions;
 206
 207 /* Queue/Recent/Added */
 208
 209 GtkWidget *queue_widget(void);
 210 GtkWidget *recent_widget(void);
 211 GtkWidget *added_widget(void);
 212 /* Create widgets for displaying the queue, the recently played list and the
 213  * newly added tracks list */
 214
 215 void queue_select_all(struct queuelike *ql);
 216 void queue_select_none(struct queuelike *ql);
 217 /* Select all/none on some queue */
 218
 219 void queue_properties(struct queuelike *ql);
 220 /* Pop up properties of selected items in some queue */
 221
 222 int queued(const char *track);
 223 /* Return nonzero iff TRACK is queued or playing */
 224
 225 void namepart_update(const char *track,
 226                      const char *context,
 227                      const char *part);
 228 /* Called when a namepart might have changed */
 229
 230 /* Choose */
 231
 232 GtkWidget *choose_widget(void);
 233 /* Create a widget for choosing tracks */
 234
 235 void choose_update(void);
 236 /* Called when we think the choose tree might need updating */
 237
 238 void play_completed(void *v,
 239                     const char *error);
 240
 241 /* Login details */
 242
 243 void login_box(void);
 244
 245 GtkWidget *login_window;
 246
 247 /* User management */
 248
 249 void manage_users(void);
 250
 251 /* Help */
 252
 253 void popup_help(void);
 254
 255 /* RTP */
 256
 257 int rtp_running(void);
 258 void start_rtp(void);
 259 void stop_rtp(void);
 260
 261 /* Settings */
 262
 263 void init_styles(void);
 264 extern GtkStyle *layout_style;
 265 extern GtkStyle *title_style;
 266 extern GtkStyle *even_style;
 267 extern GtkStyle *odd_style;
 268 extern GtkStyle *active_style;
 269 extern GtkStyle *tool_style;
 270 extern GtkStyle *search_style;
 271 extern GtkStyle *drag_style;
 272
 273 extern const char *browser;
 274
 275 void save_settings(void);
 276 void load_settings(void);
 277 void set_tool_colors(GtkWidget *w);
 278 void popup_settings(void);
 279
 280 /* Widget leakage debugging rubbish ---------------------------------------- */
 281
 282 #if MDEBUG
 283 #define NW(what) do {                                   \
 284   if(++current##what % 100 > max##what) {               \
 285     fprintf(stderr, "%s:%d: %d %s\n",                   \
 286             __FILE__, __LINE__, current##what, #what);  \
 287     max##what = current##what;                          \
 288   }                                                     \
 289 } while(0)
 290 #define WT(what) static int current##what, max##what
 291 #define DW(what) (--current##what)
 292 #else
 293 #define NW(what) do { } while(0)
 294 #define DW(what) do { } while(0)
 295 #define WT(what) struct neverused
 296 #endif
 297
 298 #if MTRACK
 299 extern const char *mtag;
 300 #define MTAG(x) do { mtag = x; } while(0)
 301 #define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
 302 #define MTAG_POP() mtag = save_mtag; } while(0)
 303 #else
 304 #define MTAG(x) do { } while(0)
 305 #define MTAG_PUSH(x) do {} while(0)
 306 #define MTAG_POP() do {} while(0)
 307 #endif
 308
 309 #endif /* DISOBEDIENCE_H */
 310
 311 /*
 312 Local Variables:
 313 c-basic-offset:2
 314 comment-column:40
 315 fill-column:79
 316 indent-tabs-mode:nil
 317 End:
 318 */