@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/model/operation/moveoperation.js

@@ -2,20 +2,16 @@
  * @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/moveoperation
  */
-
 import Operation from './operation';
 import Position from '../position';
 import Range from '../range';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
 import compareArrays from '@ckeditor/ckeditor5-utils/src/comparearrays';
 import { _move } from './utils';
-
 // @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;
-
 /**
  * Operation to move a range of {@link module:engine/model/item~Item model items}
  * to given {@link module:engine/model/position~Position target position}.
@@ -23,187 +19,161 @@ import { _move } from './utils';
  * @extends module:engine/model/operation/operation~Operation
  */
 export default class MoveOperation extends Operation {
-	/**
-	 * Creates a move operation.
-	 *
-	 * @param {module:engine/model/position~Position} sourcePosition
-	 * Position before the first {@link module:engine/model/item~Item model item} to move.
-	 * @param {Number} howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
-	 * `sourcePosition` with offset shifted by `howMany`.
-	 * @param {module:engine/model/position~Position} targetPosition Position at which moved nodes will 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( sourcePosition, howMany, targetPosition, baseVersion ) {
-		super( baseVersion );
-
-		/**
-		 * Position before the first {@link module:engine/model/item~Item model item} to move.
-		 *
-		 * @member {module:engine/model/position~Position} module:engine/model/operation/moveoperation~MoveOperation#sourcePosition
-		 */
-		this.sourcePosition = sourcePosition.clone();
-		// `'toNext'` because `sourcePosition` is a bit like a start of the moved range.
-		this.sourcePosition.stickiness = 'toNext';
-
-		/**
-		 * Offset size of moved range.
-		 *
-		 * @member {Number} module:engine/model/operation/moveoperation~MoveOperation#howMany
-		 */
-		this.howMany = howMany;
-
-		/**
-		 * Position at which moved nodes will be inserted.
-		 *
-		 * @member {module:engine/model/position~Position} module:engine/model/operation/moveoperation~MoveOperation#targetPosition
-		 */
-		this.targetPosition = targetPosition.clone();
-		this.targetPosition.stickiness = 'toNone';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	get type() {
-		if ( this.targetPosition.root.rootName == '$graveyard' ) {
-			return 'remove';
-		} else if ( this.sourcePosition.root.rootName == '$graveyard' ) {
-			return 'reinsert';
-		}
-
-		return 'move';
-	}
-
-	/**
-	 * Creates and returns an operation that has the same parameters as this operation.
-	 *
-	 * @returns {module:engine/model/operation/moveoperation~MoveOperation} Clone of this operation.
-	 */
-	clone() {
-		return new this.constructor( this.sourcePosition, this.howMany, this.targetPosition, this.baseVersion );
-	}
-
-	/**
-	 * Returns the start position of the moved range after it got moved. This may be different than
-	 * {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition} in some cases, i.e. when a range is moved
-	 * inside the same parent but {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition targetPosition}
-	 * is after {@link module:engine/model/operation/moveoperation~MoveOperation#sourcePosition sourcePosition}.
-	 *
-	 *		 vv              vv
-	 *		abcdefg ===> adefbcg
-	 *		     ^          ^
-	 *		     targetPos	movedRangeStart
-	 *		     offset 6	offset 4
-	 *
-	 * @returns {module:engine/model/position~Position}
-	 */
-	getMovedRangeStart() {
-		return this.targetPosition._getTransformedByDeletion( this.sourcePosition, this.howMany );
-	}
-
-	/**
-	 * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-	 *
-	 * @returns {module:engine/model/operation/moveoperation~MoveOperation}
-	 */
-	getReversed() {
-		const newTargetPosition = this.sourcePosition._getTransformedByInsertion( this.targetPosition, this.howMany );
-
-		return new this.constructor( this.getMovedRangeStart(), this.howMany, newTargetPosition, this.baseVersion + 1 );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_validate() {
-		const sourceElement = this.sourcePosition.parent;
-		const targetElement = this.targetPosition.parent;
-		const sourceOffset = this.sourcePosition.offset;
-		const targetOffset = this.targetPosition.offset;
-
-		// Validate whether move operation has correct parameters.
-		// Validation is pretty complex but move operation is one of the core ways to manipulate the document state.
-		// We expect that many errors might be connected with one of scenarios described below.
-		if ( sourceOffset + this.howMany > sourceElement.maxOffset ) {
-			/**
-			 * The nodes which should be moved do not exist.
-			 *
-			 * @error move-operation-nodes-do-not-exist
-			 */
-			throw new CKEditorError(
-				'move-operation-nodes-do-not-exist', this
-			);
-		} else if ( sourceElement === targetElement && sourceOffset < targetOffset && targetOffset < sourceOffset + this.howMany ) {
-			/**
-			 * Trying to move a range of nodes into the middle of that range.
-			 *
-			 * @error move-operation-range-into-itself
-			 */
-			throw new CKEditorError(
-				'move-operation-range-into-itself', this
-			);
-		} else if ( this.sourcePosition.root == this.targetPosition.root ) {
-			if ( compareArrays( this.sourcePosition.getParentPath(), this.targetPosition.getParentPath() ) == 'prefix' ) {
-				const i = this.sourcePosition.path.length - 1;
-
-				if ( this.targetPosition.path[ i ] >= sourceOffset && this.targetPosition.path[ i ] < sourceOffset + this.howMany ) {
-					/**
-					 * Trying to move a range of nodes into one of nodes from that range.
-					 *
-					 * @error move-operation-node-into-itself
-					 */
-					throw new CKEditorError(
-						'move-operation-node-into-itself', this
-					);
-				}
-			}
-		}
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_execute() {
-		_move( Range._createFromPositionAndShift( this.sourcePosition, this.howMany ), this.targetPosition );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	toJSON() {
-		const json = super.toJSON();
-
-		json.sourcePosition = this.sourcePosition.toJSON();
-		json.targetPosition = this.targetPosition.toJSON();
-
-		return json;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get className() {
-		return 'MoveOperation';
-	}
-
-	/**
-	 * Creates `MoveOperation` 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/moveoperation~MoveOperation}
-	 */
-	static fromJSON( json, document ) {
-		const sourcePosition = Position.fromJSON( json.sourcePosition, document );
-		const targetPosition = Position.fromJSON( json.targetPosition, document );
-
-		return new this( sourcePosition, json.howMany, targetPosition, json.baseVersion );
-	}
-
-	// @if CK_DEBUG_ENGINE // toString() {
-	// @if CK_DEBUG_ENGINE // 	const range = ModelRange._createFromPositionAndShift( this.sourcePosition, this.howMany );
-
-	// @if CK_DEBUG_ENGINE //	return `MoveOperation( ${ this.baseVersion } ): ${ range } -> ${ this.targetPosition }`;
-	// @if CK_DEBUG_ENGINE // }
+    /**
+     * Creates a move operation.
+     *
+     * @param {module:engine/model/position~Position} sourcePosition
+     * Position before the first {@link module:engine/model/item~Item model item} to move.
+     * @param {Number} howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
+     * `sourcePosition` with offset shifted by `howMany`.
+     * @param {module:engine/model/position~Position} targetPosition Position at which moved nodes will 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(sourcePosition, howMany, targetPosition, baseVersion) {
+        super(baseVersion);
+        /**
+         * Position before the first {@link module:engine/model/item~Item model item} to move.
+         *
+         * @member {module:engine/model/position~Position} module:engine/model/operation/moveoperation~MoveOperation#sourcePosition
+         */
+        this.sourcePosition = sourcePosition.clone();
+        // `'toNext'` because `sourcePosition` is a bit like a start of the moved range.
+        this.sourcePosition.stickiness = 'toNext';
+        /**
+         * Offset size of moved range.
+         *
+         * @member {Number} module:engine/model/operation/moveoperation~MoveOperation#howMany
+         */
+        this.howMany = howMany;
+        /**
+         * Position at which moved nodes will be inserted.
+         *
+         * @member {module:engine/model/position~Position} module:engine/model/operation/moveoperation~MoveOperation#targetPosition
+         */
+        this.targetPosition = targetPosition.clone();
+        this.targetPosition.stickiness = 'toNone';
+    }
+    /**
+     * @inheritDoc
+     */
+    get type() {
+        if (this.targetPosition.root.rootName == '$graveyard') {
+            return 'remove';
+        }
+        else if (this.sourcePosition.root.rootName == '$graveyard') {
+            return 'reinsert';
+        }
+        return 'move';
+    }
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns {module:engine/model/operation/moveoperation~MoveOperation} Clone of this operation.
+     */
+    clone() {
+        return new MoveOperation(this.sourcePosition, this.howMany, this.targetPosition, this.baseVersion);
+    }
+    /**
+     * Returns the start position of the moved range after it got moved. This may be different than
+     * {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition} in some cases, i.e. when a range is moved
+     * inside the same parent but {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition targetPosition}
+     * is after {@link module:engine/model/operation/moveoperation~MoveOperation#sourcePosition sourcePosition}.
+     *
+     *		 vv              vv
+     *		abcdefg ===> adefbcg
+     *		     ^          ^
+     *		     targetPos	movedRangeStart
+     *		     offset 6	offset 4
+     *
+     * @returns {module:engine/model/position~Position}
+     */
+    getMovedRangeStart() {
+        return this.targetPosition._getTransformedByDeletion(this.sourcePosition, this.howMany);
+    }
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     *
+     * @returns {module:engine/model/operation/moveoperation~MoveOperation}
+     */
+    getReversed() {
+        const newTargetPosition = this.sourcePosition._getTransformedByInsertion(this.targetPosition, this.howMany);
+        return new MoveOperation(this.getMovedRangeStart(), this.howMany, newTargetPosition, this.baseVersion + 1);
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate() {
+        const sourceElement = this.sourcePosition.parent;
+        const targetElement = this.targetPosition.parent;
+        const sourceOffset = this.sourcePosition.offset;
+        const targetOffset = this.targetPosition.offset;
+        // Validate whether move operation has correct parameters.
+        // Validation is pretty complex but move operation is one of the core ways to manipulate the document state.
+        // We expect that many errors might be connected with one of scenarios described below.
+        if (sourceOffset + this.howMany > sourceElement.maxOffset) {
+            /**
+             * The nodes which should be moved do not exist.
+             *
+             * @error move-operation-nodes-do-not-exist
+             */
+            throw new CKEditorError('move-operation-nodes-do-not-exist', this);
+        }
+        else if (sourceElement === targetElement && sourceOffset < targetOffset && targetOffset < sourceOffset + this.howMany) {
+            /**
+             * Trying to move a range of nodes into the middle of that range.
+             *
+             * @error move-operation-range-into-itself
+             */
+            throw new CKEditorError('move-operation-range-into-itself', this);
+        }
+        else if (this.sourcePosition.root == this.targetPosition.root) {
+            if (compareArrays(this.sourcePosition.getParentPath(), this.targetPosition.getParentPath()) == 'prefix') {
+                const i = this.sourcePosition.path.length - 1;
+                if (this.targetPosition.path[i] >= sourceOffset && this.targetPosition.path[i] < sourceOffset + this.howMany) {
+                    /**
+                     * Trying to move a range of nodes into one of nodes from that range.
+                     *
+                     * @error move-operation-node-into-itself
+                     */
+                    throw new CKEditorError('move-operation-node-into-itself', this);
+                }
+            }
+        }
+    }
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute() {
+        _move(Range._createFromPositionAndShift(this.sourcePosition, this.howMany), this.targetPosition);
+    }
+    /**
+     * @inheritDoc
+     */
+    toJSON() {
+        const json = super.toJSON();
+        json.sourcePosition = this.sourcePosition.toJSON();
+        json.targetPosition = this.targetPosition.toJSON();
+        return json;
+    }
+    /**
+     * @inheritDoc
+     */
+    static get className() {
+        return 'MoveOperation';
+    }
+    /**
+     * Creates `MoveOperation` 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/moveoperation~MoveOperation}
+     */
+    static fromJSON(json, document) {
+        const sourcePosition = Position.fromJSON(json.sourcePosition, document);
+        const targetPosition = Position.fromJSON(json.targetPosition, document);
+        return new this(sourcePosition, json.howMany, targetPosition, json.baseVersion);
+    }
 }

package/src/model/operation/nooperation.js

@@ -2,13 +2,10 @@
  * @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/nooperation
  */
-
 import Operation from './operation';
-
 /**
  * Operation which is doing nothing ("empty operation", "do-nothing operation", "noop"). This is an operation,
  * which when executed does not change the tree model. It still has some parameters defined for transformation purposes.
@@ -20,39 +17,32 @@ import Operation from './operation';
  * @extends module:engine/model/operation/operation~Operation
  */
 export default class NoOperation extends Operation {
-	get type() {
-		return 'noop';
-	}
-
-	/**
-	 * Creates and returns an operation that has the same parameters as this operation.
-	 *
-	 * @returns {module:engine/model/operation/nooperation~NoOperation} Clone of this operation.
-	 */
-	clone() {
-		return new NoOperation( this.baseVersion );
-	}
-
-	/**
-	 * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-	 *
-	 * @returns {module:engine/model/operation/nooperation~NoOperation}
-	 */
-	getReversed() {
-		return new NoOperation( this.baseVersion + 1 );
-	}
-
-	_execute() {
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get className() {
-		return 'NoOperation';
-	}
-
-	// @if CK_DEBUG_ENGINE // toString() {
-	// @if CK_DEBUG_ENGINE // 	return `NoOperation( ${ this.baseVersion } )`;
-	// @if CK_DEBUG_ENGINE // }
+    get type() {
+        return 'noop';
+    }
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns {module:engine/model/operation/nooperation~NoOperation} Clone of this operation.
+     */
+    clone() {
+        return new NoOperation(this.baseVersion);
+    }
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     *
+     * @returns {module:engine/model/operation/nooperation~NoOperation}
+     */
+    getReversed() {
+        return new NoOperation(this.baseVersion + 1);
+    }
+    /** @internal */
+    _execute() {
+    }
+    /**
+     * @inheritDoc
+     */
+    static get className() {
+        return 'NoOperation';
+    }
 }