remove uncleanedLatex from opaqueSnapshot

Author: mikehaverstock

src/mathquill.d.ts

@@ -24,7 +24,6 @@ declare namespace MathQuill {
       startIndex: number;
       endIndex: number;
       opaqueSnapshot: {
-        uncleanedLatex: string;
         cursorInsertPath: string;
         signedSelectionSize: number;
       };

src/publicapi.ts

@@ -346,7 +346,7 @@ function getInterface(v: number): MathQuill.v3.API | MathQuill.v1.API {
         return this;
       }
 
-      return this.__controller.exportLatexSelection();
+      return this.__controller.exportLatexSelection().selection;
     }
     html() {
       return this.__controller.root

src/services/latex.ts

@@ -9,7 +9,6 @@ type ExportedLatexSelection = {
   startIndex: number;
   endIndex: number;
   opaqueSnapshot: {
-    uncleanedLatex: string;
     cursorInsertPath: string;
     signedSelectionSize: number;
   };
@@ -192,14 +191,20 @@ class Controller_latex extends Controller_keystroke {
   }
 
   restoreLatexSelection(data: ExportedLatexSelection) {
-    const currentUncleanedLatex =
-      this.exportLatexSelection().opaqueSnapshot.uncleanedLatex;
-    const { cursorInsertPath, signedSelectionSize, uncleanedLatex } =
-      data.opaqueSnapshot;
-
-    // verify the uncleanedLatex are identical. We need the trees to be identical so that the
-    // path instructions are relative to an identical tree structure
-    if (currentUncleanedLatex !== uncleanedLatex) return;
+    const currentSelectionInfo = this.exportLatexSelection();
+    const currentLatex = currentSelectionInfo.selection.latex;
+    const newLatex = data.latex;
+    const { cursorInsertPath, signedSelectionSize } = data.opaqueSnapshot;
+
+    // latex's must match for the indicies in the selection to match up
+    if (currentLatex !== newLatex) return;
+
+    // TODO - track things better so that we can actually make this work
+    if (currentLatex !== currentSelectionInfo.ctx.latex) {
+      throw new Error(
+        'TODO - restoring selection requires uncleanedLatex to match latex'
+      );
+    }
 
     if (!this.insertCursorAtPath(cursorInsertPath)) return;
 
@@ -238,7 +243,10 @@ class Controller_latex extends Controller_keystroke {
     return count;
   }
 
-  exportLatexSelection(): ExportedLatexSelection {
+  exportLatexSelection(): {
+    selection: ExportedLatexSelection;
+    ctx: LatexContext;
+  } {
     var ctx: LatexContext = {
       latex: '',
       startIndex: -1,
@@ -305,14 +313,16 @@ class Controller_latex extends Controller_keystroke {
     }
 
     return {
-      latex: cleanLatex,
-      startIndex: startIndex,
-      endIndex: endIndex,
-      opaqueSnapshot: {
-        uncleanedLatex,
-        cursorInsertPath,
-        signedSelectionSize
-      }
+      selection: {
+        latex: cleanLatex,
+        startIndex: startIndex,
+        endIndex: endIndex,
+        opaqueSnapshot: {
+          cursorInsertPath,
+          signedSelectionSize
+        }
+      },
+      ctx
     };
   }
 

test/unit/latex.test.js

@@ -677,7 +677,7 @@ suite('latex', function () {
         // we tried setting
         const originalSnapShot = mq.selection();
         mq2.latex('');
-        mq2.latex(originalSnapShot.opaqueSnapshot.uncleanedLatex);
+        mq2.latex(originalSnapShot.latex);
         mq2.selection(originalSnapShot);
         const restoredSnapShot = mq2.selection();
         assert.equal(