epan/except.h

   1 /*
   2  * Portable Exception Handling for ANSI C.
   3  * Copyright (C) 1999 Kaz Kylheku <kaz@ashi.footprints.net>
   4  *
   5  * Free Software License:
   6  *
   7  * All rights are reserved by the author, with the following exceptions:
   8  * Permission is granted to freely reproduce and distribute this software,
   9  * possibly in exchange for a fee, provided that this copyright notice appears
  10  * intact. Permission is also granted to adapt this software to produce
  11  * derivative works, as long as the modified versions carry this copyright
  12  * notice and additional notices stating that the work has been modified.
  13  * This source code may be translated into executable form and incorporated
  14  * into proprietary software; there is no requirement for such software to
  15  * contain a copyright notice related to this source.
  16  *
  17  * $Id$
  18  * $Name:  $
  19  */
  20
  21 /**
  22  * @file
  23  * Portable Exception Handling for ANSI C.<BR>
  24  * Modified to support throwing an exception with a null message pointer,
  25  * and to have the message not be const (as we generate messages with
  26  * "g_strdup_sprintf()", which means they need to be freed; using
  27  * a null message means that we don't have to use a special string
  28  * for exceptions with no message, and don't have to worry about
  29  * not freeing that).
  30  */
  31
  32 #ifndef XCEPT_H
  33 #define XCEPT_H
  34
  35 #include <glib.h>
  36 #include <setjmp.h>
  37 #include <stdlib.h>
  38 #include <assert.h>
  39
  40 #define XCEPT_GROUP_ANY 0
  41 #define XCEPT_CODE_ANY  0
  42 #define XCEPT_BAD_ALLOC 1
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 enum { except_no_call, except_call };
  49
  50 typedef struct {
  51     unsigned long except_group;
  52     unsigned long except_code;
  53 } except_id_t;
  54
  55 typedef struct {
  56     except_id_t volatile except_id;
  57     const char *volatile except_message;
  58     void *volatile except_dyndata;
  59 } except_t;
  60
  61 struct except_cleanup {
  62     void (*except_func)(void *);
  63     void *except_context;
  64 };
  65
  66 struct except_catch {
  67     const except_id_t *except_id;
  68     size_t except_size;
  69     except_t except_obj;
  70     jmp_buf except_jmp;
  71 };
  72
  73 enum except_stacktype {
  74     XCEPT_CLEANUP, XCEPT_CATCHER
  75 };
  76
  77 struct except_stacknode {
  78     struct except_stacknode *except_down;
  79     enum except_stacktype except_type;
  80     union {
  81         struct except_catch *except_catcher;
  82         struct except_cleanup *except_cleanup;
  83     } except_info;
  84 };
  85
  86 /* private functions made external so they can be used in macros */
  87 extern void except_setup_clean(struct except_stacknode *,
  88         struct except_cleanup *, void (*)(void *), void *);
  89 extern void except_setup_try(struct except_stacknode *,
  90         struct except_catch *, const except_id_t [], size_t);
  91 extern struct except_stacknode *except_pop(void);
  92
  93 /* public interface functions */
  94 extern int except_init(void);
  95 extern void except_deinit(void);
  96 extern WS_MSVC_NORETURN void except_rethrow(except_t *) G_GNUC_NORETURN;
  97 extern WS_MSVC_NORETURN void except_throw(long, long, const char *) G_GNUC_NORETURN;
  98 extern WS_MSVC_NORETURN void except_throwd(long, long, const char *, void *) G_GNUC_NORETURN;
  99 extern WS_MSVC_NORETURN void except_throwf(long, long, const char *, ...) G_GNUC_NORETURN;
 100 extern void (*except_unhandled_catcher(void (*)(except_t *)))(except_t *);
 101 extern unsigned long except_code(except_t *);
 102 extern unsigned long except_group(except_t *);
 103 extern const char *except_message(except_t *);
 104 extern void *except_data(except_t *);
 105 extern void *except_take_data(except_t *);
 106 extern void except_set_allocator(void *(*)(size_t), void (*)(void *));
 107 extern void *except_alloc(size_t);
 108 extern void except_free(void *);
 109
 110 #define except_code(E) ((E)->except_id.except_code)
 111 #define except_group(E) ((E)->except_id.except_group)
 112 #define except_message(E) ((E)->except_message)
 113 #define except_data(E) ((E)->except_dyndata)
 114
 115 #ifdef __cplusplus
 116 }
 117 #endif
 118
 119 /*
 120  * void except_cleanup_push(void (*)(void *), void *);
 121  * void except_cleanup_pop(int);
 122  * void except_checked_cleanup_pop(void (*)(void *), int);
 123  * void except_try_push(const except_id_t [], size_t, except_t **);
 124  * void except_try_pop(void);
 125  */
 126
 127 #define except_cleanup_push(F, C)                               \
 128     {                                                           \
 129         struct except_stacknode except_sn;                      \
 130         struct except_cleanup except_cl;                        \
 131         except_setup_clean(&except_sn, &except_cl, F, C)
 132
 133 #define except_cleanup_pop(E)                                   \
 134         except_pop();                                           \
 135         if (E)                                                  \
 136             except_cl.except_func(except_cl.except_context);    \
 137     }
 138
 139 #define except_checked_cleanup_pop(F, E)                        \
 140         except_pop();                                           \
 141         assert (except_cl.except_func == (F));                  \
 142         if (E)                                                  \
 143             except_cl.except_func(except_cl.except_context);    \
 144     }
 145
 146 #define except_try_push(ID, NUM, PPE)                           \
 147      {                                                          \
 148         struct except_stacknode except_sn;                      \
 149         struct except_catch except_ch;                          \
 150         except_setup_try(&except_sn, &except_ch, ID, NUM);      \
 151         if (setjmp(except_ch.except_jmp))                       \
 152             *(PPE) = &except_ch.except_obj;                     \
 153         else                                                    \
 154             *(PPE) = 0
 155
 156 #define except_try_pop()                                        \
 157         except_free(except_ch.except_obj.except_dyndata);       \
 158         except_pop();                                           \
 159     }
 160
 161 #endif