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