Ruby 3.1.3p185 (2022-11-24 revision 1a6b16756e0ba6b95ab71a441357ed5484e33498)
variable.h
Go to the documentation of this file.
1#ifndef RBIMPL_INTERN_VARIABLE_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_INTERN_VARIABLE_H
26#include "ruby/internal/value.h"
27#include "ruby/st.h"
28
30
31/* variable.c */
32
33
40VALUE rb_mod_name(VALUE mod);
41
49VALUE rb_class_path(VALUE mod);
50
58VALUE rb_class_path_cached(VALUE mod);
59
69void rb_set_class_path(VALUE klass, VALUE space, const char *name);
70
80void rb_set_class_path_string(VALUE klass, VALUE space, VALUE name);
81
91VALUE rb_path_to_class(VALUE path);
92
102VALUE rb_path2class(const char *path);
103
110VALUE rb_class_name(VALUE obj);
111
130VALUE rb_autoload_load(VALUE space, ID name);
131
140VALUE rb_autoload_p(VALUE space, ID name);
141
154VALUE rb_f_trace_var(int argc, const VALUE *argv);
155
169VALUE rb_f_untrace_var(int argc, const VALUE *argv);
170
180VALUE rb_f_global_variables(void);
181
201void rb_alias_variable(ID dst, ID src);
202
217void rb_free_generic_ivar(VALUE obj);
218
228VALUE rb_ivar_get(VALUE obj, ID name);
229
243VALUE rb_ivar_set(VALUE obj, ID name, VALUE val);
244
254VALUE rb_ivar_defined(VALUE obj, ID name);
255
263void rb_ivar_foreach(VALUE obj, int (*func)(ID name, VALUE val, st_data_t arg), st_data_t arg);
264
271st_index_t rb_ivar_count(VALUE obj);
272
285VALUE rb_attr_get(VALUE obj, ID name);
286
295VALUE rb_obj_instance_variables(VALUE obj);
296
305VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name);
306
316void *rb_mod_const_at(VALUE, void*);
317
323void *rb_mod_const_of(VALUE, void*);
324
331VALUE rb_const_list(void*);
332
346VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv);
347
360VALUE rb_mod_remove_const(VALUE space, VALUE name);
361
375int rb_const_defined(VALUE space, ID name);
376
393int rb_const_defined_at(VALUE space, ID name);
394
411int rb_const_defined_from(VALUE space, ID name);
412
425VALUE rb_const_get(VALUE space, ID name);
426
441VALUE rb_const_get_at(VALUE space, ID name);
442
457VALUE rb_const_get_from(VALUE space, ID name);
458
473void rb_const_set(VALUE space, ID name, VALUE val);
474
488VALUE rb_const_remove(VALUE space, ID name);
489
490#if 0 /* EXPERIMENTAL: remove if no problem */
499VALUE rb_mod_const_missing(VALUE space, VALUE name);
500#endif
501
515VALUE rb_cvar_defined(VALUE klass, ID name);
516
529void rb_cvar_set(VALUE klass, ID name, VALUE val);
530
544VALUE rb_cvar_get(VALUE klass, ID name);
545
565VALUE rb_cvar_find(VALUE klass, ID name, VALUE *front);
566
576void rb_cv_set(VALUE klass, const char *name, VALUE val);
577
588VALUE rb_cv_get(VALUE klass, const char *name);
589
598void rb_define_class_variable(VALUE, const char*, VALUE);
599
614VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv);
615
624VALUE rb_mod_remove_cvar(VALUE mod, VALUE name);
625
627
628#endif /* RBIMPL_INTERN_VARIABLE_H */
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_mod_remove_cvar(VALUE mod, VALUE name)
Resembles Module#remove_class_variable.
Definition: variable.c:3722
VALUE rb_obj_instance_variables(VALUE obj)
Resembles Object#instance_variables.
Definition: variable.c:1886
VALUE rb_f_untrace_var(int argc, const VALUE *argv)
Deletes the passed tracer from the passed global variable, or if omitted, deletes everything.
Definition: variable.c:657
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
Definition: variable.c:2733
VALUE rb_const_list(void *)
This is another mysterious API that comes with no documents at all.
Definition: variable.c:2949
VALUE rb_path2class(const char *path)
Resolves a Q::W::E::R-style path string to the actual class it points.
Definition: variable.c:288
VALUE rb_autoload_p(VALUE space, ID name)
Queries if an autoload is defined at a point.
Definition: variable.c:2606
VALUE rb_attr_get(VALUE obj, ID name)
Identical to rb_ivar_get()
Definition: variable.c:1293
void rb_set_class_path(VALUE klass, VALUE space, const char *name)
Names a class.
Definition: variable.c:235
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
Definition: variable.c:1575
VALUE rb_mod_remove_const(VALUE space, VALUE name)
Resembles Module#remove_const.
Definition: variable.c:2825
VALUE rb_class_path_cached(VALUE mod)
Just another name of rb_mod_name.
Definition: variable.c:181
VALUE rb_f_trace_var(int argc, const VALUE *argv)
Traces a global variable.
Definition: variable.c:611
void rb_cvar_set(VALUE klass, ID name, VALUE val)
Assigns a value to a class variable.
Definition: variable.c:3487
VALUE rb_cvar_get(VALUE klass, ID name)
Obtains a value from a class variable.
Definition: variable.c:3556
VALUE rb_mod_constants(int argc, const VALUE *argv, VALUE recv)
Resembles Module#constants.
Definition: variable.c:2981
VALUE rb_cvar_find(VALUE klass, ID name, VALUE *front)
Identical to rb_cvar_get(), except it takes additional "front" pointer.
Definition: variable.c:3541
VALUE rb_path_to_class(VALUE path)
Identical to rb_path2class(), except it accepts the path as Ruby's string instead of C's.
Definition: variable.c:243
VALUE rb_ivar_get(VALUE obj, ID name)
Identical to rb_iv_get(), except it accepts the name as an ID instead of a C string.
Definition: variable.c:1285
void rb_ivar_foreach(VALUE obj, int(*func)(ID name, VALUE val, st_data_t arg), st_data_t arg)
Iterates over an object's instance variables.
void rb_const_set(VALUE space, ID name, VALUE val)
Names a constant.
Definition: variable.c:3106
VALUE rb_autoload_load(VALUE space, ID name)
Kicks the autoload procedure as if it was "touched".
Definition: variable.c:2540
VALUE rb_mod_name(VALUE mod)
Queries the name of a module.
Definition: variable.c:121
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
Definition: variable.c:294
VALUE rb_const_get_at(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
Definition: variable.c:2739
void rb_set_class_path_string(VALUE klass, VALUE space, VALUE name)
Identical to rb_set_class_path(), except it accepts the name as Ruby's string instead of C's.
Definition: variable.c:215
void rb_alias_variable(ID dst, ID src)
Aliases a global variable.
Definition: variable.c:843
void rb_define_class_variable(VALUE, const char *, VALUE)
Just another name of rb_cv_set.
Definition: variable.c:3596
VALUE rb_obj_remove_instance_variable(VALUE obj, VALUE name)
Resembles Object#remove_instance_variable.
Definition: variable.c:1941
void * rb_mod_const_of(VALUE, void *)
This is a variant of rb_mod_const_at().
Definition: variable.c:2927
st_index_t rb_ivar_count(VALUE obj)
Number of instance variables defined on an object.
Definition: variable.c:1818
void * rb_mod_const_at(VALUE, void *)
This API is mysterious.
Definition: variable.c:2910
VALUE rb_const_remove(VALUE space, ID name)
Identical to rb_mod_remove_const(), except it takes the name as ID instead of VALUE.
Definition: variable.c:2836
VALUE rb_const_get_from(VALUE space, ID name)
Identical to rb_const_defined_at(), except it returns the actual defined value.
Definition: variable.c:2727
VALUE rb_ivar_defined(VALUE obj, ID name)
Queries if the instance variable is defined at the object.
Definition: variable.c:1592
VALUE rb_cv_get(VALUE klass, const char *name)
Identical to rb_cvar_get(), except it accepts C's string instead of ID.
Definition: variable.c:3589
int rb_const_defined_at(VALUE space, ID name)
Identical to rb_const_defined(), except it doesn't look for parent classes.
Definition: variable.c:3043
void rb_cv_set(VALUE klass, const char *name, VALUE val)
Identical to rb_cvar_set(), except it accepts C's string instead of ID.
Definition: variable.c:3582
VALUE rb_mod_class_variables(int argc, const VALUE *argv, VALUE recv)
Resembles Module#class_variables.
Definition: variable.c:3687
VALUE rb_f_global_variables(void)
Queries the list of global variables.
Definition: variable.c:811
VALUE rb_cvar_defined(VALUE klass, ID name)
Queries if the given class has the given class variable.
Definition: variable.c:3563
VALUE rb_class_path(VALUE mod)
Identical to rb_mod_name(), except it returns #<Class: ...> style inspection for anonymous modules.
Definition: variable.c:172
int rb_const_defined_from(VALUE space, ID name)
Identical to rb_const_defined(), except it returns false for private constants.
Definition: variable.c:3031
int rb_const_defined(VALUE space, ID name)
Queries if the constant is defined at the namespace.
Definition: variable.c:3037
void rb_free_generic_ivar(VALUE obj)
Frees the list of instance variables.
Definition: variable.c:1155
RBIMPL_ATTR_NORETURN() void rb_eof_error(void)
Utility function to raise rb_eEOFError.
Defines RBIMPL_ATTR_NONNULL.
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition: nonnull.h:27
Defines RBIMPL_ATTR_NORETURN.
Defines VALUE and ID.