model.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
  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 Document from '/ckeditor5/engine/model/document.js';
  7. import Range from '/ckeditor5/engine/model/range.js';
  8. import Position from '/ckeditor5/engine/model/position.js';
  9. import RootElement from '/ckeditor5/engine/model/rootelement.js';
  10. import ModelConversionDispatcher from '/ckeditor5/engine/conversion/modelconversiondispatcher.js';
  11. import ModelSelection from '/ckeditor5/engine/model/selection.js';
  12. import ModelDocumentFragment from '/ckeditor5/engine/model/documentfragment.js';
  13. import ModelElement from '/ckeditor5/engine/model/element.js';
  14. import ModelText from '/ckeditor5/engine/model/text.js';
  15. import modelWriter from '/ckeditor5/engine/model/writer.js';
  16. import ViewConversionDispatcher from '/ckeditor5/engine/conversion/viewconversiondispatcher.js';
  17. import ViewSelection from '/ckeditor5/engine/view/selection.js';
  18. import ViewDocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  19. import ViewElement from '/ckeditor5/engine/view/containerelement.js';
  20. import viewWriter from '/ckeditor5/engine/view/writer.js';
  21. import { parse as viewParse, stringify as viewStringify } from '/tests/engine/_utils/view.js';
  22. import { convertRangeSelection, convertCollapsedSelection } from '/ckeditor5/engine/conversion/model-selection-to-view-converters.js';
  23. import { insertText } from '/ckeditor5/engine/conversion/model-to-view-converters.js';
  24. import { convertText as convertToModelText } from '/ckeditor5/engine/conversion/view-to-model-converters.js';
  25. let mapper;
  26. /**
  27. * Writes the contents of the {@link engine.model.Document Document} to an HTML-like string.
  28. *
  29. * @param {engine.model.Document} document
  30. * @param {Object} [options]
  31. * @param {Boolean} [options.withoutSelection=false] Whether to write the selection. When set to `true` selection will
  32. * be not included in returned string.
  33. * @param {Boolean} [options.rootName='main'] Name of the root from which data should be stringified. If not provided
  34. * default `main` name will be used.
  35. * @returns {String} The stringified data.
  36. */
  37. export function getData( document, options = {} ) {
  38. if ( !( document instanceof Document ) ) {
  39. throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
  40. }
  41. const withoutSelection = !!options.withoutSelection;
  42. const rootName = options.rootName || 'main';
  43. const root = document.getRoot( rootName );
  44. return withoutSelection ? getData._stringify( root ) : getData._stringify( root, document.selection );
  45. }
  46. // Set stringify as getData private method - needed for testing/spying.
  47. getData._stringify = stringify;
  48. /**
  49. * Sets the contents of the {@link engine.model.Document Document} provided as HTML-like string.
  50. * It uses {@link engine.model.Document#enqueueChanges enqueueChanges} method.
  51. *
  52. * NOTE:
  53. * Remember to register elements in {@link engine.model.Document#schema document's schema} before inserting them.
  54. *
  55. * @param {engine.model.Document} document
  56. * @param {String} data HTML-like string to write into Document.
  57. * @param {Object} options
  58. * @param {String} [options.rootName='main'] Root name where parsed data will be stored. If not provided, default `main`
  59. * name will be used.
  60. * @param {Array<Object>} [options.selectionAttributes] List of attributes which will be passed to selection.
  61. * @param {String} [options.batchType='transparent'] Batch type used for inserting elements. See {@link engine.model.Batch#type}.
  62. */
  63. export function setData( document, data, options = {} ) {
  64. if ( !( document instanceof Document ) ) {
  65. throw new TypeError( 'Document needs to be an instance of engine.model.Document.' );
  66. }
  67. let model, selection;
  68. const parseResult = setData._parse( data, document.schema );
  69. if ( parseResult.model ) {
  70. model = parseResult.model;
  71. selection = parseResult.selection;
  72. } else {
  73. model = parseResult;
  74. }
  75. // Save to model.
  76. const modelRoot = document.getRoot( options.rootName || 'main' );
  77. document.enqueueChanges( () => {
  78. document.batch( options.batchType || 'transparent' )
  79. .remove( Range.createIn( modelRoot ) )
  80. .insert( Position.createAt( modelRoot, 0 ), model );
  81. // Clear selection
  82. document.selection.clearAttributes();
  83. document.selection.removeAllRanges();
  84. if ( selection ) {
  85. const ranges = [];
  86. for ( let viewRange of selection.getRanges() ) {
  87. ranges.push( ( mapper.toModelRange( viewRange ) ) );
  88. }
  89. document.selection.setRanges( ranges, selection.isBackward );
  90. if ( options.selectionAttributes ) {
  91. // Something overwrites selection attributes ??!!
  92. document.selection.setAttributesTo( options.selectionAttributes );
  93. }
  94. }
  95. } );
  96. }
  97. // Set parse as setData private method - needed for testing/spying.
  98. setData._parse = parse;
  99. /**
  100. * Converts model nodes to HTML-like string representation.
  101. *
  102. * @param {engine.model.RootElement|engine.model.Element|engine.model.Text|
  103. * engine.model.DocumentFragment} node Node to stringify.
  104. * @param {engine.model.Selection|engine.model.Position|engine.model.Range} [selectionOrPositionOrRange=null]
  105. * Selection instance which ranges will be included in returned string data. If Range instance is provided - it will be
  106. * converted to selection containing this range. If Position instance is provided - it will be converted to selection
  107. * containing one range collapsed at this position.
  108. * @returns {String} HTML-like string representing the model.
  109. */
  110. export function stringify( node, selectionOrPositionOrRange = null ) {
  111. mapper = new Mapper();
  112. let selection, range;
  113. // Create a range wrapping passed node.
  114. if ( node instanceof RootElement || node instanceof ModelDocumentFragment ) {
  115. range = Range.createFromElement( node );
  116. } else {
  117. // Node is detached - create new document fragment.
  118. if ( !node.parent ) {
  119. const fragment = new ModelDocumentFragment( node );
  120. range = Range.createFromElement( fragment );
  121. } else {
  122. range = new Range(
  123. Position.createBefore( node ),
  124. Position.createAfter( node )
  125. );
  126. }
  127. }
  128. if ( selectionOrPositionOrRange instanceof ModelSelection ) {
  129. selection = selectionOrPositionOrRange;
  130. } else if ( selectionOrPositionOrRange instanceof Range ) {
  131. selection = new ModelSelection();
  132. selection.addRange( selectionOrPositionOrRange );
  133. } else if ( selectionOrPositionOrRange instanceof Position ) {
  134. selection = new ModelSelection();
  135. selection.addRange( new Range( selectionOrPositionOrRange, selectionOrPositionOrRange ) );
  136. }
  137. // Setup model -> view converter.
  138. const viewDocumentFragment = new ViewDocumentFragment();
  139. const viewSelection = new ViewSelection();
  140. const modelToView = new ModelConversionDispatcher( { mapper, viewSelection } );
  141. modelToView.on( 'insert:$text', insertText() );
  142. modelToView.on( 'insert', insertElement() );
  143. modelToView.on( 'selection', convertRangeSelection() );
  144. modelToView.on( 'selection', convertCollapsedSelection() );
  145. mapper.bindElements( node, viewDocumentFragment );
  146. // Convert view to model.
  147. modelToView.convertInsert( range );
  148. modelToView.convertSelection( selection );
  149. mapper.clearBindings();
  150. // Return parsed to data model.
  151. return viewStringify( viewDocumentFragment, viewSelection );
  152. }
  153. /**
  154. * Parses HTML-like string and returns model {@link engine.model.RootElement rootElement}.
  155. *
  156. * @param {String} data HTML-like string to be parsed.
  157. * @param {engine.model.Schema} schema Document schema.
  158. * @returns {engine.model.Element|engine.model.Text|engine.model.DocumentFragment|Object} Returns parsed model node or
  159. * object with two fields `model` and `selection` when selection ranges were included in data to parse.
  160. */
  161. export function parse( data, schema ) {
  162. mapper = new Mapper();
  163. // Parse data to view using view utils.
  164. const view = viewParse( data );
  165. // Retrieve DocumentFragment and Selection from parsed view.
  166. let viewDocumentFragment, selection;
  167. if ( view.view && view.selection ) {
  168. viewDocumentFragment = view.view;
  169. selection = view.selection;
  170. } else {
  171. viewDocumentFragment = view;
  172. }
  173. viewDocumentFragment = viewDocumentFragment.parent ? viewDocumentFragment.parent : viewDocumentFragment;
  174. // Setup view -> model converter.
  175. const viewToModel = new ViewConversionDispatcher( { schema } );
  176. viewToModel.on( 'text', convertToModelText() );
  177. viewToModel.on( 'element:model-text', convertToModelTextWithAttributes(), null, 9999 );
  178. viewToModel.on( 'element', convertToModelElement(), null, 9999 );
  179. viewToModel.on( 'documentFragment', convertToModelFragment(), null, 9999 );
  180. // Convert view to model.
  181. let root = viewToModel.convert( viewDocumentFragment, { context: [ '$root' ] } );
  182. // If root DocumentFragment contains only one element - return that element.
  183. if ( root instanceof DocumentFragment && root.childCount == 1 ) {
  184. root = root.getChild( 0 );
  185. }
  186. // Return model end selection when selection was specified.
  187. if ( selection ) {
  188. return {
  189. model: root,
  190. selection: selection
  191. };
  192. }
  193. // Otherwise return model only.
  194. return root;
  195. }
  196. // -- converters view -> model -----------------------------------------------------
  197. function convertToModelFragment() {
  198. return ( evt, data, consumable, conversionApi ) => {
  199. // Second argument in `consumable.test` is discarded for ViewDocumentFragment but is needed for ViewElement.
  200. if ( !data.output && consumable.test( data.input, { name: true } ) ) {
  201. const convertedChildren = conversionApi.convertChildren( data.input, consumable, data );
  202. data.output = new ModelDocumentFragment( modelWriter.normalizeNodes( convertedChildren ) );
  203. mapper.bindElements( data.output, data.input );
  204. }
  205. };
  206. }
  207. function convertToModelElement() {
  208. return ( evt, data, consumable, conversionApi ) => {
  209. if ( consumable.consume( data.input, { name: true } ) ) {
  210. data.output = new ModelElement( data.input.name, data.input.getAttributes() );
  211. mapper.bindElements( data.output, data.input );
  212. data.context.push( data.output );
  213. data.output.appendChildren( conversionApi.convertChildren( data.input, consumable, data ) );
  214. data.context.pop();
  215. }
  216. };
  217. }
  218. function convertToModelTextWithAttributes() {
  219. return ( evt, data, consumable ) => {
  220. if ( consumable.consume( data.input, { name: true } ) ) {
  221. data.output = new ModelText( data.input.getChild( 0 ).data, data.input.getAttributes() );
  222. }
  223. };
  224. }
  225. // -- converters model -> view -----------------------------------------------------
  226. function insertElement() {
  227. return ( evt, data, consumable, conversionApi ) => {
  228. consumable.consume( data.item, 'insert' );
  229. const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
  230. const viewElement = new ViewElement( data.item.name, data.item.getAttributes() );
  231. conversionApi.mapper.bindElements( data.item, viewElement );
  232. viewWriter.insert( viewPosition, viewElement );
  233. evt.stop();
  234. };
  235. }