Added support for visual depiction of unsupported commands

test/katex-spec.js

@@ -13,33 +13,39 @@ var Settings = require("../src/Settings");
 
 var defaultSettings = new Settings({});
 
-var getBuilt = function(expr) {
-    expect(expr).toBuild();
+var getBuilt = function(expr, settings) {
+    var usedSettings = settings ? settings : defaultSettings;
 
-    var built = buildHTML(parseTree(expr), defaultSettings);
+    expect(expr).toBuild(usedSettings);
+
+    var parsedTree = parseTree(expr, usedSettings);
+    var built = buildHTML(parsedTree, usedSettings);
 
     // Remove the outer .katex and .katex-inner layers
     return built.children[2].children;
 };
 
-var getParsed = function(expr) {
-    expect(expr).toParse();
+var getParsed = function(expr, settings) {
+    var usedSettings = settings ? settings : defaultSettings;
 
-    return parseTree(expr, defaultSettings);
+    expect(expr).toParse(usedSettings);
+    return parseTree(expr, usedSettings);
 };
 
 beforeEach(function() {
     jasmine.addMatchers({
         toParse: function() {
             return {
-                compare: function(actual) {
+                compare: function(actual, settings) {
+                    var usedSettings = settings ? settings : defaultSettings;
+
                     var result = {
                         pass: true,
                         message: "'" + actual + "' succeeded parsing"
                     };
 
                     try {
-                        parseTree(actual, defaultSettings);
+                        parseTree(actual, usedSettings);
                     } catch (e) {
                         result.pass = false;
                         if (e instanceof ParseError) {
@@ -58,7 +64,9 @@ beforeEach(function() {
 
         toNotParse: function() {
             return {
-                compare: function(actual) {
+                compare: function(actual, settings) {
+                    var usedSettings = settings ? settings : defaultSettings;
+
                     var result = {
                         pass: false,
                         message: "Expected '" + actual + "' to fail " +
@@ -66,7 +74,7 @@ beforeEach(function() {
                     };
 
                     try {
-                        parseTree(actual, defaultSettings);
+                        parseTree(actual, usedSettings);
                     } catch (e) {
                         if (e instanceof ParseError) {
                             result.pass = true;
@@ -85,16 +93,18 @@ beforeEach(function() {
 
         toBuild: function() {
             return {
-                compare: function(actual) {
+                compare: function(actual, settings) {
+                    var usedSettings = settings ? settings : defaultSettings;
+
                     var result = {
                         pass: true,
                         message: "'" + actual + "' succeeded in building"
                     };
 
-                    expect(actual).toParse();
+                    expect(actual).toParse(usedSettings);
 
                     try {
-                        buildHTML(parseTree(actual), defaultSettings);
+                        buildHTML(parseTree(actual, usedSettings), usedSettings);
                     } catch (e) {
                         result.pass = false;
                         if (e instanceof ParseError) {
@@ -1359,10 +1369,12 @@ describe("A cases environment", function() {
 
 });
 
-var getMathML = function(expr) {
-    expect(expr).toParse();
+var getMathML = function(expr, settings) {
+    var usedSettings = settings ? settings : defaultSettings;
 
-    var built = buildMathML(parseTree(expr));
+    expect(expr).toParse(usedSettings);
+
+    var built = buildMathML(parseTree(expr, usedSettings), expr, usedSettings);
 
     // Strip off the surrounding <span>
     return built.children[0];
@@ -1400,3 +1412,45 @@ describe("A MathML builder", function() {
         expect(phantom.children[0].type).toEqual("mphantom");
     });
 });
+
+describe("A parser that does not break on unsupported commands", function() {
+    // The parser breaks on unsupported commands unless it is explicitly
+    // told not to
+    var errorColor = "#933";
+    var doNotBreakSettings = new Settings({
+        breakOnUnsupportedCmds: false,
+        errorColor: errorColor
+    });
+
+    it("should still parse on unrecognized control sequences", function() {
+        expect("\\error").toParse(doNotBreakSettings);
+    });
+
+    describe("should allow unrecognized controls sequences anywhere, including", function() {
+        it("in superscripts and subscripts", function() {
+            expect("2_\\error").toBuild(doNotBreakSettings);
+            expect("3^{\\error}_\\error").toBuild(doNotBreakSettings);
+            expect("\\int\\nolimits^\\error_\\error").toBuild(doNotBreakSettings);
+        });
+
+        it("in fractions", function() {
+            expect("\\frac{345}{\\error}").toBuild(doNotBreakSettings);
+            expect("\\frac\\error{\\error}").toBuild(doNotBreakSettings);
+        });
+
+        it("in square roots", function() {
+            expect("\\sqrt\\error").toBuild(doNotBreakSettings);
+            expect("\\sqrt{234\\error}").toBuild(doNotBreakSettings);
+        });
+
+        it("in text boxes", function() {
+            expect("\\text{\\error}").toBuild(doNotBreakSettings);
+        });
+    });
+
+    it("should produce color nodes with a color value given by errorColor", function() {
+        var parsedInput = getParsed("\\error", doNotBreakSettings);
+        expect(parsedInput[0].type).toBe("color");
+        expect(parsedInput[0].value.color).toBe(errorColor);
+    });
+});

test/screenshotter/ss_data.json

@@ -38,5 +38,6 @@
     "SupSubHorizSpacing": "http://localhost:7936/test/screenshotter/test.html?m=x^{x^{x}}\\Big|x_{x_{x_{x_{x}}}}\\bigg|x^{x^{x_{x_{x_{x_{x}}}}}}\\bigg|",
     "SupSubOffsets": "http://localhost:7936/test/screenshotter/test.html?m=\\displaystyle \\int_{2+3}x f^{2+3}+3\\lim_{2+3+4+5}f",
     "Text": "http://localhost:7936/test/screenshotter/test.html?m=\\frac{a}{b}\\text{c~ {ab} \\ e}+fg",
+    "UnsupportedCmds": "http://localhost:7936/test/screenshotter/test.html?m=\\err\\,\\frac\\fracerr3\\,2^\\superr_\\suberr\\,\\sqrt\\sqrterr&doNotBreak=1&errorColor=%23dd4c4c",
     "VerticalSpacing": "http://localhost:7936/test/screenshotter/test.html?pre=potato<br>blah&post=<br>moo&m=x^{\\Huge y}z"
 }

test/screenshotter/test.html

@@ -25,9 +25,16 @@
           query[match[1]] = decodeURIComponent(match[2]);
       }
       var mathNode = document.getElementById("math");
-      katex.render(query["m"], mathNode, {
-          displayMode: !!query["display"]
-      });
+
+      var settings = {
+          displayMode: !!query["display"],
+          breakOnUnsupportedCmds: !query["doNotBreak"]
+      };
+      if (query["errorColor"]) {
+          settings.errorColor = query["errorColor"];
+      }
+
+      katex.render(query["m"], mathNode, settings);
       document.getElementById("pre").innerHTML = query["pre"] || "";
       document.getElementById("post").innerHTML = query["post"] || "";
     </script>