14#include "ruby/internal/config.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"
71static VALUE rb_cNilClass_to_s;
72static VALUE rb_cTrueClass_to_s;
73static VALUE rb_cFalseClass_to_s;
79#define id_match idEqTilde
80#define id_inspect idInspect
81#define id_init_copy idInitialize_copy
82#define id_init_clone idInitialize_clone
83#define id_init_dup idInitialize_dup
84#define id_const_missing idConst_missing
86static ID id_instance_variables_to_inspect;
88#define CLASS_OR_MODULE_P(obj) \
89 (!SPECIAL_CONST_P(obj) && \
90 (BUILTIN_TYPE(obj) == T_CLASS || BUILTIN_TYPE(obj) == T_MODULE))
97 return offsetof(
struct RObject, as.ary) + (
sizeof(
VALUE) * fields_count);
104 RBASIC_CLEAR_CLASS(obj);
113 RBASIC_SET_CLASS(obj, klass);
119rb_class_allocate_instance(
VALUE klass)
121 uint32_t index_tbl_num_entries = RCLASS_MAX_IV_COUNT(klass);
124 if (!rb_gc_size_allocatable_p(size)) {
128 NEWOBJ_OF(o,
struct RObject, klass,
132 RUBY_ASSERT(RSHAPE_TYPE_P(RBASIC_SHAPE_ID(obj), SHAPE_ROOT));
134 RBASIC_SET_SHAPE_ID(obj, rb_shape_root(rb_gc_heap_id_for_size(size)));
139 for (
size_t i = 0; i < ROBJECT_FIELDS_CAPACITY(obj); i++) {
151 RBASIC(obj)->flags = (
type & ~ignored_flags) | (
RBASIC(obj)->flags & ignored_flags);
152 RBASIC_SET_CLASS(obj, klass);
170#define case_equal rb_equal
179 if (obj1 == obj2)
return Qtrue;
180 result = rb_equal_opt(obj1, obj2);
181 if (UNDEF_P(result)) {
184 return RBOOL(
RTEST(result));
192 if (obj1 == obj2)
return TRUE;
193 result = rb_eql_opt(obj1, obj2);
194 if (UNDEF_P(result)) {
197 return RTEST(result);
206 return RBOOL(obj1 == obj2);
218 return RBOOL(!
RTEST(obj));
229 return rb_obj_not(result);
266rb_obj_singleton_class(
VALUE obj)
283 shape_id_t src_shape_id = RBASIC_SHAPE_ID(obj);
285 if (rb_shape_too_complex_p(src_shape_id)) {
286 rb_shape_copy_complex_ivars(dest, obj, src_shape_id, ROBJECT_FIELDS_HASH(obj));
290 shape_id_t initial_shape_id = RBASIC_SHAPE_ID(dest);
291 RUBY_ASSERT(RSHAPE_TYPE_P(initial_shape_id, SHAPE_ROOT));
293 shape_id_t dest_shape_id = rb_shape_rebuild(initial_shape_id, src_shape_id);
294 if (UNLIKELY(rb_shape_too_complex_p(dest_shape_id))) {
295 st_table *table = rb_st_init_numtable_with_size(src_num_ivs);
296 rb_obj_copy_ivs_to_hash_table(obj, table);
297 rb_obj_init_too_complex(dest, table);
305 attr_index_t initial_capa = RSHAPE_CAPACITY(initial_shape_id);
306 attr_index_t dest_capa = RSHAPE_CAPACITY(dest_shape_id);
309 if (initial_capa < dest_capa) {
310 rb_ensure_iv_list_size(dest, 0, dest_capa);
314 rb_shape_copy_fields(dest, dest_buf, dest_shape_id, src_buf, src_shape_id);
315 rb_obj_set_shape_id(dest, dest_shape_id);
324 RBASIC(dest)->flags &= ~T_MASK;
329 rb_bug(
"Unreachable");
336 rb_obj_copy_ivar(dest, obj);
342 rb_gc_copy_attributes(dest, obj);
347PUREFUNC(
static inline int special_object_p(
VALUE obj));
349special_object_p(
VALUE obj)
366obj_freeze_opt(
VALUE freeze)
374 rb_raise(rb_eArgError,
"unexpected value for freeze: %"PRIsVALUE,
rb_obj_class(freeze));
383 VALUE kwfreeze = obj_freeze_opt(freeze);
384 if (!special_object_p(obj))
385 return mutable_obj_clone(obj, kwfreeze);
386 return immutable_obj_clone(obj, kwfreeze);
391rb_immutable_obj_clone(
int argc,
VALUE *argv,
VALUE obj)
393 VALUE kwfreeze = rb_get_freeze_opt(argc, argv);
394 return immutable_obj_clone(obj, kwfreeze);
398rb_get_freeze_opt(
int argc,
VALUE *argv)
400 static ID keyword_ids[1];
404 if (!keyword_ids[0]) {
410 if (!UNDEF_P(kwfreeze))
411 kwfreeze = obj_freeze_opt(kwfreeze);
420 rb_raise(rb_eArgError,
"can't unfreeze %"PRIsVALUE,
430 VALUE singleton = rb_singleton_class_clone_and_attach(obj, clone);
431 RBASIC_SET_CLASS(clone, singleton);
432 if (RCLASS_SINGLETON_P(singleton)) {
436 init_copy(clone, obj);
448 shape_id_t next_shape_id = rb_shape_transition_frozen(clone);
449 rb_obj_set_shape_id(clone, next_shape_id);
453 static VALUE freeze_true_hash;
454 if (!freeze_true_hash) {
455 freeze_true_hash = rb_hash_new();
456 rb_vm_register_global_object(freeze_true_hash);
457 rb_hash_aset(freeze_true_hash,
ID2SYM(idFreeze),
Qtrue);
462 argv[1] = freeze_true_hash;
468 static VALUE freeze_false_hash;
469 if (!freeze_false_hash) {
470 freeze_false_hash = rb_hash_new();
471 rb_vm_register_global_object(freeze_false_hash);
472 rb_hash_aset(freeze_false_hash,
ID2SYM(idFreeze),
Qfalse);
477 argv[1] = freeze_false_hash;
482 rb_bug(
"invalid kwfreeze passed to mutable_obj_clone");
492 return rb_obj_clone_setup(obj, clone, kwfreeze);
498 if (special_object_p(obj))
return obj;
499 return mutable_obj_clone(obj,
Qnil);
555 if (special_object_p(obj)) {
559 return rb_obj_dup_setup(obj, dup);
574rb_obj_itself(
VALUE obj)
593 if (obj == orig)
return obj;
594 rb_check_frozen(obj);
596 rb_raise(
rb_eTypeError,
"initialize_copy should take same class object");
625 if (
rb_scan_args(argc, argv,
"1:", &orig, &opts) < argc) {
627 rb_get_freeze_opt(1, &opts);
649 str = rb_sprintf(
"#<%"PRIsVALUE
":%p>", cname, (
void*)obj);
660 if (enc == NULL) enc = rb_default_external_encoding();
661 if (!rb_enc_asciicompat(enc)) {
663 return rb_str_escape(str);
667 return rb_str_escape(str);
672inspect_i(
ID id,
VALUE value, st_data_t a)
674 VALUE *args = (
VALUE *)a, str = args[0], ivars = args[1];
677 if (
CLASS_OF(value) == 0)
return ST_CONTINUE;
681 for (
long i = 0;
RARRAY_AREF(ivars, i) != name; ) {
682 if (++i >=
RARRAY_LEN(ivars))
return ST_CONTINUE;
685 if (RSTRING_PTR(str)[0] ==
'-') {
686 RSTRING_PTR(str)[0] =
'#';
692 rb_str_catf(str,
"%"PRIsVALUE
"=", rb_id2str(
id));
710 RSTRING_PTR(str)[0] =
'#';
762rb_obj_inspect(
VALUE obj)
766 if (UNDEF_P(ivars)) {
770 else if (!
NIL_P(ivars)) {
777 rb_sprintf(
"-<%"PRIsVALUE
":%p", c, (
void*)obj),
788class_or_module_required(
VALUE c)
790 switch (OBJ_BUILTIN_TYPE(c)) {
824 c = class_or_module_required(c);
836 size_t c_depth = RCLASS_SUPERCLASS_DEPTH(c);
837 size_t cl_depth = RCLASS_SUPERCLASS_DEPTH(cl);
838 VALUE *classes = RCLASS_SUPERCLASSES(cl);
842 if (cl_depth <= c_depth)
846 return RBOOL(classes[c_depth] == c);
886 if (cl == c)
return Qtrue;
893 return class_search_class_ancestor(cl, c);
898 VALUE includer = RCLASS_INCLUDER(c);
899 if (cl == includer)
return Qtrue;
905 if (
RB_TYPE_P(includer,
T_CLASS) && class_search_class_ancestor(cl, includer))
910 return RBOOL(class_search_ancestor(cl, RCLASS_ORIGIN(c)));
914 return RBOOL(class_search_ancestor(cl, RCLASS_ORIGIN(c)));
927 if (cl == c || RCLASS_M_TBL(cl) == RCLASS_M_TBL(c))
938 cl = class_or_module_required(cl);
939 c = class_or_module_required(c);
940 return class_search_ancestor(cl, RCLASS_ORIGIN(c));
971#define rb_obj_class_inherited rb_obj_dummy1
994#define rb_obj_mod_method_added rb_obj_dummy1
1021#define rb_obj_mod_method_removed rb_obj_dummy1
1048#define rb_obj_mod_method_undefined rb_obj_dummy1
1075#define rb_obj_singleton_method_added rb_obj_dummy1
1104#define rb_obj_singleton_method_removed rb_obj_dummy1
1129#define rb_obj_singleton_method_undefined rb_obj_dummy1
1175#define rb_obj_mod_const_added rb_obj_dummy1
1195#define rb_obj_mod_extended rb_obj_dummy1
1218#define rb_obj_mod_included rb_obj_dummy1
1238#define rb_obj_mod_prepended rb_obj_dummy1
1248#define rb_obj_initialize rb_obj_dummy0
1263 return rb_obj_dummy();
1269 return rb_obj_dummy();
1302 rb_bug(
"special consts should be frozen.");
1363rb_nil_to_s(
VALUE obj)
1365 return rb_cNilClass_to_s;
1401 return rb_hash_new();
1415nil_inspect(
VALUE obj)
1472rb_true_to_s(
VALUE obj)
1474 return rb_cTrueClass_to_s;
1493 return RBOOL(
RTEST(obj2));
1537 return rb_obj_not(obj2);
1559rb_false_to_s(
VALUE obj)
1561 return rb_cFalseClass_to_s;
1599#define false_or true_and
1614#define false_xor true_and
1659 return rb_obj_not(result);
1727rb_mod_to_s(
VALUE klass)
1730 VALUE refined_class, defined_at;
1732 if (RCLASS_SINGLETON_P(klass)) {
1734 VALUE v = RCLASS_ATTACHED_OBJECT(klass);
1736 if (CLASS_OR_MODULE_P(v)) {
1746 refined_class = rb_refinement_module_get_refined_class(klass);
1747 if (!
NIL_P(refined_class)) {
1752 CONST_ID(id_defined_at,
"__defined_at__");
1753 defined_at = rb_attr_get(klass, id_defined_at);
1771rb_mod_freeze(
VALUE mod)
1807 if (mod == arg)
return Qtrue;
1811 size_t mod_depth = RCLASS_SUPERCLASS_DEPTH(mod);
1812 size_t arg_depth = RCLASS_SUPERCLASS_DEPTH(arg);
1813 if (arg_depth < mod_depth) {
1815 return RCLASS_SUPERCLASSES(mod)[arg_depth] == arg ?
1819 else if (arg_depth > mod_depth) {
1821 return RCLASS_SUPERCLASSES(arg)[mod_depth] == mod ?
1834 if (class_search_ancestor(mod, RCLASS_ORIGIN(arg))) {
1838 if (class_search_ancestor(arg, mod)) {
1861 if (mod == arg)
return Qfalse;
1881 if (!CLASS_OR_MODULE_P(arg)) {
1904 if (mod == arg)
return Qfalse;
1905 return rb_mod_ge(mod, arg);
1925 if (mod == arg)
return INT2FIX(0);
1926 if (!CLASS_OR_MODULE_P(arg)) {
1938static VALUE rb_mod_initialize_exec(
VALUE module);
1967rb_mod_initialize(
VALUE module)
1969 return rb_mod_initialize_exec(module);
1973rb_mod_initialize_exec(
VALUE module)
1983rb_mod_initialize_clone(
int argc,
VALUE* argv,
VALUE clone)
1985 VALUE ret, orig, opts;
2024rb_class_initialize(
int argc,
VALUE *argv,
VALUE klass)
2037 if (!RCLASS_INITIALIZED_P(super)) {
2038 rb_raise(
rb_eTypeError,
"can't inherit uninitialized class");
2041 rb_class_set_super(klass, super);
2042 rb_make_metaclass(klass,
RBASIC(super)->klass);
2044 rb_mod_initialize_exec(klass);
2051rb_undefined_alloc(
VALUE klass)
2053 rb_raise(
rb_eTypeError,
"allocator undefined for %"PRIsVALUE,
2083rb_class_alloc(
VALUE klass)
2086 return class_call_alloc_func(allocator, klass);
2090class_get_alloc_func(
VALUE klass)
2094 if (!RCLASS_INITIALIZED_P(klass)) {
2095 rb_raise(
rb_eTypeError,
"can't instantiate uninitialized class");
2097 if (RCLASS_SINGLETON_P(klass)) {
2098 rb_raise(
rb_eTypeError,
"can't create instance of singleton class");
2102 rb_undefined_alloc(klass);
2114 obj = (*allocator)(klass);
2126 return rb_class_alloc(klass);
2145 obj = rb_class_alloc(klass);
2157 obj = rb_class_alloc(klass);
2158 rb_obj_call_init_kw(obj, argc, argv, kw_splat);
2183 VALUE *superclasses = RCLASS_SUPERCLASSES(klass);
2184 size_t superclasses_depth = RCLASS_SUPERCLASS_DEPTH(klass);
2188 if (!superclasses) {
2193 if (!superclasses_depth) {
2197 VALUE super = superclasses[superclasses_depth - 1];
2209static const char bad_instance_name[] =
"'%1$s' is not allowed as an instance variable name";
2210static const char bad_class_name[] =
"'%1$s' is not allowed as a class variable name";
2211static const char bad_const_name[] =
"wrong constant name %1$s";
2212static const char bad_attr_name[] =
"invalid attribute name '%1$s'";
2213#define wrong_constant_name bad_const_name
2216#define id_for_var(obj, name, type) id_for_setter(obj, name, type, bad_##type##_name)
2218#define id_for_setter(obj, name, type, message) \
2219 check_setter_id(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))
2222 int (*valid_id_p)(
ID),
int (*valid_name_p)(
VALUE),
2223 const char *message,
size_t message_len)
2226 VALUE name = *pname;
2228 if (
id ? !valid_id_p(
id) : !valid_name_p(name)) {
2229 rb_name_err_raise_str(rb_fstring_new(message, message_len),
2236rb_is_attr_name(
VALUE name)
2238 return rb_is_local_name(name) || rb_is_const_name(name);
2250 ID id = id_for_var(obj, name, attr);
2251 if (!
id)
id = rb_intern_str(name);
2270rb_mod_attr_reader(
int argc,
VALUE *argv,
VALUE klass)
2275 for (i=0; i<argc; i++) {
2276 ID id = id_for_attr(klass, argv[i]);
2277 rb_attr(klass,
id, TRUE, FALSE, TRUE);
2288rb_mod_attr(
int argc,
VALUE *argv,
VALUE klass)
2290 if (argc == 2 && (argv[1] ==
Qtrue || argv[1] ==
Qfalse)) {
2291 ID id = id_for_attr(klass, argv[0]);
2300 return rb_mod_attr_reader(argc, argv, klass);
2315rb_mod_attr_writer(
int argc,
VALUE *argv,
VALUE klass)
2320 for (i=0; i<argc; i++) {
2321 ID id = id_for_attr(klass, argv[i]);
2322 rb_attr(klass,
id, FALSE, TRUE, TRUE);
2347rb_mod_attr_accessor(
int argc,
VALUE *argv,
VALUE klass)
2352 for (i=0; i<argc; i++) {
2353 ID id = id_for_attr(klass, argv[i]);
2355 rb_attr(klass,
id, TRUE, TRUE, TRUE);
2403rb_mod_const_get(
int argc,
VALUE *argv,
VALUE mod)
2407 const char *pbeg, *p, *path, *pend;
2412 recur = (argc == 1) ?
Qtrue : argv[1];
2415 if (!rb_is_const_sym(name))
goto wrong_name;
2417 if (!
id)
return rb_const_missing(mod, name);
2422 enc = rb_enc_get(name);
2424 if (!rb_enc_asciicompat(enc)) {
2425 rb_raise(rb_eArgError,
"invalid class path encoding (non ASCII)");
2429 pend = path + RSTRING_LEN(name);
2431 if (p >= pend || !*p) {
2435 if (p + 2 < pend && p[0] ==
':' && p[1] ==
':') {
2445 while (p < pend && *p !=
':') p++;
2447 if (pbeg == p)
goto wrong_name;
2452 if (p < pend && p[0] ==
':') {
2453 if (p + 2 >= pend || p[1] !=
':')
goto wrong_name;
2459 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
" does not refer to class/module",
2466 if (!rb_is_const_name(part)) {
2470 else if (!rb_method_basic_definition_p(
CLASS_OF(mod), id_const_missing)) {
2472 mod = rb_const_missing(mod, part);
2476 rb_mod_const_missing(mod, part);
2484 mod = rb_const_get_0(mod,
id, beglen > 0 || !
RTEST(recur),
RTEST(recur), FALSE);
2486 if (!
RTEST(recur)) {
2489 else if (beglen == 0) {
2501 rb_name_err_raise(wrong_constant_name, mod, name);
2527 ID id = id_for_var(mod, name,
const);
2528 if (!
id)
id = rb_intern_str(name);
2576rb_mod_const_defined(
int argc,
VALUE *argv,
VALUE mod)
2580 const char *pbeg, *p, *path, *pend;
2585 recur = (argc == 1) ?
Qtrue : argv[1];
2588 if (!rb_is_const_sym(name))
goto wrong_name;
2595 enc = rb_enc_get(name);
2597 if (!rb_enc_asciicompat(enc)) {
2598 rb_raise(rb_eArgError,
"invalid class path encoding (non ASCII)");
2602 pend = path + RSTRING_LEN(name);
2604 if (p >= pend || !*p) {
2608 if (p + 2 < pend && p[0] ==
':' && p[1] ==
':') {
2618 while (p < pend && *p !=
':') p++;
2620 if (pbeg == p)
goto wrong_name;
2625 if (p < pend && p[0] ==
':') {
2626 if (p + 2 >= pend || p[1] !=
':')
goto wrong_name;
2634 if (!rb_is_const_name(part)) {
2648 mod = rb_const_search(mod,
id, beglen > 0 || !
RTEST(recur),
RTEST(recur), FALSE);
2649 if (UNDEF_P(mod))
return Qfalse;
2651 if (!
RTEST(recur)) {
2654 if (p == pend)
return Qtrue;
2657 else if (beglen == 0) {
2660 if (p == pend)
return Qtrue;
2666 if (p == pend)
return Qtrue;
2672 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
" does not refer to class/module",
2680 rb_name_err_raise(wrong_constant_name, mod, name);
2736rb_mod_const_source_location(
int argc,
VALUE *argv,
VALUE mod)
2740 const char *pbeg, *p, *path, *pend;
2745 recur = (argc == 1) ?
Qtrue : argv[1];
2748 if (!rb_is_const_sym(name))
goto wrong_name;
2750 if (!
id)
return Qnil;
2751 return RTEST(recur) ? rb_const_source_location(mod,
id) : rb_const_source_location_at(mod, id);
2755 enc = rb_enc_get(name);
2757 if (!rb_enc_asciicompat(enc)) {
2758 rb_raise(rb_eArgError,
"invalid class path encoding (non ASCII)");
2762 pend = path + RSTRING_LEN(name);
2764 if (p >= pend || !*p) {
2768 if (p + 2 < pend && p[0] ==
':' && p[1] ==
':') {
2778 while (p < pend && *p !=
':') p++;
2780 if (pbeg == p)
goto wrong_name;
2785 if (p < pend && p[0] ==
':') {
2786 if (p + 2 >= pend || p[1] !=
':')
goto wrong_name;
2794 if (!rb_is_const_name(part)) {
2814 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
" does not refer to class/module",
2820 loc = rb_const_source_location(mod,
id);
2823 loc = rb_const_source_location_at(mod,
id);
2833 rb_name_err_raise(wrong_constant_name, mod, name);
2862 ID id = id_for_var(obj, iv, instance);
2896 ID id = id_for_var(obj, iv, instance);
2897 if (!
id)
id = rb_intern_str(iv);
2924 ID id = id_for_var(obj, iv, instance);
2951 ID id = id_for_var(obj, iv,
class);
2954 rb_name_err_raise(
"uninitialized class variable %1$s in %2$s",
2983 ID id = id_for_var(obj, iv,
class);
2984 if (!
id)
id = rb_intern_str(iv);
3008 ID id = id_for_var(obj, iv,
class);
3030rb_mod_singleton_p(
VALUE klass)
3032 return RBOOL(RCLASS_SINGLETON_P(klass));
3036static const struct conv_method_tbl {
3037 const char method[6];
3039} conv_method_names[] = {
3040#define M(n) {#n, (unsigned short)idTo_##n}
3055#define IMPLICIT_CONVERSIONS 7
3058conv_method_index(
const char *method)
3060 static const char prefix[] =
"to_";
3062 if (strncmp(prefix, method,
sizeof(prefix)-1) == 0) {
3063 const char *
const meth = &method[
sizeof(prefix)-1];
3065 for (i=0; i < numberof(conv_method_names); i++) {
3066 if (conv_method_names[i].method[0] == meth[0] &&
3067 strcmp(conv_method_names[i].method, meth) == 0) {
3072 return numberof(conv_method_names);
3076convert_type_with_id(
VALUE val,
const char *tname,
ID method,
int raise,
int index)
3082 ((index < 0 ? conv_method_index(rb_id2name(method)) : index)
3083 < IMPLICIT_CONVERSIONS) ?
3084 "no implicit conversion of" :
"can't convert";
3085 const char *cname =
NIL_P(val) ?
"nil" :
3086 val ==
Qtrue ?
"true" :
3087 val ==
Qfalse ?
"false" :
3090 rb_raise(
rb_eTypeError,
"%s %s into %s", msg, cname, tname);
3101convert_type(
VALUE val,
const char *tname,
const char *method,
int raise)
3103 int i = conv_method_index(method);
3104 ID m = i < numberof(conv_method_names) ?
3105 conv_method_names[i].id : rb_intern(method);
3106 return convert_type_with_id(val, tname, m, raise, i);
3110NORETURN(
static void conversion_mismatch(
VALUE,
const char *,
const char *,
VALUE));
3112conversion_mismatch(
VALUE val,
const char *tname,
const char *method,
VALUE result)
3116 "can't convert %"PRIsVALUE
" to %s (%"PRIsVALUE
"#%s gives %"PRIsVALUE
")",
3126 v = convert_type(val, tname, method, TRUE);
3128 conversion_mismatch(val, tname, method, v);
3135rb_convert_type_with_id(
VALUE val,
int type,
const char *tname,
ID method)
3140 v = convert_type_with_id(val, tname, method, TRUE, -1);
3142 conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
3154 v = convert_type(val, tname, method, FALSE);
3157 conversion_mismatch(val, tname, method, v);
3164rb_check_convert_type_with_id(
VALUE val,
int type,
const char *tname,
ID method)
3170 v = convert_type_with_id(val, tname, method, FALSE, -1);
3173 conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
3178#define try_to_int(val, mid, raise) \
3179 convert_type_with_id(val, "Integer", mid, raise, -1)
3181ALWAYS_INLINE(
static VALUE rb_to_integer_with_id_exception(
VALUE val,
const char *method,
ID mid,
int raise));
3184rb_to_integer_with_id_exception(
VALUE val,
const char *method,
ID mid,
int raise)
3191 current_cfp = GET_EC()->cfp;
3192 rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
3193 v = try_to_int(val, mid, raise);
3194 if (!raise &&
NIL_P(v)) {
3195 GET_EC()->cfp = current_cfp;
3199 conversion_mismatch(val,
"Integer", method, v);
3201 GET_EC()->cfp = current_cfp;
3204#define rb_to_integer(val, method, mid) \
3205 rb_to_integer_with_id_exception(val, method, mid, TRUE)
3213 v = convert_type(val,
"Integer", method, FALSE);
3223 return rb_to_integer(val,
"to_int", idTo_int);
3230 val = try_to_int(val, idTo_int, FALSE);
3236rb_check_to_i(
VALUE val)
3239 val = try_to_int(val, idTo_i, FALSE);
3245rb_convert_to_integer(
VALUE val,
int base,
int raise_exception)
3255 else if (! raise_exception) {
3259 rb_raise(rb_eArgError,
"base specified for non string value");
3264 if (!raise_exception && !isfinite(f))
return Qnil;
3266 return rb_dbl2big(f);
3272 return rb_str_convert_to_inum(val, base, TRUE, raise_exception);
3274 else if (
NIL_P(val)) {
3275 if (!raise_exception)
return Qnil;
3281 rb_set_errinfo(
Qnil);
3283 return rb_str_convert_to_inum(tmp, base, TRUE, raise_exception);
3286 if (!raise_exception) {
3287 VALUE result = rb_protect(rb_check_to_i, val, NULL);
3288 rb_set_errinfo(
Qnil);
3292 return rb_to_integer(val,
"to_i", idTo_i);
3298 return rb_convert_to_integer(val, 0, TRUE);
3302rb_check_integer_type(
VALUE val)
3304 return rb_to_integer_with_id_exception(val,
"to_int", idTo_int, FALSE);
3308rb_bool_expected(
VALUE obj,
const char *flagname,
int raise)
3316 static const char message[] =
"expected true or false as %s: %+"PRIsVALUE;
3318 rb_raise(rb_eArgError, message, flagname, obj);
3327rb_opts_exception_p(
VALUE opts,
int default_value)
3329 static const ID kwds[1] = {idException};
3332 return rb_bool_expected(exception,
"exception", TRUE);
3333 return default_value;
3339 return rb_convert_to_integer(arg, 0, TRUE);
3345 int exc = rb_bool_expected(exception,
"exception", TRUE);
3346 return rb_convert_to_integer(arg,
NUM2INT(base), exc);
3350is_digit_char(
unsigned char c,
int base)
3353 return (i >= 0 && i < base);
3357rb_cstr_to_dbl_raise(
const char *p,
rb_encoding *enc,
int badcheck,
int raise,
int *error)
3362 const char *ellipsis =
"";
3364 enum {max_width = 20};
3365#define OutOfRange() ((end - p > max_width) ? \
3366 (w = max_width, ellipsis = "...") : \
3367 (w = (int)(end - p), ellipsis = ""))
3374 if (!badcheck && p[0] ==
'0' && (p[1] ==
'x' || p[1] ==
'X')) {
3379 if (
errno == ERANGE) {
3381 rb_warning(
"Float %.*s%s out of range", w, p, ellipsis);
3391 char buf[DBL_DIG * 4 + 10];
3393 char *
const init_e = buf + DBL_DIG * 4;
3396 int dot_seen = FALSE;
3398 char exp_letter =
'e';
3400 switch (*p) {
case '+':
case '-': prev = *n++ = *p++;}
3408 if (*++p !=
'0')
break;
3411 while (*++p ==
'0');
3415 while (p < end && n < e) prev = *n++ = *p++;
3420 !is_digit_char(prev, base) ||
3421 !is_digit_char(*++p, base)) {
3422 if (badcheck)
goto bad;
3427 if (e == init_e && (
rb_tolower(prev) == exp_letter)) {
3428 e = buf +
sizeof(buf) - 1;
3430 switch (*p) {
case '+':
case '-': prev = *n++ = *p++;}
3433 while (*++p ==
'0');
3444 if (badcheck)
goto bad;
3448 else if (prev ==
'.' ? dot_seen++ : !is_digit_char(prev, base)) {
3449 if (badcheck)
goto bad;
3452 if (n < e) *n++ = prev;
3457 if (!badcheck && p[0] ==
'0' && (p[1] ==
'x' || p[1] ==
'X')) {
3462 if (
errno == ERANGE) {
3464 rb_warning(
"Float %.*s%s out of range", w, p, ellipsis);
3468 if (!end || p == end)
goto bad;
3469 while (*end &&
ISSPACE(*end)) end++;
3473 if (
errno == ERANGE) {
3476 rb_raise(rb_eArgError,
"Float %.*s%s out of range", w, q, ellipsis);
3483 rb_raise(rb_eArgError,
"invalid value for Float(): %+"PRIsVALUE, s);
3487 if (error) *error = 1;
3495 return rb_cstr_to_dbl_raise(p, NULL, badcheck, TRUE, NULL);
3499rb_str_to_dbl_raise(
VALUE str,
int badcheck,
int raise,
int *error)
3508 s = RSTRING_PTR(str);
3509 len = RSTRING_LEN(str);
3511 if (badcheck && memchr(s,
'\0',
len)) {
3513 rb_raise(rb_eArgError,
"string for Float contains null byte");
3515 if (error) *error = 1;
3526 ret = rb_cstr_to_dbl_raise(s, rb_enc_get(str), badcheck, raise, error);
3539 return rb_str_to_dbl_raise(str, badcheck, TRUE, NULL);
3543#define fix2dbl_without_to_f(x) (double)FIX2LONG(x)
3544#define big2dbl_without_to_f(x) rb_big2dbl(x)
3545#define int2dbl_without_to_f(x) \
3546 (FIXNUM_P(x) ? fix2dbl_without_to_f(x) : big2dbl_without_to_f(x))
3547#define num2dbl_without_to_f(x) \
3548 (FIXNUM_P(x) ? fix2dbl_without_to_f(x) : \
3549 RB_BIGNUM_TYPE_P(x) ? big2dbl_without_to_f(x) : \
3550 (Check_Type(x, T_FLOAT), RFLOAT_VALUE(x)))
3552rat2dbl_without_to_f(
VALUE x)
3556 return num2dbl_without_to_f(num) / num2dbl_without_to_f(den);
3559#define special_const_to_float(val, pre, post) \
3562 rb_raise_static(rb_eTypeError, pre "nil" post); \
3564 rb_raise_static(rb_eTypeError, pre "true" post); \
3566 rb_raise_static(rb_eTypeError, pre "false" post); \
3571conversion_to_float(
VALUE val)
3573 special_const_to_float(val,
"can't convert ",
" into Float");
3577implicit_conversion_to_float(
VALUE val)
3579 special_const_to_float(val,
"no implicit conversion to float from ",
"");
3583to_float(
VALUE *valp,
int raise_exception)
3588 *valp =
DBL2NUM(fix2dbl_without_to_f(val));
3594 else if (raise_exception) {
3595 conversion_to_float(val);
3604 *valp =
DBL2NUM(big2dbl_without_to_f(val));
3607 *valp =
DBL2NUM(rat2dbl_without_to_f(val));
3617convert_type_to_float_protected(
VALUE val)
3619 return rb_convert_type_with_id(val,
T_FLOAT,
"Float", id_to_f);
3623rb_convert_to_float(
VALUE val,
int raise_exception)
3625 switch (to_float(&val, raise_exception)) {
3629 if (!raise_exception) {
3631 double x = rb_str_to_dbl_raise(val, TRUE, raise_exception, &e);
3640 if (!raise_exception) {
3642 VALUE result = rb_protect(convert_type_to_float_protected, val, &state);
3643 if (state) rb_set_errinfo(
Qnil);
3647 return rb_convert_type_with_id(val,
T_FLOAT,
"Float", id_to_f);
3655 return rb_convert_to_float(val, TRUE);
3661 return rb_convert_to_float(arg, TRUE);
3667 int exception = rb_bool_expected(opts,
"exception", TRUE);
3668 return rb_convert_to_float(arg, exception);
3672numeric_to_float(
VALUE val)
3675 rb_raise(
rb_eTypeError,
"can't convert %"PRIsVALUE
" into Float",
3678 return rb_convert_type_with_id(val,
T_FLOAT,
"Float", id_to_f);
3684 switch (to_float(&val, TRUE)) {
3688 return numeric_to_float(val);
3698 return rb_check_convert_type_with_id(val,
T_FLOAT,
"Float", id_to_f);
3702basic_to_f_p(
VALUE klass)
3704 return rb_method_basic_definition_p(klass, id_to_f);
3709rb_num_to_dbl(
VALUE val)
3714 return fix2dbl_without_to_f(val);
3717 return rb_float_flonum_value(val);
3720 conversion_to_float(val);
3726 return rb_float_noflonum_value(val);
3729 return big2dbl_without_to_f(val);
3733 return rat2dbl_without_to_f(val);
3739 val = numeric_to_float(val);
3748 return fix2dbl_without_to_f(val);
3751 return rb_float_flonum_value(val);
3754 implicit_conversion_to_float(val);
3760 return rb_float_noflonum_value(val);
3762 return big2dbl_without_to_f(val);
3764 return rat2dbl_without_to_f(val);
3766 rb_raise(
rb_eTypeError,
"no implicit conversion to float from string");
3771 val = rb_convert_type_with_id(val,
T_FLOAT,
"Float", id_to_f);
3780 tmp = rb_convert_type_with_id(val,
T_STRING,
"String", idTo_s);
3813 tmp = rb_check_to_array(val);
3855 if (
NIL_P(val))
return rb_hash_new();
3856 tmp = rb_check_hash_type(val);
3859 return rb_hash_new();
3902dig_basic_p(
VALUE obj,
struct dig_method *cache)
3905 if (klass != cache->klass) {
3906 cache->klass = klass;
3907 cache->basic = rb_method_basic_definition_p(klass, id_dig);
3909 return cache->basic;
3913no_dig_method(
int found,
VALUE recv,
ID mid,
int argc,
const VALUE *argv,
VALUE data)
3916 rb_raise(
rb_eTypeError,
"%"PRIsVALUE
" does not have #dig method",
3925 struct dig_method hash = {
Qnil}, ary = {
Qnil}, strt = {
Qnil};
3927 for (; argc > 0; ++argv, --argc) {
3928 if (
NIL_P(obj))
return notfound;
3932 if (dig_basic_p(obj, &hash)) {
3933 obj = rb_hash_aref(obj, *argv);
3938 if (dig_basic_p(obj, &ary)) {
3939 obj = rb_ary_at(obj, *argv);
3944 if (dig_basic_p(obj, &strt)) {
3945 obj = rb_struct_lookup(obj, *argv);
3953 return rb_check_funcall_with_hook_kw(obj, id_dig, argc, argv,
4216 Init_class_hierarchy();
4433 rb_cNilClass_to_s = rb_fstring_enc_lit(
"", rb_usascii_encoding());
4434 rb_vm_register_global_object(rb_cNilClass_to_s);
4483 rb_class_undefined_instance_methods, 0);
4493 rb_mod_const_missing, 1);
4519 rb_cTrueClass_to_s = rb_fstring_enc_lit(
"true", rb_usascii_encoding());
4520 rb_vm_register_global_object(rb_cTrueClass_to_s);
4531 rb_cFalseClass_to_s = rb_fstring_enc_lit(
"false", rb_usascii_encoding());
4532 rb_vm_register_global_object(rb_cFalseClass_to_s);
4543#include "kernel.rbinc"
4544#include "nilclass.rbinc"
4550 id_instance_variables_to_inspect =
rb_intern_const(
"instance_variables_to_inspect");
#define RUBY_ASSERT(...)
Asserts that the given expression is truthy if and only if RUBY_DEBUG is truthy.
static int rb_tolower(int c)
Our own locale-insensitive version of tolower(3).
#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.
@ RUBY_FL_PROMOTED
Ruby objects are "generational".
VALUE rb_class_protected_instance_methods(int argc, const VALUE *argv, VALUE mod)
Identical to rb_class_instance_methods(), except it returns names of methods that are protected only.
void rb_include_module(VALUE klass, VALUE module)
Includes a module to a class.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
VALUE rb_class_subclasses(VALUE klass)
Queries the class's direct descendants.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
VALUE rb_class_attached_object(VALUE klass)
Returns the attached object for a singleton class.
VALUE rb_obj_singleton_methods(int argc, const VALUE *argv, VALUE obj)
Identical to rb_class_instance_methods(), except it returns names of singleton methods instead of ins...
VALUE rb_class_instance_methods(int argc, const VALUE *argv, VALUE mod)
Generates an array of symbols, which are the list of method names defined in the passed class.
void rb_check_inheritable(VALUE super)
Asserts that the given class can derive a child class.
VALUE rb_class_public_instance_methods(int argc, const VALUE *argv, VALUE mod)
Identical to rb_class_instance_methods(), except it returns names of methods that are public only.
VALUE rb_define_module(const char *name)
Defines a top-level module.
void rb_singleton_class_attached(VALUE klass, VALUE obj)
Attaches a singleton class to its corresponding object.
VALUE rb_mod_included_modules(VALUE mod)
Queries the list of included modules.
VALUE rb_mod_ancestors(VALUE mod)
Queries the module's ancestors.
VALUE rb_class_inherited(VALUE super, VALUE klass)
Calls Class::inherited.
VALUE rb_mod_include_p(VALUE mod, VALUE mod2)
Queries if the passed module is included by the module.
VALUE rb_class_private_instance_methods(int argc, const VALUE *argv, VALUE mod)
Identical to rb_class_instance_methods(), except it returns names of methods that are private only.
VALUE rb_mod_init_copy(VALUE clone, VALUE orig)
The comment that comes with this function says :nodoc:.
void rb_define_alias(VALUE klass, const char *name1, const char *name2)
Defines an alias of a method.
void rb_undef_method(VALUE klass, const char *name)
Defines an undef of a method.
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
int rb_block_given_p(void)
Determines if the current method is given a block.
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define T_COMPLEX
Old name of RUBY_T_COMPLEX.
#define TYPE(_)
Old name of rb_type.
#define RB_INTEGER_TYPE_P
Old name of rb_integer_type_p.
#define ALLOCV
Old name of RB_ALLOCV.
#define ISSPACE
Old name of rb_isspace.
#define RFLOAT_VALUE
Old name of rb_float_value.
#define T_STRING
Old name of RUBY_T_STRING.
#define T_MASK
Old name of RUBY_T_MASK.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define OBJ_FROZEN
Old name of RB_OBJ_FROZEN.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define T_FLOAT
Old name of RUBY_T_FLOAT.
#define T_IMEMO
Old name of RUBY_T_IMEMO.
#define ID2SYM
Old name of RB_ID2SYM.
#define T_BIGNUM
Old name of RUBY_T_BIGNUM.
#define SPECIAL_CONST_P
Old name of RB_SPECIAL_CONST_P.
#define T_STRUCT
Old name of RUBY_T_STRUCT.
#define OBJ_FREEZE
Old name of RB_OBJ_FREEZE.
#define UNREACHABLE_RETURN
Old name of RBIMPL_UNREACHABLE_RETURN.
#define T_DATA
Old name of RUBY_T_DATA.
#define CLASS_OF
Old name of rb_class_of.
#define T_NONE
Old name of RUBY_T_NONE.
#define FIXABLE
Old name of RB_FIXABLE.
#define LONG2FIX
Old name of RB_INT2FIX.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define T_RATIONAL
Old name of RUBY_T_RATIONAL.
#define T_ICLASS
Old name of RUBY_T_ICLASS.
#define T_HASH
Old name of RUBY_T_HASH.
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
#define rb_ary_new3
Old name of rb_ary_new_from_args.
#define rb_usascii_str_new2
Old name of rb_usascii_str_new_cstr.
#define FLONUM_P
Old name of RB_FLONUM_P.
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define FL_WB_PROTECTED
Old name of RUBY_FL_WB_PROTECTED.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define DBL2NUM
Old name of rb_float_new.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define BUILTIN_TYPE
Old name of RB_BUILTIN_TYPE.
#define FL_FREEZE
Old name of RUBY_FL_FREEZE.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define CONST_ID
Old name of RUBY_CONST_ID.
#define rb_ary_new2
Old name of rb_ary_new_capa.
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
#define ALLOCV_END
Old name of RB_ALLOCV_END.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
void rb_category_warning(rb_warning_category_t category, const char *fmt,...)
Identical to rb_warning(), except it takes additional "category" parameter.
VALUE rb_eTypeError
TypeError exception.
void rb_warning(const char *fmt,...)
Issues a warning.
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
VALUE rb_cClass
Class class.
VALUE rb_cRational
Rational class.
VALUE rb_class_superclass(VALUE klass)
Returns the superclass of klass.
VALUE rb_class_get_superclass(VALUE klass)
Returns the superclass of a class.
VALUE rb_convert_type(VALUE val, int type, const char *tname, const char *method)
Converts an object into another type.
VALUE rb_Float(VALUE val)
This is the logic behind Kernel#Float.
VALUE rb_mKernel
Kernel module.
VALUE rb_check_to_int(VALUE val)
Identical to rb_check_to_integer(), except it uses #to_int for conversion.
VALUE rb_obj_reveal(VALUE obj, VALUE klass)
Make a hidden object visible again.
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,...
VALUE rb_cObject
Documented in include/ruby/internal/globals.h.
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
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...
VALUE rb_cRefinement
Refinement class.
VALUE rb_cInteger
Module class.
VALUE rb_obj_hide(VALUE obj)
Make the object invisible from Ruby code.
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 ...
VALUE rb_check_to_float(VALUE val)
This is complicated.
static VALUE rb_obj_init_clone(int argc, VALUE *argv, VALUE obj)
Default implementation of #initialize_clone
VALUE rb_cNilClass
NilClass class.
VALUE rb_Hash(VALUE val)
Equivalent to Kernel#Hash in Ruby.
VALUE rb_obj_frozen_p(VALUE obj)
Just calls RB_OBJ_FROZEN() inside.
VALUE rb_obj_init_copy(VALUE obj, VALUE orig)
Default implementation of #initialize_copy
int rb_eql(VALUE obj1, VALUE obj2)
Checks for equality of the passed objects, in terms of Object#eql?.
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.
VALUE rb_Integer(VALUE val)
This is the logic behind Kernel#Integer.
VALUE rb_cFalseClass
FalseClass class.
VALUE rb_cNumeric
Numeric class.
VALUE rb_Array(VALUE val)
This is the logic behind Kernel#Array.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_obj_dup(VALUE obj)
Duplicates the given object.
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
VALUE rb_cBasicObject
BasicObject class.
VALUE rb_cModule
Module class.
VALUE rb_class_inherited_p(VALUE mod, VALUE arg)
Determines if the given two modules are relatives.
VALUE rb_obj_is_instance_of(VALUE obj, VALUE c)
Queries if the given object is a direct instance of the given class.
VALUE rb_class_real(VALUE cl)
Finds a "real" class.
VALUE rb_obj_init_dup_clone(VALUE obj, VALUE orig)
Default implementation of #initialize_dup
VALUE rb_to_float(VALUE val)
Identical to rb_check_to_float(), except it raises on error.
double rb_num2dbl(VALUE val)
Converts an instance of rb_cNumeric into C's double.
VALUE rb_equal(VALUE obj1, VALUE obj2)
This function is an optimised version of calling #==.
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
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.
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...
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
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.
VALUE rb_String(VALUE val)
This is the logic behind Kernel#String.
VALUE rb_cTrueClass
TrueClass class.
size_t rb_obj_embedded_size(uint32_t fields_count)
Internal header for Object.
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
VALUE rb_obj_setup(VALUE obj, VALUE klass, VALUE type)
Fills common fields in the object.
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.
int rb_enc_str_asciionly_p(VALUE str)
Queries if the passed string is "ASCII only".
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.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
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.
#define RGENGC_WB_PROTECTED_OBJECT
This is a compile-time flag to enable/disable write barrier for struct RObject.
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.
int rb_is_instance_id(ID id)
Classifies the given ID, then sees if it is an instance variable.
int rb_is_const_id(ID id)
Classifies the given ID, then sees if it is a constant.
int rb_is_local_id(ID id)
Classifies the given ID, then sees if it is a local variable.
VALUE rb_rational_num(VALUE rat)
Queries the numerator of the passed Rational.
VALUE rb_rational_den(VALUE rat)
Queries the denominator of the passed Rational.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
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...
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.
void rb_must_asciicompat(VALUE obj)
Asserts that the given string's encoding is (Ruby's definition of) ASCII compatible.
VALUE rb_str_concat(VALUE dst, VALUE src)
Identical to rb_str_append(), except it also accepts an integer as a codepoint.
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
VALUE rb_str_intern(VALUE str)
Identical to rb_to_symbol(), except it assumes the receiver being an instance of RString.
VALUE rb_obj_as_string(VALUE obj)
Try converting an object to its stringised representation using its to_s method, if any.
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.
VALUE rb_obj_instance_variables(VALUE obj)
Resembles Object#instance_variables.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
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.
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
void rb_cvar_set(VALUE klass, ID name, VALUE val)
Assigns a value to a class variable.
VALUE rb_cvar_get(VALUE klass, ID name)
Obtains a value from a class variable.
VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv)
Resembles Module#constants.
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.
void rb_const_set(VALUE space, ID name, VALUE val)
Names a constant.
VALUE rb_mod_name(VALUE mod)
Queries the name of a module.
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
VALUE rb_const_get_at(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name)
Resembles Object#remove_instance_variable.
st_index_t rb_ivar_count(VALUE obj)
Number of instance variables defined on an object.
VALUE rb_const_get_from(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
VALUE rb_ivar_defined(VALUE obj, ID name)
Queries if the instance variable is defined at the object.
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv)
Resembles Module#class_variables.
VALUE rb_cvar_defined(VALUE klass, ID name)
Queries if the given class has the given class variable.
int rb_const_defined_from(VALUE space, ID name)
Identical to rb_const_defined(), except it returns false for private constants.
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
VALUE(* rb_alloc_func_t)(VALUE klass)
This is the type of functions that ruby calls when trying to allocate an object.
void rb_undef_alloc_func(VALUE klass)
Deletes the allocator function of a class.
void rb_attr(VALUE klass, ID name, int need_reader, int need_writer, int honour_visibility)
This function resembles now-deprecated Module#attr.
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.
rb_alloc_func_t rb_get_alloc_func(VALUE klass)
Queries the allocator function of a class.
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.
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().
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
int len
Length of the buffer.
const signed char ruby_digit36_to_number_table[]
Character to number mapping like ‘'a’->10,'b'->11etc.
#define strtod(s, e)
Just another name of ruby_strtod.
VALUE rb_f_sprintf(int argc, const VALUE *argv)
Identical to rb_str_format(), except how the arguments are arranged.
#define MEMCPY(p1, p2, type, n)
Handy macro to call memcpy.
#define RB_GC_GUARD(v)
Prevents premature destruction of local objects.
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_ivar_foreach(VALUE q, int_type *w, VALUE e)
Iteration over each instance variable of the object.
void rb_copy_generic_ivar(VALUE clone, VALUE obj)
Copies the list of instance variables.
#define RARRAY_LEN
Just another name of rb_array_len.
#define RARRAY_AREF(a, i)
static VALUE RBASIC_CLASS(VALUE obj)
Queries the class of an object.
#define RBASIC(obj)
Convenient casting macro.
#define RCLASS_SUPER
Just another name of rb_class_get_superclass.
static VALUE * ROBJECT_FIELDS(VALUE obj)
Queries the instance variables.
#define StringValue(v)
Ensures that the parameter object is a String.
#define StringValuePtr(v)
Identical to StringValue, except it returns a char*.
const char * rb_class2name(VALUE klass)
Queries the name of the passed class.
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
#define errno
Ractor-aware version of errno.
#define InitVM(ext)
This macro is for internal use.
#define RB_PASS_KEYWORDS
Pass keywords, final argument should be a hash of keywords.
#define RB_PASS_CALLED_KEYWORDS
Pass keywords if current method is called with keywords, useful for argument delegation.
#define RB_NO_KEYWORDS
Do not pass keywords.
#define RTEST
This is an old name of RB_TEST.
#define _(args)
This was a transition path from K&R to ANSI.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static bool RB_FLOAT_TYPE_P(VALUE obj)
Queries if the object is an instance of rb_cFloat.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.