Ruby 4.1.0dev (2026-11-19 revision b3e890bf959ffb14f55ecd016717417a62ebd04e)
box.h
1#ifndef INTERNAL_BOX_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_BOX_H
3
4#include "ruby/ruby.h" /* for VALUE */
5
15 /*
16 * To retrieve Ruby::Box object that provides #require and so on.
17 * That is used from load.c, etc., that uses rb_box_t internally.
18 */
19 VALUE box_object;
20 long box_id; // box_id to generate ext filenames
21
22 VALUE top_self;
23
24 VALUE load_path;
25 VALUE load_path_snapshot;
26 VALUE load_path_check_cache;
27 VALUE expanded_load_path;
28 rb_len_t expanded_load_path_maxlen;
29 VALUE loaded_features;
30 VALUE loaded_features_snapshot;
31 VALUE loaded_features_realpaths;
32 VALUE loaded_features_realpath_map;
33 struct st_table *loaded_features_index;
34 struct st_table *loading_table;
35 /* Non-zero while the main Ractor is rebuilding loaded_features_index or
36 * expanded_load_path. Maintained under the VM lock so that
37 * rb_feature_provided_ractor_safe(), which holds that lock, is excluded from
38 * the rebuild and sees its writes once it completes. */
39 unsigned long load_unstable_depth;
40 VALUE ruby_dln_libmap;
41
42 VALUE gvar_tbl;
43 struct st_table *classext_cow_classes;
44
45 bool is_root;
46 bool is_user;
47 bool is_optional;
48};
49typedef struct rb_box_struct rb_box_t;
50
52 bool gem;
53 bool error_highlight;
54 bool did_you_mean;
55 bool syntax_suggest;
56};
57typedef struct rb_box_gem_flags rb_box_gem_flags_t;
58
59#define BOX_OBJ_P(obj) (rb_obj_class(obj) == rb_cBox)
60
61#define BOX_MASTER_P(box) (box && !box->is_root && !box->is_user)
62#define BOX_MUTABLE_P(box) (box && (box->is_root || box->is_user))
63#define BOX_ROOT_P(box) (box && box->is_root)
64#define BOX_USER_P(box) (box && box->is_user)
65#define BOX_OPTIONAL_P(box) (box && box->is_optional)
66#define BOX_MAIN_P(box) (box && box->is_user && !box->is_optional)
67
68#define BOX_METHOD_DEFINITION(mdef) (mdef ? mdef->ns : NULL)
69#define BOX_METHOD_ENTRY(me) (me ? BOX_METHOD_DEFINITION(me->def) : NULL)
70#define BOX_CC(cc) (cc ? BOX_METHOD_ENTRY(cc->cme_) : NULL)
71#define BOX_CC_ENTRIES(ccs) (ccs ? BOX_METHOD_ENTRY(ccs->cme) : NULL)
72
73RUBY_EXTERN bool ruby_box_enabled;
74RUBY_EXTERN bool ruby_box_init_done;
75RUBY_EXTERN bool ruby_box_crashed;
76
77static inline bool
78rb_box_available(void)
79{
80 return ruby_box_enabled;
81}
82
83const rb_box_t * rb_master_box(void);
84const rb_box_t * rb_root_box(void);
85const rb_box_t * rb_main_box(void);
86const rb_box_t * rb_current_box(void);
87const rb_box_t * rb_loading_box(void);
88const rb_box_t * rb_current_box_in_crash_report(void);
89
90void rb_box_entry_mark(void *);
91void rb_box_gc_update_references(void *ptr);
92
93rb_box_t * rb_get_box_t(VALUE ns);
94VALUE rb_get_box_object(rb_box_t *ns);
95
96VALUE rb_box_local_extension(VALUE box, VALUE path, VALUE *cleanup);
97void rb_box_cleanup_local_extension(VALUE cleanup);
98void rb_box_defer_unload_local_extension(void *handle);
99void rb_box_unload_local_extensions(void);
100
101void rb_initialize_mandatory_boxes(void);
102void rb_box_init_done(void);
103void rb_box_set_gem_flags(rb_box_gem_flags_t *);
104
105/* variable.c */
106void rb_autoload_copy_table_for_box(st_table *, const rb_box_t *);
107
108#endif /* INTERNAL_BOX_H */
#define RUBY_EXTERN
Declaration of externally visible global variables.
Definition dllexport.h:45
Internal header for Ruby Box.
Definition box.h:14
Definition st.h:79
long rb_len_t
A signed integer type for lengths and indices of objects such as String and Array.
Definition value.h:142
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40