@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/model/utils/insertobject.js

@@ -2,16 +2,14 @@
  * @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/utils/insertobject
  */
-
+import { findOptimalInsertionRange } from './findoptimalinsertionrange';
+import DocumentSelection from '../documentselection';
+import Selection from '../selection';
 import first from '@ckeditor/ckeditor5-utils/src/first';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
-
-import { findOptimalInsertionRange } from './findoptimalinsertionrange';
-
 /**
  * Inserts an {@glink framework/guides/deep-dive/schema#object-elements object element} at a specific position in the editor content.
  *
@@ -46,85 +44,69 @@ import { findOptimalInsertionRange } from './findoptimalinsertionrange';
  * would return the model to the state before the insertion. If no changes were preformed by `insertObject()`, returns a range collapsed
  * at the insertion position.
  */
-export default function insertObject( model, object, selectable, placeOrOffset, options = {} ) {
-	if ( !model.schema.isObject( object ) ) {
-		/**
-		 * Tried to insert an element with {@link module:engine/model/utils/insertobject insertObject()} function
-		 * that is not defined as an object in schema.
-		 * See {@link module:engine/model/schema~SchemaItemDefinition#isObject `SchemaItemDefinition`}.
-		 * If you want to insert content that is not an object you might want to use
-		 * {@link module:engine/model/utils/insertcontent insertContent()} function.
-		 * @error insertobject-element-not-an-object
-		 */
-		throw new CKEditorError( 'insertobject-element-not-an-object', model, { object } );
-	}
-
-	// Normalize selectable to a selection instance.
-	let originalSelection;
-
-	if ( !selectable ) {
-		originalSelection = model.document.selection;
-	} else if ( selectable.is( 'selection' ) ) {
-		originalSelection = selectable;
-	} else {
-		originalSelection = model.createSelection( selectable, placeOrOffset );
-	}
-
-	// Adjust the insertion selection.
-	let insertionSelection = originalSelection;
-
-	if ( options.findOptimalPosition && model.schema.isBlock( object ) ) {
-		insertionSelection = model.createSelection( findOptimalInsertionRange( originalSelection, model, options.findOptimalPosition ) );
-	}
-
-	// Collect attributes to be copied on the inserted object.
-	const firstSelectedBlock = first( originalSelection.getSelectedBlocks() );
-	const attributesToCopy = {};
-
-	if ( firstSelectedBlock ) {
-		Object.assign( attributesToCopy, model.schema.getAttributesWithProperty( firstSelectedBlock, 'copyOnReplace', true ) );
-	}
-
-	return model.change( writer => {
-		// Remove the selected content to find out what the parent of the inserted object would be.
-		// It would be removed inside model.insertContent() anyway.
-		if ( !insertionSelection.isCollapsed ) {
-			model.deleteContent( insertionSelection, { doNotAutoparagraph: true } );
-		}
-
-		let elementToInsert = object;
-		const insertionPositionParent = insertionSelection.anchor.parent;
-
-		// Autoparagraphing of an inline objects.
-		if (
-			!model.schema.checkChild( insertionPositionParent, object ) &&
-			model.schema.checkChild( insertionPositionParent, 'paragraph' ) &&
-			model.schema.checkChild( 'paragraph', object )
-		) {
-			elementToInsert = writer.createElement( 'paragraph' );
-
-			writer.insert( object, elementToInsert );
-		}
-
-		// Apply attributes that are allowed on the inserted object (or paragraph if autoparagraphed).
-		model.schema.setAllowedAttributes( elementToInsert, attributesToCopy, writer );
-
-		// Insert the prepared content at the optionally adjusted selection.
-		const affectedRange = model.insertContent( elementToInsert, insertionSelection );
-
-		// Nothing got inserted.
-		if ( affectedRange.isCollapsed ) {
-			return affectedRange;
-		}
-
-		if ( options.setSelection ) {
-			updateSelection( writer, object, options.setSelection, attributesToCopy );
-		}
-
-		return affectedRange;
-	} );
+export default function insertObject(model, object, selectable, placeOrOffset, options = {}) {
+    if (!model.schema.isObject(object)) {
+        /**
+         * Tried to insert an element with {@link module:engine/model/utils/insertobject insertObject()} function
+         * that is not defined as an object in schema.
+         * See {@link module:engine/model/schema~SchemaItemDefinition#isObject `SchemaItemDefinition`}.
+         * If you want to insert content that is not an object you might want to use
+         * {@link module:engine/model/utils/insertcontent insertContent()} function.
+         * @error insertobject-element-not-an-object
+         */
+        throw new CKEditorError('insertobject-element-not-an-object', model, { object });
+    }
+    // Normalize selectable to a selection instance.
+    let originalSelection;
+    if (!selectable) {
+        originalSelection = model.document.selection;
+    }
+    else if (selectable instanceof Selection || selectable instanceof DocumentSelection) {
+        originalSelection = selectable;
+    }
+    else {
+        originalSelection = model.createSelection(selectable, placeOrOffset);
+    }
+    // Adjust the insertion selection.
+    let insertionSelection = originalSelection;
+    if (options.findOptimalPosition && model.schema.isBlock(object)) {
+        insertionSelection = model.createSelection(findOptimalInsertionRange(originalSelection, model, options.findOptimalPosition));
+    }
+    // Collect attributes to be copied on the inserted object.
+    const firstSelectedBlock = first(originalSelection.getSelectedBlocks());
+    const attributesToCopy = {};
+    if (firstSelectedBlock) {
+        Object.assign(attributesToCopy, model.schema.getAttributesWithProperty(firstSelectedBlock, 'copyOnReplace', true));
+    }
+    return model.change(writer => {
+        // Remove the selected content to find out what the parent of the inserted object would be.
+        // It would be removed inside model.insertContent() anyway.
+        if (!insertionSelection.isCollapsed) {
+            model.deleteContent(insertionSelection, { doNotAutoparagraph: true });
+        }
+        let elementToInsert = object;
+        const insertionPositionParent = insertionSelection.anchor.parent;
+        // Autoparagraphing of an inline objects.
+        if (!model.schema.checkChild(insertionPositionParent, object) &&
+            model.schema.checkChild(insertionPositionParent, 'paragraph') &&
+            model.schema.checkChild('paragraph', object)) {
+            elementToInsert = writer.createElement('paragraph');
+            writer.insert(object, elementToInsert);
+        }
+        // Apply attributes that are allowed on the inserted object (or paragraph if autoparagraphed).
+        model.schema.setAllowedAttributes(elementToInsert, attributesToCopy, writer);
+        // Insert the prepared content at the optionally adjusted selection.
+        const affectedRange = model.insertContent(elementToInsert, insertionSelection);
+        // Nothing got inserted.
+        if (affectedRange.isCollapsed) {
+            return affectedRange;
+        }
+        if (options.setSelection) {
+            updateSelection(writer, object, options.setSelection, attributesToCopy);
+        }
+        return affectedRange;
+    });
 }
-
 // Updates document selection based on given `place` parameter in relation to `contextElement` element.
 //
 // @private
@@ -134,40 +116,35 @@ export default function insertObject( model, object, selectable, placeOrOffset,
 // Value `on` will set selection on the passed `contextElement`. Value `after` will set selection after `contextElement`.
 // @param {Object} attributes Attributes keys and values to set on a paragraph that this function can create when
 // `place` parameter is equal to `after` but there is no element with `$text` node to set selection in.
-function updateSelection( writer, contextElement, place, paragraphAttributes ) {
-	const model = writer.model;
-
-	if ( place == 'after' ) {
-		let nextElement = contextElement.nextSibling;
-
-		// Check whether an element next to the inserted element is defined and can contain a text.
-		const canSetSelection = nextElement && model.schema.checkChild( nextElement, '$text' );
-
-		// If the element is missing, but a paragraph could be inserted next to the element, let's add it.
-		if ( !canSetSelection && model.schema.checkChild( contextElement.parent, 'paragraph' ) ) {
-			nextElement = writer.createElement( 'paragraph' );
-
-			model.schema.setAllowedAttributes( nextElement, paragraphAttributes, writer );
-			model.insertContent( nextElement, writer.createPositionAfter( contextElement ) );
-		}
-
-		// Put the selection inside the element, at the beginning.
-		if ( nextElement ) {
-			writer.setSelection( nextElement, 0 );
-		}
-	}
-	else if ( place == 'on' ) {
-		writer.setSelection( contextElement, 'on' );
-	}
-	else {
-		/**
-		 * The unsupported `options.setSelection` parameter was passed
-		 * to the {@link module:engine/model/utils/insertobject insertObject()} function.
-		 * Check the {@link module:engine/model/utils/insertobject insertObject()} API documentation for allowed
-		 * `options.setSelection` parameter values.
-		 *
-		 * @error insertobject-invalid-place-parameter-value
-		 */
-		throw new CKEditorError( 'insertobject-invalid-place-parameter-value', model );
-	}
+function updateSelection(writer, contextElement, place, paragraphAttributes) {
+    const model = writer.model;
+    if (place == 'after') {
+        let nextElement = contextElement.nextSibling;
+        // Check whether an element next to the inserted element is defined and can contain a text.
+        const canSetSelection = nextElement && model.schema.checkChild(nextElement, '$text');
+        // If the element is missing, but a paragraph could be inserted next to the element, let's add it.
+        if (!canSetSelection && model.schema.checkChild(contextElement.parent, 'paragraph')) {
+            nextElement = writer.createElement('paragraph');
+            model.schema.setAllowedAttributes(nextElement, paragraphAttributes, writer);
+            model.insertContent(nextElement, writer.createPositionAfter(contextElement));
+        }
+        // Put the selection inside the element, at the beginning.
+        if (nextElement) {
+            writer.setSelection(nextElement, 0);
+        }
+    }
+    else if (place == 'on') {
+        writer.setSelection(contextElement, 'on');
+    }
+    else {
+        /**
+         * The unsupported `options.setSelection` parameter was passed
+         * to the {@link module:engine/model/utils/insertobject insertObject()} function.
+         * Check the {@link module:engine/model/utils/insertobject insertObject()} API documentation for allowed
+         * `options.setSelection` parameter values.
+         *
+         * @error insertobject-invalid-place-parameter-value
+         */
+        throw new CKEditorError('insertobject-invalid-place-parameter-value', model);
+    }
 }

package/src/model/utils/modifyselection.js

@@ -2,19 +2,15 @@
  * @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/utils/modifyselection
  */
-
+import DocumentSelection from '../documentselection';
 import Position from '../position';
-import TreeWalker from '../treewalker';
 import Range from '../range';
+import TreeWalker from '../treewalker';
 import { isInsideSurrogatePair, isInsideCombinedSymbol, isInsideEmojiSequence } from '@ckeditor/ckeditor5-utils/src/unicode';
-import DocumentSelection from '../documentselection';
-
 const wordBoundaryCharacters = ' ,.?!:;"-()';
-
 /**
  * Modifies the selection. Currently, the supported modifications are:
  *
@@ -51,186 +47,152 @@ const wordBoundaryCharacters = ' ,.?!:;"-()';
  * @param {'character'|'codePoint'|'word'} [options.unit='character'] The unit by which selection should be modified.
  * @param {Boolean} [options.treatEmojiAsSingleUnit=false] Whether multi-characer emoji sequences should be handled as single unit.
  */
-export default function modifySelection( model, selection, options = {} ) {
-	const schema = model.schema;
-	const isForward = options.direction != 'backward';
-	const unit = options.unit ? options.unit : 'character';
-	const treatEmojiAsSingleUnit = !!options.treatEmojiAsSingleUnit;
-
-	const focus = selection.focus;
-
-	const walker = new TreeWalker( {
-		boundaries: getSearchRange( focus, isForward ),
-		singleCharacters: true,
-		direction: isForward ? 'forward' : 'backward'
-	} );
-
-	const data = { walker, schema, isForward, unit, treatEmojiAsSingleUnit };
-
-	let next;
-
-	while ( ( next = walker.next() ) ) {
-		if ( next.done ) {
-			return;
-		}
-
-		const position = tryExtendingTo( data, next.value );
-
-		if ( position ) {
-			if ( selection instanceof DocumentSelection ) {
-				model.change( writer => {
-					writer.setSelectionFocus( position );
-				} );
-			} else {
-				selection.setFocus( position );
-			}
-
-			return;
-		}
-	}
+export default function modifySelection(model, selection, options = {}) {
+    const schema = model.schema;
+    const isForward = options.direction != 'backward';
+    const unit = options.unit ? options.unit : 'character';
+    const treatEmojiAsSingleUnit = !!options.treatEmojiAsSingleUnit;
+    const focus = selection.focus;
+    const walker = new TreeWalker({
+        boundaries: getSearchRange(focus, isForward),
+        singleCharacters: true,
+        direction: isForward ? 'forward' : 'backward'
+    });
+    const data = { walker, schema, isForward, unit, treatEmojiAsSingleUnit };
+    let next;
+    while ((next = walker.next())) {
+        if (next.done) {
+            return;
+        }
+        const position = tryExtendingTo(data, next.value);
+        if (position) {
+            if (selection instanceof DocumentSelection) {
+                model.change(writer => {
+                    writer.setSelectionFocus(position);
+                });
+            }
+            else {
+                selection.setFocus(position);
+            }
+            return;
+        }
+    }
 }
-
 // Checks whether the selection can be extended to the the walker's next value (next position).
 // @param {{ walker, unit, isForward, schema, treatEmojiAsSingleUnit }} data
 // @param {module:engine/view/treewalker~TreeWalkerValue} value
-function tryExtendingTo( data, value ) {
-	const { isForward, walker, unit, schema, treatEmojiAsSingleUnit } = data;
-	const { type, item, nextPosition } = value;
-
-	// If found text, we can certainly put the focus in it. Let's just find a correct position
-	// based on the unit.
-	if ( type == 'text' ) {
-		if ( data.unit === 'word' ) {
-			return getCorrectWordBreakPosition( walker, isForward );
-		}
-
-		return getCorrectPosition( walker, unit, treatEmojiAsSingleUnit );
-	}
-
-	// Entering an element.
-	if ( type == ( isForward ? 'elementStart' : 'elementEnd' ) ) {
-		// If it's a selectable, we can select it now.
-		if ( schema.isSelectable( item ) ) {
-			return Position._createAt( item, isForward ? 'after' : 'before' );
-		}
-
-		// If text allowed on this position, extend to this place.
-		if ( schema.checkChild( nextPosition, '$text' ) ) {
-			return nextPosition;
-		}
-	}
-	// Leaving an element.
-	else {
-		// If leaving a limit element, stop.
-		if ( schema.isLimit( item ) ) {
-			// NOTE: Fast-forward the walker until the end.
-			walker.skip( () => true );
-
-			return;
-		}
-
-		// If text allowed on this position, extend to this place.
-		if ( schema.checkChild( nextPosition, '$text' ) ) {
-			return nextPosition;
-		}
-	}
+function tryExtendingTo(data, value) {
+    const { isForward, walker, unit, schema, treatEmojiAsSingleUnit } = data;
+    const { type, item, nextPosition } = value;
+    // If found text, we can certainly put the focus in it. Let's just find a correct position
+    // based on the unit.
+    if (type == 'text') {
+        if (data.unit === 'word') {
+            return getCorrectWordBreakPosition(walker, isForward);
+        }
+        return getCorrectPosition(walker, unit, treatEmojiAsSingleUnit);
+    }
+    // Entering an element.
+    if (type == (isForward ? 'elementStart' : 'elementEnd')) {
+        // If it's a selectable, we can select it now.
+        if (schema.isSelectable(item)) {
+            return Position._createAt(item, isForward ? 'after' : 'before');
+        }
+        // If text allowed on this position, extend to this place.
+        if (schema.checkChild(nextPosition, '$text')) {
+            return nextPosition;
+        }
+    }
+    // Leaving an element.
+    else {
+        // If leaving a limit element, stop.
+        if (schema.isLimit(item)) {
+            // NOTE: Fast-forward the walker until the end.
+            walker.skip(() => true);
+            return;
+        }
+        // If text allowed on this position, extend to this place.
+        if (schema.checkChild(nextPosition, '$text')) {
+            return nextPosition;
+        }
+    }
 }
-
 // Finds a correct position by walking in a text node and checking whether selection can be extended to given position
 // or should be extended further.
 //
 // @param {module:engine/model/treewalker~TreeWalker} walker
 // @param {String} unit The unit by which selection should be modified.
 // @param {Boolean} treatEmojiAsSingleUnit
-function getCorrectPosition( walker, unit, treatEmojiAsSingleUnit ) {
-	const textNode = walker.position.textNode;
-
-	if ( textNode ) {
-		const data = textNode.data;
-		let offset = walker.position.offset - textNode.startOffset;
-
-		while (
-			isInsideSurrogatePair( data, offset ) ||
-			( unit == 'character' && isInsideCombinedSymbol( data, offset ) ) ||
-			( treatEmojiAsSingleUnit && isInsideEmojiSequence( data, offset ) )
-		) {
-			walker.next();
-
-			offset = walker.position.offset - textNode.startOffset;
-		}
-	}
-
-	return walker.position;
+function getCorrectPosition(walker, unit, treatEmojiAsSingleUnit) {
+    const textNode = walker.position.textNode;
+    if (textNode) {
+        const data = textNode.data;
+        let offset = walker.position.offset - textNode.startOffset;
+        while (isInsideSurrogatePair(data, offset) ||
+            (unit == 'character' && isInsideCombinedSymbol(data, offset)) ||
+            (treatEmojiAsSingleUnit && isInsideEmojiSequence(data, offset))) {
+            walker.next();
+            offset = walker.position.offset - textNode.startOffset;
+        }
+    }
+    return walker.position;
 }
-
 // Finds a correct position of a word break by walking in a text node and checking whether selection can be extended to given position
 // or should be extended further.
 //
 // @param {module:engine/model/treewalker~TreeWalker} walker
 // @param {Boolean} isForward Is the direction in which the selection should be modified is forward.
-function getCorrectWordBreakPosition( walker, isForward ) {
-	let textNode = walker.position.textNode;
-
-	if ( textNode ) {
-		let offset = walker.position.offset - textNode.startOffset;
-
-		while ( !isAtWordBoundary( textNode.data, offset, isForward ) && !isAtNodeBoundary( textNode, offset, isForward ) ) {
-			walker.next();
-
-			// Check of adjacent text nodes with different attributes (like BOLD).
-			// Example          : 'foofoo []bar<$text bold="true">bar</$text> bazbaz'
-			// should expand to : 'foofoo [bar<$text bold="true">bar</$text>] bazbaz'.
-			const nextNode = isForward ? walker.position.nodeAfter : walker.position.nodeBefore;
-
-			// Scan only text nodes. Ignore inline elements (like `<softBreak>`).
-			if ( nextNode && nextNode.is( '$text' ) ) {
-				// Check boundary char of an adjacent text node.
-				const boundaryChar = nextNode.data.charAt( isForward ? 0 : nextNode.data.length - 1 );
-
-				// Go to the next node if the character at the boundary of that node belongs to the same word.
-				if ( !wordBoundaryCharacters.includes( boundaryChar ) ) {
-					// If adjacent text node belongs to the same word go to it & reset values.
-					walker.next();
-
-					textNode = walker.position.textNode;
-				}
-			}
-
-			offset = walker.position.offset - textNode.startOffset;
-		}
-	}
-
-	return walker.position;
+function getCorrectWordBreakPosition(walker, isForward) {
+    let textNode = walker.position.textNode;
+    if (textNode) {
+        let offset = walker.position.offset - textNode.startOffset;
+        while (!isAtWordBoundary(textNode.data, offset, isForward) && !isAtNodeBoundary(textNode, offset, isForward)) {
+            walker.next();
+            // Check of adjacent text nodes with different attributes (like BOLD).
+            // Example          : 'foofoo []bar<$text bold="true">bar</$text> bazbaz'
+            // should expand to : 'foofoo [bar<$text bold="true">bar</$text>] bazbaz'.
+            const nextNode = isForward ? walker.position.nodeAfter : walker.position.nodeBefore;
+            // Scan only text nodes. Ignore inline elements (like `<softBreak>`).
+            if (nextNode && nextNode.is('$text')) {
+                // Check boundary char of an adjacent text node.
+                const boundaryChar = nextNode.data.charAt(isForward ? 0 : nextNode.data.length - 1);
+                // Go to the next node if the character at the boundary of that node belongs to the same word.
+                if (!wordBoundaryCharacters.includes(boundaryChar)) {
+                    // If adjacent text node belongs to the same word go to it & reset values.
+                    walker.next();
+                    textNode = walker.position.textNode;
+                }
+            }
+            offset = walker.position.offset - textNode.startOffset;
+        }
+    }
+    return walker.position;
 }
-
-function getSearchRange( start, isForward ) {
-	const root = start.root;
-	const searchEnd = Position._createAt( root, isForward ? 'end' : 0 );
-
-	if ( isForward ) {
-		return new Range( start, searchEnd );
-	} else {
-		return new Range( searchEnd, start );
-	}
+function getSearchRange(start, isForward) {
+    const root = start.root;
+    const searchEnd = Position._createAt(root, isForward ? 'end' : 0);
+    if (isForward) {
+        return new Range(start, searchEnd);
+    }
+    else {
+        return new Range(searchEnd, start);
+    }
 }
-
 // Checks if selection is on word boundary.
 //
 // @param {String} data The text node value to investigate.
 // @param {Number} offset Position offset.
 // @param {Boolean} isForward Is the direction in which the selection should be modified is forward.
-function isAtWordBoundary( data, offset, isForward ) {
-	// The offset to check depends on direction.
-	const offsetToCheck = offset + ( isForward ? 0 : -1 );
-
-	return wordBoundaryCharacters.includes( data.charAt( offsetToCheck ) );
+function isAtWordBoundary(data, offset, isForward) {
+    // The offset to check depends on direction.
+    const offsetToCheck = offset + (isForward ? 0 : -1);
+    return wordBoundaryCharacters.includes(data.charAt(offsetToCheck));
 }
-
 // Checks if selection is on node boundary.
 //
 // @param {module:engine/model/text~Text} textNode The text node to investigate.
 // @param {Number} offset Position offset.
 // @param {Boolean} isForward Is the direction in which the selection should be modified is forward.
-function isAtNodeBoundary( textNode, offset, isForward ) {
-	return offset === ( isForward ? textNode.endOffset : 0 );
+function isAtNodeBoundary(textNode, offset, isForward) {
+    return offset === (isForward ? textNode.endOffset : 0);
 }