katex 0.15.0 → 0.15.1

package/dist/katex.mjs

@@ -9983,6 +9983,17 @@ function defineEnvironment(_ref) {
   }
 }
 
+/**
+ * All registered global/built-in macros.
+ * `macros.js` exports this same dictionary again and makes it public.
+ * `Parser.js` requires this dictionary via `macros.js`.
+ */
+var _macros = {}; // This function might one day accept an additional argument and do more things.
+
+function defineMacro(name, body) {
+  _macros[name] = body;
+}
+
 // Helper functions
 function getHLines(parser) {
   // Return an array. The array length = number of hlines.
@@ -10007,7 +10018,19 @@ var validateAmsEnvironmentContext = context => {
   if (!settings.displayMode) {
     throw new ParseError("{" + context.envName + "} can be used only in" + " display mode.");
   }
-};
+}; // autoTag (an argument to parseArray) can be one of three values:
+// * undefined: Regular (not-top-level) array; no tags on each row
+// * true: Automatic equation numbering, overridable by \tag
+// * false: Tags allowed on each row, but no automatic numbering
+// This function *doesn't* work with the "split" environment name.
+
+
+function getAutoTag(name) {
+  if (name.indexOf("ed") === -1) {
+    return name.indexOf("*") === -1;
+  } // return undefined;
+
+}
 /**
  * Parse the body of the environment, with rows delimited by \\ and
  * columns delimited by &, and create a nested list in row-major order
@@ -10023,7 +10046,7 @@ function parseArray(parser, _ref, style) {
     cols,
     arraystretch,
     colSeparationType,
-    addEqnNum,
+    autoTag,
     singleRow,
     emptySingleRow,
     maxNumCols,
@@ -10058,7 +10081,29 @@ function parseArray(parser, _ref, style) {
   var row = [];
   var body = [row];
   var rowGaps = [];
-  var hLinesBeforeRow = []; // Test for \hline at the top of the array.
+  var hLinesBeforeRow = [];
+  var tags = autoTag != null ? [] : undefined; // amsmath uses \global\@eqnswtrue and \global\@eqnswfalse to represent
+  // whether this row should have an equation number.  Simulate this with
+  // a \@eqnsw macro set to 1 or 0.
+
+  function beginRow() {
+    if (autoTag) {
+      parser.gullet.macros.set("\\@eqnsw", "1", true);
+    }
+  }
+
+  function endRow() {
+    if (tags) {
+      if (parser.gullet.macros.get("\\df@tag")) {
+        tags.push(parser.subparse([new Token("\\df@tag")]));
+        parser.gullet.macros.set("\\df@tag", undefined, true);
+      } else {
+        tags.push(Boolean(autoTag) && parser.gullet.macros.get("\\@eqnsw") === "1");
+      }
+    }
+  }
+
+  beginRow(); // Test for \hline at the top of the array.
 
   hLinesBeforeRow.push(getHLines(parser));
 
@@ -10099,10 +10144,11 @@ function parseArray(parser, _ref, style) {
 
       parser.consume();
     } else if (next === "\\end") {
-      // Arrays terminate newlines with `\crcr` which consumes a `\cr` if
+      endRow(); // Arrays terminate newlines with `\crcr` which consumes a `\cr` if
       // the last line is empty.  However, AMS environments keep the
       // empty row if it's the only one.
       // NOTE: Currently, `cell` is the last item added into `row`.
+
       if (row.length === 1 && cell.type === "styling" && cell.body[0].body.length === 0 && (body.length > 1 || !emptySingleRow)) {
         body.pop();
       }
@@ -10124,11 +10170,13 @@ function parseArray(parser, _ref, style) {
         size = parser.parseSizeGroup(true);
       }
 
-      rowGaps.push(size ? size.value : null); // check for \hline(s) following the row separator
+      rowGaps.push(size ? size.value : null);
+      endRow(); // check for \hline(s) following the row separator
 
       hLinesBeforeRow.push(getHLines(parser));
       row = [];
       body.push(row);
+      beginRow();
     } else {
       throw new ParseError("Expected & or \\\\ or \\cr or \\end", parser.nextToken);
     }
@@ -10149,7 +10197,7 @@ function parseArray(parser, _ref, style) {
     hskipBeforeAndAfter,
     hLinesBeforeRow,
     colSeparationType,
-    addEqnNum,
+    tags,
     leqno
   };
 } // Decides on a style for cells in an array according to whether the given
@@ -10287,20 +10335,33 @@ var htmlBuilder$7 = function htmlBuilder(group, options) {
   var cols = [];
   var colSep;
   var colDescrNum;
-  var eqnNumSpans = [];
+  var tagSpans = [];
 
-  if (group.addEqnNum) {
-    // An environment with automatic equation numbers.
-    // Create node(s) that will trigger CSS counter increment.
+  if (group.tags && group.tags.some(tag => tag)) {
+    // An environment with manual tags and/or automatic equation numbers.
+    // Create node(s), the latter of which trigger CSS counter increment.
     for (r = 0; r < nr; ++r) {
       var rw = body[r];
       var shift = rw.pos - offset;
-      var eqnTag = buildCommon.makeSpan(["eqn-num"], [], options);
-      eqnTag.depth = rw.depth;
-      eqnTag.height = rw.height;
-      eqnNumSpans.push({
+      var tag = group.tags[r];
+      var tagSpan = void 0;
+
+      if (tag === true) {
+        // automatic numbering
+        tagSpan = buildCommon.makeSpan(["eqn-num"], [], options);
+      } else if (tag === false) {
+        // \nonumber/\notag or starred environment
+        tagSpan = buildCommon.makeSpan([], [], options);
+      } else {
+        // manual \tag
+        tagSpan = buildCommon.makeSpan([], buildExpression$1(tag, options, true), options);
+      }
+
+      tagSpan.depth = rw.depth;
+      tagSpan.height = rw.height;
+      tagSpans.push({
         type: "elem",
-        elem: eqnTag,
+        elem: tagSpan,
         shift
       });
     }
@@ -10436,12 +10497,12 @@ var htmlBuilder$7 = function htmlBuilder(group, options) {
     }, options);
   }
 
-  if (!group.addEqnNum) {
+  if (tagSpans.length === 0) {
     return buildCommon.makeSpan(["mord"], [body], options);
   } else {
     var eqnNumCol = buildCommon.makeVList({
       positionType: "individualShift",
-      children: eqnNumSpans
+      children: tagSpans
     }, options);
     eqnNumCol = buildCommon.makeSpan(["tag"], [eqnNumCol], options);
     return buildCommon.makeFragment([body, eqnNumCol]);
@@ -10467,7 +10528,7 @@ var mathmlBuilder$6 = function mathmlBuilder(group, options) {
       row.push(new mathMLTree.MathNode("mtd", [buildGroup(rw[j], options)]));
     }
 
-    if (group.addEqnNum) {
+    if (group.tags && group.tags[i]) {
       row.unshift(glue);
       row.push(glue);
 
@@ -10602,13 +10663,14 @@ var alignedHandler = function alignedHandler(context, args) {
 
   var cols = [];
   var separationType = context.envName.indexOf("at") > -1 ? "alignat" : "align";
+  var isSplit = context.envName === "split";
   var res = parseArray(context.parser, {
     cols,
     addJot: true,
-    addEqnNum: context.envName === "align" || context.envName === "alignat",
+    autoTag: isSplit ? undefined : getAutoTag(context.envName),
     emptySingleRow: true,
     colSeparationType: separationType,
-    maxNumCols: context.envName === "split" ? 2 : undefined,
+    maxNumCols: isSplit ? 2 : undefined,
     leqno: context.parser.settings.leqno
   }, "display"); // Determining number of columns.
   // 1. If the first argument is given, we use it as a number of columns,
@@ -10968,7 +11030,7 @@ defineEnvironment({
       }],
       addJot: true,
       colSeparationType: "gather",
-      addEqnNum: context.envName === "gather",
+      autoTag: getAutoTag(context.envName),
       emptySingleRow: true,
       leqno: context.parser.settings.leqno
     };
@@ -11001,7 +11063,7 @@ defineEnvironment({
   handler(context) {
     validateAmsEnvironmentContext(context);
     var res = {
-      addEqnNum: context.envName === "equation",
+      autoTag: getAutoTag(context.envName),
       emptySingleRow: true,
       singleRow: true,
       maxNumCols: 1,
@@ -11027,7 +11089,9 @@ defineEnvironment({
 
   htmlBuilder: htmlBuilder$7,
   mathmlBuilder: mathmlBuilder$6
-}); // Catch \hline outside array environment
+});
+defineMacro("\\nonumber", "\\gdef\\@eqnsw{0}");
+defineMacro("\\notag", "\\nonumber"); // Catch \hline outside array environment
 
 defineFunction({
   type: "text",
@@ -13153,17 +13217,6 @@ defineFunction({
   mathmlBuilder: mathmlBuilder$1
 });
 
-/**
- * All registered global/built-in macros.
- * `macros.js` exports this same dictionary again and makes it public.
- * `Parser.js` requires this dictionary via `macros.js`.
- */
-var _macros = {}; // This function might one day accept an additional argument and do more things.
-
-function defineMacro(name, body) {
-  _macros[name] = body;
-}
-
 // NOTE: Unlike most `htmlBuilder`s, this one handles not only
 // "operatorname", but also  "supsub" since \operatorname* can
 // affect super/subscripting.
@@ -14812,7 +14865,7 @@ class Namespace {
 
     for (var undef in undefs) {
       if (undefs.hasOwnProperty(undef)) {
-        if (undefs[undef] === undefined) {
+        if (undefs[undef] == null) {
           delete this.current[undef];
         } else {
           this.current[undef] = undefs[undef];
@@ -14862,6 +14915,7 @@ class Namespace {
    * Local set() sets the current value and (when appropriate) adds an undo
    * operation to the undo stack.  Global set() may change the undo
    * operation at every level, so takes time linear in their number.
+   * A value of undefined means to delete existing definitions.
    */
 
 
@@ -14893,7 +14947,11 @@ class Namespace {
       }
     }
 
-    this.current[name] = value;
+    if (value == null) {
+      delete this.current[name];
+    } else {
+      this.current[name] = value;
+    }
   }
 
 }
@@ -16831,6 +16889,25 @@ class Parser {
       this.gullet.endGroups();
     }
   }
+  /**
+   * Fully parse a separate sequence of tokens as a separate job.
+   * Tokens should be specified in reverse order, as in a MacroDefinition.
+   */
+
+
+  subparse(tokens) {
+    // Save the next token from the current job.
+    var oldToken = this.nextToken;
+    this.consume(); // Run the new job, terminating it with an excess '}'
+
+    this.gullet.pushToken(new Token("}"));
+    this.gullet.pushTokens(tokens);
+    var parse = this.parseExpression(false);
+    this.expect("}"); // Restore the next token from the current job.
+
+    this.nextToken = oldToken;
+    return parse;
+  }
 
   /**
    * Parses an "expression", which is a list of atoms.
@@ -17772,12 +17849,11 @@ var parseTree = function parseTree(toParse, settings) {
       throw new ParseError("\\tag works only in display equations");
     }
 
-    parser.gullet.feed("\\df@tag");
     tree = [{
       type: "tag",
       mode: "text",
       body: tree,
-      tag: parser.parse()
+      tag: parser.subparse([new Token("\\df@tag")])
     }];
   }
 
@@ -17879,7 +17955,7 @@ var katex = {
   /**
    * Current KaTeX version
    */
-  version: "0.15.0",
+  version: "0.15.1",
 
   /**
    * Renders the given LaTeX into an HTML+MathML combination, and adds

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "katex",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "Fast math typesetting for the web.",
   "main": "dist/katex.js",
   "exports": {

package/src/Namespace.js

@@ -15,7 +15,7 @@ export type Mapping<Value> = {[string]: Value};
 export default class Namespace<Value> {
     current: Mapping<Value>;
     builtins: Mapping<Value>;
-    undefStack: Mapping<Value>[];
+    undefStack: Mapping<?Value>[];
 
     /**
      * Both arguments are optional.  The first argument is an object of
@@ -48,7 +48,7 @@ export default class Namespace<Value> {
         const undefs = this.undefStack.pop();
         for (const undef in undefs) {
             if (undefs.hasOwnProperty(undef)) {
-                if (undefs[undef] === undefined) {
+                if (undefs[undef] == null) {
                     delete this.current[undef];
                 } else {
                     this.current[undef] = undefs[undef];
@@ -97,8 +97,9 @@ export default class Namespace<Value> {
      * Local set() sets the current value and (when appropriate) adds an undo
      * operation to the undo stack.  Global set() may change the undo
      * operation at every level, so takes time linear in their number.
+     * A value of undefined means to delete existing definitions.
      */
-    set(name: string, value: Value, global: boolean = false) {
+    set(name: string, value: ?Value, global: boolean = false) {
         if (global) {
             // Global set is equivalent to setting in all groups.  Simulate this
             // by destroying any undos currently scheduled for this name,
@@ -119,6 +120,10 @@ export default class Namespace<Value> {
                 top[name] = this.current[name];
             }
         }
-        this.current[name] = value;
+        if (value == null) {
+            delete this.current[name];
+        } else {
+            this.current[name] = value;
+        }
     }
 }

package/src/Parser.js

@@ -150,6 +150,27 @@ export default class Parser {
         }
     }
 
+    /**
+     * Fully parse a separate sequence of tokens as a separate job.
+     * Tokens should be specified in reverse order, as in a MacroDefinition.
+     */
+    subparse(tokens: Token[]): AnyParseNode[] {
+        // Save the next token from the current job.
+        const oldToken = this.nextToken;
+        this.consume();
+
+        // Run the new job, terminating it with an excess '}'
+        this.gullet.pushToken(new Token("}"));
+        this.gullet.pushTokens(tokens);
+        const parse = this.parseExpression(false);
+        this.expect("}");
+
+        // Restore the next token from the current job.
+        this.nextToken = oldToken;
+
+        return parse;
+    }
+
     static endOfExpression: string[] = ["}", "\\endgroup", "\\end", "\\right", "&"];
 
     /**

package/src/environments/array.js

@@ -4,10 +4,12 @@ import Style from "../Style";
 import defineEnvironment from "../defineEnvironment";
 import {parseCD} from "./cd";
 import defineFunction from "../defineFunction";
+import defineMacro from "../defineMacro";
 import mathMLTree from "../mathMLTree";
 import ParseError from "../ParseError";
 import {assertNodeType, assertSymbolNodeType} from "../parseNode";
 import {checkSymbolNodeType} from "../parseNode";
+import {Token} from "../Token";
 import {calculateSize, makeEm} from "../units";
 import utils from "../utils";
 
@@ -54,6 +56,18 @@ const validateAmsEnvironmentContext = context => {
     }
 };
 
+// autoTag (an argument to parseArray) can be one of three values:
+// * undefined: Regular (not-top-level) array; no tags on each row
+// * true: Automatic equation numbering, overridable by \tag
+// * false: Tags allowed on each row, but no automatic numbering
+// This function *doesn't* work with the "split" environment name.
+function getAutoTag(name): ?boolean {
+    if (name.indexOf("ed") === -1) {
+        return name.indexOf("*") === -1;
+    }
+    // return undefined;
+}
+
 /**
  * Parse the body of the environment, with rows delimited by \\ and
  * columns delimited by &, and create a nested list in row-major order
@@ -68,7 +82,7 @@ function parseArray(
         cols,
         arraystretch,
         colSeparationType,
-        addEqnNum,
+        autoTag,
         singleRow,
         emptySingleRow,
         maxNumCols,
@@ -79,7 +93,7 @@ function parseArray(
         cols?: AlignSpec[],
         arraystretch?: number,
         colSeparationType?: ColSeparationType,
-        addEqnNum?: boolean,
+        autoTag?: ?boolean,
         singleRow?: boolean,
         emptySingleRow?: boolean,
         maxNumCols?: number,
@@ -116,6 +130,29 @@ function parseArray(
     const rowGaps = [];
     const hLinesBeforeRow = [];
 
+    const tags = (autoTag != null ? [] : undefined);
+
+    // amsmath uses \global\@eqnswtrue and \global\@eqnswfalse to represent
+    // whether this row should have an equation number.  Simulate this with
+    // a \@eqnsw macro set to 1 or 0.
+    function beginRow() {
+        if (autoTag) {
+            parser.gullet.macros.set("\\@eqnsw", "1", true);
+        }
+    }
+    function endRow() {
+        if (tags) {
+            if (parser.gullet.macros.get("\\df@tag")) {
+                tags.push(parser.subparse([new Token("\\df@tag")]));
+                parser.gullet.macros.set("\\df@tag", undefined, true);
+            } else {
+                tags.push(Boolean(autoTag) &&
+                    parser.gullet.macros.get("\\@eqnsw") === "1");
+            }
+        }
+    }
+    beginRow();
+
     // Test for \hline at the top of the array.
     hLinesBeforeRow.push(getHLines(parser));
 
@@ -154,6 +191,7 @@ function parseArray(
             }
             parser.consume();
         } else if (next === "\\end") {
+            endRow();
             // Arrays terminate newlines with `\crcr` which consumes a `\cr` if
             // the last line is empty.  However, AMS environments keep the
             // empty row if it's the only one.
@@ -179,12 +217,14 @@ function parseArray(
                 size = parser.parseSizeGroup(true);
             }
             rowGaps.push(size ? size.value : null);
+            endRow();
 
             // check for \hline(s) following the row separator
             hLinesBeforeRow.push(getHLines(parser));
 
             row = [];
             body.push(row);
+            beginRow();
         } else {
             throw new ParseError("Expected & or \\\\ or \\cr or \\end",
                                  parser.nextToken);
@@ -207,7 +247,7 @@ function parseArray(
         hskipBeforeAndAfter,
         hLinesBeforeRow,
         colSeparationType,
-        addEqnNum,
+        tags,
         leqno,
     };
 }
@@ -339,17 +379,27 @@ const htmlBuilder: HtmlBuilder<"array"> = function(group, options) {
     let colSep;
     let colDescrNum;
 
-    const eqnNumSpans = [];
-    if (group.addEqnNum) {
-        // An environment with automatic equation numbers.
-        // Create node(s) that will trigger CSS counter increment.
+    const tagSpans = [];
+    if (group.tags && group.tags.some((tag) => tag)) {
+        // An environment with manual tags and/or automatic equation numbers.
+        // Create node(s), the latter of which trigger CSS counter increment.
         for (r = 0; r < nr; ++r) {
             const rw = body[r];
             const shift = rw.pos - offset;
-            const eqnTag = buildCommon.makeSpan(["eqn-num"], [], options);
-            eqnTag.depth = rw.depth;
-            eqnTag.height = rw.height;
-            eqnNumSpans.push({type: "elem", elem: eqnTag, shift});
+            const tag = group.tags[r];
+            let tagSpan;
+            if (tag === true) {  // automatic numbering
+                tagSpan = buildCommon.makeSpan(["eqn-num"], [], options);
+            } else if (tag === false) {
+                // \nonumber/\notag or starred environment
+                tagSpan = buildCommon.makeSpan([], [], options);
+            } else {  // manual \tag
+                tagSpan = buildCommon.makeSpan([],
+                    html.buildExpression(tag, options, true), options);
+            }
+            tagSpan.depth = rw.depth;
+            tagSpan.height = rw.height;
+            tagSpans.push({type: "elem", elem: tagSpan, shift});
         }
     }
 
@@ -465,12 +515,12 @@ const htmlBuilder: HtmlBuilder<"array"> = function(group, options) {
         }, options);
     }
 
-    if (!group.addEqnNum) {
+    if (tagSpans.length === 0) {
         return buildCommon.makeSpan(["mord"], [body], options);
     } else {
         let eqnNumCol = buildCommon.makeVList({
             positionType: "individualShift",
-            children: eqnNumSpans,
+            children: tagSpans,
         }, options);
         eqnNumCol = buildCommon.makeSpan(["tag"], [eqnNumCol], options);
         return buildCommon.makeFragment([body, eqnNumCol]);
@@ -494,7 +544,7 @@ const mathmlBuilder: MathMLBuilder<"array"> = function(group, options) {
             row.push(new mathMLTree.MathNode("mtd",
                 [mml.buildGroup(rw[j], options)]));
         }
-        if (group.addEqnNum) {
+        if (group.tags && group.tags[i]) {
             row.unshift(glue);
             row.push(glue);
             if (group.leqno) {
@@ -631,14 +681,15 @@ const alignedHandler = function(context, args) {
     }
     const cols = [];
     const separationType = context.envName.indexOf("at") > -1 ? "alignat" : "align";
+    const isSplit = context.envName === "split";
     const res = parseArray(context.parser,
         {
             cols,
             addJot: true,
-            addEqnNum: context.envName === "align" || context.envName === "alignat",
+            autoTag: isSplit ? undefined : getAutoTag(context.envName),
             emptySingleRow: true,
             colSeparationType: separationType,
-            maxNumCols: context.envName === "split" ? 2 : undefined,
+            maxNumCols: isSplit ? 2 : undefined,
             leqno: context.parser.settings.leqno,
         },
         "display"
@@ -984,7 +1035,7 @@ defineEnvironment({
             }],
             addJot: true,
             colSeparationType: "gather",
-            addEqnNum: context.envName === "gather",
+            autoTag: getAutoTag(context.envName),
             emptySingleRow: true,
             leqno: context.parser.settings.leqno,
         };
@@ -1017,7 +1068,7 @@ defineEnvironment({
     handler(context) {
         validateAmsEnvironmentContext(context);
         const res = {
-            addEqnNum: context.envName === "equation",
+            autoTag: getAutoTag(context.envName),
             emptySingleRow: true,
             singleRow: true,
             maxNumCols: 1,
@@ -1043,6 +1094,9 @@ defineEnvironment({
     mathmlBuilder,
 });
 
+defineMacro("\\nonumber", "\\gdef\\@eqnsw{0}");
+defineMacro("\\notag", "\\nonumber");
+
 // Catch \hline outside array environment
 defineFunction({
     type: "text", // Doesn't matter what this is.

package/src/parseNode.js

@@ -39,7 +39,8 @@ type ParseNodeTypes = {
         body: AnyParseNode[][], // List of rows in the (2D) array.
         rowGaps: (?Measurement)[],
         hLinesBeforeRow: Array<boolean[]>,
-        addEqnNum?: boolean,
+        // Whether each row should be automatically numbered, or an explicit tag
+        tags?: (boolean | AnyParseNode[])[],
         leqno?: boolean,
         isCD?: boolean,
     |},

package/src/parseTree.js

@@ -6,6 +6,7 @@
 
 import Parser from "./Parser";
 import ParseError from "./ParseError";
+import {Token} from "./Token";
 
 import type Settings from "./Settings";
 import type {AnyParseNode} from "./parseNode";
@@ -34,12 +35,11 @@ const parseTree = function(toParse: string, settings: Settings): AnyParseNode[]
         if (!settings.displayMode) {
             throw new ParseError("\\tag works only in display equations");
         }
-        parser.gullet.feed("\\df@tag");
         tree = [{
             type: "tag",
             mode: "text",
             body: tree,
-            tag: parser.parse(),
+            tag: parser.subparse([new Token("\\df@tag")]),
         }];
     }