14 #include "ruby/internal/config.h"
19 # ifdef HAVE_CRT_EXTERNS_H
20 # include <crt_externs.h>
22 # include "missing/crt_externs.h"
26 #include "debug_counter.h"
29 #include "internal/array.h"
30 #include "internal/bignum.h"
31 #include "internal/basic_operators.h"
32 #include "internal/class.h"
33 #include "internal/cont.h"
34 #include "internal/error.h"
35 #include "internal/hash.h"
36 #include "internal/object.h"
37 #include "internal/proc.h"
38 #include "internal/st.h"
39 #include "internal/symbol.h"
40 #include "internal/thread.h"
41 #include "internal/time.h"
42 #include "internal/vm.h"
46 #include "ruby_assert.h"
75 #include "internal/gc.h"
78 #define SET_DEFAULT(hash, ifnone) ( \
79 FL_UNSET_RAW(hash, RHASH_PROC_DEFAULT), \
80 RHASH_SET_IFNONE(hash, ifnone))
82 #define SET_PROC_DEFAULT(hash, proc) set_proc_default(hash, proc)
84 #define COPY_DEFAULT(hash, hash2) copy_default(RHASH(hash), RHASH(hash2))
87 copy_default(
struct RHash *hash,
const struct RHash *hash2)
89 hash->basic.
flags &= ~RHASH_PROC_DEFAULT;
90 hash->basic.
flags |= hash2->basic.
flags & RHASH_PROC_DEFAULT;
114 VALUE rb_cHash_empty_frozen;
117 static ID id_hash, id_flatten_bang;
118 static ID id_hash_iter_lev;
120 #define id_default idDefault
132 if (a == b)
return 0;
137 if (UNDEF_P(a) || UNDEF_P(b))
return -1;
146 hash_recursive(
VALUE obj,
VALUE arg,
int recurse)
148 if (recurse)
return INT2FIX(0);
152 static long rb_objid_hash(st_index_t index);
155 dbl_to_index(
double d)
157 union {
double d; st_index_t i;} u;
163 rb_dbl_long_hash(
double d)
166 if (d == 0.0) d = 0.0;
167 #if SIZEOF_INT == SIZEOF_VOIDP
170 return rb_objid_hash(dbl_to_index(d));
175 any_hash(
VALUE a, st_index_t (*other_func)(
VALUE))
187 hnum = RSYMBOL(a)->hashval;
194 hnum = rb_objid_hash((st_index_t)a);
200 hval = rb_big_hash(a);
207 hnum = other_func(a);
220 obj_any_hash(
VALUE obj)
226 if (cme && METHOD_ENTRY_BASIC(cme)) {
228 if (cme->def->type == VM_METHOD_TYPE_CFUNC && cme->def->body.cfunc.func == (rb_cfunc_t)rb_obj_hash) {
229 hval = rb_obj_hash(obj);
232 hval = rb_vm_call0(GET_EC(), obj, id_hash, 0, 0, cme, 0);
238 hval = rb_exec_recursive_outer_mid(hash_recursive, obj, 0, id_hash);
263 return any_hash(a, obj_any_hash);
269 return LONG2FIX(any_hash(obj, obj_any_hash));
278 static const uint64_t prime1 = ((uint64_t)0x2e0bb864 << 32) | 0xe9ea7df5;
279 static const uint32_t prime2 = 0x830fcab9;
282 static inline uint64_t
283 mult_and_mix(uint64_t m1, uint64_t m2)
285 #if defined HAVE_UINT128_T
286 uint128_t r = (uint128_t) m1 * (uint128_t) m2;
287 return (uint64_t) (r >> 64) ^ (uint64_t) r;
289 uint64_t hm1 = m1 >> 32, hm2 = m2 >> 32;
290 uint64_t lm1 = m1, lm2 = m2;
291 uint64_t v64_128 = hm1 * hm2;
292 uint64_t v32_96 = hm1 * lm2 + lm1 * hm2;
293 uint64_t v1_32 = lm1 * lm2;
295 return (v64_128 + (v32_96 >> 32)) ^ ((v32_96 << 32) + v1_32);
299 static inline uint64_t
300 key64_hash(uint64_t key, uint32_t seed)
302 return mult_and_mix(key + seed, prime1);
306 #define st_index_hash(index) key64_hash(rb_hash_start(index), prime2)
309 rb_objid_hash(st_index_t index)
311 return (
long)st_index_hash(index);
315 objid_hash(
VALUE obj)
319 object_id = rb_big_hash(object_id);
321 #if SIZEOF_LONG == SIZEOF_VOIDP
322 return (st_index_t)st_index_hash((st_index_t)
NUM2LONG(object_id));
323 #elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
324 return (st_index_t)st_index_hash((st_index_t)
NUM2LL(object_id));
332 rb_obj_hash(
VALUE obj)
334 long hnum = any_hash(obj, objid_hash);
343 #define rb_ident_cmp st_numcmp
346 rb_ident_hash(st_data_t n)
359 return (st_index_t)st_index_hash((st_index_t)n);
362 #define identhash rb_hashtype_ident
368 #define RHASH_IDENTHASH_P(hash) (RHASH_TYPE(hash) == &identhash)
369 #define RHASH_STRING_KEY_P(hash, key) (!RHASH_IDENTHASH_P(hash) && (rb_obj_class(key) == rb_cString))
371 typedef st_index_t st_hash_t;
381 #define RHASH_AR_TABLE_MAX_BOUND RHASH_AR_TABLE_MAX_SIZE
383 #define RHASH_AR_TABLE_REF(hash, n) (&RHASH_AR_TABLE(hash)->pairs[n])
384 #define RHASH_AR_CLEARED_HINT 0xff
386 static inline st_hash_t
387 ar_do_hash(st_data_t key)
389 return (st_hash_t)rb_any_hash(key);
392 static inline ar_hint_t
393 ar_do_hash_hint(st_hash_t hash_value)
395 return (ar_hint_t)hash_value;
398 static inline ar_hint_t
399 ar_hint(
VALUE hash,
unsigned int index)
401 return RHASH_AR_TABLE(hash)->ar_hint.ary[index];
405 ar_hint_set_hint(
VALUE hash,
unsigned int index, ar_hint_t hint)
407 RHASH_AR_TABLE(hash)->ar_hint.ary[index] = hint;
411 ar_hint_set(
VALUE hash,
unsigned int index, st_hash_t hash_value)
413 ar_hint_set_hint(hash, index, ar_do_hash_hint(hash_value));
417 ar_clear_entry(
VALUE hash,
unsigned int index)
421 ar_hint_set_hint(hash, index, RHASH_AR_CLEARED_HINT);
425 ar_cleared_entry(
VALUE hash,
unsigned int index)
427 if (ar_hint(hash, index) == RHASH_AR_CLEARED_HINT) {
432 return UNDEF_P(pair->key);
440 ar_set_entry(
VALUE hash,
unsigned int index, st_data_t key, st_data_t val, st_hash_t hash_value)
445 ar_hint_set(hash, index, hash_value);
448 #define RHASH_AR_TABLE_SIZE(h) (HASH_ASSERT(RHASH_AR_TABLE_P(h)), \
449 RHASH_AR_TABLE_SIZE_RAW(h))
451 #define RHASH_AR_TABLE_BOUND_RAW(h) \
452 ((unsigned int)((RBASIC(h)->flags >> RHASH_AR_TABLE_BOUND_SHIFT) & \
453 (RHASH_AR_TABLE_BOUND_MASK >> RHASH_AR_TABLE_BOUND_SHIFT)))
455 #define RHASH_ST_TABLE_SET(h, s) rb_hash_st_table_set(h, s)
456 #define RHASH_TYPE(hash) (RHASH_AR_TABLE_P(hash) ? &objhash : RHASH_ST_TABLE(hash)->type)
458 #define HASH_ASSERT(expr) RUBY_ASSERT_MESG_WHEN(HASH_DEBUG, expr, #expr)
460 static inline unsigned int
461 RHASH_AR_TABLE_BOUND(
VALUE h)
463 HASH_ASSERT(RHASH_AR_TABLE_P(h));
464 const unsigned int bound = RHASH_AR_TABLE_BOUND_RAW(h);
465 HASH_ASSERT(bound <= RHASH_AR_TABLE_MAX_SIZE);
470 #define hash_verify(hash) hash_verify_(hash, __FILE__, __LINE__)
473 rb_hash_dump(
VALUE hash)
475 rb_obj_info_dump(hash);
477 if (RHASH_AR_TABLE_P(hash)) {
478 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
480 fprintf(stderr,
" size:%u bound:%u\n",
481 RHASH_AR_TABLE_SIZE(hash), bound);
483 for (i=0; i<bound; i++) {
486 if (!ar_cleared_entry(hash, i)) {
487 char b1[0x100], b2[0x100];
491 fprintf(stderr,
" %d key:%s val:%s hint:%02x\n", i,
492 rb_raw_obj_info(b1, 0x100, k),
493 rb_raw_obj_info(b2, 0x100, v),
497 fprintf(stderr,
" %d empty\n", i);
504 hash_verify_(
VALUE hash,
const char *file,
int line)
508 if (RHASH_AR_TABLE_P(hash)) {
509 unsigned i, n = 0, bound = RHASH_AR_TABLE_BOUND(hash);
511 for (i=0; i<bound; i++) {
513 if (!ar_cleared_entry(hash, i)) {
517 HASH_ASSERT(!UNDEF_P(k));
518 HASH_ASSERT(!UNDEF_P(v));
522 if (n != RHASH_AR_TABLE_SIZE(hash)) {
523 rb_bug(
"n:%u, RHASH_AR_TABLE_SIZE:%u", n, RHASH_AR_TABLE_SIZE(hash));
527 HASH_ASSERT(RHASH_ST_TABLE(hash) != NULL);
528 HASH_ASSERT(RHASH_AR_TABLE_SIZE_RAW(hash) == 0);
529 HASH_ASSERT(RHASH_AR_TABLE_BOUND_RAW(hash) == 0);
536 #define hash_verify(h) ((void)0)
540 RHASH_TABLE_EMPTY_P(
VALUE hash)
545 #define RHASH_SET_ST_FLAG(h) FL_SET_RAW(h, RHASH_ST_TABLE_FLAG)
546 #define RHASH_UNSET_ST_FLAG(h) FL_UNSET_RAW(h, RHASH_ST_TABLE_FLAG)
551 st_init_existing_table_with_size(RHASH_ST_TABLE(hash),
type, size);
552 RHASH_SET_ST_FLAG(hash);
558 HASH_ASSERT(st != NULL);
559 RHASH_SET_ST_FLAG(hash);
561 *RHASH_ST_TABLE(hash) = *st;
565 RHASH_AR_TABLE_BOUND_SET(
VALUE h, st_index_t n)
567 HASH_ASSERT(RHASH_AR_TABLE_P(h));
568 HASH_ASSERT(n <= RHASH_AR_TABLE_MAX_BOUND);
570 RBASIC(h)->flags &= ~RHASH_AR_TABLE_BOUND_MASK;
571 RBASIC(h)->flags |= n << RHASH_AR_TABLE_BOUND_SHIFT;
575 RHASH_AR_TABLE_SIZE_SET(
VALUE h, st_index_t n)
577 HASH_ASSERT(RHASH_AR_TABLE_P(h));
578 HASH_ASSERT(n <= RHASH_AR_TABLE_MAX_SIZE);
580 RBASIC(h)->flags &= ~RHASH_AR_TABLE_SIZE_MASK;
581 RBASIC(h)->flags |= n << RHASH_AR_TABLE_SIZE_SHIFT;
585 HASH_AR_TABLE_SIZE_ADD(
VALUE h, st_index_t n)
587 HASH_ASSERT(RHASH_AR_TABLE_P(h));
589 RHASH_AR_TABLE_SIZE_SET(h, RHASH_AR_TABLE_SIZE(h) + n);
594 #define RHASH_AR_TABLE_SIZE_INC(h) HASH_AR_TABLE_SIZE_ADD(h, 1)
597 RHASH_AR_TABLE_SIZE_DEC(
VALUE h)
599 HASH_ASSERT(RHASH_AR_TABLE_P(h));
600 int new_size = RHASH_AR_TABLE_SIZE(h) - 1;
603 RHASH_AR_TABLE_SIZE_SET(h, new_size);
606 RHASH_AR_TABLE_SIZE_SET(h, 0);
607 RHASH_AR_TABLE_BOUND_SET(h, 0);
613 RHASH_AR_TABLE_CLEAR(
VALUE h)
615 RBASIC(h)->flags &= ~RHASH_AR_TABLE_SIZE_MASK;
616 RBASIC(h)->flags &= ~RHASH_AR_TABLE_BOUND_MASK;
618 memset(RHASH_AR_TABLE(h), 0,
sizeof(
ar_table));
621 NOINLINE(
static int ar_equal(
VALUE x,
VALUE y));
626 return rb_any_cmp(x, y) == 0;
630 ar_find_entry_hint(
VALUE hash, ar_hint_t hint, st_data_t key)
632 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
633 const ar_hint_t *hints = RHASH_AR_TABLE(hash)->ar_hint.ary;
637 for (i = 0; i < bound; i++) {
638 if (hints[i] == hint) {
640 if (ar_equal(key, pair->key)) {
641 RB_DEBUG_COUNTER_INC(artable_hint_hit);
647 static char fname[256];
650 if (pid != getpid()) {
651 snprintf(fname,
sizeof(fname),
"/tmp/ruby-armiss.%d", pid = getpid());
652 if ((fp = fopen(fname,
"w")) == NULL)
rb_bug(
"fopen");
655 st_hash_t h1 = ar_do_hash(key);
656 st_hash_t h2 = ar_do_hash(pair->key);
658 fprintf(fp,
"miss: hash_eq:%d hints[%d]:%02x hint:%02x\n"
660 " pair->key:%016lx %s\n",
661 h1 == h2, i, hints[i], hint,
662 h1, rb_obj_info(key), h2, rb_obj_info(pair->key));
664 RB_DEBUG_COUNTER_INC(artable_hint_miss);
668 RB_DEBUG_COUNTER_INC(artable_hint_notfound);
669 return RHASH_AR_TABLE_MAX_BOUND;
673 ar_find_entry(
VALUE hash, st_hash_t hash_value, st_data_t key)
675 ar_hint_t hint = ar_do_hash_hint(hash_value);
676 return ar_find_entry_hint(hash, hint, key);
680 hash_ar_free_and_clear_table(
VALUE hash)
682 RHASH_AR_TABLE_CLEAR(hash);
684 HASH_ASSERT(RHASH_AR_TABLE_SIZE(hash) == 0);
685 HASH_ASSERT(RHASH_AR_TABLE_BOUND(hash) == 0);
688 void rb_st_add_direct_with_hash(
st_table *tab, st_data_t key, st_data_t value, st_hash_t hash);
690 enum ar_each_key_type {
697 ar_each_key(
ar_table *ar,
int max,
enum ar_each_key_type
type, st_data_t *dst_keys,
st_table *new_tab, st_hash_t *hashes)
699 for (
int i = 0; i < max; i++) {
703 case ar_each_key_copy:
704 dst_keys[i] = pair->key;
706 case ar_each_key_cmp:
707 if (dst_keys[i] != pair->key)
return 1;
709 case ar_each_key_insert:
710 if (UNDEF_P(pair->key))
continue;
711 rb_st_add_direct_with_hash(new_tab, pair->key, pair->val, hashes[i]);
720 ar_force_convert_table(
VALUE hash,
const char *file,
int line)
722 if (RHASH_ST_TABLE_P(hash)) {
723 return RHASH_ST_TABLE(hash);
726 ar_table *ar = RHASH_AR_TABLE(hash);
727 st_hash_t hashes[RHASH_AR_TABLE_MAX_SIZE];
728 unsigned int bound, size;
732 st_data_t keys[RHASH_AR_TABLE_MAX_SIZE];
733 bound = RHASH_AR_TABLE_BOUND(hash);
734 size = RHASH_AR_TABLE_SIZE(hash);
735 ar_each_key(ar, bound, ar_each_key_copy, keys, NULL, NULL);
737 for (
unsigned int i = 0; i < bound; i++) {
739 hashes[i] = UNDEF_P(keys[i]) ? 0 : ar_do_hash(keys[i]);
743 if (UNLIKELY(!RHASH_AR_TABLE_P(hash)))
return RHASH_ST_TABLE(hash);
744 if (UNLIKELY(RHASH_AR_TABLE_BOUND(hash) != bound))
continue;
745 if (UNLIKELY(ar_each_key(ar, bound, ar_each_key_cmp, keys, NULL, NULL)))
continue;
751 st_init_existing_table_with_size(new_tab, &objhash, size);
752 ar_each_key(ar, bound, ar_each_key_insert, NULL, new_tab, hashes);
753 hash_ar_free_and_clear_table(hash);
754 RHASH_ST_TABLE_SET(hash, new_tab);
755 return RHASH_ST_TABLE(hash);
760 ar_compact_table(
VALUE hash)
762 const unsigned bound = RHASH_AR_TABLE_BOUND(hash);
763 const unsigned size = RHASH_AR_TABLE_SIZE(hash);
772 for (i=0; i<bound; i++) {
773 if (ar_cleared_entry(hash, i)) {
775 for (; j<bound; j++) {
776 if (!ar_cleared_entry(hash, j)) {
778 ar_hint_set_hint(hash, i, (st_hash_t)ar_hint(hash, j));
779 ar_clear_entry(hash, j);
790 HASH_ASSERT(i<=bound);
792 RHASH_AR_TABLE_BOUND_SET(hash, size);
799 ar_add_direct_with_hash(
VALUE hash, st_data_t key, st_data_t val, st_hash_t hash_value)
801 unsigned bin = RHASH_AR_TABLE_BOUND(hash);
803 if (RHASH_AR_TABLE_SIZE(hash) >= RHASH_AR_TABLE_MAX_SIZE) {
807 if (UNLIKELY(bin >= RHASH_AR_TABLE_MAX_BOUND)) {
808 bin = ar_compact_table(hash);
810 HASH_ASSERT(bin < RHASH_AR_TABLE_MAX_BOUND);
812 ar_set_entry(hash, bin, key, val, hash_value);
813 RHASH_AR_TABLE_BOUND_SET(hash, bin+1);
814 RHASH_AR_TABLE_SIZE_INC(hash);
820 ensure_ar_table(
VALUE hash)
822 if (!RHASH_AR_TABLE_P(hash)) {
828 ar_general_foreach(
VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg)
830 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
831 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
833 for (i = 0; i < bound; i++) {
834 if (ar_cleared_entry(hash, i))
continue;
837 st_data_t key = (st_data_t)pair->key;
838 st_data_t val = (st_data_t)pair->val;
839 enum st_retval retval = (*func)(key, val, arg, 0);
840 ensure_ar_table(hash);
851 retval = (*replace)(&key, &val, arg, TRUE);
854 pair = RHASH_AR_TABLE_REF(hash, i);
855 pair->key = (
VALUE)key;
856 pair->val = (
VALUE)val;
860 ar_clear_entry(hash, i);
861 RHASH_AR_TABLE_SIZE_DEC(hash);
870 ar_foreach_with_replace(
VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg)
872 return ar_general_foreach(hash, func, replace, arg);
876 st_foreach_callback_func *func;
881 apply_functor(st_data_t k, st_data_t v, st_data_t d,
int _)
883 const struct functor *f = (
void *)d;
884 return f->func(k, v, f->arg);
888 ar_foreach(
VALUE hash, st_foreach_callback_func *func, st_data_t arg)
890 const struct functor f = { func, arg };
891 return ar_general_foreach(hash, apply_functor, NULL, (st_data_t)&f);
895 ar_foreach_check(
VALUE hash, st_foreach_check_callback_func *func, st_data_t arg,
898 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
899 unsigned i, ret = 0, bound = RHASH_AR_TABLE_BOUND(hash);
900 enum st_retval retval;
905 for (i = 0; i < bound; i++) {
906 if (ar_cleared_entry(hash, i))
continue;
908 pair = RHASH_AR_TABLE_REF(hash, i);
910 hint = ar_hint(hash, i);
912 retval = (*func)(key, pair->val, arg, 0);
913 ensure_ar_table(hash);
918 pair = RHASH_AR_TABLE_REF(hash, i);
919 if (pair->key == never)
break;
920 ret = ar_find_entry_hint(hash, hint, key);
921 if (ret == RHASH_AR_TABLE_MAX_BOUND) {
922 retval = (*func)(0, 0, arg, 1);
932 if (!ar_cleared_entry(hash, i)) {
933 ar_clear_entry(hash, i);
934 RHASH_AR_TABLE_SIZE_DEC(hash);
945 ar_update(
VALUE hash, st_data_t key,
946 st_update_callback_func *func, st_data_t arg)
948 int retval, existing;
949 unsigned bin = RHASH_AR_TABLE_MAX_BOUND;
950 st_data_t value = 0, old_key;
951 st_hash_t hash_value = ar_do_hash(key);
953 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
958 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
959 bin = ar_find_entry(hash, hash_value, key);
960 existing = (bin != RHASH_AR_TABLE_MAX_BOUND) ? TRUE : FALSE;
972 retval = (*func)(&key, &value, arg, existing);
974 ensure_ar_table(hash);
979 if (ar_add_direct_with_hash(hash, key, value, hash_value)) {
985 if (old_key != key) {
993 ar_clear_entry(hash, bin);
994 RHASH_AR_TABLE_SIZE_DEC(hash);
1002 ar_insert(
VALUE hash, st_data_t key, st_data_t value)
1004 unsigned bin = RHASH_AR_TABLE_BOUND(hash);
1005 st_hash_t hash_value = ar_do_hash(key);
1007 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1012 bin = ar_find_entry(hash, hash_value, key);
1013 if (bin == RHASH_AR_TABLE_MAX_BOUND) {
1014 if (RHASH_AR_TABLE_SIZE(hash) >= RHASH_AR_TABLE_MAX_SIZE) {
1017 else if (bin >= RHASH_AR_TABLE_MAX_BOUND) {
1018 bin = ar_compact_table(hash);
1020 HASH_ASSERT(bin < RHASH_AR_TABLE_MAX_BOUND);
1022 ar_set_entry(hash, bin, key, value, hash_value);
1023 RHASH_AR_TABLE_BOUND_SET(hash, bin+1);
1024 RHASH_AR_TABLE_SIZE_INC(hash);
1028 RHASH_AR_TABLE_REF(hash, bin)->val = value;
1034 ar_lookup(
VALUE hash, st_data_t key, st_data_t *value)
1036 if (RHASH_AR_TABLE_SIZE(hash) == 0) {
1040 st_hash_t hash_value = ar_do_hash(key);
1041 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1043 return st_lookup(RHASH_ST_TABLE(hash), key, value);
1045 unsigned bin = ar_find_entry(hash, hash_value, key);
1047 if (bin == RHASH_AR_TABLE_MAX_BOUND) {
1051 HASH_ASSERT(bin < RHASH_AR_TABLE_MAX_BOUND);
1052 if (value != NULL) {
1053 *value = RHASH_AR_TABLE_REF(hash, bin)->val;
1061 ar_delete(
VALUE hash, st_data_t *key, st_data_t *value)
1064 st_hash_t hash_value = ar_do_hash(*key);
1066 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1068 return st_delete(RHASH_ST_TABLE(hash), key, value);
1071 bin = ar_find_entry(hash, hash_value, *key);
1073 if (bin == RHASH_AR_TABLE_MAX_BOUND) {
1074 if (value != 0) *value = 0;
1082 ar_clear_entry(hash, bin);
1083 RHASH_AR_TABLE_SIZE_DEC(hash);
1089 ar_shift(
VALUE hash, st_data_t *key, st_data_t *value)
1091 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
1092 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
1094 for (i = 0; i < bound; i++) {
1095 if (!ar_cleared_entry(hash, i)) {
1097 if (value != 0) *value = pair->val;
1099 ar_clear_entry(hash, i);
1100 RHASH_AR_TABLE_SIZE_DEC(hash);
1105 if (value != NULL) *value = 0;
1110 ar_keys(
VALUE hash, st_data_t *keys, st_index_t size)
1112 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
1113 st_data_t *keys_start = keys, *keys_end = keys + size;
1115 for (i = 0; i < bound; i++) {
1116 if (keys == keys_end) {
1120 if (!ar_cleared_entry(hash, i)) {
1121 *keys++ = RHASH_AR_TABLE_REF(hash, i)->key;
1126 return keys - keys_start;
1130 ar_values(
VALUE hash, st_data_t *values, st_index_t size)
1132 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
1133 st_data_t *values_start = values, *values_end = values + size;
1135 for (i = 0; i < bound; i++) {
1136 if (values == values_end) {
1140 if (!ar_cleared_entry(hash, i)) {
1141 *values++ = RHASH_AR_TABLE_REF(hash, i)->val;
1146 return values - values_start;
1152 ar_table *old_tab = RHASH_AR_TABLE(hash2);
1153 ar_table *new_tab = RHASH_AR_TABLE(hash1);
1155 *new_tab = *old_tab;
1156 RHASH_AR_TABLE(hash1)->ar_hint.word = RHASH_AR_TABLE(hash2)->ar_hint.word;
1157 RHASH_AR_TABLE_BOUND_SET(hash1, RHASH_AR_TABLE_BOUND(hash2));
1158 RHASH_AR_TABLE_SIZE_SET(hash1, RHASH_AR_TABLE_SIZE(hash2));
1160 rb_gc_writebarrier_remember(hash1);
1166 ar_clear(
VALUE hash)
1168 if (RHASH_AR_TABLE(hash) != NULL) {
1169 RHASH_AR_TABLE_SIZE_SET(hash, 0);
1170 RHASH_AR_TABLE_BOUND_SET(hash, 0);
1173 HASH_ASSERT(RHASH_AR_TABLE_SIZE(hash) == 0);
1174 HASH_ASSERT(RHASH_AR_TABLE_BOUND(hash) == 0);
1179 hash_st_free(
VALUE hash)
1181 HASH_ASSERT(RHASH_ST_TABLE_P(hash));
1183 st_table *tab = RHASH_ST_TABLE(hash);
1186 xfree(tab->entries);
1190 hash_st_free_and_clear_table(
VALUE hash)
1194 RHASH_ST_CLEAR(hash);
1198 rb_hash_free(
VALUE hash)
1200 if (RHASH_ST_TABLE_P(hash)) {
1205 typedef int st_foreach_func(st_data_t, st_data_t, st_data_t);
1209 st_foreach_func *func;
1214 foreach_safe_i(st_data_t key, st_data_t value, st_data_t args,
int error)
1219 if (error)
return ST_STOP;
1220 status = (*arg->func)(key, value, arg->arg);
1221 if (status == ST_CONTINUE) {
1233 arg.func = (st_foreach_func *)func;
1244 rb_foreach_func *func;
1249 hash_iter_status_check(
int status)
1264 hash_ar_foreach_iter(st_data_t key, st_data_t value, st_data_t argp,
int error)
1268 if (error)
return ST_STOP;
1270 int status = (*arg->func)((
VALUE)key, (
VALUE)value, arg->arg);
1273 return hash_iter_status_check(status);
1277 hash_foreach_iter(st_data_t key, st_data_t value, st_data_t argp,
int error)
1281 if (error)
return ST_STOP;
1283 st_table *tbl = RHASH_ST_TABLE(arg->hash);
1284 int status = (*arg->func)((
VALUE)key, (
VALUE)value, arg->arg);
1286 if (RHASH_ST_TABLE(arg->hash) != tbl) {
1290 return hash_iter_status_check(status);
1293 static unsigned long
1294 iter_lev_in_ivar(
VALUE hash)
1299 HASH_ASSERT(lev >= 0);
1300 return (
unsigned long)lev;
1303 void rb_ivar_set_internal(
VALUE obj,
ID id,
VALUE val);
1306 iter_lev_in_ivar_set(
VALUE hash,
unsigned long lev)
1308 HASH_ASSERT(lev >= RHASH_LEV_MAX);
1310 rb_ivar_set_internal(hash, id_hash_iter_lev,
LONG2FIX((
long)lev));
1313 static inline unsigned long
1314 iter_lev_in_flags(
VALUE hash)
1316 return (
unsigned long)((
RBASIC(hash)->flags >> RHASH_LEV_SHIFT) & RHASH_LEV_MAX);
1320 iter_lev_in_flags_set(
VALUE hash,
unsigned long lev)
1322 HASH_ASSERT(lev <= RHASH_LEV_MAX);
1323 RBASIC(hash)->flags = ((
RBASIC(hash)->flags & ~RHASH_LEV_MASK) | ((
VALUE)lev << RHASH_LEV_SHIFT));
1327 hash_iterating_p(
VALUE hash)
1329 return iter_lev_in_flags(hash) > 0;
1333 hash_iter_lev_inc(
VALUE hash)
1335 unsigned long lev = iter_lev_in_flags(hash);
1336 if (lev == RHASH_LEV_MAX) {
1337 lev = iter_lev_in_ivar(hash) + 1;
1344 iter_lev_in_flags_set(hash, lev);
1345 if (lev < RHASH_LEV_MAX)
return;
1347 iter_lev_in_ivar_set(hash, lev);
1351 hash_iter_lev_dec(
VALUE hash)
1353 unsigned long lev = iter_lev_in_flags(hash);
1354 if (lev == RHASH_LEV_MAX) {
1355 lev = iter_lev_in_ivar(hash);
1356 if (lev > RHASH_LEV_MAX) {
1357 iter_lev_in_ivar_set(hash, lev-1);
1360 rb_attr_delete(hash, id_hash_iter_lev);
1362 else if (lev == 0) {
1365 iter_lev_in_flags_set(hash, lev - 1);
1369 hash_foreach_ensure(
VALUE hash)
1371 hash_iter_lev_dec(hash);
1376 rb_hash_stlike_foreach(
VALUE hash, st_foreach_callback_func *func, st_data_t arg)
1378 if (RHASH_AR_TABLE_P(hash)) {
1379 return ar_foreach(hash, func, arg);
1382 return st_foreach(RHASH_ST_TABLE(hash), func, arg);
1387 rb_hash_stlike_foreach_with_replace(
VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg)
1389 if (RHASH_AR_TABLE_P(hash)) {
1390 return ar_foreach_with_replace(hash, func, replace, arg);
1393 return st_foreach_with_replace(RHASH_ST_TABLE(hash), func, replace, arg);
1398 hash_foreach_call(
VALUE arg)
1402 if (RHASH_AR_TABLE_P(hash)) {
1403 ret = ar_foreach_check(hash, hash_ar_foreach_iter,
1404 (st_data_t)arg, (st_data_t)
Qundef);
1406 else if (RHASH_ST_TABLE_P(hash)) {
1408 (st_data_t)arg, (st_data_t)
Qundef);
1421 if (RHASH_TABLE_EMPTY_P(hash))
1424 arg.func = (rb_foreach_func *)func;
1427 hash_foreach_call((
VALUE)&arg);
1430 hash_iter_lev_inc(hash);
1431 rb_ensure(hash_foreach_call, (
VALUE)&arg, hash_foreach_ensure, hash);
1436 void rb_st_compact_table(
st_table *tab);
1439 compact_after_delete(
VALUE hash)
1441 if (!hash_iterating_p(hash) && RHASH_ST_TABLE_P(hash)) {
1442 rb_st_compact_table(RHASH_ST_TABLE(hash));
1450 const size_t size =
sizeof(
struct RHash) + (st ? sizeof(
st_table) : sizeof(ar_table));
1452 NEWOBJ_OF(hash, struct RHash, klass, T_HASH | wb | flags, size, 0);
1460 hash_alloc(VALUE klass)
1467 empty_hash_alloc(
VALUE klass)
1469 RUBY_DTRACE_CREATE_HOOK(HASH, 0);
1471 return hash_alloc(klass);
1483 if (rb_hash_compare_by_id_p(basis)) {
1484 return rb_hash_compare_by_id(hash);
1490 rb_hash_new_with_size(st_index_t size)
1492 bool st = size > RHASH_AR_TABLE_MAX_SIZE;
1496 hash_st_table_init(ret, &objhash, size);
1505 return rb_hash_new_with_size((st_index_t)
capa);
1511 if (RHASH_AR_TABLE_P(hash)) {
1512 if (RHASH_AR_TABLE_P(ret)) {
1516 st_table *tab = RHASH_ST_TABLE(ret);
1517 st_init_existing_table_with_size(tab, &objhash, RHASH_AR_TABLE_SIZE(hash));
1519 int bound = RHASH_AR_TABLE_BOUND(hash);
1520 for (
int i = 0; i < bound; i++) {
1521 if (ar_cleared_entry(hash, i))
continue;
1524 st_add_direct(tab, pair->key, pair->val);
1533 RHASH_SET_ST_FLAG(ret);
1534 st_replace(RHASH_ST_TABLE(ret), RHASH_ST_TABLE(hash));
1536 rb_gc_writebarrier_remember(ret);
1542 hash_dup_with_compare_by_id(
VALUE hash)
1545 if (RHASH_ST_TABLE_P(hash)) {
1546 RHASH_SET_ST_FLAG(dup);
1549 RHASH_UNSET_ST_FLAG(dup);
1552 return hash_copy(dup, hash);
1567 flags & (
FL_EXIVAR|RHASH_PROC_DEFAULT));
1574 rb_hash_resurrect(
VALUE hash)
1581 rb_hash_modify_check(
VALUE hash)
1583 rb_check_frozen(hash);
1587 rb_hash_tbl_raw(
VALUE hash,
const char *file,
int line)
1589 return ar_force_convert_table(hash, file, line);
1596 return rb_hash_tbl_raw(hash, file, line);
1600 rb_hash_modify(
VALUE hash)
1602 rb_hash_modify_check(hash);
1605 NORETURN(
static void no_new_key(
void));
1617 #define NOINSERT_UPDATE_CALLBACK(func) \
1619 func##_noinsert(st_data_t *key, st_data_t *val, st_data_t arg, int existing) \
1621 if (!existing) no_new_key(); \
1622 return func(key, val, (struct update_arg *)arg, existing); \
1626 func##_insert(st_data_t *key, st_data_t *val, st_data_t arg, int existing) \
1628 return func(key, val, (struct update_arg *)arg, existing); \
1633 st_update_callback_func *func;
1639 typedef int (*tbl_update_func)(st_data_t *, st_data_t *, st_data_t, int);
1642 rb_hash_stlike_update(
VALUE hash, st_data_t key, st_update_callback_func *func, st_data_t arg)
1644 if (RHASH_AR_TABLE_P(hash)) {
1645 int result = ar_update(hash, key, func, arg);
1647 ar_force_convert_table(hash, __FILE__, __LINE__);
1654 return st_update(RHASH_ST_TABLE(hash), key, func, arg);
1658 tbl_update_modify(st_data_t *key, st_data_t *val, st_data_t arg,
int existing)
1661 st_data_t old_key = *key;
1662 st_data_t old_value = *val;
1663 VALUE hash = p->hash;
1664 int ret = (p->func)(key, val, arg, existing);
1669 if (!existing || *key != old_key || *val != old_value) {
1670 rb_hash_modify(hash);
1677 rb_hash_modify(hash);
1685 tbl_update(
VALUE hash,
VALUE key, tbl_update_func func, st_data_t optional_arg)
1688 .arg = optional_arg,
1692 .value = (
VALUE)optional_arg,
1695 int ret = rb_hash_stlike_update(hash, key, tbl_update_modify, (st_data_t)&arg);
1704 #define UPDATE_CALLBACK(iter_p, func) ((iter_p) ? func##_noinsert : func##_insert)
1706 #define RHASH_UPDATE_ITER(h, iter_p, key, func, a) do { \
1707 tbl_update((h), (key), UPDATE_CALLBACK(iter_p, func), (st_data_t)(a)); \
1710 #define RHASH_UPDATE(hash, key, func, arg) \
1711 RHASH_UPDATE_ITER(hash, hash_iterating_p(hash), key, func, arg)
1719 if (n != 2 && (n >= 0 || n < -3)) {
1720 if (n < 0) n = -n-1;
1732 rb_hash_modify(hash);
1734 if (capa_value !=
INT2FIX(0)) {
1736 if (
capa > 0 &&
RHASH_SIZE(hash) == 0 && RHASH_AR_TABLE_P(hash)) {
1737 hash_st_table_init(hash, &objhash,
capa);
1741 if (!
NIL_P(block)) {
1742 if (ifnone_unset !=
Qtrue) {
1746 SET_PROC_DEFAULT(hash, block);
1795 rb_hash_s_create(
int argc,
VALUE *argv,
VALUE klass)
1800 tmp = rb_hash_s_try_convert(
Qnil, argv[0]);
1806 tmp = rb_hash_to_a(tmp);
1809 hash = hash_alloc(klass);
1811 hash_copy(hash, tmp);
1822 hash = hash_alloc(klass);
1830 rb_builtin_class_name(e), i);
1846 if (argc % 2 != 0) {
1850 hash = hash_alloc(klass);
1857 rb_to_hash_type(
VALUE hash)
1859 return rb_convert_type_with_id(hash,
T_HASH,
"Hash", idTo_hash);
1861 #define to_hash rb_to_hash_type
1866 return rb_check_convert_type_with_id(hash,
T_HASH,
"Hash", idTo_hash);
1883 rb_hash_s_try_convert(
VALUE dummy,
VALUE hash)
1904 rb_hash_s_ruby2_keywords_hash_p(
VALUE dummy,
VALUE hash)
1907 return RBOOL(RHASH(hash)->basic.flags & RHASH_PASS_AS_KEYWORDS);
1926 rb_hash_s_ruby2_keywords_hash(
VALUE dummy,
VALUE hash)
1931 rb_hash_compare_by_id(tmp);
1933 RHASH(tmp)->basic.flags |= RHASH_PASS_AS_KEYWORDS;
1945 if (RHASH_AR_TABLE_P(arg)) {
1946 ar_insert(arg, (st_data_t)key, (st_data_t)value);
1949 st_insert(RHASH_ST_TABLE(arg), (st_data_t)key, (st_data_t)value);
1967 rb_hash_rehash(
VALUE hash)
1972 if (hash_iterating_p(hash)) {
1975 rb_hash_modify_check(hash);
1976 if (RHASH_AR_TABLE_P(hash)) {
1977 tmp = hash_alloc(0);
1980 hash_ar_free_and_clear_table(hash);
1983 else if (RHASH_ST_TABLE_P(hash)) {
1984 st_table *old_tab = RHASH_ST_TABLE(hash);
1985 tmp = hash_alloc(0);
1987 hash_st_table_init(tmp, old_tab->type, old_tab->num_entries);
1988 tbl = RHASH_ST_TABLE(tmp);
1993 RHASH_ST_TABLE_SET(hash, tbl);
1994 RHASH_ST_CLEAR(tmp);
2003 VALUE args[2] = {hash, key};
2008 rb_hash_default_unredefined(
VALUE hash)
2012 return !!BASIC_OP_UNREDEFINED_P(BOP_DEFAULT, HASH_REDEFINED_OP_FLAG);
2024 if (LIKELY(rb_hash_default_unredefined(hash))) {
2026 if (LIKELY(!
FL_TEST_RAW(hash, RHASH_PROC_DEFAULT)))
return ifnone;
2027 if (UNDEF_P(key))
return Qnil;
2028 return call_default_proc(ifnone, hash, key);
2036 hash_stlike_lookup(
VALUE hash, st_data_t key, st_data_t *pval)
2040 if (RHASH_AR_TABLE_P(hash)) {
2041 return ar_lookup(hash, key, pval);
2044 extern st_index_t rb_iseq_cdhash_hash(
VALUE);
2046 RHASH_ST_TABLE(hash)->
type->hash == rb_ident_hash ||
2047 RHASH_ST_TABLE(hash)->
type->hash == rb_iseq_cdhash_hash);
2048 return st_lookup(RHASH_ST_TABLE(hash), key, pval);
2053 rb_hash_stlike_lookup(
VALUE hash, st_data_t key, st_data_t *pval)
2055 return hash_stlike_lookup(hash, key, pval);
2077 if (hash_stlike_lookup(hash, key, &val)) {
2081 return rb_hash_default_value(hash, key);
2090 if (hash_stlike_lookup(hash, key, &val)) {
2128 rb_hash_fetch_m(
int argc,
VALUE *argv,
VALUE hash)
2138 if (block_given && argc == 2) {
2139 rb_warn(
"block supersedes default value argument");
2142 if (hash_stlike_lookup(hash, key, &val)) {
2149 else if (argc == 1) {
2155 rb_key_err_raise(
rb_sprintf(
"key not found: %"PRIsVALUE, desc), hash, key);
2166 return rb_hash_fetch_m(1, &key, hash);
2190 rb_hash_default(
int argc,
VALUE *argv,
VALUE hash)
2196 if (
FL_TEST(hash, RHASH_PROC_DEFAULT)) {
2197 if (argc == 0)
return Qnil;
2198 return call_default_proc(ifnone, hash, argv[0]);
2217 rb_hash_set_default(
VALUE hash,
VALUE ifnone)
2219 rb_hash_modify_check(hash);
2220 SET_DEFAULT(hash, ifnone);
2237 rb_hash_default_proc(
VALUE hash)
2239 if (
FL_TEST(hash, RHASH_PROC_DEFAULT)) {
2260 rb_hash_set_default_proc(
VALUE hash,
VALUE proc)
2264 rb_hash_modify_check(hash);
2266 SET_DEFAULT(hash, proc);
2269 b = rb_check_convert_type_with_id(proc,
T_DATA,
"Proc", idTo_proc);
2272 "wrong default_proc type %s (expected Proc)",
2276 SET_PROC_DEFAULT(hash, proc);
2319 rb_hash_stlike_delete(
VALUE hash, st_data_t *pkey, st_data_t *pval)
2321 if (RHASH_AR_TABLE_P(hash)) {
2322 return ar_delete(hash, pkey, pval);
2325 return st_delete(RHASH_ST_TABLE(hash), pkey, pval);
2337 st_data_t ktmp = (st_data_t)key, val;
2339 if (rb_hash_stlike_delete(hash, &ktmp, &val)) {
2355 VALUE deleted_value = rb_hash_delete_entry(hash, key);
2357 if (!UNDEF_P(deleted_value)) {
2358 return deleted_value;
2397 rb_hash_modify_check(hash);
2398 val = rb_hash_delete_entry(hash, key);
2400 if (!UNDEF_P(val)) {
2401 compact_after_delete(hash);
2444 rb_hash_shift(
VALUE hash)
2448 rb_hash_modify_check(hash);
2449 if (RHASH_AR_TABLE_P(hash)) {
2451 if (!hash_iterating_p(hash)) {
2452 if (ar_shift(hash, &var.key, &var.val)) {
2458 if (!UNDEF_P(var.key)) {
2459 rb_hash_delete_entry(hash, var.key);
2464 if (RHASH_ST_TABLE_P(hash)) {
2466 if (!hash_iterating_p(hash)) {
2467 if (st_shift(RHASH_ST_TABLE(hash), &var.key, &var.val)) {
2473 if (!UNDEF_P(var.key)) {
2474 rb_hash_delete_entry(hash, var.key);
2486 rb_hash_modify(hash);
2519 rb_hash_modify_check(hash);
2520 if (!RHASH_TABLE_EMPTY_P(hash)) {
2522 compact_after_delete(hash);
2546 rb_hash_reject_bang(
VALUE hash)
2551 rb_hash_modify(hash);
2553 if (!n)
return Qnil;
2578 rb_hash_reject(
VALUE hash)
2583 result = hash_dup_with_compare_by_id(hash);
2586 compact_after_delete(result);
2603 rb_hash_slice(
int argc,
VALUE *argv,
VALUE hash)
2606 VALUE key, value, result;
2611 result = copy_compare_by_id(rb_hash_new_with_size(argc), hash);
2613 for (i = 0; i < argc; i++) {
2616 if (!UNDEF_P(value))
2635 rb_hash_except(
int argc,
VALUE *argv,
VALUE hash)
2640 result = hash_dup_with_compare_by_id(hash);
2642 for (i = 0; i < argc; i++) {
2646 compact_after_delete(result);
2665 rb_hash_values_at(
int argc,
VALUE *argv,
VALUE hash)
2670 for (i=0; i<argc; i++) {
2697 rb_hash_fetch_values(
int argc,
VALUE *argv,
VALUE hash)
2702 for (i=0; i<argc; i++) {
2712 rb_hash_modify(hash);
2734 rb_hash_select(
VALUE hash)
2739 result = hash_dup_with_compare_by_id(hash);
2742 compact_after_delete(result);
2765 rb_hash_select_bang(
VALUE hash)
2770 rb_hash_modify_check(hash);
2772 if (!n)
return Qnil;
2796 rb_hash_keep_if(
VALUE hash)
2799 rb_hash_modify_check(hash);
2800 if (!RHASH_TABLE_EMPTY_P(hash)) {
2822 rb_hash_modify_check(hash);
2824 if (hash_iterating_p(hash)) {
2827 else if (RHASH_AR_TABLE_P(hash)) {
2831 st_clear(RHASH_ST_TABLE(hash));
2832 compact_after_delete(hash);
2839 hash_aset(st_data_t *key, st_data_t *val,
struct update_arg *arg,
int existing)
2846 rb_hash_key_str(
VALUE key)
2849 return rb_fstring(key);
2857 hash_aset_str(st_data_t *key, st_data_t *val,
struct update_arg *arg,
int existing)
2860 *key = rb_hash_key_str(*key);
2862 return hash_aset(key, val, arg, existing);
2865 NOINSERT_UPDATE_CALLBACK(hash_aset)
2866 NOINSERT_UPDATE_CALLBACK(hash_aset_str)
2895 bool iter_p = hash_iterating_p(hash);
2897 rb_hash_modify(hash);
2899 if (!RHASH_STRING_KEY_P(hash, key)) {
2900 RHASH_UPDATE_ITER(hash, iter_p, key, hash_aset, val);
2903 RHASH_UPDATE_ITER(hash, iter_p, key, hash_aset_str, val);
2921 rb_hash_modify_check(hash);
2922 if (hash == hash2)
return hash;
2923 if (hash_iterating_p(hash)) {
2926 hash2 = to_hash(hash2);
2928 COPY_DEFAULT(hash, hash2);
2930 if (RHASH_AR_TABLE_P(hash)) {
2931 hash_ar_free_and_clear_table(hash);
2934 hash_st_free_and_clear_table(hash);
2937 hash_copy(hash, hash2);
2975 rb_hash_empty_p(
VALUE hash)
3012 rb_hash_each_value(
VALUE hash)
3050 rb_hash_each_key(
VALUE hash)
3101 rb_hash_each_pair(
VALUE hash)
3104 if (rb_block_pair_yield_optimizable())
3121 VALUE trans = p->trans, result = p->result;
3123 if (UNDEF_P(new_key)) {
3179 rb_hash_transform_keys(
int argc,
VALUE *argv,
VALUE hash)
3186 transarg.trans = to_hash(argv[0]);
3194 if (transarg.trans) {
3195 transarg.result = result;
3219 rb_hash_transform_keys_bang(
int argc,
VALUE *argv,
VALUE hash)
3222 int block_given = 0;
3226 trans = to_hash(argv[0]);
3232 rb_hash_modify_check(hash);
3233 if (!RHASH_TABLE_EMPTY_P(hash)) {
3235 VALUE new_keys = hash_alloc(0);
3247 else if (block_given) {
3254 if (!hash_stlike_lookup(new_keys, key, NULL)) {
3255 rb_hash_stlike_delete(hash, &key, NULL);
3263 compact_after_delete(hash);
3268 transform_values_foreach_func(st_data_t key, st_data_t value, st_data_t argp,
int error)
3274 transform_values_foreach_replace(st_data_t *key, st_data_t *value, st_data_t argp,
int existing)
3278 rb_hash_modify(hash);
3304 rb_hash_transform_values(
VALUE hash)
3309 result = hash_dup_with_compare_by_id(hash);
3310 SET_DEFAULT(result,
Qnil);
3313 rb_hash_stlike_foreach_with_replace(result, transform_values_foreach_func, transform_values_foreach_replace, result);
3314 compact_after_delete(result);
3336 rb_hash_transform_values_bang(
VALUE hash)
3339 rb_hash_modify_check(hash);
3341 if (!RHASH_TABLE_EMPTY_P(hash)) {
3342 rb_hash_stlike_foreach_with_replace(hash, transform_values_foreach_func, transform_values_foreach_replace, hash);
3366 rb_hash_to_a(
VALUE hash)
3377 symbol_key_needs_quote(
VALUE str)
3380 if (
len == 0 || !rb_str_symname_p(str))
return true;
3383 if (first ==
'@' || first ==
'$' || first ==
'!')
return true;
3385 switch (s[
len - 1]) {
3416 quote = symbol_key_needs_quote(str2);
3442 inspect_hash(
VALUE hash,
VALUE dummy,
int recur)
3466 rb_hash_inspect(
VALUE hash)
3480 rb_hash_to_hash(
VALUE hash)
3493 rb_builtin_class_name(arg));
3511 rb_hash_to_h_block(
VALUE hash)
3538 rb_hash_to_h(
VALUE hash)
3541 return rb_hash_to_h_block(hash);
3545 hash = hash_dup(hash,
rb_cHash, flags & RHASH_PROC_DEFAULT);
3567 rb_hash_keys(
VALUE hash)
3572 if (size == 0)
return keys;
3574 if (ST_DATA_COMPATIBLE_P(
VALUE)) {
3576 if (RHASH_AR_TABLE_P(hash)) {
3577 size = ar_keys(hash,
ptr, size);
3580 st_table *table = RHASH_ST_TABLE(hash);
3581 size = st_keys(table,
ptr, size);
3584 rb_gc_writebarrier_remember(keys);
3585 rb_ary_set_len(keys, size);
3611 rb_hash_values(
VALUE hash)
3617 if (size == 0)
return values;
3619 if (ST_DATA_COMPATIBLE_P(
VALUE)) {
3620 if (RHASH_AR_TABLE_P(hash)) {
3621 rb_gc_writebarrier_remember(values);
3623 size = ar_values(hash,
ptr, size);
3626 else if (RHASH_ST_TABLE_P(hash)) {
3627 st_table *table = RHASH_ST_TABLE(hash);
3628 rb_gc_writebarrier_remember(values);
3630 size = st_values(table,
ptr, size);
3633 rb_ary_set_len(values, size);
3656 return RBOOL(hash_stlike_lookup(hash, key, NULL));
3702 if (!hash_stlike_lookup(data->hash, key, &val2)) {
3716 recursive_eql(
VALUE hash,
VALUE dt,
int recur)
3720 if (recur)
return Qtrue;
3722 data->result =
Qtrue;
3725 return data->result;
3729 hash_equal(
VALUE hash1,
VALUE hash2,
int eql)
3733 if (hash1 == hash2)
return Qtrue;
3739 if (
rb_eql(hash2, hash1)) {
3752 if (!RHASH_TABLE_EMPTY_P(hash1) && !RHASH_TABLE_EMPTY_P(hash2)) {
3753 if (RHASH_TYPE(hash1) != RHASH_TYPE(hash2)) {
3765 FL_TEST(hash1, RHASH_PROC_DEFAULT) ==
FL_TEST(hash2, RHASH_PROC_DEFAULT)))
3793 return hash_equal(hash1, hash2, FALSE);
3817 return hash_equal(hash1, hash2, TRUE);
3823 st_index_t *hval = (st_index_t *)arg;
3824 st_index_t hdata[2];
3828 *hval ^= st_hash(hdata,
sizeof(hdata), 0);
3847 rb_hash_hash(
VALUE hash)
3882 rb_hash_invert(
VALUE hash)
3898 rb_hash_update_block_callback(st_data_t *key, st_data_t *value,
struct update_arg *arg,
int existing)
3900 st_data_t newvalue = arg->arg;
3905 else if (RHASH_STRING_KEY_P(arg->hash, *key) && !
RB_OBJ_FROZEN(*key)) {
3906 *key = rb_hash_key_str(*key);
3912 NOINSERT_UPDATE_CALLBACK(rb_hash_update_block_callback)
3917 RHASH_UPDATE(hash, key, rb_hash_update_block_callback, value);
3970 rb_hash_update(
int argc,
VALUE *argv,
VALUE self)
3975 rb_hash_modify(
self);
3976 for (i = 0; i < argc; i++){
3977 VALUE hash = to_hash(argv[i]);
3995 rb_hash_update_func_callback(st_data_t *key, st_data_t *value,
struct update_arg *arg,
int existing)
3998 VALUE newvalue = uf_arg->value;
4001 newvalue = (*uf_arg->func)((
VALUE)*key, (
VALUE)*value, newvalue);
4007 NOINSERT_UPDATE_CALLBACK(rb_hash_update_func_callback)
4013 VALUE hash = arg->hash;
4016 RHASH_UPDATE(hash, key, rb_hash_update_func_callback, (
VALUE)arg);
4023 rb_hash_modify(hash1);
4024 hash2 = to_hash(hash2);
4089 rb_hash_merge(
int argc,
VALUE *argv,
VALUE self)
4091 return rb_hash_update(argc, argv, copy_compare_by_id(
rb_hash_dup(
self),
self));
4106 assoc_lookup(
VALUE arg)
4110 if (st_lookup(p->tbl, p->key, &data))
return (
VALUE)data;
4144 if (RHASH_ST_TABLE_P(hash) && !RHASH_IDENTHASH_P(hash)) {
4146 st_table assoctable = *RHASH_ST_TABLE(hash);
4148 .compare = assoc_cmp,
4149 .hash = assoctable.type->hash,
4153 .key = (st_data_t)key,
4157 value = assoc_lookup(arg);
4160 hash_iter_lev_inc(hash);
4161 value =
rb_ensure(assoc_lookup, arg, hash_foreach_ensure, hash);
4253 rb_hash_flatten(
int argc,
VALUE *argv,
VALUE hash)
4262 if (level == 0)
return rb_hash_to_a(hash);
4270 rb_funcallv(ary, id_flatten_bang, 1, &ary_flatten_level);
4272 else if (level < 0) {
4305 rb_hash_compact(
VALUE hash)
4310 compact_after_delete(result);
4312 else if (rb_hash_compare_by_id_p(hash)) {
4313 result = rb_hash_compare_by_id(result);
4330 rb_hash_compact_bang(
VALUE hash)
4333 rb_hash_modify_check(hash);
4372 rb_hash_compare_by_id(
VALUE hash)
4377 if (rb_hash_compare_by_id_p(hash))
return hash;
4379 rb_hash_modify_check(hash);
4380 if (hash_iterating_p(hash)) {
4384 if (RHASH_TABLE_EMPTY_P(hash)) {
4387 ar_force_convert_table(hash, __FILE__, __LINE__);
4388 HASH_ASSERT(RHASH_ST_TABLE_P(hash));
4390 RHASH_ST_TABLE(hash)->type = &identhash;
4395 tmp = hash_alloc(0);
4396 hash_st_table_init(tmp, &identhash,
RHASH_SIZE(hash));
4397 identtable = RHASH_ST_TABLE(tmp);
4404 RHASH_ST_TABLE_SET(hash, identtable);
4405 RHASH_ST_CLEAR(tmp);
4419 rb_hash_compare_by_id_p(
VALUE hash)
4421 return RBOOL(RHASH_IDENTHASH_P(hash));
4425 rb_ident_hash_new(
void)
4428 hash_st_table_init(hash, &identhash, 0);
4433 rb_ident_hash_new_with_size(st_index_t size)
4436 hash_st_table_init(hash, &identhash, size);
4441 rb_init_identtable(
void)
4443 return st_init_table(&identhash);
4514 rb_hash_any_p(
int argc,
VALUE *argv,
VALUE hash)
4523 rb_warn(
"given block not used");
4534 if (rb_block_pair_yield_optimizable())
4572 rb_hash_dig(
int argc,
VALUE *argv,
VALUE self)
4576 if (!--argc)
return self;
4578 return rb_obj_dig(argc, argv,
self,
Qnil);
4586 if (!UNDEF_P(v) &&
rb_equal(value, v))
return ST_CONTINUE;
4615 other = to_hash(other);
4617 return hash_le(hash, other);
4634 other = to_hash(other);
4636 return hash_le(hash, other);
4653 other = to_hash(other);
4655 return hash_le(other, hash);
4672 other = to_hash(other);
4674 return hash_le(other, hash);
4697 rb_hash_to_proc(
VALUE hash)
4699 return rb_func_lambda_new(hash_proc_call, hash, 1, 1);
4704 rb_hash_deconstruct_keys(
VALUE hash,
VALUE keys)
4710 add_new_i(st_data_t *key, st_data_t *val, st_data_t arg,
int existing)
4713 if (existing)
return ST_STOP;
4732 if (RHASH_AR_TABLE_P(hash)) {
4733 ret = ar_update(hash, (st_data_t)key, add_new_i, (st_data_t)args);
4737 ar_force_convert_table(hash, __FILE__, __LINE__);
4740 tbl = RHASH_TBL_RAW(hash);
4741 return st_update(tbl, (st_data_t)key, add_new_i, (st_data_t)args);
4746 key_stringify(
VALUE key)
4749 rb_hash_key_str(key) : key;
4753 ar_bulk_insert(
VALUE hash,
long argc,
const VALUE *argv)
4756 for (i = 0; i < argc; ) {
4757 st_data_t k = key_stringify(argv[i++]);
4758 st_data_t v = argv[i++];
4759 ar_insert(hash, k, v);
4768 HASH_ASSERT(argc % 2 == 0);
4770 st_index_t size = argc / 2;
4772 if (RHASH_AR_TABLE_P(hash) &&
4773 (RHASH_AR_TABLE_SIZE(hash) + size <= RHASH_AR_TABLE_MAX_SIZE)) {
4774 ar_bulk_insert(hash, argc, argv);
4777 rb_hash_bulk_insert_into_st_table(argc, argv, hash);
4782 static char **origenviron;
4784 #define GET_ENVIRON(e) ((e) = rb_w32_get_environ())
4785 #define FREE_ENVIRON(e) rb_w32_free_environ(e)
4786 static char **my_environ;
4788 #define environ my_environ
4790 #define getenv(n) rb_w32_ugetenv(n)
4791 #elif defined(__APPLE__)
4793 #define environ (*_NSGetEnviron())
4794 #define GET_ENVIRON(e) (e)
4795 #define FREE_ENVIRON(e)
4797 extern char **environ;
4798 #define GET_ENVIRON(e) (e)
4799 #define FREE_ENVIRON(e)
4801 #ifdef ENV_IGNORECASE
4802 #define ENVMATCH(s1, s2) (STRCASECMP((s1), (s2)) == 0)
4803 #define ENVNMATCH(s1, s2, n) (STRNCASECMP((s1), (s2), (n)) == 0)
4805 #define ENVMATCH(n1, n2) (strcmp((n1), (n2)) == 0)
4806 #define ENVNMATCH(s1, s2, n) (memcmp((s1), (s2), (n)) == 0)
4809 #define ENV_LOCK() RB_VM_LOCK_ENTER()
4810 #define ENV_UNLOCK() RB_VM_LOCK_LEAVE()
4832 env_str_new(
const char *
ptr,
long len)
4834 return env_enc_str_new(
ptr,
len, env_encoding());
4838 env_str_new2(
const char *
ptr)
4841 return env_str_new(
ptr, strlen(
ptr));
4845 getenv_with_lock(
const char *name)
4850 const char *val = getenv(name);
4851 ret = env_str_new2(val);
4858 has_env_with_lock(
const char *name)
4868 return val ? true :
false;
4871 static const char TZ_ENV[] =
"TZ";
4874 get_env_cstr(
VALUE str,
const char *name)
4886 return rb_str_fill_terminator(str, 1);
4889 #define get_env_ptr(var, val) \
4890 (var = get_env_cstr(val, #var))
4892 static inline const char *
4893 env_name(
volatile VALUE *s)
4897 get_env_ptr(name, *s);
4901 #define env_name(s) env_name(&(s))
4906 reset_by_modified_env(
const char *nam)
4914 if (ENVMATCH(nam, TZ_ENV)) {
4915 ruby_reset_timezone();
4920 env_delete(
VALUE name)
4922 const char *nam = env_name(name);
4923 reset_by_modified_env(nam);
4924 VALUE val = getenv_with_lock(nam);
4962 val = env_delete(name);
4982 const char *nam = env_name(name);
4983 VALUE env = getenv_with_lock(nam);
5023 if (block_given && argc == 2) {
5024 rb_warn(
"block supersedes default value argument");
5026 nam = env_name(key);
5027 env = getenv_with_lock(nam);
5030 if (block_given)
return rb_yield(key);
5032 rb_key_err_raise(
rb_sprintf(
"key not found: \"%"PRIsVALUE
"\"", key), envtbl, key);
5039 #if defined(_WIN32) || (defined(HAVE_SETENV) && defined(HAVE_UNSETENV))
5042 in_origenv(
const char *str)
5045 for (env = origenviron; *env; ++env) {
5046 if (*env == str)
return 1;
5052 envix(
const char *nam)
5056 register int i,
len = strlen(nam);
5059 env = GET_ENVIRON(environ);
5060 for (i = 0; env[i]; i++) {
5061 if (ENVNMATCH(env[i],nam,
len) && env[i][
len] ==
'=')
5064 FREE_ENVIRON(environ);
5069 #if defined(_WIN32) || \
5070 (defined(__sun) && !(defined(HAVE_SETENV) && defined(HAVE_UNSETENV)))
5072 NORETURN(
static void invalid_envname(
const char *name));
5075 invalid_envname(
const char *name)
5081 check_envname(
const char *name)
5083 if (strchr(name,
'=')) {
5084 invalid_envname(name);
5099 check_envname(name);
5100 len = MultiByteToWideChar(CP_UTF8, 0, name, -1, NULL, 0);
5103 len2 = MultiByteToWideChar(CP_UTF8, 0, value, -1, NULL, 0);
5105 wvalue = wname +
len;
5106 MultiByteToWideChar(CP_UTF8, 0, name, -1, wname,
len);
5107 MultiByteToWideChar(CP_UTF8, 0, value, -1, wvalue, len2);
5111 MultiByteToWideChar(CP_UTF8, 0, name, -1, wname,
len);
5112 wvalue = wname +
len;
5120 failed = _wputenv_s(wname, wvalue);
5127 if (!value || !*value) {
5129 if (!SetEnvironmentVariableW(wname, value ? wvalue : NULL) &&
5130 GetLastError() != ERROR_ENVVAR_NOT_FOUND)
goto fail;
5134 invalid_envname(name);
5136 #elif defined(HAVE_SETENV) && defined(HAVE_UNSETENV)
5141 ret = setenv(name, value, 1);
5145 if (ret) rb_sys_fail_sprintf(
"setenv(%s)", name);
5148 #ifdef VOID_UNSETENV
5158 ret = unsetenv(name);
5162 if (ret) rb_sys_fail_sprintf(
"unsetenv(%s)", name);
5170 size_t len, mem_size;
5171 char **env_ptr, *str, *mem_ptr;
5173 check_envname(name);
5176 mem_size =
len + strlen(value) + 2;
5177 mem_ptr = malloc(mem_size);
5178 if (mem_ptr == NULL)
5179 rb_sys_fail_sprintf(
"malloc(%"PRIuSIZE
")", mem_size);
5180 snprintf(mem_ptr, mem_size,
"%s=%s", name, value);
5185 for (env_ptr = GET_ENVIRON(environ); (str = *env_ptr) != 0; ++env_ptr) {
5186 if (!strncmp(str, name,
len) && str[
len] ==
'=') {
5187 if (!in_origenv(str)) free(str);
5188 while ((env_ptr[0] = env_ptr[1]) != 0) env_ptr++;
5199 ret = putenv(mem_ptr);
5205 rb_sys_fail_sprintf(
"putenv(%s)", name);
5216 if (environ == origenviron) {
5221 for (max = i; environ[max]; max++) ;
5222 tmpenv =
ALLOC_N(
char*, max+2);
5223 for (j=0; j<max; j++)
5230 char **envp = origenviron;
5231 while (*envp && *envp != environ[i]) envp++;
5235 while (environ[i]) {
5236 environ[i] = environ[i+1];
5243 if (!value)
goto finish;
5248 len = strlen(name) + strlen(value) + 2;
5250 snprintf(environ[i],
len,
"%s=%s",name,value);
5309 return env_aset(nm, val);
5325 get_env_ptr(name, nm);
5326 get_env_ptr(value, val);
5329 reset_by_modified_env(name);
5341 char **env = GET_ENVIRON(environ);
5343 char *s = strchr(*env,
'=');
5345 const char *p = *env;
5352 FREE_ENVIRON(environ);
5375 return env_keys(FALSE);
5386 env = GET_ENVIRON(environ);
5387 for (; *env ; ++env) {
5388 if (strchr(*env,
'=')) {
5392 FREE_ENVIRON(environ);
5417 env_each_key(
VALUE ehash)
5423 keys = env_keys(FALSE);
5437 char **env = GET_ENVIRON(environ);
5440 char *s = strchr(*env,
'=');
5446 FREE_ENVIRON(environ);
5468 return env_values();
5489 env_each_value(
VALUE ehash)
5495 values = env_values();
5521 env_each_pair(
VALUE ehash)
5531 char **env = GET_ENVIRON(environ);
5534 char *s = strchr(*env,
'=');
5541 FREE_ENVIRON(environ);
5545 if (rb_block_pair_yield_optimizable()) {
5582 env_reject_bang(
VALUE ehash)
5589 keys = env_keys(FALSE);
5590 RBASIC_CLEAR_CLASS(keys);
5601 if (del == 0)
return Qnil;
5626 env_delete_if(
VALUE ehash)
5629 env_reject_bang(ehash);
5657 for (i=0; i<argc; i++) {
5683 env_select(
VALUE ehash)
5691 keys = env_keys(FALSE);
5742 env_select_bang(
VALUE ehash)
5749 keys = env_keys(FALSE);
5750 RBASIC_CLEAR_CLASS(keys);
5761 if (del == 0)
return Qnil;
5784 env_keep_if(
VALUE ehash)
5787 env_select_bang(ehash);
5807 VALUE key, value, result;
5812 result = rb_hash_new_with_size(argc);
5814 for (i = 0; i < argc; i++) {
5816 value = rb_f_getenv(
Qnil, key);
5830 keys = env_keys(TRUE);
5885 char **env = GET_ENVIRON(environ);
5887 char *s = strchr(*env,
'=');
5889 if (env != environ) {
5901 FREE_ENVIRON(environ);
5926 char **env = GET_ENVIRON(environ);
5928 char *s = strchr(*env,
'=');
5931 env_str_new2(s+1)));
5935 FREE_ENVIRON(environ);
5957 env_size_with_lock(
void)
5963 char **env = GET_ENVIRON(environ);
5965 FREE_ENVIRON(environ);
5985 return INT2FIX(env_size_with_lock());
6005 char **env = GET_ENVIRON(environ);
6009 FREE_ENVIRON(environ);
6013 return RBOOL(empty);
6042 const char *s = env_name(key);
6043 return RBOOL(has_env_with_lock(s));
6069 const char *s = env_name(key);
6070 VALUE e = getenv_with_lock(s);
6102 char **env = GET_ENVIRON(environ);
6104 char *s = strchr(*env,
'=');
6106 long len = strlen(s);
6114 FREE_ENVIRON(environ);
6145 char **env = GET_ENVIRON(environ);
6148 const char *p = *env;
6149 char *s = strchr(p,
'=');
6151 long len = strlen(s);
6159 FREE_ENVIRON(environ);
6190 char **env = GET_ENVIRON(environ);
6192 char *s = strchr(*env,
'=');
6194 long len = strlen(s);
6196 str = env_str_new(*env, s-*env-1);
6202 FREE_ENVIRON(environ);
6216 char **env = GET_ENVIRON(environ);
6218 char *s = strchr(*env,
'=');
6225 FREE_ENVIRON(environ);
6239 rb_env_to_hash(
void)
6241 return env_to_hash();
6256 return env_to_hash();
6280 VALUE hash = env_to_hash();
6282 hash = rb_hash_to_h_block(hash);
6300 VALUE key, hash = env_to_hash();
6302 for (i = 0; i < argc; i++) {
6331 NORETURN(
static VALUE env_freeze(
VALUE self));
6340 env_freeze(
VALUE self)
6369 char **env = GET_ENVIRON(environ);
6371 const char *p = *env;
6372 char *s = strchr(p,
'=');
6374 key = env_str_new(p, s-p);
6379 FREE_ENVIRON(environ);
6408 return rb_hash_invert(env_to_hash());
6415 const char *keyptr, *eptr;
6423 if (elen != keylen)
continue;
6424 if (!ENVNMATCH(keyptr, eptr, elen))
continue;
6436 keylist_delete(keys, key);
6464 keys = env_keys(TRUE);
6465 if (env == hash)
return env;
6466 hash = to_hash(hash);
6487 if (!
NIL_P(oldval)) {
6534 env_update_block_i : env_update_i;
6535 for (
int i = 0; i < argc; ++i) {
6536 VALUE hash = argv[i];
6537 if (env == hash)
continue;
6538 hash = to_hash(hash);
6559 rb_get_freeze_opt(1, &opt);
6588 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED,
7073 id_hash_iter_lev = rb_make_internal_id();
7172 rb_vm_register_global_object(rb_cHash_empty_frozen);
7338 origenviron = environ;
7407 HASH_ASSERT(
sizeof(ar_hint_t) * RHASH_AR_TABLE_MAX_SIZE ==
sizeof(
VALUE));
7410 #include "hash.rbinc"
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
double rb_float_value(VALUE num)
Extracts its double value from an instance of rb_cFloat.
static bool RB_FL_ANY_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_ANY().
static bool RB_OBJ_FROZEN(VALUE obj)
Checks if an object is frozen.
@ RUBY_FL_SHAREABLE
This flag has something to do with Ractor.
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
void rb_extend_object(VALUE obj, VALUE module)
Extend the object with the module.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
void rb_define_method(VALUE klass, const char *name, VALUE(*func)(ANYARGS), int argc)
Defines a method.
int rb_block_given_p(void)
Determines if the current method is given a block.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define TYPE(_)
Old name of rb_type.
#define FL_EXIVAR
Old name of RUBY_FL_EXIVAR.
#define NUM2LL
Old name of RB_NUM2LL.
#define REALLOC_N
Old name of RB_REALLOC_N.
#define T_STRING
Old name of RUBY_T_STRING.
#define xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define T_NIL
Old name of RUBY_T_NIL.
#define T_FLOAT
Old name of RUBY_T_FLOAT.
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
#define rb_str_buf_new2
Old name of rb_str_buf_new_cstr.
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define T_DATA
Old name of RUBY_T_DATA.
#define CLASS_OF
Old name of rb_class_of.
#define LONG2FIX
Old name of RB_INT2FIX.
#define STATIC_SYM_P
Old name of RB_STATIC_SYM_P.
#define T_TRUE
Old name of RUBY_T_TRUE.
#define T_HASH
Old name of RUBY_T_HASH.
#define ALLOC_N
Old name of RB_ALLOC_N.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define rb_usascii_str_new2
Old name of rb_usascii_str_new_cstr.
#define T_FALSE
Old name of RUBY_T_FALSE.
#define FIXNUM_MIN
Old name of RUBY_FIXNUM_MIN.
#define FLONUM_P
Old name of RB_FLONUM_P.
#define Qtrue
Old name of RUBY_Qtrue.
#define ST2FIX
Old name of RB_ST2FIX.
#define FIXNUM_MAX
Old name of RUBY_FIXNUM_MAX.
#define NUM2INT
Old name of RB_NUM2INT.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define FIX2LONG
Old name of RB_FIX2LONG.
#define NIL_P
Old name of RB_NIL_P.
#define ALLOCV_N
Old name of RB_ALLOCV_N.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
#define POSFIXABLE
Old name of RB_POSFIXABLE.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define FL_TEST
Old name of RB_FL_TEST.
#define NUM2LONG
Old name of RB_NUM2LONG.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define OBJ_WB_UNPROTECT
Old name of RB_OBJ_WB_UNPROTECT.
#define rb_ary_new2
Old name of rb_ary_new_capa.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
#define ALLOCV_END
Old name of RB_ALLOCV_END.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
void rb_raise(VALUE exc, const char *fmt,...)
Exception entry point.
void rb_bug(const char *fmt,...)
Interpreter panic switch.
void rb_syserr_fail_str(int e, VALUE mesg)
Identical to rb_syserr_fail(), except it takes the message in Ruby's String instead of C's.
VALUE rb_eTypeError
TypeError exception.
VALUE rb_eRuntimeError
RuntimeError exception.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_eArgError
ArgumentError exception.
VALUE rb_ensure(VALUE(*b_proc)(VALUE), VALUE data1, VALUE(*e_proc)(VALUE), VALUE data2)
An equivalent to ensure clause.
VALUE rb_mKernel
Kernel module.
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
VALUE rb_mEnumerable
Enumerable module.
int rb_eql(VALUE lhs, VALUE rhs)
Checks for equality of the passed objects, in terms of Object#eql?.
VALUE rb_cHash
Hash class.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
VALUE rb_cString
String class.
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
#define RB_OBJ_WRITTEN(old, oldv, young)
Identical to RB_OBJ_WRITE(), except it doesn't write any values, but only a WB declaration.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
rb_encoding * rb_locale_encoding(void)
Queries the encoding that represents the current locale.
void rb_enc_copy(VALUE dst, VALUE src)
Destructively copies the encoding of the latter object to that of former one.
static bool rb_enc_asciicompat(rb_encoding *enc)
Queries if the passed encoding is in some sense compatible with ASCII.
rb_encoding * rb_utf8_encoding(void)
Queries the encoding that represents UTF-8.
rb_encoding * rb_enc_get(VALUE obj)
Identical to rb_enc_get_index(), except the return type.
static const char * rb_enc_name(rb_encoding *enc)
Queries the (canonical) name of the passed encoding.
VALUE rb_external_str_new_with_enc(const char *ptr, long len, rb_encoding *enc)
Identical to rb_external_str_new(), except it additionally takes an encoding.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
VALUE rb_funcallv(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcall(), except it takes the method arguments as a C array.
#define RGENGC_WB_PROTECTED_HASH
This is a compile-time flag to enable/disable write barrier for struct RHash.
Defines RBIMPL_HAS_BUILTIN.
VALUE rb_ary_delete_at(VALUE ary, long pos)
Destructively removes an element which resides at the specific index of the passed array.
VALUE rb_ary_cat(VALUE ary, const VALUE *train, long len)
Destructively appends multiple elements at the end of the array.
VALUE rb_check_array_type(VALUE obj)
Try converting an object to its array representation using its to_ary method, if any.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_new_capa(long capa)
Identical to rb_ary_new(), except it additionally specifies how many rooms of objects it should alloc...
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_clear(VALUE ary)
Destructively removes everything form an array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_assoc_new(VALUE car, VALUE cdr)
Identical to rb_ary_new_from_values(), except it expects exactly two parameters.
int rb_integer_pack(VALUE val, void *words, size_t numwords, size_t wordsize, size_t nails, int flags)
Exports an integer into a buffer.
#define INTEGER_PACK_NATIVE_BYTE_ORDER
Means either INTEGER_PACK_MSBYTE_FIRST or INTEGER_PACK_LSBYTE_FIRST, depending on the host processor'...
#define RETURN_SIZED_ENUMERATOR(obj, argc, argv, size_fn)
This roughly resembles return enum_for(__callee__) unless block_given?.
#define UNLIMITED_ARGUMENTS
This macro is used in conjunction with rb_check_arity().
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_hash_size(VALUE hash)
Identical to RHASH_SIZE(), except it returns the size in Ruby's integer instead of C's.
void rb_hash_bulk_insert(long argc, const VALUE *argv, VALUE hash)
Inserts a list of key-value pairs into a hash table at once.
void rb_hash_foreach(VALUE hash, int(*func)(VALUE key, VALUE val, VALUE arg), VALUE arg)
Iterates over a hash.
VALUE rb_check_hash_type(VALUE obj)
Try converting an object to its hash representation using its to_hash method, if any.
VALUE rb_hash_lookup2(VALUE hash, VALUE key, VALUE def)
Identical to rb_hash_lookup(), except you can specify what to return on misshits.
VALUE rb_hash_freeze(VALUE obj)
Just another name of rb_obj_freeze.
VALUE rb_hash_update_func(VALUE newkey, VALUE oldkey, VALUE value)
Type of callback functions to pass to rb_hash_update_by().
#define st_foreach_safe
Just another name of rb_st_foreach_safe.
VALUE rb_hash_delete(VALUE hash, VALUE key)
Deletes the passed key from the passed hash table, if any.
VALUE rb_hash_new_capa(long capa)
Identical to rb_hash_new(), except it additionally specifies how many keys it is expected to contain.
VALUE rb_hash_fetch(VALUE hash, VALUE key)
Identical to rb_hash_lookup(), except it yields the (implicitly) passed block instead of returning RU...
VALUE rb_hash_delete_if(VALUE hash)
Deletes each entry for which the block returns a truthy value.
VALUE rb_hash_update_by(VALUE hash1, VALUE hash2, rb_hash_update_func *func)
Destructively merges two hash tables into one.
VALUE rb_hash_aref(VALUE hash, VALUE key)
Queries the given key in the given hash table.
VALUE rb_hash_aset(VALUE hash, VALUE key, VALUE val)
Inserts or replaces ("upsert"s) the objects into the given hash table.
VALUE rb_env_clear(void)
Destructively removes every environment variables of the running process.
VALUE rb_hash_lookup(VALUE hash, VALUE key)
Identical to rb_hash_aref(), except it always returns RUBY_Qnil for misshits.
VALUE rb_hash_dup(VALUE hash)
Duplicates a hash.
VALUE rb_hash(VALUE obj)
Calculates a message authentication code of the passed object.
VALUE rb_hash_clear(VALUE hash)
Swipes everything out of the passed hash table.
VALUE rb_hash_new(void)
Creates a new, empty hash object.
VALUE rb_obj_id(VALUE obj)
Finds or creates an integer primary key of the given object.
VALUE rb_proc_lambda_p(VALUE recv)
Queries if the given object is a lambda.
VALUE rb_proc_call_with_block(VALUE recv, int argc, const VALUE *argv, VALUE proc)
Identical to rb_proc_call(), except you can additionally pass another proc object,...
VALUE rb_protect(VALUE(*func)(VALUE args), VALUE args, int *state)
Protects a function call from potential global escapes from the function.
int rb_proc_arity(VALUE recv)
Queries the number of mandatory arguments of the given Proc.
VALUE rb_obj_is_proc(VALUE recv)
Queries if the given object is a proc.
#define rb_hash_uint(h, i)
Just another name of st_hash_uint.
#define rb_hash_end(h)
Just another name of st_hash_end.
VALUE rb_utf8_str_new(const char *ptr, long len)
Identical to rb_str_new(), except it generates a string of "UTF-8" encoding.
int rb_str_hash_cmp(VALUE str1, VALUE str2)
Compares two strings.
VALUE rb_str_ellipsize(VALUE str, long len)
Shortens str and adds three dots, an ellipsis, if it is longer than len characters.
st_index_t rb_memhash(const void *ptr, long len)
This is a universal hash function.
VALUE rb_str_buf_cat(VALUE, const char *, long)
Just another name of rb_str_cat.
VALUE rb_str_new_frozen(VALUE str)
Creates a frozen copy of the string, if necessary.
st_index_t rb_str_hash(VALUE str)
Calculates a hash value of a string.
VALUE rb_str_buf_cat2(VALUE, const char *)
Just another name of rb_str_cat_cstr.
VALUE rb_str_buf_append(VALUE dst, VALUE src)
Identical to rb_str_cat_cstr(), except it takes Ruby's string instead of C's.
st_index_t rb_hash_start(st_index_t i)
Starts a series of hashing.
VALUE rb_str_inspect(VALUE str)
Generates a "readable" version of the receiver.
VALUE rb_str_buf_cat_ascii(VALUE dst, const char *src)
Identical to rb_str_cat_cstr(), except it additionally assumes the source string be a NUL terminated ...
VALUE rb_str_new(const char *ptr, long len)
Allocates an instance of rb_cString.
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
VALUE rb_exec_recursive_paired(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE p, VALUE h)
Identical to rb_exec_recursive(), except it checks for the recursion on the ordered pair of { g,...
VALUE rb_ivar_get(VALUE obj, ID name)
Identical to rb_iv_get(), except it accepts the name as an ID instead of a C string.
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
int rb_method_basic_definition_p(VALUE klass, ID mid)
Well...
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
VALUE rb_sym2str(VALUE id)
Identical to rb_id2str(), except it takes an instance of rb_cSymbol rather than an ID.
void rb_define_global_const(const char *name, VALUE val)
Identical to rb_define_const(), except it defines that of "global", i.e.
int capa
Designed capacity of the buffer.
char * ptr
Pointer to the underlying memory region, of at least capa bytes.
int len
Length of the buffer.
void ruby_setenv(const char *key, const char *val)
Sets an environment variable.
char * ruby_strdup(const char *str)
This is our own version of strdup(3) that uses ruby_xmalloc() instead of system malloc (benefits our ...
void ruby_unsetenv(const char *key)
Deletes the passed environment variable, if any.
VALUE rb_sprintf(const char *fmt,...)
Ruby's extended sprintf(3).
#define RB_BLOCK_CALL_FUNC_ARGLIST(yielded_arg, callback_arg)
Shim for block function parameters.
VALUE rb_yield_values(int n,...)
Identical to rb_yield(), except it takes variadic number of parameters and pass them to the block.
VALUE rb_yield_values2(int n, const VALUE *argv)
Identical to rb_yield_values(), except it takes the parameters as a C array instead of variadic argum...
VALUE rb_yield(VALUE val)
Yields the block.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
int st_foreach(st_table *q, int_type *w, st_data_t e)
Iteration over the given table.
int st_foreach_check(st_table *q, int_type *w, st_data_t e, st_data_t)
Iteration over the given table.
void rb_copy_generic_ivar(VALUE clone, VALUE obj)
Copies the list of instance variables.
#define RARRAY_LEN
Just another name of rb_array_len.
#define RARRAY_PTR_USE(ary, ptr_name, expr)
Declares a section of code where raw pointers are used.
#define RARRAY_AREF(a, i)
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RHASH_SET_IFNONE(h, ifnone)
Destructively updates the default value of the hash.
VALUE rb_hash_set_ifnone(VALUE hash, VALUE ifnone)
This is the implementation detail of RHASH_SET_IFNONE.
#define RHASH_SIZE(h)
Queries the size of the hash.
struct st_table * rb_hash_tbl(VALUE hash, const char *file, int line)
This is the implementation detail of RHASH_TBL.
size_t rb_hash_size_num(VALUE hash)
This is the implementation detail of RHASH_SIZE.
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
#define StringValue(v)
Ensures that the parameter object is a String.
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
static char * RSTRING_PTR(VALUE str)
Queries the contents pointer of the string.
#define RSTRING_GETMEM(str, ptrvar, lenvar)
Convenient macro to obtain the contents and length at once.
static long RSTRING_LEN(VALUE str)
Queries the length of the string.
#define TypedData_Wrap_Struct(klass, data_type, sval)
Converts sval, a pointer to your struct, into a Ruby object.
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
@ RUBY_SPECIAL_SHIFT
Least significant 8 bits are reserved.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
VALUE flags
Per-object flags.
This is the struct that holds necessary info for a struct.
intptr_t SIGNED_VALUE
A signed integer type that has the same width with VALUE.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.