Merge pull request #2873 from ruby/splat-param-type

Add splat (`*a`) and double-splat (`**a`) parameter support

Author: soutaro

config.yml

@@ -798,6 +798,40 @@ nodes:
       - name: comment_location
         c_type: rbs_location_range
         optional: true
+  - name: RBS::AST::Ruby::Annotations::SplatParamTypeAnnotation
+    rust_name: SplatParamTypeAnnotationNode
+    fields:
+      - name: prefix_location
+        c_type: rbs_location_range
+      - name: star_location
+        c_type: rbs_location_range
+      - name: name_location
+        c_type: rbs_location_range
+        optional: true
+      - name: colon_location
+        c_type: rbs_location_range
+      - name: param_type
+        c_type: rbs_node
+      - name: comment_location
+        c_type: rbs_location_range
+        optional: true
+  - name: RBS::AST::Ruby::Annotations::DoubleSplatParamTypeAnnotation
+    rust_name: DoubleSplatParamTypeAnnotationNode
+    fields:
+      - name: prefix_location
+        c_type: rbs_location_range
+      - name: star2_location
+        c_type: rbs_location_range
+      - name: name_location
+        c_type: rbs_location_range
+        optional: true
+      - name: colon_location
+        c_type: rbs_location_range
+      - name: param_type
+        c_type: rbs_node
+      - name: comment_location
+        c_type: rbs_location_range
+        optional: true
 
 enums:
   attribute_visibility:

docs/inline.md

@@ -227,8 +227,10 @@ The `@rbs PARAM_NAME: T` syntax declares the type of a parameter:
 class Calculator
   # @rbs x: Integer
   # @rbs y: Integer
-  def add(x, y:)
-    x + y
+  # @rbs a: String
+  # @rbs b: bool
+  def add(x, y = 1, a:, b: false)
+    pp(x:, y:, a:, b:)
   end
 end
 ```
@@ -237,10 +239,28 @@ You can add a description after `--`:
 
 ```ruby
 class Calculator
-  # @rbs x: Integer -- the first operand
-  # @rbs y: Integer -- the second operand
-  def add(x, y:)
-    x + y
+  # @rbs x: Integer -- required positional argument
+  # @rbs y: Integer -- optional positional argument
+  # @rbs a: String -- required keyword argument
+  # @rbs b: bool -- optional keyword argument
+  def add(x, y = 1, a:, b: false)
+    pp(x:, y:, a:, b:)
+  end
+end
+```
+
+Types of splat (`*a`) and double-splat (`**b`) parameters can be declared too.
+
+```ruby
+class Foo
+  # @rbs *a: String -- The type of `a` is `Array[String]`
+  # @rbs **b: bool -- The type of `b` is `Hash[Symbol, bool]`
+  def foo(*a, **b)
+  end
+
+  # @rbs *: String -- Parameter name is optional
+  # @rbs **: bool -- Parameter name can be omitted in Ruby too
+  def bar(*a, **)
   end
 end
 ```
@@ -272,7 +292,7 @@ end
 ### Current Limitations
 
 - Class methods and singleton methods are not supported
-- Only positional and keyword parameters are supported. Splat parameters (`*x`, `**y`) and block parameter (`&block`) are not supported yet. 
+- Only positional and keyword parameters are supported. Splat parameters (`*x`, `**y`) and block parameter (`&block`) are not supported yet.
 - Method visibility declaration is not supported yet
 
 ## Attributes

ext/rbs_extension/ast_translation.c

@@ -859,6 +859,24 @@ VALUE rbs_struct_to_ruby_value(rbs_translation_context_t ctx, rbs_node_t *instan
             &h
         );
     }
+    case RBS_AST_RUBY_ANNOTATIONS_DOUBLE_SPLAT_PARAM_TYPE_ANNOTATION: {
+        rbs_ast_ruby_annotations_double_splat_param_type_annotation_t *node = (rbs_ast_ruby_annotations_double_splat_param_type_annotation_t *) instance;
+
+        VALUE h = rb_hash_new();
+        rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_location_range_to_ruby_location(ctx, node->base.location));
+        rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_location_range_to_ruby_location(ctx, node->prefix_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("star2_location")), rbs_location_range_to_ruby_location(ctx, node->star2_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("name_location")), rbs_location_range_to_ruby_location(ctx, node->name_location)); // optional
+        rb_hash_aset(h, ID2SYM(rb_intern("colon_location")), rbs_location_range_to_ruby_location(ctx, node->colon_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("param_type")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->param_type));         // rbs_node
+        rb_hash_aset(h, ID2SYM(rb_intern("comment_location")), rbs_location_range_to_ruby_location(ctx, node->comment_location)); // optional
+
+        return CLASS_NEW_INSTANCE(
+            RBS_AST_Ruby_Annotations_DoubleSplatParamTypeAnnotation,
+            1,
+            &h
+        );
+    }
     case RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION: {
         rbs_ast_ruby_annotations_instance_variable_annotation_t *node = (rbs_ast_ruby_annotations_instance_variable_annotation_t *) instance;
 
@@ -972,6 +990,24 @@ VALUE rbs_struct_to_ruby_value(rbs_translation_context_t ctx, rbs_node_t *instan
             &h
         );
     }
+    case RBS_AST_RUBY_ANNOTATIONS_SPLAT_PARAM_TYPE_ANNOTATION: {
+        rbs_ast_ruby_annotations_splat_param_type_annotation_t *node = (rbs_ast_ruby_annotations_splat_param_type_annotation_t *) instance;
+
+        VALUE h = rb_hash_new();
+        rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_location_range_to_ruby_location(ctx, node->base.location));
+        rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_location_range_to_ruby_location(ctx, node->prefix_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("star_location")), rbs_location_range_to_ruby_location(ctx, node->star_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("name_location")), rbs_location_range_to_ruby_location(ctx, node->name_location)); // optional
+        rb_hash_aset(h, ID2SYM(rb_intern("colon_location")), rbs_location_range_to_ruby_location(ctx, node->colon_location));
+        rb_hash_aset(h, ID2SYM(rb_intern("param_type")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->param_type));         // rbs_node
+        rb_hash_aset(h, ID2SYM(rb_intern("comment_location")), rbs_location_range_to_ruby_location(ctx, node->comment_location)); // optional
+
+        return CLASS_NEW_INSTANCE(
+            RBS_AST_Ruby_Annotations_SplatParamTypeAnnotation,
+            1,
+            &h
+        );
+    }
     case RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION: {
         rbs_ast_ruby_annotations_type_application_annotation_t *node = (rbs_ast_ruby_annotations_type_application_annotation_t *) instance;
 

ext/rbs_extension/class_constants.c

@@ -49,13 +49,15 @@ VALUE RBS_AST_Members_Private;
 VALUE RBS_AST_Members_Public;
 VALUE RBS_AST_Ruby_Annotations_ClassAliasAnnotation;
 VALUE RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation;
+VALUE RBS_AST_Ruby_Annotations_DoubleSplatParamTypeAnnotation;
 VALUE RBS_AST_Ruby_Annotations_InstanceVariableAnnotation;
 VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
 VALUE RBS_AST_Ruby_Annotations_ModuleAliasAnnotation;
 VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
 VALUE RBS_AST_Ruby_Annotations_ParamTypeAnnotation;
 VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
 VALUE RBS_AST_Ruby_Annotations_SkipAnnotation;
+VALUE RBS_AST_Ruby_Annotations_SplatParamTypeAnnotation;
 VALUE RBS_AST_Ruby_Annotations_TypeApplicationAnnotation;
 VALUE RBS_AST_TypeParam;
 VALUE RBS_MethodType;
@@ -139,13 +141,15 @@ void rbs__init_constants(void) {
     IMPORT_CONSTANT(RBS_AST_Members_Public, RBS_AST_Members, "Public");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ClassAliasAnnotation, RBS_AST_Ruby_Annotations, "ClassAliasAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation, RBS_AST_Ruby_Annotations, "ColonMethodTypeAnnotation");
+    IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_DoubleSplatParamTypeAnnotation, RBS_AST_Ruby_Annotations, "DoubleSplatParamTypeAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_InstanceVariableAnnotation, RBS_AST_Ruby_Annotations, "InstanceVariableAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_MethodTypesAnnotation, RBS_AST_Ruby_Annotations, "MethodTypesAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ModuleAliasAnnotation, RBS_AST_Ruby_Annotations, "ModuleAliasAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_NodeTypeAssertion, RBS_AST_Ruby_Annotations, "NodeTypeAssertion");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ParamTypeAnnotation, RBS_AST_Ruby_Annotations, "ParamTypeAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ReturnTypeAnnotation, RBS_AST_Ruby_Annotations, "ReturnTypeAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_SkipAnnotation, RBS_AST_Ruby_Annotations, "SkipAnnotation");
+    IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_SplatParamTypeAnnotation, RBS_AST_Ruby_Annotations, "SplatParamTypeAnnotation");
     IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_TypeApplicationAnnotation, RBS_AST_Ruby_Annotations, "TypeApplicationAnnotation");
     IMPORT_CONSTANT(RBS_AST_TypeParam, RBS_AST, "TypeParam");
     IMPORT_CONSTANT(RBS_MethodType, RBS, "MethodType");

ext/rbs_extension/class_constants.h

@@ -57,13 +57,15 @@ extern VALUE RBS_AST_Members_Private;
 extern VALUE RBS_AST_Members_Public;
 extern VALUE RBS_AST_Ruby_Annotations_ClassAliasAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation;
+extern VALUE RBS_AST_Ruby_Annotations_DoubleSplatParamTypeAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_InstanceVariableAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_ModuleAliasAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
 extern VALUE RBS_AST_Ruby_Annotations_ParamTypeAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_SkipAnnotation;
+extern VALUE RBS_AST_Ruby_Annotations_SplatParamTypeAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_TypeApplicationAnnotation;
 extern VALUE RBS_AST_TypeParam;
 extern VALUE RBS_MethodType;

include/rbs/ast.h

@@ -92,46 +92,48 @@ enum rbs_node_type {
     RBS_AST_MEMBERS_PUBLIC = 31,
     RBS_AST_RUBY_ANNOTATIONS_CLASS_ALIAS_ANNOTATION = 32,
     RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION = 33,
-    RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION = 34,
-    RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION = 35,
-    RBS_AST_RUBY_ANNOTATIONS_MODULE_ALIAS_ANNOTATION = 36,
-    RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION = 37,
-    RBS_AST_RUBY_ANNOTATIONS_PARAM_TYPE_ANNOTATION = 38,
-    RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION = 39,
-    RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION = 40,
-    RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION = 41,
-    RBS_AST_STRING = 42,
-    RBS_AST_TYPE_PARAM = 43,
-    RBS_METHOD_TYPE = 44,
-    RBS_NAMESPACE = 45,
-    RBS_SIGNATURE = 46,
-    RBS_TYPE_NAME = 47,
-    RBS_TYPES_ALIAS = 48,
-    RBS_TYPES_BASES_ANY = 49,
-    RBS_TYPES_BASES_BOOL = 50,
-    RBS_TYPES_BASES_BOTTOM = 51,
-    RBS_TYPES_BASES_CLASS = 52,
-    RBS_TYPES_BASES_INSTANCE = 53,
-    RBS_TYPES_BASES_NIL = 54,
-    RBS_TYPES_BASES_SELF = 55,
-    RBS_TYPES_BASES_TOP = 56,
-    RBS_TYPES_BASES_VOID = 57,
-    RBS_TYPES_BLOCK = 58,
-    RBS_TYPES_CLASS_INSTANCE = 59,
-    RBS_TYPES_CLASS_SINGLETON = 60,
-    RBS_TYPES_FUNCTION = 61,
-    RBS_TYPES_FUNCTION_PARAM = 62,
-    RBS_TYPES_INTERFACE = 63,
-    RBS_TYPES_INTERSECTION = 64,
-    RBS_TYPES_LITERAL = 65,
-    RBS_TYPES_OPTIONAL = 66,
-    RBS_TYPES_PROC = 67,
-    RBS_TYPES_RECORD = 68,
-    RBS_TYPES_RECORD_FIELD_TYPE = 69,
-    RBS_TYPES_TUPLE = 70,
-    RBS_TYPES_UNION = 71,
-    RBS_TYPES_UNTYPED_FUNCTION = 72,
-    RBS_TYPES_VARIABLE = 73,
+    RBS_AST_RUBY_ANNOTATIONS_DOUBLE_SPLAT_PARAM_TYPE_ANNOTATION = 34,
+    RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION = 35,
+    RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION = 36,
+    RBS_AST_RUBY_ANNOTATIONS_MODULE_ALIAS_ANNOTATION = 37,
+    RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION = 38,
+    RBS_AST_RUBY_ANNOTATIONS_PARAM_TYPE_ANNOTATION = 39,
+    RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION = 40,
+    RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION = 41,
+    RBS_AST_RUBY_ANNOTATIONS_SPLAT_PARAM_TYPE_ANNOTATION = 42,
+    RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION = 43,
+    RBS_AST_STRING = 44,
+    RBS_AST_TYPE_PARAM = 45,
+    RBS_METHOD_TYPE = 46,
+    RBS_NAMESPACE = 47,
+    RBS_SIGNATURE = 48,
+    RBS_TYPE_NAME = 49,
+    RBS_TYPES_ALIAS = 50,
+    RBS_TYPES_BASES_ANY = 51,
+    RBS_TYPES_BASES_BOOL = 52,
+    RBS_TYPES_BASES_BOTTOM = 53,
+    RBS_TYPES_BASES_CLASS = 54,
+    RBS_TYPES_BASES_INSTANCE = 55,
+    RBS_TYPES_BASES_NIL = 56,
+    RBS_TYPES_BASES_SELF = 57,
+    RBS_TYPES_BASES_TOP = 58,
+    RBS_TYPES_BASES_VOID = 59,
+    RBS_TYPES_BLOCK = 60,
+    RBS_TYPES_CLASS_INSTANCE = 61,
+    RBS_TYPES_CLASS_SINGLETON = 62,
+    RBS_TYPES_FUNCTION = 63,
+    RBS_TYPES_FUNCTION_PARAM = 64,
+    RBS_TYPES_INTERFACE = 65,
+    RBS_TYPES_INTERSECTION = 66,
+    RBS_TYPES_LITERAL = 67,
+    RBS_TYPES_OPTIONAL = 68,
+    RBS_TYPES_PROC = 69,
+    RBS_TYPES_RECORD = 70,
+    RBS_TYPES_RECORD_FIELD_TYPE = 71,
+    RBS_TYPES_TUPLE = 72,
+    RBS_TYPES_UNION = 73,
+    RBS_TYPES_UNTYPED_FUNCTION = 74,
+    RBS_TYPES_VARIABLE = 75,
     RBS_AST_SYMBOL,
 };
 
@@ -577,6 +579,17 @@ typedef struct rbs_ast_ruby_annotations_colon_method_type_annotation {
     struct rbs_node *method_type;
 } rbs_ast_ruby_annotations_colon_method_type_annotation_t;
 
+typedef struct rbs_ast_ruby_annotations_double_splat_param_type_annotation {
+    rbs_node_t base;
+
+    rbs_location_range prefix_location;
+    rbs_location_range star2_location;
+    rbs_location_range name_location; /* Optional */
+    rbs_location_range colon_location;
+    struct rbs_node *param_type;
+    rbs_location_range comment_location; /* Optional */
+} rbs_ast_ruby_annotations_double_splat_param_type_annotation_t;
+
 typedef struct rbs_ast_ruby_annotations_instance_variable_annotation {
     rbs_node_t base;
 
@@ -641,6 +654,17 @@ typedef struct rbs_ast_ruby_annotations_skip_annotation {
     rbs_location_range comment_location; /* Optional */
 } rbs_ast_ruby_annotations_skip_annotation_t;
 
+typedef struct rbs_ast_ruby_annotations_splat_param_type_annotation {
+    rbs_node_t base;
+
+    rbs_location_range prefix_location;
+    rbs_location_range star_location;
+    rbs_location_range name_location; /* Optional */
+    rbs_location_range colon_location;
+    struct rbs_node *param_type;
+    rbs_location_range comment_location; /* Optional */
+} rbs_ast_ruby_annotations_splat_param_type_annotation_t;
+
 typedef struct rbs_ast_ruby_annotations_type_application_annotation {
     rbs_node_t base;
 
@@ -937,13 +961,15 @@ rbs_ast_members_private_t *rbs_ast_members_private_new(rbs_allocator_t *allocato
 rbs_ast_members_public_t *rbs_ast_members_public_new(rbs_allocator_t *allocator, rbs_location_range location);
 rbs_ast_ruby_annotations_class_alias_annotation_t *rbs_ast_ruby_annotations_class_alias_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range keyword_location, rbs_type_name_t *type_name, rbs_location_range type_name_location);
 rbs_ast_ruby_annotations_colon_method_type_annotation_t *rbs_ast_ruby_annotations_colon_method_type_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_node_list_t *annotations, rbs_node_t *method_type);
+rbs_ast_ruby_annotations_double_splat_param_type_annotation_t *rbs_ast_ruby_annotations_double_splat_param_type_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range star2_location, rbs_location_range name_location, rbs_location_range colon_location, rbs_node_t *param_type, rbs_location_range comment_location);
 rbs_ast_ruby_annotations_instance_variable_annotation_t *rbs_ast_ruby_annotations_instance_variable_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_ast_symbol_t *ivar_name, rbs_location_range ivar_name_location, rbs_location_range colon_location, rbs_node_t *type, rbs_location_range comment_location);
 rbs_ast_ruby_annotations_method_types_annotation_t *rbs_ast_ruby_annotations_method_types_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_node_list_t *overloads, rbs_location_range_list_t *vertical_bar_locations, rbs_location_range dot3_location);
 rbs_ast_ruby_annotations_module_alias_annotation_t *rbs_ast_ruby_annotations_module_alias_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range keyword_location, rbs_type_name_t *type_name, rbs_location_range type_name_location);
 rbs_ast_ruby_annotations_node_type_assertion_t *rbs_ast_ruby_annotations_node_type_assertion_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_node_t *type);
 rbs_ast_ruby_annotations_param_type_annotation_t *rbs_ast_ruby_annotations_param_type_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range name_location, rbs_location_range colon_location, rbs_node_t *param_type, rbs_location_range comment_location);
 rbs_ast_ruby_annotations_return_type_annotation_t *rbs_ast_ruby_annotations_return_type_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range return_location, rbs_location_range colon_location, rbs_node_t *return_type, rbs_location_range comment_location);
 rbs_ast_ruby_annotations_skip_annotation_t *rbs_ast_ruby_annotations_skip_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range skip_location, rbs_location_range comment_location);
+rbs_ast_ruby_annotations_splat_param_type_annotation_t *rbs_ast_ruby_annotations_splat_param_type_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_location_range star_location, rbs_location_range name_location, rbs_location_range colon_location, rbs_node_t *param_type, rbs_location_range comment_location);
 rbs_ast_ruby_annotations_type_application_annotation_t *rbs_ast_ruby_annotations_type_application_annotation_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_location_range prefix_location, rbs_node_list_t *type_args, rbs_location_range close_bracket_location, rbs_location_range_list_t *comma_locations);
 rbs_ast_string_t *rbs_ast_string_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_string_t string);
 rbs_ast_type_param_t *rbs_ast_type_param_new(rbs_allocator_t *allocator, rbs_location_range location, rbs_ast_symbol_t *name, enum rbs_type_param_variance variance, rbs_node_t *upper_bound, rbs_node_t *lower_bound, rbs_node_t *default_type, bool unchecked, rbs_location_range name_range);