include/mruby/value.h

   1 /*
   2 ** mruby/value.h - mrb_value definition
   3 **
   4 ** See Copyright Notice in mruby.h
   5 */
   6
   7 #ifndef MRUBY_VALUE_H
   8 #define MRUBY_VALUE_H
   9
  10 #ifdef MRB_USE_FLOAT
  11   typedef float mrb_float;
  12 # define mrb_float_to_str(buf, i) sprintf(buf, "%.7e", i)
  13 # define str_to_mrb_float(buf) strtof(buf, NULL)
  14 #else
  15   typedef double mrb_float;
  16 # define mrb_float_to_str(buf, i) sprintf(buf, "%.16e", i)
  17 # define str_to_mrb_float(buf) strtod(buf, NULL)
  18 #endif
  19
  20 #if defined(MRB_INT16) && defined(MRB_INT64)
  21 # error "You can't define MRB_INT16 and MRB_INT64 at the same time."
  22 #endif
  23
  24 #if defined(MRB_INT64)
  25 # ifdef MRB_NAN_BOXING
  26 #  error Cannot use NaN boxing when mrb_int is 64bit
  27 # else
  28    typedef int64_t mrb_int;
  29 #  define MRB_INT_BIT 64
  30 #  define MRB_INT_MIN INT64_MIN
  31 #  define MRB_INT_MAX INT64_MAX
  32 #  define PRIdMRB_INT PRId64
  33 #  define PRIiMRB_INT PRIi64
  34 #  define PRIoMRB_INT PRIo64
  35 #  define PRIxMRB_INT PRIx64
  36 #  define PRIXMRB_INT PRIX64
  37 # endif
  38 #elif defined(MRB_INT16)
  39   typedef int16_t mrb_int;
  40 # define MRB_INT_BIT 16
  41 # define MRB_INT_MIN INT16_MIN
  42 # define MRB_INT_MAX INT16_MAX
  43 #else
  44   typedef int32_t mrb_int;
  45 # define MRB_INT_BIT 32
  46 # define MRB_INT_MIN INT32_MIN
  47 # define MRB_INT_MAX INT32_MAX
  48 # define PRIdMRB_INT PRId32
  49 # define PRIiMRB_INT PRIi32
  50 # define PRIoMRB_INT PRIo32
  51 # define PRIxMRB_INT PRIx32
  52 # define PRIXMRB_INT PRIX32
  53 #endif
  54 typedef short mrb_sym;
  55
  56 #ifdef _MSC_VER
  57 # ifndef __cplusplus
  58 #  define inline __inline
  59 # endif
  60 # define snprintf _snprintf
  61 # if _MSC_VER < 1800
  62 #  include <float.h>
  63 #  define isnan _isnan
  64 #  define isinf(n) (!_finite(n) && !_isnan(n))
  65 #  define signbit(n) (_copysign(1.0, (n)) < 0.0)
  66 #  define strtoll _strtoi64
  67 #  define strtof (float)strtod
  68 #  define PRId32 "I32d"
  69 #  define PRIi32 "I32i"
  70 #  define PRIo32 "I32o"
  71 #  define PRIx32 "I32x"
  72 #  define PRIX32 "I32X"
  73 #  define PRId64 "I64d"
  74 #  define PRIi64 "I64i"
  75 #  define PRIo64 "I64o"
  76 #  define PRIx64 "I64x"
  77 #  define PRIX64 "I64X"
  78 static unsigned int IEEE754_INFINITY_BITS_SINGLE = 0x7F800000;
  79 #  define INFINITY (*(float *)&IEEE754_INFINITY_BITS_SINGLE)
  80 #  define NAN ((float)(INFINITY - INFINITY))
  81 # else
  82 #  include <inttypes.h>
  83 # endif
  84 #else
  85 # include <inttypes.h>
  86 #endif
  87
  88 typedef uint8_t mrb_bool;
  89 struct mrb_state;
  90
  91 #if defined(MRB_NAN_BOXING)
  92
  93 #ifdef MRB_USE_FLOAT
  94 # error ---->> MRB_NAN_BOXING and MRB_USE_FLOAT conflict <<----
  95 #endif
  96
  97 #ifdef MRB_INT64
  98 # error ---->> MRB_NAN_BOXING and MRB_INT64 conflict <<----
  99 #endif
 100
 101 enum mrb_vtype {
 102   MRB_TT_FALSE = 1,   /*   1 */
 103   MRB_TT_FREE,        /*   2 */
 104   MRB_TT_TRUE,        /*   3 */
 105   MRB_TT_FIXNUM,      /*   4 */
 106   MRB_TT_SYMBOL,      /*   5 */
 107   MRB_TT_UNDEF,       /*   6 */
 108   MRB_TT_FLOAT,       /*   7 */
 109   MRB_TT_CPTR,        /*   8 */
 110   MRB_TT_OBJECT,      /*   9 */
 111   MRB_TT_CLASS,       /*  10 */
 112   MRB_TT_MODULE,      /*  11 */
 113   MRB_TT_ICLASS,      /*  12 */
 114   MRB_TT_SCLASS,      /*  13 */
 115   MRB_TT_PROC,        /*  14 */
 116   MRB_TT_ARRAY,       /*  15 */
 117   MRB_TT_HASH,        /*  16 */
 118   MRB_TT_STRING,      /*  17 */
 119   MRB_TT_RANGE,       /*  18 */
 120   MRB_TT_EXCEPTION,   /*  19 */
 121   MRB_TT_FILE,        /*  20 */
 122   MRB_TT_ENV,         /*  21 */
 123   MRB_TT_DATA,        /*  22 */
 124   MRB_TT_FIBER,       /*  23 */
 125   MRB_TT_MAXDEFINE    /*  24 */
 126 };
 127
 128 #define MRB_TT_HAS_BASIC  MRB_TT_OBJECT
 129
 130 #ifdef MRB_ENDIAN_BIG
 131 #define MRB_ENDIAN_LOHI(a,b) a b
 132 #else
 133 #define MRB_ENDIAN_LOHI(a,b) b a
 134 #endif
 135
 136 typedef struct mrb_value {
 137   union {
 138     mrb_float f;
 139     union {
 140       void *p;
 141       struct {
 142         MRB_ENDIAN_LOHI(
 143           uint32_t ttt;
 144           ,union {
 145             mrb_int i;
 146             mrb_sym sym;
 147           };
 148         )
 149       };
 150     } value;
 151   };
 152 } mrb_value;
 153
 154 /* value representation by nan-boxing:
 155  *   float : FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF
 156  *   object: 111111111111TTTT TTPPPPPPPPPPPPPP PPPPPPPPPPPPPPPP PPPPPPPPPPPPPPPP
 157  *   int   : 1111111111110001 0000000000000000 IIIIIIIIIIIIIIII IIIIIIIIIIIIIIII
 158  *   sym   : 1111111111110001 0100000000000000 SSSSSSSSSSSSSSSS SSSSSSSSSSSSSSSS
 159  * In order to get enough bit size to save TT, all pointers are shifted 2 bits
 160  * in the right direction.
 161  */
 162 #define mrb_tt(o)       ((enum mrb_vtype)(((o).value.ttt & 0xfc000)>>14))
 163 #define mrb_mktt(tt)    (0xfff00000|((tt)<<14))
 164 #define mrb_type(o)     ((uint32_t)0xfff00000 < (o).value.ttt ? mrb_tt(o) : MRB_TT_FLOAT)
 165 #define mrb_ptr(o)      ((void*)((((uintptr_t)0x3fffffffffff)&((uintptr_t)((o).value.p)))<<2))
 166 #define mrb_float(o)    (o).f
 167
 168 #define MRB_SET_VALUE(o, tt, attr, v) do {\
 169   (o).value.ttt = mrb_mktt(tt);\
 170   switch (tt) {\
 171   case MRB_TT_FALSE:\
 172   case MRB_TT_TRUE:\
 173   case MRB_TT_UNDEF:\
 174   case MRB_TT_FIXNUM:\
 175   case MRB_TT_SYMBOL: (o).attr = (v); break;\
 176   default: (o).value.i = 0; (o).value.p = (void*)((uintptr_t)(o).value.p | (((uintptr_t)(v))>>2)); break;\
 177   }\
 178 } while (0)
 179
 180 static inline mrb_value
 181 mrb_float_value(struct mrb_state *mrb, mrb_float f)
 182 {
 183   mrb_value v;
 184
 185   if (f != f) {
 186     v.value.ttt = 0x7ff80000;
 187     v.value.i = 0;
 188   } else {
 189     v.f = f;
 190   }
 191   return v;
 192 }
 193 #define mrb_float_pool(mrb,f) mrb_float_value(mrb,f)
 194
 195 #else
 196
 197 enum mrb_vtype {
 198   MRB_TT_FALSE = 0,   /*   0 */
 199   MRB_TT_FREE,        /*   1 */
 200   MRB_TT_TRUE,        /*   2 */
 201   MRB_TT_FIXNUM,      /*   3 */
 202   MRB_TT_SYMBOL,      /*   4 */
 203   MRB_TT_UNDEF,       /*   5 */
 204   MRB_TT_FLOAT,       /*   6 */
 205   MRB_TT_CPTR,        /*   7 */
 206   MRB_TT_OBJECT,      /*   8 */
 207   MRB_TT_CLASS,       /*   9 */
 208   MRB_TT_MODULE,      /*  10 */
 209   MRB_TT_ICLASS,      /*  11 */
 210   MRB_TT_SCLASS,      /*  12 */
 211   MRB_TT_PROC,        /*  13 */
 212   MRB_TT_ARRAY,       /*  14 */
 213   MRB_TT_HASH,        /*  15 */
 214   MRB_TT_STRING,      /*  16 */
 215   MRB_TT_RANGE,       /*  17 */
 216   MRB_TT_EXCEPTION,   /*  18 */
 217   MRB_TT_FILE,        /*  19 */
 218   MRB_TT_ENV,         /*  20 */
 219   MRB_TT_DATA,        /*  21 */
 220   MRB_TT_FIBER,       /*  22 */
 221   MRB_TT_MAXDEFINE    /*  23 */
 222 };
 223
 224 #if defined(MRB_WORD_BOXING)
 225
 226 #include <limits.h>
 227 #define MRB_TT_HAS_BASIC  MRB_TT_FLOAT
 228
 229 enum mrb_special_consts {
 230   MRB_Qnil    = 0,
 231   MRB_Qfalse  = 2,
 232   MRB_Qtrue   = 4,
 233   MRB_Qundef  = 6,
 234 };
 235
 236 #define MRB_FIXNUM_FLAG   0x01
 237 #define MRB_FIXNUM_SHIFT  1
 238 #define MRB_SYMBOL_FLAG   0x0e
 239 #define MRB_SPECIAL_SHIFT 8
 240
 241 typedef union mrb_value {
 242   union {
 243     void *p;
 244     struct {
 245       unsigned int i_flag : MRB_FIXNUM_SHIFT;
 246       mrb_int i : (MRB_INT_BIT - MRB_FIXNUM_SHIFT);
 247     };
 248     struct {
 249       unsigned int sym_flag : MRB_SPECIAL_SHIFT;
 250       int sym : (sizeof(mrb_sym) * CHAR_BIT);
 251     };
 252     struct RBasic *bp;
 253     struct RFloat *fp;
 254     struct RCptr *vp;
 255   } value;
 256   unsigned long w;
 257 } mrb_value;
 258
 259 #define mrb_ptr(o)      (o).value.p
 260 #define mrb_float(o)    (o).value.fp->f
 261
 262 #define MRB_SET_VALUE(o, ttt, attr, v) do {\
 263   (o).w = 0;\
 264   (o).attr = (v);\
 265   switch (ttt) {\
 266   case MRB_TT_FALSE:  (o).w = (v) ? MRB_Qfalse : MRB_Qnil; break;\
 267   case MRB_TT_TRUE:   (o).w = MRB_Qtrue; break;\
 268   case MRB_TT_UNDEF:  (o).w = MRB_Qundef; break;\
 269   case MRB_TT_FIXNUM: (o).value.i_flag = MRB_FIXNUM_FLAG; break;\
 270   case MRB_TT_SYMBOL: (o).value.sym_flag = MRB_SYMBOL_FLAG; break;\
 271   default:            if ((o).value.bp) (o).value.bp->tt = ttt; break;\
 272   }\
 273 } while (0)
 274
 275 mrb_value mrb_float_value(struct mrb_state *mrb, mrb_float f);
 276 mrb_value mrb_float_pool(struct mrb_state *mrb, mrb_float f);
 277
 278 #else /* No MRB_xxx_BOXING */
 279
 280 #define MRB_TT_HAS_BASIC  MRB_TT_OBJECT
 281
 282 typedef struct mrb_value {
 283   union {
 284     mrb_float f;
 285     void *p;
 286     mrb_int i;
 287     mrb_sym sym;
 288   } value;
 289   enum mrb_vtype tt;
 290 } mrb_value;
 291
 292 #define mrb_type(o)     (o).tt
 293 #define mrb_ptr(o)      (o).value.p
 294 #define mrb_float(o)    (o).value.f
 295
 296 #define MRB_SET_VALUE(o, ttt, attr, v) do {\
 297   (o).tt = ttt;\
 298   (o).attr = v;\
 299 } while (0)
 300
 301 static inline mrb_value
 302 mrb_float_value(struct mrb_state *mrb, mrb_float f)
 303 {
 304   mrb_value v;
 305   (void) mrb;
 306
 307   MRB_SET_VALUE(v, MRB_TT_FLOAT, value.f, f);
 308   return v;
 309 }
 310 #define mrb_float_pool(mrb,f) mrb_float_value(mrb,f)
 311
 312 #endif  /* no boxing */
 313
 314 #endif
 315
 316 #ifdef MRB_WORD_BOXING
 317
 318 #define mrb_cptr(o) (o).value.vp->p
 319 #define mrb_fixnum_p(o) ((o).value.i_flag == MRB_FIXNUM_FLAG)
 320 #define mrb_undef_p(o) ((o).w == MRB_Qundef)
 321 #define mrb_nil_p(o)  ((o).w == MRB_Qnil)
 322 #define mrb_bool(o)   ((o).w != MRB_Qnil && (o).w != MRB_Qfalse)
 323
 324 #else
 325
 326 #define mrb_cptr(o) mrb_ptr(o)
 327 #define mrb_fixnum_p(o) (mrb_type(o) == MRB_TT_FIXNUM)
 328 #define mrb_undef_p(o) (mrb_type(o) == MRB_TT_UNDEF)
 329 #define mrb_nil_p(o)  (mrb_type(o) == MRB_TT_FALSE && !(o).value.i)
 330 #define mrb_bool(o)   (mrb_type(o) != MRB_TT_FALSE)
 331
 332 #endif  /* no boxing */
 333
 334 #define mrb_fixnum(o) (o).value.i
 335 #define mrb_symbol(o) (o).value.sym
 336 #define mrb_float_p(o) (mrb_type(o) == MRB_TT_FLOAT)
 337 #define mrb_symbol_p(o) (mrb_type(o) == MRB_TT_SYMBOL)
 338 #define mrb_array_p(o) (mrb_type(o) == MRB_TT_ARRAY)
 339 #define mrb_string_p(o) (mrb_type(o) == MRB_TT_STRING)
 340 #define mrb_hash_p(o) (mrb_type(o) == MRB_TT_HASH)
 341 #define mrb_cptr_p(o) (mrb_type(o) == MRB_TT_CPTR)
 342 #define mrb_test(o)   mrb_bool(o)
 343 mrb_bool mrb_regexp_p(struct mrb_state*, mrb_value);
 344
 345 #define MRB_OBJECT_HEADER \
 346   enum mrb_vtype tt:8;\
 347   uint32_t color:3;\
 348   uint32_t flags:21;\
 349   struct RClass *c;\
 350   struct RBasic *gcnext
 351
 352 /* white: 011, black: 100, gray: 000 */
 353 #define MRB_GC_GRAY 0
 354 #define MRB_GC_WHITE_A 1
 355 #define MRB_GC_WHITE_B (1 << 1)
 356 #define MRB_GC_BLACK (1 << 2)
 357 #define MRB_GC_WHITES (MRB_GC_WHITE_A | MRB_GC_WHITE_B)
 358 #define MRB_GC_COLOR_MASK 7
 359
 360 #define paint_gray(o) ((o)->color = MRB_GC_GRAY)
 361 #define paint_black(o) ((o)->color = MRB_GC_BLACK)
 362 #define paint_white(o) ((o)->color = MRB_GC_WHITES)
 363 #define paint_partial_white(s, o) ((o)->color = (s)->current_white_part)
 364 #define is_gray(o) ((o)->color == MRB_GC_GRAY)
 365 #define is_white(o) ((o)->color & MRB_GC_WHITES)
 366 #define is_black(o) ((o)->color & MRB_GC_BLACK)
 367 #define is_dead(s, o) (((o)->color & other_white_part(s) & MRB_GC_WHITES) || (o)->tt == MRB_TT_FREE)
 368 #define flip_white_part(s) ((s)->current_white_part = other_white_part(s))
 369 #define other_white_part(s) ((s)->current_white_part ^ MRB_GC_WHITES)
 370
 371 struct RBasic {
 372   MRB_OBJECT_HEADER;
 373 };
 374 #define mrb_basic_ptr(v) ((struct RBasic*)(mrb_ptr(v)))
 375 /* obsolete macro mrb_basic; will be removed soon */
 376 #define mrb_basic(v)     mrb_basic_ptr(v)
 377
 378 struct RObject {
 379   MRB_OBJECT_HEADER;
 380   struct iv_tbl *iv;
 381 };
 382 #define mrb_obj_ptr(v)   ((struct RObject*)(mrb_ptr(v)))
 383 /* obsolete macro mrb_object; will be removed soon */
 384 #define mrb_object(o) mrb_obj_ptr(o)
 385 #define mrb_immediate_p(x) (mrb_type(x) <= MRB_TT_CPTR)
 386 #define mrb_special_const_p(x) mrb_immediate_p(x)
 387
 388 struct RFiber {
 389   MRB_OBJECT_HEADER;
 390   struct mrb_context *cxt;
 391 };
 392
 393 #ifdef MRB_WORD_BOXING
 394 struct RFloat {
 395   MRB_OBJECT_HEADER;
 396   mrb_float f;
 397 };
 398
 399 struct RCptr {
 400   MRB_OBJECT_HEADER;
 401   void *p;
 402 };
 403
 404 static inline enum mrb_vtype
 405 mrb_type(mrb_value o)
 406 {
 407   switch (o.w) {
 408   case MRB_Qfalse:
 409   case MRB_Qnil:
 410     return MRB_TT_FALSE;
 411   case MRB_Qtrue:
 412     return MRB_TT_TRUE;
 413   case MRB_Qundef:
 414     return MRB_TT_UNDEF;
 415   }
 416   if (o.value.i_flag == MRB_FIXNUM_FLAG) {
 417     return MRB_TT_FIXNUM;
 418   }
 419   if (o.value.sym_flag == MRB_SYMBOL_FLAG) {
 420     return MRB_TT_SYMBOL;
 421   }
 422   return o.value.bp->tt;
 423 }
 424 #endif  /* MRB_WORD_BOXING */
 425
 426 static inline mrb_value
 427 mrb_fixnum_value(mrb_int i)
 428 {
 429   mrb_value v;
 430
 431   MRB_SET_VALUE(v, MRB_TT_FIXNUM, value.i, i);
 432   return v;
 433 }
 434
 435 static inline mrb_value
 436 mrb_symbol_value(mrb_sym i)
 437 {
 438   mrb_value v;
 439
 440   MRB_SET_VALUE(v, MRB_TT_SYMBOL, value.sym, i);
 441   return v;
 442 }
 443
 444 static inline mrb_value
 445 mrb_obj_value(void *p)
 446 {
 447   mrb_value v;
 448   struct RBasic *b = (struct RBasic*)p;
 449
 450   MRB_SET_VALUE(v, b->tt, value.p, p);
 451   return v;
 452 }
 453
 454 #ifdef MRB_WORD_BOXING
 455 mrb_value
 456 mrb_cptr_value(struct mrb_state *mrb, void *p);
 457 #else
 458 static inline mrb_value
 459 mrb_cptr_value(struct mrb_state *mrb, void *p)
 460 {
 461   mrb_value v;
 462   (void) mrb;
 463
 464   MRB_SET_VALUE(v, MRB_TT_CPTR, value.p, p);
 465   return v;
 466 }
 467 #endif
 468 /* obsolete macros; will be removed */
 469 #define MRB_TT_VOIDP MRB_TT_CPTR
 470 #define mrb_voidp_value(m,p) mrb_cptr_value((m),(p))
 471 #define mrb_voidp(o) mrb_cptr(o)
 472 #define mrb_voidp_p(o) mrb_cptr_p(o)
 473
 474 #define MRB_TT_HAS_BASIC_P(tt) ((tt) >= MRB_TT_HAS_BASIC)
 475
 476 static inline mrb_value
 477 mrb_false_value(void)
 478 {
 479   mrb_value v;
 480
 481   MRB_SET_VALUE(v, MRB_TT_FALSE, value.i, 1);
 482   return v;
 483 }
 484
 485 static inline mrb_value
 486 mrb_nil_value(void)
 487 {
 488   mrb_value v;
 489
 490   MRB_SET_VALUE(v, MRB_TT_FALSE, value.i, 0);
 491   return v;
 492 }
 493
 494 static inline mrb_value
 495 mrb_true_value(void)
 496 {
 497   mrb_value v;
 498
 499   MRB_SET_VALUE(v, MRB_TT_TRUE, value.i, 1);
 500   return v;
 501 }
 502
 503 static inline mrb_value
 504 mrb_undef_value(void)
 505 {
 506   mrb_value v;
 507
 508   MRB_SET_VALUE(v, MRB_TT_UNDEF, value.i, 0);
 509   return v;
 510 }
 511
 512 static inline mrb_value
 513 mrb_bool_value(mrb_bool boolean)
 514 {
 515   mrb_value v;
 516
 517   MRB_SET_VALUE(v, boolean ? MRB_TT_TRUE : MRB_TT_FALSE, value.i, 1);
 518   return v;
 519 }
 520
 521 #endif  /* MRUBY_VALUE_H */