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 "ruby_assert.h"
67#define WIFEXITED(status) 1
71#define WEXITSTATUS(status) (status)
76int rb_str_end_with_asciichar(
VALUE str,
int c);
78long rb_backtrace_length_limit = -1;
82static VALUE rb_mWarning;
83static VALUE rb_cWarningBuffer;
87static ID id_deprecated;
88static ID id_experimental;
89static ID id_performance;
90static ID id_strict_unused_block;
91static VALUE sym_category;
92static VALUE sym_highlight;
97extern const char *rb_dynamic_description;
102#define defined_error(name, num) if (err == (num)) return (name);
103#define undefined_error(name)
104#include "known_errors.inc"
106#undef undefined_error
111err_position_0(
char *buf,
long len,
const char *file,
int line)
116 else if (line == 0) {
117 return snprintf(buf,
len,
"%s: ", file);
120 return snprintf(buf,
len,
"%s:%d: ", file, line);
126err_vcatf(
VALUE str, const
char *pre, const
char *file,
int line,
127 const
char *fmt, va_list args)
131 if (line) rb_str_catf(str,
":%d", line);
135 rb_str_vcatf(str, fmt, args);
142rb_syntax_error_append(
VALUE exc,
VALUE file,
int line,
int column,
145 const char *fn =
NIL_P(file) ? NULL : RSTRING_PTR(file);
147 VALUE mesg = rb_enc_str_new(0, 0, enc);
148 err_vcatf(mesg, NULL, fn, line, fmt, args);
150 rb_write_error_str(mesg);
154 exc = syntax_error_with_path(exc, file, &mesg, enc);
155 err_vcatf(mesg, NULL, fn, line, fmt, args);
161static unsigned int warning_disabled_categories = (
163 ~RB_WARN_CATEGORY_DEFAULT_BITS);
166rb_warning_category_mask(
VALUE category)
168 return 1U << rb_warning_category_from_name(category);
172rb_warning_category_from_name(
VALUE category)
178 !st_lookup(warning_categories.id2enum, cat_id, &cat_value)) {
179 rb_raise(
rb_eArgError,
"unknown category: %"PRIsVALUE, category);
188 if (!st_lookup(warning_categories.enum2id, category, &
id)) {
189 rb_raise(
rb_eArgError,
"invalid category: %d", (
int)category);
195rb_warning_category_update(
unsigned int mask,
unsigned int bits)
197 warning_disabled_categories &= ~mask;
198 warning_disabled_categories |= mask & ~bits;
204 return !(warning_disabled_categories & (1U << category));
232 return RBOOL(rb_warning_category_enabled_p(cat));
246 unsigned int mask = rb_warning_category_mask(category);
247 unsigned int disabled = warning_disabled_categories;
252 warning_disabled_categories = disabled;
264rb_warning_s_categories(
VALUE mod)
266 st_index_t num = warning_categories.id2enum->num_entries;
268 num = st_keys(warning_categories.id2enum, ids, num);
270 for (st_index_t i = 0; i < num; ++i) {
288rb_warning_s_warn(
int argc,
VALUE *argv,
VALUE mod)
299 if (!
NIL_P(category)) {
301 if (!rb_warning_category_enabled_p(cat))
return Qnil;
303 rb_write_error_str(str);
344 return rb_funcallv(mod, id_warn, 1, &str);
349rb_warning_warn_arity(
void)
352 return me ? rb_method_entry_arity(me) : 1;
359 rb_warning_category_from_name(category);
362 if (rb_warning_warn_arity() == 1) {
363 return rb_warning_warn(rb_mWarning, str);
368 args[1] = rb_hash_new();
369 rb_hash_aset(args[1], sym_category, category);
375rb_write_warning_str(
VALUE str)
377 rb_warning_warn(rb_mWarning, str);
382warn_vsprintf(
rb_encoding *enc, const
char *file,
int line, const
char *fmt, va_list args)
384 VALUE str = rb_enc_str_new(0, 0, enc);
386 err_vcatf(str,
"warning: ", file, line, fmt, args);
390#define with_warn_vsprintf(enc, file, line, fmt) \
393 va_start(args, fmt); \
394 str = warn_vsprintf(enc, file, line, fmt, args); \
398rb_compile_warn(
const char *file,
int line,
const char *fmt, ...)
401 with_warn_vsprintf(NULL, file, line, fmt) {
402 rb_write_warning_str(str);
408rb_enc_compile_warn(
rb_encoding *enc,
const char *file,
int line,
const char *fmt, ...)
411 with_warn_vsprintf(enc, file, line, fmt) {
412 rb_write_warning_str(str);
419rb_compile_warning(
const char *file,
int line,
const char *fmt, ...)
422 with_warn_vsprintf(NULL, file, line, fmt) {
423 rb_write_warning_str(str);
430rb_enc_compile_warning(
rb_encoding *enc,
const char *file,
int line,
const char *fmt, ...)
433 with_warn_vsprintf(enc, file, line, fmt) {
434 rb_write_warning_str(str);
443 with_warn_vsprintf(NULL, file, line, fmt) {
444 rb_warn_category(str, rb_warning_category_to_name(category));
451warning_string(
rb_encoding *enc, const
char *fmt, va_list args)
454 const char *file = rb_source_location_cstr(&line);
455 return warn_vsprintf(enc, file, line, fmt, args);
458#define with_warning_string(mesg, enc, fmt) \
459 with_warning_string_from(mesg, enc, fmt, fmt)
460#define with_warning_string_from(mesg, enc, fmt, last_arg) \
462 va_list args; va_start(args, last_arg); \
463 mesg = warning_string(enc, fmt, args); \
470 with_warning_string(mesg, 0, fmt) {
471 rb_write_warning_str(mesg);
480 with_warning_string(mesg, 0, fmt) {
481 rb_warn_category(mesg, rb_warning_category_to_name(category));
490 with_warning_string(mesg, enc, fmt) {
491 rb_write_warning_str(mesg);
501 with_warning_string(mesg, 0, fmt) {
502 rb_write_warning_str(mesg);
512 with_warning_string(mesg, 0, fmt) {
513 rb_warn_category(mesg, rb_warning_category_to_name(category));
519rb_warning_string(
const char *fmt, ...)
521 with_warning_string(mesg, 0, fmt) {
528rb_enc_warning(
rb_encoding *enc,
const char *fmt, ...)
531 with_warning_string(mesg, enc, fmt) {
532 rb_write_warning_str(mesg);
539deprecation_warning_enabled(
void)
547warn_deprecated(
VALUE mesg,
const char *removal,
const char *suggest)
552 rb_str_catf(mesg,
" and will be removed in Ruby %s", removal);
554 if (suggest) rb_str_catf(mesg,
"; use %s instead", suggest);
556 rb_warn_category(mesg,
ID2SYM(id_deprecated));
560rb_warn_deprecated(
const char *fmt,
const char *suggest, ...)
562 if (!deprecation_warning_enabled())
return;
564 with_warning_string_from(mesg, 0, fmt, suggest) {
565 warn_deprecated(mesg, NULL, suggest);
570rb_warn_deprecated_to_remove(
const char *removal,
const char *fmt,
const char *suggest, ...)
572 if (!deprecation_warning_enabled())
return;
574 with_warning_string_from(mesg, 0, fmt, suggest) {
575 warn_deprecated(mesg, removal, suggest);
580rb_warn_reserved_name(
const char *coming,
const char *fmt, ...)
582 if (!deprecation_warning_enabled())
return;
584 with_warning_string_from(mesg, 0, fmt, fmt) {
586 rb_str_catf(mesg,
" is reserved for Ruby %s\n", coming);
587 rb_warn_category(mesg,
ID2SYM(id_deprecated));
592end_with_asciichar(
VALUE str,
int c)
595 rb_str_end_with_asciichar(str, c);
600warning_write(
int argc,
VALUE *argv,
VALUE buf)
619 if (!
NIL_P(uplevel)) {
624 location = rb_ec_backtrace_location_ary(ec, lev + 1, 1, TRUE);
625 if (!
NIL_P(location)) {
629 if (argc > 1 || !
NIL_P(uplevel) || !end_with_asciichar(str,
'\n')) {
631 if (
NIL_P(uplevel)) {
634 else if (
NIL_P(location) ||
639 str = rb_sprintf(
"%s:%ld: warning: ",
643 RBASIC_SET_CLASS(str, rb_cWarningBuffer);
644 rb_io_puts(argc, argv, str);
648 if (!
NIL_P(category)) {
649 category = rb_to_symbol_type(category);
650 rb_warning_category_from_name(category);
653 if (exc == rb_mWarning) {
655 rb_write_error_str(str);
658 rb_warn_category(str, category);
664#define MAX_BUG_REPORTERS 0x100
667 void (*func)(
FILE *out,
void *data);
671static int bug_reporters_size;
674rb_bug_reporter_add(
void (*func)(
FILE *,
void *),
void *data)
677 if (bug_reporters_size >= MAX_BUG_REPORTERS) {
681 reporter->func = func;
682 reporter->data = data;
691#if defined __CYGWIN__ || defined DOSISH
692# define PATH_SEP_ENCODING 1
694 if (x ==
':')
return true;
695 if (x ==
'\\')
return true;
705static const char PATHSEP_REPLACE =
'!';
708append_pathname(
char *p,
const char *pe,
VALUE str)
710#ifdef PATH_SEP_ENCODING
713 const char *s = RSTRING_PTR(str);
714 const char *
const se = s + RSTRING_LEN(str);
719 while (p < pe && s < se && (c = *s) !=
'\0') {
721 if (s == se || !*s)
break;
722 if (path_sep_p(s[1]))
goto skipsep;
724 else if (path_sep_p(c)) {
726 *p++ = PATHSEP_REPLACE;
728 while (++s < se && path_sep_p(*s));
731 const char *
const ss = s;
732 while (p < pe && s < se && *s && !path_sep_p(*s)) {
733#ifdef PATH_SEP_ENCODING
734 int n = rb_enc_mbclen(s, se, enc);
741 if (s > ss) memcpy(p - (s - ss), ss, s - ss);
748append_basename(
char *p,
const char *pe,
struct path_string *path,
VALUE str)
751#ifdef PATH_SEP_ENCODING
754 const char *
const b = RSTRING_PTR(str), *
const e =
RSTRING_END(str), *p = e;
757 if (path_sep_p(p[-1])) {
758#ifdef PATH_SEP_ENCODING
759 const char *t = rb_enc_prev_char(b, p, e, enc);
774 size_t n = path->len;
775 if (p + n > pe) n = pe - p;
776 memcpy(p, path->ptr, n);
781finish_report(
FILE *out, rb_pid_t pid)
783 if (out != stdout && out != stderr) fclose(out);
784#ifdef HAVE_WORKING_FORK
785 if (pid > 0) waitpid(pid, NULL, 0);
814expand_report_argument(
const char **input_template,
struct report_expansion *values,
815 char *buf,
size_t size,
bool word)
818 char *end = buf + size;
819 const char *
template = *input_template;
822 if (p >= end-1 || !*
template)
return NULL;
824 char c = *
template++;
826 if (!store)
continue;
829 switch (c = *
template++) {
831 p = append_basename(p, end, &values->exe,
rb_argv0);
834 p = append_pathname(p, end,
rb_argv0);
837 p = append_basename(p, end, &values->script, GET_VM()->orig_progname);
840 p = append_pathname(p, end, GET_VM()->orig_progname);
843 if (!values->pid) values->pid = getpid();
848 if (!values->time) values->time = time(NULL);
849 snprintf(p, end-p,
"%" PRI_TIMET_PREFIX
"d", values->time);
853 if (c >=
'0' && c <=
'7') {
854 c = (
unsigned char)ruby_scan_oct(
template-1, 3, &n);
856 if (!c) store =
false;
861 if (p < end-1) *p++ = c;
863 *input_template =
template;
868FILE *ruby_popen_writer(
char *
const *argv, rb_pid_t *pid);
871open_report_path(
const char *
template,
char *buf,
size_t size, rb_pid_t *pid)
875 if (!
template)
return NULL;
876 if (0) fprintf(stderr,
"RUBY_CRASH_REPORT=%s\n", buf);
877 if (*
template ==
'|') {
878 char *argv[16], *bufend = buf + size, *p;
881 for (argc = 0; argc < numberof(argv) - 1; ++argc) {
882 while (*
template &&
ISSPACE(*
template))
template++;
883 p = expand_report_argument(&
template, &values, buf, bufend-buf,
true);
889 if (!p)
return ruby_popen_writer(argv, pid);
891 else if (*
template) {
892 expand_report_argument(&
template, &values, buf, size,
false);
893 return fopen(buf,
"w");
898static const char *crash_report;
901#define REPORT_BUG_BUFSIZ 256
903bug_report_file(
const char *file,
int line, rb_pid_t *pid)
905 char buf[REPORT_BUG_BUFSIZ];
906 const char *report = crash_report;
907 if (!report) report = getenv(
"RUBY_CRASH_REPORT");
908 FILE *out = open_report_path(report, buf,
sizeof(buf), pid);
909 int len = err_position_0(buf,
sizeof(buf), file, line);
915 setvbuf(out, NULL, _IONBF, 0);
916 if ((ssize_t)fwrite(buf, 1,
len, out) == (ssize_t)
len)
return out;
919 if ((ssize_t)fwrite(buf, 1,
len, stderr) == (ssize_t)
len) {
922 if ((ssize_t)fwrite(buf, 1,
len, stdout) == (ssize_t)
len) {
929FUNC_MINIMIZED(
static void bug_important_message(
FILE *out,
const char *
const msg,
size_t len));
932bug_important_message(
FILE *out,
const char *
const msg,
size_t len)
934 const char *
const endmsg = msg +
len;
938 if (isatty(fileno(out))) {
939 static const char red[] =
"\033[;31;1;7m";
940 static const char green[] =
"\033[;32;7m";
941 static const char reset[] =
"\033[m";
942 const char *e = strchr(p,
'\n');
943 const int w = (int)(e - p);
945 int i = (int)(e - p);
946 fputs(*p ==
' ' ? green : red, out);
947 fwrite(p, 1, e - p, out);
948 for (; i < w; ++i) fputc(
' ', out);
951 }
while ((p = e + 1) < endmsg && (e = strchr(p,
'\n')) != 0 && e > p + 1);
953 fwrite(p, 1, endmsg - p, out);
956#undef CRASH_REPORTER_MAY_BE_CREATED
957#if defined(__APPLE__) && \
958 (!defined(MAC_OS_X_VERSION_10_6) || MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_6 || defined(__POWERPC__))
959# define CRASH_REPORTER_MAY_BE_CREATED
962preface_dump(
FILE *out)
965 static const char msg[] =
""
966 "-- Crash Report log information "
967 "--------------------------------------------\n"
968 " See Crash Report log file in one of the following locations:\n"
969# ifdef CRASH_REPORTER_MAY_BE_CREATED
970 " * ~/Library/Logs/CrashReporter\n"
971 " * /Library/Logs/CrashReporter\n"
973 " * ~/Library/Logs/DiagnosticReports\n"
974 " * /Library/Logs/DiagnosticReports\n"
975 " for more details.\n"
976 "Don't forget to include the above Crash Report log file in bug reports.\n"
978 const size_t msglen =
sizeof(msg) - 1;
980 const char *msg = NULL;
981 const size_t msglen = 0;
983 bug_important_message(out, msg, msglen);
987postscript_dump(
FILE *out)
990 static const char msg[] =
""
993 "\n""Don't forget to include the Crash Report log file under\n"
994# ifdef CRASH_REPORTER_MAY_BE_CREATED
997 "DiagnosticReports directory in bug reports.\n"
1000 const size_t msglen =
sizeof(msg) - 1;
1002 const char *msg = NULL;
1003 const size_t msglen = 0;
1005 bug_important_message(out, msg, msglen);
1010bug_report_begin_valist(
FILE *out, const
char *fmt, va_list args)
1012 char buf[REPORT_BUG_BUFSIZ];
1014 fputs(
"[BUG] ", out);
1015 vsnprintf(buf,
sizeof(buf), fmt, args);
1017 snprintf(buf,
sizeof(buf),
"\n%s\n\n", rb_dynamic_description);
1022#define bug_report_begin(out, fmt) do { \
1024 va_start(args, fmt); \
1025 bug_report_begin_valist(out, fmt, args); \
1030bug_report_end(
FILE *out, rb_pid_t pid)
1035 for (i=0; i<bug_reporters_size; i++) {
1037 (*reporter->func)(out, reporter->data);
1040 postscript_dump(out);
1041 finish_report(out, pid);
1044#define report_bug(file, line, fmt, ctx) do { \
1045 rb_pid_t pid = -1; \
1046 FILE *out = bug_report_file(file, line, &pid); \
1048 bug_report_begin(out, fmt); \
1049 rb_vm_bugreport(ctx, out); \
1050 bug_report_end(out, pid); \
1054#define report_bug_valist(file, line, fmt, ctx, args) do { \
1055 rb_pid_t pid = -1; \
1056 FILE *out = bug_report_file(file, line, &pid); \
1058 bug_report_begin_valist(out, fmt, args); \
1059 rb_vm_bugreport(ctx, out); \
1060 bug_report_end(out, pid); \
1065ruby_set_crash_report(
const char *
template)
1067 crash_report =
template;
1070 char buf[REPORT_BUG_BUFSIZ];
1071 FILE *out = open_report_path(
template, buf,
sizeof(buf), &pid);
1073 time_t t = time(NULL);
1074 fprintf(out,
"ruby_test_bug_report: %s", ctime(&t));
1075 finish_report(out, pid);
1080NORETURN(
static void die(
void));
1084#if defined(_WIN32) && defined(RUBY_MSVCRT_VERSION) && RUBY_MSVCRT_VERSION >= 80
1086 _set_abort_behavior( 0, _CALL_REPORTFAULT);
1092 signal(SIGABRT, SIG_DFL);
1098rb_bug_without_die_internal(const
char *fmt, va_list args)
1100 const char *file = NULL;
1103 if (rb_current_execution_context(
false)) {
1104 file = rb_source_location_cstr(&line);
1107 report_bug_valist(file, line, fmt, NULL, args);
1112rb_bug_without_die(const
char *fmt, ...)
1115 va_start(args, fmt);
1116 rb_bug_without_die_internal(fmt, args);
1121rb_bug(
const char *fmt, ...)
1124 va_start(args, fmt);
1125 rb_bug_without_die_internal(fmt, args);
1131rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler,
int sig,
const void *ctx,
const char *fmt, ...)
1133 const char *file = NULL;
1136 if (rb_current_execution_context(
false)) {
1137 file = rb_source_location_cstr(&line);
1140 report_bug(file, line, fmt, ctx);
1142 if (default_sighandler) default_sighandler(sig);
1153 rb_bug(
"%s: errno == 0 (NOERROR)", mesg);
1155 const char *errno_str = rb_strerrno(errno_arg);
1157 rb_bug(
"%s: %s (%s)", mesg, strerror(errno_arg), errno_str);
1159 rb_bug(
"%s: %s (%d)", mesg, strerror(errno_arg), errno_arg);
1167#define write_or_abort(fd, str, len) (write((fd), (str), (len)) < 0 ? abort() : (void)0)
1168#define WRITE_CONST(fd,str) write_or_abort((fd),(str),sizeof(str) - 1)
1171rb_async_bug_errno(
const char *mesg,
int errno_arg)
1173 WRITE_CONST(2,
"[ASYNC BUG] ");
1174 write_or_abort(2, mesg, strlen(mesg));
1175 WRITE_CONST(2,
"\n");
1177 if (errno_arg == 0) {
1178 WRITE_CONST(2,
"errno == 0 (NOERROR)\n");
1181 const char *errno_str = rb_strerrno(errno_arg);
1184 errno_str =
"undefined errno";
1185 write_or_abort(2, errno_str, strlen(errno_str));
1187 WRITE_CONST(2,
"\n\n");
1188 write_or_abort(2, rb_dynamic_description, strlen(rb_dynamic_description));
1193rb_report_bug_valist(
VALUE file,
int line,
const char *fmt, va_list args)
1195 report_bug_valist(RSTRING_PTR(file), line, fmt, NULL, args);
1199rb_assert_failure(
const char *file,
int line,
const char *name,
const char *expr)
1201 rb_assert_failure_detail(file, line, name, expr, NULL);
1205rb_assert_failure_detail(
const char *file,
int line,
const char *name,
const char *expr,
1206 const char *fmt, ...)
1209 FILE *out = bug_report_file(file, line, &pid);
1211 fputs(
"Assertion Failed: ", out);
1212 if (name) fprintf(out,
"%s:", name);
1217 va_start(args, fmt);
1219 vfprintf(out, fmt, args);
1222 fprintf(out,
"\n%s\n\n", rb_dynamic_description);
1225 rb_vm_bugreport(NULL, out);
1226 bug_report_end(out, pid);
1232static const char builtin_types[][10] = {
1265rb_builtin_type_name(
int t)
1268 if ((
unsigned int)t >= numberof(builtin_types))
return 0;
1269 name = builtin_types[t];
1270 if (*name)
return name;
1275displaying_class_of(
VALUE x)
1278 case Qfalse:
return rb_fstring_cstr(
"false");
1279 case Qnil:
return rb_fstring_cstr(
"nil");
1280 case Qtrue:
return rb_fstring_cstr(
"true");
1286builtin_class_name(
VALUE x)
1312rb_builtin_class_name(
VALUE x)
1314 const char *etype = builtin_class_name(x);
1322COLDFUNC NORETURN(
static void unexpected_type(
VALUE,
int,
int));
1323#define UNDEF_LEAKED "undef leaked to the Ruby space"
1328 rb_raise(
rb_eTypeError,
"wrong argument type %s (expected %s)",
1335 rb_raise(
rb_eTypeError,
"wrong argument type %"PRIsVALUE
" (expected %s)",
1336 displaying_class_of(obj), expected);
1340unexpected_type(
VALUE x,
int xt,
int t)
1342 const char *tname = rb_builtin_type_name(t);
1348 else if (xt >
T_MASK && xt <= 0x3f) {
1349 mesg = rb_sprintf(
"unknown type 0x%x (0x%x given, probably comes"
1350 " from extension library for ruby 1.8)", t, xt);
1353 mesg = rb_sprintf(
"unknown type 0x%x (0x%x given)", t, xt);
1363 if (RB_UNLIKELY(UNDEF_P(x))) {
1364 rb_bug(UNDEF_LEAKED);
1368 if (xt != t || (xt ==
T_DATA && rbimpl_rtypeddata_p(x))) {
1377 unexpected_type(x, xt, t);
1384 if (RB_UNLIKELY(UNDEF_P(x))) {
1385 rb_bug(UNDEF_LEAKED);
1388 unexpected_type(x,
TYPE(x), t);
1391#undef rb_typeddata_inherited_p
1395 return rbimpl_typeddata_inherited_p_inline(child, parent);
1398#undef rb_typeddata_is_kind_of
1402 return rbimpl_typeddata_is_kind_of_inline(obj, data_type);
1405#undef rb_typeddata_is_instance_of
1409 return rb_typeddata_is_instance_of_inline(obj, data_type);
1415 return rbimpl_check_typeddata(obj, data_type);
1449static VALUE rb_eNOERROR;
1451ID ruby_static_id_cause;
1452#define id_cause ruby_static_id_cause
1453static ID id_message, id_detailed_message, id_backtrace;
1454static ID id_key, id_matchee, id_args, id_Errno, id_errno, id_i_path;
1455static ID id_receiver, id_recv, id_iseq, id_local_variables;
1456static ID id_private_call_p, id_top, id_bottom;
1458#define id_bt_locations idBt_locations
1459#define id_mesg idMesg
1460#define id_name idName
1462#undef rb_exc_new_cstr
1480 rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
1515exc_initialize(
int argc,
VALUE *argv,
VALUE exc)
1520 return exc_init(exc, arg);
1549exc_exception(
int argc,
VALUE *argv,
VALUE self)
1554 if (argc == 0)
return self;
1555 if (argc == 1 && self == argv[0])
return self;
1577 VALUE mesg = rb_attr_get(exc, idMesg);
1587rb_get_message(
VALUE exc)
1590 if (UNDEF_P(e))
return Qnil;
1605 if (UNDEF_P(e))
return Qnil;
1617exc_s_to_tty_p(
VALUE self)
1619 return RBOOL(rb_stderr_tty_p());
1623check_highlight_keyword(
VALUE opt,
int auto_tty_detect)
1628 highlight = rb_hash_lookup(opt, sym_highlight);
1630 switch (highlight) {
1632 rb_bool_expected(highlight,
"highlight", TRUE);
1638 if (
NIL_P(highlight)) {
1639 highlight = RBOOL(auto_tty_detect && rb_stderr_tty_p());
1646check_order_keyword(
VALUE opt)
1651 static VALUE kw_order;
1654 order = rb_hash_lookup(opt, kw_order);
1656 if (order !=
Qnil) {
1658 if (
id == id_bottom) order =
Qtrue;
1659 else if (
id == id_top) order =
Qfalse;
1662 "order: %+"PRIsVALUE, order);
1722exc_full_message(
int argc,
VALUE *argv,
VALUE exc)
1724 VALUE opt, str, emesg, errat;
1725 VALUE highlight, order;
1729 highlight = check_highlight_keyword(opt, 1);
1730 order = check_order_keyword(opt);
1733 if (
NIL_P(opt)) opt = rb_hash_new();
1734 rb_hash_aset(opt, sym_highlight, highlight);
1738 errat = rb_get_backtrace(exc);
1739 emesg = rb_get_detailed_message(exc, opt);
1741 rb_error_write(exc, emesg, errat, str, opt, highlight, order);
1755exc_message(
VALUE exc)
1757 return rb_funcallv(exc, idTo_s, 0, 0);
1806exc_detailed_message(
int argc,
VALUE *argv,
VALUE exc)
1812 VALUE highlight = check_highlight_keyword(opt, 0);
1814 extern VALUE rb_decorate_message(
const VALUE eclass,
VALUE emesg,
int highlight);
1816 return rb_decorate_message(
CLASS_OF(exc), rb_get_message(exc),
RTEST(highlight));
1833exc_inspect(
VALUE exc)
1839 if (RSTRING_LEN(exc) == 0) {
1848 rb_str_catf(str,
":%+"PRIsVALUE, exc);
1894exc_backtrace(
VALUE exc)
1898 obj = rb_attr_get(exc, id_bt);
1900 if (rb_backtrace_p(obj)) {
1901 obj = rb_backtrace_to_str_ary(obj);
1911rb_get_backtrace(
VALUE exc)
1913 ID mid = id_backtrace;
1915 if (rb_method_basic_definition_p(
CLASS_OF(exc), id_backtrace)) {
1921 info = exc_backtrace(exc);
1925 info = rb_funcallv(exc, mid, 0, 0);
1928 return rb_check_backtrace(info);
1970exc_backtrace_locations(
VALUE exc)
1974 obj = rb_attr_get(exc, id_bt_locations);
1976 obj = rb_backtrace_to_location_ary(obj);
1982rb_check_backtrace(
VALUE bt)
1985 static const char err[] =
"backtrace must be an Array of String or an Array of Thread::Backtrace::Location";
1989 if (rb_backtrace_p(bt))
return bt;
2108 VALUE btobj = rb_location_ary_to_backtrace(bt);
2115 return rb_ivar_set(exc, id_bt, rb_check_backtrace(bt));
2122 return exc_set_backtrace(exc, bt);
2160 return rb_attr_get(exc, id_cause);
2164try_convert_to_exception(
VALUE obj)
2181 VALUE mesg, backtrace;
2183 if (exc == obj)
return Qtrue;
2188 obj = rb_protect(try_convert_to_exception, obj, &state);
2189 if (state || UNDEF_P(obj)) {
2190 rb_set_errinfo(
Qnil);
2195 if (UNDEF_P(mesg))
return Qfalse;
2197 if (UNDEF_P(backtrace))
return Qfalse;
2200 mesg = rb_attr_get(obj, id_mesg);
2201 backtrace = exc_backtrace(obj);
2204 if (!
rb_equal(rb_attr_get(exc, id_mesg), mesg))
2206 return rb_equal(exc_backtrace(exc), backtrace);
2222exit_initialize(
int argc,
VALUE *argv,
VALUE exc)
2230 status =
INT2FIX(EXIT_SUCCESS);
2235 status =
INT2FIX(EXIT_FAILURE);
2241 if (
NIL_P(status)) {
2242 status =
INT2FIX(EXIT_SUCCESS);
2245#if EXIT_SUCCESS != 0
2247 status =
INT2FIX(EXIT_SUCCESS);
2256 status =
INT2FIX(EXIT_SUCCESS);
2272exit_status(
VALUE exc)
2274 return rb_attr_get(exc, id_status);
2286exit_success_p(
VALUE exc)
2288 VALUE status_val = rb_attr_get(exc, id_status);
2291 if (
NIL_P(status_val))
2294 return RBOOL(WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SUCCESS);
2300 if (!UNDEF_P(recv))
rb_ivar_set(exc, id_recv, recv);
2317frozen_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2320 VALUE values[numberof(keywords)], options;
2323 keywords[0] = id_receiver;
2324 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2326 err_init_recv(self, values[0]);
2338#define frozen_err_receiver name_err_receiver
2346 va_start(args, fmt);
2361 va_start(args, fmt);
2375 cfp = rb_vm_get_ruby_level_next_cfp(ec, cfp);
2377 err_init_recv(exc, recv);
2378 if (cfp && VM_FRAME_TYPE(cfp) != VM_FRAME_MAGIC_DUMMY) {
2379 rb_ivar_set(exc, id_iseq, rb_iseqw_new(CFP_ISEQ(cfp)));
2398name_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2401 VALUE values[numberof(keywords)], name, options;
2404 keywords[0] = id_receiver;
2405 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2406 name = (argc > 1) ? argv[--argc] :
Qnil;
2408 name_err_init_attr(self, values[0], name);
2417 exc_init(exc, rb_name_err_mesg_new(mesg, recv, method));
2418 return name_err_init_attr(exc, recv, method);
2425 return name_err_init(exc, mesg, recv, method);
2436name_err_name(
VALUE self)
2438 return rb_attr_get(self, id_name);
2452name_err_local_variables(
VALUE self)
2454 VALUE vars = rb_attr_get(self, id_local_variables);
2457 VALUE iseqw = rb_attr_get(self, id_iseq);
2458 if (!
NIL_P(iseqw)) vars = rb_iseqw_local_variables(iseqw);
2466nometh_err_init_attr(
VALUE exc,
VALUE args,
int priv)
2490nometh_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2493 VALUE args, options;
2495 priv = (argc > 3) && (--argc,
RTEST(argv[argc]));
2496 args = (argc > 2) ? argv[--argc] :
Qnil;
2497 if (!
NIL_P(options)) argv[argc++] = options;
2499 return nometh_err_init_attr(self, args, priv);
2506 name_err_init(exc, mesg, recv, method);
2507 return nometh_err_init_attr(exc, args, priv);
2517name_err_mesg_mark_and_move(
void *p)
2520 rb_gc_mark_and_move(&ptr->mesg);
2521 rb_gc_mark_and_move(&ptr->recv);
2522 rb_gc_mark_and_move(&ptr->name);
2528 name_err_mesg_mark_and_move,
2531 name_err_mesg_mark_and_move,
2557name_err_mesg_alloc(
VALUE klass)
2564name_err_mesg_init_copy(
VALUE obj1,
VALUE obj2)
2566 if (obj1 == obj2)
return obj1;
2583 if (obj1 == obj2)
return Qtrue;
2600name_err_mesg_receiver_name(
VALUE obj)
2611name_err_mesg_to_str(
VALUE obj)
2616 VALUE mesg = ptr->mesg;
2619 struct RString s_str = {RBASIC_INIT}, c_str = {RBASIC_INIT}, d_str = {RBASIC_INIT};
2620 VALUE c, s, d = 0, args[4], c2;
2624#define FAKE_CSTR(v, str) rb_setup_fake_str((v), (str), rb_strlen_lit(str), usascii)
2625 c = s = FAKE_CSTR(&s_str,
"");
2629 c = d = FAKE_CSTR(&d_str,
"nil");
2632 c = d = FAKE_CSTR(&d_str,
"true");
2635 c = d = FAKE_CSTR(&d_str,
"false");
2638 if (strstr(RSTRING_PTR(mesg),
"%2$s")) {
2639 d = rb_protect(name_err_mesg_receiver_name, obj, &state);
2640 if (state || NIL_OR_UNDEF_P(d))
2643 rb_set_errinfo(
Qnil);
2654 s = FAKE_CSTR(&s_str,
"module ");
2658 s = FAKE_CSTR(&s_str,
"class ");
2670 s = FAKE_CSTR(&s_str,
"");
2671 if (obj == rb_vm_top_self()) {
2672 c = FAKE_CSTR(&c_str,
"main");
2680 s = FAKE_CSTR(&s_str,
"an instance of ");
2684 c2 = rb_protect(name_err_mesg_receiver_name, c, &state);
2685 if (state || NIL_OR_UNDEF_P(c2))
2688 rb_set_errinfo(
Qnil);
2710 return name_err_mesg_to_str(obj);
2728name_err_receiver(
VALUE self)
2730 VALUE recv = rb_ivar_lookup(self, id_recv,
Qundef);
2731 if (!UNDEF_P(recv))
return recv;
2733 VALUE mesg = rb_attr_get(self, id_mesg);
2734 if (!rb_typeddata_is_kind_of(mesg, &name_err_mesg_data_type)) {
2752nometh_err_args(
VALUE self)
2754 return rb_attr_get(self, id_args);
2765nometh_err_private_call_p(
VALUE self)
2767 return rb_attr_get(self, id_private_call_p);
2771type_err_cname(
VALUE val)
2776 else if (val ==
Qtrue) {
2779 else if (val ==
Qfalse) {
2785NORETURN(
static void type_err_raise(
VALUE val,
const char *tname,
const char *msg));
2787type_err_raise(
VALUE val,
const char *tname,
const char *msg)
2789 const char *cname = type_err_cname(val);
2797NORETURN(
void rb_no_implicit_conversion(
VALUE val,
const char *tname));
2799rb_no_implicit_conversion(
VALUE val,
const char *tname)
2801 type_err_raise(val, tname,
"no implicit conversion of");
2804NORETURN(
void rb_cant_convert(
VALUE val,
const char *tname));
2806rb_cant_convert(
VALUE val,
const char *tname)
2808 type_err_raise(val, tname,
"can't convert");
2811NORETURN(
void rb_cant_convert_invalid_return(
VALUE val,
const char *tname,
const char *method_name,
VALUE ret));
2813rb_cant_convert_invalid_return(
VALUE val,
const char *tname,
const char *method_name,
VALUE ret)
2815 const char *cname = type_err_cname(val);
2819 enc,
rb_eTypeError,
"can't convert %s into %s (%s#%s gives %s)",
2820 cname, tname, cname, method_name, type_err_cname(ret));
2823 const char *retname = type_err_cname(ret);
2828 enc,
rb_eTypeError,
"can't convert %"PRIsVALUE
" into %s (%"PRIsVALUE
"#%s gives %s)",
2829 klass, tname, klass, method_name, retname);
2848key_err_receiver(
VALUE self)
2852 recv = rb_ivar_lookup(self, id_receiver,
Qundef);
2853 if (!UNDEF_P(recv))
return recv;
2865key_err_key(
VALUE self)
2869 key = rb_ivar_lookup(self, id_key,
Qundef);
2870 if (!UNDEF_P(key))
return key;
2894key_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2900 if (!
NIL_P(options)) {
2902 VALUE values[numberof(keywords)];
2904 keywords[0] = id_receiver;
2905 keywords[1] = id_key;
2906 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2907 for (i = 0; i < numberof(values); ++i) {
2908 if (!UNDEF_P(values[i])) {
2925no_matching_pattern_key_err_matchee(
VALUE self)
2929 matchee = rb_ivar_lookup(self, id_matchee,
Qundef);
2930 if (!UNDEF_P(matchee))
return matchee;
2942no_matching_pattern_key_err_key(
VALUE self)
2946 key = rb_ivar_lookup(self, id_key,
Qundef);
2947 if (!UNDEF_P(key))
return key;
2960no_matching_pattern_key_err_initialize(
int argc,
VALUE *argv,
VALUE self)
2966 if (!
NIL_P(options)) {
2968 VALUE values[numberof(keywords)];
2970 keywords[0] = id_matchee;
2971 keywords[1] = id_key;
2972 rb_get_kwargs(options, keywords, 0, numberof(values), values);
2973 for (i = 0; i < numberof(values); ++i) {
2974 if (!UNDEF_P(values[i])) {
2992syntax_error_initialize(
int argc,
VALUE *argv,
VALUE self)
2996 mesg = rb_fstring_lit(
"compile error");
3007 *mesg = rb_enc_str_new(0, 0, enc);
3012 VALUE old_path = rb_attr_get(exc, id_i_path);
3013 if (old_path != path) {
3015 rb_raise(
rb_eArgError,
"SyntaxError#path changed: %+"PRIsVALUE
" (%p->%p)",
3016 old_path, (
void *)old_path, (
void *)path);
3019 rb_raise(
rb_eArgError,
"SyntaxError#path changed: %+"PRIsVALUE
"(%s%s)->%+"PRIsVALUE
"(%s)",
3020 old_path, rb_enc_name(rb_enc_get(old_path)),
3021 (
FL_TEST(old_path, RSTRING_FSTR) ?
":FSTR" :
""),
3022 path, rb_enc_name(rb_enc_get(path)));
3025 VALUE s = *mesg = rb_attr_get(exc, idMesg);
3026 if (RSTRING_LEN(s) > 0 && *(
RSTRING_END(s)-1) !=
'\n')
3087rb_free_warning(
void)
3089 st_free_table(warning_categories.id2enum);
3090 st_free_table(warning_categories.enum2id);
3091 st_free_table(syserr_tbl);
3095setup_syserr(
int n,
const char *name)
3104#if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN
3109 rb_eEWOULDBLOCK = error;
3112 rb_eEINPROGRESS = error;
3116 rb_define_const(error,
"Errno",
INT2NUM(n));
3117 st_add_direct(syserr_tbl, n, (st_data_t)error);
3122set_syserr(
int n,
const char *name)
3126 if (!st_lookup(syserr_tbl, n, &error)) {
3127 return setup_syserr(n, name);
3131 rb_define_const(
rb_mErrno, name, errclass);
3141 if (!st_lookup(syserr_tbl, n, &error)) {
3144 snprintf(name,
sizeof(name),
"E%03d", n);
3145 return setup_syserr(n, name);
3147 return (
VALUE)error;
3182syserr_initialize(
int argc,
VALUE *argv,
VALUE self)
3185 VALUE mesg, error, func, errmsg;
3189 st_data_t data = (st_data_t)klass;
3192 error = mesg; mesg =
Qnil;
3194 if (!
NIL_P(error) && st_lookup(syserr_tbl,
NUM2LONG(error), &data)) {
3195 klass = (
VALUE)data;
3200 RBASIC_SET_CLASS(self, klass);
3208 else err =
"unknown error";
3214 if (!
NIL_P(func)) rb_str_catf(errmsg,
" @ %"PRIsVALUE, func);
3215 rb_str_catf(errmsg,
" - %"PRIsVALUE, str);
3232syserr_errno(
VALUE self)
3234 return rb_attr_get(self, id_errno);
3255 num = rb_attr_get(exc, id_errno);
3257 num = rb_funcallv(exc, id_errno, 0, 0);
3639exception_alloc(
VALUE klass)
3641 return rb_class_allocate_instance(klass);
3645exception_dumper(
VALUE exc)
3655ivar_copy_i(
ID key,
VALUE val, st_data_t exc)
3661void rb_exc_check_circular_cause(
VALUE exc);
3677 rb_exc_check_circular_cause(exc);
3679 if (rb_attr_get(exc, id_bt) == rb_attr_get(exc, id_bt_locations)) {
3774 syserr_tbl = st_init_numtable();
3814 id_iseq = rb_make_internal_id();
3815 id_recv = rb_make_internal_id();
3817 sym_category =
ID2SYM(id_category);
3820 warning_categories.id2enum = rb_init_identtable();
3826 warning_categories.enum2id = rb_init_identtable();
3840 va_start(args, fmt);
3848rb_vraise(
VALUE exc,
const char *fmt, va_list ap)
3854rb_raise(
VALUE exc_class,
const char *fmt, ...)
3857 va_start(args, fmt);
3863NORETURN(
static void raise_loaderror(
VALUE path,
VALUE mesg));
3879 va_start(args, fmt);
3882 raise_loaderror(
Qnil, mesg);
3891 va_start(args, fmt);
3894 raise_loaderror(path, mesg);
3901 "%"PRIsVALUE
"() function is unimplemented on this machine",
3902 rb_id2str(rb_frame_this_func()));
3906rb_fatal(
const char *fmt, ...)
3911 if (! ruby_thread_has_gvl_p()) {
3914 fprintf(stderr,
"[FATAL] rb_fatal() outside of GVL\n");
3915 rb_print_backtrace(stderr);
3919 va_start(args, fmt);
3927make_errno_exc(
const char *mesg)
3933 rb_bug(
"rb_sys_fail(%s) - errno == 0", mesg ? mesg :
"");
3939make_errno_exc_str(
VALUE mesg)
3944 if (!mesg) mesg =
Qnil;
3946 const char *s = !
NIL_P(mesg) ? RSTRING_PTR(mesg) :
"";
3947 rb_bug(
"rb_sys_fail_str(%s) - errno == 0", s);
3980rb_sys_fail(
const char *mesg)
3985#undef rb_sys_fail_str
3992#ifdef RUBY_FUNCTION_NAME_STRING
3994rb_sys_fail_path_in(
const char *func_name,
VALUE path)
3999 rb_syserr_fail_path_in(func_name, n, path);
4003rb_syserr_fail_path_in(
const char *func_name,
int n,
VALUE path)
4005 rb_exc_raise(rb_syserr_new_path_in(func_name, n, path));
4009rb_syserr_new_path_in(
const char *func_name,
int n,
VALUE path)
4013 if (!path) path =
Qnil;
4015 const char *s = !
NIL_P(path) ? RSTRING_PTR(path) :
"";
4016 if (!func_name) func_name =
"(null)";
4017 rb_bug(
"rb_sys_fail_path_in(%s, %s) - errno == 0",
4026NORETURN(
static void rb_mod_exc_raise(
VALUE exc,
VALUE mod));
4038 VALUE exc = make_errno_exc(mesg);
4039 rb_mod_exc_raise(exc, mod);
4045 VALUE exc = make_errno_exc_str(mesg);
4046 rb_mod_exc_raise(exc, mod);
4053 rb_mod_exc_raise(exc, mod);
4060 rb_mod_exc_raise(exc, mod);
4064syserr_warning(
VALUE mesg,
int err)
4067 rb_str_catf(mesg,
": %s\n", strerror(err));
4068 rb_write_warning_str(mesg);
4073rb_sys_warn(
const char *fmt, ...)
4076 int errno_save =
errno;
4077 with_warning_string(mesg, 0, fmt) {
4078 syserr_warning(mesg, errno_save);
4085rb_syserr_warn(
int err,
const char *fmt, ...)
4088 with_warning_string(mesg, 0, fmt) {
4089 syserr_warning(mesg, err);
4095rb_sys_enc_warn(
rb_encoding *enc,
const char *fmt, ...)
4098 int errno_save =
errno;
4099 with_warning_string(mesg, enc, fmt) {
4100 syserr_warning(mesg, errno_save);
4107rb_syserr_enc_warn(
int err,
rb_encoding *enc,
const char *fmt, ...)
4110 with_warning_string(mesg, enc, fmt) {
4111 syserr_warning(mesg, err);
4121 int errno_save =
errno;
4122 with_warning_string(mesg, 0, fmt) {
4123 syserr_warning(mesg, errno_save);
4131rb_syserr_warning(
int err,
const char *fmt, ...)
4134 with_warning_string(mesg, 0, fmt) {
4135 syserr_warning(mesg, err);
4142rb_sys_enc_warning(
rb_encoding *enc,
const char *fmt, ...)
4145 int errno_save =
errno;
4146 with_warning_string(mesg, enc, fmt) {
4147 syserr_warning(mesg, errno_save);
4154rb_syserr_enc_warning(
int err,
rb_encoding *enc,
const char *fmt, ...)
4157 with_warning_string(mesg, enc, fmt) {
4158 syserr_warning(mesg, err);
4164rb_load_fail(
VALUE path,
const char *err)
4169 raise_loaderror(path, mesg);
4184 va_start(args, fmt);
4193inspect_frozen_obj(
VALUE obj,
VALUE mesg,
int recur)
4205get_created_info(
VALUE obj,
int *pline)
4207 VALUE info = rb_attr_get(obj, id_debug_created_info);
4221 rb_yjit_lazy_push_frame(GET_EC()->cfp->pc);
4223 VALUE mesg = rb_sprintf(
"can't modify frozen %"PRIsVALUE
": ",
4231 VALUE created_path = get_created_info(frozen_obj, &created_line);
4232 if (!
NIL_P(created_path)) {
4233 rb_str_catf(mesg,
", created at %"PRIsVALUE
":%d", created_path, created_line);
4239rb_warn_unchilled_literal(
VALUE obj)
4244 VALUE file = rb_source_location(&line);
4248 if (line) rb_str_catf(mesg,
":%d", line);
4251 rb_str_cat2(mesg,
"warning: literal string will be frozen in the future");
4254 if (STR_SHARED_P(str)) {
4255 str =
RSTRING(obj)->as.heap.aux.shared;
4257 VALUE created = get_created_info(str, &line);
4258 if (
NIL_P(created)) {
4259 rb_str_cat2(mesg,
" (run with --debug-frozen-string-literal for more information)\n");
4264 if (line) rb_str_catf(mesg,
":%d", line);
4265 rb_str_cat2(mesg,
": info: the string was created here\n");
4267 rb_warn_category(mesg, rb_warning_category_to_name(category));
4272rb_warn_unchilled_symbol_to_s(
VALUE obj)
4276 "string returned by :%s.to_s will be frozen in the future", RSTRING_PTR(obj)
4280#undef rb_check_frozen
4291 rb_check_frozen(obj);
4298 rb_eNOERROR = setup_syserr(0,
"NOERROR");
4301 rb_define_const(
rb_mErrno,
"NOERROR", rb_eNOERROR);
4303#define defined_error(name, num) set_syserr((num), (name));
4304#define undefined_error(name) rb_define_const(rb_mErrno, (name), rb_eNOERROR);
4305#include "known_errors.inc"
4307#undef undefined_error
4310#include "warning.rbinc"
#define RUBY_DEBUG
Define this macro when you want assertions.
#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.
VALUE rb_define_class(const char *name, VALUE super)
Defines a top-level class.
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.
VALUE rb_define_class_under(VALUE outer, const char *name, VALUE super)
Defines a class under the namespace of outer.
VALUE rb_define_module(const char *name)
Defines a top-level module.
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_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.
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_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.
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 RUBY_TYPED_FREE_IMMEDIATELY
Macros to see if each corresponding flag is defined.
#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.