@ckeditor/ckeditor5-engine 30.0.0

package/src/view/text.js

@@ -0,0 +1,147 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module engine/view/text
+ */
+
+import Node from './node';
+
+/**
+ * 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~DowncastWriter#createText `DowncastWriter#createText()`}
+ * method when working on data downcasted from the model or the
+ * {@link module:engine/view/upcastwriter~UpcastWriter#createText `UpcastWriter#createText()`}
+ * method when working on non-semantic views.
+ *
+ * @extends module:engine/view/node~Node
+ */
+export default class Text extends Node {
+	/**
+	 * Creates a tree view text node.
+	 *
+	 * @protected
+	 * @param {module:engine/view/document~Document} document The document instance to which this text node belongs.
+	 * @param {String} data The text's data.
+	 */
+	constructor( document, data ) {
+		super( document );
+
+		/**
+		 * The text content.
+		 *
+		 * Setting the data fires the {@link module:engine/view/node~Node#event:change:text change event}.
+		 *
+		 * @protected
+		 * @member {String} module:engine/view/text~Text#_textData
+		 */
+		this._textData = data;
+	}
+
+	/**
+	 * Checks whether this object is of the given type.
+	 *
+	 *		text.is( '$text' ); // -> true
+	 *		text.is( 'node' ); // -> true
+	 *		text.is( 'view:$text' ); // -> true
+	 *		text.is( 'view:node' ); // -> true
+	 *
+	 *		text.is( 'model:$text' ); // -> false
+	 *		text.is( 'element' ); // -> false
+	 *		text.is( 'range' ); // -> false
+	 *
+	 * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
+	 *
+	 * **Note:** Until version 20.0.0 this method wasn't accepting `'$text'` type. The legacy `'text'` type is still
+	 * accepted for backward compatibility.
+	 *
+	 * @param {String} type Type to check.
+	 * @returns {Boolean}
+	 */
+	is( 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';
+	}
+
+	/**
+	 * The text content.
+	 *
+	 * @readonly
+	 * @type {String}
+	 */
+	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:
+	 *
+	 *		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~Node#event:change:text change event}.
+	 *
+	 * @protected
+	 * @type {String}
+	 */
+	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 {module:engine/view/text~Text} otherNode Node to check if it is same as this node.
+	 * @returns {Boolean}
+	 */
+	isSimilar( otherNode ) {
+		if ( !( otherNode instanceof Text ) ) {
+			return false;
+		}
+
+		return this === otherNode || this.data === otherNode.data;
+	}
+
+	/**
+	 * Clones this node.
+	 *
+	 * @protected
+	 * @returns {module:engine/view/text~Text} Text node that is a clone of this node.
+	 */
+	_clone() {
+		return new Text( this.document, this.data );
+	}
+
+	// @if CK_DEBUG_ENGINE // toString() {
+	// @if CK_DEBUG_ENGINE // 	return `#${ this.data }`;
+	// @if CK_DEBUG_ENGINE // }
+
+	// @if CK_DEBUG_ENGINE // log() {
+	// @if CK_DEBUG_ENGINE // 	console.log( 'ViewText: ' + this );
+	// @if CK_DEBUG_ENGINE // }
+
+	// @if CK_DEBUG_ENGINE // logExtended() {
+	// @if CK_DEBUG_ENGINE // 	console.log( 'ViewText: ' + this );
+	// @if CK_DEBUG_ENGINE // }
+}

package/src/view/textproxy.js

@@ -0,0 +1,199 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module engine/view/textproxy
+ */
+
+import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
+
+/**
+ * TextProxy is a wrapper for substring of {@link module:engine/view/text~Text}. Instance of this class is created by
+ * {@link module:engine/view/treewalker~TreeWalker} when only a part of {@link module:engine/view/text~Text} needs to be returned.
+ *
+ * `TextProxy` has an API similar to {@link module:engine/view/text~Text Text} and allows to do most of the common tasks performed
+ * on view nodes.
+ *
+ * **Note:** Some `TextProxy` instances may represent whole text node, not just a part of it.
+ * See {@link module:engine/view/textproxy~TextProxy#isPartial}.
+ *
+ * **Note:** `TextProxy` is a readonly interface.
+ *
+ * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
+ * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
+ * invalidated due to operations on Document. Also TextProxy is not a {@link module:engine/view/node~Node} so it can not be
+ * inserted as a child of {@link module:engine/view/element~Element}.
+ *
+ * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
+ * an instance of this class by your own.
+ */
+export default class TextProxy {
+	/**
+	 * Creates a text proxy.
+	 *
+	 * @protected
+	 * @param {module:engine/view/text~Text} textNode Text node which part is represented by this text proxy.
+	 * @param {Number} offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
+	 * from which the text proxy starts.
+	 * @param {Number} length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
+	 * @constructor
+	 */
+	constructor( textNode, offsetInText, length ) {
+		/**
+		 * Reference to the {@link module:engine/view/text~Text} element which TextProxy is a substring.
+		 *
+		 * @readonly
+		 * @member {module:engine/view/text~Text} module:engine/view/textproxy~TextProxy#textNode
+		 */
+		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 );
+		}
+
+		/**
+		 * Text data represented by this text proxy.
+		 *
+		 * @readonly
+		 * @member {String} module:engine/view/textproxy~TextProxy#data
+		 */
+		this.data = textNode.data.substring( offsetInText, offsetInText + length );
+
+		/**
+		 * Offset in the `textNode` where this `TextProxy` instance starts.
+		 *
+		 * @readonly
+		 * @member {Number} module:engine/view/textproxy~TextProxy#offsetInText
+		 */
+		this.offsetInText = offsetInText;
+	}
+
+	/**
+	 * Offset size of this node.
+	 *
+	 * @readonly
+	 * @type {Number}
+	 */
+	get offsetSize() {
+		return this.data.length;
+	}
+
+	/**
+	 * Flag indicating whether `TextProxy` instance covers only part of the original {@link module:engine/view/text~Text 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~TextProxy#textNode textNode}
+	 * ({@link module:engine/view/textproxy~TextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
+	 * text node size.
+	 *
+	 * @readonly
+	 * @type {Boolean}
+	 */
+	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.
+	 *
+	 * @readonly
+	 * @type {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null}
+	 */
+	get parent() {
+		return this.textNode.parent;
+	}
+
+	/**
+	 * Root of this text proxy, which is same as root of text node represented by this text proxy.
+	 *
+	 * @readonly
+	 * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment}
+	 */
+	get root() {
+		return this.textNode.root;
+	}
+
+	/**
+	 * {@link module:engine/view/document~Document View document} that owns this text proxy, or `null` if the text proxy is inside
+	 * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
+	 *
+	 * @readonly
+	 * @type {module:engine/view/document~Document|null}
+	 */
+	get document() {
+		return this.textNode.document;
+	}
+
+	/**
+	 * Checks whether this object is of the given type.
+	 *
+	 *		textProxy.is( '$textProxy' ); // -> true
+	 *		textProxy.is( 'view:$textProxy' ); // -> true
+	 *
+	 *		textProxy.is( 'model:$textProxy' ); // -> false
+	 *		textProxy.is( 'element' ); // -> false
+	 *		textProxy.is( 'range' ); // -> false
+	 *
+	 * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
+	 *
+	 * **Note:** Until version 20.0.0 this method wasn't accepting `'$textProxy'` type. The legacy `'textProxy'` type is still
+	 * accepted for backward compatibility.
+	 *
+	 * @param {String} type Type to check.
+	 * @returns {Boolean}
+	 */
+	is( type ) {
+		return type === '$textProxy' || type === 'view:$textProxy' ||
+			// This are legacy values kept for backward compatibility.
+			type === 'textProxy' || type === 'view:textProxy';
+	}
+
+	/**
+	 * Returns ancestors array of this text proxy.
+	 *
+	 * @param {Object} options Options object.
+	 * @param {Boolean} [options.includeSelf=false] When set to `true` {#textNode} will be also included in parent's array.
+	 * @param {Boolean} [options.parentFirst=false] 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} Array with ancestors.
+	 */
+	getAncestors( options = { includeSelf: false, parentFirst: false } ) {
+		const ancestors = [];
+		let parent = options.includeSelf ? this.textNode : this.parent;
+
+		while ( parent !== null ) {
+			ancestors[ options.parentFirst ? 'push' : 'unshift' ]( parent );
+			parent = parent.parent;
+		}
+
+		return ancestors;
+	}
+
+	// @if CK_DEBUG_ENGINE // toString() {
+	// @if CK_DEBUG_ENGINE // 	return `#${ this.data }`;
+	// @if CK_DEBUG_ENGINE // }
+
+	// @if CK_DEBUG_ENGINE // log() {
+	// @if CK_DEBUG_ENGINE // 	console.log( 'ViewTextProxy: ' + this );
+	// @if CK_DEBUG_ENGINE // }
+
+	// @if CK_DEBUG_ENGINE // logExtended() {
+	// @if CK_DEBUG_ENGINE // 	console.log( 'ViewTextProxy: ' + this );
+	// @if CK_DEBUG_ENGINE // }
+}