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