Let events about fixed up cursor positions be part of operation event stack

Author: Friedrich W. H. Kossebau

webodf/lib/gui/SessionView.js

@@ -410,7 +410,7 @@ gui.SessionViewOptions = function () {
             var annotationViewManager = odfCanvas.getAnnotationViewManager();
             if (annotationViewManager) {
                 annotationViewManager.rehighlightAnnotations();
-                odtDocument.fixCursorPositions(); // TODO: remove this, this should not be needed. for now add return value if moved, and assert here that not.
+                odtDocument.fixCursorPositions(false); // TODO: workaround, ideally this would not be needed
             }
         }
 

webodf/lib/ops/OdtDocument.js

@@ -154,7 +154,7 @@ ops.OdtDocument = function OdtDocument(odfCanvas) {
         initialDoc = rootElement.cloneNode(true);
         odfCanvas.refreshAnnotations();
         // workaround AnnotationViewManager not fixing up cursor positions after creating the highlighting
-        self.fixCursorPositions();
+        self.fixCursorPositions(false);
         return initialDoc;
     };
 
@@ -724,8 +724,14 @@ ops.OdtDocument = function OdtDocument(odfCanvas) {
      * walkable positions; if not, move the cursor 1 filtered step backward
      * which guarantees walkable state for all cursors,
      * while keeping them inside the same root. An event will be raised for this cursor if it is moved
+     * @param {!Array.<!ops.Operation.Event>|!boolean} events  array to add events for moved cursors, needs to be otherwise explicitely set to false
+     * @return {undefined}
      */
-    this.fixCursorPositions = function () {
+    this.fixCursorPositions = function (events) {
+        var /** @type{!Array.<!ops.OdtCursor>}*/ movedCursors = [];
+
+        runtime.assert(Array.isArray(events) || (typeof events === "boolean" && events === false), "second parameter to fixCursorPositions needs to be set to false or an event");
+
         Object.keys(cursors).forEach(function (memberId) {
             var cursor = cursors[memberId],
                 root = getRoot(cursor.getNode()),
@@ -768,9 +774,19 @@ ops.OdtDocument = function OdtDocument(odfCanvas) {
 
             if (cursorMoved) {
                 cursor.setSelectedRange(selectedRange, cursor.hasForwardSelection());
-                eventNotifier.emit(ops.Document.signalCursorMoved, cursor);
+                movedCursors.push(cursor);
             }
         });
+
+        if (events) {
+            movedCursors.forEach(function(cursor) {
+                events.push({ eventid: ops.Document.signalCursorMoved, args: cursor });
+            });
+        } else {
+            movedCursors.forEach(function(cursor) {
+                eventNotifier.emit(ops.Document.signalCursorMoved, cursor);
+            });
+        }
     };
 
     /**

webodf/lib/ops/OpAddAnnotation.js

@@ -174,7 +174,7 @@ ops.OpAddAnnotation = function OpAddAnnotation() {
         }
         // Track this annotation
         odtDocument.getOdfCanvas().addAnnotation(annotation);
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
         events.push({eventid: ops.OdtDocument.signalAnnotationAdded, args: { memberId: memberid, annotation: annotation }});
 
         return events;

webodf/lib/ops/OpApplyDirectStyling.js

@@ -92,7 +92,7 @@ ops.OpApplyDirectStyling = function OpApplyDirectStyling() {
 
         range.detach();
         odtDocument.getOdfCanvas().refreshCSS();
-        odtDocument.fixCursorPositions(); // The container splits may leave the cursor in an invalid spot
+        odtDocument.fixCursorPositions(events); // The container splits may leave the cursor in an invalid spot
 
         impactedParagraphs.forEach(function (n) {
             events.push({

webodf/lib/ops/OpApplyHyperlink.js

@@ -112,7 +112,7 @@ ops.OpApplyHyperlink = function OpApplyHyperlink() {
         boundaryNodes.forEach(domUtils.normalizeTextNodes);
         range.detach();
 
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
         odtDocument.getOdfCanvas().refreshSize();
         odtDocument.getOdfCanvas().rerenderAnnotations();
         modifiedParagraphs.forEach(function (paragraph) {

webodf/lib/ops/OpMergeParagraph.js

@@ -271,7 +271,7 @@ ops.OpMergeParagraph = function OpMergeParagraph() {
             events.push({eventid: ops.Document.signalCursorMoved, args:cursor});
         }
 
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
         odtDocument.getOdfCanvas().refreshSize();
         // TODO: signal also the deleted paragraphs, so e.g. SessionView can clean up the EditInfo
         events.push({

webodf/lib/ops/OpRemoveAnnotation.js

@@ -95,7 +95,7 @@ ops.OpRemoveAnnotation = function OpRemoveAnnotation() {
         odtDocument.handleStepsRemoved({position: position > 0 ? position - 1 : position}, events);
 
         odtDocument.getOdfCanvas().rerenderAnnotations();
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
 
         return events;
     };

webodf/lib/ops/OpRemoveHyperlink.js

@@ -56,23 +56,25 @@ ops.OpRemoveHyperlink = function OpRemoveHyperlink() {
         var odtDocument = /**@type{ops.OdtDocument}*/(document),
             range = odtDocument.convertCursorToDomRange(position, length),
             links = odfUtils.getHyperlinkElements(range),
-            node;
+            node,
+            events = [];
 
         runtime.assert(links.length === 1, "The given range should only contain a single link.");
         node = domUtils.mergeIntoParent(/**@type{!Node}*/(links[0]));
         range.detach();
 
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
         odtDocument.getOdfCanvas().refreshSize();
         odtDocument.getOdfCanvas().rerenderAnnotations();
-        return [{
+        events.push({
             eventid: ops.OdtDocument.signalParagraphChanged,
             args: {
                 paragraphElement: odfUtils.getParagraphElement(node),
                 memberId: memberid,
                 timeStamp: timestamp
             }
-        }];
+        });
+        return events;
     };
 
     /**

webodf/lib/ops/OpRemoveText.js

@@ -95,7 +95,7 @@ ops.OpRemoveText = function OpRemoveText() {
 
         odtDocument.handleStepsRemoved({position: position}, events);
         odtDocument.downgradeWhitespacesAtPosition(position);
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
         odtDocument.getOdfCanvas().refreshSize();
         events.push({
             eventid: ops.OdtDocument.signalParagraphChanged,

webodf/lib/ops/OpSplitParagraph.js

@@ -177,7 +177,7 @@ ops.OpSplitParagraph = function OpSplitParagraph() {
             events.push({eventid: ops.Document.signalCursorMoved, args: cursor});
         }
 
-        odtDocument.fixCursorPositions();
+        odtDocument.fixCursorPositions(events);
         odtDocument.getOdfCanvas().refreshSize();
         // mark both paragraphs as edited
         events.push({