@ckeditor/ckeditor5-engine 35.0.1 → 35.1.0

package/src/view/attributeelement.js

@@ -2,17 +2,13 @@
  * @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/view/attributeelement
  */
-
 import Element from './element';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
-
 // Default attribute priority.
 const DEFAULT_PRIORITY = 10;
-
 /**
  * Attribute elements are used to represent formatting elements in the view (think – `<b>`, `<span style="font-size: 2em">`, etc.).
  * Most often they are created when downcasting model text attributes.
@@ -27,238 +23,206 @@ const DEFAULT_PRIORITY = 10;
  * @extends module:engine/view/element~Element
  */
 export default class AttributeElement extends Element {
-	/**
-	 * Creates an attribute element.
-	 *
-	 * @see module:engine/view/downcastwriter~DowncastWriter#createAttributeElement
-	 * @see module:engine/view/element~Element
-	 * @protected
-	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
-	 * @param {String} name Node name.
-	 * @param {Object|Iterable} [attrs] Collection of attributes.
-	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
-	 * A list of nodes to be inserted into created element.
-	 */
-	constructor( document, name, attrs, children ) {
-		super( document, name, attrs, children );
-
-		/**
-		 * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
-		 *
-		 * @method #getFillerOffset
-		 * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
-		 */
-		this.getFillerOffset = getFillerOffset;
-
-		/**
-		 * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
-		 *
-		 * @protected
-		 * @member {Number}
-		 */
-		this._priority = DEFAULT_PRIORITY;
-
-		/**
-		 * Element identifier. If set, it is used by {@link module:engine/view/element~Element#isSimilar},
-		 * and then two elements are considered similar if, and only if they have the same `_id`.
-		 *
-		 * @protected
-		 * @member {String|Number}
-		 */
-		this._id = null;
-
-		/**
-		 * Keeps all the attribute elements that have the same {@link module:engine/view/attributeelement~AttributeElement#id ids}
-		 * and still exist in the view tree.
-		 *
-		 * This property is managed by {@link module:engine/view/downcastwriter~DowncastWriter}.
-		 *
-		 * @protected
-		 * @member {Set.<module:engine/view/attributeelement~AttributeElement>|null}
-		 */
-		this._clonesGroup = null;
-	}
-
-	/**
-	 * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
-	 *
-	 * @readonly
-	 * @type {Number}
-	 */
-	get priority() {
-		return this._priority;
-	}
-
-	/**
-	 * Element identifier. If set, it is used by {@link module:engine/view/element~Element#isSimilar},
-	 * and then two elements are considered similar if, and only if they have the same `id`.
-	 *
-	 * @readonly
-	 * @type {String|Number}
-	 */
-	get id() {
-		return this._id;
-	}
-
-	/**
-	 * Returns all {@link module:engine/view/attributeelement~AttributeElement attribute elements} that has the
-	 * same {@link module:engine/view/attributeelement~AttributeElement#id id} and are in the view tree (were not removed).
-	 *
-	 * Note: If this element has been removed from the tree, returned set will not include it.
-	 *
-	 * Throws {@link module:utils/ckeditorerror~CKEditorError attribute-element-get-elements-with-same-id-no-id}
-	 * if this element has no `id`.
-	 *
-	 * @returns {Set.<module:engine/view/attributeelement~AttributeElement>} Set containing all the attribute elements
-	 * with the same `id` that were added and not removed from the view tree.
-	 */
-	getElementsWithSameId() {
-		if ( this.id === null ) {
-			/**
-			 * Cannot get elements with the same id for an attribute element without id.
-			 *
-			 * @error attribute-element-get-elements-with-same-id-no-id
-			 */
-			throw new CKEditorError(
-				'attribute-element-get-elements-with-same-id-no-id',
-				this
-			);
-		}
-
-		return new Set( this._clonesGroup );
-	}
-
-	/**
-	 * Checks whether this object is of the given.
-	 *
-	 *		attributeElement.is( 'attributeElement' ); // -> true
-	 *		attributeElement.is( 'element' ); // -> true
-	 *		attributeElement.is( 'node' ); // -> true
-	 *		attributeElement.is( 'view:attributeElement' ); // -> true
-	 *		attributeElement.is( 'view:element' ); // -> true
-	 *		attributeElement.is( 'view:node' ); // -> true
-	 *
-	 *		attributeElement.is( 'model:element' ); // -> false
-	 *		attributeElement.is( 'documentFragment' ); // -> false
-	 *
-	 * Assuming that the object being checked is an attribute element, you can also check its
-	 * {@link module:engine/view/attributeelement~AttributeElement#name name}:
-	 *
-	 *		attributeElement.is( 'element', 'b' ); // -> true if this is a bold element
-	 *		attributeElement.is( 'attributeElement', 'b' ); // -> same as above
-	 *		text.is( 'element', 'b' ); -> false
-	 *
-	 * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
-	 *
-	 * @param {String} type Type to check.
-	 * @param {String} [name] Element name.
-	 * @returns {Boolean}
-	 */
-	is( type, name = null ) {
-		if ( !name ) {
-			return type === 'attributeElement' || type === 'view:attributeElement' ||
-				// From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-				type === 'element' || type === 'view:element' ||
-				type === 'node' || type === 'view:node';
-		} else {
-			return name === this.name && (
-				type === 'attributeElement' || type === 'view:attributeElement' ||
-				// From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-				type === 'element' || type === 'view:element'
-			);
-		}
-	}
-
-	/**
-	 * Checks if this element is similar to other element.
-	 *
-	 * If none of elements has set {@link module:engine/view/attributeelement~AttributeElement#id}, then both elements
-	 * should have the same name, attributes and priority to be considered as similar. Two similar elements can contain
-	 * different set of children nodes.
-	 *
-	 * If at least one element has {@link module:engine/view/attributeelement~AttributeElement#id} set, then both
-	 * elements have to have the same {@link module:engine/view/attributeelement~AttributeElement#id} value to be
-	 * considered similar.
-	 *
-	 * Similarity is important for {@link module:engine/view/downcastwriter~DowncastWriter}. For example:
-	 *
-	 * * two following similar elements can be merged together into one, longer element,
-	 * * {@link module:engine/view/downcastwriter~DowncastWriter#unwrap} checks similarity of passed element and processed element to
-	 * decide whether processed element should be unwrapped,
-	 * * etc.
-	 *
-	 * @param {module:engine/view/element~Element} otherElement
-	 * @returns {Boolean}
-	 */
-	isSimilar( otherElement ) {
-		// If any element has an `id` set, just compare the ids.
-		if ( this.id !== null || otherElement.id !== null ) {
-			return this.id === otherElement.id;
-		}
-
-		return super.isSimilar( otherElement ) && this.priority == otherElement.priority;
-	}
-
-	/**
-	 * Clones provided element with priority.
-	 *
-	 * @protected
-	 * @param {Boolean} deep If set to `true` clones element and all its children recursively. When set to `false`,
-	 * element will be cloned without any children.
-	 * @returns {module:engine/view/attributeelement~AttributeElement} Clone of this element.
-	 */
-	_clone( deep ) {
-		const cloned = super._clone( deep );
-
-		// Clone priority too.
-		cloned._priority = this._priority;
-
-		// And id too.
-		cloned._id = this._id;
-
-		return cloned;
-	}
+    /**
+     * Creates an attribute element.
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createAttributeElement
+     * @see module:engine/view/element~Element
+     * @protected
+     * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
+     * @param {String} name Node name.
+     * @param {Object|Iterable} [attrs] Collection of attributes.
+     * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
+     * A list of nodes to be inserted into created element.
+     */
+    constructor(...args) {
+        super(...args);
+        /**
+         * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
+         *
+         * @method #getFillerOffset
+         * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
+         */
+        this.getFillerOffset = getFillerOffset;
+        /**
+         * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
+         *
+         * @protected
+         * @member {Number}
+         */
+        this._priority = DEFAULT_PRIORITY;
+        /**
+         * Element identifier. If set, it is used by {@link module:engine/view/element~Element#isSimilar},
+         * and then two elements are considered similar if, and only if they have the same `_id`.
+         *
+         * @protected
+         * @member {String|Number}
+         */
+        this._id = null;
+        /**
+         * Keeps all the attribute elements that have the same {@link module:engine/view/attributeelement~AttributeElement#id ids}
+         * and still exist in the view tree.
+         *
+         * This property is managed by {@link module:engine/view/downcastwriter~DowncastWriter}.
+         *
+         * @protected
+         * @member {Set.<module:engine/view/attributeelement~AttributeElement>|null}
+         */
+        this._clonesGroup = null;
+    }
+    /**
+     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~DowncastWriter}.
+     *
+     * @readonly
+     * @type {Number}
+     */
+    get priority() {
+        return this._priority;
+    }
+    /**
+     * Element identifier. If set, it is used by {@link module:engine/view/element~Element#isSimilar},
+     * and then two elements are considered similar if, and only if they have the same `id`.
+     *
+     * @readonly
+     * @type {String|Number}
+     */
+    get id() {
+        return this._id;
+    }
+    /**
+     * Returns all {@link module:engine/view/attributeelement~AttributeElement attribute elements} that has the
+     * same {@link module:engine/view/attributeelement~AttributeElement#id id} and are in the view tree (were not removed).
+     *
+     * Note: If this element has been removed from the tree, returned set will not include it.
+     *
+     * Throws {@link module:utils/ckeditorerror~CKEditorError attribute-element-get-elements-with-same-id-no-id}
+     * if this element has no `id`.
+     *
+     * @returns {Set.<module:engine/view/attributeelement~AttributeElement>} Set containing all the attribute elements
+     * with the same `id` that were added and not removed from the view tree.
+     */
+    getElementsWithSameId() {
+        if (this.id === null) {
+            /**
+             * Cannot get elements with the same id for an attribute element without id.
+             *
+             * @error attribute-element-get-elements-with-same-id-no-id
+             */
+            throw new CKEditorError('attribute-element-get-elements-with-same-id-no-id', this);
+        }
+        return new Set(this._clonesGroup);
+    }
+    /**
+     * Checks if this element is similar to other element.
+     *
+     * If none of elements has set {@link module:engine/view/attributeelement~AttributeElement#id}, then both elements
+     * should have the same name, attributes and priority to be considered as similar. Two similar elements can contain
+     * different set of children nodes.
+     *
+     * If at least one element has {@link module:engine/view/attributeelement~AttributeElement#id} set, then both
+     * elements have to have the same {@link module:engine/view/attributeelement~AttributeElement#id} value to be
+     * considered similar.
+     *
+     * Similarity is important for {@link module:engine/view/downcastwriter~DowncastWriter}. For example:
+     *
+     * * two following similar elements can be merged together into one, longer element,
+     * * {@link module:engine/view/downcastwriter~DowncastWriter#unwrap} checks similarity of passed element and processed element to
+     * decide whether processed element should be unwrapped,
+     * * etc.
+     *
+     * @param {module:engine/view/element~Element} otherElement
+     * @returns {Boolean}
+     */
+    isSimilar(otherElement) {
+        // If any element has an `id` set, just compare the ids.
+        if (this.id !== null || otherElement.id !== null) {
+            return this.id === otherElement.id;
+        }
+        return super.isSimilar(otherElement) && this.priority == otherElement.priority;
+    }
+    /**
+     * Clones provided element with priority.
+     *
+     * @protected
+     * @param {Boolean} deep If set to `true` clones element and all its children recursively. When set to `false`,
+     * element will be cloned without any children.
+     * @returns {module:engine/view/attributeelement~AttributeElement} Clone of this element.
+     */
+    _clone(deep = false) {
+        const cloned = super._clone(deep);
+        // Clone priority too.
+        cloned._priority = this._priority;
+        // And id too.
+        cloned._id = this._id;
+        return cloned;
+    }
 }
-
+AttributeElement.DEFAULT_PRIORITY = DEFAULT_PRIORITY;
 /**
- * Default attribute priority.
+ * Checks whether this object is of the given.
+ *
+ *		attributeElement.is( 'attributeElement' ); // -> true
+ *		attributeElement.is( 'element' ); // -> true
+ *		attributeElement.is( 'node' ); // -> true
+ *		attributeElement.is( 'view:attributeElement' ); // -> true
+ *		attributeElement.is( 'view:element' ); // -> true
+ *		attributeElement.is( 'view:node' ); // -> true
+ *
+ *		attributeElement.is( 'model:element' ); // -> false
+ *		attributeElement.is( 'documentFragment' ); // -> false
+ *
+ * Assuming that the object being checked is an attribute element, you can also check its
+ * {@link module:engine/view/attributeelement~AttributeElement#name name}:
  *
- * @member {Number} module:engine/view/attributeelement~AttributeElement.DEFAULT_PRIORITY
+ *		attributeElement.is( 'element', 'b' ); // -> true if this is a bold element
+ *		attributeElement.is( 'attributeElement', 'b' ); // -> same as above
+ *		text.is( 'element', 'b' ); -> false
+ *
+ * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
+ *
+ * @param {String} type Type to check.
+ * @param {String} [name] Element name.
+ * @returns {Boolean}
  */
-AttributeElement.DEFAULT_PRIORITY = DEFAULT_PRIORITY;
-
+AttributeElement.prototype.is = function (type, name) {
+    if (!name) {
+        return type === 'attributeElement' || type === 'view:attributeElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'element' || type === 'view:element' ||
+            type === 'node' || type === 'view:node';
+    }
+    else {
+        return name === this.name && (type === 'attributeElement' || type === 'view:attributeElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'element' || type === 'view:element');
+    }
+};
 // Returns block {@link module:engine/view/filler~Filler filler} offset or `null` if block filler is not needed.
 //
 // @returns {Number|null} Block filler offset or `null` if block filler is not needed.
 function getFillerOffset() {
-	// <b>foo</b> does not need filler.
-	if ( nonUiChildrenCount( this ) ) {
-		return null;
-	}
-
-	let element = this.parent;
-
-	// <p><b></b></p> needs filler -> <p><b><br></b></p>
-	while ( element && element.is( 'attributeElement' ) ) {
-		if ( nonUiChildrenCount( element ) > 1 ) {
-			return null;
-		}
-
-		element = element.parent;
-	}
-
-	if ( !element || nonUiChildrenCount( element ) > 1 ) {
-		return null;
-	}
-
-	// Render block filler at the end of element (after all ui elements).
-	return this.childCount;
+    // <b>foo</b> does not need filler.
+    if (nonUiChildrenCount(this)) {
+        return null;
+    }
+    let element = this.parent;
+    // <p><b></b></p> needs filler -> <p><b><br></b></p>
+    while (element && element.is('attributeElement')) {
+        if (nonUiChildrenCount(element) > 1) {
+            return null;
+        }
+        element = element.parent;
+    }
+    if (!element || nonUiChildrenCount(element) > 1) {
+        return null;
+    }
+    // Render block filler at the end of element (after all ui elements).
+    return this.childCount;
 }
-
 // Returns total count of children that are not {@link module:engine/view/uielement~UIElement UIElements}.
 //
 // @param {module:engine/view/element~Element} element
 // @returns {Number}
-function nonUiChildrenCount( element ) {
-	return Array.from( element.getChildren() ).filter( element => !element.is( 'uiElement' ) ).length;
+function nonUiChildrenCount(element) {
+    return Array.from(element.getChildren()).filter(element => !element.is('uiElement')).length;
 }

package/src/view/containerelement.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/view/containerelement
  */
-
 import Element from './element';
-
 /**
  * Containers are elements which define document structure. They define boundaries for
  * {@link module:engine/view/attributeelement~AttributeElement attributes}. They are mostly used for block elements like `<p>` or `<div>`.
@@ -31,93 +28,86 @@ import Element from './element';
  * @extends module:engine/view/element~Element
  */
 export default class ContainerElement extends Element {
-	/**
-	 * Creates a container element.
-	 *
-	 * @see module:engine/view/downcastwriter~DowncastWriter#createContainerElement
-	 * @see module:engine/view/element~Element
-	 * @protected
-	 * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
-	 * @param {String} name Node name.
-	 * @param {Object|Iterable} [attrs] Collection of attributes.
-	 * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
-	 * A list of nodes to be inserted into created element.
-	 */
-	constructor( document, name, attrs, children ) {
-		super( document, name, attrs, children );
-
-		/**
-		 * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
-		 *
-		 * @method #getFillerOffset
-		 * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
-		 */
-		this.getFillerOffset = getFillerOffset;
-	}
-
-	/**
-	 * Checks whether this object is of the given.
-	 *
-	 *		containerElement.is( 'containerElement' ); // -> true
-	 *		containerElement.is( 'element' ); // -> true
-	 *		containerElement.is( 'node' ); // -> true
-	 *		containerElement.is( 'view:containerElement' ); // -> true
-	 *		containerElement.is( 'view:element' ); // -> true
-	 *		containerElement.is( 'view:node' ); // -> true
-	 *
-	 *		containerElement.is( 'model:element' ); // -> false
-	 *		containerElement.is( 'documentFragment' ); // -> false
-	 *
-	 * Assuming that the object being checked is a container element, you can also check its
-	 * {@link module:engine/view/containerelement~ContainerElement#name name}:
-	 *
-	 *		containerElement.is( 'element', 'div' ); // -> true if this is a div container element
-	 *		containerElement.is( 'contaienrElement', 'div' ); // -> same as above
-	 *		text.is( 'element', 'div' ); -> false
-	 *
-	 * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
-	 *
-	 * @param {String} type Type to check.
-	 * @param {String} [name] Element name.
-	 * @returns {Boolean}
-	 */
-	is( type, name = null ) {
-		if ( !name ) {
-			return type === 'containerElement' || type === 'view:containerElement' ||
-				// From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-				type === 'element' || type === 'view:element' ||
-				type === 'node' || type === 'view:node';
-		} else {
-			return name === this.name && (
-				type === 'containerElement' || type === 'view:containerElement' ||
-				// From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-				type === 'element' || type === 'view:element'
-			);
-		}
-	}
+    /**
+     * Creates a container element.
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createContainerElement
+     * @see module:engine/view/element~Element
+     * @protected
+     * @param {module:engine/view/document~Document} document The document instance to which this element belongs.
+     * @param {String} name Node name.
+     * @param {Object|Iterable} [attrs] Collection of attributes.
+     * @param {module:engine/view/node~Node|Iterable.<module:engine/view/node~Node>} [children]
+     * A list of nodes to be inserted into created element.
+     */
+    constructor(...args) {
+        super(...args);
+        /**
+         * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
+         *
+         * @method #getFillerOffset
+         * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
+         */
+        this.getFillerOffset = getFillerOffset;
+    }
 }
-
+/**
+ * Checks whether this object is of the given.
+ *
+ *		containerElement.is( 'containerElement' ); // -> true
+ *		containerElement.is( 'element' ); // -> true
+ *		containerElement.is( 'node' ); // -> true
+ *		containerElement.is( 'view:containerElement' ); // -> true
+ *		containerElement.is( 'view:element' ); // -> true
+ *		containerElement.is( 'view:node' ); // -> true
+ *
+ *		containerElement.is( 'model:element' ); // -> false
+ *		containerElement.is( 'documentFragment' ); // -> false
+ *
+ * Assuming that the object being checked is a container element, you can also check its
+ * {@link module:engine/view/containerelement~ContainerElement#name name}:
+ *
+ *		containerElement.is( 'element', 'div' ); // -> true if this is a div container element
+ *		containerElement.is( 'contaienrElement', 'div' ); // -> same as above
+ *		text.is( 'element', 'div' ); -> false
+ *
+ * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
+ *
+ * @param {String} type Type to check.
+ * @param {String} [name] Element name.
+ * @returns {Boolean}
+ */
+ContainerElement.prototype.is = function (type, name) {
+    if (!name) {
+        return type === 'containerElement' || type === 'view:containerElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'element' || type === 'view:element' ||
+            type === 'node' || type === 'view:node';
+    }
+    else {
+        return name === this.name && (type === 'containerElement' || type === 'view:containerElement' ||
+            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+            type === 'element' || type === 'view:element');
+    }
+};
 /**
  * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
  *
  * @returns {Number|null} Block filler offset or `null` if block filler is not needed.
  */
 export function getFillerOffset() {
-	const children = [ ...this.getChildren() ];
-	const lastChild = children[ this.childCount - 1 ];
-
-	// Block filler is required after a `<br>` if it's the last element in its container. See #1422.
-	if ( lastChild && lastChild.is( 'element', 'br' ) ) {
-		return this.childCount;
-	}
-
-	for ( const child of children ) {
-		// If there's any non-UI element – don't render the bogus.
-		if ( !child.is( 'uiElement' ) ) {
-			return null;
-		}
-	}
-
-	// If there are only UI elements – render the bogus at the end of the element.
-	return this.childCount;
+    const children = [...this.getChildren()];
+    const lastChild = children[this.childCount - 1];
+    // Block filler is required after a `<br>` if it's the last element in its container. See #1422.
+    if (lastChild && lastChild.is('element', 'br')) {
+        return this.childCount;
+    }
+    for (const child of children) {
+        // If there's any non-UI element – don't render the bogus.
+        if (!child.is('uiElement')) {
+            return null;
+        }
+    }
+    // If there are only UI elements – render the bogus at the end of the element.
+    return this.childCount;
 }