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