Kill unused E_FSTAT.
[paraslash.git] / error.h
diff --git a/error.h b/error.h
index f1a3e41..c05948a 100644 (file)
--- a/error.h
+++ b/error.h
@@ -4,11 +4,11 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file error.h list of error messages for all subsystems */
+/** \file error.h List of error messages for all subsystems. */
 
 /** \cond */
 
-/* list of all subsystems that use paraslash's error facility */
+/* List of all subsystems that use paraslash's error facility. */
 DEFINE_ERRLIST_OBJECT_ENUM;
 
 /* these do not need error handling (yet) */
@@ -24,8 +24,9 @@ DEFINE_ERRLIST_OBJECT_ENUM;
 #define RINGBUFFER_ERRORS
 #define SCORE_ERRORS
 #define SHA1_ERRORS
-#define RECV_ERRORS
 #define AFH_COMMON_ERRORS
+#define RBTREE_ERRORS
+#define RECV_ERRORS
 
 extern const char **para_errlist[];
 
@@ -63,21 +64,18 @@ extern const char **para_errlist[];
        PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \
        PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \
        PARA_ERROR(STAT, "can not stat file"), \
-       PARA_ERROR(FSTAT, "fstat error"), \
        PARA_ERROR(RENAME, "rename failed"), \
        PARA_ERROR(WRITE, "write error"), \
        PARA_ERROR(LSEEK, "lseek error"), \
        PARA_ERROR(BUSY, "table is busy"), \
        PARA_ERROR(SHORT_TABLE, "table too short"), \
        PARA_ERROR(NO_MAGIC, "missing table header magic"), \
-       PARA_ERROR(VERSION_MISMATCH, "table version not suppoerted"), \
+       PARA_ERROR(VERSION_MISMATCH, "table version not supported"), \
        PARA_ERROR(BAD_COLUMN_NUM, "invalid column number"), \
        PARA_ERROR(BAD_TABLE_FLAGS, "invalid flags in table description"), \
        PARA_ERROR(BAD_ROW, "invalid row"), \
 
 
-#define RBTREE_ERRORS \
-
 
 #define AFS_ERRORS \
        PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
@@ -86,18 +84,21 @@ extern const char **para_errlist[];
        PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
        PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
        PARA_ERROR(AFS_PARENT_DIED, "fatal: server process terminated"), \
+       PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
 
 
 #define MOOD_ERRORS \
        PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
        PARA_ERROR(NO_MOOD, "no mood available"), \
        PARA_ERROR(MOOD_LOADED, "mood loaded"), \
-       PARA_ERROR(NOT_ADMISSIBLE, "file is not admussible"), \
+       PARA_ERROR(NOT_ADMISSIBLE, "file is not admissible"), \
 
 
 #define ATTRIBUTE_ERRORS \
        PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
        PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
+       PARA_ERROR(ATT_TABLE_FULL, "no more space left in attribute table"), \
+
 
 #define BLOB_ERRORS \
        PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
@@ -112,7 +113,7 @@ extern const char **para_errlist[];
 
 
 #define AFT_ERRORS \
-       PARA_ERROR(BAD_AFSI, "invaid afs info"), \
+       PARA_ERROR(BAD_AFSI, "invaiid afs info"), \
        PARA_ERROR(LOCALTIME, "localtime() failed"), \
        PARA_ERROR(STRFTIME, "strftime() failed"), \
        PARA_ERROR(BAD_PATH, "invalid path"), \
@@ -144,14 +145,12 @@ extern const char **para_errlist[];
        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 */ \
 
 
@@ -168,42 +167,37 @@ extern const char **para_errlist[];
 
 #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"), \
-       PARA_ERROR(SOCKET, "socket error"), \
        PARA_ERROR(CONNECT, "connect error"), \
-       PARA_ERROR(ACCEPT, "accept error"), \
-       PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
-       PARA_ERROR(BIND, "bind error"), \
        PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
+       PARA_ERROR(ADDRESS_LOOKUP, "address lookup / socket creation failed"), \
        PARA_ERROR(CHMOD, "failed to set socket mode"), \
        PARA_ERROR(SENDMSG, "sendmsg() failed"), \
        PARA_ERROR(RECVMSG, "recvmsg() failed"), \
        PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
-       PARA_ERROR(LISTEN, "listen error"), \
        PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
-       PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
 
 
 #define ORTP_RECV_ERRORS \
        PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
-       PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
+       PARA_ERROR(ORTP_SYNTAX, "ortp syntax error"), \
        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(OVERRUN, "output buffer overrun"), \
        PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
 
 
 #define HTTP_RECV_ERRORS \
-       PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \
-       PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: outout buffer overrun"), \
+       PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: output buffer overrun"), \
+
 
 #define RECV_COMMON_ERRORS \
        PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
+       PARA_ERROR(RECV_EOF, "end of file"), \
+       PARA_ERROR(RECV_CONNECT, "connection failed"), \
+
 
 
 #define AUDIOD_ERRORS \
@@ -211,6 +205,7 @@ extern const char **para_errlist[];
        PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
        PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
        PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
+       PARA_ERROR(NOT_PLAYING, "not playing"), \
 
 
 #define AUDIOD_COMMAND_ERRORS \
@@ -261,7 +256,7 @@ extern const char **para_errlist[];
 
 
 #define SIGNAL_ERRORS \
-       PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
+       PARA_ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR"), \
        PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
 
 
@@ -354,20 +349,11 @@ extern const char **para_errlist[];
        PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
 
 
-#define DCCP_ERRORS \
-       PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
-
-
 #define DCCP_RECV_ERRORS \
-       PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
        PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
-       PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
-       PARA_ERROR(DCCP_RECV_EOF, "dccp_recv: end of file"), \
 
 
 #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"), \
 
 
@@ -418,7 +404,6 @@ extern const char **para_errlist[];
 
 #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 \
@@ -430,25 +415,26 @@ extern const char **para_errlist[];
 #define CHUNK_QUEUE_ERRORS \
        PARA_ERROR(QUEUE, "packet queue overrun"), \
 
+
 /** \endcond */
 
 /**
- * the subsystem shift
+ * The subsystem shift.
  *
  * 255 error codes ought to be enough for every subsystem. Use the higher bits
- * of the return value to encode the subsystem number
+ * of the return value to encode the subsystem number.
  */
 #define SS_SHIFT 8
 
 /**
- * compute the subsystem offset
+ * Compute the subsystem offset.
  *
- * It is given by x * 2**8 where \a x is the subsystem number
+ * It is given by x * 2**8 where \a x is the subsystem number.
  */
 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
 
 /**
- * make the enum of all errors of one subsystem
+ * Make the enum of all errors of one subsystem.
  *
  * As zero should not be an error, we define a dummy enum entry with value
  * 2**ss. That lets the real errors start at 2**ss + 1.
@@ -458,14 +444,14 @@ extern const char **para_errlist[];
        ss ## _ERRORS}
 
 /**
- * determine the subsystem number from the error number
+ * Determine the subsystem number from the error number.
  *
  * Easy, it's just \a num / 2**8.
  */
 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
 
 /**
- * determine the index of an error number
+ * Determine the index of an error number.
  *
  * Also easy: It's the lower 8 bits of num.
  */
@@ -484,27 +470,27 @@ static inline int is_errno(int val, int _errno)
 }
 
 /**
- * paraslash's version of strerror(3)
+ * Paraslash's version of strerror(3).
  *
- * expands to the error text of \a num (a string constant).
+ * Expands to the error text of \a num (a string constant).
  */
 #define PARA_STRERROR(num) IS_SYSTEM_ERROR(num)? \
        strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1)) : \
        para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
 
 /**
- * define the error list for one subsystem
+ * 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)
+ * Used by macros in config.h (generated by configure).
  */
 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
 
 /**
- * activate errors for one subsystem.
+ * Activate errors for one subsystem.
  *
- * Each executable needs only the error lists of those subssystems it is
- * actually linked with. We always reserve space for NUM_SS char ** pointers,
+ * Each executable needs only the error lists of those subsystems 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).
  */
@@ -517,5 +503,5 @@ static inline int is_errno(int val, int _errno)
 #define PARA_ERROR(err, msg) E_ ## err
 #include "error2.h"
 #undef PARA_ERROR
-/* rest of the world only sees the error text */
+/* Rest of the world only sees the error text. */
 #define PARA_ERROR(err, msg) msg