Merge ../paraslash.fml/paraslash
[paraslash.git] / error.h
diff --git a/error.h b/error.h
index 924f960..9563303 100644 (file)
--- a/error.h
+++ b/error.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
 
 /** \file error.h list of error messages for all subsystems */
 
-/** \cond list of all subsystems that support the shiny new error facility */
+/** \cond list of all subsystems that support the shiny error facility */
 enum para_subsystem {
+       SS_CLIENT,
+       SS_GUI,
+       SS_TIME,
+       SS_WAV,
+       SS_COMPRESS,
+       SS_CLOSE_ON_FORK,
+       SS_DAEMON,
+       SS_DCCP_SEND,
+       SS_RINGBUFFER,
        SS_RECV,
        SS_NET,
        SS_ORTP_RECV,
+       SS_CLIENT_COMMON,
+       SS_AUDIOC,
+       SS_SCHED,
        SS_AUDIOD,
+       SS_AUDIOD_COMMAND,
        SS_EXEC,
-       SS_CLOSE_ON_FORK,
+       SS_STDIN,
+       SS_STDOUT,
        SS_SIGNAL,
        SS_STRING,
-       SS_DAEMON,
        SS_STAT,
-       SS_TIME,
        SS_GRAB_CLIENT,
        SS_HTTP_RECV,
        SS_RECV_COMMON,
        SS_FILTER_CHAIN,
-       SS_WAV,
-       SS_COMPRESS,
        SS_OGGDEC,
        SS_FILTER,
        SS_COMMAND,
@@ -53,24 +63,90 @@ enum para_subsystem {
        SS_AACDEC,
        SS_AAC_COMMON,
        SS_SERVER,
-       SS_AFS,
+       SS_VSS,
        SS_MYSQL_SELECTOR,
        SS_IPC,
        SS_DCCP,
        SS_DCCP_RECV,
-       SS_DCCP_SEND,
        SS_FD,
-       SS_GUI,
        SS_WRITE,
        SS_WRITE_COMMON,
-       SS_ALSA_WRITER,
-       SS_FILE_WRITER,
-       SS_RINGBUFFER};
+       SS_ALSA_WRITE,
+       SS_FILE_WRITE,
+       SS_OSX_WRITE,
+       SS_USER_LIST,
+       NUM_SS
+};
+
+/* these do not need error handling (yet) */
+#define SERVER_ERRORS
+#define CLIENT_ERRORS
+#define WAV_ERRORS
+#define COMPRESS_ERRORS
+#define TIME_ERRORS
+#define CLOSE_ON_FORK_ERRORS
+#define DAEMON_ERRORS
+#define ORTP_SEND_ERRORS
+#define GUI_ERRORS
+#define RINGBUFFER_ERRORS
+
+
 
-#define NUM_SS (SS_RINGBUFFER + 1)
 extern const char **para_errlist[];
 /** \endcond */
 
+#define USER_LIST_ERRORS \
+       PARA_ERROR(USERLIST, "failed to open user list file"), \
+       PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
+
+
+#define OSX_WRITE_ERRORS \
+       PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
+       PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
+       PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
+       PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
+       PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
+       PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
+       PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
+
+
+#define AUDIOC_ERRORS \
+       PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
+       PARA_ERROR(AUDIOC_READ, "audioc read error"), \
+       PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
+       PARA_ERROR(INIT_SOCK_ADDR, "can not init socket"), \
+       PARA_ERROR(AUDIOC_CONNECT, "audioc connect error"), \
+       PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
+
+
+
+
+#define CLIENT_COMMON_ERRORS \
+       PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
+       PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
+       PARA_ERROR(NO_CONFIG, "config file not found"), \
+       PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
+       PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
+       PARA_ERROR(INPUT_EOF, "end of input"), \
+       PARA_ERROR(HANDSHAKE_COMPLETE, ""), /* not really an error */ \
+
+
+#define SCHED_ERRORS \
+       PARA_ERROR(TASK_KILLED, "task killed"), \
+       PARA_ERROR(NO_SUCH_TASK, "task not found"), \
+       PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
+
+
+#define STDIN_ERRORS \
+       PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
+       PARA_ERROR(STDIN_EOF, "end of file"), \
+
+
+#define STDOUT_ERRORS \
+       PARA_ERROR(STDOUT_WRITE, "failed to write to stdout"), \
+       PARA_ERROR(STDOUT_EOF, "end of file"), \
+
+
 #define NET_ERRORS \
        PARA_ERROR(SEND, "send error"), \
        PARA_ERROR(RECV, "receive error"), \
@@ -95,12 +171,14 @@ extern const char **para_errlist[];
        PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
        PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
        PARA_ERROR(OVERRUN, "outout buffer overrun"), \
+       PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
 
 
 #define HTTP_RECV_ERRORS \
        PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
        PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
-       PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
+       PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer"), \
+       PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \
 
 
 #define RECV_ERRORS \
@@ -117,7 +195,12 @@ extern const char **para_errlist[];
        PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
        PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
        PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
+       PARA_ERROR(STATUS_EOF, "server closed status connection"), \
+
+
+#define AUDIOD_COMMAND_ERRORS \
        PARA_ERROR(CLIENT_WRITE, "client write error"), \
+       PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
        PARA_ERROR(UCRED_PERM, "permission denied"), \
        PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
 
@@ -125,6 +208,7 @@ extern const char **para_errlist[];
 #define FILTER_CHAIN_ERRORS \
        PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
        PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
+       PARA_ERROR(FC_EOF, "filter chain: eof"), \
 
 
 #define STAT_ERRORS \
@@ -166,6 +250,7 @@ extern const char **para_errlist[];
        PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
        PARA_ERROR(WAITPID, "waitpid error"), \
        PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
+       PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
 
 
 #define STRING_ERRORS \
@@ -195,10 +280,10 @@ extern const char **para_errlist[];
        PARA_ERROR(AAC_READ, "aac read error"), \
        PARA_ERROR(STSZ, "did not find stcz atom"), \
        PARA_ERROR(MP4ASC, "audio spec config error"), \
+       PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
 
 
 #define AAC_COMMON_ERRORS \
-       PARA_ERROR(AAC_BUF, "invalid buffer"), \
        PARA_ERROR(ESDS, "did not find esds atom"), \
        PARA_ERROR(STCO, "did not find stco atom"), \
 
@@ -215,7 +300,7 @@ extern const char **para_errlist[];
        PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
 
 
-#define AFS_ERRORS \
+#define VSS_ERRORS \
        PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
        PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
 
@@ -242,7 +327,6 @@ extern const char **para_errlist[];
 
 
 #define RANDOM_SELECTOR_ERRORS \
-       PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
        PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
 
 
@@ -276,10 +360,10 @@ extern const char **para_errlist[];
        PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
        PARA_ERROR(BAD_CMD, "invalid command"), \
        PARA_ERROR(PERM, "permission denied"), \
-       PARA_ERROR(USERLIST, "failed to open user list file"), \
-       PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
        PARA_ERROR(LOCK, "lock error"), \
        PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
+       PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
+
 
 #define PLAYLIST_SELECTOR_ERRORS \
        PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
@@ -298,6 +382,7 @@ extern const char **para_errlist[];
        PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
        PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
        PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
+       PARA_ERROR(DCCP_RECV_EOF, "dccp_recv: end of file"), \
 
 
 #define DCCP_RECV_ERRORS \
@@ -305,25 +390,29 @@ extern const char **para_errlist[];
        PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
        PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
 
+
 #define DCCP_SEND_ERRORS \
        PARA_ERROR(DCCP_BIND, "dccp bind error"), \
        PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
        PARA_ERROR(DCCP_WRITE, "dccp write error"), \
 
+
 #define FD_ERRORS \
        PARA_ERROR(F_GETFL, "failed to get fd flags"), \
        PARA_ERROR(F_SETFL, "failed to set fd flags"), \
+       PARA_ERROR(FGETS, "fgets error"), \
 
 
 #define WRITE_ERRORS \
-       PARA_ERROR(READ_HDR, "failed to read audio file header"), \
-       PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
        PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
-       PARA_ERROR(WRITE_OVERRUN, "buffer overrun"), \
        PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
+       PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
+       PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
+       PARA_ERROR(NO_DELAY, "no initial delay"), \
+       PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
 
 
-#define ALSA_WRITER_ERRORS \
+#define ALSA_WRITE_ERRORS \
        PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
        PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
        PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
@@ -341,31 +430,23 @@ extern const char **para_errlist[];
        PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
        PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
        PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
-       PARA_ERROR(ALSA_LOG, "snd_output_stdio_attach() failed"), \
 
 
-#define FILE_WRITER_ERRORS \
+#define FILE_WRITE_ERRORS \
        PARA_ERROR(FW_WRITE, "file writer write error"), \
        PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
+       PARA_ERROR(FW_NO_FILE, "task started without open file"), \
+
 
 #define WRITE_COMMON_ERRORS \
        PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
+       PARA_ERROR(WNG_EOF, "wng: end of file"), \
+
 
 #define AACDEC_ERRORS \
        PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
        PARA_ERROR(AAC_DECODE, "aac decode error"), \
 
-/* these do not need error handling (yet) */
-#define SERVER_ERRORS
-#define WAV_ERRORS
-#define COMPRESS_ERRORS
-#define TIME_ERRORS
-#define CLOSE_ON_FORK_ERRORS
-#define DAEMON_ERRORS
-#define ORTP_SEND_ERRORS
-#define GUI_ERRORS
-#define RINGBUFFER_ERRORS
-
 
 /**
  * the subsystem shift
@@ -402,9 +483,9 @@ extern const char **para_errlist[];
 /**
  * determine the index of an error number
  *
- * Also easy: It's the lower 8 bits of num - 1.
+ * Also easy: It's the lower 8 bits of num.
  */
-#define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & ((num) - 1))
+#define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
 
 /**
  * paraslash's version of strerror(3)
@@ -415,45 +496,53 @@ extern const char **para_errlist[];
 
 /**
  * define the error list for one subsystem
- *
+ #
+ * The first entry (index 0) is always the name of the subsystem
  * Used by macros in config.h (generated by configure)
  */
-#define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {ss ## _ERRORS}
+#define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
 
 /**
  * activate errors for one subsystem.
  *
- * Each executable needs only the error lists of those subssystems it is actually
- * linked with. We always reserve zeroed-out space for NUM_SS char ** pointers, but
- * only init those of the needed subsystems. This macro is used by macros in config.h
- * (generated by configure).
+ * Each executable needs only the error lists of those subssystems it is
+ * actually linked with. We always reserve space for NUM_SS char ** pointers,
+ * but only init those of the needed subsystems. This macro is used by macros
+ * in config.h (generated by configure).
  */
 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
 
 /**
- * This is temporarily defined to expand to its second argument (prefixed by
+ * This is temporarily defined to expand to its first argument (prefixed by
  * 'E_') and gets later redefined to expand to the error text only
  */
 #define PARA_ERROR(err, msg) E_ ## err
 
+#define SS_NAME(ss) para_errlist[ss]? para_errlist[ss][0] : ""
+
 /** \cond popcorn time */
+SS_ENUM(GUI);
+SS_ENUM(SCHED);
+SS_ENUM(STDIN);
+SS_ENUM(STDOUT);
+SS_ENUM(WAV);
+SS_ENUM(COMPRESS);
+SS_ENUM(TIME);
+SS_ENUM(CLOSE_ON_FORK);
 SS_ENUM(ORTP_RECV);
 SS_ENUM(NET);
 SS_ENUM(RECV);
 SS_ENUM(AUDIOD);
+SS_ENUM(AUDIOD_COMMAND);
 SS_ENUM(EXEC);
-SS_ENUM(CLOSE_ON_FORK);
 SS_ENUM(SIGNAL);
 SS_ENUM(STRING);
 SS_ENUM(DAEMON);
 SS_ENUM(STAT);
-SS_ENUM(TIME);
 SS_ENUM(GRAB_CLIENT);
 SS_ENUM(HTTP_RECV);
 SS_ENUM(RECV_COMMON);
 SS_ENUM(FILTER_CHAIN);
-SS_ENUM(WAV);
-SS_ENUM(COMPRESS);
 SS_ENUM(OGGDEC);
 SS_ENUM(MP3DEC);
 SS_ENUM(AACDEC);
@@ -463,7 +552,7 @@ SS_ENUM(OGG_AFH);
 SS_ENUM(AAC_AFH);
 SS_ENUM(AAC_COMMON);
 SS_ENUM(SERVER);
-SS_ENUM(AFS);
+SS_ENUM(VSS);
 SS_ENUM(COMMAND);
 SS_ENUM(RANDOM_SELECTOR);
 SS_ENUM(PLAYLIST_SELECTOR);
@@ -477,12 +566,16 @@ SS_ENUM(DCCP);
 SS_ENUM(DCCP_RECV);
 SS_ENUM(DCCP_SEND);
 SS_ENUM(FD);
-SS_ENUM(GUI);
 SS_ENUM(WRITE);
 SS_ENUM(WRITE_COMMON);
-SS_ENUM(ALSA_WRITER);
-SS_ENUM(FILE_WRITER);
+SS_ENUM(ALSA_WRITE);
+SS_ENUM(FILE_WRITE);
+SS_ENUM(OSX_WRITE);
 SS_ENUM(RINGBUFFER);
+SS_ENUM(CLIENT);
+SS_ENUM(CLIENT_COMMON);
+SS_ENUM(AUDIOC);
+SS_ENUM(USER_LIST);
 /** \endcond */
 #undef PARA_ERROR
 /* rest of the world only sees the error text */