rbs 3.5.3 → 3.6.0.pre.1

data/core/thread.rbs

@@ -382,7 +382,7 @@ class Thread < Object
   # If you're going to subclass Thread, be sure to call super in your `initialize`
   # method, otherwise a ThreadError will be raised.
   #
-  def initialize: (*untyped) { (*untyped) -> void } -> void
+  def initialize: (*untyped) { (?) -> void } -> void
 
   # <!--
   #   rdoc-file=thread.c
@@ -1178,7 +1178,7 @@ class Thread < Object
   # calling `start` in that subclass will not invoke the subclass's `initialize`
   # method.
   #
-  def self.start: (*untyped args) { (*untyped) -> void } -> instance
+  def self.start: (*untyped args) { (?) -> void } -> instance
 
   # <!--
   #   rdoc-file=thread.c
@@ -1545,7 +1545,7 @@ end
 #
 #     consumer.join
 #
-class Thread::Queue < Object
+class Thread::Queue[Elem = untyped] < Object
   # <!-- rdoc-file=thread_sync.c -->
   # Pushes the given `object` to the queue.
   #
@@ -1661,7 +1661,7 @@ class Thread::Queue < Object
   # If `timeout` seconds have passed and no data is available `nil` is returned.
   # If `timeout` is `0` it returns immediately.
   #
-  def pop: (?boolish non_block, ?timeout: _ToF?) -> untyped
+  def pop: (?boolish non_block, ?timeout: _ToF?) -> Elem?
 
   # <!--
   #   rdoc-file=thread_sync.c
@@ -1671,7 +1671,7 @@ class Thread::Queue < Object
   # -->
   # Pushes the given `object` to the queue.
   #
-  def push: (untyped obj) -> void
+  def push: (Elem obj) -> void
 
   # <!--
   #   rdoc-file=thread_sync.rb
@@ -1692,7 +1692,7 @@ end
 #
 # See Thread::Queue for an example of how a Thread::SizedQueue works.
 #
-class Thread::SizedQueue < Thread::Queue
+class Thread::SizedQueue[Elem = untyped] < Thread::Queue[Elem]
   # <!--
   #   rdoc-file=thread_sync.rb
   #   - <<(object, non_block = false, timeout: nil)
@@ -1755,7 +1755,8 @@ class Thread::SizedQueue < Thread::Queue
   # If `timeout` seconds have passed and no space is available `nil` is returned.
   # If `timeout` is `0` it returns immediately. Otherwise it returns `self`.
   #
-  def push: (untyped obj, ?boolish non_block, timeout: _ToF?) -> void
+  def push: (Elem obj, ?boolish non_block) -> void
+          | (Elem obj, timeout: _ToF?) -> self?
 end
 
 class ConditionVariable = Thread::ConditionVariable

data/core/trace_point.rbs

@@ -63,7 +63,7 @@
 # `:script_compiled`
 # :   new Ruby code compiled (with `eval`, `load` or `require`)
 #
-class TracePoint < Object
+class TracePoint
   # <!--
   #   rdoc-file=trace_point.rb
   #   - TracePoint.new(*events) { |obj| block }         -> obj
@@ -110,7 +110,7 @@ class TracePoint < Object
   #
   # Access from other threads is also forbidden.
   #
-  def initialize: (*Symbol events) { (TracePoint tp) -> void } -> void
+  def self.new: (*_ToSym events) { (instance tp) -> void } -> instance
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -172,7 +172,7 @@ class TracePoint < Object
   # (note that we needed to filter out calls by itself from :line handler,
   # otherwise it will call itself infinitely).
   #
-  def self.allow_reentry: () { () -> void } -> void
+  def self.allow_reentry: [T] () { (nil) -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -199,7 +199,7 @@ class TracePoint < Object
   #
   #     trace.enabled? #=> true
   #
-  def self.trace: (*Symbol events) { (TracePoint tp) -> void } -> TracePoint
+  def self.trace: (*_ToSym events) { (instance tp) -> void } -> instance
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -218,7 +218,7 @@ class TracePoint < Object
   # -->
   # Return the called name of the method being called
   #
-  def callee_id: () -> Symbol
+  def callee_id: () -> Symbol?
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -257,7 +257,7 @@ class TracePoint < Object
   #       C.foo
   #     end
   #
-  def defined_class: () -> Module
+  def defined_class: () -> (Class | Module)?
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -293,7 +293,7 @@ class TracePoint < Object
   #     #=> RuntimeError: access from outside
   #
   def disable: () -> bool
-             | () { () -> void } -> void
+             | [T] () { () -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -352,8 +352,8 @@ class TracePoint < Object
   #     trace.enable { p tp.lineno }
   #     #=> RuntimeError: access from outside
   #
-  def enable:     (?target: (Method | UnboundMethod | Proc)?, ?target_line: Integer?, ?target_thread: Thread?) -> bool
-            | [R] (?target: (Method | UnboundMethod | Proc)?, ?target_line: Integer?, ?target_thread: Thread?) { () -> R } -> R
+  def enable: (?target: Method | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) -> bool
+            | [T] (?target: Method | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) { () -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -395,7 +395,7 @@ class TracePoint < Object
   # -->
   # Return the name at the definition of the method being called
   #
-  def method_id: () -> Symbol
+  def method_id: () -> Symbol?
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -412,7 +412,7 @@ class TracePoint < Object
   # Return the parameters definition of the method or block that the current hook
   # belongs to. Format is the same as for Method#parameters
   #
-  def parameters: () -> ::Array[[ :req | :opt | :rest | :keyreq | :key | :keyrest | :block, Symbol ] | [ :rest | :keyrest ]]
+  def parameters: () -> Method::param_types?
 
   # <!--
   #   rdoc-file=trace_point.rb
@@ -421,7 +421,7 @@ class TracePoint < Object
   # Value from exception raised on the `:raise` event, or rescued on the `:rescue`
   # event.
   #
-  def raised_exception: () -> untyped
+  def raised_exception: () -> Exception
 
   # <!--
   #   rdoc-file=trace_point.rb

data/core/unbound_method.rbs

@@ -325,5 +325,5 @@ class UnboundMethod
   # arguments. This is semantically equivalent to `umeth.bind(recv).call(args,
   # ...)`.
   #
-  def bind_call: (untyped recv, *untyped, **untyped) ?{ (*untyped, **untyped) -> untyped } -> untyped
+  def bind_call: (untyped recv, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
 end

data/docs/syntax.md

@@ -64,7 +64,7 @@ Interface type denotes _type of a value which can be a subtype of the interface_
 
 ```rbs
 _ToS                          # _ToS interface
-::MyApp::_Each[String]        # Interface name with namespace and type application
+::Enumerator::_Each[String]   # Interface name with namespace and type application
 ```
 
 ### Alias type
@@ -424,8 +424,10 @@ _visibility_ ::= `public` | `private`
 
 _attribute-type_ ::= `attr_reader` | `attr_writer` | `attr_accessor`
 
-_include-member_ ::= `include` _class-name_ _type-arguments_
-                   | `include` _interface-name_ _type-arguments_
+_include-member_ ::= _include-class-member_
+                   | _include-interface-member_
+_include-class-member_ ::= `include` _class-name_ _type-arguments_
+_include-interface-member_ :== `include` _interface-name_ _type-arguments_
 _extend-member_ ::= `extend` _class-name_ _type-arguments_
                   | `extend` _interface-name_ _type-arguments_
 _prepend-member_ ::= `prepend` _class-name_ _type-arguments_
@@ -621,7 +623,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
-                      | _include-member_             # Mixin (include)
+                      | _include-interface-member_   # Mixin (include)
                       | _alias-member_               # Alias
 
 _type-alias-decl_ ::= `type` _alias-name_ _module-type-parameters_ `=` _type_
@@ -750,16 +752,15 @@ $LOAD_PATH: Array[String]
 ### Generics
 
 ```markdown
-_module-type-parameter_ ::= _generics-unchecked_ _generics-variance_ _type-variable_ _generics-bound_
+_module-type-parameter_ ::= _generics-unchecked_ _generics-variance_ _type-variable_ _generics-bound_ _default-type_
 
 _method-type-param_ ::= _type-variable_ _generics-bound_
 
-_generics-bound_ ::=                       (No type bound)
-                   | `<` _bound-type_      (The generics parameter is bounded)
+_generics-bound_ ::=                 (No type bound)
+                   | `<` _type_      (The generics parameter is bounded)
 
-_bound-type_ ::= _class-name_ _type-arguments_       (Class instance type)
-               | _interface-name_ _type-arguments_   (Interface type)
-               | `singleton(` _class-name_ `)`       (Class singleton type)
+_default-type_ ::=                    (No default type)
+                 | `=` _type_         (The generics parameter has default type)
 
 _generics-variance_ ::=               (Invariant)
                       | `out`         (Covariant)
@@ -826,14 +827,27 @@ class PrettyPrint[T < _Output]
 end
 ```
 
-If a type parameter has an upper bound, the type parameter must be instantiated with types that is a subclass of the upper bound.
+If a type parameter has an upper bound, the type parameter must be instantiated with types that is a subtype of the upper bound.
 
 ```rbs
 type str_printer = PrettyPrint[String]    # OK
 type int_printer = PrettyPrint[Integer]   # Type error
 ```
 
-The upper bound must be one of a class instance type, interface type, or class singleton type.
+The generics type parameter of modules, classes, interfaces, or type aliases can have a default type.
+
+```rbs
+interface _Foo[T = untyped]
+end
+
+interface _Bar[T, S = untyped]
+end
+
+type foo = _Foo          # equivalent to _Foo[untyped]
+type bar = _Bar[String]  # equivalent to _Bar[String, untyped]
+```
+
+Type parameters with default types cannot appear before type parameters without default types. The generic method type parameters cannot have the default types.
 
 ### Directives
 

data/ext/rbs_extension/lexer.c

@@ -116,7 +116,7 @@ token rbsparser_next_token(lexstate *state) {
 yy1:
 	rbs_skip(state);
 #line 144 "ext/rbs_extension/lexer.re"
-	{ return next_token(state, pEOF); }
+	{ return next_eof_token(state); }
 #line 121 "ext/rbs_extension/lexer.c"
 yy2:
 	rbs_skip(state);

data/ext/rbs_extension/lexer.h

@@ -167,6 +167,11 @@ void skipn(lexstate *state, size_t size);
  * */
 token next_token(lexstate *state, enum TokenType type);
 
+/**
+ * Return new token with EOF type.
+ * */
+token next_eof_token(lexstate *state);
+
 token rbsparser_next_token(lexstate *state);
 
 void print_token(token tok);

data/ext/rbs_extension/lexer.re

@@ -141,7 +141,7 @@ token rbsparser_next_token(lexstate *state) {
       skip = ([ \t]+|[\r\n]);
 
       skip     { return next_token(state, tTRIVIA); }
-      "\x00"   { return next_token(state, pEOF); }
+      "\x00"   { return next_eof_token(state); }
       *        { return next_token(state, ErrorToken); }
   */
 }

data/ext/rbs_extension/lexstate.c

@@ -129,6 +129,22 @@ token next_token(lexstate *state, enum TokenType type) {
   return t;
 }
 
+token next_eof_token(lexstate *state) {
+  if (state->current.byte_pos == RSTRING_LEN(state->string)+1) {
+    // End of String
+    token t;
+    t.type = pEOF;
+    t.range.start = state->start;
+    t.range.end = state->start;
+    state->start = state->current;
+
+    return t;
+  } else {
+    // NULL byte in the middle of the string
+    return next_token(state, pEOF);
+  }
+}
+
 void rbs_skip(lexstate *state) {
   if (!state->last_char) {
     peek(state);

data/ext/rbs_extension/location.c

@@ -3,7 +3,9 @@
 #define RBS_LOC_REQUIRED_P(loc, i) ((loc)->children->required_p & (1 << (i)))
 #define RBS_LOC_OPTIONAL_P(loc, i) (!RBS_LOC_REQUIRED_P((loc), (i)))
 #define RBS_LOC_CHILDREN_SIZE(cap) (sizeof(rbs_loc_children) + sizeof(rbs_loc_entry) * ((cap) - 1))
+#define NULL_LOC_RANGE_P(rg) ((rg).start == -1)
 
+rbs_loc_range RBS_LOC_NULL_RANGE = { -1, -1 };
 VALUE RBS_Location;
 
 position rbs_loc_position(int char_pos) {
@@ -16,6 +18,11 @@ position rbs_loc_position3(int char_pos, int line, int column) {
   return pos;
 }
 
+rbs_loc_range rbs_new_loc_range(range rg) {
+  rbs_loc_range r = { rg.start.char_pos, rg.end.char_pos };
+  return r;
+}
+
 static void check_children_max(unsigned short n) {
   size_t max = sizeof(rbs_loc_entry_bitmap) * 8;
   if (n > max) {
@@ -51,7 +58,7 @@ void rbs_loc_add_required_child(rbs_loc *loc, ID name, range r) {
 
   unsigned short i = loc->children->len++;
   loc->children->entries[i].name = name;
-  loc->children->entries[i].rg = r;
+  loc->children->entries[i].rg = rbs_new_loc_range(r);
 
   loc->children->required_p |= 1 << i;
 }
@@ -61,10 +68,10 @@ void rbs_loc_add_optional_child(rbs_loc *loc, ID name, range r) {
 
   unsigned short i = loc->children->len++;
   loc->children->entries[i].name = name;
-  loc->children->entries[i].rg = r;
+  loc->children->entries[i].rg = rbs_new_loc_range(r);
 }
 
-void rbs_loc_init(rbs_loc *loc, VALUE buffer, range rg) {
+void rbs_loc_init(rbs_loc *loc, VALUE buffer, rbs_loc_range rg) {
   loc->buffer = buffer;
   loc->rg = rg;
   loc->children = NULL;
@@ -100,7 +107,7 @@ static VALUE location_s_allocate(VALUE klass) {
   rbs_loc *loc;
   VALUE obj = TypedData_Make_Struct(klass, rbs_loc, &location_type, loc);
 
-  rbs_loc_init(loc, Qnil, NULL_RANGE);
+  rbs_loc_init(loc, Qnil, RBS_LOC_NULL_RANGE);
 
   return obj;
 }
@@ -112,8 +119,8 @@ rbs_loc *rbs_check_location(VALUE obj) {
 static VALUE location_initialize(VALUE self, VALUE buffer, VALUE start_pos, VALUE end_pos) {
   rbs_loc *loc = rbs_check_location(self);
 
-  position start = rbs_loc_position(FIX2INT(start_pos));
-  position end = rbs_loc_position(FIX2INT(end_pos));
+  int start = FIX2INT(start_pos);
+  int end = FIX2INT(end_pos);
 
   loc->buffer = buffer;
   loc->rg.start = start;
@@ -143,38 +150,12 @@ static VALUE location_buffer(VALUE self) {
 
 static VALUE location_start_pos(VALUE self) {
   rbs_loc *loc = rbs_check_location(self);
-  return INT2FIX(loc->rg.start.char_pos);
+  return INT2FIX(loc->rg.start);
 }
 
 static VALUE location_end_pos(VALUE self) {
   rbs_loc *loc = rbs_check_location(self);
-  return INT2FIX(loc->rg.end.char_pos);
-}
-
-static VALUE location_start_loc(VALUE self) {
-  rbs_loc *loc = rbs_check_location(self);
-
-  if (loc->rg.start.line >= 0) {
-    VALUE pair = rb_ary_new_capa(2);
-    rb_ary_push(pair, INT2FIX(loc->rg.start.line));
-    rb_ary_push(pair, INT2FIX(loc->rg.start.column));
-    return pair;
-  } else {
-    return Qnil;
-  }
-}
-
-static VALUE location_end_loc(VALUE self) {
-  rbs_loc *loc = rbs_check_location(self);
-
-  if (loc->rg.end.line >= 0) {
-    VALUE pair = rb_ary_new_capa(2);
-    rb_ary_push(pair, INT2FIX(loc->rg.end.line));
-    rb_ary_push(pair, INT2FIX(loc->rg.end.column));
-    return pair;
-  } else {
-    return Qnil;
-  }
+  return INT2FIX(loc->rg.end);
 }
 
 static VALUE location_add_required_child(VALUE self, VALUE name, VALUE start, VALUE end) {
@@ -213,6 +194,15 @@ VALUE rbs_new_location(VALUE buffer, range rg) {
   rbs_loc *loc;
   VALUE obj = TypedData_Make_Struct(RBS_Location, rbs_loc, &location_type, loc);
 
+  rbs_loc_init(loc, buffer, rbs_new_loc_range(rg));
+
+  return obj;
+}
+
+static VALUE rbs_new_location_from_loc_range(VALUE buffer, rbs_loc_range rg) {
+  rbs_loc *loc;
+  VALUE obj = TypedData_Make_Struct(RBS_Location, rbs_loc, &location_type, loc);
+
   rbs_loc_init(loc, buffer, rg);
 
   return obj;
@@ -226,12 +216,12 @@ static VALUE location_aref(VALUE self, VALUE name) {
   if (loc->children != NULL) {
     for (unsigned short i = 0; i < loc->children->len; i++) {
       if (loc->children->entries[i].name == id) {
-        range result = loc->children->entries[i].rg;
+        rbs_loc_range result = loc->children->entries[i].rg;
 
-        if (RBS_LOC_OPTIONAL_P(loc, i) && null_range_p(result)) {
+        if (RBS_LOC_OPTIONAL_P(loc, i) && NULL_LOC_RANGE_P(result)) {
           return Qnil;
         } else {
-          return rbs_new_location(loc->buffer, result);
+          return rbs_new_location_from_loc_range(loc->buffer, result);
         }
       }
     }
@@ -294,8 +284,6 @@ void rbs__init_location(void) {
   rb_define_method(RBS_Location, "buffer", location_buffer, 0);
   rb_define_method(RBS_Location, "start_pos", location_start_pos, 0);
   rb_define_method(RBS_Location, "end_pos", location_end_pos, 0);
-  rb_define_private_method(RBS_Location, "_start_loc", location_start_loc, 0);
-  rb_define_private_method(RBS_Location, "_end_loc", location_end_loc, 0);
   rb_define_method(RBS_Location, "_add_required_child", location_add_required_child, 3);
   rb_define_method(RBS_Location, "_add_optional_child", location_add_optional_child, 3);
   rb_define_method(RBS_Location, "_add_optional_no_child", location_add_optional_no_child, 1);

data/ext/rbs_extension/location.h

@@ -9,9 +9,14 @@
  * */
 extern VALUE RBS_Location;
 
+typedef struct {
+  int start;
+  int end;
+} rbs_loc_range;
+
 typedef struct {
   ID name;
-  range rg;
+  rbs_loc_range rg;
 } rbs_loc_entry;
 
 typedef unsigned int rbs_loc_entry_bitmap;
@@ -27,7 +32,7 @@ typedef struct {
 
 typedef struct {
   VALUE buffer;
-  range rg;
+  rbs_loc_range rg;
   rbs_loc_children *children; // NULL when no children is allocated
 } rbs_loc;