@ckeditor/ckeditor5-engine 43.2.0 → 43.3.0-alpha.1

package/src/model/nodelist.js

@@ -14,7 +14,7 @@ import { CKEditorError, spliceArray } from '@ckeditor/ckeditor5-utils';
  */
 export default class NodeList {
     /**
-     * Creates an empty node list.
+     * Creates a node list.
      *
      * @internal
      * @param nodes Nodes contained in this node list.
@@ -24,6 +24,14 @@ export default class NodeList {
          * Nodes contained in this node list.
          */
         this._nodes = [];
+        /**
+         * This array maps numbers (offsets) to node that is placed at that offset.
+         *
+         * This array is similar to `_nodes` with the difference that one node may occupy multiple consecutive items in the array.
+         *
+         * This array is needed to quickly retrieve a node that is placed at given offset.
+         */
+        this._offsetToNode = [];
         if (nodes) {
             this._insertNodes(0, nodes);
         }
@@ -46,7 +54,7 @@ export default class NodeList {
      * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all nodes contained inside this node list.
      */
     get maxOffset() {
-        return this._nodes.reduce((sum, node) => sum + node.offsetSize, 0);
+        return this._offsetToNode.length;
     }
     /**
      * Gets the node at the given index. Returns `null` if incorrect index was passed.
@@ -55,32 +63,32 @@ export default class NodeList {
         return this._nodes[index] || null;
     }
     /**
-     * Returns an index of the given node. Returns `null` if given node is not inside this node list.
+     * Gets the node at the given offset. Returns `null` if incorrect offset was passed.
+     */
+    getNodeAtOffset(offset) {
+        return this._offsetToNode[offset] || null;
+    }
+    /**
+     * Returns an index of the given node or `null` if given node does not have a parent.
+     *
+     * This is an alias to {@link module:engine/model/node~Node#index}.
      */
     getNodeIndex(node) {
-        const index = this._nodes.indexOf(node);
-        return index == -1 ? null : index;
+        return node.index;
     }
     /**
-     * Returns the starting offset of given node. Starting offset is equal to the sum of
-     * {@link module:engine/model/node~Node#offsetSize offset sizes} of all nodes that are before this node in this node list.
+     * Returns the offset at which given node is placed in its parent or `null` if given node does not have a parent.
+     *
+     * This is an alias to {@link module:engine/model/node~Node#startOffset}.
      */
     getNodeStartOffset(node) {
-        const index = this.getNodeIndex(node);
-        if (index === null) {
-            return null;
-        }
-        let sum = 0;
-        for (let i = 0; i < index; i++) {
-            sum += this._nodes[i].offsetSize;
-        }
-        return sum;
+        return node.startOffset;
     }
     /**
      * Converts index to offset in node list.
      *
-     * Returns starting offset of a node that is at given index. Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError}
-     * `model-nodelist-index-out-of-bounds` if given index is less than `0` or more than {@link #length}.
+     * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `model-nodelist-index-out-of-bounds` if given index is less
+     * than `0` or more than {@link #length}.
      */
     indexToOffset(index) {
         if (index == this._nodes.length) {
@@ -100,18 +108,15 @@ export default class NodeList {
     /**
      * Converts offset in node list to index.
      *
-     * Returns index of a node that occupies given offset. Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError}
-     * `model-nodelist-offset-out-of-bounds` if given offset is less than `0` or more than {@link #maxOffset}.
+     * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `model-nodelist-offset-out-of-bounds` if given offset is less
+     * than `0` or more than {@link #maxOffset}.
      */
     offsetToIndex(offset) {
-        let totalOffset = 0;
-        for (const node of this._nodes) {
-            if (offset >= totalOffset && offset < totalOffset + node.offsetSize) {
-                return this.getNodeIndex(node);
-            }
-            totalOffset += node.offsetSize;
+        if (offset == this._offsetToNode.length) {
+            return this._nodes.length;
         }
-        if (totalOffset != offset) {
+        const node = this._offsetToNode[offset];
+        if (!node) {
             /**
              * Given offset cannot be found in the node list.
              *
@@ -124,7 +129,7 @@ export default class NodeList {
                 nodeList: this
             });
         }
-        return this.length;
+        return this.getNodeIndex(node);
     }
     /**
      * Inserts given nodes at given index.
@@ -145,7 +150,18 @@ export default class NodeList {
                 throw new CKEditorError('model-nodelist-insertnodes-not-node', this);
             }
         }
-        this._nodes = spliceArray(this._nodes, Array.from(nodes), index, 0);
+        const nodesArray = Array.from(nodes);
+        const offsetsArray = makeOffsetsArray(nodesArray);
+        let offset = this.indexToOffset(index);
+        // Splice nodes array and offsets array into the nodelist.
+        this._nodes = spliceArray(this._nodes, nodesArray, index, 0);
+        this._offsetToNode = spliceArray(this._offsetToNode, offsetsArray, offset, 0);
+        // Refresh indexes and offsets for nodes inside this node list. We need to do this for all inserted nodes and all nodes after them.
+        for (let i = index; i < this._nodes.length; i++) {
+            this._nodes[i]._index = i;
+            this._nodes[i]._startOffset = offset;
+            offset += this._nodes[i].offsetSize;
+        }
     }
     /**
      * Removes one or more nodes starting at the given index.
@@ -156,7 +172,26 @@ export default class NodeList {
      * @returns Array containing removed nodes.
      */
     _removeNodes(indexStart, howMany = 1) {
-        return this._nodes.splice(indexStart, howMany);
+        if (howMany == 0) {
+            return [];
+        }
+        // Remove nodes from this nodelist.
+        let offset = this.indexToOffset(indexStart);
+        const nodes = this._nodes.splice(indexStart, howMany);
+        const lastNode = nodes[nodes.length - 1];
+        const removedOffsetSum = lastNode.startOffset + lastNode.offsetSize - offset;
+        this._offsetToNode.splice(offset, removedOffsetSum);
+        // Reset index and start offset properties for the removed nodes -- they do not have a parent anymore.
+        for (const node of nodes) {
+            node._index = null;
+            node._startOffset = null;
+        }
+        for (let i = indexStart; i < this._nodes.length; i++) {
+            this._nodes[i]._index = i;
+            this._nodes[i]._startOffset = offset;
+            offset += this._nodes[i].offsetSize;
+        }
+        return nodes;
     }
     /**
      * Converts `NodeList` instance to an array containing nodes that were inserted in the node list. Nodes
@@ -168,3 +203,16 @@ export default class NodeList {
         return this._nodes.map(node => node.toJSON());
     }
 }
+/**
+ * Creates an array of nodes in the format as in {@link module:engine/model/nodelist~NodeList#_offsetToNode}, i.e. one node will
+ * occupy multiple items if its offset size is greater than one.
+ */
+function makeOffsetsArray(nodes) {
+    const offsets = [];
+    for (const node of nodes) {
+        const start = offsets.length;
+        offsets.length += node.offsetSize;
+        offsets.fill(node, start);
+    }
+    return offsets;
+}

package/src/model/position.d.ts

@@ -124,11 +124,11 @@ export default class Position extends TypeCheckable {
      */
     get textNode(): Text | null;
     /**
-     * Node directly after this position or `null` if this position is in text node.
+     * Node directly after this position. Returns `null` if this position is at the end of its parent, or if it is in a text node.
      */
     get nodeAfter(): Node | null;
     /**
-     * Node directly before this position or `null` if this position is in text node.
+     * Node directly before this position. Returns `null` if this position is at the start of its parent, or if it is in a text node.
      */
     get nodeBefore(): Node | null;
     /**
@@ -139,6 +139,10 @@ export default class Position extends TypeCheckable {
      * Is `true` if position is at the end of its {@link module:engine/model/position~Position#parent parent}, `false` otherwise.
      */
     get isAtEnd(): boolean;
+    /**
+     * Checks whether the position is valid in current model tree, that is whether it points to an existing place in the model.
+     */
+    isValid(): boolean;
     /**
      * Checks whether this position is before or after given position.
      *
@@ -496,6 +500,7 @@ export type PositionStickiness = 'toNone' | 'toNext' | 'toPrevious';
  * * {@link module:engine/model/position~getNodeAfterPosition}
  * * {@link module:engine/model/position~getNodeBeforePosition}
  *
+ * @param position
  * @param positionParent The parent of the given position.
  */
 export declare function getTextNodeAtPosition(position: Position, positionParent: Element | DocumentFragment): Text | null;
@@ -518,6 +523,7 @@ export declare function getTextNodeAtPosition(position: Position, positionParent
  * * {@link module:engine/model/position~getTextNodeAtPosition}
  * * {@link module:engine/model/position~getNodeBeforePosition}
  *
+ * @param position Position to check.
  * @param positionParent The parent of the given position.
  * @param textNode Text node at the given position.
  */
@@ -532,6 +538,7 @@ export declare function getNodeAfterPosition(position: Position, positionParent:
  * * {@link module:engine/model/position~getTextNodeAtPosition}
  * * {@link module:engine/model/position~getNodeAfterPosition}
  *
+ * @param position Position to check.
  * @param positionParent The parent of the given position.
  * @param textNode Text node at the given position.
  */

package/src/model/position.js

@@ -100,7 +100,7 @@ export default class Position extends TypeCheckable {
     get parent() {
         let parent = this.root;
         for (let i = 0; i < this.path.length - 1; i++) {
-            parent = parent.getChild(parent.offsetToIndex(this.path[i]));
+            parent = parent.getChildAtOffset(this.path[i]);
             if (!parent) {
                 /**
                  * The position's path is incorrect. This means that a position does not point to
@@ -141,7 +141,7 @@ export default class Position extends TypeCheckable {
         return getTextNodeAtPosition(this, this.parent);
     }
     /**
-     * Node directly after this position or `null` if this position is in text node.
+     * Node directly after this position. Returns `null` if this position is at the end of its parent, or if it is in a text node.
      */
     get nodeAfter() {
         // Cache the parent and reuse for performance reasons. See #6579 and #6582.
@@ -149,7 +149,7 @@ export default class Position extends TypeCheckable {
         return getNodeAfterPosition(this, parent, getTextNodeAtPosition(this, parent));
     }
     /**
-     * Node directly before this position or `null` if this position is in text node.
+     * Node directly before this position. Returns `null` if this position is at the start of its parent, or if it is in a text node.
      */
     get nodeBefore() {
         // Cache the parent and reuse for performance reasons. See #6579 and #6582.
@@ -168,6 +168,22 @@ export default class Position extends TypeCheckable {
     get isAtEnd() {
         return this.offset == this.parent.maxOffset;
     }
+    /**
+     * Checks whether the position is valid in current model tree, that is whether it points to an existing place in the model.
+     */
+    isValid() {
+        if (this.offset < 0) {
+            return false;
+        }
+        let parent = this.root;
+        for (let i = 0; i < this.path.length - 1; i++) {
+            parent = parent.getChildAtOffset(this.path[i]);
+            if (!parent) {
+                return false;
+            }
+        }
+        return this.offset <= parent.maxOffset;
+    }
     /**
      * Checks whether this position is before or after given position.
      *
@@ -841,10 +857,11 @@ Position.prototype.is = function (type) {
  * * {@link module:engine/model/position~getNodeAfterPosition}
  * * {@link module:engine/model/position~getNodeBeforePosition}
  *
+ * @param position
  * @param positionParent The parent of the given position.
  */
 export function getTextNodeAtPosition(position, positionParent) {
-    const node = positionParent.getChild(positionParent.offsetToIndex(position.offset));
+    const node = positionParent.getChildAtOffset(position.offset);
     if (node && node.is('$text') && node.startOffset < position.offset) {
         return node;
     }
@@ -869,6 +886,7 @@ export function getTextNodeAtPosition(position, positionParent) {
  * * {@link module:engine/model/position~getTextNodeAtPosition}
  * * {@link module:engine/model/position~getNodeBeforePosition}
  *
+ * @param position Position to check.
  * @param positionParent The parent of the given position.
  * @param textNode Text node at the given position.
  */
@@ -876,7 +894,7 @@ export function getNodeAfterPosition(position, positionParent, textNode) {
     if (textNode !== null) {
         return null;
     }
-    return positionParent.getChild(positionParent.offsetToIndex(position.offset));
+    return positionParent.getChildAtOffset(position.offset);
 }
 /**
  * Returns the node before the given position.
@@ -888,6 +906,7 @@ export function getNodeAfterPosition(position, positionParent, textNode) {
  * * {@link module:engine/model/position~getTextNodeAtPosition}
  * * {@link module:engine/model/position~getNodeAfterPosition}
  *
+ * @param position Position to check.
  * @param positionParent The parent of the given position.
  * @param textNode Text node at the given position.
  */

package/src/view/domconverter.js

@@ -77,7 +77,7 @@ export default class DomConverter {
         this.document = document;
         this.renderingMode = renderingMode;
         this.blockFillerMode = blockFillerMode || (renderingMode === 'editing' ? 'br' : 'nbsp');
-        this.preElements = ['pre'];
+        this.preElements = ['pre', 'textarea'];
         this.blockElements = [
             'address', 'article', 'aside', 'blockquote', 'caption', 'center', 'dd', 'details', 'dir', 'div',
             'dl', 'dt', 'fieldset', 'figcaption', 'figure', 'footer', 'form', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'header',
@@ -1097,6 +1097,8 @@ export default class DomConverter {
             // for inline objects can verify if the element is empty.
             if (this._isInlineObjectElement(viewElement)) {
                 inlineNodes.push(viewElement);
+                // Inline object content should be handled as a flow-root.
+                this._processDomInlineNodes(null, nestedInlineNodes, options);
             }
             else {
                 // It's an inline element that is not an object (like <b>, <i>) or a block element.