Text source range refactor (#949)

* Rename functions for better clarity

* Remove unused properties

* Add getNodesInRange function

* Improve ignore nodes check

* Use private fields

ext/fg/js/text-source-element.js

@@ -89,7 +89,7 @@ class TextSourceElement {
         // NOP
     }
 
-    equals(other) {
+    hasSameStart(other) {
         return (
             typeof other === 'object' &&
             other !== null &&
@@ -100,6 +100,10 @@ class TextSourceElement {
         );
     }
 
+    getNodesInRange() {
+        return [];
+    }
+
     static getElementContent(element) {
         let content;
         switch (element.nodeName.toUpperCase()) {

ext/fg/js/text-source-range.js

@@ -17,70 +17,75 @@
 
 /* global
  * DOMTextScanner
+ * DocumentUtil
  */
 
 class TextSourceRange {
     constructor(range, content, imposterContainer, imposterSourceElement) {
-        this.range = range;
+        this._range = range;
-        this.rangeStartOffset = range.startOffset;
+        this._rangeStartOffset = range.startOffset;
-        this.content = content;
+        this._content = content;
-        this.imposterContainer = imposterContainer;
+        this._imposterContainer = imposterContainer;
-        this.imposterSourceElement = imposterSourceElement;
+        this._imposterSourceElement = imposterSourceElement;
     }
 
-    get startOffset() {
+    get range() {
-        return this.range.startOffset;
+        return this._range;
     }
 
-    get endOffset() {
+    get rangeStartOffset() {
-        return this.range.endOffset;
+        return this._rangeStartOffset;
+    }
+
+    get imposterSourceElement() {
+        return this._imposterSourceElement;
     }
 
     clone() {
-        return new TextSourceRange(this.range.cloneRange(), this.content, this.imposterContainer, this.imposterSourceElement);
+        return new TextSourceRange(this._range.cloneRange(), this._content, this._imposterContainer, this._imposterSourceElement);
     }
 
     cleanup() {
-        if (this.imposterContainer !== null && this.imposterContainer.parentNode !== null) {
+        if (this._imposterContainer !== null && this._imposterContainer.parentNode !== null) {
-            this.imposterContainer.parentNode.removeChild(this.imposterContainer);
+            this._imposterContainer.parentNode.removeChild(this._imposterContainer);
         }
     }
 
     text() {
-        return this.content;
+        return this._content;
     }
 
     setEndOffset(length, layoutAwareScan, fromEnd=false) {
         const state = (
             fromEnd ?
-            new DOMTextScanner(this.range.endContainer, this.range.endOffset, !layoutAwareScan, layoutAwareScan).seek(length) :
+            new DOMTextScanner(this._range.endContainer, this._range.endOffset, !layoutAwareScan, layoutAwareScan).seek(length) :
-            new DOMTextScanner(this.range.startContainer, this.range.startOffset, !layoutAwareScan, layoutAwareScan).seek(length)
+            new DOMTextScanner(this._range.startContainer, this._range.startOffset, !layoutAwareScan, layoutAwareScan).seek(length)
         );
-        this.range.setEnd(state.node, state.offset);
+        this._range.setEnd(state.node, state.offset);
-        this.content = (fromEnd ? this.content + state.content : state.content);
+        this._content = (fromEnd ? this._content + state.content : state.content);
         return length - state.remainder;
     }
 
     setStartOffset(length, layoutAwareScan) {
-        const state = new DOMTextScanner(this.range.startContainer, this.range.startOffset, !layoutAwareScan, layoutAwareScan).seek(-length);
+        const state = new DOMTextScanner(this._range.startContainer, this._range.startOffset, !layoutAwareScan, layoutAwareScan).seek(-length);
-        this.range.setStart(state.node, state.offset);
+        this._range.setStart(state.node, state.offset);
-        this.rangeStartOffset = this.range.startOffset;
+        this._rangeStartOffset = this._range.startOffset;
-        this.content = state.content + this.content;
+        this._content = state.content + this._content;
         return length - state.remainder;
     }
 
     getRect() {
-        return this.range.getBoundingClientRect();
+        return this._range.getBoundingClientRect();
     }
 
     getWritingMode() {
-        return TextSourceRange.getElementWritingMode(TextSourceRange.getParentElement(this.range.startContainer));
+        return TextSourceRange.getElementWritingMode(TextSourceRange.getParentElement(this._range.startContainer));
     }
 
     select() {
         const selection = window.getSelection();
         selection.removeAllRanges();
-        selection.addRange(this.range);
+        selection.addRange(this._range);
     }
 
     deselect() {
@@ -88,7 +93,7 @@ class TextSourceRange {
         selection.removeAllRanges();
     }
 
-    equals(other) {
+    hasSameStart(other) {
         if (!(
             typeof other === 'object' &&
             other !== null &&
@@ -96,14 +101,14 @@ class TextSourceRange {
         )) {
             return false;
         }
-        if (this.imposterSourceElement !== null) {
+        if (this._imposterSourceElement !== null) {
             return (
-                this.imposterSourceElement === other.imposterSourceElement &&
+                this._imposterSourceElement === other.imposterSourceElement &&
-                this.rangeStartOffset === other.rangeStartOffset
+                this._rangeStartOffset === other.rangeStartOffset
             );
         } else {
             try {
-                return this.range.compareBoundaryPoints(Range.START_TO_START, other.range) === 0;
+                return this._range.compareBoundaryPoints(Range.START_TO_START, other.range) === 0;
             } catch (e) {
                 if (e.name === 'WrongDocumentError') {
                     // This can happen with shadow DOMs if the ranges are in different documents.
@@ -114,6 +119,10 @@ class TextSourceRange {
         }
     }
 
+    getNodesInRange() {
+        return DocumentUtil.getNodesInRange(this._range);
+    }
+
     static getParentElement(node) {
         while (node !== null && node.nodeType !== Node.ELEMENT_NODE) {
             node = node.parentNode;

ext/mixed/js/text-scanner.js

@@ -178,13 +178,12 @@ class TextScanner extends EventDispatcher {
 
         clonedTextSource.setEndOffset(length, layoutAwareScan);
 
-        if (this._ignoreNodes !== null && clonedTextSource.range) {
+        if (this._ignoreNodes !== null) {
             length = clonedTextSource.text().length;
-            while (clonedTextSource.range && length > 0) {
+            while (
-                const nodes = DocumentUtil.getNodesInRange(clonedTextSource.range);
+                length > 0 &&
-                if (!DocumentUtil.anyNodeMatchesSelector(nodes, this._ignoreNodes)) {
+                DocumentUtil.anyNodeMatchesSelector(clonedTextSource.getNodesInRange(), this._ignoreNodes)
-                    break;
+            ) {
-                }
                 --length;
                 clonedTextSource.setEndOffset(length, layoutAwareScan);
             }
@@ -247,7 +246,7 @@ class TextScanner extends EventDispatcher {
         let optionsContext = null;
 
         try {
-            if (this._textSourceCurrent !== null && this._textSourceCurrent.equals(textSource)) {
+            if (this._textSourceCurrent !== null && this._textSourceCurrent.hasSameStart(textSource)) {
                 return;
             }
 
@@ -772,7 +771,7 @@ class TextScanner extends EventDispatcher {
 
         if (
             this._textSourceCurrent !== null &&
-            !this._textSourceCurrent.equals(textSourceCurrentPrevious)
+            !this._textSourceCurrent.hasSameStart(textSourceCurrentPrevious)
         ) {
             this._preventScroll = preventScroll;
             this._preventNextContextMenu = true;