Remove debugging message in error.h.
[adu.git] / error.h
1 /**
2 * This bit indicates whether a number is considered a system error code.
3 * If yes, the system errno is just the result of clearing this bit from
4 * the given number.
5 */
6 #define SYSTEM_ERROR_BIT 30
7
8 /** Check whether the system error bit is set. */
9 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
10
11 /** Set the system error bit for the given number. */
12 #define ERRNO_TO_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
13
14 #define ALL_ERRORS \
15 _ERROR(SUCCESS, "success") \
16 _ERROR(SYNTAX, "syntax error") \
17 _ERROR(LOOP_COMPLETE, "loop complete") \
18 _ERROR(HASH_TABLE_OVERFLOW, "hash table too small") \
19 _ERROR(BAD_UID, "uid not found in hash table") \
20 _ERROR(ATOI_OVERFLOW, "value too large") \
21 _ERROR(STRTOLL, "unknown strtoll error") \
22 _ERROR(ATOI_NO_DIGITS, "no digits found in string") \
23 _ERROR(ATOI_JUNK_AT_END, "further characters after number") \
24 _ERROR(EMPTY, "file empty") \
25 _ERROR(MMAP, "mmap error") \
26 _ERROR(OSL, "osl error") \
27
28
29 /**
30 * This is temporarily defined to expand to its first argument (prefixed by
31 * 'E_') and gets later redefined to expand to the error text only
32 */
33 #define _ERROR(err, msg) E_ ## err,
34
35 enum error_codes {
36 ALL_ERRORS
37 };
38 #undef _ERROR
39 #define _ERROR(err, msg) msg,
40 #define DEFINE_ERRLIST char *adu_errlist[] = {ALL_ERRORS}
41
42 extern int osl_errno;
43 extern char *adu_errlist[];
44
45
46 /**
47 * adu's version of strerror(3).
48 *
49 * \param num The error number.
50 *
51 * \return The error text of \a num.
52 */
53 static inline const char *adu_strerror(int num)
54 {
55 assert(num > 0);
56 if (num == E_OSL) {
57 assert(osl_errno > 0);
58 return osl_strerror((osl_errno));
59 }
60 if (IS_SYSTEM_ERROR(num))
61 return strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1));
62 return adu_errlist[num];
63 }
64
65 /**
66 * Wrapper for osl library calls.
67 *
68 * This should be used for all calls to osl functions that return an osl error
69 * code. It changes the return value to \p -E_OSL appropriately so that it can
70 * be used for printing the correct error message.
71 *
72 * \return \a ret if \a ret >= 0, \p -E_OSL otherwise.
73 */
74 static inline int osl(int ret)
75 {
76 if (ret >= 0)
77 return ret;
78 osl_errno = -ret;
79 return -E_OSL;
80 }