1

#ifndef ERROR_H

     2

#define ERROR_H

     3

     4

/*

     5

 * Error-handling functions

     6

 */

     7

#include <errno.h>

     8

     9

/*

    10

 * Type used for error codes is an explicitly *unsigned* int, meaning that error codes themselves are positive.

    11

 * Negative error codes also exist in some places, and they are just a negative err_t.

    12

 */

    13

typedef unsigned int err_t;

    14

    15

/*

    35

 * List of defined error codes, organized mostly by function name

    36

 */

    37

enum error_code {

    38

    /* Core functions */

    40

    41

    /* Network resolver errors */

    44

    45

    /* Low-level network errors */

    48

    49

    /* Low-level IO errors */

    52

    53

    /* GnuTLS errors */

    63

};

    64

    65

/*

    66

 * An error code and associated extra infos

    67

 */

    68

struct error_info {

    69

    /* The base error code */

    70

    err_t code;

    71

    72

    /* Additional detail info, usually some third-part error code */

    73

    unsigned int extra;

    74

};

    75

    76

/*

    78

 */

    79

const char *error_name (err_t code);

    80

    93

/** No error, evaulates as logical false */

    94

#define SUCCESS (0)

    95

    96

/* Evaulates to error_info.code as lvalue */

    97

#define ERROR_CODE(err_info_ptr) ((err_info_ptr)->code)

    98

    99

/* Evaulates to error_info.extra as lvalue */

   100

#define ERROR_EXTRA(err_info_ptr) ((err_info_ptr)->extra)

   101

   102

/* Set error_info.code to SUCCESS, evaulates as zero */

   103

#define RESET_ERROR(err_info_ptr) ((err_info_ptr)->code = SUCCESS)

   104

   105

/* Compare error_info.code != 0 */

   106

#define IS_ERROR(err_info_ptr) (!!(err_info_ptr)->code)

   107

   108

/* Set error_info.code, but leave err_extra as-is. Evaluates to err_code */

   109

#define SET_ERROR(err_info_ptr, err_code) ((err_info_ptr)->code = (err_code))

   110

   111

/* Set error_info.code/extra. XXX: should evaluate to err_code */

   112

#define _SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra) (err_info_ptr)->code = (err_code); (err_info_ptr)->extra = (err_extra)

   113

#define SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra) do { _SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra); } while (0)

   114

   115

/* Set error_info.code to err_code, and .extra to errno. XXX: should evaulate to err_code */

   116

#define _SET_ERROR_ERRNO(err_info_ptr, err_code) _SET_ERROR_EXTRA(err_info_ptr, err_code, errno);

   117

#define SET_ERROR_ERRNO(err_info_ptr, err_code) SET_ERROR_EXTRA(err_info_ptr, err_code, errno);

   118

   119

/* Set error_info from another error_info. Evaluates to the new error_info */

   120

#define SET_ERROR_INFO(err_info_ptr, from_ptr) (*err_info_ptr = *from_ptr)

   121

   122

/* Same as above, but also return err_code from func. XXX: use 'return SET_ERROR...' instead */

   123

#define RETURN_SET_ERROR(err_info_ptr, err_code) do { SET_ERROR(err_info_ptr, err_code); return (err_code); } while (0)

   124

#define RETURN_SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra) do { _SET_ERROR_EXTRA(err_info_ptr, err_code, err_extra); return (err_code); } while (0)

   125

#define RETURN_SET_ERROR_ERRNO(err_info_ptr, err_code) do { _SET_ERROR_ERRNO(err_info_ptr, err_code); return (err_code); } while (0)

   126

   127

/* Same as above, but also do a 'goto error' */

   128

#define JUMP_SET_ERROR(err_info_ptr, err_code) do { SET_ERROR(err_info_ptr, err_code); goto error; } while (0)

   129

#define JUMP_SET_ERROR_INFO(err_info_ptr, from_ptr) do { SET_ERROR_INFO(err_info_ptr, from_ptr); goto error; } while (0)

   130

   131

#endif