Allow inline math inside display math (#857)

DistributedProofreaders · Feb 9, 2023 · acea39e · acea39e
1 parent 4042c12
commit acea39e
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 24 deletions.
diff --git a/SETUP/tests/jsTests/formatPreviewTests.js b/SETUP/tests/jsTests/formatPreviewTests.js
@@ -467,6 +467,12 @@ QUnit.module("Format preview test", function() {
         issueTest(assert, 1, 8, 2, "misMatchTag", 1);
     });
 
+    QUnit.test("inline math inside display math", function (assert) {
+        text = "\\[e=mc^2 \\text{abc \\(x=y\\)}\\]";
+        issArray = analyse(text, mathConfig).issues;
+        noIssueTest(assert);
+    });
+
     QUnit.test("missing maths end tag", function (assert) {
         text = "\\[e=mc^2\\(";
         issArray = analyse(text, mathConfig).issues;

diff --git a/tools/proofers/preview.js b/tools/proofers/preview.js
@@ -706,42 +706,75 @@ $(function () {
             }
         }
 
-        // check that math delimiters \[ \], \( \) are correctly matched
+        // check that math delimiters \[ \], \( \) are matched
+        // allow inline math inside display math (in text{})
         function checkMath() {
-            let mathRe = /\\\[|\\\]|\\\(|\\\)/g;
+            var tagStack = [];  // holds start tag [ or (
+            var stackTop;
+            const mathRe = /\\\[|\\\]|\\\(|\\\)/g;
             let result;
-            let tag, openTag = false;
-            let openStart = 0;
+            let tag;
+            let start;
             while((result = mathRe.exec(txt)) !== null) {
+                start = result.index;
                 tag = result[0].charAt(1);
-                // if no open tag and ( or [ set open else error
-                if (!openTag) {
+                if (tagStack.length === 0) {
+                    // no tags on stack
                     if ((tag === '(') || (tag === '[')) {
-                        openTag = tag;
-                        openStart = result.index;
+                        tagStack.push({tag: tag, start: start});
                     } else {
-                        reportIssue(result.index, 2, "noStartTag");
+                        reportIssue(start, 2, "noStartTag");
                     }
                 } else {
-                    if (((openTag === '(') && (tag === ')')) || ((openTag === '[') && (tag === ']'))) {
-                        // correctly matched
-                        openTag = false;
-                    } else if (((openTag === '(') && (tag === ']')) || ((openTag === '[') && (tag === ')'))) {
-                        // mismatched
-                        openTag = false;
-                        reportIssue(openStart, 2, "misMatchTag");
-                        reportIssue(result.index, 2, "misMatchTag");
+                    // there are tags in the stack
+                    stackTop = tagStack[tagStack.length - 1];
+                    if(stackTop.tag === '[') {
+                        // ] or ( ok, [ or ) error
+                        switch(tag) {
+                        case ']':
+                            tagStack.pop();
+                            break;
+                        case '(':
+                            tagStack.push({tag: tag, start: start});
+                            break;
+                        case '[':
+                            // report error for stack tag push the new one
+                            tagStack.pop();
+                            tagStack.push({tag: tag, start: start});
+                            reportIssue(stackTop.start, 2, "noEndTag");
+                            break;
+                        case ')':
+                            tagStack.pop();
+                            reportIssue(stackTop.start, 2, "misMatchTag");
+                            reportIssue(start, 2, "misMatchTag");
+                            break;
+                        }
                     } else {
-                        // a start tag of either sort follows a start tag
-                        reportIssue(openStart, 2, "noEndTag");
-                        openTag = tag;
-                        openStart = result.index;
+                        // stacktop is (, ) ok else error
+                        switch(tag) {
+                        case ')':
+                            tagStack.pop();
+                            break;
+                        case '(':
+                        case '[':
+                            // report error for stack tag push the new one
+                            tagStack.pop();
+                            tagStack.push({tag: tag, start: start});
+                            reportIssue(stackTop.start, 2, "noEndTag");
+                            break;
+                        case ']':
+                            tagStack.pop();
+                            reportIssue(stackTop.start, 2, "misMatchTag");
+                            reportIssue(start, 2, "misMatchTag");
+                            break;
+                        }
                     }
                 }
             }
-            // if there is a tag open mark it as an error
-            if (openTag) {
-                reportIssue(openStart, 2, "noEndTag");
+            // if there are any tags on the stack mark them as errors
+            while (tagStack.length !== 0) {
+                stackTop = tagStack.pop();
+                reportIssue(stackTop.start, 2, "noEndTag");
             }
         }