Merge master and support upstream's parser enhancements (#41)

`ruby/rbs` recently received a few enhancements for new keywords and
inline parsing:

- ruby#2403
- ruby#2405
- ruby#2406

So the major change of this PR is to reimplement them under the `c-api`
structure.

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Soutaro Matsumoto <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Alexander Momchilov <[email protected]>

Author: 4 people

Gemfile.lock

@@ -34,13 +34,13 @@ GEM
     benchmark-ips (2.14.0)
     bigdecimal (3.1.9)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
-    csv (3.3.3)
+    connection_pool (2.5.1)
+    csv (3.3.4)
     dbm (1.1.0)
     diff-lcs (1.6.1)
     digest (3.2.0)
     drb (2.2.1)
-    ffi (1.17.1)
+    ffi (1.17.2)
     fileutils (1.7.3)
     goodcheck (3.1.0)
       marcel (>= 1.0, < 2.0)
@@ -69,12 +69,12 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nkf (0.2.0)
-    nokogiri (1.18.7)
+    nokogiri (1.18.8)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     ostruct (0.6.1)
-    parallel (1.26.3)
-    parser (3.3.7.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     pathname (0.4.0)
@@ -90,7 +90,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rake-compiler (1.2.9)
+    rake-compiler (1.3.0)
       rake
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
@@ -111,7 +111,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.75.2)
+    rubocop (1.75.3)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -122,7 +122,7 @@ GEM
       rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.0)
+    rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-on-rbs (1.5.0)
@@ -155,9 +155,9 @@ GEM
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 5)
       uri (>= 0.12.0)
-    stringio (3.1.6)
+    stringio (3.1.7)
     strong_json (2.1.2)
-    strscan (3.1.2)
+    strscan (3.1.3)
     tempfile (0.3.1)
     terminal-table (4.0.0)
       unicode-display_width (>= 1.1.1, < 4)

config.yml

@@ -443,3 +443,45 @@ nodes:
     fields:
       - name: name
         c_type: rbs_ast_symbol
+  - name: RBS::AST::Ruby::Annotations::NodeTypeAssertion
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: type
+        c_type: rbs_node
+  - name: RBS::AST::Ruby::Annotations::ColonMethodTypeAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: annotations
+        c_type: rbs_node_list
+      - name: method_type
+        c_type: rbs_node
+  - name: RBS::AST::Ruby::Annotations::MethodTypesAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: overloads
+        c_type: rbs_node_list
+      - name: vertical_bar_locations
+        c_type: rbs_location_list
+  - name: RBS::AST::Ruby::Annotations::SkipAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: skip_location
+        c_type: rbs_location
+      - name: comment_location
+        c_type: rbs_location
+  - name: RBS::AST::Ruby::Annotations::ReturnTypeAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: return_location
+        c_type: rbs_location
+      - name: colon_location
+        c_type: rbs_location
+      - name: return_type
+        c_type: rbs_node
+      - name: comment_location
+        c_type: rbs_location

ext/rbs_extension/ast_translation.c

@@ -44,6 +44,10 @@ VALUE rbs_hash_to_ruby_hash(rbs_translation_context_t ctx, rbs_hash_t *rbs_hash)
 }
 
 VALUE rbs_loc_to_ruby_location(rbs_translation_context_t ctx, rbs_location_t *source_loc) {
+  if (source_loc == NULL) {
+    return Qnil;
+  }
+
   VALUE new_loc = rbs_new_location(ctx.buffer, source_loc->rg);
   rbs_loc *new_loc_struct = rbs_check_location(new_loc);
 
@@ -55,6 +59,20 @@ VALUE rbs_loc_to_ruby_location(rbs_translation_context_t ctx, rbs_location_t *so
   return new_loc;
 }
 
+VALUE rbs_location_list_to_ruby_array(rbs_translation_context_t ctx, rbs_location_list_t *list) {
+    VALUE ruby_array = rb_ary_new();
+
+    if (list == NULL) {
+        return ruby_array;
+    }
+
+    for (rbs_location_list_node_t *n = list->head; n != NULL; n = n->next) {
+        rb_ary_push(ruby_array, rbs_loc_to_ruby_location(ctx, n->loc));
+    }
+
+    return ruby_array;
+}
+
 #ifdef RB_PASS_KEYWORDS
   // Ruby 2.7 or later
   #define CLASS_NEW_INSTANCE(klass, argc, argv)\
@@ -586,6 +604,87 @@ VALUE rbs_struct_to_ruby_value(rbs_translation_context_t ctx, rbs_node_t *instan
                 &h
             );
         }
+        case RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION: {
+            rbs_ast_ruby_annotations_colon_method_type_annotation_t *node = (rbs_ast_ruby_annotations_colon_method_type_annotation_t *)instance;
+
+            VALUE h = rb_hash_new();
+            rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+            rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("annotations")), rbs_node_list_to_ruby_array(ctx, node->annotations));
+            rb_hash_aset(h, ID2SYM(rb_intern("method_type")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->method_type)); // rbs_node
+
+
+            return CLASS_NEW_INSTANCE(
+                RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation,
+                1,
+                &h
+            );
+        }
+        case RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION: {
+            rbs_ast_ruby_annotations_method_types_annotation_t *node = (rbs_ast_ruby_annotations_method_types_annotation_t *)instance;
+
+            VALUE h = rb_hash_new();
+            rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+            rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("overloads")), rbs_node_list_to_ruby_array(ctx, node->overloads));
+            rb_hash_aset(h, ID2SYM(rb_intern("vertical_bar_locations")), rbs_location_list_to_ruby_array(ctx, node->vertical_bar_locations));
+
+
+            return CLASS_NEW_INSTANCE(
+                RBS_AST_Ruby_Annotations_MethodTypesAnnotation,
+                1,
+                &h
+            );
+        }
+        case RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION: {
+            rbs_ast_ruby_annotations_node_type_assertion_t *node = (rbs_ast_ruby_annotations_node_type_assertion_t *)instance;
+
+            VALUE h = rb_hash_new();
+            rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+            rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("type")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->type)); // rbs_node
+
+
+            return CLASS_NEW_INSTANCE(
+                RBS_AST_Ruby_Annotations_NodeTypeAssertion,
+                1,
+                &h
+            );
+        }
+        case RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION: {
+            rbs_ast_ruby_annotations_return_type_annotation_t *node = (rbs_ast_ruby_annotations_return_type_annotation_t *)instance;
+
+            VALUE h = rb_hash_new();
+            rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+            rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("return_location")), rbs_loc_to_ruby_location(ctx, node->return_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("colon_location")), rbs_loc_to_ruby_location(ctx, node->colon_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("return_type")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->return_type)); // rbs_node
+            rb_hash_aset(h, ID2SYM(rb_intern("comment_location")), rbs_loc_to_ruby_location(ctx, node->comment_location));
+
+
+            return CLASS_NEW_INSTANCE(
+                RBS_AST_Ruby_Annotations_ReturnTypeAnnotation,
+                1,
+                &h
+            );
+        }
+        case RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION: {
+            rbs_ast_ruby_annotations_skip_annotation_t *node = (rbs_ast_ruby_annotations_skip_annotation_t *)instance;
+
+            VALUE h = rb_hash_new();
+            rb_hash_aset(h, ID2SYM(rb_intern("location")), rbs_loc_to_ruby_location(ctx, node->base.location));
+            rb_hash_aset(h, ID2SYM(rb_intern("prefix_location")), rbs_loc_to_ruby_location(ctx, node->prefix_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("skip_location")), rbs_loc_to_ruby_location(ctx, node->skip_location));
+            rb_hash_aset(h, ID2SYM(rb_intern("comment_location")), rbs_loc_to_ruby_location(ctx, node->comment_location));
+
+
+            return CLASS_NEW_INSTANCE(
+                RBS_AST_Ruby_Annotations_SkipAnnotation,
+                1,
+                &h
+            );
+        }
         case RBS_AST_STRING: {
             rbs_ast_string_t *string_node = (rbs_ast_string_t *) instance;
             rbs_string_t s = string_node->string;

ext/rbs_extension/class_constants.c

@@ -14,6 +14,8 @@ VALUE RBS_AST;
 VALUE RBS_AST_Declarations;
 VALUE RBS_AST_Directives;
 VALUE RBS_AST_Members;
+VALUE RBS_AST_Ruby;
+VALUE RBS_AST_Ruby_Annotations;
 VALUE RBS_Parser;
 VALUE RBS_Types;
 VALUE RBS_Types_Bases;
@@ -47,6 +49,11 @@ VALUE RBS_AST_Members_MethodDefinition_Overload;
 VALUE RBS_AST_Members_Prepend;
 VALUE RBS_AST_Members_Private;
 VALUE RBS_AST_Members_Public;
+VALUE RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation;
+VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
+VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
+VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
+VALUE RBS_AST_Ruby_Annotations_SkipAnnotation;
 VALUE RBS_AST_TypeParam;
 VALUE RBS_MethodType;
 VALUE RBS_Namespace;
@@ -89,6 +96,8 @@ void rbs__init_constants(void) {
   IMPORT_CONSTANT(RBS_AST_Declarations, RBS_AST, "Declarations");
   IMPORT_CONSTANT(RBS_AST_Directives, RBS_AST, "Directives");
   IMPORT_CONSTANT(RBS_AST_Members, RBS_AST, "Members");
+  IMPORT_CONSTANT(RBS_AST_Ruby, RBS_AST, "Ruby");
+  IMPORT_CONSTANT(RBS_AST_Ruby_Annotations, RBS_AST_Ruby, "Annotations");
   IMPORT_CONSTANT(RBS_Types, RBS, "Types");
   IMPORT_CONSTANT(RBS_Types_Bases, RBS_Types, "Bases");
 
@@ -121,6 +130,11 @@ void rbs__init_constants(void) {
   IMPORT_CONSTANT(RBS_AST_Members_Prepend, RBS_AST_Members, "Prepend");
   IMPORT_CONSTANT(RBS_AST_Members_Private, RBS_AST_Members, "Private");
   IMPORT_CONSTANT(RBS_AST_Members_Public, RBS_AST_Members, "Public");
+  IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation, RBS_AST_Ruby_Annotations, "ColonMethodTypeAnnotation");
+  IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_MethodTypesAnnotation, RBS_AST_Ruby_Annotations, "MethodTypesAnnotation");
+  IMPORT_CONSTANT(RBS_AST_Ruby_Annotations_NodeTypeAssertion, RBS_AST_Ruby_Annotations, "NodeTypeAssertion");
+  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_TypeParam, RBS_AST, "TypeParam");
   IMPORT_CONSTANT(RBS_MethodType, RBS, "MethodType");
   IMPORT_CONSTANT(RBS_Namespace, RBS, "Namespace");

ext/rbs_extension/class_constants.h

@@ -16,6 +16,8 @@ extern VALUE RBS_AST;
 extern VALUE RBS_AST_Declarations;
 extern VALUE RBS_AST_Directives;
 extern VALUE RBS_AST_Members;
+extern VALUE RBS_AST_Ruby;
+extern VALUE RBS_AST_Ruby_Annotations;
 extern VALUE RBS_Types;
 extern VALUE RBS_Types_Bases;
 extern VALUE RBS_ParsingError;
@@ -49,6 +51,11 @@ extern VALUE RBS_AST_Members_MethodDefinition_Overload;
 extern VALUE RBS_AST_Members_Prepend;
 extern VALUE RBS_AST_Members_Private;
 extern VALUE RBS_AST_Members_Public;
+extern VALUE RBS_AST_Ruby_Annotations_ColonMethodTypeAnnotation;
+extern VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
+extern VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
+extern VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
+extern VALUE RBS_AST_Ruby_Annotations_SkipAnnotation;
 extern VALUE RBS_AST_TypeParam;
 extern VALUE RBS_MethodType;
 extern VALUE RBS_Namespace;

ext/rbs_extension/legacy_location.c

@@ -305,8 +305,8 @@ void rbs__init_location(void) {
   rb_define_private_method(RBS_Location, "initialize", location_initialize, 3);
   rb_define_private_method(RBS_Location, "initialize_copy", location_initialize_copy, 1);
   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_method(RBS_Location, "_start_pos", location_start_pos, 0);
+  rb_define_method(RBS_Location, "_end_pos", location_end_pos, 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);