8
0

model.js 15 KB

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