rbs 3.8.0 → 3.9.0.dev.1

data/core/kernel.rbs

@@ -936,16 +936,37 @@ module Kernel : BasicObject
   #
   # See [Messages](rdoc-ref:exceptions.md@Messages).
   #
-  # Argument `backtrace` sets the stored backtrace in the new exception, which may
-  # be retrieved by method Exception#backtrace; the backtrace must be an array of
-  # strings or `nil`:
+  # Argument `backtrace` might be used to modify the backtrace of the new
+  # exception, as reported by Exception#backtrace and
+  # Exception#backtrace_locations; the backtrace must be an array of
+  # Thread::Backtrace::Location, an array of strings, a single string, or `nil`.
+  #
+  # Using the array of Thread::Backtrace::Location instances is the most
+  # consistent option and should be preferred when possible. The necessary value
+  # might be obtained from #caller_locations, or copied from
+  # Exception#backtrace_locations of another error:
   #
   #     begin
-  #       raise(StandardError, 'Boom', %w[foo bar baz])
-  #     rescue => x
-  #       p x.backtrace
+  #       do_some_work()
+  #     rescue ZeroDivisionError => ex
+  #       raise(LogicalError, "You have an error in your math", ex.backtrace_locations)
+  #     end
+  #
+  # The ways, both Exception#backtrace and Exception#backtrace_locations of the
+  # raised error are set to the same backtrace.
+  #
+  # 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 Exception#backtrace is set:
+  #
+  #     begin
+  #       raise(StandardError, 'Boom', %w[dsl.rb:3 framework.rb:1])
+  #     rescue => ex
+  #       p ex.backtrace
+  #       # => ["dsl.rb:3", "framework.rb:1"]
+  #       p ex.backtrace_locations
+  #       # => nil
   #     end
-  #     # => ["foo", "bar", "baz"]
   #
   # If argument `backtrace` is not given, the backtrace is set according to an
   # array of Thread::Backtrace::Location objects, as derived from the call stack.
@@ -1021,16 +1042,37 @@ module Kernel : BasicObject
   #
   # See [Messages](rdoc-ref:exceptions.md@Messages).
   #
-  # Argument `backtrace` sets the stored backtrace in the new exception, which may
-  # be retrieved by method Exception#backtrace; the backtrace must be an array of
-  # strings or `nil`:
+  # Argument `backtrace` might be used to modify the backtrace of the new
+  # exception, as reported by Exception#backtrace and
+  # Exception#backtrace_locations; the backtrace must be an array of
+  # Thread::Backtrace::Location, an array of strings, a single string, or `nil`.
+  #
+  # Using the array of Thread::Backtrace::Location instances is the most
+  # consistent option and should be preferred when possible. The necessary value
+  # might be obtained from #caller_locations, or copied from
+  # Exception#backtrace_locations of another error:
   #
   #     begin
-  #       raise(StandardError, 'Boom', %w[foo bar baz])
-  #     rescue => x
-  #       p x.backtrace
+  #       do_some_work()
+  #     rescue ZeroDivisionError => ex
+  #       raise(LogicalError, "You have an error in your math", ex.backtrace_locations)
+  #     end
+  #
+  # The ways, both Exception#backtrace and Exception#backtrace_locations of the
+  # raised error are set to the same backtrace.
+  #
+  # 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 Exception#backtrace is set:
+  #
+  #     begin
+  #       raise(StandardError, 'Boom', %w[dsl.rb:3 framework.rb:1])
+  #     rescue => ex
+  #       p ex.backtrace
+  #       # => ["dsl.rb:3", "framework.rb:1"]
+  #       p ex.backtrace_locations
+  #       # => nil
   #     end
-  #     # => ["foo", "bar", "baz"]
   #
   # If argument `backtrace` is not given, the backtrace is set according to an
   # array of Thread::Backtrace::Location objects, as derived from the call stack.
@@ -1121,7 +1163,7 @@ module Kernel : BasicObject
   # The style of programming using `$_` as an implicit parameter is gradually
   # losing favor in the Ruby community.
   #
-  def self?.gets: (?String arg0, ?Integer arg1) -> String?
+  def self?.gets: (?String sep, ?Integer limit, ?chomp: boolish) -> String?
 
   # <!--
   #   rdoc-file=eval.c
@@ -1444,7 +1486,7 @@ module Kernel : BasicObject
   # Optional keyword argument `chomp` specifies whether line separators are to be
   # omitted.
   #
-  def self?.readline: (?String arg0, ?Integer arg1) -> String
+  def self?.readline: (?String arg0, ?Integer arg1, ?chomp: boolish) -> String
 
   # <!--
   #   rdoc-file=io.c

data/core/method.rbs

@@ -54,7 +54,7 @@ class Method
   #
   def hash: () -> Integer
 
-  def dup: () -> instance
+  def dup: () -> self
 
   # <!--
   #   rdoc-file=proc.c
@@ -252,7 +252,7 @@ class Method
   #     m.call # => "bar"
   #     n = m.clone.call # => "bar"
   #
-  def clone: () -> instance
+  def clone: () -> self
 
   # <!--
   #   rdoc-file=proc.c

data/core/module.rbs

@@ -731,8 +731,8 @@ class Module < Object
   #     I'm Dino!
   #     #<B:0x401b39e8>
   #
-  def define_method: (interned symbol, ^() [self: instance] -> untyped | Method | UnboundMethod method) -> Symbol
-                   | (interned symbol) { () [self: instance] -> untyped } -> Symbol
+  def define_method: (interned symbol, ^() [self: self] -> untyped | Method | UnboundMethod method) -> Symbol
+                   | (interned symbol) { () [self: self] -> untyped } -> Symbol
 
   # <!--
   #   rdoc-file=object.c
@@ -1164,7 +1164,7 @@ class Module < Object
   # -->
   # Returns the name of the module *mod*.  Returns `nil` for anonymous modules.
   #
-  def name: () -> String?
+  def name: %a{implicitly-returns-nil} () -> String
 
   # <!--
   #   rdoc-file=eval.c

data/core/proc.rbs

@@ -376,8 +376,8 @@ class Proc
   #
   def self.new: () { (?) -> untyped } -> instance
 
-  def clone: () -> instance
-  def dup: () -> instance
+  def clone: () -> self
+  def dup: () -> self
 
   # <!-- rdoc-file=proc.c -->
   # Invokes the block, setting the block's parameters to the values in *params*

data/core/ractor.rbs

@@ -603,7 +603,7 @@ class Ractor
   #       }
   #     }.map(&:value).uniq.size #=> 1 and f() is called only once
   #
-  def self.store_if_absent: (Symbol) { () -> untyped } -> untyped
+  def self.store_if_absent: [A] (Symbol) { (nil) -> A } -> A
 
   # <!--
   #   rdoc-file=ractor.rb
@@ -1053,6 +1053,9 @@ class Ractor
   #     end
   #
   class RemoteError < Ractor::Error
+    # <!-- rdoc-file=ractor.rb -->
+    # The Ractor an uncaught exception is raised in.
+    #
     def ractor: () -> Ractor
   end
 

data/core/rbs/unnamed/argf.rbs

@@ -639,7 +639,7 @@ module RBS
       # See IO.readlines for details about getline_args.
       #
       %a{annotate:rdoc:copy:ARGF#gets}
-      def gets: (?String sep, ?Integer limit) -> String?
+      def gets: (?String sep, ?Integer limit, ?chomp: boolish) -> String?
 
       # <!--
       #   rdoc-file=io.c
@@ -1024,7 +1024,7 @@ module RBS
       # An EOFError is raised at the end of the file.
       #
       %a{annotate:rdoc:copy:ARGF#readline}
-      def readline: (?String sep, ?Integer limit) -> String
+      def readline: (?String sep, ?Integer limit, ?chomp: boolish) -> String
 
       # <!--
       #   rdoc-file=io.c
@@ -1044,7 +1044,7 @@ module RBS
       # See `IO.readlines` for a full description of all options.
       #
       %a{annotate:rdoc:copy:ARGF#readlines}
-      def readlines: (?String sep, ?Integer limit) -> ::Array[String]
+      def readlines: (?String sep, ?Integer limit, ?chomp: boolish) -> ::Array[String]
 
       # <!--
       #   rdoc-file=io.c

data/core/regexp.rbs

@@ -836,8 +836,10 @@
 # These are also commonly used:
 #
 # *   `/\p{Emoji}/`: Unicode emoji.
-# *   `/\p{Graph}/`: Non-blank character (excludes spaces, control characters,
-#     and similar).
+# *   `/\p{Graph}/`: Characters excluding `/\p{Cntrl}/` and `/\p{Space}/`. Note
+#     that invisible characters under the Unicode
+#     ["Format"](https://www.compart.com/en/unicode/category/Cf) category are
+#     included.
 # *   `/\p{Word}/`: A member in one of these Unicode character categories (see
 #     below) or having one of these Unicode properties:
 #

data/core/ruby_vm.rbs

@@ -688,14 +688,14 @@ module RubyVM::YJIT
   # Enable YJIT compilation. `stats` option decides whether to enable YJIT stats
   # or not. `compilation_log` decides
   # whether to enable YJIT compilation logging or not.
-  # `stats`:
-  # * `false`: Don't enable stats.
-  # * `true`: Enable stats. Print stats at exit.
-  # * `:quiet`: Enable stats. Do not print stats at exit.
-  # `log`:
-  # * `false`: Don't enable the log.
-  # * `true`: Enable the log. Print log at exit.
-  # * `:quiet`: Enable the log. Do not print log at exit.
+  # *   `stats`:
+  #     *   `false`: Don't enable stats.
+  #     *   `true`: Enable stats. Print stats at exit.
+  #     *   `:quiet`: Enable stats. Do not print stats at exit.
+  # *   `log`:
+  #     *   `false`: Don't enable the log.
+  #     *   `true`: Enable the log. Print log at exit.
+  #     *   `:quiet`: Enable the log. Do not print log at exit.
   #
   def self.enable: (?stats: false | true | :quiet) -> void
 

data/core/rubygems/version.rbs

@@ -221,7 +221,7 @@ module Gem
     #
     # Pre-release (alpha) parts, e.g, 5.3.1.b.2 => 5.4, are ignored.
     #
-    def bump: () -> instance
+    def bump: () -> self
 
     # <!--
     #   rdoc-file=lib/rubygems/version.rb
@@ -274,7 +274,7 @@ module Gem
     # The release for this version (e.g. 1.2.0.a -> 1.2.0). Non-prerelease versions
     # return themselves.
     #
-    def release: () -> instance
+    def release: () -> self
 
     # <!--
     #   rdoc-file=lib/rubygems/version.rb

data/core/string.rbs

@@ -1936,7 +1936,7 @@ class String
     ?crlf_newline: boolish,
     ?lf_newline: boolish,
     ?fallback: ^(String) -> string? | Method | _EncodeFallbackAref
-  ) -> instance
+  ) -> self
 
   interface _EncodeFallbackAref
     def []: (String) -> string?

data/core/time.rbs

@@ -1629,7 +1629,7 @@ class Time < Object
   #
   # You must require 'time' to use this method.
   #
-  def xmlschema: () -> String
+  def xmlschema: (?Integer fraction_digits) -> String
 
   # <!--
   #   rdoc-file=time.c

data/core/unbound_method.rbs

@@ -100,7 +100,7 @@ class UnboundMethod
   #     m.call # => "bar"
   #     n = m.clone.call # => "bar"
   #
-  def clone: () -> instance
+  def clone: () -> self
 
   # <!--
   #   rdoc-file=proc.c

data/docs/syntax.md

@@ -289,7 +289,9 @@ The following `class`/`instance` types are allowed.
 class Foo
   attr_reader parent: class
 
-  def foo: () -> instance
+  def foo: () -> instance # behaves like `self` in this context
+
+  def self?.bar: () -> instance # behaves like `class` for `def self.bar()` and `self` for `def bar()`
 
   @@foos: Array[instance]
 
@@ -405,9 +407,12 @@ _ivar-member_ ::= _ivar-name_ `:` _type_
                 | `self` `.` _ivar-name_ `:` _type_
                 | _cvar-name_ `:` _type_
 
-_method-member_ ::= _visibility_ `def` _method-name_ `:` _method-types_            # Instance method
-                  | _visibility_ `def self.` _method-name_ `:` _method-types_      # Singleton method
-                  | `def self?.` _method-name_ `:` _method-types_     # Singleton and instance method
+_method-member_ ::= _method-class-member_
+                  | _method-interface-member_
+_method-class-member_ ::= _visibility_ `def` _method-name_ `:` _method-types_            # Instance method
+                        | _visibility_ `def self.` _method-name_ `:` _method-types_      # Singleton method
+                        | `def self?.` _method-name_ `:` _method-types_                  # Singleton and instance method
+_method-interface-member_ ::= `def` _method-name_ `:` _method-types_                     # Instance method
 
 _method-types_ ::= _method-type-parameters_ _method-type_                       # Single method type
                  | _method-type-parameters_ _method-type_ `|` _method-types_    # Overloading types
@@ -624,7 +629,7 @@ _module-self-types_ ::= _class-name_ _type-arguments_ `,` _module-self-types_
 
 _interface-decl_ ::= `interface` _interface-name_ _module-type-parameters_ _interface-members_ `end`
 
-_interface-members_ ::= _method-member_              # Method
+_interface-members_ ::= _method-interface-member_    # Method
                       | _include-interface-member_   # Mixin (include)
                       | _alias-member_               # Alias
 

data/ext/rbs_extension/extconf.rb

@@ -4,10 +4,11 @@ $INCFLAGS << " -I$(top_srcdir)" if $extmk
 $INCFLAGS << " -I$(srcdir)/../../include"
 
 $VPATH << "$(srcdir)/../../src"
+$VPATH << "$(srcdir)/../../src/util"
 $VPATH << "$(srcdir)/ext/rbs_extension"
 
 root_dir = File.expand_path('../../../', __FILE__)
-$srcs = Dir.glob("#{root_dir}/src/*.c") +
+$srcs = Dir.glob("#{root_dir}/src/**/*.c") +
         Dir.glob("#{root_dir}/ext/rbs_extension/*.c")
 
 append_cflags ['-std=gnu99']

data/ext/rbs_extension/location.c

@@ -56,14 +56,14 @@ static void check_children_cap(rbs_loc *loc) {
   }
 }
 
-void rbs_loc_add_required_child(rbs_loc *loc, ID name, range r) {
+void rbs_loc_add_required_child(rbs_loc *loc, rbs_constant_id_t name, range r) {
   rbs_loc_add_optional_child(loc, name, r);
 
   unsigned short last_index = loc->children->len - 1;
   loc->children->required_p |= 1 << last_index;
 }
 
-void rbs_loc_add_optional_child(rbs_loc *loc, ID name, range r) {
+void rbs_loc_add_optional_child(rbs_loc *loc, rbs_constant_id_t name, range r) {
   check_children_cap(loc);
 
   unsigned short i = loc->children->len++;
@@ -168,6 +168,15 @@ static VALUE location_end_pos(VALUE self) {
   return INT2FIX(loc->rg.end);
 }
 
+static rbs_constant_id_t rbs_constant_pool_insert_ruby_symbol(VALUE symbol) {
+  VALUE name = rb_sym2str(symbol);
+
+  // Constants inserted here will never be freed, but that's acceptable because:
+  // 1. Most symbols passed into here will be the ones already inserted into the constant pool by `parser.c`.
+  // 2. Methods like `add_required_child` and `add_optional_child` will usually only get called with a few different symbols.
+  return rbs_constant_pool_insert_constant(RBS_GLOBAL_CONSTANT_POOL, (const uint8_t *) RSTRING_PTR(name), RSTRING_LEN(name));
+}
+
 static VALUE location_add_required_child(VALUE self, VALUE name, VALUE start, VALUE end) {
   rbs_loc *loc = rbs_check_location(self);
 
@@ -175,7 +184,7 @@ static VALUE location_add_required_child(VALUE self, VALUE name, VALUE start, VA
   rg.start = rbs_loc_position(FIX2INT(start));
   rg.end = rbs_loc_position(FIX2INT(end));
 
-  rbs_loc_add_required_child(loc, SYM2ID(name), rg);
+  rbs_loc_add_required_child(loc, rbs_constant_pool_insert_ruby_symbol(name), rg);
 
   return Qnil;
 }
@@ -187,7 +196,7 @@ static VALUE location_add_optional_child(VALUE self, VALUE name, VALUE start, VA
   rg.start = rbs_loc_position(FIX2INT(start));
   rg.end = rbs_loc_position(FIX2INT(end));
 
-  rbs_loc_add_optional_child(loc, SYM2ID(name), rg);
+  rbs_loc_add_optional_child(loc, rbs_constant_pool_insert_ruby_symbol(name), rg);
 
   return Qnil;
 }
@@ -195,7 +204,7 @@ static VALUE location_add_optional_child(VALUE self, VALUE name, VALUE start, VA
 static VALUE location_add_optional_no_child(VALUE self, VALUE name) {
   rbs_loc *loc = rbs_check_location(self);
 
-  rbs_loc_add_optional_child(loc, SYM2ID(name), NULL_RANGE);
+  rbs_loc_add_optional_child(loc, rbs_constant_pool_insert_ruby_symbol(name), NULL_RANGE);
 
   return Qnil;
 }
@@ -218,12 +227,18 @@ static VALUE rbs_new_location_from_loc_range(VALUE buffer, rbs_loc_range rg) {
   return obj;
 }
 
+static rbs_constant_id_t rbs_constant_pool_find_ruby_symbol(VALUE symbol) {
+  VALUE name = rb_sym2str(symbol);
+
+  return rbs_constant_pool_find(RBS_GLOBAL_CONSTANT_POOL, (const uint8_t *) RSTRING_PTR(name), RSTRING_LEN(name));
+}
+
 static VALUE location_aref(VALUE self, VALUE name) {
   rbs_loc *loc = rbs_check_location(self);
 
-  ID id = SYM2ID(name);
+  rbs_constant_id_t id = rbs_constant_pool_find_ruby_symbol(name);
 
-  if (loc->children != NULL) {
+  if (loc->children != NULL && id != RBS_CONSTANT_ID_UNSET) {
     for (unsigned short i = 0; i < loc->children->len; i++) {
       if (loc->children->entries[i].name == id) {
         rbs_loc_range result = loc->children->entries[i].rg;
@@ -241,6 +256,10 @@ static VALUE location_aref(VALUE self, VALUE name) {
   rb_raise(rb_eRuntimeError, "Unknown child name given: %s", RSTRING_PTR(string));
 }
 
+static VALUE rbs_constant_to_ruby_symbol(rbs_constant_t *constant) {
+  return ID2SYM(rb_intern2((const char *) constant->start, constant->length));
+}
+
 static VALUE location_optional_keys(VALUE self) {
   VALUE keys = rb_ary_new();
 
@@ -252,8 +271,9 @@ static VALUE location_optional_keys(VALUE self) {
 
   for (unsigned short i = 0; i < children->len; i++) {
     if (RBS_LOC_OPTIONAL_P(loc, i)) {
-      rb_ary_push(keys, ID2SYM(children->entries[i].name));
-
+      rbs_constant_t *key_id = rbs_constant_pool_id_to_constant(RBS_GLOBAL_CONSTANT_POOL, children->entries[i].name);
+      VALUE key_sym = rbs_constant_to_ruby_symbol(key_id);
+      rb_ary_push(keys, key_sym);
     }
   }
 
@@ -271,7 +291,9 @@ static VALUE location_required_keys(VALUE self) {
 
   for (unsigned short i = 0; i < children->len; i++) {
     if (RBS_LOC_REQUIRED_P(loc, i)) {
-      rb_ary_push(keys, ID2SYM(children->entries[i].name));
+      rbs_constant_t *key_id = rbs_constant_pool_id_to_constant(RBS_GLOBAL_CONSTANT_POOL, children->entries[i].name);
+      VALUE key_sym = rbs_constant_to_ruby_symbol(key_id);
+      rb_ary_push(keys, key_sym);
     }
   }
 

data/ext/rbs_extension/location.h

@@ -3,6 +3,7 @@
 
 #include "ruby.h"
 #include "lexer.h"
+#include "rbs/util/rbs_constant_pool.h"
 
 /**
  * RBS::Location class
@@ -15,7 +16,7 @@ typedef struct {
 } rbs_loc_range;
 
 typedef struct {
-  ID name;
+  rbs_constant_id_t name;
   rbs_loc_range rg;
 } rbs_loc_entry;
 
@@ -58,14 +59,14 @@ void rbs_loc_alloc_children(rbs_loc *loc, unsigned short cap);
  *
  * Allocate memory for children with rbs_loc_alloc_children before calling this function.
  * */
-void rbs_loc_add_required_child(rbs_loc *loc, ID name, range r);
+void rbs_loc_add_required_child(rbs_loc *loc, rbs_constant_id_t name, range r);
 
 /**
  * Add an optional child range with given name.
  *
  * Allocate memory for children with rbs_loc_alloc_children before calling this function.
  * */
-void rbs_loc_add_optional_child(rbs_loc *loc, ID name, range r);
+void rbs_loc_add_optional_child(rbs_loc *loc, rbs_constant_id_t name, range r);
 
 /**
  * Returns RBS::Location object with start/end positions.

data/ext/rbs_extension/main.c

@@ -1,12 +1,33 @@
 #include "rbs_extension.h"
+#include "rbs/util/rbs_constant_pool.h"
+
+#include "ruby/vm.h"
+
+static
+void Deinit_rbs_extension(ruby_vm_t *_) {
+  rbs_constant_pool_free(RBS_GLOBAL_CONSTANT_POOL);
+}
 
 void
 Init_rbs_extension(void)
 {
 #ifdef HAVE_RB_EXT_RACTOR_SAFE
   rb_ext_ractor_safe(true);
-#endif  
+#endif
   rbs__init_constants();
   rbs__init_location();
   rbs__init_parser();
+
+  // Calculated based on the number of unique strings used with the `INTERN` macro in `parser.c`.
+  //
+  // ```bash
+  // grep -o 'INTERN("\([^"]*\)")' ext/rbs_extension/parser.c \
+  //     | sed 's/INTERN("\(.*\)")/\1/' \
+  //     | sort -u \
+  //     | wc -l
+  // ```
+  const size_t num_uniquely_interned_strings = 26;
+  rbs_constant_pool_init(RBS_GLOBAL_CONSTANT_POOL, num_uniquely_interned_strings);
+
+  ruby_vm_at_exit(Deinit_rbs_extension);
 }