Fix runaway regex in comment string detection (#42)

* Fix runaway regex in comment string detection * Adding tests * Update version --------- Co-authored-by: AnHeuermann <[email protected]>
AnHeuermann · Mar 15, 2024 · 0355079 · 0355079
1 parent 74d508e
commit 0355079
Show file tree

Hide file tree

Showing 10 changed files with 54 additions and 13 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -20,7 +20,7 @@
       "group": "test",
       "presentation": {
         "reveal": "always",
-        "panel": "new",
+        "panel": "dedicated",
       },
       "problemMatcher": {
         "owner": "vscode-tmgrammar-test",

diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ for more details on the publishing process.
 npm install
 ```
 
-Translate the `*tmGrammar.yaml` files to `*.tmGrammar.json` JSON files.
+Translate the `*.tmGrammar.yaml` files to `*.tmGrammar.json` JSON files.
 Start build task (Ctrl+Shift+B)
 
 ```bash

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "metamodelica",
   "displayName": "MetaModelica",
   "description": "MetaModelica, Susan and Modelica language support.",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "publisher": "AnHeuermann",
   "license": "See LICENSE.txt",
   "engines": {

diff --git a/syntaxes/metamodelica.tmGrammar.yaml b/syntaxes/metamodelica.tmGrammar.yaml
@@ -92,11 +92,13 @@ patterns:
       - name: keyword
     end: \)\s*;
 
-  # Strings
-  - match: (?<![=+]\s*)((?<!\\)"([^"]*|\\")*(?<!\\)")\s*;
+  # Documentation Strings
+  - match: (?<![=+]\s*)((?<!\\)"([^"]|\\")*(?<!\\)")\s*;
     captures:
       1:
         name: comment.line
+
+  # Strings
   - begin: \"
     end: \"
     name: string.quoted.double

diff --git a/syntaxes/modelica.tmGrammar.yaml b/syntaxes/modelica.tmGrammar.yaml
@@ -51,7 +51,7 @@ patterns:
     name: support.type
 
   # Class definitions
-  - begin: \b(model|class|record|block|package|function)\s+(\w+)\s*((?<!\\)"([^"]*|\\")*(?<!\\)")?
+  - begin: \b(model|class|record|block|package|function)\s+(\w+)\s*((?<!\\)"([^"]|\\")*(?<!\\)")?
     beginCaptures:
       1:
         name: keyword
@@ -80,11 +80,13 @@ patterns:
     patterns:
       - include: '#annotations'
 
-  # Strings
-  - match: (?<![=+]\s*)((?<!\\)"([^"]*|\\")*(?<!\\)")\s*;
+  # Documentation Strings
+  - match: (?<![=+]\s*)((?<!\\)"([^"]|\\")*(?<!\\)")\s*;
     captures:
       1:
         name: comment.line
+
+  # Strings
   - begin: \"
     end: \"
     name: string.quoted.double

diff --git a/test/metamodelica/function.test.mo → test/metamodelica/Function.test.mo b/test/metamodelica/function.test.mo → test/metamodelica/Function.test.mo
diff --git a/test/metamodelica/FunctionDoc.test.mo b/test/metamodelica/FunctionDoc.test.mo
@@ -0,0 +1,15 @@
+// SYNTAX TEST "source.metamodelica" "Function with doc string"
+
+public function foo
+  "Function does crazy stuff --fmiFlags
+   and creates an awesome record for stuff.
+   Author: ItIsI"
+  input Boolean isAwesome = true;
+//^^^^^ source.metamodelica keyword.control
+//      ^^^^^^^ source.metamodelica storage.type
+//                          ^^^^ source.metamodelica constant.language
+  output Option<SimCode.Awesome> awesome;
+//^^^^^^ source.metamodelica keyword.control
+//       ^^^^^^^^^^^^^^^^^^^^^^^ source.metamodelica storage.type
+// [...]
+end foo;
diff --git a/test/modelica/Comments.test.mo b/test/modelica/Comments.test.mo
@@ -1,6 +1,8 @@
 // SYNTAX TEST "source.modelica" "Comments"
 
 model M "Documentation"
+//<-- source.modelica keyword
+//    ^ source.modelica entity.name.type
 //      ^^^^^^^^^^^^^^^ source.modelica comment.line
   Real x "Variable \"x\"";
 //       ^^^^^^^^^^^^^^^^ source.modelica comment.line
@@ -28,3 +30,5 @@ model M "Documentation"
 //           ^^^ source.modelica string.quoted.double
 //                 ^^^ source.modelica string.quoted.double
 end M;
+//<-- source.modelica keyword
+//  ^ source.modelica entity.name.type
diff --git a/test/modelica/Function.test.mo b/test/modelica/Function.test.mo
@@ -0,0 +1,18 @@
+// SYNTAX TEST "source.modelica" "Function with doc string"
+
+public function foo
+  "Function does crazy stuff --fmiFlags
+   and creates an awesome record for stuff.
+   Author: ItIsI"
+  input Boolean isAwesome = true;
+//^^^^^ source.modelica keyword.control
+//      ^^^^^^^ source.modelica storage.type
+//                          ^^^^ source.modelica constant.language
+  output MyRecord awesome;
+//^^^^^^ source.modelica keyword.control
+// [...]
+//<--- source.modelica comment.line
+//^^^^^^ source.modelica comment.line
+end foo;
+//<--- source.modelica keyword
+//  ^^^ source.modelica entity.name.type