@ckeditor/ckeditor5-engine 47.6.1 → 48.0.0-alpha.0

package/src/view/text.js

@@ -1,110 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module engine/view/text
- */
-import { ViewNode } from './node.js';
-/**
- * Tree view text node.
- *
- * The constructor of this class should not be used directly. To create a new text node instance
- * use the {@link module:engine/view/downcastwriter~ViewDowncastWriter#createText `ViewDowncastWriter#createText()`}
- * method when working on data downcasted from the model or the
- * {@link module:engine/view/upcastwriter~ViewUpcastWriter#createText `ViewUpcastWriter#createText()`}
- * method when working on non-semantic views.
- */
-export class ViewText extends ViewNode {
-    /**
-     * The text content.
-     *
-     * Setting the data fires the {@link module:engine/view/node~ViewNode#event:change:text change event}.
-     */
-    _textData;
-    /**
-     * Creates a tree view text node.
-     *
-     * @see module:engine/view/downcastwriter~ViewDowncastWriter#createText
-     * @internal
-     * @param document The document instance to which this text node belongs.
-     * @param data The text's data.
-     */
-    constructor(document, data) {
-        super(document);
-        this._textData = data;
-    }
-    /**
-     * The text content.
-     */
-    get data() {
-        return this._textData;
-    }
-    /**
-     * The `_data` property is controlled by a getter and a setter.
-     *
-     * The getter is required when using the addition assignment operator on protected property:
-     *
-     * ```ts
-     * const foo = downcastWriter.createText( 'foo' );
-     * const bar = downcastWriter.createText( 'bar' );
-     *
-     * foo._data += bar.data;   // executes: `foo._data = foo._data + bar.data`
-     * console.log( foo.data ); // prints: 'foobar'
-     * ```
-     *
-     * If the protected getter didn't exist, `foo._data` will return `undefined` and result of the merge will be invalid.
-     *
-     * The setter sets data and fires the {@link module:engine/view/node~ViewNode#event:change:text change event}.
-     *
-     * @internal
-     */
-    get _data() {
-        return this.data;
-    }
-    set _data(data) {
-        this._fireChange('text', this);
-        this._textData = data;
-    }
-    /**
-     * Checks if this text node is similar to other text node.
-     * Both nodes should have the same data to be considered as similar.
-     *
-     * @param otherNode Node to check if it is same as this node.
-     */
-    isSimilar(otherNode) {
-        if (!(otherNode instanceof ViewText)) {
-            return false;
-        }
-        return this === otherNode || this.data === otherNode.data;
-    }
-    /**
-     * Converts `ViewText` instance to plain object and returns it.
-     *
-     * @returns `ViewText` instance converted to plain object.
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.type = 'Text';
-        json.data = this.data;
-        return json;
-    }
-    /**
-     * Clones this node.
-     *
-     * @internal
-     * @returns Text node that is a clone of this node.
-     */
-    _clone() {
-        return new ViewText(this.document, this.data);
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ViewText.prototype.is = function (type) {
-    return type === '$text' || type === 'view:$text' ||
-        // This are legacy values kept for backward compatibility.
-        type === 'text' || type === 'view:text' ||
-        // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-        type === 'node' || type === 'view:node';
-};

package/src/view/textproxy.js

@@ -1,136 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module engine/view/textproxy
- */
-import { ViewTypeCheckable } from './typecheckable.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * ViewTextProxy is a wrapper for substring of {@link module:engine/view/text~ViewText}. Instance of this class is created by
- * {@link module:engine/view/treewalker~ViewTreeWalker} when only a part of {@link module:engine/view/text~ViewText} needs to be returned.
- *
- * `ViewTextProxy` has an API similar to {@link module:engine/view/text~ViewText Text} and allows to do most of the common tasks performed
- * on view nodes.
- *
- * **Note:** Some `ViewTextProxy` instances may represent whole text node, not just a part of it.
- * See {@link module:engine/view/textproxy~ViewTextProxy#isPartial}.
- *
- * **Note:** `ViewTextProxy` is a readonly interface.
- *
- * **Note:** `ViewTextProxy` instances are created on the fly basing
- * on the current state of parent {@link module:engine/view/text~ViewText}.
- * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
- * invalidated due to operations on Document. Also ViewTextProxy is not a {@link module:engine/view/node~ViewNode} so it cannot be
- * inserted as a child of {@link module:engine/view/element~ViewElement}.
- *
- * `ViewTextProxy` instances are created by {@link module:engine/view/treewalker~ViewTreeWalker view tree walker}.
- * You should not need to create an instance of this class by your own.
- */
-export class ViewTextProxy extends ViewTypeCheckable {
-    /**
-     * Reference to the {@link module:engine/view/text~ViewText} element which ViewTextProxy is a substring.
-     */
-    textNode;
-    /**
-     * Text data represented by this text proxy.
-     */
-    data;
-    /**
-     * Offset in the `textNode` where this `ViewTextProxy` instance starts.
-     */
-    offsetInText;
-    /**
-     * Creates a text proxy.
-     *
-     * @internal
-     * @param textNode Text node which part is represented by this text proxy.
-     * @param offsetInText Offset in {@link module:engine/view/textproxy~ViewTextProxy#textNode text node}
-     * from which the text proxy starts.
-     * @param length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
-     */
-    constructor(textNode, offsetInText, length) {
-        super();
-        this.textNode = textNode;
-        if (offsetInText < 0 || offsetInText > textNode.data.length) {
-            /**
-             * Given offsetInText value is incorrect.
-             *
-             * @error view-textproxy-wrong-offsetintext
-             */
-            throw new CKEditorError('view-textproxy-wrong-offsetintext', this);
-        }
-        if (length < 0 || offsetInText + length > textNode.data.length) {
-            /**
-             * Given length value is incorrect.
-             *
-             * @error view-textproxy-wrong-length
-             */
-            throw new CKEditorError('view-textproxy-wrong-length', this);
-        }
-        this.data = textNode.data.substring(offsetInText, offsetInText + length);
-        this.offsetInText = offsetInText;
-    }
-    /**
-     * Offset size of this node.
-     */
-    get offsetSize() {
-        return this.data.length;
-    }
-    /**
-     * Flag indicating whether `ViewTextProxy` instance covers only part of the original {@link module:engine/view/text~ViewText text node}
-     * (`true`) or the whole text node (`false`).
-     *
-     * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~ViewTextProxy#textNode textNode}
-     * ({@link module:engine/view/textproxy~ViewTextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
-     * text node size.
-     */
-    get isPartial() {
-        return this.data.length !== this.textNode.data.length;
-    }
-    /**
-     * Parent of this text proxy, which is same as parent of text node represented by this text proxy.
-     */
-    get parent() {
-        return this.textNode.parent;
-    }
-    /**
-     * Root of this text proxy, which is same as root of text node represented by this text proxy.
-     */
-    get root() {
-        return this.textNode.root;
-    }
-    /**
-     * {@link module:engine/view/document~ViewDocument View document} that owns this text proxy, or `null` if the text proxy is inside
-     * {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}.
-     */
-    get document() {
-        return this.textNode.document;
-    }
-    /**
-     * Returns ancestors array of this text proxy.
-     *
-     * @param options Options object.
-     * @param options.includeSelf When set to `true`, textNode will be also included in parent's array.
-     * @param options.parentFirst When set to `true`, array will be sorted from text proxy parent to
-     * root element, otherwise root element will be the first item in the array.
-     * @returns Array with ancestors.
-     */
-    getAncestors(options = {}) {
-        const ancestors = [];
-        let parent = options.includeSelf ? this.textNode : this.parent;
-        while (parent !== null) {
-            ancestors[options.parentFirst ? 'push' : 'unshift'](parent);
-            parent = parent.parent;
-        }
-        return ancestors;
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ViewTextProxy.prototype.is = function (type) {
-    return type === '$textProxy' || type === 'view:$textProxy' ||
-        // This are legacy values kept for backward compatibility.
-        type === 'textProxy' || type === 'view:textProxy';
-};

package/src/view/tokenlist.js

@@ -1,194 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module engine/view/tokenlist
- */
-import { toArray } from '@ckeditor/ckeditor5-utils';
-/**
- * Token list. Allows handling (adding, removing, retrieving) a set of tokens (for example class names).
- */
-export class ViewTokenList {
-    /**
-     * The set of tokens.
-     */
-    _set = new Set();
-    /**
-     * Returns true if token list has no tokens set.
-     */
-    get isEmpty() {
-        return this._set.size == 0;
-    }
-    /**
-     * Number of tokens.
-     */
-    get size() {
-        return this._set.size;
-    }
-    /**
-     * Checks if a given token is set.
-     */
-    has(name) {
-        return this._set.has(name);
-    }
-    /**
-     * Returns all tokens.
-     */
-    keys() {
-        return Array.from(this._set.keys());
-    }
-    /**
-     * Resets the value to the given one.
-     */
-    setTo(value) {
-        this.clear();
-        for (const token of value.split(/\s+/)) {
-            if (token) {
-                this._set.add(token);
-            }
-        }
-        return this;
-    }
-    /**
-     * Sets a given token without affecting other tokens.
-     */
-    set(tokens) {
-        for (const token of toArray(tokens)) {
-            if (token) {
-                this._set.add(token);
-            }
-        }
-    }
-    /**
-     * Removes given token.
-     */
-    remove(tokens) {
-        for (const token of toArray(tokens)) {
-            this._set.delete(token);
-        }
-    }
-    /**
-     * Removes all tokens.
-     */
-    clear() {
-        this._set.clear();
-    }
-    /**
-     * Returns a normalized tokens string.
-     */
-    toString() {
-        return Array.from(this._set).join(' ');
-    }
-    /**
-     * Returns `true` if both attributes have the same tokens.
-     */
-    isSimilar(other) {
-        if (this.size !== other.size) {
-            return false;
-        }
-        for (const token of this.keys()) {
-            if (!other.has(token)) {
-                return false;
-            }
-        }
-        return true;
-    }
-    /**
-     * Clones the attribute value.
-     *
-     * @internal
-     */
-    _clone() {
-        const clone = new this.constructor();
-        clone._set = new Set(this._set);
-        return clone;
-    }
-    /**
-     * Used by the {@link module:engine/view/matcher~Matcher Matcher} to collect matching attribute tokens.
-     *
-     * @internal
-     * @param tokenPattern The matched token name pattern.
-     * @returns An array of matching tokens.
-     */
-    _getTokensMatch(tokenPattern) {
-        const match = [];
-        if (tokenPattern === true) {
-            for (const token of this._set.keys()) {
-                match.push(token);
-            }
-            return match;
-        }
-        if (typeof tokenPattern == 'string') {
-            for (const token of tokenPattern.split(/\s+/)) {
-                if (this._set.has(token)) {
-                    match.push(token);
-                }
-                else {
-                    return undefined;
-                }
-            }
-            return match;
-        }
-        for (const token of this._set.keys()) {
-            if (token.match(tokenPattern)) {
-                match.push(token);
-            }
-        }
-        return match.length ? match : undefined;
-    }
-    /**
-     * Returns a list of consumables for the attribute.
-     *
-     * Could be filtered by the given token name.
-     *
-     * @internal
-     */
-    _getConsumables(name) {
-        return name ? [name] : this.keys();
-    }
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_canMergeAttributesFrom} to verify if the given attribute
-     * can be merged without conflicts into the attribute.
-     *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while downcasting
-     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other `AttributeElement`.
-     *
-     * @internal
-     */
-    _canMergeFrom() {
-        return true;
-    }
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to merge a given attribute into the attribute.
-     *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other ViewAttributeElement.
-     *
-     * @internal
-     */
-    _mergeFrom(other) {
-        for (const token of other._set.keys()) {
-            if (!this._set.has(token)) {
-                this._set.add(token);
-            }
-        }
-    }
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_canSubtractAttributesOf} to verify if the given attribute
-     * can be fully subtracted from the attribute.
-     *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to unwrap the ViewAttributeElement.
-     *
-     * @internal
-     */
-    _isMatching(other) {
-        for (const name of other._set.keys()) {
-            if (!this._set.has(name)) {
-                return false;
-            }
-        }
-        return true;
-    }
-}