diff options
Diffstat (limited to 'warning.rb')
| -rw-r--r-- | warning.rb | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/warning.rb b/warning.rb new file mode 100644 index 0000000000..625dd9506b --- /dev/null +++ b/warning.rb @@ -0,0 +1,59 @@ +# encoding: utf-8 +# frozen-string-literal: true + +module Kernel + module_function + + # call-seq: + # warn(*msgs, uplevel: nil, category: nil) -> nil + # + # If warnings have been disabled (for example with the + # <code>-W0</code> flag), does nothing. Otherwise, + # converts each of the messages to strings, appends a newline + # character to the string if the string does not end in a newline, + # and calls Warning.warn with the string. + # + # warn("warning 1", "warning 2") + # + # <em>produces:</em> + # + # warning 1 + # warning 2 + # + # If the <code>uplevel</code> keyword argument is given, the string will + # be prepended with information for the given caller frame in + # the same format used by the <code>rb_warn</code> C function. + # + # # In baz.rb + # def foo + # warn("invalid call to foo", uplevel: 1) + # end + # + # def bar + # foo + # end + # + # bar + # + # <em>produces:</em> + # + # baz.rb:6: warning: invalid call to foo + # + # If <code>category</code> keyword argument is given, passes the category + # to <code>Warning.warn</code>. The category given must be one of the + # following categories: + # + # :deprecated :: Used for warning for deprecated functionality that may + # be removed in the future. + # :experimental :: Used for experimental features that may change in + # future releases. + # :performance :: Used for warning about APIs or pattern that have + # negative performance impact + def warn(*msgs, uplevel: nil, category: nil) + if Primitive.cexpr!("NIL_P(category)") + Primitive.rb_warn_m(msgs, uplevel, nil) + elsif Warning[category = Primitive.cexpr!("rb_to_symbol_type(category)")] + Primitive.rb_warn_m(msgs, uplevel, category) + end + end +end |