12#include "ruby/internal/config.h"
31# include <AvailabilityMacros.h>
35#include "internal/class.h"
36#include "internal/error.h"
37#include "internal/eval.h"
38#include "internal/hash.h"
39#include "internal/io.h"
40#include "internal/load.h"
41#include "internal/object.h"
42#include "internal/process.h"
43#include "internal/string.h"
44#include "internal/symbol.h"
45#include "internal/thread.h"
46#include "internal/variable.h"
50#include "internal/vm.h"
51#include "ruby_assert.h"
68#define WIFEXITED(status) 1
72#define WEXITSTATUS(status) (status)
77int rb_str_end_with_asciichar(
VALUE str,
int c);
79long rb_backtrace_length_limit = -1;
83static VALUE rb_mWarning;
84static VALUE rb_cWarningBuffer;
88static ID id_deprecated;
89static ID id_experimental;
90static ID id_performance;
91static ID id_strict_unused_block;
92static VALUE sym_category;
93static VALUE sym_highlight;
98extern const char *rb_dynamic_description;
103#define defined_error(name, num) if (err == (num)) return (name);
104#define undefined_error(name)
105#include "known_errors.inc"
107#undef undefined_error
112err_position_0(
char *buf,
long len,
const char *file,
int line)
117 else if (line == 0) {
118 return snprintf(buf,
len,
"%s: ", file);
121 return snprintf(buf,
len,
"%s:%d: ", file, line);
127err_vcatf(
VALUE str, const
char *pre, const
char *file,
int line,
128 const
char *fmt, va_list args)
132 if (line) rb_str_catf(str,
":%d", line);
136 rb_str_vcatf(str, fmt, args);
143rb_syntax_error_append(
VALUE exc,
VALUE file,
int line,
int column,
146 const char *fn =
NIL_P(file) ? NULL : RSTRING_PTR(file);
148 VALUE mesg = rb_enc_str_new(0, 0, enc);
149 err_vcatf(mesg, NULL, fn, line, fmt, args);
151 rb_write_error_str(mesg);
155 exc = syntax_error_with_path(exc, file, &mesg, enc);
156 err_vcatf(mesg, NULL, fn, line, fmt, args);
162static unsigned int warning_disabled_categories = (
164 ~RB_WARN_CATEGORY_DEFAULT_BITS);
167rb_warning_category_mask(
VALUE category)
169 return 1U << rb_warning_category_from_name(category);
173rb_warning_category_from_name(
VALUE category)
179 !st_lookup(warning_categories.id2enum, cat_id, &cat_value)) {
180 rb_raise(
rb_eArgError,
"unknown category: %"PRIsVALUE, category);
189 if (!st_lookup(warning_categories.enum2id, category, &
id)) {
190 rb_raise(
rb_eArgError,
"invalid category: %d", (
int)category);
196rb_warning_category_update(
unsigned int mask,
unsigned int bits)
198 warning_disabled_categories &= ~mask;
199 warning_disabled_categories |= mask & ~bits;
205 return !(warning_disabled_categories & (1U << category));
233 return RBOOL(rb_warning_category_enabled_p(cat));
247 unsigned int mask = rb_warning_category_mask(category);
248 unsigned int disabled = warning_disabled_categories;
253 warning_disabled_categories = disabled;
265rb_warning_s_categories(
VALUE mod)
267 st_index_t num = warning_categories.id2enum->num_entries;
269 num = st_keys(warning_categories.id2enum, ids, num);
271 for (st_index_t i = 0; i < num; ++i) {
289rb_warning_s_warn(
int argc,
VALUE *argv,
VALUE mod)
300 if (!
NIL_P(category)) {
302 if (!rb_warning_category_enabled_p(cat))
return Qnil;
304 rb_write_error_str(str);
350rb_warning_warn_arity(
void)
353 return me ? rb_method_entry_arity(me) : 1;
360 rb_warning_category_from_name(category);
363 if (rb_warning_warn_arity() == 1) {
364 return rb_warning_warn(rb_mWarning, str);
369 args[1] = rb_hash_new();
370 rb_hash_aset(args[1], sym_category, category);
376rb_write_warning_str(
VALUE str)
378 rb_warning_warn(rb_mWarning, str);
383warn_vsprintf(
rb_encoding *enc, const
char *file,
int line, const
char *fmt, va_list args)
385 VALUE str = rb_enc_str_new(0, 0, enc);
387 err_vcatf(str,
"warning: ", file, line, fmt, args);
391#define with_warn_vsprintf(enc, file, line, fmt) \
394 va_start(args, fmt); \
395 str = warn_vsprintf(enc, file, line, fmt, args); \
399rb_compile_warn(
const char *file,
int line,
const char *fmt, ...)
402 with_warn_vsprintf(NULL, file, line, fmt) {
403 rb_write_warning_str(str);
409rb_enc_compile_warn(
rb_encoding *enc,
const char *file,
int line,
const char *fmt, ...)
412 with_warn_vsprintf(enc, file, line, fmt) {
413 rb_write_warning_str(str);
420rb_compile_warning(
const char *file,
int line,
const char *fmt, ...)
423 with_warn_vsprintf(NULL, file, line, fmt) {
424 rb_write_warning_str(str);
431rb_enc_compile_warning(
rb_encoding *enc,
const char *file,
int line,
const char *fmt, ...)
434 with_warn_vsprintf(enc, file, line, fmt) {
435 rb_write_warning_str(str);
444 with_warn_vsprintf(NULL, file, line, fmt) {
445 rb_warn_category(str, rb_warning_category_to_name(category));
452warning_string(
rb_encoding *enc, const
char *fmt, va_list args)
455 const char *file = rb_source_location_cstr(&line);
456 return warn_vsprintf(enc, file, line, fmt, args);
459#define with_warning_string(mesg, enc, fmt) \
460 with_warning_string_from(mesg, enc, fmt, fmt)
461#define with_warning_string_from(mesg, enc, fmt, last_arg) \
463 va_list args; va_start(args, last_arg); \
464 mesg = warning_string(enc, fmt, args); \
471 with_warning_string(mesg, 0, fmt) {
472 rb_write_warning_str(mesg);
481 with_warning_string(mesg, 0, fmt) {
482 rb_warn_category(mesg, rb_warning_category_to_name(category));
491 with_warning_string(mesg, enc, fmt) {
492 rb_write_warning_str(mesg);
502 with_warning_string(mesg, 0, fmt) {
503 rb_write_warning_str(mesg);
513 with_warning_string(mesg, 0, fmt) {
514 rb_warn_category(mesg, rb_warning_category_to_name(category));
520rb_warning_string(
const char *fmt, ...)
522 with_warning_string(mesg, 0, fmt) {
529rb_enc_warning(
rb_encoding *enc,
const char *fmt, ...)
532 with_warning_string(mesg, enc, fmt) {
533 rb_write_warning_str(mesg);
540deprecation_warning_enabled(
void)
548warn_deprecated(
VALUE mesg,
const char *removal,
const char *suggest)
553 rb_str_catf(mesg,
" and will be removed in Ruby %s", removal);
555 if (suggest) rb_str_catf(mesg,
"; use %s instead", suggest);
557 rb_warn_category(mesg,
ID2SYM(id_deprecated));
561rb_warn_deprecated(
const char *fmt,
const char *suggest, ...)
563 if (!deprecation_warning_enabled())
return;
565 with_warning_string_from(mesg, 0, fmt, suggest) {
566 warn_deprecated(mesg, NULL, suggest);
571rb_warn_deprecated_to_remove(
const char *removal,
const char *fmt,
const char *suggest, ...)
573 if (!deprecation_warning_enabled())
return;
575 with_warning_string_from(mesg, 0, fmt, suggest) {
576 warn_deprecated(mesg, removal, suggest);
581rb_warn_reserved_name(
const char *coming,
const char *fmt, ...)
583 if (!deprecation_warning_enabled())
return;
585 with_warning_string_from(mesg, 0, fmt, fmt) {
587 rb_str_catf(mesg,
" is reserved for Ruby %s\n", coming);
588 rb_warn_category(mesg,
ID2SYM(id_deprecated));
593end_with_asciichar(
VALUE str,
int c)
596 rb_str_end_with_asciichar(str, c);
601warning_write(
int argc,
VALUE *argv,
VALUE buf)
620 if (!
NIL_P(uplevel)) {
625 location = rb_ec_backtrace_location_ary(ec, lev + 1, 1, TRUE);
626 if (!
NIL_P(location)) {
630 if (argc > 1 || !
NIL_P(uplevel) || !end_with_asciichar(str,
'\n')) {
632 if (
NIL_P(uplevel)) {
635 else if (
NIL_P(location) ||
640 str = rb_sprintf(
"%s:%ld: warning: ",
644 RBASIC_SET_CLASS(str, rb_cWarningBuffer);
645 rb_io_puts(argc, argv, str);
649 if (!
NIL_P(category)) {
650 category = rb_to_symbol_type(category);
651 rb_warning_category_from_name(category);
654 if (exc == rb_mWarning) {
656 rb_write_error_str(str);
659 rb_warn_category(str, category);
665#define MAX_BUG_REPORTERS 0x100
668 void (*func)(
FILE *out,
void *data);
672static int bug_reporters_size;
675rb_bug_reporter_add(
void (*func)(
FILE *,
void *),
void *data)
678 if (bug_reporters_size >= MAX_BUG_REPORTERS) {
682 reporter->func = func;
683 reporter->data = data;
692#if defined __CYGWIN__ || defined DOSISH
693# define PATH_SEP_ENCODING 1
695 if (x ==
':')
return true;
696 if (x ==
'\\')
return true;
706static const char PATHSEP_REPLACE =
'!';
709append_pathname(
char *p,
const char *pe,
VALUE str)
711#ifdef PATH_SEP_ENCODING
714 const char *s = RSTRING_PTR(str);
715 const char *
const se = s + RSTRING_LEN(str);
720 while (p < pe && s < se && (c = *s) !=
'\0') {
722 if (s == se || !*s)
break;
723 if (path_sep_p(s[1]))
goto skipsep;
725 else if (path_sep_p(c)) {
727 *p++ = PATHSEP_REPLACE;
729 while (++s < se && path_sep_p(*s));
732 const char *
const ss = s;
733 while (p < pe && s < se && *s && !path_sep_p(*s)) {
734#ifdef PATH_SEP_ENCODING
735 int n = rb_enc_mbclen(s, se, enc);
742 if (s > ss) memcpy(p - (s - ss), ss, s - ss);
749append_basename(
char *p,
const char *pe,
struct path_string *path,
VALUE str)
752#ifdef PATH_SEP_ENCODING
755 const char *
const b = RSTRING_PTR(str), *
const e =
RSTRING_END(str), *p = e;
758 if (path_sep_p(p[-1])) {
759#ifdef PATH_SEP_ENCODING
760 const char *t = rb_enc_prev_char(b, p, e, enc);
775 size_t n = path->len;
776 if (p + n > pe) n = pe - p;
777 memcpy(p, path->ptr, n);
782finish_report(
FILE *out, rb_pid_t pid)
784 if (out != stdout && out != stderr) fclose(out);
785#ifdef HAVE_WORKING_FORK
786 if (pid > 0) waitpid(pid, NULL, 0);
815expand_report_argument(
const char **input_template,
struct report_expansion *values,
816 char *buf,
size_t size,
bool word)
819 char *end = buf + size;
820 const char *
template = *input_template;
823 if (p >= end-1 || !*
template)
return NULL;
825 char c = *
template++;
827 if (!store)
continue;
830 switch (c = *
template++) {
832 p = append_basename(p, end, &values->exe,
rb_argv0);
835 p = append_pathname(p, end,
rb_argv0);
838 p = append_basename(p, end, &values->script, GET_VM()->orig_progname);
841 p = append_pathname(p, end, GET_VM()->orig_progname);
844 if (!values->pid) values->pid = getpid();
849 if (!values->time) values->time = time(NULL);
850 snprintf(p, end-p,
"%" PRI_TIMET_PREFIX
"d", values->time);
854 if (c >=
'0' && c <=
'7') {
855 c = (
unsigned char)ruby_scan_oct(
template-1, 3, &n);
857 if (!c) store =
false;
862 if (p < end-1) *p++ = c;
864 *input_template =
template;
869FILE *ruby_popen_writer(
char *
const *argv, rb_pid_t *pid);
872open_report_path(
const char *
template,
char *buf,
size_t size, rb_pid_t *pid)
876 if (!
template)
return NULL;
877 if (0) fprintf(stderr,
"RUBY_CRASH_REPORT=%s\n", buf);
878 if (*
template ==
'|') {
879 char *argv[16], *bufend = buf + size, *p;
882 for (argc = 0; argc < numberof(argv) - 1; ++argc) {
883 while (*
template &&
ISSPACE(*
template))
template++;
884 p = expand_report_argument(&
template, &values, buf, bufend-buf,
true);
890 if (!p)
return ruby_popen_writer(argv, pid);
892 else if (*
template) {
893 expand_report_argument(&
template, &values, buf, size,
false);
894 return fopen(buf,
"w");
899static const char *crash_report;
902#define REPORT_BUG_BUFSIZ 256
904bug_report_file(
const char *file,
int line, rb_pid_t *pid)
906 char buf[REPORT_BUG_BUFSIZ];
907 const char *report = crash_report;
908 if (!report) report = getenv(
"RUBY_CRASH_REPORT");
909 FILE *out = open_report_path(report, buf,
sizeof(buf), pid);
910 int len = err_position_0(buf,
sizeof(buf), file, line);
916 setvbuf(out, NULL, _IONBF, 0);
917 if ((ssize_t)fwrite(buf, 1,
len, out) == (ssize_t)
len)
return out;
920 if ((ssize_t)fwrite(buf, 1,
len, stderr) == (ssize_t)
len) {
923 if ((ssize_t)fwrite(buf, 1,
len, stdout) == (ssize_t)
len) {
930FUNC_MINIMIZED(
static void bug_important_message(
FILE *out,
const char *
const msg,
size_t len));
933bug_important_message(
FILE *out,
const char *
const msg,
size_t len)
935 const char *
const endmsg = msg +
len;
939 if (isatty(fileno(out))) {
940 static const char red[] =
"\033[;31;1;7m";
941 static const char green[] =
"\033[;32;7m";
942 static const char reset[] =
"\033[m";
943 const char *e = strchr(p,
'\n');
944 const int w = (int)(e - p);
946 int i = (int)(e - p);
947 fputs(*p ==
' ' ? green : red, out);
948 fwrite(p, 1, e - p, out);
949 for (; i < w; ++i) fputc(
' ', out);
952 }
while ((p = e + 1) < endmsg && (e = strchr(p,
'\n')) != 0 && e > p + 1);
954 fwrite(p, 1, endmsg - p, out);
957#undef CRASH_REPORTER_MAY_BE_CREATED
958#if defined(__APPLE__) && \
959 (!defined(MAC_OS_X_VERSION_10_6) || MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_6 || defined(__POWERPC__))
960# define CRASH_REPORTER_MAY_BE_CREATED
963preface_dump(
FILE *out)
966 static const char msg[] =
""
967 "-- Crash Report log information "
968 "--------------------------------------------\n"
969 " See Crash Report log file in one of the following locations:\n"
970# ifdef CRASH_REPORTER_MAY_BE_CREATED
971 " * ~/Library/Logs/CrashReporter\n"
972 " * /Library/Logs/CrashReporter\n"
974 " * ~/Library/Logs/DiagnosticReports\n"
975 " * /Library/Logs/DiagnosticReports\n"
976 " for more details.\n"
977 "Don't forget to include the above Crash Report log file in bug reports.\n"
979 const size_t msglen =
sizeof(msg) - 1;
981 const char *msg = NULL;
982 const size_t msglen = 0;
984 bug_important_message(out, msg, msglen);
988postscript_dump(
FILE *out)
991 static const char msg[] =
""
994 "\n""Don't forget to include the Crash Report log file under\n"
995# ifdef CRASH_REPORTER_MAY_BE_CREATED
998 "DiagnosticReports directory in bug reports.\n"
1001 const size_t msglen =
sizeof(msg) - 1;
1003 const char *msg = NULL;
1004 const size_t msglen = 0;
1006 bug_important_message(out, msg, msglen);
1011bug_report_begin_valist(
FILE *out, const
char *fmt, va_list args)
1013 char buf[REPORT_BUG_BUFSIZ];
1015 fputs(
"[BUG] ", out);
1016 vsnprintf(buf,
sizeof(buf), fmt, args);
1018 snprintf(buf,
sizeof(buf),
"\n%s\n\n", rb_dynamic_description);
1023#define bug_report_begin(out, fmt) do { \
1025 va_start(args, fmt); \
1026 bug_report_begin_valist(out, fmt, args); \
1031bug_report_end(
FILE *out, rb_pid_t pid)
1036 for (i=0; i<bug_reporters_size; i++) {
1038 (*reporter->func)(out, reporter->data);
1041 postscript_dump(out);
1042 finish_report(out, pid);
1045#define report_bug(file, line, fmt, ctx) do { \
1046 rb_pid_t pid = -1; \
1047 FILE *out = bug_report_file(file, line, &pid); \
1049 bug_report_begin(out, fmt); \
1050 rb_vm_bugreport(ctx, out); \
1051 bug_report_end(out, pid); \
1055#define report_bug_valist(file, line, fmt, ctx, args) do { \
1056 rb_pid_t pid = -1; \
1057 FILE *out = bug_report_file(file, line, &pid); \
1059 bug_report_begin_valist(out, fmt, args); \
1060 rb_vm_bugreport(ctx, out); \
1061 bug_report_end(out, pid); \
1066ruby_set_crash_report(
const char *
template)
1068 crash_report =
template;
1071 char buf[REPORT_BUG_BUFSIZ];
1072 FILE *out = open_report_path(
template, buf,
sizeof(buf), &pid);
1074 time_t t = time(NULL);
1075 fprintf(out,
"ruby_test_bug_report: %s", ctime(&t));
1076 finish_report(out, pid);
1081NORETURN(
static void die(
void));
1085#if defined(_WIN32) && defined(RUBY_MSVCRT_VERSION) && RUBY_MSVCRT_VERSION >= 80
1087 _set_abort_behavior( 0, _CALL_REPORTFAULT);
1093 signal(SIGABRT, SIG_DFL);
1099rb_bug_without_die_internal(const
char *fmt, va_list args)
1101 const char *file = NULL;
1104 if (rb_current_execution_context(
false)) {
1105 file = rb_source_location_cstr(&line);
1108 report_bug_valist(file, line, fmt, NULL, args);
1113rb_bug_without_die(const
char *fmt, ...)
1116 va_start(args, fmt);
1117 rb_bug_without_die_internal(fmt, args);
1122rb_bug(
const char *fmt, ...)
1125 va_start(args, fmt);
1126 rb_bug_without_die_internal(fmt, args);
1132rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler,
int sig,
const void *ctx,
const char *fmt, ...)
1134 const char *file = NULL;
1137 if (rb_current_execution_context(
false)) {
1138 file = rb_source_location_cstr(&line);
1141 report_bug(file, line, fmt, ctx);
1143 if (default_sighandler) default_sighandler(sig);
1154 rb_bug(
"%s: errno == 0 (NOERROR)", mesg);
1156 const char *errno_str = rb_strerrno(errno_arg);
1158 rb_bug(
"%s: %s (%s)", mesg, strerror(errno_arg), errno_str);
1160 rb_bug(
"%s: %s (%d)", mesg, strerror(errno_arg), errno_arg);
1168#define write_or_abort(fd, str, len) (write((fd), (str), (len)) < 0 ? abort() : (void)0)
1169#define WRITE_CONST(fd,str) write_or_abort((fd),(str),sizeof(str) - 1)
1172rb_async_bug_errno(
const char *mesg,
int errno_arg)
1174 WRITE_CONST(2,
"[ASYNC BUG] ");
1175 write_or_abort(2, mesg, strlen(mesg));
1176 WRITE_CONST(2,
"\n");
1178 if (errno_arg == 0) {
1179 WRITE_CONST(2,
"errno == 0 (NOERROR)\n");
1182 const char *errno_str = rb_strerrno(errno_arg);
1185 errno_str =
"undefined errno";
1186 write_or_abort(2, errno_str, strlen(errno_str));
1188 WRITE_CONST(2,
"\n\n");
1189 write_or_abort(2, rb_dynamic_description, strlen(rb_dynamic_description));
1194rb_report_bug_valist(
VALUE file,
int line,
const char *fmt, va_list args)
1196 report_bug_valist(RSTRING_PTR(file), line, fmt, NULL, args);
1200rb_assert_failure(
const char *file,
int line,
const char *name,
const char *expr)
1202 rb_assert_failure_detail(file, line, name, expr, NULL);
1206rb_assert_failure_detail(
const char *file,
int line,
const char *name,
const char *expr,
1207 const char *fmt, ...)
1210 FILE *out = bug_report_file(file, line, &pid);
1212 fputs(
"Assertion Failed: ", out);
1213 if (name) fprintf(out,
"%s:", name);
1218 va_start(args, fmt);
1220 vfprintf(out, fmt, args);
1223 fprintf(out,
"\n%s\n\n", rb_dynamic_description);
1226 rb_vm_bugreport(NULL, out);
1227 bug_report_end(out, pid);
1233static const char builtin_types[][10] = {
1266rb_builtin_type_name(
int t)
1269 if ((
unsigned int)t >= numberof(builtin_types))
return 0;
1270 name = builtin_types[t];
1271 if (*name)
return name;
1276displaying_class_of(
VALUE x)
1279 case Qfalse:
return rb_fstring_cstr(
"false");
1280 case Qnil:
return rb_fstring_cstr(
"nil");
1281 case Qtrue:
return rb_fstring_cstr(
"true");
1287builtin_class_name(
VALUE x)
1313rb_builtin_class_name(
VALUE x)
1315 const char *etype = builtin_class_name(x);
1323COLDFUNC NORETURN(
static void unexpected_type(
VALUE,
int,
int));
1324#define UNDEF_LEAKED "undef leaked to the Ruby space"
1329 rb_raise(
rb_eTypeError,
"wrong argument type %s (expected %s)",
1336 rb_raise(
rb_eTypeError,
"wrong argument type %"PRIsVALUE
" (expected %s)",
1337 displaying_class_of(obj), expected);
1341unexpected_type(
VALUE x,
int xt,
int t)
1343 const char *tname = rb_builtin_type_name(t);
1349 else if (xt >
T_MASK && xt <= 0x3f) {
1350 mesg = rb_sprintf(
"unknown type 0x%x (0x%x given, probably comes"
1351 " from extension library for ruby 1.8)", t, xt);
1354 mesg = rb_sprintf(
"unknown type 0x%x (0x%x given)", t, xt);
1364 if (RB_UNLIKELY(UNDEF_P(x))) {
1365 rb_bug(UNDEF_LEAKED);
1381 unexpected_type(x, xt, t);
1388 if (RB_UNLIKELY(UNDEF_P(x))) {
1389 rb_bug(UNDEF_LEAKED);
1392 unexpected_type(x,
TYPE(x), t);
1395#undef rb_typeddata_inherited_p
1399 return rbimpl_typeddata_inherited_p_inline(child, parent);
1402#undef rb_typeddata_is_kind_of
1406 return rbimpl_typeddata_is_kind_of_inline(obj, data_type);
1409#undef rb_typeddata_is_instance_of
1413 return rb_typeddata_is_instance_of_inline(obj, data_type);
1419 return rbimpl_check_typeddata(obj, data_type);
1453static VALUE rb_eNOERROR;
1455ID ruby_static_id_cause;
1456#define id_cause ruby_static_id_cause
1457static ID id_message, id_detailed_message, id_backtrace;
1458static ID id_key, id_matchee, id_args, id_Errno, id_errno, id_i_path;
1459static ID id_receiver, id_recv, id_iseq, id_local_variables;
1460static ID id_private_call_p, id_top, id_bottom;
1462#define id_bt_locations idBt_locations
1463#define id_mesg idMesg
1464#define id_name idName
1466#undef rb_exc_new_cstr
1484 rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
1519exc_initialize(
int argc,
VALUE *argv,
VALUE exc)
1524 return exc_init(exc, arg);
1553exc_exception(
int argc,
VALUE *argv,
VALUE self)
1558 if (argc == 0)
return self;
1559 if (argc == 1 && self == argv[0])
return self;
1581 VALUE mesg = rb_attr_get(exc, idMesg);
1591rb_get_message(
VALUE exc)
1594 if (UNDEF_P(e))
return Qnil;
1609 if (UNDEF_P(e))
return Qnil;
1621exc_s_to_tty_p(
VALUE self)
1623 return RBOOL(rb_stderr_tty_p());
1627check_highlight_keyword(
VALUE opt,
int auto_tty_detect)
1632 highlight = rb_hash_lookup(opt, sym_highlight);
1634 switch (highlight) {
1636 rb_bool_expected(highlight,
"highlight", TRUE);
1642 if (
NIL_P(highlight)) {
1643 highlight = RBOOL(auto_tty_detect && rb_stderr_tty_p());
1650check_order_keyword(
VALUE opt)
1655 static VALUE kw_order;
1658 order = rb_hash_lookup(opt, kw_order);
1660 if (order !=
Qnil) {
1662 if (
id == id_bottom) order =
Qtrue;
1663 else if (
id == id_top) order =
Qfalse;
1666 "order: %+"PRIsVALUE, order);
1726exc_full_message(
int argc,
VALUE *argv,
VALUE exc)
1728 VALUE opt, str, emesg, errat;
1729 VALUE highlight, order;
1733 highlight = check_highlight_keyword(opt, 1);
1734 order = check_order_keyword(opt);
1737 if (
NIL_P(opt)) opt = rb_hash_new();
1738 rb_hash_aset(opt, sym_highlight, highlight);
1742 errat = rb_get_backtrace(exc);
1743 emesg = rb_get_detailed_message(exc, opt);
1745 rb_error_write(exc, emesg, errat, str, opt, highlight, order);
1759exc_message(
VALUE exc)
1770load_decoration_gem(
VALUE feature)
1781require_decoration_gems(
void)
1787 VALUE saved_errinfo = rb_errinfo();
1788 static const char *
const gems[] = {
"ErrorHighlight",
"DidYouMean",
"SyntaxSuggest"};
1789 for (
size_t i = 0; i < numberof(gems); i++) {
1791 if (
NIL_P(feature))
continue;
1793 rb_protect(load_decoration_gem, feature, &state);
1796 rb_set_errinfo(saved_errinfo);
1805lazy_load_decoration_gems(
VALUE exc)
1807 if (ATOMIC_EXCHANGE(decoration_gems_loaded, 1))
return false;
1814 require_decoration_gems();
1822rb_eager_load_detailed_message_extension(
void)
1824 if (ATOMIC_EXCHANGE(decoration_gems_loaded, 1))
return;
1826 require_decoration_gems();
1875exc_detailed_message(
int argc,
VALUE *argv,
VALUE exc)
1877 if (lazy_load_decoration_gems(exc)) {
1885 VALUE highlight = check_highlight_keyword(opt, 0);
1887 extern VALUE rb_decorate_message(
const VALUE eclass,
VALUE emesg,
int highlight);
1889 return rb_decorate_message(
CLASS_OF(exc), rb_get_message(exc),
RTEST(highlight));
1906exc_inspect(
VALUE exc)
1912 if (RSTRING_LEN(exc) == 0) {
1921 rb_str_catf(str,
":%+"PRIsVALUE, exc);
1967exc_backtrace(
VALUE exc)
1971 obj = rb_attr_get(exc, id_bt);
1973 if (rb_backtrace_p(obj)) {
1974 obj = rb_backtrace_to_str_ary(obj);
1984rb_get_backtrace(
VALUE exc)
1986 ID mid = id_backtrace;
1994 info = exc_backtrace(exc);
2001 return rb_check_backtrace(info);
2043exc_backtrace_locations(
VALUE exc)
2047 obj = rb_attr_get(exc, id_bt_locations);
2049 obj = rb_backtrace_to_location_ary(obj);
2055rb_check_backtrace(
VALUE bt)
2058 static const char err[] =
"backtrace must be an Array of String or an Array of Thread::Backtrace::Location";
2062 if (rb_backtrace_p(bt))
return bt;
2181 VALUE btobj = rb_location_ary_to_backtrace(bt);
2188 return rb_ivar_set(exc, id_bt, rb_check_backtrace(bt));
2195 return exc_set_backtrace(exc, bt);
2233 return rb_attr_get(exc, id_cause);
2237try_convert_to_exception(
VALUE obj)
2254 VALUE mesg, backtrace;
2256 if (exc == obj)
return Qtrue;
2261 obj = rb_protect(try_convert_to_exception, obj, &state);
2262 if (state || UNDEF_P(obj)) {
2263 rb_set_errinfo(
Qnil);
2268 if (UNDEF_P(mesg))
return Qfalse;
2270 if (UNDEF_P(backtrace))
return Qfalse;
2273 mesg = rb_attr_get(obj, id_mesg);
2274 backtrace = exc_backtrace(obj);
2277 if (!
rb_equal(rb_attr_get(exc, id_mesg), mesg))
2279 return rb_equal(exc_backtrace(exc), backtrace);
2295exit_initialize(
int argc,
VALUE *argv,
VALUE exc)
2303 status =
INT2FIX(EXIT_SUCCESS);
2308 status =
INT2FIX(EXIT_FAILURE);
2314 if (
NIL_P(status)) {
2315 status =
INT2FIX(EXIT_SUCCESS);
2318#if EXIT_SUCCESS != 0
2320 status =
INT2FIX(EXIT_SUCCESS);
2329 status =
INT2FIX(EXIT_SUCCESS);
2345exit_status(
VALUE exc)
2347 return rb_attr_get(exc, id_status);
2359exit_success_p(
VALUE exc)
2361 VALUE status_val = rb_attr_get(exc, id_status);
2364 if (
NIL_P(status_val))
2367 return RBOOL(WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SUCCESS);
2373 if (!UNDEF_P(recv))
rb_ivar_set(exc, id_recv, recv);
2390frozen_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2393 VALUE values[numberof(keywords)], options;
2396 keywords[0] = id_receiver;
2397 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2399 err_init_recv(self, values[0]);
2411#define frozen_err_receiver name_err_receiver
2419 va_start(args, fmt);
2434 va_start(args, fmt);
2448 cfp = rb_vm_get_ruby_level_next_cfp(ec, cfp);
2450 err_init_recv(exc, recv);
2451 if (cfp && VM_FRAME_TYPE(cfp) != VM_FRAME_MAGIC_DUMMY) {
2452 rb_ivar_set(exc, id_iseq, rb_iseqw_new(CFP_ISEQ(cfp)));
2471name_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2474 VALUE values[numberof(keywords)], name, options;
2477 keywords[0] = id_receiver;
2478 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2479 name = (argc > 1) ? argv[--argc] :
Qnil;
2481 name_err_init_attr(self, values[0], name);
2490 exc_init(exc, rb_name_err_mesg_new(mesg, recv, method));
2491 return name_err_init_attr(exc, recv, method);
2498 return name_err_init(exc, mesg, recv, method);
2509name_err_name(
VALUE self)
2511 return rb_attr_get(self, id_name);
2525name_err_local_variables(
VALUE self)
2527 VALUE vars = rb_attr_get(self, id_local_variables);
2530 VALUE iseqw = rb_attr_get(self, id_iseq);
2531 if (!
NIL_P(iseqw)) vars = rb_iseqw_local_variables(iseqw);
2539nometh_err_init_attr(
VALUE exc,
VALUE args,
int priv)
2563nometh_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2566 VALUE args, options;
2568 priv = (argc > 3) && (--argc,
RTEST(argv[argc]));
2569 args = (argc > 2) ? argv[--argc] :
Qnil;
2570 if (!
NIL_P(options)) argv[argc++] = options;
2572 return nometh_err_init_attr(self, args, priv);
2579 name_err_init(exc, mesg, recv, method);
2580 return nometh_err_init_attr(exc, args, priv);
2590name_err_mesg_mark_and_move(
void *p)
2593 rb_gc_mark_and_move(&ptr->mesg);
2594 rb_gc_mark_and_move(&ptr->recv);
2595 rb_gc_mark_and_move(&ptr->name);
2601 name_err_mesg_mark_and_move,
2604 name_err_mesg_mark_and_move,
2606 0, 0, RUBY_TYPED_THREAD_SAFE_FREE | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE
2630name_err_mesg_alloc(
VALUE klass)
2637name_err_mesg_init_copy(
VALUE obj1,
VALUE obj2)
2639 if (obj1 == obj2)
return obj1;
2656 if (obj1 == obj2)
return Qtrue;
2673name_err_mesg_receiver_name(
VALUE obj)
2684name_err_mesg_to_str(
VALUE obj)
2689 VALUE mesg = ptr->mesg;
2692 struct RString s_str = {RBASIC_INIT}, c_str = {RBASIC_INIT}, d_str = {RBASIC_INIT};
2693 VALUE c, s, d = 0, args[4], c2;
2697#define rb_memsearch_lit(str, v) \
2698 rb_memsearch((str), rb_strlen_lit(str), RSTRING_PTR(v), RSTRING_LEN(v), rb_enc_get(v))
2699#define FAKE_CSTR(v, str) rb_setup_fake_str((v), (str), rb_strlen_lit(str), usascii)
2700 c = s = FAKE_CSTR(&s_str,
"");
2704 c = d = FAKE_CSTR(&d_str,
"nil");
2707 c = d = FAKE_CSTR(&d_str,
"true");
2710 c = d = FAKE_CSTR(&d_str,
"false");
2713 if (rb_memsearch_lit(
"%2$s", mesg) >= 0) {
2714 d = rb_protect(name_err_mesg_receiver_name, obj, &state);
2715 if (state || NIL_OR_UNDEF_P(d))
2718 rb_set_errinfo(
Qnil);
2729 s = FAKE_CSTR(&s_str,
"module ");
2733 s = FAKE_CSTR(&s_str,
"class ");
2745 s = FAKE_CSTR(&s_str,
"");
2746 if (obj == rb_vm_top_self()) {
2747 c = FAKE_CSTR(&c_str,
"main");
2755 s = FAKE_CSTR(&s_str,
"an instance of ");
2759 c2 = rb_protect(name_err_mesg_receiver_name, c, &state);
2760 if (state || NIL_OR_UNDEF_P(c2))
2763 rb_set_errinfo(
Qnil);
2785 return name_err_mesg_to_str(obj);
2803name_err_receiver(
VALUE self)
2805 VALUE recv = rb_ivar_lookup(self, id_recv,
Qundef);
2806 if (!UNDEF_P(recv))
return recv;
2808 VALUE mesg = rb_attr_get(self, id_mesg);
2809 if (!rb_typeddata_is_kind_of(mesg, &name_err_mesg_data_type)) {
2827nometh_err_args(
VALUE self)
2829 return rb_attr_get(self, id_args);
2840nometh_err_private_call_p(
VALUE self)
2842 return rb_attr_get(self, id_private_call_p);
2846type_err_cname(
VALUE val)
2851 else if (val ==
Qtrue) {
2854 else if (val ==
Qfalse) {
2860NORETURN(
static void type_err_raise(
VALUE val,
const char *tname,
const char *msg));
2862type_err_raise(
VALUE val,
const char *tname,
const char *msg)
2864 const char *cname = type_err_cname(val);
2872NORETURN(
void rb_no_implicit_conversion(
VALUE val,
const char *tname));
2874rb_no_implicit_conversion(
VALUE val,
const char *tname)
2876 type_err_raise(val, tname,
"no implicit conversion of");
2879NORETURN(
void rb_cant_convert(
VALUE val,
const char *tname));
2881rb_cant_convert(
VALUE val,
const char *tname)
2883 type_err_raise(val, tname,
"can't convert");
2886NORETURN(
void rb_cant_convert_invalid_return(
VALUE val,
const char *tname,
const char *method_name,
VALUE ret));
2888rb_cant_convert_invalid_return(
VALUE val,
const char *tname,
const char *method_name,
VALUE ret)
2890 const char *cname = type_err_cname(val);
2894 enc,
rb_eTypeError,
"can't convert %s into %s (%s#%s gives %s)",
2895 cname, tname, cname, method_name, type_err_cname(ret));
2898 const char *retname = type_err_cname(ret);
2903 enc,
rb_eTypeError,
"can't convert %"PRIsVALUE
" into %s (%"PRIsVALUE
"#%s gives %s)",
2904 klass, tname, klass, method_name, retname);
2923key_err_receiver(
VALUE self)
2927 recv = rb_ivar_lookup(self, id_receiver,
Qundef);
2928 if (!UNDEF_P(recv))
return recv;
2940key_err_key(
VALUE self)
2944 key = rb_ivar_lookup(self, id_key,
Qundef);
2945 if (!UNDEF_P(key))
return key;
2969key_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2975 if (!
NIL_P(options)) {
2977 VALUE values[numberof(keywords)];
2979 keywords[0] = id_receiver;
2980 keywords[1] = id_key;
2981 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2982 for (i = 0; i < numberof(values); ++i) {
2983 if (!UNDEF_P(values[i])) {
3000no_matching_pattern_key_err_matchee(
VALUE self)
3004 matchee = rb_ivar_lookup(self, id_matchee,
Qundef);
3005 if (!UNDEF_P(matchee))
return matchee;
3017no_matching_pattern_key_err_key(
VALUE self)
3021 key = rb_ivar_lookup(self, id_key,
Qundef);
3022 if (!UNDEF_P(key))
return key;
3035no_matching_pattern_key_err_initialize(
int argc,
VALUE *argv,
VALUE self)
3041 if (!
NIL_P(options)) {
3043 VALUE values[numberof(keywords)];
3045 keywords[0] = id_matchee;
3046 keywords[1] = id_key;
3047 rb_get_kwargs(options, keywords, 0, numberof(values), values);
3048 for (i = 0; i < numberof(values); ++i) {
3049 if (!UNDEF_P(values[i])) {
3067syntax_error_initialize(
int argc,
VALUE *argv,
VALUE self)
3071 mesg = rb_fstring_lit(
"compile error");
3082 *mesg = rb_enc_str_new(0, 0, enc);
3087 VALUE old_path = rb_attr_get(exc, id_i_path);
3088 if (old_path != path) {
3090 rb_raise(
rb_eArgError,
"SyntaxError#path changed: %+"PRIsVALUE
" (%p->%p)",
3091 old_path, (
void *)old_path, (
void *)path);
3094 rb_raise(
rb_eArgError,
"SyntaxError#path changed: %+"PRIsVALUE
"(%s%s)->%+"PRIsVALUE
"(%s)",
3095 old_path, rb_enc_name(rb_enc_get(old_path)),
3096 (
FL_TEST(old_path, RSTRING_FSTR) ?
":FSTR" :
""),
3097 path, rb_enc_name(rb_enc_get(path)));
3100 VALUE s = *mesg = rb_attr_get(exc, idMesg);
3101 if (RSTRING_LEN(s) > 0 && *(
RSTRING_END(s)-1) !=
'\n')
3162rb_free_warning(
void)
3164 st_free_table(warning_categories.id2enum);
3165 st_free_table(warning_categories.enum2id);
3166 st_free_table(syserr_tbl);
3170setup_syserr(
int n,
const char *name)
3179#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
3184 rb_eEWOULDBLOCK = error;
3187 rb_eEINPROGRESS = error;
3191 rb_define_const(error,
"Errno",
INT2NUM(n));
3192 st_add_direct(syserr_tbl, n, (st_data_t)error);
3197set_syserr(
int n,
const char *name)
3201 if (!st_lookup(syserr_tbl, n, &error)) {
3202 return setup_syserr(n, name);
3206 rb_define_const(
rb_mErrno, name, errclass);
3216 if (!st_lookup(syserr_tbl, n, &error)) {
3219 snprintf(name,
sizeof(name),
"E%03d", n);
3220 return setup_syserr(n, name);
3222 return (
VALUE)error;
3257syserr_initialize(
int argc,
VALUE *argv,
VALUE self)
3260 VALUE mesg, error, func, errmsg;
3264 st_data_t data = (st_data_t)klass;
3267 error = mesg; mesg =
Qnil;
3269 if (!
NIL_P(error) && st_lookup(syserr_tbl,
NUM2LONG(error), &data)) {
3270 klass = (
VALUE)data;
3275 RBASIC_SET_CLASS(self, klass);
3283 else err =
"unknown error";
3289 if (!
NIL_P(func)) rb_str_catf(errmsg,
" @ %"PRIsVALUE, func);
3290 rb_str_catf(errmsg,
" - %"PRIsVALUE, str);
3307syserr_errno(
VALUE self)
3309 return rb_attr_get(self, id_errno);
3330 num = rb_attr_get(exc, id_errno);
3714exception_alloc(
VALUE klass)
3716 return rb_class_allocate_instance(klass);
3720exception_dumper(
VALUE exc)
3730ivar_copy_i(
ID key,
VALUE val, st_data_t exc)
3736void rb_exc_check_circular_cause(
VALUE exc);
3752 rb_exc_check_circular_cause(exc);
3754 if (rb_attr_get(exc, id_bt) == rb_attr_get(exc, id_bt_locations)) {
3849 syserr_tbl = st_init_numtable();
3857 rb_mWarning = rb_define_module(
"Warning");
3865 rb_cWarningBuffer = rb_define_class_under(rb_mWarning,
"buffer",
rb_cString);
3889 id_iseq = rb_make_internal_id();
3890 id_recv = rb_make_internal_id();
3892 sym_category =
ID2SYM(id_category);
3895 warning_categories.id2enum = rb_init_identtable();
3901 warning_categories.enum2id = rb_init_identtable();
3915 va_start(args, fmt);
3923rb_vraise(
VALUE exc,
const char *fmt, va_list ap)
3929rb_raise(
VALUE exc_class,
const char *fmt, ...)
3932 va_start(args, fmt);
3938NORETURN(
static void raise_loaderror(
VALUE path,
VALUE mesg));
3954 va_start(args, fmt);
3957 raise_loaderror(
Qnil, mesg);
3966 va_start(args, fmt);
3969 raise_loaderror(path, mesg);
3976 "%"PRIsVALUE
"() function is unimplemented on this machine",
3977 rb_id2str(rb_frame_this_func()));
3981rb_fatal(
const char *fmt, ...)
3986 if (! ruby_thread_has_gvl_p()) {
3989 fprintf(stderr,
"[FATAL] rb_fatal() outside of GVL\n");
3990 rb_print_backtrace(stderr);
3994 va_start(args, fmt);
4002make_errno_exc(
const char *mesg)
4008 rb_bug(
"rb_sys_fail(%s) - errno == 0", mesg ? mesg :
"");
4014make_errno_exc_str(
VALUE mesg)
4019 if (!mesg) mesg =
Qnil;
4021 const char *s = !
NIL_P(mesg) ? RSTRING_PTR(mesg) :
"";
4022 rb_bug(
"rb_sys_fail_str(%s) - errno == 0", s);
4055rb_sys_fail(
const char *mesg)
4060#undef rb_sys_fail_str
4067#ifdef RUBY_FUNCTION_NAME_STRING
4069rb_sys_fail_path_in(
const char *func_name,
VALUE path)
4074 rb_syserr_fail_path_in(func_name, n, path);
4078rb_syserr_fail_path_in(
const char *func_name,
int n,
VALUE path)
4080 rb_exc_raise(rb_syserr_new_path_in(func_name, n, path));
4084rb_syserr_new_path_in(
const char *func_name,
int n,
VALUE path)
4088 if (!path) path =
Qnil;
4090 const char *s = !
NIL_P(path) ? RSTRING_PTR(path) :
"";
4091 if (!func_name) func_name =
"(null)";
4092 rb_bug(
"rb_sys_fail_path_in(%s, %s) - errno == 0",
4101NORETURN(
static void rb_mod_exc_raise(
VALUE exc,
VALUE mod));
4113 VALUE exc = make_errno_exc(mesg);
4114 rb_mod_exc_raise(exc, mod);
4120 VALUE exc = make_errno_exc_str(mesg);
4121 rb_mod_exc_raise(exc, mod);
4128 rb_mod_exc_raise(exc, mod);
4135 rb_mod_exc_raise(exc, mod);
4139syserr_warning(
VALUE mesg,
int err)
4142 rb_str_catf(mesg,
": %s\n", strerror(err));
4143 rb_write_warning_str(mesg);
4148rb_sys_warn(
const char *fmt, ...)
4151 int errno_save =
errno;
4152 with_warning_string(mesg, 0, fmt) {
4153 syserr_warning(mesg, errno_save);
4160rb_syserr_warn(
int err,
const char *fmt, ...)
4163 with_warning_string(mesg, 0, fmt) {
4164 syserr_warning(mesg, err);
4170rb_sys_enc_warn(
rb_encoding *enc,
const char *fmt, ...)
4173 int errno_save =
errno;
4174 with_warning_string(mesg, enc, fmt) {
4175 syserr_warning(mesg, errno_save);
4182rb_syserr_enc_warn(
int err,
rb_encoding *enc,
const char *fmt, ...)
4185 with_warning_string(mesg, enc, fmt) {
4186 syserr_warning(mesg, err);
4196 int errno_save =
errno;
4197 with_warning_string(mesg, 0, fmt) {
4198 syserr_warning(mesg, errno_save);
4206rb_syserr_warning(
int err,
const char *fmt, ...)
4209 with_warning_string(mesg, 0, fmt) {
4210 syserr_warning(mesg, err);
4217rb_sys_enc_warning(
rb_encoding *enc,
const char *fmt, ...)
4220 int errno_save =
errno;
4221 with_warning_string(mesg, enc, fmt) {
4222 syserr_warning(mesg, errno_save);
4229rb_syserr_enc_warning(
int err,
rb_encoding *enc,
const char *fmt, ...)
4232 with_warning_string(mesg, enc, fmt) {
4233 syserr_warning(mesg, err);
4239rb_load_fail(
VALUE path,
const char *err)
4244 raise_loaderror(path, mesg);
4259 va_start(args, fmt);
4268inspect_frozen_obj(
VALUE obj,
VALUE mesg,
int recur)
4280get_created_info(
VALUE obj,
int *pline)
4282 VALUE info = rb_attr_get(obj, id_debug_created_info);
4296 rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
4298 VALUE mesg = rb_sprintf(
"can't modify frozen %"PRIsVALUE
": ",
4306 VALUE created_path = get_created_info(frozen_obj, &created_line);
4307 if (!
NIL_P(created_path)) {
4308 rb_str_catf(mesg,
", created at %"PRIsVALUE
":%d", created_path, created_line);
4314rb_warn_unchilled_literal(
VALUE obj)
4319 VALUE file = rb_source_location(&line);
4323 if (line) rb_str_catf(mesg,
":%d", line);
4326 rb_str_cat2(mesg,
"warning: literal string will be frozen in the future");
4329 if (STR_SHARED_P(str)) {
4330 str =
RSTRING(obj)->as.heap.aux.shared;
4332 VALUE created = get_created_info(str, &line);
4333 if (
NIL_P(created)) {
4334 rb_str_cat2(mesg,
" (run with --debug-frozen-string-literal for more information)\n");
4339 if (line) rb_str_catf(mesg,
":%d", line);
4340 rb_str_cat2(mesg,
": info: the string was created here\n");
4342 rb_warn_category(mesg, rb_warning_category_to_name(category));
4346#undef rb_check_frozen
4357 rb_check_frozen(obj);
4364 rb_eNOERROR = setup_syserr(0,
"NOERROR");
4367 rb_define_const(
rb_mErrno,
"NOERROR", rb_eNOERROR);
4369#define defined_error(name, num) set_syserr((num), (name));
4370#define undefined_error(name) rb_define_const(rb_mErrno, (name), rb_eNOERROR);
4371#include "known_errors.inc"
4373#undef undefined_error
4376#include "warning.rbinc"
#define RUBY_DEBUG
Define this macro when you want assertions.
std::atomic< unsigned > rb_atomic_t
Type that is eligible for atomic operations.
#define rb_define_method(klass, mid, func, arity)
Defines klass#mid.
#define rb_define_singleton_method(klass, mid, func, arity)
Defines klass.mid.
VALUE rb_enc_vsprintf(rb_encoding *enc, const char *fmt, va_list ap)
Identical to rb_enc_sprintf(), except it takes a va_list instead of variadic arguments.
#define RUBY_EVENT_C_CALL
A method, written in C, is called.
#define RUBY_EVENT_C_RETURN
Return from a method, written in C.
void rb_extend_object(VALUE obj, VALUE module)
Extend the object with the module.
VALUE rb_singleton_class(VALUE obj)
Finds or creates the singleton class of the passed object.
int rb_scan_args(int argc, const VALUE *argv, const char *fmt,...)
Retrieves argument from argc and argv to given VALUE references according to the format string.
int rb_get_kwargs(VALUE keyword_hash, const ID *table, int required, int optional, VALUE *values)
Keyword argument deconstructor.
#define rb_str_new2
Old name of rb_str_new_cstr.
#define TYPE(_)
Old name of rb_type.
#define ISSPACE
Old name of rb_isspace.
#define T_STRING
Old name of RUBY_T_STRING.
#define T_MASK
Old name of RUBY_T_MASK.
#define Qundef
Old name of RUBY_Qundef.
#define INT2FIX
Old name of RB_INT2FIX.
#define rb_str_cat2
Old name of rb_str_cat_cstr.
#define UNREACHABLE
Old name of RBIMPL_UNREACHABLE.
#define ID2SYM
Old name of RB_ID2SYM.
#define rb_str_buf_new2
Old name of rb_str_buf_new_cstr.
#define T_DATA
Old name of RUBY_T_DATA.
#define CLASS_OF
Old name of rb_class_of.
#define T_MODULE
Old name of RUBY_T_MODULE.
#define T_TRUE
Old name of RUBY_T_TRUE.
#define FL_ABLE
Old name of RB_FL_ABLE.
#define rb_ary_new3
Old name of rb_ary_new_from_args.
#define rb_exc_new3
Old name of rb_exc_new_str.
#define T_FALSE
Old name of RUBY_T_FALSE.
#define Qtrue
Old name of RUBY_Qtrue.
#define NUM2INT
Old name of RB_NUM2INT.
#define INT2NUM
Old name of RB_INT2NUM.
#define Qnil
Old name of RUBY_Qnil.
#define Qfalse
Old name of RUBY_Qfalse.
#define T_ARRAY
Old name of RUBY_T_ARRAY.
#define T_OBJECT
Old name of RUBY_T_OBJECT.
#define NIL_P
Old name of RB_NIL_P.
#define T_SYMBOL
Old name of RUBY_T_SYMBOL.
#define T_CLASS
Old name of RUBY_T_CLASS.
#define FL_TEST
Old name of RB_FL_TEST.
#define NUM2LONG
Old name of RB_NUM2LONG.
#define FIXNUM_P
Old name of RB_FIXNUM_P.
#define SYMBOL_P
Old name of RB_SYMBOL_P.
void rb_notimplement(void)
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...
rb_warning_category_t
Warning categories.
void rb_category_warn(rb_warning_category_t category, const char *fmt,...)
Identical to rb_category_warning(), except it reports unless $VERBOSE is nil.
void rb_category_warning(rb_warning_category_t category, const char *fmt,...)
Identical to rb_warning(), except it takes additional "category" parameter.
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.
VALUE rb_eNotImpError
NotImplementedError exception.
VALUE rb_eScriptError
ScriptError exception.
void rb_exc_raise(VALUE mesg)
Raises an exception in the current thread.
void rb_syserr_fail(int e, const char *mesg)
Raises appropriate exception that represents a C errno.
VALUE rb_eKeyError
KeyError exception.
VALUE rb_cNameErrorMesg
NameError::Message class.
VALUE rb_eSystemExit
SystemExit exception.
void rb_name_error(ID id, const char *fmt,...)
Raises an instance of rb_eNameError.
void rb_sys_warning(const char *fmt,...)
Identical to rb_sys_fail(), except it does not raise an exception to render a warning instead.
void rb_check_copyable(VALUE obj, VALUE orig)
Ensures that the passed object can be initialize_copy relationship.
VALUE rb_eStandardError
StandardError exception.
VALUE rb_mErrno
Errno module.
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.
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.
void rb_error_frozen(const char *what)
Identical to rb_frozen_error_raise(), except its raising exception has a message like "can't modify f...
VALUE rb_eFrozenError
FrozenError exception.
VALUE rb_eNoMemError
NoMemoryError exception.
VALUE rb_eRangeError
RangeError exception.
VALUE rb_eLoadError
LoadError exception.
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.
#define ruby_verbose
This variable controls whether the interpreter is in debug mode.
VALUE rb_eTypeError
TypeError exception.
void rb_unexpected_object_type(VALUE obj, const char *expected)
Fails with the given object's type incompatibility to the type.
VALUE rb_eNoMatchingPatternError
NoMatchingPatternError exception.
void rb_name_error_str(VALUE str, const char *fmt,...)
Identical to rb_name_error(), except it takes a VALUE instead of ID.
void rb_frozen_error_raise(VALUE frozen_obj, const char *fmt,...)
Raises an instance of rb_eFrozenError.
VALUE rb_eEncCompatError
Encoding::CompatibilityError exception.
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.
VALUE rb_eFatal
fatal exception.
void rb_invalid_str(const char *str, const char *type)
Honestly I don't understand the name, but it raises an instance of rb_eArgError.
VALUE rb_eInterrupt
Interrupt exception.
VALUE rb_eNameError
NameError exception.
VALUE rb_eNoMethodError
NoMethodError exception.
void rb_exc_fatal(VALUE mesg)
Raises a fatal error in the current thread.
VALUE rb_eRuntimeError
RuntimeError exception.
void * rb_check_typeddata(VALUE obj, const rb_data_type_t *data_type)
Identical to rb_typeddata_is_kind_of(), except it raises exceptions instead of returning false.
void rb_warn(const char *fmt,...)
Identical to rb_warning(), except it reports unless $VERBOSE is nil.
VALUE rb_exc_new(VALUE etype, const char *ptr, long len)
Creates an instance of the passed exception class.
VALUE rb_eNoMatchingPatternKeyError
NoMatchingPatternKeyError exception.
void rb_error_frozen_object(VALUE frozen_obj)
Identical to rb_error_frozen(), except it takes arbitrary Ruby object instead of C's string.
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.
VALUE rb_eArgError
ArgumentError exception.
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...
void rb_enc_raise(rb_encoding *enc, VALUE exc, const char *fmt,...)
Identical to rb_raise(), except it additionally takes an encoding.
void rb_loaderror(const char *fmt,...)
Raises an instance of rb_eLoadError.
VALUE rb_eException
Mother of all exceptions.
VALUE rb_eIndexError
IndexError exception.
void rb_loaderror_with_path(VALUE path, const char *fmt,...)
Identical to rb_loaderror(), except it additionally takes which file is unable to load.
VALUE rb_eSyntaxError
SyntaxError exception.
VALUE rb_eEncodingError
EncodingError exception.
void rb_unexpected_typeddata(const rb_data_type_t *actual, const rb_data_type_t *expected)
Fails with the given object's type incompatibility to the type.
VALUE rb_syserr_new(int n, const char *mesg)
Creates an exception object that represents the given C errno.
VALUE rb_eSecurityError
SecurityError exception.
void rb_unexpected_type(VALUE x, int t)
Fails with the given object's type incompatibility to the type.
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.
void rb_check_type(VALUE x, int t)
This was the old implementation of Check_Type(), but they diverged.
VALUE rb_eSystemCallError
SystemCallError exception.
void rb_warning(const char *fmt,...)
Issues a warning.
VALUE rb_eSignal
SignalException exception.
@ RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK
Warning is for checking unused block strictly.
@ RB_WARN_CATEGORY_DEPRECATED
Warning is for deprecated features.
@ RB_WARN_CATEGORY_EXPERIMENTAL
Warning is for experimental features.
@ RB_WARN_CATEGORY_PERFORMANCE
Warning is for performance issues (not enabled by -w).
@ RB_WARN_CATEGORY_NONE
Category unspecified.
VALUE rb_check_to_int(VALUE val)
Identical to rb_check_to_integer(), except it uses #to_int for conversion.
VALUE rb_cObject
Object class.
VALUE rb_any_to_s(VALUE obj)
Generates a textual representation of the given object.
VALUE rb_obj_alloc(VALUE klass)
Allocates an instance of the given class.
VALUE rb_class_new_instance(int argc, const VALUE *argv, VALUE klass)
Allocates, then initialises an instance of the given class.
VALUE rb_obj_init_copy(VALUE src, VALUE dst)
Default implementation of #initialize_copy, #initialize_dup and #initialize_clone.
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
VALUE rb_cEncoding
Encoding class.
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
VALUE rb_equal(VALUE lhs, VALUE rhs)
This function is an optimised version of calling #==.
VALUE rb_obj_clone(VALUE obj)
Produces a shallow copy of the given object.
VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass)
Queries if the given object is an instance (of possibly descendants) of the given class.
VALUE rb_String(VALUE val)
This is the logic behind Kernel#String.
VALUE rb_cString
String class.
#define RB_OBJ_WRITE(old, slot, young)
Declaration of a "back" pointer.
VALUE rb_enc_str_new_cstr(const char *ptr, rb_encoding *enc)
Identical to rb_enc_str_new(), except it assumes the passed pointer is a pointer to a C string.
VALUE rb_funcall(VALUE recv, ID mid, int n,...)
Calls a method.
VALUE rb_funcallv_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_funcallv(), except you can specify how to handle the last element of the given array.
VALUE rb_funcallv(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcall(), except it takes the method arguments as a C array.
VALUE rb_call_super_kw(int argc, const VALUE *argv, int kw_splat)
Identical to rb_call_super(), except you can specify how to handle the last element of the given arra...
VALUE rb_call_super(int argc, const VALUE *argv)
This resembles ruby's super.
Defines RBIMPL_HAS_BUILTIN.
VALUE rb_ary_new(void)
Allocates a new, empty array.
VALUE rb_ary_new_capa(long capa)
Identical to rb_ary_new(), except it additionally specifies how many rooms of objects it should alloc...
VALUE rb_ary_push(VALUE ary, VALUE elem)
Special case of rb_ary_cat() that it adds only one element.
VALUE rb_ary_freeze(VALUE obj)
Freeze an array, preventing further modifications.
VALUE rb_ary_entry(VALUE ary, long off)
Queries an element of an array.
static void rb_check_frozen_inline(VALUE obj)
Just another name of rb_check_frozen.
static int rb_check_arity(int argc, int min, int max)
Ensures that the passed integer is in the passed range.
VALUE rb_require_string(VALUE feature)
Finds and loads the given feature, if absent.
void ruby_default_signal(int sig)
Pretends as if there was no custom signal handler.
VALUE rb_str_append(VALUE dst, VALUE src)
Identical to rb_str_buf_append(), except it converts the right hand side before concatenating.
VALUE rb_str_tmp_new(long len)
Allocates a "temporary" string.
#define rb_str_new(str, len)
Allocates an instance of rb_cString.
#define rb_str_buf_cat
Just another name of rb_str_cat.
#define rb_exc_new_cstr(exc, str)
Identical to rb_exc_new(), except it assumes the passed pointer is a pointer to a C string.
VALUE rb_str_dup(VALUE str)
Duplicates a string.
#define rb_str_buf_new_cstr(str)
Identical to rb_str_new_cstr, except done differently.
VALUE rb_str_buf_append(VALUE dst, VALUE src)
Identical to rb_str_cat_cstr(), except it takes Ruby's string instead of C's.
VALUE rb_str_equal(VALUE str1, VALUE str2)
Equality of two strings.
void rb_str_set_len(VALUE str, long len)
Overwrites the length of the string.
void rb_must_asciicompat(VALUE obj)
Asserts that the given string's encoding is (Ruby's definition of) ASCII compatible.
VALUE rb_check_string_type(VALUE obj)
Try converting an object to its stringised representation using its to_str method,...
#define rb_str_cat_cstr(buf, str)
Identical to rb_str_cat(), except it assumes the passed pointer is a pointer to a C string.
#define rb_str_new_cstr(str)
Identical to rb_str_new, except it assumes the passed pointer is a pointer to a C string.
VALUE rb_obj_as_string(VALUE obj)
Try converting an object to its stringised representation using its to_s method, if any.
VALUE rb_exec_recursive(VALUE(*f)(VALUE g, VALUE h, int r), VALUE g, VALUE h)
"Recursion" API entry point.
VALUE rb_const_get(VALUE space, ID name)
Identical to rb_const_defined(), except it returns the actual defined value.
VALUE rb_autoload_p(VALUE space, ID name)
Queries if an autoload is defined at a point.
VALUE rb_ivar_set(VALUE obj, ID name, VALUE val)
Identical to rb_iv_set(), except it accepts the name as an ID instead of a C string.
VALUE rb_class_name(VALUE obj)
Queries the name of the given object's class.
int rb_respond_to(VALUE obj, ID mid)
Queries if the object responds to the method.
int rb_method_basic_definition_p(VALUE klass, ID mid)
Well... Let us hesitate from describing what a "basic definition" is.
void rb_attr(VALUE klass, ID name, int need_reader, int need_writer, int honour_visibility)
This function resembles now-deprecated Module#attr.
VALUE rb_check_funcall(VALUE recv, ID mid, int argc, const VALUE *argv)
Identical to rb_funcallv(), except it returns RUBY_Qundef instead of raising rb_eNoMethodError.
VALUE rb_check_funcall_kw(VALUE recv, ID mid, int argc, const VALUE *argv, int kw_splat)
Identical to rb_check_funcall(), except you can specify how to handle the last element of the given a...
void rb_define_alloc_func(VALUE klass, rb_alloc_func_t func)
Sets the allocator function of a class.
static ID rb_intern_const(const char *str)
This is a "tiny optimisation" over rb_intern().
ID rb_check_id(volatile VALUE *namep)
Detects if the given name is already interned or not.
int len
Length of the buffer.
#define DECIMAL_SIZE_OF(expr)
An approximation of decimal representation size.
VALUE rb_str_format(int argc, const VALUE *argv, VALUE fmt)
Formats a string.
VALUE rb_vsprintf(const char *fmt, va_list ap)
Identical to rb_sprintf(), except it takes a va_list.
void rb_marshal_define_compat(VALUE newclass, VALUE oldclass, VALUE(*dumper)(VALUE), VALUE(*loader)(VALUE, VALUE))
Marshal format compatibility layer.
#define ALLOCA_N(type, n)
VALUE type(ANYARGS)
ANYARGS-ed function type.
void rb_ivar_foreach(VALUE q, int_type *w, VALUE e)
Iteration over each instance variable of the object.
#define PRI_PIDT_PREFIX
A rb_sprintf() format prefix to be used for a pid_t parameter.
#define RARRAY_LEN
Just another name of rb_array_len.
static int RARRAY_LENINT(VALUE ary)
Identical to rb_array_len(), except it differs for the return type.
#define RARRAY_AREF(a, i)
#define RARRAY_CONST_PTR
Just another name of rb_array_const_ptr.
#define StringValue(v)
Ensures that the parameter object is a String.
static char * RSTRING_END(VALUE str)
Queries the end of the contents pointer of the string.
#define RSTRING(obj)
Convenient casting macro.
char * rb_string_value_ptr(volatile VALUE *ptr)
Identical to rb_str_to_str(), except it returns the converted string's backend memory region.
#define RUBY_TYPED_DEFAULT_FREE
This is a value you can set to rb_data_type_struct::dfree.
#define TypedData_Get_Struct(obj, type, data_type, sval)
Obtains a C struct from inside of a wrapper Ruby object.
#define TypedData_Make_Struct(klass, type, data_type, sval)
Identical to TypedData_Wrap_Struct, except it allocates a new data region internally instead of takin...
VALUE rb_argv0
The value of $0 at process bootup.
const char * rb_obj_classname(VALUE obj)
Queries the name of the class of the passed object.
#define errno
Ractor-aware version of errno.
#define RB_PASS_KEYWORDS
Pass keywords, final argument must be a hash of keywords.
#define RB_PASS_CALLED_KEYWORDS
Pass keywords if current method is called with keywords, useful for argument delegation.
static bool RB_SPECIAL_CONST_P(VALUE obj)
Checks if the given object is of enum ruby_special_consts.
#define RTEST
This is an old name of RB_TEST.
char * ptr
Pointer to the contents of the string.
This is the struct that holds necessary info for a struct.
const char * wrap_struct_name
Name of structs of this kind.
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
uintptr_t VALUE
Type that represents a Ruby object.
static enum ruby_value_type RB_BUILTIN_TYPE(VALUE obj)
Queries the type of the object.
static void Check_Type(VALUE v, enum ruby_value_type t)
Identical to RB_TYPE_P(), except it raises exceptions on predication failure.
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.