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

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2006, 2007 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   } u;
  79 };
  80
  81 /** @brief Per-tab callbacks
  82  *
  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.
  85  */
  86 struct tabtype {
  87   int (*properties_sensitive)(GtkWidget *tab);
  88   int (*selectall_sensitive)(GtkWidget *tab);
  89   void (*properties_activate)(GtkWidget *tab);
  90   void (*selectall_activate)(GtkWidget *tab);
  91 };
  92
  93 /** @brief Button definitions */
  94 struct button {
  95   const gchar *stock;
  96   void (*clicked)(GtkButton *button, gpointer userdata);
  97   const char *tip;
  98 };
  99
 100 /* Variables --------------------------------------------------------------- */
 101
 102 extern GMainLoop *mainloop;
 103 extern GtkWidget *toplevel;             /* top level window */
 104 extern GtkWidget *report_label;         /* label for progress indicator */
 105 extern GtkWidget *tabs;                 /* main tabs */
 106 extern disorder_eclient *client;        /* main client */
 107
 108 extern unsigned long last_state;        /* last reported state */
 109 extern int playing;                     /* true if playing some track */
 110 extern int volume_l, volume_r;          /* current volume */
 111 extern double goesupto;                 /* volume upper bound */
 112 extern int choosealpha;                 /* break up choose by letter */
 113 extern GtkTooltips *tips;
 114
 115 extern const disorder_eclient_log_callbacks log_callbacks;
 116
 117 typedef void monitor_callback(void *u);
 118
 119 /* Functions --------------------------------------------------------------- */
 120
 121 disorder_eclient *gtkclient(void);
 122 /* Configure C for use in GTK+ programs */
 123
 124 void popup_protocol_error(int code,
 125                           const char *msg);
 126 /* Report an error */
 127
 128 void properties(int ntracks, const char **tracks);
 129 /* Pop up a properties window for a list of tracks */
 130
 131 void properties_reset(void);
 132
 133 GtkWidget *scroll_widget(GtkWidget *child, const char *name);
 134 /* Wrap a widget up for scrolling */
 135
 136 GdkPixbuf *find_image(const char *name);
 137 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
 138  * found. */
 139
 140 void popup_error(const char *msg);
 141 /* Pop up an error message */
 142
 143 void fpopup_error(const char *fmt, ...);
 144
 145 struct progress_window *progress_window_new(const char *title);
 146 /* Pop up a progress window */
 147
 148 void progress_window_progress(struct progress_window *pw,
 149                               int progress,
 150                               int limit);
 151 /* Report current progress */
 152
 153 GtkWidget *iconbutton(const char *path, const char *tip);
 154
 155 GtkWidget *create_buttons(const struct button *buttons,
 156                           size_t nbuttons);
 157
 158 void register_monitor(monitor_callback *callback,
 159                       void *u,
 160                       unsigned long mask);
 161 /* Register a state monitor */
 162
 163 /** @brief Type signature for a reset callback */
 164 typedef void reset_callback(void);
 165
 166 void register_reset(reset_callback *callback);
 167 /* Register a reset callback */
 168
 169 void reset(void);
 170
 171 void all_update(void);
 172 /* Update everything */
 173
 174 /* Main menu */
 175
 176 GtkWidget *menubar(GtkWidget *w);
 177 /* Create the menu bar */
 178
 179 void menu_update(int page);
 180 /* Called whenever the main menu might need to change.  PAGE is the current
 181  * page if known or -1 otherwise. */
 182
 183
 184 /* Controls */
 185
 186 GtkWidget *control_widget(void);
 187 /* Make the controls widget */
 188
 189 void volume_update(void);
 190 /* Called whenever we think the volume control has changed */
 191
 192 /* Queue/Recent/Added */
 193
 194 GtkWidget *queue_widget(void);
 195 GtkWidget *recent_widget(void);
 196 GtkWidget *added_widget(void);
 197 /* Create widgets for displaying the queue, the recently played list and the
 198  * newly added tracks list */
 199
 200 void queue_update(void);
 201 void recent_update(void);
 202 void added_update(void);
 203 /* Called whenever we think the queue, recent or newly-added list might have
 204  * changed */
 205
 206 void queue_select_all(struct queuelike *ql);
 207 /* Select all on some queue */
 208
 209 void queue_properties(struct queuelike *ql);
 210 /* Pop up properties of selected items in some queue */
 211
 212 int queued(const char *track);
 213 /* Return nonzero iff TRACK is queued or playing */
 214
 215 void namepart_update(const char *track,
 216                      const char *context,
 217                      const char *part);
 218 /* Called when a namepart might have changed */
 219
 220
 221 /* Choose */
 222
 223 GtkWidget *choose_widget(void);
 224 /* Create a widget for choosing tracks */
 225
 226 void choose_update(void);
 227 /* Called when we think the choose tree might need updating */
 228
 229 void login_box(void);
 230
 231 /* Widget leakage debugging rubbish ---------------------------------------- */
 232
 233 #if MDEBUG
 234 #define NW(what) do {                                   \
 235   if(++current##what % 100 > max##what) {               \
 236     fprintf(stderr, "%s:%d: %d %s\n",                   \
 237             __FILE__, __LINE__, current##what, #what);  \
 238     max##what = current##what;                          \
 239   }                                                     \
 240 } while(0)
 241 #define WT(what) static int current##what, max##what
 242 #define DW(what) (--current##what)
 243 #else
 244 #define NW(what) do { } while(0)
 245 #define DW(what) do { } while(0)
 246 #define WT(what) struct neverused
 247 #endif
 248
 249 #if MTRACK
 250 extern const char *mtag;
 251 #define MTAG(x) do { mtag = x; } while(0)
 252 #define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
 253 #define MTAG_POP() mtag = save_mtag; } while(0)
 254 #else
 255 #define MTAG(x) do { } while(0)
 256 #define MTAG_PUSH(x) do {} while(0)
 257 #define MTAG_POP() do {} while(0)
 258 #endif
 259
 260 #endif /* DISOBEDIENCE_H */
 261
 262 /*
 263 Local Variables:
 264 c-basic-offset:2
 265 comment-column:40
 266 fill-column:79
 267 indent-tabs-mode:nil
 268 End:
 269 */