8
0

model.js 11 KB

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