Ruby  3.1.4p223 (2023-03-30 revision HEAD)
variable.h
1 #ifndef INTERNAL_VARIABLE_H /*-*-C-*-vi:se ft=c:*/
2 #define INTERNAL_VARIABLE_H
11 #include "ruby/internal/config.h"
12 #include <stddef.h> /* for size_t */
13 #include "constant.h" /* for rb_const_entry_t */
14 #include "ruby/internal/stdbool.h" /* for bool */
15 #include "ruby/ruby.h" /* for VALUE */
16 
17 /* global variable */
18 
19 #define ROBJECT_TRANSIENT_FLAG FL_USER13
20 
21 /* variable.c */
22 void rb_gc_mark_global_tbl(void);
23 void rb_gc_update_global_tbl(void);
24 size_t rb_generic_ivar_memsize(VALUE);
25 VALUE rb_search_class_path(VALUE);
26 VALUE rb_attr_delete(VALUE, ID);
27 VALUE rb_ivar_lookup(VALUE obj, ID id, VALUE undef);
28 void rb_autoload_str(VALUE mod, ID id, VALUE file);
29 VALUE rb_autoload_at_p(VALUE, ID, int);
30 NORETURN(VALUE rb_mod_const_missing(VALUE,VALUE));
31 rb_gvar_getter_t *rb_gvar_getter_function_of(ID);
32 rb_gvar_setter_t *rb_gvar_setter_function_of(ID);
33 void rb_gvar_readonly_setter(VALUE v, ID id, VALUE *_);
34 void rb_gvar_ractor_local(const char *name);
35 static inline bool ROBJ_TRANSIENT_P(VALUE obj);
36 static inline void ROBJ_TRANSIENT_SET(VALUE obj);
37 static inline void ROBJ_TRANSIENT_UNSET(VALUE obj);
38 uint32_t rb_obj_ensure_iv_index_mapping(VALUE obj, ID id);
39 
40 RUBY_SYMBOL_EXPORT_BEGIN
41 /* variable.c (export) */
42 void rb_mark_generic_ivar(VALUE);
43 void rb_mv_generic_ivar(VALUE src, VALUE dst);
44 VALUE rb_const_missing(VALUE klass, VALUE name);
45 int rb_class_ivar_set(VALUE klass, ID vid, VALUE value);
46 void rb_iv_tbl_copy(VALUE dst, VALUE src);
47 RUBY_SYMBOL_EXPORT_END
48 
49 MJIT_SYMBOL_EXPORT_BEGIN
50 VALUE rb_gvar_get(ID);
51 VALUE rb_gvar_set(ID, VALUE);
52 VALUE rb_gvar_defined(ID);
53 void rb_const_warn_if_deprecated(const rb_const_entry_t *, VALUE, ID);
54 void rb_init_iv_list(VALUE obj);
55 MJIT_SYMBOL_EXPORT_END
56 
57 static inline bool
58 ROBJ_TRANSIENT_P(VALUE obj)
59 {
60 #if USE_TRANSIENT_HEAP
61  return FL_TEST_RAW(obj, ROBJECT_TRANSIENT_FLAG);
62 #else
63  return false;
64 #endif
65 }
66 
67 static inline void
68 ROBJ_TRANSIENT_SET(VALUE obj)
69 {
70 #if USE_TRANSIENT_HEAP
71  FL_SET_RAW(obj, ROBJECT_TRANSIENT_FLAG);
72 #endif
73 }
74 
75 static inline void
76 ROBJ_TRANSIENT_UNSET(VALUE obj)
77 {
78 #if USE_TRANSIENT_HEAP
79  FL_UNSET_RAW(obj, ROBJECT_TRANSIENT_FLAG);
80 #endif
81 }
82 
83 #endif /* INTERNAL_VARIABLE_H */
#define FL_UNSET_RAW
Old name of RB_FL_UNSET_RAW.
Definition: fl_type.h:142
#define FL_TEST_RAW
Old name of RB_FL_TEST_RAW.
Definition: fl_type.h:140
#define FL_SET_RAW
Old name of RB_FL_SET_RAW.
Definition: fl_type.h:138
void rb_gvar_setter_t(VALUE val, ID id, VALUE *data)
Type that represents a global variable setter function.
Definition: variable.h:46
rb_gvar_setter_t rb_gvar_readonly_setter
This function just raises rb_eNameError.
Definition: variable.h:135
VALUE rb_gvar_getter_t(ID id, VALUE *data)
Type that represents a global variable getter function.
Definition: variable.h:37
#define _(args)
This was a transition path from K&R to ANSI.
Definition: stdarg.h:35
C99 shim for <stdbool.h>
Definition: constant.h:33
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition: value.h:52
uintptr_t VALUE
Type that represents a Ruby object.
Definition: value.h:40