Dist & docs

arnog · Feb 13, 2019 · 77d7bf9 · 77d7bf9
1 parent 0dc06f3
commit 77d7bf9
Show file tree

Hide file tree

Showing 43 changed files with 314 additions and 84 deletions.
diff --git a/dist/mathlive.js b/dist/mathlive.js
diff --git a/dist/mathlive.mjs b/dist/mathlive.mjs
diff --git a/dist/src/editor/editor-editableMathlist.js b/dist/src/editor/editor-editableMathlist.js
@@ -883,6 +883,11 @@ EditableMathlist.prototype.commitCommandStringBeforeInsertionPoint = function()
 EditableMathlist.prototype.spliceCommandStringAroundInsertionPoint = function(mathlist) {
     const command = this.commandOffsets();
     if (command) {
+        // Dispatch notifications
+        if (typeof this.config.onContentWillChange === 'function' && 
+            !this.suppressContentChangeNotifications) {
+            this.config.onContentWillChange(this.target);
+        }
         Array.prototype.splice.apply(this.siblings(),
             [command.start, command.end - command.start].concat(mathlist));
 
@@ -901,6 +906,11 @@ EditableMathlist.prototype.spliceCommandStringAroundInsertionPoint = function(ma
         if (newPlaceholders.length === 0 || !this.leap(+1, false)) {
             this.setSelection(command.start + mathlist.length - 1);
         }
+
+        // Dispatch notifications
+        if (typeof this.config.onContentDidChange === 'function' && !this.suppressContentChangeNotifications) {
+            this.config.onContentDidChange(this.target);
+        }
     }
 }
 
@@ -1799,7 +1809,7 @@ EditableMathlist.prototype._insertSmartFence = function(fence) {
     if (rDelim && !(parent && (parent.type === 'leftright' && parent.leftDelim === '|'))) {
         // We have a valid open fence as input
         let s = '';
-        const collapsed = this.isCollapsed();
+        const collapsed = this.isCollapsed() || this.anchor().type === 'placeholder';
 
         if (this.sibling(0).isFunction) {
             // We're before a function (e.g. `\sin`)

diff --git a/dist/src/editor/editor-mathfield.js b/dist/src/editor/editor-mathfield.js
@@ -313,12 +313,9 @@ function MathField(element, config) {
         this.latex(elementText);
     }
 
-    // If fonts get loaded (which could happen as a result of the first pass
-    // rendering done in .latex()), render again.
-    // if (document && document.fonts) {
-    //     const that = this;
-    //     document.fonts.ready.then(() => that._render());
-    // }
+    // Now start recording potentially undoable actions
+    this.undoManager.startRecording();
+    this.undoManager.snapshot(this.config);
 }
 
 /**
@@ -923,26 +920,28 @@ MathField.prototype.$perform = function(command) {
     selector += '_';
 
     if (typeof this.mathlist[selector] === 'function') {
-        if (/^(delete|transpose|deleteToMathFieldEnd|deleteToGroupEnd|deleteToGroupStart|deletePreviousWord|deleteNextWord|deletePreviousChar|deleteNextChar)_$/.test(selector)) {
-            this.undoManager.snapshot(this.config);
+        if (/^(delete|transpose|add)/.test(selector)) {
             if (this.selectionIsCollapsed() && 
-                selector === 'deletePreviousChar_' && 
-                this.config.inlineShortcutBackspaceCommand === 'undo') {
+                selector === 'deletePreviousChar_') {
                 this.inlineShortcutBuffer = this.inlineShortcutBuffer.substring(0, this.inlineShortcutBuffer.length - 1);
                 this.inlineShortcutStates.pop();
             } else {
                 this._resetInlineShortcutBuffer();
             } 
         }
 
+        if (/^(delete|transpose|add)/.test(selector) && this.mathlist.parseMode() !== 'command') {
+            // Update the undo state to account for the current selection
+            this.undoManager.pop();
+            this.undoManager.snapshot(this.config);
+        }
         this.mathlist[selector](...args);
+        if (/^(delete|transpose|add)/.test(selector) && this.mathlist.parseMode() !== 'command') {
+            this.undoManager.snapshot(this.config);
+        }
         dirty = true;
         handled = true;
     } else if (typeof this[selector] === 'function') {
-        if (selector === 'complete_') {
-            this.undoManager.snapshot(this.config);
-        }
-
         dirty = this[selector](...args);
 
         handled = true;
@@ -951,7 +950,7 @@ MathField.prototype.$perform = function(command) {
     // If the command changed the selection so that it is no longer 
     // collapsed, or if it was an editing command, reset the inline
     // shortcut buffer
-    if (!this.mathlist.isCollapsed() || /^(transpose|paste|((move|extent).*))_$/.test(selector)) {
+    if (!this.mathlist.isCollapsed() || /^(transpose|paste|complete|((move|extend).*))_$/.test(selector)) {
         this._resetInlineShortcutBuffer();
     }
 
@@ -1077,15 +1076,6 @@ MathField.prototype._onKeystroke = function(keystroke, evt) {
                     }
                 }
             }
-        } else {
-            // If we're in the middle of a potential inline shortcut, treat 
-            // Backspace as Undo. This deals with the case "pi<backspace>i"
-            if (this.config.inlineShortcutBackspaceCommand !== 'delete' && 
-                    this.mathlist.isCollapsed() && 
-                    this.inlineShortcutBuffer.length > 0) {
-                selector = this.config.inlineShortcutBackspaceCommand;
-                this._announce('delete');
-            }
         }
     }
 
@@ -1111,21 +1101,23 @@ MathField.prototype._onKeystroke = function(keystroke, evt) {
     // 5.2 If we have a `moveAfterParent` selector (usually triggered with 
     // `spacebar), and we're at the end of a smart fence, close the fence with 
     // an empty (.) right delimiter
-    if (selector === 'moveAfterParent' && this.mathlist._insertSmartFence('.')) {
+    const parent = this.mathlist.parent();
+    if (selector === 'moveAfterParent' && parent && 
+        parent.type === 'leftright' && 
+        this.mathlist.endOffset() === this.mathlist.siblings().length - 1 &&
+        this.mathlist._insertSmartFence('.')) {
         selector = '';
         this._render(); // Re-render the closed smartfence
     }
-    if (selector && !this.perform(selector)) {
+    if ((selector && !this.perform(selector)) || shortcut) {
         // Perform the selector or insert the shortcut
         if (shortcut) {
-            this.undoManager.snapshot(this.config);
-
             // To enable the substitution to be undoable,
             // insert the character before applying the substitution
             this.mathlist.insert(Keyboard.eventToChar(evt));
 
             // Create a snapshot with the inserted character
-            this.undoManager.snapshot(this.config);
+            this.undoManager.snapshotAndCoalesce(this.config);
 
             // Revert to the state before the beginning of the shortcut
             // (restore doesn't change the undo stack)
@@ -1135,6 +1127,7 @@ MathField.prototype._onKeystroke = function(keystroke, evt) {
             if (!this.mathlist._insertSmartFence(shortcut)) {
                 this.mathlist.insert(shortcut, {format: 'latex'});
             }
+            this.undoManager.snapshot(this.config);
             this._render();
             this._announce('replacement');
 
@@ -1262,7 +1255,6 @@ MathField.prototype._onTypedText = function(text, options) {
                 if (selector) {
                     this.perform(selector);
                 } else {
-                    this.undoManager.snapshot(this.config);
                     if (!this.mathlist._insertSmartFence(c)) {
                         this.mathlist.insert(c);
                     }
@@ -1271,6 +1263,10 @@ MathField.prototype._onTypedText = function(text, options) {
         }
     }
 
+    if (this.mathlist.parseMode() !== 'command') {
+        this.undoManager.snapshotAndCoalesce(this.config);
+    }
+
     // Render the mathlist
     this._render();
 
@@ -1580,13 +1576,13 @@ MathField.prototype.$latex = function(text, options) {
         const oldValue = this.mathlist.root.toLatex();
         if (text !== oldValue) {
             options = options || {};
-            this.undoManager.snapshot(this.config);
             this.mathlist.insert(text, Object.assign(this.config, {
                 insertionMode: 'replaceAll',
                 selectionMode: 'after',
                 format: 'latex',
                 suppressContentChangeNotifications: options.suppressContentChangeNotifications
             }));
+            this.undoManager.snapshot(this.config);
             this._render();
         }
         return text;
@@ -1610,11 +1606,15 @@ MathField.prototype.$el = function() {
 }
 
 MathField.prototype.undo_ = MathField.prototype.undo = function() {
+    this.complete_();
+
+    // Undo to the previous state
     this.undoManager.undo(this.config);
     return true;
 }
 
 MathField.prototype.redo_ = MathField.prototype.redo = function() {
+    this.complete_();
     this.undoManager.redo(this.config);
     return true;
 }
@@ -1653,7 +1653,6 @@ MathField.prototype.enterCommandMode_ = function() {
         this.switchKeyboardLayer_('lower-command');
     }
 
-    this.undoManager.snapshot(this.config);
     this.mathlist.insert('\u001b');
     return true;
 }
@@ -1728,7 +1727,6 @@ MathField.prototype.$insert = function(s, options) {
                 this.keypressSound.play();
             }
         }
-        this.undoManager.snapshot(this.config);
         if (s === '\\\\') {
             // This string is interpreted as an "insert row after" command
             this.mathlist.addRowAfter_();
@@ -1737,6 +1735,7 @@ MathField.prototype.$insert = function(s, options) {
         } else {
             this.mathlist.insert(s, options);
         }
+        this.undoManager.snapshot(this.config);
         return true;
     }
     return false;
@@ -1780,6 +1779,7 @@ MathField.prototype.complete_ = function() {
                 }
             }
         }
+        this.undoManager.snapshot(this.config);
         this._announce('replacement');
         return true;
     }
@@ -2371,8 +2371,8 @@ MathField.prototype.toggleVirtualKeyboard_ = function(theme) {
 }
 
 MathField.prototype.applyStyle_ = function(style) {
-    this.undoManager.snapshot(this.config);
     this.mathlist._applyStyle(style);
+    this.undoManager.snapshot(this.config);
     return true;
 }
 
@@ -2470,7 +2470,6 @@ MathField.prototype.$setConfig = function(conf) {
         this.config = {
             smartFence: true,
             removeExtraneousParentheses: false,
-            inlineShortcutBackspaceCommand: 'undo',
             overrideDefaultInlineShortcuts: false,
             virtualKeyboard: '',
             virtualKeyboardLayout: 'qwerty',

diff --git a/dist/src/editor/editor-undo.js b/dist/src/editor/editor-undo.js
@@ -11,9 +11,17 @@
 class UndoManager {
     constructor(mathlist) {
         this.mathlist = mathlist;
+        this.maximumDepth = 1000;
+        this.record = false;
+        this.canCoalesce = false;
+        this.reset();
+    }
+    reset() {
         this.stack = [];
         this.index = -1;
-        this.maximumDepth = 1000;
+    }
+    startRecording() {
+        this.record = true;
     }
     /**
      *
@@ -23,7 +31,7 @@ class UndoManager {
      * @private
      */
     canUndo() {
-        return this.index >= 0;
+        return this.index > 0;
     }
     /**
      *
@@ -46,11 +54,12 @@ class UndoManager {
             if (options && typeof options.onUndoStateWillChange === 'function') {
                 options.onUndoStateWillChange(this.mathlist.target, 'undo');
             }
-            this.restore(this.stack[this.index], options);
+            this.restore(this.stack[this.index - 1], options);
             this.index -= 1;
             if (options && typeof options.onUndoStateDidChange === 'function') {
                 options.onUndoStateDidChange(this.mathlist.target, 'undo');
             }
+            this.canCoalesce = false;
         }
     }
     /**
@@ -69,6 +78,18 @@ class UndoManager {
             if (options && typeof options.onUndoStateDidChange === 'function') {
                 options.onUndoStateDidChange(this.mathlist.target, 'redo');
             }
+            this.canCoalesce = false;
+        }
+    }
+    /**
+     * 
+     * @memberof UndoManager
+     * @instance
+     * @private
+     */
+    pop() {
+        if (this.canUndo()) {
+            this.index -= 1;
         }
     }
     /**
@@ -79,6 +100,8 @@ class UndoManager {
      * @private
      */
     snapshot(options) {
+        if (!this.record) return;
+
         if (options && options.onUndoStateWillChange === 'function') {
             options.onUndoStateWillChange(this.mathlist.target, 'snapshot');
         }
@@ -89,6 +112,7 @@ class UndoManager {
             latex: this.mathlist.root.toLatex(),
             selection: this.mathlist.toString()
         });
+
         this.index++;
         // If we've reached the maximum number of undo operations, forget the 
         // oldest one.
@@ -98,6 +122,18 @@ class UndoManager {
         if (options && typeof options.onUndoStateDidChange === 'function') {
             options.onUndoStateDidChange(this.mathlist.target, 'snapshot');
         }
+        this.canCoalesce = false;
+    }
+    /**
+     * 
+     * @param {Object.<any>} options 
+     */
+    snapshotAndCoalesce(options) {
+        if (this.canCoalesce) {
+            this.pop();
+        }
+        this.snapshot(options);
+        this.canCoalesce = true;
     }
     /**
      * Return an object capturing the state of the content and selection of the

diff --git a/docs/Context.html b/docs/Context.html
diff --git a/docs/EditableMathlist.html b/docs/EditableMathlist.html
diff --git a/docs/MathAtom.html b/docs/MathAtom.html
diff --git a/docs/MathField.html b/docs/MathField.html
diff --git a/docs/UndoManager.html b/docs/UndoManager.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/module-addons_debug.html b/docs/module-addons_debug.html
diff --git a/docs/module-addons_maston.html b/docs/module-addons_maston.html
diff --git a/docs/module-addons_outputLatex.html b/docs/module-addons_outputLatex.html
diff --git a/docs/module-addons_outputMathML.html b/docs/module-addons_outputMathML.html
diff --git a/docs/module-core_color.html b/docs/module-core_color.html
diff --git a/docs/module-core_definitions.html b/docs/module-core_definitions.html
diff --git a/docs/module-core_delimiters.html b/docs/module-core_delimiters.html
diff --git a/docs/module-core_fontMetrics.html b/docs/module-core_fontMetrics.html
diff --git a/docs/module-core_lexer.html b/docs/module-core_lexer.html
diff --git a/docs/module-core_lexer_Lexer.html b/docs/module-core_lexer_Lexer.html
diff --git a/docs/module-core_lexer_Token.html b/docs/module-core_lexer_Token.html
diff --git a/docs/module-core_mathatom.html b/docs/module-core_mathatom.html
diff --git a/docs/module-core_mathstyle.html b/docs/module-core_mathstyle.html
diff --git a/docs/module-core_mathstyle_Mathstyle.html b/docs/module-core_mathstyle_Mathstyle.html
diff --git a/docs/module-core_parser.html b/docs/module-core_parser.html
diff --git a/docs/module-core_parser_Parser.html b/docs/module-core_parser_Parser.html
diff --git a/docs/module-core_span.Span.html b/docs/module-core_span.Span.html
diff --git a/docs/module-core_span.html b/docs/module-core_span.html
diff --git a/docs/module-editor_editableMathlist.html b/docs/module-editor_editableMathlist.html
diff --git a/docs/module-editor_keyboard.html b/docs/module-editor_keyboard.html
diff --git a/docs/module-editor_mathfield.html b/docs/module-editor_mathfield.html
diff --git a/docs/module-editor_mathpath.html b/docs/module-editor_mathpath.html
diff --git a/docs/module-editor_shortcuts.html b/docs/module-editor_shortcuts.html
diff --git a/docs/module-editor_virtualKeyboard.html b/docs/module-editor_virtualKeyboard.html
diff --git a/docs/module-mathlive.html b/docs/module-mathlive.html
diff --git a/docs/tutorial-COMMANDS_REFERENCE.html b/docs/tutorial-COMMANDS_REFERENCE.html
diff --git a/docs/tutorial-CONFIG.html b/docs/tutorial-CONFIG.html
diff --git a/docs/tutorial-CONTRIBUTOR_GUIDE.html b/docs/tutorial-CONTRIBUTOR_GUIDE.html
diff --git a/docs/tutorial-EXAMPLES.html b/docs/tutorial-EXAMPLES.html
diff --git a/docs/tutorial-MASTON.html b/docs/tutorial-MASTON.html
diff --git a/docs/tutorial-SELECTORS.html b/docs/tutorial-SELECTORS.html
diff --git a/docs/tutorial-USAGE_GUIDE.html b/docs/tutorial-USAGE_GUIDE.html