Implement parser

Author: soutaro

config.yml

@@ -497,3 +497,17 @@ nodes:
         c_type: rbs_location
       - name: comma_locations
         c_type: rbs_location_list
+  - name: RBS::AST::Ruby::Annotations::InstanceVariableAnnotation
+    fields:
+      - name: prefix_location
+        c_type: rbs_location
+      - name: ivar_name
+        c_type: rbs_ast_symbol
+      - name: ivar_name_location
+        c_type: rbs_location
+      - name: colon_location
+        c_type: rbs_location
+      - name: type
+        c_type: rbs_node
+      - name: comment_location
+        c_type: rbs_location

ext/rbs_extension/ast_translation.c

@@ -588,6 +588,24 @@ VALUE rbs_struct_to_ruby_value(rbs_translation_context_t ctx, rbs_node_t *instan
             &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;
+
+        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("ivar_name")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->ivar_name)); // rbs_ast_symbol
+        rb_hash_aset(h, ID2SYM(rb_intern("ivar_name_location")), rbs_loc_to_ruby_location(ctx, node->ivar_name_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("type")), rbs_struct_to_ruby_value(ctx, (rbs_node_t *) node->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_InstanceVariableAnnotation,
+            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;
 

ext/rbs_extension/class_constants.c

@@ -50,6 +50,7 @@ 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_InstanceVariableAnnotation;
 VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
 VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
 VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;
@@ -136,6 +137,7 @@ void rbs__init_constants(void) {
     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_InstanceVariableAnnotation, RBS_AST_Ruby_Annotations, "InstanceVariableAnnotation");
     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");

ext/rbs_extension/class_constants.h

@@ -56,6 +56,7 @@ 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_InstanceVariableAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_MethodTypesAnnotation;
 extern VALUE RBS_AST_Ruby_Annotations_NodeTypeAssertion;
 extern VALUE RBS_AST_Ruby_Annotations_ReturnTypeAnnotation;

include/rbs/ast.h

@@ -46,43 +46,44 @@ enum rbs_node_type {
     RBS_AST_MEMBERS_PRIVATE = 30,
     RBS_AST_MEMBERS_PUBLIC = 31,
     RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION = 32,
-    RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION = 33,
-    RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION = 34,
-    RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION = 35,
-    RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION = 36,
-    RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION = 37,
-    RBS_AST_STRING = 38,
-    RBS_AST_TYPE_PARAM = 39,
-    RBS_METHOD_TYPE = 40,
-    RBS_NAMESPACE = 41,
-    RBS_SIGNATURE = 42,
-    RBS_TYPE_NAME = 43,
-    RBS_TYPES_ALIAS = 44,
-    RBS_TYPES_BASES_ANY = 45,
-    RBS_TYPES_BASES_BOOL = 46,
-    RBS_TYPES_BASES_BOTTOM = 47,
-    RBS_TYPES_BASES_CLASS = 48,
-    RBS_TYPES_BASES_INSTANCE = 49,
-    RBS_TYPES_BASES_NIL = 50,
-    RBS_TYPES_BASES_SELF = 51,
-    RBS_TYPES_BASES_TOP = 52,
-    RBS_TYPES_BASES_VOID = 53,
-    RBS_TYPES_BLOCK = 54,
-    RBS_TYPES_CLASS_INSTANCE = 55,
-    RBS_TYPES_CLASS_SINGLETON = 56,
-    RBS_TYPES_FUNCTION = 57,
-    RBS_TYPES_FUNCTION_PARAM = 58,
-    RBS_TYPES_INTERFACE = 59,
-    RBS_TYPES_INTERSECTION = 60,
-    RBS_TYPES_LITERAL = 61,
-    RBS_TYPES_OPTIONAL = 62,
-    RBS_TYPES_PROC = 63,
-    RBS_TYPES_RECORD = 64,
-    RBS_TYPES_RECORD_FIELD_TYPE = 65,
-    RBS_TYPES_TUPLE = 66,
-    RBS_TYPES_UNION = 67,
-    RBS_TYPES_UNTYPED_FUNCTION = 68,
-    RBS_TYPES_VARIABLE = 69,
+    RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION = 33,
+    RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION = 34,
+    RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION = 35,
+    RBS_AST_RUBY_ANNOTATIONS_RETURN_TYPE_ANNOTATION = 36,
+    RBS_AST_RUBY_ANNOTATIONS_SKIP_ANNOTATION = 37,
+    RBS_AST_RUBY_ANNOTATIONS_TYPE_APPLICATION_ANNOTATION = 38,
+    RBS_AST_STRING = 39,
+    RBS_AST_TYPE_PARAM = 40,
+    RBS_METHOD_TYPE = 41,
+    RBS_NAMESPACE = 42,
+    RBS_SIGNATURE = 43,
+    RBS_TYPE_NAME = 44,
+    RBS_TYPES_ALIAS = 45,
+    RBS_TYPES_BASES_ANY = 46,
+    RBS_TYPES_BASES_BOOL = 47,
+    RBS_TYPES_BASES_BOTTOM = 48,
+    RBS_TYPES_BASES_CLASS = 49,
+    RBS_TYPES_BASES_INSTANCE = 50,
+    RBS_TYPES_BASES_NIL = 51,
+    RBS_TYPES_BASES_SELF = 52,
+    RBS_TYPES_BASES_TOP = 53,
+    RBS_TYPES_BASES_VOID = 54,
+    RBS_TYPES_BLOCK = 55,
+    RBS_TYPES_CLASS_INSTANCE = 56,
+    RBS_TYPES_CLASS_SINGLETON = 57,
+    RBS_TYPES_FUNCTION = 58,
+    RBS_TYPES_FUNCTION_PARAM = 59,
+    RBS_TYPES_INTERFACE = 60,
+    RBS_TYPES_INTERSECTION = 61,
+    RBS_TYPES_LITERAL = 62,
+    RBS_TYPES_OPTIONAL = 63,
+    RBS_TYPES_PROC = 64,
+    RBS_TYPES_RECORD = 65,
+    RBS_TYPES_RECORD_FIELD_TYPE = 66,
+    RBS_TYPES_TUPLE = 67,
+    RBS_TYPES_UNION = 68,
+    RBS_TYPES_UNTYPED_FUNCTION = 69,
+    RBS_TYPES_VARIABLE = 70,
     RBS_KEYWORD,
     RBS_AST_SYMBOL,
 };
@@ -406,6 +407,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_instance_variable_annotation {
+    rbs_node_t base;
+
+    struct rbs_location *prefix_location;
+    struct rbs_ast_symbol *ivar_name;
+    struct rbs_location *ivar_name_location;
+    struct rbs_location *colon_location;
+    struct rbs_node *type;
+    struct rbs_location *comment_location;
+} rbs_ast_ruby_annotations_instance_variable_annotation_t;
+
 typedef struct rbs_ast_ruby_annotations_method_types_annotation {
     rbs_node_t base;
 
@@ -718,6 +730,7 @@ rbs_ast_members_prepend_t *rbs_ast_members_prepend_new(rbs_allocator_t *allocato
 rbs_ast_members_private_t *rbs_ast_members_private_new(rbs_allocator_t *allocator, rbs_location_t *location);
 rbs_ast_members_public_t *rbs_ast_members_public_new(rbs_allocator_t *allocator, rbs_location_t *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_t *location, rbs_location_t *prefix_location, rbs_node_list_t *annotations, rbs_node_t *method_type);
+rbs_ast_ruby_annotations_instance_variable_annotation_t *rbs_ast_ruby_annotations_instance_variable_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_ast_symbol_t *ivar_name, rbs_location_t *ivar_name_location, rbs_location_t *colon_location, rbs_node_t *type, rbs_location_t *comment_location);
 rbs_ast_ruby_annotations_method_types_annotation_t *rbs_ast_ruby_annotations_method_types_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_node_list_t *overloads, rbs_location_list_t *vertical_bar_locations);
 rbs_ast_ruby_annotations_node_type_assertion_t *rbs_ast_ruby_annotations_node_type_assertion_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_node_t *type);
 rbs_ast_ruby_annotations_return_type_annotation_t *rbs_ast_ruby_annotations_return_type_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_location_t *return_location, rbs_location_t *colon_location, rbs_node_t *return_type, rbs_location_t *comment_location);

src/ast.c

@@ -77,6 +77,8 @@ const char *rbs_node_type_name(rbs_node_t *node) {
         return "RBS::AST::Members::Public";
     case RBS_AST_RUBY_ANNOTATIONS_COLON_METHOD_TYPE_ANNOTATION:
         return "RBS::AST::Ruby::Annotations::ColonMethodTypeAnnotation";
+    case RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION:
+        return "RBS::AST::Ruby::Annotations::InstanceVariableAnnotation";
     case RBS_AST_RUBY_ANNOTATIONS_METHOD_TYPES_ANNOTATION:
         return "RBS::AST::Ruby::Annotations::MethodTypesAnnotation";
     case RBS_AST_RUBY_ANNOTATIONS_NODE_TYPE_ASSERTION:
@@ -818,6 +820,25 @@ rbs_ast_ruby_annotations_colon_method_type_annotation_t *rbs_ast_ruby_annotation
     return instance;
 }
 #line 156 "prism/templates/src/ast.c.erb"
+rbs_ast_ruby_annotations_instance_variable_annotation_t *rbs_ast_ruby_annotations_instance_variable_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_ast_symbol_t *ivar_name, rbs_location_t *ivar_name_location, rbs_location_t *colon_location, rbs_node_t *type, rbs_location_t *comment_location) {
+    rbs_ast_ruby_annotations_instance_variable_annotation_t *instance = rbs_allocator_alloc(allocator, rbs_ast_ruby_annotations_instance_variable_annotation_t);
+
+    *instance = (rbs_ast_ruby_annotations_instance_variable_annotation_t) {
+        .base = (rbs_node_t) {
+            .type = RBS_AST_RUBY_ANNOTATIONS_INSTANCE_VARIABLE_ANNOTATION,
+            .location = location,
+        },
+        .prefix_location = prefix_location,
+        .ivar_name = ivar_name,
+        .ivar_name_location = ivar_name_location,
+        .colon_location = colon_location,
+        .type = type,
+        .comment_location = comment_location,
+    };
+
+    return instance;
+}
+#line 156 "prism/templates/src/ast.c.erb"
 rbs_ast_ruby_annotations_method_types_annotation_t *rbs_ast_ruby_annotations_method_types_annotation_new(rbs_allocator_t *allocator, rbs_location_t *location, rbs_location_t *prefix_location, rbs_node_list_t *overloads, rbs_location_list_t *vertical_bar_locations) {
     rbs_ast_ruby_annotations_method_types_annotation_t *instance = rbs_allocator_alloc(allocator, rbs_ast_ruby_annotations_method_types_annotation_t);
 

src/parser.c

@@ -3766,6 +3766,53 @@ static bool parse_inline_leading_annotation(rbs_parser_t *parser, rbs_ast_ruby_a
             );
             return true;
         }
+        case tAIDENT: {
+            // Parse instance variable annotation: @rbs @name: Type
+            rbs_parser_advance(parser);
+
+            rbs_range_t ivar_name_range = parser->current_token.range;
+            rbs_location_t *ivar_name_loc = rbs_location_new(ALLOCATOR(), ivar_name_range);
+
+            // Extract the instance variable name as a symbol
+            rbs_string_t ivar_string = rbs_parser_peek_current_token(parser);
+            rbs_constant_id_t ivar_id = rbs_constant_pool_insert_string(&parser->constant_pool, ivar_string);
+            rbs_ast_symbol_t *ivar_name = rbs_ast_symbol_new(ALLOCATOR(), ivar_name_loc, &parser->constant_pool, ivar_id);
+
+            ADVANCE_ASSERT(parser, pCOLON);
+
+            rbs_range_t colon_range = parser->current_token.range;
+            rbs_location_t *colon_loc = rbs_location_new(ALLOCATOR(), colon_range);
+
+            rbs_node_t *type = NULL;
+            if (!rbs_parse_type(parser, &type, false)) {
+                return false;
+            }
+
+            rbs_location_t *comment_loc = NULL;
+            if (!parse_inline_comment(parser, &comment_loc)) {
+                return false;
+            }
+
+            rbs_range_t full_range = {
+                .start = rbs_range.start,
+                .end = parser->current_token.range.end
+            };
+
+            rbs_location_t *full_loc = rbs_location_new(ALLOCATOR(), full_range);
+            rbs_location_t *rbs_loc = rbs_location_new(ALLOCATOR(), rbs_range);
+
+            *annotation = (rbs_ast_ruby_annotations_t *) rbs_ast_ruby_annotations_instance_variable_annotation_new(
+                ALLOCATOR(),
+                full_loc,
+                rbs_loc,
+                ivar_name,
+                ivar_name_loc,
+                colon_loc,
+                type,
+                comment_loc
+            );
+            return true;
+        }
         default: {
             rbs_parser_set_error(parser, parser->next_token, true, "unexpected token for @rbs annotation");
             return false;

test/rbs/inline_annotation_parsing_test.rb

@@ -156,4 +156,53 @@ def test_error__type_application
       Parser.parse_inline_trailing_annotation("[,String]", 0...)
     end
   end
+
+  def test_parse__instance_variable
+    Parser.parse_inline_leading_annotation("@rbs @name: String", 0...).tap do |annot|
+      assert_instance_of AST::Ruby::Annotations::InstanceVariableAnnotation, annot
+      assert_equal "@rbs @name: String", annot.location.source
+      assert_equal "@rbs", annot.prefix_location.source
+      assert_equal "@name", annot.ivar_name_location.source
+      assert_equal :@name, annot.ivar_name
+      assert_equal ":", annot.colon_location.source
+      assert_equal "String", annot.type.location.source
+      assert_nil annot.comment_location
+    end
+
+    Parser.parse_inline_leading_annotation("@rbs @age: Integer? -- person's age", 0...).tap do |annot|
+      assert_instance_of AST::Ruby::Annotations::InstanceVariableAnnotation, annot
+      assert_equal "@rbs @age: Integer? -- person's age", annot.location.source
+      assert_equal "@rbs", annot.prefix_location.source
+      assert_equal "@age", annot.ivar_name_location.source
+      assert_equal :@age, annot.ivar_name
+      assert_equal ":", annot.colon_location.source
+      assert_equal "Integer?", annot.type.location.source
+      assert_equal "-- person's age", annot.comment_location.source
+    end
+
+    Parser.parse_inline_leading_annotation("@rbs @items: Array[String]", 0...).tap do |annot|
+      assert_instance_of AST::Ruby::Annotations::InstanceVariableAnnotation, annot
+      assert_equal "@rbs @items: Array[String]", annot.location.source
+      assert_equal "@rbs", annot.prefix_location.source
+      assert_equal "@items", annot.ivar_name_location.source
+      assert_equal :@items, annot.ivar_name
+      assert_equal ":", annot.colon_location.source
+      assert_equal "Array[String]", annot.type.location.source
+      assert_nil annot.comment_location
+    end
+  end
+
+  def test_error__instance_variable
+    assert_raises RBS::ParsingError do
+      Parser.parse_inline_leading_annotation("@rbs @name", 0...)
+    end
+
+    assert_raises RBS::ParsingError do
+      Parser.parse_inline_leading_annotation("@rbs @name:", 0...)
+    end
+
+    assert_raises RBS::ParsingError do
+      Parser.parse_inline_leading_annotation("@rbs name: String", 0...)
+    end
+  end
 end