| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- import Matcher from '../view/matcher';
- import ConversionHelpers from './conversionhelpers';
- import { cloneDeep } from 'lodash-es';
- import { attachLinkToDocumentation } from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import priorities from '@ckeditor/ckeditor5-utils/src/priorities';
- import { isParagraphable, wrapInParagraph } from '../model/utils/autoparagraphing';
- /* global console */
- /**
- * Contains {@link module:engine/view/view view} to {@link module:engine/model/model model} converters for
- * {@link module:engine/conversion/upcastdispatcher~UpcastDispatcher}.
- *
- * @module engine/conversion/upcasthelpers
- */
- /**
- * Upcast conversion helper functions.
- *
- * @extends module:engine/conversion/conversionhelpers~ConversionHelpers
- */
- export default class UpcastHelpers extends ConversionHelpers {
- /**
- * View element to model element conversion helper.
- *
- * This conversion results in creating a model element. For example,
- * view `<p>Foo</p>` becomes `<paragraph>Foo</paragraph>` in the model.
- *
- * Keep in mind that the element will be inserted only if it is allowed
- * by {@link module:engine/model/schema~Schema schema} configuration.
- *
- * editor.conversion.for( 'upcast' ).elementToElement( {
- * view: 'p',
- * model: 'paragraph'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToElement( {
- * view: 'p',
- * model: 'paragraph',
- * converterPriority: 'high'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToElement( {
- * view: {
- * name: 'p',
- * classes: 'fancy'
- * },
- * model: 'fancyParagraph'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToElement( {
- * view: {
- * name: 'p',
- * classes: 'heading'
- * },
- * model: ( viewElement, conversionApi ) => {
- * const modelWriter = conversionApi.writer;
- *
- * return modelWriter.createElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } );
- * }
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
- * to the conversion process.
- *
- * @method #elementToElement
- * @param {Object} config Conversion configuration.
- * @param {module:engine/view/matcher~MatcherPattern} [config.view] Pattern matching all view elements which should be converted. If not
- * set, the converter will fire for every view element.
- * @param {String|module:engine/model/element~Element|Function} config.model Name of the model element, a model element instance or a
- * function that takes a view element and {@link module:engine/conversion/upcastdispatcher~UpcastConversionApi upcast conversion API}
- * and returns a model element. The model element will be inserted in the model.
- * @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
- * @returns {module:engine/conversion/upcasthelpers~UpcastHelpers}
- */
- elementToElement( config ) {
- return this.add( upcastElementToElement( config ) );
- }
- /**
- * View element to model attribute conversion helper.
- *
- * This conversion results in setting an attribute on a model node. For example, view `<strong>Foo</strong>` becomes
- * `Foo` {@link module:engine/model/text~Text model text node} with `bold` attribute set to `true`.
- *
- * This helper is meant to set a model attribute on all the elements that are inside the converted element:
- *
- * <strong>Foo</strong> --> <strong><p>Foo</p></strong> --> <paragraph><$text bold="true">Foo</$text></paragraph>
- *
- * Above is a sample of HTML code, that goes through autoparagraphing (first step) and then is converted (second step).
- * Even though `<strong>` is over `<p>` element, `bold="true"` was added to the text. See
- * {@link module:engine/conversion/upcasthelpers~UpcastHelpers#attributeToAttribute} for comparison.
- *
- * Keep in mind that the attribute will be set only if it is allowed by {@link module:engine/model/schema~Schema schema} configuration.
- *
- * editor.conversion.for( 'upcast' ).elementToAttribute( {
- * view: 'strong',
- * model: 'bold'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToAttribute( {
- * view: 'strong',
- * model: 'bold',
- * converterPriority: 'high'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToAttribute( {
- * view: {
- * name: 'span',
- * classes: 'bold'
- * },
- * model: 'bold'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToAttribute( {
- * view: {
- * name: 'span',
- * classes: [ 'styled', 'styled-dark' ]
- * },
- * model: {
- * key: 'styled',
- * value: 'dark'
- * }
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToAttribute( {
- * view: {
- * name: 'span',
- * styles: {
- * 'font-size': /[\s\S]+/
- * }
- * },
- * model: {
- * key: 'fontSize',
- * value: ( viewElement, conversionApi ) => {
- * const fontSize = viewElement.getStyle( 'font-size' );
- * const value = fontSize.substr( 0, fontSize.length - 2 );
- *
- * if ( value <= 10 ) {
- * return 'small';
- * } else if ( value > 12 ) {
- * return 'big';
- * }
- *
- * return null;
- * }
- * }
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
- * to the conversion process.
- *
- * @method #elementToAttribute
- * @param {Object} config Conversion configuration.
- * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.
- * @param {String|Object} config.model Model attribute key or an object with `key` and `value` properties, describing
- * the model attribute. `value` property may be set as a function that takes a view element and
- * {@link module:engine/conversion/upcastdispatcher~UpcastConversionApi upcast conversion API} and returns the value.
- * If `String` is given, the model attribute value will be set to `true`.
- * @param {module:utils/priorities~PriorityString} [config.converterPriority='low'] Converter priority.
- * @returns {module:engine/conversion/upcasthelpers~UpcastHelpers}
- */
- elementToAttribute( config ) {
- return this.add( upcastElementToAttribute( config ) );
- }
- /**
- * View attribute to model attribute conversion helper.
- *
- * This conversion results in setting an attribute on a model node. For example, view `<img src="foo.jpg"></img>` becomes
- * `<image source="foo.jpg"></image>` in the model.
- *
- * This helper is meant to convert view attributes from view elements which got converted to the model, so the view attribute
- * is set only on the corresponding model node:
- *
- * <div class="dark"><div>foo</div></div> --> <div dark="true"><div>foo</div></div>
- *
- * Above, `class="dark"` attribute is added only to the `<div>` elements that has it. This is in contrary to
- * {@link module:engine/conversion/upcasthelpers~UpcastHelpers#elementToAttribute} which sets attributes for
- * all the children in the model:
- *
- * <strong>Foo</strong> --> <strong><p>Foo</p></strong> --> <paragraph><$text bold="true">Foo</$text></paragraph>
- *
- * Above is a sample of HTML code, that goes through autoparagraphing (first step) and then is converted (second step).
- * Even though `<strong>` is over `<p>` element, `bold="true"` was added to the text.
- *
- * Keep in mind that the attribute will be set only if it is allowed by {@link module:engine/model/schema~Schema schema} configuration.
- *
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: 'src',
- * model: 'source'
- * } );
- *
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: { key: 'src' },
- * model: 'source'
- * } );
- *
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: { key: 'src' },
- * model: 'source',
- * converterPriority: 'normal'
- * } );
- *
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: {
- * key: 'data-style',
- * value: /[\s\S]+/
- * },
- * model: 'styled'
- * } );
- *
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: {
- * name: 'img',
- * key: 'class',
- * value: 'styled-dark'
- * },
- * model: {
- * key: 'styled',
- * value: 'dark'
- * }
- * } );
- *
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: {
- * key: 'class',
- * value: /styled-[\S]+/
- * },
- * model: {
- * key: 'styled'
- * value: ( viewElement, conversionApi ) => {
- * const regexp = /styled-([\S]+)/;
- * const match = viewElement.getAttribute( 'class' ).match( regexp );
- *
- * return match[ 1 ];
- * }
- * }
- * } );
- *
- * Converting styles works a bit differently as it requires `view.styles` to be an object and by default
- * a model attribute will be set to `true` by such a converter. You can set the model attribute to any value by providing the `value`
- * callback that returns the desired value.
- *
- * // Default conversion of font-weight style will result in setting bold attribute to true.
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: {
- * styles: {
- * 'font-weight': 'bold'
- * }
- * },
- * model: 'bold'
- * } );
- *
- * // This converter will pass any style value to the `lineHeight` model attribute.
- * editor.conversion.for( 'upcast' ).attributeToAttribute( {
- * view: {
- * styles: {
- * 'line-height': /[\s\S]+/
- * }
- * },
- * model: {
- * key: 'lineHeight',
- * value: ( viewElement, conversionApi ) => viewElement.getStyle( 'line-height' )
- * }
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
- * to the conversion process.
- *
- * @method #attributeToAttribute
- * @param {Object} config Conversion configuration.
- * @param {String|Object} config.view Specifies which view attribute will be converted. If a `String` is passed,
- * attributes with given key will be converted. If an `Object` is passed, it must have a required `key` property,
- * specifying view attribute key, and may have an optional `value` property, specifying view attribute value and optional `name`
- * property specifying a view element name from/on which the attribute should be converted. `value` can be given as a `String`,
- * a `RegExp` or a function callback, that takes view attribute value as the only parameter and returns `Boolean`.
- * @param {String|Object} config.model Model attribute key or an object with `key` and `value` properties, describing
- * the model attribute. `value` property may be set as a function that takes a view element and
- * {@link module:engine/conversion/upcastdispatcher~UpcastConversionApi upcast conversion API} and returns the value.
- * If `String` is given, the model attribute value will be same as view attribute value.
- * @param {module:utils/priorities~PriorityString} [config.converterPriority='low'] Converter priority.
- * @returns {module:engine/conversion/upcasthelpers~UpcastHelpers}
- */
- attributeToAttribute( config ) {
- return this.add( upcastAttributeToAttribute( config ) );
- }
- /**
- * View element to model marker conversion helper.
- *
- * **Note**: This method was deprecated. Please use {@link #dataToMarker} instead.
- *
- * This conversion results in creating a model marker. For example, if the marker was stored in a view as an element:
- * `<p>Fo<span data-marker="comment" data-comment-id="7"></span>o</p><p>B<span data-marker="comment" data-comment-id="7"></span>ar</p>`,
- * after the conversion is done, the marker will be available in
- * {@link module:engine/model/model~Model#markers model document markers}.
- *
- * editor.conversion.for( 'upcast' ).elementToMarker( {
- * view: 'marker-search',
- * model: 'search'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToMarker( {
- * view: 'marker-search',
- * model: 'search',
- * converterPriority: 'high'
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToMarker( {
- * view: 'marker-search',
- * model: ( viewElement, conversionApi ) => 'comment:' + viewElement.getAttribute( 'data-comment-id' )
- * } );
- *
- * editor.conversion.for( 'upcast' ).elementToMarker( {
- * view: {
- * name: 'span',
- * attributes: {
- * 'data-marker': 'search'
- * }
- * },
- * model: 'search'
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
- * to the conversion process.
- *
- * @deprecated
- * @method #elementToMarker
- * @param {Object} config Conversion configuration.
- * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.
- * @param {String|Function} config.model Name of the model marker, or a function that takes a view element and returns
- * a model marker name.
- * @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
- * @returns {module:engine/conversion/upcasthelpers~UpcastHelpers}
- */
- elementToMarker( config ) {
- /**
- * The {@link module:engine/conversion/upcasthelpers~UpcastHelpers#elementToMarker `UpcastHelpers#elementToMarker()`}
- * method was deprecated and will be removed in the near future.
- * Please use {@link module:engine/conversion/upcasthelpers~UpcastHelpers#dataToMarker `UpcastHelpers#dataToMarker()`} instead.
- *
- * @error upcast-helpers-element-to-marker-deprecated
- */
- console.warn(
- attachLinkToDocumentation(
- 'upcast-helpers-element-to-marker-deprecated: ' +
- 'The UpcastHelpers#elementToMarker() method was deprecated and will be removed in the near future. ' +
- 'Please use UpcastHelpers#dataToMarker() instead.'
- )
- );
- return this.add( upcastElementToMarker( config ) );
- }
- /**
- * View-to-model marker conversion helper.
- *
- * Converts view data created by {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData `#markerToData()`}
- * back to a model marker.
- *
- * This converter looks for specific view elements and view attributes that mark marker boundaries. See
- * {@link module:engine/conversion/downcasthelpers~DowncastHelpers#markerToData `#markerToData()`} to learn what view data
- * is expected by this converter.
- *
- * The `config.view` property is equal to the marker group name to convert.
- *
- * By default, this converter creates markers with the `group:name` name convention (to match the default `markerToData` conversion).
- *
- * The conversion configuration can take a function that will generate a marker name.
- * If such function is set as the `config.model` parameter, it is passed the `name` part from the view element or attribute and it is
- * expected to return a string with the marker name.
- *
- * Basic usage:
- *
- * // Using the default conversion.
- * // In this case, all markers from the `comment` group will be converted.
- * // The conversion will look for `<comment-start>` and `<comment-end>` tags and
- * // `data-comment-start-before`, `data-comment-start-after`,
- * // `data-comment-end-before` and `data-comment-end-after` attributes.
- * editor.conversion.for( 'upcast' ).dataToMarker( {
- * view: 'comment'
- * } );
- *
- * An example of a model that may be generated by this conversion:
- *
- * // View:
- * <p>Foo<comment-start name="commentId:uid"></comment-start>bar</p>
- * <figure data-comment-end-after="commentId:uid" class="image"><img src="abc.jpg" /></figure>
- *
- * // Model:
- * <paragraph>Foo[bar</paragraph>
- * <image src="abc.jpg"></image>]
- *
- * Where `[]` are boundaries of a marker that will receive the `comment:commentId:uid` name.
- *
- * Other examples of usage:
- *
- * // Using a custom function which is the same as the default conversion:
- * editor.conversion.for( 'upcast' ).dataToMarker( {
- * view: 'comment',
- * model: ( name, conversionApi ) => 'comment:' + name,
- * } );
- *
- * // Using the converter priority:
- * editor.conversion.for( 'upcast' ).dataToMarker( {
- * view: 'comment',
- * model: ( name, conversionApi ) => 'comment:' + name,
- * converterPriority: 'high'
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for `conversion.for()`} to learn how to add a converter
- * to the conversion process.
- *
- * @method #dataToMarker
- * @param {Object} config Conversion configuration.
- * @param {String} config.view The marker group name to convert.
- * @param {Function} [config.model] A function that takes the `name` part from the view element or attribute and
- * {@link module:engine/conversion/upcastdispatcher~UpcastConversionApi upcast conversion API} and returns the marker name.
- * @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
- * @returns {module:engine/conversion/upcasthelpers~UpcastHelpers}
- */
- dataToMarker( config ) {
- return this.add( upcastDataToMarker( config ) );
- }
- }
- /**
- * Function factory, creates a converter that converts {@link module:engine/view/documentfragment~DocumentFragment view document fragment}
- * or all children of {@link module:engine/view/element~Element} into
- * {@link module:engine/model/documentfragment~DocumentFragment model document fragment}.
- * This is the "entry-point" converter for upcast (view to model conversion). This converter starts the conversion of all children
- * of passed view document fragment. Those children {@link module:engine/view/node~Node view nodes} are then handled by other converters.
- *
- * This also a "default", last resort converter for all view elements that has not been converted by other converters.
- * When a view element is being converted to the model but it does not have converter specified, that view element
- * will be converted to {@link module:engine/model/documentfragment~DocumentFragment model document fragment} and returned.
- *
- * @returns {Function} Universal converter for view {@link module:engine/view/documentfragment~DocumentFragment fragments} and
- * {@link module:engine/view/element~Element elements} that returns
- * {@link module:engine/model/documentfragment~DocumentFragment model fragment} with children of converted view item.
- */
- export function convertToModelFragment() {
- return ( evt, data, conversionApi ) => {
- // Second argument in `consumable.consume` is discarded for ViewDocumentFragment but is needed for ViewElement.
- if ( !data.modelRange && conversionApi.consumable.consume( data.viewItem, { name: true } ) ) {
- const { modelRange, modelCursor } = conversionApi.convertChildren( data.viewItem, data.modelCursor );
- data.modelRange = modelRange;
- data.modelCursor = modelCursor;
- }
- };
- }
- /**
- * Function factory, creates a converter that converts {@link module:engine/view/text~Text} to {@link module:engine/model/text~Text}.
- *
- * @returns {Function} {@link module:engine/view/text~Text View text} converter.
- */
- export function convertText() {
- return ( evt, data, { schema, consumable, writer } ) => {
- let position = data.modelCursor;
- // When node is already converted then do nothing.
- if ( !consumable.test( data.viewItem ) ) {
- return;
- }
- if ( !schema.checkChild( position, '$text' ) ) {
- if ( !isParagraphable( position, '$text', schema ) ) {
- return;
- }
- position = wrapInParagraph( position, writer );
- }
- consumable.consume( data.viewItem );
- const text = writer.createText( data.viewItem.data );
- writer.insert( text, position );
- data.modelRange = writer.createRange(
- position,
- position.getShiftedBy( text.offsetSize )
- );
- data.modelCursor = data.modelRange.end;
- };
- }
- /**
- * Function factory, creates a callback function which converts a {@link module:engine/view/selection~Selection
- * view selection} taken from the {@link module:engine/view/document~Document#event:selectionChange} event
- * and sets in on the {@link module:engine/model/document~Document#selection model}.
- *
- * **Note**: because there is no view selection change dispatcher nor any other advanced view selection to model
- * conversion mechanism, the callback should be set directly on view document.
- *
- * view.document.on( 'selectionChange', convertSelectionChange( modelDocument, mapper ) );
- *
- * @param {module:engine/model/model~Model} model Data model.
- * @param {module:engine/conversion/mapper~Mapper} mapper Conversion mapper.
- * @returns {Function} {@link module:engine/view/document~Document#event:selectionChange} callback function.
- */
- export function convertSelectionChange( model, mapper ) {
- return ( evt, data ) => {
- const viewSelection = data.newSelection;
- const ranges = [];
- for ( const viewRange of viewSelection.getRanges() ) {
- ranges.push( mapper.toModelRange( viewRange ) );
- }
- const modelSelection = model.createSelection( ranges, { backward: viewSelection.isBackward } );
- if ( !modelSelection.isEqual( model.document.selection ) ) {
- model.change( writer => {
- writer.setSelection( modelSelection );
- } );
- }
- };
- }
- // View element to model element conversion helper.
- //
- // See {@link ~UpcastHelpers#elementToElement `.elementToElement()` upcast helper} for examples.
- //
- // @param {Object} config Conversion configuration.
- // @param {module:engine/view/matcher~MatcherPattern} [config.view] Pattern matching all view elements which should be converted. If not
- // set, the converter will fire for every view element.
- // @param {String|module:engine/model/element~Element|Function} config.model Name of the model element, a model element
- // instance or a function that takes a view element and returns a model element. The model element will be inserted in the model.
- // @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
- // @returns {Function} Conversion helper.
- function upcastElementToElement( config ) {
- config = cloneDeep( config );
- const converter = prepareToElementConverter( config );
- const elementName = getViewElementNameFromConfig( config.view );
- const eventName = elementName ? 'element:' + elementName : 'element';
- return dispatcher => {
- dispatcher.on( eventName, converter, { priority: config.converterPriority || 'normal' } );
- };
- }
- // View element to model attribute conversion helper.
- //
- // See {@link ~UpcastHelpers#elementToAttribute `.elementToAttribute()` upcast helper} for examples.
- //
- // @param {Object} config Conversion configuration.
- // @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.
- // @param {String|Object} config.model Model attribute key or an object with `key` and `value` properties, describing
- // the model attribute. `value` property may be set as a function that takes a view element and returns the value.
- // If `String` is given, the model attribute value will be set to `true`.
- // @param {module:utils/priorities~PriorityString} [config.converterPriority='low'] Converter priority.
- // @returns {Function} Conversion helper.
- function upcastElementToAttribute( config ) {
- config = cloneDeep( config );
- normalizeModelAttributeConfig( config );
- const converter = prepareToAttributeConverter( config, false );
- const elementName = getViewElementNameFromConfig( config.view );
- const eventName = elementName ? 'element:' + elementName : 'element';
- return dispatcher => {
- dispatcher.on( eventName, converter, { priority: config.converterPriority || 'low' } );
- };
- }
- // View attribute to model attribute conversion helper.
- //
- // See {@link ~UpcastHelpers#attributeToAttribute `.attributeToAttribute()` upcast helper} for examples.
- //
- // @param {Object} config Conversion configuration.
- // @param {String|Object} config.view Specifies which view attribute will be converted. If a `String` is passed,
- // attributes with given key will be converted. If an `Object` is passed, it must have a required `key` property,
- // specifying view attribute key, and may have an optional `value` property, specifying view attribute value and optional `name`
- // property specifying a view element name from/on which the attribute should be converted. `value` can be given as a `String`,
- // a `RegExp` or a function callback, that takes view attribute value as the only parameter and returns `Boolean`.
- // @param {String|Object} config.model Model attribute key or an object with `key` and `value` properties, describing
- // the model attribute. `value` property may be set as a function that takes a view element and returns the value.
- // If `String` is given, the model attribute value will be same as view attribute value.
- // @param {module:utils/priorities~PriorityString} [config.converterPriority='low'] Converter priority.
- // @returns {Function} Conversion helper.
- function upcastAttributeToAttribute( config ) {
- config = cloneDeep( config );
- let viewKey = null;
- if ( typeof config.view == 'string' || config.view.key ) {
- viewKey = normalizeViewAttributeKeyValueConfig( config );
- }
- normalizeModelAttributeConfig( config, viewKey );
- const converter = prepareToAttributeConverter( config, true );
- return dispatcher => {
- dispatcher.on( 'element', converter, { priority: config.converterPriority || 'low' } );
- };
- }
- // View element to model marker conversion helper.
- //
- // See {@link ~UpcastHelpers#elementToMarker `.elementToMarker()` upcast helper} for examples.
- //
- // @param {Object} config Conversion configuration.
- // @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.
- // @param {String|Function} config.model Name of the model marker, or a function that takes a view element and returns
- // a model marker name.
- // @param {module:utils/priorities~PriorityString} [config.converterPriority='normal'] Converter priority.
- // @returns {Function} Conversion helper.
- function upcastElementToMarker( config ) {
- config = cloneDeep( config );
- normalizeElementToMarkerConfig( config );
- return upcastElementToElement( config );
- }
- // View data to model marker conversion helper.
- //
- // See {@link ~UpcastHelpers#dataToMarker} to learn more.
- //
- // @param {Object} config
- // @param {String} config.view
- // @param {Function} [config.model]
- // @param {module:utils/priorities~PriorityString} [config.converterPriority='normal']
- // @returns {Function} Conversion helper.
- function upcastDataToMarker( config ) {
- config = cloneDeep( config );
- // Default conversion.
- if ( !config.model ) {
- config.model = name => {
- return name ? config.view + ':' + name : config.view;
- };
- }
- const converterStart = prepareToElementConverter( normalizeDataToMarkerConfig( config, 'start' ) );
- const converterEnd = prepareToElementConverter( normalizeDataToMarkerConfig( config, 'end' ) );
- return dispatcher => {
- dispatcher.on( 'element:' + config.view + '-start', converterStart, { priority: config.converterPriority || 'normal' } );
- dispatcher.on( 'element:' + config.view + '-end', converterEnd, { priority: config.converterPriority || 'normal' } );
- // Below is a hack that is needed to properly handle `converterPriority` for both elements and attributes.
- // Attribute conversion needs to be performed *after* element conversion.
- // This converter handles both element conversion and attribute conversion, which means that if a single
- // `config.converterPriority` is used, it will lead to problems. For example, if `'high'` priority is used,
- // then attribute conversion will be performed before a lot of element upcast converters.
- // On the other hand we want to support `config.converterPriority` and overwriting conveters.
- //
- // To have it work, we need to do some extra processing for priority for attribute converter.
- // Priority `'low'` value should be the base value and then we will change it depending on `config.converterPriority` value.
- //
- // This hack probably would not be needed if attributes are upcasted separately.
- //
- const basePriority = priorities.get( 'low' );
- const maxPriority = priorities.get( 'highest' );
- const priorityFactor = priorities.get( config.converterPriority ) / maxPriority; // Number in range [ -1, 1 ].
- dispatcher.on( 'element', upcastAttributeToMarker( config ), { priority: basePriority + priorityFactor } );
- };
- }
- // Function factory, returns a callback function which converts view attributes to a model marker.
- //
- // The converter looks for elements with `data-group-start-before`, `data-group-start-after`, `data-group-end-before`
- // and `data-group-end-after` attributes and inserts `$marker` model elements before/after those elements.
- // `group` part is specified in `config.view`.
- //
- // @param {Object} config
- // @param {String} config.view
- // @param {Function} [config.model]
- // @returns {Function} Marker converter.
- function upcastAttributeToMarker( config ) {
- return ( evt, data, conversionApi ) => {
- const attrName = `data-${ config.view }`;
- // This converter wants to add a model element, marking a marker, before/after an element (or maybe even group of elements).
- // To do that, we can use `data.modelRange` which is set on an element (or a group of elements) that has been upcasted.
- // But, if the processed view element has not been upcasted yet (it does not have been converted), we need to
- // fire conversion for its children first, then we will have `data.modelRange` available.
- if ( !data.modelRange ) {
- data = Object.assign( data, conversionApi.convertChildren( data.viewItem, data.modelCursor ) );
- }
- if ( conversionApi.consumable.consume( data.viewItem, { attributes: attrName + '-end-after' } ) ) {
- addMarkerElements( data.modelRange.end, data.viewItem.getAttribute( attrName + '-end-after' ).split( ',' ) );
- }
- if ( conversionApi.consumable.consume( data.viewItem, { attributes: attrName + '-start-after' } ) ) {
- addMarkerElements( data.modelRange.end, data.viewItem.getAttribute( attrName + '-start-after' ).split( ',' ) );
- }
- if ( conversionApi.consumable.consume( data.viewItem, { attributes: attrName + '-end-before' } ) ) {
- addMarkerElements( data.modelRange.start, data.viewItem.getAttribute( attrName + '-end-before' ).split( ',' ) );
- }
- if ( conversionApi.consumable.consume( data.viewItem, { attributes: attrName + '-start-before' } ) ) {
- addMarkerElements( data.modelRange.start, data.viewItem.getAttribute( attrName + '-start-before' ).split( ',' ) );
- }
- function addMarkerElements( position, markerViewNames ) {
- for ( const markerViewName of markerViewNames ) {
- const markerName = config.model( markerViewName, conversionApi );
- const element = conversionApi.writer.createElement( '$marker', { 'data-name': markerName } );
- conversionApi.writer.insert( element, position );
- if ( data.modelCursor.isEqual( position ) ) {
- data.modelCursor = data.modelCursor.getShiftedBy( 1 );
- } else {
- data.modelCursor = data.modelCursor._getTransformedByInsertion( position, 1 );
- }
- data.modelRange = data.modelRange._getTransformedByInsertion( position, 1 )[ 0 ];
- }
- }
- };
- }
- // Helper function for from-view-element conversion. Checks if `config.view` directly specifies converted view element's name
- // and if so, returns it.
- //
- // @param {Object} config Conversion view config.
- // @returns {String|null} View element name or `null` if name is not directly set.
- function getViewElementNameFromConfig( viewConfig ) {
- if ( typeof viewConfig == 'string' ) {
- return viewConfig;
- }
- if ( typeof viewConfig == 'object' && typeof viewConfig.name == 'string' ) {
- return viewConfig.name;
- }
- return null;
- }
- // Helper for to-model-element conversion. Takes a config object and returns a proper converter function.
- //
- // @param {Object} config Conversion configuration.
- // @returns {Function} View to model converter.
- function prepareToElementConverter( config ) {
- const matcher = new Matcher( config.view );
- return ( evt, data, conversionApi ) => {
- const matcherResult = matcher.match( data.viewItem );
- if ( !matcherResult ) {
- return;
- }
- const match = matcherResult.match;
- // Force consuming element's name.
- match.name = true;
- if ( !conversionApi.consumable.test( data.viewItem, match ) ) {
- return;
- }
- const modelElement = getModelElement( config.model, data.viewItem, conversionApi );
- if ( !modelElement ) {
- return;
- }
- if ( !conversionApi.safeInsert( modelElement, data.modelCursor ) ) {
- return;
- }
- conversionApi.consumable.consume( data.viewItem, match );
- conversionApi.convertChildren( data.viewItem, modelElement );
- conversionApi.updateConversionResult( modelElement, data );
- };
- }
- // Helper function for upcasting-to-element converter. Takes the model configuration, the converted view element
- // and a writer instance and returns a model element instance to be inserted in the model.
- //
- // @param {String|Function|module:engine/model/element~Element} model Model conversion configuration.
- // @param {module:engine/view/node~Node} input The converted view node.
- // @param {module:engine/conversion/upcastdispatcher~UpcastConversionApi} conversionApi The upcast conversion API.
- function getModelElement( model, input, conversionApi ) {
- if ( model instanceof Function ) {
- return model( input, conversionApi );
- } else {
- return conversionApi.writer.createElement( model );
- }
- }
- // Helper function view-attribute-to-model-attribute helper. Normalizes `config.view` which was set as `String` or
- // as an `Object` with `key`, `value` and `name` properties. Normalized `config.view` has is compatible with
- // {@link module:engine/view/matcher~MatcherPattern}.
- //
- // @param {Object} config Conversion config.
- // @returns {String} Key of the converted view attribute.
- function normalizeViewAttributeKeyValueConfig( config ) {
- if ( typeof config.view == 'string' ) {
- config.view = { key: config.view };
- }
- const key = config.view.key;
- let normalized;
- if ( key == 'class' || key == 'style' ) {
- const keyName = key == 'class' ? 'classes' : 'styles';
- normalized = {
- [ keyName ]: config.view.value
- };
- } else {
- const value = typeof config.view.value == 'undefined' ? /[\s\S]*/ : config.view.value;
- normalized = {
- attributes: {
- [ key ]: value
- }
- };
- }
- if ( config.view.name ) {
- normalized.name = config.view.name;
- }
- config.view = normalized;
- return key;
- }
- // Helper function that normalizes `config.model` in from-model-attribute conversion. `config.model` can be set
- // as a `String`, an `Object` with only `key` property or an `Object` with `key` and `value` properties. Normalized
- // `config.model` is an `Object` with `key` and `value` properties.
- //
- // @param {Object} config Conversion config.
- // @param {String} viewAttributeKeyToCopy Key of the converted view attribute. If it is set, model attribute value
- // will be equal to view attribute value.
- function normalizeModelAttributeConfig( config, viewAttributeKeyToCopy = null ) {
- const defaultModelValue = viewAttributeKeyToCopy === null ? true : viewElement => viewElement.getAttribute( viewAttributeKeyToCopy );
- const key = typeof config.model != 'object' ? config.model : config.model.key;
- const value = typeof config.model != 'object' || typeof config.model.value == 'undefined' ? defaultModelValue : config.model.value;
- config.model = { key, value };
- }
- // Helper for to-model-attribute conversion. Takes the model attribute name and conversion configuration and returns
- // a proper converter function.
- //
- // @param {String} modelAttributeKey The key of the model attribute to set on a model node.
- // @param {Object|Array.<Object>} config Conversion configuration. It is possible to provide multiple configurations in an array.
- // @param {Boolean} shallow If set to `true` the attribute will be set only on top-level nodes. Otherwise, it will be set
- // on all elements in the range.
- function prepareToAttributeConverter( config, shallow ) {
- const matcher = new Matcher( config.view );
- return ( evt, data, conversionApi ) => {
- const match = matcher.match( data.viewItem );
- // If there is no match, this callback should not do anything.
- if ( !match ) {
- return;
- }
- const modelKey = config.model.key;
- const modelValue = typeof config.model.value == 'function' ?
- config.model.value( data.viewItem, conversionApi ) : config.model.value;
- // Do not convert if attribute building function returned falsy value.
- if ( modelValue === null ) {
- return;
- }
- if ( onlyViewNameIsDefined( config.view, data.viewItem ) ) {
- match.match.name = true;
- } else {
- // Do not test or consume `name` consumable.
- delete match.match.name;
- }
- // Try to consume appropriate values from consumable values list.
- if ( !conversionApi.consumable.test( data.viewItem, match.match ) ) {
- return;
- }
- // Since we are converting to attribute we need an range on which we will set the attribute.
- // If the range is not created yet, we will create it.
- if ( !data.modelRange ) {
- // Convert children and set conversion result as a current data.
- data = Object.assign( data, conversionApi.convertChildren( data.viewItem, data.modelCursor ) );
- }
- // Set attribute on current `output`. `Schema` is checked inside this helper function.
- const attributeWasSet = setAttributeOn( data.modelRange, { key: modelKey, value: modelValue }, shallow, conversionApi );
- if ( attributeWasSet ) {
- conversionApi.consumable.consume( data.viewItem, match.match );
- }
- };
- }
- // Helper function that checks if element name should be consumed in attribute converters.
- //
- // @param {Object} config Conversion view config.
- // @returns {Boolean}
- function onlyViewNameIsDefined( viewConfig, viewItem ) {
- // https://github.com/ckeditor/ckeditor5-engine/issues/1786
- const configToTest = typeof viewConfig == 'function' ? viewConfig( viewItem ) : viewConfig;
- if ( typeof configToTest == 'object' && !getViewElementNameFromConfig( configToTest ) ) {
- return false;
- }
- return !configToTest.classes && !configToTest.attributes && !configToTest.styles;
- }
- // Helper function for to-model-attribute converter. Sets model attribute on given range. Checks {@link module:engine/model/schema~Schema}
- // to ensure proper model structure.
- //
- // @param {module:engine/model/range~Range} modelRange Model range on which attribute should be set.
- // @param {Object} modelAttribute Model attribute to set.
- // @param {module:engine/conversion/upcastdispatcher~UpcastConversionApi} conversionApi Conversion API.
- // @param {Boolean} shallow If set to `true` the attribute will be set only on top-level nodes. Otherwise, it will be set
- // on all elements in the range.
- // @returns {Boolean} `true` if attribute was set on at least one node from given `modelRange`.
- function setAttributeOn( modelRange, modelAttribute, shallow, conversionApi ) {
- let result = false;
- // Set attribute on each item in range according to Schema.
- for ( const node of Array.from( modelRange.getItems( { shallow } ) ) ) {
- if ( conversionApi.schema.checkAttribute( node, modelAttribute.key ) ) {
- conversionApi.writer.setAttribute( modelAttribute.key, modelAttribute.value, node );
- result = true;
- }
- }
- return result;
- }
- // Helper function for upcasting-to-marker conversion. Takes the config in a format requested by `upcastElementToMarker()`
- // function and converts it to a format that is supported by `upcastElementToElement()` function.
- //
- // @param {Object} config Conversion configuration.
- function normalizeElementToMarkerConfig( config ) {
- const oldModel = config.model;
- config.model = ( viewElement, conversionApi ) => {
- const markerName = typeof oldModel == 'string' ? oldModel : oldModel( viewElement, conversionApi );
- return conversionApi.writer.createElement( '$marker', { 'data-name': markerName } );
- };
- }
- // Helper function for upcasting-to-marker conversion. Takes the config in a format requested by `upcastDataToMarker()`
- // function and converts it to a format that is supported by `upcastElementToElement()` function.
- //
- // @param {Object} config Conversion configuration.
- function normalizeDataToMarkerConfig( config, type ) {
- const configForElements = {};
- // Upcast <markerGroup-start> and <markerGroup-end> elements.
- configForElements.view = config.view + '-' + type;
- configForElements.model = ( viewElement, conversionApi ) => {
- const viewName = viewElement.getAttribute( 'name' );
- const markerName = config.model( viewName, conversionApi );
- return conversionApi.writer.createElement( '$marker', { 'data-name': markerName } );
- };
- return configForElements;
- }
|