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/gc.h"
36#include "internal/hash.h"
37#include "internal/object.h"
38#include "internal/proc.h"
39#include "internal/st.h"
40#include "internal/symbol.h"
41#include "internal/thread.h"
42#include "internal/time.h"
43#include "internal/vm.h"
47#include "ruby_assert.h"
80#define SET_DEFAULT(hash, ifnone) ( \
81 FL_UNSET_RAW(hash, RHASH_PROC_DEFAULT), \
82 RHASH_SET_IFNONE(hash, ifnone))
84#define SET_PROC_DEFAULT(hash, proc) set_proc_default(hash, proc)
86#define COPY_DEFAULT(hash, hash2) copy_default(RHASH(hash), RHASH(hash2))
88#define RHASH_TYPE(hash) (FL_TEST_RAW(hash, RHASH_COMPARE_BY_IDENTITY) ? &identhash : &objhash)
91copy_default(
struct RHash *hash,
const struct RHash *hash2)
93 hash->basic.
flags &= ~RHASH_PROC_DEFAULT;
94 hash->basic.
flags |= hash2->basic.
flags & RHASH_PROC_DEFAULT;
110static int ar_compact_table(
VALUE hash);
116 if (!
OBJ_FROZEN(hash) && RHASH_AR_TABLE_P(hash)) {
117 ar_compact_table(hash);
123VALUE rb_cHash_empty_frozen;
126static ID id_hash, id_flatten_bang;
127static ID id_hash_iter_lev;
129#define id_default idDefault
141 if (a == b)
return 0;
146 if (UNDEF_P(a) || UNDEF_P(b))
return -1;
155hash_recursive(
VALUE obj,
VALUE arg,
int recurse)
157 if (recurse)
return INT2FIX(0);
161static long rb_objid_hash(st_index_t index);
164dbl_to_index(
double d)
166 union {
double d; st_index_t i;} u;
172rb_dbl_long_hash(
double d)
175 if (d == 0.0) d = 0.0;
176#if SIZEOF_INT == SIZEOF_VOIDP
179 return rb_objid_hash(dbl_to_index(d));
184any_hash(
VALUE a, st_index_t (*other_func)(
VALUE))
196 hnum = RSHIFT(RSYMBOL(a)->hashval, 1);
203 hnum = rb_objid_hash((st_index_t)a);
209 hval = rb_big_hash(a);
213 hnum = rb_dbl_long_hash(rb_float_value(a));
216 hnum = other_func(a);
229obj_any_hash(
VALUE obj)
235 if (cme && METHOD_ENTRY_BASIC(cme)) {
237 if (cme->def->type == VM_METHOD_TYPE_CFUNC && cme->def->body.cfunc.func == (rb_cfunc_t)rb_obj_hash) {
238 hval = rb_obj_hash(obj);
241 hval = rb_vm_call0(GET_EC(), obj, id_hash, 0, 0, cme, 0);
247 hval = rb_exec_recursive_outer_mid(hash_recursive, obj, 0, id_hash);
254 sign = rb_integer_pack(hval, &ul, 1,
sizeof(ul), 0,
272 return any_hash(a, obj_any_hash);
278 return LONG2FIX(any_hash(obj, obj_any_hash));
287static const uint64_t prime1 = ((uint64_t)0x2e0bb864 << 32) | 0xe9ea7df5;
288static const uint32_t prime2 = 0x830fcab9;
291static inline uint64_t
292mult_and_mix(uint64_t m1, uint64_t m2)
294#if defined HAVE_UINT128_T
295 uint128_t r = (uint128_t) m1 * (uint128_t) m2;
296 return (uint64_t) (r >> 64) ^ (uint64_t) r;
298 uint64_t hm1 = m1 >> 32, hm2 = m2 >> 32;
299 uint64_t lm1 = m1, lm2 = m2;
300 uint64_t v64_128 = hm1 * hm2;
301 uint64_t v32_96 = hm1 * lm2 + lm1 * hm2;
302 uint64_t v1_32 = lm1 * lm2;
304 return (v64_128 + (v32_96 >> 32)) ^ ((v32_96 << 32) + v1_32);
308static inline uint64_t
309key64_hash(uint64_t key, uint32_t seed)
311 return mult_and_mix(key + seed, prime1);
315#define st_index_hash(index) key64_hash(rb_hash_start(index), prime2)
318rb_objid_hash(st_index_t index)
320 return (
long)st_index_hash(index);
326 VALUE object_id = rb_obj_id(obj);
328 object_id = rb_big_hash(object_id);
330#if SIZEOF_LONG == SIZEOF_VOIDP
331 return (st_index_t)st_index_hash((st_index_t)
NUM2LONG(object_id));
332#elif SIZEOF_LONG_LONG == SIZEOF_VOIDP
333 return (st_index_t)st_index_hash((st_index_t)
NUM2LL(object_id));
368rb_obj_hash(
VALUE obj)
370 long hnum = any_hash(obj, objid_hash);
379#define rb_ident_cmp st_numcmp
382rb_ident_hash(st_data_t n)
391 n ^= dbl_to_index(rb_float_value(n));
395 return (st_index_t)st_index_hash((st_index_t)n);
398#define identhash rb_hashtype_ident
404#define RHASH_IDENTHASH_P(hash) FL_TEST_RAW(hash, RHASH_COMPARE_BY_IDENTITY)
405#define RHASH_STRING_KEY_P(hash, key) (!RHASH_IDENTHASH_P(hash) && (rb_obj_class(key) == rb_cString))
407typedef st_index_t st_hash_t;
417static inline unsigned int
418RHASH_AR_TABLE_MAX_BOUND(
VALUE h)
420 size_t usable_space = rb_obj_shape_slot_size(h) -
sizeof(
struct RHash) - offsetof(
ar_table, pairs);
424 return (
unsigned)usable_space;
426 return usable_space <= RHASH_AR_TABLE_MAX_SIZE ? (unsigned)usable_space : RHASH_AR_TABLE_MAX_SIZE;
430#define RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE (RHASH_AR_TABLE_MAX_SIZE + 1)
431#define RHASH_AR_TABLE_MISS RHASH_AR_TABLE_MAX_SIZE
433#define RHASH_AR_TABLE_REF(hash, n) (&RHASH_AR_TABLE(hash)->pairs[n])
434#define RHASH_AR_CLEARED_HINT 0x00
435#define RHASH_AR_SUBSTITUTION_HINT 0x01
437static inline st_hash_t
438ar_do_hash(
VALUE hash, st_data_t key)
440 if (RHASH_IDENTHASH_P(hash)) {
441 return (st_hash_t)rb_ident_hash(key);
443 return (st_hash_t)rb_any_hash(key);
446static inline ar_hint_t
447ar_do_hash_hint(st_hash_t hash_value)
449 ar_hint_t hint = (ar_hint_t)hash_value;
450 return hint == RHASH_AR_CLEARED_HINT ? RHASH_AR_SUBSTITUTION_HINT : hint;
453static inline ar_hint_t
454ar_hint(
VALUE hash,
unsigned int index)
456 return RHASH_AR_TABLE(hash)->ar_hint.ary[index];
460ar_hint_set_hint(
VALUE hash,
unsigned int index, ar_hint_t hint)
462 RHASH_AR_TABLE(hash)->ar_hint.ary[index] = hint;
466ar_hint_set(
VALUE hash,
unsigned int index, st_hash_t hash_value)
468 ar_hint_set_hint(hash, index, ar_do_hash_hint(hash_value));
472ar_clear_entry(
VALUE hash,
unsigned int index)
476 ar_hint_set_hint(hash, index, RHASH_AR_CLEARED_HINT);
480ar_cleared_entry(
VALUE hash,
unsigned int index)
482 return ar_hint(hash, index) == RHASH_AR_CLEARED_HINT;
486ar_set_entry(
VALUE hash,
unsigned int index, st_data_t key, st_data_t val, st_hash_t hash_value)
491 ar_hint_set(hash, index, hash_value);
494#define RHASH_AR_TABLE_SIZE(h) (HASH_ASSERT(RHASH_AR_TABLE_P(h)), \
495 RHASH_AR_TABLE_SIZE_RAW(h))
497#define HASH_ASSERT(expr) RUBY_ASSERT_MESG_WHEN(HASH_DEBUG, expr, #expr)
500#define hash_verify(hash) hash_verify_(hash, __FILE__, __LINE__)
503hash_verify_(
VALUE hash,
const char *file,
int line)
507 if (RHASH_AR_TABLE_P(hash)) {
508 unsigned i, n = 0, bound = RHASH_AR_TABLE_BOUND(hash);
510 for (i=0; i<bound; i++) {
512 if (!ar_cleared_entry(hash, i)) {
516 HASH_ASSERT(!UNDEF_P(k));
517 HASH_ASSERT(!UNDEF_P(v));
521 if (n != RHASH_AR_TABLE_SIZE(hash)) {
522 rb_bug(
"n:%u, RHASH_AR_TABLE_SIZE:%u", n, RHASH_AR_TABLE_SIZE(hash));
526 HASH_ASSERT(RHASH_ST_TABLE(hash) != NULL);
527 HASH_ASSERT(RHASH_AR_TABLE_SIZE_RAW(hash) == 0);
528 HASH_ASSERT(RHASH_AR_TABLE_BOUND_RAW(hash) == 0);
529 HASH_ASSERT(!!RHASH_IDENTHASH_P(hash) == (RHASH_ST_TABLE(hash)->
type == &identhash));
536#define hash_verify(h) ((void)0)
540RHASH_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)
549hash_st_table_init(
VALUE hash, st_index_t size)
552 st_init_existing_table_with_size(RHASH_ST_TABLE(hash), RHASH_TYPE(hash), size);
553 RHASH_SET_ST_FLAG(hash);
559 HASH_ASSERT(st != NULL);
560 RHASH_SET_ST_FLAG(hash);
562 *RHASH_ST_TABLE(hash) = *st;
566RHASH_AR_TABLE_BOUND_SET(
VALUE h, st_index_t n)
568 HASH_ASSERT(RHASH_AR_TABLE_P(h));
569 HASH_ASSERT(n <= RHASH_AR_TABLE_MAX_BOUND(h));
571 RBASIC(h)->flags &= ~RHASH_AR_TABLE_BOUND_MASK;
572 RBASIC(h)->flags |= n << RHASH_AR_TABLE_BOUND_SHIFT;
576RHASH_AR_TABLE_SIZE_SET(
VALUE h, st_index_t n)
578 HASH_ASSERT(RHASH_AR_TABLE_P(h));
579 HASH_ASSERT(n <= RHASH_AR_TABLE_MAX_BOUND(h));
581 RBASIC(h)->flags &= ~RHASH_AR_TABLE_SIZE_MASK;
582 RBASIC(h)->flags |= n << RHASH_AR_TABLE_SIZE_SHIFT;
586HASH_AR_TABLE_SIZE_ADD(
VALUE h, st_index_t n)
588 HASH_ASSERT(RHASH_AR_TABLE_P(h));
590 RHASH_AR_TABLE_SIZE_SET(h, RHASH_AR_TABLE_SIZE(h) + n);
595#define RHASH_AR_TABLE_SIZE_INC(h) HASH_AR_TABLE_SIZE_ADD(h, 1)
598RHASH_AR_TABLE_SIZE_DEC(
VALUE h)
600 HASH_ASSERT(RHASH_AR_TABLE_P(h));
601 int new_size = RHASH_AR_TABLE_SIZE(h) - 1;
604 RHASH_AR_TABLE_SIZE_SET(h, new_size);
607 RHASH_AR_TABLE_SIZE_SET(h, 0);
608 RHASH_AR_TABLE_BOUND_SET(h, 0);
614RHASH_AR_TABLE_CLEAR(
VALUE h)
616 RBASIC(h)->flags &= ~RHASH_AR_TABLE_SIZE_MASK;
617 RBASIC(h)->flags &= ~RHASH_AR_TABLE_BOUND_MASK;
619 memset(RHASH_AR_TABLE(h), 0, rb_obj_shape_slot_size(h) -
sizeof(
struct RHash));
627 if (RHASH_IDENTHASH_P(hash)) {
630 return rb_any_cmp(x, y) == 0;
635#define AR_HINT_BASE_MASK 0x101010101010101
636#define AR_HINT_NORMALIZE_MASK 0x7F7F7F7F7F7F7F7F
637#ifdef WORDS_BIGENDIAN
638#define AR_HINT_FIND_FIRST_ZERO_BYTE(x) (nlz_int64(x) / CHAR_BIT)
640#define AR_HINT_FIND_FIRST_ZERO_BYTE(x) (ntz_int64(x) / CHAR_BIT)
643#define AR_HINT_BASE_MASK 0x1010101
644#define AR_HINT_NORMALIZE_MASK 0x7F7F7F7F
645#ifdef WORDS_BIGENDIAN
646#define AR_HINT_FIND_FIRST_ZERO_BYTE(x) (nlz_int32(x) / CHAR_BIT)
648#define AR_HINT_FIND_FIRST_ZERO_BYTE(x) (ntz_int32(x) / CHAR_BIT)
652static inline unsigned int
653ar_hint_first_match(ar_hint_t needle,
VALUE haystack)
657 VALUE search_mask = (
VALUE)AR_HINT_BASE_MASK * needle;
658 VALUE matches = haystack ^ search_mask;
661 matches = ~((((matches & AR_HINT_NORMALIZE_MASK) + AR_HINT_NORMALIZE_MASK) | matches) | AR_HINT_NORMALIZE_MASK);
662 unsigned index = AR_HINT_FIND_FIRST_ZERO_BYTE(matches);
670ar_find_entry_hint(
VALUE hash, ar_hint_t hint, st_data_t key)
672 unsigned first_match = ar_hint_first_match(hint, RHASH_AR_TABLE(hash)->ar_hint.word);
674 if (LIKELY(first_match >= RHASH_AR_TABLE_BOUND(hash))) {
675 RB_DEBUG_COUNTER_INC(artable_hint_notfound);
676 return RHASH_AR_TABLE_MISS;
679 RUBY_ASSERT(RHASH_AR_TABLE(hash)->ar_hint.ary[first_match] == hint);
680 int eq = ar_equal(hash, key, RHASH_AR_TABLE_REF(hash, first_match)->key);
681 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
682 return RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE;
685 RB_DEBUG_COUNTER_INC(artable_hint_hit);
692 for (
unsigned i = first_match + 1; i < RHASH_AR_TABLE_BOUND(hash); i++) {
693 const ar_hint_t *hints = RHASH_AR_TABLE(hash)->ar_hint.ary;
694 if (UNLIKELY(hints[i] == hint)) {
695 eq = ar_equal(hash, key, RHASH_AR_TABLE_REF(hash, i)->key);
696 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
697 return RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE;
700 RB_DEBUG_COUNTER_INC(artable_hint_hit);
704 RB_DEBUG_COUNTER_INC(artable_hint_miss);
710 RB_DEBUG_COUNTER_INC(artable_hint_notfound);
711 return RHASH_AR_TABLE_MISS;
715ar_find_entry(
VALUE hash, st_hash_t hash_value, st_data_t key)
717 ar_hint_t hint = ar_do_hash_hint(hash_value);
718 return ar_find_entry_hint(hash, hint, key);
722hash_ar_free_and_clear_table(
VALUE hash)
724 RHASH_AR_TABLE_CLEAR(hash);
726 HASH_ASSERT(RHASH_AR_TABLE_SIZE(hash) == 0);
727 HASH_ASSERT(RHASH_AR_TABLE_BOUND(hash) == 0);
730void rb_st_add_direct_with_hash(
st_table *tab, st_data_t key, st_data_t value, st_hash_t hash);
732enum ar_each_key_type {
739ar_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)
741 for (
int i = 0; i < max; i++) {
745 case ar_each_key_copy:
746 dst_keys[i] = pair->key;
748 case ar_each_key_cmp:
749 if (dst_keys[i] != pair->key)
return 1;
751 case ar_each_key_insert:
752 if (UNDEF_P(pair->key))
continue;
753 rb_st_add_direct_with_hash(new_tab, pair->key, pair->val, hashes[i]);
762ar_force_convert_table(
VALUE hash,
const char *file,
int line)
764 if (RHASH_ST_TABLE_P(hash)) {
765 return RHASH_ST_TABLE(hash);
768 ar_table *ar = RHASH_AR_TABLE(hash);
769 st_hash_t hashes[RHASH_AR_TABLE_MAX_SIZE];
770 unsigned int bound, size;
777 st_data_t keys[RHASH_AR_TABLE_MAX_SIZE];
778 bound = RHASH_AR_TABLE_BOUND(hash);
779 size = RHASH_AR_TABLE_SIZE(hash);
780 ar_each_key(ar, bound, ar_each_key_copy, keys, NULL, NULL);
782 for (
unsigned int i = 0; i < bound; i++) {
784 hashes[i] = UNDEF_P(keys[i]) ? 0 : ar_do_hash(hash, keys[i]);
788 if (UNLIKELY(!RHASH_AR_TABLE_P(hash)))
return RHASH_ST_TABLE(hash);
789 if (UNLIKELY(RHASH_AR_TABLE_BOUND(hash) != bound))
continue;
790 if (UNLIKELY(ar_each_key(ar, bound, ar_each_key_cmp, keys, NULL, NULL)))
continue;
798 st_init_existing_table_with_size(new_tab,
type, size);
799 ar_each_key(ar, bound, ar_each_key_insert, NULL, new_tab, hashes);
800 hash_ar_free_and_clear_table(hash);
801 rb_hash_st_table_set(hash, new_tab);
802 return RHASH_ST_TABLE(hash);
812 const unsigned src_bound = RHASH_AR_TABLE_BOUND(src);
813 const unsigned src_size = RHASH_AR_TABLE_SIZE(src);
816 for (
unsigned i = 0; i < src_bound; i++) {
817 if (!ar_cleared_entry(src, i)) {
818 dst_pairs[j] = src_pairs[i];
819 ar_hint_set_hint(dst, j, (st_hash_t)ar_hint(src, i));
823 RHASH_AR_TABLE_BOUND_SET(dst, src_size);
824 RHASH_AR_TABLE_SIZE_SET(dst, src_size);
829ar_compact_table(
VALUE hash)
831 const unsigned bound = RHASH_AR_TABLE_BOUND(hash);
832 const unsigned size = RHASH_AR_TABLE_SIZE(hash);
841 for (i=0; i<bound; i++) {
842 if (ar_cleared_entry(hash, i)) {
844 for (; j<bound; j++) {
845 if (!ar_cleared_entry(hash, j)) {
847 ar_hint_set_hint(hash, i, (st_hash_t)ar_hint(hash, j));
848 ar_clear_entry(hash, j);
859 HASH_ASSERT(i<=bound);
861 RHASH_AR_TABLE_BOUND_SET(hash, size);
868ar_add_direct_with_hash(
VALUE hash, st_data_t key, st_data_t val, st_hash_t hash_value)
870 unsigned bin = RHASH_AR_TABLE_BOUND(hash);
872 if (RHASH_AR_TABLE_SIZE(hash) >= RHASH_AR_TABLE_MAX_BOUND(hash)) {
876 if (UNLIKELY(bin >= RHASH_AR_TABLE_MAX_BOUND(hash))) {
877 bin = ar_compact_table(hash);
879 HASH_ASSERT(bin < RHASH_AR_TABLE_MAX_BOUND(hash));
881 ar_set_entry(hash, bin, key, val, hash_value);
882 RHASH_AR_TABLE_BOUND_SET(hash, bin+1);
883 RHASH_AR_TABLE_SIZE_INC(hash);
889ensure_ar_table(
VALUE hash)
891 if (!RHASH_AR_TABLE_P(hash)) {
892 rb_raise(
rb_eRuntimeError,
"hash representation was changed during iteration");
897ar_general_foreach(
VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg)
899 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
900 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
902 for (i = 0; i < bound; i++) {
903 if (ar_cleared_entry(hash, i))
continue;
906 st_data_t key = (st_data_t)pair->key;
907 st_data_t val = (st_data_t)pair->val;
908 enum st_retval retval = (*func)(key, val, arg, 0);
909 ensure_ar_table(hash);
920 (*replace)(&key, &val, arg, TRUE);
923 HASH_ASSERT(pair == RHASH_AR_TABLE_REF(hash, i));
925 pair->key = (
VALUE)key;
926 pair->val = (
VALUE)val;
930 ar_clear_entry(hash, i);
931 RHASH_AR_TABLE_SIZE_DEC(hash);
940ar_foreach_with_replace(
VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg)
942 return ar_general_foreach(hash, func, replace, arg);
946 st_foreach_callback_func *func;
951apply_functor(st_data_t k, st_data_t v, st_data_t d,
int _)
953 const struct functor *f = (
void *)d;
954 return f->func(k, v, f->arg);
958ar_foreach(
VALUE hash, st_foreach_callback_func *func, st_data_t arg)
960 const struct functor f = { func, arg };
961 return ar_general_foreach(hash, apply_functor, NULL, (st_data_t)&f);
965ar_foreach_check(
VALUE hash, st_foreach_check_callback_func *func, st_data_t arg,
968 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
969 unsigned i, ret = 0, bound = RHASH_AR_TABLE_BOUND(hash);
970 enum st_retval retval;
975 for (i = 0; i < bound; i++) {
976 if (ar_cleared_entry(hash, i))
continue;
978 pair = RHASH_AR_TABLE_REF(hash, i);
980 hint = ar_hint(hash, i);
982 retval = (*func)(key, pair->val, arg, 0);
983 ensure_ar_table(hash);
988 pair = RHASH_AR_TABLE_REF(hash, i);
989 if (pair->key == never)
break;
990 ret = ar_find_entry_hint(hash, hint, key);
991 if (UNLIKELY(ret == RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE)) {
992 ensure_ar_table(hash);
994 if (ret == RHASH_AR_TABLE_MISS) {
995 (*func)(0, 0, arg, 1);
1005 if (!ar_cleared_entry(hash, i)) {
1006 ar_clear_entry(hash, i);
1007 RHASH_AR_TABLE_SIZE_DEC(hash);
1018ar_update(
VALUE hash, st_data_t key,
1019 st_update_callback_func *func, st_data_t arg)
1021 int retval, existing;
1022 unsigned bin = RHASH_AR_TABLE_MISS;
1023 st_data_t value = 0, old_key;
1024 st_hash_t hash_value = ar_do_hash(hash, key);
1026 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1031 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
1032 bin = ar_find_entry(hash, hash_value, key);
1033 if (UNLIKELY(bin == RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE)) {
1036 existing = (bin != RHASH_AR_TABLE_MISS);
1048 retval = (*func)(&key, &value, arg, existing);
1050 ensure_ar_table(hash);
1055 if (ar_add_direct_with_hash(hash, key, value, hash_value)) {
1061 if (old_key != key) {
1069 ar_clear_entry(hash, bin);
1070 RHASH_AR_TABLE_SIZE_DEC(hash);
1078ar_insert_direct(
VALUE hash, st_data_t key, st_data_t value, st_hash_t hash_value)
1080 unsigned bin = RHASH_AR_TABLE_BOUND(hash);
1081 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1086 bin = ar_find_entry(hash, hash_value, key);
1087 if (UNLIKELY(bin == RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE)) {
1091 if (bin == RHASH_AR_TABLE_MISS) {
1092 if (RHASH_AR_TABLE_SIZE(hash) == RHASH_AR_TABLE_MAX_BOUND(hash)) {
1096 bin = ar_compact_table(hash);
1097 HASH_ASSERT(bin < RHASH_AR_TABLE_MAX_BOUND(hash));
1099 ar_set_entry(hash, bin, key, value, hash_value);
1100 RHASH_AR_TABLE_BOUND_SET(hash, bin+1);
1101 RHASH_AR_TABLE_SIZE_INC(hash);
1105 RHASH_AR_TABLE_REF(hash, bin)->val = value;
1111ar_insert(
VALUE hash, st_data_t key, st_data_t value)
1113 st_hash_t hash_value = ar_do_hash(hash, key);
1114 return ar_insert_direct(hash, key, value, hash_value);
1118ar_lookup(
VALUE hash, st_data_t key, st_data_t *value)
1120 if (RHASH_AR_TABLE_SIZE(hash) == 0) {
1124 st_hash_t hash_value = ar_do_hash(hash, key);
1125 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1127 return st_lookup(RHASH_ST_TABLE(hash), key, value);
1129 unsigned bin = ar_find_entry(hash, hash_value, key);
1131 if (UNLIKELY(bin == RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE)) {
1132 return st_lookup(RHASH_ST_TABLE(hash), key, value);
1135 if (bin == RHASH_AR_TABLE_MISS) {
1139 HASH_ASSERT(bin < RHASH_AR_TABLE_MAX_BOUND(hash));
1140 if (value != NULL) {
1141 *value = RHASH_AR_TABLE_REF(hash, bin)->val;
1148ar_delete(
VALUE hash, st_data_t *key, st_data_t *value)
1151 st_hash_t hash_value = ar_do_hash(hash, *key);
1153 if (UNLIKELY(!RHASH_AR_TABLE_P(hash))) {
1155 return st_delete(RHASH_ST_TABLE(hash), key, value);
1158 bin = ar_find_entry(hash, hash_value, *key);
1159 if (UNLIKELY(bin == RHASH_AR_TABLE_CONVERTED_TO_ST_TABLE)) {
1160 return st_delete(RHASH_ST_TABLE(hash), key, value);
1163 if (bin == RHASH_AR_TABLE_MISS) {
1164 if (value != 0) *value = 0;
1172 ar_clear_entry(hash, bin);
1173 RHASH_AR_TABLE_SIZE_DEC(hash);
1179ar_shift(
VALUE hash, st_data_t *key, st_data_t *value)
1181 if (RHASH_AR_TABLE_SIZE(hash) > 0) {
1182 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
1184 for (i = 0; i < bound; i++) {
1185 if (!ar_cleared_entry(hash, i)) {
1187 if (value != 0) *value = pair->val;
1189 ar_clear_entry(hash, i);
1190 RHASH_AR_TABLE_SIZE_DEC(hash);
1195 if (value != NULL) *value = 0;
1200ar_keys(
VALUE hash, st_data_t *keys, st_index_t size)
1202 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
1203 st_data_t *keys_start = keys, *keys_end = keys + size;
1205 for (i = 0; i < bound; i++) {
1206 if (keys == keys_end) {
1210 if (!ar_cleared_entry(hash, i)) {
1211 *keys++ = RHASH_AR_TABLE_REF(hash, i)->key;
1216 return keys - keys_start;
1220ar_values(
VALUE hash, st_data_t *values, st_index_t size)
1222 unsigned i, bound = RHASH_AR_TABLE_BOUND(hash);
1223 st_data_t *values_start = values, *values_end = values + size;
1225 for (i = 0; i < bound; i++) {
1226 if (values == values_end) {
1230 if (!ar_cleared_entry(hash, i)) {
1231 *values++ = RHASH_AR_TABLE_REF(hash, i)->val;
1236 return values - values_start;
1243 ar_table *new_tab = RHASH_AR_TABLE(hash1);
1245 unsigned int bound = RHASH_AR_TABLE_BOUND(hash2);
1246 unsigned int size = RHASH_AR_TABLE_SIZE(hash2);
1247 if (UNLIKELY(bound != size)) {
1248 ar_compact_into(hash1, hash2);
1252 ar_table *old_tab = RHASH_AR_TABLE(hash2);
1253 new_tab->ar_hint.word = old_tab->ar_hint.word;
1255 RHASH_AR_TABLE_BOUND_SET(hash1, bound);
1256 RHASH_AR_TABLE_SIZE_SET(hash1, RHASH_AR_TABLE_SIZE(hash2));
1257 rb_gc_writebarrier_remember(hash1);
1265 if (RHASH_AR_TABLE(hash) != NULL) {
1266 RHASH_AR_TABLE_SIZE_SET(hash, 0);
1267 RHASH_AR_TABLE_BOUND_SET(hash, 0);
1270 HASH_ASSERT(RHASH_AR_TABLE_SIZE(hash) == 0);
1271 HASH_ASSERT(RHASH_AR_TABLE_BOUND(hash) == 0);
1276hash_st_free(
VALUE hash)
1278 HASH_ASSERT(RHASH_ST_TABLE_P(hash));
1280 rb_st_free_embedded_table(RHASH_ST_TABLE(hash));
1284hash_st_free_and_clear_table(
VALUE hash)
1287 RHASH_ST_CLEAR(hash);
1291rb_hash_free(
VALUE hash)
1293 if (RHASH_ST_TABLE_P(hash)) {
1298typedef int st_foreach_func(st_data_t, st_data_t, st_data_t);
1302 st_foreach_func *func;
1307foreach_safe_i(st_data_t key, st_data_t value, st_data_t args,
int error)
1312 if (error)
return ST_STOP;
1313 status = (*arg->func)(key, value, arg->arg);
1314 if (status == ST_CONTINUE) {
1326 arg.func = (st_foreach_func *)func;
1328 if (st_foreach_check(table, foreach_safe_i, (st_data_t)&arg, 0)) {
1337 rb_foreach_func *func;
1342hash_iter_status_check(
int status)
1357hash_ar_foreach_iter(st_data_t key, st_data_t value, st_data_t argp,
int error)
1361 if (error)
return ST_STOP;
1363 int status = (*arg->func)((
VALUE)key, (
VALUE)value, arg->arg);
1365 return hash_iter_status_check(status);
1369hash_foreach_iter(st_data_t key, st_data_t value, st_data_t argp,
int error)
1373 if (error)
return ST_STOP;
1375 int status = (*arg->func)((
VALUE)key, (
VALUE)value, arg->arg);
1377 return hash_iter_status_check(status);
1381iter_lev_in_ivar(
VALUE hash)
1386 HASH_ASSERT(lev >= 0);
1387 return (
unsigned long)lev;
1393iter_lev_in_ivar_set(
VALUE hash,
unsigned long lev)
1395 HASH_ASSERT(lev >= RHASH_LEV_MAX);
1397 rb_ivar_set_internal(hash, id_hash_iter_lev,
LONG2FIX((
long)lev));
1400static inline unsigned long
1401iter_lev_in_flags(
VALUE hash)
1403 return (
unsigned long)((
RBASIC(hash)->flags >> RHASH_LEV_SHIFT) & RHASH_LEV_MAX);
1407iter_lev_in_flags_set(
VALUE hash,
unsigned long lev)
1409 HASH_ASSERT(lev <= RHASH_LEV_MAX);
1410 RBASIC(hash)->flags = ((
RBASIC(hash)->flags & ~RHASH_LEV_MASK) | ((
VALUE)lev << RHASH_LEV_SHIFT));
1414hash_iterating_p(
VALUE hash)
1416 return iter_lev_in_flags(hash) > 0;
1420hash_iter_lev_inc(
VALUE hash)
1422 unsigned long lev = iter_lev_in_flags(hash);
1423 if (lev == RHASH_LEV_MAX) {
1424 lev = iter_lev_in_ivar(hash) + 1;
1431 iter_lev_in_flags_set(hash, lev);
1432 if (lev < RHASH_LEV_MAX)
return;
1434 iter_lev_in_ivar_set(hash, lev);
1438hash_iter_lev_dec(
VALUE hash)
1440 unsigned long lev = iter_lev_in_flags(hash);
1441 if (lev == RHASH_LEV_MAX) {
1442 lev = iter_lev_in_ivar(hash);
1443 if (lev > RHASH_LEV_MAX) {
1444 iter_lev_in_ivar_set(hash, lev-1);
1447 rb_attr_delete(hash, id_hash_iter_lev);
1449 else if (lev == 0) {
1452 iter_lev_in_flags_set(hash, lev - 1);
1456hash_foreach_ensure(
VALUE hash)
1458 hash_iter_lev_dec(hash);
1464rb_hash_stlike_foreach(
VALUE hash, st_foreach_callback_func *func, st_data_t arg)
1466 if (RHASH_AR_TABLE_P(hash)) {
1467 return ar_foreach(hash, func, arg);
1470 return st_foreach(RHASH_ST_TABLE(hash), func, arg);
1476rb_hash_stlike_foreach_with_replace(
VALUE hash, st_foreach_check_callback_func *func, st_update_callback_func *replace, st_data_t arg)
1478 if (RHASH_AR_TABLE_P(hash)) {
1479 return ar_foreach_with_replace(hash, func, replace, arg);
1482 return st_foreach_with_replace(RHASH_ST_TABLE(hash), func, replace, arg);
1487hash_foreach_call(
VALUE arg)
1491 if (RHASH_AR_TABLE_P(hash)) {
1492 ret = ar_foreach_check(hash, hash_ar_foreach_iter,
1493 (st_data_t)arg, (st_data_t)
Qundef);
1495 else if (RHASH_ST_TABLE_P(hash)) {
1496 ret = st_foreach_check(RHASH_ST_TABLE(hash), hash_foreach_iter,
1497 (st_data_t)arg, (st_data_t)
Qundef);
1500 rb_raise(
rb_eRuntimeError,
"ret: %d, hash modified during iteration", ret);
1506rb_hash_foreach(
VALUE hash, rb_foreach_func *func,
VALUE farg)
1510 if (RHASH_TABLE_EMPTY_P(hash))
1513 arg.func = (rb_foreach_func *)func;
1516 hash_foreach_call((
VALUE)&arg);
1519 hash_iter_lev_inc(hash);
1520 rb_ensure(hash_foreach_call, (
VALUE)&arg, hash_foreach_ensure, hash);
1525void rb_st_compact_table(
st_table *tab);
1528compact_after_delete(
VALUE hash)
1530 if (!hash_iterating_p(hash) && RHASH_ST_TABLE_P(hash)) {
1531 rb_st_compact_table(RHASH_ST_TABLE(hash));
1536hash_slot_size(
size_t capa,
bool frozen)
1538 if (
capa <= RHASH_AR_TABLE_MAX_SIZE) {
1539 const size_t ar_size = RHASH_AR_SLOT_SIZE(
capa);
1542 if (frozen || ar_size >= RHASH_ST_SLOT_SIZE) {
1547 return RHASH_ST_SLOT_SIZE;
1551hash_alloc(
VALUE klass,
VALUE flags,
VALUE ifnone,
size_t size,
bool frozen)
1553 VALUE hash = rb_newobj_of(klass,
T_HASH | flags, hash_slot_size(size, frozen));
1554 rb_hash_set_ifnone(hash, ifnone);
1557 if (hash_slot_size(size, frozen) >=
sizeof(
struct RHash) +
sizeof(
st_table)) {
1558 RHASH_ST_TABLE(hash)->num_entries = 0;
1559 RHASH_ST_TABLE(hash)->entries = NULL;
1567hash_init_capa(
VALUE hash,
size_t size)
1569 if (size > RHASH_AR_TABLE_MAX_SIZE) {
1570 hash_st_table_init(hash, size);
1573 RUBY_ASSERT(RHASH_AR_TABLE_MAX_BOUND(hash) >= size);
1579hash_hidden_new(
size_t size)
1581 return hash_init_capa(hash_alloc(0, 0,
Qnil, size,
false), size);
1585hash_alloc_capa(
VALUE klass,
size_t size)
1587 return hash_alloc(klass, 0,
Qnil, size,
false);
1593 return hash_alloc_capa(klass,
RHASH_SIZE(src));
1597empty_hash_alloc(
VALUE klass)
1599 RUBY_DTRACE_CREATE_HOOK(HASH, 0);
1601 return hash_alloc_capa(klass, 0);
1607 if (rb_hash_compare_by_id_p(basis)) {
1608 return rb_hash_compare_by_id(hash);
1616 return hash_init_capa(hash_alloc_capa(klass,
capa),
capa);
1623 rb_raise(rb_eArgError,
"negative hash size (or size too big)");
1631 return rb_hash_new_capa(0);
1635rb_hash_alloc_fixed_size(
VALUE klass, st_index_t size)
1637 return hash_init_capa(hash_alloc(klass, 0,
Qnil, size,
true), size);
1641ar_add_direct_i(st_data_t key, st_data_t value, st_data_t hash_value, st_data_t arg)
1644 ar_insert_direct(ret, key, value, hash_value);
1652 if (RHASH_ST_TABLE_P(ret)) {
1653 RUBY_ASSERT(RHASH_ST_TABLE(ret)->entries == NULL);
1654 RHASH_UNSET_ST_FLAG(ret);
1657 bool compare_by_id = RHASH_IDENTHASH_P(hash);
1659 if (compare_by_id) {
1660 rb_gc_register_pinning_obj(ret);
1667 if (RHASH_AR_TABLE_MAX_BOUND(ret) <
RHASH_SIZE(hash)) {
1668 RHASH_SET_ST_FLAG(ret);
1671 if (RHASH_AR_TABLE_P(hash)) {
1672 if (RHASH_AR_TABLE_P(ret)) {
1676 st_table *tab = RHASH_ST_TABLE(ret);
1678 st_init_existing_table_with_size(RHASH_ST_TABLE(ret),
1679 compare_by_id ? &identhash : &objhash,
1682 int bound = RHASH_AR_TABLE_BOUND(hash);
1683 for (
int i = 0; i < bound; i++) {
1684 if (ar_cleared_entry(hash, i))
continue;
1687 st_add_direct(tab, pair->key, pair->val);
1694 if (RHASH_AR_TABLE_P(ret)) {
1695 rb_st_foreach_with_hash(RHASH_ST_TABLE(hash), ar_add_direct_i, (st_data_t)ret);
1698 st_replace(RHASH_ST_TABLE(ret), RHASH_ST_TABLE(hash));
1699 rb_gc_writebarrier_remember(ret);
1706hash_dup_with_compare_by_id(
VALUE hash)
1709 if (RHASH_ST_TABLE_P(hash)) {
1710 RHASH_SET_ST_FLAG(dup);
1713 return hash_copy(dup, hash);
1720 return hash_copy(dup, hash);
1727 if (
capa > RHASH_AR_TABLE_MAX_SIZE) {
1728 RHASH_SET_ST_FLAG(ret);
1729 RHASH_ST_CLEAR(ret);
1734 hash_copy(ret, hash);
1739rb_hash_dup_capa(
VALUE hash,
size_t capa)
1752 return rb_hash_dup_capa(hash,
RHASH_SIZE(hash));
1756rb_hash_resurrect(
VALUE hash)
1763rb_zjit_hash_new_size(
VALUE *flags_out,
size_t size)
1767 return hash_slot_size(size,
false);
1771rb_zjit_hash_dup_can_fastpath(
VALUE hash,
size_t *alloc_size_out,
VALUE *flags_out,
VALUE *ifnone_out,
long *bound_out)
1773 if (!RHASH_AR_TABLE_P(hash))
return false;
1774 if (rb_hash_compare_by_id_p(hash))
return false;
1776 const unsigned int bound = RHASH_AR_TABLE_BOUND(hash);
1778 *alloc_size_out = hash_slot_size(bound,
false);
1780 | ((
VALUE)RHASH_AR_TABLE_SIZE(hash) << RHASH_AR_TABLE_SIZE_SHIFT)
1781 | ((
VALUE)bound << RHASH_AR_TABLE_BOUND_SHIFT);
1783 *bound_out = (long)bound;
1789rb_hash_modify_check(
VALUE hash)
1791 rb_check_frozen(hash);
1795rb_hash_tbl_raw(
VALUE hash,
const char *file,
int line)
1797 return ar_force_convert_table(hash, file, line);
1801rb_hash_tbl(
VALUE hash,
const char *file,
int line)
1804 return rb_hash_tbl_raw(hash, file, line);
1808rb_hash_modify(
VALUE hash)
1810 rb_hash_modify_check(hash);
1813NORETURN(
static void no_new_key(
void));
1817 rb_raise(
rb_eRuntimeError,
"can't add a new key into hash during iteration");
1825#define NOINSERT_UPDATE_CALLBACK(func) \
1827func##_noinsert(st_data_t *key, st_data_t *val, st_data_t arg, int existing) \
1829 if (!existing) no_new_key(); \
1830 return func(key, val, (struct update_arg *)arg, existing); \
1834func##_insert(st_data_t *key, st_data_t *val, st_data_t arg, int existing) \
1836 return func(key, val, (struct update_arg *)arg, existing); \
1841 st_update_callback_func *func;
1847typedef int (*tbl_update_func)(st_data_t *, st_data_t *, st_data_t, int);
1850rb_hash_stlike_update(
VALUE hash, st_data_t key, st_update_callback_func *func, st_data_t arg)
1852 if (RHASH_AR_TABLE_P(hash)) {
1853 int result = ar_update(hash, key, func, arg);
1855 ar_force_convert_table(hash, __FILE__, __LINE__);
1862 return st_update(RHASH_ST_TABLE(hash), key, func, arg);
1866tbl_update_modify(st_data_t *key, st_data_t *val, st_data_t arg,
int existing)
1869 st_data_t old_key = *key;
1870 st_data_t old_value = *val;
1871 VALUE hash = p->hash;
1872 int ret = (p->func)(key, val, arg, existing);
1877 if (!existing || *key != old_key || *val != old_value) {
1878 rb_hash_modify(hash);
1885 rb_hash_modify(hash);
1893tbl_update(
VALUE hash,
VALUE key, tbl_update_func func, st_data_t optional_arg)
1896 .arg = optional_arg,
1903 int ret = rb_hash_stlike_update(hash, key, tbl_update_modify, (st_data_t)&arg);
1912#define UPDATE_CALLBACK(iter_p, func) ((iter_p) ? func##_noinsert : func##_insert)
1914#define RHASH_UPDATE_ITER(h, iter_p, key, func, a) do { \
1915 tbl_update((h), (key), UPDATE_CALLBACK(iter_p, func), (st_data_t)(a)); \
1918#define RHASH_UPDATE(hash, key, func, arg) \
1919 RHASH_UPDATE_ITER(hash, hash_iterating_p(hash), key, func, arg)
1927 if (n != 2 && (n >= 0 || n < -3)) {
1928 if (n < 0) n = -n-1;
1929 rb_raise(
rb_eTypeError,
"default_proc takes two arguments (2 for %d)", n);
1940 rb_hash_modify(hash);
1942 if (capa_value !=
INT2FIX(0)) {
1944 if (
capa > 0 && RHASH_AR_TABLE_P(hash) &&
RHASH_SIZE(hash) == 0 &&
1945 (
unsigned long)
capa > RHASH_AR_TABLE_MAX_BOUND(hash)) {
1946 hash_st_table_init(hash,
capa);
1950 if (!
NIL_P(block)) {
1951 if (ifnone_unset !=
Qtrue) {
1955 SET_PROC_DEFAULT(hash, block);
1967static VALUE hash_new_with_bulk_insert(
VALUE klass,
long argc,
const VALUE *argv);
2007rb_hash_s_create(
int argc,
VALUE *argv,
VALUE klass)
2012 tmp = rb_hash_s_try_convert(
Qnil, argv[0]);
2015 return hash_new_capa(klass, 0);
2018 if (rb_hash_compare_by_id_p(tmp)) {
2022 tmp = rb_hash_to_a(tmp);
2025 hash = hash_alloc_capa(klass,
RHASH_SIZE(tmp));
2026 return hash_copy(hash, tmp);
2035 return hash_new_capa(klass, 0);
2046 rb_raise(rb_eArgError,
"wrong element type %s at %ld (expected array)",
2047 rb_builtin_class_name(e), i);
2053 hash = hash_new_capa(klass,
RARRAY_LEN(tmp));
2056 hash = hash_new_capa(klass,
RARRAY_LEN(tmp) / 1);
2063 rb_raise(rb_eArgError,
"invalid number of elements (%ld for 1..2)",
2070 rb_hash_aset(hash, key, val);
2076 if (argc % 2 != 0) {
2077 rb_raise(rb_eArgError,
"odd number of arguments for Hash");
2080 hash = hash_new_with_bulk_insert(klass, argc, argv);
2086rb_to_hash_type(
VALUE hash)
2088 return rb_convert_type_with_id(hash,
T_HASH,
"Hash", idTo_hash);
2090#define to_hash rb_to_hash_type
2095 return rb_check_convert_type_with_id(hash,
T_HASH,
"Hash", idTo_hash);
2111rb_hash_s_try_convert(
VALUE dummy,
VALUE hash)
2113 return rb_check_hash_type(hash);
2136rb_hash_s_ruby2_keywords_hash_p(
VALUE dummy,
VALUE hash)
2139 return RBOOL(RHASH(hash)->basic.flags & RHASH_PASS_AS_KEYWORDS);
2162rb_hash_s_ruby2_keywords_hash(
VALUE dummy,
VALUE hash)
2165 VALUE tmp = rb_hash_dup(hash);
2167 rb_hash_compare_by_id(tmp);
2169 RHASH(tmp)->basic.flags |= RHASH_PASS_AS_KEYWORDS;
2181 if (RHASH_AR_TABLE_P(arg)) {
2182 ar_insert(arg, (st_data_t)key, (st_data_t)value);
2185 st_insert(RHASH_ST_TABLE(arg), (st_data_t)key, (st_data_t)value);
2207rb_hash_rehash(
VALUE hash)
2212 if (hash_iterating_p(hash)) {
2215 rb_hash_modify_check(hash);
2216 if (RHASH_AR_TABLE_P(hash)) {
2218 if (RHASH_IDENTHASH_P(hash)) {
2221 rb_hash_foreach(hash, rb_hash_rehash_i, (
VALUE)tmp);
2223 hash_ar_free_and_clear_table(hash);
2226 else if (RHASH_ST_TABLE_P(hash)) {
2227 st_table *old_tab = RHASH_ST_TABLE(hash);
2228 tmp = hash_alloc_capa(0, 0);
2229 if (old_tab->type == &identhash) {
2233 hash_st_table_init(tmp, old_tab->num_entries);
2234 RHASH_ST_TABLE(tmp)->type = old_tab->type;
2235 tbl = RHASH_ST_TABLE(tmp);
2237 rb_hash_foreach(hash, rb_hash_rehash_i, (
VALUE)tmp);
2240 rb_hash_st_table_set(hash, tbl);
2241 RHASH_ST_CLEAR(tmp);
2250 VALUE args[2] = {hash, key};
2255rb_hash_default_unredefined(
VALUE hash)
2259 return !!BASIC_OP_UNREDEFINED_P(BOP_DEFAULT, HASH_REDEFINED_OP_FLAG);
2271 if (LIKELY(rb_hash_default_unredefined(hash))) {
2273 if (LIKELY(!
FL_TEST_RAW(hash, RHASH_PROC_DEFAULT)))
return ifnone;
2274 if (UNDEF_P(key))
return Qnil;
2275 return call_default_proc(ifnone, hash, key);
2283hash_stlike_lookup(
VALUE hash, st_data_t key, st_data_t *pval)
2287 if (RHASH_AR_TABLE_P(hash)) {
2288 return ar_lookup(hash, key, pval);
2291 extern st_index_t rb_iseq_cdhash_hash(
VALUE);
2293 RHASH_ST_TABLE(hash)->
type->hash == rb_ident_hash ||
2294 RHASH_ST_TABLE(hash)->
type->hash == rb_iseq_cdhash_hash);
2295 return st_lookup(RHASH_ST_TABLE(hash), key, pval);
2300rb_hash_stlike_lookup(
VALUE hash, st_data_t key, st_data_t *pval)
2302 return hash_stlike_lookup(hash, key, pval);
2327 if (hash_stlike_lookup(hash, key, &val)) {
2331 return rb_hash_default_value(hash, key);
2340 if (hash_stlike_lookup(hash, key, &val)) {
2351 return rb_hash_lookup2(hash, key,
Qnil);
2381rb_hash_fetch_m(
int argc,
VALUE *argv,
VALUE hash)
2391 if (block_given && argc == 2) {
2392 rb_warn(
"block supersedes default value argument");
2395 if (hash_stlike_lookup(hash, key, &val)) {
2402 else if (argc == 1) {
2408 rb_key_err_raise(rb_sprintf(
"key not found: %"PRIsVALUE, desc), hash, key);
2419 return rb_hash_fetch_m(1, &key, hash);
2443rb_hash_default(
int argc,
VALUE *argv,
VALUE hash)
2449 if (
FL_TEST(hash, RHASH_PROC_DEFAULT)) {
2450 if (argc == 0)
return Qnil;
2451 return call_default_proc(ifnone, hash, argv[0]);
2472 rb_hash_modify_check(hash);
2473 SET_DEFAULT(hash, ifnone);
2490rb_hash_default_proc(
VALUE hash)
2492 if (
FL_TEST(hash, RHASH_PROC_DEFAULT)) {
2513rb_hash_set_default_proc(
VALUE hash,
VALUE proc)
2517 rb_hash_modify_check(hash);
2519 SET_DEFAULT(hash, proc);
2522 b = rb_check_convert_type_with_id(proc,
T_DATA,
"Proc", idTo_proc);
2525 "wrong default_proc type %s (expected Proc)",
2529 SET_PROC_DEFAULT(hash, proc);
2569 rb_hash_foreach(hash, key_i, (
VALUE)args);
2575rb_hash_stlike_delete(
VALUE hash, st_data_t *pkey, st_data_t *pval)
2577 if (RHASH_AR_TABLE_P(hash)) {
2578 return ar_delete(hash, pkey, pval);
2581 return st_delete(RHASH_ST_TABLE(hash), pkey, pval);
2593 st_data_t ktmp = (st_data_t)key, val;
2595 if (rb_hash_stlike_delete(hash, &ktmp, &val)) {
2611 VALUE deleted_value = rb_hash_delete_entry(hash, key);
2613 if (!UNDEF_P(deleted_value)) {
2614 return deleted_value;
2660 rb_hash_modify_check(hash);
2661 val = rb_hash_delete_entry(hash, key);
2663 if (!UNDEF_P(val)) {
2664 compact_after_delete(hash);
2709rb_hash_shift(
VALUE hash)
2713 rb_hash_modify_check(hash);
2714 if (RHASH_AR_TABLE_P(hash)) {
2716 if (!hash_iterating_p(hash)) {
2717 if (ar_shift(hash, &var.key, &var.val)) {
2722 rb_hash_foreach(hash, shift_i_safe, (
VALUE)&var);
2723 if (!UNDEF_P(var.key)) {
2724 rb_hash_delete_entry(hash, var.key);
2729 if (RHASH_ST_TABLE_P(hash)) {
2731 if (!hash_iterating_p(hash)) {
2732 if (st_shift(RHASH_ST_TABLE(hash), &var.key, &var.val)) {
2737 rb_hash_foreach(hash, shift_i_safe, (
VALUE)&var);
2738 if (!UNDEF_P(var.key)) {
2739 rb_hash_delete_entry(hash, var.key);
2751 rb_hash_modify(hash);
2760 return rb_hash_size(hash);
2784 rb_hash_modify_check(hash);
2785 if (!RHASH_TABLE_EMPTY_P(hash)) {
2786 rb_hash_foreach(hash, delete_if_i, hash);
2787 compact_after_delete(hash);
2812rb_hash_reject_bang(
VALUE hash)
2817 rb_hash_modify(hash);
2819 if (!n)
return Qnil;
2820 rb_hash_foreach(hash, delete_if_i, hash);
2845rb_hash_reject(
VALUE hash)
2850 result = hash_dup_with_compare_by_id(hash);
2852 rb_hash_foreach(result, delete_if_i, result);
2853 compact_after_delete(result);
2872rb_hash_slice(
int argc,
VALUE *argv,
VALUE hash)
2875 VALUE key, value, result;
2878 return copy_compare_by_id(rb_hash_new_capa(0), hash);
2880 result = copy_compare_by_id(rb_hash_new_capa(argc), hash);
2882 for (i = 0; i < argc; i++) {
2884 value = rb_hash_lookup2(hash, key,
Qundef);
2885 if (!UNDEF_P(value))
2886 rb_hash_aset(result, key, value);
2907rb_hash_except(
int argc,
VALUE *argv,
VALUE hash)
2912 result = hash_dup_with_compare_by_id(hash);
2914 for (i = 0; i < argc; i++) {
2916 rb_hash_delete(result, key);
2918 compact_after_delete(result);
2941rb_hash_values_at(
int argc,
VALUE *argv,
VALUE hash)
2946 for (i=0; i<argc; i++) {
2977rb_hash_fetch_values(
int argc,
VALUE *argv,
VALUE hash)
2982 for (i=0; i<argc; i++) {
2983 rb_ary_push(result, rb_hash_fetch(hash, argv[i]));
2992 rb_hash_modify(hash);
3015rb_hash_select(
VALUE hash)
3020 result = hash_dup_with_compare_by_id(hash);
3022 rb_hash_foreach(result, keep_if_i, result);
3023 compact_after_delete(result);
3049rb_hash_select_bang(
VALUE hash)
3054 rb_hash_modify_check(hash);
3056 if (!n)
return Qnil;
3057 rb_hash_foreach(hash, keep_if_i, hash);
3080rb_hash_keep_if(
VALUE hash)
3083 rb_hash_modify_check(hash);
3084 if (!RHASH_TABLE_EMPTY_P(hash)) {
3085 rb_hash_foreach(hash, keep_if_i, hash);
3108 rb_hash_modify_check(hash);
3110 if (hash_iterating_p(hash)) {
3111 rb_hash_foreach(hash, clear_i, 0);
3113 else if (RHASH_AR_TABLE_P(hash)) {
3117 st_clear(RHASH_ST_TABLE(hash));
3118 compact_after_delete(hash);
3125hash_aset(st_data_t *key, st_data_t *val,
struct update_arg *arg,
int existing)
3132rb_hash_key_str(
VALUE key)
3135 return rb_fstring(key);
3143hash_aset_str(st_data_t *key, st_data_t *val,
struct update_arg *arg,
int existing)
3146 *key = rb_hash_key_str(*key);
3148 return hash_aset(key, val, arg, existing);
3151NOINSERT_UPDATE_CALLBACK(hash_aset)
3152NOINSERT_UPDATE_CALLBACK(hash_aset_str)
3186 bool iter_p = hash_iterating_p(hash);
3188 rb_hash_modify(hash);
3190 if (!RHASH_STRING_KEY_P(hash, key)) {
3191 RHASH_UPDATE_ITER(hash, iter_p, key, hash_aset, val);
3194 RHASH_UPDATE_ITER(hash, iter_p, key, hash_aset_str, val);
3223 rb_hash_modify_check(hash);
3224 if (hash == hash2)
return hash;
3225 if (hash_iterating_p(hash)) {
3228 hash2 = to_hash(hash2);
3230 COPY_DEFAULT(hash, hash2);
3232 if (RHASH_AR_TABLE_P(hash)) {
3233 hash_ar_free_and_clear_table(hash);
3236 hash_st_free_and_clear_table(hash);
3239 hash_copy(hash, hash2);
3280rb_hash_empty_p(
VALUE hash)
3313rb_hash_each_value(
VALUE hash)
3316 rb_hash_foreach(hash, each_value_i, 0);
3347rb_hash_each_key(
VALUE hash)
3350 rb_hash_foreach(hash, each_key_i, 0);
3393rb_hash_each_pair(
VALUE hash)
3396 if (rb_block_pair_yield_optimizable())
3397 rb_hash_foreach(hash, each_pair_i_fast, 0);
3399 rb_hash_foreach(hash, each_pair_i, 0);
3413 VALUE trans = p->trans, result = p->result;
3414 VALUE new_key = rb_hash_lookup2(trans, key,
Qundef);
3415 if (UNDEF_P(new_key)) {
3421 rb_hash_aset(result, new_key, value);
3429 rb_hash_aset(result, new_key, value);
3522rb_hash_transform_keys(
int argc,
VALUE *argv,
VALUE hash)
3529 transarg.trans = to_hash(argv[0]);
3537 if (transarg.trans) {
3538 transarg.result = result;
3539 rb_hash_foreach(hash, transform_keys_hash_i, (
VALUE)&transarg);
3542 rb_hash_foreach(hash, transform_keys_i, result);
3646rb_hash_transform_keys_bang(
int argc,
VALUE *argv,
VALUE hash)
3649 int block_given = 0;
3653 trans = to_hash(argv[0]);
3659 rb_hash_modify_check(hash);
3660 if (!RHASH_TABLE_EMPTY_P(hash)) {
3664 rb_hash_foreach(hash, flatten_i, pairs);
3671 else if (!UNDEF_P(new_key = rb_hash_lookup2(trans, key,
Qundef))) {
3674 else if (block_given) {
3681 if (!hash_stlike_lookup(new_keys, key, NULL)) {
3682 rb_hash_stlike_delete(hash, &key, NULL);
3684 rb_hash_aset(hash, new_key, val);
3685 rb_hash_aset(new_keys, new_key,
Qnil);
3689 compact_after_delete(hash);
3694transform_values_foreach_func(st_data_t key, st_data_t value, st_data_t argp,
int error)
3700transform_values_foreach_replace(st_data_t *key, st_data_t *value, st_data_t argp,
int existing)
3704 rb_hash_modify(hash);
3710transform_values_call(
VALUE hash)
3712 rb_hash_stlike_foreach_with_replace(hash, transform_values_foreach_func, transform_values_foreach_replace, hash);
3717transform_values(
VALUE hash)
3719 hash_iter_lev_inc(hash);
3720 rb_ensure(transform_values_call, hash, hash_foreach_ensure, hash);
3742rb_hash_transform_values(
VALUE hash)
3747 result = hash_dup_with_compare_by_id(hash);
3748 SET_DEFAULT(result,
Qnil);
3751 transform_values(result);
3752 compact_after_delete(result);
3780rb_hash_transform_values_bang(
VALUE hash)
3783 rb_hash_modify_check(hash);
3785 if (!RHASH_TABLE_EMPTY_P(hash)) {
3786 transform_values(hash);
3813rb_hash_to_a(
VALUE hash)
3818 rb_hash_foreach(hash, to_a_i, ary);
3824symbol_key_needs_quote(
VALUE str)
3826 long len = RSTRING_LEN(str);
3827 if (
len == 0 || !rb_str_symname_p(str))
return true;
3828 const char *s = RSTRING_PTR(str);
3830 if (first ==
'@' || first ==
'$' || first ==
'!')
return true;
3831 if (!at_char_boundary(s, s +
len - 1,
RSTRING_END(str), rb_enc_get(str)))
return false;
3832 switch (s[
len - 1]) {
3863 quote = symbol_key_needs_quote(str2);
3868 if (RSTRING_LEN(str) > 1) {
3872 rb_enc_copy(str, str2);
3889inspect_hash(
VALUE hash,
VALUE dummy,
int recur)
3895 rb_hash_foreach(hash, inspect_i, str);
3914rb_hash_inspect(
VALUE hash)
3930rb_hash_to_hash(
VALUE hash)
3942 rb_raise(
rb_eTypeError,
"wrong element type %s (expected array)",
3943 rb_builtin_class_name(arg));
3946 rb_raise(rb_eArgError,
"element has wrong array length (expected 2, was %ld)",
3961rb_hash_to_h_block(
VALUE hash)
3964 rb_hash_foreach(hash, to_h_i, h);
3989rb_hash_to_h(
VALUE hash)
3992 return rb_hash_to_h_block(hash);
4021rb_hash_keys(
VALUE hash)
4026 if (size == 0)
return keys;
4028 if (ST_DATA_COMPATIBLE_P(
VALUE)) {
4030 if (RHASH_AR_TABLE_P(hash)) {
4031 size = ar_keys(hash, ptr, size);
4034 st_table *table = RHASH_ST_TABLE(hash);
4035 size = st_keys(table, ptr, size);
4038 rb_gc_writebarrier_remember(keys);
4039 rb_ary_set_len(keys, size);
4042 rb_hash_foreach(hash, keys_i, keys);
4068rb_hash_values(
VALUE hash)
4074 if (size == 0)
return values;
4076 if (ST_DATA_COMPATIBLE_P(
VALUE)) {
4077 if (RHASH_AR_TABLE_P(hash)) {
4078 rb_gc_writebarrier_remember(values);
4080 size = ar_values(hash, ptr, size);
4083 else if (RHASH_ST_TABLE_P(hash)) {
4084 st_table *table = RHASH_ST_TABLE(hash);
4085 rb_gc_writebarrier_remember(values);
4087 size = st_values(table, ptr, size);
4090 rb_ary_set_len(values, size);
4093 rb_hash_foreach(hash, values_i, values);
4115 return RBOOL(hash_stlike_lookup(hash, key, NULL));
4146 rb_hash_foreach(hash, rb_hash_search_value, (
VALUE)data);
4162 if (!hash_stlike_lookup(data->hash, key, &val2)) {
4176recursive_eql(
VALUE hash,
VALUE dt,
int recur)
4180 if (recur)
return Qtrue;
4182 data->result =
Qtrue;
4183 rb_hash_foreach(hash, eql_i, dt);
4185 return data->result;
4193 if (hash1 == hash2)
return Qtrue;
4199 if (
rb_eql(hash2, hash1)) {
4212 if (!RHASH_TABLE_EMPTY_P(hash1) && !RHASH_TABLE_EMPTY_P(hash2)) {
4213 if (RHASH_TYPE(hash1) != RHASH_TYPE(hash2)) {
4225 FL_TEST(hash1, RHASH_PROC_DEFAULT) ==
FL_TEST(hash2, RHASH_PROC_DEFAULT)))
4257 return hash_equal(hash1, hash2, FALSE);
4284 return hash_equal(hash1, hash2, TRUE);
4290 st_index_t *hval = (st_index_t *)arg;
4291 st_index_t hdata[2];
4293 hdata[0] = rb_hash(key);
4294 hdata[1] = rb_hash(val);
4295 *hval ^= st_hash(hdata,
sizeof(hdata), 0);
4317rb_hash_hash(
VALUE hash)
4323 rb_hash_foreach(hash, hash_i, (
VALUE)&hval);
4332 rb_hash_aset(hash, value, key);
4356rb_hash_invert(
VALUE hash)
4360 rb_hash_foreach(hash, rb_hash_invert_i, h);
4367 rb_hash_aset(hash, key, value);
4372 VALUE hash, newvalue, *argv;
4379rb_hash_update_block_callback(st_data_t *key, st_data_t *value,
struct update_arg *arg,
int existing)
4383 VALUE newvalue = ua->newvalue, hash = arg->hash;
4386 hash_iter_lev_inc(hash);
4387 ua->iterating =
true;
4389 hash_iter_lev_dec(hash);
4390 ua->iterating =
false;
4392 else if (RHASH_STRING_KEY_P(hash, k) && !
RB_OBJ_FROZEN(k)) {
4393 *key = (st_data_t)rb_hash_key_str(k);
4395 *value = (st_data_t)newvalue;
4399NOINSERT_UPDATE_CALLBACK(rb_hash_update_block_callback)
4405 ua->newvalue = value;
4406 RHASH_UPDATE(ua->hash, key, rb_hash_update_block_callback, args);
4411rb_hash_update_call(
VALUE args)
4415 for (
int i = 0; i < arg->argc; i++){
4416 VALUE hash = to_hash(arg->argv[i]);
4417 if (arg->block_given) {
4418 rb_hash_foreach(hash, rb_hash_update_block_i, args);
4421 rb_hash_foreach(hash, rb_hash_update_i, arg->hash);
4428rb_hash_update_ensure(
VALUE args)
4431 if (ua->iterating) hash_iter_lev_dec(ua->hash);
4480rb_hash_update(
int argc,
VALUE *argv,
VALUE self)
4491 rb_hash_modify(self);
4492 return rb_ensure(rb_hash_update_call, arg, rb_hash_update_ensure, arg);
4502rb_hash_update_func_callback(st_data_t *key, st_data_t *value,
struct update_arg *arg,
int existing)
4505 VALUE newvalue = uf_arg->value;
4508 newvalue = (*uf_arg->func)((
VALUE)*key, (
VALUE)*value, newvalue);
4514NOINSERT_UPDATE_CALLBACK(rb_hash_update_func_callback)
4520 VALUE hash = arg->hash;
4523 RHASH_UPDATE(hash, key, rb_hash_update_func_callback, (
VALUE)arg);
4530 rb_hash_modify(hash1);
4531 hash2 = to_hash(hash2);
4536 rb_hash_foreach(hash2, rb_hash_update_func_i, (
VALUE)&arg);
4539 rb_hash_foreach(hash2, rb_hash_update_i, hash1);
4545hash_merge_guess_size(
int argc,
VALUE *argv,
VALUE self)
4555 VALUE other = argv[0];
4561 unsigned bound = RHASH_AR_TABLE_BOUND(other);
4562 for (
unsigned i = 0; i < bound; i++) {
4563 VALUE key = RHASH_AR_TABLE_REF(other, i)->key;
4572 if (!hash_stlike_lookup(self, key, NULL)) {
4627rb_hash_merge(
int argc,
VALUE *argv,
VALUE self)
4629 size_t guessed_size = hash_merge_guess_size(argc, argv, self);
4630 VALUE ret = guessed_size ? rb_hash_dup_capa(self, guessed_size) : rb_hash_dup(self);
4631 return rb_hash_update(argc, argv, copy_compare_by_id(ret, self));
4646assoc_lookup(
VALUE arg)
4650 if (st_lookup(p->tbl, p->key, &data))
return (
VALUE)data;
4688 if (RHASH_ST_TABLE_P(hash) && !RHASH_IDENTHASH_P(hash)) {
4690 st_table assoctable = *RHASH_ST_TABLE(hash);
4692 .compare = assoc_cmp,
4693 .hash = assoctable.type->hash,
4697 .key = (st_data_t)key,
4701 value = assoc_lookup(arg);
4704 hash_iter_lev_inc(hash);
4705 value =
rb_ensure(assoc_lookup, arg, hash_foreach_ensure, hash);
4713 rb_hash_foreach(hash, assoc_i, (
VALUE)args);
4752 rb_hash_foreach(hash, rassoc_i, (
VALUE)args);
4805rb_hash_flatten(
int argc,
VALUE *argv,
VALUE hash)
4814 if (level == 0)
return rb_hash_to_a(hash);
4817 rb_hash_foreach(hash, flatten_i, ary);
4822 rb_funcallv(ary, id_flatten_bang, 1, &ary_flatten_level);
4824 else if (level < 0) {
4831 rb_hash_foreach(hash, flatten_i, ary);
4859rb_hash_compact(
VALUE hash)
4861 VALUE result = rb_hash_dup(hash);
4863 rb_hash_foreach(result, delete_if_nil, result);
4864 compact_after_delete(result);
4866 else if (rb_hash_compare_by_id_p(hash)) {
4867 result = rb_hash_compare_by_id(result);
4889rb_hash_compact_bang(
VALUE hash)
4892 rb_hash_modify_check(hash);
4895 rb_hash_foreach(hash, delete_if_nil, hash);
4929rb_hash_compare_by_id(
VALUE hash)
4934 if (rb_hash_compare_by_id_p(hash))
return hash;
4936 rb_hash_modify_check(hash);
4937 if (hash_iterating_p(hash)) {
4941 if (RHASH_AR_TABLE_P(hash)) {
4942 unsigned int bound = RHASH_AR_TABLE_BOUND(hash);
4943 for (
unsigned int i = 0; i < bound; i++) {
4944 if (ar_cleared_entry(hash, i))
continue;
4947 ar_hint_set(hash, i, (st_hash_t)rb_ident_hash(pair->key));
4950 else if (RHASH_TABLE_EMPTY_P(hash)) {
4952 HASH_ASSERT(RHASH_ST_TABLE_P(hash));
4954 RHASH_ST_TABLE(hash)->type = &identhash;
4959 tmp = hash_alloc_capa(0, 0);
4962 identtable = RHASH_ST_TABLE(tmp);
4964 rb_hash_foreach(hash, rb_hash_rehash_i, (
VALUE)tmp);
4969 rb_hash_st_table_set(hash, identtable);
4970 RHASH_ST_CLEAR(tmp);
4975 rb_gc_register_pinning_obj(hash);
4996rb_hash_compare_by_id_p(
VALUE hash)
4998 return RBOOL(RHASH_IDENTHASH_P(hash));
5002rb_ident_hash_new(
void)
5004 VALUE hash = rb_hash_new_capa(0);
5006 hash_st_table_init(hash, 0);
5007 rb_gc_register_pinning_obj(hash);
5012rb_ident_hash_new_capa(
long size)
5014 VALUE hash = rb_hash_new_capa(0);
5016 hash_st_table_init(hash, size);
5017 rb_gc_register_pinning_obj(hash);
5022rb_init_identtable(
void)
5024 return st_init_table(&identhash);
5101rb_hash_any_p(
int argc,
VALUE *argv,
VALUE hash)
5110 rb_warn(
"given block not used");
5114 rb_hash_foreach(hash, any_p_i_pattern, (
VALUE)args);
5121 if (rb_block_pair_yield_optimizable())
5122 rb_hash_foreach(hash, any_p_i_fast, (
VALUE)args);
5124 rb_hash_foreach(hash, any_p_i, (
VALUE)args);
5165rb_hash_dig(
int argc,
VALUE *argv,
VALUE self)
5168 self = rb_hash_aref(self, *argv);
5169 if (!--argc)
return self;
5171 return rb_obj_dig(argc, argv, self,
Qnil);
5179 if (!UNDEF_P(v) &&
rb_equal(value, v))
return ST_CONTINUE;
5190 rb_hash_foreach(hash1, hash_le_i, (
VALUE)args);
5215 other = to_hash(other);
5217 return hash_le(hash, other);
5243 other = to_hash(other);
5245 return hash_le(hash, other);
5269 other = to_hash(other);
5271 return hash_le(other, hash);
5297 other = to_hash(other);
5299 return hash_le(other, hash);
5306 return rb_hash_aref(hash, *argv);
5327rb_hash_to_proc(
VALUE hash)
5329 return rb_func_lambda_new(hash_proc_call, hash, 1, 1);
5334rb_hash_deconstruct_keys(
VALUE hash,
VALUE keys)
5340add_new_i(st_data_t *key, st_data_t *val, st_data_t arg,
int existing)
5342 if (existing)
return ST_STOP;
5354 int ret = rb_hash_stlike_update(hash, key, add_new_i, val);
5366 return (RHASH_STRING_KEY_P(hash, key) && !
RB_OBJ_FROZEN(key)) ?
5367 rb_hash_key_str(key) : key;
5371ar_bulk_insert(
VALUE hash,
long argc,
const VALUE *argv)
5374 for (i = 0; i < argc; ) {
5375 st_data_t k = key_stringify(hash, argv[i++]);
5376 st_data_t v = argv[i++];
5377 ar_insert(hash, k, v);
5386 HASH_ASSERT(argc % 2 == 0);
5388 st_index_t size = argc / 2;
5390 if (RHASH_AR_TABLE_P(hash) &&
5391 (RHASH_AR_TABLE_SIZE(hash) + size <= RHASH_AR_TABLE_MAX_BOUND(hash))) {
5392 ar_bulk_insert(hash, argc, argv);
5395 rb_hash_bulk_insert_into_st_table(argc, argv, hash);
5401hash_new_with_bulk_insert(
VALUE klass,
long argc,
const VALUE *argv)
5403 VALUE val = hash_new_capa(klass, argc / 2);
5404 rb_hash_bulk_insert(argc, argv, val);
5409rb_hash_new_with_bulk_insert(
long argc,
const VALUE *argv)
5411 return hash_new_with_bulk_insert(
rb_cHash, argc, argv);
5415rb_hash_merge2_bulk(
VALUE hash,
long argc,
const VALUE *argv,
bool dup)
5421 val = hash_dup_capa(val,
RHASH_SIZE(val) + argc / 2);
5423 rb_hash_bulk_insert(argc, argv, val);
5436 rb_hash_foreach(h2, rb_hash_update_i, val);
5440#undef USE_ORIGENVIRON
5441#if !defined(_WIN32) && !(defined(HAVE_SETENV) && defined(HAVE_UNSETENV))
5442# define USE_ORIGENVIRON 1
5443static char **origenviron;
5446#define GET_ENVIRON(e) ((e) = rb_w32_get_environ())
5447#define FREE_ENVIRON(e) rb_w32_free_environ(e)
5448static char **my_environ;
5450#define environ my_environ
5452#define getenv(n) rb_w32_ugetenv(n)
5453#elif defined(__APPLE__)
5455#define environ (*_NSGetEnviron())
5456#define GET_ENVIRON(e) (e)
5457#define FREE_ENVIRON(e)
5459extern char **environ;
5460#define GET_ENVIRON(e) (e)
5461#define FREE_ENVIRON(e)
5463#ifdef ENV_IGNORECASE
5464#define ENVMATCH(s1, s2) (STRCASECMP((s1), (s2)) == 0)
5465#define ENVNMATCH(s1, s2, n) (STRNCASECMP((s1), (s2), (n)) == 0)
5467#define ENVMATCH(n1, n2) (strcmp((n1), (n2)) == 0)
5468#define ENVNMATCH(s1, s2, n) (memcmp((s1), (s2), (n)) == 0)
5471#define ENV_LOCKING() RB_VM_LOCKING()
5477 return rb_utf8_encoding();
5479 return rb_locale_encoding();
5495 return env_enc_str_new(ptr,
len, enc);
5501 if (!ptr)
return Qnil;
5502 return env_str_new(ptr, strlen(ptr), enc);
5506getenv_with_lock(
const char *name)
5511 const char *val = getenv(name);
5512 ret = env_str_new2(val, enc);
5518has_env_with_lock(
const char *name)
5526 return val ? true :
false;
5529static const char TZ_ENV[] =
"TZ";
5532get_env_cstr(
VALUE str,
const char *name)
5536 if (!rb_enc_asciicompat(enc)) {
5537 rb_raise(rb_eArgError,
"bad environment variable %s: ASCII incompatible encoding: %s",
5538 name, rb_enc_name(enc));
5540 var = RSTRING_PTR(str);
5541 if (memchr(var,
'\0', RSTRING_LEN(str))) {
5542 rb_raise(rb_eArgError,
"bad environment variable %s: contains null byte", name);
5544 return rb_str_fill_terminator(str, 1);
5547#define get_env_ptr(var, val) \
5548 (var = get_env_cstr(val, #var))
5550static inline const char *
5551env_name(
volatile VALUE *s)
5555 get_env_ptr(name, *s);
5559#define env_name(s) env_name(&(s))
5564reset_by_modified_env(
const char *nam,
const char *val)
5572 if (ENVMATCH(nam, TZ_ENV)) {
5573 ruby_reset_timezone(val);
5578env_delete(
VALUE name)
5580 const char *nam = env_name(name);
5581 reset_by_modified_env(nam, NULL);
5582 VALUE val = getenv_with_lock(nam);
5585 ruby_setenv(nam, 0);
5620 val = env_delete(name);
5640 const char *nam = env_name(name);
5641 VALUE env = getenv_with_lock(nam);
5681 if (block_given && argc == 2) {
5682 rb_warn(
"block supersedes default value argument");
5684 nam = env_name(key);
5685 env = getenv_with_lock(nam);
5688 if (block_given)
return rb_yield(key);
5690 rb_key_err_raise(rb_sprintf(
"key not found: \"%"PRIsVALUE
"\"", key), envtbl, key);
5721env_fetch_values(
int argc,
VALUE *argv,
VALUE ehash)
5726 for (i=0; i<argc; i++) {
5727 rb_ary_push(result, env_fetch(1, &argv[i], ehash));
5733#if defined(_WIN32) || (defined(HAVE_SETENV) && defined(HAVE_UNSETENV))
5736in_origenv(
const char *str)
5739 for (env = origenviron; *env; ++env) {
5740 if (*env == str)
return 1;
5746envix(
const char *nam)
5750 register int i,
len = strlen(nam);
5753 env = GET_ENVIRON(environ);
5754 for (i = 0; env[i]; i++) {
5755 if (ENVNMATCH(env[i],nam,
len) && env[i][
len] ==
'=')
5758 FREE_ENVIRON(environ);
5763#if defined(_WIN32) || \
5764 (defined(__sun) && !(defined(HAVE_SETENV) && defined(HAVE_UNSETENV)))
5766NORETURN(
static void invalid_envname(
const char *name));
5769invalid_envname(
const char *name)
5775check_envname(
const char *name)
5777 if (strchr(name,
'=')) {
5778 invalid_envname(name);
5785ruby_setenv(
const char *name,
const char *value)
5793 check_envname(name);
5794 len = MultiByteToWideChar(CP_UTF8, 0, name, -1, NULL, 0);
5797 len2 = MultiByteToWideChar(CP_UTF8, 0, value, -1, NULL, 0);
5799 wvalue = wname +
len;
5800 MultiByteToWideChar(CP_UTF8, 0, name, -1, wname,
len);
5801 MultiByteToWideChar(CP_UTF8, 0, value, -1, wvalue, len2);
5805 MultiByteToWideChar(CP_UTF8, 0, name, -1, wname,
len);
5806 wvalue = wname +
len;
5813 failed = _wputenv_s(wname, wvalue);
5819 if (!value || !*value) {
5821 if (!SetEnvironmentVariableW(wname, value ? wvalue : NULL) &&
5822 GetLastError() != ERROR_ENVVAR_NOT_FOUND)
goto fail;
5826 invalid_envname(name);
5828#elif defined(HAVE_SETENV) && defined(HAVE_UNSETENV)
5832 ret = setenv(name, value, 1);
5835 if (ret) rb_sys_fail_sprintf(
"setenv(%s)", name);
5845 ret = unsetenv(name);
5848 if (ret) rb_sys_fail_sprintf(
"unsetenv(%s)", name);
5856 size_t len, mem_size;
5857 char **env_ptr, *str, *mem_ptr;
5859 check_envname(name);
5862 mem_size =
len + strlen(value) + 2;
5863 mem_ptr = malloc(mem_size);
5864 if (mem_ptr == NULL)
5865 rb_sys_fail_sprintf(
"malloc(%"PRIuSIZE
")", mem_size);
5866 snprintf(mem_ptr, mem_size,
"%s=%s", name, value);
5870 for (env_ptr = GET_ENVIRON(environ); (str = *env_ptr) != 0; ++env_ptr) {
5871 if (!strncmp(str, name,
len) && str[
len] ==
'=') {
5872 if (!in_origenv(str)) free(str);
5873 while ((env_ptr[0] = env_ptr[1]) != 0) env_ptr++;
5882 ret = putenv(mem_ptr);
5887 rb_sys_fail_sprintf(
"putenv(%s)", name);
5897 if (environ == origenviron) {
5902 for (max = i; environ[max]; max++) ;
5903 tmpenv =
ALLOC_N(
char*, max+2);
5904 for (j=0; j<max; j++)
5911 char **envp = origenviron;
5912 while (*envp && *envp != environ[i]) envp++;
5916 while (environ[i]) {
5917 environ[i] = environ[i+1];
5924 if (!value)
goto finish;
5929 len = strlen(name) + strlen(value) + 2;
5931 snprintf(environ[i],
len,
"%s=%s",name,value);
5939ruby_unsetenv(
const char *name)
5941 ruby_setenv(name, 0);
5989 return env_aset(nm, val);
6005 get_env_ptr(name, nm);
6006 get_env_ptr(value, val);
6008 ruby_setenv(name, value);
6009 reset_by_modified_env(name, value);
6020 char **env = GET_ENVIRON(environ);
6022 char *s = strchr(*env,
'=');
6024 const char *p = *env;
6031 FREE_ENVIRON(environ);
6053 return env_keys(FALSE);
6063 env = GET_ENVIRON(environ);
6064 for (; *env ; ++env) {
6065 if (strchr(*env,
'=')) {
6069 FREE_ENVIRON(environ);
6093env_each_key(
VALUE ehash)
6099 keys = env_keys(FALSE);
6113 char **env = GET_ENVIRON(environ);
6116 char *s = strchr(*env,
'=');
6122 FREE_ENVIRON(environ);
6143 return env_values();
6164env_each_value(
VALUE ehash)
6170 values = env_values();
6196env_each_pair(
VALUE ehash)
6206 char **env = GET_ENVIRON(environ);
6209 char *s = strchr(*env,
'=');
6216 FREE_ENVIRON(environ);
6219 if (rb_block_pair_yield_optimizable()) {
6256env_reject_bang(
VALUE ehash)
6263 keys = env_keys(FALSE);
6264 RBASIC_CLEAR_CLASS(keys);
6275 if (del == 0)
return Qnil;
6295env_delete_if(
VALUE ehash)
6298 env_reject_bang(ehash);
6326 for (i=0; i<argc; i++) {
6348env_select(
VALUE ehash)
6355 result = rb_hash_new();
6356 keys = env_keys(FALSE);
6362 rb_hash_aset(result, key, val);
6395env_select_bang(
VALUE ehash)
6402 keys = env_keys(FALSE);
6403 RBASIC_CLEAR_CLASS(keys);
6414 if (del == 0)
return Qnil;
6433env_keep_if(
VALUE ehash)
6436 env_select_bang(ehash);
6456 VALUE key, value, result;
6458 result = rb_hash_new_capa(argc);
6460 for (i = 0; i < argc; i++) {
6462 value = rb_f_getenv(
Qnil, key);
6464 rb_hash_aset(result, key, value);
6476 keys = env_keys(TRUE);
6479 const char *nam = RSTRING_PTR(key);
6480 ruby_setenv(nam, 0);
6499 return rb_env_clear();
6530 char **env = GET_ENVIRON(environ);
6532 const char *s = strchr(*env,
'=');
6534 if (env != environ) {
6545 FREE_ENVIRON(environ);
6569 char **env = GET_ENVIRON(environ);
6571 char *s = strchr(*env,
'=');
6574 env_str_new2(s+1, enc)));
6578 FREE_ENVIRON(environ);
6599env_size_with_lock(
void)
6604 char **env = GET_ENVIRON(environ);
6606 FREE_ENVIRON(environ);
6625 return INT2FIX(env_size_with_lock());
6644 char **env = GET_ENVIRON(environ);
6648 FREE_ENVIRON(environ);
6651 return RBOOL(empty);
6680 const char *s = env_name(key);
6681 return RBOOL(has_env_with_lock(s));
6707 const char *s = env_name(key);
6708 VALUE e = getenv_with_lock(s);
6739 char **env = GET_ENVIRON(environ);
6741 char *s = strchr(*env,
'=');
6743 long len = strlen(s);
6744 if (RSTRING_LEN(obj) ==
len && strncmp(s, RSTRING_PTR(obj),
len) == 0) {
6751 FREE_ENVIRON(environ);
6780 char **env = GET_ENVIRON(environ);
6783 const char *p = *env;
6784 const char *s = strchr(p,
'=');
6786 long len = strlen(s);
6787 if (RSTRING_LEN(obj) ==
len && strncmp(s, RSTRING_PTR(obj),
len) == 0) {
6794 FREE_ENVIRON(environ);
6824 char **env = GET_ENVIRON(environ);
6826 char *s = strchr(*env,
'=');
6828 long len = strlen(s);
6829 if (RSTRING_LEN(value) ==
len && strncmp(s, RSTRING_PTR(value),
len) == 0) {
6830 str = env_str_new(*env, s-*env-1, enc);
6836 FREE_ENVIRON(environ);
6843environ_size(
char **env)
6860 char **env = GET_ENVIRON(environ);
6861 hash = rb_hash_new_capa(environ_size(env));
6863 char *s = strchr(*env,
'=');
6865 rb_hash_aset(hash, env_str_new(*env, s-*env, enc),
6866 env_str_new2(s+1, enc));
6870 FREE_ENVIRON(environ);
6885 return env_to_hash();
6900 return env_to_hash();
6924 VALUE hash = env_to_hash();
6926 hash = rb_hash_to_h_block(hash);
6944 VALUE key, hash = env_to_hash();
6946 for (i = 0; i < argc; i++) {
6948 rb_hash_delete(hash, key);
6972 return rb_hash_delete_if(env_to_hash());
6975NORETURN(
static VALUE env_freeze(
VALUE self));
6984env_freeze(
VALUE self)
7013 char **env = GET_ENVIRON(environ);
7015 const char *p = *env;
7016 const char *s = strchr(p,
'=');
7018 key = env_str_new(p, s-p, enc);
7019 VALUE val = env_str_new2(getenv(RSTRING_PTR(key)), enc);
7023 FREE_ENVIRON(environ);
7051 return rb_hash_invert(env_to_hash());
7058 const char *keyptr, *eptr;
7066 if (elen != keylen)
continue;
7067 if (!ENVNMATCH(keyptr, eptr, elen))
continue;
7079 keylist_delete(keys, key);
7107 keys = env_keys(TRUE);
7108 if (env == hash)
return env;
7109 hash = to_hash(hash);
7110 rb_hash_foreach(hash, env_replace_i, keys);
7130 if (!
NIL_P(oldval)) {
7177 env_update_block_i : env_update_i;
7178 for (
int i = 0; i < argc; ++i) {
7179 VALUE hash = argv[i];
7180 if (env == hash)
continue;
7181 hash = to_hash(hash);
7182 rb_hash_foreach(hash, func, 0);
7202 rb_get_freeze_opt(1, &opt);
7206 rb_raise(
rb_eTypeError,
"Cannot clone ENV, use ENV.to_h to get a copy of ENV as a hash");
7220 rb_raise(
rb_eTypeError,
"Cannot dup ENV, use ENV.to_h to get a copy of ENV as a hash");
7231 0, 0, RUBY_TYPED_THREAD_SAFE_FREE | RUBY_TYPED_WB_PROTECTED,
7701 id_hash_iter_lev = rb_make_internal_id();
7799 rb_cHash_empty_frozen = rb_hash_freeze(rb_hash_alloc_fixed_size(
rb_cHash, 0));
7801 rb_vm_register_global_object(rb_cHash_empty_frozen);
7968#ifdef USE_ORIGENVIRON
7969 origenviron = environ;
8039 HASH_ASSERT(
sizeof(ar_hint_t) * RHASH_AR_TABLE_MAX_SIZE ==
sizeof(
VALUE));
8042#include "hash.rbinc"
#define RBIMPL_ASSERT_OR_ASSUME(...)
This is either RUBY_ASSERT or RBIMPL_ASSUME, depending on RUBY_DEBUG.
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
static bool RB_OBJ_FROZEN(VALUE obj)
Checks if an object is frozen.
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a 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.
int rb_block_given_p(void)
Determines if the current method is given a block.
#define TYPE(_)
Old name of rb_type.
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
#define rb_str_buf_cat2
Old name of rb_usascii_str_new_cstr.
#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 OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#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 ASSUME
Old name of RBIMPL_ASSUME.
#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 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_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_mKernel
Kernel module.
VALUE rb_cObject
Object class.
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.
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.
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.
#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_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_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,...
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.
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.
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
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_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_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
#define rb_utf8_str_new(str, len)
Identical to rb_str_new, except it generates a string of "UTF-8" encoding.
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... Let us hesitate from describing what a "basic definition" is.
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 symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
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.
int len
Length of the buffer.
#define RB_OBJ_SET_SHAREABLE(obj)
Wrapper of rb_obj_set_shareable().
char * ruby_strdup(const char *str)
This is our own version of strdup(3) that uses ruby_xmalloc() instead of system malloc (benefits our ...
#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 MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
VALUE rb_ensure(type *q, VALUE w, type *e, VALUE r)
An equivalent of ensure clause.
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.
#define RHASH_SIZE(h)
Queries the size of the hash.
#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.
#define RSTRING_GETMEM(str, ptrvar, lenvar)
Convenient macro to obtain the contents and length at once.
#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.