Ruby: internal.h Source File

Ruby 3.2.5p208 (2024-07-26 revision 31d0f1a2e7dbfb60731d1f05b868e1d578cda493)

internal.h
1#ifndef RUBY_INTERNAL_H /*-*-C-*-vi:se ft=c:*/
2#define RUBY_INTERNAL_H 1
12#include "ruby/internal/config.h"
13
14#ifdef __cplusplus
15# error not for C++
16#endif
17
18#define LIKELY(x) RB_LIKELY(x)
19#define UNLIKELY(x) RB_UNLIKELY(x)
20
21#define numberof(array) ((int)(sizeof(array) / sizeof((array)[0])))
22#define roomof(x, y) (((x) + (y) - 1) / (y))
23#define type_roomof(x, y) roomof(sizeof(x), sizeof(y))
24
25/* Prevent compiler from reordering access */
26#define ACCESS_ONCE(type,x) (*((volatile type *)&(x)))
27
28#define UNDEF_P RB_UNDEF_P
29#define NIL_OR_UNDEF_P RB_NIL_OR_UNDEF_P
30
31#include "ruby/ruby.h"
32
33/* Following macros were formerly defined in this header but moved to somewhere
34 * else. In order to detect them we undef here. */
35
36/* internal/array.h */
37#undef RARRAY_AREF
38
39/* internal/class.h */
40#undef RClass
41#undef RCLASS_SUPER
42
43/* internal/gc.h */
44#undef NEWOBJ_OF
45#undef RB_NEWOBJ_OF
46#undef RB_OBJ_WRITE
47
48/* internal/hash.h */
49#undef RHASH_IFNONE
50#undef RHASH_SIZE
51#undef RHASH_TBL
52#undef RHASH_EMPTY_P
53
54/* internal/struct.h */
55#undef RSTRUCT_LEN
56#undef RSTRUCT_PTR
57#undef RSTRUCT_SET
58#undef RSTRUCT_GET
59
60/* Also, we keep the following macros here. They are expected to be
61 * overridden in each headers. */
62
63/* internal/array.h */
64#define rb_ary_new_from_args(...) rb_nonexistent_symbol(__VA_ARGS__)
65
66/* internal/io.h */
67#define rb_io_fptr_finalize(...) rb_nonexistent_symbol(__VA_ARGS__)
68
69/* internal/string.h */
70#define rb_fstring_cstr(...) rb_nonexistent_symbol(__VA_ARGS__)
71
72/* internal/symbol.h */
73#define rb_sym_intern_ascii_cstr(...) rb_nonexistent_symbol(__VA_ARGS__)
74
75/* internal/vm.h */
76#define rb_funcallv(...) rb_nonexistent_symbol(__VA_ARGS__)
77#define rb_method_basic_definition_p(...) rb_nonexistent_symbol(__VA_ARGS__)
78
79
80/* MRI debug support */
81
82/* gc.c */
83void rb_obj_info_dump(VALUE obj);
84void rb_obj_info_dump_loc(VALUE obj, const char *file, int line, const char *func);
85
86/* debug.c */
87
88RUBY_SYMBOL_EXPORT_BEGIN
89void ruby_debug_breakpoint(void);
90PRINTF_ARGS(void ruby_debug_printf(const char*, ...), 1, 2);
91RUBY_SYMBOL_EXPORT_END
92
93// show obj data structure without any side-effect
94#define rp(obj) rb_obj_info_dump_loc((VALUE)(obj), __FILE__, __LINE__, RUBY_FUNCTION_NAME_STRING)
95
96// same as rp, but add message header
97#define rp_m(msg, obj) do { \
98 fputs((msg), stderr); \
99 rb_obj_info_dump((VALUE)(obj)); \
100} while (0)
101
102// `ruby_debug_breakpoint()` does nothing,
103// but breakpoint is set in run.gdb, so `make gdb` can stop here.
104#define bp() ruby_debug_breakpoint()
105
106#define RBOOL(v) ((v) ? Qtrue : Qfalse)
107#define RB_BIGNUM_TYPE_P(x) RB_TYPE_P((x), T_BIGNUM)
108
109#ifndef __MINGW32__
110#undef memcpy
111#define memcpy ruby_nonempty_memcpy
112#endif
113#endif /* RUBY_INTERNAL_H */
ruby.h
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40