This repository has been archived by the owner on Jun 26, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 40
/
two-way-converters.js
400 lines (380 loc) · 11.6 KB
/
two-way-converters.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
/**
* @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md.
*/
/**
* @module engine/conversion/two-way-converters
*/
import {
downcastElementToElement,
downcastAttributeToElement,
downcastAttributeToAttribute
} from './downcast-converters';
import {
upcastElementToElement,
upcastElementToAttribute,
upcastAttributeToAttribute
} from './upcast-converters';
/**
* Defines a conversion between the model and the view where a model element is represented as a view element (and vice versa).
* For example, model `<paragraph>Foo</paragraph>` is `<p>Foo</p>` in the view.
*
* elementToElement( conversion, { model: 'paragraph', view: 'p' } );
*
* elementToElement( conversion, {
* model: 'fancyParagraph',
* view: {
* name: 'p',
* class: 'fancy'
* }
* } );
*
* elementToElement( conversion, {
* model: 'paragraph',
* view: 'p',
* upcastAlso: [
* 'div',
* {
* // Match any name.
* name: /./,
* style: {
* display: 'block'
* }
* }
* ]
* } );
*
* elementToElement( conversion, {
* model: 'heading',
* view: 'h2',
* // Convert "headling-like" paragraphs to headings.
* upcastAlso: viewElement => {
* const fontSize = viewElement.getStyle( 'font-size' );
*
* if ( !fontSize ) {
* return null;
* }
*
* const match = fontSize.match( /(\d+)\s*px/ );
*
* if ( !match ) {
* return null;
* }
*
* const size = Number( match[ 1 ] );
*
* if ( size > 26 ) {
* return { name: true, style: [ 'font-size' ] };
* }
*
* return null;
* }
* } );
*
* @param {module:engine/conversion/conversion~Conversion} conversion Conversion class instance with registered conversion dispatchers.
* @param {Object} definition Conversion definition.
* @param {String} definition.model Name of the model element to convert.
* @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to.
* @param {module:engine/view/matcher~MatcherPattern|Array.<module:engine/view/matcher~MatcherPattern>} [definition.upcastAlso]
* Any view element matching `upcastAlso` will also be converted to the given model element.
*/
export function elementToElement( conversion, definition ) {
// Set up downcast converter.
conversion.for( 'downcast' ).add( downcastElementToElement( definition ) );
// Set up upcast converter.
for ( const view of _getAllViews( definition ) ) {
const priority = view == definition.view ? 'normal' : 'high';
conversion.for( 'upcast' ).add( upcastElementToElement( {
model: definition.model,
view
}, priority ) );
}
}
/**
* Defines a conversion between the model and the view where a model attribute is represented as a view element (and vice versa).
* For example, model text node with data `"Foo"` and `bold` attribute is `<strong>Foo</strong>` in the view.
*
* attributeToElement( conversion, 'bold', { view: 'strong' } );
*
* attributeToElement( conversion, 'bold', {
* view: {
* name: 'span',
* class: 'bold'
* }
* } );
*
* attributeToElement( conversion, 'bold', {
* view: 'strong',
* upcastAlso: [
* 'b',
* {
* name: 'span',
* class: 'bold'
* },
* {
* name: 'span',
* style: {
* 'font-weight': 'bold'
* }
* },
* viewElement => {
* const fontWeight = viewElement.getStyle( 'font-weight' );
*
* if ( viewElement.is( 'span' ) && fontWeight && /\d+/.test() && Number( fontWeight ) > 500 ) {
* return {
* name: true,
* style: [ 'font-weight' ]
* };
* }
* }
* ]
* } );
*
* attributeToElement( conversion, 'styled', {
* model: 'dark',
* view: {
* name: 'span',
* class: [ 'styled', 'styled-dark' ]
* }
* } );
*
* attributeToElement( conversion, 'fontSize', [
* {
* model: 'big',
* view: {
* name: 'span',
* style: {
* 'font-size': '1.2em'
* }
* }
* },
* {
* model: 'small',
* view: {
* name: 'span',
* style: {
* 'font-size': '0.8em'
* }
* }
* }
* ] );
*
* attributeToElement( conversion, 'fontSize', [
* {
* model: 'big',
* view: {
* name: 'span',
* style: {
* 'font-size': '1.2em'
* }
* },
* upcastAlso: viewElement => {
* const fontSize = viewElement.getStyle( 'font-size' );
*
* if ( !fontSize ) {
* return null;
* }
*
* const match = fontSize.match( /(\d+)\s*px/ );
*
* if ( !match ) {
* return null;
* }
*
* const size = Number( match[ 1 ] );
*
* if ( viewElement.is( 'span' ) && size > 10 ) {
* return { name: true, style: [ 'font-size' ] };
* }
*
* return null;
* }
* },
* {
* model: 'small',
* view: {
* name: 'span',
* style: {
* 'font-size': '0.8em'
* }
* },
* upcastAlso: viewElement => {
* const fontSize = viewElement.getStyle( 'font-size' );
*
* if ( !fontSize ) {
* return null;
* }
*
* const match = fontSize.match( /(\d+)\s*px/ );
*
* if ( !match ) {
* return null;
* }
*
* const size = Number( match[ 1 ] );
*
* if ( viewElement.is( 'span' ) && size < 10 ) {
* return { name: true, style: [ 'font-size' ] };
* }
*
* return null;
* }
* }
* ] );
*
* @param {module:engine/conversion/conversion~Conversion} conversion Conversion class instance with registered conversion dispatchers.
* @param {String} modelAttributeKey The key of the model attribute to convert.
* @param {Object|Array.<Object>} definition Conversion definition. It is possible to provide multiple definitions in an array.
* @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasted, the item will be treated
* as a default item, that will be used when no other item matches. When upcasted, the model attribute value will be set to `true`.
* @param {module:engine/view/elementdefinition~ElementDefinition} definition.view Definition of a view element to convert from/to.
* @param {module:engine/view/matcher~MatcherPattern|Array.<module:engine/view/matcher~MatcherPattern>} [definition.upcastAlso]
* Any view element matching `upcastAlso` will also be converted to the given model element.
*/
export function attributeToElement( conversion, modelAttributeKey, definition ) {
// Set downcast (model to view conversion).
conversion.for( 'downcast' ).add( downcastAttributeToElement( modelAttributeKey, definition ) );
// Set upcast (view to model conversion). In this case, we need to re-organise the definition config.
if ( !Array.isArray( definition ) ) {
definition = [ definition ];
}
for ( const item of definition ) {
const model = _getModelAttributeDefinition( modelAttributeKey, item.model );
for ( const view of _getAllViews( item ) ) {
const priority = view == item.view ? 'normal' : 'high';
conversion.for( 'upcast' ).add( upcastElementToAttribute( {
view,
model
}, priority ) );
}
}
}
/**
* Defines a conversion between the model and the view where a model attribute is represented as a view attribute (and vice versa).
* For example, `<image src='foo.jpg'></image>` is converted to `<img src='foo.jpg'></img>` (same attribute name and value).
*
* attributeToAttribute( conversion, 'src' );
*
* attributeToAttribute( conversion, 'source', { view: 'src' } );
*
* attributeToAttribute( conversion, 'aside', {
* model: true,
* view: {
* name: 'img',
* key: 'class',
* value: 'aside half-size'
* }
* } );
*
* attributeToAttribute( conversion, 'styled', [
* {
* model: 'dark',
* view: {
* key: 'class',
* value: 'styled styled-dark'
* }
* },
* {
* model: 'light',
* view: {
* key: 'class',
* value: 'styled styled-light'
* }
* }
* ] );
*
* attributeToAttribute( conversion, 'align', [
* {
* model: 'right',
* view: {
* key: 'class',
* value: 'align-right'
* },
* upcastAlso: viewElement => {
* if ( viewElement.getStyle( 'text-align' ) == 'right' ) {
* return {
* style: [ 'text-align' ]
* };
* }
*
* return null;
* }
* },
* {
* model: 'center',
* view: {
* key: 'class',
* value: 'align-center'
* },
* upcastAlso: {
* style: {
* 'text-align': 'center'
* }
* }
* }
* ] );
*
* @param {module:engine/conversion/conversion~Conversion} conversion Conversion class instance with registered conversion dispatchers.
* @param {String} modelAttributeKey The key of the model attribute to convert.
* @param {Object|Array.<Object>} [definition] Conversion definition. It is possible to provide multiple definitions in an array.
* If not set, the conversion helper will assume 1-to-1 conversion, that is the model attribute key and value will be same
* as the view attribute key and value.
* @param {*} [definition.model] The value of the converted model attribute. If omitted, when downcasting,
* the item will be treated as a default item, that will be used when no other item matches. When upcasting conversion,
* the model attribute value will be set to the same value as in the view.
* @param {Object} definition.view View attribute conversion details. Given object has required `key` property,
* specifying view attribute key, optional `value` property, specifying view attribute value and optional `name`
* property specifying a view element name from/on which the attribute should be converted. If `value` is not given,
* the view attribute value will be equal to model attribute value.
* @param {module:engine/view/matcher~MatcherPattern|Array.<module:engine/view/matcher~MatcherPattern>} [definition.upcastAlso]
* Any view element matching `upcastAlso` will also be converted to the given model element.
*/
export function attributeToAttribute( conversion, modelAttributeKey, definition ) {
// Set up downcast converter.
conversion.for( 'downcast' ).add( downcastAttributeToAttribute( modelAttributeKey, definition ) );
// Set up upcast converter. In this case, we need to re-organise the definition config.
if ( !definition ) {
definition = { view: modelAttributeKey };
}
if ( !Array.isArray( definition ) ) {
definition = [ definition ];
}
for ( const item of definition ) {
const model = _getModelAttributeDefinition( modelAttributeKey, item.model );
for ( const view of _getAllViews( item ) ) {
const priority = view == item.view ? 'low' : 'normal';
conversion.for( 'upcast' ).add( upcastAttributeToAttribute( {
view,
model
}, priority ) );
}
}
}
// Helper function, normalizes input data into a correct config form that can be accepted by conversion helpers. The
// correct form is either `String` or an object with `key` and `value` properties.
//
// @param {String} key Model attribute key.
// @param {*} [model] Model attribute value.
// @returns {Object} Normalized model attribute definition.
function _getModelAttributeDefinition( key, model ) {
if ( model === undefined ) {
return key;
} else {
return {
key, value: model
};
}
}
// Helper function that creates a joint array out of an item passed in `definition.view` and items passed in
// `definition.upcastAlso`.
//
// @param {Object} definition Conversion definition.
// @returns {Array} Array containing view definitions.
function _getAllViews( definition ) {
if ( !definition.upcastAlso ) {
return [ definition.view ];
} else {
const upcastAlso = Array.isArray( definition.upcastAlso ) ? definition.upcastAlso : [ definition.upcastAlso ];
return [ definition.view ].concat( upcastAlso );
}
}