@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/model/operation/insertoperation.js

@@ -2,11 +2,9 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/model/operation/insertoperation
  */
-
 import Operation from './operation';
 import Position from '../position';
 import NodeList from '../nodelist';
@@ -15,174 +13,145 @@ import { _insert, _normalizeNodes } from './utils';
 import Text from '../text';
 import Element from '../element';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
-
 /**
  * Operation to insert one or more nodes at given position in the model.
  *
  * @extends module:engine/model/operation/operation~Operation
  */
 export default class InsertOperation extends Operation {
-	/**
-	 * Creates an insert operation.
-	 *
-	 * @param {module:engine/model/position~Position} position Position of insertion.
-	 * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted.
-	 * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-	 * can be applied or `null` if the operation operates on detached (non-document) tree.
-	 */
-	constructor( position, nodes, baseVersion ) {
-		super( baseVersion );
-
-		/**
-		 * Position of insertion.
-		 *
-		 * @readonly
-		 * @member {module:engine/model/position~Position} module:engine/model/operation/insertoperation~InsertOperation#position
-		 */
-		this.position = position.clone();
-		this.position.stickiness = 'toNone';
-
-		/**
-		 * List of nodes to insert.
-		 *
-		 * @readonly
-		 * @member {module:engine/model/nodelist~NodeList} module:engine/model/operation/insertoperation~InsertOperation#nodeList
-		 */
-		this.nodes = new NodeList( _normalizeNodes( nodes ) );
-
-		/**
-		 * Flag deciding how the operation should be transformed. If set to `true`, nodes might get additional attributes
-		 * during operational transformation. This happens when the operation insertion position is inside of a range
-		 * where attributes have changed.
-		 *
-		 * @member {Boolean} module:engine/model/operation/insertoperation~InsertOperation#shouldReceiveAttributes
-		 */
-		this.shouldReceiveAttributes = false;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	get type() {
-		return 'insert';
-	}
-
-	/**
-	 * Total offset size of inserted nodes.
-	 *
-	 * @returns {Number}
-	 */
-	get howMany() {
-		return this.nodes.maxOffset;
-	}
-
-	/**
-	 * Creates and returns an operation that has the same parameters as this operation.
-	 *
-	 * @returns {module:engine/model/operation/insertoperation~InsertOperation} Clone of this operation.
-	 */
-	clone() {
-		const nodes = new NodeList( [ ...this.nodes ].map( node => node._clone( true ) ) );
-		const insert = new InsertOperation( this.position, nodes, this.baseVersion );
-
-		insert.shouldReceiveAttributes = this.shouldReceiveAttributes;
-
-		return insert;
-	}
-
-	/**
-	 * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-	 *
-	 * @returns {module:engine/model/operation/moveoperation~MoveOperation}
-	 */
-	getReversed() {
-		const graveyard = this.position.root.document.graveyard;
-		const gyPosition = new Position( graveyard, [ 0 ] );
-
-		return new MoveOperation( this.position, this.nodes.maxOffset, gyPosition, this.baseVersion + 1 );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_validate() {
-		const targetElement = this.position.parent;
-
-		if ( !targetElement || targetElement.maxOffset < this.position.offset ) {
-			/**
-			 * Insertion position is invalid.
-			 *
-			 * @error insert-operation-position-invalid
-			 */
-			throw new CKEditorError(
-				'insert-operation-position-invalid',
-				this
-			);
-		}
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_execute() {
-		// What happens here is that we want original nodes be passed to writer because we want original nodes
-		// to be inserted to the model. But in InsertOperation, we want to keep those nodes as they were added
-		// to the operation, not modified. For example, text nodes can get merged or cropped while Elements can
-		// get children. It is important that InsertOperation has the copy of original nodes in intact state.
-		const originalNodes = this.nodes;
-		this.nodes = new NodeList( [ ...originalNodes ].map( node => node._clone( true ) ) );
-
-		_insert( this.position, originalNodes );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	toJSON() {
-		const json = super.toJSON();
-
-		json.position = this.position.toJSON();
-		json.nodes = this.nodes.toJSON();
-
-		return json;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get className() {
-		return 'InsertOperation';
-	}
-
-	/**
-	 * Creates `InsertOperation` object from deserilized object, i.e. from parsed JSON string.
-	 *
-	 * @param {Object} json Deserialized JSON object.
-	 * @param {module:engine/model/document~Document} document Document on which this operation will be applied.
-	 * @returns {module:engine/model/operation/insertoperation~InsertOperation}
-	 */
-	static fromJSON( json, document ) {
-		const children = [];
-
-		for ( const child of json.nodes ) {
-			if ( child.name ) {
-				// If child has name property, it is an Element.
-				children.push( Element.fromJSON( child ) );
-			} else {
-				// Otherwise, it is a Text node.
-				children.push( Text.fromJSON( child ) );
-			}
-		}
-
-		const insert = new InsertOperation( Position.fromJSON( json.position, document ), children, json.baseVersion );
-		insert.shouldReceiveAttributes = json.shouldReceiveAttributes;
-
-		return insert;
-	}
-
-	// @if CK_DEBUG_ENGINE // toString() {
-	// @if CK_DEBUG_ENGINE // 	const nodeString = this.nodes.length > 1 ? `[ ${ this.nodes.length } ]` : this.nodes.getNode( 0 );
-
-	// @if CK_DEBUG_ENGINE //	return `InsertOperation( ${ this.baseVersion } ): ${ nodeString } -> ${ this.position }`;
-	// @if CK_DEBUG_ENGINE // }
+    /**
+     * Creates an insert operation.
+     *
+     * @param {module:engine/model/position~Position} position Position of insertion.
+     * @param {module:engine/model/node~NodeSet} nodes The list of nodes to be inserted.
+     * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(position, nodes, baseVersion) {
+        super(baseVersion);
+        /**
+         * Position of insertion.
+         *
+         * @readonly
+         * @member {module:engine/model/position~Position} module:engine/model/operation/insertoperation~InsertOperation#position
+         */
+        this.position = position.clone();
+        this.position.stickiness = 'toNone';
+        /**
+         * List of nodes to insert.
+         *
+         * @readonly
+         * @member {module:engine/model/nodelist~NodeList} module:engine/model/operation/insertoperation~InsertOperation#nodeList
+         */
+        this.nodes = new NodeList(_normalizeNodes(nodes));
+        /**
+         * Flag deciding how the operation should be transformed. If set to `true`, nodes might get additional attributes
+         * during operational transformation. This happens when the operation insertion position is inside of a range
+         * where attributes have changed.
+         *
+         * @member {Boolean} module:engine/model/operation/insertoperation~InsertOperation#shouldReceiveAttributes
+         */
+        this.shouldReceiveAttributes = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    get type() {
+        return 'insert';
+    }
+    /**
+     * Total offset size of inserted nodes.
+     *
+     * @returns {Number}
+     */
+    get howMany() {
+        return this.nodes.maxOffset;
+    }
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns {module:engine/model/operation/insertoperation~InsertOperation} Clone of this operation.
+     */
+    clone() {
+        const nodes = new NodeList([...this.nodes].map(node => node._clone(true)));
+        const insert = new InsertOperation(this.position, nodes, this.baseVersion);
+        insert.shouldReceiveAttributes = this.shouldReceiveAttributes;
+        return insert;
+    }
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     *
+     * @returns {module:engine/model/operation/moveoperation~MoveOperation}
+     */
+    getReversed() {
+        const graveyard = this.position.root.document.graveyard;
+        const gyPosition = new Position(graveyard, [0]);
+        return new MoveOperation(this.position, this.nodes.maxOffset, gyPosition, this.baseVersion + 1);
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate() {
+        const targetElement = this.position.parent;
+        if (!targetElement || targetElement.maxOffset < this.position.offset) {
+            /**
+             * Insertion position is invalid.
+             *
+             * @error insert-operation-position-invalid
+             */
+            throw new CKEditorError('insert-operation-position-invalid', this);
+        }
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute() {
+        // What happens here is that we want original nodes be passed to writer because we want original nodes
+        // to be inserted to the model. But in InsertOperation, we want to keep those nodes as they were added
+        // to the operation, not modified. For example, text nodes can get merged or cropped while Elements can
+        // get children. It is important that InsertOperation has the copy of original nodes in intact state.
+        const originalNodes = this.nodes;
+        this.nodes = new NodeList([...originalNodes].map(node => node._clone(true)));
+        _insert(this.position, originalNodes);
+    }
+    /**
+     * @inheritDoc
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.position = this.position.toJSON();
+        json.nodes = this.nodes.toJSON();
+        return json;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get className() {
+        return 'InsertOperation';
+    }
+    /**
+     * Creates `InsertOperation` object from deserilized object, i.e. from parsed JSON string.
+     *
+     * @param {Object} json Deserialized JSON object.
+     * @param {module:engine/model/document~Document} document Document on which this operation will be applied.
+     * @returns {module:engine/model/operation/insertoperation~InsertOperation}
+     */
+    static fromJSON(json, document) {
+        const children = [];
+        for (const child of json.nodes) {
+            if (child.name) {
+                // If child has name property, it is an Element.
+                children.push(Element.fromJSON(child));
+            }
+            else {
+                // Otherwise, it is a Text node.
+                children.push(Text.fromJSON(child));
+            }
+        }
+        const insert = new InsertOperation(Position.fromJSON(json.position, document), children, json.baseVersion);
+        insert.shouldReceiveAttributes = json.shouldReceiveAttributes;
+        return insert;
+    }
 }

package/src/model/operation/markeroperation.js

@@ -2,153 +2,127 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine/model/operation/markeroperation
  */
-
 import Operation from './operation';
 import Range from '../range';
-
 /**
  * @extends module:engine/model/operation/operation~Operation
  */
 export default class MarkerOperation extends Operation {
-	/**
-	 * @param {String} name Marker name.
-	 * @param {module:engine/model/range~Range} oldRange Marker range before the change.
-	 * @param {module:engine/model/range~Range} newRange Marker range after the change.
-	 * @param {module:engine/model/markercollection~MarkerCollection} markers Marker collection on which change should be executed.
-	 * @param {Boolean} affectsData Specifies whether the marker operation affects the data produced by the data pipeline
-	 * (is persisted in the editor's data).
-	 * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
-	 * can be applied or `null` if the operation operates on detached (non-document) tree.
-	 */
-	constructor( name, oldRange, newRange, markers, affectsData, baseVersion ) {
-		super( baseVersion );
-
-		/**
-		 * Marker name.
-		 *
-		 * @readonly
-		 * @member {String}
-		 */
-		this.name = name;
-
-		/**
-		 * Marker range before the change.
-		 *
-		 * @readonly
-		 * @member {module:engine/model/range~Range}
-		 */
-		this.oldRange = oldRange ? oldRange.clone() : null;
-
-		/**
-		 * Marker range after the change.
-		 *
-		 * @readonly
-		 * @member {module:engine/model/range~Range}
-		 */
-		this.newRange = newRange ? newRange.clone() : null;
-
-		/**
-		 * Specifies whether the marker operation affects the data produced by the data pipeline
-		 * (is persisted in the editor's data).
-		 *
-		 * @readonly
-		 * @member {Boolean}
-		 */
-		this.affectsData = affectsData;
-
-		/**
-		 * Marker collection on which change should be executed.
-		 *
-		 * @private
-		 * @member {module:engine/model/markercollection~MarkerCollection}
-		 */
-		this._markers = markers;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	get type() {
-		return 'marker';
-	}
-
-	/**
-	 * Creates and returns an operation that has the same parameters as this operation.
-	 *
-	 * @returns {module:engine/model/operation/markeroperation~MarkerOperation} Clone of this operation.
-	 */
-	clone() {
-		return new MarkerOperation( this.name, this.oldRange, this.newRange, this._markers, this.affectsData, this.baseVersion );
-	}
-
-	/**
-	 * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-	 *
-	 * @returns {module:engine/model/operation/markeroperation~MarkerOperation}
-	 */
-	getReversed() {
-		return new MarkerOperation( this.name, this.newRange, this.oldRange, this._markers, this.affectsData, this.baseVersion + 1 );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_execute() {
-		const type = this.newRange ? '_set' : '_remove';
-
-		this._markers[ type ]( this.name, this.newRange, true, this.affectsData );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	toJSON() {
-		const json = super.toJSON();
-
-		if ( this.oldRange ) {
-			json.oldRange = this.oldRange.toJSON();
-		}
-
-		if ( this.newRange ) {
-			json.newRange = this.newRange.toJSON();
-		}
-
-		delete json._markers;
-
-		return json;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get className() {
-		return 'MarkerOperation';
-	}
-
-	/**
-	 * Creates `MarkerOperation` object from deserialized object, i.e. from parsed JSON string.
-	 *
-	 * @param {Object} json Deserialized JSON object.
-	 * @param {module:engine/model/document~Document} document Document on which this operation will be applied.
-	 * @returns {module:engine/model/operation/markeroperation~MarkerOperation}
-	 */
-	static fromJSON( json, document ) {
-		return new MarkerOperation(
-			json.name,
-			json.oldRange ? Range.fromJSON( json.oldRange, document ) : null,
-			json.newRange ? Range.fromJSON( json.newRange, document ) : null,
-			document.model.markers,
-			json.affectsData,
-			json.baseVersion
-		);
-	}
-
-	// @if CK_DEBUG_ENGINE // toString() {
-	// @if CK_DEBUG_ENGINE // 	return `MarkerOperation( ${ this.baseVersion } ): ` +
-	// @if CK_DEBUG_ENGINE //		`"${ this.name }": ${ this.oldRange } -> ${ this.newRange }`;
-	// @if CK_DEBUG_ENGINE // }
+    /**
+     * @param {String} name Marker name.
+     * @param {module:engine/model/range~Range|null} oldRange Marker range before the change.
+     * @param {module:engine/model/range~Range|null} newRange Marker range after the change.
+     * @param {module:engine/model/markercollection~MarkerCollection} markers Marker collection on which change should be executed.
+     * @param {Boolean} affectsData Specifies whether the marker operation affects the data produced by the data pipeline
+     * (is persisted in the editor's data).
+     * @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(name, oldRange, newRange, markers, affectsData, baseVersion) {
+        super(baseVersion);
+        /**
+         * Marker name.
+         *
+         * @readonly
+         * @member {String}
+         */
+        this.name = name;
+        /**
+         * Marker range before the change.
+         *
+         * @readonly
+         * @member {module:engine/model/range~Range|null}
+         */
+        this.oldRange = oldRange ? oldRange.clone() : null;
+        /**
+         * Marker range after the change.
+         *
+         * @readonly
+         * @member {module:engine/model/range~Range}
+         */
+        this.newRange = newRange ? newRange.clone() : null;
+        /**
+         * Specifies whether the marker operation affects the data produced by the data pipeline
+         * (is persisted in the editor's data).
+         *
+         * @readonly
+         * @member {Boolean}
+         */
+        this.affectsData = affectsData;
+        /**
+         * Marker collection on which change should be executed.
+         *
+         * @private
+         * @member {module:engine/model/markercollection~MarkerCollection}
+         */
+        this._markers = markers;
+    }
+    /**
+     * @inheritDoc
+     */
+    get type() {
+        return 'marker';
+    }
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns {module:engine/model/operation/markeroperation~MarkerOperation} Clone of this operation.
+     */
+    clone() {
+        return new MarkerOperation(this.name, this.oldRange, this.newRange, this._markers, this.affectsData, this.baseVersion);
+    }
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     *
+     * @returns {module:engine/model/operation/markeroperation~MarkerOperation}
+     */
+    getReversed() {
+        return new MarkerOperation(this.name, this.newRange, this.oldRange, this._markers, this.affectsData, this.baseVersion + 1);
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute() {
+        if (this.newRange) {
+            this._markers._set(this.name, this.newRange, true, this.affectsData);
+        }
+        else {
+            this._markers._remove(this.name);
+        }
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    toJSON() {
+        const json = super.toJSON();
+        if (this.oldRange) {
+            json.oldRange = this.oldRange.toJSON();
+        }
+        if (this.newRange) {
+            json.newRange = this.newRange.toJSON();
+        }
+        delete json._markers;
+        return json;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get className() {
+        return 'MarkerOperation';
+    }
+    /**
+     * Creates `MarkerOperation` object from deserialized object, i.e. from parsed JSON string.
+     *
+     * @param {Object} json Deserialized JSON object.
+     * @param {module:engine/model/document~Document} document Document on which this operation will be applied.
+     * @returns {module:engine/model/operation/markeroperation~MarkerOperation}
+     */
+    static fromJSON(json, document) {
+        return new MarkerOperation(json.name, json.oldRange ? Range.fromJSON(json.oldRange, document) : null, json.newRange ? Range.fromJSON(json.newRange, document) : null, document.model.markers, json.affectsData, json.baseVersion);
+    }
 }