datacontroller.js 6.7 KB

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