katex 0.10.1 → 0.12.0

package/src/parseNode.js

@@ -1,7 +1,7 @@
 // @flow
 import {NON_ATOMS} from "./symbols";
 import type SourceLocation from "./SourceLocation";
-import type {AlignSpec} from "./environments/array";
+import type {AlignSpec, ColSeparationType} from "./environments/array";
 import type {Atom} from "./symbols";
 import type {Mode, StyleStr} from "./types";
 import type {Token} from "./Token";
@@ -19,6 +19,9 @@ export type SymbolParseNode =
     ParseNode<"spacing"> |
     ParseNode<"textord">;
 
+// ParseNode from `Parser.formatUnsupportedCmd`
+export type UnsupportedCmdParseNode = ParseNode<"color">;
+
 // Union of all possible `ParseNode<>` types.
 export type AnyParseNode = $Values<ParseNodeTypes>;
 
@@ -28,6 +31,7 @@ type ParseNodeTypes = {
         type: "array",
         mode: Mode,
         loc?: ?SourceLocation,
+        colSeparationType?: ColSeparationType,
         hskipBeforeAndAfter?: boolean,
         addJot?: boolean,
         cols?: AlignSpec[],
@@ -60,6 +64,7 @@ type ParseNodeTypes = {
         limits: boolean,
         alwaysHandleSupSub?: boolean,
         suppressBaseShift?: boolean,
+        parentIsSupSub: boolean,
         symbol: boolean,
         name: string,
         body?: void,
@@ -70,6 +75,7 @@ type ParseNodeTypes = {
         limits: boolean,
         alwaysHandleSupSub?: boolean,
         suppressBaseShift?: boolean,
+        parentIsSupSub: boolean,
         symbol: false,  // If 'symbol' is true, `body` *must* be set.
         name?: void,
         body: AnyParseNode[],
@@ -264,6 +270,13 @@ type ParseNodeTypes = {
         href: string,
         body: AnyParseNode[],
     |},
+    "html": {|
+        type: "html",
+        mode: Mode,
+        loc?: ?SourceLocation,
+        attributes: {[string]: string},
+        body: AnyParseNode[],
+    |},
     "htmlmathml": {|
         type: "htmlmathml",
         mode: Mode,
@@ -271,6 +284,16 @@ type ParseNodeTypes = {
         html: AnyParseNode[],
         mathml: AnyParseNode[],
     |},
+    "includegraphics": {|
+        type: "includegraphics",
+        mode: Mode,
+        loc?: ?SourceLocation,
+        alt: string,
+        width: Measurement,
+        height: Measurement,
+        totalheight: Measurement,
+        src: string,
+    |},
     "infix": {|
         type: "infix",
         mode: Mode,
@@ -279,6 +302,11 @@ type ParseNodeTypes = {
         size?: Measurement,
         token: ?Token,
     |},
+    "internal": {|
+        type: "internal",
+        mode: Mode,
+        loc?: ?SourceLocation,
+    |},
     "kern": {|
         type: "kern",
         mode: Mode,
@@ -299,12 +327,14 @@ type ParseNodeTypes = {
         body: AnyParseNode[],
         left: string,
         right: string,
+        rightColor: ?string, // undefined means "inherit"
     |},
     "leftright-right": {|
         type: "leftright-right",
         mode: Mode,
         loc?: ?SourceLocation,
         delim: string,
+        color: ?string, // undefined means "inherit"
     |},
     "mathchoice": {|
         type: "mathchoice",
@@ -327,12 +357,16 @@ type ParseNodeTypes = {
         loc?: ?SourceLocation,
         mclass: string,
         body: AnyParseNode[],
+        isCharacterBox: boolean,
     |},
     "operatorname": {|
         type: "operatorname",
         mode: Mode,
         loc?: ?SourceLocation,
         body: AnyParseNode[],
+        alwaysHandleSupSub: boolean,
+        limits: boolean,
+        parentIsSupSub: boolean,
     |},
     "overline": {|
         type: "overline",
@@ -419,66 +453,12 @@ export function assertNodeType<NODETYPE: NodeType>(
     node: ?AnyParseNode,
     type: NODETYPE,
 ): ParseNode<NODETYPE> {
-    const typedNode = checkNodeType(node, type);
-    if (!typedNode) {
+    if (!node || node.type !== type) {
         throw new Error(
             `Expected node of type ${type}, but got ` +
             (node ? `node of type ${node.type}` : String(node)));
     }
-    // $FlowFixMe: Unsure why.
-    return typedNode;
-}
-
-/**
- * Returns the node more strictly typed iff it is of the given type. Otherwise,
- * returns null.
- */
-export function checkNodeType<NODETYPE: NodeType>(
-    node: ?AnyParseNode,
-    type: NODETYPE,
-): ?ParseNode<NODETYPE> {
-    if (node && node.type === type) {
-        // The definition of ParseNode<TYPE> doesn't communicate to flow that
-        // `type: TYPE` (as that's not explicitly mentioned anywhere), though that
-        // happens to be true for all our value types.
-        // $FlowFixMe
-        return node;
-    }
-    return null;
-}
-
-/**
- * Asserts that the node is of the given type and returns it with stricter
- * typing. Throws if the node's type does not match.
- */
-export function assertAtomFamily(
-    node: ?AnyParseNode,
-    family: Atom,
-): ParseNode<"atom"> {
-    const typedNode = checkAtomFamily(node, family);
-    if (!typedNode) {
-        throw new Error(
-            `Expected node of type "atom" and family "${family}", but got ` +
-            (node ?
-                (node.type === "atom" ?
-                    `atom of family ${node.family}` :
-                    `node of type ${node.type}`) :
-                String(node)));
-    }
-    return typedNode;
-}
-
-/**
- * Returns the node more strictly typed iff it is of the given type. Otherwise,
- * returns null.
- */
-export function checkAtomFamily(
-    node: ?AnyParseNode,
-    family: Atom,
-): ?ParseNode<"atom"> {
-    return node && node.type === "atom" && node.family === family ?
-        node :
-        null;
+    return node;
 }
 
 /**

package/src/stretchy.js

@@ -25,8 +25,10 @@ const stretchyCodePoint: {[string]: string} = {
     overrightarrow: "\u2192",
     underrightarrow: "\u2192",
     xrightarrow: "\u2192",
-    underbrace: "\u23b5",
+    underbrace: "\u23df",
     overbrace: "\u23de",
+    overgroup: "\u23e0",
+    undergroup: "\u23e1",
     overleftrightarrow: "\u2194",
     underleftrightarrow: "\u2194",
     xleftrightarrow: "\u2194",

package/src/svgGeometry.js

@@ -1,60 +1,155 @@
 // @flow
 /**
- * This file provides support to domTree.js
+ * This file provides support to domTree.js and delimiter.js.
  * It's a storehouse of path geometry for SVG images.
  */
 
 // In all paths below, the viewBox-to-em scale is 1000:1.
 
-const hLinePad = 80;  // padding above a sqrt viniculum.
-
-const path: {[string]: string} = {
+const hLinePad = 80;  // padding above a sqrt viniculum. Prevents image cropping.
+
+// The viniculum of a \sqrt can be made thicker by a KaTeX rendering option.
+// Think of variable extraViniculum as two detours in the SVG path.
+// The detour begins at the lower left of the area labeled extraViniculum below.
+// The detour proceeds one extraViniculum distance up and slightly to the right,
+// displacing the radiused corner between surd and viniculum. The radius is
+// traversed as usual, then the detour resumes. It goes right, to the end of
+// the very long viniculumn, then down one extraViniculum distance,
+// after which it resumes regular path geometry for the radical.
+/*                                                  viniculum
+                                                   /
+         /▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒←extraViniculum
+        / █████████████████████←0.04em (40 unit) std viniculum thickness
+       / /
+      / /
+     / /\
+    / / surd
+*/
+
+const sqrtMain = function(extraViniculum: number, hLinePad: number): string {
     // sqrtMain path geometry is from glyph U221A in the font KaTeX Main
-    // All surds have 80 units padding above the viniculumn.
-    sqrtMain: `M95,${622 + hLinePad}c-2.7,0,-7.17,-2.7,-13.5,-8c-5.8,-5.3,-9.5,
--10,-9.5,-14c0,-2,0.3,-3.3,1,-4c1.3,-2.7,23.83,-20.7,67.5,-54c44.2,-33.3,65.8,
--50.3,66.5,-51c1.3,-1.3,3,-2,5,-2c4.7,0,8.7,3.3,12,10s173,378,173,378c0.7,0,
-35.3,-71,104,-213c68.7,-142,137.5,-285,206.5,-429c69,-144,104.5,-217.7,106.5,
--221c5.3,-9.3,12,-14,20,-14H400000v40H845.2724s-225.272,467,-225.272,467
-s-235,486,-235,486c-2.7,4.7,-9,7,-19,7c-6,0,-10,-1,-12,-3s-194,-422,-194,-422
-s-65,47,-65,47z M834 ${hLinePad}H400000v40H845z`,
+    return `M95,${622 + extraViniculum + hLinePad}
+c-2.7,0,-7.17,-2.7,-13.5,-8c-5.8,-5.3,-9.5,-10,-9.5,-14
+c0,-2,0.3,-3.3,1,-4c1.3,-2.7,23.83,-20.7,67.5,-54
+c44.2,-33.3,65.8,-50.3,66.5,-51c1.3,-1.3,3,-2,5,-2c4.7,0,8.7,3.3,12,10
+s173,378,173,378c0.7,0,35.3,-71,104,-213c68.7,-142,137.5,-285,206.5,-429
+c69,-144,104.5,-217.7,106.5,-221
+l${extraViniculum / 2.075} -${extraViniculum}
+c5.3,-9.3,12,-14,20,-14
+H400000v${40 + extraViniculum}H845.2724
+s-225.272,467,-225.272,467s-235,486,-235,486c-2.7,4.7,-9,7,-19,7
+c-6,0,-10,-1,-12,-3s-194,-422,-194,-422s-65,47,-65,47z
+M${834 + extraViniculum} ${hLinePad}h400000v${40 + extraViniculum}h-400000z`;
+};
 
+const sqrtSize1 = function(extraViniculum: number, hLinePad: number): string {
     // size1 is from glyph U221A in the font KaTeX_Size1-Regular
-    sqrtSize1: `M263,${601 + hLinePad}c0.7,0,18,39.7,52,119c34,79.3,68.167,
-158.7,102.5,238c34.3,79.3,51.8,119.3,52.5,120c340,-704.7,510.7,-1060.3,512,-1067
-c4.7,-7.3,11,-11,19,-11H40000v40H1012.3s-271.3,567,-271.3,567c-38.7,80.7,-84,
-175,-136,283c-52,108,-89.167,185.3,-111.5,232c-22.3,46.7,-33.8,70.3,-34.5,71
-c-4.7,4.7,-12.3,7,-23,7s-12,-1,-12,-1s-109,-253,-109,-253c-72.7,-168,-109.3,
--252,-110,-252c-10.7,8,-22,16.7,-34,26c-22,17.3,-33.3,26,-34,26s-26,-26,-26,-26
-s76,-59,76,-59s76,-60,76,-60z M1001 ${hLinePad}H40000v40H1012z`,
+    return `M263,${601 + extraViniculum + hLinePad}c0.7,0,18,39.7,52,119
+c34,79.3,68.167,158.7,102.5,238c34.3,79.3,51.8,119.3,52.5,120
+c340,-704.7,510.7,-1060.3,512,-1067
+l${extraViniculum / 2.084} -${extraViniculum}
+c4.7,-7.3,11,-11,19,-11
+H40000v${40 + extraViniculum}H1012.3
+s-271.3,567,-271.3,567c-38.7,80.7,-84,175,-136,283c-52,108,-89.167,185.3,-111.5,232
+c-22.3,46.7,-33.8,70.3,-34.5,71c-4.7,4.7,-12.3,7,-23,7s-12,-1,-12,-1
+s-109,-253,-109,-253c-72.7,-168,-109.3,-252,-110,-252c-10.7,8,-22,16.7,-34,26
+c-22,17.3,-33.3,26,-34,26s-26,-26,-26,-26s76,-59,76,-59s76,-60,76,-60z
+M${1001 + extraViniculum} ${hLinePad}h400000v${40 + extraViniculum}h-400000z`;
+};
 
+const sqrtSize2 = function(extraViniculum: number, hLinePad: number): string {
     // size2 is from glyph U221A in the font KaTeX_Size2-Regular
-    // The 80 units padding is most obvious here. Note start node at M1001 80.
-    sqrtSize2: `M1001,${hLinePad}H400000v40H1013.1s-83.4,268,-264.1,840c-180.7,
-572,-277,876.3,-289,913c-4.7,4.7,-12.7,7,-24,7s-12,0,-12,0c-1.3,-3.3,-3.7,-11.7,
--7,-25c-35.3,-125.3,-106.7,-373.3,-214,-744c-10,12,-21,25,-33,39s-32,39,-32,39
-c-6,-5.3,-15,-14,-27,-26s25,-30,25,-30c26.7,-32.7,52,-63,76,-91s52,-60,52,-60
-s208,722,208,722c56,-175.3,126.3,-397.3,211,-666c84.7,-268.7,153.8,-488.2,207.5,
--658.5c53.7,-170.3,84.5,-266.8,92.5,-289.5c4,-6.7,10,-10,18,-10z
-M1001 ${hLinePad}H400000v40H1013z`,
+    return `M983 ${10 + extraViniculum + hLinePad}
+l${extraViniculum / 3.13} -${extraViniculum}
+c4,-6.7,10,-10,18,-10 H400000v${40 + extraViniculum}
+H1013.1s-83.4,268,-264.1,840c-180.7,572,-277,876.3,-289,913c-4.7,4.7,-12.7,7,-24,7
+s-12,0,-12,0c-1.3,-3.3,-3.7,-11.7,-7,-25c-35.3,-125.3,-106.7,-373.3,-214,-744
+c-10,12,-21,25,-33,39s-32,39,-32,39c-6,-5.3,-15,-14,-27,-26s25,-30,25,-30
+c26.7,-32.7,52,-63,76,-91s52,-60,52,-60s208,722,208,722
+c56,-175.3,126.3,-397.3,211,-666c84.7,-268.7,153.8,-488.2,207.5,-658.5
+c53.7,-170.3,84.5,-266.8,92.5,-289.5z
+M${1001 + extraViniculum} ${hLinePad}h400000v${40 + extraViniculum}h-400000z`;
+};
 
+const sqrtSize3 = function(extraViniculum: number, hLinePad: number): string {
     // size3 is from glyph U221A in the font KaTeX_Size3-Regular
-    sqrtSize3: `M424,${2398 + hLinePad}c-1.3,-0.7,-38.5,-172,-111.5,-514c-73,
--342,-109.8,-513.3,-110.5,-514c0,-2,-10.7,14.3,-32,49c-4.7,7.3,-9.8,15.7,-15.5,
-25c-5.7,9.3,-9.8,16,-12.5,20s-5,7,-5,7c-4,-3.3,-8.3,-7.7,-13,-13s-13,-13,-13,
--13s76,-122,76,-122s77,-121,77,-121s209,968,209,968c0,-2,84.7,-361.7,254,-1079
-c169.3,-717.3,254.7,-1077.7,256,-1081c4,-6.7,10,-10,18,-10H400000v40H1014.6
-s-87.3,378.7,-272.6,1166c-185.3,787.3,-279.3,1182.3,-282,1185c-2,6,-10,9,-24,9
-c-8,0,-12,-0.7,-12,-2z M1001 ${hLinePad}H400000v40H1014z`,
+    return `M424,${2398 + extraViniculum + hLinePad}
+c-1.3,-0.7,-38.5,-172,-111.5,-514c-73,-342,-109.8,-513.3,-110.5,-514
+c0,-2,-10.7,14.3,-32,49c-4.7,7.3,-9.8,15.7,-15.5,25c-5.7,9.3,-9.8,16,-12.5,20
+s-5,7,-5,7c-4,-3.3,-8.3,-7.7,-13,-13s-13,-13,-13,-13s76,-122,76,-122s77,-121,77,-121
+s209,968,209,968c0,-2,84.7,-361.7,254,-1079c169.3,-717.3,254.7,-1077.7,256,-1081
+l${extraViniculum / 4.223} -${extraViniculum}c4,-6.7,10,-10,18,-10 H400000
+v${40 + extraViniculum}H1014.6
+s-87.3,378.7,-272.6,1166c-185.3,787.3,-279.3,1182.3,-282,1185
+c-2,6,-10,9,-24,9
+c-8,0,-12,-0.7,-12,-2z M${1001 + extraViniculum} ${hLinePad}
+h400000v${40 + extraViniculum}h-400000z`;
+};
 
+const sqrtSize4 = function(extraViniculum: number, hLinePad: number): string {
     // size4 is from glyph U221A in the font KaTeX_Size4-Regular
-    sqrtSize4: `M473,${2713 + hLinePad}c339.3,-1799.3,509.3,-2700,510,-2702
-c3.3,-7.3,9.3,-11,18,-11H400000v40H1017.7s-90.5,478,-276.2,1466c-185.7,988,
--279.5,1483,-281.5,1485c-2,6,-10,9,-24,9c-8,0,-12,-0.7,-12,-2c0,-1.3,-5.3,-32,
--16,-92c-50.7,-293.3,-119.7,-693.3,-207,-1200c0,-1.3,-5.3,8.7,-16,30c-10.7,
-21.3,-21.3,42.7,-32,64s-16,33,-16,33s-26,-26,-26,-26s76,-153,76,-153s77,-151,
-77,-151c0.7,0.7,35.7,202,105,604c67.3,400.7,102,602.7,104,606z
-M1001 ${hLinePad}H400000v40H1017z`,
+    return `M473,${2713 + extraViniculum + hLinePad}
+c339.3,-1799.3,509.3,-2700,510,-2702 l${extraViniculum / 5.298} -${extraViniculum}
+c3.3,-7.3,9.3,-11,18,-11 H400000v${40 + extraViniculum}H1017.7
+s-90.5,478,-276.2,1466c-185.7,988,-279.5,1483,-281.5,1485c-2,6,-10,9,-24,9
+c-8,0,-12,-0.7,-12,-2c0,-1.3,-5.3,-32,-16,-92c-50.7,-293.3,-119.7,-693.3,-207,-1200
+c0,-1.3,-5.3,8.7,-16,30c-10.7,21.3,-21.3,42.7,-32,64s-16,33,-16,33s-26,-26,-26,-26
+s76,-153,76,-153s77,-151,77,-151c0.7,0.7,35.7,202,105,604c67.3,400.7,102,602.7,104,
+606zM${1001 + extraViniculum} ${hLinePad}h400000v${40 + extraViniculum}H1017.7z`;
+};
+
+const sqrtTall = function(
+    extraViniculum: number,
+    hLinePad: number,
+    viewBoxHeight: number
+): string {
+    // sqrtTall is from glyph U23B7 in the font KaTeX_Size4-Regular
+    // One path edge has a variable length. It runs vertically from the viniculumn
+    // to a point near (14 units) the bottom of the surd. The viniculum
+    // is normally 40 units thick. So the length of the line in question is:
+    const vertSegment = viewBoxHeight - 54 - hLinePad - extraViniculum;
+
+    return `M702 ${extraViniculum + hLinePad}H400000${40 + extraViniculum}
+H742v${vertSegment}l-4 4-4 4c-.667.7 -2 1.5-4 2.5s-4.167 1.833-6.5 2.5-5.5 1-9.5 1
+h-12l-28-84c-16.667-52-96.667 -294.333-240-727l-212 -643 -85 170
+c-4-3.333-8.333-7.667-13 -13l-13-13l77-155 77-156c66 199.333 139 419.667
+219 661 l218 661zM702 ${hLinePad}H400000v${40 + extraViniculum}H742z`;
+};
+
+export const sqrtPath = function(
+    size: string,
+    extraViniculum: number,
+    viewBoxHeight: number
+): string {
+    extraViniculum = 1000 * extraViniculum; // Convert from document ems to viewBox.
+    let path = "";
+
+    switch (size) {
+        case "sqrtMain":
+            path = sqrtMain(extraViniculum, hLinePad);
+            break;
+        case "sqrtSize1":
+            path = sqrtSize1(extraViniculum, hLinePad);
+            break;
+        case "sqrtSize2":
+            path = sqrtSize2(extraViniculum, hLinePad);
+            break;
+        case "sqrtSize3":
+            path = sqrtSize3(extraViniculum, hLinePad);
+            break;
+        case "sqrtSize4":
+            path = sqrtSize4(extraViniculum, hLinePad);
+            break;
+        case "sqrtTall":
+            path = sqrtTall(extraViniculum, hLinePad, viewBoxHeight);
+    }
+    return path;
+};
+
+export const path: {[string]: string} = {
+    // Two paths that cover gaps in built-up parentheses.
+    leftParenInner: `M291 0 H417 V300 H291 z`,
+    rightParenInner: `M457 0 H583 V300 H457 z`,
 
     // The doubleleftarrow geometry is from glyph U+21D0 in the font KaTeX Main
     doubleleftarrow: `M262 157
@@ -363,6 +458,3 @@ c4.7,-4.7,7,-9.3,7,-14c0,-9.3,-3.7,-15.3,-11,-18c-92.7,-56.7,-159,-133.7,-199,
 c-2,2.7,-1,9.7,3,21c15.3,42,36.7,81.8,64,119.5c27.3,37.7,58,69.2,92,94.5z
 M500 241 v40 H399408 v-40z M500 435 v40 H400000 v-40z`,
 };
-
-
-export default {path};