third-party/mruby/include/mruby/proc.h

   1 /*
   2 ** mruby/proc.h - Proc class
   3 **
   4 ** See Copyright Notice in mruby.h
   5 */
   6
   7 #ifndef MRUBY_PROC_H
   8 #define MRUBY_PROC_H
   9
  10 #include "common.h"
  11 #include <mruby/irep.h>
  12
  13 /**
  14  * Proc class
  15  */
  16 MRB_BEGIN_DECL
  17
  18 struct REnv {
  19   MRB_OBJECT_HEADER;
  20   mrb_value *stack;
  21   struct mrb_context *cxt;
  22   mrb_sym mid;
  23 };
  24
  25 /* flags (21bits): 1(shared flag):10(cioff/bidx):10(stack_len) */
  26 #define MRB_ENV_SET_STACK_LEN(e,len) ((e)->flags = (((e)->flags & ~0x3ff)|((unsigned int)(len) & 0x3ff)))
  27 #define MRB_ENV_STACK_LEN(e) ((mrb_int)((e)->flags & 0x3ff))
  28 #define MRB_ENV_STACK_UNSHARED (1<<20)
  29 #define MRB_ENV_UNSHARE_STACK(e) ((e)->flags |= MRB_ENV_STACK_UNSHARED)
  30 #define MRB_ENV_STACK_SHARED_P(e) (((e)->flags & MRB_ENV_STACK_UNSHARED) == 0)
  31 #define MRB_ENV_BIDX(e) (((e)->flags >> 10) & 0x3ff)
  32 #define MRB_ENV_SET_BIDX(e,idx) ((e)->flags = (((e)->flags & ~(0x3ff<<10))|((unsigned int)(idx) & 0x3ff)<<10))
  33
  34 void mrb_env_unshare(mrb_state*, struct REnv*);
  35
  36 struct RProc {
  37   MRB_OBJECT_HEADER;
  38   union {
  39     mrb_irep *irep;
  40     mrb_func_t func;
  41   } body;
  42   struct RProc *upper;
  43   union {
  44     struct RClass *target_class;
  45     struct REnv *env;
  46   } e;
  47 };
  48
  49 /* aspec access */
  50 #define MRB_ASPEC_REQ(a)          (((a) >> 18) & 0x1f)
  51 #define MRB_ASPEC_OPT(a)          (((a) >> 13) & 0x1f)
  52 #define MRB_ASPEC_REST(a)         (((a) >> 12) & 0x1)
  53 #define MRB_ASPEC_POST(a)         (((a) >> 7) & 0x1f)
  54 #define MRB_ASPEC_KEY(a)          (((a) >> 2) & 0x1f)
  55 #define MRB_ASPEC_KDICT(a)        ((a) & (1<<1))
  56 #define MRB_ASPEC_BLOCK(a)        ((a) & 1)
  57
  58 #define MRB_PROC_CFUNC_FL 128
  59 #define MRB_PROC_CFUNC_P(p) (((p)->flags & MRB_PROC_CFUNC_FL) != 0)
  60 #define MRB_PROC_CFUNC(p) (p)->body.func
  61 #define MRB_PROC_STRICT 256
  62 #define MRB_PROC_STRICT_P(p) (((p)->flags & MRB_PROC_STRICT) != 0)
  63 #define MRB_PROC_ORPHAN 512
  64 #define MRB_PROC_ORPHAN_P(p) (((p)->flags & MRB_PROC_ORPHAN) != 0)
  65 #define MRB_PROC_ENVSET 1024
  66 #define MRB_PROC_ENV_P(p) (((p)->flags & MRB_PROC_ENVSET) != 0)
  67 #define MRB_PROC_ENV(p) (MRB_PROC_ENV_P(p) ? (p)->e.env : NULL)
  68 #define MRB_PROC_TARGET_CLASS(p) (MRB_PROC_ENV_P(p) ? (p)->e.env->c : (p)->e.target_class)
  69 #define MRB_PROC_SET_TARGET_CLASS(p,tc) do {\
  70   if (MRB_PROC_ENV_P(p)) {\
  71     (p)->e.env->c = (tc);\
  72     mrb_field_write_barrier(mrb, (struct RBasic*)(p)->e.env, (struct RBasic*)(tc));\
  73   }\
  74   else {\
  75     (p)->e.target_class = (tc);\
  76     mrb_field_write_barrier(mrb, (struct RBasic*)p, (struct RBasic*)(tc));\
  77   }\
  78 } while (0)
  79 #define MRB_PROC_SCOPE 2048
  80 #define MRB_PROC_SCOPE_P(p) (((p)->flags & MRB_PROC_SCOPE) != 0)
  81
  82 #define mrb_proc_ptr(v)    ((struct RProc*)(mrb_ptr(v)))
  83
  84 struct RProc *mrb_proc_new(mrb_state*, mrb_irep*);
  85 struct RProc *mrb_closure_new(mrb_state*, mrb_irep*);
  86 MRB_API struct RProc *mrb_proc_new_cfunc(mrb_state*, mrb_func_t);
  87 MRB_API struct RProc *mrb_closure_new_cfunc(mrb_state *mrb, mrb_func_t func, int nlocals);
  88 void mrb_proc_copy(struct RProc *a, struct RProc *b);
  89
  90 /* implementation of #send method */
  91 mrb_value mrb_f_send(mrb_state *mrb, mrb_value self);
  92
  93 /* following functions are defined in mruby-proc-ext so please include it when using */
  94 MRB_API struct RProc *mrb_proc_new_cfunc_with_env(mrb_state*, mrb_func_t, mrb_int, const mrb_value*);
  95 MRB_API mrb_value mrb_proc_cfunc_env_get(mrb_state*, mrb_int);
  96 /* old name */
  97 #define mrb_cfunc_env_get(mrb, idx) mrb_proc_cfunc_env_get(mrb, idx)
  98
  99 #ifdef MRB_METHOD_TABLE_INLINE
 100
 101 #define MRB_METHOD_FUNC_FL ((uintptr_t)1)
 102 #define MRB_METHOD_FUNC_P(m) (((uintptr_t)(m))&MRB_METHOD_FUNC_FL)
 103 #define MRB_METHOD_FUNC(m) ((mrb_func_t)((uintptr_t)(m)&(~MRB_METHOD_FUNC_FL)))
 104 #define MRB_METHOD_FROM_FUNC(m,fn) ((m)=(mrb_method_t)((struct RProc*)((uintptr_t)(fn)|MRB_METHOD_FUNC_FL)))
 105 #define MRB_METHOD_FROM_PROC(m,pr) ((m)=(mrb_method_t)(struct RProc*)(pr))
 106 #define MRB_METHOD_PROC_P(m) (!MRB_METHOD_FUNC_P(m))
 107 #define MRB_METHOD_PROC(m) ((struct RProc*)(m))
 108 #define MRB_METHOD_UNDEF_P(m) ((m)==0)
 109
 110 #else
 111
 112 #define MRB_METHOD_FUNC_P(m) ((m).func_p)
 113 #define MRB_METHOD_FUNC(m) ((m).func)
 114 #define MRB_METHOD_FROM_FUNC(m,fn) do{(m).func_p=TRUE;(m).func=(fn);}while(0)
 115 #define MRB_METHOD_FROM_PROC(m,pr) do{(m).func_p=FALSE;(m).proc=(pr);}while(0)
 116 #define MRB_METHOD_PROC_P(m) (!MRB_METHOD_FUNC_P(m))
 117 #define MRB_METHOD_PROC(m) ((m).proc)
 118 #define MRB_METHOD_UNDEF_P(m) ((m).proc==NULL)
 119
 120 #endif /* MRB_METHOD_TABLE_INLINE */
 121
 122 #define MRB_METHOD_CFUNC_P(m) (MRB_METHOD_FUNC_P(m)?TRUE:(MRB_METHOD_PROC(m)?(MRB_PROC_CFUNC_P(MRB_METHOD_PROC(m))):FALSE))
 123 #define MRB_METHOD_CFUNC(m) (MRB_METHOD_FUNC_P(m)?MRB_METHOD_FUNC(m):((MRB_METHOD_PROC(m)&&MRB_PROC_CFUNC_P(MRB_METHOD_PROC(m)))?MRB_PROC_CFUNC(MRB_METHOD_PROC(m)):NULL))
 124
 125
 126 #include <mruby/khash.h>
 127 KHASH_DECLARE(mt, mrb_sym, mrb_method_t, TRUE)
 128
 129 MRB_END_DECL
 130
 131 #endif  /* MRUBY_PROC_H */