d7/d93/include_2ruby_2internal_2intern_2object_8h_source.html

#ifndef RBIMPL_INTERN_OBJECT_H                       /*-*-C++-*-vi:se ft=cpp:*/

#define RBIMPL_INTERN_OBJECT_H

#include "ruby/internal/attr/const.h"

#include "ruby/internal/attr/deprecated.h"

#include "ruby/internal/attr/nonnull.h"

#include "ruby/internal/attr/pure.h"

#include "ruby/internal/dllexport.h"

#include "ruby/internal/value.h"


RBIMPL_SYMBOL_EXPORT_BEGIN()


#define RB_OBJ_INIT_COPY(obj, orig) \

    ((obj) != (orig) && (rb_obj_init_copy((obj), (orig)), 1))


#define OBJ_INIT_COPY(obj, orig) RB_OBJ_INIT_COPY(obj, orig)


/* object.c */


VALUE rb_class_new_instance_pass_kw(int argc, const VALUE *argv, VALUE klass);


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


VALUE rb_class_new_instance_kw(int argc, const VALUE *argv, VALUE klass, int kw_splat);


int rb_eql(VALUE lhs, VALUE rhs);


VALUE rb_any_to_s(VALUE obj);


VALUE rb_inspect(VALUE obj);


VALUE rb_obj_is_instance_of(VALUE obj, VALUE klass);


VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass);


VALUE rb_obj_alloc(VALUE klass);


VALUE rb_obj_clone(VALUE obj);


VALUE rb_obj_dup(VALUE obj);


VALUE rb_obj_init_copy(VALUE src, VALUE dst);


RBIMPL_ATTR_DEPRECATED_EXT(("taintedness turned out to be a wrong idea."))

VALUE rb_obj_taint(VALUE obj);


RBIMPL_ATTR_PURE()

RBIMPL_ATTR_DEPRECATED_EXT(("taintedness turned out to be a wrong idea."))

VALUE rb_obj_tainted(VALUE obj);


RBIMPL_ATTR_DEPRECATED_EXT(("taintedness turned out to be a wrong idea."))

VALUE rb_obj_untaint(VALUE obj);


RBIMPL_ATTR_DEPRECATED_EXT(("trustedness turned out to be a wrong idea."))

VALUE rb_obj_untrust(VALUE obj);


RBIMPL_ATTR_PURE()

RBIMPL_ATTR_DEPRECATED_EXT(("trustedness turned out to be a wrong idea."))

VALUE rb_obj_untrusted(VALUE obj);


RBIMPL_ATTR_DEPRECATED_EXT(("trustedness turned out to be a wrong idea."))

VALUE rb_obj_trust(VALUE obj);


VALUE rb_obj_freeze(VALUE obj);


RBIMPL_ATTR_PURE()

VALUE rb_obj_frozen_p(VALUE obj);


/* gc.c */


VALUE rb_obj_id(VALUE obj);


RBIMPL_ATTR_CONST()

VALUE rb_memory_id(VALUE obj);


/* object.c */


RBIMPL_ATTR_PURE()

VALUE rb_class_real(VALUE klass);


RBIMPL_ATTR_PURE()

VALUE rb_class_inherited_p(VALUE scion, VALUE ascendant);


RBIMPL_ATTR_PURE()

VALUE rb_class_superclass(VALUE klass);


RBIMPL_ATTR_NONNULL(())

VALUE rb_convert_type(VALUE val, int type, const char *name, const char *mid);


RBIMPL_ATTR_NONNULL(())

VALUE rb_check_convert_type(VALUE val, int type, const char *name, const char *mid);


RBIMPL_ATTR_NONNULL(())

VALUE rb_check_to_integer(VALUE val, const char *mid);


VALUE rb_check_to_float(VALUE val);


VALUE rb_to_int(VALUE val);


VALUE rb_check_to_int(VALUE val);


VALUE rb_Integer(VALUE val);


VALUE rb_to_float(VALUE val);


VALUE rb_Float(VALUE val);


VALUE rb_String(VALUE val);


VALUE rb_Array(VALUE val);


VALUE rb_Hash(VALUE val);


RBIMPL_ATTR_NONNULL(())

double rb_cstr_to_dbl(const char *str, int mode);


double rb_str_to_dbl(VALUE str, int mode);


RBIMPL_SYMBOL_EXPORT_END()


#endif /* RBIMPL_INTERN_OBJECT_H */

const.h
Defines RBIMPL_ATTR_CONST.

RBIMPL_ATTR_CONST
#define RBIMPL_ATTR_CONST()
Wraps (or simulates) __attribute__((const))
Definition const.h:36

deprecated.h
Defines RBIMPL_ATTR_DEPRECATED.

RBIMPL_ATTR_DEPRECATED_EXT
#define RBIMPL_ATTR_DEPRECATED_EXT(msg)
This is when a function is used internally (for backwards compatibility etc.), but extension librarie...
Definition deprecated.h:72

dllexport.h
Tweaking visibility of C variables/functions.

RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:106

RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:97

rb_class_superclass
VALUE rb_class_superclass(VALUE klass)
Queries the parent of the given class.
Definition object.c:1971

rb_obj_taint
VALUE rb_obj_taint(VALUE obj)
Definition object.c:1066

rb_obj_trust
VALUE rb_obj_trust(VALUE obj)
Definition object.c:1124

rb_convert_type
VALUE rb_convert_type(VALUE val, int type, const char *name, const char *mid)
Converts an object into another type.
Definition object.c:2906

rb_Float
VALUE rb_Float(VALUE val)
This is the logic behind Kernel#Float.
Definition object.c:3441

rb_check_to_int
VALUE rb_check_to_int(VALUE val)
Identical to rb_check_to_integer(), except it uses #to_int for conversion.
Definition object.c:3004

rb_check_convert_type
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:2933

rb_any_to_s
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
Definition object.c:553

rb_obj_alloc
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
Definition object.c:1909

rb_class_new_instance
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
Definition object.c:1950

rb_class_new_instance_kw
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:1938

rb_class_new_instance_pass_kw
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:1927

rb_check_to_float
VALUE rb_check_to_float(VALUE val)
This is complicated.
Definition object.c:3480

rb_Hash
VALUE rb_Hash(VALUE val)
This is the logic behind Kernel#Hash.
Definition object.c:3636

rb_obj_frozen_p
VALUE rb_obj_frozen_p(VALUE obj)
Just calls RB_OBJ_FROZEN() inside.
Definition object.c:1173

rb_obj_init_copy
VALUE rb_obj_init_copy(VALUE src, VALUE dst)
Default implementation of #initialize_copy, #initialize_dup and #initialize_clone.
Definition object.c:500

rb_eql
int rb_eql(VALUE lhs, VALUE rhs)
Checks for equality of the passed objects, in terms of Object#eql?.
Definition object.c:133

rb_str_to_dbl
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:3325

rb_Integer
VALUE rb_Integer(VALUE val)
This is the logic behind Kernel#Integer.
Definition object.c:3070

rb_Array
VALUE rb_Array(VALUE val)
This is the logic behind Kernel#Array.
Definition object.c:3593

rb_obj_dup
VALUE rb_obj_dup(VALUE obj)
Duplicates the given object.
Definition object.c:451

rb_inspect
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:564

rb_obj_untrust
VALUE rb_obj_untrust(VALUE obj)
Definition object.c:1109

rb_class_inherited_p
VALUE rb_class_inherited_p(VALUE scion, VALUE ascendant)
Determines if the given two modules are relatives.
Definition object.c:1608

rb_obj_is_instance_of
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:695

rb_class_real
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
Definition object.c:178

rb_to_float
VALUE rb_to_float(VALUE val)
Identical to rb_check_to_float(), except it raises on error.
Definition object.c:3470

rb_obj_clone
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
Definition object.c:405

rb_obj_is_kind_of
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:731

rb_cstr_to_dbl
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:3284

rb_obj_freeze
VALUE rb_obj_freeze(VALUE obj)
Just calls rb_obj_freeze_inline() inside.
Definition object.c:1161

rb_check_to_integer
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:2985

rb_obj_untrusted
VALUE rb_obj_untrusted(VALUE obj)
Definition object.c:1095

rb_String
VALUE rb_String(VALUE val)
This is the logic behind Kernel#String.
Definition object.c:3564

rb_obj_untaint
VALUE rb_obj_untaint(VALUE obj)
Definition object.c:1081

rb_obj_tainted
VALUE rb_obj_tainted(VALUE obj)
Definition object.c:1052

rb_to_int
VALUE rb_to_int(VALUE val)
Identical to rb_check_to_int(), except it raises in case of conversion mismatch.
Definition object.c:2998

rb_obj_id
VALUE rb_obj_id(VALUE obj)
Finds or creates an integer primary key of the given object.
Definition gc.c:4447

rb_memory_id
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:4414

nonnull.h
Defines RBIMPL_ATTR_NONNULL.

RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30

pure.h
Defines RBIMPL_ATTR_PURE.

RBIMPL_ATTR_PURE
#define RBIMPL_ATTR_PURE()
Wraps (or simulates) __attribute__((pure))
Definition pure.h:33

value.h
Defines VALUE and ID.

VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40