| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import Matcher from '../view/matcher';
- import ModelRange from '../model/range';
- import ModelPosition from '../model/position';
- import cloneDeep from '@ckeditor/ckeditor5-utils/src/lib/lodash/cloneDeep';
- /**
- * 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/upcast-converters
- */
- /**
- * 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.
- *
- * upcastElementToElement( { view: 'p', model: 'paragraph' } );
- *
- * upcastElementToElement( { view: 'p', model: 'paragraph' }, 'high' );
- *
- * upcastElementToElement( {
- * view: {
- * name: 'p',
- * class: 'fancy'
- * },
- * model: 'fancyParagraph'
- * } );
- *
- * upcastElementToElement( {
- * view: {
- * name: 'p',
- * class: 'fancy'
- * },
- * model: new ModelElement( 'p', { fancy: true } )
- * } );
- *
- * upcastElementToElement( {
- * view: {
- * name: 'p',
- * class: 'heading'
- * },
- * model: viewElement => new ModelElement( 'heading', { level: viewElement.getAttribute( 'data-level' ) } )
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process.
- *
- * @param {Object} config Conversion configuration.
- * @param {module:engine/view/matcher~MatcherPattern} config.view Pattern matching all view elements which should be converted.
- * @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} [priority='normal'] Converter priority.
- * @returns {Function} Conversion helper.
- */
- export function upcastElementToElement( config, priority = 'normal' ) {
- config = cloneDeep( config );
- const converter = _prepareToElementConverter( config );
- const elementName = _getViewElementNameFromConfig( config );
- const eventName = elementName ? 'element:' + elementName : 'element';
- return dispatcher => {
- dispatcher.on( eventName, converter, { priority } );
- };
- }
- /**
- * 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`.
- *
- * Keep in mind that the attribute will be set only if it is allowed by {@link module:engine/model/schema~Schema schema} configuration.
- *
- * upcastElementToAttribute( { view: 'strong', model: 'bold' } );
- *
- * upcastElementToAttribute( { view: 'strong', model: 'bold' }, 'normal' );
- *
- * upcastElementToAttribute( {
- * view: {
- * name: 'span',
- * class: 'bold'
- * },
- * model: 'bold'
- * } );
- *
- * upcastElementToAttribute( {
- * view: {
- * name: 'span',
- * class: [ 'styled', 'styled-dark' ]
- * },
- * model: {
- * key: 'styled',
- * value: 'dark'
- * }
- * } );
- *
- * upcastElementToAttribute( {
- * view: {
- * name: 'span',
- * style: {
- * 'font-size': /[\s\S]+/
- * }
- * },
- * model: {
- * key: 'fontSize',
- * value: viewElement => {
- * 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} to learn how to add converter to conversion process.
- *
- * @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} [priority='low'] Converter priority.
- * @returns {Function} Conversion helper.
- */
- export function upcastElementToAttribute( config, priority = 'low' ) {
- config = cloneDeep( config );
- _normalizeModelAttributeConfig( config );
- const converter = _prepareToAttributeConverter( config, true );
- const elementName = _getViewElementNameFromConfig( config );
- const eventName = elementName ? 'element:' + elementName : 'element';
- return dispatcher => {
- dispatcher.on( eventName, converter, { priority } );
- };
- }
- /**
- * 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.
- *
- * Keep in mind that the attribute will be set only if it is allowed by {@link module:engine/model/schema~Schema schema} configuration.
- *
- * upcastAttributeToAttribute( { view: 'src', model: 'source' } );
- *
- * upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source' } );
- *
- * upcastAttributeToAttribute( { view: { key: 'src' }, model: 'source' }, 'normal' );
- *
- * upcastAttributeToAttribute( {
- * view: {
- * key: 'data-style',
- * value: /[\s\S]+/
- * },
- * model: 'styled'
- * } );
- *
- * upcastAttributeToAttribute( {
- * view: {
- * name: 'span',
- * key: 'class',
- * value: 'styled-dark'
- * },
- * model: {
- * key: 'styled',
- * value: 'dark'
- * }
- * } );
- *
- * upcastAttributeToAttribute( {
- * view: {
- * key: 'class',
- * value: /styled-[\S]+/
- * },
- * model: {
- * key: 'styled'
- * value: viewElement => {
- * const regexp = /styled-([\S]+)/;
- * const match = viewElement.getAttribute( 'class' ).match( regexp );
- *
- * return match[ 1 ];
- * }
- * }
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process.
- *
- * @param {String|Object} config Conversion configuration. If given as a `String`, the conversion will be set for a
- * view attribute with given key. The model attribute key and value will be same as view attribute key and value.
- * @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} [priority='low'] Converter priority.
- * @returns {Function} Conversion helper.
- */
- export function upcastAttributeToAttribute( config, priority = 'low' ) {
- config = cloneDeep( config );
- let viewKey = null;
- if ( typeof config.view == 'string' || config.view.key ) {
- viewKey = _normalizeViewAttributeKeyValueConfig( config );
- }
- _normalizeModelAttributeConfig( config, viewKey );
- const converter = _prepareToAttributeConverter( config, false );
- return dispatcher => {
- dispatcher.on( 'element', converter, { priority } );
- };
- }
- /**
- * View element to model marker conversion helper.
- *
- * 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}.
- *
- * upcastElementToMarker( { view: 'marker-search', model: 'search' } );
- *
- * upcastElementToMarker( { view: 'marker-search', model: 'search' }, 'high' );
- *
- * upcastElementToMarker( {
- * view: 'marker-search',
- * model: viewElement => 'comment:' + viewElement.getAttribute( 'data-comment-id' )
- * } );
- *
- * upcastElementToMarker( {
- * view: {
- * name: 'span',
- * attribute: {
- * 'data-marker': 'search'
- * }
- * },
- * model: 'search'
- * } );
- *
- * See {@link module:engine/conversion/conversion~Conversion#for} to learn how to add converter to conversion process.
- *
- * @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} [priority='normal'] Converter priority.
- * @returns {Function} Conversion helper.
- */
- export function upcastElementToMarker( config, priority = 'normal' ) {
- config = cloneDeep( config );
- _normalizeToMarkerConfig( config );
- return upcastElementToElement( config, priority );
- }
- // 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 config.
- // @returns {String|null} View element name or `null` if name is not directly set.
- function _getViewElementNameFromConfig( config ) {
- if ( typeof config.view == 'string' ) {
- return config.view;
- }
- if ( typeof config.view == 'object' && typeof config.view.name == 'string' ) {
- return config.view.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 ) => {
- // This will be usually just one pattern but we support matchers with many patterns too.
- const match = matcher.match( data.viewItem );
- // If there is no match, this callback should not do anything.
- if ( !match ) {
- return;
- }
- // Create model element basing on config.
- const modelElement = _getModelElement( config.model, data.viewItem, conversionApi.writer );
- // Do not convert if element building function returned falsy value.
- if ( !modelElement ) {
- return;
- }
- // When element was already consumed then skip it.
- if ( !conversionApi.consumable.test( data.viewItem, match.match ) ) {
- return;
- }
- // Find allowed parent for element that we are going to insert.
- // If current parent does not allow to insert element but one of the ancestors does
- // then split nodes to allowed parent.
- const splitResult = conversionApi.splitToAllowedParent( modelElement, data.cursorPosition );
- // When there is no split result it means that we can't insert element to model tree, so let's skip it.
- if ( !splitResult ) {
- return;
- }
- // Insert element on allowed position.
- conversionApi.writer.insert( modelElement, splitResult.position );
- // Convert children and insert to element.
- const childrenResult = conversionApi.convertChildren( data.viewItem, ModelPosition.createAt( modelElement ) );
- // Consume appropriate value from consumable values list.
- conversionApi.consumable.consume( data.viewItem, match.match );
- // Set conversion result range.
- data.modelRange = new ModelRange(
- // Range should start before inserted element
- ModelPosition.createBefore( modelElement ),
- // Should end after but we need to take into consideration that children could split our
- // element, so we need to move range after parent of the last converted child.
- // before: <allowed>[]</allowed>
- // after: <allowed>[<converted><child></child></converted><child></child><converted>]</converted></allowed>
- ModelPosition.createAfter( childrenResult.cursorPosition.parent )
- );
- // Now we need to check where the cursorPosition should be.
- // If we had to split parent to insert our element then we want to continue conversion inside split parent.
- //
- // before: <allowed><notAllowed>[]</notAllowed></allowed>
- // after: <allowed><notAllowed></notAllowed><converted></converted><notAllowed>[]</notAllowed></allowed>
- if ( splitResult.cursorParent ) {
- data.cursorPosition = ModelPosition.createAt( splitResult.cursorParent );
- // Otherwise just continue after inserted element.
- } else {
- data.cursorPosition = data.modelRange.end;
- }
- };
- }
- // 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/model/writer~Writer} writer A writer instance to use to create the model element.
- function _getModelElement( model, input, writer ) {
- if ( model instanceof Function ) {
- return model( input, writer );
- } else if ( typeof model == 'string' ) {
- return writer.createElement( model );
- } else {
- return 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;
- const value = typeof config.view.value == 'undefined' ? /[\s\S]*/ : config.view.value;
- const normalized = {
- attribute: {
- [ 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' ? 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} consumeName If set to `true` converter will not consume element's name.
- function _prepareToAttributeConverter( config, consumeName ) {
- 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 ) : config.model.value;
- // Do not convert if attribute building function returned falsy value.
- if ( modelValue === null ) {
- return;
- }
- if ( !consumeName ) {
- // 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.cursorPosition ) );
- }
- // Set attribute on current `output`. `Schema` is checked inside this helper function.
- const attributeWasSet = _setAttributeOn( data.modelRange, { key: modelKey, value: modelValue }, conversionApi );
- if ( attributeWasSet ) {
- conversionApi.consumable.consume( data.viewItem, match.match );
- }
- };
- }
- // 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 {Object} conversionApi Conversion API.
- // @returns {Boolean} `true` if attribute was set on at least one node from given `modelRange`.
- function _setAttributeOn( modelRange, modelAttribute, conversionApi ) {
- let result = false;
- // Set attribute on each item in range according to Schema.
- for ( const node of Array.from( modelRange.getItems() ) ) {
- 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 _normalizeToMarkerConfig( config ) {
- const oldModel = config.model;
- config.model = ( viewElement, writer ) => {
- const markerName = typeof oldModel == 'string' ? oldModel : oldModel( viewElement );
- return writer.createElement( '$marker', { 'data-name': markerName } );
- };
- }
- /**
- * 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, conversionApi ) => {
- if ( conversionApi.schema.checkChild( data.modelCursor, '$text' ) ) {
- if ( conversionApi.consumable.consume( data.viewItem ) ) {
- const text = conversionApi.writer.createText( data.viewItem.data );
- conversionApi.writer.insert( text, data.modelCursor );
- data.modelRange = ModelRange.createFromPositionAndShift( data.modelCursor, text.offsetSize );
- data.modelCursor = data.modelRange.end;
- }
- }
- };
- }
|