-
Notifications
You must be signed in to change notification settings - Fork 62
/
livemodeldata.js
420 lines (367 loc) · 11.4 KB
/
livemodeldata.js
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
/**
* @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md.
*/
/* global process */
import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
// A dictionary of words to help keeping the output size smaller.
const $element = 'e';
const $text = 't';
const $attribs = 'a';
const $children = '_';
/**
* Enables `editor.model.data`, a "live" property that can be used to get and set simple native object representation
* of the main root in the model document.
*
* The focus of this plugin is performance, providing a very fast way to dump the editor data
* for every change made in the editor content. Using `editor.model.data` should be at least 100x faster
* than `editor.getData()`.
*/
export default class LiveModelData extends Plugin {
constructor( editor ) {
super( editor );
const liveDocumentData = new LiveDocumentData( editor.model.document );
/**
* The model raw data as simple object.
*
* Attention: the object returned by this property must not be manipulated directly or it can
* immediately break the editor. If manipulation is necessary, be sure to do so in a deep clone of it.
*
* This property can be set to data in the same format as the one it outputs,
* having it the following structure:
* { -> document root, wrapping the whole data
* _: [ -> root children
* { -> if element
* e: "...", -> element name
* a: {}, -> element attributes (optional)
* _: [ ... ] -> element children (optional)
* },
* { -> if text
* t: "...", -> text data
* a: {}, -> text attributes (optional)
* },
* ...
* ]
* }
*
* @memberOf Model
* @member {String} #data
*/
Object.defineProperty( editor.model, 'data', {
get: () => {
return liveDocumentData.get();
},
set: data => {
return liveDocumentData.set( data );
}
} );
}
}
/**
* Maintains a "live" version of the main root element in a model document.
*
* By "live" we mean that changes to the model will just update the portions of the data that they touch.
*/
class LiveDocumentData {
/**
* Creates an instance of the LiveDocumentData class.
*
* @param document {module:engine/model/document~Document} The document to be watching for changes.
*/
constructor( document ) {
this.root = document.getRoot();
// This is the "database" that holds the output text version for all nodes in the document model.
const tree = this.tree = new Tree();
document.on( 'change:data', () => {
/* istanbul ignore next */
if ( process.env.NODE_ENV !== 'production' ) {
// Just set the following global (in the extension console) to see the performance log.
if ( window.LOG_LIVE_MODEL_DATA ) {
console.time( 'LiveModelData - process changes' );
}
}
const changes = document.differ.getChanges();
for ( const change of changes ) {
const position = change.position;
switch ( change.type ) {
case 'insert' : {
if ( change.name === '$text' ) {
// It is hard to say precisely what a text insertion changed so we refresh
// all texts (for simplicity).
tree.refreshTexts( position.parent );
} else {
const element = position.nodeAfter;
tree.insert( element );
// If the element ended up between texts, there is a chance that it split them,
// creating additional text nodes. As we don't have means to know that,
// we refresh all texts (for simplicity).
const isBetweenTexts = element.previousSibling && element.previousSibling.is( '$text' ) &&
element.nextSibling && element.nextSibling.is( '$text' );
if ( isBetweenTexts ) {
tree.refreshTexts( position.parent );
}
}
break;
}
case 'remove' : {
if ( change.name === '$text' ) {
// We have no information about which text nodes have been touched so
// we refresh all of them (for simplicity).
tree.refreshTexts( position.parent );
} else {
tree.remove( position );
}
break;
}
case 'attribute': {
const walker = change.range.getWalker( { ignoreElementEnd: true } );
let lastTextRefreshParent;
for ( const { item } of walker ) {
if ( item.is( 'element' ) ) {
// If the walker is passing through an element, we just refresh it,
// updating the attribute value in it (if it applies).
tree.refreshNode( item );
} else {
// If instead we have a text node, we have no idea if it has been
// merged with siblings, so we update it and all its sibling texts.
if ( item.parent !== lastTextRefreshParent ) {
tree.refreshTexts( item.parent );
// Do it just once for this parent.
lastTextRefreshParent = item.parent;
}
}
}
}
}
}
/* istanbul ignore next */
if ( process.env.NODE_ENV !== 'production' ) {
if ( window.LOG_LIVE_MODEL_DATA ) {
console.timeEnd( 'LiveModelData - process changes' );
}
}
/**
* Fired when the `data` property value "potentially" changed.
*
* @memberOf {Model}
* @event #data
*/
document.model.fire( 'data' );
} );
}
/**
* Gets the live object that holds the representation of the document main root data.
*
* This object must not be changed directly. It's main purpose is storage.
*
* return {Object} A live object.
*/
get() {
return this.tree.root;
}
/**
* Sets the data of the main document root with data produced by get().
*
* @param data {Object} And object containing the model data representation.
*/
set( data ) {
const root = this.root;
const model = root.document.model;
model.change( writer => {
// Replace the document contents.
writer.remove( writer.createRangeIn( root ) );
writer.insert( createFragment( data, writer ), root );
// Clean up previous document selection.
writer.setSelection( null );
writer.removeSelectionAttribute( model.document.selection.getAttributeKeys() );
} );
function createFragment( data, writer ) {
const fragment = writer.createDocumentFragment();
addChildren( data, fragment );
return fragment;
function addChildren( dataNode, modelTarget ) {
const children = dataNode[ $children ];
if ( children ) {
let index = 0;
let child;
while ( ( child = children[ index ] ) ) {
if ( $text in child ) {
writer.appendText( child[ $text ], child[ $attribs ], modelTarget );
} else {
const element = writer.createElement( child[ $element ], child[ $attribs ] );
// Go recursively.
addChildren( child, element );
writer.append( element, modelTarget );
}
index++;
}
}
}
}
}
}
/**
* Holds a deep object representation of model nodes.
*/
class Tree {
/**
* Creates and instance of the Tree class with an empty root node.
*/
constructor() {
/**
* The root node.
*
* @type {String[]}
*/
this.root = {};
}
/**
* Inserts a model node in the tree.
*
* The node position in the tree reflects its position in the model.
*
* @param modelNode {Element|Text} The model node to be inserted.
*/
insert( modelNode ) {
const parent = this.getNode( modelNode.parent );
const children = parent[ $children ] || ( parent[ $children ] = [] );
children.splice( modelNode.index, 0, this.getDefinition( modelNode ) );
}
/**
* Remove a node from the tree based on its position.
*
* The position in the tree is calculated out of a model position.
*
* @param modelPosition {Position} The model position.
*/
remove( modelPosition ) {
// By default we take the node which matches the position index.
let index = modelPosition.index;
// If we're inside a text node though, it means that the removed node was actually
// after that text node, so we fix the index. To illustrate (e.g.):
//
// Index: 0 1 2
// Before: text-before|{removed}text-after -> | == position.index = 1
//
// Index: 0
// After: text-before|text-after -> | == position.index = 0
//
const inTextNode = modelPosition.textNode;
if ( inTextNode ) {
index = modelPosition.textNode.index + 1;
}
const parent = this.getNode( modelPosition.parent );
parent[ $children ].splice( index, 1 );
if ( !parent[ $children ].length ) {
delete parent[ $children ];
}
// As demonstrated in the above comment, text need to be refreshed as they where merged.
if ( inTextNode ) {
this.refreshTexts( modelPosition.parent );
}
}
/**
* Refreshes a node. This is useful when changes to attributes happen.
*
* @param modelNode {Element|Text} The node to be refreshed.
*/
refreshNode( modelNode ) {
this.updateDefinition( this.getNode( modelNode ), modelNode );
}
/**
* Removes and re-inserts all text nodes that are direct children of an element.
*
* @param modelNode {Element} The parent element.
*/
refreshTexts( modelNode ) {
const node = this.getNode( modelNode );
const children = node[ $children ] || [];
// Remove all text nodes.
for ( let i = children.length - 1; i >= 0; i-- ) {
if ( $text in children[ i ] ) {
children.splice( i, 1 );
}
}
// Insert all text nodes back again.
Array.from( modelNode.getChildren() ).forEach( child => {
if ( child.is( '$text' ) ) {
children.splice( child.index, 0, this.getDefinition( child ) );
}
} );
if ( children.length ) {
node[ $children ] = children;
} else {
delete node[ $children ];
}
}
/**
* Fills up a node definition, not including children nodes.
*
* @param definition {Object}
* @param modelNode {Element|Text} The node to be processed.
*/
updateDefinition( definition, modelNode ) {
if ( modelNode.data ) {
definition[ $text ] = modelNode.data;
} else {
definition[ $element ] = modelNode.name;
}
// Attributes.
{
const nodeAttribs = Array.from( modelNode.getAttributes() );
if ( nodeAttribs.length ) {
definition[ $attribs ] = nodeAttribs.reduce( ( obj, [ name, value ] ) => {
obj[ name ] = value;
return obj;
}, {} );
}
}
}
/**
* Gets the complete node definition, including its children tree.
*
* @param modelNode {Element|Text} The node to be processed.
* @returns {Object} The node definition.
*/
getDefinition( modelNode ) {
const definition = {};
this.updateDefinition( definition, modelNode );
if ( $element in definition ) {
if ( modelNode.childCount ) {
definition[ $children ] = Array.from( modelNode.getChildren() )
.map( child => this.getDefinition( child ) );
}
}
return definition;
}
/**
* Calculates the tree path for a given model node.
*
* The path reflects that node position in the model document.
*
* @param modelNode {Element|Text} The model node.
* @returns {Number[]} A sequence of indexes to reach this node in the tree.
*/
getPath( modelNode ) {
const path = [];
while ( modelNode.parent ) {
path.unshift( modelNode.index );
modelNode = modelNode.parent;
}
return path;
}
/**
* Gets the tree entry representing a model node.
*
* @param modelNode {Element|Text} The model node.
* @returns {String[]} The tree representation of the node.
*/
getNode( modelNode ) {
const path = this.getPath( modelNode );
let node = this.root;
while ( path.length ) {
node = node[ $children ][ path.shift() ];
}
return node;
}
}