model.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Mapper from '/ckeditor5/engine/conversion/mapper.js';
  6. import { parse as viewParse, stringify as viewStringify } from '/tests/engine/_utils/view.js';
  7. import {
  8. convertRangeSelection,
  9. convertCollapsedSelection,
  10. convertSelectionAttribute
  11. } from '/ckeditor5/engine/conversion/model-selection-to-view-converters.js';
  12. import { insertText, insertElement, wrap } from '/ckeditor5/engine/conversion/model-to-view-converters.js';
  13. import RootElement from '/ckeditor5/engine/model/rootelement.js';
  14. import ModelDocument from '/ckeditor5/engine/model/document.js';
  15. import ModelRange from '/ckeditor5/engine/model/range.js';
  16. import ModelPosition from '/ckeditor5/engine/model/position.js';
  17. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  18. import ModelSelection from '/ckeditor5/engine/model/selection.js';
  19. import ModelDocumentFragment from '/ckeditor5/engine/model/documentfragment.js';
  20. import ModelElement from '/ckeditor5/engine/model/element.js';
  21. import ModelText from '/ckeditor5/engine/model/text.js';
  22. import ModelTextProxy from '/ckeditor5/engine/model/textproxy.js';
  23. import modelWriter from '/ckeditor5/engine/model/writer.js';
  24. import ViewConversionDispatcher from '/ckeditor5/engine/conversion/viewconversiondispatcher.js';
  25. import ViewSelection from '/ckeditor5/engine/view/selection.js';
  26. import ViewDocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  27. import ViewElement from '/ckeditor5/engine/view/containerelement.js';
  28. import ViewAttributeElement from '/ckeditor5/engine/view/attributeelement.js';
  29. /**
  30. * Writes the contents of the {@link engine.model.Document Document} to an HTML-like string.
  31. *
  32. * ** Note: ** {@link engine.model.Text text} node contains attributes will be represented as:
  33. * <$text attribute="value">Text data</$text>
  34. *
  35. * @param {engine.model.Document} document
  36. * @param {Object} [options]
  37. * @param {Boolean} [options.withoutSelection=false] Whether to write the selection. When set to `true` selection will
  38. * be not included in returned string.
  39. * @param {Boolean} [options.rootName='main'] Name of the root from which data should be stringified. If not provided
  40. * default `main` name will be used.
  41. * @returns {String} The stringified data.
  42. */
  43. export function getData( document, options = {} ) {
  44. if ( !( document instanceof ModelDocument ) ) {
  45. throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
  46. }
  47. const withoutSelection = !!options.withoutSelection;
  48. const rootName = options.rootName || 'main';
  49. const root = document.getRoot( rootName );
  50. return withoutSelection ? getData._stringify( root ) : getData._stringify( root, document.selection );
  51. }
  52. // Set stringify as getData private method - needed for testing/spying.
  53. getData._stringify = stringify;
  54. /**
  55. * Sets the contents of the {@link engine.model.Document Document} provided as HTML-like string.
  56. * It uses {@link engine.model.Document#enqueueChanges enqueueChanges} method.
  57. *
  58. * ** Note: ** Remember to register elements in {@link engine.model.Document#schema document's schema} before inserting them.
  59. *
  60. * ** Note: ** To create {@link engine.model.Text text} node witch containing attributes use:
  61. * <$text attribute="value">Text data</$text>
  62. *
  63. * @param {engine.model.Document} document
  64. * @param {String} data HTML-like string to write into Document.
  65. * @param {Object} options
  66. * @param {String} [options.rootName='main'] Root name where parsed data will be stored. If not provided, default `main`
  67. * name will be used.
  68. * @param {Array<Object>} [options.selectionAttributes] List of attributes which will be passed to the selection.
  69. * @param {Boolean} [options.lastRangeBackward=false] If set to true last range will be added as backward.
  70. * @param {String} [options.batchType='transparent'] Batch type used for inserting elements. See {@link engine.model.Batch#type}.
  71. */
  72. export function setData( document, data, options = {} ) {
  73. if ( !( document instanceof ModelDocument ) ) {
  74. throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
  75. }
  76. let modelDocumentFragment, selection;
  77. const modelRoot = document.getRoot( options.rootName || 'main' );
  78. // Parse data string to model.
  79. const parsedResult = setData._parse( data, document.schema, {
  80. lastRangeBackward: options.lastRangeBackward,
  81. selectionAttributes: options.selectionAttributes
  82. } );
  83. // Retrieve DocumentFragment and Selection from parsed model.
  84. if ( parsedResult.model ) {
  85. modelDocumentFragment = parsedResult.model;
  86. selection = parsedResult.selection;
  87. } else {
  88. modelDocumentFragment = parsedResult;
  89. }
  90. document.enqueueChanges( () => {
  91. // Replace existing model in document by new one.
  92. document.batch( options.batchType || 'transparent' )
  93. .remove( ModelRange.createIn( modelRoot ) )
  94. .insert( ModelPosition.createAt( modelRoot, 0 ), modelDocumentFragment );
  95. // Clean up previous document selection.
  96. document.selection.clearAttributes();
  97. document.selection.removeAllRanges();
  98. // Update document selection if specified.
  99. if ( selection ) {
  100. const ranges = [];
  101. for ( let range of selection.getRanges() ) {
  102. let start, end;
  103. // Each range returned from `parse()` method has its root placed in DocumentFragment.
  104. // Here we convert each range to have its root re-calculated properly and be placed inside
  105. // model document root.
  106. if ( range.start.parent instanceof ModelDocumentFragment ) {
  107. start = ModelPosition.createFromParentAndOffset( modelRoot, range.start.offset );
  108. } else {
  109. start = ModelPosition.createFromParentAndOffset( range.start.parent, range.start.offset );
  110. }
  111. if ( range.end.parent instanceof ModelDocumentFragment ) {
  112. end = ModelPosition.createFromParentAndOffset( modelRoot, range.end.offset );
  113. } else {
  114. end = ModelPosition.createFromParentAndOffset( range.end.parent, range.end.offset );
  115. }
  116. ranges.push( new ModelRange( start, end ) );
  117. }
  118. document.selection.setRanges( ranges, selection.isBackward );
  119. document.selection.setAttributesTo( selection.getAttributes() );
  120. }
  121. } );
  122. }
  123. // Set parse as setData private method - needed for testing/spying.
  124. setData._parse = parse;
  125. /**
  126. * Converts model nodes to HTML-like string representation.
  127. *
  128. * ** Note: ** {@link engine.model.Text text} node contains attributes will be represented as:
  129. * <$text attribute="value">Text data</$text>
  130. *
  131. * @param {engine.model.RootElement|engine.model.Element|engine.model.Text|
  132. * engine.model.DocumentFragment} node Node to stringify.
  133. * @param {engine.model.Selection|engine.model.Position|engine.model.Range} [selectionOrPositionOrRange=null]
  134. * Selection instance which ranges will be included in returned string data. If Range instance is provided - it will be
  135. * converted to selection containing this range. If Position instance is provided - it will be converted to selection
  136. * containing one range collapsed at this position.
  137. * @returns {String} HTML-like string representing the model.
  138. */
  139. export function stringify( node, selectionOrPositionOrRange = null ) {
  140. const mapper = new Mapper();
  141. let selection, range;
  142. // Create a range witch wraps passed node.
  143. if ( node instanceof RootElement || node instanceof ModelDocumentFragment ) {
  144. range = ModelRange.createIn( node );
  145. } else {
  146. // Node is detached - create new document fragment.
  147. if ( !node.parent ) {
  148. const fragment = new ModelDocumentFragment( node );
  149. range = ModelRange.createIn( fragment );
  150. } else {
  151. range = new ModelRange(
  152. ModelPosition.createBefore( node ),
  153. ModelPosition.createAfter( node )
  154. );
  155. }
  156. }
  157. // Get selection from passed selection or position or range if at least one is specified.
  158. if ( selectionOrPositionOrRange instanceof ModelSelection ) {
  159. selection = selectionOrPositionOrRange;
  160. } else if ( selectionOrPositionOrRange instanceof ModelRange ) {
  161. selection = new ModelSelection();
  162. selection.addRange( selectionOrPositionOrRange );
  163. } else if ( selectionOrPositionOrRange instanceof ModelPosition ) {
  164. selection = new ModelSelection();
  165. selection.addRange( new ModelRange( selectionOrPositionOrRange, selectionOrPositionOrRange ) );
  166. }
  167. // Setup model to view converter.
  168. const viewDocumentFragment = new ViewDocumentFragment();
  169. const viewSelection = new ViewSelection();
  170. const modelToView = new ModelConversionDispatcher( { mapper, viewSelection } );
  171. // Bind root elements.
  172. mapper.bindElements( node.root, viewDocumentFragment );
  173. modelToView.on( 'insert:$text', insertText(), 'lowest' );
  174. modelToView.on( 'addAttribute', wrap( ( value, data ) => {
  175. if ( data.item instanceof ModelTextProxy ) {
  176. return new ViewAttributeElement( 'model-text-with-attributes', { [ data.attributeKey ]: value } );
  177. }
  178. } ), 'lowest' );
  179. modelToView.on( 'insert', insertElement( data => new ViewElement( data.item.name, data.item.getAttributes() ) ), 'lowest' );
  180. modelToView.on( 'selection', convertRangeSelection(), 'lowest' );
  181. modelToView.on( 'selection', convertCollapsedSelection(), 'lowest' );
  182. modelToView.on( 'selectionAttribute', convertSelectionAttribute( ( value, data ) => {
  183. return new ViewAttributeElement( 'model-text-with-attributes', { [ data.key ]: value } );
  184. } ), 'lowest' );
  185. // Convert model to view.
  186. modelToView.convertInsertion( range );
  187. // Convert model selection to view selection.
  188. if ( selection ) {
  189. modelToView.convertSelection( selection );
  190. }
  191. // Parse view to data string.
  192. let data = viewStringify( viewDocumentFragment, viewSelection, { sameSelectionCharacters: true } );
  193. // Replace valid XML `model-text-with-attributes` element name to `$text`.
  194. return data.replace( new RegExp( 'model-text-with-attributes', 'g' ), '$text' );
  195. }
  196. /**
  197. * Parses HTML-like string and returns model {@link engine.model.RootElement rootElement}.
  198. *
  199. * ** Note: ** To create {@link engine.model.Text text} node witch containing attributes use:
  200. * <$text attribute="value">Text data</$text>
  201. *
  202. * @param {String} data HTML-like string to be parsed.
  203. * @param {engine.model.schema} schema Schema instance uses by converters for element validation.
  204. * @param {Object} options Additional configuration.
  205. * @param {Array<Object>} [options.selectionAttributes] List of attributes which will be passed to the selection.
  206. * @param {Boolean} [options.lastRangeBackward=false] If set to true last range will be added as backward.
  207. * @returns {engine.model.Element|engine.model.Text|engine.model.DocumentFragment|Object} Returns parsed model node or
  208. * object with two fields `model` and `selection` when selection ranges were included in data to parse.
  209. */
  210. export function parse( data, schema, options = {} ) {
  211. const mapper = new Mapper();
  212. // Replace not accepted by XML `$text` tag name by valid one `model-text-with-attributes`.
  213. data = data.replace( new RegExp( '\\$text', 'g' ), 'model-text-with-attributes' );
  214. // Parse data to view using view utils.
  215. const parsedResult = viewParse( data, {
  216. sameSelectionCharacters: true,
  217. lastRangeBackward: !!options.lastRangeBackward
  218. } );
  219. // Retrieve DocumentFragment and Selection from parsed view.
  220. let viewDocumentFragment, viewSelection;
  221. if ( parsedResult.view && parsedResult.selection ) {
  222. viewDocumentFragment = parsedResult.view;
  223. viewSelection = parsedResult.selection;
  224. } else {
  225. viewDocumentFragment = parsedResult;
  226. }
  227. // Setup view to model converter.
  228. const viewToModel = new ViewConversionDispatcher( { schema, mapper } );
  229. viewToModel.on( 'documentFragment', convertToModelFragment(), 'lowest' );
  230. viewToModel.on( `element:model-text-with-attributes`, convertToModelText( true ), 'lowest' );
  231. viewToModel.on( 'element', convertToModelElement(), 'lowest' );
  232. viewToModel.on( 'text', convertToModelText(), 'lowest' );
  233. // Convert view to model.
  234. let model = viewToModel.convert( viewDocumentFragment.root, { context: [ '$root' ] } );
  235. // If root DocumentFragment contains only one element - return that element.
  236. if ( model instanceof ModelDocumentFragment && model.childCount == 1 ) {
  237. model = model.getChild( 0 );
  238. }
  239. // Convert view selection to model selection.
  240. let selection;
  241. if ( viewSelection ) {
  242. const ranges = [];
  243. // Convert ranges.
  244. for ( let viewRange of viewSelection.getRanges() ) {
  245. ranges.push( ( mapper.toModelRange( viewRange ) ) );
  246. }
  247. // Create new selection.
  248. selection = new ModelSelection();
  249. selection.setRanges( ranges, viewSelection.isBackward );
  250. // Set attributes to selection if specified.
  251. if ( options.selectionAttributes ) {
  252. selection.setAttributesTo( options.selectionAttributes );
  253. }
  254. }
  255. // Return model end selection when selection was specified.
  256. if ( selection ) {
  257. return { model, selection };
  258. }
  259. // Otherwise return model only.
  260. return model;
  261. }
  262. // -- converters view -> model -----------------------------------------------------
  263. function convertToModelFragment() {
  264. return ( evt, data, consumable, conversionApi ) => {
  265. // Second argument in `consumable.test` is discarded for ViewDocumentFragment but is needed for ViewElement.
  266. if ( !data.output && consumable.test( data.input, { name: true } ) ) {
  267. const convertedChildren = conversionApi.convertChildren( data.input, consumable, data );
  268. data.output = new ModelDocumentFragment( modelWriter.normalizeNodes( convertedChildren ) );
  269. conversionApi.mapper.bindElements( data.output, data.input );
  270. }
  271. evt.stop();
  272. };
  273. }
  274. function convertToModelElement() {
  275. return ( evt, data, consumable, conversionApi ) => {
  276. const schemaQuery = {
  277. name: data.input.name,
  278. inside: data.context
  279. };
  280. if ( !conversionApi.schema.check( schemaQuery ) ) {
  281. throw new Error( `Element '${ schemaQuery.name }' not allowed in context.` );
  282. }
  283. if ( consumable.consume( data.input, { name: true } ) ) {
  284. data.output = new ModelElement( data.input.name, data.input.getAttributes() );
  285. conversionApi.mapper.bindElements( data.output, data.input );
  286. data.context.push( data.output );
  287. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, data ) );
  288. data.context.pop();
  289. }
  290. evt.stop();
  291. };
  292. }
  293. function convertToModelText( withAttributes = false ) {
  294. return ( evt, data, consumable, conversionApi ) => {
  295. const schemaQuery = {
  296. name: '$text',
  297. inside: data.context
  298. };
  299. if ( !conversionApi.schema.check( schemaQuery ) ) {
  300. throw new Error( `Element '${ schemaQuery.name }' not allowed in context.` );
  301. }
  302. if ( conversionApi.schema.check( schemaQuery ) ) {
  303. if ( consumable.consume( data.input, { name: true } ) ) {
  304. let node;
  305. if ( withAttributes ) {
  306. node = new ModelText( data.input.getChild( 0 ).data, data.input.getAttributes() );
  307. } else {
  308. node = new ModelText( data.input.data );
  309. }
  310. data.output = node;
  311. }
  312. }
  313. evt.stop();
  314. };
  315. }