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