Fix the bug where a ; or // (start-of-comment characters) in a string would cause the rest of the line to be treated as a comment and would create a parse error.

Fixes #70.

Author: riot-harrisont

CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.13.3
+
+## Bug Fixes
+
+* ([#70](https://github.com/harrisont/fastbuild-vscode/issues/70)) Fix the bug where a `;` or `//` (start-of-comment characters) in a string would cause the rest of the line to be treated as a comment and would create a parse error.
+
 # v0.13.2
 
 ## Bug Fixes

package.json

@@ -2,7 +2,7 @@
 	"name": "fastbuild-support",
 	"displayName": "FASTBuild Support",
 	"description": "FASTBuild language support. Includes go-to definition, find references, variable evaluation, syntax errors, etc.",
-	"version": "0.13.2",
+	"version": "0.13.3",
 	"preview": true,
 	"publisher": "HarrisonT",
 	"author": {

server/src/parser.ts

@@ -343,23 +343,30 @@ function removeComments(input: string): string {
     for (const line of lines) {
         let inSingleQuotedString = false;
         let inDoubleQuotedString = false;
+        let escapeNextChar = false;
         let lineWithCommentRemoved = line;
 
         for (let i = 0, lastNonSpaceIndex = -1; i < line.length; ++i) {
             const char = line[i];
 
-            if (char === "'" && !inDoubleQuotedString) {
-                inSingleQuotedString = !inSingleQuotedString;
-            } else if (char === '"' && !inSingleQuotedString) {
-                inDoubleQuotedString = !inDoubleQuotedString;
-            } else if (!inSingleQuotedString
-                    && !inDoubleQuotedString
-                    && ((char === ';')
-                        || ((char === '/') && (i + 1 < line.length) && (line[i + 1] === '/'))))
-            {
-                // Comment. Strip the rest of the line.
-                lineWithCommentRemoved = line.substring(0, lastNonSpaceIndex + 1);
-                break;
+            if (char === '^') {
+                escapeNextChar = true;
+            } else if (escapeNextChar) {
+                escapeNextChar = false;
+            } else {
+                if (char === "'" && !inDoubleQuotedString) {
+                    inSingleQuotedString = !inSingleQuotedString;
+                } else if (char === '"' && !inSingleQuotedString) {
+                    inDoubleQuotedString = !inDoubleQuotedString;
+                } else if (!inSingleQuotedString
+                        && !inDoubleQuotedString
+                        && ((char === ';')
+                            || ((char === '/') && (i + 1 < line.length) && (line[i + 1] === '/'))))
+                {
+                    // Comment. Strip the rest of the line.
+                    lineWithCommentRemoved = line.substring(0, lastNonSpaceIndex + 1);
+                    break;
+                }
             }
 
             if (char !== ' ') {
@@ -369,4 +376,4 @@ function removeComments(input: string): string {
         modifiedLines.push(lineWithCommentRemoved);
     }
     return modifiedLines.join('\n');
-}
+}

server/src/test/1-parser.test.ts

@@ -416,6 +416,52 @@ describe('parser', () => {
         ]);
     });
 
+    it('should work on assigning a string literal with single quotes with an escaped single quote and a comment character (";") inside', () => {
+        const input = `.MyVar = '^';'`;
+        assertParseResultsEqual(input, [
+            {
+                type: 'variableDefinition',
+                lhs: {
+                    name: {
+                        type: 'string',
+                        value: 'MyVar',
+                        range: createRange(0, 1, 0, 6)
+                    },
+                    scope: 'current',
+                    range: createRange(0, 0, 0, 6),
+                },
+                rhs: {
+                    type: 'string',
+                    value: "';",
+                    range: createRange(0, 9, 0, 14)
+                }
+            }
+        ]);
+    });
+
+    it('should work on assigning a string literal with single quotes with an escaped single quote and a comment character ("//") inside', () => {
+        const input = `.MyVar = '^'//'`;
+        assertParseResultsEqual(input, [
+            {
+                type: 'variableDefinition',
+                lhs: {
+                    name: {
+                        type: 'string',
+                        value: 'MyVar',
+                        range: createRange(0, 1, 0, 6)
+                    },
+                    scope: 'current',
+                    range: createRange(0, 0, 0, 6),
+                },
+                rhs: {
+                    type: 'string',
+                    value: "'//",
+                    range: createRange(0, 9, 0, 15)
+                }
+            }
+        ]);
+    });
+
     it('should work on assigning a string literal with double quotes with an escaped double quote inside', () => {
         const input = `.MyVar = "h^"i"`;
         assertParseResultsEqual(input, [
@@ -439,6 +485,52 @@ describe('parser', () => {
         ]);
     });
 
+    it('should work on assigning a string literal with double quotes with an escaped double quote and a comment character (";") inside', () => {
+        const input = `.MyVar = "^";"`;
+        assertParseResultsEqual(input, [
+            {
+                type: 'variableDefinition',
+                lhs: {
+                    name: {
+                        type: 'string',
+                        value: 'MyVar',
+                        range: createRange(0, 1, 0, 6)
+                    },
+                    scope: 'current',
+                    range: createRange(0, 0, 0, 6),
+                },
+                rhs: {
+                    type: 'string',
+                    value: '";',
+                    range: createRange(0, 9, 0, 14)
+                }
+            }
+        ]);
+    });
+
+    it('should work on assigning a string literal with double quotes with an escaped double quote and a comment character ("//") inside', () => {
+        const input = `.MyVar = "^"//"`;
+        assertParseResultsEqual(input, [
+            {
+                type: 'variableDefinition',
+                lhs: {
+                    name: {
+                        type: 'string',
+                        value: 'MyVar',
+                        range: createRange(0, 1, 0, 6)
+                    },
+                    scope: 'current',
+                    range: createRange(0, 0, 0, 6),
+                },
+                rhs: {
+                    type: 'string',
+                    value: '"//',
+                    range: createRange(0, 9, 0, 15)
+                }
+            }
+        ]);
+    });
+
     it('should work on assigning a string literal with single quotes with a comment-symbol inside (;)', () => {
         const input = `.MyVar = 'h;i'`;
         assertParseResultsEqual(input, [
@@ -3050,4 +3142,4 @@ Expecting to see one of the following:
             assertInputsGenerateSameParseResult(withComments, withoutComments);
         });
     });
-});
+});