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 #include "split.h"
  51
  52 #include <glib.h>
  53 #include <gtk/gtk.h>
  54 #include <gdk-pixbuf/gdk-pixbuf.h>
  55
  56 /* Types ------------------------------------------------------------------- */
  57
  58 struct queuelike;
  59 struct choosenode;
  60 struct progress_window;
  61
  62 /** @brief Callback data structure
  63  *
  64  * This program is extremely heavily callback-driven.  Rather than have
  65  * numerous different callback structures we have a single one which can be
  66  * interpreted adequately both by success and error handlers.
  67  */
  68 struct callbackdata {
  69   void (*onerror)(struct callbackdata *cbd,
  70                   int code,
  71                   const char *msg);     /* called on error */
  72   union {
  73     const char *key;                    /* gtkqueue.c op_part_lookup */
  74     struct choosenode *choosenode;      /* gtkchoose.c got_files/got_dirs */
  75     struct queuelike *ql;               /* gtkqueue.c queuelike_completed */
  76     struct prefdata *f;                 /* properties.c */
  77     const char *user;                   /* users.c */
  78     struct {
  79       const char *user, *email;         /* users.c */
  80     } edituser;
  81   } u;
  82 };
  83
  84 /** @brief Per-tab callbacks
  85  *
  86  * Some of the options in the main menu depend on which tab is displayed, so we
  87  * have some callbacks to set them appropriately.
  88  */
  89 struct tabtype {
  90   int (*properties_sensitive)(GtkWidget *tab);
  91   int (*selectall_sensitive)(GtkWidget *tab);
  92   int (*selectnone_sensitive)(GtkWidget *tab);
  93   void (*properties_activate)(GtkWidget *tab);
  94   void (*selectall_activate)(GtkWidget *tab);
  95   void (*selectnone_activate)(GtkWidget *tab);
  96   void (*selected)(void);
  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 rights_type last_rights;         /* last reported rights bitmap */
 117 extern int playing;                     /* true if playing some track */
 118 extern int volume_l, volume_r;          /* current volume */
 119 extern double goesupto;                 /* volume upper bound */
 120 extern int choosealpha;                 /* break up choose by letter */
 121 extern GtkTooltips *tips;
 122 extern int rtp_supported;
 123 extern int rtp_is_running;
 124 extern GtkItemFactory *mainmenufactory;
 125
 126 extern const disorder_eclient_log_callbacks log_callbacks;
 127
 128 /* Functions --------------------------------------------------------------- */
 129
 130 disorder_eclient *gtkclient(void);
 131 /* Configure C for use in GTK+ programs */
 132
 133 void popup_protocol_error(int code,
 134                           const char *msg);
 135 /* Report an error */
 136
 137 void properties(int ntracks, const char **tracks);
 138 /* Pop up a properties window for a list of tracks */
 139
 140 GtkWidget *scroll_widget(GtkWidget *child);
 141 /* Wrap a widget up for scrolling */
 142
 143 GtkWidget *frame_widget(GtkWidget *w, const char *title);
 144
 145 GdkPixbuf *find_image(const char *name);
 146 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
 147  * found. */
 148
 149 void popup_msg(GtkMessageType mt, const char *msg);
 150 void popup_submsg(GtkWidget *parent, GtkMessageType mt, const char *msg);
 151
 152 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
 153
 154 struct progress_window *progress_window_new(const char *title);
 155 /* Pop up a progress window */
 156
 157 void progress_window_progress(struct progress_window *pw,
 158                               int progress,
 159                               int limit);
 160 /* Report current progress */
 161
 162 GtkWidget *iconbutton(const char *path, const char *tip);
 163
 164 GtkWidget *create_buttons(struct button *buttons,
 165                           size_t nbuttons);
 166 GtkWidget *create_buttons_box(struct button *buttons,
 167                               size_t nbuttons,
 168                               GtkWidget *box);
 169
 170 void logged_in(void);
 171
 172 void all_update(void);
 173 /* Update everything */
 174
 175 /* Main menu */
 176
 177 GtkWidget *menubar(GtkWidget *w);
 178 /* Create the menu bar */
 179
 180 void menu_update(int page);
 181 /* Called whenever the main menu might need to change.  PAGE is the current
 182  * page if known or -1 otherwise. */
 183
 184 void users_set_sensitive(int sensitive);
 185
 186 /* Controls */
 187
 188 GtkWidget *control_widget(void);
 189 /* Make the controls widget */
 190
 191 extern int suppress_actions;
 192
 193 /* Queue/Recent/Added */
 194
 195 GtkWidget *queue_widget(void);
 196 GtkWidget *recent_widget(void);
 197 GtkWidget *added_widget(void);
 198 /* Create widgets for displaying the queue, the recently played list and the
 199  * newly added tracks list */
 200
 201 void queue_select_all(struct queuelike *ql);
 202 void queue_select_none(struct queuelike *ql);
 203 /* Select all/none on some queue */
 204
 205 void queue_properties(struct queuelike *ql);
 206 /* Pop up properties of selected items in some queue */
 207
 208 int queued(const char *track);
 209 /* Return nonzero iff TRACK is queued or playing */
 210
 211 void namepart_update(const char *track,
 212                      const char *context,
 213                      const char *part);
 214 /* Called when a namepart might have changed */
 215
 216 extern struct queue_entry *playing_track;
 217
 218 /* Choose */
 219
 220 GtkWidget *choose_widget(void);
 221 /* Create a widget for choosing tracks */
 222
 223 void choose_update(void);
 224 /* Called when we think the choose tree might need updating */
 225
 226 void play_completed(void *v,
 227                     const char *error);
 228
 229 /* Login details */
 230
 231 void login_box(void);
 232
 233 GtkWidget *login_window;
 234
 235 /* User management */
 236
 237 void manage_users(void);
 238
 239 /* Help */
 240
 241 void popup_help(void);
 242
 243 /* RTP */
 244
 245 int rtp_running(void);
 246 void start_rtp(void);
 247 void stop_rtp(void);
 248
 249 /* Settings */
 250
 251 void init_styles(void);
 252 extern GtkStyle *layout_style;
 253 extern GtkStyle *title_style;
 254 extern GtkStyle *even_style;
 255 extern GtkStyle *odd_style;
 256 extern GtkStyle *active_style;
 257 extern GtkStyle *tool_style;
 258 extern GtkStyle *search_style;
 259 extern GtkStyle *drag_style;
 260
 261 extern const char *browser;
 262
 263 void save_settings(void);
 264 void load_settings(void);
 265 void set_tool_colors(GtkWidget *w);
 266 void popup_settings(void);
 267
 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
 281 #define NW(what) do { } while(0)
 282 #define DW(what) do { } while(0)
 283 #define WT(what) struct neverused
 284 #endif
 285
 286 #if MTRACK
 287 extern 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
 297 #endif /* DISOBEDIENCE_H */
 298
 299 /*
 300 Local Variables:
 301 c-basic-offset:2
 302 comment-column:40
 303 fill-column:79
 304 indent-tabs-mode:nil
 305 End:
 306 */