diff options
Diffstat (limited to 'error.c')
| -rw-r--r-- | error.c | 1353 |
1 files changed, 998 insertions, 355 deletions
@@ -23,25 +23,33 @@ # include <unistd.h> #endif +#ifdef HAVE_SYS_WAIT_H +# include <sys/wait.h> +#endif + #if defined __APPLE__ # include <AvailabilityMacros.h> #endif #include "internal.h" +#include "internal/class.h" #include "internal/error.h" #include "internal/eval.h" #include "internal/hash.h" #include "internal/io.h" #include "internal/load.h" #include "internal/object.h" +#include "internal/process.h" #include "internal/string.h" #include "internal/symbol.h" #include "internal/thread.h" #include "internal/variable.h" #include "ruby/encoding.h" #include "ruby/st.h" +#include "ruby/util.h" #include "ruby_assert.h" #include "vm_core.h" +#include "yjit.h" #include "builtin.h" @@ -78,6 +86,7 @@ static ID id_category; static ID id_deprecated; static ID id_experimental; static ID id_performance; +static ID id_strict_unused_block; static VALUE sym_category; static VALUE sym_highlight; static struct { @@ -205,12 +214,10 @@ rb_warning_category_enabled_p(rb_warning_category_t category) * deprecation warnings * * assignment of non-nil value to <code>$,</code> and <code>$;</code> * * keyword arguments - * * proc/lambda without block * etc. * * +:experimental+ :: * experimental features - * * Pattern matching * * +:performance+ :: * performance hints @@ -247,6 +254,26 @@ rb_warning_s_aset(VALUE mod, VALUE category, VALUE flag) /* * call-seq: + * categories -> array + * + * Returns a list of the supported category symbols. + */ + +static VALUE +rb_warning_s_categories(VALUE mod) +{ + st_index_t num = warning_categories.id2enum->num_entries; + ID *ids = ALLOCA_N(ID, num); + num = st_keys(warning_categories.id2enum, ids, num); + VALUE ary = rb_ary_new_capa(num); + for (st_index_t i = 0; i < num; ++i) { + rb_ary_push(ary, ID2SYM(ids[i])); + } + return rb_ary_freeze(ary); +} + +/* + * call-seq: * warn(msg, category: nil) -> nil * * Writes warning message +msg+ to $stderr. This method is called by @@ -286,11 +313,11 @@ rb_warning_s_warn(int argc, VALUE *argv, VALUE mod) * * Changing the behavior of Warning.warn is useful to customize how warnings are * handled by Ruby, for instance by filtering some warnings, and/or outputting - * warnings somewhere other than $stderr. + * warnings somewhere other than <tt>$stderr</tt>. * * If you want to change the behavior of Warning.warn you should use - * +Warning.extend(MyNewModuleWithWarnMethod)+ and you can use `super` - * to get the default behavior of printing the warning to $stderr. + * <tt>Warning.extend(MyNewModuleWithWarnMethod)</tt> and you can use +super+ + * to get the default behavior of printing the warning to <tt>$stderr</tt>. * * Example: * module MyWarningFilter @@ -307,7 +334,7 @@ rb_warning_s_warn(int argc, VALUE *argv, VALUE mod) * You should never redefine Warning#warn (the instance method), as that will * then no longer provide a way to use the default behavior. * - * The +warning+ gem provides convenient ways to customize Warning.warn. + * The warning[https://rubygems.org/gems/warning] gem provides convenient ways to customize Warning.warn. */ static VALUE @@ -359,18 +386,28 @@ warn_vsprintf(rb_encoding *enc, const char *file, int line, const char *fmt, va_ return rb_str_cat2(str, "\n"); } -#define with_warn_vsprintf(file, line, fmt) \ +#define with_warn_vsprintf(enc, file, line, fmt) \ VALUE str; \ va_list args; \ va_start(args, fmt); \ - str = warn_vsprintf(NULL, file, line, fmt, args); \ + str = warn_vsprintf(enc, file, line, fmt, args); \ va_end(args); void rb_compile_warn(const char *file, int line, const char *fmt, ...) { if (!NIL_P(ruby_verbose)) { - with_warn_vsprintf(file, line, fmt) { + with_warn_vsprintf(NULL, file, line, fmt) { + rb_write_warning_str(str); + } + } +} + +void +rb_enc_compile_warn(rb_encoding *enc, const char *file, int line, const char *fmt, ...) +{ + if (!NIL_P(ruby_verbose)) { + with_warn_vsprintf(enc, file, line, fmt) { rb_write_warning_str(str); } } @@ -381,7 +418,18 @@ void rb_compile_warning(const char *file, int line, const char *fmt, ...) { if (RTEST(ruby_verbose)) { - with_warn_vsprintf(file, line, fmt) { + with_warn_vsprintf(NULL, file, line, fmt) { + rb_write_warning_str(str); + } + } +} + +/* rb_enc_compile_warning() reports only in verbose mode */ +void +rb_enc_compile_warning(rb_encoding *enc, const char *file, int line, const char *fmt, ...) +{ + if (RTEST(ruby_verbose)) { + with_warn_vsprintf(enc, file, line, fmt) { rb_write_warning_str(str); } } @@ -391,7 +439,7 @@ void rb_category_compile_warn(rb_warning_category_t category, const char *file, int line, const char *fmt, ...) { if (!NIL_P(ruby_verbose)) { - with_warn_vsprintf(file, line, fmt) { + with_warn_vsprintf(NULL, file, line, fmt) { rb_warn_category(str, rb_warning_category_to_name(category)); } } @@ -427,7 +475,7 @@ rb_warn(const char *fmt, ...) void rb_category_warn(rb_warning_category_t category, const char *fmt, ...) { - if (!NIL_P(ruby_verbose)) { + if (!NIL_P(ruby_verbose) && rb_warning_category_enabled_p(category)) { with_warning_string(mesg, 0, fmt) { rb_warn_category(mesg, rb_warning_category_to_name(category)); } @@ -459,7 +507,7 @@ rb_warning(const char *fmt, ...) void rb_category_warning(rb_warning_category_t category, const char *fmt, ...) { - if (RTEST(ruby_verbose)) { + if (RTEST(ruby_verbose) && rb_warning_category_enabled_p(category)) { with_warning_string(mesg, 0, fmt) { rb_warn_category(mesg, rb_warning_category_to_name(category)); } @@ -527,6 +575,18 @@ rb_warn_deprecated_to_remove(const char *removal, const char *fmt, const char *s } } +void +rb_warn_reserved_name(const char *coming, const char *fmt, ...) +{ + if (!deprecation_warning_enabled()) return; + + with_warning_string_from(mesg, 0, fmt, fmt) { + rb_str_set_len(mesg, RSTRING_LEN(mesg) - 1); + rb_str_catf(mesg, " is reserved for Ruby %s\n", coming); + rb_warn_category(mesg, ID2SYM(id_deprecated)); + } +} + static inline int end_with_asciichar(VALUE str, int c) { @@ -623,18 +683,239 @@ rb_bug_reporter_add(void (*func)(FILE *, void *), void *data) return 1; } +/* returns true if x can not be used as file name */ +static bool +path_sep_p(char x) +{ +#if defined __CYGWIN__ || defined DOSISH +# define PATH_SEP_ENCODING 1 + // Assume that "/" is only the first byte in any encoding. + if (x == ':') return true; // drive letter or ADS + if (x == '\\') return true; +#endif + return x == '/'; +} + +struct path_string { + const char *ptr; + size_t len; +}; + +static const char PATHSEP_REPLACE = '!'; + +static char * +append_pathname(char *p, const char *pe, VALUE str) +{ +#ifdef PATH_SEP_ENCODING + rb_encoding *enc = rb_enc_get(str); +#endif + const char *s = RSTRING_PTR(str); + const char *const se = s + RSTRING_LEN(str); + char c; + + --pe; // for terminator + + while (p < pe && s < se && (c = *s) != '\0') { + if (c == '.') { + if (s == se || !*s) break; // chomp "." basename + if (path_sep_p(s[1])) goto skipsep; // skip "./" + } + else if (path_sep_p(c)) { + // squeeze successive separators + *p++ = PATHSEP_REPLACE; + skipsep: + while (++s < se && path_sep_p(*s)); + continue; + } + const char *const ss = s; + while (p < pe && s < se && *s && !path_sep_p(*s)) { +#ifdef PATH_SEP_ENCODING + int n = rb_enc_mbclen(s, se, enc); +#else + const int n = 1; +#endif + p += n; + s += n; + } + if (s > ss) memcpy(p - (s - ss), ss, s - ss); + } + + return p; +} + +static char * +append_basename(char *p, const char *pe, struct path_string *path, VALUE str) +{ + if (!path->ptr) { +#ifdef PATH_SEP_ENCODING + rb_encoding *enc = rb_enc_get(str); +#endif + const char *const b = RSTRING_PTR(str), *const e = RSTRING_END(str), *p = e; + + while (p > b) { + if (path_sep_p(p[-1])) { +#ifdef PATH_SEP_ENCODING + const char *t = rb_enc_prev_char(b, p, e, enc); + if (t == p-1) break; + p = t; +#else + break; +#endif + } + else { + --p; + } + } + + path->ptr = p; + path->len = e - p; + } + size_t n = path->len; + if (p + n > pe) n = pe - p; + memcpy(p, path->ptr, n); + return p + n; +} + +static void +finish_report(FILE *out, rb_pid_t pid) +{ + if (out != stdout && out != stderr) fclose(out); +#ifdef HAVE_WORKING_FORK + if (pid > 0) waitpid(pid, NULL, 0); +#endif +} + +struct report_expansion { + struct path_string exe, script; + rb_pid_t pid; + time_t time; +}; + +/* + * Open a bug report file to write. The `RUBY_CRASH_REPORT` + * environment variable can be set to define a template that is used + * to name bug report files. The template can contain % specifiers + * which are substituted by the following values when a bug report + * file is created: + * + * %% A single % character. + * %e The base name of the executable filename. + * %E Pathname of executable, with slashes ('/') replaced by + * exclamation marks ('!'). + * %f Similar to %e with the main script filename. + * %F Similar to %E with the main script filename. + * %p PID of dumped process in decimal. + * %t Time of dump, expressed as seconds since the Epoch, + * 1970-01-01 00:00:00 +0000 (UTC). + * %NNN Octal char code, upto 3 digits. + */ +static char * +expand_report_argument(const char **input_template, struct report_expansion *values, + char *buf, size_t size, bool word) +{ + char *p = buf; + char *end = buf + size; + const char *template = *input_template; + bool store = true; + + if (p >= end-1 || !*template) return NULL; + do { + char c = *template++; + if (word && ISSPACE(c)) break; + if (!store) continue; + if (c == '%') { + size_t n; + switch (c = *template++) { + case 'e': + p = append_basename(p, end, &values->exe, rb_argv0); + continue; + case 'E': + p = append_pathname(p, end, rb_argv0); + continue; + case 'f': + p = append_basename(p, end, &values->script, GET_VM()->orig_progname); + continue; + case 'F': + p = append_pathname(p, end, GET_VM()->orig_progname); + continue; + case 'p': + if (!values->pid) values->pid = getpid(); + snprintf(p, end-p, "%" PRI_PIDT_PREFIX "d", values->pid); + p += strlen(p); + continue; + case 't': + if (!values->time) values->time = time(NULL); + snprintf(p, end-p, "%" PRI_TIMET_PREFIX "d", values->time); + p += strlen(p); + continue; + default: + if (c >= '0' && c <= '7') { + c = (unsigned char)ruby_scan_oct(template-1, 3, &n); + template += n - 1; + if (!c) store = false; + } + break; + } + } + if (p < end-1) *p++ = c; + } while (*template); + *input_template = template; + *p = '\0'; + return ++p; +} + +FILE *ruby_popen_writer(char *const *argv, rb_pid_t *pid); + +static FILE * +open_report_path(const char *template, char *buf, size_t size, rb_pid_t *pid) +{ + struct report_expansion values = {{0}}; + + if (!template) return NULL; + if (0) fprintf(stderr, "RUBY_CRASH_REPORT=%s\n", buf); + if (*template == '|') { + char *argv[16], *bufend = buf + size, *p; + int argc; + template++; + for (argc = 0; argc < numberof(argv) - 1; ++argc) { + while (*template && ISSPACE(*template)) template++; + p = expand_report_argument(&template, &values, buf, bufend-buf, true); + if (!p) break; + argv[argc] = buf; + buf = p; + } + argv[argc] = NULL; + if (!p) return ruby_popen_writer(argv, pid); + } + else if (*template) { + expand_report_argument(&template, &values, buf, size, false); + return fopen(buf, "w"); + } + return NULL; +} + +static const char *crash_report; + /* SIGSEGV handler might have a very small stack. Thus we need to use it carefully. */ #define REPORT_BUG_BUFSIZ 256 static FILE * -bug_report_file(const char *file, int line) +bug_report_file(const char *file, int line, rb_pid_t *pid) { char buf[REPORT_BUG_BUFSIZ]; - FILE *out = stderr; + const char *report = crash_report; + if (!report) report = getenv("RUBY_CRASH_REPORT"); + FILE *out = open_report_path(report, buf, sizeof(buf), pid); int len = err_position_0(buf, sizeof(buf), file, line); - if ((ssize_t)fwrite(buf, 1, len, out) == (ssize_t)len || - (ssize_t)fwrite(buf, 1, len, (out = stdout)) == (ssize_t)len) { - return out; + if (out) { + if ((ssize_t)fwrite(buf, 1, len, out) == (ssize_t)len) return out; + fclose(out); + } + if ((ssize_t)fwrite(buf, 1, len, stderr) == (ssize_t)len) { + return stderr; + } + if ((ssize_t)fwrite(buf, 1, len, stdout) == (ssize_t)len) { + return stdout; } return NULL; @@ -741,7 +1022,7 @@ bug_report_begin_valist(FILE *out, const char *fmt, va_list args) } while (0) static void -bug_report_end(FILE *out) +bug_report_end(FILE *out, rb_pid_t pid) { /* call additional bug reporters */ { @@ -752,31 +1033,51 @@ bug_report_end(FILE *out) } } postscript_dump(out); + finish_report(out, pid); } #define report_bug(file, line, fmt, ctx) do { \ - FILE *out = bug_report_file(file, line); \ + rb_pid_t pid = -1; \ + FILE *out = bug_report_file(file, line, &pid); \ if (out) { \ bug_report_begin(out, fmt); \ - rb_vm_bugreport(ctx); \ - bug_report_end(out); \ + rb_vm_bugreport(ctx, out); \ + bug_report_end(out, pid); \ } \ } while (0) \ #define report_bug_valist(file, line, fmt, ctx, args) do { \ - FILE *out = bug_report_file(file, line); \ + rb_pid_t pid = -1; \ + FILE *out = bug_report_file(file, line, &pid); \ if (out) { \ bug_report_begin_valist(out, fmt, args); \ - rb_vm_bugreport(ctx); \ - bug_report_end(out); \ + rb_vm_bugreport(ctx, out); \ + bug_report_end(out, pid); \ } \ } while (0) \ +void +ruby_set_crash_report(const char *template) +{ + crash_report = template; +#if RUBY_DEBUG + rb_pid_t pid = -1; + char buf[REPORT_BUG_BUFSIZ]; + FILE *out = open_report_path(template, buf, sizeof(buf), &pid); + if (out) { + time_t t = time(NULL); + fprintf(out, "ruby_test_bug_report: %s", ctime(&t)); + finish_report(out, pid); + } +#endif +} + NORETURN(static void die(void)); static void die(void) { #if defined(_WIN32) && defined(RUBY_MSVCRT_VERSION) && RUBY_MSVCRT_VERSION >= 80 + /* mingw32 declares in stdlib.h but does not provide. */ _set_abort_behavior( 0, _CALL_REPORTFAULT); #endif @@ -784,25 +1085,35 @@ die(void) } RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 0) -void -rb_bug_without_die(const char *fmt, va_list args) +static void +rb_bug_without_die_internal(const char *fmt, va_list args) { const char *file = NULL; int line = 0; - if (GET_EC()) { + if (rb_current_execution_context(false)) { file = rb_source_location_cstr(&line); } report_bug_valist(file, line, fmt, NULL, args); } +RBIMPL_ATTR_FORMAT(RBIMPL_PRINTF_FORMAT, 1, 0) +void +rb_bug_without_die(const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + rb_bug_without_die_internal(fmt, args); + va_end(args); +} + void rb_bug(const char *fmt, ...) { va_list args; va_start(args, fmt); - rb_bug_without_die(fmt, args); + rb_bug_without_die_internal(fmt, args); va_end(args); die(); } @@ -813,7 +1124,7 @@ rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler, int sig, const voi const char *file = NULL; int line = 0; - if (GET_EC()) { + if (rb_current_execution_context(false)) { file = rb_source_location_cstr(&line); } @@ -821,6 +1132,7 @@ rb_bug_for_fatal_signal(ruby_sighandler_t default_sighandler, int sig, const voi if (default_sighandler) default_sighandler(sig); + ruby_default_signal(sig); die(); } @@ -877,13 +1189,34 @@ rb_report_bug_valist(VALUE file, int line, const char *fmt, va_list args) void rb_assert_failure(const char *file, int line, const char *name, const char *expr) { - FILE *out = stderr; - fprintf(out, "Assertion Failed: %s:%d:", file, line); - if (name) fprintf(out, "%s:", name); - fprintf(out, "%s\n%s\n\n", expr, rb_dynamic_description); - preface_dump(out); - rb_vm_bugreport(NULL); - bug_report_end(out); + rb_assert_failure_detail(file, line, name, expr, NULL); +} + +void +rb_assert_failure_detail(const char *file, int line, const char *name, const char *expr, + const char *fmt, ...) +{ + rb_pid_t pid = -1; + FILE *out = bug_report_file(file, line, &pid); + if (out) { + fputs("Assertion Failed: ", out); + if (name) fprintf(out, "%s:", name); + fputs(expr, out); + + if (fmt && *fmt) { + va_list args; + va_start(args, fmt); + fputs(": ", out); + vfprintf(out, fmt, args); + va_end(args); + } + fprintf(out, "\n%s\n\n", rb_dynamic_description); + + preface_dump(out); + rb_vm_bugreport(NULL, out); + bug_report_end(out, pid); + } + die(); } @@ -980,6 +1313,20 @@ rb_builtin_class_name(VALUE x) COLDFUNC NORETURN(static void unexpected_type(VALUE, int, int)); #define UNDEF_LEAKED "undef leaked to the Ruby space" +void +rb_unexpected_typeddata(const rb_data_type_t *actual, const rb_data_type_t *expected) +{ + rb_raise(rb_eTypeError, "wrong argument type %s (expected %s)", + actual->wrap_struct_name, expected->wrap_struct_name); +} + +void +rb_unexpected_object_type(VALUE obj, const char *expected) +{ + rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE" (expected %s)", + displaying_class_of(obj), expected); +} + static void unexpected_type(VALUE x, int xt, int t) { @@ -987,9 +1334,7 @@ unexpected_type(VALUE x, int xt, int t) VALUE mesg, exc = rb_eFatal; if (tname) { - mesg = rb_sprintf("wrong argument type %"PRIsVALUE" (expected %s)", - displaying_class_of(x), tname); - exc = rb_eTypeError; + rb_unexpected_object_type(x, tname); } else if (xt > T_MASK && xt <= 0x3f) { mesg = rb_sprintf("unknown type 0x%x (0x%x given, probably comes" @@ -1034,24 +1379,18 @@ rb_unexpected_type(VALUE x, int t) unexpected_type(x, TYPE(x), t); } +#undef rb_typeddata_inherited_p int rb_typeddata_inherited_p(const rb_data_type_t *child, const rb_data_type_t *parent) { - while (child) { - if (child == parent) return 1; - child = child->parent; - } - return 0; + return rbimpl_typeddata_inherited_p_inline(child, parent); } +#undef rb_typeddata_is_kind_of int rb_typeddata_is_kind_of(VALUE obj, const rb_data_type_t *data_type) { - if (!RB_TYPE_P(obj, T_DATA) || - !RTYPEDDATA_P(obj) || !rb_typeddata_inherited_p(RTYPEDDATA_TYPE(obj), data_type)) { - return 0; - } - return 1; + return rbimpl_typeddata_is_kind_of_inline(obj, data_type); } #undef rb_typeddata_is_instance_of @@ -1064,26 +1403,7 @@ rb_typeddata_is_instance_of(VALUE obj, const rb_data_type_t *data_type) void * rb_check_typeddata(VALUE obj, const rb_data_type_t *data_type) { - VALUE actual; - - if (!RB_TYPE_P(obj, T_DATA)) { - actual = displaying_class_of(obj); - } - else if (!RTYPEDDATA_P(obj)) { - actual = displaying_class_of(obj); - } - else if (!rb_typeddata_inherited_p(RTYPEDDATA_TYPE(obj), data_type)) { - const char *name = RTYPEDDATA_TYPE(obj)->wrap_struct_name; - actual = rb_str_new_cstr(name); /* or rb_fstring_cstr? not sure... */ - } - else { - return DATA_PTR(obj); - } - - const char *expected = data_type->wrap_struct_name; - rb_raise(rb_eTypeError, "wrong argument type %"PRIsVALUE" (expected %s)", - actual, expected); - UNREACHABLE_RETURN(NULL); + return rbimpl_check_typeddata(obj, data_type); } /* exception classes */ @@ -1148,6 +1468,7 @@ rb_exc_new_cstr(VALUE etype, const char *s) VALUE rb_exc_new_str(VALUE etype, VALUE str) { + rb_yjit_lazy_push_frame(GET_EC()->cfp->pc); StringValue(str); return rb_class_new_instance(1, &str, etype); } @@ -1162,12 +1483,23 @@ exc_init(VALUE exc, VALUE mesg) } /* - * call-seq: - * Exception.new(msg = nil) -> exception - * Exception.exception(msg = nil) -> exception + * call-seq: + * Exception.new(message = nil) -> exception + * + * Returns a new exception object. + * + * The given +message+ should be + * a {string-convertible object}[rdoc-ref:implicit_conversion.rdoc@String-Convertible+Objects]; + * see method #message; + * if not given, the message is the class name of the new instance + * (which may be the name of a subclass): + * + * Examples: + * + * Exception.new # => #<Exception: Exception> + * LoadError.new # => #<LoadError: LoadError> # Subclass of Exception. + * Exception.new('Boom') # => #<Exception: Boom> * - * Construct a new Exception object, optionally passing in - * a message. */ static VALUE @@ -1183,12 +1515,24 @@ exc_initialize(int argc, VALUE *argv, VALUE exc) * Document-method: exception * * call-seq: - * exc.exception([string]) -> an_exception or exc + * exception(message = nil) -> self or new_exception + * + * Returns an exception object of the same class as +self+; + * useful for creating a similar exception, but with a different message. + * + * With +message+ +nil+, returns +self+: * - * With no argument, or if the argument is the same as the receiver, - * return the receiver. Otherwise, create a new - * exception object of the same class as the receiver, but with a - * message equal to <code>string.to_str</code>. + * x0 = StandardError.new('Boom') # => #<StandardError: Boom> + * x1 = x0.exception # => #<StandardError: Boom> + * x0.__id__ == x1.__id__ # => true + * + * With {string-convertible object}[rdoc-ref:implicit_conversion.rdoc@String-Convertible+Objects] + * +message+ (even the same as the original message), + * returns a new exception object whose class is the same as +self+, + * and whose message is the given +message+: + * + * x1 = x0.exception('Boom') # => #<StandardError: Boom> + * x0..equal?(x1) # => false * */ @@ -1207,10 +1551,15 @@ exc_exception(int argc, VALUE *argv, VALUE self) /* * call-seq: - * exception.to_s -> string + * to_s -> string + * + * Returns a string representation of +self+: + * + * x = RuntimeError.new('Boom') + * x.to_s # => "Boom" + * x = RuntimeError.new + * x.to_s # => "RuntimeError" * - * Returns exception's message (or the name of the exception if - * no message is set). */ static VALUE @@ -1250,10 +1599,10 @@ rb_get_detailed_message(VALUE exc, VALUE opt) } /* - * call-seq: - * Exception.to_tty? -> true or false + * call-seq: + * Exception.to_tty? -> true or false * - * Returns +true+ if exception messages will be sent to a tty. + * Returns +true+ if exception messages will be sent to a terminal device. */ static VALUE exc_s_to_tty_p(VALUE self) @@ -1313,20 +1662,51 @@ check_order_keyword(VALUE opt) /* * call-seq: - * exception.full_message(highlight: bool, order: [:top or :bottom]) -> string + * full_message(highlight: true, order: :top) -> string + * + * Returns an enhanced message string: * - * Returns formatted string of _exception_. - * The returned string is formatted using the same format that Ruby uses - * when printing an uncaught exceptions to stderr. + * - Includes the exception class name. + * - If the value of keyword +highlight+ is true (not +nil+ or +false+), + * includes bolding ANSI codes (see below) to enhance the appearance of the message. + * - Includes the {backtrace}[rdoc-ref:exceptions.md@Backtraces]: * - * If _highlight_ is +true+ the default error handler will send the - * messages to a tty. + * - If the value of keyword +order+ is +:top+ (the default), + * lists the error message and the innermost backtrace entry first. + * - If the value of keyword +order+ is +:bottom+, + * lists the error message the innermost entry last. * - * _order_ must be either of +:top+ or +:bottom+, and places the error - * message and the innermost backtrace come at the top or the bottom. + * Example: * - * The default values of these options depend on <code>$stderr</code> - * and its +tty?+ at the timing of a call. + * def baz + * begin + * 1 / 0 + * rescue => x + * pp x.message + * pp x.full_message(highlight: false).split("\n") + * pp x.full_message.split("\n") + * end + * end + * def bar; baz; end + * def foo; bar; end + * foo + * + * Output: + * + * "divided by 0" + * ["t.rb:3:in 'Integer#/': divided by 0 (ZeroDivisionError)", + * "\tfrom t.rb:3:in 'Object#baz'", + * "\tfrom t.rb:10:in 'Object#bar'", + * "\tfrom t.rb:11:in 'Object#foo'", + * "\tfrom t.rb:12:in '<main>'"] + * ["t.rb:3:in 'Integer#/': \e[1mdivided by 0 (\e[1;4mZeroDivisionError\e[m\e[1m)\e[m", + * "\tfrom t.rb:3:in 'Object#baz'", + * "\tfrom t.rb:10:in 'Object#bar'", + * "\tfrom t.rb:11:in 'Object#foo'", + * "\tfrom t.rb:12:in '<main>'"] + * + * An overriding method should be careful with ANSI code enhancements; + * see {Messages}[rdoc-ref:exceptions.md@Messages]. */ static VALUE @@ -1355,10 +1735,11 @@ exc_full_message(int argc, VALUE *argv, VALUE exc) /* * call-seq: - * exception.message -> string + * message -> string + * + * Returns #to_s. * - * Returns the result of invoking <code>exception.to_s</code>. - * Normally this returns the exception's message or name. + * See {Messages}[rdoc-ref:exceptions.md@Messages]. */ static VALUE @@ -1369,42 +1750,47 @@ exc_message(VALUE exc) /* * call-seq: - * exception.detailed_message(highlight: bool, **opt) -> string + * detailed_message(highlight: false, **kwargs) -> string * - * Processes a string returned by #message. + * Returns the message string with enhancements: * - * It may add the class name of the exception to the end of the first line. - * Also, when +highlight+ keyword is true, it adds ANSI escape sequences to - * make the message bold. + * - Includes the exception class name in the first line. + * - If the value of keyword +highlight+ is +true+, + * includes bolding and underlining ANSI codes (see below) + * to enhance the appearance of the message. * - * If you override this method, it must be tolerant for unknown keyword - * arguments. All keyword arguments passed to #full_message are delegated - * to this method. + * Examples: * - * This method is overridden by did_you_mean and error_highlight to add - * their information. + * begin + * 1 / 0 + * rescue => x + * p x.message + * p x.detailed_message # Class name added. + * p x.detailed_message(highlight: true) # Class name, bolding, and underlining added. + * end * - * A user-defined exception class can also define their own - * +detailed_message+ method to add supplemental information. - * When +highlight+ is true, it can return a string containing escape - * sequences, but use widely-supported ones. It is recommended to limit - * the following codes: + * Output: * - * - Reset (+\e[0m+) - * - Bold (+\e[1m+) - * - Underline (+\e[4m+) - * - Foreground color except white and black - * - Red (+\e[31m+) - * - Green (+\e[32m+) - * - Yellow (+\e[33m+) - * - Blue (+\e[34m+) - * - Magenta (+\e[35m+) - * - Cyan (+\e[36m+) + * "divided by 0" + * "divided by 0 (ZeroDivisionError)" + * "\e[1mdivided by 0 (\e[1;4mZeroDivisionError\e[m\e[1m)\e[m" * - * Use escape sequences carefully even if +highlight+ is true. - * Do not use escape sequences to express essential information; - * the message should be readable even if all escape sequences are - * ignored. + * This method is overridden by some gems in the Ruby standard library to add information: + * + * - DidYouMean::Correctable#detailed_message. + * - ErrorHighlight::CoreExt#detailed_message. + * - SyntaxSuggest#detailed_message. + * + * An overriding method must be tolerant of passed keyword arguments, + * which may include (but may not be limited to): + * + * - +:highlight+. + * - +:did_you_mean+. + * - +:error_highlight+. + * - +:syntax_suggest+. + * + * An overriding method should also be careful with ANSI code enhancements; + * see {Messages}[rdoc-ref:exceptions.md@Messages]. */ static VALUE @@ -1416,16 +1802,22 @@ exc_detailed_message(int argc, VALUE *argv, VALUE exc) VALUE highlight = check_highlight_keyword(opt, 0); - extern VALUE rb_decorate_message(const VALUE eclass, const VALUE emesg, int highlight); + extern VALUE rb_decorate_message(const VALUE eclass, VALUE emesg, int highlight); return rb_decorate_message(CLASS_OF(exc), rb_get_message(exc), RTEST(highlight)); } /* * call-seq: - * exception.inspect -> string + * inspect -> string + * + * Returns a string representation of +self+: + * + * x = RuntimeError.new('Boom') + * x.inspect # => "#<RuntimeError: Boom>" + * x = RuntimeError.new + * x.inspect # => "#<RuntimeError: RuntimeError>" * - * Return this exception's class name and message. */ static VALUE @@ -1458,38 +1850,36 @@ exc_inspect(VALUE exc) /* * call-seq: - * exception.backtrace -> array or nil - * - * Returns any backtrace associated with the exception. The backtrace - * is an array of strings, each containing either ``filename:lineNo: in - * `method''' or ``filename:lineNo.'' + * backtrace -> array or nil * - * def a - * raise "boom" - * end + * Returns the backtrace (the list of code locations that led to the exception), + * as an array of strings. * - * def b - * a() - * end + * Example (assuming the code is stored in the file named <tt>t.rb</tt>): * - * begin - * b() - * rescue => detail - * print detail.backtrace.join("\n") - * end + * def division(numerator, denominator) + * numerator / denominator + * end * - * <em>produces:</em> + * begin + * division(1, 0) + * rescue => ex + * p ex.backtrace + * # ["t.rb:2:in 'Integer#/'", "t.rb:2:in 'Object#division'", "t.rb:6:in '<main>'"] + * loc = ex.backtrace.first + * p loc.class + * # String + * end * - * prog.rb:2:in `a' - * prog.rb:6:in `b' - * prog.rb:10 + * The value returned by this method might be adjusted when raising (see Kernel#raise), + * or during intermediate handling by #set_backtrace. * - * In the case no backtrace has been set, +nil+ is returned + * See also #backtrace_locations that provide the same value, as structured objects. + * (Note though that two values might not be consistent with each other when + * backtraces are manually adjusted.) * - * ex = StandardError.new - * ex.backtrace - * #=> nil -*/ + * see {Backtraces}[rdoc-ref:exceptions.md@Backtraces]. + */ static VALUE exc_backtrace(VALUE exc) @@ -1531,13 +1921,41 @@ rb_get_backtrace(VALUE exc) /* * call-seq: - * exception.backtrace_locations -> array or nil + * backtrace_locations -> array or nil + * + * Returns the backtrace (the list of code locations that led to the exception), + * as an array of Thread::Backtrace::Location instances. * - * Returns any backtrace associated with the exception. This method is - * similar to Exception#backtrace, but the backtrace is an array of - * Thread::Backtrace::Location. + * Example (assuming the code is stored in the file named <tt>t.rb</tt>): * - * This method is not affected by Exception#set_backtrace(). + * def division(numerator, denominator) + * numerator / denominator + * end + * + * begin + * division(1, 0) + * rescue => ex + * p ex.backtrace_locations + * # ["t.rb:2:in 'Integer#/'", "t.rb:2:in 'Object#division'", "t.rb:6:in '<main>'"] + * loc = ex.backtrace_locations.first + * p loc.class + * # Thread::Backtrace::Location + * p loc.path + * # "t.rb" + * p loc.lineno + * # 2 + * p loc.label + * # "Integer#/" + * end + * + * The value returned by this method might be adjusted when raising (see Kernel#raise), + * or during intermediate handling by #set_backtrace. + * + * See also #backtrace that provide the same value as an array of strings. + * (Note though that two values might not be consistent with each other when + * backtraces are manually adjusted.) + * + * See {Backtraces}[rdoc-ref:exceptions.md@Backtraces]. */ static VALUE exc_backtrace_locations(VALUE exc) @@ -1555,7 +1973,7 @@ static VALUE rb_check_backtrace(VALUE bt) { long i; - static const char err[] = "backtrace must be Array of String"; + static const char err[] = "backtrace must be an Array of String or an Array of Thread::Backtrace::Location"; if (!NIL_P(bt)) { if (RB_TYPE_P(bt, T_STRING)) return rb_ary_new3(1, bt); @@ -1575,18 +1993,118 @@ rb_check_backtrace(VALUE bt) /* * call-seq: - * exc.set_backtrace(backtrace) -> array + * set_backtrace(value) -> value + * + * Sets the backtrace value for +self+; returns the given +value+. + * + * The +value+ might be: + * + * - an array of Thread::Backtrace::Location; + * - an array of String instances; + * - a single String instance; or + * - +nil+. + * + * Using array of Thread::Backtrace::Location is the most consistent + * option: it sets both #backtrace and #backtrace_locations. It should be + * preferred when possible. The suitable array of locations can be obtained + * from Kernel#caller_locations, copied from another error, or just set to + * the adjusted result of the current error's #backtrace_locations: * - * Sets the backtrace information associated with +exc+. The +backtrace+ must - * be an array of String objects or a single String in the format described - * in Exception#backtrace. + * require 'json' * + * def parse_payload(text) + * JSON.parse(text) # test.rb, line 4 + * rescue JSON::ParserError => ex + * ex.set_backtrace(ex.backtrace_locations[2...]) + * raise + * end + * + * parse_payload('{"wrong: "json"') + * # test.rb:4:in 'Object#parse_payload': unexpected token at '{"wrong: "json"' (JSON::ParserError) + * # + * # An error points to the body of parse_payload method, + * # hiding the parts of the backtrace related to the internals + * # of the "json" library + * + * # The error has both #backtace and #backtrace_locations set + * # consistently: + * begin + * parse_payload('{"wrong: "json"') + * rescue => ex + * p ex.backtrace + * # ["test.rb:4:in 'Object#parse_payload'", "test.rb:20:in '<main>'"] + * p ex.backtrace_locations + * # ["test.rb:4:in 'Object#parse_payload'", "test.rb:20:in '<main>'"] + * end + * + * When the desired stack of locations is not available and should + * be constructed from scratch, an array of strings or a singular + * string can be used. In this case, only #backtrace is affected: + * + * def parse_payload(text) + * JSON.parse(text) + * rescue JSON::ParserError => ex + * ex.set_backtrace(["dsl.rb:34", "framework.rb:1"]) + * # The error have the new value in #backtrace: + * p ex.backtrace + * # ["dsl.rb:34", "framework.rb:1"] + * + * # but the original one in #backtrace_locations + * p ex.backtrace_locations + * # [".../json/common.rb:221:in 'JSON::Ext::Parser.parse'", ...] + * end + * + * parse_payload('{"wrong: "json"') + * + * Calling #set_backtrace with +nil+ clears up #backtrace but doesn't affect + * #backtrace_locations: + * + * def parse_payload(text) + * JSON.parse(text) + * rescue JSON::ParserError => ex + * ex.set_backtrace(nil) + * p ex.backtrace + * # nil + * p ex.backtrace_locations + * # [".../json/common.rb:221:in 'JSON::Ext::Parser.parse'", ...] + * end + * + * parse_payload('{"wrong: "json"') + * + * On reraising of such an exception, both #backtrace and #backtrace_locations + * is set to the place of reraising: + * + * def parse_payload(text) + * JSON.parse(text) + * rescue JSON::ParserError => ex + * ex.set_backtrace(nil) + * raise # test.rb, line 7 + * end + * + * begin + * parse_payload('{"wrong: "json"') + * rescue => ex + * p ex.backtrace + * # ["test.rb:7:in 'Object#parse_payload'", "test.rb:11:in '<main>'"] + * p ex.backtrace_locations + * # ["test.rb:7:in 'Object#parse_payload'", "test.rb:11:in '<main>'"] + * end + * + * See {Backtraces}[rdoc-ref:exceptions.md@Backtraces]. */ static VALUE exc_set_backtrace(VALUE exc, VALUE bt) { - return rb_ivar_set(exc, id_bt, rb_check_backtrace(bt)); + VALUE btobj = rb_location_ary_to_backtrace(bt); + if (RTEST(btobj)) { + rb_ivar_set(exc, id_bt, btobj); + rb_ivar_set(exc, id_bt_locations, btobj); + return bt; + } + else { + return rb_ivar_set(exc, id_bt, rb_check_backtrace(bt)); + } } VALUE @@ -1596,12 +2114,35 @@ rb_exc_set_backtrace(VALUE exc, VALUE bt) } /* - * call-seq: - * exception.cause -> an_exception or nil + * call-seq: + * cause -> exception or nil + * + * Returns the previous value of global variable <tt>$!</tt>, + * which may be +nil+ + * (see {Global Variables}[rdoc-ref:exceptions.md@Global+Variables]): + * + * begin + * raise('Boom 0') + * rescue => x0 + * puts "Exception: #{x0}; $!: #{$!}; cause: #{x0.cause.inspect}." + * begin + * raise('Boom 1') + * rescue => x1 + * puts "Exception: #{x1}; $!: #{$!}; cause: #{x1.cause}." + * begin + * raise('Boom 2') + * rescue => x2 + * puts "Exception: #{x2}; $!: #{$!}; cause: #{x2.cause}." + * end + * end + * end + * + * Output: + * + * Exception: Boom 0; $!: Boom 0; cause: nil. + * Exception: Boom 1; $!: Boom 1; cause: Boom 0. + * Exception: Boom 2; $!: Boom 2; cause: Boom 1. * - * Returns the previous exception ($!) at the time this exception was raised. - * This is useful for wrapping exceptions and retaining the original exception - * information. */ static VALUE @@ -1618,11 +2159,11 @@ try_convert_to_exception(VALUE obj) /* * call-seq: - * exc == obj -> true or false + * self == other -> true or false + * + * Returns whether +other+ is the same class as +self+ + * and its #message and #backtrace are equal to those of +self+. * - * Equality---If <i>obj</i> is not an Exception, returns - * <code>false</code>. Otherwise, returns <code>true</code> if <i>exc</i> and - * <i>obj</i> share same class, messages, and backtrace. */ static VALUE @@ -1957,50 +2498,41 @@ rb_nomethod_err_new(VALUE mesg, VALUE recv, VALUE method, VALUE args, int priv) return nometh_err_init_attr(exc, args, priv); } -/* :nodoc: */ -enum { - NAME_ERR_MESG__MESG, - NAME_ERR_MESG__RECV, - NAME_ERR_MESG__NAME, - NAME_ERR_MESG_COUNT -}; +typedef struct name_error_message_struct { + VALUE mesg; + VALUE recv; + VALUE name; +} name_error_message_t; static void -name_err_mesg_mark(void *p) +name_err_mesg_mark_and_move(void *p) { - VALUE *ptr = p; - rb_gc_mark_locations(ptr, ptr+NAME_ERR_MESG_COUNT); -} - -#define name_err_mesg_free RUBY_TYPED_DEFAULT_FREE - -static size_t -name_err_mesg_memsize(const void *p) -{ - return NAME_ERR_MESG_COUNT * sizeof(VALUE); + name_error_message_t *ptr = (name_error_message_t *)p; + rb_gc_mark_and_move(&ptr->mesg); + rb_gc_mark_and_move(&ptr->recv); + rb_gc_mark_and_move(&ptr->name); } static const rb_data_type_t name_err_mesg_data_type = { "name_err_mesg", { - name_err_mesg_mark, - name_err_mesg_free, - name_err_mesg_memsize, + name_err_mesg_mark_and_move, + RUBY_TYPED_DEFAULT_FREE, + NULL, // No external memory to report, + name_err_mesg_mark_and_move, }, - 0, 0, RUBY_TYPED_FREE_IMMEDIATELY + 0, 0, RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_EMBEDDABLE }; /* :nodoc: */ static VALUE -rb_name_err_mesg_init(VALUE klass, VALUE mesg, VALUE recv, VALUE method) +rb_name_err_mesg_init(VALUE klass, VALUE mesg, VALUE recv, VALUE name) { - VALUE result = TypedData_Wrap_Struct(klass, &name_err_mesg_data_type, 0); - VALUE *ptr = ALLOC_N(VALUE, NAME_ERR_MESG_COUNT); - - ptr[NAME_ERR_MESG__MESG] = mesg; - ptr[NAME_ERR_MESG__RECV] = recv; - ptr[NAME_ERR_MESG__NAME] = method; - RTYPEDDATA_DATA(result) = ptr; + name_error_message_t *message; + VALUE result = TypedData_Make_Struct(klass, name_error_message_t, &name_err_mesg_data_type, message); + RB_OBJ_WRITE(result, &message->mesg, mesg); + RB_OBJ_WRITE(result, &message->recv, recv); + RB_OBJ_WRITE(result, &message->name, name); return result; } @@ -2022,14 +2554,16 @@ name_err_mesg_alloc(VALUE klass) static VALUE name_err_mesg_init_copy(VALUE obj1, VALUE obj2) { - VALUE *ptr1, *ptr2; - if (obj1 == obj2) return obj1; rb_obj_init_copy(obj1, obj2); - TypedData_Get_Struct(obj1, VALUE, &name_err_mesg_data_type, ptr1); - TypedData_Get_Struct(obj2, VALUE, &name_err_mesg_data_type, ptr2); - MEMCPY(ptr1, ptr2, VALUE, NAME_ERR_MESG_COUNT); + name_error_message_t *ptr1, *ptr2; + TypedData_Get_Struct(obj1, name_error_message_t, &name_err_mesg_data_type, ptr1); + TypedData_Get_Struct(obj2, name_error_message_t, &name_err_mesg_data_type, ptr2); + + RB_OBJ_WRITE(obj1, &ptr1->mesg, ptr2->mesg); + RB_OBJ_WRITE(obj1, &ptr1->recv, ptr2->recv); + RB_OBJ_WRITE(obj1, &ptr1->name, ptr2->name); return obj1; } @@ -2037,19 +2571,18 @@ name_err_mesg_init_copy(VALUE obj1, VALUE obj2) static VALUE name_err_mesg_equal(VALUE obj1, VALUE obj2) { - VALUE *ptr1, *ptr2; - int i; - if (obj1 == obj2) return Qtrue; + if (rb_obj_class(obj2) != rb_cNameErrorMesg) return Qfalse; - TypedData_Get_Struct(obj1, VALUE, &name_err_mesg_data_type, ptr1); - TypedData_Get_Struct(obj2, VALUE, &name_err_mesg_data_type, ptr2); - for (i=0; i<NAME_ERR_MESG_COUNT; i++) { - if (!rb_equal(ptr1[i], ptr2[i])) - return Qfalse; - } + name_error_message_t *ptr1, *ptr2; + TypedData_Get_Struct(obj1, name_error_message_t, &name_err_mesg_data_type, ptr1); + TypedData_Get_Struct(obj2, name_error_message_t, &name_err_mesg_data_type, ptr2); + + if (!rb_equal(ptr1->mesg, ptr2->mesg)) return Qfalse; + if (!rb_equal(ptr1->recv, ptr2->recv)) return Qfalse; + if (!rb_equal(ptr1->name, ptr2->name)) return Qfalse; return Qtrue; } @@ -2068,20 +2601,20 @@ name_err_mesg_receiver_name(VALUE obj) static VALUE name_err_mesg_to_str(VALUE obj) { - VALUE *ptr, mesg; - TypedData_Get_Struct(obj, VALUE, &name_err_mesg_data_type, ptr); + name_error_message_t *ptr; + TypedData_Get_Struct(obj, name_error_message_t, &name_err_mesg_data_type, ptr); - mesg = ptr[NAME_ERR_MESG__MESG]; + VALUE mesg = ptr->mesg; if (NIL_P(mesg)) return Qnil; else { - struct RString s_str, c_str, d_str; + struct RString s_str = {RBASIC_INIT}, c_str = {RBASIC_INIT}, d_str = {RBASIC_INIT}; VALUE c, s, d = 0, args[4], c2; int state = 0; rb_encoding *usascii = rb_usascii_encoding(); #define FAKE_CSTR(v, str) rb_setup_fake_str((v), (str), rb_strlen_lit(str), usascii) c = s = FAKE_CSTR(&s_str, ""); - obj = ptr[NAME_ERR_MESG__RECV]; + obj = ptr->recv; switch (obj) { case Qnil: c = d = FAKE_CSTR(&d_str, "nil"); @@ -2124,7 +2657,7 @@ name_err_mesg_to_str(VALUE obj) VALUE klass; object: klass = CLASS_OF(obj); - if (RB_TYPE_P(klass, T_CLASS) && FL_TEST(klass, FL_SINGLETON)) { + if (RB_TYPE_P(klass, T_CLASS) && RCLASS_SINGLETON_P(klass)) { s = FAKE_CSTR(&s_str, ""); if (obj == rb_vm_top_self()) { c = FAKE_CSTR(&c_str, "main"); @@ -2152,7 +2685,7 @@ name_err_mesg_to_str(VALUE obj) c = c2; break; } - args[0] = rb_obj_as_string(ptr[NAME_ERR_MESG__NAME]); + args[0] = rb_obj_as_string(ptr->name); args[1] = d; args[2] = s; args[3] = c; @@ -2185,17 +2718,17 @@ name_err_mesg_load(VALUE klass, VALUE str) static VALUE name_err_receiver(VALUE self) { - VALUE *ptr, recv, mesg; - - recv = rb_ivar_lookup(self, id_recv, Qundef); + VALUE recv = rb_ivar_lookup(self, id_recv, Qundef); if (!UNDEF_P(recv)) return recv; - mesg = rb_attr_get(self, id_mesg); + VALUE mesg = rb_attr_get(self, id_mesg); if (!rb_typeddata_is_kind_of(mesg, &name_err_mesg_data_type)) { rb_raise(rb_eArgError, "no receiver is available"); } - ptr = DATA_PTR(mesg); - return ptr[NAME_ERR_MESG__RECV]; + + name_error_message_t *ptr; + TypedData_Get_Struct(mesg, name_error_message_t, &name_err_mesg_data_type, ptr); + return ptr->recv; } /* @@ -2405,8 +2938,18 @@ syntax_error_with_path(VALUE exc, VALUE path, VALUE *mesg, rb_encoding *enc) rb_ivar_set(exc, id_i_path, path); } else { - if (rb_attr_get(exc, id_i_path) != path) { - rb_raise(rb_eArgError, "SyntaxError#path changed"); + VALUE old_path = rb_attr_get(exc, id_i_path); + if (old_path != path) { + if (rb_str_equal(path, old_path)) { + rb_raise(rb_eArgError, "SyntaxError#path changed: %+"PRIsVALUE" (%p->%p)", + old_path, (void *)old_path, (void *)path); + } + else { + rb_raise(rb_eArgError, "SyntaxError#path changed: %+"PRIsVALUE"(%s%s)->%+"PRIsVALUE"(%s)", + old_path, rb_enc_name(rb_enc_get(old_path)), + (FL_TEST(old_path, RSTRING_FSTR) ? ":FSTR" : ""), + path, rb_enc_name(rb_enc_get(path))); + } } VALUE s = *mesg = rb_attr_get(exc, idMesg); if (RSTRING_LEN(s) > 0 && *(RSTRING_END(s)-1) != '\n') @@ -2418,67 +2961,105 @@ syntax_error_with_path(VALUE exc, VALUE path, VALUE *mesg, rb_encoding *enc) /* * Document-module: Errno * - * Ruby exception objects are subclasses of Exception. However, - * operating systems typically report errors using plain - * integers. Module Errno is created dynamically to map these - * operating system errors to Ruby classes, with each error number - * generating its own subclass of SystemCallError. As the subclass - * is created in module Errno, its name will start - * <code>Errno::</code>. + * When an operating system encounters an error, + * it typically reports the error as an integer error code: + * + * $ ls nosuch.txt + * ls: cannot access 'nosuch.txt': No such file or directory + * $ echo $? # Code for last error. + * 2 + * + * When the Ruby interpreter interacts with the operating system + * and receives such an error code (e.g., +2+), + * it maps the code to a particular Ruby exception class (e.g., +Errno::ENOENT+): + * + * File.open('nosuch.txt') + * # => No such file or directory @ rb_sysopen - nosuch.txt (Errno::ENOENT) * - * The names of the <code>Errno::</code> classes depend on the - * environment in which Ruby runs. On a typical Unix or Windows - * platform, there are Errno classes such as Errno::EACCES, - * Errno::EAGAIN, Errno::EINTR, and so on. + * Each such class is: * - * The integer operating system error number corresponding to a - * particular error is available as the class constant - * <code>Errno::</code><em>error</em><code>::Errno</code>. + * - A nested class in this module, +Errno+. + * - A subclass of class SystemCallError. + * - Associated with an error code. * - * Errno::EACCES::Errno #=> 13 - * Errno::EAGAIN::Errno #=> 11 - * Errno::EINTR::Errno #=> 4 + * Thus: * - * The full list of operating system errors on your particular platform - * are available as the constants of Errno. + * Errno::ENOENT.superclass # => SystemCallError + * Errno::ENOENT::Errno # => 2 * - * Errno.constants #=> :E2BIG, :EACCES, :EADDRINUSE, :EADDRNOTAVAIL, ... + * The names of nested classes are returned by method +Errno.constants+: + * + * Errno.constants.size # => 158 + * Errno.constants.sort.take(5) # => [:E2BIG, :EACCES, :EADDRINUSE, :EADDRNOTAVAIL, :EADV] + * + * As seen above, the error code associated with each class + * is available as the value of a constant; + * the value for a particular class may vary among operating systems. + * If the class is not needed for the particular operating system, + * the value is zero: + * + * Errno::ENOENT::Errno # => 2 + * Errno::ENOTCAPABLE::Errno # => 0 + * + * Each class in Errno can be created with optional messages: + * + * Errno::EPIPE.new # => #<Errno::EPIPE: Broken pipe> + * Errno::EPIPE.new("foo") # => #<Errno::EPIPE: Broken pipe - foo> + * Errno::EPIPE.new("foo", "here") # => #<Errno::EPIPE: Broken pipe @ here - foo> + * + * See SystemCallError.new. */ static st_table *syserr_tbl; -static VALUE -set_syserr(int n, const char *name) +void +rb_free_warning(void) { - st_data_t error; + st_free_table(warning_categories.id2enum); + st_free_table(warning_categories.enum2id); + st_free_table(syserr_tbl); +} - if (!st_lookup(syserr_tbl, n, &error)) { - error = rb_define_class_under(rb_mErrno, name, rb_eSystemCallError); +static VALUE +setup_syserr(int n, const char *name) +{ + VALUE error = rb_define_class_under(rb_mErrno, name, rb_eSystemCallError); - /* capture nonblock errnos for WaitReadable/WaitWritable subclasses */ - switch (n) { - case EAGAIN: - rb_eEAGAIN = error; + /* capture nonblock errnos for WaitReadable/WaitWritable subclasses */ + switch (n) { + case EAGAIN: + rb_eEAGAIN = error; #if defined(EWOULDBLOCK) && EWOULDBLOCK != EAGAIN - break; - case EWOULDBLOCK: + break; + case EWOULDBLOCK: #endif - rb_eEWOULDBLOCK = error; - break; - case EINPROGRESS: - rb_eEINPROGRESS = error; - break; - } + rb_eEWOULDBLOCK = error; + break; + case EINPROGRESS: + rb_eEINPROGRESS = error; + break; + } - rb_define_const(error, "Errno", INT2NUM(n)); - st_add_direct(syserr_tbl, n, error); + rb_define_const(error, "Errno", INT2NUM(n)); + st_add_direct(syserr_tbl, n, (st_data_t)error); + return error; +} + +static VALUE +set_syserr(int n, const char *name) +{ + st_data_t error; + + if (!st_lookup(syserr_tbl, n, &error)) { + return setup_syserr(n, name); } else { - rb_define_const(rb_mErrno, name, error); + VALUE errclass = (VALUE)error; + rb_define_const(rb_mErrno, name, errclass); + return errclass; } - return error; } static VALUE @@ -2487,22 +3068,43 @@ get_syserr(int n) st_data_t error; if (!st_lookup(syserr_tbl, n, &error)) { - char name[8]; /* some Windows' errno have 5 digits. */ + char name[DECIMAL_SIZE_OF(n) + sizeof("E-")]; snprintf(name, sizeof(name), "E%03d", n); - error = set_syserr(n, name); + return setup_syserr(n, name); } - return error; + return (VALUE)error; } /* * call-seq: - * SystemCallError.new(msg, errno) -> system_call_error_subclass + * SystemCallError.new(msg, errno = nil, func = nil) -> system_call_error_subclass * * If _errno_ corresponds to a known system error code, constructs the * appropriate Errno class for that error, otherwise constructs a * generic SystemCallError object. The error number is subsequently * available via the #errno method. + * + * If only numeric object is given, it is treated as an Integer _errno_, + * and _msg_ is omitted, otherwise the first argument _msg_ is used as + * the additional error message. + * + * SystemCallError.new(Errno::EPIPE::Errno) + * #=> #<Errno::EPIPE: Broken pipe> + * + * SystemCallError.new("foo") + * #=> #<SystemCallError: unknown error - foo> + * + * SystemCallError.new("foo", Errno::EPIPE::Errno) + * #=> #<Errno::EPIPE: Broken pipe - foo> + * + * If _func_ is not +nil+, it is appended to the message with "<tt> @ </tt>". + * + * SystemCallError.new("foo", Errno::EPIPE::Errno, "here") + * #=> #<Errno::EPIPE: Broken pipe @ here - foo> + * + * A subclass of SystemCallError can also be instantiated via the + * +new+ method of the subclass. See Errno. */ static VALUE @@ -2806,7 +3408,7 @@ syserr_eqq(VALUE self, VALUE exc) * * <em>raises the exception:</em> * - * NoMethodError: undefined method `to_ary' for "hello":String + * NoMethodError: undefined method `to_ary' for an instance of String */ /* @@ -2877,9 +3479,21 @@ syserr_eqq(VALUE self, VALUE exc) */ /* + * Document-class: NoMatchingPatternError + * + * Raised when matching pattern not found. + */ + +/* + * Document-class: NoMatchingPatternKeyError + * + * Raised when matching key not found. + */ + +/* * Document-class: fatal * - * fatal is an Exception that is raised when Ruby has encountered a fatal + * +fatal+ is an Exception that is raised when Ruby has encountered a fatal * error and must exit. */ @@ -2891,62 +3505,26 @@ syserr_eqq(VALUE self, VALUE exc) /* * Document-class: Exception * - * \Class Exception and its subclasses are used to communicate between - * Kernel#raise and +rescue+ statements in <code>begin ... end</code> blocks. - * - * An Exception object carries information about an exception: - * - Its type (the exception's class). - * - An optional descriptive message. - * - Optional backtrace information. - * - * Some built-in subclasses of Exception have additional methods: e.g., NameError#name. - * - * == Defaults - * - * Two Ruby statements have default exception classes: - * - +raise+: defaults to RuntimeError. - * - +rescue+: defaults to StandardError. - * - * == Global Variables - * - * When an exception has been raised but not yet handled (in +rescue+, - * +ensure+, +at_exit+ and +END+ blocks), two global variables are set: - * - <code>$!</code> contains the current exception. - * - <code>$@</code> contains its backtrace. + * Class +Exception+ and its subclasses are used to indicate that an error + * or other problem has occurred, + * and may need to be handled. + * See {Exceptions}[rdoc-ref:exceptions.md]. * - * == Custom Exceptions + * An +Exception+ object carries certain information: * - * To provide additional or alternate information, - * a program may create custom exception classes - * that derive from the built-in exception classes. + * - The type (the exception's class), + * commonly StandardError, RuntimeError, or a subclass of one or the other; + * see {Built-In Exception Class Hierarchy}[rdoc-ref:Exception@Built-In+Exception+Class+Hierarchy]. + * - An optional descriptive message; + * see methods ::new, #message. + * - Optional backtrace information; + * see methods #backtrace, #backtrace_locations, #set_backtrace. + * - An optional cause; + * see method #cause. * - * A good practice is for a library to create a single "generic" exception class - * (typically a subclass of StandardError or RuntimeError) - * and have its other exception classes derive from that class. - * This allows the user to rescue the generic exception, thus catching all exceptions - * the library may raise even if future versions of the library add new - * exception subclasses. + * == Built-In \Exception Class Hierarchy * - * For example: - * - * class MyLibrary - * class Error < ::StandardError - * end - * - * class WidgetError < Error - * end - * - * class FrobError < Error - * end - * - * end - * - * To handle both MyLibrary::WidgetError and MyLibrary::FrobError the library - * user can rescue MyLibrary::Error. - * - * == Built-In Exception Classes - * - * The built-in subclasses of Exception are: + * The hierarchy of built-in subclasses of class +Exception+: * * * NoMemoryError * * ScriptError @@ -2976,13 +3554,14 @@ syserr_eqq(VALUE self, VALUE exc) * * RuntimeError * * FrozenError * * SystemCallError - * * Errno::* + * * Errno (and its subclasses, representing system errors) * * ThreadError * * TypeError * * ZeroDivisionError * * SystemExit * * SystemStackError - * * fatal + * * {fatal}[rdoc-ref:fatal] + * */ static VALUE @@ -3002,9 +3581,9 @@ exception_dumper(VALUE exc) } static int -ivar_copy_i(st_data_t key, st_data_t val, st_data_t exc) +ivar_copy_i(ID key, VALUE val, st_data_t exc) { - rb_ivar_set((VALUE) exc, (ID) key, (VALUE) val); + rb_ivar_set((VALUE)exc, key, val); return ST_CONTINUE; } @@ -3081,11 +3660,11 @@ Init_Exception(void) * and will render `idPath` as an attribute name without this trick */ ID path = idPath; - /* the path failed to parse */ + /* the path that failed to parse */ rb_attr(rb_eSyntaxError, path, TRUE, FALSE, FALSE); rb_eLoadError = rb_define_class("LoadError", rb_eScriptError); - /* the path failed to load */ + /* the path that failed to load */ rb_attr(rb_eLoadError, path, TRUE, FALSE, FALSE); rb_eNotImpError = rb_define_class("NotImplementedError", rb_eScriptError); @@ -3132,6 +3711,7 @@ Init_Exception(void) rb_mWarning = rb_define_module("Warning"); rb_define_singleton_method(rb_mWarning, "[]", rb_warning_s_aref, 1); rb_define_singleton_method(rb_mWarning, "[]=", rb_warning_s_aset, 2); + rb_define_singleton_method(rb_mWarning, "categories", rb_warning_s_categories, 0); rb_define_method(rb_mWarning, "warn", rb_warning_s_warn, -1); rb_extend_object(rb_mWarning, rb_mWarning); @@ -3157,6 +3737,7 @@ Init_Exception(void) id_deprecated = rb_intern_const("deprecated"); id_experimental = rb_intern_const("experimental"); id_performance = rb_intern_const("performance"); + id_strict_unused_block = rb_intern_const("strict_unused_block"); id_top = rb_intern_const("top"); id_bottom = rb_intern_const("bottom"); id_iseq = rb_make_internal_id(); @@ -3169,12 +3750,14 @@ Init_Exception(void) st_add_direct(warning_categories.id2enum, id_deprecated, RB_WARN_CATEGORY_DEPRECATED); st_add_direct(warning_categories.id2enum, id_experimental, RB_WARN_CATEGORY_EXPERIMENTAL); st_add_direct(warning_categories.id2enum, id_performance, RB_WARN_CATEGORY_PERFORMANCE); + st_add_direct(warning_categories.id2enum, id_strict_unused_block, RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK); warning_categories.enum2id = rb_init_identtable(); st_add_direct(warning_categories.enum2id, RB_WARN_CATEGORY_NONE, 0); st_add_direct(warning_categories.enum2id, RB_WARN_CATEGORY_DEPRECATED, id_deprecated); st_add_direct(warning_categories.enum2id, RB_WARN_CATEGORY_EXPERIMENTAL, id_experimental); st_add_direct(warning_categories.enum2id, RB_WARN_CATEGORY_PERFORMANCE, id_performance); + st_add_direct(warning_categories.enum2id, RB_WARN_CATEGORY_STRICT_UNUSED_BLOCK, id_strict_unused_block); } void @@ -3197,12 +3780,13 @@ rb_vraise(VALUE exc, const char *fmt, va_list ap) } void -rb_raise(VALUE exc, const char *fmt, ...) +rb_raise(VALUE exc_class, const char *fmt, ...) { va_list args; va_start(args, fmt); - rb_vraise(exc, fmt, args); + VALUE exc = rb_exc_new3(exc_class, rb_vsprintf(fmt, args)); va_end(args); + rb_exc_raise(exc); } NORETURN(static void raise_loaderror(VALUE path, VALUE mesg)); @@ -3257,7 +3841,7 @@ rb_fatal(const char *fmt, ...) /* The thread has no GVL. Object allocation impossible (cant run GC), * thus no message can be printed out. */ fprintf(stderr, "[FATAL] rb_fatal() outside of GVL\n"); - rb_print_backtrace(); + rb_print_backtrace(stderr); die(); } @@ -3546,48 +4130,107 @@ inspect_frozen_obj(VALUE obj, VALUE mesg, int recur) return mesg; } +static VALUE +get_created_info(VALUE obj, int *pline) +{ + VALUE info = rb_attr_get(obj, id_debug_created_info); + + if (NIL_P(info)) return Qnil; + + VALUE path = rb_ary_entry(info, 0); + VALUE line = rb_ary_entry(info, 1); + if (NIL_P(path)) return Qnil; + *pline = NUM2INT(line); + return StringValue(path); +} + void rb_error_frozen_object(VALUE frozen_obj) { - VALUE debug_info; - const ID created_info = id_debug_created_info; + rb_yjit_lazy_push_frame(GET_EC()->cfp->pc); + VALUE mesg = rb_sprintf("can't modify frozen %"PRIsVALUE": ", - CLASS_OF(frozen_obj)); + rb_obj_class(frozen_obj)); VALUE exc = rb_exc_new_str(rb_eFrozenError, mesg); rb_ivar_set(exc, id_recv, frozen_obj); rb_exec_recursive(inspect_frozen_obj, frozen_obj, mesg); - if (!NIL_P(debug_info = rb_attr_get(frozen_obj, created_info))) { - VALUE path = rb_ary_entry(debug_info, 0); - VALUE line = rb_ary_entry(debug_info, 1); - - rb_str_catf(mesg, ", created at %"PRIsVALUE":%"PRIsVALUE, path, line); + int created_line; + VALUE created_path = get_created_info(frozen_obj, &created_line); + if (!NIL_P(created_path)) { + rb_str_catf(mesg, ", created at %"PRIsVALUE":%d", created_path, created_line); } rb_exc_raise(exc); } +void +rb_warn_unchilled_literal(VALUE obj) +{ + rb_warning_category_t category = RB_WARN_CATEGORY_DEPRECATED; + if (!NIL_P(ruby_verbose) && rb_warning_category_enabled_p(category)) { + int line; + VALUE file = rb_source_location(&line); + VALUE mesg = NIL_P(file) ? rb_str_new(0, 0) : rb_str_dup(file); + + if (!NIL_P(file)) { + if (line) rb_str_catf(mesg, ":%d", line); + rb_str_cat2(mesg, ": "); + } + rb_str_cat2(mesg, "warning: literal string will be frozen in the future"); + + VALUE str = obj; + if (STR_SHARED_P(str)) { + str = RSTRING(obj)->as.heap.aux.shared; + } + VALUE created = get_created_info(str, &line); + if (NIL_P(created)) { + rb_str_cat2(mesg, " (run with --debug-frozen-string-literal for more information)\n"); + } + else { + rb_str_cat2(mesg, "\n"); + rb_str_append(mesg, created); + if (line) rb_str_catf(mesg, ":%d", line); + rb_str_cat2(mesg, ": info: the string was created here\n"); + } + rb_warn_category(mesg, rb_warning_category_to_name(category)); + } +} + +void +rb_warn_unchilled_symbol_to_s(VALUE obj) +{ + rb_category_warn( + RB_WARN_CATEGORY_DEPRECATED, + "string returned by :%s.to_s will be frozen in the future", RSTRING_PTR(obj) + ); +} + #undef rb_check_frozen void rb_check_frozen(VALUE obj) { - rb_check_frozen_internal(obj); + rb_check_frozen_inline(obj); } void rb_check_copyable(VALUE obj, VALUE orig) { if (!FL_ABLE(obj)) return; - rb_check_frozen_internal(obj); + rb_check_frozen(obj); if (!FL_ABLE(orig)) return; } void Init_syserr(void) { - rb_eNOERROR = set_syserr(0, "NOERROR"); + rb_eNOERROR = setup_syserr(0, "NOERROR"); +#if 0 + /* No error */ + rb_define_const(rb_mErrno, "NOERROR", rb_eNOERROR); +#endif #define defined_error(name, num) set_syserr((num), (name)); -#define undefined_error(name) set_syserr(0, (name)); +#define undefined_error(name) rb_define_const(rb_mErrno, (name), rb_eNOERROR); #include "known_errors.inc" #undef defined_error #undef undefined_error |