/
node.ts
322 lines (270 loc) · 8.88 KB
/
node.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
/**
* @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/node
*/
import TypeCheckable from './typecheckable.js';
import {
CKEditorError,
EmitterMixin,
compareArrays
} from '@ckeditor/ckeditor5-utils';
import { clone } from 'lodash-es';
// To check if component is loaded more than once.
import '@ckeditor/ckeditor5-utils/src/version.js';
import type { default as Document, ChangeType } from './document.js';
import type DocumentFragment from './documentfragment.js';
import type Element from './element.js';
/**
* Abstract view node class.
*
* This is an abstract class. Its constructor should not be used directly.
* Use the {@link module:engine/view/downcastwriter~DowncastWriter} or {@link module:engine/view/upcastwriter~UpcastWriter}
* to create new instances of view nodes.
*/
export default abstract class Node extends EmitterMixin( TypeCheckable ) {
/**
* The document instance to which this node belongs.
*/
public readonly document: Document;
/**
* Parent element. Null by default. Set by {@link module:engine/view/element~Element#_insertChild}.
*/
public readonly parent: Element | DocumentFragment | null;
/**
* Creates a tree view node.
*
* @param document The document instance to which this node belongs.
*/
protected constructor( document: Document ) {
super();
this.document = document;
this.parent = null;
}
/**
* Index of the node in the parent element or null if the node has no parent.
*
* Accessing this property throws an error if this node's parent element does not contain it.
* This means that view tree got broken.
*/
public get index(): number | null {
let pos;
if ( !this.parent ) {
return null;
}
// No parent or child doesn't exist in parent's children.
if ( ( pos = this.parent.getChildIndex( this ) ) == -1 ) {
/**
* The node's parent does not contain this node. It means that the document tree is corrupted.
*
* @error view-node-not-found-in-parent
*/
throw new CKEditorError( 'view-node-not-found-in-parent', this );
}
return pos;
}
/**
* Node's next sibling, or `null` if it is the last child.
*/
public get nextSibling(): Node | null {
const index = this.index;
return ( index !== null && this.parent!.getChild( index + 1 ) ) || null;
}
/**
* Node's previous sibling, or `null` if it is the first child.
*/
public get previousSibling(): Node | null {
const index = this.index;
return ( index !== null && this.parent!.getChild( index - 1 ) ) || null;
}
/**
* Top-most ancestor of the node. If the node has no parent it is the root itself.
*/
public get root(): Element | DocumentFragment {
// eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
let root: Node | DocumentFragment = this;
while ( root.parent ) {
root = root.parent;
}
return root as any;
}
/**
* Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).
*/
public isAttached(): boolean {
return this.root.is( 'rootElement' );
}
/**
* Gets a path to the node. The path is an array containing indices of consecutive ancestors of this node,
* beginning from {@link module:engine/view/node~Node#root root}, down to this node's index.
*
* ```ts
* const abc = downcastWriter.createText( 'abc' );
* const foo = downcastWriter.createText( 'foo' );
* const h1 = downcastWriter.createElement( 'h1', null, downcastWriter.createText( 'header' ) );
* const p = downcastWriter.createElement( 'p', null, [ abc, foo ] );
* const div = downcastWriter.createElement( 'div', null, [ h1, p ] );
* foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
* h1.getPath(); // Returns [ 0 ].
* div.getPath(); // Returns [].
* ```
*
* @returns The path.
*/
public getPath(): Array<number> {
const path = [];
// eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
let node: Node | DocumentFragment = this;
while ( node.parent ) {
path.unshift( node.index! );
node = node.parent;
}
return path;
}
/**
* Returns ancestors array of this node.
*
* @param options Options object.
* @param options.includeSelf When set to `true` this node will be also included in parent's array.
* @param options.parentFirst When set to `true`, array will be sorted from node's 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<Node | DocumentFragment> {
const ancestors: Array<Node | DocumentFragment> = [];
let parent = options.includeSelf ? this : this.parent;
while ( parent ) {
ancestors[ options.parentFirst ? 'push' : 'unshift' ]( parent );
parent = parent.parent;
}
return ancestors;
}
/**
* Returns a {@link module:engine/view/element~Element} or {@link module:engine/view/documentfragment~DocumentFragment}
* which is a common ancestor of both nodes.
*
* @param node The second node.
* @param options Options object.
* @param options.includeSelf When set to `true` both nodes will be considered "ancestors" too.
* Which means that if e.g. node A is inside B, then their common ancestor will be B.
*/
public getCommonAncestor( node: Node, options: { includeSelf?: boolean } = {} ): Element | DocumentFragment | null {
const ancestorsA = this.getAncestors( options );
const ancestorsB = node.getAncestors( options );
let i = 0;
while ( ancestorsA[ i ] == ancestorsB[ i ] && ancestorsA[ i ] ) {
i++;
}
return i === 0 ? null : ancestorsA[ i - 1 ] as ( Element | DocumentFragment );
}
/**
* Returns whether this node is before given node. `false` is returned if nodes are in different trees (for example,
* in different {@link module:engine/view/documentfragment~DocumentFragment}s).
*
* @param node Node to compare with.
*/
public isBefore( node: Node ): boolean {
// Given node is not before this node if they are same.
if ( this == node ) {
return false;
}
// Return `false` if it is impossible to compare nodes.
if ( this.root !== node.root ) {
return false;
}
const thisPath = this.getPath();
const nodePath = node.getPath();
const result = compareArrays( thisPath, nodePath );
switch ( result ) {
case 'prefix':
return true;
case 'extension':
return false;
default:
return thisPath[ result as number ] < nodePath[ result as number ];
}
}
/**
* Returns whether this node is after given node. `false` is returned if nodes are in different trees (for example,
* in different {@link module:engine/view/documentfragment~DocumentFragment}s).
*
* @param node Node to compare with.
*/
public isAfter( node: Node ): boolean {
// Given node is not before this node if they are same.
if ( this == node ) {
return false;
}
// Return `false` if it is impossible to compare nodes.
if ( this.root !== node.root ) {
return false;
}
// In other cases, just check if the `node` is before, and return the opposite.
return !this.isBefore( node );
}
/**
* Removes node from parent.
*
* @internal
*/
public _remove(): void {
this.parent!._removeChildren( this.index! );
}
/**
* @internal
* @param type Type of the change.
* @param node Changed node.
* @fires change
*/
public _fireChange( type: ChangeType, node: Node ): void {
this.fire<ViewNodeChangeEvent>( `change:${ type }`, node );
if ( this.parent ) {
this.parent._fireChange( type, node );
}
}
/**
* Custom toJSON method to solve child-parent circular dependencies.
*
* @returns Clone of this object with the parent property removed.
*/
public toJSON(): unknown {
const json: any = clone( this );
// Due to circular references we need to remove parent reference.
delete json.parent;
return json;
}
/**
* Clones this node.
*
* @internal
* @returns Clone of this node.
*/
public abstract _clone( deep?: boolean ): Node;
/**
* Checks if provided node is similar to this node.
*
* @returns True if nodes are similar.
*/
public abstract isSimilar( other: Node ): boolean;
}
// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
// Proper overload would interfere with that.
Node.prototype.is = function( type: string ): boolean {
return type === 'node' || type === 'view:node';
};
/**
* Fired when list of {@link module:engine/view/element~Element elements} children, attributes or data changes.
*
* Change event is bubbled – it is fired on all ancestors.
*
* @eventName ~Node#change
* @eventName ~Node#change:children
* @eventName ~Node#change:attributes
* @eventName ~Node#change:text
*/
export type ViewNodeChangeEvent = {
name: 'change' | `change:${ ChangeType }`;
args: [ changedNode: Node ];
};