Move the uid-range parser to string.c.
[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 _ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR") \
28
29
30 /**
31 * This is temporarily defined to expand to its first argument (prefixed by
32 * 'E_') and gets later redefined to expand to the error text only
33 */
34 #define _ERROR(err, msg) E_ ## err,
35
36 enum error_codes {
37 ALL_ERRORS
38 };
39 #undef _ERROR
40 #define _ERROR(err, msg) msg,
41 #define DEFINE_ERRLIST char *adu_errlist[] = {ALL_ERRORS}
42
43 extern int osl_errno;
44 extern char *adu_errlist[];
45
46
47 /**
48 * adu's version of strerror(3).
49 *
50 * \param num The error number.
51 *
52 * \return The error text of \a num.
53 */
54 static inline const char *adu_strerror(int num)
55 {
56 assert(num > 0);
57 if (num == E_OSL) {
58 assert(osl_errno > 0);
59 return osl_strerror((osl_errno));
60 }
61 if (IS_SYSTEM_ERROR(num))
62 return strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1));
63 return adu_errlist[num];
64 }
65
66 /**
67 * Wrapper for osl library calls.
68 *
69 * This should be used for all calls to osl functions that return an osl error
70 * code. It changes the return value to \p -E_OSL appropriately so that it can
71 * be used for printing the correct error message.
72 *
73 * \return \a ret if \a ret >= 0, \p -E_OSL otherwise.
74 */
75 static inline int osl(int ret)
76 {
77 if (ret >= 0)
78 return ret;
79 osl_errno = -ret;
80 return -E_OSL;
81 }