17#include "ruby/internal/config.h"
21#include "debug_counter.h"
24#include "internal/class.h"
25#include "internal/eval.h"
26#include "internal/hash.h"
27#include "internal/namespace.h"
28#include "internal/object.h"
29#include "internal/string.h"
30#include "internal/variable.h"
79#define METACLASS_OF(k) RBASIC(k)->klass
80#define SET_METACLASS_OF(k, cls) RBASIC_SET_CLASS(k, cls)
82static enum rb_id_table_iterator_result
83cvar_table_free_i(
VALUE value,
void *ctx)
86 return ID_TABLE_CONTINUE;
94 rb_id_table_free(RCLASSEXT_M_TBL(ext));
96 if (!RCLASSEXT_SHARED_CONST_TBL(ext) && (tbl = RCLASSEXT_CONST_TBL(ext)) != NULL) {
97 rb_free_const_table(tbl);
100 if ((tbl = RCLASSEXT_CVC_TBL(ext)) != NULL) {
101 rb_id_table_foreach_values(tbl, cvar_table_free_i, NULL);
102 rb_id_table_free(tbl);
105 rb_class_classext_free_subclasses(ext, klass,
false);
107 if (RCLASSEXT_SUPERCLASSES_WITH_SELF(ext)) {
109 xfree(RCLASSEXT_SUPERCLASSES(ext));
120 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
122 rb_id_table_free(RCLASSEXT_M_TBL(ext));
125 if (RCLASSEXT_CALLABLE_M_TBL(ext) != NULL) {
126 rb_id_table_free(RCLASSEXT_CALLABLE_M_TBL(ext));
129 rb_class_classext_free_subclasses(ext, klass,
false);
139 if (RCLASSEXT_ICLASS_IS_ORIGIN(ext) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext)) {
141 rb_id_table_free(RCLASSEXT_M_TBL(ext));
144 if (RCLASSEXT_CALLABLE_M_TBL(ext) != NULL) {
145 rb_id_table_free(RCLASSEXT_CALLABLE_M_TBL(ext));
148 rb_class_classext_free_subclasses(ext, klass,
true);
159rb_class_set_namespace_classext_update(st_data_t *key_ptr, st_data_t *val_ptr, st_data_t a,
int existing)
165 iclass_free_orphan_classext(args->obj, (
rb_classext_t *)*val_ptr);
168 rb_bug(
"Updating existing classext for non-iclass never happen");
172 *val_ptr = (st_data_t)args->ext;
185 st_update(RCLASS_CLASSEXT_TBL(obj), (st_data_t)ns->ns_object, rb_class_set_namespace_classext_update, (st_data_t)&args);
195static enum rb_id_table_iterator_result
196duplicate_classext_id_table_i(
ID key,
VALUE value,
void *data)
199 rb_id_table_insert(tbl, key, value);
200 return ID_TABLE_CONTINUE;
203static enum rb_id_table_iterator_result
204duplicate_classext_m_tbl_i(
ID key,
VALUE value,
void *data)
208 rb_method_table_insert0(arg->klass, arg->tbl, key, me,
false);
209 return ID_TABLE_CONTINUE;
213duplicate_classext_m_tbl(
struct rb_id_table *orig,
VALUE klass,
bool init_missing)
218 return rb_id_table_create(0);
222 tbl = rb_id_table_create(rb_id_table_size(orig));
227 rb_id_table_foreach(orig, duplicate_classext_m_tbl_i, &data);
232duplicate_classext_id_table(
struct rb_id_table *orig,
bool init_missing)
238 return rb_id_table_create(0);
242 tbl = rb_id_table_create(rb_id_table_size(orig));
243 rb_id_table_foreach(orig, duplicate_classext_id_table_i, tbl);
253 dst->flag = src->flag;
254 dst->line = src->line;
261static enum rb_id_table_iterator_result
262duplicate_classext_const_tbl_i(
ID key,
VALUE value,
void *data)
267 rb_id_table_insert(arg->tbl, key, (
VALUE)entry);
269 return ID_TABLE_CONTINUE;
280 dst = rb_id_table_create(rb_id_table_size(src));
286 rb_id_table_foreach(src, duplicate_classext_const_tbl_i, (
void *)&data);
297 return (
VALUE)ns->ns_id;
308 if (RCLASSEXT_SUBCLASSES(orig)) {
309 orig_anchor = RCLASSEXT_SUBCLASSES(orig);
310 ns_subclasses = orig_anchor->ns_subclasses;
314 anchor->ns_subclasses = rb_ns_subclasses_ref_inc(ns_subclasses);
319 RCLASSEXT_SUBCLASSES(copy) = anchor;
322 entry = orig_anchor->head;
327 if (rb_objspace_garbage_object_p(entry->klass)) {
332 cdr->klass = entry->klass;
336 VALUE ns_id = namespace_subclasses_tbl_key(RCLASSEXT_NS(copy));
338 st_insert(tbl, ns_id, (st_data_t)first);
345 if (RCLASSEXT_NS_SUPER_SUBCLASSES(orig))
346 RCLASSEXT_NS_SUPER_SUBCLASSES(copy) = rb_ns_subclasses_ref_inc(RCLASSEXT_NS_SUPER_SUBCLASSES(orig));
347 if (RCLASSEXT_NS_MODULE_SUBCLASSES(orig))
348 RCLASSEXT_NS_MODULE_SUBCLASSES(copy) = rb_ns_subclasses_ref_inc(RCLASSEXT_NS_MODULE_SUBCLASSES(orig));
357 rb_classext_t *ext = RCLASS_EXT_TABLE_LOOKUP_INTERNAL(iclass, ns);
362 rb_invalidate_method_caches(RCLASSEXT_CALLABLE_M_TBL(ext), RCLASSEXT_CC_TBL(ext));
367 RCLASSEXT_NS(ext) = ns;
369 RCLASSEXT_SUPER(ext) = RCLASSEXT_SUPER(src);
372 if (RCLASSEXT_ICLASS_IS_ORIGIN(src) && !RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(src)) {
373 RCLASSEXT_M_TBL(ext) = duplicate_classext_m_tbl(RCLASSEXT_M_TBL(src), iclass,
true);
376 RCLASSEXT_M_TBL(ext) = RCLASSEXT_M_TBL(mod_ext);
379 RCLASSEXT_CONST_TBL(ext) = RCLASSEXT_CONST_TBL(mod_ext);
380 RCLASSEXT_CVC_TBL(ext) = RCLASSEXT_CVC_TBL(mod_ext);
387 duplicate_classext_subclasses(src, ext);
389 RCLASSEXT_SET_ORIGIN(ext, iclass, RCLASSEXT_ORIGIN(src));
390 RCLASSEXT_ICLASS_IS_ORIGIN(ext) = RCLASSEXT_ICLASS_IS_ORIGIN(src);
391 RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext) = RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(src);
393 RCLASSEXT_SET_INCLUDER(ext, iclass, RCLASSEXT_INCLUDER(src));
395 VM_ASSERT(
FL_TEST_RAW(iclass, RCLASS_NAMESPACEABLE));
397 first_set = RCLASS_SET_NAMESPACE_CLASSEXT(iclass, ns, ext);
399 RCLASS_SET_PRIME_CLASSEXT_WRITABLE(iclass,
false);
411 RCLASSEXT_NS(ext) = ns;
413 RCLASSEXT_SUPER(ext) = RCLASSEXT_SUPER(orig);
415 RCLASSEXT_M_TBL(ext) = duplicate_classext_m_tbl(RCLASSEXT_M_TBL(orig), klass, dup_iclass);
416 RCLASSEXT_ICLASS_IS_ORIGIN(ext) =
true;
417 RCLASSEXT_ICLASS_ORIGIN_SHARED_MTBL(ext) =
false;
419 if (orig->fields_obj) {
420 RB_OBJ_WRITE(klass, &ext->fields_obj, rb_imemo_fields_clone(orig->fields_obj));
423 if (RCLASSEXT_SHARED_CONST_TBL(orig)) {
424 RCLASSEXT_CONST_TBL(ext) = RCLASSEXT_CONST_TBL(orig);
425 RCLASSEXT_SHARED_CONST_TBL(ext) =
true;
428 RCLASSEXT_CONST_TBL(ext) = duplicate_classext_const_tbl(RCLASSEXT_CONST_TBL(orig), klass);
429 RCLASSEXT_SHARED_CONST_TBL(ext) =
false;
441 RCLASSEXT_CVC_TBL(ext) = duplicate_classext_id_table(RCLASSEXT_CVC_TBL(orig), dup_iclass);
444 duplicate_classext_subclasses(orig, ext);
446 RCLASSEXT_SET_ORIGIN(ext, klass, RCLASSEXT_ORIGIN(orig));
455 RCLASSEXT_PERMANENT_CLASSPATH(ext) = RCLASSEXT_PERMANENT_CLASSPATH(orig);
456 RCLASSEXT_CLONED(ext) = RCLASSEXT_CLONED(orig);
457 RCLASSEXT_CLASSPATH(ext) = RCLASSEXT_CLASSPATH(orig);
470 while (subclass_entry) {
472 iclass = subclass_entry->klass;
476 VM_ASSERT(
FL_TEST_RAW(iclass, RCLASS_NAMESPACEABLE));
477 class_duplicate_iclass_classext(iclass, ext, ns);
480 subclass_entry = subclass_entry->next;
488rb_class_ensure_writable(
VALUE klass)
491 RCLASS_EXT_WRITABLE(klass);
495 rb_class_classext_foreach_callback_func *func;
500class_classext_foreach_i(st_data_t key, st_data_t value, st_data_t arg)
503 rb_class_classext_foreach_callback_func *func =
foreach_arg->func;
509rb_class_classext_foreach(
VALUE klass, rb_class_classext_foreach_callback_func *func,
void *arg)
511 st_table *tbl = RCLASS_CLASSEXT_TBL(klass);
516 rb_st_foreach(tbl, class_classext_foreach_i, (st_data_t)&
foreach_arg);
518 func(RCLASS_EXT_PRIME(klass),
true, (
VALUE)NULL, arg);
522rb_class_super_of(
VALUE klass)
528rb_class_singleton_p(
VALUE klass)
530 return RCLASS_SINGLETON_P(klass);
534rb_class_variation_count(
VALUE klass)
536 return RCLASS_VARIATION_COUNT(klass);
540push_subclass_entry_to_list(
VALUE super,
VALUE klass,
bool is_module)
549 entry->klass = klass;
552 anchor = RCLASS_WRITABLE_SUBCLASSES(super);
555 VM_ASSERT(ns_subclasses);
556 tbl = ns_subclasses->tbl;
561 head->next->prev = entry;
562 entry->next = head->next;
566 st_insert(tbl, namespace_subclasses_tbl_key(ns), (st_data_t)entry);
570 RCLASS_WRITE_NS_MODULE_SUBCLASSES(klass, anchor->ns_subclasses);
573 RCLASS_WRITE_NS_SUPER_SUBCLASSES(klass, anchor->ns_subclasses);
578rb_class_subclass_add(
VALUE super,
VALUE klass)
580 if (super && !UNDEF_P(super)) {
581 push_subclass_entry_to_list(super, klass,
false);
586rb_module_add_to_subclasses_list(
VALUE module,
VALUE iclass)
588 if (module && !UNDEF_P(module)) {
589 push_subclass_entry_to_list(module, iclass,
true);
594rb_class_remove_subclass_head(
VALUE klass)
597 rb_class_classext_free_subclasses(ext, klass,
false);
601class_get_subclasses_for_ns(
struct st_table *tbl,
VALUE ns_id)
604 if (st_lookup(tbl, (st_data_t)ns_id, &value)) {
611remove_class_from_subclasses_replace_first_entry(st_data_t *key, st_data_t *value, st_data_t arg,
int existing)
621 bool first_entry =
true;
623 if (entry->klass == klass) {
635 st_update(tbl, ns_id, remove_class_from_subclasses_replace_first_entry, (st_data_t)next);
639 st_delete(tbl, &ns_id, NULL);
647 else if (first_entry) {
655rb_class_remove_from_super_subclasses(
VALUE klass)
660 if (!ns_subclasses)
return;
661 remove_class_from_subclasses(ns_subclasses->tbl, namespace_subclasses_tbl_key(RCLASSEXT_NS(ext)), klass);
662 rb_ns_subclasses_ref_dec(ns_subclasses);
663 RCLASSEXT_NS_SUPER_SUBCLASSES(ext) = 0;
667rb_class_remove_from_module_subclasses(
VALUE klass)
672 if (!ns_subclasses)
return;
673 remove_class_from_subclasses(ns_subclasses->tbl, namespace_subclasses_tbl_key(RCLASSEXT_NS(ext)), klass);
674 rb_ns_subclasses_ref_dec(ns_subclasses);
675 RCLASSEXT_NS_MODULE_SUBCLASSES(ext) = 0;
682 struct st_table *tbl = anchor->ns_subclasses->tbl;
683 VALUE ns_id = namespace_subclasses_tbl_key(RCLASSEXT_NS(ext));
692 rb_ns_subclasses_ref_count(anchor->ns_subclasses) > 0,
693 "ns_subclasses refcount (%p) %ld", anchor->ns_subclasses, rb_ns_subclasses_ref_count(anchor->ns_subclasses));
694 st_delete(tbl, &ns_id, NULL);
695 rb_ns_subclasses_ref_dec(anchor->ns_subclasses);
698 if (!replacing && RCLASSEXT_NS_SUPER_SUBCLASSES(ext)) {
700 remove_class_from_subclasses(ns_sub->tbl, ns_id, klass);
701 rb_ns_subclasses_ref_dec(ns_sub);
703 if (!replacing && RCLASSEXT_NS_MODULE_SUBCLASSES(ext)) {
705 remove_class_from_subclasses(ns_sub->tbl, ns_id, klass);
706 rb_ns_subclasses_ref_dec(ns_sub);
718 VALUE curklass = cur->klass;
728class_detach_subclasses(
VALUE klass,
VALUE arg)
730 rb_class_remove_from_super_subclasses(klass);
734rb_class_detach_subclasses(
VALUE klass)
736 rb_class_foreach_subclass(klass, class_detach_subclasses,
Qnil);
740class_detach_module_subclasses(
VALUE klass,
VALUE arg)
742 rb_class_remove_from_module_subclasses(klass);
746rb_class_detach_module_subclasses(
VALUE klass)
748 rb_class_foreach_subclass(klass, class_detach_module_subclasses,
Qnil);
752class_switch_superclass(
VALUE super,
VALUE klass)
754 class_detach_subclasses(klass,
Qnil);
755 rb_class_subclass_add(super, klass);
775 if (!ruby_namespace_init_done) {
776 namespaceable =
true;
791 ns_subclasses->refcount = 1;
792 ns_subclasses->tbl = st_init_numtable();
794 anchor->ns_subclasses = ns_subclasses;
801 if (namespaceable) flags |= RCLASS_NAMESPACEABLE;
803 NEWOBJ_OF(obj,
struct RClass, klass, flags, alloc_size, 0);
820 RCLASS_PRIME_NS((
VALUE)obj) = ns;
823 RCLASS_SET_PRIME_CLASSEXT_WRITABLE((
VALUE)obj, !namespaceable || NAMESPACE_USER_P(ns));
826 RCLASS_SET_REFINED_CLASS((
VALUE)obj,
Qnil);
828 RCLASS_SET_SUBCLASSES((
VALUE)obj, anchor);
840class_associate_super(
VALUE klass,
VALUE super,
bool init)
842 if (super && !UNDEF_P(super)) {
843 class_switch_superclass(super, klass);
846 RCLASS_SET_SUPER(klass, super);
849 RCLASS_WRITE_SUPER(klass, super);
851 rb_class_update_superclasses(klass);
858 return class_associate_super(klass, super,
false);
862class_initialize_method_table(
VALUE c)
865 RCLASS_SET_M_TBL(c, rb_id_table_create(0));
869class_clear_method_table(
VALUE c)
871 RCLASS_WRITE_M_TBL(c, rb_id_table_create(0));
875class_boot_namespaceable(
VALUE super,
bool namespaceable)
881 class_initialize_method_table(klass);
883 class_associate_super(klass, super,
true);
884 if (super && !UNDEF_P(super)) {
885 rb_class_set_initialized(klass);
903 return class_boot_namespaceable(super,
false);
907class_superclasses_including_self(
VALUE klass)
909 if (RCLASS_SUPERCLASSES_WITH_SELF_P(klass))
910 return RCLASS_SUPERCLASSES(klass);
912 size_t depth = RCLASS_SUPERCLASS_DEPTH(klass);
915 memcpy(superclasses, RCLASS_SUPERCLASSES(klass),
sizeof(
VALUE) * depth);
916 superclasses[depth] = klass;
922rb_class_update_superclasses(
VALUE klass)
929 if (UNDEF_P(super))
return;
932 if (RCLASS_SUPERCLASSES(klass))
947 rb_class_update_superclasses(super);
950 if (!RCLASS_SUPERCLASS_DEPTH(super))
954 super_depth = RCLASS_SUPERCLASS_DEPTH(super);
955 if (RCLASS_SUPERCLASSES_WITH_SELF_P(super)) {
956 superclasses = RCLASS_SUPERCLASSES(super);
959 superclasses = class_superclasses_including_self(super);
960 RCLASS_WRITE_SUPERCLASSES(super, super_depth, superclasses,
true);
963 size_t depth = super_depth == RCLASS_MAX_SUPERCLASS_DEPTH ? super_depth : super_depth + 1;
964 RCLASS_WRITE_SUPERCLASSES(klass, depth, superclasses,
false);
971 rb_raise(
rb_eTypeError,
"superclass must be an instance of Class (given an instance of %"PRIsVALUE
")",
974 if (RCLASS_SINGLETON_P(super)) {
975 rb_raise(
rb_eTypeError,
"can't make subclass of singleton class");
990 RCLASS_SET_MAX_IV_COUNT(klass, RCLASS_MAX_IV_COUNT(super));
993 RUBY_ASSERT(getenv(
"RUBY_NAMESPACE") || RCLASS_PRIME_CLASSEXT_WRITABLE_P(klass));
999rb_class_s_alloc(
VALUE klass)
1007 if (me->def->type == VM_METHOD_TYPE_ISEQ) {
1008 rb_cref_t *new_cref = rb_vm_rewrite_cref(me->def->body.iseq.
cref, old_klass, new_klass);
1009 rb_add_method_iseq(new_klass, mid, me->def->body.iseq.
iseqptr, new_cref, METHOD_ENTRY_VISI(me));
1012 rb_method_entry_set(new_klass, mid, me, METHOD_ENTRY_VISI(me));
1021static enum rb_id_table_iterator_result
1022clone_method_i(
ID key,
VALUE value,
void *data)
1025 clone_method(arg->old_klass, arg->new_klass, key, (
const rb_method_entry_t *)value);
1026 return ID_TABLE_CONTINUE;
1042 rb_id_table_insert(arg->tbl, key, (
VALUE)nce);
1043 return ID_TABLE_CONTINUE;
1046static enum rb_id_table_iterator_result
1047clone_const_i(
ID key,
VALUE value,
void *data)
1053class_init_copy_check(
VALUE clone,
VALUE orig)
1058 if (RCLASS_INITIALIZED_P(clone)) {
1061 if (RCLASS_SINGLETON_P(orig)) {
1071static enum rb_id_table_iterator_result
1072cvc_table_copy(
ID id,
VALUE val,
void *data)
1081 ent->class_value = ctx->clone;
1082 ent->cref = orig_entry->cref;
1083 ent->global_cvar_state = orig_entry->global_cvar_state;
1084 rb_id_table_insert(ctx->new_table,
id, (
VALUE)ent);
1088 return ID_TABLE_CONTINUE;
1094 if (RCLASS_CONST_TBL(clone)) {
1095 rb_free_const_table(RCLASS_CONST_TBL(clone));
1096 RCLASS_WRITE_CONST_TBL(clone, 0,
false);
1098 if (RCLASS_CVC_TBL(orig)) {
1099 struct rb_id_table *rb_cvc_tbl = RCLASS_CVC_TBL(orig);
1100 struct rb_id_table *rb_cvc_tbl_dup = rb_id_table_create(rb_id_table_size(rb_cvc_tbl));
1104 ctx.new_table = rb_cvc_tbl_dup;
1105 rb_id_table_foreach(rb_cvc_tbl, cvc_table_copy, &ctx);
1106 RCLASS_WRITE_CVC_TBL(clone, rb_cvc_tbl_dup);
1108 rb_id_table_free(RCLASS_M_TBL(clone));
1109 RCLASS_WRITE_M_TBL(clone, 0);
1111 rb_fields_tbl_copy(clone, orig);
1113 if (RCLASS_CONST_TBL(orig)) {
1116 struct rb_id_table *orig_tbl = RCLASS_CONST_TBL(orig);
1117 arg.tbl = const_tbl = rb_id_table_create(rb_id_table_size(orig_tbl));
1119 rb_id_table_foreach(orig_tbl, clone_const_i, &arg);
1120 RCLASS_WRITE_CONST_TBL(clone, const_tbl,
false);
1124static bool ensure_origin(
VALUE klass);
1127rb_class_set_initialized(
VALUE klass)
1135rb_module_check_initializable(
VALUE mod)
1137 if (RCLASS_INITIALIZED_P(mod)) {
1151 class_init_copy_check(clone, orig);
1154 rb_module_check_initializable(clone);
1164 rb_class_set_initialized(clone);
1169 RCLASS_SET_CLONED(clone,
true);
1170 RCLASS_SET_CLONED(orig,
true);
1172 if (!RCLASS_SINGLETON_P(
CLASS_OF(clone))) {
1177 RCLASS_SET_ALLOCATOR(clone, RCLASS_ALLOCATOR(orig));
1179 copy_tables(clone, orig);
1180 if (RCLASS_M_TBL(orig)) {
1182 arg.old_klass = orig;
1183 arg.new_klass = clone;
1184 class_initialize_method_table(clone);
1185 rb_id_table_foreach(RCLASS_M_TBL(orig), clone_method_i, &arg);
1188 if (RCLASS_ORIGIN(orig) == orig) {
1193 VALUE orig_origin = RCLASS_ORIGIN(orig);
1194 VALUE prev_clone_p = clone;
1202 ensure_origin(clone);
1203 clone_origin = RCLASS_ORIGIN(clone);
1205 while (p && p != orig_origin) {
1207 rb_bug(
"non iclass between module/class and origin");
1209 clone_p = class_alloc(
T_ICLASS, METACLASS_OF(p));
1210 RCLASS_SET_M_TBL(clone_p, RCLASS_M_TBL(p));
1211 rb_class_set_super(prev_clone_p, clone_p);
1212 prev_clone_p = clone_p;
1213 RCLASS_SET_CONST_TBL(clone_p, RCLASS_CONST_TBL(p),
false);
1215 RCLASS_SET_INCLUDER(clone_p, clone);
1217 add_subclass = TRUE;
1218 if (p != RCLASS_ORIGIN(p)) {
1219 origin[0] = clone_p;
1220 origin[1] = RCLASS_ORIGIN(p);
1223 else if ((origin_len =
RARRAY_LEN(origin_stack)) > 1 &&
1225 RCLASS_WRITE_ORIGIN(
RARRAY_AREF(origin_stack, (origin_len -= 2)), clone_p);
1226 RICLASS_WRITE_ORIGIN_SHARED_MTBL(clone_p);
1228 add_subclass = FALSE;
1231 rb_module_add_to_subclasses_list(METACLASS_OF(p), clone_p);
1236 if (p == orig_origin) {
1238 rb_class_set_super(clone_p, clone_origin);
1239 rb_class_set_super(clone_origin,
RCLASS_SUPER(orig_origin));
1241 copy_tables(clone_origin, orig_origin);
1242 if (RCLASS_M_TBL(orig_origin)) {
1244 arg.old_klass = orig;
1245 arg.new_klass = clone;
1246 class_initialize_method_table(clone_origin);
1247 rb_id_table_foreach(RCLASS_M_TBL(orig_origin), clone_method_i, &arg);
1251 rb_bug(
"no origin for class that has origin");
1254 rb_class_update_superclasses(clone);
1263 return rb_singleton_class_clone_and_attach(obj,
Qundef);
1268rb_singleton_class_clone_and_attach(
VALUE obj,
VALUE attach)
1270 const VALUE klass = METACLASS_OF(obj);
1276 if (!(RCLASS_SINGLETON_P(klass) && RCLASS_ATTACHED_OBJECT(klass) == obj)) {
1282 bool klass_of_clone_is_new;
1287 klass_of_clone_is_new =
true;
1288 RBASIC_SET_CLASS(clone, clone);
1294 klass_of_clone_is_new = (METACLASS_OF(klass) != klass_metaclass_clone);
1295 RBASIC_SET_CLASS(clone, klass_metaclass_clone);
1299 class_initialize_method_table(clone);
1302 rb_fields_tbl_copy(clone, klass);
1303 if (RCLASS_CONST_TBL(klass)) {
1306 arg.tbl = table = rb_id_table_create(rb_id_table_size(RCLASS_CONST_TBL(klass)));
1308 rb_id_table_foreach(RCLASS_CONST_TBL(klass), clone_const_i, &arg);
1309 RCLASS_SET_CONST_TBL(clone, table,
false);
1311 if (!UNDEF_P(attach)) {
1316 arg.old_klass = klass;
1317 arg.new_klass = clone;
1318 rb_id_table_foreach(RCLASS_M_TBL(klass), clone_method_i, &arg);
1320 if (klass_of_clone_is_new) {
1332 if (RCLASS_SINGLETON_P(klass)) {
1333 RCLASS_SET_ATTACHED_OBJECT(klass, obj);
1342#define META_CLASS_OF_CLASS_CLASS_P(k) (METACLASS_OF(k) == (k))
1345rb_singleton_class_has_metaclass_p(
VALUE sklass)
1347 return RCLASS_ATTACHED_OBJECT(METACLASS_OF(sklass)) == sklass;
1351rb_singleton_class_internal_p(
VALUE sklass)
1354 !rb_singleton_class_has_metaclass_p(sklass));
1362#define HAVE_METACLASS_P(k) \
1363 (FL_TEST(METACLASS_OF(k), FL_SINGLETON) && \
1364 rb_singleton_class_has_metaclass_p(k))
1373#define ENSURE_EIGENCLASS(klass) \
1374 (HAVE_METACLASS_P(klass) ? METACLASS_OF(klass) : make_metaclass(klass))
1396 SET_METACLASS_OF(klass, metaclass);
1397 SET_METACLASS_OF(metaclass, metaclass);
1400 VALUE tmp = METACLASS_OF(klass);
1401 SET_METACLASS_OF(klass, metaclass);
1408 rb_class_set_initialized(klass);
1411 rb_class_update_superclasses(METACLASS_OF(metaclass));
1425 VALUE orig_class = METACLASS_OF(obj);
1426 VALUE klass = class_boot_namespaceable(orig_class,
FL_TEST_RAW(orig_class, RCLASS_NAMESPACEABLE));
1429 RBASIC_SET_CLASS(obj, klass);
1431 rb_yjit_invalidate_no_singleton_class(orig_class);
1432 rb_zjit_invalidate_no_singleton_class(orig_class);
1434 SET_METACLASS_OF(klass, METACLASS_OF(
rb_class_real(orig_class)));
1440boot_defclass(
const char *name,
VALUE super)
1443 ID id = rb_intern(name);
1445 rb_const_set((rb_cObject ? rb_cObject : obj), id, obj);
1446 rb_vm_register_global_object(obj);
1497refinement_import_methods(
int argc,
VALUE *argv,
VALUE refinement)
1522Init_class_hierarchy(
void)
1526 rb_vm_register_global_object(rb_cObject);
1531 rb_cModule = boot_defclass(
"Module", rb_cObject);
1543 RBASIC_SET_CLASS(rb_cObject,
rb_cClass);
1577 if (!super) super = rb_cObject;
1579 rb_make_metaclass(klass, METACLASS_OF(super));
1597 if (!super) super = rb_cObject;
1599 return rb_funcall(super, inherited, 1, klass);
1609 id = rb_intern(name);
1610 if (NAMESPACE_OPTIONAL_P(ns)) {
1620 rb_raise(
rb_eTypeError,
"superclass mismatch for class %s", name);
1624 rb_vm_register_global_object(klass);
1628 rb_raise(rb_eArgError,
"no super class for '%s'", name);
1631 rb_vm_register_global_object(klass);
1645rb_define_class_id_under_no_pin(
VALUE outer,
ID id,
VALUE super)
1652 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
"::%"PRIsVALUE
" is not a class"
1658 "%"PRIsVALUE
"::%"PRIsVALUE
""
1659 " (%"PRIsVALUE
" is given but was %"PRIsVALUE
")",
1666 rb_raise(rb_eArgError,
"no super class for '%"PRIsVALUE
"::%"PRIsVALUE
"'",
1680 VALUE klass = rb_define_class_id_under_no_pin(outer,
id, super);
1681 rb_vm_register_global_object(klass);
1686rb_module_s_alloc(
VALUE klass)
1689 class_initialize_method_table(mod);
1694module_new(
VALUE klass)
1697 class_initialize_method_table(mdl);
1727 id = rb_intern(name);
1728 if (NAMESPACE_OPTIONAL_P(ns)) {
1732 module = rb_const_get(rb_cObject, id);
1734 rb_raise(
rb_eTypeError,
"%s is not a module (%"PRIsVALUE
")",
1738 rb_vm_register_global_object(module);
1741 module = rb_module_new();
1742 rb_vm_register_global_object(module);
1760 module = rb_const_get_at(outer, id);
1762 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
"::%"PRIsVALUE
" is not a module"
1767 rb_vm_register_global_object(module);
1770 module = rb_module_new();
1773 rb_vm_register_global_object(module);
1779rb_include_class_new(
VALUE module,
VALUE super)
1783 RCLASS_SET_M_TBL(klass, RCLASS_WRITABLE_M_TBL(module));
1785 RCLASS_SET_ORIGIN(klass, klass);
1787 module = METACLASS_OF(module);
1790 if (RCLASS_WRITABLE_CONST_TBL(module)) {
1791 RCLASS_SET_CONST_TBL(klass, RCLASS_WRITABLE_CONST_TBL(module),
true);
1794 RCLASS_WRITE_CONST_TBL(module, rb_id_table_create(0),
false);
1795 RCLASS_SET_CONST_TBL(klass, RCLASS_WRITABLE_CONST_TBL(module),
true);
1798 RCLASS_SET_CVC_TBL(klass, RCLASS_WRITABLE_CVC_TBL(module));
1800 class_associate_super(klass, super,
true);
1801 RBASIC_SET_CLASS(klass, module);
1803 return (
VALUE)klass;
1806static int include_modules_at(
const VALUE klass,
VALUE c,
VALUE module,
int search_super);
1813 rb_class_set_initialized(module);
1814 if (!
NIL_P(rb_refinement_module_get_refined_class(module))) {
1815 rb_raise(rb_eArgError,
"refinement module is not allowed");
1824 ensure_includable(klass, module);
1826 changed = include_modules_at(klass, RCLASS_ORIGIN(klass), module, TRUE);
1828 rb_raise(rb_eArgError,
"cyclic include detected");
1834 VALUE check_class = iclass->klass;
1837 if (!rb_objspace_garbage_object_p(check_class)) {
1838 while (check_class) {
1839 RUBY_ASSERT(!rb_objspace_garbage_object_p(check_class));
1842 (METACLASS_OF(check_class) == module)) {
1849 include_modules_at(iclass->klass, RCLASS_ORIGIN(iclass->klass), module, TRUE);
1853 iclass = iclass->next;
1858static enum rb_id_table_iterator_result
1859add_refined_method_entry_i(
ID key,
VALUE value,
void *data)
1861 rb_add_refined_method_entry((
VALUE)data, key);
1862 return ID_TABLE_CONTINUE;
1865static enum rb_id_table_iterator_result
1866clear_module_cache_i(
ID id,
VALUE val,
void *data)
1869 rb_clear_method_cache(klass,
id);
1870 return ID_TABLE_CONTINUE;
1874module_in_super_chain(
const VALUE klass,
VALUE module)
1876 struct rb_id_table *
const klass_m_tbl = RCLASS_M_TBL(RCLASS_ORIGIN(klass));
1879 if (klass_m_tbl == RCLASS_M_TBL(module))
1881 module = RCLASS_SUPER(module);
1889static enum rb_id_table_iterator_result
1890clear_constant_cache_i(
ID id,
VALUE value,
void *data)
1893 return ID_TABLE_CONTINUE;
1897do_include_modules_at(
const VALUE klass,
VALUE c,
VALUE module,
int search_super,
bool check_cyclic)
1899 VALUE p, iclass, origin_stack = 0;
1900 int method_changed = 0;
1902 VALUE klass_origin = RCLASS_ORIGIN(klass);
1903 VALUE original_klass = klass;
1905 if (check_cyclic && module_in_super_chain(klass, module))
1910 int superclass_seen = FALSE;
1916 if (klass_origin != c || search_super) {
1922 if (klass_origin == p && !search_super)
1927 if (RCLASS_M_TBL(p) == RCLASS_M_TBL(module)) {
1928 if (!superclass_seen && c_seen) {
1935 superclass_seen = TRUE;
1943 RB_DEBUG_COUNTER_INC(cvar_include_invalidate);
1944 ruby_vm_global_cvar_state++;
1945 tbl = RCLASS_M_TBL(module);
1946 if (tbl && rb_id_table_size(tbl)) {
1949 rb_id_table_foreach(tbl, clear_module_cache_i, (
void *)super_class);
1954 rb_id_table_foreach(tbl, clear_module_cache_i, (
void *)original_klass);
1961 iclass = rb_include_class_new(module, super_class);
1962 c = rb_class_set_super(c, iclass);
1963 RCLASS_SET_INCLUDER(iclass, klass);
1964 if (module != RCLASS_ORIGIN(module)) {
1966 VALUE origin[2] = {iclass, RCLASS_ORIGIN(module)};
1969 else if (origin_stack && (origin_len =
RARRAY_LEN(origin_stack)) > 1 &&
1970 RARRAY_AREF(origin_stack, origin_len - 1) == module) {
1971 RCLASS_WRITE_ORIGIN(
RARRAY_AREF(origin_stack, (origin_len -= 2)), iclass);
1972 RICLASS_WRITE_ORIGIN_SHARED_MTBL(iclass);
1978 rb_module_add_to_subclasses_list(m, iclass);
1981 VALUE refined_class =
1982 rb_refinement_module_get_refined_class(klass);
1984 rb_id_table_foreach(RCLASS_M_TBL(module), add_refined_method_entry_i, (
void *)refined_class);
1988 tbl = RCLASS_CONST_TBL(module);
1989 if (tbl && rb_id_table_size(tbl))
1990 rb_id_table_foreach(tbl, clear_constant_cache_i, NULL);
1992 module = RCLASS_SUPER(module);
1995 return method_changed;
1999include_modules_at(
const VALUE klass,
VALUE c,
VALUE module,
int search_super)
2001 return do_include_modules_at(klass, c, module, search_super,
true);
2004static enum rb_id_table_iterator_result
2005move_refined_method(
ID key,
VALUE value,
void *data)
2009 if (me->def->type == VM_METHOD_TYPE_REFINED) {
2011 struct rb_id_table *tbl = RCLASS_WRITABLE_M_TBL(klass);
2013 if (me->def->body.refined.orig_me) {
2015 RB_OBJ_WRITE(me, &me->def->body.refined.orig_me, NULL);
2016 new_me = rb_method_entry_clone(me);
2017 rb_method_table_insert(klass, tbl, key, new_me);
2018 rb_method_entry_copy(me, orig_me);
2019 return ID_TABLE_CONTINUE;
2022 rb_method_table_insert(klass, tbl, key, me);
2023 return ID_TABLE_DELETE;
2027 return ID_TABLE_CONTINUE;
2031static enum rb_id_table_iterator_result
2032cache_clear_refined_method(
ID key,
VALUE value,
void *data)
2036 if (me->def->type == VM_METHOD_TYPE_REFINED && me->def->body.refined.orig_me) {
2038 rb_clear_method_cache(klass, me->called_id);
2043 return ID_TABLE_CONTINUE;
2047ensure_origin(
VALUE klass)
2049 VALUE origin = RCLASS_ORIGIN(klass);
2050 if (origin == klass) {
2051 origin = class_alloc(
T_ICLASS, klass);
2052 RCLASS_SET_M_TBL(origin, RCLASS_M_TBL(klass));
2054 rb_class_set_super(klass, origin);
2055 RCLASS_WRITE_ORIGIN(klass, origin);
2059 rb_gc_writebarrier_remember(origin);
2061 class_clear_method_table(klass);
2062 rb_id_table_foreach(RCLASS_M_TBL(origin), cache_clear_refined_method, (
void *)klass);
2063 rb_id_table_foreach(RCLASS_M_TBL(origin), move_refined_method, (
void *)klass);
2073 bool klass_had_no_origin;
2075 ensure_includable(klass, module);
2076 if (module_in_super_chain(klass, module))
2077 rb_raise(rb_eArgError,
"cyclic prepend detected");
2079 klass_had_no_origin = ensure_origin(klass);
2080 changed = do_include_modules_at(klass, klass, module, FALSE,
false);
2083 rb_vm_check_redefinition_by_prepend(klass);
2087 VALUE klass_origin = RCLASS_ORIGIN(klass);
2088 struct rb_id_table *klass_m_tbl = RCLASS_M_TBL(klass);
2089 struct rb_id_table *klass_origin_m_tbl = RCLASS_M_TBL(klass_origin);
2093 if (!rb_objspace_garbage_object_p(iclass->klass)) {
2094 const VALUE subclass = iclass->klass;
2095 if (klass_had_no_origin && klass_origin_m_tbl == RCLASS_M_TBL(subclass)) {
2097 rb_id_table_foreach(RCLASS_M_TBL(subclass), clear_module_cache_i, (
void *)subclass);
2098 RCLASS_WRITE_M_TBL(subclass, klass_m_tbl);
2100 rb_class_set_super(subclass, origin);
2101 RCLASS_SET_INCLUDER(origin, RCLASS_INCLUDER(subclass));
2102 RCLASS_WRITE_ORIGIN(subclass, origin);
2103 RICLASS_SET_ORIGIN_SHARED_MTBL(origin);
2105 include_modules_at(subclass, subclass, module, FALSE);
2108 iclass = iclass->next;
2140 VALUE origin = RCLASS_ORIGIN(mod);
2144 VALUE m = METACLASS_OF(p);
2179 if (METACLASS_OF(p) == mod2)
return Qtrue;
2209 refined_class = rb_refinement_module_get_refined_class(mod);
2213 if (p == refined_class)
break;
2214 if (p != RCLASS_ORIGIN(p))
continue;
2230 bool immediate_only;
2234class_descendants_recursive(
VALUE klass,
VALUE v)
2239 if (data->buffer && data->count < data->maxcount && !rb_objspace_garbage_object_p(klass)) {
2244 if (!data->immediate_only) {
2245 rb_class_foreach_subclass(klass, class_descendants_recursive, v);
2249 rb_class_foreach_subclass(klass, class_descendants_recursive, v);
2254class_descendants(
VALUE klass,
bool immediate_only)
2259 rb_class_foreach_subclass(klass, class_descendants_recursive, (
VALUE) &data);
2263 data.maxcount = data.count;
2266 size_t gc_count = rb_gc_count();
2269 rb_class_foreach_subclass(klass, class_descendants_recursive, (
VALUE) &data);
2271 if (gc_count != rb_gc_count()) {
2272 rb_bug(
"GC must not occur during the subclass iteration of Class#descendants");
2320 return class_descendants(klass,
true);
2343 if (!RCLASS_SINGLETON_P(klass)) {
2344 rb_raise(
rb_eTypeError,
"'%"PRIsVALUE
"' is not a singleton class", klass);
2347 return RCLASS_ATTACHED_OBJECT(klass);
2351ins_methods_push(st_data_t name, st_data_t ary)
2357ins_methods_i(st_data_t name, st_data_t
type, st_data_t ary)
2359 switch ((rb_method_visibility_t)
type) {
2360 case METHOD_VISI_UNDEF:
2361 case METHOD_VISI_PRIVATE:
2364 ins_methods_push(name, ary);
2371ins_methods_type_i(st_data_t name, st_data_t
type, st_data_t ary, rb_method_visibility_t visi)
2373 if ((rb_method_visibility_t)
type == visi) {
2374 ins_methods_push(name, ary);
2380ins_methods_prot_i(st_data_t name, st_data_t
type, st_data_t ary)
2382 return ins_methods_type_i(name,
type, ary, METHOD_VISI_PROTECTED);
2386ins_methods_priv_i(st_data_t name, st_data_t
type, st_data_t ary)
2388 return ins_methods_type_i(name,
type, ary, METHOD_VISI_PRIVATE);
2392ins_methods_pub_i(st_data_t name, st_data_t
type, st_data_t ary)
2394 return ins_methods_type_i(name,
type, ary, METHOD_VISI_PUBLIC);
2398ins_methods_undef_i(st_data_t name, st_data_t
type, st_data_t ary)
2400 return ins_methods_type_i(name,
type, ary, METHOD_VISI_UNDEF);
2408static enum rb_id_table_iterator_result
2409method_entry_i(
ID key,
VALUE value,
void *data)
2413 rb_method_visibility_t
type;
2415 if (me->def->type == VM_METHOD_TYPE_REFINED) {
2416 VALUE owner = me->owner;
2417 me = rb_resolve_refined_method(
Qnil, me);
2418 if (!me)
return ID_TABLE_CONTINUE;
2419 if (!arg->recur && me->owner != owner)
return ID_TABLE_CONTINUE;
2421 if (!st_is_member(arg->list, key)) {
2422 if (UNDEFINED_METHOD_ENTRY_P(me)) {
2423 type = METHOD_VISI_UNDEF;
2426 type = METHOD_ENTRY_VISI(me);
2429 st_add_direct(arg->list, key, (st_data_t)
type);
2431 return ID_TABLE_CONTINUE;
2439 rb_id_table_foreach(m_tbl, method_entry_i, me_arg);
2443particular_class_p(
VALUE mod)
2445 if (!mod)
return false;
2446 if (RCLASS_SINGLETON_P(mod))
return true;
2452class_instance_method_list(
int argc,
const VALUE *argv,
VALUE mod,
int obj,
int (*func) (st_data_t, st_data_t, st_data_t))
2455 int recur = TRUE, prepended = 0;
2460 me_arg.list = st_init_numtable();
2461 me_arg.recur = recur;
2464 for (; particular_class_p(mod); mod =
RCLASS_SUPER(mod)) {
2465 add_instance_method_list(mod, &me_arg);
2469 if (!recur && RCLASS_ORIGIN(mod) != mod) {
2470 mod = RCLASS_ORIGIN(mod);
2475 add_instance_method_list(mod, &me_arg);
2480 st_foreach(me_arg.list, func, ary);
2481 st_free_table(me_arg.list);
2525 return class_instance_method_list(argc, argv, mod, 0, ins_methods_i);
2540 return class_instance_method_list(argc, argv, mod, 0, ins_methods_prot_i);
2563 return class_instance_method_list(argc, argv, mod, 0, ins_methods_priv_i);
2578 return class_instance_method_list(argc, argv, mod, 0, ins_methods_pub_i);
2590rb_class_undefined_instance_methods(
VALUE mod)
2593 return class_instance_method_list(1, &include_super, mod, 0, ins_methods_undef_i);
2627rb_obj_methods(
int argc,
const VALUE *argv,
VALUE obj)
2630 if (argc > 0 && !
RTEST(argv[0])) {
2633 return class_instance_method_list(argc, argv,
CLASS_OF(obj), 1, ins_methods_i);
2646rb_obj_protected_methods(
int argc,
const VALUE *argv,
VALUE obj)
2648 return class_instance_method_list(argc, argv,
CLASS_OF(obj), 1, ins_methods_prot_i);
2661rb_obj_private_methods(
int argc,
const VALUE *argv,
VALUE obj)
2663 return class_instance_method_list(argc, argv,
CLASS_OF(obj), 1, ins_methods_priv_i);
2676rb_obj_public_methods(
int argc,
const VALUE *argv,
VALUE obj)
2678 return class_instance_method_list(argc, argv,
CLASS_OF(obj), 1, ins_methods_pub_i);
2717 VALUE ary, klass, origin;
2723 if (RCLASS_SINGLETON_P(obj)) {
2727 origin = RCLASS_ORIGIN(klass);
2728 me_arg.list = st_init_numtable();
2729 me_arg.recur = recur;
2730 if (klass && RCLASS_SINGLETON_P(klass)) {
2731 if ((mtbl = RCLASS_M_TBL(origin)) != 0) rb_id_table_foreach(mtbl, method_entry_i, &me_arg);
2736 if (klass != origin && (mtbl = RCLASS_M_TBL(klass)) != 0) rb_id_table_foreach(mtbl, method_entry_i, &me_arg);
2741 st_foreach(me_arg.list, ins_methods_i, ary);
2742 st_free_table(me_arg.list);
2755#ifdef rb_define_method_id
2756#undef rb_define_method_id
2761 rb_add_method_cfunc(klass, mid, func, argc, METHOD_VISI_PUBLIC);
2764#ifdef rb_define_method
2765#undef rb_define_method
2770 rb_add_method_cfunc(klass, rb_intern(name), func, argc, METHOD_VISI_PUBLIC);
2773#ifdef rb_define_protected_method
2774#undef rb_define_protected_method
2779 rb_add_method_cfunc(klass, rb_intern(name), func, argc, METHOD_VISI_PROTECTED);
2782#ifdef rb_define_private_method
2783#undef rb_define_private_method
2788 rb_add_method_cfunc(klass, rb_intern(name), func, argc, METHOD_VISI_PRIVATE);
2794 rb_add_method(klass, rb_intern(name), VM_METHOD_TYPE_UNDEF, 0, METHOD_VISI_UNDEF);
2797static enum rb_id_table_iterator_result
2798undef_method_i(
ID name,
VALUE value,
void *data)
2801 rb_add_method(klass, name, VM_METHOD_TYPE_UNDEF, 0, METHOD_VISI_UNDEF);
2802 return ID_TABLE_CONTINUE;
2806rb_undef_methods_from(
VALUE klass,
VALUE super)
2810 rb_id_table_foreach(mtbl, undef_method_i, (
void *)klass);
2823special_singleton_class_of(
VALUE obj)
2829 default:
return Qnil;
2834rb_special_singleton_class(
VALUE obj)
2836 return special_singleton_class_of(obj);
2849singleton_class_of(
VALUE obj)
2853 switch (
TYPE(obj)) {
2863 klass = special_singleton_class_of(obj);
2865 rb_bug(
"unknown immediate %p", (
void *)obj);
2869 if (CHILLED_STRING_P(obj)) {
2870 CHILLED_STRING_MUTATED(obj);
2877 klass = METACLASS_OF(obj);
2878 if (!(RCLASS_SINGLETON_P(klass) &&
2879 RCLASS_ATTACHED_OBJECT(klass) == obj)) {
2880 klass = rb_make_metaclass(obj, klass);
2892 if (!RCLASS_SINGLETON_P(x)) {
2915 return rb_special_singleton_class(obj);
2917 klass = METACLASS_OF(obj);
2918 if (!RCLASS_SINGLETON_P(klass))
return Qnil;
2919 if (RCLASS_ATTACHED_OBJECT(klass) != obj)
return Qnil;
2926 VALUE klass = singleton_class_of(obj);
2943#ifdef rb_define_singleton_method
2944#undef rb_define_singleton_method
2952#ifdef rb_define_module_function
2953#undef rb_define_module_function
2962#ifdef rb_define_global_function
2963#undef rb_define_global_function
2974 rb_alias(klass, rb_intern(name1), rb_intern(name2));
2980 rb_attr(klass, rb_intern(name), read, write, FALSE);
2984rb_keyword_error_new(
const char *error,
VALUE keys)
2987 VALUE error_message = rb_sprintf(
"%s keyword%.*s", error,
len > 1,
"s");
2994 if (++i >=
len)
break;
3002NORETURN(
static void rb_keyword_error(
const char *error,
VALUE keys));
3004rb_keyword_error(
const char *error,
VALUE keys)
3009NORETURN(
static void unknown_keyword_error(
VALUE hash,
const ID *table,
int keywords));
3011unknown_keyword_error(
VALUE hash,
const ID *table,
int keywords)
3014 for (i = 0; i < keywords; i++) {
3015 st_data_t key =
ID2SYM(table[i]);
3016 rb_hash_stlike_delete(hash, &key, NULL);
3018 rb_keyword_error(
"unknown", rb_hash_keys(hash));
3023separate_symbol(st_data_t key, st_data_t value, st_data_t arg)
3027 if (!*kwdhash) *kwdhash = rb_hash_new();
3028 rb_hash_aset(*kwdhash, (
VALUE)key, (
VALUE)value);
3035 VALUE parthash[2] = {0, 0};
3036 VALUE hash = *orighash;
3043 *orighash = parthash[1];
3058#define extract_kwarg(keyword, val) \
3059 (key = (st_data_t)(keyword), values ? \
3060 (rb_hash_stlike_delete(keyword_hash, &key, &(val)) || ((val) = Qundef, 0)) : \
3061 rb_hash_stlike_lookup(keyword_hash, key, NULL))
3063 if (
NIL_P(keyword_hash)) keyword_hash = 0;
3067 optional = -1-optional;
3070 for (; i < required; i++) {
3073 if (extract_kwarg(keyword, values[i])) {
3080 if (!
NIL_P(missing)) {
3081 rb_keyword_error(
"missing", missing);
3085 if (optional && keyword_hash) {
3086 for (i = 0; i < optional; i++) {
3087 if (extract_kwarg(
ID2SYM(table[required+i]), values[required+i])) {
3092 if (!rest && keyword_hash) {
3093 if (
RHASH_SIZE(keyword_hash) > (
unsigned int)(values ? 0 : j)) {
3094 unknown_keyword_error(keyword_hash, table, required+optional);
3097 if (values && !keyword_hash) {
3098 for (i = 0; i < required + optional; i++) {
3117rb_scan_args_parse(
int kw_flag,
const char *fmt,
struct rb_scan_args_t *arg)
3119 const char *p = fmt;
3121 memset(arg, 0,
sizeof(*arg));
3122 arg->kw_flag = kw_flag;
3125 arg->n_lead = *p -
'0';
3128 arg->n_opt = *p -
'0';
3137 arg->n_trail = *p -
'0';
3149 rb_fatal(
"bad scan arg format: %s", fmt);
3154rb_scan_args_assign(
const struct rb_scan_args_t *arg,
int argc,
const VALUE *
const argv, va_list vargs)
3158#define rb_scan_args_next_param() va_arg(vargs, VALUE *)
3159 const int kw_flag = arg->kw_flag;
3160 const int n_lead = arg->n_lead;
3161 const int n_opt = arg->n_opt;
3162 const int n_trail = arg->n_trail;
3163 const int n_mand = n_lead + n_trail;
3164 const bool f_var = arg->f_var;
3165 const bool f_hash = arg->f_hash;
3166 const bool f_block = arg->f_block;
3169 if (f_hash && argc > 0) {
3170 VALUE last = argv[argc - 1];
3171 if (rb_scan_args_keyword_p(kw_flag, last)) {
3172 hash = rb_hash_dup(last);
3177 if (argc < n_mand) {
3182 for (i = 0; i < n_lead; i++) {
3183 var = rb_scan_args_next_param();
3184 if (var) *var = argv[argi];
3188 for (i = 0; i < n_opt; i++) {
3189 var = rb_scan_args_next_param();
3190 if (argi < argc - n_trail) {
3191 if (var) *var = argv[argi];
3195 if (var) *var =
Qnil;
3200 int n_var = argc - argi - n_trail;
3202 var = rb_scan_args_next_param();
3212 for (i = 0; i < n_trail; i++) {
3213 var = rb_scan_args_next_param();
3214 if (var) *var = argv[argi];
3219 var = rb_scan_args_next_param();
3220 if (var) *var = hash;
3224 var = rb_scan_args_next_param();
3239#undef rb_scan_args_next_param
3243rb_scan_args_result(
const struct rb_scan_args_t *
const arg,
int argc)
3245 const int n_lead = arg->n_lead;
3246 const int n_opt = arg->n_opt;
3247 const int n_trail = arg->n_trail;
3248 const int n_mand = n_lead + n_trail;
3249 const bool f_var = arg->f_var;
3267 va_start(vargs,fmt);
3268 argc = rb_scan_args_assign(&arg, argc, argv, vargs);
3270 return rb_scan_args_result(&arg, argc);
3273#undef rb_scan_args_kw
3279 rb_scan_args_parse(kw_flag, fmt, &arg);
3280 va_start(vargs,fmt);
3281 argc = rb_scan_args_assign(&arg, argc, argv, vargs);
3283 return rb_scan_args_result(&arg, argc);
#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_method_id(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
#define rb_define_protected_method(klass, mid, func, arity)
Defines klass#mid and makes it protected.
#define rb_define_module_function(klass, mid, func, arity)
Defines klass#mid and makes it a module function.
#define rb_define_private_method(klass, mid, func, arity)
Defines klass#mid and makes it private.
#define rb_define_global_function(mid, func, arity)
Defines rb_mKernel #mid.
#define RUBY_EXTERN
Declaration of externally visible global variables.
static VALUE RB_OBJ_FROZEN_RAW(VALUE obj)
This is an implementation detail of RB_OBJ_FROZEN().
static void RB_FL_SET_RAW(VALUE obj, VALUE flags)
This is an implementation detail of RB_FL_SET().
VALUE rb_class_protected_instance_methods(int argc, const VALUE *argv, VALUE mod)
Identical to rb_class_instance_methods(), except it returns names of methods that are protected only.
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
VALUE rb_refinement_new(void)
Creates a new, anonymous refinement.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
VALUE rb_class_new(VALUE super)
Creates a new, anonymous class.
static VALUE make_singleton_class(VALUE obj)
Creates a singleton class for obj.
VALUE rb_singleton_class_clone(VALUE obj)
Clones a singleton class.
void rb_prepend_module(VALUE klass, VALUE module)
Identical to rb_include_module(), except it "prepends" the passed module to the klass,...
VALUE rb_class_subclasses(VALUE klass)
Queries the class's direct descendants.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
VALUE rb_class_attached_object(VALUE klass)
Returns the attached object for a singleton class.
VALUE rb_obj_singleton_methods(int argc, const VALUE *argv, VALUE obj)
Identical to rb_class_instance_methods(), except it returns names of singleton methods instead of ins...
VALUE rb_module_new(void)
Creates a new, anonymous module.
#define META_CLASS_OF_CLASS_CLASS_P(k)
whether k is a meta^(n)-class of Class class
VALUE rb_class_instance_methods(int argc, const VALUE *argv, VALUE mod)
Generates an array of symbols, which are the list of method names defined in the passed class.
void rb_check_inheritable(VALUE super)
Asserts that the given class can derive a child class.
VALUE rb_class_public_instance_methods(int argc, const VALUE *argv, VALUE mod)
Identical to rb_class_instance_methods(), except it returns names of methods that are public only.
static VALUE class_alloc0(enum ruby_value_type type, VALUE klass, bool namespaceable)
Allocates a struct RClass for a new class, iclass, or module.
VALUE rb_class_boot(VALUE super)
A utility function that wraps class_alloc.
VALUE rb_define_module(const char *name)
Defines a top-level module.
void rb_class_modify_check(VALUE klass)
Asserts that klass is not a frozen class.
VALUE rb_define_module_id_under(VALUE outer, ID id)
Identical to rb_define_module_under(), except it takes the name in ID instead of C's string.
void rb_singleton_class_attached(VALUE klass, VALUE obj)
Attaches a singleton class to its corresponding object.
void rb_freeze_singleton_class(VALUE x)
This is an implementation detail of RB_OBJ_FREEZE().
VALUE rb_mod_included_modules(VALUE mod)
Queries the list of included modules.
VALUE rb_define_class_id_under(VALUE outer, ID id, VALUE super)
Identical to rb_define_class_under(), except it takes the name in ID instead of C's string.
VALUE rb_mod_ancestors(VALUE mod)
Queries the module's ancestors.
static VALUE make_metaclass(VALUE klass)
Creates a metaclass of klass
VALUE rb_class_inherited(VALUE super, VALUE klass)
Calls Class::inherited.
VALUE rb_mod_include_p(VALUE mod, VALUE mod2)
Queries if the passed module is included by the module.
VALUE rb_class_private_instance_methods(int argc, const VALUE *argv, VALUE mod)
Identical to rb_class_instance_methods(), except it returns names of methods that are private only.
#define ENSURE_EIGENCLASS(klass)
ensures klass belongs to its own eigenclass.
VALUE rb_mod_init_copy(VALUE clone, VALUE orig)
The comment that comes with this function says :nodoc:.
VALUE rb_define_module_under(VALUE outer, const char *name)
Defines a module under the namespace of outer.
VALUE rb_singleton_class_get(VALUE obj)
Returns the singleton class of obj, or nil if obj is not a singleton object.
VALUE rb_define_module_id(ID id)
This is a very badly designed API that creates an anonymous module.
VALUE rb_define_class_id(ID id, VALUE super)
This is a very badly designed API that creates an anonymous class.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
VALUE rb_extract_keywords(VALUE *orighash)
Splits a hash into two.
void rb_define_attr(VALUE klass, const char *name, int read, int write)
Defines public accessor method(s) for an attribute.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
int rb_scan_args_kw(int kw_flag, int argc, const VALUE *argv, const char *fmt,...)
Identical to rb_scan_args(), except it also accepts kw_splat.
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.
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define TYPE(_)
Old name of rb_type.
#define FL_SINGLETON
Old name of RUBY_FL_SINGLETON.
#define OBJ_INIT_COPY(obj, orig)
Old name of RB_OBJ_INIT_COPY.
#define ALLOC
Old name of RB_ALLOC.
#define T_STRING
Old name of RUBY_T_STRING.
#define xfree
Old name of ruby_xfree.
#define Qundef
Old name of RUBY_Qundef.
#define T_NIL
Old name of RUBY_T_NIL.
#define T_FLOAT
Old name of RUBY_T_FLOAT.
#define ID2SYM
Old name of RB_ID2SYM.
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define T_FIXNUM
Old name of RUBY_T_FIXNUM.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define ZALLOC
Old name of RB_ZALLOC.
#define FL_SHAREABLE
Old name of RUBY_FL_SHAREABLE.
#define CLASS_OF
Old name of rb_class_of.
#define xmalloc
Old name of ruby_xmalloc.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define ISDIGIT
Old name of rb_isdigit.
#define T_TRUE
Old name of RUBY_T_TRUE.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define FL_SET
Old name of RB_FL_SET.
#define T_FALSE
Old name of RUBY_T_FALSE.
#define Qtrue
Old name of RUBY_Qtrue.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_TEST
Old name of RB_FL_TEST.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define rb_ary_new2
Old name of rb_ary_new_capa.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
#define OBJ_FROZEN_RAW
Old name of RB_OBJ_FROZEN_RAW.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
VALUE rb_eTypeError
TypeError exception.
VALUE rb_exc_new_str(VALUE etype, VALUE str)
Identical to rb_exc_new_cstr(), except it takes a Ruby's string instead of C's.
VALUE rb_cClass
Class class.
VALUE rb_mKernel
Kernel module.
VALUE rb_cRefinement
Refinement class.
VALUE rb_cNilClass
NilClass class.
VALUE rb_cHash
Hash class.
VALUE rb_cFalseClass
FalseClass 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_cBasicObject
BasicObject class.
VALUE rb_cModule
Module class.
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
VALUE rb_cTrueClass
TrueClass class.
#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_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
#define RGENGC_WB_PROTECTED_CLASS
This is a compile-time flag to enable/disable write barrier for struct RClass.
VALUE rb_ary_new_from_values(long n, const VALUE *elts)
Identical to rb_ary_new_from_args(), except how objects are passed.
VALUE rb_ary_cat(VALUE ary, const VALUE *train, long len)
Destructively appends multiple elements at the end of the array.
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_resize(VALUE ary, long len)
Expands or shrinks the passed array to the passed length.
VALUE rb_ary_hidden_new(long capa)
Allocates a hidden (no class) empty array.
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
#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_block_proc(void)
Constructs a Proc object from implicitly passed components.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
void rb_const_set(VALUE space, ID name, VALUE val)
Names a constant.
VALUE rb_const_get_at(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
void rb_set_class_path_string(VALUE klass, VALUE space, VALUE name)
Identical to rb_set_class_path(), except it accepts the name as Ruby's string instead of C's.
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
void rb_alias(VALUE klass, ID dst, ID src)
Resembles alias.
void rb_attr(VALUE klass, ID name, int need_reader, int need_writer, int honour_visibility)
This function resembles now-deprecated Module#attr.
void rb_clear_constant_cache_for_id(ID id)
Clears the inline constant caches associated with a particular ID.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
int len
Length of the buffer.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_hash_foreach(VALUE q, int_type *w, VALUE e)
Iteration over the given hash.
#define RARRAY_LEN
Just another name of rb_array_len.
#define RARRAY_AREF(a, i)
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
#define RHASH_SIZE(h)
Queries the size of the hash.
#define RHASH_EMPTY_P(h)
Checks if the hash is empty.
#define RB_SCAN_ARGS_PASS_CALLED_KEYWORDS
Same behaviour as rb_scan_args().
#define RTEST
This is an old name of RB_TEST.
#define ANYARGS
Functions declared using this macro take arbitrary arguments, including void.
rb_cref_t * cref
class reference, should be marked
const rb_iseq_t * iseqptr
iseq pointer, should be separated from iseqval
Internal header for Namespace.
Internal header for Class.
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.
ruby_value_type
C-level type of an object.