Ruby: include/ruby/internal/error.h Source File

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

error.h
Go to the documentation of this file.
1#ifndef RBIMPL_ERROR_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_ERROR_H
23#include "ruby/internal/attr/cold.h"
24#include "ruby/internal/attr/format.h"
25#include "ruby/internal/attr/noreturn.h"
26#include "ruby/internal/attr/nonnull.h"
27#include "ruby/internal/dllexport.h"
28#include "ruby/internal/value.h"
29
34
43 typedef enum {
45 RB_WARN_CATEGORY_NONE,
46
48 RB_WARN_CATEGORY_DEPRECATED,
49
51 RB_WARN_CATEGORY_EXPERIMENTAL,
52
54 RB_WARN_CATEGORY_PERFORMANCE,
55
57 RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK,
58
59 RB_WARN_CATEGORY_DEFAULT_BITS = (
60 (1U << RB_WARN_CATEGORY_DEPRECATED) |
61 (1U << RB_WARN_CATEGORY_EXPERIMENTAL) |
62 0),
63
64 RB_WARN_CATEGORY_ALL_BITS = (
65 (1U << RB_WARN_CATEGORY_DEPRECATED) |
66 (1U << RB_WARN_CATEGORY_EXPERIMENTAL) |
67 (1U << RB_WARN_CATEGORY_PERFORMANCE) |
68 (1U << RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK) |
69 0)
70} rb_warning_category_t;
71
73 enum rb_io_wait_readwrite {RB_IO_WAIT_READABLE, RB_IO_WAIT_WRITABLE};
75#define RB_IO_WAIT_READABLE RB_IO_WAIT_READABLE
76#define RB_IO_WAIT_WRITABLE RB_IO_WAIT_WRITABLE
78
79 RBIMPL_SYMBOL_EXPORT_BEGIN()
80
81
88 VALUE rb_errinfo(void);
89
100void rb_set_errinfo(VALUE err);
101
102 RBIMPL_ATTR_NORETURN()
103 RBIMPL_ATTR_NONNULL((2))
104 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
117void rb_raise(VALUE exc, const char *fmt, ...);
118
119 RBIMPL_ATTR_NORETURN()
120 RBIMPL_ATTR_NONNULL((1))
121 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
131void rb_fatal(const char *fmt, ...);
132
133 RBIMPL_ATTR_COLD()
134 RBIMPL_ATTR_NORETURN()
135 RBIMPL_ATTR_NONNULL((1))
136 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
153void rb_bug(const char *fmt, ...);
154
155 RBIMPL_ATTR_NORETURN()
156 RBIMPL_ATTR_NONNULL(())
165void rb_bug_errno(const char *msg, int err);
166
167 RBIMPL_ATTR_NORETURN()
190void rb_sys_fail(const char *msg);
191
192 RBIMPL_ATTR_NORETURN()
201void rb_sys_fail_str(VALUE msg);
202
203 RBIMPL_ATTR_NORETURN()
204 RBIMPL_ATTR_NONNULL((2))
218void rb_mod_sys_fail(VALUE mod, const char *msg);
219
220 RBIMPL_ATTR_NORETURN()
230void rb_mod_sys_fail_str(VALUE mod, VALUE msg);
231
232 RBIMPL_ATTR_NORETURN()
250void rb_readwrite_sys_fail(enum rb_io_wait_readwrite waiting, const char *msg);
251
252 RBIMPL_ATTR_NORETURN()
262void rb_iter_break(void);
263
264 RBIMPL_ATTR_NORETURN()
301void rb_iter_break_value(VALUE val);
302
303 RBIMPL_ATTR_NORETURN()
324void rb_exit(int status);
325
326 RBIMPL_ATTR_NORETURN()
331void rb_notimplement(void);
332
340 VALUE rb_syserr_new(int err, const char * msg);
341
350 VALUE rb_syserr_new_str(int n, VALUE arg);
351
352 RBIMPL_ATTR_NORETURN()
361void rb_syserr_fail(int err, const char *msg);
362
363 RBIMPL_ATTR_NORETURN()
373void rb_syserr_fail_str(int err, VALUE msg);
374
375 RBIMPL_ATTR_NORETURN()
376 RBIMPL_ATTR_NONNULL(())
387void rb_mod_syserr_fail(VALUE mod, int err, const char *msg);
388
389 RBIMPL_ATTR_NORETURN()
400void rb_mod_syserr_fail_str(VALUE mod, int err, VALUE msg);
401
402 RBIMPL_ATTR_NORETURN()
419void rb_readwrite_syserr_fail(enum rb_io_wait_readwrite waiting, int err, const char *msg);
420
421 RBIMPL_ATTR_COLD()
422 RBIMPL_ATTR_NORETURN()
438void rb_unexpected_type(VALUE self, int t);
439
450 VALUE *rb_ruby_verbose_ptr(void);
451
462 VALUE *rb_ruby_debug_ptr(void);
463
475#define ruby_verbose (*rb_ruby_verbose_ptr())
476
486#define ruby_debug (*rb_ruby_debug_ptr())
487
488/* reports if $VERBOSE is true */
489 RBIMPL_ATTR_NONNULL((1))
490 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
511void rb_warning(const char *fmt, ...);
512
513 RBIMPL_ATTR_NONNULL((2))
514 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
521void rb_category_warning(rb_warning_category_t cat, const char *fmt, ...);
522
523 RBIMPL_ATTR_NONNULL((1, 3))
524 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 4)
534void rb_compile_warning(const char *file, int line, const char *fmt, ...);
535
536 RBIMPL_ATTR_NONNULL((1))
537 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
545void rb_sys_warning(const char *fmt, ...);
546
547/* reports if $VERBOSE is not nil (so if it is true or false) */
548 RBIMPL_ATTR_COLD()
549 RBIMPL_ATTR_NONNULL((1))
550 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
558void rb_warn(const char *fmt, ...);
559
560 RBIMPL_ATTR_COLD()
561 RBIMPL_ATTR_NONNULL((2))
562 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
569void rb_category_warn(rb_warning_category_t cat, const char *fmt, ...);
570
571 RBIMPL_ATTR_NONNULL((1, 3))
572 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 4)
580void rb_compile_warn(const char *file, int line, const char *fmt, ...);
581
582 RBIMPL_ATTR_NONNULL((2, 4))
583 RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 4, 5)
592void rb_category_compile_warn(rb_warning_category_t cat, const char *file, int line, const char *fmt, ...);
593
595
596 RBIMPL_SYMBOL_EXPORT_END()
597
598#endif /* RBIMPL_ERROR_H */
cold.h
Defines RBIMPL_ATTR_COLD.
RBIMPL_ATTR_COLD
#define RBIMPL_ATTR_COLD()
Wraps (or simulates) __attribute__((cold))
Definition cold.h:34
dllexport.h
Tweaking visibility of C variables/functions.
RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:74
RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:65
format.h
Defines RBIMPL_ATTR_FORMAT.
RBIMPL_ATTR_FORMAT
#define RBIMPL_ATTR_FORMAT(x, y, z)
Wraps (or simulates) __attribute__((format))
Definition format.h:29
rb_notimplement
void rb_notimplement(void)
Definition error.c:3808
rb_mod_sys_fail
void rb_mod_sys_fail(VALUE mod, const char *mesg)
Identical to rb_sys_fail(), except it takes additional module to extend the exception object before r...
Definition error.c:3946
rb_warning_category_t
rb_warning_category_t
Warning categories.
Definition error.h:43
rb_category_warn
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:476
rb_category_warning
void rb_category_warning(rb_warning_category_t category, const char *fmt,...)
Identical to rb_warning(), except it takes additional "category" parameter.
Definition error.c:508
rb_mod_syserr_fail
void rb_mod_syserr_fail(VALUE mod, int e, const char *mesg)
Identical to rb_mod_sys_fail(), except it does not depend on C global variable errno.
Definition error.c:3960
rb_syserr_fail
void rb_syserr_fail(int e, const char *mesg)
Raises appropriate exception that represents a C errno.
Definition error.c:3877
rb_iter_break
void rb_iter_break(void)
Breaks from a block.
Definition vm.c:2085
rb_readwrite_syserr_fail
void rb_readwrite_syserr_fail(enum rb_io_wait_readwrite waiting, int err, const char *msg)
Identical to rb_readwrite_sys_fail(), except it does not depend on C global variable errno.
Definition io.c:14668
rb_sys_warning
void rb_sys_warning(const char *fmt,...)
Identical to rb_sys_fail(), except it does not raise an exception to render a warning instead.
Definition error.c:4028
rb_syserr_new_str
VALUE rb_syserr_new_str(int n, VALUE arg)
Identical to rb_syserr_new(), except it takes the message in Ruby's String instead of C's.
Definition error.c:3871
rb_mod_syserr_fail_str
void rb_mod_syserr_fail_str(VALUE mod, int e, VALUE mesg)
Identical to rb_mod_syserr_fail(), except it takes the message in Ruby's String instead of C's.
Definition error.c:3967
rb_syserr_fail_str
void rb_syserr_fail_str(int e, VALUE mesg)
Identical to rb_syserr_fail(), except it takes the message in Ruby's String instead of C's.
Definition error.c:3883
rb_readwrite_sys_fail
void rb_readwrite_sys_fail(enum rb_io_wait_readwrite waiting, const char *msg)
Raises appropriate exception using the parameters.
Definition io.c:14662
rb_iter_break_value
void rb_iter_break_value(VALUE val)
Identical to rb_iter_break(), except it additionally takes the "value" of this breakage.
Definition vm.c:2091
rb_io_wait_readwrite
rb_io_wait_readwrite
for rb_readwrite_sys_fail first argument
Definition error.h:73
rb_category_compile_warn
void rb_category_compile_warn(rb_warning_category_t category, const char *file, int line, const char *fmt,...)
Identical to rb_compile_warn(), except it also accepts category.
Definition error.c:439
rb_warn
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
Definition error.c:466
rb_bug_errno
void rb_bug_errno(const char *mesg, int errno_arg)
This is a wrapper of rb_bug() which automatically constructs appropriate message from the passed errn...
Definition error.c:1140
rb_syserr_new
VALUE rb_syserr_new(int n, const char *mesg)
Creates an exception object that represents the given C errno.
Definition error.c:3863
rb_unexpected_type
void rb_unexpected_type(VALUE x, int t)
Fails with the given object's type incompatibility to the type.
Definition error.c:1360
rb_mod_sys_fail_str
void rb_mod_sys_fail_str(VALUE mod, VALUE mesg)
Identical to rb_mod_sys_fail(), except it takes the message in Ruby's String instead of C's.
Definition error.c:3953
rb_exit
void rb_exit(int status)
Terminates the current execution context.
Definition process.c:4457
rb_warning
void rb_warning(const char *fmt,...)
Issues a warning.
Definition error.c:497
RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK
@ RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK
Warning is for checking unused block strictly.
Definition error.h:57
RB_WARN_CATEGORY_DEPRECATED
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
Definition error.h:48
RB_WARN_CATEGORY_EXPERIMENTAL
@ RB_WARN_CATEGORY_EXPERIMENTAL
Warning is for experimental features.
Definition error.h:51
RB_WARN_CATEGORY_PERFORMANCE
@ RB_WARN_CATEGORY_PERFORMANCE
Warning is for performance issues (not enabled by -w).
Definition error.h:54
RB_WARN_CATEGORY_NONE
@ RB_WARN_CATEGORY_NONE
Category unspecified.
Definition error.h:45
nonnull.h
Defines RBIMPL_ATTR_NONNULL.
RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30
noreturn.h
Defines RBIMPL_ATTR_NORETURN.
RBIMPL_ATTR_NORETURN
#define RBIMPL_ATTR_NORETURN()
Wraps (or simulates) [[noreturn]]
Definition noreturn.h:38
value.h
Defines VALUE and ID.
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40