Add support for ref variable declarations in foreach statement

dotnet · Dec 29, 2023 · 52173fe · 52173fe
1 parent be24caf
commit 52173fe
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 17 deletions.
diff --git a/grammars/csharp.tmLanguage b/grammars/csharp.tmLanguage
@@ -4250,9 +4250,10 @@
                 <key>match</key>
                 <string>(?x)
 (?:
-  (\bvar\b)|
+  (?:(\bref)\s+)?(\bvar\b)| # ref local
   (?&lt;type_name&gt;
     (?:
+      (?:ref\s+)?   # ref local
       (?:
         (?:(?&lt;identifier&gt;@?[_[:alpha:]][_[:alnum:]]*)\s*\:\:\s*)? # alias-qualification
         (?&lt;name_and_type_args&gt; # identifier + type arguments (if any)
@@ -4281,9 +4282,14 @@
                   <key>1</key>
                   <dict>
                     <key>name</key>
-                    <string>storage.type.var.cs</string>
+                    <string>storage.modifier.ref.cs</string>
                   </dict>
                   <key>2</key>
+                  <dict>
+                    <key>name</key>
+                    <string>storage.type.var.cs</string>
+                  </dict>
+                  <key>3</key>
                   <dict>
                     <key>patterns</key>
                     <array>
@@ -4293,12 +4299,12 @@
                       </dict>
                     </array>
                   </dict>
-                  <key>7</key>
+                  <key>8</key>
                   <dict>
                     <key>name</key>
                     <string>entity.name.variable.local.cs</string>
                   </dict>
-                  <key>8</key>
+                  <key>9</key>
                   <dict>
                     <key>name</key>
                     <string>keyword.control.loop.in.cs</string>

diff --git a/grammars/csharp.tmLanguage.cson b/grammars/csharp.tmLanguage.cson
@@ -2603,9 +2603,10 @@ repository:
             match: '''
               (?x)
               (?:
-                (\\bvar\\b)|
+                (?:(\\bref)\\s+)?(\\bvar\\b)| # ref local
                 (?<type_name>
                   (?:
+                    (?:ref\\s+)?   # ref local
                     (?:
                       (?:(?<identifier>@?[_[:alpha:]][_[:alnum:]]*)\\s*\\:\\:\\s*)? # alias-qualification
                       (?<name_and_type_args> # identifier + type arguments (if any)
@@ -2632,16 +2633,18 @@ repository:
             '''
             captures:
               "1":
-                name: "storage.type.var.cs"
+                name: "storage.modifier.ref.cs"
               "2":
+                name: "storage.type.var.cs"
+              "3":
                 patterns: [
                   {
                     include: "#type"
                   }
                 ]
-              "7":
-                name: "entity.name.variable.local.cs"
               "8":
+                name: "entity.name.variable.local.cs"
+              "9":
                 name: "keyword.control.loop.in.cs"
           }
           {

diff --git a/src/csharp.tmLanguage.yml b/src/csharp.tmLanguage.yml
@@ -1521,9 +1521,10 @@ repository:
       - match: |-
           (?x)
           (?:
-            (\bvar\b)|
+            (?:(\bref)\s+)?(\bvar\b)| # ref local
             (?<type_name>
               (?:
+                (?:ref\s+)?   # ref local
                 (?:
                   (?:(?<identifier>@?[_[:alpha:]][_[:alnum:]]*)\s*\:\:\s*)? # alias-qualification
                   (?<name_and_type_args> # identifier + type arguments (if any)
@@ -1548,16 +1549,17 @@ repository:
           (\g<identifier>)\s+
           \b(in)\b
         captures:
-          '1': { name: storage.type.var.cs }
-          '2':
+          1: { name: storage.modifier.ref.cs }
+          2: { name: storage.type.var.cs }
+          3:
             patterns:
             - include: '#type'
-          # '3': ?<identifier> is a sub-expression. It's final value is not considered.
-          # '4': ?<name_and_type_args> is a sub-expression. It's final value is not considered.
-          # '5': ?<type_args> is a sub-expression. It's final value is not considered.
-          # '6': ?<tuple> is a sub-expression. It's final value is not considered.
-          '7': { name: entity.name.variable.local.cs }
-          '8': { name: keyword.control.loop.in.cs }
+          # 4: ?<identifier> is a sub-expression. It's final value is not considered.
+          # 5: ?<name_and_type_args> is a sub-expression. It's final value is not considered.
+          # 6: ?<type_args> is a sub-expression. It's final value is not considered.
+          # 7: ?<tuple> is a sub-expression. It's final value is not considered.
+          8: { name: entity.name.variable.local.cs }
+          9: { name: keyword.control.loop.in.cs }
       - match: |-
           (?x) # match foreach (var (x, y) in ...)
           (?:\b(var)\b\s*)?

diff --git a/test/statements.tests.ts b/test/statements.tests.ts
@@ -347,6 +347,25 @@ foreach (var s in myList)
                     Token.Punctuation.CloseBrace,
                 ]);
             });
+
+            it("foreach loop with ref var (issue #308)", async () => {
+                const input = Input.InMethod(`
+foreach (ref var i in span) {}`);
+                const tokens = await tokenize(input);
+
+                tokens.should.deep.equal([
+                    Token.Keyword.Loop.ForEach,
+                    Token.Punctuation.OpenParen,
+                    Token.Keyword.Modifier.Ref,
+                    Token.Keyword.Definition.Var,
+                    Token.Identifier.LocalName("i"),
+                    Token.Keyword.Loop.In,
+                    Token.Variable.ReadWrite("span"),
+                    Token.Punctuation.CloseParen,
+                    Token.Punctuation.OpenBrace,
+                    Token.Punctuation.CloseBrace,
+                ]);
+            });
         });
 
         describe("While", () => {