chiark / gitweb /
relax config file checking for non-server programs
[disorder] / disobedience / disobedience.c
index 7c6ef3dc9d6e0a7d1a03eb724785d8b359f22305..72b07200bc65ab14c55e143c94465bf31cfd7aaf 100644 (file)
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file disobedience/disobedience.c
+ * @brief Main Disobedience program
+ */
 
 #include "disobedience.h"
 
 #include <getopt.h>
 #include <locale.h>
+#include <pcre.h>
 
 /* Apologies for the numerous de-consting casts, but GLib et al do not seem to
  * have heard of const. */
 
 #include "style.h"                      /* generated style */
 
-/* Functions --------------------------------------------------------------- */
-
-static void log_connected(void *v);
-static void log_completed(void *v, const char *track);
-static void log_failed(void *v, const char *track, const char *status);
-static void log_moved(void *v, const char *user);
-static void log_playing(void *v, const char *track, const char *user);
-static void log_queue(void *v, struct queue_entry *q);
-static void log_recent_added(void *v, struct queue_entry *q);
-static void log_recent_removed(void *v, const char *id);
-static void log_removed(void *v, const char *id, const char *user);
-static void log_scratched(void *v, const char *track, const char *user);
-static void log_state(void *v, unsigned long state);
-static void log_volume(void *v, int l, int r);
-
 /* Variables --------------------------------------------------------------- */
 
-GMainLoop *mainloop;                    /* event loop */
-GtkWidget *toplevel;                    /* top level window */
-GtkWidget *report_label;                /* label for progress indicator */
-GtkWidget *tabs;                        /* main tabs */
+/** @brief Event loop */
+GMainLoop *mainloop;
+
+/** @brief Top-level window */
+GtkWidget *toplevel;
+
+/** @brief Label for progress indicator */
+GtkWidget *report_label;
+
+/** @brief Main tab group */
+GtkWidget *tabs;
+
+/** @brief Main client */
+disorder_eclient *client;
+
+/** @brief Last reported state
+ *
+ * This is updated by log_state().
+ */
+unsigned long last_state;
+
+/** @brief True if some track is playing
+ *
+ * This ought to be removed in favour of last_state & DISORDER_PLAYING
+ */
+int playing;
+
+/** @brief Left channel volume */
+int volume_l;
 
-disorder_eclient *client;               /* main client */
+/** @brief Right channel volume */
+int volume_r;
 
-unsigned long last_state;               /* last reported state */
-int playing;                            /* true if playing some track */
-int volume_l, volume_r;                 /* volume */
 double goesupto = 10;                   /* volume upper bound */
-int choosealpha;                        /* break up choose by letter */
-
-static const disorder_eclient_log_callbacks gdisorder_log_callbacks = {
-  log_connected,
-  log_completed,
-  log_failed,
-  log_moved,
-  log_playing,
-  log_queue,
-  log_recent_added,
-  log_recent_removed,
-  log_removed,
-  log_scratched,
-  log_state,
-  log_volume
-};
+
+/** @brief Break up choose tab by initial letter */
+int choosealpha;
+
+/** @brief True if a NOP is in flight */
+static int nop_in_flight;
+
+/** @brief Global tooltip group */
+GtkTooltips *tips;
 
 /* Window creation --------------------------------------------------------- */
 
 /* Note that all the client operations kicked off from here will only complete
  * after we've entered the event loop. */
 
+/** @brief Called when main window is deleted
+ *
+ * Terminates the program.
+ */
 static gboolean delete_event(GtkWidget attribute((unused)) *widget,
                              GdkEvent attribute((unused)) *event,
                              gpointer attribute((unused)) data) {
@@ -85,7 +94,10 @@ static gboolean delete_event(GtkWidget attribute((unused)) *widget,
   exit(0);                              /* die immediately */
 }
 
-/* Called when the current tab is switched. */
+/** @brief Called when the current tab is switched
+ *
+ * Updates the menu settings to correspond to the new page.
+ */
 static void tab_switched(GtkNotebook attribute((unused)) *notebook,
                          GtkNotebookPage attribute((unused)) *page,
                          guint page_num,
@@ -93,6 +105,7 @@ static void tab_switched(GtkNotebook attribute((unused)) *notebook,
   menu_update(page_num);
 }
 
+/** @brief Create the report box */
 static GtkWidget *report_box(void) {
   GtkWidget *vbox = gtk_vbox_new(FALSE, 0);
 
@@ -104,6 +117,7 @@ static GtkWidget *report_box(void) {
   return vbox;
 }
 
+/** @brief Create and populate the main tab group */
 static GtkWidget *notebook(void) {
   tabs = gtk_notebook_new();
   g_signal_connect(tabs, "switch-page", G_CALLBACK(tab_switched), 0);
@@ -116,6 +130,7 @@ static GtkWidget *notebook(void) {
   return tabs;
 }
 
+/** @brief Create and populate the main window */
 static void make_toplevel_window(void) {
   GtkWidget *const vbox = gtk_vbox_new(FALSE, 1);
   GtkWidget *const rb = report_box();
@@ -150,107 +165,95 @@ static void make_toplevel_window(void) {
   gtk_widget_set_name(toplevel, "disobedience");
 }
 
-/* State monitoring -------------------------------------------------------- */
-
-static void all_update(void) {
-  playing_update();
-  queue_update();
-  recent_update();
-  control_update();
-}
-
-static void log_connected(void attribute((unused)) *v) {
-  struct callbackdata *cbd;
+#if MDEBUG
+static int widget_count, container_count;
 
-  /* Don't know what we might have missed while disconnected so update
-   * everything.  We get this at startup too and this is how we do the initial
-   * state fetch. */
-  all_update();
-  /* Re-get the volume */
-  cbd = xmalloc(sizeof *cbd);
-  cbd->onerror = 0;
-  disorder_eclient_volume(client, log_volume, -1, -1, cbd);
-}
-
-static void log_completed(void attribute((unused)) *v,
-                          const char attribute((unused)) *track) {
-  playing = 0;
-  playing_update();
-  control_update();
-}
-
-static void log_failed(void attribute((unused)) *v,
-                       const char attribute((unused)) *track,
-                       const char attribute((unused)) *status) {
-  playing = 0;
-  playing_update();
-  control_update();
+static void count_callback(GtkWidget *w,
+                           gpointer attribute((unused)) data) {
+  ++widget_count;
+  if(GTK_IS_CONTAINER(w)) {
+    ++container_count;
+    gtk_container_foreach(GTK_CONTAINER(w), count_callback, 0);
+  }
 }
 
-static void log_moved(void attribute((unused)) *v,
-                      const char attribute((unused)) *user) {
-   queue_update();
+static void count_widgets(void) {
+  widget_count = 0;
+  container_count = 1;
+  if(toplevel)
+    gtk_container_foreach(GTK_CONTAINER(toplevel), count_callback, 0);
+  fprintf(stderr, "widget count: %8d  container count: %8d\n",
+          widget_count, container_count);
 }
-
-static void log_playing(void attribute((unused)) *v,
-                        const char attribute((unused)) *track,
-                        const char attribute((unused)) *user) {
-  playing = 1;
-  playing_update();
-  control_update();
-  /* we get a log_removed() anyway so we don't need to update_queue() from
-   * here */
+#endif
+
+#if MTRACK
+const char *mtag = "init";
+static hash *mtrack_hash;
+
+static int *mthfind(const char *tag) {
+  static const int zero = 0;
+  int *cp = hash_find(mtrack_hash, tag);
+  if(!cp) {
+    hash_add(mtrack_hash, tag, &zero, HASH_INSERT);
+    cp = hash_find(mtrack_hash, tag);
+  }
+  return cp;
 }
 
-static void log_queue(void attribute((unused)) *v,
-                      struct queue_entry attribute((unused)) *q) {
-  queue_update();
-}
+static void *trap_malloc(size_t n) {
+  void *ptr = malloc(n + sizeof(char *));
 
-static void log_recent_added(void attribute((unused)) *v,
-                             struct queue_entry attribute((unused)) *q) {
-  recent_update();
+  *(const char **)ptr = mtag;
+  ++*mthfind(mtag);
+  return (char *)ptr + sizeof(char *);
 }
 
-static void log_recent_removed(void attribute((unused)) *v,
-                               const char attribute((unused)) *id) {
-  /* nothing - log_recent_added() will trigger the relevant update */
+static void trap_free(void *ptr) {
+  const char *tag;
+  if(!ptr)
+    return;
+  ptr = (char *)ptr - sizeof(char *);
+  tag = *(const char **)ptr;
+  --*mthfind(tag);
+  free(ptr);
 }
 
-static void log_removed(void attribute((unused)) *v,
-                        const char attribute((unused)) *id,
-                        const char attribute((unused)) *user) {
-  queue_update();
+static void *trap_realloc(void *ptr, size_t n) {
+  if(!ptr)
+    return trap_malloc(n);
+  if(!n) {
+    trap_free(ptr);
+    return 0;
+  }
+  ptr = (char *)ptr - sizeof(char *);
+  ptr = realloc(ptr, n + sizeof(char *));
+  *(const char **)ptr = mtag;
+  return (char *)ptr + sizeof(char *);
 }
 
-static void log_scratched(void attribute((unused)) *v,
-                          const char attribute((unused)) *track,
-                          const char attribute((unused)) *user) {
-  playing = 0;
-  playing_update();
-  control_update();
+static int report_tags_callback(const char *key, void *value,
+                                void attribute((unused)) *u) {
+  fprintf(stderr, "%16s: %d\n", key, *(int *)value);
+  return 0;
 }
 
-static void log_state(void attribute((unused)) *v,
-                      unsigned long state) {
-  last_state = state;
-  control_update();
-  /* If the track is paused or resume then the currently playing track is
-   * refetched so that we can continue to correctly calculate the played so-far
-   * field */
-  playing_update();
+static void report_tags(void) {
+  hash_foreach(mtrack_hash, report_tags_callback, 0);
+  fprintf(stderr, "\n");
 }
 
-static void log_volume(void attribute((unused)) *v,
-                       int l, int r) {
-  if(volume_l != l || volume_r != r) {
-    volume_l = l;
-    volume_r = r;
-    control_update();
-  }
-}
+static const GMemVTable glib_memvtable = {
+  trap_malloc,
+  trap_realloc,
+  trap_free,
+  0,
+  0,
+  0
+};
+#endif
 
-/* Called once every 10 minutes */
+/** @brief Called once every 10 minutes */
 static gboolean periodic(gpointer attribute((unused)) data) {
   D(("periodic"));
   /* Expire cached data */
@@ -258,9 +261,20 @@ static gboolean periodic(gpointer attribute((unused)) data) {
   /* Update everything to be sure that the connection to the server hasn't
    * mysteriously gone stale on us. */
   all_update();
+#if MDEBUG
+  count_widgets();
+  fprintf(stderr, "cache size: %zu\n", cache_count());
+#endif
+#if MTRACK
+  report_tags();
+#endif
   return TRUE;                          /* don't remove me */
 }
 
+/** @brief Called from time to time
+ *
+ * Used for debugging purposes
+ */
 static gboolean heartbeat(gpointer attribute((unused)) data) {
   static struct timeval last;
   struct timeval now;
@@ -279,6 +293,24 @@ static gboolean heartbeat(gpointer attribute((unused)) data) {
   return TRUE;
 }
 
+/** @brief Called when a NOP completes */
+static void nop_completed(void attribute((unused)) *v) {
+  nop_in_flight = 0;
+}
+
+/** @brief Called from time to time to arrange for a NOP to be sent
+ *
+ * At most one NOP remains in flight at any moment.  If the client is not
+ * currently connected then no NOP is sent.
+ */
+static gboolean maybe_send_nop(gpointer attribute((unused)) data) {
+  if(!nop_in_flight && (disorder_eclient_state(client) & DISORDER_CONNECTED)) {
+    nop_in_flight = 1;
+    disorder_eclient_nop(client, nop_completed, 0);
+  }
+  return TRUE;                          /* keep call me please */
+}
+
 /* main -------------------------------------------------------------------- */
 
 static const struct option options[] = {
@@ -319,7 +351,14 @@ int main(int argc, char **argv) {
   int n;
   disorder_eclient *logclient;
 
-  mem_init(1);
+  mem_init();
+  /* garbage-collect PCRE's memory */
+  pcre_malloc = xmalloc;
+  pcre_free = xfree;
+#if MTRACK
+  mtrack_hash = hash_new(sizeof (int));
+  g_mem_set_vtable((GMemVTable *)&glib_memvtable);
+#endif
   if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
   gtk_init(&argc, &argv);
   gtk_rc_parse_string(style);
@@ -338,23 +377,37 @@ int main(int argc, char **argv) {
   /* create the event loop */
   D(("create main loop"));
   mainloop = g_main_loop_new(0, 0);
-  if(config_read()) fatal(0, "cannot read configuration");
+  if(config_read(0)) fatal(0, "cannot read configuration");
   /* create the clients */
   if(!(client = gtkclient())
      || !(logclient = gtkclient()))
     return 1;                           /* already reported an error */
-  disorder_eclient_log(logclient, &gdisorder_log_callbacks, 0);
   /* periodic operations (e.g. expiring the cache) */
+#if MDEBUG || MTRACK
+  g_timeout_add(5000/*milliseconds*/, periodic, 0);
+#else
   g_timeout_add(600000/*milliseconds*/, periodic, 0);
+#endif
   /* The point of this is to try and get a handle on mysterious
    * unresponsiveness.  It's not very useful in production use. */
   if(0)
     g_timeout_add(1000/*milliseconds*/, heartbeat, 0);
+  /* global tooltips */
+  tips = gtk_tooltips_new();
   make_toplevel_window();
   /* reset styles now everything has its name */
   gtk_rc_reset_styles(gtk_settings_get_for_screen(gdk_screen_get_default()));
   gtk_widget_show_all(toplevel);
+  /* issue a NOP every so often */
+  g_timeout_add_full(G_PRIORITY_LOW,
+                     1000/*interval, ms*/,
+                     maybe_send_nop,
+                     0/*data*/,
+                     0/*notify*/);
+  /* Start monitoring the log */
+  disorder_eclient_log(logclient, &log_callbacks, 0);
   D(("enter main loop"));
+  MTAG("misc");
   g_main_loop_run(mainloop);
   return 0;
 }