Ruby 3.5.0dev (2025-06-26 revision b1c09faf67a663bcda430931c987762521efd53a)
object.c (b1c09faf67a663bcda430931c987762521efd53a)
1/**********************************************************************
2
3 object.c -
4
5 $Author$
6 created at: Thu Jul 15 12:01:24 JST 1993
7
8 Copyright (C) 1993-2007 Yukihiro Matsumoto
9 Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
10 Copyright (C) 2000 Information-technology Promotion Agency, Japan
11
12**********************************************************************/
13
14#include "ruby/internal/config.h"
15
16#include <ctype.h>
17#include <errno.h>
18#include <float.h>
19#include <math.h>
20#include <stdio.h>
21
22#include "constant.h"
23#include "id.h"
24#include "internal.h"
25#include "internal/array.h"
26#include "internal/class.h"
27#include "internal/error.h"
28#include "internal/eval.h"
29#include "internal/inits.h"
30#include "internal/numeric.h"
31#include "internal/object.h"
32#include "internal/struct.h"
33#include "internal/string.h"
34#include "internal/st.h"
35#include "internal/symbol.h"
36#include "internal/variable.h"
37#include "variable.h"
38#include "probes.h"
39#include "ruby/encoding.h"
40#include "ruby/st.h"
41#include "ruby/util.h"
42#include "ruby/assert.h"
43#include "builtin.h"
44#include "shape.h"
45#include "yjit.h"
46
47/* Flags of RObject
48 *
49 * 1: ROBJECT_EMBED
50 * The object has its instance variables embedded (the array of
51 * instance variables directly follow the object, rather than being
52 * on a separately allocated buffer).
53 */
54
66
70
71static VALUE rb_cNilClass_to_s;
72static VALUE rb_cTrueClass_to_s;
73static VALUE rb_cFalseClass_to_s;
74
77#define id_eq idEq
78#define id_eql idEqlP
79#define id_match idEqTilde
80#define id_inspect idInspect
81#define id_init_copy idInitialize_copy
82#define id_init_clone idInitialize_clone
83#define id_init_dup idInitialize_dup
84#define id_const_missing idConst_missing
85#define id_to_f idTo_f
86static ID id_instance_variables_to_inspect;
87
88#define CLASS_OR_MODULE_P(obj) \
89 (!SPECIAL_CONST_P(obj) && \
90 (BUILTIN_TYPE(obj) == T_CLASS || BUILTIN_TYPE(obj) == T_MODULE))
91
94size_t
95rb_obj_embedded_size(uint32_t fields_count)
96{
97 return offsetof(struct RObject, as.ary) + (sizeof(VALUE) * fields_count);
98}
99
100VALUE
102{
103 if (!SPECIAL_CONST_P(obj)) {
104 RBASIC_CLEAR_CLASS(obj);
105 }
106 return obj;
107}
108
109VALUE
111{
112 if (!SPECIAL_CONST_P(obj)) {
113 RBASIC_SET_CLASS(obj, klass);
114 }
115 return obj;
116}
117
118VALUE
119rb_class_allocate_instance(VALUE klass)
120{
121 uint32_t index_tbl_num_entries = RCLASS_MAX_IV_COUNT(klass);
122
123 size_t size = rb_obj_embedded_size(index_tbl_num_entries);
124 if (!rb_gc_size_allocatable_p(size)) {
125 size = sizeof(struct RObject);
126 }
127
128 NEWOBJ_OF(o, struct RObject, klass,
129 T_OBJECT | ROBJECT_EMBED | (RGENGC_WB_PROTECTED_OBJECT ? FL_WB_PROTECTED : 0), size, 0);
130 VALUE obj = (VALUE)o;
131
132 RUBY_ASSERT(RSHAPE_TYPE_P(RBASIC_SHAPE_ID(obj), SHAPE_ROOT));
133
134 RBASIC_SET_SHAPE_ID(obj, rb_shape_root(rb_gc_heap_id_for_size(size)));
135
136#if RUBY_DEBUG
137 RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
138 VALUE *ptr = ROBJECT_FIELDS(obj);
139 for (size_t i = 0; i < ROBJECT_FIELDS_CAPACITY(obj); i++) {
140 ptr[i] = Qundef;
141 }
142#endif
143
144 return obj;
145}
146
147VALUE
149{
150 VALUE ignored_flags = RUBY_FL_PROMOTED;
151 RBASIC(obj)->flags = (type & ~ignored_flags) | (RBASIC(obj)->flags & ignored_flags);
152 RBASIC_SET_CLASS(obj, klass);
153 return obj;
154}
155
156/*
157 * call-seq:
158 * true === other -> true or false
159 * false === other -> true or false
160 * nil === other -> true or false
161 *
162 * Returns +true+ or +false+.
163 *
164 * Like Object#==, if +object+ is an instance of Object
165 * (and not an instance of one of its many subclasses).
166 *
167 * This method is commonly overridden by those subclasses,
168 * to provide meaningful semantics in +case+ statements.
169 */
170#define case_equal rb_equal
171 /* The default implementation of #=== is
172 * to call #== with the rb_equal() optimization. */
173
174VALUE
176{
177 VALUE result;
178
179 if (obj1 == obj2) return Qtrue;
180 result = rb_equal_opt(obj1, obj2);
181 if (UNDEF_P(result)) {
182 result = rb_funcall(obj1, id_eq, 1, obj2);
183 }
184 return RBOOL(RTEST(result));
185}
186
187int
188rb_eql(VALUE obj1, VALUE obj2)
189{
190 VALUE result;
191
192 if (obj1 == obj2) return TRUE;
193 result = rb_eql_opt(obj1, obj2);
194 if (UNDEF_P(result)) {
195 result = rb_funcall(obj1, id_eql, 1, obj2);
196 }
197 return RTEST(result);
198}
199
203VALUE
204rb_obj_equal(VALUE obj1, VALUE obj2)
205{
206 return RBOOL(obj1 == obj2);
207}
208
209VALUE rb_obj_hash(VALUE obj);
210
215VALUE
216rb_obj_not(VALUE obj)
217{
218 return RBOOL(!RTEST(obj));
219}
220
225VALUE
226rb_obj_not_equal(VALUE obj1, VALUE obj2)
227{
228 VALUE result = rb_funcall(obj1, id_eq, 1, obj2);
229 return rb_obj_not(result);
230}
231
232VALUE
234{
235 while (cl &&
236 (RCLASS_SINGLETON_P(cl) || BUILTIN_TYPE(cl) == T_ICLASS)) {
237 cl = RCLASS_SUPER(cl);
238 }
239 return cl;
240}
241
242VALUE
244{
245 return rb_class_real(CLASS_OF(obj));
246}
247
248/*
249 * call-seq:
250 * obj.singleton_class -> class
251 *
252 * Returns the singleton class of <i>obj</i>. This method creates
253 * a new singleton class if <i>obj</i> does not have one.
254 *
255 * If <i>obj</i> is <code>nil</code>, <code>true</code>, or
256 * <code>false</code>, it returns NilClass, TrueClass, or FalseClass,
257 * respectively.
258 * If <i>obj</i> is an Integer, a Float or a Symbol, it raises a TypeError.
259 *
260 * Object.new.singleton_class #=> #<Class:#<Object:0xb7ce1e24>>
261 * String.singleton_class #=> #<Class:String>
262 * nil.singleton_class #=> NilClass
263 */
264
265static VALUE
266rb_obj_singleton_class(VALUE obj)
267{
268 return rb_singleton_class(obj);
269}
270
272void
273rb_obj_copy_ivar(VALUE dest, VALUE obj)
274{
277
278 unsigned long src_num_ivs = rb_ivar_count(obj);
279 if (!src_num_ivs) {
280 return;
281 }
282
283 shape_id_t src_shape_id = RBASIC_SHAPE_ID(obj);
284
285 if (rb_shape_too_complex_p(src_shape_id)) {
286 rb_shape_copy_complex_ivars(dest, obj, src_shape_id, ROBJECT_FIELDS_HASH(obj));
287 return;
288 }
289
290 shape_id_t dest_shape_id = src_shape_id;
291 shape_id_t initial_shape_id = RBASIC_SHAPE_ID(dest);
292
293 RUBY_ASSERT(RSHAPE_TYPE_P(initial_shape_id, SHAPE_ROOT));
294
295 dest_shape_id = rb_shape_rebuild(initial_shape_id, src_shape_id);
296 if (UNLIKELY(rb_shape_too_complex_p(dest_shape_id))) {
297 st_table *table = rb_st_init_numtable_with_size(src_num_ivs);
298 rb_obj_copy_ivs_to_hash_table(obj, table);
299 rb_obj_init_too_complex(dest, table);
300
301 return;
302 }
303
304 VALUE *src_buf = ROBJECT_FIELDS(obj);
305 VALUE *dest_buf = ROBJECT_FIELDS(dest);
306
307 attr_index_t initial_capa = RSHAPE_CAPACITY(initial_shape_id);
308 attr_index_t dest_capa = RSHAPE_CAPACITY(dest_shape_id);
309
310 RUBY_ASSERT(src_num_ivs <= dest_capa);
311 if (initial_capa < dest_capa) {
312 rb_ensure_iv_list_size(dest, 0, dest_capa);
313 dest_buf = ROBJECT_FIELDS(dest);
314 }
315
316 rb_shape_copy_fields(dest, dest_buf, dest_shape_id, obj, src_buf, src_shape_id);
317 rb_obj_set_shape_id(dest, dest_shape_id);
318}
319
320static void
321init_copy(VALUE dest, VALUE obj)
322{
323 if (OBJ_FROZEN(dest)) {
324 rb_raise(rb_eTypeError, "[bug] frozen object (%s) allocated", rb_obj_classname(dest));
325 }
326 RBASIC(dest)->flags &= ~T_MASK;
327 // Copies the shape id from obj to dest
328 RBASIC(dest)->flags |= RBASIC(obj)->flags & T_MASK;
329 switch (BUILTIN_TYPE(obj)) {
330 case T_IMEMO:
331 rb_bug("Unreachable");
332 break;
333 case T_CLASS:
334 case T_MODULE:
335 // noop: handled in class.c: rb_mod_init_copy
336 break;
337 case T_OBJECT:
338 rb_obj_copy_ivar(dest, obj);
339 break;
340 default:
341 rb_copy_generic_ivar(dest, obj);
342 break;
343 }
344 rb_gc_copy_attributes(dest, obj);
345}
346
347static VALUE immutable_obj_clone(VALUE obj, VALUE kwfreeze);
348static VALUE mutable_obj_clone(VALUE obj, VALUE kwfreeze);
349PUREFUNC(static inline int special_object_p(VALUE obj));
350static inline int
351special_object_p(VALUE obj)
352{
353 if (SPECIAL_CONST_P(obj)) return TRUE;
354 switch (BUILTIN_TYPE(obj)) {
355 case T_BIGNUM:
356 case T_FLOAT:
357 case T_SYMBOL:
358 case T_RATIONAL:
359 case T_COMPLEX:
360 /* not a comprehensive list */
361 return TRUE;
362 default:
363 return FALSE;
364 }
365}
366
367static VALUE
368obj_freeze_opt(VALUE freeze)
369{
370 switch (freeze) {
371 case Qfalse:
372 case Qtrue:
373 case Qnil:
374 break;
375 default:
376 rb_raise(rb_eArgError, "unexpected value for freeze: %"PRIsVALUE, rb_obj_class(freeze));
377 }
378
379 return freeze;
380}
381
382static VALUE
383rb_obj_clone2(rb_execution_context_t *ec, VALUE obj, VALUE freeze)
384{
385 VALUE kwfreeze = obj_freeze_opt(freeze);
386 if (!special_object_p(obj))
387 return mutable_obj_clone(obj, kwfreeze);
388 return immutable_obj_clone(obj, kwfreeze);
389}
390
392VALUE
393rb_immutable_obj_clone(int argc, VALUE *argv, VALUE obj)
394{
395 VALUE kwfreeze = rb_get_freeze_opt(argc, argv);
396 return immutable_obj_clone(obj, kwfreeze);
397}
398
399VALUE
400rb_get_freeze_opt(int argc, VALUE *argv)
401{
402 static ID keyword_ids[1];
403 VALUE opt;
404 VALUE kwfreeze = Qnil;
405
406 if (!keyword_ids[0]) {
407 CONST_ID(keyword_ids[0], "freeze");
408 }
409 rb_scan_args(argc, argv, "0:", &opt);
410 if (!NIL_P(opt)) {
411 rb_get_kwargs(opt, keyword_ids, 0, 1, &kwfreeze);
412 if (!UNDEF_P(kwfreeze))
413 kwfreeze = obj_freeze_opt(kwfreeze);
414 }
415 return kwfreeze;
416}
417
418static VALUE
419immutable_obj_clone(VALUE obj, VALUE kwfreeze)
420{
421 if (kwfreeze == Qfalse)
422 rb_raise(rb_eArgError, "can't unfreeze %"PRIsVALUE,
423 rb_obj_class(obj));
424 return obj;
425}
426
427VALUE
428rb_obj_clone_setup(VALUE obj, VALUE clone, VALUE kwfreeze)
429{
430 VALUE argv[2];
431
432 VALUE singleton = rb_singleton_class_clone_and_attach(obj, clone);
433 RBASIC_SET_CLASS(clone, singleton);
434 if (RCLASS_SINGLETON_P(singleton)) {
435 rb_singleton_class_attached(singleton, clone);
436 }
437
438 init_copy(clone, obj);
439
440 switch (kwfreeze) {
441 case Qnil:
442 rb_funcall(clone, id_init_clone, 1, obj);
443 RBASIC(clone)->flags |= RBASIC(obj)->flags & FL_FREEZE;
444
445 if (RB_TYPE_P(obj, T_STRING)) {
446 FL_SET_RAW(clone, FL_TEST_RAW(obj, STR_CHILLED));
447 }
448
449 if (RB_OBJ_FROZEN(obj)) {
450 shape_id_t next_shape_id = rb_shape_transition_frozen(clone);
451 rb_obj_set_shape_id(clone, next_shape_id);
452 }
453 break;
454 case Qtrue: {
455 static VALUE freeze_true_hash;
456 if (!freeze_true_hash) {
457 freeze_true_hash = rb_hash_new();
458 rb_vm_register_global_object(freeze_true_hash);
459 rb_hash_aset(freeze_true_hash, ID2SYM(idFreeze), Qtrue);
460 rb_obj_freeze(freeze_true_hash);
461 }
462
463 argv[0] = obj;
464 argv[1] = freeze_true_hash;
465 rb_funcallv_kw(clone, id_init_clone, 2, argv, RB_PASS_KEYWORDS);
466 OBJ_FREEZE(clone);
467 break;
468 }
469 case Qfalse: {
470 static VALUE freeze_false_hash;
471 if (!freeze_false_hash) {
472 freeze_false_hash = rb_hash_new();
473 rb_vm_register_global_object(freeze_false_hash);
474 rb_hash_aset(freeze_false_hash, ID2SYM(idFreeze), Qfalse);
475 rb_obj_freeze(freeze_false_hash);
476 }
477
478 argv[0] = obj;
479 argv[1] = freeze_false_hash;
480 rb_funcallv_kw(clone, id_init_clone, 2, argv, RB_PASS_KEYWORDS);
481 break;
482 }
483 default:
484 rb_bug("invalid kwfreeze passed to mutable_obj_clone");
485 }
486
487 return clone;
488}
489
490static VALUE
491mutable_obj_clone(VALUE obj, VALUE kwfreeze)
492{
493 VALUE clone = rb_obj_alloc(rb_obj_class(obj));
494 return rb_obj_clone_setup(obj, clone, kwfreeze);
495}
496
497VALUE
499{
500 if (special_object_p(obj)) return obj;
501 return mutable_obj_clone(obj, Qnil);
502}
503
504VALUE
505rb_obj_dup_setup(VALUE obj, VALUE dup)
506{
507 init_copy(dup, obj);
508 rb_funcall(dup, id_init_dup, 1, obj);
509
510 return dup;
511}
512
513/*
514 * call-seq:
515 * obj.dup -> an_object
516 *
517 * Produces a shallow copy of <i>obj</i>---the instance variables of
518 * <i>obj</i> are copied, but not the objects they reference.
519 *
520 * This method may have class-specific behavior. If so, that
521 * behavior will be documented under the #+initialize_copy+ method of
522 * the class.
523 *
524 * === on dup vs clone
525 *
526 * In general, #clone and #dup may have different semantics in
527 * descendant classes. While #clone is used to duplicate an object,
528 * including its internal state, #dup typically uses the class of the
529 * descendant object to create the new instance.
530 *
531 * When using #dup, any modules that the object has been extended with will not
532 * be copied.
533 *
534 * class Klass
535 * attr_accessor :str
536 * end
537 *
538 * module Foo
539 * def foo; 'foo'; end
540 * end
541 *
542 * s1 = Klass.new #=> #<Klass:0x401b3a38>
543 * s1.extend(Foo) #=> #<Klass:0x401b3a38>
544 * s1.foo #=> "foo"
545 *
546 * s2 = s1.clone #=> #<Klass:0x401be280>
547 * s2.foo #=> "foo"
548 *
549 * s3 = s1.dup #=> #<Klass:0x401c1084>
550 * s3.foo #=> NoMethodError: undefined method `foo' for #<Klass:0x401c1084>
551 */
552VALUE
554{
555 VALUE dup;
556
557 if (special_object_p(obj)) {
558 return obj;
559 }
560 dup = rb_obj_alloc(rb_obj_class(obj));
561 return rb_obj_dup_setup(obj, dup);
562}
563
564/*
565 * call-seq:
566 * obj.itself -> obj
567 *
568 * Returns the receiver.
569 *
570 * string = "my string"
571 * string.itself.object_id == string.object_id #=> true
572 *
573 */
574
575static VALUE
576rb_obj_itself(VALUE obj)
577{
578 return obj;
579}
580
581VALUE
582rb_obj_size(VALUE self, VALUE args, VALUE obj)
583{
584 return LONG2FIX(1);
585}
586
592VALUE
594{
595 if (obj == orig) return obj;
596 rb_check_frozen(obj);
597 if (TYPE(obj) != TYPE(orig) || rb_obj_class(obj) != rb_obj_class(orig)) {
598 rb_raise(rb_eTypeError, "initialize_copy should take same class object");
599 }
600 return obj;
601}
602
609VALUE
611{
612 rb_funcall(obj, id_init_copy, 1, orig);
613 return obj;
614}
615
623static VALUE
624rb_obj_init_clone(int argc, VALUE *argv, VALUE obj)
625{
626 VALUE orig, opts;
627 if (rb_scan_args(argc, argv, "1:", &orig, &opts) < argc) {
628 /* Ignore a freeze keyword */
629 rb_get_freeze_opt(1, &opts);
630 }
631 rb_funcall(obj, id_init_copy, 1, orig);
632 return obj;
633}
634
635/*
636 * call-seq:
637 * obj.to_s -> string
638 *
639 * Returns a string representing <i>obj</i>. The default #to_s prints
640 * the object's class and an encoding of the object id. As a special
641 * case, the top-level object that is the initial execution context
642 * of Ruby programs returns ``main''.
643 *
644 */
645VALUE
647{
648 VALUE str;
649 VALUE cname = rb_class_name(CLASS_OF(obj));
650
651 str = rb_sprintf("#<%"PRIsVALUE":%p>", cname, (void*)obj);
652
653 return str;
654}
655
656VALUE
658{
659 VALUE str = rb_obj_as_string(rb_funcallv(obj, id_inspect, 0, 0));
660
661 rb_encoding *enc = rb_default_internal_encoding();
662 if (enc == NULL) enc = rb_default_external_encoding();
663 if (!rb_enc_asciicompat(enc)) {
664 if (!rb_enc_str_asciionly_p(str))
665 return rb_str_escape(str);
666 return str;
667 }
668 if (rb_enc_get(str) != enc && !rb_enc_str_asciionly_p(str))
669 return rb_str_escape(str);
670 return str;
671}
672
673static int
674inspect_i(ID id, VALUE value, st_data_t a)
675{
676 VALUE *args = (VALUE *)a, str = args[0], ivars = args[1];
677
678 /* need not to show internal data */
679 if (CLASS_OF(value) == 0) return ST_CONTINUE;
680 if (!rb_is_instance_id(id)) return ST_CONTINUE;
681 if (!NIL_P(ivars)) {
682 VALUE name = ID2SYM(id);
683 for (long i = 0; RARRAY_AREF(ivars, i) != name; ) {
684 if (++i >= RARRAY_LEN(ivars)) return ST_CONTINUE;
685 }
686 }
687 if (RSTRING_PTR(str)[0] == '-') { /* first element */
688 RSTRING_PTR(str)[0] = '#';
689 rb_str_cat2(str, " ");
690 }
691 else {
692 rb_str_cat2(str, ", ");
693 }
694 rb_str_catf(str, "%"PRIsVALUE"=", rb_id2str(id));
695 rb_str_buf_append(str, rb_inspect(value));
696
697 return ST_CONTINUE;
698}
699
700static VALUE
701inspect_obj(VALUE obj, VALUE a, int recur)
702{
703 VALUE *args = (VALUE *)a, str = args[0];
704
705 if (recur) {
706 rb_str_cat2(str, " ...");
707 }
708 else {
709 rb_ivar_foreach(obj, inspect_i, a);
710 }
711 rb_str_cat2(str, ">");
712 RSTRING_PTR(str)[0] = '#';
713
714 return str;
715}
716
717/*
718 * call-seq:
719 * obj.inspect -> string
720 *
721 * Returns a string containing a human-readable representation of <i>obj</i>.
722 * The default #inspect shows the object's class name, an encoding of
723 * its memory address, and a list of the instance variables and their
724 * values (by calling #inspect on each of them). User defined classes
725 * should override this method to provide a better representation of
726 * <i>obj</i>. When overriding this method, it should return a string
727 * whose encoding is compatible with the default external encoding.
728 *
729 * [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]"
730 * Time.new.inspect #=> "2008-03-08 19:43:39 +0900"
731 *
732 * class Foo
733 * end
734 * Foo.new.inspect #=> "#<Foo:0x0300c868>"
735 *
736 * class Bar
737 * def initialize
738 * @bar = 1
739 * end
740 * end
741 * Bar.new.inspect #=> "#<Bar:0x0300c868 @bar=1>"
742 *
743 * If _obj_ responds to +instance_variables_to_inspect+, then only
744 * the instance variables listed in the returned array will be included
745 * in the inspect string.
746 *
747 *
748 * class DatabaseConfig
749 * def initialize(host, user, password)
750 * @host = host
751 * @user = user
752 * @password = password
753 * end
754 *
755 * private
756 * def instance_variables_to_inspect = [:@host, :@user]
757 * end
758 *
759 * conf = DatabaseConfig.new("localhost", "root", "hunter2")
760 * conf.inspect #=> #<DatabaseConfig:0x0000000104def350 @host="localhost", @user="root">
761 */
762
763static VALUE
764rb_obj_inspect(VALUE obj)
765{
766 VALUE ivars = rb_check_funcall(obj, id_instance_variables_to_inspect, 0, 0);
767 st_index_t n = 0;
768 if (UNDEF_P(ivars)) {
769 n = rb_ivar_count(obj);
770 ivars = Qnil;
771 }
772 else if (!NIL_P(ivars)) {
773 Check_Type(ivars, T_ARRAY);
774 n = RARRAY_LEN(ivars);
775 }
776 if (n > 0) {
777 VALUE c = rb_class_name(CLASS_OF(obj));
778 VALUE args[2] = {
779 rb_sprintf("-<%"PRIsVALUE":%p", c, (void*)obj),
780 ivars
781 };
782 return rb_exec_recursive(inspect_obj, obj, (VALUE)args);
783 }
784 else {
785 return rb_any_to_s(obj);
786 }
787}
788
789static VALUE
790class_or_module_required(VALUE c)
791{
792 switch (OBJ_BUILTIN_TYPE(c)) {
793 case T_MODULE:
794 case T_CLASS:
795 case T_ICLASS:
796 break;
797
798 default:
799 rb_raise(rb_eTypeError, "class or module required");
800 }
801 return c;
802}
803
804static VALUE class_search_ancestor(VALUE cl, VALUE c);
805
806/*
807 * call-seq:
808 * obj.instance_of?(class) -> true or false
809 *
810 * Returns <code>true</code> if <i>obj</i> is an instance of the given
811 * class. See also Object#kind_of?.
812 *
813 * class A; end
814 * class B < A; end
815 * class C < B; end
816 *
817 * b = B.new
818 * b.instance_of? A #=> false
819 * b.instance_of? B #=> true
820 * b.instance_of? C #=> false
821 */
822
823VALUE
825{
826 c = class_or_module_required(c);
827 return RBOOL(rb_obj_class(obj) == c);
828}
829
830// Returns whether c is a proper (c != cl) superclass of cl
831// Both c and cl must be T_CLASS
832static VALUE
833class_search_class_ancestor(VALUE cl, VALUE c)
834{
837
838 size_t c_depth = RCLASS_SUPERCLASS_DEPTH(c);
839 size_t cl_depth = RCLASS_SUPERCLASS_DEPTH(cl);
840 VALUE *classes = RCLASS_SUPERCLASSES(cl);
841
842 // If c's inheritance chain is longer, it cannot be an ancestor
843 // We are checking for a proper superclass so don't check if they are equal
844 if (cl_depth <= c_depth)
845 return Qfalse;
846
847 // Otherwise check that c is in cl's inheritance chain
848 return RBOOL(classes[c_depth] == c);
849}
850
851/*
852 * call-seq:
853 * obj.is_a?(class) -> true or false
854 * obj.kind_of?(class) -> true or false
855 *
856 * Returns <code>true</code> if <i>class</i> is the class of
857 * <i>obj</i>, or if <i>class</i> is one of the superclasses of
858 * <i>obj</i> or modules included in <i>obj</i>.
859 *
860 * module M; end
861 * class A
862 * include M
863 * end
864 * class B < A; end
865 * class C < B; end
866 *
867 * b = B.new
868 * b.is_a? A #=> true
869 * b.is_a? B #=> true
870 * b.is_a? C #=> false
871 * b.is_a? M #=> true
872 *
873 * b.kind_of? A #=> true
874 * b.kind_of? B #=> true
875 * b.kind_of? C #=> false
876 * b.kind_of? M #=> true
877 */
878
879VALUE
881{
882 VALUE cl = CLASS_OF(obj);
883
885
886 // Fastest path: If the object's class is an exact match we know `c` is a
887 // class without checking type and can return immediately.
888 if (cl == c) return Qtrue;
889
890 // Note: YJIT needs this function to never allocate and never raise when
891 // `c` is a class or a module.
892
893 if (LIKELY(RB_TYPE_P(c, T_CLASS))) {
894 // Fast path: Both are T_CLASS
895 return class_search_class_ancestor(cl, c);
896 }
897 else if (RB_TYPE_P(c, T_ICLASS)) {
898 // First check if we inherit the includer
899 // If we do we can return true immediately
900 VALUE includer = RCLASS_INCLUDER(c);
901 if (cl == includer) return Qtrue;
902
903 // Usually includer is a T_CLASS here, except when including into an
904 // already included Module.
905 // If it is a class, attempt the fast class-to-class check and return
906 // true if there is a match.
907 if (RB_TYPE_P(includer, T_CLASS) && class_search_class_ancestor(cl, includer))
908 return Qtrue;
909
910 // We don't include the ICLASS directly, so must check if we inherit
911 // the module via another include
912 return RBOOL(class_search_ancestor(cl, RCLASS_ORIGIN(c)));
913 }
914 else if (RB_TYPE_P(c, T_MODULE)) {
915 // Slow path: check each ancestor in the linked list and its method table
916 return RBOOL(class_search_ancestor(cl, RCLASS_ORIGIN(c)));
917 }
918 else {
919 rb_raise(rb_eTypeError, "class or module required");
921 }
922}
923
924
925static VALUE
926class_search_ancestor(VALUE cl, VALUE c)
927{
928 while (cl) {
929 if (cl == c || RCLASS_M_TBL(cl) == RCLASS_M_TBL(c))
930 return cl;
931 cl = RCLASS_SUPER(cl);
932 }
933 return 0;
934}
935
937VALUE
938rb_class_search_ancestor(VALUE cl, VALUE c)
939{
940 cl = class_or_module_required(cl);
941 c = class_or_module_required(c);
942 return class_search_ancestor(cl, RCLASS_ORIGIN(c));
943}
944
945
946/*
947 * Document-method: inherited
948 *
949 * call-seq:
950 * inherited(subclass)
951 *
952 * Callback invoked whenever a subclass of the current class is created.
953 *
954 * Example:
955 *
956 * class Foo
957 * def self.inherited(subclass)
958 * puts "New subclass: #{subclass}"
959 * end
960 * end
961 *
962 * class Bar < Foo
963 * end
964 *
965 * class Baz < Bar
966 * end
967 *
968 * <em>produces:</em>
969 *
970 * New subclass: Bar
971 * New subclass: Baz
972 */
973#define rb_obj_class_inherited rb_obj_dummy1
974
975/* Document-method: method_added
976 *
977 * call-seq:
978 * method_added(method_name)
979 *
980 * Invoked as a callback whenever an instance method is added to the
981 * receiver.
982 *
983 * module Chatty
984 * def self.method_added(method_name)
985 * puts "Adding #{method_name.inspect}"
986 * end
987 * def self.some_class_method() end
988 * def some_instance_method() end
989 * end
990 *
991 * <em>produces:</em>
992 *
993 * Adding :some_instance_method
994 *
995 */
996#define rb_obj_mod_method_added rb_obj_dummy1
997
998/* Document-method: method_removed
999 *
1000 * call-seq:
1001 * method_removed(method_name)
1002 *
1003 * Invoked as a callback whenever an instance method is removed from the
1004 * receiver.
1005 *
1006 * module Chatty
1007 * def self.method_removed(method_name)
1008 * puts "Removing #{method_name.inspect}"
1009 * end
1010 * def self.some_class_method() end
1011 * def some_instance_method() end
1012 * class << self
1013 * remove_method :some_class_method
1014 * end
1015 * remove_method :some_instance_method
1016 * end
1017 *
1018 * <em>produces:</em>
1019 *
1020 * Removing :some_instance_method
1021 *
1022 */
1023#define rb_obj_mod_method_removed rb_obj_dummy1
1024
1025/* Document-method: method_undefined
1026 *
1027 * call-seq:
1028 * method_undefined(method_name)
1029 *
1030 * Invoked as a callback whenever an instance method is undefined from the
1031 * receiver.
1032 *
1033 * module Chatty
1034 * def self.method_undefined(method_name)
1035 * puts "Undefining #{method_name.inspect}"
1036 * end
1037 * def self.some_class_method() end
1038 * def some_instance_method() end
1039 * class << self
1040 * undef_method :some_class_method
1041 * end
1042 * undef_method :some_instance_method
1043 * end
1044 *
1045 * <em>produces:</em>
1046 *
1047 * Undefining :some_instance_method
1048 *
1049 */
1050#define rb_obj_mod_method_undefined rb_obj_dummy1
1051
1052/*
1053 * Document-method: singleton_method_added
1054 *
1055 * call-seq:
1056 * singleton_method_added(symbol)
1057 *
1058 * Invoked as a callback whenever a singleton method is added to the
1059 * receiver.
1060 *
1061 * module Chatty
1062 * def Chatty.singleton_method_added(id)
1063 * puts "Adding #{id.id2name}"
1064 * end
1065 * def self.one() end
1066 * def two() end
1067 * def Chatty.three() end
1068 * end
1069 *
1070 * <em>produces:</em>
1071 *
1072 * Adding singleton_method_added
1073 * Adding one
1074 * Adding three
1075 *
1076 */
1077#define rb_obj_singleton_method_added rb_obj_dummy1
1078
1079/*
1080 * Document-method: singleton_method_removed
1081 *
1082 * call-seq:
1083 * singleton_method_removed(symbol)
1084 *
1085 * Invoked as a callback whenever a singleton method is removed from
1086 * the receiver.
1087 *
1088 * module Chatty
1089 * def Chatty.singleton_method_removed(id)
1090 * puts "Removing #{id.id2name}"
1091 * end
1092 * def self.one() end
1093 * def two() end
1094 * def Chatty.three() end
1095 * class << self
1096 * remove_method :three
1097 * remove_method :one
1098 * end
1099 * end
1100 *
1101 * <em>produces:</em>
1102 *
1103 * Removing three
1104 * Removing one
1105 */
1106#define rb_obj_singleton_method_removed rb_obj_dummy1
1107
1108/*
1109 * Document-method: singleton_method_undefined
1110 *
1111 * call-seq:
1112 * singleton_method_undefined(symbol)
1113 *
1114 * Invoked as a callback whenever a singleton method is undefined in
1115 * the receiver.
1116 *
1117 * module Chatty
1118 * def Chatty.singleton_method_undefined(id)
1119 * puts "Undefining #{id.id2name}"
1120 * end
1121 * def Chatty.one() end
1122 * class << self
1123 * undef_method(:one)
1124 * end
1125 * end
1126 *
1127 * <em>produces:</em>
1128 *
1129 * Undefining one
1130 */
1131#define rb_obj_singleton_method_undefined rb_obj_dummy1
1132
1133/* Document-method: const_added
1134 *
1135 * call-seq:
1136 * const_added(const_name)
1137 *
1138 * Invoked as a callback whenever a constant is assigned on the receiver
1139 *
1140 * module Chatty
1141 * def self.const_added(const_name)
1142 * super
1143 * puts "Added #{const_name.inspect}"
1144 * end
1145 * FOO = 1
1146 * end
1147 *
1148 * <em>produces:</em>
1149 *
1150 * Added :FOO
1151 *
1152 * If we define a class using the <tt>class</tt> keyword, <tt>const_added</tt>
1153 * runs before <tt>inherited</tt>:
1154 *
1155 * module M
1156 * def self.const_added(const_name)
1157 * super
1158 * p :const_added
1159 * end
1160 *
1161 * parent = Class.new do
1162 * def self.inherited(subclass)
1163 * super
1164 * p :inherited
1165 * end
1166 * end
1167 *
1168 * class Child < parent
1169 * end
1170 * end
1171 *
1172 * <em>produces:</em>
1173 *
1174 * :const_added
1175 * :inherited
1176 */
1177#define rb_obj_mod_const_added rb_obj_dummy1
1178
1179/*
1180 * Document-method: extended
1181 *
1182 * call-seq:
1183 * extended(othermod)
1184 *
1185 * The equivalent of <tt>included</tt>, but for extended modules.
1186 *
1187 * module A
1188 * def self.extended(mod)
1189 * puts "#{self} extended in #{mod}"
1190 * end
1191 * end
1192 * module Enumerable
1193 * extend A
1194 * end
1195 * # => prints "A extended in Enumerable"
1196 */
1197#define rb_obj_mod_extended rb_obj_dummy1
1198
1199/*
1200 * Document-method: included
1201 *
1202 * call-seq:
1203 * included(othermod)
1204 *
1205 * Callback invoked whenever the receiver is included in another
1206 * module or class. This should be used in preference to
1207 * <tt>Module.append_features</tt> if your code wants to perform some
1208 * action when a module is included in another.
1209 *
1210 * module A
1211 * def A.included(mod)
1212 * puts "#{self} included in #{mod}"
1213 * end
1214 * end
1215 * module Enumerable
1216 * include A
1217 * end
1218 * # => prints "A included in Enumerable"
1219 */
1220#define rb_obj_mod_included rb_obj_dummy1
1221
1222/*
1223 * Document-method: prepended
1224 *
1225 * call-seq:
1226 * prepended(othermod)
1227 *
1228 * The equivalent of <tt>included</tt>, but for prepended modules.
1229 *
1230 * module A
1231 * def self.prepended(mod)
1232 * puts "#{self} prepended to #{mod}"
1233 * end
1234 * end
1235 * module Enumerable
1236 * prepend A
1237 * end
1238 * # => prints "A prepended to Enumerable"
1239 */
1240#define rb_obj_mod_prepended rb_obj_dummy1
1241
1242/*
1243 * Document-method: initialize
1244 *
1245 * call-seq:
1246 * BasicObject.new
1247 *
1248 * Returns a new BasicObject.
1249 */
1250#define rb_obj_initialize rb_obj_dummy0
1251
1252/*
1253 * Not documented
1254 */
1255
1256static VALUE
1257rb_obj_dummy(void)
1258{
1259 return Qnil;
1260}
1261
1262static VALUE
1263rb_obj_dummy0(VALUE _)
1264{
1265 return rb_obj_dummy();
1266}
1267
1268static VALUE
1269rb_obj_dummy1(VALUE _x, VALUE _y)
1270{
1271 return rb_obj_dummy();
1272}
1273
1274/*
1275 * call-seq:
1276 * obj.freeze -> obj
1277 *
1278 * Prevents further modifications to <i>obj</i>. A
1279 * FrozenError will be raised if modification is attempted.
1280 * There is no way to unfreeze a frozen object. See also
1281 * Object#frozen?.
1282 *
1283 * This method returns self.
1284 *
1285 * a = [ "a", "b", "c" ]
1286 * a.freeze
1287 * a << "z"
1288 *
1289 * <em>produces:</em>
1290 *
1291 * prog.rb:3:in `<<': can't modify frozen Array (FrozenError)
1292 * from prog.rb:3
1293 *
1294 * Objects of the following classes are always frozen: Integer,
1295 * Float, Symbol.
1296 */
1297
1298VALUE
1300{
1301 if (!OBJ_FROZEN(obj)) {
1302 OBJ_FREEZE(obj);
1303 if (SPECIAL_CONST_P(obj)) {
1304 rb_bug("special consts should be frozen.");
1305 }
1306 }
1307 return obj;
1308}
1309
1310VALUE
1312{
1313 return RBOOL(OBJ_FROZEN(obj));
1314}
1315
1316
1317/*
1318 * Document-class: NilClass
1319 *
1320 * The class of the singleton object +nil+.
1321 *
1322 * Several of its methods act as operators:
1323 *
1324 * - #&
1325 * - #|
1326 * - #===
1327 * - #=~
1328 * - #^
1329 *
1330 * Others act as converters, carrying the concept of _nullity_
1331 * to other classes:
1332 *
1333 * - #rationalize
1334 * - #to_a
1335 * - #to_c
1336 * - #to_h
1337 * - #to_r
1338 * - #to_s
1339 *
1340 * While +nil+ doesn't have an explicitly defined #to_hash method,
1341 * it can be used in <code>**</code> unpacking, not adding any
1342 * keyword arguments.
1343 *
1344 * Another method provides inspection:
1345 *
1346 * - #inspect
1347 *
1348 * Finally, there is this query method:
1349 *
1350 * - #nil?
1351 *
1352 */
1353
1354/*
1355 * call-seq:
1356 * to_s -> ''
1357 *
1358 * Returns an empty String:
1359 *
1360 * nil.to_s # => ""
1361 *
1362 */
1363
1364VALUE
1365rb_nil_to_s(VALUE obj)
1366{
1367 return rb_cNilClass_to_s;
1368}
1369
1370/*
1371 * Document-method: to_a
1372 *
1373 * call-seq:
1374 * to_a -> []
1375 *
1376 * Returns an empty Array.
1377 *
1378 * nil.to_a # => []
1379 *
1380 */
1381
1382static VALUE
1383nil_to_a(VALUE obj)
1384{
1385 return rb_ary_new2(0);
1386}
1387
1388/*
1389 * Document-method: to_h
1390 *
1391 * call-seq:
1392 * to_h -> {}
1393 *
1394 * Returns an empty Hash.
1395 *
1396 * nil.to_h #=> {}
1397 *
1398 */
1399
1400static VALUE
1401nil_to_h(VALUE obj)
1402{
1403 return rb_hash_new();
1404}
1405
1406/*
1407 * call-seq:
1408 * inspect -> 'nil'
1409 *
1410 * Returns string <tt>'nil'</tt>:
1411 *
1412 * nil.inspect # => "nil"
1413 *
1414 */
1415
1416static VALUE
1417nil_inspect(VALUE obj)
1418{
1419 return rb_usascii_str_new2("nil");
1420}
1421
1422/*
1423 * call-seq:
1424 * nil =~ object -> nil
1425 *
1426 * Returns +nil+.
1427 *
1428 * This method makes it useful to write:
1429 *
1430 * while gets =~ /re/
1431 * # ...
1432 * end
1433 *
1434 */
1435
1436static VALUE
1437nil_match(VALUE obj1, VALUE obj2)
1438{
1439 return Qnil;
1440}
1441
1442/*
1443 * Document-class: TrueClass
1444 *
1445 * The class of the singleton object +true+.
1446 *
1447 * Several of its methods act as operators:
1448 *
1449 * - #&
1450 * - #|
1451 * - #===
1452 * - #^
1453 *
1454 * One other method:
1455 *
1456 * - #to_s and its alias #inspect.
1457 *
1458 */
1459
1460
1461/*
1462 * call-seq:
1463 * true.to_s -> 'true'
1464 *
1465 * Returns string <tt>'true'</tt>:
1466 *
1467 * true.to_s # => "true"
1468 *
1469 * TrueClass#inspect is an alias for TrueClass#to_s.
1470 *
1471 */
1472
1473VALUE
1474rb_true_to_s(VALUE obj)
1475{
1476 return rb_cTrueClass_to_s;
1477}
1478
1479
1480/*
1481 * call-seq:
1482 * true & object -> true or false
1483 *
1484 * Returns +false+ if +object+ is +false+ or +nil+, +true+ otherwise:
1485 *
1486 * true & Object.new # => true
1487 * true & false # => false
1488 * true & nil # => false
1489 *
1490 */
1491
1492static VALUE
1493true_and(VALUE obj, VALUE obj2)
1494{
1495 return RBOOL(RTEST(obj2));
1496}
1497
1498/*
1499 * call-seq:
1500 * true | object -> true
1501 *
1502 * Returns +true+:
1503 *
1504 * true | Object.new # => true
1505 * true | false # => true
1506 * true | nil # => true
1507 *
1508 * Argument +object+ is evaluated.
1509 * This is different from +true+ with the short-circuit operator,
1510 * whose operand is evaluated only if necessary:
1511 *
1512 * true | raise # => Raises RuntimeError.
1513 * true || raise # => true
1514 *
1515 */
1516
1517static VALUE
1518true_or(VALUE obj, VALUE obj2)
1519{
1520 return Qtrue;
1521}
1522
1523
1524/*
1525 * call-seq:
1526 * true ^ object -> !object
1527 *
1528 * Returns +true+ if +object+ is +false+ or +nil+, +false+ otherwise:
1529 *
1530 * true ^ Object.new # => false
1531 * true ^ false # => true
1532 * true ^ nil # => true
1533 *
1534 */
1535
1536static VALUE
1537true_xor(VALUE obj, VALUE obj2)
1538{
1539 return rb_obj_not(obj2);
1540}
1541
1542
1543/*
1544 * Document-class: FalseClass
1545 *
1546 * The global value <code>false</code> is the only instance of class
1547 * FalseClass and represents a logically false value in
1548 * boolean expressions. The class provides operators allowing
1549 * <code>false</code> to participate correctly in logical expressions.
1550 *
1551 */
1552
1553/*
1554 * call-seq:
1555 * false.to_s -> "false"
1556 *
1557 * The string representation of <code>false</code> is "false".
1558 */
1559
1560VALUE
1561rb_false_to_s(VALUE obj)
1562{
1563 return rb_cFalseClass_to_s;
1564}
1565
1566/*
1567 * call-seq:
1568 * false & object -> false
1569 * nil & object -> false
1570 *
1571 * Returns +false+:
1572 *
1573 * false & true # => false
1574 * false & Object.new # => false
1575 *
1576 * Argument +object+ is evaluated:
1577 *
1578 * false & raise # Raises RuntimeError.
1579 *
1580 */
1581static VALUE
1582false_and(VALUE obj, VALUE obj2)
1583{
1584 return Qfalse;
1585}
1586
1587
1588/*
1589 * call-seq:
1590 * false | object -> true or false
1591 * nil | object -> true or false
1592 *
1593 * Returns +false+ if +object+ is +nil+ or +false+, +true+ otherwise:
1594 *
1595 * nil | nil # => false
1596 * nil | false # => false
1597 * nil | Object.new # => true
1598 *
1599 */
1600
1601#define false_or true_and
1602
1603/*
1604 * call-seq:
1605 * false ^ object -> true or false
1606 * nil ^ object -> true or false
1607 *
1608 * Returns +false+ if +object+ is +nil+ or +false+, +true+ otherwise:
1609 *
1610 * nil ^ nil # => false
1611 * nil ^ false # => false
1612 * nil ^ Object.new # => true
1613 *
1614 */
1615
1616#define false_xor true_and
1617
1618/*
1619 * call-seq:
1620 * nil.nil? -> true
1621 *
1622 * Returns +true+.
1623 * For all other objects, method <tt>nil?</tt> returns +false+.
1624 */
1625
1626static VALUE
1627rb_true(VALUE obj)
1628{
1629 return Qtrue;
1630}
1631
1632/*
1633 * call-seq:
1634 * obj.nil? -> true or false
1635 *
1636 * Only the object <i>nil</i> responds <code>true</code> to <code>nil?</code>.
1637 *
1638 * Object.new.nil? #=> false
1639 * nil.nil? #=> true
1640 */
1641
1642
1643VALUE
1644rb_false(VALUE obj)
1645{
1646 return Qfalse;
1647}
1648
1649/*
1650 * call-seq:
1651 * obj !~ other -> true or false
1652 *
1653 * Returns true if two objects do not match (using the <i>=~</i>
1654 * method), otherwise false.
1655 */
1656
1657static VALUE
1658rb_obj_not_match(VALUE obj1, VALUE obj2)
1659{
1660 VALUE result = rb_funcall(obj1, id_match, 1, obj2);
1661 return rb_obj_not(result);
1662}
1663
1664
1665/*
1666 * call-seq:
1667 * obj <=> other -> 0 or nil
1668 *
1669 * Returns 0 if +obj+ and +other+ are the same object
1670 * or <code>obj == other</code>, otherwise nil.
1671 *
1672 * The #<=> is used by various methods to compare objects, for example
1673 * Enumerable#sort, Enumerable#max etc.
1674 *
1675 * Your implementation of #<=> should return one of the following values: -1, 0,
1676 * 1 or nil. -1 means self is smaller than other. 0 means self is equal to other.
1677 * 1 means self is bigger than other. Nil means the two values could not be
1678 * compared.
1679 *
1680 * When you define #<=>, you can include Comparable to gain the
1681 * methods #<=, #<, #==, #>=, #> and #between?.
1682 */
1683static VALUE
1684rb_obj_cmp(VALUE obj1, VALUE obj2)
1685{
1686 if (rb_equal(obj1, obj2))
1687 return INT2FIX(0);
1688 return Qnil;
1689}
1690
1691/***********************************************************************
1692 *
1693 * Document-class: Module
1694 *
1695 * A Module is a collection of methods and constants. The
1696 * methods in a module may be instance methods or module methods.
1697 * Instance methods appear as methods in a class when the module is
1698 * included, module methods do not. Conversely, module methods may be
1699 * called without creating an encapsulating object, while instance
1700 * methods may not. (See Module#module_function.)
1701 *
1702 * In the descriptions that follow, the parameter <i>sym</i> refers
1703 * to a symbol, which is either a quoted string or a
1704 * Symbol (such as <code>:name</code>).
1705 *
1706 * module Mod
1707 * include Math
1708 * CONST = 1
1709 * def meth
1710 * # ...
1711 * end
1712 * end
1713 * Mod.class #=> Module
1714 * Mod.constants #=> [:CONST, :PI, :E]
1715 * Mod.instance_methods #=> [:meth]
1716 *
1717 */
1718
1719/*
1720 * call-seq:
1721 * mod.to_s -> string
1722 *
1723 * Returns a string representing this module or class. For basic
1724 * classes and modules, this is the name. For singletons, we
1725 * show information on the thing we're attached to as well.
1726 */
1727
1728VALUE
1729rb_mod_to_s(VALUE klass)
1730{
1731 ID id_defined_at;
1732 VALUE refined_class, defined_at;
1733
1734 if (RCLASS_SINGLETON_P(klass)) {
1735 VALUE s = rb_usascii_str_new2("#<Class:");
1736 VALUE v = RCLASS_ATTACHED_OBJECT(klass);
1737
1738 if (CLASS_OR_MODULE_P(v)) {
1740 }
1741 else {
1743 }
1744 rb_str_cat2(s, ">");
1745
1746 return s;
1747 }
1748 refined_class = rb_refinement_module_get_refined_class(klass);
1749 if (!NIL_P(refined_class)) {
1750 VALUE s = rb_usascii_str_new2("#<refinement:");
1751
1752 rb_str_concat(s, rb_inspect(refined_class));
1753 rb_str_cat2(s, "@");
1754 CONST_ID(id_defined_at, "__defined_at__");
1755 defined_at = rb_attr_get(klass, id_defined_at);
1756 rb_str_concat(s, rb_inspect(defined_at));
1757 rb_str_cat2(s, ">");
1758 return s;
1759 }
1760 return rb_class_name(klass);
1761}
1762
1763/*
1764 * call-seq:
1765 * mod.freeze -> mod
1766 *
1767 * Prevents further modifications to <i>mod</i>.
1768 *
1769 * This method returns self.
1770 */
1771
1772static VALUE
1773rb_mod_freeze(VALUE mod)
1774{
1775 rb_class_name(mod);
1776 return rb_obj_freeze(mod);
1777}
1778
1779/*
1780 * call-seq:
1781 * mod === obj -> true or false
1782 *
1783 * Case Equality---Returns <code>true</code> if <i>obj</i> is an
1784 * instance of <i>mod</i> or an instance of one of <i>mod</i>'s descendants.
1785 * Of limited use for modules, but can be used in <code>case</code> statements
1786 * to classify objects by class.
1787 */
1788
1789static VALUE
1790rb_mod_eqq(VALUE mod, VALUE arg)
1791{
1792 return rb_obj_is_kind_of(arg, mod);
1793}
1794
1795/*
1796 * call-seq:
1797 * mod <= other -> true, false, or nil
1798 *
1799 * Returns true if <i>mod</i> is a subclass of <i>other</i> or
1800 * is the same as <i>other</i>. Returns
1801 * <code>nil</code> if there's no relationship between the two.
1802 * (Think of the relationship in terms of the class definition:
1803 * "class A < B" implies "A < B".)
1804 */
1805
1806VALUE
1808{
1809 if (mod == arg) return Qtrue;
1810
1811 if (RB_TYPE_P(arg, T_CLASS) && RB_TYPE_P(mod, T_CLASS)) {
1812 // comparison between classes
1813 size_t mod_depth = RCLASS_SUPERCLASS_DEPTH(mod);
1814 size_t arg_depth = RCLASS_SUPERCLASS_DEPTH(arg);
1815 if (arg_depth < mod_depth) {
1816 // check if mod < arg
1817 return RCLASS_SUPERCLASSES(mod)[arg_depth] == arg ?
1818 Qtrue :
1819 Qnil;
1820 }
1821 else if (arg_depth > mod_depth) {
1822 // check if mod > arg
1823 return RCLASS_SUPERCLASSES(arg)[mod_depth] == mod ?
1824 Qfalse :
1825 Qnil;
1826 }
1827 else {
1828 // Depths match, and we know they aren't equal: no relation
1829 return Qnil;
1830 }
1831 }
1832 else {
1833 if (!CLASS_OR_MODULE_P(arg) && !RB_TYPE_P(arg, T_ICLASS)) {
1834 rb_raise(rb_eTypeError, "compared with non class/module");
1835 }
1836 if (class_search_ancestor(mod, RCLASS_ORIGIN(arg))) {
1837 return Qtrue;
1838 }
1839 /* not mod < arg; check if mod > arg */
1840 if (class_search_ancestor(arg, mod)) {
1841 return Qfalse;
1842 }
1843 return Qnil;
1844 }
1845}
1846
1847/*
1848 * call-seq:
1849 * mod < other -> true, false, or nil
1850 *
1851 * Returns true if <i>mod</i> is a subclass of <i>other</i>. Returns
1852 * <code>false</code> if <i>mod</i> is the same as <i>other</i>
1853 * or <i>mod</i> is an ancestor of <i>other</i>.
1854 * Returns <code>nil</code> if there's no relationship between the two.
1855 * (Think of the relationship in terms of the class definition:
1856 * "class A < B" implies "A < B".)
1857 *
1858 */
1859
1860static VALUE
1861rb_mod_lt(VALUE mod, VALUE arg)
1862{
1863 if (mod == arg) return Qfalse;
1864 return rb_class_inherited_p(mod, arg);
1865}
1866
1867
1868/*
1869 * call-seq:
1870 * mod >= other -> true, false, or nil
1871 *
1872 * Returns true if <i>mod</i> is an ancestor of <i>other</i>, or the
1873 * two modules are the same. Returns
1874 * <code>nil</code> if there's no relationship between the two.
1875 * (Think of the relationship in terms of the class definition:
1876 * "class A < B" implies "B > A".)
1877 *
1878 */
1879
1880static VALUE
1881rb_mod_ge(VALUE mod, VALUE arg)
1882{
1883 if (!CLASS_OR_MODULE_P(arg)) {
1884 rb_raise(rb_eTypeError, "compared with non class/module");
1885 }
1886
1887 return rb_class_inherited_p(arg, mod);
1888}
1889
1890/*
1891 * call-seq:
1892 * mod > other -> true, false, or nil
1893 *
1894 * Returns true if <i>mod</i> is an ancestor of <i>other</i>. Returns
1895 * <code>false</code> if <i>mod</i> is the same as <i>other</i>
1896 * or <i>mod</i> is a descendant of <i>other</i>.
1897 * Returns <code>nil</code> if there's no relationship between the two.
1898 * (Think of the relationship in terms of the class definition:
1899 * "class A < B" implies "B > A".)
1900 *
1901 */
1902
1903static VALUE
1904rb_mod_gt(VALUE mod, VALUE arg)
1905{
1906 if (mod == arg) return Qfalse;
1907 return rb_mod_ge(mod, arg);
1908}
1909
1910/*
1911 * call-seq:
1912 * module <=> other_module -> -1, 0, +1, or nil
1913 *
1914 * Comparison---Returns -1, 0, +1 or nil depending on whether +module+
1915 * includes +other_module+, they are the same, or if +module+ is included by
1916 * +other_module+.
1917 *
1918 * Returns +nil+ if +module+ has no relationship with +other_module+, if
1919 * +other_module+ is not a module, or if the two values are incomparable.
1920 */
1921
1922static VALUE
1923rb_mod_cmp(VALUE mod, VALUE arg)
1924{
1925 VALUE cmp;
1926
1927 if (mod == arg) return INT2FIX(0);
1928 if (!CLASS_OR_MODULE_P(arg)) {
1929 return Qnil;
1930 }
1931
1932 cmp = rb_class_inherited_p(mod, arg);
1933 if (NIL_P(cmp)) return Qnil;
1934 if (cmp) {
1935 return INT2FIX(-1);
1936 }
1937 return INT2FIX(1);
1938}
1939
1940static VALUE rb_mod_initialize_exec(VALUE module);
1941
1942/*
1943 * call-seq:
1944 * Module.new -> mod
1945 * Module.new {|mod| block } -> mod
1946 *
1947 * Creates a new anonymous module. If a block is given, it is passed
1948 * the module object, and the block is evaluated in the context of this
1949 * module like #module_eval.
1950 *
1951 * fred = Module.new do
1952 * def meth1
1953 * "hello"
1954 * end
1955 * def meth2
1956 * "bye"
1957 * end
1958 * end
1959 * a = "my string"
1960 * a.extend(fred) #=> "my string"
1961 * a.meth1 #=> "hello"
1962 * a.meth2 #=> "bye"
1963 *
1964 * Assign the module to a constant (name starting uppercase) if you
1965 * want to treat it like a regular module.
1966 */
1967
1968static VALUE
1969rb_mod_initialize(VALUE module)
1970{
1971 return rb_mod_initialize_exec(module);
1972}
1973
1974static VALUE
1975rb_mod_initialize_exec(VALUE module)
1976{
1977 if (rb_block_given_p()) {
1978 rb_mod_module_exec(1, &module, module);
1979 }
1980 return Qnil;
1981}
1982
1983/* :nodoc: */
1984static VALUE
1985rb_mod_initialize_clone(int argc, VALUE* argv, VALUE clone)
1986{
1987 VALUE ret, orig, opts;
1988 rb_scan_args(argc, argv, "1:", &orig, &opts);
1989 ret = rb_obj_init_clone(argc, argv, clone);
1990 if (OBJ_FROZEN(orig))
1991 rb_class_name(clone);
1992 return ret;
1993}
1994
1995/*
1996 * call-seq:
1997 * Class.new(super_class=Object) -> a_class
1998 * Class.new(super_class=Object) { |mod| ... } -> a_class
1999 *
2000 * Creates a new anonymous (unnamed) class with the given superclass
2001 * (or Object if no parameter is given). You can give a
2002 * class a name by assigning the class object to a constant.
2003 *
2004 * If a block is given, it is passed the class object, and the block
2005 * is evaluated in the context of this class like
2006 * #class_eval.
2007 *
2008 * fred = Class.new do
2009 * def meth1
2010 * "hello"
2011 * end
2012 * def meth2
2013 * "bye"
2014 * end
2015 * end
2016 *
2017 * a = fred.new #=> #<#<Class:0x100381890>:0x100376b98>
2018 * a.meth1 #=> "hello"
2019 * a.meth2 #=> "bye"
2020 *
2021 * Assign the class to a constant (name starting uppercase) if you
2022 * want to treat it like a regular class.
2023 */
2024
2025static VALUE
2026rb_class_initialize(int argc, VALUE *argv, VALUE klass)
2027{
2028 VALUE super;
2029
2030 if (RCLASS_SUPER(klass) != 0 || klass == rb_cBasicObject) {
2031 rb_raise(rb_eTypeError, "already initialized class");
2032 }
2033 if (rb_check_arity(argc, 0, 1) == 0) {
2034 super = rb_cObject;
2035 }
2036 else {
2037 super = argv[0];
2038 rb_check_inheritable(super);
2039 if (!RCLASS_INITIALIZED_P(super)) {
2040 rb_raise(rb_eTypeError, "can't inherit uninitialized class");
2041 }
2042 }
2043 rb_class_set_super(klass, super);
2044 rb_make_metaclass(klass, RBASIC(super)->klass);
2045 rb_class_inherited(super, klass);
2046 rb_mod_initialize_exec(klass);
2047
2048 return klass;
2049}
2050
2052void
2053rb_undefined_alloc(VALUE klass)
2054{
2055 rb_raise(rb_eTypeError, "allocator undefined for %"PRIsVALUE,
2056 klass);
2057}
2058
2059static rb_alloc_func_t class_get_alloc_func(VALUE klass);
2060static VALUE class_call_alloc_func(rb_alloc_func_t allocator, VALUE klass);
2061
2062/*
2063 * call-seq:
2064 * class.allocate() -> obj
2065 *
2066 * Allocates space for a new object of <i>class</i>'s class and does not
2067 * call initialize on the new instance. The returned object must be an
2068 * instance of <i>class</i>.
2069 *
2070 * klass = Class.new do
2071 * def initialize(*args)
2072 * @initialized = true
2073 * end
2074 *
2075 * def initialized?
2076 * @initialized || false
2077 * end
2078 * end
2079 *
2080 * klass.allocate.initialized? #=> false
2081 *
2082 */
2083
2084static VALUE
2085rb_class_alloc(VALUE klass)
2086{
2087 rb_alloc_func_t allocator = class_get_alloc_func(klass);
2088 return class_call_alloc_func(allocator, klass);
2089}
2090
2091static rb_alloc_func_t
2092class_get_alloc_func(VALUE klass)
2093{
2094 rb_alloc_func_t allocator;
2095
2096 if (!RCLASS_INITIALIZED_P(klass)) {
2097 rb_raise(rb_eTypeError, "can't instantiate uninitialized class");
2098 }
2099 if (RCLASS_SINGLETON_P(klass)) {
2100 rb_raise(rb_eTypeError, "can't create instance of singleton class");
2101 }
2102 allocator = rb_get_alloc_func(klass);
2103 if (!allocator) {
2104 rb_undefined_alloc(klass);
2105 }
2106 return allocator;
2107}
2108
2109static VALUE
2110class_call_alloc_func(rb_alloc_func_t allocator, VALUE klass)
2111{
2112 VALUE obj;
2113
2114 RUBY_DTRACE_CREATE_HOOK(OBJECT, rb_class2name(klass));
2115
2116 obj = (*allocator)(klass);
2117
2118 if (rb_obj_class(obj) != rb_class_real(klass)) {
2119 rb_raise(rb_eTypeError, "wrong instance allocation");
2120 }
2121 return obj;
2122}
2123
2124VALUE
2126{
2127 Check_Type(klass, T_CLASS);
2128 return rb_class_alloc(klass);
2129}
2130
2131/*
2132 * call-seq:
2133 * class.new(args, ...) -> obj
2134 *
2135 * Calls #allocate to create a new object of <i>class</i>'s class,
2136 * then invokes that object's #initialize method, passing it
2137 * <i>args</i>. This is the method that ends up getting called
2138 * whenever an object is constructed using <code>.new</code>.
2139 *
2140 */
2141
2142VALUE
2143rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass)
2144{
2145 VALUE obj;
2146
2147 obj = rb_class_alloc(klass);
2148 rb_obj_call_init_kw(obj, argc, argv, RB_PASS_CALLED_KEYWORDS);
2149
2150 return obj;
2151}
2152
2153VALUE
2154rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat)
2155{
2156 VALUE obj;
2157 Check_Type(klass, T_CLASS);
2158
2159 obj = rb_class_alloc(klass);
2160 rb_obj_call_init_kw(obj, argc, argv, kw_splat);
2161
2162 return obj;
2163}
2164
2165VALUE
2166rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
2167{
2168 return rb_class_new_instance_kw(argc, argv, klass, RB_NO_KEYWORDS);
2169}
2170
2180VALUE
2182{
2183 RUBY_ASSERT(RB_TYPE_P(klass, T_CLASS));
2184
2185 VALUE *superclasses = RCLASS_SUPERCLASSES(klass);
2186 size_t superclasses_depth = RCLASS_SUPERCLASS_DEPTH(klass);
2187
2188 if (klass == rb_cBasicObject) return Qnil;
2189
2190 if (!superclasses) {
2191 RUBY_ASSERT(!RCLASS_SUPER(klass));
2192 rb_raise(rb_eTypeError, "uninitialized class");
2193 }
2194
2195 if (!superclasses_depth) {
2196 return Qnil;
2197 }
2198 else {
2199 VALUE super = superclasses[superclasses_depth - 1];
2200 RUBY_ASSERT(RB_TYPE_P(super, T_CLASS));
2201 return super;
2202 }
2203}
2204
2205VALUE
2207{
2208 return RCLASS_SUPER(klass);
2209}
2210
2211static const char bad_instance_name[] = "'%1$s' is not allowed as an instance variable name";
2212static const char bad_class_name[] = "'%1$s' is not allowed as a class variable name";
2213static const char bad_const_name[] = "wrong constant name %1$s";
2214static const char bad_attr_name[] = "invalid attribute name '%1$s'";
2215#define wrong_constant_name bad_const_name
2216
2218#define id_for_var(obj, name, type) id_for_setter(obj, name, type, bad_##type##_name)
2220#define id_for_setter(obj, name, type, message) \
2221 check_setter_id(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))
2222static ID
2223check_setter_id(VALUE obj, VALUE *pname,
2224 int (*valid_id_p)(ID), int (*valid_name_p)(VALUE),
2225 const char *message, size_t message_len)
2226{
2227 ID id = rb_check_id(pname);
2228 VALUE name = *pname;
2229
2230 if (id ? !valid_id_p(id) : !valid_name_p(name)) {
2231 rb_name_err_raise_str(rb_fstring_new(message, message_len),
2232 obj, name);
2233 }
2234 return id;
2235}
2236
2237static int
2238rb_is_attr_name(VALUE name)
2239{
2240 return rb_is_local_name(name) || rb_is_const_name(name);
2241}
2242
2243static int
2244rb_is_attr_id(ID id)
2245{
2246 return rb_is_local_id(id) || rb_is_const_id(id);
2247}
2248
2249static ID
2250id_for_attr(VALUE obj, VALUE name)
2251{
2252 ID id = id_for_var(obj, name, attr);
2253 if (!id) id = rb_intern_str(name);
2254 return id;
2255}
2256
2257/*
2258 * call-seq:
2259 * attr_reader(symbol, ...) -> array
2260 * attr(symbol, ...) -> array
2261 * attr_reader(string, ...) -> array
2262 * attr(string, ...) -> array
2263 *
2264 * Creates instance variables and corresponding methods that return the
2265 * value of each instance variable. Equivalent to calling
2266 * ``<code>attr</code><i>:name</i>'' on each name in turn.
2267 * String arguments are converted to symbols.
2268 * Returns an array of defined method names as symbols.
2269 */
2270
2271static VALUE
2272rb_mod_attr_reader(int argc, VALUE *argv, VALUE klass)
2273{
2274 int i;
2275 VALUE names = rb_ary_new2(argc);
2276
2277 for (i=0; i<argc; i++) {
2278 ID id = id_for_attr(klass, argv[i]);
2279 rb_attr(klass, id, TRUE, FALSE, TRUE);
2280 rb_ary_push(names, ID2SYM(id));
2281 }
2282 return names;
2283}
2284
2289VALUE
2290rb_mod_attr(int argc, VALUE *argv, VALUE klass)
2291{
2292 if (argc == 2 && (argv[1] == Qtrue || argv[1] == Qfalse)) {
2293 ID id = id_for_attr(klass, argv[0]);
2294 VALUE names = rb_ary_new();
2295
2296 rb_category_warning(RB_WARN_CATEGORY_DEPRECATED, "optional boolean argument is obsoleted");
2297 rb_attr(klass, id, 1, RTEST(argv[1]), TRUE);
2298 rb_ary_push(names, ID2SYM(id));
2299 if (argv[1] == Qtrue) rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
2300 return names;
2301 }
2302 return rb_mod_attr_reader(argc, argv, klass);
2303}
2304
2305/*
2306 * call-seq:
2307 * attr_writer(symbol, ...) -> array
2308 * attr_writer(string, ...) -> array
2309 *
2310 * Creates an accessor method to allow assignment to the attribute
2311 * <i>symbol</i><code>.id2name</code>.
2312 * String arguments are converted to symbols.
2313 * Returns an array of defined method names as symbols.
2314 */
2315
2316static VALUE
2317rb_mod_attr_writer(int argc, VALUE *argv, VALUE klass)
2318{
2319 int i;
2320 VALUE names = rb_ary_new2(argc);
2321
2322 for (i=0; i<argc; i++) {
2323 ID id = id_for_attr(klass, argv[i]);
2324 rb_attr(klass, id, FALSE, TRUE, TRUE);
2325 rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
2326 }
2327 return names;
2328}
2329
2330/*
2331 * call-seq:
2332 * attr_accessor(symbol, ...) -> array
2333 * attr_accessor(string, ...) -> array
2334 *
2335 * Defines a named attribute for this module, where the name is
2336 * <i>symbol.</i><code>id2name</code>, creating an instance variable
2337 * (<code>@name</code>) and a corresponding access method to read it.
2338 * Also creates a method called <code>name=</code> to set the attribute.
2339 * String arguments are converted to symbols.
2340 * Returns an array of defined method names as symbols.
2341 *
2342 * module Mod
2343 * attr_accessor(:one, :two) #=> [:one, :one=, :two, :two=]
2344 * end
2345 * Mod.instance_methods.sort #=> [:one, :one=, :two, :two=]
2346 */
2347
2348static VALUE
2349rb_mod_attr_accessor(int argc, VALUE *argv, VALUE klass)
2350{
2351 int i;
2352 VALUE names = rb_ary_new2(argc * 2);
2353
2354 for (i=0; i<argc; i++) {
2355 ID id = id_for_attr(klass, argv[i]);
2356
2357 rb_attr(klass, id, TRUE, TRUE, TRUE);
2358 rb_ary_push(names, ID2SYM(id));
2359 rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
2360 }
2361 return names;
2362}
2363
2364/*
2365 * call-seq:
2366 * mod.const_get(sym, inherit=true) -> obj
2367 * mod.const_get(str, inherit=true) -> obj
2368 *
2369 * Checks for a constant with the given name in <i>mod</i>.
2370 * If +inherit+ is set, the lookup will also search
2371 * the ancestors (and +Object+ if <i>mod</i> is a +Module+).
2372 *
2373 * The value of the constant is returned if a definition is found,
2374 * otherwise a +NameError+ is raised.
2375 *
2376 * Math.const_get(:PI) #=> 3.14159265358979
2377 *
2378 * This method will recursively look up constant names if a namespaced
2379 * class name is provided. For example:
2380 *
2381 * module Foo; class Bar; end end
2382 * Object.const_get 'Foo::Bar'
2383 *
2384 * The +inherit+ flag is respected on each lookup. For example:
2385 *
2386 * module Foo
2387 * class Bar
2388 * VAL = 10
2389 * end
2390 *
2391 * class Baz < Bar; end
2392 * end
2393 *
2394 * Object.const_get 'Foo::Baz::VAL' # => 10
2395 * Object.const_get 'Foo::Baz::VAL', false # => NameError
2396 *
2397 * If the argument is not a valid constant name a +NameError+ will be
2398 * raised with a warning "wrong constant name".
2399 *
2400 * Object.const_get 'foobar' #=> NameError: wrong constant name foobar
2401 *
2402 */
2403
2404static VALUE
2405rb_mod_const_get(int argc, VALUE *argv, VALUE mod)
2406{
2407 VALUE name, recur;
2408 rb_encoding *enc;
2409 const char *pbeg, *p, *path, *pend;
2410 ID id;
2411
2412 rb_check_arity(argc, 1, 2);
2413 name = argv[0];
2414 recur = (argc == 1) ? Qtrue : argv[1];
2415
2416 if (SYMBOL_P(name)) {
2417 if (!rb_is_const_sym(name)) goto wrong_name;
2418 id = rb_check_id(&name);
2419 if (!id) return rb_const_missing(mod, name);
2420 return RTEST(recur) ? rb_const_get(mod, id) : rb_const_get_at(mod, id);
2421 }
2422
2423 path = StringValuePtr(name);
2424 enc = rb_enc_get(name);
2425
2426 if (!rb_enc_asciicompat(enc)) {
2427 rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
2428 }
2429
2430 pbeg = p = path;
2431 pend = path + RSTRING_LEN(name);
2432
2433 if (p >= pend || !*p) {
2434 goto wrong_name;
2435 }
2436
2437 if (p + 2 < pend && p[0] == ':' && p[1] == ':') {
2438 mod = rb_cObject;
2439 p += 2;
2440 pbeg = p;
2441 }
2442
2443 while (p < pend) {
2444 VALUE part;
2445 long len, beglen;
2446
2447 while (p < pend && *p != ':') p++;
2448
2449 if (pbeg == p) goto wrong_name;
2450
2451 id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
2452 beglen = pbeg-path;
2453
2454 if (p < pend && p[0] == ':') {
2455 if (p + 2 >= pend || p[1] != ':') goto wrong_name;
2456 p += 2;
2457 pbeg = p;
2458 }
2459
2460 if (!RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
2461 rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
2462 QUOTE(name));
2463 }
2464
2465 if (!id) {
2466 part = rb_str_subseq(name, beglen, len);
2467 OBJ_FREEZE(part);
2468 if (!rb_is_const_name(part)) {
2469 name = part;
2470 goto wrong_name;
2471 }
2472 else if (!rb_method_basic_definition_p(CLASS_OF(mod), id_const_missing)) {
2473 part = rb_str_intern(part);
2474 mod = rb_const_missing(mod, part);
2475 continue;
2476 }
2477 else {
2478 rb_mod_const_missing(mod, part);
2479 }
2480 }
2481 if (!rb_is_const_id(id)) {
2482 name = ID2SYM(id);
2483 goto wrong_name;
2484 }
2485#if 0
2486 mod = rb_const_get_0(mod, id, beglen > 0 || !RTEST(recur), RTEST(recur), FALSE);
2487#else
2488 if (!RTEST(recur)) {
2489 mod = rb_const_get_at(mod, id);
2490 }
2491 else if (beglen == 0) {
2492 mod = rb_const_get(mod, id);
2493 }
2494 else {
2495 mod = rb_const_get_from(mod, id);
2496 }
2497#endif
2498 }
2499
2500 return mod;
2501
2502 wrong_name:
2503 rb_name_err_raise(wrong_constant_name, mod, name);
2505}
2506
2507/*
2508 * call-seq:
2509 * mod.const_set(sym, obj) -> obj
2510 * mod.const_set(str, obj) -> obj
2511 *
2512 * Sets the named constant to the given object, returning that object.
2513 * Creates a new constant if no constant with the given name previously
2514 * existed.
2515 *
2516 * Math.const_set("HIGH_SCHOOL_PI", 22.0/7.0) #=> 3.14285714285714
2517 * Math::HIGH_SCHOOL_PI - Math::PI #=> 0.00126448926734968
2518 *
2519 * If +sym+ or +str+ is not a valid constant name a +NameError+ will be
2520 * raised with a warning "wrong constant name".
2521 *
2522 * Object.const_set('foobar', 42) #=> NameError: wrong constant name foobar
2523 *
2524 */
2525
2526static VALUE
2527rb_mod_const_set(VALUE mod, VALUE name, VALUE value)
2528{
2529 ID id = id_for_var(mod, name, const);
2530 if (!id) id = rb_intern_str(name);
2531 rb_const_set(mod, id, value);
2532
2533 return value;
2534}
2535
2536/*
2537 * call-seq:
2538 * mod.const_defined?(sym, inherit=true) -> true or false
2539 * mod.const_defined?(str, inherit=true) -> true or false
2540 *
2541 * Says whether _mod_ or its ancestors have a constant with the given name:
2542 *
2543 * Float.const_defined?(:EPSILON) #=> true, found in Float itself
2544 * Float.const_defined?("String") #=> true, found in Object (ancestor)
2545 * BasicObject.const_defined?(:Hash) #=> false
2546 *
2547 * If _mod_ is a +Module+, additionally +Object+ and its ancestors are checked:
2548 *
2549 * Math.const_defined?(:String) #=> true, found in Object
2550 *
2551 * In each of the checked classes or modules, if the constant is not present
2552 * but there is an autoload for it, +true+ is returned directly without
2553 * autoloading:
2554 *
2555 * module Admin
2556 * autoload :User, 'admin/user'
2557 * end
2558 * Admin.const_defined?(:User) #=> true
2559 *
2560 * If the constant is not found the callback +const_missing+ is *not* called
2561 * and the method returns +false+.
2562 *
2563 * If +inherit+ is false, the lookup only checks the constants in the receiver:
2564 *
2565 * IO.const_defined?(:SYNC) #=> true, found in File::Constants (ancestor)
2566 * IO.const_defined?(:SYNC, false) #=> false, not found in IO itself
2567 *
2568 * In this case, the same logic for autoloading applies.
2569 *
2570 * If the argument is not a valid constant name a +NameError+ is raised with the
2571 * message "wrong constant name _name_":
2572 *
2573 * Hash.const_defined? 'foobar' #=> NameError: wrong constant name foobar
2574 *
2575 */
2576
2577static VALUE
2578rb_mod_const_defined(int argc, VALUE *argv, VALUE mod)
2579{
2580 VALUE name, recur;
2581 rb_encoding *enc;
2582 const char *pbeg, *p, *path, *pend;
2583 ID id;
2584
2585 rb_check_arity(argc, 1, 2);
2586 name = argv[0];
2587 recur = (argc == 1) ? Qtrue : argv[1];
2588
2589 if (SYMBOL_P(name)) {
2590 if (!rb_is_const_sym(name)) goto wrong_name;
2591 id = rb_check_id(&name);
2592 if (!id) return Qfalse;
2593 return RTEST(recur) ? rb_const_defined(mod, id) : rb_const_defined_at(mod, id);
2594 }
2595
2596 path = StringValuePtr(name);
2597 enc = rb_enc_get(name);
2598
2599 if (!rb_enc_asciicompat(enc)) {
2600 rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
2601 }
2602
2603 pbeg = p = path;
2604 pend = path + RSTRING_LEN(name);
2605
2606 if (p >= pend || !*p) {
2607 goto wrong_name;
2608 }
2609
2610 if (p + 2 < pend && p[0] == ':' && p[1] == ':') {
2611 mod = rb_cObject;
2612 p += 2;
2613 pbeg = p;
2614 }
2615
2616 while (p < pend) {
2617 VALUE part;
2618 long len, beglen;
2619
2620 while (p < pend && *p != ':') p++;
2621
2622 if (pbeg == p) goto wrong_name;
2623
2624 id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
2625 beglen = pbeg-path;
2626
2627 if (p < pend && p[0] == ':') {
2628 if (p + 2 >= pend || p[1] != ':') goto wrong_name;
2629 p += 2;
2630 pbeg = p;
2631 }
2632
2633 if (!id) {
2634 part = rb_str_subseq(name, beglen, len);
2635 OBJ_FREEZE(part);
2636 if (!rb_is_const_name(part)) {
2637 name = part;
2638 goto wrong_name;
2639 }
2640 else {
2641 return Qfalse;
2642 }
2643 }
2644 if (!rb_is_const_id(id)) {
2645 name = ID2SYM(id);
2646 goto wrong_name;
2647 }
2648
2649#if 0
2650 mod = rb_const_search(mod, id, beglen > 0 || !RTEST(recur), RTEST(recur), FALSE);
2651 if (UNDEF_P(mod)) return Qfalse;
2652#else
2653 if (!RTEST(recur)) {
2654 if (!rb_const_defined_at(mod, id))
2655 return Qfalse;
2656 if (p == pend) return Qtrue;
2657 mod = rb_const_get_at(mod, id);
2658 }
2659 else if (beglen == 0) {
2660 if (!rb_const_defined(mod, id))
2661 return Qfalse;
2662 if (p == pend) return Qtrue;
2663 mod = rb_const_get(mod, id);
2664 }
2665 else {
2666 if (!rb_const_defined_from(mod, id))
2667 return Qfalse;
2668 if (p == pend) return Qtrue;
2669 mod = rb_const_get_from(mod, id);
2670 }
2671#endif
2672
2673 if (p < pend && !RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
2674 rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
2675 QUOTE(name));
2676 }
2677 }
2678
2679 return Qtrue;
2680
2681 wrong_name:
2682 rb_name_err_raise(wrong_constant_name, mod, name);
2684}
2685
2686/*
2687 * call-seq:
2688 * mod.const_source_location(sym, inherit=true) -> [String, Integer]
2689 * mod.const_source_location(str, inherit=true) -> [String, Integer]
2690 *
2691 * Returns the Ruby source filename and line number containing the definition
2692 * of the constant specified. If the named constant is not found, +nil+ is returned.
2693 * If the constant is found, but its source location can not be extracted
2694 * (constant is defined in C code), empty array is returned.
2695 *
2696 * _inherit_ specifies whether to lookup in <code>mod.ancestors</code> (+true+
2697 * by default).
2698 *
2699 * # test.rb:
2700 * class A # line 1
2701 * C1 = 1
2702 * C2 = 2
2703 * end
2704 *
2705 * module M # line 6
2706 * C3 = 3
2707 * end
2708 *
2709 * class B < A # line 10
2710 * include M
2711 * C4 = 4
2712 * end
2713 *
2714 * class A # continuation of A definition
2715 * C2 = 8 # constant redefinition; warned yet allowed
2716 * end
2717 *
2718 * p B.const_source_location('C4') # => ["test.rb", 12]
2719 * p B.const_source_location('C3') # => ["test.rb", 7]
2720 * p B.const_source_location('C1') # => ["test.rb", 2]
2721 *
2722 * p B.const_source_location('C3', false) # => nil -- don't lookup in ancestors
2723 *
2724 * p A.const_source_location('C2') # => ["test.rb", 16] -- actual (last) definition place
2725 *
2726 * p Object.const_source_location('B') # => ["test.rb", 10] -- top-level constant could be looked through Object
2727 * p Object.const_source_location('A') # => ["test.rb", 1] -- class reopening is NOT considered new definition
2728 *
2729 * p B.const_source_location('A') # => ["test.rb", 1] -- because Object is in ancestors
2730 * p M.const_source_location('A') # => ["test.rb", 1] -- Object is not ancestor, but additionally checked for modules
2731 *
2732 * p Object.const_source_location('A::C1') # => ["test.rb", 2] -- nesting is supported
2733 * p Object.const_source_location('String') # => [] -- constant is defined in C code
2734 *
2735 *
2736 */
2737static VALUE
2738rb_mod_const_source_location(int argc, VALUE *argv, VALUE mod)
2739{
2740 VALUE name, recur, loc = Qnil;
2741 rb_encoding *enc;
2742 const char *pbeg, *p, *path, *pend;
2743 ID id;
2744
2745 rb_check_arity(argc, 1, 2);
2746 name = argv[0];
2747 recur = (argc == 1) ? Qtrue : argv[1];
2748
2749 if (SYMBOL_P(name)) {
2750 if (!rb_is_const_sym(name)) goto wrong_name;
2751 id = rb_check_id(&name);
2752 if (!id) return Qnil;
2753 return RTEST(recur) ? rb_const_source_location(mod, id) : rb_const_source_location_at(mod, id);
2754 }
2755
2756 path = StringValuePtr(name);
2757 enc = rb_enc_get(name);
2758
2759 if (!rb_enc_asciicompat(enc)) {
2760 rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
2761 }
2762
2763 pbeg = p = path;
2764 pend = path + RSTRING_LEN(name);
2765
2766 if (p >= pend || !*p) {
2767 goto wrong_name;
2768 }
2769
2770 if (p + 2 < pend && p[0] == ':' && p[1] == ':') {
2771 mod = rb_cObject;
2772 p += 2;
2773 pbeg = p;
2774 }
2775
2776 while (p < pend) {
2777 VALUE part;
2778 long len, beglen;
2779
2780 while (p < pend && *p != ':') p++;
2781
2782 if (pbeg == p) goto wrong_name;
2783
2784 id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
2785 beglen = pbeg-path;
2786
2787 if (p < pend && p[0] == ':') {
2788 if (p + 2 >= pend || p[1] != ':') goto wrong_name;
2789 p += 2;
2790 pbeg = p;
2791 }
2792
2793 if (!id) {
2794 part = rb_str_subseq(name, beglen, len);
2795 OBJ_FREEZE(part);
2796 if (!rb_is_const_name(part)) {
2797 name = part;
2798 goto wrong_name;
2799 }
2800 else {
2801 return Qnil;
2802 }
2803 }
2804 if (!rb_is_const_id(id)) {
2805 name = ID2SYM(id);
2806 goto wrong_name;
2807 }
2808 if (p < pend) {
2809 if (RTEST(recur)) {
2810 mod = rb_const_get(mod, id);
2811 }
2812 else {
2813 mod = rb_const_get_at(mod, id);
2814 }
2815 if (!RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
2816 rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
2817 QUOTE(name));
2818 }
2819 }
2820 else {
2821 if (RTEST(recur)) {
2822 loc = rb_const_source_location(mod, id);
2823 }
2824 else {
2825 loc = rb_const_source_location_at(mod, id);
2826 }
2827 break;
2828 }
2829 recur = Qfalse;
2830 }
2831
2832 return loc;
2833
2834 wrong_name:
2835 rb_name_err_raise(wrong_constant_name, mod, name);
2837}
2838
2839/*
2840 * call-seq:
2841 * obj.instance_variable_get(symbol) -> obj
2842 * obj.instance_variable_get(string) -> obj
2843 *
2844 * Returns the value of the given instance variable, or nil if the
2845 * instance variable is not set. The <code>@</code> part of the
2846 * variable name should be included for regular instance
2847 * variables. Throws a NameError exception if the
2848 * supplied symbol is not valid as an instance variable name.
2849 * String arguments are converted to symbols.
2850 *
2851 * class Fred
2852 * def initialize(p1, p2)
2853 * @a, @b = p1, p2
2854 * end
2855 * end
2856 * fred = Fred.new('cat', 99)
2857 * fred.instance_variable_get(:@a) #=> "cat"
2858 * fred.instance_variable_get("@b") #=> 99
2859 */
2860
2861static VALUE
2862rb_obj_ivar_get(VALUE obj, VALUE iv)
2863{
2864 ID id = id_for_var(obj, iv, instance);
2865
2866 if (!id) {
2867 return Qnil;
2868 }
2869 return rb_ivar_get(obj, id);
2870}
2871
2872/*
2873 * call-seq:
2874 * obj.instance_variable_set(symbol, obj) -> obj
2875 * obj.instance_variable_set(string, obj) -> obj
2876 *
2877 * Sets the instance variable named by <i>symbol</i> to the given
2878 * object. This may circumvent the encapsulation intended by
2879 * the author of the class, so it should be used with care.
2880 * The variable does not have to exist prior to this call.
2881 * If the instance variable name is passed as a string, that string
2882 * is converted to a symbol.
2883 *
2884 * class Fred
2885 * def initialize(p1, p2)
2886 * @a, @b = p1, p2
2887 * end
2888 * end
2889 * fred = Fred.new('cat', 99)
2890 * fred.instance_variable_set(:@a, 'dog') #=> "dog"
2891 * fred.instance_variable_set(:@c, 'cat') #=> "cat"
2892 * fred.inspect #=> "#<Fred:0x401b3da8 @a=\"dog\", @b=99, @c=\"cat\">"
2893 */
2894
2895static VALUE
2896rb_obj_ivar_set_m(VALUE obj, VALUE iv, VALUE val)
2897{
2898 ID id = id_for_var(obj, iv, instance);
2899 if (!id) id = rb_intern_str(iv);
2900 return rb_ivar_set(obj, id, val);
2901}
2902
2903/*
2904 * call-seq:
2905 * obj.instance_variable_defined?(symbol) -> true or false
2906 * obj.instance_variable_defined?(string) -> true or false
2907 *
2908 * Returns <code>true</code> if the given instance variable is
2909 * defined in <i>obj</i>.
2910 * String arguments are converted to symbols.
2911 *
2912 * class Fred
2913 * def initialize(p1, p2)
2914 * @a, @b = p1, p2
2915 * end
2916 * end
2917 * fred = Fred.new('cat', 99)
2918 * fred.instance_variable_defined?(:@a) #=> true
2919 * fred.instance_variable_defined?("@b") #=> true
2920 * fred.instance_variable_defined?("@c") #=> false
2921 */
2922
2923static VALUE
2924rb_obj_ivar_defined(VALUE obj, VALUE iv)
2925{
2926 ID id = id_for_var(obj, iv, instance);
2927
2928 if (!id) {
2929 return Qfalse;
2930 }
2931 return rb_ivar_defined(obj, id);
2932}
2933
2934/*
2935 * call-seq:
2936 * mod.class_variable_get(symbol) -> obj
2937 * mod.class_variable_get(string) -> obj
2938 *
2939 * Returns the value of the given class variable (or throws a
2940 * NameError exception). The <code>@@</code> part of the
2941 * variable name should be included for regular class variables.
2942 * String arguments are converted to symbols.
2943 *
2944 * class Fred
2945 * @@foo = 99
2946 * end
2947 * Fred.class_variable_get(:@@foo) #=> 99
2948 */
2949
2950static VALUE
2951rb_mod_cvar_get(VALUE obj, VALUE iv)
2952{
2953 ID id = id_for_var(obj, iv, class);
2954
2955 if (!id) {
2956 rb_name_err_raise("uninitialized class variable %1$s in %2$s",
2957 obj, iv);
2958 }
2959 return rb_cvar_get(obj, id);
2960}
2961
2962/*
2963 * call-seq:
2964 * obj.class_variable_set(symbol, obj) -> obj
2965 * obj.class_variable_set(string, obj) -> obj
2966 *
2967 * Sets the class variable named by <i>symbol</i> to the given
2968 * object.
2969 * If the class variable name is passed as a string, that string
2970 * is converted to a symbol.
2971 *
2972 * class Fred
2973 * @@foo = 99
2974 * def foo
2975 * @@foo
2976 * end
2977 * end
2978 * Fred.class_variable_set(:@@foo, 101) #=> 101
2979 * Fred.new.foo #=> 101
2980 */
2981
2982static VALUE
2983rb_mod_cvar_set(VALUE obj, VALUE iv, VALUE val)
2984{
2985 ID id = id_for_var(obj, iv, class);
2986 if (!id) id = rb_intern_str(iv);
2987 rb_cvar_set(obj, id, val);
2988 return val;
2989}
2990
2991/*
2992 * call-seq:
2993 * obj.class_variable_defined?(symbol) -> true or false
2994 * obj.class_variable_defined?(string) -> true or false
2995 *
2996 * Returns <code>true</code> if the given class variable is defined
2997 * in <i>obj</i>.
2998 * String arguments are converted to symbols.
2999 *
3000 * class Fred
3001 * @@foo = 99
3002 * end
3003 * Fred.class_variable_defined?(:@@foo) #=> true
3004 * Fred.class_variable_defined?(:@@bar) #=> false
3005 */
3006
3007static VALUE
3008rb_mod_cvar_defined(VALUE obj, VALUE iv)
3009{
3010 ID id = id_for_var(obj, iv, class);
3011
3012 if (!id) {
3013 return Qfalse;
3014 }
3015 return rb_cvar_defined(obj, id);
3016}
3017
3018/*
3019 * call-seq:
3020 * mod.singleton_class? -> true or false
3021 *
3022 * Returns <code>true</code> if <i>mod</i> is a singleton class or
3023 * <code>false</code> if it is an ordinary class or module.
3024 *
3025 * class C
3026 * end
3027 * C.singleton_class? #=> false
3028 * C.singleton_class.singleton_class? #=> true
3029 */
3030
3031static VALUE
3032rb_mod_singleton_p(VALUE klass)
3033{
3034 return RBOOL(RCLASS_SINGLETON_P(klass));
3035}
3036
3038static const struct conv_method_tbl {
3039 const char method[6];
3040 unsigned short id;
3041} conv_method_names[] = {
3042#define M(n) {#n, (unsigned short)idTo_##n}
3043 M(int),
3044 M(ary),
3045 M(str),
3046 M(sym),
3047 M(hash),
3048 M(proc),
3049 M(io),
3050 M(a),
3051 M(s),
3052 M(i),
3053 M(f),
3054 M(r),
3055#undef M
3056};
3057#define IMPLICIT_CONVERSIONS 7
3058
3059static int
3060conv_method_index(const char *method)
3061{
3062 static const char prefix[] = "to_";
3063
3064 if (strncmp(prefix, method, sizeof(prefix)-1) == 0) {
3065 const char *const meth = &method[sizeof(prefix)-1];
3066 int i;
3067 for (i=0; i < numberof(conv_method_names); i++) {
3068 if (conv_method_names[i].method[0] == meth[0] &&
3069 strcmp(conv_method_names[i].method, meth) == 0) {
3070 return i;
3071 }
3072 }
3073 }
3074 return numberof(conv_method_names);
3075}
3076
3077static VALUE
3078convert_type_with_id(VALUE val, const char *tname, ID method, int raise, int index)
3079{
3080 VALUE r = rb_check_funcall(val, method, 0, 0);
3081 if (UNDEF_P(r)) {
3082 if (raise) {
3083 const char *msg =
3084 ((index < 0 ? conv_method_index(rb_id2name(method)) : index)
3085 < IMPLICIT_CONVERSIONS) ?
3086 "no implicit conversion of" : "can't convert";
3087 const char *cname = NIL_P(val) ? "nil" :
3088 val == Qtrue ? "true" :
3089 val == Qfalse ? "false" :
3090 NULL;
3091 if (cname)
3092 rb_raise(rb_eTypeError, "%s %s into %s", msg, cname, tname);
3093 rb_raise(rb_eTypeError, "%s %"PRIsVALUE" into %s", msg,
3094 rb_obj_class(val),
3095 tname);
3096 }
3097 return Qnil;
3098 }
3099 return r;
3100}
3101
3102static VALUE
3103convert_type(VALUE val, const char *tname, const char *method, int raise)
3104{
3105 int i = conv_method_index(method);
3106 ID m = i < numberof(conv_method_names) ?
3107 conv_method_names[i].id : rb_intern(method);
3108 return convert_type_with_id(val, tname, m, raise, i);
3109}
3110
3112NORETURN(static void conversion_mismatch(VALUE, const char *, const char *, VALUE));
3113static void
3114conversion_mismatch(VALUE val, const char *tname, const char *method, VALUE result)
3115{
3116 VALUE cname = rb_obj_class(val);
3117 rb_raise(rb_eTypeError,
3118 "can't convert %"PRIsVALUE" to %s (%"PRIsVALUE"#%s gives %"PRIsVALUE")",
3119 cname, tname, cname, method, rb_obj_class(result));
3120}
3121
3122VALUE
3123rb_convert_type(VALUE val, int type, const char *tname, const char *method)
3124{
3125 VALUE v;
3126
3127 if (TYPE(val) == type) return val;
3128 v = convert_type(val, tname, method, TRUE);
3129 if (TYPE(v) != type) {
3130 conversion_mismatch(val, tname, method, v);
3131 }
3132 return v;
3133}
3134
3136VALUE
3137rb_convert_type_with_id(VALUE val, int type, const char *tname, ID method)
3138{
3139 VALUE v;
3140
3141 if (TYPE(val) == type) return val;
3142 v = convert_type_with_id(val, tname, method, TRUE, -1);
3143 if (TYPE(v) != type) {
3144 conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
3145 }
3146 return v;
3147}
3148
3149VALUE
3150rb_check_convert_type(VALUE val, int type, const char *tname, const char *method)
3151{
3152 VALUE v;
3153
3154 /* always convert T_DATA */
3155 if (TYPE(val) == type && type != T_DATA) return val;
3156 v = convert_type(val, tname, method, FALSE);
3157 if (NIL_P(v)) return Qnil;
3158 if (TYPE(v) != type) {
3159 conversion_mismatch(val, tname, method, v);
3160 }
3161 return v;
3162}
3163
3165VALUE
3166rb_check_convert_type_with_id(VALUE val, int type, const char *tname, ID method)
3167{
3168 VALUE v;
3169
3170 /* always convert T_DATA */
3171 if (TYPE(val) == type && type != T_DATA) return val;
3172 v = convert_type_with_id(val, tname, method, FALSE, -1);
3173 if (NIL_P(v)) return Qnil;
3174 if (TYPE(v) != type) {
3175 conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
3176 }
3177 return v;
3178}
3179
3180#define try_to_int(val, mid, raise) \
3181 convert_type_with_id(val, "Integer", mid, raise, -1)
3182
3183ALWAYS_INLINE(static VALUE rb_to_integer_with_id_exception(VALUE val, const char *method, ID mid, int raise));
3184/* Integer specific rb_check_convert_type_with_id */
3185static inline VALUE
3186rb_to_integer_with_id_exception(VALUE val, const char *method, ID mid, int raise)
3187{
3188 // We need to pop the lazily pushed frame when not raising an exception.
3189 rb_control_frame_t *current_cfp;
3190 VALUE v;
3191
3192 if (RB_INTEGER_TYPE_P(val)) return val;
3193 current_cfp = GET_EC()->cfp;
3194 rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
3195 v = try_to_int(val, mid, raise);
3196 if (!raise && NIL_P(v)) {
3197 GET_EC()->cfp = current_cfp;
3198 return Qnil;
3199 }
3200 if (!RB_INTEGER_TYPE_P(v)) {
3201 conversion_mismatch(val, "Integer", method, v);
3202 }
3203 GET_EC()->cfp = current_cfp;
3204 return v;
3205}
3206#define rb_to_integer(val, method, mid) \
3207 rb_to_integer_with_id_exception(val, method, mid, TRUE)
3208
3209VALUE
3210rb_check_to_integer(VALUE val, const char *method)
3211{
3212 VALUE v;
3213
3214 if (RB_INTEGER_TYPE_P(val)) return val;
3215 v = convert_type(val, "Integer", method, FALSE);
3216 if (!RB_INTEGER_TYPE_P(v)) {
3217 return Qnil;
3218 }
3219 return v;
3220}
3221
3222VALUE
3224{
3225 return rb_to_integer(val, "to_int", idTo_int);
3226}
3227
3228VALUE
3230{
3231 if (RB_INTEGER_TYPE_P(val)) return val;
3232 val = try_to_int(val, idTo_int, FALSE);
3233 if (RB_INTEGER_TYPE_P(val)) return val;
3234 return Qnil;
3235}
3236
3237static VALUE
3238rb_check_to_i(VALUE val)
3239{
3240 if (RB_INTEGER_TYPE_P(val)) return val;
3241 val = try_to_int(val, idTo_i, FALSE);
3242 if (RB_INTEGER_TYPE_P(val)) return val;
3243 return Qnil;
3244}
3245
3246static VALUE
3247rb_convert_to_integer(VALUE val, int base, int raise_exception)
3248{
3249 VALUE tmp;
3250
3251 if (base) {
3252 tmp = rb_check_string_type(val);
3253
3254 if (! NIL_P(tmp)) {
3255 val = tmp;
3256 }
3257 else if (! raise_exception) {
3258 return Qnil;
3259 }
3260 else {
3261 rb_raise(rb_eArgError, "base specified for non string value");
3262 }
3263 }
3264 if (RB_FLOAT_TYPE_P(val)) {
3265 double f = RFLOAT_VALUE(val);
3266 if (!raise_exception && !isfinite(f)) return Qnil;
3267 if (FIXABLE(f)) return LONG2FIX((long)f);
3268 return rb_dbl2big(f);
3269 }
3270 else if (RB_INTEGER_TYPE_P(val)) {
3271 return val;
3272 }
3273 else if (RB_TYPE_P(val, T_STRING)) {
3274 return rb_str_convert_to_inum(val, base, TRUE, raise_exception);
3275 }
3276 else if (NIL_P(val)) {
3277 if (!raise_exception) return Qnil;
3278 rb_raise(rb_eTypeError, "can't convert nil into Integer");
3279 }
3280
3281 tmp = rb_protect(rb_check_to_int, val, NULL);
3282 if (RB_INTEGER_TYPE_P(tmp)) return tmp;
3283 rb_set_errinfo(Qnil);
3284 if (!NIL_P(tmp = rb_check_string_type(val))) {
3285 return rb_str_convert_to_inum(tmp, base, TRUE, raise_exception);
3286 }
3287
3288 if (!raise_exception) {
3289 VALUE result = rb_protect(rb_check_to_i, val, NULL);
3290 rb_set_errinfo(Qnil);
3291 return result;
3292 }
3293
3294 return rb_to_integer(val, "to_i", idTo_i);
3295}
3296
3297VALUE
3299{
3300 return rb_convert_to_integer(val, 0, TRUE);
3301}
3302
3303VALUE
3304rb_check_integer_type(VALUE val)
3305{
3306 return rb_to_integer_with_id_exception(val, "to_int", idTo_int, FALSE);
3307}
3308
3309int
3310rb_bool_expected(VALUE obj, const char *flagname, int raise)
3311{
3312 switch (obj) {
3313 case Qtrue:
3314 return TRUE;
3315 case Qfalse:
3316 return FALSE;
3317 default: {
3318 static const char message[] = "expected true or false as %s: %+"PRIsVALUE;
3319 if (raise) {
3320 rb_raise(rb_eArgError, message, flagname, obj);
3321 }
3322 rb_warning(message, flagname, obj);
3323 return !NIL_P(obj);
3324 }
3325 }
3326}
3327
3328int
3329rb_opts_exception_p(VALUE opts, int default_value)
3330{
3331 static const ID kwds[1] = {idException};
3332 VALUE exception;
3333 if (rb_get_kwargs(opts, kwds, 0, 1, &exception))
3334 return rb_bool_expected(exception, "exception", TRUE);
3335 return default_value;
3336}
3337
3338static VALUE
3339rb_f_integer1(rb_execution_context_t *ec, VALUE obj, VALUE arg)
3340{
3341 return rb_convert_to_integer(arg, 0, TRUE);
3342}
3343
3344static VALUE
3345rb_f_integer(rb_execution_context_t *ec, VALUE obj, VALUE arg, VALUE base, VALUE exception)
3346{
3347 int exc = rb_bool_expected(exception, "exception", TRUE);
3348 return rb_convert_to_integer(arg, NUM2INT(base), exc);
3349}
3350
3351static bool
3352is_digit_char(unsigned char c, int base)
3353{
3355 return (i >= 0 && i < base);
3356}
3357
3358static double
3359rb_cstr_to_dbl_raise(const char *p, rb_encoding *enc, int badcheck, int raise, int *error)
3360{
3361 const char *q;
3362 char *end;
3363 double d;
3364 const char *ellipsis = "";
3365 int w;
3366 enum {max_width = 20};
3367#define OutOfRange() ((end - p > max_width) ? \
3368 (w = max_width, ellipsis = "...") : \
3369 (w = (int)(end - p), ellipsis = ""))
3370 /* p...end has been parsed with strtod, should be ASCII-only */
3371
3372 if (!p) return 0.0;
3373 q = p;
3374 while (ISSPACE(*p)) p++;
3375
3376 if (!badcheck && p[0] == '0' && (p[1] == 'x' || p[1] == 'X')) {
3377 return 0.0;
3378 }
3379
3380 d = strtod(p, &end);
3381 if (errno == ERANGE) {
3382 OutOfRange();
3383 rb_warning("Float %.*s%s out of range", w, p, ellipsis);
3384 errno = 0;
3385 }
3386 if (p == end) {
3387 if (badcheck) {
3388 goto bad;
3389 }
3390 return d;
3391 }
3392 if (*end) {
3393 char buf[DBL_DIG * 4 + 10];
3394 char *n = buf;
3395 char *const init_e = buf + DBL_DIG * 4;
3396 char *e = init_e;
3397 char prev = 0;
3398 int dot_seen = FALSE;
3399 int base = 10;
3400 char exp_letter = 'e';
3401
3402 switch (*p) {case '+': case '-': prev = *n++ = *p++;}
3403 if (*p == '0') {
3404 prev = *n++ = '0';
3405 switch (*++p) {
3406 case 'x': case 'X':
3407 prev = *n++ = 'x';
3408 base = 16;
3409 exp_letter = 'p';
3410 if (*++p != '0') break;
3411 /* fallthrough */
3412 case '0': /* squeeze successive zeros */
3413 while (*++p == '0');
3414 break;
3415 }
3416 }
3417 while (p < end && n < e) prev = *n++ = *p++;
3418 while (*p) {
3419 if (*p == '_') {
3420 /* remove an underscore between digits */
3421 if (n == buf ||
3422 !is_digit_char(prev, base) ||
3423 !is_digit_char(*++p, base)) {
3424 if (badcheck) goto bad;
3425 break;
3426 }
3427 }
3428 prev = *p++;
3429 if (e == init_e && (rb_tolower(prev) == exp_letter)) {
3430 e = buf + sizeof(buf) - 1;
3431 *n++ = prev;
3432 switch (*p) {case '+': case '-': prev = *n++ = *p++;}
3433 if (*p == '0') {
3434 prev = *n++ = '0';
3435 while (*++p == '0');
3436 }
3437
3438 /* reset base to decimal for underscore check of
3439 * binary exponent part */
3440 base = 10;
3441 continue;
3442 }
3443 else if (ISSPACE(prev)) {
3444 while (ISSPACE(*p)) ++p;
3445 if (*p) {
3446 if (badcheck) goto bad;
3447 break;
3448 }
3449 }
3450 else if (prev == '.' ? dot_seen++ : !is_digit_char(prev, base)) {
3451 if (badcheck) goto bad;
3452 break;
3453 }
3454 if (n < e) *n++ = prev;
3455 }
3456 *n = '\0';
3457 p = buf;
3458
3459 if (!badcheck && p[0] == '0' && (p[1] == 'x' || p[1] == 'X')) {
3460 return 0.0;
3461 }
3462
3463 d = strtod(p, &end);
3464 if (errno == ERANGE) {
3465 OutOfRange();
3466 rb_warning("Float %.*s%s out of range", w, p, ellipsis);
3467 errno = 0;
3468 }
3469 if (badcheck) {
3470 if (!end || p == end) goto bad;
3471 while (*end && ISSPACE(*end)) end++;
3472 if (*end) goto bad;
3473 }
3474 }
3475 if (errno == ERANGE) {
3476 errno = 0;
3477 OutOfRange();
3478 rb_raise(rb_eArgError, "Float %.*s%s out of range", w, q, ellipsis);
3479 }
3480 return d;
3481
3482 bad:
3483 if (raise) {
3484 VALUE s = rb_enc_str_new_cstr(q, enc);
3485 rb_raise(rb_eArgError, "invalid value for Float(): %+"PRIsVALUE, s);
3486 UNREACHABLE_RETURN(nan(""));
3487 }
3488 else {
3489 if (error) *error = 1;
3490 return 0.0;
3491 }
3492}
3493
3494double
3495rb_cstr_to_dbl(const char *p, int badcheck)
3496{
3497 return rb_cstr_to_dbl_raise(p, NULL, badcheck, TRUE, NULL);
3498}
3499
3500static double
3501rb_str_to_dbl_raise(VALUE str, int badcheck, int raise, int *error)
3502{
3503 char *s;
3504 long len;
3505 double ret;
3506 VALUE v = 0;
3507
3508 StringValue(str);
3510 s = RSTRING_PTR(str);
3511 len = RSTRING_LEN(str);
3512 if (s) {
3513 if (badcheck && memchr(s, '\0', len)) {
3514 if (raise)
3515 rb_raise(rb_eArgError, "string for Float contains null byte");
3516 else {
3517 if (error) *error = 1;
3518 return 0.0;
3519 }
3520 }
3521 if (s[len]) { /* no sentinel somehow */
3522 char *p = ALLOCV(v, (size_t)len + 1);
3523 MEMCPY(p, s, char, len);
3524 p[len] = '\0';
3525 s = p;
3526 }
3527 }
3528 ret = rb_cstr_to_dbl_raise(s, rb_enc_get(str), badcheck, raise, error);
3529 if (v)
3530 ALLOCV_END(v);
3531 else
3532 RB_GC_GUARD(str);
3533 return ret;
3534}
3535
3536FUNC_MINIMIZED(double rb_str_to_dbl(VALUE str, int badcheck));
3537
3538double
3539rb_str_to_dbl(VALUE str, int badcheck)
3540{
3541 return rb_str_to_dbl_raise(str, badcheck, TRUE, NULL);
3542}
3543
3545#define fix2dbl_without_to_f(x) (double)FIX2LONG(x)
3546#define big2dbl_without_to_f(x) rb_big2dbl(x)
3547#define int2dbl_without_to_f(x) \
3548 (FIXNUM_P(x) ? fix2dbl_without_to_f(x) : big2dbl_without_to_f(x))
3549#define num2dbl_without_to_f(x) \
3550 (FIXNUM_P(x) ? fix2dbl_without_to_f(x) : \
3551 RB_BIGNUM_TYPE_P(x) ? big2dbl_without_to_f(x) : \
3552 (Check_Type(x, T_FLOAT), RFLOAT_VALUE(x)))
3553static inline double
3554rat2dbl_without_to_f(VALUE x)
3555{
3556 VALUE num = rb_rational_num(x);
3557 VALUE den = rb_rational_den(x);
3558 return num2dbl_without_to_f(num) / num2dbl_without_to_f(den);
3559}
3560
3561#define special_const_to_float(val, pre, post) \
3562 switch (val) { \
3563 case Qnil: \
3564 rb_raise_static(rb_eTypeError, pre "nil" post); \
3565 case Qtrue: \
3566 rb_raise_static(rb_eTypeError, pre "true" post); \
3567 case Qfalse: \
3568 rb_raise_static(rb_eTypeError, pre "false" post); \
3569 }
3572static inline void
3573conversion_to_float(VALUE val)
3574{
3575 special_const_to_float(val, "can't convert ", " into Float");
3576}
3577
3578static inline void
3579implicit_conversion_to_float(VALUE val)
3580{
3581 special_const_to_float(val, "no implicit conversion to float from ", "");
3582}
3583
3584static int
3585to_float(VALUE *valp, int raise_exception)
3586{
3587 VALUE val = *valp;
3588 if (SPECIAL_CONST_P(val)) {
3589 if (FIXNUM_P(val)) {
3590 *valp = DBL2NUM(fix2dbl_without_to_f(val));
3591 return T_FLOAT;
3592 }
3593 else if (FLONUM_P(val)) {
3594 return T_FLOAT;
3595 }
3596 else if (raise_exception) {
3597 conversion_to_float(val);
3598 }
3599 }
3600 else {
3601 int type = BUILTIN_TYPE(val);
3602 switch (type) {
3603 case T_FLOAT:
3604 return T_FLOAT;
3605 case T_BIGNUM:
3606 *valp = DBL2NUM(big2dbl_without_to_f(val));
3607 return T_FLOAT;
3608 case T_RATIONAL:
3609 *valp = DBL2NUM(rat2dbl_without_to_f(val));
3610 return T_FLOAT;
3611 case T_STRING:
3612 return T_STRING;
3613 }
3614 }
3615 return T_NONE;
3616}
3617
3618static VALUE
3619convert_type_to_float_protected(VALUE val)
3620{
3621 return rb_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
3622}
3623
3624static VALUE
3625rb_convert_to_float(VALUE val, int raise_exception)
3626{
3627 switch (to_float(&val, raise_exception)) {
3628 case T_FLOAT:
3629 return val;
3630 case T_STRING:
3631 if (!raise_exception) {
3632 int e = 0;
3633 double x = rb_str_to_dbl_raise(val, TRUE, raise_exception, &e);
3634 return e ? Qnil : DBL2NUM(x);
3635 }
3636 return DBL2NUM(rb_str_to_dbl(val, TRUE));
3637 case T_NONE:
3638 if (SPECIAL_CONST_P(val) && !raise_exception)
3639 return Qnil;
3640 }
3641
3642 if (!raise_exception) {
3643 int state;
3644 VALUE result = rb_protect(convert_type_to_float_protected, val, &state);
3645 if (state) rb_set_errinfo(Qnil);
3646 return result;
3647 }
3648
3649 return rb_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
3650}
3651
3652FUNC_MINIMIZED(VALUE rb_Float(VALUE val));
3653
3654VALUE
3656{
3657 return rb_convert_to_float(val, TRUE);
3658}
3659
3660static VALUE
3661rb_f_float1(rb_execution_context_t *ec, VALUE obj, VALUE arg)
3662{
3663 return rb_convert_to_float(arg, TRUE);
3664}
3665
3666static VALUE
3667rb_f_float(rb_execution_context_t *ec, VALUE obj, VALUE arg, VALUE opts)
3668{
3669 int exception = rb_bool_expected(opts, "exception", TRUE);
3670 return rb_convert_to_float(arg, exception);
3671}
3672
3673static VALUE
3674numeric_to_float(VALUE val)
3675{
3676 if (!rb_obj_is_kind_of(val, rb_cNumeric)) {
3677 rb_raise(rb_eTypeError, "can't convert %"PRIsVALUE" into Float",
3678 rb_obj_class(val));
3679 }
3680 return rb_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
3681}
3682
3683VALUE
3685{
3686 switch (to_float(&val, TRUE)) {
3687 case T_FLOAT:
3688 return val;
3689 }
3690 return numeric_to_float(val);
3691}
3692
3693VALUE
3695{
3696 if (RB_FLOAT_TYPE_P(val)) return val;
3697 if (!rb_obj_is_kind_of(val, rb_cNumeric)) {
3698 return Qnil;
3699 }
3700 return rb_check_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
3701}
3702
3703static inline int
3704basic_to_f_p(VALUE klass)
3705{
3706 return rb_method_basic_definition_p(klass, id_to_f);
3707}
3708
3710double
3711rb_num_to_dbl(VALUE val)
3712{
3713 if (SPECIAL_CONST_P(val)) {
3714 if (FIXNUM_P(val)) {
3715 if (basic_to_f_p(rb_cInteger))
3716 return fix2dbl_without_to_f(val);
3717 }
3718 else if (FLONUM_P(val)) {
3719 return rb_float_flonum_value(val);
3720 }
3721 else {
3722 conversion_to_float(val);
3723 }
3724 }
3725 else {
3726 switch (BUILTIN_TYPE(val)) {
3727 case T_FLOAT:
3728 return rb_float_noflonum_value(val);
3729 case T_BIGNUM:
3730 if (basic_to_f_p(rb_cInteger))
3731 return big2dbl_without_to_f(val);
3732 break;
3733 case T_RATIONAL:
3734 if (basic_to_f_p(rb_cRational))
3735 return rat2dbl_without_to_f(val);
3736 break;
3737 default:
3738 break;
3739 }
3740 }
3741 val = numeric_to_float(val);
3742 return RFLOAT_VALUE(val);
3743}
3744
3745double
3747{
3748 if (SPECIAL_CONST_P(val)) {
3749 if (FIXNUM_P(val)) {
3750 return fix2dbl_without_to_f(val);
3751 }
3752 else if (FLONUM_P(val)) {
3753 return rb_float_flonum_value(val);
3754 }
3755 else {
3756 implicit_conversion_to_float(val);
3757 }
3758 }
3759 else {
3760 switch (BUILTIN_TYPE(val)) {
3761 case T_FLOAT:
3762 return rb_float_noflonum_value(val);
3763 case T_BIGNUM:
3764 return big2dbl_without_to_f(val);
3765 case T_RATIONAL:
3766 return rat2dbl_without_to_f(val);
3767 case T_STRING:
3768 rb_raise(rb_eTypeError, "no implicit conversion to float from string");
3769 default:
3770 break;
3771 }
3772 }
3773 val = rb_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
3774 return RFLOAT_VALUE(val);
3775}
3776
3777VALUE
3779{
3780 VALUE tmp = rb_check_string_type(val);
3781 if (NIL_P(tmp))
3782 tmp = rb_convert_type_with_id(val, T_STRING, "String", idTo_s);
3783 return tmp;
3784}
3785
3786
3787/*
3788 * call-seq:
3789 * String(object) -> object or new_string
3790 *
3791 * Returns a string converted from +object+.
3792 *
3793 * Tries to convert +object+ to a string
3794 * using +to_str+ first and +to_s+ second:
3795 *
3796 * String([0, 1, 2]) # => "[0, 1, 2]"
3797 * String(0..5) # => "0..5"
3798 * String({foo: 0, bar: 1}) # => "{foo: 0, bar: 1}"
3799 *
3800 * Raises +TypeError+ if +object+ cannot be converted to a string.
3801 */
3802
3803static VALUE
3804rb_f_string(VALUE obj, VALUE arg)
3805{
3806 return rb_String(arg);
3807}
3808
3809VALUE
3811{
3812 VALUE tmp = rb_check_array_type(val);
3813
3814 if (NIL_P(tmp)) {
3815 tmp = rb_check_to_array(val);
3816 if (NIL_P(tmp)) {
3817 return rb_ary_new3(1, val);
3818 }
3819 }
3820 return tmp;
3821}
3822
3823/*
3824 * call-seq:
3825 * Array(object) -> object or new_array
3826 *
3827 * Returns an array converted from +object+.
3828 *
3829 * Tries to convert +object+ to an array
3830 * using +to_ary+ first and +to_a+ second:
3831 *
3832 * Array([0, 1, 2]) # => [0, 1, 2]
3833 * Array({foo: 0, bar: 1}) # => [[:foo, 0], [:bar, 1]]
3834 * Array(0..4) # => [0, 1, 2, 3, 4]
3835 *
3836 * Returns +object+ in an array, <tt>[object]</tt>,
3837 * if +object+ cannot be converted:
3838 *
3839 * Array(:foo) # => [:foo]
3840 *
3841 */
3842
3843static VALUE
3844rb_f_array(VALUE obj, VALUE arg)
3845{
3846 return rb_Array(arg);
3847}
3848
3852VALUE
3854{
3855 VALUE tmp;
3856
3857 if (NIL_P(val)) return rb_hash_new();
3858 tmp = rb_check_hash_type(val);
3859 if (NIL_P(tmp)) {
3860 if (RB_TYPE_P(val, T_ARRAY) && RARRAY_LEN(val) == 0)
3861 return rb_hash_new();
3862 rb_raise(rb_eTypeError, "can't convert %s into Hash", rb_obj_classname(val));
3863 }
3864 return tmp;
3865}
3866
3867/*
3868 * call-seq:
3869 * Hash(object) -> object or new_hash
3870 *
3871 * Returns a hash converted from +object+.
3872 *
3873 * - If +object+ is:
3874 *
3875 * - A hash, returns +object+.
3876 * - An empty array or +nil+, returns an empty hash.
3877 *
3878 * - Otherwise, if <tt>object.to_hash</tt> returns a hash, returns that hash.
3879 * - Otherwise, returns TypeError.
3880 *
3881 * Examples:
3882 *
3883 * Hash({foo: 0, bar: 1}) # => {:foo=>0, :bar=>1}
3884 * Hash(nil) # => {}
3885 * Hash([]) # => {}
3886 *
3887 */
3888
3889static VALUE
3890rb_f_hash(VALUE obj, VALUE arg)
3891{
3892 return rb_Hash(arg);
3893}
3894
3896struct dig_method {
3897 VALUE klass;
3898 int basic;
3899};
3900
3901static ID id_dig;
3902
3903static int
3904dig_basic_p(VALUE obj, struct dig_method *cache)
3905{
3906 VALUE klass = RBASIC_CLASS(obj);
3907 if (klass != cache->klass) {
3908 cache->klass = klass;
3909 cache->basic = rb_method_basic_definition_p(klass, id_dig);
3910 }
3911 return cache->basic;
3912}
3913
3914static void
3915no_dig_method(int found, VALUE recv, ID mid, int argc, const VALUE *argv, VALUE data)
3916{
3917 if (!found) {
3918 rb_raise(rb_eTypeError, "%"PRIsVALUE" does not have #dig method",
3919 CLASS_OF(data));
3920 }
3921}
3922
3924VALUE
3925rb_obj_dig(int argc, VALUE *argv, VALUE obj, VALUE notfound)
3926{
3927 struct dig_method hash = {Qnil}, ary = {Qnil}, strt = {Qnil};
3928
3929 for (; argc > 0; ++argv, --argc) {
3930 if (NIL_P(obj)) return notfound;
3931 if (!SPECIAL_CONST_P(obj)) {
3932 switch (BUILTIN_TYPE(obj)) {
3933 case T_HASH:
3934 if (dig_basic_p(obj, &hash)) {
3935 obj = rb_hash_aref(obj, *argv);
3936 continue;
3937 }
3938 break;
3939 case T_ARRAY:
3940 if (dig_basic_p(obj, &ary)) {
3941 obj = rb_ary_at(obj, *argv);
3942 continue;
3943 }
3944 break;
3945 case T_STRUCT:
3946 if (dig_basic_p(obj, &strt)) {
3947 obj = rb_struct_lookup(obj, *argv);
3948 continue;
3949 }
3950 break;
3951 default:
3952 break;
3953 }
3954 }
3955 return rb_check_funcall_with_hook_kw(obj, id_dig, argc, argv,
3956 no_dig_method, obj,
3958 }
3959 return obj;
3960}
3961
3962/*
3963 * call-seq:
3964 * sprintf(format_string *objects) -> string
3965 *
3966 * Returns the string resulting from formatting +objects+
3967 * into +format_string+.
3968 *
3969 * For details on +format_string+, see
3970 * {Format Specifications}[rdoc-ref:format_specifications.rdoc].
3971 */
3972
3973static VALUE
3974f_sprintf(int c, const VALUE *v, VALUE _)
3975{
3976 return rb_f_sprintf(c, v);
3977}
3978
3979static VALUE
3980rb_f_loop_size(VALUE self, VALUE args, VALUE eobj)
3981{
3982 return DBL2NUM(HUGE_VAL);
3983}
3984
3985/*
3986 * Document-class: Class
3987 *
3988 * Classes in Ruby are first-class objects---each is an instance of
3989 * class Class.
3990 *
3991 * Typically, you create a new class by using:
3992 *
3993 * class Name
3994 * # some code describing the class behavior
3995 * end
3996 *
3997 * When a new class is created, an object of type Class is initialized and
3998 * assigned to a global constant (Name in this case).
3999 *
4000 * When <code>Name.new</code> is called to create a new object, the
4001 * #new method in Class is run by default.
4002 * This can be demonstrated by overriding #new in Class:
4003 *
4004 * class Class
4005 * alias old_new new
4006 * def new(*args)
4007 * print "Creating a new ", self.name, "\n"
4008 * old_new(*args)
4009 * end
4010 * end
4011 *
4012 * class Name
4013 * end
4014 *
4015 * n = Name.new
4016 *
4017 * <em>produces:</em>
4018 *
4019 * Creating a new Name
4020 *
4021 * Classes, modules, and objects are interrelated. In the diagram
4022 * that follows, the vertical arrows represent inheritance, and the
4023 * parentheses metaclasses. All metaclasses are instances
4024 * of the class `Class'.
4025 * +---------+ +-...
4026 * | | |
4027 * BasicObject-----|-->(BasicObject)-------|-...
4028 * ^ | ^ |
4029 * | | | |
4030 * Object---------|----->(Object)---------|-...
4031 * ^ | ^ |
4032 * | | | |
4033 * +-------+ | +--------+ |
4034 * | | | | | |
4035 * | Module-|---------|--->(Module)-|-...
4036 * | ^ | | ^ |
4037 * | | | | | |
4038 * | Class-|---------|---->(Class)-|-...
4039 * | ^ | | ^ |
4040 * | +---+ | +----+
4041 * | |
4042 * obj--->OtherClass---------->(OtherClass)-----------...
4043 *
4044 */
4045
4046
4047/*
4048 * Document-class: BasicObject
4049 *
4050 * +BasicObject+ is the parent class of all classes in Ruby.
4051 * In particular, +BasicObject+ is the parent class of class Object,
4052 * which is itself the default parent class of every Ruby class:
4053 *
4054 * class Foo; end
4055 * Foo.superclass # => Object
4056 * Object.superclass # => BasicObject
4057 *
4058 * +BasicObject+ is the only class that has no parent:
4059 *
4060 * BasicObject.superclass # => nil
4061 *
4062 * Class +BasicObject+ can be used to create an object hierarchy
4063 * (e.g., class Delegator) that is independent of Ruby's object hierarchy.
4064 * Such objects:
4065 *
4066 * - Do not have namespace "pollution" from the many methods
4067 * provided in class Object and its included module Kernel.
4068 * - Do not have definitions of common classes,
4069 * and so references to such common classes must be fully qualified
4070 * (+::String+, not +String+).
4071 *
4072 * A variety of strategies can be used to provide useful portions
4073 * of the Standard Library in subclasses of +BasicObject+:
4074 *
4075 * - The immediate subclass could <tt>include Kernel</tt>,
4076 * which would define methods such as +puts+, +exit+, etc.
4077 * - A custom Kernel-like module could be created and included.
4078 * - Delegation can be used via #method_missing:
4079 *
4080 * class MyObjectSystem < BasicObject
4081 * DELEGATE = [:puts, :p]
4082 *
4083 * def method_missing(name, *args, &block)
4084 * return super unless DELEGATE.include? name
4085 * ::Kernel.send(name, *args, &block)
4086 * end
4087 *
4088 * def respond_to_missing?(name, include_private = false)
4089 * DELEGATE.include?(name)
4090 * end
4091 * end
4092 *
4093 * === What's Here
4094 *
4095 * These are the methods defined for \BasicObject:
4096 *
4097 * - ::new: Returns a new \BasicObject instance.
4098 * - #!: Returns the boolean negation of +self+: +true+ or +false+.
4099 * - #!=: Returns whether +self+ and the given object are _not_ equal.
4100 * - #==: Returns whether +self+ and the given object are equivalent.
4101 * - #__id__: Returns the integer object identifier for +self+.
4102 * - #__send__: Calls the method identified by the given symbol.
4103 * - #equal?: Returns whether +self+ and the given object are the same object.
4104 * - #instance_eval: Evaluates the given string or block in the context of +self+.
4105 * - #instance_exec: Executes the given block in the context of +self+, passing the given arguments.
4106 * - #method_missing: Called when +self+ is called with a method it does not define.
4107 * - #singleton_method_added: Called when a singleton method is added to +self+.
4108 * - #singleton_method_removed: Called when a singleton method is removed from +self+.
4109 * - #singleton_method_undefined: Called when a singleton method is undefined in +self+.
4110 *
4111 */
4112
4113/* Document-class: Object
4114 *
4115 * Object is the default root of all Ruby objects. Object inherits from
4116 * BasicObject which allows creating alternate object hierarchies. Methods
4117 * on Object are available to all classes unless explicitly overridden.
4118 *
4119 * Object mixes in the Kernel module, making the built-in kernel functions
4120 * globally accessible. Although the instance methods of Object are defined
4121 * by the Kernel module, we have chosen to document them here for clarity.
4122 *
4123 * When referencing constants in classes inheriting from Object you do not
4124 * need to use the full namespace. For example, referencing +File+ inside
4125 * +YourClass+ will find the top-level File class.
4126 *
4127 * In the descriptions of Object's methods, the parameter <i>symbol</i> refers
4128 * to a symbol, which is either a quoted string or a Symbol (such as
4129 * <code>:name</code>).
4130 *
4131 * == What's Here
4132 *
4133 * First, what's elsewhere. Class \Object:
4134 *
4135 * - Inherits from {class BasicObject}[rdoc-ref:BasicObject@What-27s+Here].
4136 * - Includes {module Kernel}[rdoc-ref:Kernel@What-27s+Here].
4137 *
4138 * Here, class \Object provides methods for:
4139 *
4140 * - {Querying}[rdoc-ref:Object@Querying]
4141 * - {Instance Variables}[rdoc-ref:Object@Instance+Variables]
4142 * - {Other}[rdoc-ref:Object@Other]
4143 *
4144 * === Querying
4145 *
4146 * - #!~: Returns +true+ if +self+ does not match the given object,
4147 * otherwise +false+.
4148 * - #<=>: Returns 0 if +self+ and the given object +object+ are the same
4149 * object, or if <tt>self == object</tt>; otherwise returns +nil+.
4150 * - #===: Implements case equality, effectively the same as calling #==.
4151 * - #eql?: Implements hash equality, effectively the same as calling #==.
4152 * - #kind_of? (aliased as #is_a?): Returns whether given argument is an ancestor
4153 * of the singleton class of +self+.
4154 * - #instance_of?: Returns whether +self+ is an instance of the given class.
4155 * - #instance_variable_defined?: Returns whether the given instance variable
4156 * is defined in +self+.
4157 * - #method: Returns the +Method+ object for the given method in +self+.
4158 * - #methods: Returns an array of symbol names of public and protected methods
4159 * in +self+.
4160 * - #nil?: Returns +false+. (Only +nil+ responds +true+ to method <tt>nil?</tt>.)
4161 * - #object_id: Returns an integer corresponding to +self+ that is unique
4162 * for the current process
4163 * - #private_methods: Returns an array of the symbol names
4164 * of the private methods in +self+.
4165 * - #protected_methods: Returns an array of the symbol names
4166 * of the protected methods in +self+.
4167 * - #public_method: Returns the +Method+ object for the given public method in +self+.
4168 * - #public_methods: Returns an array of the symbol names
4169 * of the public methods in +self+.
4170 * - #respond_to?: Returns whether +self+ responds to the given method.
4171 * - #singleton_class: Returns the singleton class of +self+.
4172 * - #singleton_method: Returns the +Method+ object for the given singleton method
4173 * in +self+.
4174 * - #singleton_methods: Returns an array of the symbol names
4175 * of the singleton methods in +self+.
4176 *
4177 * - #define_singleton_method: Defines a singleton method in +self+
4178 * for the given symbol method-name and block or proc.
4179 * - #extend: Includes the given modules in the singleton class of +self+.
4180 * - #public_send: Calls the given public method in +self+ with the given argument.
4181 * - #send: Calls the given method in +self+ with the given argument.
4182 *
4183 * === Instance Variables
4184 *
4185 * - #instance_variable_get: Returns the value of the given instance variable
4186 * in +self+, or +nil+ if the instance variable is not set.
4187 * - #instance_variable_set: Sets the value of the given instance variable in +self+
4188 * to the given object.
4189 * - #instance_variables: Returns an array of the symbol names
4190 * of the instance variables in +self+.
4191 * - #remove_instance_variable: Removes the named instance variable from +self+.
4192 *
4193 * === Other
4194 *
4195 * - #clone: Returns a shallow copy of +self+, including singleton class
4196 * and frozen state.
4197 * - #define_singleton_method: Defines a singleton method in +self+
4198 * for the given symbol method-name and block or proc.
4199 * - #display: Prints +self+ to the given IO stream or <tt>$stdout</tt>.
4200 * - #dup: Returns a shallow unfrozen copy of +self+.
4201 * - #enum_for (aliased as #to_enum): Returns an Enumerator for +self+
4202 * using the using the given method, arguments, and block.
4203 * - #extend: Includes the given modules in the singleton class of +self+.
4204 * - #freeze: Prevents further modifications to +self+.
4205 * - #hash: Returns the integer hash value for +self+.
4206 * - #inspect: Returns a human-readable string representation of +self+.
4207 * - #itself: Returns +self+.
4208 * - #method_missing: Method called when an undefined method is called on +self+.
4209 * - #public_send: Calls the given public method in +self+ with the given argument.
4210 * - #send: Calls the given method in +self+ with the given argument.
4211 * - #to_s: Returns a string representation of +self+.
4212 *
4213 */
4214
4215void
4216InitVM_Object(void)
4217{
4218 Init_class_hierarchy();
4219
4220#if 0
4221 // teach RDoc about these classes
4222 rb_cBasicObject = rb_define_class("BasicObject", Qnil);
4226 rb_cRefinement = rb_define_class("Refinement", rb_cModule);
4227#endif
4228
4229 rb_define_private_method(rb_cBasicObject, "initialize", rb_obj_initialize, 0);
4230 rb_define_alloc_func(rb_cBasicObject, rb_class_allocate_instance);
4231 rb_define_method(rb_cBasicObject, "==", rb_obj_equal, 1);
4232 rb_define_method(rb_cBasicObject, "equal?", rb_obj_equal, 1);
4233 rb_define_method(rb_cBasicObject, "!", rb_obj_not, 0);
4234 rb_define_method(rb_cBasicObject, "!=", rb_obj_not_equal, 1);
4235
4236 rb_define_private_method(rb_cBasicObject, "singleton_method_added", rb_obj_singleton_method_added, 1);
4237 rb_define_private_method(rb_cBasicObject, "singleton_method_removed", rb_obj_singleton_method_removed, 1);
4238 rb_define_private_method(rb_cBasicObject, "singleton_method_undefined", rb_obj_singleton_method_undefined, 1);
4239
4240 /* Document-module: Kernel
4241 *
4242 * The Kernel module is included by class Object, so its methods are
4243 * available in every Ruby object.
4244 *
4245 * The Kernel instance methods are documented in class Object while the
4246 * module methods are documented here. These methods are called without a
4247 * receiver and thus can be called in functional form:
4248 *
4249 * sprintf "%.1f", 1.234 #=> "1.2"
4250 *
4251 * == What's Here
4252 *
4253 * Module \Kernel provides methods that are useful for:
4254 *
4255 * - {Converting}[rdoc-ref:Kernel@Converting]
4256 * - {Querying}[rdoc-ref:Kernel@Querying]
4257 * - {Exiting}[rdoc-ref:Kernel@Exiting]
4258 * - {Exceptions}[rdoc-ref:Kernel@Exceptions]
4259 * - {IO}[rdoc-ref:Kernel@IO]
4260 * - {Procs}[rdoc-ref:Kernel@Procs]
4261 * - {Tracing}[rdoc-ref:Kernel@Tracing]
4262 * - {Subprocesses}[rdoc-ref:Kernel@Subprocesses]
4263 * - {Loading}[rdoc-ref:Kernel@Loading]
4264 * - {Yielding}[rdoc-ref:Kernel@Yielding]
4265 * - {Random Values}[rdoc-ref:Kernel@Random+Values]
4266 * - {Other}[rdoc-ref:Kernel@Other]
4267 *
4268 * === Converting
4269 *
4270 * - #Array: Returns an Array based on the given argument.
4271 * - #Complex: Returns a Complex based on the given arguments.
4272 * - #Float: Returns a Float based on the given arguments.
4273 * - #Hash: Returns a Hash based on the given argument.
4274 * - #Integer: Returns an Integer based on the given arguments.
4275 * - #Rational: Returns a Rational based on the given arguments.
4276 * - #String: Returns a String based on the given argument.
4277 *
4278 * === Querying
4279 *
4280 * - #__callee__: Returns the called name of the current method as a symbol.
4281 * - #__dir__: Returns the path to the directory from which the current
4282 * method is called.
4283 * - #__method__: Returns the name of the current method as a symbol.
4284 * - #autoload?: Returns the file to be loaded when the given module is referenced.
4285 * - #binding: Returns a Binding for the context at the point of call.
4286 * - #block_given?: Returns +true+ if a block was passed to the calling method.
4287 * - #caller: Returns the current execution stack as an array of strings.
4288 * - #caller_locations: Returns the current execution stack as an array
4289 * of Thread::Backtrace::Location objects.
4290 * - #class: Returns the class of +self+.
4291 * - #frozen?: Returns whether +self+ is frozen.
4292 * - #global_variables: Returns an array of global variables as symbols.
4293 * - #local_variables: Returns an array of local variables as symbols.
4294 * - #test: Performs specified tests on the given single file or pair of files.
4295 *
4296 * === Exiting
4297 *
4298 * - #abort: Exits the current process after printing the given arguments.
4299 * - #at_exit: Executes the given block when the process exits.
4300 * - #exit: Exits the current process after calling any registered
4301 * +at_exit+ handlers.
4302 * - #exit!: Exits the current process without calling any registered
4303 * +at_exit+ handlers.
4304 *
4305 * === Exceptions
4306 *
4307 * - #catch: Executes the given block, possibly catching a thrown object.
4308 * - #raise (aliased as #fail): Raises an exception based on the given arguments.
4309 * - #throw: Returns from the active catch block waiting for the given tag.
4310 *
4311 *
4312 * === \IO
4313 *
4314 * - ::pp: Prints the given objects in pretty form.
4315 * - #gets: Returns and assigns to <tt>$_</tt> the next line from the current input.
4316 * - #open: Creates an IO object connected to the given stream, file, or subprocess.
4317 * - #p: Prints the given objects' inspect output to the standard output.
4318 * - #print: Prints the given objects to standard output without a newline.
4319 * - #printf: Prints the string resulting from applying the given format string
4320 * to any additional arguments.
4321 * - #putc: Equivalent to <tt>$stdout.putc(object)</tt> for the given object.
4322 * - #puts: Equivalent to <tt>$stdout.puts(*objects)</tt> for the given objects.
4323 * - #readline: Similar to #gets, but raises an exception at the end of file.
4324 * - #readlines: Returns an array of the remaining lines from the current input.
4325 * - #select: Same as IO.select.
4326 *
4327 * === Procs
4328 *
4329 * - #lambda: Returns a lambda proc for the given block.
4330 * - #proc: Returns a new Proc; equivalent to Proc.new.
4331 *
4332 * === Tracing
4333 *
4334 * - #set_trace_func: Sets the given proc as the handler for tracing,
4335 * or disables tracing if given +nil+.
4336 * - #trace_var: Starts tracing assignments to the given global variable.
4337 * - #untrace_var: Disables tracing of assignments to the given global variable.
4338 *
4339 * === Subprocesses
4340 *
4341 * - {\`command`}[rdoc-ref:Kernel#`]: Returns the standard output of running
4342 * +command+ in a subshell.
4343 * - #exec: Replaces current process with a new process.
4344 * - #fork: Forks the current process into two processes.
4345 * - #spawn: Executes the given command and returns its pid without waiting
4346 * for completion.
4347 * - #system: Executes the given command in a subshell.
4348 *
4349 * === Loading
4350 *
4351 * - #autoload: Registers the given file to be loaded when the given constant
4352 * is first referenced.
4353 * - #load: Loads the given Ruby file.
4354 * - #require: Loads the given Ruby file unless it has already been loaded.
4355 * - #require_relative: Loads the Ruby file path relative to the calling file,
4356 * unless it has already been loaded.
4357 *
4358 * === Yielding
4359 *
4360 * - #tap: Yields +self+ to the given block; returns +self+.
4361 * - #then (aliased as #yield_self): Yields +self+ to the block
4362 * and returns the result of the block.
4363 *
4364 * === \Random Values
4365 *
4366 * - #rand: Returns a pseudo-random floating point number
4367 * strictly between 0.0 and 1.0.
4368 * - #srand: Seeds the pseudo-random number generator with the given number.
4369 *
4370 * === Other
4371 *
4372 * - #eval: Evaluates the given string as Ruby code.
4373 * - #loop: Repeatedly executes the given block.
4374 * - #sleep: Suspends the current thread for the given number of seconds.
4375 * - #sprintf (aliased as #format): Returns the string resulting from applying
4376 * the given format string to any additional arguments.
4377 * - #syscall: Runs an operating system call.
4378 * - #trap: Specifies the handling of system signals.
4379 * - #warn: Issue a warning based on the given messages and options.
4380 *
4381 */
4382 rb_mKernel = rb_define_module("Kernel");
4384 rb_define_private_method(rb_cClass, "inherited", rb_obj_class_inherited, 1);
4385 rb_define_private_method(rb_cModule, "included", rb_obj_mod_included, 1);
4386 rb_define_private_method(rb_cModule, "extended", rb_obj_mod_extended, 1);
4387 rb_define_private_method(rb_cModule, "prepended", rb_obj_mod_prepended, 1);
4388 rb_define_private_method(rb_cModule, "method_added", rb_obj_mod_method_added, 1);
4389 rb_define_private_method(rb_cModule, "const_added", rb_obj_mod_const_added, 1);
4390 rb_define_private_method(rb_cModule, "method_removed", rb_obj_mod_method_removed, 1);
4391 rb_define_private_method(rb_cModule, "method_undefined", rb_obj_mod_method_undefined, 1);
4392
4393 rb_define_method(rb_mKernel, "nil?", rb_false, 0);
4394 rb_define_method(rb_mKernel, "===", case_equal, 1);
4395 rb_define_method(rb_mKernel, "!~", rb_obj_not_match, 1);
4396 rb_define_method(rb_mKernel, "eql?", rb_obj_equal, 1);
4397 rb_define_method(rb_mKernel, "hash", rb_obj_hash, 0); /* in hash.c */
4398 rb_define_method(rb_mKernel, "<=>", rb_obj_cmp, 1);
4399
4400 rb_define_method(rb_mKernel, "singleton_class", rb_obj_singleton_class, 0);
4402 rb_define_method(rb_mKernel, "itself", rb_obj_itself, 0);
4403 rb_define_method(rb_mKernel, "initialize_copy", rb_obj_init_copy, 1);
4404 rb_define_method(rb_mKernel, "initialize_dup", rb_obj_init_dup_clone, 1);
4405 rb_define_method(rb_mKernel, "initialize_clone", rb_obj_init_clone, -1);
4406
4408
4410 rb_define_method(rb_mKernel, "inspect", rb_obj_inspect, 0);
4411 rb_define_method(rb_mKernel, "methods", rb_obj_methods, -1); /* in class.c */
4412 rb_define_method(rb_mKernel, "singleton_methods", rb_obj_singleton_methods, -1); /* in class.c */
4413 rb_define_method(rb_mKernel, "protected_methods", rb_obj_protected_methods, -1); /* in class.c */
4414 rb_define_method(rb_mKernel, "private_methods", rb_obj_private_methods, -1); /* in class.c */
4415 rb_define_method(rb_mKernel, "public_methods", rb_obj_public_methods, -1); /* in class.c */
4416 rb_define_method(rb_mKernel, "instance_variables", rb_obj_instance_variables, 0); /* in variable.c */
4417 rb_define_method(rb_mKernel, "instance_variable_get", rb_obj_ivar_get, 1);
4418 rb_define_method(rb_mKernel, "instance_variable_set", rb_obj_ivar_set_m, 2);
4419 rb_define_method(rb_mKernel, "instance_variable_defined?", rb_obj_ivar_defined, 1);
4420 rb_define_method(rb_mKernel, "remove_instance_variable",
4421 rb_obj_remove_instance_variable, 1); /* in variable.c */
4422
4426
4427 rb_define_global_function("sprintf", f_sprintf, -1);
4428 rb_define_global_function("format", f_sprintf, -1);
4429
4430 rb_define_global_function("String", rb_f_string, 1);
4431 rb_define_global_function("Array", rb_f_array, 1);
4432 rb_define_global_function("Hash", rb_f_hash, 1);
4433
4435 rb_cNilClass_to_s = rb_fstring_enc_lit("", rb_usascii_encoding());
4436 rb_vm_register_global_object(rb_cNilClass_to_s);
4437 rb_define_method(rb_cNilClass, "to_s", rb_nil_to_s, 0);
4438 rb_define_method(rb_cNilClass, "to_a", nil_to_a, 0);
4439 rb_define_method(rb_cNilClass, "to_h", nil_to_h, 0);
4440 rb_define_method(rb_cNilClass, "inspect", nil_inspect, 0);
4441 rb_define_method(rb_cNilClass, "=~", nil_match, 1);
4442 rb_define_method(rb_cNilClass, "&", false_and, 1);
4443 rb_define_method(rb_cNilClass, "|", false_or, 1);
4444 rb_define_method(rb_cNilClass, "^", false_xor, 1);
4445 rb_define_method(rb_cNilClass, "===", case_equal, 1);
4446
4447 rb_define_method(rb_cNilClass, "nil?", rb_true, 0);
4450
4451 rb_define_method(rb_cModule, "freeze", rb_mod_freeze, 0);
4452 rb_define_method(rb_cModule, "===", rb_mod_eqq, 1);
4453 rb_define_method(rb_cModule, "==", rb_obj_equal, 1);
4454 rb_define_method(rb_cModule, "<=>", rb_mod_cmp, 1);
4455 rb_define_method(rb_cModule, "<", rb_mod_lt, 1);
4457 rb_define_method(rb_cModule, ">", rb_mod_gt, 1);
4458 rb_define_method(rb_cModule, ">=", rb_mod_ge, 1);
4459 rb_define_method(rb_cModule, "initialize_copy", rb_mod_init_copy, 1); /* in class.c */
4460 rb_define_method(rb_cModule, "to_s", rb_mod_to_s, 0);
4461 rb_define_alias(rb_cModule, "inspect", "to_s");
4462 rb_define_method(rb_cModule, "included_modules", rb_mod_included_modules, 0); /* in class.c */
4463 rb_define_method(rb_cModule, "include?", rb_mod_include_p, 1); /* in class.c */
4464 rb_define_method(rb_cModule, "name", rb_mod_name, 0); /* in variable.c */
4465 rb_define_method(rb_cModule, "set_temporary_name", rb_mod_set_temporary_name, 1); /* in variable.c */
4466 rb_define_method(rb_cModule, "ancestors", rb_mod_ancestors, 0); /* in class.c */
4467
4468 rb_define_method(rb_cModule, "attr", rb_mod_attr, -1);
4469 rb_define_method(rb_cModule, "attr_reader", rb_mod_attr_reader, -1);
4470 rb_define_method(rb_cModule, "attr_writer", rb_mod_attr_writer, -1);
4471 rb_define_method(rb_cModule, "attr_accessor", rb_mod_attr_accessor, -1);
4472
4473 rb_define_alloc_func(rb_cModule, rb_module_s_alloc);
4475 rb_define_method(rb_cModule, "initialize", rb_mod_initialize, 0);
4476 rb_define_method(rb_cModule, "initialize_clone", rb_mod_initialize_clone, -1);
4477 rb_define_method(rb_cModule, "instance_methods", rb_class_instance_methods, -1); /* in class.c */
4478 rb_define_method(rb_cModule, "public_instance_methods",
4479 rb_class_public_instance_methods, -1); /* in class.c */
4480 rb_define_method(rb_cModule, "protected_instance_methods",
4481 rb_class_protected_instance_methods, -1); /* in class.c */
4482 rb_define_method(rb_cModule, "private_instance_methods",
4483 rb_class_private_instance_methods, -1); /* in class.c */
4484 rb_define_method(rb_cModule, "undefined_instance_methods",
4485 rb_class_undefined_instance_methods, 0); /* in class.c */
4486
4487 rb_define_method(rb_cModule, "constants", rb_mod_constants, -1); /* in variable.c */
4488 rb_define_method(rb_cModule, "const_get", rb_mod_const_get, -1);
4489 rb_define_method(rb_cModule, "const_set", rb_mod_const_set, 2);
4490 rb_define_method(rb_cModule, "const_defined?", rb_mod_const_defined, -1);
4491 rb_define_method(rb_cModule, "const_source_location", rb_mod_const_source_location, -1);
4492 rb_define_private_method(rb_cModule, "remove_const",
4493 rb_mod_remove_const, 1); /* in variable.c */
4494 rb_define_method(rb_cModule, "const_missing",
4495 rb_mod_const_missing, 1); /* in variable.c */
4496 rb_define_method(rb_cModule, "class_variables",
4497 rb_mod_class_variables, -1); /* in variable.c */
4498 rb_define_method(rb_cModule, "remove_class_variable",
4499 rb_mod_remove_cvar, 1); /* in variable.c */
4500 rb_define_method(rb_cModule, "class_variable_get", rb_mod_cvar_get, 1);
4501 rb_define_method(rb_cModule, "class_variable_set", rb_mod_cvar_set, 2);
4502 rb_define_method(rb_cModule, "class_variable_defined?", rb_mod_cvar_defined, 1);
4503 rb_define_method(rb_cModule, "public_constant", rb_mod_public_constant, -1); /* in variable.c */
4504 rb_define_method(rb_cModule, "private_constant", rb_mod_private_constant, -1); /* in variable.c */
4505 rb_define_method(rb_cModule, "deprecate_constant", rb_mod_deprecate_constant, -1); /* in variable.c */
4506 rb_define_method(rb_cModule, "singleton_class?", rb_mod_singleton_p, 0);
4507
4508 rb_define_method(rb_singleton_class(rb_cClass), "allocate", rb_class_alloc, 0);
4509 rb_define_method(rb_cClass, "allocate", rb_class_alloc, 0);
4511 rb_define_method(rb_cClass, "initialize", rb_class_initialize, -1);
4513 rb_define_method(rb_cClass, "subclasses", rb_class_subclasses, 0); /* in class.c */
4514 rb_define_method(rb_cClass, "attached_object", rb_class_attached_object, 0); /* in class.c */
4515 rb_define_alloc_func(rb_cClass, rb_class_s_alloc);
4516 rb_undef_method(rb_cClass, "extend_object");
4517 rb_undef_method(rb_cClass, "append_features");
4518 rb_undef_method(rb_cClass, "prepend_features");
4519
4521 rb_cTrueClass_to_s = rb_fstring_enc_lit("true", rb_usascii_encoding());
4522 rb_vm_register_global_object(rb_cTrueClass_to_s);
4523 rb_define_method(rb_cTrueClass, "to_s", rb_true_to_s, 0);
4524 rb_define_alias(rb_cTrueClass, "inspect", "to_s");
4525 rb_define_method(rb_cTrueClass, "&", true_and, 1);
4526 rb_define_method(rb_cTrueClass, "|", true_or, 1);
4527 rb_define_method(rb_cTrueClass, "^", true_xor, 1);
4528 rb_define_method(rb_cTrueClass, "===", case_equal, 1);
4531
4532 rb_cFalseClass = rb_define_class("FalseClass", rb_cObject);
4533 rb_cFalseClass_to_s = rb_fstring_enc_lit("false", rb_usascii_encoding());
4534 rb_vm_register_global_object(rb_cFalseClass_to_s);
4535 rb_define_method(rb_cFalseClass, "to_s", rb_false_to_s, 0);
4536 rb_define_alias(rb_cFalseClass, "inspect", "to_s");
4537 rb_define_method(rb_cFalseClass, "&", false_and, 1);
4538 rb_define_method(rb_cFalseClass, "|", false_or, 1);
4539 rb_define_method(rb_cFalseClass, "^", false_xor, 1);
4540 rb_define_method(rb_cFalseClass, "===", case_equal, 1);
4543}
4544
4545#include "kernel.rbinc"
4546#include "nilclass.rbinc"
4547
4548void
4549Init_Object(void)
4550{
4551 id_dig = rb_intern_const("dig");
4552 id_instance_variables_to_inspect = rb_intern_const("instance_variables_to_inspect");
4553 InitVM(Object);
4554}
4555
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
Definition assert.h:219
static int rb_tolower(int c)
Our own locale-insensitive version of tolower(3).
Definition ctype.h:514
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#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.
static bool RB_OBJ_FROZEN(VALUE obj)
Checks if an object is frozen.
Definition fl_type.h:892
@ RUBY_FL_PROMOTED
Ruby objects are "generational".
Definition fl_type.h:217
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.
Definition class.c:2414
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
Definition class.c:1701
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
Definition class.c:1484
VALUE rb_class_subclasses(VALUE klass)
Queries the class's direct descendants.
Definition class.c:2194
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
Definition class.c:2800
VALUE rb_class_attached_object(VALUE klass)
Returns the attached object for a singleton class.
Definition class.c:2217
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...
Definition class.c:2591
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.
Definition class.c:2399
void rb_check_inheritable(VALUE super)
Asserts that the given class can derive a child class.
Definition class.c:840
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.
Definition class.c:2452
VALUE rb_define_module(const char *name)
Defines a top-level module.
Definition class.c:1602
void rb_singleton_class_attached(VALUE klass, VALUE obj)
Attaches a singleton class to its corresponding object.
Definition class.c:1212
VALUE rb_mod_included_modules(VALUE mod)
Queries the list of included modules.
Definition class.c:2012
VALUE rb_mod_ancestors(VALUE mod)
Queries the module's ancestors.
Definition class.c:2080
VALUE rb_class_inherited(VALUE super, VALUE klass)
Calls Class::inherited.
Definition class.c:1475
VALUE rb_mod_include_p(VALUE mod, VALUE mod2)
Queries if the passed module is included by the module.
Definition class.c:2048
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.
Definition class.c:2437
VALUE rb_mod_init_copy(VALUE clone, VALUE orig)
The comment that comes with this function says :nodoc:.
Definition class.c:1021
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
Definition class.c:2848
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
Definition class.c:2668
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.
Definition class.c:3138
int rb_block_given_p(void)
Determines if the current method is given a block.
Definition eval.c:943
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
Definition class.c:2927
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
Definition value_type.h:59
#define TYPE(_)
Old name of rb_type.
Definition value_type.h:108
#define RB_INTEGER_TYPE_P
Old name of rb_integer_type_p.
Definition value_type.h:87
#define ALLOCV
Old name of RB_ALLOCV.
Definition memory.h:404
#define ISSPACE
Old name of rb_isspace.
Definition ctype.h:88
#define RFLOAT_VALUE
Old name of rb_float_value.
Definition double.h:28
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
#define T_MASK
Old name of RUBY_T_MASK.
Definition value_type.h:68
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
Definition long.h:48
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
Definition fl_type.h:136
#define rb_str_cat2
Old name of rb_str_cat_cstr.
Definition string.h:1683
#define T_FLOAT
Old name of RUBY_T_FLOAT.
Definition value_type.h:64
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
#define ID2SYM
Old name of RB_ID2SYM.
Definition symbol.h:44
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
Definition value_type.h:57
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
Definition value_type.h:79
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
Definition fl_type.h:134
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
Definition assume.h:29
#define T_DATA
Old name of RUBY_T_DATA.
Definition value_type.h:60
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:205
#define T_NONE
Old name of RUBY_T_NONE.
Definition value_type.h:74
#define FIXABLE
Old name of RB_FIXABLE.
Definition fixnum.h:25
#define LONG2FIX
Old name of RB_INT2FIX.
Definition long.h:49
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
Definition value_type.h:76
#define T_ICLASS
Old name of RUBY_T_ICLASS.
Definition value_type.h:66
#define T_HASH
Old name of RUBY_T_HASH.
Definition value_type.h:65
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition fl_type.h:131
#define rb_ary_new3
Old name of rb_ary_new_from_args.
Definition array.h:658
#define rb_usascii_str_new2
Old name of rb_usascii_str_new_cstr.
Definition string.h:1680
#define FLONUM_P
Old name of RB_FLONUM_P.
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
Definition int.h:44
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
Definition value_type.h:56
#define T_OBJECT
Old name of RUBY_T_OBJECT.
Definition value_type.h:75
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
Definition fl_type.h:59
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
Definition value_type.h:80
#define DBL2NUM
Old name of rb_float_new.
Definition double.h:29
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
Definition value_type.h:85
#define FL_FREEZE
Old name of RUBY_FL_FREEZE.
Definition fl_type.h:66
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define CONST_ID
Old name of RUBY_CONST_ID.
Definition symbol.h:47
#define rb_ary_new2
Old name of rb_ary_new_capa.
Definition array.h:657
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
Definition fl_type.h:129
#define ALLOCV_END
Old name of RB_ALLOCV_END.
Definition memory.h:406
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
void rb_category_warning(rb_warning_category_t category, const char *fmt,...)
Identical to rb_warning(), except it takes additional "category" parameter.
Definition error.c:508
VALUE rb_eTypeError
TypeError exception.
Definition error.c:1430
void rb_warning(const char *fmt,...)
Issues a warning.
Definition error.c:497
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
Definition error.h:48
VALUE rb_cClass
Class class.
Definition object.c:64
VALUE rb_cRational
Rational class.
Definition rational.c:53
VALUE rb_class_superclass(VALUE klass)
Returns the superclass of klass.
Definition object.c:2181
VALUE rb_class_get_superclass(VALUE klass)
Returns the superclass of a class.
Definition object.c:2206
VALUE rb_convert_type(VALUE val, int type, const char *tname, const char *method)
Converts an object into another type.
Definition object.c:3123
VALUE rb_Float(VALUE val)
This is the logic behind Kernel#Float.
Definition object.c:3655
VALUE rb_mKernel
Kernel module.
Definition object.c:61
VALUE rb_check_to_int(VALUE val)
Identical to rb_check_to_integer(), except it uses #to_int for conversion.
Definition object.c:3229
VALUE rb_obj_reveal(VALUE obj, VALUE klass)
Make a hidden object visible again.
Definition object.c:110
VALUE rb_check_convert_type(VALUE val, int type, const char *tname, const char *method)
Identical to rb_convert_type(), except it returns RUBY_Qnil instead of raising exceptions,...
Definition object.c:3150
VALUE rb_cObject
Documented in include/ruby/internal/globals.h.
Definition object.c:62
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
Definition object.c:646
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
Definition object.c:2125
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
Definition object.c:2166
VALUE rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat)
Identical to rb_class_new_instance(), except you can specify how to handle the last element of the gi...
Definition object.c:2154
VALUE rb_cRefinement
Refinement class.
Definition object.c:65
VALUE rb_cInteger
Module class.
Definition numeric.c:198
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
Definition object.c:101
VALUE rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass)
Identical to rb_class_new_instance(), except it passes the passed keywords if any to the #initialize ...
Definition object.c:2143
VALUE rb_check_to_float(VALUE val)
This is complicated.
Definition object.c:3694
static VALUE rb_obj_init_clone(int argc, VALUE *argv, VALUE obj)
Default implementation of #initialize_clone
Definition object.c:624
VALUE rb_cNilClass
NilClass class.
Definition object.c:67
VALUE rb_Hash(VALUE val)
Equivalent to Kernel#Hash in Ruby.
Definition object.c:3853
VALUE rb_obj_frozen_p(VALUE obj)
Just calls RB_OBJ_FROZEN() inside.
Definition object.c:1311
VALUE rb_obj_init_copy(VALUE obj, VALUE orig)
Default implementation of #initialize_copy
Definition object.c:593
int rb_eql(VALUE obj1, VALUE obj2)
Checks for equality of the passed objects, in terms of Object#eql?.
Definition object.c:188
double rb_str_to_dbl(VALUE str, int badcheck)
Identical to rb_cstr_to_dbl(), except it accepts a Ruby's string instead of C's.
Definition object.c:3539
VALUE rb_Integer(VALUE val)
This is the logic behind Kernel#Integer.
Definition object.c:3298
VALUE rb_cFalseClass
FalseClass class.
Definition object.c:69
VALUE rb_cNumeric
Numeric class.
Definition numeric.c:196
VALUE rb_Array(VALUE val)
This is the logic behind Kernel#Array.
Definition object.c:3810
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:243
VALUE rb_obj_dup(VALUE obj)
Duplicates the given object.
Definition object.c:553
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:657
VALUE rb_cBasicObject
BasicObject class.
Definition object.c:60
VALUE rb_cModule
Module class.
Definition object.c:63
VALUE rb_class_inherited_p(VALUE mod, VALUE arg)
Determines if the given two modules are relatives.
Definition object.c:1807
VALUE rb_obj_is_instance_of(VALUE obj, VALUE c)
Queries if the given object is a direct instance of the given class.
Definition object.c:824
VALUE rb_class_real(VALUE cl)
Finds a "real" class.
Definition object.c:233
VALUE rb_obj_init_dup_clone(VALUE obj, VALUE orig)
Default implementation of #initialize_dup
Definition object.c:610
VALUE rb_to_float(VALUE val)
Identical to rb_check_to_float(), except it raises on error.
Definition object.c:3684
double rb_num2dbl(VALUE val)
Converts an instance of rb_cNumeric into C's double.
Definition object.c:3746
VALUE rb_equal(VALUE obj1, VALUE obj2)
This function is an optimised version of calling #==.
Definition object.c:175
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
Definition object.c:498
VALUE rb_obj_is_kind_of(VALUE obj, VALUE c)
Queries if the given object is an instance (of possibly descendants) of the given class.
Definition object.c:880
double rb_cstr_to_dbl(const char *p, int badcheck)
Converts a textual representation of a real number into a numeric, which is the nearest value that th...
Definition object.c:3495
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
Definition object.c:1299
VALUE rb_check_to_integer(VALUE val, const char *method)
Identical to rb_check_convert_type(), except the return value type is fixed to rb_cInteger.
Definition object.c:3210
VALUE rb_String(VALUE val)
This is the logic behind Kernel#String.
Definition object.c:3778
VALUE rb_cTrueClass
TrueClass class.
Definition object.c:68
size_t rb_obj_embedded_size(uint32_t fields_count)
Internal header for Object.
Definition object.c:95
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
Definition object.c:3223
VALUE rb_obj_setup(VALUE obj, VALUE klass, VALUE type)
Fills common fields in the object.
Definition object.c:148
Encoding relates APIs.
VALUE rb_enc_str_new_cstr(const char *ptr, rb_encoding *enc)
Identical to rb_enc_str_new(), except it assumes the passed pointer is a pointer to a C string.
Definition string.c:1476
int rb_enc_str_asciionly_p(VALUE str)
Queries if the passed string is "ASCII only".
Definition string.c:1297
ID rb_check_id_cstr(const char *ptr, long len, rb_encoding *enc)
Identical to rb_check_id(), except it takes a pointer to a memory region instead of Ruby's string.
Definition symbol.c:1213
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
Definition vm_eval.c:1117
VALUE rb_funcallv_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv(), except you can specify how to handle the last element of the given array.
Definition vm_eval.c:1084
#define RGENGC_WB_PROTECTED_OBJECT
This is a compile-time flag to enable/disable write barrier for struct RObject.
Definition gc.h:490
Defines RBIMPL_HAS_BUILTIN.
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_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
Definition error.h:284
int rb_is_instance_id(ID id)
Classifies the given ID, then sees if it is an instance variable.
Definition symbol.c:1081
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
Definition symbol.c:1063
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
Definition symbol.c:1093
VALUE rb_rational_num(VALUE rat)
Queries the numerator of the passed Rational.
Definition rational.c:1989
VALUE rb_rational_den(VALUE rat)
Queries the denominator of the passed Rational.
Definition rational.c:1995
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
Definition string.c:4102
VALUE rb_str_subseq(VALUE str, long beg, long len)
Identical to rb_str_substr(), except the numbers are interpreted as byte offsets instead of character...
Definition string.c:3458
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.
Definition string.c:4068
void rb_must_asciicompat(VALUE obj)
Asserts that the given string's encoding is (Ruby's definition of) ASCII compatible.
Definition string.c:3095
VALUE rb_str_concat(VALUE dst, VALUE src)
Identical to rb_str_append(), except it also accepts an integer as a codepoint.
Definition string.c:4351
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
Definition string.c:3255
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
Definition symbol.c:884
VALUE rb_obj_as_string(VALUE obj)
Try converting an object to its stringised representation using its to_s method, if any.
Definition string.c:2161
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
VALUE rb_mod_remove_cvar(VALUE mod, VALUE name)
Resembles Module#remove_class_variable.
Definition variable.c:4650
VALUE rb_obj_instance_variables(VALUE obj)
Resembles Object#instance_variables.
Definition variable.c:2533
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
Definition variable.c:3623
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
Definition variable.c:2127
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
Definition variable.c:3728
void rb_cvar_set(VALUE klass, ID name, VALUE val)
Assigns a value to a class variable.
Definition variable.c:4414
VALUE rb_cvar_get(VALUE klass, ID name)
Obtains a value from a class variable.
Definition variable.c:4485
VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv)
Resembles Module#constants.
Definition variable.c:3890
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.
Definition variable.c:1443
void rb_const_set(VALUE space, ID name, VALUE val)
Names a constant.
Definition variable.c:4090
VALUE rb_mod_name(VALUE mod)
Queries the name of a module.
Definition variable.c:135
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition variable.c:493
VALUE rb_const_get_at(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
Definition variable.c:3629
VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name)
Resembles Object#remove_instance_variable.
Definition variable.c:2587
st_index_t rb_ivar_count(VALUE obj)
Number of instance variables defined on an object.
Definition variable.c:2443
VALUE rb_const_get_from(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
Definition variable.c:3617
VALUE rb_ivar_defined(VALUE obj, ID name)
Queries if the instance variable is defined at the object.
Definition variable.c:2204
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
Definition variable.c:3952
VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv)
Resembles Module#class_variables.
Definition variable.c:4615
VALUE rb_cvar_defined(VALUE klass, ID name)
Queries if the given class has the given class variable.
Definition variable.c:4492
int rb_const_defined_from(VALUE space, ID name)
Identical to rb_const_defined(), except it returns false for private constants.
Definition variable.c:3940
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
Definition variable.c:3946
VALUE(* rb_alloc_func_t)(VALUE klass)
This is the type of functions that ruby calls when trying to allocate an object.
Definition vm.h:216
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
Definition vm_method.c:1419
void rb_attr(VALUE klass, ID name, int need_reader, int need_writer, int honour_visibility)
This function resembles now-deprecated Module#attr.
Definition vm_method.c:2003
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
Definition vm_eval.c:686
rb_alloc_func_t rb_get_alloc_func(VALUE klass)
Queries the allocator function of a class.
Definition vm_method.c:1425
VALUE rb_mod_module_exec(int argc, const VALUE *argv, VALUE mod)
Identical to rb_obj_instance_exec(), except it evaluates within the context of module.
Definition vm_eval.c:2426
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().
Definition symbol.h:284
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
Definition symbol.c:1117
int len
Length of the buffer.
Definition io.h:8
const signed char ruby_digit36_to_number_table[]
Character to number mapping like ‘'a’->10,'b'->11etc.
Definition util.c:81
#define strtod(s, e)
Just another name of ruby_strtod.
Definition util.h:223
VALUE rb_f_sprintf(int argc, const VALUE *argv)
Identical to rb_str_format(), except how the arguments are arranged.
Definition sprintf.c:209
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
Definition memory.h:372
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
Definition memory.h:167
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_ivar_foreach(VALUE q, int_type *w, VALUE e)
Iteration over each instance variable of the object.
void rb_copy_generic_ivar(VALUE clone, VALUE obj)
Copies the list of instance variables.
Definition variable.c:2324
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
#define RARRAY_AREF(a, i)
Definition rarray.h:403
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
Definition rbasic.h:163
#define RBASIC(obj)
Convenient casting macro.
Definition rbasic.h:40
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
Definition rclass.h:44
static VALUE * ROBJECT_FIELDS(VALUE obj)
Queries the instance variables.
Definition robject.h:126
#define StringValue(v)
Ensures that the parameter object is a String.
Definition rstring.h:66
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
Definition rstring.h:76
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
Definition variable.c:499
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
Definition variable.c:508
#define errno
Ractor-aware version of errno.
Definition ruby.h:388
#define InitVM(ext)
This macro is for internal use.
Definition ruby.h:231
#define RB_PASS_KEYWORDS
Pass keywords, final argument should be a hash of keywords.
Definition scan_args.h:72
#define RB_PASS_CALLED_KEYWORDS
Pass keywords if current method is called with keywords, useful for argument delegation.
Definition scan_args.h:78
#define RB_NO_KEYWORDS
Do not pass keywords.
Definition scan_args.h:69
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
Definition stdarg.h:35
Ruby's ordinal objects.
Definition robject.h:83
Definition st.h:79
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
static bool RB_FLOAT_TYPE_P(VALUE obj)
Queries if the object is an instance of rb_cFloat.
Definition value_type.h:264
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376