Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)
Data Structures | Macros | Functions
Classes and their hierarchy.

Data Structures

struct  clone_method_arg
 
struct  clone_const_arg
 
struct  method_entry_arg
 

Macros

#define id_attached   id__attached__
 
#define METACLASS_OF(k)   RBASIC(k)->klass
 
#define SET_METACLASS_OF(k, cls)   RBASIC_SET_CLASS(k, cls)
 
#define META_CLASS_OF_CLASS_CLASS_P(k)   (METACLASS_OF(k) == (k))
 whether k is a meta^(n)-class of Class class More...
 
#define HAVE_METACLASS_P(k)
 whether k has a metaclass More...
 
#define ENSURE_EIGENCLASS(klass)    (HAVE_METACLASS_P(klass) ? METACLASS_OF(klass) : make_metaclass(klass))
 ensures klass belongs to its own eigenclass. More...
 

Functions

void rb_class_subclass_add (VALUE super, VALUE klass)
 
void rb_class_remove_from_super_subclasses (VALUE klass)
 
void rb_class_remove_from_module_subclasses (VALUE klass)
 
void rb_class_foreach_subclass (VALUE klass, void(*f)(VALUE, VALUE), VALUE arg)
 
void rb_class_detach_subclasses (VALUE klass)
 
void rb_class_detach_module_subclasses (VALUE klass)
 
VALUE rb_class_boot (VALUE super)
 A utility function that wraps class_alloc. More...
 
void rb_check_inheritable (VALUE super)
 Ensures a class can be derived from super. More...
 
VALUE rb_class_new (VALUE super)
 Creates a new class. More...
 
VALUE rb_mod_init_copy (VALUE clone, VALUE orig)
 
VALUE rb_singleton_class_clone (VALUE obj)
 
VALUE rb_singleton_class_clone_and_attach (VALUE obj, VALUE attach)
 
void rb_singleton_class_attached (VALUE klass, VALUE obj)
 Attach a object to a singleton class. More...
 
int rb_singleton_class_internal_p (VALUE sklass)
 
void Init_class_hierarchy (void)
 
VALUE rb_make_metaclass (VALUE obj, VALUE unused)
 
VALUE rb_define_class_id (ID id, VALUE super)
 Defines a new class. More...
 
VALUE rb_class_inherited (VALUE super, VALUE klass)
 Calls Class::inherited. More...
 
VALUE rb_define_class (const char *name, VALUE super)
 Defines a top-level class. More...
 
VALUE rb_define_class_under (VALUE outer, const char *name, VALUE super)
 Defines a class under the namespace of outer. More...
 
VALUE rb_define_class_id_under (VALUE outer, ID id, VALUE super)
 Defines a class under the namespace of outer. More...
 
VALUE rb_module_new (void)
 
VALUE rb_define_module_id (ID id)
 
VALUE rb_define_module (const char *name)
 
VALUE rb_define_module_under (VALUE outer, const char *name)
 
VALUE rb_define_module_id_under (VALUE outer, ID id)
 
VALUE rb_include_class_new (VALUE module, VALUE super)
 
void rb_include_module (VALUE klass, VALUE module)
 
void rb_prepend_module (VALUE klass, VALUE module)
 
VALUE rb_mod_included_modules (VALUE mod)
 
VALUE rb_mod_include_p (VALUE mod, VALUE mod2)
 
VALUE rb_mod_ancestors (VALUE mod)
 
VALUE rb_class_instance_methods (int argc, const VALUE *argv, VALUE mod)
 
VALUE rb_class_protected_instance_methods (int argc, const VALUE *argv, VALUE mod)
 
VALUE rb_class_private_instance_methods (int argc, const VALUE *argv, VALUE mod)
 
VALUE rb_class_public_instance_methods (int argc, const VALUE *argv, VALUE mod)
 
VALUE rb_obj_methods (int argc, const VALUE *argv, VALUE obj)
 
VALUE rb_obj_protected_methods (int argc, const VALUE *argv, VALUE obj)
 
VALUE rb_obj_private_methods (int argc, const VALUE *argv, VALUE obj)
 
VALUE rb_obj_public_methods (int argc, const VALUE *argv, VALUE obj)
 
VALUE rb_obj_singleton_methods (int argc, const VALUE *argv, VALUE obj)
 
VALUE rb_special_singleton_class (VALUE obj)
 
void rb_freeze_singleton_class (VALUE x)
 
VALUE rb_singleton_class_get (VALUE obj)
 Returns the singleton class of obj, or nil if obj is not a singleton object. More...
 
VALUE rb_singleton_class (VALUE obj)
 Returns the singleton class of obj. More...
 
void rb_class_modify_check (VALUE klass)
 Asserts that klass is not a frozen class. More...
 
void rb_extend_object (VALUE obj, VALUE module)
 Extend the object with the module. More...
 

Detailed Description

Terminology
  • class: same as in Ruby.
  • singleton class: class for a particular object
  • eigenclass: = singleton class
  • metaclass: class of a class. metaclass is a kind of singleton class.
  • metametaclass: class of a metaclass.
  • meta^(n)-class: class of a meta^(n-1)-class.
  • attached object: A singleton class knows its unique instance. The instance is called the attached object for the singleton class.

Macro Definition Documentation

◆ ENSURE_EIGENCLASS

#define ENSURE_EIGENCLASS (   klass)     (HAVE_METACLASS_P(klass) ? METACLASS_OF(klass) : make_metaclass(klass))

ensures klass belongs to its own eigenclass.

Returns
the eigenclass of klass
Postcondition
klass belongs to the returned eigenclass. i.e. the attached object of the eigenclass is klass.
Note
this macro creates a new eigenclass if necessary.

Definition at line 576 of file class.c.

◆ HAVE_METACLASS_P

#define HAVE_METACLASS_P (   k)
Value:
rb_singleton_class_has_metaclass_p(k))
#define FL_SINGLETON
Definition: fl_type.h:49
#define METACLASS_OF(k)
Definition: class.c:44
#define FL_TEST
Definition: fl_type.h:130

whether k has a metaclass

Return values
1if k has a metaclass
0otherwise

Definition at line 565 of file class.c.

◆ id_attached

#define id_attached   id__attached__

Definition at line 42 of file class.c.

◆ META_CLASS_OF_CLASS_CLASS_P

#define META_CLASS_OF_CLASS_CLASS_P (   k)    (METACLASS_OF(k) == (k))

whether k is a meta^(n)-class of Class class

Return values
1if k is a meta^(n)-class of Class class (n >= 0)
0otherwise

Definition at line 545 of file class.c.

◆ METACLASS_OF

#define METACLASS_OF (   k)    RBASIC(k)->klass

Definition at line 44 of file class.c.

◆ SET_METACLASS_OF

#define SET_METACLASS_OF (   k,
  cls 
)    RBASIC_SET_CLASS(k, cls)

Definition at line 45 of file class.c.

Function Documentation

◆ Init_class_hierarchy()

void Init_class_hierarchy ( void  )

◆ rb_check_inheritable()

void rb_check_inheritable ( VALUE  super)

Ensures a class can be derived from super.

Parameters
supera reference to an object.
Exceptions
TypeErrorif super is not a Class or super is a singleton class.

Definition at line 231 of file class.c.

References FL_SINGLETON, PRIsVALUE, rb_cClass, rb_eTypeError, rb_obj_class(), rb_raise(), RBASIC, and T_CLASS.

Referenced by rb_class_new().

◆ rb_class_boot()

VALUE rb_class_boot ( VALUE  super)

A utility function that wraps class_alloc.

allocates a class and initializes safely.

Parameters
supera class from which the new class derives.
Returns
a class object.
Precondition
super must be a class.
Postcondition
the metaclass of the new class is Class.

Definition at line 213 of file class.c.

References rb_cClass, and T_CLASS.

Referenced by rb_class_new().

◆ rb_class_detach_module_subclasses()

void rb_class_detach_module_subclasses ( VALUE  klass)

Definition at line 157 of file class.c.

References Qnil, and rb_class_foreach_subclass().

◆ rb_class_detach_subclasses()

void rb_class_detach_subclasses ( VALUE  klass)

Definition at line 145 of file class.c.

References Qnil, and rb_class_foreach_subclass().

◆ rb_class_foreach_subclass()

void rb_class_foreach_subclass ( VALUE  klass,
void(*)(VALUE, VALUE f,
VALUE  arg 
)

◆ rb_class_inherited()

VALUE rb_class_inherited ( VALUE  super,
VALUE  klass 
)

Calls Class::inherited.

Parameters
superA class which will be called #inherited. NULL means Object class.
klassA Class object which derived from super
Returns
the value Class::inherited's returns
Precondition
Each of super and klass must be a Class object.

Definition at line 722 of file class.c.

References CONST_ID, rb_cObject, and rb_funcall().

Referenced by rb_define_class(), and rb_define_class_id_under().

◆ rb_class_instance_methods()

VALUE rb_class_instance_methods ( int  argc,
const VALUE argv,
VALUE  mod 
)

Definition at line 1474 of file class.c.

References argc, argv, and mod.

◆ rb_class_modify_check()

void rb_class_modify_check ( VALUE  klass)

Asserts that klass is not a frozen class.

Parameters
[in]klassa Module object
Exceptions
RuntimeErrorif klass is not a class or frozen.

Definition at line 477 of file eval.c.

References BUILTIN_TYPE, FL_SINGLETON, FL_TEST, OBJ_FROZEN, PRIsVALUE, rb_frozen_error_raise(), rb_ivar_get(), SPECIAL_CONST_P, T_CLASS, T_ICLASS, T_MODULE, and UNREACHABLE.

Referenced by rb_alias(), rb_deprecate_constant(), and rb_undef().

◆ rb_class_new()

VALUE rb_class_new ( VALUE  super)

Creates a new class.

Parameters
supera class from which the new class derives.
Exceptions
TypeErrorsuper is not inheritable.
TypeErrorsuper is the Class class.

Definition at line 253 of file class.c.

References rb_check_inheritable(), rb_class_boot(), and T_CLASS.

Referenced by Init_IO(), Init_VM(), and rb_define_class_id().

◆ rb_class_private_instance_methods()

VALUE rb_class_private_instance_methods ( int  argc,
const VALUE argv,
VALUE  mod 
)

Definition at line 1512 of file class.c.

References argc, argv, and mod.

◆ rb_class_protected_instance_methods()

VALUE rb_class_protected_instance_methods ( int  argc,
const VALUE argv,
VALUE  mod 
)

Definition at line 1489 of file class.c.

References argc, argv, and mod.

◆ rb_class_public_instance_methods()

VALUE rb_class_public_instance_methods ( int  argc,
const VALUE argv,
VALUE  mod 
)

Definition at line 1527 of file class.c.

References argc, argv, and mod.

◆ rb_class_remove_from_module_subclasses()

void rb_class_remove_from_module_subclasses ( VALUE  klass)

Definition at line 106 of file class.c.

References rb_subclass_entry::klass, rb_subclass_entry::next, NULL, RCLASS_EXT, and xfree.

◆ rb_class_remove_from_super_subclasses()

void rb_class_remove_from_super_subclasses ( VALUE  klass)

Definition at line 88 of file class.c.

References rb_subclass_entry::klass, rb_subclass_entry::next, NULL, RCLASS_EXT, and xfree.

◆ rb_class_subclass_add()

void rb_class_subclass_add ( VALUE  super,
VALUE  klass 
)

Definition at line 48 of file class.c.

References ALLOC, rb_subclass_entry::klass, rb_subclass_entry::next, NULL, Qundef, and RCLASS_EXT.

◆ rb_define_class()

VALUE rb_define_class ( const char *  name,
VALUE  super 
)

Defines a top-level class.

Parameters
namename of the class
supera class from which the new class will derive.
Returns
the created class
Exceptions
TypeErrorif the constant name name is already taken but the constant is not a Class.
TypeErrorif the class is already defined but the class can not be reopened because its superclass is not super.
ArgumentErrorif the super is NULL.
Postcondition
top-level constant named name refers the returned class.
Note
if a class named name is already defined and its superclass is super, the function just returns the defined class.

Definition at line 748 of file class.c.

References id, name, PRIsVALUE, rb_class_inherited(), rb_class_real(), rb_cObject, rb_const_defined(), rb_const_get(), rb_const_set(), rb_define_class_id(), rb_eArgError, rb_eTypeError, rb_intern(), rb_obj_class(), rb_raise(), rb_vm_add_root_module(), RCLASS_SUPER, and T_CLASS.

Referenced by Init_Array(), Init_bigdecimal(), Init_Binding(), Init_Complex(), Init_Cont(), Init_date_core(), Init_dbm(), Init_Dir(), Init_Encoding(), Init_Exception(), Init_File(), Init_gdbm(), Init_Hash(), Init_IO(), Init_monitor(), Init_Numeric(), Init_pathname(), Init_Proc(), Init_Ractor(), Init_Rational(), Init_Regexp(), Init_socket(), Init_String(), Init_stringio(), Init_strscan(), Init_Thread(), Init_Time(), Init_VM(), Init_vm_eval(), Init_vm_trace(), Init_win32ole(), Init_win32ole_error(), Init_win32ole_event(), Init_win32ole_method(), Init_win32ole_param(), Init_win32ole_record(), Init_win32ole_type(), Init_win32ole_typelib(), Init_win32ole_variable(), Init_win32ole_variant(), InitVM_Enumerator(), InitVM_escape(), InitVM_Random(), InitVM_Struct(), rsock_init_addrinfo(), rsock_init_basicsocket(), rsock_init_ipsocket(), rsock_init_socket_init(), rsock_init_sockssocket(), rsock_init_tcpserver(), rsock_init_tcpsocket(), rsock_init_udpsocket(), rsock_init_unixserver(), rsock_init_unixsocket(), and ruby_Init_Continuation_body().

◆ rb_define_class_id()

VALUE rb_define_class_id ( ID  id,
VALUE  super 
)

Defines a new class.

Parameters
idignored
superA class from which the new class will derive. NULL means Object class.
Returns
the created class
Exceptions
TypeErrorif super is not a Class object.
Note
the returned class will not be associated with id. You must explicitly set a class name if necessary.

Definition at line 701 of file class.c.

References rb_class_new(), rb_cObject, rb_make_metaclass(), and RBASIC.

Referenced by InitVM_Random(), rb_define_class(), and rb_define_class_id_under().

◆ rb_define_class_id_under()

VALUE rb_define_class_id_under ( VALUE  outer,
ID  id,
VALUE  super 
)

Defines a class under the namespace of outer.

Parameters
outera class which contains the new class.
idname of the new class
supera class from which the new class will derive. NULL means Object class.
Returns
the created class
Exceptions
TypeErrorif the constant name name is already taken but the constant is not a Class.
TypeErrorif the class is already defined but the class can not be reopened because its superclass is not super.
Postcondition
top-level constant named name refers the returned class.
Note
if a class named name is already defined and its superclass is super, the function just returns the defined class.

Definition at line 820 of file class.c.

References PRIsVALUE, rb_class_inherited(), rb_class_path(), rb_class_real(), rb_const_defined_at(), rb_const_get_at(), rb_const_set(), rb_define_class_id(), rb_eArgError, rb_eTypeError, rb_id2str, rb_obj_class(), rb_raise(), rb_set_class_path_string(), rb_vm_add_root_module(), RCLASS_SUPER, and T_CLASS.

Referenced by rb_define_class_under().

◆ rb_define_class_under()

VALUE rb_define_class_under ( VALUE  outer,
const char *  name,
VALUE  super 
)

Defines a class under the namespace of outer.

Parameters
outera class which contains the new class.
namename of the new class
supera class from which the new class will derive. NULL means Object class.
Returns
the created class
Exceptions
TypeErrorif the constant name name is already taken but the constant is not a Class.
TypeErrorif the class is already defined but the class can not be reopened because its superclass is not super.
Postcondition
top-level constant named name refers the returned class.
Note
if a class named name is already defined and its superclass is super, the function just returns the defined class.

Definition at line 797 of file class.c.

References name, rb_define_class_id_under(), and rb_intern().

Referenced by exp2(), Init_ast(), Init_bubblebabble(), Init_Complex(), Init_Cont(), Init_cparse(), Init_date_core(), Init_Exception(), Init_fiddle(), Init_fiddle_closure(), Init_fiddle_function(), Init_fiddle_handle(), Init_fiddle_pinned(), Init_fiddle_pointer(), Init_File(), Init_GC(), Init_generator(), Init_IO(), Init_ISeq(), Init_md5(), Init_objspace(), Init_openssl(), Init_ossl_asn1(), Init_ossl_bn(), Init_ossl_cipher(), Init_ossl_config(), Init_ossl_dh(), Init_ossl_digest(), Init_ossl_dsa(), Init_ossl_ec(), Init_ossl_engine(), Init_ossl_hmac(), Init_ossl_kdf(), Init_ossl_ns_spki(), Init_ossl_ocsp(), Init_ossl_pkcs12(), Init_ossl_pkcs7(), Init_ossl_pkey(), Init_ossl_rand(), Init_ossl_rsa(), Init_ossl_ssl(), Init_ossl_ssl_session(), Init_ossl_ts(), Init_ossl_x509attr(), Init_ossl_x509cert(), Init_ossl_x509crl(), Init_ossl_x509ext(), Init_ossl_x509name(), Init_ossl_x509req(), Init_ossl_x509revoked(), Init_ossl_x509store(), Init_parser(), Init_psych_emitter(), Init_psych_parser(), Init_psych_to_ruby(), Init_psych_yaml_tree(), Init_pty(), Init_Ractor(), Init_Rational(), Init_rmd160(), Init_sha1(), Init_strscan(), Init_vm_backtrace(), Init_zlib(), InitVM_console(), InitVM_digest(), InitVM_Enumerator(), InitVM_process(), InitVM_transcode(), rb_struct_define_under(), rsock_init_ancdata(), rsock_init_sockifaddr(), and rsock_init_sockopt().

◆ rb_define_module()

VALUE rb_define_module ( const char *  name)

◆ rb_define_module_id()

VALUE rb_define_module_id ( ID  id)

Definition at line 865 of file class.c.

References rb_module_new().

◆ rb_define_module_id_under()

VALUE rb_define_module_id_under ( VALUE  outer,
ID  id 
)

◆ rb_define_module_under()

VALUE rb_define_module_under ( VALUE  outer,
const char *  name 
)

◆ rb_extend_object()

void rb_extend_object ( VALUE  obj,
VALUE  module 
)

◆ rb_freeze_singleton_class()

void rb_freeze_singleton_class ( VALUE  x)

Definition at line 1873 of file class.c.

References FL_FREEZE, FL_SINGLETON, FL_TEST, OBJ_FREEZE_RAW, RBASIC, RBASIC_CLASS, and RCLASS_ORIGIN.

◆ rb_include_class_new()

VALUE rb_include_class_new ( VALUE  module,
VALUE  super 
)

◆ rb_include_module()

void rb_include_module ( VALUE  klass,
VALUE  module 
)

◆ rb_make_metaclass()

VALUE rb_make_metaclass ( VALUE  obj,
VALUE  unused 
)

Definition at line 679 of file class.c.

References BUILTIN_TYPE, and T_CLASS.

Referenced by rb_define_class_id().

◆ rb_mod_ancestors()

VALUE rb_mod_ancestors ( VALUE  mod)

Definition at line 1301 of file class.c.

References BUILTIN_TYPE, mod, rb_ary_new(), rb_ary_push(), RBASIC, RCLASS_ORIGIN, RCLASS_SUPER, and T_ICLASS.

◆ rb_mod_include_p()

VALUE rb_mod_include_p ( VALUE  mod,
VALUE  mod2 
)

Definition at line 1269 of file class.c.

References BUILTIN_TYPE, FL_TEST, mod, Qfalse, Qtrue, RBASIC, RCLASS_SUPER, RICLASS_IS_ORIGIN, T_ICLASS, and T_MODULE.

◆ rb_mod_included_modules()

VALUE rb_mod_included_modules ( VALUE  mod)

◆ rb_mod_init_copy()

VALUE rb_mod_init_copy ( VALUE  clone,
VALUE  orig 
)

◆ rb_module_new()

VALUE rb_module_new ( void  )

◆ rb_obj_methods()

VALUE rb_obj_methods ( int  argc,
const VALUE argv,
VALUE  obj 
)

Definition at line 1563 of file class.c.

References argc, argv, CLASS_OF, rb_check_arity, rb_obj_singleton_methods(), and RTEST.

◆ rb_obj_private_methods()

VALUE rb_obj_private_methods ( int  argc,
const VALUE argv,
VALUE  obj 
)

Definition at line 1597 of file class.c.

References argc, argv, and CLASS_OF.

◆ rb_obj_protected_methods()

VALUE rb_obj_protected_methods ( int  argc,
const VALUE argv,
VALUE  obj 
)

Definition at line 1582 of file class.c.

References argc, argv, and CLASS_OF.

◆ rb_obj_public_methods()

VALUE rb_obj_public_methods ( int  argc,
const VALUE argv,
VALUE  obj 
)

Definition at line 1612 of file class.c.

References argc, argv, and CLASS_OF.

◆ rb_obj_singleton_methods()

VALUE rb_obj_singleton_methods ( int  argc,
const VALUE argv,
VALUE  obj 
)

◆ rb_prepend_module()

void rb_prepend_module ( VALUE  klass,
VALUE  module 
)

◆ rb_singleton_class()

VALUE rb_singleton_class ( VALUE  obj)

Returns the singleton class of obj.

Creates it if necessary.

Parameters
objan arbitrary object.
Exceptions
TypeErrorif obj is an Integer or a Symbol.
Returns
the singleton class.
Postcondition
obj has its own singleton class.
if obj is a class, the returned singleton class also has its own singleton class in order to keep consistency of the inheritance structure of metaclasses.
Note
a new singleton class will be created if obj does not have it.
the singleton classes for nil, true and false are: NilClass, TrueClass and FalseClass.

Definition at line 1924 of file class.c.

References ENSURE_EIGENCLASS, and T_CLASS.

Referenced by Init_date_core(), Init_eval(), Init_eval_method(), Init_nkf(), Init_ossl_rand(), Init_Proc(), Init_Time(), Init_top_self(), Init_VM(), InitVM_process(), InitVM_resolv(), rb_extend_object(), and rb_obj_singleton_methods().

◆ rb_singleton_class_attached()

void rb_singleton_class_attached ( VALUE  klass,
VALUE  obj 
)

Attach a object to a singleton class.

Precondition
klass is the singleton class of obj.

Definition at line 530 of file class.c.

References FL_SINGLETON, FL_TEST, id_attached, rb_class_ivar_set(), RCLASS_IV_TBL, and st_init_numtable.

Referenced by rb_mod_init_copy(), and rb_singleton_class_clone_and_attach().

◆ rb_singleton_class_clone()

VALUE rb_singleton_class_clone ( VALUE  obj)

Definition at line 459 of file class.c.

References Qundef, and rb_singleton_class_clone_and_attach().

Referenced by rb_mod_init_copy(), and rb_singleton_class_clone_and_attach().

◆ rb_singleton_class_clone_and_attach()

VALUE rb_singleton_class_clone_and_attach ( VALUE  obj,
VALUE  attach 
)

◆ rb_singleton_class_get()

VALUE rb_singleton_class_get ( VALUE  obj)

Returns the singleton class of obj, or nil if obj is not a singleton object.

Parameters
objan arbitrary object.
Returns
the singleton class or nil.

Definition at line 1893 of file class.c.

References FL_SINGLETON, FL_TEST, id_attached, Qnil, rb_attr_get(), rb_special_singleton_class(), RBASIC, and SPECIAL_CONST_P.

Referenced by rb_obj_singleton_method().

◆ rb_singleton_class_internal_p()

int rb_singleton_class_internal_p ( VALUE  sklass)

Definition at line 554 of file class.c.

References id_attached, rb_attr_get(), and T_CLASS.

◆ rb_special_singleton_class()

VALUE rb_special_singleton_class ( VALUE  obj)

Definition at line 1819 of file class.c.

Referenced by rb_singleton_class_get().