include/mruby/error.h

   1 /**
   2 ** @file mruby/error.h - Exception class
   3 **
   4 ** See Copyright Notice in mruby.h
   5 */
   6
   7 #ifndef MRUBY_ERROR_H
   8 #define MRUBY_ERROR_H
   9
  10 #include "common.h"
  11
  12 /**
  13  * MRuby error handling.
  14  */
  15 MRB_BEGIN_DECL
  16
  17 struct RException {
  18   MRB_OBJECT_HEADER;
  19   struct iv_tbl *iv;
  20   struct RString *mesg;
  21 };
  22
  23 #define mrb_exc_ptr(v) ((struct RException*)mrb_ptr(v))
  24 #define MRB_EXC_MESG_STRING_FLAG 0x100
  25
  26 MRB_API void mrb_sys_fail(mrb_state *mrb, const char *mesg);
  27 MRB_API mrb_value mrb_exc_new_str(mrb_state *mrb, struct RClass* c, mrb_value str);
  28 #define mrb_exc_new_lit(mrb, c, lit) mrb_exc_new_str(mrb, c, mrb_str_new_lit(mrb, lit))
  29 #define mrb_exc_new_str_lit(mrb, c, lit) mrb_exc_new_lit(mrb, c, lit)
  30 MRB_API mrb_value mrb_make_exception(mrb_state *mrb, mrb_int argc, const mrb_value *argv);
  31 mrb_value mrb_exc_backtrace(mrb_state *mrb, mrb_value exc);
  32 mrb_value mrb_get_backtrace(mrb_state *mrb);
  33
  34 MRB_API mrb_noreturn void mrb_no_method_error(mrb_state *mrb, mrb_sym id, mrb_value args, const char *fmt, ...);
  35
  36 /* declaration for `fail` method */
  37 MRB_API mrb_value mrb_f_raise(mrb_state*, mrb_value);
  38
  39 #if defined(MRB_64BIT) || defined(MRB_USE_FLOAT32) || defined(MRB_NAN_BOXING) || defined(MRB_WORD_BOXING)
  40 struct RBreak {
  41   MRB_OBJECT_HEADER;
  42   const struct RProc *proc;
  43   mrb_value val;
  44 };
  45 #define mrb_break_value_get(brk) ((brk)->val)
  46 #define mrb_break_value_set(brk, v) ((brk)->val = v)
  47 #else
  48 struct RBreak {
  49   MRB_OBJECT_HEADER;
  50   const struct RProc *proc;
  51   union mrb_value_union value;
  52 };
  53 #define RBREAK_VALUE_TT_MASK ((1 << 8) - 1)
  54 static inline mrb_value
  55 mrb_break_value_get(struct RBreak *brk)
  56 {
  57   mrb_value val;
  58   val.value = brk->value;
  59   val.tt = (enum mrb_vtype)(brk->flags & RBREAK_VALUE_TT_MASK);
  60   return val;
  61 }
  62 static inline void
  63 mrb_break_value_set(struct RBreak *brk, mrb_value val)
  64 {
  65   brk->value = val.value;
  66   brk->flags &= ~RBREAK_VALUE_TT_MASK;
  67   brk->flags |= val.tt;
  68 }
  69 #endif  /* MRB_64BIT || MRB_USE_FLOAT32 || MRB_NAN_BOXING || MRB_WORD_BOXING */
  70 #define mrb_break_proc_get(brk) ((brk)->proc)
  71 #define mrb_break_proc_set(brk, p) ((brk)->proc = p)
  72
  73 #define RBREAK_TAG_FOREACH(f) \
  74   f(RBREAK_TAG_BREAK, 0) \
  75   f(RBREAK_TAG_BREAK_UPPER, 1) \
  76   f(RBREAK_TAG_BREAK_INTARGET, 2) \
  77   f(RBREAK_TAG_RETURN_BLOCK, 3) \
  78   f(RBREAK_TAG_RETURN, 4) \
  79   f(RBREAK_TAG_RETURN_TOPLEVEL, 5) \
  80   f(RBREAK_TAG_JUMP, 6) \
  81   f(RBREAK_TAG_STOP, 7)
  82
  83 #define RBREAK_TAG_DEFINE(tag, i) tag = i,
  84 enum {
  85   RBREAK_TAG_FOREACH(RBREAK_TAG_DEFINE)
  86 };
  87 #undef RBREAK_TAG_DEFINE
  88
  89 #define RBREAK_TAG_BIT          3
  90 #define RBREAK_TAG_BIT_OFF      8
  91 #define RBREAK_TAG_MASK         (~(~UINT32_C(0) << RBREAK_TAG_BIT))
  92
  93 static inline uint32_t
  94 mrb_break_tag_get(struct RBreak *brk)
  95 {
  96   return (brk->flags >> RBREAK_TAG_BIT_OFF) & RBREAK_TAG_MASK;
  97 }
  98
  99 static inline void
 100 mrb_break_tag_set(struct RBreak *brk, uint32_t tag)
 101 {
 102   brk->flags &= ~(RBREAK_TAG_MASK << RBREAK_TAG_BIT_OFF);
 103   brk->flags |= (tag & RBREAK_TAG_MASK) << RBREAK_TAG_BIT_OFF;
 104 }
 105
 106 /**
 107  * Protect
 108  *
 109  */
 110 typedef mrb_value mrb_protect_error_func(mrb_state *mrb, void *userdata);
 111 MRB_API mrb_value mrb_protect_error(mrb_state *mrb, mrb_protect_error_func *body, void *userdata, mrb_bool *error);
 112
 113 /**
 114  * Protect (takes mrb_value for body argument)
 115  *
 116  * Implemented in the mruby-error mrbgem
 117  */
 118 MRB_API mrb_value mrb_protect(mrb_state *mrb, mrb_func_t body, mrb_value data, mrb_bool *state);
 119
 120 /**
 121  * Ensure
 122  *
 123  * Implemented in the mruby-error mrbgem
 124  */
 125 MRB_API mrb_value mrb_ensure(mrb_state *mrb, mrb_func_t body, mrb_value b_data,
 126                              mrb_func_t ensure, mrb_value e_data);
 127
 128 /**
 129  * Rescue
 130  *
 131  * Implemented in the mruby-error mrbgem
 132  */
 133 MRB_API mrb_value mrb_rescue(mrb_state *mrb, mrb_func_t body, mrb_value b_data,
 134                              mrb_func_t rescue, mrb_value r_data);
 135
 136 /**
 137  * Rescue exception
 138  *
 139  * Implemented in the mruby-error mrbgem
 140  */
 141 MRB_API mrb_value mrb_rescue_exceptions(mrb_state *mrb, mrb_func_t body, mrb_value b_data,
 142                                         mrb_func_t rescue, mrb_value r_data,
 143                                         mrb_int len, struct RClass **classes);
 144
 145 MRB_END_DECL
 146
 147 #endif  /* MRUBY_ERROR_H */