/
textproxy.ts
176 lines (153 loc) · 6.24 KB
/
textproxy.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/**
* @license Copyright (c) 2003-2024, 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/textproxy
*/
import TypeCheckable from './typecheckable.js';
import { CKEditorError } from '@ckeditor/ckeditor5-utils';
import type Document from './document.js';
import type DocumentFragment from './documentfragment.js';
import type Element from './element.js';
import type Node from './node.js';
import type Text from './text.js';
/**
* 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 extends TypeCheckable {
/**
* Reference to the {@link module:engine/view/text~Text} element which TextProxy is a substring.
*/
public readonly textNode: Text;
/**
* Text data represented by this text proxy.
*/
public readonly data: string;
/**
* Offset in the `textNode` where this `TextProxy` instance starts.
*/
public readonly offsetInText: number;
/**
* 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~TextProxy#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
*/
constructor( textNode: Text, offsetInText: number, length: number ) {
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.
*/
public get offsetSize(): number {
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.
*/
public get isPartial(): boolean {
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.
*/
public get parent(): Element | DocumentFragment | null {
return this.textNode.parent;
}
/**
* Root of this text proxy, which is same as root of text node represented by this text proxy.
*/
public get root(): Node | DocumentFragment {
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}.
*/
public get document(): Document | null {
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.
*/
public getAncestors( options: {
includeSelf?: boolean;
parentFirst?: boolean;
} = {} ): Array<Text | Element | DocumentFragment> {
const ancestors: Array<Text | Element | DocumentFragment> = [];
let parent: Text | Element | DocumentFragment | null = options.includeSelf ? this.textNode : this.parent;
while ( parent !== null ) {
ancestors[ options.parentFirst ? 'push' : 'unshift' ]( parent );
parent = parent.parent;
}
return ancestors;
}
// @if CK_DEBUG_ENGINE // public override toString(): string {
// @if CK_DEBUG_ENGINE // return `#${ this.data }`;
// @if CK_DEBUG_ENGINE // }
// @if CK_DEBUG_ENGINE // public log(): void {
// @if CK_DEBUG_ENGINE // console.log( 'ViewTextProxy: ' + this );
// @if CK_DEBUG_ENGINE // }
// @if CK_DEBUG_ENGINE // public logExtended(): void {
// @if CK_DEBUG_ENGINE // console.log( 'ViewTextProxy: ' + this );
// @if CK_DEBUG_ENGINE // }
}
// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
// Proper overload would interfere with that.
TextProxy.prototype.is = function( type: string ): boolean {
return type === '$textProxy' || type === 'view:$textProxy' ||
// This are legacy values kept for backward compatibility.
type === 'textProxy' || type === 'view:textProxy';
};