-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
node.ts
460 lines (393 loc) · 14.3 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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
/**
* @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
*/
/* eslint-disable @typescript-eslint/no-unused-vars */
/**
* @module engine/model/node
*/
import TypeCheckable from './typecheckable.js';
import type Document from './document.js';
import type DocumentFragment from './documentfragment.js';
import type Element from './element.js';
import { CKEditorError, compareArrays, toMap } from '@ckeditor/ckeditor5-utils';
/**
* Model node. Most basic structure of model tree.
*
* This is an abstract class that is a base for other classes representing different nodes in model.
*
* **Note:** If a node is detached from the model tree, you can manipulate it using it's API.
* However, it is **very important** that nodes already attached to model tree should be only changed through
* {@link module:engine/model/writer~Writer Writer API}.
*
* Changes done by `Node` methods, like {@link module:engine/model/element~Element#_insertChild _insertChild} or
* {@link module:engine/model/node~Node#_setAttribute _setAttribute}
* do not generate {@link module:engine/model/operation/operation~Operation operations}
* which are essential for correct editor work if you modify nodes in {@link module:engine/model/document~Document document} root.
*
* The flow of working on `Node` (and classes that inherits from it) is as such:
* 1. You can create a `Node` instance, modify it using it's API.
* 2. Add `Node` to the model using `Batch` API.
* 3. Change `Node` that was already added to the model using `Batch` API.
*
* Similarly, you cannot use `Batch` API on a node that has not been added to the model tree, with the exception
* of {@link module:engine/model/writer~Writer#insert inserting} that node to the model tree.
*
* Be aware that using {@link module:engine/model/writer~Writer#remove remove from Batch API} does not allow to use `Node` API because
* the information about `Node` is still kept in model document.
*
* In case of {@link module:engine/model/element~Element element node}, adding and removing children also counts as changing a node and
* follows same rules.
*/
export default abstract class Node extends TypeCheckable {
/**
* Parent of this node. It could be {@link module:engine/model/element~Element}
* or {@link module:engine/model/documentfragment~DocumentFragment}.
* Equals to `null` if the node has no parent.
*/
public readonly parent: Element | DocumentFragment | null = null;
/**
* Unique root name used to identify this root element by {@link module:engine/model/document~Document}.
*/
declare public readonly rootName: string | undefined;
/**
* Attributes set on this node.
*/
private _attrs: Map<string, unknown>;
/**
* Creates a model node.
*
* This is an abstract class, so this constructor should not be used directly.
*
* @param attrs Node's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
*/
constructor( attrs?: NodeAttributes ) {
super();
this._attrs = toMap( attrs! );
}
/**
* {@link module:engine/model/document~Document Document} that owns this root element.
*/
public get document(): Document | null {
return null;
}
/**
* Index of this node in its parent 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 model tree got broken.
*/
public get index(): number | null {
let pos;
if ( !this.parent ) {
return null;
}
if ( ( pos = this.parent.getChildIndex( this ) ) === null ) {
throw new CKEditorError( 'model-node-not-found-in-parent', this );
}
return pos;
}
/**
* Offset at which this node starts in its parent. It is equal to the sum of {@link #offsetSize offsetSize}
* of all its previous siblings. Equals to `null` if node has no parent.
*
* Accessing this property throws an error if this node's parent element does not contain it.
* This means that model tree got broken.
*/
public get startOffset(): number | null {
let pos;
if ( !this.parent ) {
return null;
}
if ( ( pos = this.parent.getChildStartOffset( this ) ) === null ) {
throw new CKEditorError( 'model-node-not-found-in-parent', this );
}
return pos;
}
/**
* Offset size of this node. Represents how much "offset space" is occupied by the node in it's parent.
* It is important for {@link module:engine/model/position~Position position}. When node has `offsetSize` greater than `1`, position
* can be placed between that node start and end. `offsetSize` greater than `1` is for nodes that represents more
* than one entity, i.e. {@link module:engine/model/text~Text text node}.
*/
public get offsetSize(): number {
return 1;
}
/**
* Offset at which this node ends in it's parent. It is equal to the sum of this node's
* {@link module:engine/model/node~Node#startOffset start offset} and {@link #offsetSize offset size}.
* Equals to `null` if the node has no parent.
*/
public get endOffset(): number | null {
if ( !this.parent ) {
return null;
}
return this.startOffset! + this.offsetSize;
}
/**
* Node's next sibling or `null` if the node is a last child of it's parent or if the node has no parent.
*/
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 the node is a first child of it's parent or if the node has no parent.
*/
public get previousSibling(): Node | null {
const index = this.index;
return ( index !== null && this.parent!.getChild( index - 1 ) ) || null;
}
/**
* The top-most ancestor of the node. If node has no parent it is the root itself. If the node is a part
* of {@link module:engine/model/documentfragment~DocumentFragment}, it's `root` is equal to that `DocumentFragment`.
*/
public get root(): Node | 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;
}
/**
* Returns `true` if the node is inside a document root that is attached to the document.
*/
public isAttached(): boolean {
// If the node has no parent it means that it is a root.
// But this is not a `RootElement`, so it means that it is not attached.
//
// If this is not the root, check if this element's root is attached.
return this.parent === null ? false : this.root.isAttached();
}
/**
* Gets path to the node. The path is an array containing starting offsets of consecutive ancestors of this node,
* beginning from {@link module:engine/model/node~Node#root root}, down to this node's starting offset. The path can be used to
* create {@link module:engine/model/position~Position Position} instance.
*
* ```ts
* const abc = new Text( 'abc' );
* const foo = new Text( 'foo' );
* const h1 = new Element( 'h1', null, new Text( 'header' ) );
* const p = new Element( 'p', null, [ abc, foo ] );
* const div = new Element( '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 [].
* ```
*/
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.startOffset! );
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/model/element~Element} or {@link module:engine/model/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/model/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/model/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 );
}
/**
* Checks if the node has an attribute with given key.
*
* @param key Key of attribute to check.
* @returns `true` if attribute with given key is set on node, `false` otherwise.
*/
public hasAttribute( key: string ): boolean {
return this._attrs.has( key );
}
/**
* Gets an attribute value for given key or `undefined` if that attribute is not set on node.
*
* @param key Key of attribute to look for.
* @returns Attribute value or `undefined`.
*/
public getAttribute( key: string ): unknown {
return this._attrs.get( key );
}
/**
* Returns iterator that iterates over this node's attributes.
*
* Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value.
* This format is accepted by native `Map` object and also can be passed in `Node` constructor.
*/
public getAttributes(): IterableIterator<[ string, unknown ]> {
return this._attrs.entries();
}
/**
* Returns iterator that iterates over this node's attribute keys.
*/
public getAttributeKeys(): IterableIterator<string> {
return this._attrs.keys();
}
/**
* Converts `Node` to plain object and returns it.
*
* @returns `Node` converted to plain object.
*/
public toJSON(): unknown {
const json: any = {};
// Serializes attributes to the object.
// attributes = { a: 'foo', b: 1, c: true }.
if ( this._attrs.size ) {
json.attributes = Array.from( this._attrs ).reduce( ( result, attr ) => {
result[ attr[ 0 ] ] = attr[ 1 ];
return result;
}, {} as any );
}
return json;
}
/**
* Creates a copy of this node, that is a node with exactly same attributes, and returns it.
*
* @internal
* @returns Node with same attributes as this node.
*/
public _clone( _deep?: boolean ): Node {
return new ( this.constructor as any )( this._attrs );
}
/**
* Removes this node from it's parent.
*
* @internal
* @see module:engine/model/writer~Writer#remove
*/
public _remove(): void {
this.parent!._removeChildren( this.index! );
}
/**
* Sets attribute on the node. If attribute with the same key already is set, it's value is overwritten.
*
* @see module:engine/model/writer~Writer#setAttribute
* @internal
* @param key Key of attribute to set.
* @param value Attribute value.
*/
public _setAttribute( key: string, value: unknown ): void {
this._attrs.set( key, value );
}
/**
* Removes all attributes from the node and sets given attributes.
*
* @see module:engine/model/writer~Writer#setAttributes
* @internal
* @param attrs Attributes to set. See {@link module:utils/tomap~toMap} for a list of accepted values.
*/
public _setAttributesTo( attrs: NodeAttributes ): void {
this._attrs = toMap( attrs );
}
/**
* Removes an attribute with given key from the node.
*
* @see module:engine/model/writer~Writer#removeAttribute
* @internal
* @param key Key of attribute to remove.
* @returns `true` if the attribute was set on the element, `false` otherwise.
*/
public _removeAttribute( key: string ): boolean {
return this._attrs.delete( key );
}
/**
* Removes all attributes from the node.
*
* @see module:engine/model/writer~Writer#clearAttributes
* @internal
*/
public _clearAttributes(): void {
this._attrs.clear();
}
}
// 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 === 'model:node';
};
/**
* The node's parent does not contain this node.
*
* @error model-node-not-found-in-parent
*/
/**
* Node's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
*/
export type NodeAttributes = Record<string, unknown> | Iterable<[ string, unknown ]>;