summaryrefslogtreecommitdiff
path: root/object.c
diff options
context:
space:
mode:
Diffstat (limited to 'object.c')
-rw-r--r--object.c1912
1 files changed, 1112 insertions, 800 deletions
diff --git a/object.c b/object.c
index a07915606c..75186a30c6 100644
--- a/object.c
+++ b/object.c
@@ -31,14 +31,25 @@
#include "internal/object.h"
#include "internal/struct.h"
#include "internal/string.h"
+#include "internal/st.h"
#include "internal/symbol.h"
#include "internal/variable.h"
+#include "variable.h"
#include "probes.h"
#include "ruby/encoding.h"
#include "ruby/st.h"
#include "ruby/util.h"
#include "ruby/assert.h"
#include "builtin.h"
+#include "shape.h"
+#include "yjit.h"
+
+/* Flags of RObject
+ *
+ * 4: ROBJECT_HEAP
+ * The object has its instance variables in a separately allocated buffer.
+ * This can be either a flat buffer of reference, or an st_table for complex objects.
+ */
/*!
* \addtogroup object
@@ -71,6 +82,7 @@ static VALUE rb_cFalseClass_to_s;
#define id_init_dup idInitialize_dup
#define id_const_missing idConst_missing
#define id_to_f idTo_f
+static ID id_instance_variables_to_inspect;
#define CLASS_OR_MODULE_P(obj) \
(!SPECIAL_CONST_P(obj) && \
@@ -78,11 +90,17 @@ static VALUE rb_cFalseClass_to_s;
/*! \endcond */
+size_t
+rb_obj_embedded_size(uint32_t fields_count)
+{
+ return offsetof(struct RObject, as.ary) + (sizeof(VALUE) * fields_count);
+}
+
VALUE
rb_obj_hide(VALUE obj)
{
if (!SPECIAL_CONST_P(obj)) {
- RBASIC_CLEAR_CLASS(obj);
+ RBASIC_CLEAR_CLASS(obj);
}
return obj;
}
@@ -91,26 +109,64 @@ VALUE
rb_obj_reveal(VALUE obj, VALUE klass)
{
if (!SPECIAL_CONST_P(obj)) {
- RBASIC_SET_CLASS(obj, klass);
+ RBASIC_SET_CLASS(obj, klass);
+ }
+ return obj;
+}
+
+VALUE
+rb_class_allocate_instance(VALUE klass)
+{
+ uint32_t index_tbl_num_entries = RCLASS_MAX_IV_COUNT(klass);
+
+ size_t size = rb_obj_embedded_size(index_tbl_num_entries);
+ if (!rb_gc_size_allocatable_p(size)) {
+ size = sizeof(struct RObject);
+ }
+
+ // There might be a NEWOBJ tracepoint callback, and it may set fields.
+ // So the shape must be passed to `NEWOBJ_OF`.
+ VALUE flags = T_OBJECT | (RGENGC_WB_PROTECTED_OBJECT ? FL_WB_PROTECTED : 0);
+ NEWOBJ_OF_WITH_SHAPE(o, struct RObject, klass, flags, rb_shape_root(rb_gc_heap_id_for_size(size)), size, 0);
+ VALUE obj = (VALUE)o;
+
+#if RUBY_DEBUG
+ RUBY_ASSERT(!rb_shape_obj_too_complex_p(obj));
+ VALUE *ptr = ROBJECT_FIELDS(obj);
+ size_t fields_count = RSHAPE_LEN(RBASIC_SHAPE_ID(obj));
+ for (size_t i = fields_count; i < ROBJECT_FIELDS_CAPACITY(obj); i++) {
+ ptr[i] = Qundef;
}
+ if (rb_obj_class(obj) != rb_class_real(klass)) {
+ rb_bug("Expected rb_class_allocate_instance to set the class correctly");
+ }
+#endif
+
return obj;
}
VALUE
rb_obj_setup(VALUE obj, VALUE klass, VALUE type)
{
- RBASIC(obj)->flags = type;
+ VALUE ignored_flags = RUBY_FL_PROMOTED;
+ RBASIC(obj)->flags = (type & ~ignored_flags) | (RBASIC(obj)->flags & ignored_flags);
RBASIC_SET_CLASS(obj, klass);
return obj;
}
-/**
- * call-seq:
- * obj === other -> true or false
+/*
+ * call-seq:
+ * true === other -> true or false
+ * false === other -> true or false
+ * nil === other -> true or false
*
- * Case Equality -- For class Object, effectively the same as calling
- * <code>#==</code>, but typically overridden by descendants to provide
- * meaningful semantics in +case+ statements.
+ * Returns +true+ or +false+.
+ *
+ * Like Object#==, if +other+ is an instance of \Object
+ * (and not an instance of one of its many subclasses).
+ *
+ * This method is commonly overridden by those subclasses,
+ * to provide meaningful semantics in +case+ statements.
*/
#define case_equal rb_equal
/* The default implementation of #=== is
@@ -123,8 +179,8 @@ rb_equal(VALUE obj1, VALUE obj2)
if (obj1 == obj2) return Qtrue;
result = rb_equal_opt(obj1, obj2);
- if (result == Qundef) {
- result = rb_funcall(obj1, id_eq, 1, obj2);
+ if (UNDEF_P(result)) {
+ result = rb_funcall(obj1, id_eq, 1, obj2);
}
return RBOOL(RTEST(result));
}
@@ -134,24 +190,28 @@ rb_eql(VALUE obj1, VALUE obj2)
{
VALUE result;
- if (obj1 == obj2) return Qtrue;
+ if (obj1 == obj2) return TRUE;
result = rb_eql_opt(obj1, obj2);
- if (result == Qundef) {
- result = rb_funcall(obj1, id_eql, 1, obj2);
+ if (UNDEF_P(result)) {
+ result = rb_funcall(obj1, id_eql, 1, obj2);
}
- return RBOOL(RTEST(result));
+ return RTEST(result);
}
/**
* call-seq:
- * obj == other -> true or false
- * obj.equal?(other) -> true or false
- * obj.eql?(other) -> true or false
+ * self == other -> true or false
+ * equal?(other) -> true or false
+ * eql?(other) -> true or false
*
- * Equality --- At the Object level, #== returns <code>true</code>
- * only if +obj+ and +other+ are the same object. Typically, this
- * method is overridden in descendant classes to provide
- * class-specific meaning.
+ * Returns whether +self+ and +other+ are the same object:
+ *
+ * object = Object.new
+ * object == object # => true
+ * object == Object.new # => false
+ *
+ * Here in class \Object, #==, #equal?, and #eql? are the same method.
+ * A subclass may override #== to provide class-specific meaning.
*
* Unlike #==, the #equal? method should never be overridden by
* subclasses as it is used to determine object identity (that is,
@@ -183,7 +243,7 @@ rb_eql(VALUE obj1, VALUE obj2)
* \private
*++
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_obj_equal(VALUE obj1, VALUE obj2)
{
return RBOOL(obj1 == obj2);
@@ -201,7 +261,7 @@ VALUE rb_obj_hash(VALUE obj);
*++
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_obj_not(VALUE obj)
{
return RBOOL(!RTEST(obj));
@@ -217,19 +277,39 @@ rb_obj_not(VALUE obj)
*++
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_obj_not_equal(VALUE obj1, VALUE obj2)
{
VALUE result = rb_funcall(obj1, id_eq, 1, obj2);
return rb_obj_not(result);
}
+static inline VALUE
+fake_class_p(VALUE klass)
+{
+ RUBY_ASSERT(klass);
+ RUBY_ASSERT(RB_TYPE_P(klass, T_CLASS) || RB_TYPE_P(klass, T_MODULE) || RB_TYPE_P(klass, T_ICLASS));
+ STATIC_ASSERT(t_iclass_overlap_t_class, !(T_CLASS & T_ICLASS));
+ STATIC_ASSERT(t_iclass_overlap_t_module, !(T_MODULE & T_ICLASS));
+
+ return FL_TEST_RAW(klass, T_ICLASS | FL_SINGLETON);
+}
+
+static inline VALUE
+class_real(VALUE cl)
+{
+ RUBY_ASSERT(cl);
+ while (RB_UNLIKELY(fake_class_p(cl))) {
+ cl = RCLASS_SUPER(cl);
+ }
+ return cl;
+}
+
VALUE
rb_class_real(VALUE cl)
{
- while (cl &&
- ((RBASIC(cl)->flags & FL_SINGLETON) || BUILTIN_TYPE(cl) == T_ICLASS)) {
- cl = RCLASS_SUPER(cl);
+ if (cl) {
+ cl = class_real(cl);
}
return cl;
}
@@ -237,7 +317,17 @@ rb_class_real(VALUE cl)
VALUE
rb_obj_class(VALUE obj)
{
- return rb_class_real(CLASS_OF(obj));
+ VALUE cl = CLASS_OF(obj);
+ if (cl) {
+ cl = class_real(cl);
+ }
+ return cl;
+}
+
+static inline VALUE
+rb_obj_class_must(VALUE obj)
+{
+ return class_real(CLASS_OF(obj));
}
/*
@@ -264,36 +354,50 @@ rb_obj_singleton_class(VALUE obj)
}
/*! \private */
-MJIT_FUNC_EXPORTED void
+void
rb_obj_copy_ivar(VALUE dest, VALUE obj)
{
- VALUE *dst_buf = 0;
- VALUE *src_buf = 0;
- uint32_t len = ROBJECT_EMBED_LEN_MAX;
+ RUBY_ASSERT(!RB_TYPE_P(obj, T_CLASS) && !RB_TYPE_P(obj, T_MODULE));
+ RUBY_ASSERT(BUILTIN_TYPE(dest) == BUILTIN_TYPE(obj));
- if (RBASIC(obj)->flags & ROBJECT_EMBED) {
- src_buf = ROBJECT(obj)->as.ary;
+ unsigned long src_num_ivs = rb_ivar_count(obj);
+ if (!src_num_ivs) {
+ return;
+ }
- // embedded -> embedded
- if (RBASIC(dest)->flags & ROBJECT_EMBED) {
- dst_buf = ROBJECT(dest)->as.ary;
- }
- // embedded -> extended
- else {
- dst_buf = ROBJECT(dest)->as.heap.ivptr;
- }
+ shape_id_t src_shape_id = RBASIC_SHAPE_ID(obj);
+
+ if (rb_shape_too_complex_p(src_shape_id)) {
+ rb_shape_copy_complex_ivars(dest, obj, src_shape_id, ROBJECT_FIELDS_HASH(obj));
+ return;
}
- // extended -> extended
- else {
- uint32_t src_len = ROBJECT(obj)->as.heap.numiv;
- uint32_t dst_len = ROBJECT(dest)->as.heap.numiv;
- len = src_len < dst_len ? src_len : dst_len;
- dst_buf = ROBJECT(dest)->as.heap.ivptr;
- src_buf = ROBJECT(obj)->as.heap.ivptr;
+ shape_id_t initial_shape_id = RBASIC_SHAPE_ID(dest);
+ RUBY_ASSERT(RSHAPE_TYPE_P(initial_shape_id, SHAPE_ROOT));
+
+ shape_id_t dest_shape_id = rb_shape_rebuild(initial_shape_id, src_shape_id);
+ if (UNLIKELY(rb_shape_too_complex_p(dest_shape_id))) {
+ st_table *table = rb_st_init_numtable_with_size(src_num_ivs);
+ rb_obj_copy_ivs_to_hash_table(obj, table);
+ rb_obj_init_too_complex(dest, table);
+
+ return;
+ }
+
+ VALUE *src_buf = ROBJECT_FIELDS(obj);
+ VALUE *dest_buf = ROBJECT_FIELDS(dest);
+
+ attr_index_t initial_capa = RSHAPE_CAPACITY(initial_shape_id);
+ attr_index_t dest_capa = RSHAPE_CAPACITY(dest_shape_id);
+
+ RUBY_ASSERT(src_num_ivs <= dest_capa);
+ if (initial_capa < dest_capa) {
+ rb_ensure_iv_list_size(dest, 0, dest_capa);
+ dest_buf = ROBJECT_FIELDS(dest);
}
- MEMCPY(dst_buf, src_buf, VALUE, len);
+ rb_shape_copy_fields(dest, dest_buf, dest_shape_id, src_buf, src_shape_id);
+ RBASIC_SET_SHAPE_ID(dest, dest_shape_id);
}
static void
@@ -302,14 +406,25 @@ init_copy(VALUE dest, VALUE obj)
if (OBJ_FROZEN(dest)) {
rb_raise(rb_eTypeError, "[bug] frozen object (%s) allocated", rb_obj_classname(dest));
}
- RBASIC(dest)->flags &= ~(T_MASK|FL_EXIVAR);
- RBASIC(dest)->flags |= RBASIC(obj)->flags & (T_MASK|FL_EXIVAR);
- rb_copy_wb_protected_attribute(dest, obj);
- rb_copy_generic_ivar(dest, obj);
- rb_gc_copy_finalizer(dest, obj);
- if (RB_TYPE_P(obj, T_OBJECT)) {
- rb_obj_copy_ivar(dest, obj);
+ RBASIC(dest)->flags &= ~T_MASK;
+ // Copies the shape id from obj to dest
+ RBASIC(dest)->flags |= RBASIC(obj)->flags & T_MASK;
+ switch (BUILTIN_TYPE(obj)) {
+ case T_IMEMO:
+ rb_bug("Unreachable");
+ break;
+ case T_CLASS:
+ case T_MODULE:
+ rb_mod_init_copy(dest, obj);
+ break;
+ case T_OBJECT:
+ rb_obj_copy_ivar(dest, obj);
+ break;
+ default:
+ rb_copy_generic_ivar(dest, obj);
+ break;
}
+ rb_gc_copy_attributes(dest, obj);
}
static VALUE immutable_obj_clone(VALUE obj, VALUE kwfreeze);
@@ -325,10 +440,10 @@ special_object_p(VALUE obj)
case T_SYMBOL:
case T_RATIONAL:
case T_COMPLEX:
- /* not a comprehensive list */
- return TRUE;
+ /* not a comprehensive list */
+ return TRUE;
default:
- return FALSE;
+ return FALSE;
}
}
@@ -352,7 +467,7 @@ rb_obj_clone2(rb_execution_context_t *ec, VALUE obj, VALUE freeze)
{
VALUE kwfreeze = obj_freeze_opt(freeze);
if (!special_object_p(obj))
- return mutable_obj_clone(obj, kwfreeze);
+ return mutable_obj_clone(obj, kwfreeze);
return immutable_obj_clone(obj, kwfreeze);
}
@@ -372,12 +487,12 @@ rb_get_freeze_opt(int argc, VALUE *argv)
VALUE kwfreeze = Qnil;
if (!keyword_ids[0]) {
- CONST_ID(keyword_ids[0], "freeze");
+ CONST_ID(keyword_ids[0], "freeze");
}
rb_scan_args(argc, argv, "0:", &opt);
if (!NIL_P(opt)) {
- rb_get_kwargs(opt, keyword_ids, 0, 1, &kwfreeze);
- if (kwfreeze != Qundef)
+ rb_get_kwargs(opt, keyword_ids, 0, 1, &kwfreeze);
+ if (!UNDEF_P(kwfreeze))
kwfreeze = obj_freeze_opt(kwfreeze);
}
return kwfreeze;
@@ -387,23 +502,20 @@ static VALUE
immutable_obj_clone(VALUE obj, VALUE kwfreeze)
{
if (kwfreeze == Qfalse)
- rb_raise(rb_eArgError, "can't unfreeze %"PRIsVALUE,
- rb_obj_class(obj));
+ rb_raise(rb_eArgError, "can't unfreeze %"PRIsVALUE,
+ rb_obj_class(obj));
return obj;
}
-static VALUE
-mutable_obj_clone(VALUE obj, VALUE kwfreeze)
+VALUE
+rb_obj_clone_setup(VALUE obj, VALUE clone, VALUE kwfreeze)
{
- VALUE clone, singleton;
VALUE argv[2];
- clone = rb_obj_alloc(rb_obj_class(obj));
-
- singleton = rb_singleton_class_clone_and_attach(obj, clone);
+ VALUE singleton = rb_singleton_class_clone_and_attach(obj, clone);
RBASIC_SET_CLASS(clone, singleton);
- if (FL_TEST(singleton, FL_SINGLETON)) {
- rb_singleton_class_attached(singleton, clone);
+ if (RCLASS_SINGLETON_P(singleton)) {
+ rb_singleton_class_attached(singleton, clone);
}
init_copy(clone, obj);
@@ -411,14 +523,22 @@ mutable_obj_clone(VALUE obj, VALUE kwfreeze)
switch (kwfreeze) {
case Qnil:
rb_funcall(clone, id_init_clone, 1, obj);
- RBASIC(clone)->flags |= RBASIC(obj)->flags & FL_FREEZE;
+ RBASIC(clone)->flags |= RBASIC(obj)->flags & FL_FREEZE;
+
+ if (RB_TYPE_P(obj, T_STRING)) {
+ FL_SET_RAW(clone, FL_TEST_RAW(obj, STR_CHILLED));
+ }
+
+ if (RB_OBJ_FROZEN(obj)) {
+ shape_id_t next_shape_id = rb_shape_transition_frozen(clone);
+ RBASIC_SET_SHAPE_ID(clone, next_shape_id);
+ }
break;
- case Qtrue:
- {
+ case Qtrue: {
static VALUE freeze_true_hash;
if (!freeze_true_hash) {
freeze_true_hash = rb_hash_new();
- rb_gc_register_mark_object(freeze_true_hash);
+ rb_vm_register_global_object(freeze_true_hash);
rb_hash_aset(freeze_true_hash, ID2SYM(idFreeze), Qtrue);
rb_obj_freeze(freeze_true_hash);
}
@@ -426,15 +546,14 @@ mutable_obj_clone(VALUE obj, VALUE kwfreeze)
argv[0] = obj;
argv[1] = freeze_true_hash;
rb_funcallv_kw(clone, id_init_clone, 2, argv, RB_PASS_KEYWORDS);
- RBASIC(clone)->flags |= FL_FREEZE;
+ OBJ_FREEZE(clone);
break;
- }
- case Qfalse:
- {
+ }
+ case Qfalse: {
static VALUE freeze_false_hash;
if (!freeze_false_hash) {
freeze_false_hash = rb_hash_new();
- rb_gc_register_mark_object(freeze_false_hash);
+ rb_vm_register_global_object(freeze_false_hash);
rb_hash_aset(freeze_false_hash, ID2SYM(idFreeze), Qfalse);
rb_obj_freeze(freeze_false_hash);
}
@@ -443,7 +562,7 @@ mutable_obj_clone(VALUE obj, VALUE kwfreeze)
argv[1] = freeze_false_hash;
rb_funcallv_kw(clone, id_init_clone, 2, argv, RB_PASS_KEYWORDS);
break;
- }
+ }
default:
rb_bug("invalid kwfreeze passed to mutable_obj_clone");
}
@@ -451,6 +570,13 @@ mutable_obj_clone(VALUE obj, VALUE kwfreeze)
return clone;
}
+static VALUE
+mutable_obj_clone(VALUE obj, VALUE kwfreeze)
+{
+ VALUE clone = rb_obj_alloc(rb_obj_class(obj));
+ return rb_obj_clone_setup(obj, clone, kwfreeze);
+}
+
VALUE
rb_obj_clone(VALUE obj)
{
@@ -458,6 +584,15 @@ rb_obj_clone(VALUE obj)
return mutable_obj_clone(obj, Qnil);
}
+VALUE
+rb_obj_dup_setup(VALUE obj, VALUE dup)
+{
+ init_copy(dup, obj);
+ rb_funcall(dup, id_init_dup, 1, obj);
+
+ return dup;
+}
+
/*
* call-seq:
* obj.dup -> an_object
@@ -503,13 +638,10 @@ rb_obj_dup(VALUE obj)
VALUE dup;
if (special_object_p(obj)) {
- return obj;
+ return obj;
}
dup = rb_obj_alloc(rb_obj_class(obj));
- init_copy(dup, obj);
- rb_funcall(dup, id_init_dup, 1, obj);
-
- return dup;
+ return rb_obj_dup_setup(obj, dup);
}
/*
@@ -535,18 +667,12 @@ rb_obj_size(VALUE self, VALUE args, VALUE obj)
return LONG2FIX(1);
}
-static VALUE
-block_given_p(rb_execution_context_t *ec, VALUE self)
-{
- return RBOOL(rb_block_given_p());
-}
-
/**
* :nodoc:
*--
- * Default implementation of \c #initialize_copy
- * \param[in,out] obj the receiver being initialized
- * \param[in] orig the object to be copied from.
+ * Default implementation of `#initialize_copy`
+ * @param[in,out] obj the receiver being initialized
+ * @param[in] orig the object to be copied from.
*++
*/
VALUE
@@ -555,18 +681,18 @@ rb_obj_init_copy(VALUE obj, VALUE orig)
if (obj == orig) return obj;
rb_check_frozen(obj);
if (TYPE(obj) != TYPE(orig) || rb_obj_class(obj) != rb_obj_class(orig)) {
- rb_raise(rb_eTypeError, "initialize_copy should take same class object");
+ rb_raise(rb_eTypeError, "initialize_copy should take same class object");
}
return obj;
}
-/*!
+/**
* :nodoc:
*--
- * Default implementation of \c #initialize_dup
+ * Default implementation of `#initialize_dup`
*
- * \param[in,out] obj the receiver being initialized
- * \param[in] orig the object to be dup from.
+ * @param[in,out] obj the receiver being initialized
+ * @param[in] orig the object to be dup from.
*++
**/
VALUE
@@ -576,14 +702,14 @@ rb_obj_init_dup_clone(VALUE obj, VALUE orig)
return obj;
}
-/*!
+/**
* :nodoc:
*--
- * Default implementation of \c #initialize_clone
+ * Default implementation of `#initialize_clone`
*
- * \param[in] The number of arguments
- * \param[in] The array of arguments
- * \param[in] obj the receiver being initialized
+ * @param[in] The number of arguments
+ * @param[in] The array of arguments
+ * @param[in] obj the receiver being initialized
*++
**/
static VALUE
@@ -627,46 +753,52 @@ rb_inspect(VALUE obj)
rb_encoding *enc = rb_default_internal_encoding();
if (enc == NULL) enc = rb_default_external_encoding();
if (!rb_enc_asciicompat(enc)) {
- if (!rb_enc_str_asciionly_p(str))
- return rb_str_escape(str);
- return str;
+ if (!rb_enc_str_asciionly_p(str))
+ return rb_str_escape(str);
+ return str;
}
if (rb_enc_get(str) != enc && !rb_enc_str_asciionly_p(str))
- return rb_str_escape(str);
+ return rb_str_escape(str);
return str;
}
static int
-inspect_i(st_data_t k, st_data_t v, st_data_t a)
+inspect_i(ID id, VALUE value, st_data_t a)
{
- ID id = (ID)k;
- VALUE value = (VALUE)v;
- VALUE str = (VALUE)a;
+ VALUE *args = (VALUE *)a, str = args[0], ivars = args[1];
/* need not to show internal data */
if (CLASS_OF(value) == 0) return ST_CONTINUE;
if (!rb_is_instance_id(id)) return ST_CONTINUE;
+ if (!NIL_P(ivars)) {
+ VALUE name = ID2SYM(id);
+ for (long i = 0; RARRAY_AREF(ivars, i) != name; ) {
+ if (++i >= RARRAY_LEN(ivars)) return ST_CONTINUE;
+ }
+ }
if (RSTRING_PTR(str)[0] == '-') { /* first element */
- RSTRING_PTR(str)[0] = '#';
- rb_str_cat2(str, " ");
+ RSTRING_PTR(str)[0] = '#';
+ rb_str_cat2(str, " ");
}
else {
- rb_str_cat2(str, ", ");
+ rb_str_cat2(str, ", ");
}
- rb_str_catf(str, "%"PRIsVALUE"=%+"PRIsVALUE,
- rb_id2str(id), value);
+ rb_str_catf(str, "%"PRIsVALUE"=", rb_id2str(id));
+ rb_str_buf_append(str, rb_inspect(value));
return ST_CONTINUE;
}
static VALUE
-inspect_obj(VALUE obj, VALUE str, int recur)
+inspect_obj(VALUE obj, VALUE a, int recur)
{
+ VALUE *args = (VALUE *)a, str = args[0];
+
if (recur) {
- rb_str_cat2(str, " ...");
+ rb_str_cat2(str, " ...");
}
else {
- rb_ivar_foreach(obj, inspect_i, str);
+ rb_ivar_foreach(obj, inspect_i, a);
}
rb_str_cat2(str, ">");
RSTRING_PTR(str)[0] = '#';
@@ -699,23 +831,67 @@ inspect_obj(VALUE obj, VALUE str, int recur)
* end
* end
* Bar.new.inspect #=> "#<Bar:0x0300c868 @bar=1>"
+ *
+ * If _obj_ responds to +instance_variables_to_inspect+, then only
+ * the instance variables listed in the returned array will be included
+ * in the inspect string.
+ *
+ *
+ * class DatabaseConfig
+ * def initialize(host, user, password)
+ * @host = host
+ * @user = user
+ * @password = password
+ * end
+ *
+ * private
+ * def instance_variables_to_inspect = [:@host, :@user]
+ * end
+ *
+ * conf = DatabaseConfig.new("localhost", "root", "hunter2")
+ * conf.inspect #=> #<DatabaseConfig:0x0000000104def350 @host="localhost", @user="root">
*/
static VALUE
rb_obj_inspect(VALUE obj)
{
- if (rb_ivar_count(obj) > 0) {
- VALUE str;
- VALUE c = rb_class_name(CLASS_OF(obj));
+ VALUE ivars = rb_check_funcall(obj, id_instance_variables_to_inspect, 0, 0);
+ st_index_t n = 0;
+ if (UNDEF_P(ivars) || NIL_P(ivars)) {
+ n = rb_ivar_count(obj);
+ ivars = Qnil;
+ }
+ else if (RB_TYPE_P(ivars, T_ARRAY)) {
+ n = RARRAY_LEN(ivars);
+ }
+ else {
+ rb_raise(
+ rb_eTypeError,
+ "Expected #instance_variables_to_inspect to return an Array or nil, but it returned %"PRIsVALUE,
+ rb_obj_class(ivars)
+ );
+ }
- str = rb_sprintf("-<%"PRIsVALUE":%p", c, (void*)obj);
- return rb_exec_recursive(inspect_obj, obj, str);
+ if (n > 0) {
+ VALUE c = rb_class_name(CLASS_OF(obj));
+ VALUE args[2] = {
+ rb_sprintf("-<%"PRIsVALUE":%p", c, (void*)obj),
+ ivars
+ };
+ return rb_exec_recursive(inspect_obj, obj, (VALUE)args);
}
else {
- return rb_any_to_s(obj);
+ return rb_any_to_s(obj);
}
}
+/* :nodoc: */
+static VALUE
+rb_obj_instance_variables_to_inspect(VALUE obj)
+{
+ return Qnil;
+}
+
static VALUE
class_or_module_required(VALUE c)
{
@@ -723,10 +899,10 @@ class_or_module_required(VALUE c)
case T_MODULE:
case T_CLASS:
case T_ICLASS:
- break;
+ break;
default:
- rb_raise(rb_eTypeError, "class or module required");
+ rb_raise(rb_eTypeError, "class or module required");
}
return c;
}
@@ -757,7 +933,7 @@ rb_obj_is_instance_of(VALUE obj, VALUE c)
return RBOOL(rb_obj_class(obj) == c);
}
-// Returns whether c is a proper (c != cl) subclass of cl
+// Returns whether c is a proper (c != cl) superclass of cl
// Both c and cl must be T_CLASS
static VALUE
class_search_class_ancestor(VALUE cl, VALUE c)
@@ -770,7 +946,7 @@ class_search_class_ancestor(VALUE cl, VALUE c)
VALUE *classes = RCLASS_SUPERCLASSES(cl);
// If c's inheritance chain is longer, it cannot be an ancestor
- // We are checking for a proper subclass so don't check if they are equal
+ // We are checking for a proper superclass so don't check if they are equal
if (cl_depth <= c_depth)
return Qfalse;
@@ -1079,6 +1255,30 @@ rb_class_search_ancestor(VALUE cl, VALUE c)
*
* Added :FOO
*
+ * If we define a class using the <tt>class</tt> keyword, <tt>const_added</tt>
+ * runs before <tt>inherited</tt>:
+ *
+ * module M
+ * def self.const_added(const_name)
+ * super
+ * p :const_added
+ * end
+ *
+ * parent = Class.new do
+ * def self.inherited(subclass)
+ * super
+ * p :inherited
+ * end
+ * end
+ *
+ * class Child < parent
+ * end
+ * end
+ *
+ * <em>produces:</em>
+ *
+ * :const_added
+ * :inherited
*/
#define rb_obj_mod_const_added rb_obj_dummy1
@@ -1205,10 +1405,10 @@ VALUE
rb_obj_freeze(VALUE obj)
{
if (!OBJ_FROZEN(obj)) {
- OBJ_FREEZE(obj);
- if (SPECIAL_CONST_P(obj)) {
- rb_bug("special consts should be frozen.");
- }
+ OBJ_FREEZE(obj);
+ if (SPECIAL_CONST_P(obj)) {
+ rb_bug("special consts should be frozen.");
+ }
}
return obj;
}
@@ -1223,17 +1423,51 @@ rb_obj_frozen_p(VALUE obj)
/*
* Document-class: NilClass
*
- * The class of the singleton object <code>nil</code>.
+ * The class of the singleton object +nil+.
+ *
+ * Several of its methods act as operators:
+ *
+ * - #&
+ * - #|
+ * - #===
+ * - #=~
+ * - #^
+ *
+ * Others act as converters, carrying the concept of _nullity_
+ * to other classes:
+ *
+ * - #rationalize
+ * - #to_a
+ * - #to_c
+ * - #to_h
+ * - #to_r
+ * - #to_s
+ *
+ * While +nil+ doesn't have an explicitly defined #to_hash method,
+ * it can be used in <code>**</code> unpacking, not adding any
+ * keyword arguments.
+ *
+ * Another method provides inspection:
+ *
+ * - #inspect
+ *
+ * Finally, there is this query method:
+ *
+ * - #nil?
+ *
*/
/*
- * call-seq:
- * nil.to_s -> ""
+ * call-seq:
+ * to_s -> ''
+ *
+ * Returns an empty String:
+ *
+ * nil.to_s # => ""
*
- * Always returns the empty string.
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_nil_to_s(VALUE obj)
{
return rb_cNilClass_to_s;
@@ -1242,12 +1476,13 @@ rb_nil_to_s(VALUE obj)
/*
* Document-method: to_a
*
- * call-seq:
- * nil.to_a -> []
+ * call-seq:
+ * to_a -> []
*
- * Always returns an empty array.
+ * Returns an empty Array.
+ *
+ * nil.to_a # => []
*
- * nil.to_a #=> []
*/
static VALUE
@@ -1259,12 +1494,13 @@ nil_to_a(VALUE obj)
/*
* Document-method: to_h
*
- * call-seq:
- * nil.to_h -> {}
+ * call-seq:
+ * to_h -> {}
+ *
+ * Returns an empty Hash.
*
- * Always returns an empty hash.
+ * nil.to_h #=> {}
*
- * nil.to_h #=> {}
*/
static VALUE
@@ -1274,10 +1510,13 @@ nil_to_h(VALUE obj)
}
/*
- * call-seq:
- * nil.inspect -> "nil"
+ * call-seq:
+ * inspect -> 'nil'
+ *
+ * Returns string <tt>'nil'</tt>:
+ *
+ * nil.inspect # => "nil"
*
- * Always returns the string "nil".
*/
static VALUE
@@ -1287,12 +1526,17 @@ nil_inspect(VALUE obj)
}
/*
- * call-seq:
- * nil =~ other -> nil
+ * call-seq:
+ * nil =~ object -> nil
+ *
+ * Returns +nil+.
*
- * Dummy pattern matching -- always returns nil.
+ * This method makes it useful to write:
+ *
+ * while gets =~ /re/
+ * # ...
+ * end
*
- * This method makes it possible to `while gets =~ /re/ do`.
*/
static VALUE
@@ -1301,24 +1545,38 @@ nil_match(VALUE obj1, VALUE obj2)
return Qnil;
}
-/***********************************************************************
+/*
* Document-class: TrueClass
*
- * The global value <code>true</code> is the only instance of class
- * TrueClass and represents a logically true value in
- * boolean expressions. The class provides operators allowing
- * <code>true</code> to be used in logical expressions.
+ * The class of the singleton object +true+.
+ *
+ * Several of its methods act as operators:
+ *
+ * - #&
+ * - #|
+ * - #===
+ * - #^
+ *
+ * One other method:
+ *
+ * - #to_s and its alias #inspect.
+ *
*/
/*
* call-seq:
- * true.to_s -> "true"
+ * true.to_s -> 'true'
+ *
+ * Returns string <tt>'true'</tt>:
+ *
+ * true.to_s # => "true"
+ *
+ * TrueClass#inspect is an alias for TrueClass#to_s.
*
- * The string representation of <code>true</code> is "true".
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_true_to_s(VALUE obj)
{
return rb_cTrueClass_to_s;
@@ -1327,10 +1585,14 @@ rb_true_to_s(VALUE obj)
/*
* call-seq:
- * true & obj -> true or false
+ * true & object -> true or false
+ *
+ * Returns +false+ if +object+ is +false+ or +nil+, +true+ otherwise:
+ *
+ * true & Object.new # => true
+ * true & false # => false
+ * true & nil # => false
*
- * And---Returns <code>false</code> if <i>obj</i> is
- * <code>nil</code> or <code>false</code>, <code>true</code> otherwise.
*/
static VALUE
@@ -1341,18 +1603,21 @@ true_and(VALUE obj, VALUE obj2)
/*
* call-seq:
- * true | obj -> true
+ * true | object -> true
*
- * Or---Returns <code>true</code>. As <i>obj</i> is an argument to
- * a method call, it is always evaluated; there is no short-circuit
- * evaluation in this case.
+ * Returns +true+:
*
- * true | puts("or")
- * true || puts("logical or")
+ * true | Object.new # => true
+ * true | false # => true
+ * true | nil # => true
*
- * <em>produces:</em>
+ * Argument +object+ is evaluated.
+ * This is different from +true+ with the short-circuit operator,
+ * whose operand is evaluated only if necessary:
+ *
+ * true | raise # => Raises RuntimeError.
+ * true || raise # => true
*
- * or
*/
static VALUE
@@ -1364,11 +1629,14 @@ true_or(VALUE obj, VALUE obj2)
/*
* call-seq:
- * true ^ obj -> !obj
+ * true ^ object -> !object
+ *
+ * Returns +true+ if +object+ is +false+ or +nil+, +false+ otherwise:
+ *
+ * true ^ Object.new # => false
+ * true ^ false # => true
+ * true ^ nil # => true
*
- * Exclusive Or---Returns <code>true</code> if <i>obj</i> is
- * <code>nil</code> or <code>false</code>, <code>false</code>
- * otherwise.
*/
static VALUE
@@ -1395,22 +1663,27 @@ true_xor(VALUE obj, VALUE obj2)
* The string representation of <code>false</code> is "false".
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_false_to_s(VALUE obj)
{
return rb_cFalseClass_to_s;
}
/*
- * call-seq:
- * false & obj -> false
- * nil & obj -> false
+ * call-seq:
+ * false & object -> false
+ * nil & object -> false
+ *
+ * Returns +false+:
+ *
+ * false & true # => false
+ * false & Object.new # => false
+ *
+ * Argument +object+ is evaluated:
+ *
+ * false & raise # Raises RuntimeError.
*
- * And---Returns <code>false</code>. <i>obj</i> is always
- * evaluated as it is the argument to a method call---there is no
- * short-circuit evaluation in this case.
*/
-
static VALUE
false_and(VALUE obj, VALUE obj2)
{
@@ -1419,24 +1692,30 @@ false_and(VALUE obj, VALUE obj2)
/*
- * call-seq:
- * false | obj -> true or false
- * nil | obj -> true or false
+ * call-seq:
+ * false | object -> true or false
+ * nil | object -> true or false
+ *
+ * Returns +false+ if +object+ is +nil+ or +false+, +true+ otherwise:
+ *
+ * nil | nil # => false
+ * nil | false # => false
+ * nil | Object.new # => true
*
- * Or---Returns <code>false</code> if <i>obj</i> is
- * <code>nil</code> or <code>false</code>; <code>true</code> otherwise.
*/
#define false_or true_and
/*
- * call-seq:
- * false ^ obj -> true or false
- * nil ^ obj -> true or false
+ * call-seq:
+ * false ^ object -> true or false
+ * nil ^ object -> true or false
*
- * Exclusive Or---If <i>obj</i> is <code>nil</code> or
- * <code>false</code>, returns <code>false</code>; otherwise, returns
- * <code>true</code>.
+ * Returns +false+ if +object+ is +nil+ or +false+, +true+ otherwise:
+ *
+ * nil ^ nil # => false
+ * nil ^ false # => false
+ * nil ^ Object.new # => true
*
*/
@@ -1444,9 +1723,10 @@ false_and(VALUE obj, VALUE obj2)
/*
* call-seq:
- * nil.nil? -> true
+ * nil.nil? -> true
*
- * Only the object <i>nil</i> responds <code>true</code> to <code>nil?</code>.
+ * Returns +true+.
+ * For all other objects, method <tt>nil?</tt> returns +false+.
*/
static VALUE
@@ -1466,7 +1746,7 @@ rb_true(VALUE obj)
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_false(VALUE obj)
{
return Qfalse;
@@ -1490,27 +1770,39 @@ rb_obj_not_match(VALUE obj1, VALUE obj2)
/*
* call-seq:
- * obj <=> other -> 0 or nil
+ * self <=> other -> 0 or nil
+ *
+ * Compares +self+ and +other+.
*
- * Returns 0 if +obj+ and +other+ are the same object
- * or <code>obj == other</code>, otherwise nil.
+ * Returns:
*
- * The #<=> is used by various methods to compare objects, for example
- * Enumerable#sort, Enumerable#max etc.
+ * - +0+, if +self+ and +other+ are the same object,
+ * or if <tt>self == other</tt>.
+ * - +nil+, otherwise.
+ *
+ * Examples:
*
- * Your implementation of #<=> should return one of the following values: -1, 0,
- * 1 or nil. -1 means self is smaller than other. 0 means self is equal to other.
- * 1 means self is bigger than other. Nil means the two values could not be
- * compared.
+ * o = Object.new
+ * o <=> o # => 0
+ * o <=> o.dup # => nil
+ *
+ * A class that includes module Comparable
+ * should override this method by defining an instance method that:
+ *
+ * - Take one argument, +other+.
+ * - Returns:
+ *
+ * - +-1+, if +self+ is less than +other+.
+ * - +0+, if +self+ is equal to +other+.
+ * - +1+, if +self+ is greater than +other+.
+ * - +nil+, if the two values are incommensurate.
*
- * When you define #<=>, you can include Comparable to gain the
- * methods #<=, #<, #==, #>=, #> and #between?.
*/
static VALUE
rb_obj_cmp(VALUE obj1, VALUE obj2)
{
if (rb_equal(obj1, obj2))
- return INT2FIX(0);
+ return INT2FIX(0);
return Qnil;
}
@@ -1551,37 +1843,37 @@ rb_obj_cmp(VALUE obj1, VALUE obj2)
* show information on the thing we're attached to as well.
*/
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_mod_to_s(VALUE klass)
{
ID id_defined_at;
VALUE refined_class, defined_at;
- if (FL_TEST(klass, FL_SINGLETON)) {
- VALUE s = rb_usascii_str_new2("#<Class:");
- VALUE v = rb_ivar_get(klass, id__attached__);
+ if (RCLASS_SINGLETON_P(klass)) {
+ VALUE s = rb_usascii_str_new2("#<Class:");
+ VALUE v = RCLASS_ATTACHED_OBJECT(klass);
- if (CLASS_OR_MODULE_P(v)) {
- rb_str_append(s, rb_inspect(v));
- }
- else {
- rb_str_append(s, rb_any_to_s(v));
- }
- rb_str_cat2(s, ">");
+ if (CLASS_OR_MODULE_P(v)) {
+ rb_str_append(s, rb_inspect(v));
+ }
+ else {
+ rb_str_append(s, rb_any_to_s(v));
+ }
+ rb_str_cat2(s, ">");
- return s;
+ return s;
}
refined_class = rb_refinement_module_get_refined_class(klass);
if (!NIL_P(refined_class)) {
- VALUE s = rb_usascii_str_new2("#<refinement:");
-
- rb_str_concat(s, rb_inspect(refined_class));
- rb_str_cat2(s, "@");
- CONST_ID(id_defined_at, "__defined_at__");
- defined_at = rb_attr_get(klass, id_defined_at);
- rb_str_concat(s, rb_inspect(defined_at));
- rb_str_cat2(s, ">");
- return s;
+ VALUE s = rb_usascii_str_new2("#<refinement:");
+
+ rb_str_concat(s, rb_inspect(refined_class));
+ rb_str_cat2(s, "@");
+ CONST_ID(id_defined_at, "__defined_at__");
+ defined_at = rb_attr_get(klass, id_defined_at);
+ rb_str_concat(s, rb_inspect(defined_at));
+ rb_str_cat2(s, ">");
+ return s;
}
return rb_class_name(klass);
}
@@ -1604,11 +1896,12 @@ rb_mod_freeze(VALUE mod)
/*
* call-seq:
- * mod === obj -> true or false
+ * self === other -> true or false
*
- * Case Equality---Returns <code>true</code> if <i>obj</i> is an
- * instance of <i>mod</i> or an instance of one of <i>mod</i>'s descendants.
- * Of limited use for modules, but can be used in <code>case</code> statements
+ * Returns whether +other+ is an instance of +self+,
+ * or is an instance of a subclass of +self+.
+ *
+ * Of limited use for modules, but can be used in +case+ statements
* to classify objects by class.
*/
@@ -1622,11 +1915,24 @@ rb_mod_eqq(VALUE mod, VALUE arg)
* call-seq:
* mod <= other -> true, false, or nil
*
- * Returns true if <i>mod</i> is a subclass of <i>other</i> or
- * is the same as <i>other</i>. Returns
- * <code>nil</code> if there's no relationship between the two.
- * (Think of the relationship in terms of the class definition:
- * "class A < B" implies "A < B".)
+ * Returns +true+ if +self+ is a descendant of +other+
+ * (+self+ is a subclass of +other+ or +self+ includes +other+) or
+ * if +self+ is the same as +other+:
+ *
+ * Float <= Numeric # => true
+ * Array <= Enumerable # => true
+ * Float <= Float # => true
+ *
+ * Returns +false+ if +self+ is an ancestor of +other+
+ * (+self+ is a superclass of +other+ or +self+ is included in +other+):
+ *
+ * Numeric <= Float # => false
+ * Enumerable <= Array # => false
+ *
+ * Returns +nil+ if there is no relationship between the two:
+ *
+ * Float <= Hash # => nil
+ * Enumerable <= String # => nil
*/
VALUE
@@ -1643,16 +1949,19 @@ rb_class_inherited_p(VALUE mod, VALUE arg)
return RCLASS_SUPERCLASSES(mod)[arg_depth] == arg ?
Qtrue :
Qnil;
- } else if (arg_depth > mod_depth) {
+ }
+ else if (arg_depth > mod_depth) {
// check if mod > arg
return RCLASS_SUPERCLASSES(arg)[mod_depth] == mod ?
Qfalse :
Qnil;
- } else {
+ }
+ else {
// Depths match, and we know they aren't equal: no relation
return Qnil;
}
- } else {
+ }
+ else {
if (!CLASS_OR_MODULE_P(arg) && !RB_TYPE_P(arg, T_ICLASS)) {
rb_raise(rb_eTypeError, "compared with non class/module");
}
@@ -1669,14 +1978,26 @@ rb_class_inherited_p(VALUE mod, VALUE arg)
/*
* call-seq:
- * mod < other -> true, false, or nil
+ * self < other -> true, false, or nil
+ *
+ * Returns +true+ if +self+ is a descendant of +other+
+ * (+self+ is a subclass of +other+ or +self+ includes +other+):
+ *
+ * Float < Numeric # => true
+ * Array < Enumerable # => true
+ *
+ * Returns +false+ if +self+ is an ancestor of +other+
+ * (+self+ is a superclass of +other+ or +self+ is included in +other+) or
+ * if +self+ is the same as +other+:
*
- * Returns true if <i>mod</i> is a subclass of <i>other</i>. Returns
- * <code>false</code> if <i>mod</i> is the same as <i>other</i>
- * or <i>mod</i> is an ancestor of <i>other</i>.
- * Returns <code>nil</code> if there's no relationship between the two.
- * (Think of the relationship in terms of the class definition:
- * "class A < B" implies "A < B".)
+ * Numeric < Float # => false
+ * Enumerable < Array # => false
+ * Float < Float # => false
+ *
+ * Returns +nil+ if there is no relationship between the two:
+ *
+ * Float < Hash # => nil
+ * Enumerable < String # => nil
*
*/
@@ -1692,11 +2013,24 @@ rb_mod_lt(VALUE mod, VALUE arg)
* call-seq:
* mod >= other -> true, false, or nil
*
- * Returns true if <i>mod</i> is an ancestor of <i>other</i>, or the
- * two modules are the same. Returns
- * <code>nil</code> if there's no relationship between the two.
- * (Think of the relationship in terms of the class definition:
- * "class A < B" implies "B > A".)
+ * Returns +true+ if +self+ is an ancestor of +other+
+ * (+self+ is a superclass of +other+ or +self+ is included in +other+) or
+ * if +self+ is the same as +other+:
+ *
+ * Numeric >= Float # => true
+ * Enumerable >= Array # => true
+ * Float >= Float # => true
+ *
+ * Returns +false+ if +self+ is a descendant of +other+
+ * (+self+ is a subclass of +other+ or +self+ includes +other+):
+ *
+ * Float >= Numeric # => false
+ * Array >= Enumerable # => false
+ *
+ * Returns +nil+ if there is no relationship between the two:
+ *
+ * Float >= Hash # => nil
+ * Enumerable >= String # => nil
*
*/
@@ -1704,7 +2038,7 @@ static VALUE
rb_mod_ge(VALUE mod, VALUE arg)
{
if (!CLASS_OR_MODULE_P(arg)) {
- rb_raise(rb_eTypeError, "compared with non class/module");
+ rb_raise(rb_eTypeError, "compared with non class/module");
}
return rb_class_inherited_p(arg, mod);
@@ -1712,14 +2046,26 @@ rb_mod_ge(VALUE mod, VALUE arg)
/*
* call-seq:
- * mod > other -> true, false, or nil
+ * self > other -> true, false, or nil
+ *
+ * Returns +true+ if +self+ is an ancestor of +other+
+ * (+self+ is a superclass of +other+ or +self+ is included in +other+):
*
- * Returns true if <i>mod</i> is an ancestor of <i>other</i>. Returns
- * <code>false</code> if <i>mod</i> is the same as <i>other</i>
- * or <i>mod</i> is a descendant of <i>other</i>.
- * Returns <code>nil</code> if there's no relationship between the two.
- * (Think of the relationship in terms of the class definition:
- * "class A < B" implies "B > A".)
+ * Numeric > Float # => true
+ * Enumerable > Array # => true
+ *
+ * Returns +false+ if +self+ is a descendant of +other+
+ * (+self+ is a subclass of +other+ or +self+ includes +other+) or
+ * if +self+ is the same as +other+:
+ *
+ * Float > Numeric # => false
+ * Array > Enumerable # => false
+ * Float > Float # => false
+ *
+ * Returns +nil+ if there is no relationship between the two:
+ *
+ * Float > Hash # => nil
+ * Enumerable > String # => nil
*
*/
@@ -1732,14 +2078,30 @@ rb_mod_gt(VALUE mod, VALUE arg)
/*
* call-seq:
- * module <=> other_module -> -1, 0, +1, or nil
+ * self <=> other -> -1, 0, 1, or nil
+ *
+ * Compares +self+ and +other+.
+ *
+ * Returns:
+ *
+ * - +-1+, if +self+ includes +other+, if or +self+ is a subclass of +other+.
+ * - +0+, if +self+ and +other+ are the same.
+ * - +1+, if +other+ includes +self+, or if +other+ is a subclass of +self+.
+ * - +nil+, if none of the above is true.
*
- * Comparison---Returns -1, 0, +1 or nil depending on whether +module+
- * includes +other_module+, they are the same, or if +module+ is included by
- * +other_module+.
+ * Examples:
+ *
+ * # Class Array includes module Enumerable.
+ * Array <=> Enumerable # => -1
+ * Enumerable <=> Enumerable # => 0
+ * Enumerable <=> Array # => 1
+ * # Class File is a subclass of class IO.
+ * File <=> IO # => -1
+ * File <=> File # => 0
+ * IO <=> File # => 1
+ * # Class File has no relationship to class String.
+ * File <=> String # => nil
*
- * Returns +nil+ if +module+ has no relationship with +other_module+, if
- * +other_module+ is not a module, or if the two values are incomparable.
*/
static VALUE
@@ -1749,13 +2111,13 @@ rb_mod_cmp(VALUE mod, VALUE arg)
if (mod == arg) return INT2FIX(0);
if (!CLASS_OR_MODULE_P(arg)) {
- return Qnil;
+ return Qnil;
}
cmp = rb_class_inherited_p(mod, arg);
if (NIL_P(cmp)) return Qnil;
if (cmp) {
- return INT2FIX(-1);
+ return INT2FIX(-1);
}
return INT2FIX(1);
}
@@ -1798,7 +2160,7 @@ static VALUE
rb_mod_initialize_exec(VALUE module)
{
if (rb_block_given_p()) {
- rb_mod_module_exec(1, &module, module);
+ rb_mod_module_exec(1, &module, module);
}
return Qnil;
}
@@ -1851,19 +2213,19 @@ rb_class_initialize(int argc, VALUE *argv, VALUE klass)
VALUE super;
if (RCLASS_SUPER(klass) != 0 || klass == rb_cBasicObject) {
- rb_raise(rb_eTypeError, "already initialized class");
+ rb_raise(rb_eTypeError, "already initialized class");
}
if (rb_check_arity(argc, 0, 1) == 0) {
- super = rb_cObject;
+ super = rb_cObject;
}
else {
super = argv[0];
- rb_check_inheritable(super);
- if (super != rb_cBasicObject && !RCLASS_SUPER(super)) {
- rb_raise(rb_eTypeError, "can't inherit uninitialized class");
- }
+ rb_check_inheritable(super);
+ if (!RCLASS_INITIALIZED_P(super)) {
+ rb_raise(rb_eTypeError, "can't inherit uninitialized class");
+ }
}
- RCLASS_SET_SUPER(klass, super);
+ rb_class_set_super(klass, super);
rb_make_metaclass(klass, RBASIC(super)->klass);
rb_class_inherited(super, klass);
rb_mod_initialize_exec(klass);
@@ -1876,7 +2238,7 @@ void
rb_undefined_alloc(VALUE klass)
{
rb_raise(rb_eTypeError, "allocator undefined for %"PRIsVALUE,
- klass);
+ klass);
}
static rb_alloc_func_t class_get_alloc_func(VALUE klass);
@@ -1905,17 +2267,6 @@ static VALUE class_call_alloc_func(rb_alloc_func_t allocator, VALUE klass);
*/
static VALUE
-rb_class_alloc_m(VALUE klass)
-{
- rb_alloc_func_t allocator = class_get_alloc_func(klass);
- if (!rb_obj_respond_to(klass, rb_intern("allocate"), 1)) {
- rb_raise(rb_eTypeError, "calling %"PRIsVALUE".allocate is prohibited",
- klass);
- }
- return class_call_alloc_func(allocator, klass);
-}
-
-static VALUE
rb_class_alloc(VALUE klass)
{
rb_alloc_func_t allocator = class_get_alloc_func(klass);
@@ -1927,19 +2278,28 @@ class_get_alloc_func(VALUE klass)
{
rb_alloc_func_t allocator;
- if (RCLASS_SUPER(klass) == 0 && klass != rb_cBasicObject) {
- rb_raise(rb_eTypeError, "can't instantiate uninitialized class");
+ if (!RCLASS_INITIALIZED_P(klass)) {
+ rb_raise(rb_eTypeError, "can't instantiate uninitialized class");
}
- if (FL_TEST(klass, FL_SINGLETON)) {
- rb_raise(rb_eTypeError, "can't create instance of singleton class");
+ if (RCLASS_SINGLETON_P(klass)) {
+ rb_raise(rb_eTypeError, "can't create instance of singleton class");
}
allocator = rb_get_alloc_func(klass);
if (!allocator) {
- rb_undefined_alloc(klass);
+ rb_undefined_alloc(klass);
}
return allocator;
}
+// Might return NULL.
+rb_alloc_func_t
+rb_zjit_class_get_alloc_func(VALUE klass)
+{
+ assert(RCLASS_INITIALIZED_P(klass));
+ assert(!RCLASS_SINGLETON_P(klass));
+ return rb_get_alloc_func(klass);
+}
+
static VALUE
class_call_alloc_func(rb_alloc_func_t allocator, VALUE klass)
{
@@ -1949,8 +2309,10 @@ class_call_alloc_func(rb_alloc_func_t allocator, VALUE klass)
obj = (*allocator)(klass);
- if (rb_obj_class(obj) != rb_class_real(klass)) {
- rb_raise(rb_eTypeError, "wrong instance allocation");
+ if (UNLIKELY(RBASIC_CLASS(obj) != klass)) {
+ if (rb_obj_class(obj) != rb_class_real(klass)) {
+ rb_raise(rb_eTypeError, "wrong instance allocation");
+ }
}
return obj;
}
@@ -1999,13 +2361,7 @@ rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat)
VALUE
rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
{
- VALUE obj;
- Check_Type(klass, T_CLASS);
-
- obj = rb_class_alloc(klass);
- rb_obj_call_init_kw(obj, argc, argv, RB_NO_KEYWORDS);
-
- return obj;
+ return rb_class_new_instance_kw(argc, argv, klass, RB_NO_KEYWORDS);
}
/**
@@ -2026,12 +2382,12 @@ rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
* BasicObject.superclass #=> nil
*
*--
- * Returns the superclass of \a klass. Equivalent to \c Class\#superclass in Ruby.
+ * Returns the superclass of `klass`. Equivalent to `Class#superclass` in Ruby.
*
* It skips modules.
- * \param[in] klass a Class object
- * \return the superclass, or \c Qnil if \a klass does not have a parent class.
- * \sa rb_class_get_superclass
+ * @param[in] klass a Class object
+ * @return the superclass, or `Qnil` if `klass` does not have a parent class.
+ * @sa rb_class_get_superclass
*++
*/
@@ -2040,14 +2396,22 @@ rb_class_superclass(VALUE klass)
{
RUBY_ASSERT(RB_TYPE_P(klass, T_CLASS));
- VALUE super = RCLASS_SUPER(klass);
+ VALUE *superclasses = RCLASS_SUPERCLASSES(klass);
+ size_t superclasses_depth = RCLASS_SUPERCLASS_DEPTH(klass);
+
+ if (klass == rb_cBasicObject) return Qnil;
- if (!super) {
- if (klass == rb_cBasicObject) return Qnil;
- rb_raise(rb_eTypeError, "uninitialized class");
- } else {
- super = RCLASS_SUPERCLASSES(klass)[RCLASS_SUPERCLASS_DEPTH(klass) - 1];
- RUBY_ASSERT(RB_TYPE_P(klass, T_CLASS));
+ if (!superclasses) {
+ RUBY_ASSERT(!RCLASS_SUPER(klass));
+ rb_raise(rb_eTypeError, "uninitialized class");
+ }
+
+ if (!superclasses_depth) {
+ return Qnil;
+ }
+ else {
+ VALUE super = superclasses[superclasses_depth - 1];
+ RUBY_ASSERT(RB_TYPE_P(super, T_CLASS));
return super;
}
}
@@ -2055,13 +2419,13 @@ rb_class_superclass(VALUE klass)
VALUE
rb_class_get_superclass(VALUE klass)
{
- return RCLASS(klass)->super;
+ return RCLASS_SUPER(klass);
}
-static const char bad_instance_name[] = "`%1$s' is not allowed as an instance variable name";
-static const char bad_class_name[] = "`%1$s' is not allowed as a class variable name";
+static const char bad_instance_name[] = "'%1$s' is not allowed as an instance variable name";
+static const char bad_class_name[] = "'%1$s' is not allowed as a class variable name";
static const char bad_const_name[] = "wrong constant name %1$s";
-static const char bad_attr_name[] = "invalid attribute name `%1$s'";
+static const char bad_attr_name[] = "invalid attribute name '%1$s'";
#define wrong_constant_name bad_const_name
/*! \private */
@@ -2071,15 +2435,15 @@ static const char bad_attr_name[] = "invalid attribute name `%1$s'";
check_setter_id(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))
static ID
check_setter_id(VALUE obj, VALUE *pname,
- int (*valid_id_p)(ID), int (*valid_name_p)(VALUE),
- const char *message, size_t message_len)
+ int (*valid_id_p)(ID), int (*valid_name_p)(VALUE),
+ const char *message, size_t message_len)
{
ID id = rb_check_id(pname);
VALUE name = *pname;
if (id ? !valid_id_p(id) : !valid_name_p(name)) {
- rb_name_err_raise_str(rb_fstring_new(message, message_len),
- obj, name);
+ rb_name_err_raise_str(rb_fstring_new(message, message_len),
+ obj, name);
}
return id;
}
@@ -2125,9 +2489,9 @@ rb_mod_attr_reader(int argc, VALUE *argv, VALUE klass)
VALUE names = rb_ary_new2(argc);
for (i=0; i<argc; i++) {
- ID id = id_for_attr(klass, argv[i]);
- rb_attr(klass, id, TRUE, FALSE, TRUE);
- rb_ary_push(names, ID2SYM(id));
+ ID id = id_for_attr(klass, argv[i]);
+ rb_attr(klass, id, TRUE, FALSE, TRUE);
+ rb_ary_push(names, ID2SYM(id));
}
return names;
}
@@ -2151,14 +2515,14 @@ VALUE
rb_mod_attr(int argc, VALUE *argv, VALUE klass)
{
if (argc == 2 && (argv[1] == Qtrue || argv[1] == Qfalse)) {
- ID id = id_for_attr(klass, argv[0]);
- VALUE names = rb_ary_new();
-
- rb_category_warning(RB_WARN_CATEGORY_DEPRECATED, "optional boolean argument is obsoleted");
- rb_attr(klass, id, 1, RTEST(argv[1]), TRUE);
- rb_ary_push(names, ID2SYM(id));
- if (argv[1] == Qtrue) rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
- return names;
+ ID id = id_for_attr(klass, argv[0]);
+ VALUE names = rb_ary_new();
+
+ rb_category_warning(RB_WARN_CATEGORY_DEPRECATED, "optional boolean argument is obsoleted");
+ rb_attr(klass, id, 1, RTEST(argv[1]), TRUE);
+ rb_ary_push(names, ID2SYM(id));
+ if (argv[1] == Qtrue) rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
+ return names;
}
return rb_mod_attr_reader(argc, argv, klass);
}
@@ -2181,9 +2545,9 @@ rb_mod_attr_writer(int argc, VALUE *argv, VALUE klass)
VALUE names = rb_ary_new2(argc);
for (i=0; i<argc; i++) {
- ID id = id_for_attr(klass, argv[i]);
- rb_attr(klass, id, FALSE, TRUE, TRUE);
- rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
+ ID id = id_for_attr(klass, argv[i]);
+ rb_attr(klass, id, FALSE, TRUE, TRUE);
+ rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
}
return names;
}
@@ -2213,11 +2577,11 @@ rb_mod_attr_accessor(int argc, VALUE *argv, VALUE klass)
VALUE names = rb_ary_new2(argc * 2);
for (i=0; i<argc; i++) {
- ID id = id_for_attr(klass, argv[i]);
+ ID id = id_for_attr(klass, argv[i]);
- rb_attr(klass, id, TRUE, TRUE, TRUE);
- rb_ary_push(names, ID2SYM(id));
- rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
+ rb_attr(klass, id, TRUE, TRUE, TRUE);
+ rb_ary_push(names, ID2SYM(id));
+ rb_ary_push(names, ID2SYM(rb_id_attrset(id)));
}
return names;
}
@@ -2275,17 +2639,17 @@ rb_mod_const_get(int argc, VALUE *argv, VALUE mod)
recur = (argc == 1) ? Qtrue : argv[1];
if (SYMBOL_P(name)) {
- if (!rb_is_const_sym(name)) goto wrong_name;
- id = rb_check_id(&name);
- if (!id) return rb_const_missing(mod, name);
- return RTEST(recur) ? rb_const_get(mod, id) : rb_const_get_at(mod, id);
+ if (!rb_is_const_sym(name)) goto wrong_name;
+ id = rb_check_id(&name);
+ if (!id) return rb_const_missing(mod, name);
+ return RTEST(recur) ? rb_const_get(mod, id) : rb_const_get_at(mod, id);
}
path = StringValuePtr(name);
enc = rb_enc_get(name);
if (!rb_enc_asciicompat(enc)) {
- rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
+ rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
}
pbeg = p = path;
@@ -2296,53 +2660,53 @@ rb_mod_const_get(int argc, VALUE *argv, VALUE mod)
}
if (p + 2 < pend && p[0] == ':' && p[1] == ':') {
- mod = rb_cObject;
- p += 2;
- pbeg = p;
+ mod = rb_cObject;
+ p += 2;
+ pbeg = p;
}
while (p < pend) {
- VALUE part;
- long len, beglen;
-
- while (p < pend && *p != ':') p++;
-
- if (pbeg == p) goto wrong_name;
-
- id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
- beglen = pbeg-path;
-
- if (p < pend && p[0] == ':') {
- if (p + 2 >= pend || p[1] != ':') goto wrong_name;
- p += 2;
- pbeg = p;
- }
-
- if (!RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
- rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
- QUOTE(name));
- }
-
- if (!id) {
- part = rb_str_subseq(name, beglen, len);
- OBJ_FREEZE(part);
- if (!rb_is_const_name(part)) {
- name = part;
- goto wrong_name;
- }
- else if (!rb_method_basic_definition_p(CLASS_OF(mod), id_const_missing)) {
- part = rb_str_intern(part);
- mod = rb_const_missing(mod, part);
- continue;
- }
- else {
- rb_mod_const_missing(mod, part);
- }
- }
- if (!rb_is_const_id(id)) {
- name = ID2SYM(id);
- goto wrong_name;
- }
+ VALUE part;
+ long len, beglen;
+
+ while (p < pend && *p != ':') p++;
+
+ if (pbeg == p) goto wrong_name;
+
+ id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
+ beglen = pbeg-path;
+
+ if (p < pend && p[0] == ':') {
+ if (p + 2 >= pend || p[1] != ':') goto wrong_name;
+ p += 2;
+ pbeg = p;
+ }
+
+ if (!RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
+ rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
+ QUOTE(name));
+ }
+
+ if (!id) {
+ part = rb_str_subseq(name, beglen, len);
+ OBJ_FREEZE(part);
+ if (!rb_is_const_name(part)) {
+ name = part;
+ goto wrong_name;
+ }
+ else if (!rb_method_basic_definition_p(CLASS_OF(mod), id_const_missing)) {
+ part = rb_str_intern(part);
+ mod = rb_const_missing(mod, part);
+ continue;
+ }
+ else {
+ rb_mod_const_missing(mod, part);
+ }
+ }
+ if (!rb_is_const_id(id)) {
+ name = ID2SYM(id);
+ goto wrong_name;
+ }
#if 0
mod = rb_const_get_0(mod, id, beglen > 0 || !RTEST(recur), RTEST(recur), FALSE);
#else
@@ -2448,17 +2812,17 @@ rb_mod_const_defined(int argc, VALUE *argv, VALUE mod)
recur = (argc == 1) ? Qtrue : argv[1];
if (SYMBOL_P(name)) {
- if (!rb_is_const_sym(name)) goto wrong_name;
- id = rb_check_id(&name);
- if (!id) return Qfalse;
- return RTEST(recur) ? rb_const_defined(mod, id) : rb_const_defined_at(mod, id);
+ if (!rb_is_const_sym(name)) goto wrong_name;
+ id = rb_check_id(&name);
+ if (!id) return Qfalse;
+ return RTEST(recur) ? rb_const_defined(mod, id) : rb_const_defined_at(mod, id);
}
path = StringValuePtr(name);
enc = rb_enc_get(name);
if (!rb_enc_asciicompat(enc)) {
- rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
+ rb_raise(rb_eArgError, "invalid class path encoding (non ASCII)");
}
pbeg = p = path;
@@ -2469,54 +2833,54 @@ rb_mod_const_defined(int argc, VALUE *argv, VALUE mod)
}
if (p + 2 < pend && p[0] == ':' && p[1] == ':') {
- mod = rb_cObject;
- p += 2;
- pbeg = p;
+ mod = rb_cObject;
+ p += 2;
+ pbeg = p;
}
while (p < pend) {
- VALUE part;
- long len, beglen;
-
- while (p < pend && *p != ':') p++;
-
- if (pbeg == p) goto wrong_name;
-
- id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
- beglen = pbeg-path;
-
- if (p < pend && p[0] == ':') {
- if (p + 2 >= pend || p[1] != ':') goto wrong_name;
- p += 2;
- pbeg = p;
- }
-
- if (!id) {
- part = rb_str_subseq(name, beglen, len);
- OBJ_FREEZE(part);
- if (!rb_is_const_name(part)) {
- name = part;
- goto wrong_name;
- }
- else {
- return Qfalse;
- }
- }
- if (!rb_is_const_id(id)) {
- name = ID2SYM(id);
- goto wrong_name;
- }
+ VALUE part;
+ long len, beglen;
+
+ while (p < pend && *p != ':') p++;
+
+ if (pbeg == p) goto wrong_name;
+
+ id = rb_check_id_cstr(pbeg, len = p-pbeg, enc);
+ beglen = pbeg-path;
+
+ if (p < pend && p[0] == ':') {
+ if (p + 2 >= pend || p[1] != ':') goto wrong_name;
+ p += 2;
+ pbeg = p;
+ }
+
+ if (!id) {
+ part = rb_str_subseq(name, beglen, len);
+ OBJ_FREEZE(part);
+ if (!rb_is_const_name(part)) {
+ name = part;
+ goto wrong_name;
+ }
+ else {
+ return Qfalse;
+ }
+ }
+ if (!rb_is_const_id(id)) {
+ name = ID2SYM(id);
+ goto wrong_name;
+ }
#if 0
mod = rb_const_search(mod, id, beglen > 0 || !RTEST(recur), RTEST(recur), FALSE);
- if (mod == Qundef) return Qfalse;
+ if (UNDEF_P(mod)) return Qfalse;
#else
if (!RTEST(recur)) {
- if (!rb_const_defined_at(mod, id))
- return Qfalse;
+ if (!rb_const_defined_at(mod, id))
+ return Qfalse;
if (p == pend) return Qtrue;
- mod = rb_const_get_at(mod, id);
- }
+ mod = rb_const_get_at(mod, id);
+ }
else if (beglen == 0) {
if (!rb_const_defined(mod, id))
return Qfalse;
@@ -2531,10 +2895,10 @@ rb_mod_const_defined(int argc, VALUE *argv, VALUE mod)
}
#endif
- if (p < pend && !RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
- rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
- QUOTE(name));
- }
+ if (p < pend && !RB_TYPE_P(mod, T_MODULE) && !RB_TYPE_P(mod, T_CLASS)) {
+ rb_raise(rb_eTypeError, "%"PRIsVALUE" does not refer to class/module",
+ QUOTE(name));
+ }
}
return Qtrue;
@@ -2725,7 +3089,7 @@ rb_obj_ivar_get(VALUE obj, VALUE iv)
ID id = id_for_var(obj, iv, instance);
if (!id) {
- return Qnil;
+ return Qnil;
}
return rb_ivar_get(obj, id);
}
@@ -2754,7 +3118,7 @@ rb_obj_ivar_get(VALUE obj, VALUE iv)
*/
static VALUE
-rb_obj_ivar_set(VALUE obj, VALUE iv, VALUE val)
+rb_obj_ivar_set_m(VALUE obj, VALUE iv, VALUE val)
{
ID id = id_for_var(obj, iv, instance);
if (!id) id = rb_intern_str(iv);
@@ -2787,7 +3151,7 @@ rb_obj_ivar_defined(VALUE obj, VALUE iv)
ID id = id_for_var(obj, iv, instance);
if (!id) {
- return Qfalse;
+ return Qfalse;
}
return rb_ivar_defined(obj, id);
}
@@ -2814,8 +3178,8 @@ rb_mod_cvar_get(VALUE obj, VALUE iv)
ID id = id_for_var(obj, iv, class);
if (!id) {
- rb_name_err_raise("uninitialized class variable %1$s in %2$s",
- obj, iv);
+ rb_name_err_raise("uninitialized class variable %1$s in %2$s",
+ obj, iv);
}
return rb_cvar_get(obj, id);
}
@@ -2871,7 +3235,7 @@ rb_mod_cvar_defined(VALUE obj, VALUE iv)
ID id = id_for_var(obj, iv, class);
if (!id) {
- return Qfalse;
+ return Qfalse;
}
return rb_cvar_defined(obj, id);
}
@@ -2892,7 +3256,7 @@ rb_mod_cvar_defined(VALUE obj, VALUE iv)
static VALUE
rb_mod_singleton_p(VALUE klass)
{
- return RBOOL(RB_TYPE_P(klass, T_CLASS) && FL_TEST(klass, FL_SINGLETON));
+ return RBOOL(RCLASS_SINGLETON_P(klass));
}
/*! \private */
@@ -2923,14 +3287,14 @@ conv_method_index(const char *method)
static const char prefix[] = "to_";
if (strncmp(prefix, method, sizeof(prefix)-1) == 0) {
- const char *const meth = &method[sizeof(prefix)-1];
- int i;
- for (i=0; i < numberof(conv_method_names); i++) {
- if (conv_method_names[i].method[0] == meth[0] &&
- strcmp(conv_method_names[i].method, meth) == 0) {
- return i;
- }
- }
+ const char *const meth = &method[sizeof(prefix)-1];
+ int i;
+ for (i=0; i < numberof(conv_method_names); i++) {
+ if (conv_method_names[i].method[0] == meth[0] &&
+ strcmp(conv_method_names[i].method, meth) == 0) {
+ return i;
+ }
+ }
}
return numberof(conv_method_names);
}
@@ -2939,23 +3303,23 @@ static VALUE
convert_type_with_id(VALUE val, const char *tname, ID method, int raise, int index)
{
VALUE r = rb_check_funcall(val, method, 0, 0);
- if (r == Qundef) {
- if (raise) {
- const char *msg =
- ((index < 0 ? conv_method_index(rb_id2name(method)) : index)
- < IMPLICIT_CONVERSIONS) ?
- "no implicit conversion of" : "can't convert";
- const char *cname = NIL_P(val) ? "nil" :
- val == Qtrue ? "true" :
- val == Qfalse ? "false" :
- NULL;
- if (cname)
- rb_raise(rb_eTypeError, "%s %s into %s", msg, cname, tname);
- rb_raise(rb_eTypeError, "%s %"PRIsVALUE" into %s", msg,
- rb_obj_class(val),
- tname);
- }
- return Qnil;
+ if (UNDEF_P(r)) {
+ if (raise) {
+ const char *msg =
+ ((index < 0 ? conv_method_index(rb_id2name(method)) : index)
+ < IMPLICIT_CONVERSIONS) ?
+ "no implicit conversion of" : "can't convert";
+ const char *cname = NIL_P(val) ? "nil" :
+ val == Qtrue ? "true" :
+ val == Qfalse ? "false" :
+ NULL;
+ if (cname)
+ rb_raise(rb_eTypeError, "%s %s into %s", msg, cname, tname);
+ rb_raise(rb_eTypeError, "%s %"PRIsVALUE" into %s", msg,
+ rb_obj_class(val),
+ tname);
+ }
+ return Qnil;
}
return r;
}
@@ -2965,7 +3329,7 @@ convert_type(VALUE val, const char *tname, const char *method, int raise)
{
int i = conv_method_index(method);
ID m = i < numberof(conv_method_names) ?
- conv_method_names[i].id : rb_intern(method);
+ conv_method_names[i].id : rb_intern(method);
return convert_type_with_id(val, tname, m, raise, i);
}
@@ -2976,8 +3340,8 @@ conversion_mismatch(VALUE val, const char *tname, const char *method, VALUE resu
{
VALUE cname = rb_obj_class(val);
rb_raise(rb_eTypeError,
- "can't convert %"PRIsVALUE" to %s (%"PRIsVALUE"#%s gives %"PRIsVALUE")",
- cname, tname, cname, method, rb_obj_class(result));
+ "can't convert %"PRIsVALUE" to %s (%"PRIsVALUE"#%s gives %"PRIsVALUE")",
+ cname, tname, cname, method, rb_obj_class(result));
}
VALUE
@@ -2988,7 +3352,7 @@ rb_convert_type(VALUE val, int type, const char *tname, const char *method)
if (TYPE(val) == type) return val;
v = convert_type(val, tname, method, TRUE);
if (TYPE(v) != type) {
- conversion_mismatch(val, tname, method, v);
+ conversion_mismatch(val, tname, method, v);
}
return v;
}
@@ -3002,7 +3366,7 @@ rb_convert_type_with_id(VALUE val, int type, const char *tname, ID method)
if (TYPE(val) == type) return val;
v = convert_type_with_id(val, tname, method, TRUE, -1);
if (TYPE(v) != type) {
- conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
+ conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
}
return v;
}
@@ -3017,13 +3381,13 @@ rb_check_convert_type(VALUE val, int type, const char *tname, const char *method
v = convert_type(val, tname, method, FALSE);
if (NIL_P(v)) return Qnil;
if (TYPE(v) != type) {
- conversion_mismatch(val, tname, method, v);
+ conversion_mismatch(val, tname, method, v);
}
return v;
}
/*! \private */
-MJIT_FUNC_EXPORTED VALUE
+VALUE
rb_check_convert_type_with_id(VALUE val, int type, const char *tname, ID method)
{
VALUE v;
@@ -3033,7 +3397,7 @@ rb_check_convert_type_with_id(VALUE val, int type, const char *tname, ID method)
v = convert_type_with_id(val, tname, method, FALSE, -1);
if (NIL_P(v)) return Qnil;
if (TYPE(v) != type) {
- conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
+ conversion_mismatch(val, tname, RSTRING_PTR(rb_id2str(method)), v);
}
return v;
}
@@ -3046,14 +3410,22 @@ ALWAYS_INLINE(static VALUE rb_to_integer_with_id_exception(VALUE val, const char
static inline VALUE
rb_to_integer_with_id_exception(VALUE val, const char *method, ID mid, int raise)
{
+ // We need to pop the lazily pushed frame when not raising an exception.
+ rb_control_frame_t *current_cfp;
VALUE v;
if (RB_INTEGER_TYPE_P(val)) return val;
+ current_cfp = GET_EC()->cfp;
+ rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
v = try_to_int(val, mid, raise);
- if (!raise && NIL_P(v)) return Qnil;
+ if (!raise && NIL_P(v)) {
+ GET_EC()->cfp = current_cfp;
+ return Qnil;
+ }
if (!RB_INTEGER_TYPE_P(v)) {
conversion_mismatch(val, "Integer", method, v);
}
+ GET_EC()->cfp = current_cfp;
return v;
}
#define rb_to_integer(val, method, mid) \
@@ -3134,6 +3506,9 @@ rb_convert_to_integer(VALUE val, int base, int raise_exception)
tmp = rb_protect(rb_check_to_int, val, NULL);
if (RB_INTEGER_TYPE_P(tmp)) return tmp;
rb_set_errinfo(Qnil);
+ if (!NIL_P(tmp = rb_check_string_type(val))) {
+ return rb_str_convert_to_inum(tmp, base, TRUE, raise_exception);
+ }
if (!raise_exception) {
VALUE result = rb_protect(rb_check_to_i, val, NULL);
@@ -3157,16 +3532,22 @@ rb_check_integer_type(VALUE val)
}
int
-rb_bool_expected(VALUE obj, const char *flagname)
+rb_bool_expected(VALUE obj, const char *flagname, int raise)
{
switch (obj) {
- case Qtrue: case Qfalse:
- break;
- default:
- rb_raise(rb_eArgError, "expected true or false as %s: %+"PRIsVALUE,
- flagname, obj);
+ case Qtrue:
+ return TRUE;
+ case Qfalse:
+ return FALSE;
+ default: {
+ static const char message[] = "expected true or false as %s: %+"PRIsVALUE;
+ if (raise) {
+ rb_raise(rb_eArgError, message, flagname, obj);
+ }
+ rb_warning(message, flagname, obj);
+ return !NIL_P(obj);
+ }
}
- return obj != Qfalse;
}
int
@@ -3175,106 +3556,32 @@ rb_opts_exception_p(VALUE opts, int default_value)
static const ID kwds[1] = {idException};
VALUE exception;
if (rb_get_kwargs(opts, kwds, 0, 1, &exception))
- return rb_bool_expected(exception, "exception");
+ return rb_bool_expected(exception, "exception", TRUE);
return default_value;
}
-#define opts_exception_p(opts) rb_opts_exception_p((opts), TRUE)
-
-/*
- * call-seq:
- * Integer(object, base = 0, exception: true) -> integer or nil
- *
- * Returns an integer converted from +object+.
- *
- * Tries to convert +object+ to an integer
- * using +to_int+ first and +to_i+ second;
- * see below for exceptions.
- *
- * With integer argument +object+ given, returns +object+:
- *
- * Integer(1) # => 1
- * Integer(-1) # => -1
- *
- * With floating-point argument +object+ given,
- * returns +object+ truncated to an intger:
- *
- * Integer(1.9) # => 1 # Rounds toward zero.
- * Integer(-1.9) # => -1 # Rounds toward zero.
- *
- * With string argument +object+ and zero +base+ given,
- * returns +object+ converted to an integer in base 10:
- *
- * Integer('100') # => 100
- * Integer('-100') # => -100
- *
- * With +base+ zero, string +object+ may contain leading characters
- * to specify the actual base:
- *
- * Integer('0100') # => 64 # Leading '0' specifies base 8.
- * Integer('0b100') # => 4 # Leading '0b', specifies base 2.
- * Integer('0x100') # => 256 # Leading '0x' specifies base 16.
- *
- * With a non-zero +base+ (in range 2..36) given
- * (in which case +object+ must be a string),
- * returns +object+ converted to an integer in the given base:
- *
- * Integer('100', 2) # => 4
- * Integer('100', 8) # => 64
- * Integer('-100', 16) # => -256
- *
- * When converting strings, surrounding whitespace and embedded underscores
- * are allowed and ignored:
- *
- * Integer(' 100 ') # => 100
- * Integer('-1_0_0', 16) # => -256
- *
- * Examples with +object+ of various other classes:
- *
- * Integer(Rational(9, 10)) # => 0 # Rounds toward zero.
- * Integer(Complex(2, 0)) # => 2 # Imaginary part must be zero.
- * Integer(Time.now) # => 1650974042
- *
- * With optional keyword argument +exception+ given as +true+ (the default):
- *
- * - Raises TypeError if +object+ does not respond to +to_int+ or +to_i+.
- * - Raises TypeError if +object+ is +nil+.
- * - Raise ArgumentError if +object+ is an invalid string.
- *
- * With +exception+ given as +false+, an exception of any kind is suppressed
- * and +nil+ is returned.
- *
- */
-
static VALUE
-rb_f_integer(int argc, VALUE *argv, VALUE obj)
+rb_f_integer1(rb_execution_context_t *ec, VALUE obj, VALUE arg)
{
- VALUE arg = Qnil, opts = Qnil;
- int base = 0;
+ return rb_convert_to_integer(arg, 0, TRUE);
+}
- if (argc > 1) {
- int narg = 1;
- VALUE vbase = rb_check_to_int(argv[1]);
- if (!NIL_P(vbase)) {
- base = NUM2INT(vbase);
- narg = 2;
- }
- if (argc > narg) {
- VALUE hash = rb_check_hash_type(argv[argc-1]);
- if (!NIL_P(hash)) {
- opts = rb_extract_keywords(&hash);
- if (!hash) --argc;
- }
- }
- }
- rb_check_arity(argc, 1, 2);
- arg = argv[0];
+static VALUE
+rb_f_integer(rb_execution_context_t *ec, VALUE obj, VALUE arg, VALUE base, VALUE exception)
+{
+ int exc = rb_bool_expected(exception, "exception", TRUE);
+ return rb_convert_to_integer(arg, NUM2INT(base), exc);
+}
- return rb_convert_to_integer(arg, base, opts_exception_p(opts));
+static bool
+is_digit_char(unsigned char c, int base)
+{
+ int i = ruby_digit36_to_number_table[c];
+ return (i >= 0 && i < base);
}
static double
-rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
+rb_cstr_to_dbl_raise(const char *p, rb_encoding *enc, int badcheck, int raise, int *error)
{
const char *q;
char *end;
@@ -3285,6 +3592,7 @@ rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
#define OutOfRange() ((end - p > max_width) ? \
(w = max_width, ellipsis = "...") : \
(w = (int)(end - p), ellipsis = ""))
+ /* p...end has been parsed with strtod, should be ASCII-only */
if (!p) return 0.0;
q = p;
@@ -3313,23 +3621,37 @@ rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
char *e = init_e;
char prev = 0;
int dot_seen = FALSE;
+ int base = 10;
+ char exp_letter = 'e';
switch (*p) {case '+': case '-': prev = *n++ = *p++;}
if (*p == '0') {
prev = *n++ = '0';
- while (*++p == '0');
+ switch (*++p) {
+ case 'x': case 'X':
+ prev = *n++ = 'x';
+ base = 16;
+ exp_letter = 'p';
+ if (*++p != '0') break;
+ /* fallthrough */
+ case '0': /* squeeze successive zeros */
+ while (*++p == '0');
+ break;
+ }
}
while (p < end && n < e) prev = *n++ = *p++;
while (*p) {
if (*p == '_') {
/* remove an underscore between digits */
- if (n == buf || !ISDIGIT(prev) || (++p, !ISDIGIT(*p))) {
+ if (n == buf ||
+ !is_digit_char(prev, base) ||
+ !is_digit_char(*++p, base)) {
if (badcheck) goto bad;
break;
}
}
prev = *p++;
- if (e == init_e && (prev == 'e' || prev == 'E' || prev == 'p' || prev == 'P')) {
+ if (e == init_e && (rb_tolower(prev) == exp_letter)) {
e = buf + sizeof(buf) - 1;
*n++ = prev;
switch (*p) {case '+': case '-': prev = *n++ = *p++;}
@@ -3337,6 +3659,10 @@ rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
prev = *n++ = '0';
while (*++p == '0');
}
+
+ /* reset base to decimal for underscore check of
+ * binary exponent part */
+ base = 10;
continue;
}
else if (ISSPACE(prev)) {
@@ -3346,7 +3672,7 @@ rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
break;
}
}
- else if (prev == '.' ? dot_seen++ : !ISDIGIT(prev)) {
+ else if (prev == '.' ? dot_seen++ : !is_digit_char(prev, base)) {
if (badcheck) goto bad;
break;
}
@@ -3380,7 +3706,8 @@ rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
bad:
if (raise) {
- rb_invalid_str(q, "Float()");
+ VALUE s = rb_enc_str_new_cstr(q, enc);
+ rb_raise(rb_eArgError, "invalid value for Float(): %+"PRIsVALUE, s);
UNREACHABLE_RETURN(nan(""));
}
else {
@@ -3392,7 +3719,7 @@ rb_cstr_to_dbl_raise(const char *p, int badcheck, int raise, int *error)
double
rb_cstr_to_dbl(const char *p, int badcheck)
{
- return rb_cstr_to_dbl_raise(p, badcheck, TRUE, NULL);
+ return rb_cstr_to_dbl_raise(p, NULL, badcheck, TRUE, NULL);
}
static double
@@ -3404,27 +3731,30 @@ rb_str_to_dbl_raise(VALUE str, int badcheck, int raise, int *error)
VALUE v = 0;
StringValue(str);
+ rb_must_asciicompat(str);
s = RSTRING_PTR(str);
len = RSTRING_LEN(str);
if (s) {
- if (badcheck && memchr(s, '\0', len)) {
+ if (badcheck && memchr(s, '\0', len)) {
if (raise)
rb_raise(rb_eArgError, "string for Float contains null byte");
else {
if (error) *error = 1;
return 0.0;
}
- }
- if (s[len]) { /* no sentinel somehow */
- char *p = ALLOCV(v, (size_t)len + 1);
- MEMCPY(p, s, char, len);
- p[len] = '\0';
- s = p;
- }
+ }
+ if (s[len]) { /* no sentinel somehow */
+ char *p = ALLOCV(v, (size_t)len + 1);
+ MEMCPY(p, s, char, len);
+ p[len] = '\0';
+ s = p;
+ }
}
- ret = rb_cstr_to_dbl_raise(s, badcheck, raise, error);
+ ret = rb_cstr_to_dbl_raise(s, rb_enc_get(str), badcheck, raise, error);
if (v)
- ALLOCV_END(v);
+ ALLOCV_END(v);
+ else
+ RB_GC_GUARD(str);
return ret;
}
@@ -3456,11 +3786,11 @@ rat2dbl_without_to_f(VALUE x)
#define special_const_to_float(val, pre, post) \
switch (val) { \
case Qnil: \
- rb_raise_static(rb_eTypeError, pre "nil" post); \
+ rb_raise_static(rb_eTypeError, pre "nil" post); \
case Qtrue: \
- rb_raise_static(rb_eTypeError, pre "true" post); \
+ rb_raise_static(rb_eTypeError, pre "true" post); \
case Qfalse: \
- rb_raise_static(rb_eTypeError, pre "false" post); \
+ rb_raise_static(rb_eTypeError, pre "false" post); \
}
/*! \endcond */
@@ -3481,31 +3811,31 @@ to_float(VALUE *valp, int raise_exception)
{
VALUE val = *valp;
if (SPECIAL_CONST_P(val)) {
- if (FIXNUM_P(val)) {
- *valp = DBL2NUM(fix2dbl_without_to_f(val));
- return T_FLOAT;
- }
- else if (FLONUM_P(val)) {
- return T_FLOAT;
- }
- else if (raise_exception) {
- conversion_to_float(val);
- }
+ if (FIXNUM_P(val)) {
+ *valp = DBL2NUM(fix2dbl_without_to_f(val));
+ return T_FLOAT;
+ }
+ else if (FLONUM_P(val)) {
+ return T_FLOAT;
+ }
+ else if (raise_exception) {
+ conversion_to_float(val);
+ }
}
else {
- int type = BUILTIN_TYPE(val);
- switch (type) {
- case T_FLOAT:
- return T_FLOAT;
- case T_BIGNUM:
- *valp = DBL2NUM(big2dbl_without_to_f(val));
- return T_FLOAT;
- case T_RATIONAL:
- *valp = DBL2NUM(rat2dbl_without_to_f(val));
- return T_FLOAT;
- case T_STRING:
- return T_STRING;
- }
+ int type = BUILTIN_TYPE(val);
+ switch (type) {
+ case T_FLOAT:
+ return T_FLOAT;
+ case T_BIGNUM:
+ *valp = DBL2NUM(big2dbl_without_to_f(val));
+ return T_FLOAT;
+ case T_RATIONAL:
+ *valp = DBL2NUM(rat2dbl_without_to_f(val));
+ return T_FLOAT;
+ case T_STRING:
+ return T_STRING;
+ }
}
return T_NONE;
}
@@ -3521,7 +3851,7 @@ rb_convert_to_float(VALUE val, int raise_exception)
{
switch (to_float(&val, raise_exception)) {
case T_FLOAT:
- return val;
+ return val;
case T_STRING:
if (!raise_exception) {
int e = 0;
@@ -3561,7 +3891,7 @@ rb_f_float1(rb_execution_context_t *ec, VALUE obj, VALUE arg)
static VALUE
rb_f_float(rb_execution_context_t *ec, VALUE obj, VALUE arg, VALUE opts)
{
- int exception = rb_bool_expected(opts, "exception");
+ int exception = rb_bool_expected(opts, "exception", TRUE);
return rb_convert_to_float(arg, exception);
}
@@ -3569,8 +3899,8 @@ static VALUE
numeric_to_float(VALUE val)
{
if (!rb_obj_is_kind_of(val, rb_cNumeric)) {
- rb_raise(rb_eTypeError, "can't convert %"PRIsVALUE" into Float",
- rb_obj_class(val));
+ rb_raise(rb_eTypeError, "can't convert %"PRIsVALUE" into Float",
+ rb_obj_class(val));
}
return rb_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
}
@@ -3580,7 +3910,7 @@ rb_to_float(VALUE val)
{
switch (to_float(&val, TRUE)) {
case T_FLOAT:
- return val;
+ return val;
}
return numeric_to_float(val);
}
@@ -3590,7 +3920,7 @@ rb_check_to_float(VALUE val)
{
if (RB_FLOAT_TYPE_P(val)) return val;
if (!rb_obj_is_kind_of(val, rb_cNumeric)) {
- return Qnil;
+ return Qnil;
}
return rb_check_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
}
@@ -3606,32 +3936,32 @@ double
rb_num_to_dbl(VALUE val)
{
if (SPECIAL_CONST_P(val)) {
- if (FIXNUM_P(val)) {
- if (basic_to_f_p(rb_cInteger))
- return fix2dbl_without_to_f(val);
- }
- else if (FLONUM_P(val)) {
- return rb_float_flonum_value(val);
- }
- else {
- conversion_to_float(val);
- }
+ if (FIXNUM_P(val)) {
+ if (basic_to_f_p(rb_cInteger))
+ return fix2dbl_without_to_f(val);
+ }
+ else if (FLONUM_P(val)) {
+ return rb_float_flonum_value(val);
+ }
+ else {
+ conversion_to_float(val);
+ }
}
else {
- switch (BUILTIN_TYPE(val)) {
- case T_FLOAT:
- return rb_float_noflonum_value(val);
- case T_BIGNUM:
- if (basic_to_f_p(rb_cInteger))
- return big2dbl_without_to_f(val);
- break;
- case T_RATIONAL:
- if (basic_to_f_p(rb_cRational))
- return rat2dbl_without_to_f(val);
- break;
+ switch (BUILTIN_TYPE(val)) {
+ case T_FLOAT:
+ return rb_float_noflonum_value(val);
+ case T_BIGNUM:
+ if (basic_to_f_p(rb_cInteger))
+ return big2dbl_without_to_f(val);
+ break;
+ case T_RATIONAL:
+ if (basic_to_f_p(rb_cRational))
+ return rat2dbl_without_to_f(val);
+ break;
default:
- break;
- }
+ break;
+ }
}
val = numeric_to_float(val);
return RFLOAT_VALUE(val);
@@ -3641,29 +3971,29 @@ double
rb_num2dbl(VALUE val)
{
if (SPECIAL_CONST_P(val)) {
- if (FIXNUM_P(val)) {
- return fix2dbl_without_to_f(val);
- }
- else if (FLONUM_P(val)) {
- return rb_float_flonum_value(val);
- }
- else {
- implicit_conversion_to_float(val);
- }
+ if (FIXNUM_P(val)) {
+ return fix2dbl_without_to_f(val);
+ }
+ else if (FLONUM_P(val)) {
+ return rb_float_flonum_value(val);
+ }
+ else {
+ implicit_conversion_to_float(val);
+ }
}
else {
- switch (BUILTIN_TYPE(val)) {
- case T_FLOAT:
- return rb_float_noflonum_value(val);
- case T_BIGNUM:
- return big2dbl_without_to_f(val);
- case T_RATIONAL:
- return rat2dbl_without_to_f(val);
- case T_STRING:
- rb_raise(rb_eTypeError, "no implicit conversion to float from string");
+ switch (BUILTIN_TYPE(val)) {
+ case T_FLOAT:
+ return rb_float_noflonum_value(val);
+ case T_BIGNUM:
+ return big2dbl_without_to_f(val);
+ case T_RATIONAL:
+ return rat2dbl_without_to_f(val);
+ case T_STRING:
+ rb_raise(rb_eTypeError, "no implicit conversion to float from string");
default:
- break;
- }
+ break;
+ }
}
val = rb_convert_type_with_id(val, T_FLOAT, "Float", id_to_f);
return RFLOAT_VALUE(val);
@@ -3674,7 +4004,7 @@ rb_String(VALUE val)
{
VALUE tmp = rb_check_string_type(val);
if (NIL_P(tmp))
- tmp = rb_convert_type_with_id(val, T_STRING, "String", idTo_s);
+ tmp = rb_convert_type_with_id(val, T_STRING, "String", idTo_s);
return tmp;
}
@@ -3690,7 +4020,7 @@ rb_String(VALUE val)
*
* String([0, 1, 2]) # => "[0, 1, 2]"
* String(0..5) # => "0..5"
- * String({foo: 0, bar: 1}) # => "{:foo=>0, :bar=>1}"
+ * String({foo: 0, bar: 1}) # => "{foo: 0, bar: 1}"
*
* Raises +TypeError+ if +object+ cannot be converted to a string.
*/
@@ -3707,10 +4037,10 @@ rb_Array(VALUE val)
VALUE tmp = rb_check_array_type(val);
if (NIL_P(tmp)) {
- tmp = rb_check_to_array(val);
- if (NIL_P(tmp)) {
- return rb_ary_new3(1, val);
- }
+ tmp = rb_check_to_array(val);
+ if (NIL_P(tmp)) {
+ return rb_ary_new3(1, val);
+ }
}
return tmp;
}
@@ -3752,9 +4082,9 @@ rb_Hash(VALUE val)
if (NIL_P(val)) return rb_hash_new();
tmp = rb_check_hash_type(val);
if (NIL_P(tmp)) {
- if (RB_TYPE_P(val, T_ARRAY) && RARRAY_LEN(val) == 0)
- return rb_hash_new();
- rb_raise(rb_eTypeError, "can't convert %s into Hash", rb_obj_classname(val));
+ if (RB_TYPE_P(val, T_ARRAY) && RARRAY_LEN(val) == 0)
+ return rb_hash_new();
+ rb_raise(rb_eTypeError, "can't convert %s into Hash", rb_obj_classname(val));
}
return tmp;
}
@@ -3800,8 +4130,8 @@ dig_basic_p(VALUE obj, struct dig_method *cache)
{
VALUE klass = RBASIC_CLASS(obj);
if (klass != cache->klass) {
- cache->klass = klass;
- cache->basic = rb_method_basic_definition_p(klass, id_dig);
+ cache->klass = klass;
+ cache->basic = rb_method_basic_definition_p(klass, id_dig);
}
return cache->basic;
}
@@ -3810,8 +4140,8 @@ static void
no_dig_method(int found, VALUE recv, ID mid, int argc, const VALUE *argv, VALUE data)
{
if (!found) {
- rb_raise(rb_eTypeError, "%"PRIsVALUE" does not have #dig method",
- CLASS_OF(data));
+ rb_raise(rb_eTypeError, "%"PRIsVALUE" does not have #dig method",
+ CLASS_OF(data));
}
}
@@ -3822,31 +4152,31 @@ rb_obj_dig(int argc, VALUE *argv, VALUE obj, VALUE notfound)
struct dig_method hash = {Qnil}, ary = {Qnil}, strt = {Qnil};
for (; argc > 0; ++argv, --argc) {
- if (NIL_P(obj)) return notfound;
- if (!SPECIAL_CONST_P(obj)) {
- switch (BUILTIN_TYPE(obj)) {
- case T_HASH:
- if (dig_basic_p(obj, &hash)) {
- obj = rb_hash_aref(obj, *argv);
- continue;
- }
- break;
- case T_ARRAY:
- if (dig_basic_p(obj, &ary)) {
- obj = rb_ary_at(obj, *argv);
- continue;
- }
- break;
- case T_STRUCT:
- if (dig_basic_p(obj, &strt)) {
- obj = rb_struct_lookup(obj, *argv);
- continue;
- }
- break;
+ if (NIL_P(obj)) return notfound;
+ if (!SPECIAL_CONST_P(obj)) {
+ switch (BUILTIN_TYPE(obj)) {
+ case T_HASH:
+ if (dig_basic_p(obj, &hash)) {
+ obj = rb_hash_aref(obj, *argv);
+ continue;
+ }
+ break;
+ case T_ARRAY:
+ if (dig_basic_p(obj, &ary)) {
+ obj = rb_ary_at(obj, *argv);
+ continue;
+ }
+ break;
+ case T_STRUCT:
+ if (dig_basic_p(obj, &strt)) {
+ obj = rb_struct_lookup(obj, *argv);
+ continue;
+ }
+ break;
default:
break;
- }
- }
+ }
+ }
return rb_check_funcall_with_hook_kw(obj, id_dig, argc, argv,
no_dig_method, obj,
RB_NO_KEYWORDS);
@@ -3862,10 +4192,7 @@ rb_obj_dig(int argc, VALUE *argv, VALUE obj, VALUE notfound)
* into +format_string+.
*
* For details on +format_string+, see
- * {Format Specifications}[rdoc-ref:format_specifications.rdoc].
- *
- * Kernel#format is an alias for Kernel#sprintf.
- *
+ * {Format Specifications}[rdoc-ref:language/format_specifications.rdoc].
*/
static VALUE
@@ -3874,6 +4201,12 @@ f_sprintf(int c, const VALUE *v, VALUE _)
return rb_f_sprintf(c, v);
}
+static VALUE
+rb_f_loop_size(VALUE self, VALUE args, VALUE eobj)
+{
+ return DBL2NUM(HUGE_VAL);
+}
+
/*
* Document-class: Class
*
@@ -3936,57 +4269,51 @@ f_sprintf(int c, const VALUE *v, VALUE _)
*/
-/* Document-class: BasicObject
+/*
+ * Document-class: BasicObject
*
- * BasicObject is the parent class of all classes in Ruby. It's an explicit
- * blank class.
+ * +BasicObject+ is the parent class of all classes in Ruby.
+ * In particular, +BasicObject+ is the parent class of class Object,
+ * which is itself the default parent class of every Ruby class:
*
- * BasicObject can be used for creating object hierarchies independent of
- * Ruby's object hierarchy, proxy objects like the Delegator class, or other
- * uses where namespace pollution from Ruby's methods and classes must be
- * avoided.
+ * class Foo; end
+ * Foo.superclass # => Object
+ * Object.superclass # => BasicObject
*
- * To avoid polluting BasicObject for other users an appropriately named
- * subclass of BasicObject should be created instead of directly modifying
- * BasicObject:
+ * +BasicObject+ is the only class that has no parent:
*
- * class MyObjectSystem < BasicObject
- * end
+ * BasicObject.superclass # => nil
*
- * BasicObject does not include Kernel (for methods like +puts+) and
- * BasicObject is outside of the namespace of the standard library so common
- * classes will not be found without using a full class path.
+ * Class +BasicObject+ can be used to create an object hierarchy
+ * (e.g., class Delegator) that is independent of Ruby's object hierarchy.
+ * Such objects:
*
- * A variety of strategies can be used to provide useful portions of the
- * standard library to subclasses of BasicObject. A subclass could
- * <code>include Kernel</code> to obtain +puts+, +exit+, etc. A custom
- * Kernel-like module could be created and included or delegation can be used
- * via #method_missing:
+ * - Do not have namespace "pollution" from the many methods
+ * provided in class Object and its included module Kernel.
+ * - Do not have definitions of common classes,
+ * and so references to such common classes must be fully qualified
+ * (+::String+, not +String+).
*
- * class MyObjectSystem < BasicObject
- * DELEGATE = [:puts, :p]
+ * A variety of strategies can be used to provide useful portions
+ * of the Standard Library in subclasses of +BasicObject+:
*
- * def method_missing(name, *args, &block)
- * return super unless DELEGATE.include? name
- * ::Kernel.send(name, *args, &block)
- * end
+ * - The immediate subclass could <tt>include Kernel</tt>,
+ * which would define methods such as +puts+, +exit+, etc.
+ * - A custom Kernel-like module could be created and included.
+ * - Delegation can be used via #method_missing:
*
- * def respond_to_missing?(name, include_private = false)
- * DELEGATE.include?(name) or super
- * end
- * end
+ * class MyObjectSystem < BasicObject
+ * DELEGATE = [:puts, :p]
*
- * Access to classes and modules from the Ruby standard library can be
- * obtained in a BasicObject subclass by referencing the desired constant
- * from the root like <code>::File</code> or <code>::Enumerator</code>.
- * Like #method_missing, #const_missing can be used to delegate constant
- * lookup to +Object+:
+ * def method_missing(name, *args, &block)
+ * return super unless DELEGATE.include? name
+ * ::Kernel.send(name, *args, &block)
+ * end
*
- * class MyObjectSystem < BasicObject
- * def self.const_missing(name)
- * ::Object.const_get(name)
+ * def respond_to_missing?(name, include_private = false)
+ * DELEGATE.include?(name)
+ * end
* end
- * end
*
* === What's Here
*
@@ -4000,8 +4327,11 @@ f_sprintf(int c, const VALUE *v, VALUE _)
* - #__send__: Calls the method identified by the given symbol.
* - #equal?: Returns whether +self+ and the given object are the same object.
* - #instance_eval: Evaluates the given string or block in the context of +self+.
- * - #instance_exec: Executes the given block in the context of +self+,
- * passing the given arguments.
+ * - #instance_exec: Executes the given block in the context of +self+, passing the given arguments.
+ * - #method_missing: Called when +self+ is called with a method it does not define.
+ * - #singleton_method_added: Called when a singleton method is added to +self+.
+ * - #singleton_method_removed: Called when a singleton method is removed from +self+.
+ * - #singleton_method_undefined: Called when a singleton method is undefined in +self+.
*
*/
@@ -4025,7 +4355,7 @@ f_sprintf(int c, const VALUE *v, VALUE _)
*
* == What's Here
*
- * First, what's elsewhere. \Class \Object:
+ * First, what's elsewhere. Class \Object:
*
* - Inherits from {class BasicObject}[rdoc-ref:BasicObject@What-27s+Here].
* - Includes {module Kernel}[rdoc-ref:Kernel@What-27s+Here].
@@ -4049,7 +4379,7 @@ f_sprintf(int c, const VALUE *v, VALUE _)
* - #instance_of?: Returns whether +self+ is an instance of the given class.
* - #instance_variable_defined?: Returns whether the given instance variable
* is defined in +self+.
- * - #method: Returns the Method object for the given method in +self+.
+ * - #method: Returns the +Method+ object for the given method in +self+.
* - #methods: Returns an array of symbol names of public and protected methods
* in +self+.
* - #nil?: Returns +false+. (Only +nil+ responds +true+ to method <tt>nil?</tt>.)
@@ -4059,12 +4389,12 @@ f_sprintf(int c, const VALUE *v, VALUE _)
* of the private methods in +self+.
* - #protected_methods: Returns an array of the symbol names
* of the protected methods in +self+.
- * - #public_method: Returns the Method object for the given public method in +self+.
+ * - #public_method: Returns the +Method+ object for the given public method in +self+.
* - #public_methods: Returns an array of the symbol names
* of the public methods in +self+.
* - #respond_to?: Returns whether +self+ responds to the given method.
* - #singleton_class: Returns the singleton class of +self+.
- * - #singleton_method: Returns the Method object for the given singleton method
+ * - #singleton_method: Returns the +Method+ object for the given singleton method
* in +self+.
* - #singleton_methods: Returns an array of the symbol names
* of the singleton methods in +self+.
@@ -4091,7 +4421,7 @@ f_sprintf(int c, const VALUE *v, VALUE _)
* and frozen state.
* - #define_singleton_method: Defines a singleton method in +self+
* for the given symbol method-name and block or proc.
- * - #display: Prints +self+ to the given \IO stream or <tt>$stdout</tt>.
+ * - #display: Prints +self+ to the given IO stream or <tt>$stdout</tt>.
* - #dup: Returns a shallow unfrozen copy of +self+.
* - #enum_for (aliased as #to_enum): Returns an Enumerator for +self+
* using the using the given method, arguments, and block.
@@ -4107,27 +4437,6 @@ f_sprintf(int c, const VALUE *v, VALUE _)
*
*/
-/*!
- *--
- * \private
- * Initializes the world of objects and classes.
- *
- * At first, the function bootstraps the class hierarchy.
- * It initializes the most fundamental classes and their metaclasses.
- * - \c BasicObject
- * - \c Object
- * - \c Module
- * - \c Class
- * After the bootstrap step, the class hierarchy becomes as the following
- * diagram.
- *
- * \image html boottime-classes.png
- *
- * Then, the function defines classes, modules and methods as usual.
- * \ingroup class
- *++
- */
-
void
InitVM_Object(void)
{
@@ -4166,7 +4475,7 @@ InitVM_Object(void)
*
* == What's Here
*
- * \Module \Kernel provides methods that are useful for:
+ * Module \Kernel provides methods that are useful for:
*
* - {Converting}[rdoc-ref:Kernel@Converting]
* - {Querying}[rdoc-ref:Kernel@Querying]
@@ -4234,7 +4543,7 @@ InitVM_Object(void)
* - #print: Prints the given objects to standard output without a newline.
* - #printf: Prints the string resulting from applying the given format string
* to any additional arguments.
- * - #putc: Equivalent to <tt.$stdout.putc(object)</tt> for the given object.
+ * - #putc: Equivalent to <tt>$stdout.putc(object)</tt> for the given object.
* - #puts: Equivalent to <tt>$stdout.puts(*objects)</tt> for the given objects.
* - #readline: Similar to #gets, but raises an exception at the end of file.
* - #readlines: Returns an array of the remaining lines from the current input.
@@ -4324,6 +4633,7 @@ InitVM_Object(void)
rb_define_method(rb_mKernel, "to_s", rb_any_to_s, 0);
rb_define_method(rb_mKernel, "inspect", rb_obj_inspect, 0);
+ rb_define_private_method(rb_mKernel, "instance_variables_to_inspect", rb_obj_instance_variables_to_inspect, 0);
rb_define_method(rb_mKernel, "methods", rb_obj_methods, -1); /* in class.c */
rb_define_method(rb_mKernel, "singleton_methods", rb_obj_singleton_methods, -1); /* in class.c */
rb_define_method(rb_mKernel, "protected_methods", rb_obj_protected_methods, -1); /* in class.c */
@@ -4331,10 +4641,10 @@ InitVM_Object(void)
rb_define_method(rb_mKernel, "public_methods", rb_obj_public_methods, -1); /* in class.c */
rb_define_method(rb_mKernel, "instance_variables", rb_obj_instance_variables, 0); /* in variable.c */
rb_define_method(rb_mKernel, "instance_variable_get", rb_obj_ivar_get, 1);
- rb_define_method(rb_mKernel, "instance_variable_set", rb_obj_ivar_set, 2);
+ rb_define_method(rb_mKernel, "instance_variable_set", rb_obj_ivar_set_m, 2);
rb_define_method(rb_mKernel, "instance_variable_defined?", rb_obj_ivar_defined, 1);
rb_define_method(rb_mKernel, "remove_instance_variable",
- rb_obj_remove_instance_variable, 1); /* in variable.c */
+ rb_obj_remove_instance_variable, 1); /* in variable.c */
rb_define_method(rb_mKernel, "instance_of?", rb_obj_is_instance_of, 1);
rb_define_method(rb_mKernel, "kind_of?", rb_obj_is_kind_of, 1);
@@ -4343,15 +4653,13 @@ InitVM_Object(void)
rb_define_global_function("sprintf", f_sprintf, -1);
rb_define_global_function("format", f_sprintf, -1);
- rb_define_global_function("Integer", rb_f_integer, -1);
-
rb_define_global_function("String", rb_f_string, 1);
rb_define_global_function("Array", rb_f_array, 1);
rb_define_global_function("Hash", rb_f_hash, 1);
rb_cNilClass = rb_define_class("NilClass", rb_cObject);
rb_cNilClass_to_s = rb_fstring_enc_lit("", rb_usascii_encoding());
- rb_gc_register_mark_object(rb_cNilClass_to_s);
+ rb_vm_register_global_object(rb_cNilClass_to_s);
rb_define_method(rb_cNilClass, "to_s", rb_nil_to_s, 0);
rb_define_method(rb_cNilClass, "to_a", nil_to_a, 0);
rb_define_method(rb_cNilClass, "to_h", nil_to_h, 0);
@@ -4374,12 +4682,12 @@ InitVM_Object(void)
rb_define_method(rb_cModule, "<=", rb_class_inherited_p, 1);
rb_define_method(rb_cModule, ">", rb_mod_gt, 1);
rb_define_method(rb_cModule, ">=", rb_mod_ge, 1);
- rb_define_method(rb_cModule, "initialize_copy", rb_mod_init_copy, 1); /* in class.c */
rb_define_method(rb_cModule, "to_s", rb_mod_to_s, 0);
rb_define_alias(rb_cModule, "inspect", "to_s");
rb_define_method(rb_cModule, "included_modules", rb_mod_included_modules, 0); /* in class.c */
rb_define_method(rb_cModule, "include?", rb_mod_include_p, 1); /* in class.c */
rb_define_method(rb_cModule, "name", rb_mod_name, 0); /* in variable.c */
+ rb_define_method(rb_cModule, "set_temporary_name", rb_mod_set_temporary_name, 1); /* in variable.c */
rb_define_method(rb_cModule, "ancestors", rb_mod_ancestors, 0); /* in class.c */
rb_define_method(rb_cModule, "attr", rb_mod_attr, -1);
@@ -4393,11 +4701,13 @@ InitVM_Object(void)
rb_define_method(rb_cModule, "initialize_clone", rb_mod_initialize_clone, -1);
rb_define_method(rb_cModule, "instance_methods", rb_class_instance_methods, -1); /* in class.c */
rb_define_method(rb_cModule, "public_instance_methods",
- rb_class_public_instance_methods, -1); /* in class.c */
+ rb_class_public_instance_methods, -1); /* in class.c */
rb_define_method(rb_cModule, "protected_instance_methods",
- rb_class_protected_instance_methods, -1); /* in class.c */
+ rb_class_protected_instance_methods, -1); /* in class.c */
rb_define_method(rb_cModule, "private_instance_methods",
- rb_class_private_instance_methods, -1); /* in class.c */
+ rb_class_private_instance_methods, -1); /* in class.c */
+ rb_define_method(rb_cModule, "undefined_instance_methods",
+ rb_class_undefined_instance_methods, 0); /* in class.c */
rb_define_method(rb_cModule, "constants", rb_mod_constants, -1); /* in variable.c */
rb_define_method(rb_cModule, "const_get", rb_mod_const_get, -1);
@@ -4405,13 +4715,13 @@ InitVM_Object(void)
rb_define_method(rb_cModule, "const_defined?", rb_mod_const_defined, -1);
rb_define_method(rb_cModule, "const_source_location", rb_mod_const_source_location, -1);
rb_define_private_method(rb_cModule, "remove_const",
- rb_mod_remove_const, 1); /* in variable.c */
+ rb_mod_remove_const, 1); /* in variable.c */
rb_define_method(rb_cModule, "const_missing",
- rb_mod_const_missing, 1); /* in variable.c */
+ rb_mod_const_missing, 1); /* in variable.c */
rb_define_method(rb_cModule, "class_variables",
- rb_mod_class_variables, -1); /* in variable.c */
+ rb_mod_class_variables, -1); /* in variable.c */
rb_define_method(rb_cModule, "remove_class_variable",
- rb_mod_remove_cvar, 1); /* in variable.c */
+ rb_mod_remove_cvar, 1); /* in variable.c */
rb_define_method(rb_cModule, "class_variable_get", rb_mod_cvar_get, 1);
rb_define_method(rb_cModule, "class_variable_set", rb_mod_cvar_set, 2);
rb_define_method(rb_cModule, "class_variable_defined?", rb_mod_cvar_defined, 1);
@@ -4420,12 +4730,13 @@ InitVM_Object(void)
rb_define_method(rb_cModule, "deprecate_constant", rb_mod_deprecate_constant, -1); /* in variable.c */
rb_define_method(rb_cModule, "singleton_class?", rb_mod_singleton_p, 0);
- rb_define_method(rb_singleton_class(rb_cClass), "allocate", rb_class_alloc_m, 0);
- rb_define_method(rb_cClass, "allocate", rb_class_alloc_m, 0);
+ rb_define_method(rb_singleton_class(rb_cClass), "allocate", rb_class_alloc, 0);
+ rb_define_method(rb_cClass, "allocate", rb_class_alloc, 0);
rb_define_method(rb_cClass, "new", rb_class_new_instance_pass_kw, -1);
rb_define_method(rb_cClass, "initialize", rb_class_initialize, -1);
rb_define_method(rb_cClass, "superclass", rb_class_superclass, 0);
rb_define_method(rb_cClass, "subclasses", rb_class_subclasses, 0); /* in class.c */
+ rb_define_method(rb_cClass, "attached_object", rb_class_attached_object, 0); /* in class.c */
rb_define_alloc_func(rb_cClass, rb_class_s_alloc);
rb_undef_method(rb_cClass, "extend_object");
rb_undef_method(rb_cClass, "append_features");
@@ -4433,7 +4744,7 @@ InitVM_Object(void)
rb_cTrueClass = rb_define_class("TrueClass", rb_cObject);
rb_cTrueClass_to_s = rb_fstring_enc_lit("true", rb_usascii_encoding());
- rb_gc_register_mark_object(rb_cTrueClass_to_s);
+ rb_vm_register_global_object(rb_cTrueClass_to_s);
rb_define_method(rb_cTrueClass, "to_s", rb_true_to_s, 0);
rb_define_alias(rb_cTrueClass, "inspect", "to_s");
rb_define_method(rb_cTrueClass, "&", true_and, 1);
@@ -4445,7 +4756,7 @@ InitVM_Object(void)
rb_cFalseClass = rb_define_class("FalseClass", rb_cObject);
rb_cFalseClass_to_s = rb_fstring_enc_lit("false", rb_usascii_encoding());
- rb_gc_register_mark_object(rb_cFalseClass_to_s);
+ rb_vm_register_global_object(rb_cFalseClass_to_s);
rb_define_method(rb_cFalseClass, "to_s", rb_false_to_s, 0);
rb_define_alias(rb_cFalseClass, "inspect", "to_s");
rb_define_method(rb_cFalseClass, "&", false_and, 1);
@@ -4463,6 +4774,7 @@ void
Init_Object(void)
{
id_dig = rb_intern_const("dig");
+ id_instance_variables_to_inspect = rb_intern_const("instance_variables_to_inspect");
InitVM(Object);
}