Ruby 3.2.1p31 (2023-02-08 revision 31819e82c88c6f8ecfaeb162519bfa26a14b21fd)
error.h
Go to the documentation of this file.
1#ifndef RBIMPL_ERROR_H /*-*-C++-*-vi:se ft=cpp:*/
2#define RBIMPL_ERROR_H
28#include "ruby/internal/value.h"
29
43typedef enum {
46
49
52
53 RB_WARN_CATEGORY_ALL_BITS = 0x6 /* no RB_WARN_CATEGORY_NONE bit */
55
57enum rb_io_wait_readwrite {RB_IO_WAIT_READABLE, RB_IO_WAIT_WRITABLE};
59#define RB_IO_WAIT_READABLE RB_IO_WAIT_READABLE
60#define RB_IO_WAIT_WRITABLE RB_IO_WAIT_WRITABLE
64
65
72VALUE rb_errinfo(void);
73
84void rb_set_errinfo(VALUE err);
85
88RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
101void rb_raise(VALUE exc, const char *fmt, ...);
102
105RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
115void rb_fatal(const char *fmt, ...);
116
120RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
137void rb_bug(const char *fmt, ...);
138
149void rb_bug_errno(const char *msg, int err);
150
174void rb_sys_fail(const char *msg);
175
185void rb_sys_fail_str(VALUE msg);
186
202void rb_mod_sys_fail(VALUE mod, const char *msg);
203
214void rb_mod_sys_fail_str(VALUE mod, VALUE msg);
215
234void rb_readwrite_sys_fail(enum rb_io_wait_readwrite waiting, const char *msg);
235
246void rb_iter_break(void);
247
285void rb_iter_break_value(VALUE val);
286
308void rb_exit(int status);
309
315void rb_notimplement(void);
316
324VALUE rb_syserr_new(int err, const char * msg);
325
334VALUE rb_syserr_new_str(int n, VALUE arg);
335
345void rb_syserr_fail(int err, const char *msg);
346
357void rb_syserr_fail_str(int err, VALUE msg);
358
371void rb_mod_syserr_fail(VALUE mod, int err, const char *msg);
372
384void rb_mod_syserr_fail_str(VALUE mod, int err, VALUE msg);
385
403void rb_readwrite_syserr_fail(enum rb_io_wait_readwrite waiting, int err, const char *msg);
404
422void rb_unexpected_type(VALUE self, int t);
423
434VALUE *rb_ruby_verbose_ptr(void);
435
446VALUE *rb_ruby_debug_ptr(void);
447
459#define ruby_verbose (*rb_ruby_verbose_ptr())
460
470#define ruby_debug (*rb_ruby_debug_ptr())
471
472/* reports if `-W' specified */
474RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
494void rb_warning(const char *fmt, ...);
495
497RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
504void rb_category_warning(rb_warning_category_t cat, const char *fmt, ...);
505
507RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 4)
517void rb_compile_warning(const char *file, int line, const char *fmt, ...);
518
520RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
528void rb_sys_warning(const char *fmt, ...);
529
530/* reports always */
533RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 2)
540void rb_warn(const char *fmt, ...);
541
544RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 2, 3)
552void rb_category_warn(rb_warning_category_t cat, const char *fmt, ...);
553
555RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 3, 4)
564void rb_compile_warn(const char *file, int line, const char *fmt, ...);
565
567RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 4, 5)
576void rb_category_compile_warn(rb_warning_category_t cat, const char *file, int line, const char *fmt, ...);
577
581
582#endif /* RBIMPL_ERROR_H */
Defines RBIMPL_ATTR_COLD.
#define RBIMPL_ATTR_COLD()
Wraps (or simulates) __attribute__((cold))
Definition: cold.h:34
Tweaking visibility of C variables/functions.
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition: dllexport.h:106
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition: dllexport.h:97
Defines RBIMPL_ATTR_FORMAT.
#define RBIMPL_ATTR_FORMAT(x, y, z)
Wraps (or simulates) __attribute__((format))
Definition: format.h:29
void rb_notimplement(void)
Definition: error.c:3191
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:3327
rb_warning_category_t
Warning categories.
Definition: error.h:43
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
Definition: error.h:48
@ RB_WARN_CATEGORY_EXPERIMENTAL
Warning is for experimental features.
Definition: error.h:51
@ RB_WARN_CATEGORY_NONE
Category unspecified.
Definition: error.h:45
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports always regardless of runtime -W flag.
Definition: error.c:421
void rb_raise(VALUE exc, const char *fmt,...)
Exception entry point.
Definition: error.c:3148
void rb_compile_warn(const char *file, int line, const char *fmt,...)
Identical to rb_compile_warning(), except it reports always regardless of runtime -W flag.
Definition: error.c:363
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:453
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:3341
void rb_syserr_fail(int e, const char *mesg)
Raises appropriate exception that represents a C errno.
Definition: error.c:3260
void rb_bug(const char *fmt,...)
Interpreter panic switch.
Definition: error.c:794
void rb_iter_break(void)
Breaks from a block.
Definition: vm.c:1901
void rb_sys_fail(const char *mesg)
Converts a C errno into a Ruby exception, then raises it.
Definition: error.c:3272
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:14566
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:3409
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:3254
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:3348
void rb_set_errinfo(VALUE err)
Sets the current exception ($!) to the given value.
Definition: eval.c:1876
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:3266
void rb_fatal(const char *fmt,...)
Raises the unsung "fatal" exception.
Definition: error.c:3199
void rb_readwrite_sys_fail(enum rb_io_wait_readwrite waiting, const char *msg)
Raises appropriate exception using the parameters.
Definition: io.c:14560
void rb_iter_break_value(VALUE val)
Identical to rb_iter_break(), except it additionally takes the "value" of this breakage.
Definition: vm.c:1907
rb_io_wait_readwrite
for rb_readwrite_sys_fail first argument
Definition: error.h:57
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:384
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports always regardless of runtime -W flag.
Definition: error.c:411
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:822
void rb_compile_warning(const char *file, int line, const char *fmt,...)
Issues a compile-time warning that happens at __file__:__line__.
Definition: error.c:374
VALUE rb_errinfo(void)
This is the same as $! in Ruby.
Definition: eval.c:1870
VALUE rb_syserr_new(int n, const char *mesg)
Creates an exception object that represents the given C errno.
Definition: error.c:3246
void rb_sys_fail_str(VALUE mesg)
Identical to rb_sys_fail(), except it takes the message in Ruby's String instead of C's.
Definition: error.c:3278
void rb_unexpected_type(VALUE x, int t)
Fails with the given object's type incompatibility to the type.
Definition: error.c:1021
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:3334
void rb_exit(int status)
Terminates the current execution context.
Definition: process.c:4510
void rb_warning(const char *fmt,...)
Issues a warning.
Definition: error.c:442
Defines RBIMPL_ATTR_NONNULL.
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition: nonnull.h:30
Defines RBIMPL_ATTR_NORETURN.
#define RBIMPL_ATTR_NORETURN()
Wraps (or simulates) [[noreturn]]
Definition: noreturn.h:38
Defines VALUE and ID.
uintptr_t VALUE
Type that represents a Ruby object.
Definition: value.h:40