prioritize parsing MultiLineComment over MultiLineNatSpecComment

OmarTawfik · OmarTawfik · commit 582c16d0208f · 2024-02-22T07:22:13.000-08:00
diff --git a/.changeset/great-sheep-camp.md b/.changeset/great-sheep-camp.md
@@ -0,0 +1,5 @@
+---
+"@nomicfoundation/slang": patch
+---
+
+prioritize parsing `MultiLineComment` over `MultiLineNatSpecComment`
diff --git a/crates/solidity/inputs/language/src/definition.rs b/crates/solidity/inputs/language/src/definition.rs
@@ -425,7 +425,7 @@ codegen_language_macros::compile!(Language(
                         Trivia(
                             name = MultiLineNatSpecComment,
                             scanner = Sequence([
-                                Atom("/**"),
+                                TrailingContext(scanner = Atom("/**"), not_followed_by = Atom("/")),
                                 ZeroOrMore(Choice([
                                     Not(['*']),
                                     TrailingContext(
diff --git a/crates/solidity/outputs/cargo/slang_solidity/src/generated/language.rs b/crates/solidity/outputs/cargo/slang_solidity/src/generated/language.rs
diff --git a/crates/solidity/outputs/cargo/tests/src/cst_output/generated/SourceUnit.rs b/crates/solidity/outputs/cargo/tests/src/cst_output/generated/SourceUnit.rs
diff --git a/crates/solidity/testing/snapshots/cst_output/SourceUnit/empty_multiline_over_natspec/generated/0.4.11-success.yml b/crates/solidity/testing/snapshots/cst_output/SourceUnit/empty_multiline_over_natspec/generated/0.4.11-success.yml
@@ -0,0 +1,35 @@
+# This file is generated automatically by infrastructure scripts. Please don't edit by hand.
+
+Source: >
+  1  │ // The below comments should be parsed into two separate tokens, instead of one NatSpec comment: │ 0..96
+  2  │                                                                                                  │ 97..97
+  3  │ contract Foo {                                                                                   │ 98..112
+  4  │   /**/                                                                                           │ 113..119
+  5  │ }                                                                                                │ 120..121
+  6  │ /**/                                                                                             │ 122..126
+
+Errors: []
+
+Tree:
+  - (SourceUnit): # "// The below comments should be parsed into two se..." (0..127)
+      - (members꞉ SourceUnitMembers): # "// The below comments should be parsed into two se..." (0..122)
+          - (item꞉ SourceUnitMember) ► (variant꞉ ContractDefinition): # "// The below comments should be parsed into two se..." (0..122)
+              - (LeadingTrivia): # "// The below comments should be parsed into two se..." (0..98)
+                  - (SingleLineComment): "// The below comments should be parsed into two se..." # (0..96)
+                  - (EndOfLine): "\n" # (96..97)
+                  - (EndOfLine): "\n" # (97..98)
+              - (contract_keyword꞉ ContractKeyword): "contract" # (98..106)
+              - (LeadingTrivia) ► (Whitespace): " " # (106..107)
+              - (name꞉ Identifier): "Foo" # (107..110)
+              - (LeadingTrivia) ► (Whitespace): " " # (110..111)
+              - (open_brace꞉ OpenBrace): "{" # (111..112)
+              - (TrailingTrivia) ► (EndOfLine): "\n" # (112..113)
+              - (LeadingTrivia): # "  /**/\n" (113..120)
+                  - (Whitespace): "  " # (113..115)
+                  - (MultiLineComment): "/**/" # (115..119)
+                  - (EndOfLine): "\n" # (119..120)
+              - (close_brace꞉ CloseBrace): "}" # (120..121)
+              - (TrailingTrivia) ► (EndOfLine): "\n" # (121..122)
+      - (LeadingTrivia): # "/**/\n" (122..127)
+          - (MultiLineComment): "/**/" # (122..126)
+          - (EndOfLine): "\n" # (126..127)
diff --git a/crates/solidity/testing/snapshots/cst_output/SourceUnit/empty_multiline_over_natspec/input.sol b/crates/solidity/testing/snapshots/cst_output/SourceUnit/empty_multiline_over_natspec/input.sol
@@ -0,0 +1,6 @@
+// The below comments should be parsed into two separate tokens, instead of one NatSpec comment:
+
+contract Foo {
+  /**/
+}
+/**/

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@nomicfoundation/slang": patch
 +---
++
 +prioritize parsing `MultiLineComment` over `MultiLineNatSpecComment`