SPB Git

Repository Public

MathConverterTests.swift 26.6 KB 363 lines swift

1// ORIX Docs2// File: Packages/ORIXDocsKit/Tests/DocDOCXTests/MathConverterTests.swift3// Description: Tests of the math converter: LaTeX ↔ OMML round trips on the canonical form, real pandoc OMML,4//              MathML well-formedness, pandoc reading our OMML back, hostile input.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import Testing9import Foundation10import DocContainer11@testable import DocDOCX1213@Suite struct MathConverterTests {14    /// Formulas already in the canonical form written by the converter: LaTeX → OMML → LaTeX must be the identity.15    static let canonical: [String] = [16        "E=mc^{2}",17        "\\frac{a}{b}",18        "x_{i}",19        "x_{i}^{2}",20        "a^{n+1}+b_{k-1}",21        "\\sqrt{x}",22        "\\sqrt[3]{x+1}",23        "\\alpha+\\beta\\leq\\gamma",24        "\\Gamma\\neq\\Delta\\times\\Omega",25        "\\sum_{i=1}^{n}x_{i}",26        "\\prod_{k=1}^{\\infty}\\frac{1}{k}",27        "\\int_{0}^{1}f(x)\\,dx",28        "\\oint_{C}\\vec{F}\\cdot d\\vec{r}",29        "\\bigcup_{i\\in I}A_{i}",30        "\\sum x",31        "\\left(\\frac{a}{b}\\right)",32        "\\left[x+y\\right]^{2}",33        "\\left\\{a\\middle|b\\right\\}",34        "\\left\\langle u,v\\right\\rangle",35        "\\left.\\frac{df}{dx}\\right|_{x=0}",36        "\\left\\|x\\right\\|",37        "\\hat{x}+\\bar{y}+\\tilde{z}+\\vec{v}+\\dot{q}+\\ddot{q}",38        "\\overline{ab}+\\underline{cd}",39        "\\sin x+\\cos\\theta",40        "\\sin(x+1)",41        "\\sin^{2}x+\\cos^{2}x=1",42        "\\log_{2}n",43        "\\lim_{x\\to0}\\frac{\\sin x}{x}=1",44        "\\max_{i}x_{i}",45        "\\exp(-x^{2})+1",46        "\\operatorname{argmax}x",47        "\\text{if }x>0",48        "\\mathrm{d}x",49        "\\mathbf{x}+\\boldsymbol{y}",50        "\\mathbb{R}^{n}",51        "\\mathcal{L}+\\mathfrak{g}+\\mathsf{A}+\\mathtt{B}",52        "\\binom{n}{k}",53        "\\overset{a}{=}",54        "\\underset{x}{y}",55        "\\underbrace{x+y}_{n}",56        "\\overbrace{a+b}^{m}",57        "\\begin{matrix}a&b\\\\c&d\\end{matrix}",58        "\\begin{pmatrix}a&b\\\\c&d\\end{pmatrix}",59        "\\begin{bmatrix}1&0\\\\0&1\\end{bmatrix}",60        "\\begin{vmatrix}a&b\\\\c&d\\end{vmatrix}",61        "\\begin{Bmatrix}x\\\\y\\end{Bmatrix}",62        "\\begin{Vmatrix}x\\end{Vmatrix}",63        "f(x)=\\begin{cases}1&x>0\\\\0&\\text{otherwise}\\end{cases}",64        "\\begin{aligned}a&=b\\\\c&=d\\end{aligned}",65        "\\boxed{x=1}",66        "a\\phantom{b}c",67        "a\\,b\\;c\\quad d\\ e",68        "x^{\\prime}",69        "\\forall x\\in A\\,\\exists y\\notin B",70        "A\\subseteq B\\cup C\\cap D",71        "p\\Rightarrow q\\iff\\neg p\\vee q",72        "\\partial_{t}u=\\nabla^{2}u",73        "a\\pm b\\mp c\\div d",74        "1,2,\\ldots,n",75        "\\{a\\}\\%\\#\\&\\_",76        "\\frac{\\partial^{2}f}{\\partial x^{2}}",77        "\\sqrt{\\frac{1}{1-x^{2}}}",78        "e^{i\\pi}+1=0",79        "{}^{14}C",80        "x\\in\\left[0,1\\right)",81        "\\sum_{i=1}^{n}\\sum_{j=1}^{m}a_{ij}",82        "\\hbar\\omega\\approx\\ell",83    ]8485    @Test func canonicalLatexSurvivesOMML() throws {86        #expect(Self.canonical.count >= 40)87        for f in Self.canonical {88            let omml = try #require(MathConverter.omml(fromLatex: f), "cannot parse \(f)")89            #expect(omml.hasPrefix("<m:oMath>") && omml.hasSuffix("</m:oMath>"))90            let back = MathConverter.latex(fromOMML: omml)91            #expect(back == f, "\(f) came back as \(back ?? "nil")")92        }93    }9495    @Test func ommlIsAFixedPoint() throws {96        let extra = ["E = mc^2", "\\sum_{i=1}^n x_i", "\\frac12", "x'", "\\dfrac{a}{b}", "\\sqrt2", "a \\le b", "\\sin{x}", "\\int_0^1 f(x)\\,dx",97                     "\\mathbf{x^2}", "\\operatorname{foo}", "\\lim_{n\\to\\infty} a_n = 0", "a &= b \\\\ c &= d", "\\begin{align*} a &= b \\end{align*}",98                     "\\begin{array}{cc} a & b \\end{array}", "\\qquad x", "\\left( x \\right)", "\\sum", "\\sum_i \\sum_j x", "\\sin\\cos x", "x^2^3", "\\big( x \\big)"]99        for f in Self.canonical + extra {100            let o1 = try #require(MathConverter.omml(fromLatex: f), "cannot parse \(f)")101            let l1 = try #require(MathConverter.latex(fromOMML: o1))102            let o2 = try #require(MathConverter.omml(fromLatex: l1), "cannot re-parse \(l1) (from \(f))")103            let l2 = try #require(MathConverter.latex(fromOMML: o2))104            #expect(o1 == o2, "OMML not stable for \(f): \(l1)")105            #expect(l1 == l2, "LaTeX not stable for \(f): \(l1) → \(l2)")106        }107    }108109    @Test func outputIsWellFormedXML() throws {110        let ns = "xmlns:m=\"\(XMLNS.m)\""111        for f in Self.canonical + ["a<b>c&d", "\\text{<tag attr=\"v\"> & co}"] {112            let latex = f == "a<b>c&d" ? "a<b>c\\&d" : f113            let omml = try #require(MathConverter.omml(fromLatex: latex))114            let root = try XMLTree.parse(Data("<root \(ns)>\(omml)</root>".utf8))115            #expect(root.first("m:oMath") != nil)116            for display in [true, false] {117                let mathml = try #require(MathConverter.mathML(fromLatex: latex, display: display))118                let math = try XMLTree.parse(Data(mathml.utf8))119                #expect(math.name == "math")120                #expect(math.attr("display") == (display ? "block" : "inline"))121                #expect(!math.children.isEmpty)122            }123        }124    }125126    @Test func mathMLStructure() throws {127        #expect(MathConverter.mathML(fromLatex: "\\frac{a}{b}", display: false)128            == "<math xmlns=\"http://www.w3.org/1998/Math/MathML\" display=\"inline\"><mfrac><mi>a</mi><mi>b</mi></mfrac></math>")129        #expect(MathConverter.mathML(fromLatex: "x^{2}+12.5", display: true)130            == "<math xmlns=\"http://www.w3.org/1998/Math/MathML\" display=\"block\"><msup><mi>x</mi><mn>2</mn></msup><mo>+</mo><mn>12.5</mn></math>")131        let sum = try #require(MathConverter.mathML(fromLatex: "\\sum_{i=1}^{n}x_{i}", display: true))132        #expect(sum.contains("<munderover><mo largeop=\"true\">∑</mo><mrow><mi>i</mi><mo>=</mo><mn>1</mn></mrow><mi>n</mi></munderover>"))133        let root = try #require(MathConverter.mathML(fromLatex: "\\sqrt[3]{x}", display: false))134        #expect(root.contains("<mroot><mi>x</mi><mn>3</mn></mroot>"))135        let matrix = try #require(MathConverter.mathML(fromLatex: "\\begin{pmatrix}a&b\\\\c&d\\end{pmatrix}", display: false))136        #expect(matrix.contains("<mtable><mtr><mtd><mi>a</mi></mtd><mtd><mi>b</mi></mtd></mtr><mtr><mtd><mi>c</mi></mtd><mtd><mi>d</mi></mtd></mtr></mtable>"))137        #expect(MathConverter.mathML(fromLatex: "\\frac{a}{", display: false) == nil)138    }139140    @Test func unparseableLatexReturnsNil() {141        for bad in ["\\frac{a}{b", "x^", "\\unknowncommand{x}", "\\begin{nosuchenv}x\\end{nosuchenv}", "\\begin{matrix}a", "}", "\\left( x",142                    "\\begin{pmatrix}a\\end{bmatrix}", "a # b", "\\sqrt[3{x}"] {143            #expect(MathConverter.omml(fromLatex: bad) == nil, "\(bad) should not parse")144            #expect(MathConverter.mathML(fromLatex: bad, display: false) == nil)145        }146        #expect(MathConverter.omml(fromLatex: "") == "<m:oMath></m:oMath>")147    }148149    @Test func hostileNestingDoesNotCrash() {150        let deep = String(repeating: "{", count: 10_000) + "x" + String(repeating: "}", count: 10_000)151        #expect(MathConverter.omml(fromLatex: deep) == nil)152        #expect(MathConverter.omml(fromLatex: String(repeating: "{", count: 10_000)) == nil)153        #expect(MathConverter.omml(fromLatex: String(repeating: "\\frac{", count: 5_000)) == nil)154        #expect(MathConverter.omml(fromLatex: String(repeating: "\\sqrt", count: 5_000) + "x") == nil)155        // Repeated scripts on one base are merged, not nested.156        #expect((MathConverter.omml(fromLatex: String(repeating: "x^", count: 5_000) + "x") ?? "").count > 5_000)157        #expect(MathConverter.omml(fromLatex: String(repeating: "\\left(", count: 5_000)) == nil)158        // Wide input is fine.159        #expect(MathConverter.omml(fromLatex: String(repeating: "x+", count: 20_000) + "x") != nil)160        // Deep OMML: the XML layer refuses it, the converter reports nil instead of crashing.161        let deepXML = "<m:oMath>" + String(repeating: "<m:e>", count: 5_000) + String(repeating: "</m:e>", count: 5_000) + "</m:oMath>"162        #expect(MathConverter.latex(fromOMML: deepXML) == nil)163        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:r>") == nil)164        #expect(MathConverter.latex(fromOMML: "<!DOCTYPE x [<!ENTITY e SYSTEM \"file:///etc/passwd\">]><m:oMath><m:r><m:t>&e;</m:t></m:r></m:oMath>") == nil)165    }166167    // MARK: Real OMML168169    /// m:oMath elements copied from word/document.xml written by pandoc 3.9.0.2 (`pandoc -f markdown -t docx`).170    static let pandocSamples: [(omml: String, latex: String)] = [171        ("<m:oMath><m:f><m:fPr><m:type m:val=\"bar\" /></m:fPr><m:num><m:r><m:t>a</m:t></m:r></m:num><m:den><m:r><m:t>b</m:t></m:r></m:den></m:f></m:oMath>",172         "\\frac{a}{b}"),173        ("<m:oMath><m:sSup><m:e><m:r><m:t>x</m:t></m:r></m:e><m:sup><m:r><m:t>2</m:t></m:r></m:sup></m:sSup><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:sSub><m:e><m:r><m:t>y</m:t></m:r></m:e><m:sub><m:r><m:t>i</m:t></m:r></m:sub></m:sSub><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>=</m:t></m:r><m:sSubSup><m:e><m:r><m:t>z</m:t></m:r></m:e><m:sub><m:r><m:t>i</m:t></m:r></m:sub><m:sup><m:r><m:t>2</m:t></m:r></m:sup></m:sSubSup></m:oMath>",174         "x^{2}+y_{i}=z_{i}^{2}"),175        ("<m:oMath><m:nary><m:naryPr><m:chr m:val=\"∑\" /><m:limLoc m:val=\"undOvr\" /><m:subHide m:val=\"off\" /><m:supHide m:val=\"off\" /></m:naryPr><m:sub><m:r><m:t>i</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>=</m:t></m:r><m:r><m:t>1</m:t></m:r></m:sub><m:sup><m:r><m:t>n</m:t></m:r></m:sup><m:e><m:sSub><m:e><m:r><m:t>x</m:t></m:r></m:e><m:sub><m:r><m:t>i</m:t></m:r></m:sub></m:sSub></m:e></m:nary></m:oMath>",176         "\\sum_{i=1}^{n}x_{i}"),177        ("<m:oMath><m:rad><m:deg><m:r><m:t>3</m:t></m:r></m:deg><m:e><m:r><m:t>x</m:t></m:r></m:e></m:rad><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:rad><m:radPr><m:degHide m:val=\"on\" /></m:radPr><m:deg /><m:e><m:r><m:t>y</m:t></m:r></m:e></m:rad></m:oMath>",178         "\\sqrt[3]{x}+\\sqrt{y}"),179        ("<m:oMath><m:d><m:dPr><m:begChr m:val=\"(\" /><m:sepChr m:val=\"\" /><m:endChr m:val=\")\" /><m:grow /></m:dPr><m:e><m:f><m:fPr><m:type m:val=\"bar\" /></m:fPr><m:num><m:r><m:t>a</m:t></m:r></m:num><m:den><m:r><m:t>b</m:t></m:r></m:den></m:f></m:e></m:d></m:oMath>",180         "\\left(\\frac{a}{b}\\right)"),181        ("<m:oMath><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>sin</m:t></m:r><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:sSub><m:e><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>lim</m:t></m:r></m:e><m:sub><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>→</m:t></m:r><m:r><m:t>0</m:t></m:r></m:sub></m:sSub><m:r><m:t>f</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>(</m:t></m:r><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>)</m:t></m:r></m:oMath>",182         "\\sin x+\\lim_{x\\to0}f(x)"),183        ("<m:oMath><m:acc><m:accPr><m:chr m:val=\"̂\" /></m:accPr><m:e><m:r><m:t>x</m:t></m:r></m:e></m:acc><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:acc><m:accPr><m:chr m:val=\"‾\" /></m:accPr><m:e><m:r><m:t>y</m:t></m:r></m:e></m:acc><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:acc><m:accPr><m:chr m:val=\"⃗\" /></m:accPr><m:e><m:r><m:t>v</m:t></m:r></m:e></m:acc><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:bar><m:barPr><m:pos m:val=\"top\" /></m:barPr><m:e><m:r><m:t>a</m:t></m:r><m:r><m:t>b</m:t></m:r></m:e></m:bar></m:oMath>",184         "\\hat{x}+\\bar{y}+\\vec{v}+\\overline{ab}"),185        ("<m:oMath><m:r><m:rPr><m:sty m:val=\"bi\" /></m:rPr><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:r><m:rPr><m:scr m:val=\"double-struck\" /><m:sty m:val=\"p\" /></m:rPr><m:t>R</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:r><m:rPr><m:scr m:val=\"script\" /><m:sty m:val=\"p\" /></m:rPr><m:t>L</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>d</m:t></m:r><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:r><m:rPr><m:nor /><m:sty m:val=\"p\" /></m:rPr><m:t>if </m:t></m:r><m:r><m:t>x</m:t></m:r></m:oMath>",186         "\\boldsymbol{x}+\\mathbb{R}+\\mathcal{L}+\\mathrm{d}x+\\text{if }x"),187        ("<m:oMath><m:d><m:dPr><m:begChr m:val=\"(\" /><m:sepChr m:val=\"\" /><m:endChr m:val=\")\" /><m:grow /></m:dPr><m:e><m:m><m:mPr><m:baseJc m:val=\"center\" /><m:plcHide m:val=\"on\" /><m:mcs><m:mc><m:mcPr><m:mcJc m:val=\"center\" /><m:count m:val=\"1\" /></m:mcPr></m:mc><m:mc><m:mcPr><m:mcJc m:val=\"center\" /><m:count m:val=\"1\" /></m:mcPr></m:mc></m:mcs></m:mPr><m:mr><m:e><m:r><m:t>a</m:t></m:r></m:e><m:e><m:r><m:t>b</m:t></m:r></m:e></m:mr><m:mr><m:e><m:r><m:t>c</m:t></m:r></m:e><m:e><m:r><m:t>d</m:t></m:r></m:e></m:mr></m:m></m:e></m:d></m:oMath>",188         "\\begin{pmatrix}a&b\\\\c&d\\end{pmatrix}"),189        ("<m:oMath><m:r><m:t>f</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>(</m:t></m:r><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>)</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>=</m:t></m:r><m:d><m:dPr><m:begChr m:val=\"{\" /><m:sepChr m:val=\"\" /><m:endChr m:val=\"\" /><m:grow /></m:dPr><m:e><m:m><m:mr><m:e><m:r><m:t>1</m:t></m:r></m:e><m:e><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>&gt;</m:t></m:r><m:r><m:t>0</m:t></m:r></m:e></m:mr><m:mr><m:e><m:r><m:t>0</m:t></m:r></m:e><m:e><m:r><m:rPr><m:nor /><m:sty m:val=\"p\" /></m:rPr><m:t>otherwise</m:t></m:r></m:e></m:mr></m:m></m:e></m:d></m:oMath>",190         "f(x)=\\begin{cases}1&x>0\\\\0&\\text{otherwise}\\end{cases}"),191        ("<m:oMath><m:r><m:t>α</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>≤</m:t></m:r><m:r><m:t>β</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>≠</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>∞</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>−</m:t></m:r><m:r><m:t>1</m:t></m:r></m:oMath>",192         "\\alpha\\leq\\beta\\neq\\infty-1"),193        ("<m:oMath><m:d><m:dPr><m:begChr m:val=\"(\" /><m:sepChr m:val=\"\" /><m:endChr m:val=\")\" /><m:grow /></m:dPr><m:e><m:f><m:fPr><m:type m:val=\"noBar\" /></m:fPr><m:num><m:r><m:t>n</m:t></m:r></m:num><m:den><m:r><m:t>k</m:t></m:r></m:den></m:f></m:e></m:d><m:limLow><m:e><m:limLow><m:e><m:r><m:t>x</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>+</m:t></m:r><m:r><m:t>y</m:t></m:r></m:e><m:lim><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>⏟</m:t></m:r></m:lim></m:limLow></m:e><m:lim><m:r><m:t>n</m:t></m:r></m:lim></m:limLow><m:limUpp><m:e><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>=</m:t></m:r></m:e><m:lim><m:r><m:t>a</m:t></m:r></m:lim></m:limUpp></m:oMath>",194         "\\binom{n}{k}\\underbrace{x+y}_{n}\\overset{a}{=}"),195        ("<m:oMath><m:eqArr><m:e><m:r><m:t>a</m:t></m:r><m:r><m:t>&amp;</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>=</m:t></m:r><m:r><m:t>b</m:t></m:r></m:e><m:e><m:r><m:t>c</m:t></m:r><m:r><m:t>&amp;</m:t></m:r><m:r><m:rPr><m:sty m:val=\"p\" /></m:rPr><m:t>=</m:t></m:r><m:r><m:t>d</m:t></m:r></m:e></m:eqArr></m:oMath>",196         "\\begin{aligned}a&=b\\\\c&=d\\end{aligned}"),197    ]198199    @Test func pandocOMMLConvertsToLatex() throws {200        for sample in Self.pandocSamples {201            let latex = try #require(MathConverter.latex(fromOMML: sample.omml))202            #expect(latex == sample.latex)203            // What we read from pandoc must be LaTeX we can write again.204            #expect(MathConverter.omml(fromLatex: latex) != nil, "cannot re-export \(latex)")205        }206    }207208    /// Constructs written by Word that pandoc does not produce.209    @Test func wordStyleOMML() throws {210        let m = "xmlns:m=\"\(XMLNS.m)\" xmlns:w=\"\(XMLNS.w)\""211        // m:func with a limit in the function name, control properties, explicit namespace declaration.212        let lim = "<m:oMath \(m)><m:func><m:funcPr><m:ctrlPr><w:rPr><w:rFonts w:ascii=\"Cambria Math\"/><w:i/></w:rPr></m:ctrlPr></m:funcPr><m:fName><m:limLow><m:e><m:r><m:rPr><m:sty m:val=\"p\"/></m:rPr><w:rPr><w:rFonts w:ascii=\"Cambria Math\"/></w:rPr><m:t>lim</m:t></m:r></m:e><m:lim><m:r><m:t>n→∞</m:t></m:r></m:lim></m:limLow></m:fName><m:e><m:sSub><m:e><m:r><m:t>a</m:t></m:r></m:e><m:sub><m:r><m:t>n</m:t></m:r></m:sub></m:sSub></m:e></m:func></m:oMath>"213        #expect(MathConverter.latex(fromOMML: lim) == "\\lim_{n\\to\\infty}a_{n}")214        // Defaults: m:d without properties is a parenthesis pair, m:nary without m:chr is an integral, m:acc without m:chr is a hat.215        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:d><m:e><m:r><m:t>x</m:t></m:r></m:e><m:e><m:r><m:t>y</m:t></m:r></m:e></m:d></m:oMath>") == "\\left(x\\middle|y\\right)")216        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:nary><m:naryPr><m:supHide m:val=\"1\"/></m:naryPr><m:sub><m:r><m:t>a</m:t></m:r></m:sub><m:sup/><m:e><m:r><m:t>f</m:t></m:r></m:e></m:nary></m:oMath>") == "\\int_{a}f")217        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:acc><m:e><m:r><m:t>x</m:t></m:r></m:e></m:acc></m:oMath>") == "\\hat{x}")218        // Linear and skewed fractions, pre-scripts, boxes, group characters.219        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:f><m:fPr><m:type m:val=\"lin\"/></m:fPr><m:num><m:r><m:t>a</m:t></m:r></m:num><m:den><m:r><m:t>b</m:t></m:r></m:den></m:f></m:oMath>") == "{a}/{b}")220        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:sPre><m:sub><m:r><m:t>6</m:t></m:r></m:sub><m:sup><m:r><m:t>14</m:t></m:r></m:sup><m:e><m:r><m:t>C</m:t></m:r></m:e></m:sPre></m:oMath>") == "{}_{6}^{14}C")221        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:borderBox><m:e><m:box><m:e><m:r><m:t>x</m:t></m:r></m:e></m:box></m:e></m:borderBox></m:oMath>") == "\\boxed{x}")222        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:groupChr><m:groupChrPr><m:chr m:val=\"⏞\"/><m:pos m:val=\"top\"/></m:groupChrPr><m:e><m:r><m:t>ab</m:t></m:r></m:e></m:groupChr></m:oMath>") == "\\overbrace{ab}")223        #expect(MathConverter.latex(fromOMML: "<m:oMath><m:r><m:rPr><m:sty m:val=\"b\"/></m:rPr><m:t>v</m:t></m:r><m:r><m:t>ℝ</m:t></m:r></m:oMath>") == "\\mathbf{v}\\mathbb{R}")224        // Several equations in one paragraph are joined as rows.225        let para = "<m:oMathPara \(m)><m:oMath><m:r><m:t>a=b</m:t></m:r></m:oMath><m:oMath><m:r><m:t>c=d</m:t></m:r></m:oMath></m:oMathPara>"226        let joined = try #require(MathConverter.latex(fromOMML: para))227        #expect(joined == "a=b \\\\ c=d")228        #expect(MathConverter.omml(fromLatex: joined)?.contains("<m:eqArr>") == true)229    }230231    @Test func unknownOMMLIsKeptAndReported() throws {232        let xml = "<root xmlns:m=\"\(XMLNS.m)\"><m:oMath><m:r><m:t>a</m:t></m:r><m:mystery><m:e><m:r><m:t>b+c</m:t></m:r></m:e></m:mystery><m:other>d</m:other></m:oMath></root>"233        let root = try XMLTree.parse(Data(xml.utf8))234        let result = MathConverter.latex(fromOMMLNode: try #require(root.first("m:oMath")))235        #expect(result.latex == "ab+cd")236        #expect(result.unsupported == ["m:mystery", "m:other"])237        let clean = MathConverter.latex(fromOMMLNode: try XMLTree.parse(Data("<m:oMath xmlns:m=\"\(XMLNS.m)\"><m:r><m:t>x</m:t></m:r></m:oMath>".utf8)))238        #expect(clean.latex == "x" && clean.unsupported.isEmpty)239    }240241    @Test func textEscaping() throws {242        let latex = "\\text{50\\% of \\{a\\_b\\} \\& c\\textbackslash{}d \\$5 \\#1}"243        let omml = try #require(MathConverter.omml(fromLatex: latex))244        #expect(omml.contains("<m:nor/>"))245        #expect(omml.contains("50% of {a_b} &amp; c\\d $5 #1"))246        #expect(MathConverter.latex(fromOMML: omml) == latex)247        // Raw LaTeX stored as normal text (the exporter's fallback for unparseable formulas) comes back as \text{…}.248        let raw = "<m:oMath><m:r><m:rPr><m:nor/></m:rPr><m:t>\\foo{x}^2</m:t></m:r></m:oMath>"249        let back = try #require(MathConverter.latex(fromOMML: raw))250        #expect(back == "\\text{\\textbackslash{}foo\\{x\\}\\textasciicircum{}2}")251        #expect(MathConverter.omml(fromLatex: back) != nil)252    }253254    // MARK: External validation with pandoc255256    static let pandocPath: String? = ["/opt/homebrew/bin/pandoc", "/usr/local/bin/pandoc", "/usr/bin/pandoc"].first { FileManager.default.isExecutableFile(atPath: $0) }257258    static func docx(withMath omml: [String]) throws -> Data {259        var zip = ZipWriter()260        try zip.add("[Content_Types].xml", text: xmlDeclaration + "<Types xmlns=\"\(XMLNS.ct)\"><Default Extension=\"rels\" ContentType=\"application/vnd.openxmlformats-package.relationships+xml\"/><Default Extension=\"xml\" ContentType=\"application/xml\"/><Override PartName=\"/word/document.xml\" ContentType=\"application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml\"/></Types>")261        try zip.add("_rels/.rels", text: xmlDeclaration + "<Relationships xmlns=\"\(XMLNS.rel)\"><Relationship Id=\"rId1\" Type=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument\" Target=\"word/document.xml\"/></Relationships>")262        let body = omml.map { "<w:p>\($0)</w:p>" }.joined()263        try zip.add("word/document.xml", text: xmlDeclaration + "<w:document xmlns:w=\"\(XMLNS.w)\" xmlns:m=\"\(XMLNS.m)\"><w:body>\(body)</w:body></w:document>")264        return zip.finalize()265    }266267    /// Removes the differences that do not change the formula: spaces and the braces around single-token scripts.268    static func loose(_ latex: String) -> String {269        var s = latex.replacingOccurrences(of: " ", with: "")270        for pattern in ["\\^\\{([A-Za-z0-9])\\}", "_\\{([A-Za-z0-9])\\}"] {271            s = s.replacingOccurrences(of: pattern, with: String(pattern.prefix(pattern.hasPrefix("\\^") ? 2 : 1)).replacingOccurrences(of: "\\", with: "") + "$1", options: .regularExpression)272        }273        return s274    }275276    @Test func pandocReadsOurOMML() throws {277        guard let pandoc = Self.pandocPath else {278            print("NOTE: pandoc not found, pandocReadsOurOMML skipped")279            return280        }281        // (our LaTeX, LaTeX expected back from pandoc after `loose` normalisation)282        let cases: [(String, String)] = [283            ("\\frac{a}{b}", "\\frac{a}{b}"),284            ("x_{i}^{2}+y^{2}", "x_i^2+y^2"),285            ("\\sum_{i=1}^{n}x_{i}", "\\sum_{i=1}^nx_i"),286            ("\\sqrt[3]{x+1}", "\\sqrt[3]{x+1}"),287            ("\\left(\\frac{a}{b}\\right)", "\\left(\\frac{a}{b}\\right)"),288            ("\\alpha\\leq\\beta", "\\alpha\\leq\\beta"),289            ("\\int_{0}^{1}f(x)\\,dx", "\\int_0^1f(x)\\,dx"),290            ("\\begin{pmatrix}a&b\\\\c&d\\end{pmatrix}", "\\begin{pmatrix}a&b\\\\c&d\\end{pmatrix}"),291            ("\\hat{x}+\\overline{ab}", "\\widehat{x}+\\overline{ab}"),292            ("\\lim_{x\\to0}\\frac{\\sin x}{x}=1", "\\lim_{x\\rightarrow0}\\frac{\\sin x}{x}=1"),293        ]294        let omml = try cases.map { try #require(MathConverter.omml(fromLatex: $0.0)) }295        let dir = FileManager.default.temporaryDirectory.appendingPathComponent("orix-math-\(UUID().uuidString)")296        try FileManager.default.createDirectory(at: dir, withIntermediateDirectories: true)297        defer { try? FileManager.default.removeItem(at: dir) }298        let file = dir.appendingPathComponent("math.docx")299        try Self.docx(withMath: omml).write(to: file)300        let p = Process()301        p.executableURL = URL(fileURLWithPath: pandoc)302        p.arguments = ["-f", "docx", "-t", "markdown", "--wrap=none", file.path]303        let pipe = Pipe()304        p.standardOutput = pipe305        p.standardError = Pipe()306        try p.run()307        let out = String(decoding: pipe.fileHandleForReading.readDataToEndOfFile(), as: UTF8.self)308        p.waitUntilExit()309        #expect(p.terminationStatus == 0)310        // One formula per paragraph; pandoc may spread a matrix over several lines.311        let formulas = out.components(separatedBy: "\n\n").map { $0.replacingOccurrences(of: "\n", with: "").trimmingCharacters(in: .whitespaces) }312            .filter { $0.hasPrefix("$") }.map { $0.trimmingCharacters(in: CharacterSet(charactersIn: "$")) }313        #expect(formulas.count == cases.count, "pandoc output:\n\(out)")314        for (k, f) in formulas.enumerated() where k < cases.count {315            #expect(Self.loose(f) == Self.loose(cases[k].1), "pandoc read \(cases[k].0) as \(f)")316        }317    }318}319320@Suite struct MathConverterStackTests {321    /// Swift concurrency and GCD threads have a 512 KB stack: deep but legal nesting must convert there, and anything322    /// accepted by the LaTeX parser must produce OMML shallow enough for the XML layer to read back.323    @Test func deepNestingOnASmallStack() {324        let results = ResultBox()325        let thread = Thread {326            for n in [10, 60, 99] {327                let cases = [String(repeating: "\\frac{a}{", count: n) + "x" + String(repeating: "}", count: n),328                             String(repeating: "\\sqrt", count: n) + " x",329                             String(repeating: "\\left(", count: n) + "x" + String(repeating: "\\right)", count: n),330                             String(repeating: "\\sin", count: n) + " x",331                             String(repeating: "x^{", count: n) + "x" + String(repeating: "}", count: n)]332                for c in cases {333                    guard let omml = MathConverter.omml(fromLatex: c), let latex = MathConverter.latex(fromOMML: omml),334                          MathConverter.omml(fromLatex: latex) == omml, MathConverter.mathML(fromLatex: c, display: true) != nil else {335                        results.failures.append("\(n) × \(c.prefix(10))")336                        continue337                    }338                }339            }340            for n in [101, 300, 5_000] {341                if MathConverter.omml(fromLatex: String(repeating: "\\sqrt", count: n) + " x") != nil { results.failures.append("accepted \(n) nested roots") }342                if MathConverter.omml(fromLatex: String(repeating: "\\sin", count: n) + " x") != nil { results.failures.append("accepted \(n) nested functions") }343            }344            // OMML as deep as the XML layer allows.345            let half = 120346            let deep = "<m:oMath>" + String(repeating: "<m:sSup><m:e>", count: half) + "<m:r><m:t>x</m:t></m:r>"347                + String(repeating: "</m:e><m:sup><m:r><m:t>2</m:t></m:r></m:sup></m:sSup>", count: half) + "</m:oMath>"348            if MathConverter.latex(fromOMML: deep) == nil { results.failures.append("deep OMML not read") }349            results.finished = true350        }351        thread.stackSize = 512 * 1024352        thread.start()353        while !thread.isFinished { usleep(2_000) }354        #expect(results.finished)355        #expect(results.failures.isEmpty, "\(results.failures)")356    }357358    final class ResultBox: @unchecked Sendable {359        var failures: [String] = []360        var finished = false361    }362}363
Files main
Menu

Theme