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)(void *extra);
  91   int (*selectall_sensitive)(void *extra);
  92   int (*selectnone_sensitive)(void *extra);
  93   void (*properties_activate)(GtkMenuItem *menuitem,
  94                               gpointer user_data);
  95   void (*selectall_activate)(GtkMenuItem *menuitem,
  96                              gpointer user_data);
  97   void (*selectnone_activate)(GtkMenuItem *menuitem,
  98                               gpointer user_data);
  99   void (*selected)(void);
 100   void *extra;
 101 };
 102
 103 /** @brief Button definitions */
 104 struct button {
 105   const gchar *stock;
 106   void (*clicked)(GtkButton *button, gpointer userdata);
 107   const char *tip;
 108   GtkWidget *widget;
 109 };
 110
 111 /* Variables --------------------------------------------------------------- */
 112
 113 extern GMainLoop *mainloop;
 114 extern GtkWidget *toplevel;             /* top level window */
 115 extern GtkWidget *report_label;         /* label for progress indicator */
 116 extern GtkWidget *tabs;                 /* main tabs */
 117 extern disorder_eclient *client;        /* main client */
 118
 119 extern unsigned long last_state;        /* last reported state */
 120 extern rights_type last_rights;         /* last reported rights bitmap */
 121 extern int playing;                     /* true if playing some track */
 122 extern int volume_l, volume_r;          /* current volume */
 123 extern double goesupto;                 /* volume upper bound */
 124 extern int choosealpha;                 /* break up choose by letter */
 125 extern GtkTooltips *tips;
 126 extern int rtp_supported;
 127 extern int rtp_is_running;
 128 extern GtkItemFactory *mainmenufactory;
 129
 130 extern const disorder_eclient_log_callbacks log_callbacks;
 131
 132 /* Functions --------------------------------------------------------------- */
 133
 134 disorder_eclient *gtkclient(void);
 135 /* Configure C for use in GTK+ programs */
 136
 137 void popup_protocol_error(int code,
 138                           const char *msg);
 139 /* Report an error */
 140
 141 void properties(int ntracks, const char **tracks);
 142 /* Pop up a properties window for a list of tracks */
 143
 144 GtkWidget *scroll_widget(GtkWidget *child);
 145 /* Wrap a widget up for scrolling */
 146
 147 GtkWidget *frame_widget(GtkWidget *w, const char *title);
 148
 149 GdkPixbuf *find_image(const char *name);
 150 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
 151  * found. */
 152
 153 void popup_msg(GtkMessageType mt, const char *msg);
 154 void popup_submsg(GtkWidget *parent, GtkMessageType mt, const char *msg);
 155
 156 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
 157
 158 struct progress_window *progress_window_new(const char *title);
 159 /* Pop up a progress window */
 160
 161 void progress_window_progress(struct progress_window *pw,
 162                               int progress,
 163                               int limit);
 164 /* Report current progress */
 165
 166 GtkWidget *iconbutton(const char *path, const char *tip);
 167
 168 GtkWidget *create_buttons(struct button *buttons,
 169                           size_t nbuttons);
 170 GtkWidget *create_buttons_box(struct button *buttons,
 171                               size_t nbuttons,
 172                               GtkWidget *box);
 173
 174 void logged_in(void);
 175
 176 void all_update(void);
 177 /* Update everything */
 178
 179 /* Main menu */
 180
 181 GtkWidget *menubar(GtkWidget *w);
 182 /* Create the menu bar */
 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 extern struct queue_entry *playing_track;
 212
 213 /* Lookups */
 214 const char *namepart(const char *track,
 215                      const char *context,
 216                      const char *part);
 217 long namepart_length(const char *track);
 218
 219 void namepart_update(const char *track,
 220                      const char *context,
 221                      const char *part);
 222 /* Called when a namepart might have changed */
 223
 224 /* Choose */
 225
 226 GtkWidget *choose_widget(void);
 227 /* Create a widget for choosing tracks */
 228
 229 void choose_update(void);
 230 /* Called when we think the choose tree might need updating */
 231
 232 void play_completed(void *v,
 233                     const char *error);
 234
 235 /* Login details */
 236
 237 void login_box(void);
 238
 239 GtkWidget *login_window;
 240
 241 /* User management */
 242
 243 void manage_users(void);
 244
 245 /* Help */
 246
 247 void popup_help(void);
 248
 249 /* RTP */
 250
 251 int rtp_running(void);
 252 void start_rtp(void);
 253 void stop_rtp(void);
 254
 255 /* Settings */
 256
 257 void init_styles(void);
 258 extern GtkStyle *layout_style;
 259 extern GtkStyle *title_style;
 260 extern GtkStyle *even_style;
 261 extern GtkStyle *odd_style;
 262 extern GtkStyle *active_style;
 263 extern GtkStyle *tool_style;
 264 extern GtkStyle *search_style;
 265 extern GtkStyle *drag_style;
 266
 267 extern const char *browser;
 268
 269 void save_settings(void);
 270 void load_settings(void);
 271 void set_tool_colors(GtkWidget *w);
 272 void popup_settings(void);
 273
 274 #endif /* DISOBEDIENCE_H */
 275
 276 /*
 277 Local Variables:
 278 c-basic-offset:2
 279 comment-column:40
 280 fill-column:79
 281 indent-tabs-mode:nil
 282 End:
 283 */