Merge pull request #697 from mathjax/mathtools-update

Mathtools update
mathjax · Jun 8, 2021 · 3d2a44c · 3d2a44c
2 parents 3e2c672 + ced45f9
commit 3d2a44c
Show file tree

Hide file tree

Showing 26 changed files with 1,715 additions and 178 deletions.
diff --git a/components/src/dependencies.js b/components/src/dependencies.js
@@ -21,6 +21,7 @@ export const dependencies = {
   '[tex]/enclose': ['input/tex-base'],
   '[tex]/extpfeil': ['input/tex-base', '[tex]/newcommand', '[tex]/ams'],
   '[tex]/html': ['input/tex-base'],
+  '[tex]/mathtools': ['input/tex-base', '[tex]/newcommand', '[tex]/ams'],
   '[tex]/mhchem': ['input/tex-base', '[tex]/ams'],
   '[tex]/newcommand': ['input/tex-base'],
   '[tex]/noerrors': ['input/tex-base'],
@@ -56,6 +57,7 @@ const allPackages = [
   '[tex]/enclose',
   '[tex]/extpfeil',
   '[tex]/html',
+  '[tex]/mathtools',
   '[tex]/mhchem',
   '[tex]/newcommand',
   '[tex]/noerrors',

diff --git a/components/src/input/tex/extensions/mathtools/build.json b/components/src/input/tex/extensions/mathtools/build.json
@@ -0,0 +1,4 @@
+{
+  "component": "input/tex/extensions/mathtools",
+  "targets": ["input/tex/mathtools"]
+}
diff --git a/components/src/input/tex/extensions/mathtools/mathtools.js b/components/src/input/tex/extensions/mathtools/mathtools.js
@@ -0,0 +1 @@
+import './lib/mathtools.js';
diff --git a/components/src/input/tex/extensions/mathtools/webpack.config.js b/components/src/input/tex/extensions/mathtools/webpack.config.js
@@ -0,0 +1,13 @@
+const PACKAGE = require('../../../../../webpack.common.js');
+
+module.exports = PACKAGE(
+  'input/tex/extensions/mathtools',   // the package to build
+  '../../../../../../js',             // location of the MathJax js library
+  [                                   // packages to link to
+    'components/src/input/tex/extensions/ams/lib',
+    'components/src/input/tex/extensions/newcommand/lib',
+    'components/src/input/tex-base/lib',
+    'components/src/core/lib'
+  ],
+  __dirname                           // our directory
+);
diff --git a/components/src/source.js b/components/src/source.js
@@ -23,6 +23,7 @@ export const source = {
   '[tex]/enclose': `${src}/input/tex/extensions/enclose/enclose.js`,
   '[tex]/extpfeil': `${src}/input/tex/extensions/extpfeil/extpfeil.js`,
   '[tex]/html': `${src}/input/tex/extensions/html/html.js`,
+  '[tex]/mathtools': `${src}/input/tex/extensions/mathtools/mathtools.js`,
   '[tex]/mhchem': `${src}/input/tex/extensions/mhchem/mhchem.js`,
   '[tex]/newcommand': `${src}/input/tex/extensions/newcommand/newcommand.js`,
   '[tex]/noerrors': `${src}/input/tex/extensions/noerrors/noerrors.js`,

diff --git a/ts/core/MmlTree/MmlNodes/mstyle.ts b/ts/core/MmlTree/MmlNodes/mstyle.ts
@@ -75,10 +75,16 @@ export class MmlMstyle extends AbstractMmlLayoutNode {
       } else {
         level = parseInt(scriptlevel);
       }
+      prime = false;  // style change resets tex prime style
     }
     let displaystyle = this.attributes.getExplicit('displaystyle') as boolean;
     if (displaystyle != null) {
       display = (displaystyle === true);
+      prime = false;  // style change resets tex prime style
+    }
+    const cramped = this.attributes.getExplicit('data-cramped') as boolean;  // manual control of tex prime style
+    if (cramped != null) {
+      prime = cramped;
     }
     attributes = this.addInheritedAttributes(attributes, this.attributes.getAllAttributes());
     this.childNodes[0].setInheritedAttributes(attributes, display, level, prime);

diff --git a/ts/core/MmlTree/MmlNodes/mtable.ts b/ts/core/MmlTree/MmlNodes/mtable.ts
@@ -106,10 +106,11 @@ export class MmlMtable extends AbstractMmlNode {
   /**
    * Make sure all children are mtr or mlabeledtr nodes
    * Inherit the table attributes, and set the display attribute based on the table's displaystyle attribute
+   * Reset the prime value to false
    *
    * @override
    */
-  protected setChildInheritedAttributes(attributes: AttributeList, display: boolean, level: number, prime: boolean) {
+  protected setChildInheritedAttributes(attributes: AttributeList, display: boolean, level: number, _prime: boolean) {
     for (const child of this.childNodes) {
       if (!child.isKind('mtr')) {
         this.replaceChild(this.factory.create('mtr'), child)
@@ -122,10 +123,11 @@ export class MmlMtable extends AbstractMmlNode {
       columnalign: this.attributes.get('columnalign'),
       rowalign: 'center'
     });
+    const cramped = this.attributes.getExplicit('data-cramped') as boolean;
     const ralign = split(this.attributes.get('rowalign') as string);
     for (const child of this.childNodes) {
       attributes.rowalign[1] = ralign.shift() || attributes.rowalign[1];
-      child.setInheritedAttributes(attributes, display, level, prime);
+      child.setInheritedAttributes(attributes, display, level, !!cramped);
     }
   }
 

diff --git a/ts/input/tex/AllPackages.ts b/ts/input/tex/AllPackages.ts
@@ -39,6 +39,7 @@ import './enclose/EncloseConfiguration.js';
 import './extpfeil/ExtpfeilConfiguration.js';
 import './gensymb/GensymbConfiguration.js';
 import './html/HtmlConfiguration.js';
+import './mathtools/MathtoolsConfiguration.js';
 import './mhchem/MhchemConfiguration.js';
 import './newcommand/NewcommandConfiguration.js';
 import './noerrors/NoErrorsConfiguration.js';
@@ -70,6 +71,7 @@ if (typeof MathJax !== 'undefined' && MathJax.loader) {
     '[tex]/extpfeil',
     '[tex]/gensymb',
     '[tex]/html',
+    '[tex]/mathtools',
     '[tex]/mhchem',
     '[tex]/newcommand',
     '[tex]/noerrors',
@@ -102,6 +104,7 @@ export const AllPackages: string[] = [
   'extpfeil',
   'gensymb',
   'html',
+  'mathtools',
   'mhchem',
   'newcommand',
   'noerrors',

diff --git a/ts/input/tex/ParseUtil.ts b/ts/input/tex/ParseUtil.ts
@@ -30,6 +30,7 @@ import NodeUtil from './NodeUtil.js';
 import TexParser from './TexParser.js';
 import TexError from './TexError.js';
 import {entities} from '../../util/Entities.js';
+import {MmlMunderover} from '../../core/MmlTree/MmlNodes/munderover.js';
 import {em} from '../../util/lengths.js';
 
 
@@ -360,6 +361,40 @@ namespace ParseUtil {
     return parser.create('node', 'mtext', [], def, textNode);
   }
 
+  /**
+   * Create an munderover node with the given script position.
+   * @param {TexParser} parser   The current TeX parser.
+   * @param {MmlNode} base       The base node.
+   * @param {MmlNode} script     The under- or over-script.
+   * @param {string} pos         Either 'over' or 'under'.
+   * @param {boolean} stack      True if super- or sub-scripts should stack.
+   * @return {MmlNode}           The generated node (MmlMunderover or TeXAtom)
+   */
+  export function underOver(parser: TexParser, base: MmlNode, script: MmlNode, pos: string, stack: boolean): MmlNode {
+    // @test Overline
+    const symbol = NodeUtil.getForm(base);
+    if ((symbol && symbol[3] && symbol[3]['movablelimits']) || NodeUtil.getProperty(base, 'movablelimits')) {
+      // @test Overline Sum
+      NodeUtil.setProperties(base, {'movablelimits': false});
+    }
+    if (NodeUtil.isType(base, 'munderover') && NodeUtil.isEmbellished(base)) {
+      // @test Overline Limits
+      NodeUtil.setProperties(NodeUtil.getCoreMO(base), {lspace: 0, rspace: 0});
+      const mo = parser.create('node', 'mo', [], {rspace: 0});
+      base = parser.create('node', 'mrow', [mo, base]);
+      // TODO? add an empty <mi> so it's not embellished any more
+    }
+    const mml = parser.create('node', 'munderover', [base]) as MmlMunderover;
+    NodeUtil.setChild(mml, pos === 'over' ?  mml.over : mml.under, script);
+    let node: MmlNode = mml;
+    if (stack) {
+      // @test Overbrace 1 2 3, Underbrace, Overbrace Op 1 2
+      node = parser.create('node', 'TeXAtom', [mml], {texClass: TEXCLASS.OP, movesupsub: true});
+    }
+    NodeUtil.setProperty(node, 'subsupOK', true);
+    return node;
+  }
+
   /**
    * Trim spaces from a string.
    * @param {string} text The string to clean.
@@ -391,7 +426,7 @@ namespace ParseUtil {
     } else if (align === 'b') {
       array.arraydef.align = 'baseline -1';
     } else if (align === 'c') {
-      array.arraydef.align = 'center';
+      array.arraydef.align = 'axis';
     } else if (align) {
       array.arraydef.align = align;
     } // FIXME: should be an error?
@@ -458,6 +493,26 @@ namespace ParseUtil {
     return s1 + s2;
   }
 
+  /**
+   * Report an error if there are too many macro substitutions.
+   * @param {TexParser} parser The current TeX parser.
+   * @param {boolean} isMacro  True if we are substituting a macro, false for environment.
+   */
+  export function checkMaxMacros(parser: TexParser, isMacro: boolean = true) {
+    if (++parser.macroCount <= parser.configuration.options['maxMacros']) {
+      return;
+    }
+    if (isMacro) {
+      throw new TexError('MaxMacroSub1',
+                         'MathJax maximum macro substitution count exceeded; ' +
+                         'is here a recursive macro call?');
+    } else {
+      throw new TexError('MaxMacroSub2',
+                         'MathJax maximum substitution count exceeded; ' +
+                         'is there a recursive latex environment?');
+    }
+  }
+
 
   /**
    *  Check for bad nesting of equation environments
@@ -513,8 +568,7 @@ namespace ParseUtil {
       for (let key of Object.keys(def)) {
         if (!allowed.hasOwnProperty(key)) {
           if (error) {
-            throw new TexError('InvalidOption',
-                               'Invalid optional argument: %1', key);
+            throw new TexError('InvalidOption', 'Invalid option: %1', key);
           }
           delete def[key];
         }

diff --git a/ts/input/tex/ams/AmsMappings.ts b/ts/input/tex/ams/AmsMappings.ts
@@ -89,7 +89,7 @@ new sm.CommandMap('AMSmath-macros', {
   shoveleft:  ['HandleShove', TexConstant.Align.LEFT],
   shoveright: ['HandleShove', TexConstant.Align.RIGHT],
 
-  xrightarrow: ['xArrow', 0x2192, 7, 12],
+  xrightarrow: ['xArrow', 0x2192, 5, 10],
   xleftarrow:  ['xArrow', 0x2190, 10, 5]
 }, AmsMethods);
 

diff --git a/ts/input/tex/base/BaseItems.ts b/ts/input/tex/base/BaseItems.ts
@@ -1025,6 +1025,29 @@ export class ArrayItem extends BaseItem {
     }
   }
 
+  /**
+   * Adds a row-spacing to the current row (padding out the rowspacing if needed to get there).
+   *
+   * @param {string} spacing   The rowspacing to use for the current row.
+   */
+  public addRowSpacing(spacing: string) {
+    if (this.arraydef['rowspacing']) {
+      const rows = (this.arraydef['rowspacing'] as string).split(/ /);
+      if (!this.getProperty('rowspacing')) {
+        // @test Array Custom Linebreak
+        let dimem = ParseUtil.dimen2em(rows[0]);
+        this.setProperty('rowspacing', dimem);
+      }
+      const rowspacing = this.getProperty('rowspacing') as number;
+      while (rows.length < this.table.length) {
+        rows.push(ParseUtil.Em(rowspacing));
+      }
+      rows[this.table.length - 1] = ParseUtil.Em(
+        Math.max(0, rowspacing + ParseUtil.dimen2em(spacing)));
+      this.arraydef['rowspacing'] = rows.join(' ');
+    }
+  }
+
 }
 
 

diff --git a/ts/input/tex/base/BaseMappings.ts b/ts/input/tex/base/BaseMappings.ts
@@ -610,6 +610,8 @@ new sm.CommandMap('macros', {
   text:               'HBox',
   mbox:               ['HBox', 0],
   fbox:               'FBox',
+  boxed:              ['Macro', '\\fbox{$\\displaystyle{#1}$}', 1],
+  framebox:           'FrameBox',
 
   strut:              'Strut',
   mathstrut:         ['Macro', '\\vphantom{(}'],