Ruby: internal/error.h Source File

Ruby 3.4.3p32 (2025-04-14 revision d0b7e5b6a04bde21ca483d20a1546b28b401c2d4)

error.h
1#ifndef INTERNAL_ERROR_H /*-*-C-*-vi:se ft=c:*/
2#define INTERNAL_ERROR_H
11#include "ruby/internal/config.h"
12#include <stdarg.h> /* for va_list */
13#include "internal/string.h" /* for rb_fstring_cstr */
14#include "ruby/internal/stdbool.h" /* for bool */
15#include "ruby/encoding.h" /* for rb_encoding */
16#include "ruby/intern.h" /* for rb_exc_raise */
17#include "ruby/ruby.h" /* for enum ruby_value_type */
18
19#ifdef Check_Type
20# undef Check_Type /* in ruby/ruby.h */
21#endif
22
23#ifdef rb_raise_static
24# undef rb_raise_static
25# undef rb_sys_fail_path
26# undef rb_syserr_fail_path
27#endif
28
29#define rb_raise_static(e, m) \
30 rb_raise_cstr_i((e), rb_str_new_static((m), rb_strlen_lit(m)))
31#ifdef RUBY_FUNCTION_NAME_STRING
32# define rb_syserr_fail_path(err, path) rb_syserr_fail_path_in(RUBY_FUNCTION_NAME_STRING, (err), (path))
33# define rb_syserr_new_path(err, path) rb_syserr_new_path_in(RUBY_FUNCTION_NAME_STRING, (err), (path))
34#else
35# define rb_syserr_fail_path(err, path) rb_syserr_fail_str((err), (path))
36# define rb_syserr_new_path(err, path) rb_syserr_new_str((err), (path))
37#endif
38
39#define rb_sys_fail(mesg) \
40do { \
41 int errno_to_fail = errno; \
42 rb_syserr_fail(errno_to_fail, (mesg)); \
43} while (0)
44
45#define rb_sys_fail_str(mesg) \
46do { \
47 int errno_to_fail = errno; \
48 rb_syserr_fail_str(errno_to_fail, (mesg)); \
49} while (0)
50
51#define rb_sys_fail_path(path) \
52do { \
53 int errno_to_fail = errno; \
54 rb_syserr_fail_path(errno_to_fail, (path)); \
55} while (0)
56
57#define rb_sys_fail_sprintf(...) \
58do { \
59 int errno_to_fail = errno; \
60 rb_syserr_fail_str(errno_to_fail, rb_sprintf("" __VA_ARGS__)); \
61} while (0)
62
63/* error.c */
64extern long rb_backtrace_length_limit;
65extern VALUE rb_eEAGAIN;
66extern VALUE rb_eEWOULDBLOCK;
67extern VALUE rb_eEINPROGRESS;
68 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 0)
69void rb_report_bug_valist(VALUE file, int line, const char *fmt, va_list args);
70NORETURN(void rb_async_bug_errno(const char *,int));
71const char *rb_builtin_type_name(int t);
72const char *rb_builtin_class_name(VALUE x);
73PRINTF_ARGS(void rb_warn_deprecated(const char *fmt, const char *suggest, ...), 1, 3);
74PRINTF_ARGS(void rb_warn_deprecated_to_remove(const char *removal, const char *fmt, const char *suggest, ...), 2, 4);
75PRINTF_ARGS(void rb_warn_reserved_name(const char *removal, const char *fmt, ...), 2, 3);
76#if RUBY_DEBUG
77# include "ruby/version.h"
78# define RUBY_VERSION_SINCE(major, minor) (RUBY_API_VERSION_CODE >= (major * 10000) + (minor) * 100)
79# define RUBY_VERSION_BEFORE(major, minor) (RUBY_API_VERSION_CODE < (major * 10000) + (minor) * 100)
80# if defined(RBIMPL_WARNING_PRAGMA0)
81# define RBIMPL_TODO0(x) RBIMPL_WARNING_PRAGMA0(message(x))
82# elif RBIMPL_COMPILER_SINCE(MSVC, 12, 0, 0)
83# define RBIMPL_TODO0(x) __pragma(message(x))
84# endif
85
86# if RBIMPL_HAS_ATTRIBUTE(diagnose_if) || defined(__OPTIMIZE__)
87
88#define RUBY_VERSION_isdigit(c) ('0'<=(c)&&(c)<='9')
89// upto 99
90#define RUBY_VERSION__number_len(v, ofs) \
91 (!RUBY_VERSION_isdigit((v)[ofs]) ? \
92 0 : !RUBY_VERSION_isdigit((v)[(ofs) + 1]) ? 1 : 2)
93#define RUBY_VERSION__to_number(v, ofs) \
94 (!RUBY_VERSION_isdigit((v)[ofs]) ? \
95 0 : !RUBY_VERSION_isdigit((v)[(ofs) + 1]) ? \
96 ((v)[ofs]-'0') : \
97 (((v)[ofs]-'0')*10+(v)[(ofs)+1]-'0'))
98
99#define RUBY_VERSION_CODE_FROM_MAJOR_MINOR_STRING(v) \
100 (RUBY_VERSION__to_number(v, 0) * 10000 + \
101 ((v)[RUBY_VERSION__number_len(v, 0)] == '.' ? \
102 RUBY_VERSION__to_number(v, RUBY_VERSION__number_len(v, 0)+1) * 100 : 0))
103#define RUBY_VERSION_STRING_SINCE(v) (RUBY_API_VERSION_CODE >= RUBY_VERSION_CODE_FROM_MAJOR_MINOR_STRING(v))
104#define RUBY_VERSION_STRING_BEFORE(v) (RUBY_API_VERSION_CODE < RUBY_VERSION_CODE_FROM_MAJOR_MINOR_STRING(v))
105
106# if RBIMPL_HAS_ATTRIBUTE(diagnose_if)
107 RBIMPL_ATTR_FORCEINLINE()
108static void
109rb_deprecated_method_to_be_removed(const char *removal)
110 RBIMPL_ATTR_DIAGNOSE_IF(!RUBY_VERSION_isdigit(removal[0]), "malformed version number", "error")
111 RBIMPL_ATTR_DIAGNOSE_IF(RUBY_VERSION_STRING_SINCE(removal), "deprecated method to be removed", "error")
112{
113}
114
115 RBIMPL_ATTR_FORCEINLINE()
116static void
117rb_diagnose_reserved_name_at(const char *coming)
118 RBIMPL_ATTR_DIAGNOSE_IF(!RUBY_VERSION_isdigit(coming[0]), "malformed version number", "error")
119 RBIMPL_ATTR_DIAGNOSE_IF(RUBY_VERSION_STRING_SINCE(coming), "reserved name already in use", "error")
120{
121}
122# else
123 RBIMPL_ATTR_ERROR(("deprecated"))
124void rb_deprecated_method_to_be_removed(const char *);
125# define rb_deprecated_method_to_be_removed(removal) \
126 (sizeof(char[1-2*(!RUBY_VERSION_isdigit(removal[0]) || RUBY_VERSION_STRING_SINCE(removal))])!=1 ? \
127 rb_deprecated_method_to_be_removed(removal) : \
128 RBIMPL_ASSERT_NOTHING)
129
130 RBIMPL_ATTR_ERROR(("deprecated"))
131void rb_diagnose_reserved_name_at(const char *);
132# define rb_diagnose_reserved_name_at(coming) \
133 (sizeof(char[1-2*(!RUBY_VERSION_isdigit(coming[0]) || RUBY_VERSION_STRING_SINCE(coming))])!=1 ? \
134 rb_diagnose_reserved_name_at(coming) : \
135 RBIMPL_ASSERT_NOTHING)
136
137# endif
138# define rb_warn_deprecated_to_remove_at(removal, ...) \
139 (rb_deprecated_method_to_be_removed(#removal), \
140 rb_warn_deprecated_to_remove(#removal, __VA_ARGS__))
141
142# define rb_warn_reserved_name_at(coming, ...) \
143 (rb_diagnose_reserved_name_at(#coming), \
144 rb_warn_reserved_name(#coming, __VA_ARGS__))
145# endif
146#endif
147#ifndef rb_warn_deprecated_to_remove_at
148# define rb_warn_deprecated_to_remove_at(removal, ...) \
149 rb_warn_deprecated_to_remove(#removal, __VA_ARGS__)
150#endif
151#ifndef rb_warn_reserved_name_at
152# define rb_warn_reserved_name_at(removal, ...) \
153 rb_warn_reserved_name(#removal, __VA_ARGS__)
154#endif
155#ifndef RUBY_VERSION_SINCE
156# define RUBY_VERSION_SINCE(major, minor) 0
157#endif
158#ifndef RUBY_VERSION_BEFORE
159# define RUBY_VERSION_BEFORE(major, minor) 0
160#endif
161#ifndef RBIMPL_TODO0
162# define RBIMPL_TODO0(x)
163#endif
164#define RBIMPL_TODO(message) RBIMPL_TODO0("TODO: " message)
165 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 6, 0)
166 VALUE rb_syntax_error_append(VALUE, VALUE, int, int, rb_encoding*, const char*, va_list);
167PRINTF_ARGS(void rb_enc_warn(rb_encoding *enc, const char *fmt, ...), 2, 3);
168PRINTF_ARGS(void rb_sys_enc_warning(rb_encoding *enc, const char *fmt, ...), 2, 3);
169PRINTF_ARGS(void rb_syserr_enc_warning(int err, rb_encoding *enc, const char *fmt, ...), 3, 4);
170PRINTF_ARGS(void rb_enc_compile_warning(rb_encoding *enc, const char *file, int line, const char *fmt, ...), 4, 5);
171PRINTF_ARGS(void rb_enc_compile_warn(rb_encoding *enc, const char *file, int line, const char *fmt, ...), 4, 5);
172 rb_warning_category_t rb_warning_category_from_name(VALUE category);
173bool rb_warning_category_enabled_p(rb_warning_category_t category);
174 VALUE rb_name_err_new(VALUE mesg, VALUE recv, VALUE method);
175 VALUE rb_nomethod_err_new(VALUE mesg, VALUE recv, VALUE method, VALUE args, int priv);
176 VALUE rb_key_err_new(VALUE mesg, VALUE recv, VALUE name);
177PRINTF_ARGS(VALUE rb_warning_string(const char *fmt, ...), 1, 2);
178 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 0)
179NORETURN(void rb_vraise(VALUE, const char *, va_list));
180NORETURN(static inline void rb_raise_cstr(VALUE etype, const char *mesg));
181NORETURN(static inline void rb_raise_cstr_i(VALUE etype, VALUE mesg));
182NORETURN(static inline void rb_name_err_raise_str(VALUE mesg, VALUE recv, VALUE name));
183NORETURN(static inline void rb_name_err_raise(const char *mesg, VALUE recv, VALUE name));
184NORETURN(static inline void rb_key_err_raise(VALUE mesg, VALUE recv, VALUE name));
185static inline void Check_Type(VALUE v, enum ruby_value_type t);
186static inline bool rb_typeddata_is_instance_of_inline(VALUE obj, const rb_data_type_t *data_type);
187#define rb_typeddata_is_instance_of rb_typeddata_is_instance_of_inline
188void rb_bug_without_die(const char *fmt, ...);
189
190RUBY_SYMBOL_EXPORT_BEGIN
191/* error.c (export) */
192int rb_bug_reporter_add(void (*func)(FILE *, void *), void *data);
193#ifdef RUBY_FUNCTION_NAME_STRING
194NORETURN(void rb_sys_fail_path_in(const char *func_name, VALUE path));
195NORETURN(void rb_syserr_fail_path_in(const char *func_name, int err, VALUE path));
196 VALUE rb_syserr_new_path_in(const char *func_name, int n, VALUE path);
197#endif
198RUBY_SYMBOL_EXPORT_END
199
200/* vm.c */
201void rb_free_warning(void);
202
203static inline void
204rb_raise_cstr_i(VALUE etype, VALUE mesg)
205{
206 VALUE exc = rb_exc_new_str(etype, mesg);
207 rb_exc_raise(exc);
208}
209
210static inline void
211rb_raise_cstr(VALUE etype, const char *mesg)
212{
213 VALUE str = rb_str_new_cstr(mesg);
214 rb_raise_cstr_i(etype, str);
215}
216
217static inline void
218rb_name_err_raise_str(VALUE mesg, VALUE recv, VALUE name)
219{
220 VALUE exc = rb_name_err_new(mesg, recv, name);
221 rb_exc_raise(exc);
222}
223
224static inline void
225rb_name_err_raise(const char *mesg, VALUE recv, VALUE name)
226{
227 VALUE str = rb_fstring_cstr(mesg);
228 rb_name_err_raise_str(str, recv, name);
229}
230
231static inline void
232rb_key_err_raise(VALUE mesg, VALUE recv, VALUE name)
233{
234 VALUE exc = rb_key_err_new(mesg, recv, name);
235 rb_exc_raise(exc);
236}
237
238static inline bool
239rb_typeddata_is_instance_of_inline(VALUE obj, const rb_data_type_t *data_type)
240{
241 return RB_TYPE_P(obj, T_DATA) && RTYPEDDATA_P(obj) && (RTYPEDDATA_TYPE(obj) == data_type);
242}
243
244#endif /* INTERNAL_ERROR_H */
RBIMPL_ATTR_DIAGNOSE_IF
#define RBIMPL_ATTR_DIAGNOSE_IF(_, __, ___)
Wraps (or simulates) __attribute__((diagnose_if))
Definition diagnose_if.h:39
RBIMPL_ATTR_FORCEINLINE
#define RBIMPL_ATTR_FORCEINLINE()
Wraps (or simulates) __forceinline.
Definition forceinline.h:37
RBIMPL_ATTR_FORMAT
#define RBIMPL_ATTR_FORMAT(x, y, z)
Wraps (or simulates) __attribute__((format))
Definition format.h:29
T_DATA
#define T_DATA
Old name of RUBY_T_DATA.
Definition value_type.h:60
rb_warning_category_t
rb_warning_category_t
Warning categories.
Definition error.h:43
rb_exc_new_str
VALUE rb_exc_new_str(VALUE etype, VALUE str)
Identical to rb_exc_new_cstr(), except it takes a Ruby's string instead of C's.
Definition error.c:1481
encoding.h
Encoding relates APIs.
RBIMPL_ATTR_ERROR
#define RBIMPL_ATTR_ERROR(msg)
Wraps (or simulates) __attribute__((error))
Definition error.h:29
rb_str_new_cstr
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
Definition string.h:1514
version.h
intern.h
inline
#define inline
Old Visual Studio versions do not support the inline keyword, so we need to define it to be __inline.
Definition defines.h:88
RTYPEDDATA_P
static bool RTYPEDDATA_P(VALUE obj)
Checks whether the passed object is RTypedData or RData.
Definition rtypeddata.h:579
rb_data_type_t
struct rb_data_type_struct rb_data_type_t
This is the struct that holds necessary info for a struct.
Definition rtypeddata.h:197
RTYPEDDATA_TYPE
static const struct rb_data_type_struct * RTYPEDDATA_TYPE(VALUE obj)
Queries for the type of given object.
Definition rtypeddata.h:602
ruby.h
stdarg.h
Defines old _.
stdbool.h
C99 shim for <stdbool.h>
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
Check_Type
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
Definition value_type.h:433
RB_TYPE_P
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
ruby_value_type
ruby_value_type
C-level type of an object.
Definition value_type.h:113