Ruby 3.2.4p170 (2024-04-23 revision af471c0e0127eea0cafa6f308c0425bbfab0acf5)
object.h
Go to the documentation of this file.
1#ifndef RBIMPL_INTERN_OBJECT_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_INTERN_OBJECT_H
28#include "ruby/internal/value.h"
29
31
32
38#define RB_OBJ_INIT_COPY(obj, orig) \
39 ((obj) != (orig) && (rb_obj_init_copy((obj), (orig)), 1))
41#define OBJ_INIT_COPY(obj, orig) RB_OBJ_INIT_COPY(obj, orig)
42
43/* object.c */
44
57VALUE rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass);
58
71VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass);
72
88VALUE rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat);
89
100int rb_eql(VALUE lhs, VALUE rhs);
101
111
122
133
145
164
180
191
204
213
224
225/* gc.c */
226
246
267
268/* object.c */
269
283
295VALUE rb_class_inherited_p(VALUE scion, VALUE ascendant);
296
311
324VALUE rb_convert_type(VALUE val, int type, const char *name, const char *mid);
325
341VALUE rb_check_convert_type(VALUE val, int type, const char *name, const char *mid);
342
354VALUE rb_check_to_integer(VALUE val, const char *mid);
355
377
387
397
413
422
436VALUE rb_Float(VALUE val);
437
447
456VALUE rb_Array(VALUE val);
457
467VALUE rb_Hash(VALUE val);
468
486double rb_cstr_to_dbl(const char *str, int mode);
487
497double rb_str_to_dbl(VALUE str, int mode);
498
500
501#endif /* RBIMPL_INTERN_OBJECT_H */
Defines RBIMPL_ATTR_CONST.
#define RBIMPL_ATTR_CONST()
Wraps (or simulates) __attribute__((const))
Definition const.h:36
Defines RBIMPL_ATTR_DEPRECATED.
Tweaking visibility of C variables/functions.
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:106
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:97
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
Definition object.c:1995
VALUE rb_convert_type(VALUE val, int type, const char *name, const char *mid)
Converts an object into another type.
Definition object.c:2934
VALUE rb_Float(VALUE val)
This is the logic behind Kernel#Float.
Definition object.c:3532
VALUE rb_check_to_int(VALUE val)
Identical to rb_check_to_integer(), except it uses #to_int for conversion.
Definition object.c:3032
VALUE rb_check_convert_type(VALUE val, int type, const char *name, const char *mid)
Identical to rb_convert_type(), except it returns RUBY_Qnil instead of raising exceptions,...
Definition object.c:2961
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
Definition object.c:589
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
Definition object.c:1939
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
Definition object.c:1980
VALUE rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat)
Identical to rb_class_new_instance(), except you can specify how to handle the last element of the gi...
Definition object.c:1968
VALUE rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass)
Identical to rb_class_new_instance(), except it passes the passed keywords if any to the #initialize ...
Definition object.c:1957
VALUE rb_check_to_float(VALUE val)
This is complicated.
Definition object.c:3571
VALUE rb_Hash(VALUE val)
This is the logic behind Kernel#Hash.
Definition object.c:3730
VALUE rb_obj_frozen_p(VALUE obj)
Just calls RB_OBJ_FROZEN() inside.
Definition object.c:1194
VALUE rb_obj_init_copy(VALUE src, VALUE dst)
Default implementation of #initialize_copy, #initialize_dup and #initialize_clone.
Definition object.c:536
int rb_eql(VALUE lhs, VALUE rhs)
Checks for equality of the passed objects, in terms of Object#eql?.
Definition object.c:135
double rb_str_to_dbl(VALUE str, int mode)
Identical to rb_cstr_to_dbl(), except it accepts a Ruby's string instead of C's.
Definition object.c:3416
VALUE rb_Integer(VALUE val)
This is the logic behind Kernel#Integer.
Definition object.c:3101
VALUE rb_Array(VALUE val)
This is the logic behind Kernel#Array.
Definition object.c:3687
VALUE rb_obj_dup(VALUE obj)
Duplicates the given object.
Definition object.c:487
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:600
VALUE rb_class_inherited_p(VALUE scion, VALUE ascendant)
Determines if the given two modules are relatives.
Definition object.c:1610
VALUE rb_obj_is_instance_of(VALUE obj, VALUE klass)
Queries if the given object is a direct instance of the given class.
Definition object.c:731
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
Definition object.c:180
VALUE rb_to_float(VALUE val)
Identical to rb_check_to_float(), except it raises on error.
Definition object.c:3561
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
Definition object.c:441
VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass)
Queries if the given object is an instance (of possibly descendants) of the given class.
Definition object.c:787
double rb_cstr_to_dbl(const char *str, int mode)
Converts a textual representation of a real number into a numeric, which is the nearest value that th...
Definition object.c:3375
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
Definition object.c:1182
VALUE rb_check_to_integer(VALUE val, const char *mid)
Identical to rb_check_convert_type(), except the return value type is fixed to rb_cInteger.
Definition object.c:3013
VALUE rb_String(VALUE val)
This is the logic behind Kernel#String.
Definition object.c:3655
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
Definition object.c:3026
VALUE rb_obj_id(VALUE obj)
Finds or creates an integer primary key of the given object.
Definition gc.c:4828
VALUE rb_memory_id(VALUE obj)
Identical to rb_obj_id(), except it hesitates from allocating a new instance of rb_cInteger.
Definition gc.c:4795
Defines RBIMPL_ATTR_NONNULL.
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30
Defines RBIMPL_ATTR_PURE.
#define RBIMPL_ATTR_PURE()
Wraps (or simulates) __attribute__((pure))
Definition pure.h:33
Defines VALUE and ID.
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40