Macros
#define	id_for_var(obj, name, part, type) id_for_setter(obj, name, type, "`%1$s' is not allowed as "#part" "#type" variable name")

#define	id_for_setter(obj, name, type, message) check_setter_id(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))

#define	IMPLICIT_CONVERSIONS 7

Functions
void	rb_obj_call_init (VALUE obj, int argc, const VALUE *argv)
	Calls `#initialize` method of obj with the given arguments. More...

VALUE	rb_obj_hide (VALUE obj)
	Make the object invisible from Ruby code. More...

VALUE	rb_obj_reveal (VALUE obj, VALUE klass)
	Make a hidden object visible again. More...

VALUE	rb_obj_setup (VALUE obj, VALUE klass, VALUE type)
	Fills common (`RBasic`) fields in obj. More...

VALUE	rb_equal (VALUE obj1, VALUE obj2)
	call-seq: obj === other -> true or false More...

int	rb_eql (VALUE obj1, VALUE obj2)
	Determines if obj1 and obj2 are equal in terms of `Object::eql`?. More...

VALUE	rb_obj_hash (VALUE obj)

VALUE	rb_class_real (VALUE cl)
	Looks up the nearest ancestor of cl, skipping singleton classes or module inclusions. More...

VALUE	rb_obj_class (VALUE obj)
	call-seq: obj.class -> class More...

VALUE	rb_obj_clone (VALUE obj)
	:nodoc Almost same as `Object::clone` ++ More...

VALUE	rb_obj_dup (VALUE obj)
	call-seq: obj.dup -> an_object More...

VALUE	rb_obj_init_copy (VALUE obj, VALUE orig)
	:nodoc: Default implementation of `#initialize_copy` More...

VALUE	rb_obj_init_dup_clone (VALUE obj, VALUE orig)
	:nodoc: Default implementation of `#initialize_dup` and `#initialize_clone` More...

VALUE	rb_any_to_s (VALUE obj)
	call-seq: obj.to_s -> string More...

VALUE	rb_str_escape (VALUE str)

VALUE	rb_inspect (VALUE obj)
	Convenient wrapper of `Object::inspect`. More...

VALUE	rb_obj_is_instance_of (VALUE obj, VALUE c)
	call-seq: obj.instance_of?(class) -> true or false More...

VALUE	rb_obj_is_kind_of (VALUE obj, VALUE c)
	call-seq: obj.is_a?(class) -> true or false obj.kind_of?(class) -> true or false More...

VALUE	rb_obj_tainted (VALUE obj)
	call-seq: obj.tainted? -> true or false More...

VALUE	rb_obj_taint (VALUE obj)
	call-seq: obj.taint -> obj More...

VALUE	rb_obj_untaint (VALUE obj)
	call-seq: obj.untaint -> obj More...

VALUE	rb_obj_untrusted (VALUE obj)
	call-seq: obj.untrusted? -> true or false More...

VALUE	rb_obj_untrust (VALUE obj)
	call-seq: obj.untrust -> obj More...

VALUE	rb_obj_trust (VALUE obj)
	call-seq: obj.trust -> obj More...

void	rb_obj_infect (VALUE victim, VALUE carrier)
	Convenient function to infect victim with the taintedness of carrier. More...

VALUE	rb_obj_freeze (VALUE obj)
	call-seq: obj.freeze -> obj More...

VALUE	rb_obj_frozen_p (VALUE obj)
	call-seq: obj.frozen? -> true or false More...

VALUE	rb_class_inherited_p (VALUE mod, VALUE arg)
	call-seq: mod <= other -> true, false, or nil More...

VALUE	rb_obj_alloc (VALUE klass)
	Allocates an instance of klass. More...

VALUE	rb_class_new_instance (int argc, const VALUE *argv, VALUE klass)
	Allocates and initializes an instance of klass. More...

VALUE	rb_class_superclass (VALUE klass)
	call-seq: class.superclass -> a_super_class or nil More...

VALUE	rb_class_get_superclass (VALUE klass)
	Returns the superclass of klass The return value might be an iclass of a module, unlike rb_class_superclass. More...

VALUE	rb_convert_type (VALUE val, int type, const char tname, const char method)
	Converts an object into another type. More...

VALUE	rb_check_convert_type (VALUE val, int type, const char tname, const char method)
	Tries to convert an object into another type. More...

VALUE	rb_check_to_integer (VALUE val, const char *method)
	Tries to convert val into `Integer`. More...

VALUE	rb_to_int (VALUE val)
	Converts val into `Integer`. More...

VALUE	rb_check_to_int (VALUE val)
	Tries to convert val into Integer. More...

VALUE	rb_Integer (VALUE val)
	Equivalent to `Kernel#Integer` in Ruby. More...

double	rb_cstr_to_dbl (const char *p, int badcheck)
	Parses a string representation of a floating point number. More...

double	rb_str_to_dbl (VALUE str, int badcheck)
	Parses a string representation of a floating point number. More...

VALUE	rb_Float (VALUE val)
	Equivalent to `Kernel#Float` in Ruby. More...

VALUE	rb_to_float (VALUE val)
	Converts a `Numeric` object into `Float`. More...

VALUE	rb_check_to_float (VALUE val)
	Tries to convert an object into `Float`. More...

double	rb_num2dbl (VALUE val)
	Converts a `Numeric` object to `double`. More...

VALUE	rb_String (VALUE val)
	Equivalent to `Kernel#String` in Ruby. More...

VALUE	rb_Array (VALUE val)
	Equivalent to `Kernel#Array` in Ruby. More...

VALUE	rb_Hash (VALUE val)
	Equivalent to `Kernel#Hash` in Ruby. More...

void	Init_Object (void)

Variables
VALUE	rb_cBasicObject
	BasicObject class. More...

VALUE	rb_mKernel
	Kernel module. More...

VALUE	rb_cObject
	Object class. More...

VALUE	rb_cModule
	Module class. More...

VALUE	rb_cClass
	Class class. More...

VALUE	rb_cData
	Data class. More...

VALUE	rb_cNilClass
	NilClass class. More...

VALUE	rb_cTrueClass
	TrueClass class. More...

VALUE	rb_cFalseClass
	FalseClass class. More...

Detailed Description

Macro Definition Documentation

◆ id_for_setter

#define id_for_setter	(	obj,
		name,
		type,
		message
	)	check_setter_id(obj, &(name), rb_is_##type##_id, rb_is_##type##_name, message, strlen(message))

Definition at line 2238 of file object.c.

◆ id_for_var

#define id_for_var	(	obj,
		name,
		part,
		type
	)	id_for_setter(obj, name, type, "`%1$s' is not allowed as "#part" "#type" variable name")

Definition at line 2235 of file object.c.

◆ IMPLICIT_CONVERSIONS

#define IMPLICIT_CONVERSIONS 7

Definition at line 2886 of file object.c.

Function Documentation

◆ Init_Object()

void Init_Object ( void )

Definition at line 4117 of file object.c.

References InitVM, and rb_intern_const.

◆ rb_any_to_s()

VALUE rb_any_to_s ( VALUE obj )

call-seq: obj.to_s -> string

Returns a string representing obj. The default to_s prints the object's class and an encoding of the object id. As a special case, the top-level object that is the initial execution context of Ruby programs returns ``main''.

Default implementation of #to_s. ++

Definition at line 631 of file object.c.

References CLASS_OF, OBJ_INFECT, PRIsVALUE, rb_class_name(), rb_sprintf(), and rb_str_escape().

Referenced by rb_int2str(), and rb_obj_as_string_result().

◆ rb_Array()

VALUE rb_Array ( VALUE val )

Equivalent to Kernel#Array in Ruby.

Definition at line 3592 of file object.c.

References NIL_P, rb_ary_new3, rb_check_array_type(), rb_check_convert_type_with_id(), and T_ARRAY.

◆ rb_check_convert_type()

VALUE rb_check_convert_type	(	VALUE	val,
		int	type,
		const char *	tname,
		const char *	method
	)

Tries to convert an object into another type.

Calls the specified conversion method if necessary.

Parameters

[in]	val	the object to be converted
[in]	type	a value of `ruby_value_type`
[in]	tname	name of the target type. only used for error messages.
[in]	method	name of the method

Returns: an object of the specified type, or Qnil if no such conversion method defined.

Exceptions

TypeError if the conversion method returns an unexpected type of value.

See also: rb_convert_type; rb_check_convert_type_with_id

Definition at line 3006 of file object.c.

References T_DATA, TYPE, and val.

Referenced by rb_check_regexp_type(), and rb_check_to_float().

◆ rb_check_to_float()

VALUE rb_check_to_float ( VALUE val )

Tries to convert an object into Float.

It calls #to_f if necessary.

It returns Qnil if the object is not a Numeric or #to_f is not defined on the object.

Definition at line 3465 of file object.c.

References Qnil, rb_check_convert_type(), rb_cNumeric, rb_obj_is_kind_of(), RB_TYPE_P, T_FLOAT, and val.

◆ rb_check_to_int()

VALUE rb_check_to_int ( VALUE val )

Tries to convert val into Integer.

It calls #to_int method if necessary.

Parameters

[in] val a Ruby object

Returns: an Integer object on success, or Qnil if #to_int is not defined.

Exceptions

TypeError if #to_int returns a non-Integer object.

Definition at line 3099 of file object.c.

References rb_check_to_integer().

◆ rb_check_to_integer()

VALUE rb_check_to_integer	(	VALUE	val,
		const char *	method
	)

Tries to convert val into Integer.

It calls the specified conversion method if necessary.

Parameters

[in]	val	a Ruby object
[in]	method	a name of a method

Returns: an Integer object on success, or Qnil if no such conversion method defined.

Exceptions

TypeError if the conversion method returns a non-Integer object.

Definition at line 3062 of file object.c.

References FIXNUM_P, RB_TYPE_P, T_BIGNUM, and val.

Referenced by rb_check_to_int().

◆ rb_class_get_superclass()

VALUE rb_class_get_superclass ( VALUE klass )

Returns the superclass of klass The return value might be an iclass of a module, unlike rb_class_superclass.

Also it returns Qfalse when klass does not have a parent class.

See also: rb_class_superclass

Definition at line 2229 of file object.c.

References RCLASS.

◆ rb_class_inherited_p()

VALUE rb_class_inherited_p	(	VALUE	mod,
		VALUE	arg
	)

call-seq: mod <= other -> true, false, or nil

Returns true if mod is a subclass of other or is the same as other. Returns nil if there's no relationship between the two. (Think of the relationship in terms of the class definition:

"class A < B" implies "A < B".)

Determines if mod inherits arg. Equivalent to Module#<= in Ruby

Parameters

[in]	mod	a Module object
[in]	arg	another Module object or an iclass of a module

Return values

Qtrue	if mod inherits arg, or mod equals arg
Qfalse	if arg inherits mod
Qnil	if otherwise ++

Definition at line 1827 of file object.c.

References CLASS_OR_MODULE_P, Qtrue, rb_eTypeError, rb_raise(), RB_TYPE_P, and T_ICLASS.

◆ rb_class_new_instance()

VALUE rb_class_new_instance	(	int	argc,
		const VALUE *	argv,
		VALUE	klass
	)

Allocates and initializes an instance of klass.

Equivalent to Class#new in Ruby

Parameters

[in]	argc	the number of arguments to `#initialize`
[in]	argv	a pointer to an array of arguments to `#initialize`
[in]	klass	a Class object

Returns: the new instance of klass

See also: rb_obj_call_init; rb_obj_alloc

Definition at line 2170 of file object.c.

References Check_Type, and T_CLASS.

Referenced by Init_Exception(), rb_exit(), rb_f_abort(), rb_fiddle_new_function(), rb_name_error(), rb_name_error_str(), rb_struct_alloc(), rb_syserr_new_str(), and rb_throw_obj().

◆ rb_class_real()

VALUE rb_class_real ( VALUE cl )

Looks up the nearest ancestor of cl, skipping singleton classes or module inclusions.

It returns the cl itself if it is neither a singleton class or a module.

Parameters

[in] cl a Class object.

Returns: the ancestor class found, or a falsey value if nothing found.

Definition at line 251 of file object.c.

References BUILTIN_TYPE, FL_SINGLETON, RBASIC, RCLASS_SUPER, and T_ICLASS.

Referenced by rb_class_name(), rb_define_class(), rb_define_class_id_under(), rb_obj_class(), rb_vm_bugreport(), and ruby_vm_special_exception_copy().

◆ rb_class_superclass()

VALUE rb_class_superclass ( VALUE klass )

call-seq: class.superclass -> a_super_class or nil

Returns the superclass of class, or nil.

File.superclass #=> IO IO.superclass #=> Object Object.superclass #=> BasicObject class Foo; end class Bar < Foo; end Bar.superclass #=> Foo

Returns nil when the given class does not have a parent class:

BasicObject.superclass #=> nil

Returns the superclass of klass. Equivalent to Class#superclass in Ruby.

It skips modules.

Parameters

[in] klass a Class object

Returns: the superclass, or Qnil if klass does not have a parent class.

See also: rb_class_get_superclass ++

Definition at line 2204 of file object.c.

References Qnil, rb_cBasicObject, rb_eTypeError, rb_raise(), RB_TYPE_P, RCLASS_SUPER, and T_ICLASS.

◆ rb_convert_type()

VALUE rb_convert_type	(	VALUE	val,
		int	type,
		const char *	tname,
		const char *	method
	)

Converts an object into another type.

Calls the specified conversion method if necessary.

Parameters

[in]	val	the object to be converted
[in]	type	a value of `ruby_value_type`
[in]	tname	name of the target type. only used for error messages.
[in]	method	name of the method

Returns: an object of the specified type

Exceptions

TypeError on failure

See also: rb_check_convert_type

Definition at line 2965 of file object.c.

References TYPE, and val.

Referenced by rb_numeric_quo().

◆ rb_cstr_to_dbl()

double rb_cstr_to_dbl	(	const char *	p,
		int	badcheck
	)

Parses a string representation of a floating point number.

Parameters

[in]	p	a string representation of a floating number
[in]	badcheck	raises an exception on parse error if badcheck is non-zero.

Returns: the floating point number in the string on success, 0.0 on parse error and badcheck is zero.

Note: it always fails to parse a hexadecimal representation like "0xAB.CDp+1" when badcheck is zero, even though it would success if badcheck was non-zero. This inconsistency is coming from a historical compatibility reason. [ruby-dev:40822]

Definition at line 3208 of file object.c.

References bad, buf, DBL_DIG, errno, ISDIGIT, ISSPACE, OutOfRange, rb_eArgError, rb_invalid_str(), rb_raise(), rb_warning(), and strtod.

Referenced by rb_str_to_dbl().

◆ rb_eql()

int rb_eql	(	VALUE	obj1,
		VALUE	obj2
	)

Determines if obj1 and obj2 are equal in terms of Object::eql?.

Note: It actually calls #eql? when necessary. So you cannot implement #eql? with this function.

Return values

non-zero	if they are eql?
zero	if they are not eql?.

Definition at line 149 of file object.c.

◆ rb_equal()

VALUE rb_equal	(	VALUE	obj1,
		VALUE	obj2
	)

call-seq: obj === other -> true or false

Case Equality – For class Object, effectively the same as calling #==, but typically overridden by descendants to provide

meaningful semantics in +case+ statements.

Same as Object#===, case equality. ++

Definition at line 126 of file object.c.

Referenced by rb_ary_assoc(), rb_ary_delete(), rb_ary_includes(), rb_ary_rassoc(), and rb_str_equal().

◆ rb_Float()

VALUE rb_Float ( VALUE val )

Equivalent to Kernel#Float in Ruby.

Converts val into Float in a slightly more strict manner than #to_f.

Definition at line 3398 of file object.c.

◆ rb_Hash()

VALUE rb_Hash ( VALUE val )

Equivalent to Kernel#Hash in Ruby.

Definition at line 3635 of file object.c.

References NIL_P, RARRAY_LEN, rb_check_hash_type(), rb_eTypeError, rb_hash_new(), rb_obj_classname(), rb_raise(), RB_TYPE_P, and T_ARRAY.

◆ rb_inspect()

VALUE rb_inspect ( VALUE obj )

Convenient wrapper of Object::inspect.

Returns a human-readable string representation of obj, similarly to Object::inspect.

Unlike Ruby-level #inspect, it escapes characters to keep the result compatible to the default internal or external encoding. If the default internal or external encoding is ASCII compatible, the encoding of the inspected result must be compatible with it. If the default internal or external encoding is ASCII incompatible, the result must be ASCII only.

Definition at line 656 of file object.c.

References NULL, rb_default_external_encoding(), rb_default_internal_encoding(), rb_enc_asciicompat, rb_enc_get(), rb_enc_str_asciionly_p(), rb_funcallv, rb_obj_as_string(), and rb_str_escape().

Referenced by rb_p(), rb_vmdebug_debug_print_post(), and rb_vmdebug_proc_dump_raw().

◆ rb_Integer()

VALUE rb_Integer ( VALUE val )

Equivalent to Kernel#Integer in Ruby.

Converts val into Integer in a slightly more strict manner than #to_i.

Definition at line 3148 of file object.c.

Referenced by ossl_time_split(), and value_to_generic().

◆ rb_num2dbl()

double rb_num2dbl ( VALUE val )

Converts a Numeric object to double.

Parameters

[in] val a Numeric object

Returns: the converted value

Exceptions

TypeError if val is not a Numeric or it does not support conversion to a floating point number.

Definition at line 3524 of file object.c.

References FIXNUM_P, FLONUM_P, and SPECIAL_CONST_P.

◆ rb_obj_alloc()

VALUE rb_obj_alloc ( VALUE klass )

Allocates an instance of klass.

Note: It calls the allocator defined by {rb_define_alloc_func}. So you cannot use this function to define an allocator. Use {rb_newobj_of}, {TypedData_Make_Struct} or others, instead.; Usually prefer rb_class_new_instance to rb_obj_alloc and rb_obj_call_init

Parameters

[in] klass a Class object

See also: rb_class_new_instance; rb_obj_call_init; rb_define_alloc_func; rb_newobj_of; TypedData_Make_Struct

Definition at line 2121 of file object.c.

References Check_Type, and T_CLASS.

Referenced by Init_top_self(), rb_catch(), rb_key_err_new(), rb_last_status_set(), rb_name_err_new(), rb_range_new(), and ruby_vm_special_exception_copy().

◆ rb_obj_call_init()

void rb_obj_call_init	(	VALUE	obj,
		int	argc,
		const VALUE *	argv
	)

Calls #initialize method of obj with the given arguments.

It also forwards the given block to #initialize if given.

Parameters

[in]	obj	the receiver object
[in]	argc	the number of arguments
[in]	argv	a pointer to the array of arguments

Definition at line 1583 of file eval.c.

References PASS_PASSED_BLOCK_HANDLER, and rb_funcallv.

◆ rb_obj_class()

VALUE rb_obj_class ( VALUE obj )

call-seq: obj.class -> class

Returns the class of obj. This method must always be called with an explicit receiver, as class is also a reserved word in Ruby.

1.class #=> Integer

self.class #=> Object

Equivalent to Object#class in Ruby.

Returns the class of obj, skipping singleton classes or module inclusions. ++

Definition at line 277 of file object.c.

References CLASS_OF, and rb_class_real().

Referenced by BIGNUM_1c(), rb_ary_subseq(), rb_block_to_s(), rb_check_inheritable(), rb_define_class(), rb_define_class_id_under(), rb_define_module(), rb_define_module_id_under(), rb_obj_init_copy(), rb_struct_members(), and rb_vm_bugreport().

◆ rb_obj_clone()

VALUE rb_obj_clone ( VALUE obj )

:nodoc

Almost same as Object::clone ++

Definition at line 475 of file object.c.

Referenced by rb_eval_string_wrap().

◆ rb_obj_dup()

VALUE rb_obj_dup ( VALUE obj )

call-seq: obj.dup -> an_object

Produces a shallow copy of obj—the instance variables of obj are copied, but not the objects they reference. dup copies the tainted state of obj.

This method may have class-specific behavior. If so, that behavior will be documented under the #+initialize_copy+ method of the class.

=== on dup vs clone

In general, clone and dup may have different semantics in descendant classes. While clone is used to duplicate an object, including its internal state, dup typically uses the class of the descendant object to create the new instance.

When using #dup, any modules that the object has been extended with will not be copied.

  class Klass
    attr_accessor :str
  end

  module Foo
    def foo; 'foo'; end
  end

  s1 = Klass.new #=> #<Klass:0x401b3a38>
  s1.extend(Foo) #=> #<Klass:0x401b3a38>
  s1.foo #=> "foo"

  s2 = s1.clone #=> #<Klass:0x401b3a38>
  s2.foo #=> "foo"

  s3 = s1.dup #=> #<Klass:0x401b3a38>
  s3.foo #=> NoMethodError: undefined method `foo' for #<Klass:0x401b3a38>

– Equivalent to Object#dup in Ruby ++

Definition at line 526 of file object.c.

◆ rb_obj_freeze()

VALUE rb_obj_freeze ( VALUE obj )

call-seq: obj.freeze -> obj

Prevents further modifications to obj. A RuntimeError will be raised if modification is attempted. There is no way to unfreeze a frozen object. See also Object::frozen?.

This method returns self.

a = [ "a", "b", "c" ] a.freeze a << "z"

produces:

prog.rb:3:in `<<': can't modify frozen Array (RuntimeError) from prog.rb:3

Objects of the following classes are always frozen: Integer,

Float, Symbol.

Make the object unmodifiable. Equivalent to Object#freeze in Ruby.

Parameters

[in,out] obj the object to be frozen

Returns: the frozen object ++

Definition at line 1331 of file object.c.

References OBJ_FREEZE, OBJ_FROZEN, rb_bug(), and SPECIAL_CONST_P.

Referenced by rb_ary_freeze(), rb_insns_name_array(), rb_iseq_pathobj_new(), rb_str_freeze(), and rb_vm_register_special_exception_str().

◆ rb_obj_frozen_p()

VALUE rb_obj_frozen_p ( VALUE obj )

call-seq: obj.frozen? -> true or false

Returns the freeze status of obj.

a = [ "a", "b", "c" ] a.freeze #=> ["a", "b", "c"]

a.frozen? #=> true

Determines if the object is frozen. Equivalent to Object#frozen? in Ruby.

Parameters

[in] obj the object to be determines

Return values

Qtrue	if frozen
Qfalse	if not frozen ++

Definition at line 1360 of file object.c.

References OBJ_FROZEN, Qfalse, and Qtrue.

◆ rb_obj_hash()

VALUE rb_obj_hash ( VALUE obj )

Definition at line 258 of file hash.c.

◆ rb_obj_hide()

VALUE rb_obj_hide ( VALUE obj )

Make the object invisible from Ruby code.

It is useful to let Ruby's GC manage your internal data structure – The object keeps being managed by GC, but ObjectSpace.each_object never yields the object.

Note that the object also lose a way to call a method on it.

Parameters

[in] obj a Ruby object

See also: rb_obj_reveal

Definition at line 72 of file object.c.

References RBASIC_CLEAR_CLASS, and SPECIAL_CONST_P.

◆ rb_obj_infect()

void rb_obj_infect	(	VALUE	victim,
		VALUE	carrier
	)

Convenient function to infect victim with the taintedness of carrier.

It just keeps the taintedness of victim if carrier is not tainted.

Parameters

[in,out]	victim	the object being infected with the taintness of carrier
[in]	carrier	a possibly tainted object

Definition at line 1296 of file object.c.

References OBJ_INFECT.

◆ rb_obj_init_copy()

VALUE rb_obj_init_copy	(	VALUE	obj,
		VALUE	orig
	)

:nodoc:

Default implementation of #initialize_copy

Parameters

[in,out]	obj	the receiver being initialized
[in]	orig	the object to be copied from. ++

Definition at line 590 of file object.c.

References rb_check_frozen, rb_check_trusted(), rb_eTypeError, rb_obj_class(), rb_raise(), and TYPE.

◆ rb_obj_init_dup_clone()

VALUE rb_obj_init_dup_clone	(	VALUE	obj,
		VALUE	orig
	)

:nodoc:

Default implementation of #initialize_dup and #initialize_clone

Parameters

[in,out]	obj	the receiver being initialized
[in]	orig	the object to be dup or cloned from. ++

Definition at line 611 of file object.c.

References rb_funcall().

◆ rb_obj_is_instance_of()

VALUE rb_obj_is_instance_of	(	VALUE	obj,
		VALUE	c
	)

call-seq: obj.instance_of?(class) -> true or false

Returns true if obj is an instance of the given class. See also Object::kind_of?.

class A; end class B < A; end class C < B; end

b = B.new b.instance_of? A #=> false b.instance_of? B #=> true

b.instance_of? C #=> false

Determines if obj is an instance of c.

Equivalent to Object#is_instance_of in Ruby.

Parameters

[in]	obj	the object to be determined.
[in]	c	a Class object ++

Definition at line 798 of file object.c.

◆ rb_obj_is_kind_of()

VALUE rb_obj_is_kind_of	(	VALUE	obj,
		VALUE	c
	)

call-seq: obj.is_a?(class) -> true or false obj.kind_of?(class) -> true or false

Returns true if class is the class of obj, or if class is one of the superclasses of obj or modules included in obj.

module M; end class A include M end class B < A; end class C < B; end

b = B.new b.is_a? A #=> true b.is_a? B #=> true b.is_a? C #=> false b.is_a? M #=> true

b.kind_of? A #=> true b.kind_of? B #=> true b.kind_of? C #=> false

b.kind_of? M #=> true

Determines if obj is a kind of c.

Equivalent to Object#kind_of? in Ruby.

Parameters

[in]	obj	the object to be determined
[in]	c	a Module object. ++

Definition at line 842 of file object.c.

References CLASS_OF.

Referenced by ole_val2variant(), ossl_evp_get_cipherbyname(), rb_check_to_float(), rb_enumeratorize_with_size(), rb_range_values(), and rb_set_errinfo().

◆ rb_obj_reveal()

VALUE rb_obj_reveal	(	VALUE	obj,
		VALUE	klass
	)

Make a hidden object visible again.

It is the caller's responsibility to pass the right klass which obj originally used to belong to.

See also: rb_obj_hide

Definition at line 89 of file object.c.

References RBASIC_SET_CLASS, and SPECIAL_CONST_P.

◆ rb_obj_setup()

VALUE rb_obj_setup	(	VALUE	obj,
		VALUE	klass,
		VALUE	type
	)

Fills common (RBasic) fields in obj.

Note: Prefer rb_newobj_of() to this function.

Parameters

[in,out]	obj	a Ruby object to be set up.
[in]	klass	`obj` will belong to this class.
[in]	type	one of `ruby_value_type`

Definition at line 106 of file object.c.

References RBASIC, and RBASIC_SET_CLASS.

◆ rb_obj_taint()

VALUE rb_obj_taint ( VALUE obj )

call-seq: obj.taint -> obj

Mark the object as tainted.

Objects that are marked as tainted will be restricted from various built-in methods. This is to prevent insecure data, such as command-line arguments or strings read from Kernel::gets, from inadvertently compromising the user's system.

To check whether an object is tainted, use #tainted?.

You should only untaint a tainted object if your code has inspected it and

determined that it is safe. To do so use #untaint.

Marks the object as tainted. Equivalent to Object#taint in Ruby

Parameters

[in] obj the object to be tainted

Returns: the object itself

See also: rb_obj_untaint; rb_obj_tainted ++

Definition at line 1179 of file object.c.

References OBJ_TAINT, OBJ_TAINTABLE, OBJ_TAINTED, and rb_check_frozen.

Referenced by rb_obj_untrust().

◆ rb_obj_tainted()

VALUE rb_obj_tainted ( VALUE obj )

call-seq: obj.tainted? -> true or false

Returns true if the object is tainted.

See #taint for more information.

Determines if obj is tainted. Equivalent to Object#tainted? in Ruby.

Parameters

[in] obj the object to be determined

Return values

Qtrue	if the object is tainted
Qfalse	if the object is not tainted

See also: rb_obj_taint; rb_obj_untaint ++

Definition at line 1147 of file object.c.

References OBJ_TAINTED, Qfalse, and Qtrue.

Referenced by rb_obj_untrusted().

◆ rb_obj_trust()

VALUE rb_obj_trust ( VALUE obj )

call-seq: obj.trust -> obj

Deprecated method that is equivalent to #untaint.

Deprecated:: Use rb_obj_untaint(obj)

Trustiness used to have independent semantics from taintedness. But now trustiness of objects is obsolete and this function behaves the same as rb_obj_untaint.

See also: rb_obj_untaint ++

Definition at line 1281 of file object.c.

References rb_obj_untaint(), and rb_warning().

◆ rb_obj_untaint()

VALUE rb_obj_untaint ( VALUE obj )

call-seq: obj.untaint -> obj

Removes the tainted mark from the object.

See #taint for more information.

Removes the tainted mark from the object. Equivalent to Object#untaint in Ruby.

Parameters

[in] obj the object to be tainted

Returns: the object itself

See also: rb_obj_taint; rb_obj_tainted ++

Definition at line 1208 of file object.c.

References FL_TAINT, FL_UNSET, OBJ_TAINTED, and rb_check_frozen.

Referenced by rb_obj_trust().

◆ rb_obj_untrust()

VALUE rb_obj_untrust ( VALUE obj )

call-seq: obj.untrust -> obj

Deprecated method that is equivalent to #taint.

Deprecated:: Use rb_obj_taint(obj)

Trustiness used to have independent semantics from taintedness. But now trustiness of objects is obsolete and this function behaves the same as rb_obj_taint.

See also: rb_obj_taint ++

Definition at line 1257 of file object.c.

References rb_obj_taint(), and rb_warning().

◆ rb_obj_untrusted()

VALUE rb_obj_untrusted ( VALUE obj )

call-seq: obj.untrusted? -> true or false

Deprecated method that is equivalent to #tainted?.

Deprecated:: Use rb_obj_tainted.

Trustiness used to have independent semantics from taintedness. But now trustiness of objects is obsolete and this function behaves the same as rb_obj_tainted.

See also: rb_obj_tainted ++

Definition at line 1234 of file object.c.

References rb_obj_tainted(), and rb_warning().

◆ rb_str_escape()

VALUE rb_str_escape ( VALUE str )

Definition at line 5737 of file string.c.

References buf, CHAR_ESC_LEN, ENCODING_GET, rb_enc_from_index(), RSTRING_END, and RSTRING_PTR.

Referenced by rb_any_to_s(), and rb_inspect().

◆ rb_str_to_dbl()

double rb_str_to_dbl	(	VALUE	str,
		int	badcheck
	)

Parses a string representation of a floating point number.

Parameters

[in]	str	a `String` object representation of a floating number
[in]	badcheck	raises an exception on parse error if badcheck is non-zero.

Returns: the floating point number in the string on success, 0.0 on parse error and badcheck is zero.

Note: it always fails to parse a hexadecimal representation like "0xAB.CDp+1" when badcheck is zero, even though it would success if badcheck was non-zero. This inconsistency is coming from a historical compatibility reason. [ruby-dev:40822]

Definition at line 3298 of file object.c.

References ALLOCV, ALLOCV_END, len, MEMCPY, rb_cstr_to_dbl(), rb_eArgError, rb_raise(), RSTRING_LEN, RSTRING_PTR, and StringValue.

◆ rb_String()

VALUE rb_String ( VALUE val )

Equivalent to Kernel#String in Ruby.

Converts val into String by trying #to_str at first and then trying #to_s.

Definition at line 3560 of file object.c.

References NIL_P, rb_check_string_type(), rb_convert_type_with_id(), and T_STRING.

◆ rb_to_float()

VALUE rb_to_float ( VALUE val )

Converts a Numeric object into Float.

Parameters

[in] val a Numeric object

Exceptions

TypeError if val is not a Numeric or other conversion failures.

Definition at line 3448 of file object.c.

◆ rb_to_int()

VALUE rb_to_int ( VALUE val )

Converts val into Integer.

It calls #to_int method if necessary.

Parameters

[in] val a Ruby object

Returns: an Integer object

Exceptions

TypeError on failure

Definition at line 3084 of file object.c.

Referenced by rb_absint_singlebit_p(), rb_absint_size(), rb_integer_pack(), rb_num2fix(), and rb_num2long().

Variable Documentation

◆ rb_cBasicObject

VALUE rb_cBasicObject

BasicObject class.

Definition at line 31 of file object.c.

Referenced by rb_class_superclass().

◆ rb_cClass

VALUE rb_cClass

Class class.

Definition at line 35 of file object.c.

◆ rb_cData

VALUE rb_cData

Data class.

Definition at line 36 of file object.c.

◆ rb_cFalseClass

VALUE rb_cFalseClass

FalseClass class.

Definition at line 40 of file object.c.

◆ rb_cModule

VALUE rb_cModule

Module class.

Definition at line 34 of file object.c.

◆ rb_cNilClass

VALUE rb_cNilClass

NilClass class.

Definition at line 38 of file object.c.

◆ rb_cObject

VALUE rb_cObject

Object class.

Definition at line 33 of file object.c.

◆ rb_cTrueClass

VALUE rb_cTrueClass

TrueClass class.

Definition at line 39 of file object.c.

◆ rb_mKernel

VALUE rb_mKernel

Kernel module.

Definition at line 32 of file object.c.

Macros

Functions

:nodoc

:nodoc:

:nodoc:

Variables

Detailed Description

Macro Definition Documentation

◆ id_for_setter

◆ id_for_var

◆ IMPLICIT_CONVERSIONS

Function Documentation

◆ Init_Object()

◆ rb_any_to_s()

◆ rb_Array()

◆ rb_check_convert_type()

◆ rb_check_to_float()

◆ rb_check_to_int()

◆ rb_check_to_integer()

◆ rb_class_get_superclass()

◆ rb_class_inherited_p()

"class A < B" implies "A < B".)

◆ rb_class_new_instance()

◆ rb_class_real()

◆ rb_class_superclass()

◆ rb_convert_type()

◆ rb_cstr_to_dbl()

◆ rb_eql()

◆ rb_equal()

meaningful semantics in +case+ statements.

◆ rb_Float()

◆ rb_Hash()

◆ rb_inspect()

◆ rb_Integer()

◆ rb_num2dbl()

◆ rb_obj_alloc()

◆ rb_obj_call_init()

◆ rb_obj_class()

self.class #=> Object

◆ rb_obj_clone()

:nodoc

◆ rb_obj_dup()

◆ rb_obj_freeze()

Float, Symbol.

◆ rb_obj_frozen_p()

a.frozen? #=> true

◆ rb_obj_hash()

◆ rb_obj_hide()

◆ rb_obj_infect()

◆ rb_obj_init_copy()

:nodoc:

◆ rb_obj_init_dup_clone()

:nodoc:

◆ rb_obj_is_instance_of()

b.instance_of? C #=> false

◆ rb_obj_is_kind_of()

b.kind_of? M #=> true

◆ rb_obj_reveal()

◆ rb_obj_setup()

◆ rb_obj_taint()

determined that it is safe. To do so use #untaint.

◆ rb_obj_tainted()

See #taint for more information.

◆ rb_obj_trust()

Deprecated method that is equivalent to #untaint.

◆ rb_obj_untaint()

See #taint for more information.

◆ rb_obj_untrust()

Deprecated method that is equivalent to #taint.

◆ rb_obj_untrusted()

Deprecated method that is equivalent to #tainted?.

◆ rb_str_escape()

◆ rb_str_to_dbl()

◆ rb_String()

◆ rb_to_float()

◆ rb_to_int()

Variable Documentation

◆ rb_cBasicObject

◆ rb_cClass

◆ rb_cData