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 <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;
  61 struct progress_window;
  62
  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  */
  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     const char *user;                   /* users.c */
  79   } u;
  80 };
  81
  82 /** @brief Per-tab callbacks
  83  *
  84  * Some of the options in the main menu depend on which tab is displayed, so we
  85  * have some callbacks to set them appropriately.
  86  */
  87 struct tabtype {
  88   int (*properties_sensitive)(GtkWidget *tab);
  89   int (*selectall_sensitive)(GtkWidget *tab);
  90   int (*selectnone_sensitive)(GtkWidget *tab);
  91   void (*properties_activate)(GtkWidget *tab);
  92   void (*selectall_activate)(GtkWidget *tab);
  93   void (*selectnone_activate)(GtkWidget *tab);
  94 };
  95
  96 /** @brief Button definitions */
  97 struct button {
  98   const gchar *stock;
  99   void (*clicked)(GtkButton *button, gpointer userdata);
 100   const char *tip;
 101 };
 102
 103 /* Variables --------------------------------------------------------------- */
 104
 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 */
 110
 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;
 120
 121 extern const disorder_eclient_log_callbacks log_callbacks;
 122
 123 typedef void monitor_callback(void *u);
 124
 125 /* Functions --------------------------------------------------------------- */
 126
 127 disorder_eclient *gtkclient(void);
 128 /* Configure C for use in GTK+ programs */
 129
 130 void popup_protocol_error(int code,
 131                           const char *msg);
 132 /* Report an error */
 133
 134 void properties(int ntracks, const char **tracks);
 135 /* Pop up a properties window for a list of tracks */
 136
 137 void properties_reset(void);
 138
 139 GtkWidget *scroll_widget(GtkWidget *child);
 140 /* Wrap a widget up for scrolling */
 141
 142 GdkPixbuf *find_image(const char *name);
 143 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
 144  * found. */
 145
 146 void popup_msg(GtkMessageType mt, const char *msg);
 147 /* Pop up a message */
 148
 149 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
 150
 151 struct progress_window *progress_window_new(const char *title);
 152 /* Pop up a progress window */
 153
 154 void progress_window_progress(struct progress_window *pw,
 155                               int progress,
 156                               int limit);
 157 /* Report current progress */
 158
 159 GtkWidget *iconbutton(const char *path, const char *tip);
 160
 161 GtkWidget *create_buttons(const struct button *buttons,
 162                           size_t nbuttons);
 163 GtkWidget *create_buttons_box(const struct button *buttons,
 164                               size_t nbuttons,
 165                               GtkWidget *box);
 166
 167 void register_monitor(monitor_callback *callback,
 168                       void *u,
 169                       unsigned long mask);
 170 /* Register a state monitor */
 171
 172 /** @brief Type signature for a reset callback */
 173 typedef void reset_callback(void);
 174
 175 void register_reset(reset_callback *callback);
 176 /* Register a reset callback */
 177
 178 void reset(void);
 179
 180 void all_update(void);
 181 /* Update everything */
 182
 183 /* Main menu */
 184
 185 GtkWidget *menubar(GtkWidget *w);
 186 /* Create the menu bar */
 187
 188 void menu_update(int page);
 189 /* Called whenever the main menu might need to change.  PAGE is the current
 190  * page if known or -1 otherwise. */
 191
 192
 193 /* Controls */
 194
 195 GtkWidget *control_widget(void);
 196 /* Make the controls widget */
 197
 198 void volume_update(void);
 199 /* Called whenever we think the volume control has changed */
 200
 201 void control_monitor(void *u);
 202
 203 extern int suppress_actions;
 204
 205 /* Queue/Recent/Added */
 206
 207 GtkWidget *queue_widget(void);
 208 GtkWidget *recent_widget(void);
 209 GtkWidget *added_widget(void);
 210 /* Create widgets for displaying the queue, the recently played list and the
 211  * newly added tracks list */
 212
 213 void queue_update(void);
 214 void recent_update(void);
 215 void added_update(void);
 216 /* Called whenever we think the queue, recent or newly-added list might have
 217  * changed */
 218
 219 void queue_select_all(struct queuelike *ql);
 220 void queue_select_none(struct queuelike *ql);
 221 /* Select all/none on some queue */
 222
 223 void queue_properties(struct queuelike *ql);
 224 /* Pop up properties of selected items in some queue */
 225
 226 int queued(const char *track);
 227 /* Return nonzero iff TRACK is queued or playing */
 228
 229 void namepart_update(const char *track,
 230                      const char *context,
 231                      const char *part);
 232 /* Called when a namepart might have changed */
 233
 234
 235 /* Choose */
 236
 237 GtkWidget *choose_widget(void);
 238 /* Create a widget for choosing tracks */
 239
 240 void choose_update(void);
 241 /* Called when we think the choose tree might need updating */
 242
 243 /* Login details */
 244
 245 void login_box(void);
 246
 247 GtkWidget *login_window;
 248
 249 /* User management */
 250
 251 void manage_users(void);
 252
 253 /* Help */
 254
 255 void popup_help(void);
 256
 257 /* RTP */
 258
 259 int rtp_running(void);
 260 void start_rtp(void);
 261 void stop_rtp(void);
 262
 263 /* Settings */
 264
 265 void init_styles(void);
 266 extern GtkStyle *layout_style;
 267 extern GtkStyle *title_style;
 268 extern GtkStyle *even_style;
 269 extern GtkStyle *odd_style;
 270 extern GtkStyle *active_style;
 271 extern GtkStyle *tool_style;
 272 extern GtkStyle *search_style;
 273 extern GtkStyle *drag_style;
 274
 275 extern const char *browser;
 276
 277 void save_settings(void);
 278 void load_settings(void);
 279 void set_tool_colors(GtkWidget *w);
 280 void popup_settings(void);
 281
 282 /* Widget leakage debugging rubbish ---------------------------------------- */
 283
 284 #if MDEBUG
 285 #define NW(what) do {                                   \
 286   if(++current##what % 100 > max##what) {               \
 287     fprintf(stderr, "%s:%d: %d %s\n",                   \
 288             __FILE__, __LINE__, current##what, #what);  \
 289     max##what = current##what;                          \
 290   }                                                     \
 291 } while(0)
 292 #define WT(what) static int current##what, max##what
 293 #define DW(what) (--current##what)
 294 #else
 295 #define NW(what) do { } while(0)
 296 #define DW(what) do { } while(0)
 297 #define WT(what) struct neverused
 298 #endif
 299
 300 #if MTRACK
 301 extern const char *mtag;
 302 #define MTAG(x) do { mtag = x; } while(0)
 303 #define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
 304 #define MTAG_POP() mtag = save_mtag; } while(0)
 305 #else
 306 #define MTAG(x) do { } while(0)
 307 #define MTAG_PUSH(x) do {} while(0)
 308 #define MTAG_POP() do {} while(0)
 309 #endif
 310
 311 #endif /* DISOBEDIENCE_H */
 312
 313 /*
 314 Local Variables:
 315 c-basic-offset:2
 316 comment-column:40
 317 fill-column:79
 318 indent-tabs-mode:nil
 319 End:
 320 */