datacontroller.js 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. 'use strict';
  6. import Mapper from './conversion/mapper.js';
  7. import ModelConversionDispatcher from './conversion/modelconversiondispatcher.js';
  8. import { insertText } from './conversion/model-to-view-converters.js';
  9. import ViewConversionDispatcher from './conversion/viewconversiondispatcher.js';
  10. import { convertText, convertToModelFragment } from './conversion/view-to-model-converters.js';
  11. import ViewDocumentFragment from './view/documentfragment.js';
  12. import DomConverter from './view/domconverter.js';
  13. import { NBSP_FILLER } from './view/filler.js';
  14. import ModelRange from './model/range.js';
  15. import ModelPosition from './model/position.js';
  16. /**
  17. * Controller for the data pipeline. The data pipeline controls how data is retrieved from the document
  18. * and set inside it. Hence, the controller features two methods which allow to {@link engine.DataController#get get}
  19. * and {@link engine.DataController#set set} data of the {@link engine.DataController#model model}
  20. * using given:
  21. *
  22. * * {@link engine.dataProcessor.DataProcessor data processor},
  23. * * {@link engine.conversion.ModelConversionDispatcher model to view} and
  24. * {@link engine.conversion.ViewConversionDispatcher view to model} converters.
  25. *
  26. * @memberOf engine
  27. */
  28. export default class DataController {
  29. /**
  30. * Creates data controller instance.
  31. *
  32. * @param {engine.model.Document} model Document model.
  33. * @param {engine.dataProcessor.DataProcessor} [dataProcessor] Data processor which should used by the controller.
  34. */
  35. constructor( model, dataProcessor ) {
  36. /**
  37. * Document model.
  38. *
  39. * @readonly
  40. * @member {engine.model.document} engine.DataController#model
  41. */
  42. this.model = model;
  43. /**
  44. * Data processor used during the conversion.
  45. *
  46. * @readonly
  47. * @member {engine.dataProcessor.DataProcessor} engine.DataController#processor
  48. */
  49. this.processor = dataProcessor;
  50. /**
  51. * Mapper used for the conversion. It has no permanent bindings, because they are created when getting data and
  52. * cleared directly after data are converted. However, the mapper is defined as class property, because
  53. * it needs to be passed to the `ModelConversionDispatcher` as a conversion API.
  54. *
  55. * @private
  56. * @member {engine.conversion.Mapper} engine.DataController#_mapper
  57. */
  58. this._mapper = new Mapper();
  59. /**
  60. * DOM converter used during the conversion.
  61. *
  62. * @private
  63. * @member {engine.view.DomConverter} engine.DataController#_domConverter
  64. */
  65. this._domConverter = new DomConverter( { blockFiller: NBSP_FILLER } );
  66. /**
  67. * Model to view conversion dispatcher used by the {@link engine.DataController#get get method}.
  68. * To attach model to view converter to the data pipeline you need to add lister to this property:
  69. *
  70. * data.modelToView( 'insert:$element', customInsertConverter );
  71. *
  72. * Or use {@link engine.conversion.ModelConverterBuilder}:
  73. *
  74. * BuildModelConverterFor( data.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
  75. *
  76. * @readonly
  77. * @member {engine.conversion.ModelConversionDispatcher} engine.DataController#modelToView
  78. */
  79. this.modelToView = new ModelConversionDispatcher( {
  80. mapper: this._mapper
  81. } );
  82. this.modelToView.on( 'insert:$text', insertText() );
  83. /**
  84. * View to model conversion dispatcher used by the {@link engine.DataController#set set method}.
  85. * To attach view to model converter to the data pipeline you need to add lister to this property:
  86. *
  87. * data.viewToModel( 'element', customElementConverter );
  88. *
  89. * Or use {@link engine.conversion.ViewConverterBuilder}:
  90. *
  91. * BuildViewConverterFor( data.viewToModel ).fromElement( 'b' ).toAttribute( 'bold', 'true' );
  92. *
  93. * @readonly
  94. * @member {engine.conversion.ViewConversionDispatcher} engine.DataController#viewToModel
  95. */
  96. this.viewToModel = new ViewConversionDispatcher( {
  97. schema: model.schema
  98. } );
  99. // Define default converters for text and elements.
  100. //
  101. // Note that if there is no default converter for the element it will be skipped, for instance `<b>foo</b>` will be
  102. // converted to nothing. We add `convertToModelFragment` as a last converter so it converts children of that
  103. // element to the document fragment so `<b>foo</b>` will be converted to `foo` if there is no converter for `<b>`.
  104. this.viewToModel.on( 'text', convertText() );
  105. this.viewToModel.on( 'element', convertToModelFragment(), null, 9999 );
  106. this.viewToModel.on( 'documentFragment', convertToModelFragment(), null, 9999 );
  107. }
  108. /**
  109. * Returns model's data converted by the {@link engine.DataController#modelToView model to view converters} and
  110. * formatted by the {@link engine.DataController#processor data processor}.
  111. *
  112. * @param {String} [rootName='main'] Root name.
  113. * @returns {String} Output data.
  114. */
  115. get( rootName = 'main' ) {
  116. // Get model range.
  117. const modelRoot = this.model.getRoot( rootName );
  118. const modelRange = ModelRange.createFromElement( modelRoot );
  119. // model -> view.
  120. const viewDocumentFragment = new ViewDocumentFragment();
  121. this._mapper.bindElements( modelRoot, viewDocumentFragment );
  122. this.modelToView.convertInsert( modelRange );
  123. this._mapper.clearBindings();
  124. // view -> DOM.
  125. const domDocumentFragment = this._domConverter.viewToDom( viewDocumentFragment, document );
  126. // DOM -> data.
  127. return this.processor.toData( domDocumentFragment );
  128. }
  129. /**
  130. * Sets input data parsed by the {@link engine.DataController#processor data processor} and
  131. * converted by the {@link engine.DataController#viewToModel view to model converters}.
  132. *
  133. * This method also creates a batch with all the changes applied. If all you need is to parse data use
  134. * the {@link engine.dataController#parse} method.
  135. *
  136. * @param {String} data Input data.
  137. * @param {String} [rootName='main'] Root name.
  138. */
  139. set( data, rootName = 'main' ) {
  140. // Save to model.
  141. const modelRoot = this.model.getRoot( rootName );
  142. this.model.enqueueChanges( () => {
  143. // Initial batch should be ignored by features like undo, etc.
  144. this.model.batch( 'transparent' )
  145. .remove( ModelRange.createFromElement( modelRoot ) )
  146. .insert( ModelPosition.createAt( modelRoot, 0 ), this.parse( data ) );
  147. } );
  148. }
  149. /**
  150. * Returns data parsed by the {@link engine.DataController#processor data processor} and then
  151. * converted by the {@link engine.DataController#viewToModel view to model converters}.
  152. *
  153. * @see engine.DataController#set
  154. * @param {String} data Data to parse.
  155. * @returns {engine.model.DocumentFragment} Parsed data.
  156. */
  157. parse( data ) {
  158. // data -> DOM.
  159. const domDocumentFragment = this.processor.toDom( data );
  160. // DOM -> view.
  161. const viewDocumentFragment = this._domConverter.domToView( domDocumentFragment );
  162. // view -> model.
  163. const modelDocumentFragment = this.viewToModel.convert( viewDocumentFragment, { context: [ '$root' ] } );
  164. return modelDocumentFragment;
  165. }
  166. /**
  167. * Removes all event listeners set by the DataController.
  168. */
  169. destroy() {}
  170. }