downcast-selection-converters.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601
  1. /**
  2. * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Model from '../../src/model/model';
  6. import ModelElement from '../../src/model/element';
  7. import ModelRange from '../../src/model/range';
  8. import ModelPosition from '../../src/model/position';
  9. import View from '../../src/view/view';
  10. import ViewUIElement from '../../src/view/uielement';
  11. import Mapper from '../../src/conversion/mapper';
  12. import DowncastDispatcher from '../../src/conversion/downcastdispatcher';
  13. import {
  14. convertRangeSelection,
  15. convertCollapsedSelection,
  16. clearAttributes,
  17. } from '../../src/conversion/downcast-selection-converters';
  18. import {
  19. insertElement,
  20. insertText,
  21. wrap,
  22. highlightElement,
  23. highlightText,
  24. removeHighlight
  25. } from '../../src/conversion/downcast-converters';
  26. import createViewRoot from '../view/_utils/createroot';
  27. import { stringify as stringifyView } from '../../src/dev-utils/view';
  28. import { setData as setModelData } from '../../src/dev-utils/model';
  29. describe( 'downcast-selection-converters', () => {
  30. let dispatcher, mapper, model, view, modelDoc, modelRoot, docSelection, viewDoc, viewRoot, viewSelection, highlightDescriptor;
  31. beforeEach( () => {
  32. model = new Model();
  33. modelDoc = model.document;
  34. modelRoot = modelDoc.createRoot();
  35. docSelection = modelDoc.selection;
  36. model.schema.extend( '$text', { allowIn: '$root' } );
  37. view = new View();
  38. viewDoc = view.document;
  39. viewRoot = createViewRoot( viewDoc );
  40. viewSelection = viewDoc.selection;
  41. mapper = new Mapper();
  42. mapper.bindElements( modelRoot, viewRoot );
  43. highlightDescriptor = { classes: 'marker', priority: 1 };
  44. dispatcher = new DowncastDispatcher( { mapper, viewSelection } );
  45. dispatcher.on( 'insert:$text', insertText() );
  46. const strongCreator = ( modelAttributeValue, viewWriter ) => viewWriter.createAttributeElement( 'strong' );
  47. dispatcher.on( 'attribute:bold', wrap( strongCreator ) );
  48. dispatcher.on( 'addMarker:marker', highlightText( highlightDescriptor ) );
  49. dispatcher.on( 'addMarker:marker', highlightElement( highlightDescriptor ) );
  50. dispatcher.on( 'removeMarker:marker', removeHighlight( highlightDescriptor ) );
  51. // Default selection converters.
  52. dispatcher.on( 'selection', clearAttributes(), { priority: 'low' } );
  53. dispatcher.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  54. dispatcher.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  55. } );
  56. afterEach( () => {
  57. view.destroy();
  58. } );
  59. describe( 'default converters', () => {
  60. describe( 'range selection', () => {
  61. it( 'in same container', () => {
  62. test(
  63. [ 1, 4 ],
  64. 'foobar',
  65. 'f{oob}ar'
  66. );
  67. } );
  68. it( 'in same container with unicode characters', () => {
  69. test(
  70. [ 2, 6 ],
  71. 'நிலைக்கு',
  72. 'நி{லைக்}கு'
  73. );
  74. } );
  75. it( 'in same container, over attribute', () => {
  76. test(
  77. [ 1, 5 ],
  78. 'fo<$text bold="true">ob</$text>ar',
  79. 'f{o<strong>ob</strong>a}r'
  80. );
  81. } );
  82. it( 'in same container, next to attribute', () => {
  83. test(
  84. [ 1, 2 ],
  85. 'fo<$text bold="true">ob</$text>ar',
  86. 'f{o}<strong>ob</strong>ar'
  87. );
  88. } );
  89. it( 'in same attribute', () => {
  90. test(
  91. [ 2, 4 ],
  92. 'f<$text bold="true">ooba</$text>r',
  93. 'f<strong>o{ob}a</strong>r'
  94. );
  95. } );
  96. it( 'in same attribute, selection same as attribute', () => {
  97. test(
  98. [ 2, 4 ],
  99. 'fo<$text bold="true">ob</$text>ar',
  100. 'fo{<strong>ob</strong>}ar'
  101. );
  102. } );
  103. it( 'starts in text node, ends in attribute #1', () => {
  104. test(
  105. [ 1, 3 ],
  106. 'fo<$text bold="true">ob</$text>ar',
  107. 'f{o<strong>o}b</strong>ar'
  108. );
  109. } );
  110. it( 'starts in text node, ends in attribute #2', () => {
  111. test(
  112. [ 1, 4 ],
  113. 'fo<$text bold="true">ob</$text>ar',
  114. 'f{o<strong>ob</strong>}ar'
  115. );
  116. } );
  117. it( 'starts in attribute, ends in text node', () => {
  118. test(
  119. [ 3, 5 ],
  120. 'fo<$text bold="true">ob</$text>ar',
  121. 'fo<strong>o{b</strong>a}r'
  122. );
  123. } );
  124. it( 'consumes consumable values properly', () => {
  125. // Add callback that will fire before default ones.
  126. // This should prevent default callback doing anything.
  127. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  128. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  129. }, { priority: 'high' } );
  130. // Similar test case as the first in this suite.
  131. test(
  132. [ 1, 4 ],
  133. 'foobar',
  134. 'foobar' // No selection in view.
  135. );
  136. } );
  137. it( 'should convert backward selection', () => {
  138. test(
  139. [ 1, 3, 'backward' ],
  140. 'foobar',
  141. 'f{oo}bar'
  142. );
  143. expect( viewSelection.focus.offset ).to.equal( 1 );
  144. } );
  145. } );
  146. describe( 'collapsed selection', () => {
  147. let marker;
  148. it( 'in container', () => {
  149. test(
  150. [ 1, 1 ],
  151. 'foobar',
  152. 'f{}oobar'
  153. );
  154. } );
  155. it( 'in attribute', () => {
  156. test(
  157. [ 3, 3 ],
  158. 'f<$text bold="true">ooba</$text>r',
  159. 'f<strong>oo{}ba</strong>r'
  160. );
  161. } );
  162. it( 'in attribute and marker', () => {
  163. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  164. model.change( writer => {
  165. marker = writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  166. writer.setSelection( new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) );
  167. } );
  168. // Remove view children manually (without firing additional conversion).
  169. viewRoot._removeChildren( 0, viewRoot.childCount );
  170. // Convert model to view.
  171. view.change( writer => {
  172. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  173. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  174. dispatcher.convertSelection( docSelection, model.markers, writer );
  175. } );
  176. // Stringify view and check if it is same as expected.
  177. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal(
  178. '<div>f<span class="marker">o<strong>o{}b</strong>a</span>r</div>'
  179. );
  180. } );
  181. it( 'in attribute and marker - no attribute', () => {
  182. setModelData( model, 'fo<$text bold="true">ob</$text>ar' );
  183. model.change( writer => {
  184. marker = writer.setMarker( 'marker', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  185. writer.setSelection( new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) );
  186. writer.removeSelectionAttribute( 'bold' );
  187. } );
  188. // Remove view children manually (without firing additional conversion).
  189. viewRoot._removeChildren( 0, viewRoot.childCount );
  190. // Convert model to view.
  191. view.change( writer => {
  192. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  193. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  194. dispatcher.convertSelection( docSelection, model.markers, writer );
  195. } );
  196. // Stringify view and check if it is same as expected.
  197. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  198. .to.equal( '<div>f<span class="marker">o<strong>o</strong>[]<strong>b</strong>a</span>r</div>' );
  199. } );
  200. it( 'in marker - using highlight descriptor creator', () => {
  201. dispatcher.on( 'addMarker:marker2', highlightText(
  202. data => ( { classes: data.markerName } )
  203. ) );
  204. setModelData( model, 'foobar' );
  205. model.change( writer => {
  206. marker = writer.setMarker( 'marker2', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  207. writer.setSelection( new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) );
  208. } );
  209. // Remove view children manually (without firing additional conversion).
  210. viewRoot._removeChildren( 0, viewRoot.childCount );
  211. // Convert model to view.
  212. view.change( writer => {
  213. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  214. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  215. dispatcher.convertSelection( docSelection, model.markers, writer );
  216. } );
  217. // Stringify view and check if it is same as expected.
  218. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  219. .to.equal( '<div>f<span class="marker2">oo{}ba</span>r</div>' );
  220. } );
  221. it( 'should do nothing if creator return null', () => {
  222. dispatcher.on( 'addMarker:marker3', highlightText( () => null ) );
  223. setModelData( model, 'foobar' );
  224. model.change( writer => {
  225. marker = writer.setMarker( 'marker3', ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 5 ) );
  226. writer.setSelection( new ModelRange( ModelPosition.createAt( modelRoot, 3 ) ) );
  227. } );
  228. // Remove view children manually (without firing additional conversion).
  229. viewRoot._removeChildren( 0, viewRoot.childCount );
  230. // Convert model to view.
  231. view.change( writer => {
  232. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  233. dispatcher.convertMarkerAdd( marker.name, marker.getRange(), writer );
  234. dispatcher.convertSelection( docSelection, model.markers, writer );
  235. } );
  236. // Stringify view and check if it is same as expected.
  237. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  238. .to.equal( '<div>foo{}bar</div>' );
  239. } );
  240. // #1072 - if the container has only ui elements, collapsed selection attribute should be rendered after those ui elements.
  241. it( 'selection with attribute before ui element - no non-ui children', () => {
  242. setModelData( model, '' );
  243. // Add two ui elements to view.
  244. viewRoot._appendChild( [
  245. new ViewUIElement( 'span' ),
  246. new ViewUIElement( 'span' )
  247. ] );
  248. model.change( writer => {
  249. writer.setSelection( new ModelRange( new ModelPosition( modelRoot, [ 0 ] ) ) );
  250. writer.setSelectionAttribute( 'bold', true );
  251. } );
  252. // Convert model to view.
  253. view.change( writer => {
  254. dispatcher.convertSelection( docSelection, model.markers, writer );
  255. } );
  256. // Stringify view and check if it is same as expected.
  257. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  258. .to.equal( '<div><span></span><span></span><strong>[]</strong></div>' );
  259. } );
  260. // #1072.
  261. it( 'selection with attribute before ui element - has non-ui children #1', () => {
  262. setModelData( model, 'x' );
  263. model.change( writer => {
  264. writer.setSelection( new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) );
  265. writer.setSelectionAttribute( 'bold', true );
  266. } );
  267. // Convert model to view.
  268. view.change( writer => {
  269. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  270. // Add ui element to view.
  271. const uiElement = new ViewUIElement( 'span' );
  272. viewRoot._insertChild( 1, uiElement );
  273. dispatcher.convertSelection( docSelection, model.markers, writer );
  274. } );
  275. // Stringify view and check if it is same as expected.
  276. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  277. .to.equal( '<div>x<strong>[]</strong><span></span></div>' );
  278. } );
  279. // #1072.
  280. it( 'selection with attribute before ui element - has non-ui children #2', () => {
  281. setModelData( model, '<$text bold="true">x</$text>y' );
  282. model.change( writer => {
  283. writer.setSelection( new ModelRange( new ModelPosition( modelRoot, [ 1 ] ) ) );
  284. writer.setSelectionAttribute( 'bold', true );
  285. } );
  286. // Convert model to view.
  287. view.change( writer => {
  288. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  289. // Add ui element to view.
  290. const uiElement = new ViewUIElement( 'span' );
  291. viewRoot._insertChild( 1, uiElement, writer );
  292. dispatcher.convertSelection( docSelection, model.markers, writer );
  293. } );
  294. // Stringify view and check if it is same as expected.
  295. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) )
  296. .to.equal( '<div><strong>x{}</strong><span></span>y</div>' );
  297. } );
  298. it( 'consumes consumable values properly', () => {
  299. // Add callbacks that will fire before default ones.
  300. // This should prevent default callbacks doing anything.
  301. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  302. expect( conversionApi.consumable.consume( data.selection, 'selection' ) ).to.be.true;
  303. }, { priority: 'high' } );
  304. dispatcher.on( 'attribute:bold', ( evt, data, conversionApi ) => {
  305. expect( conversionApi.consumable.consume( data.item, 'attribute:bold' ) ).to.be.true;
  306. }, { priority: 'high' } );
  307. // Similar test case as above.
  308. test(
  309. [ 3, 3 ],
  310. 'f<$text bold="true">ooba</$text>r',
  311. 'foobar' // No selection in view and no attribute.
  312. );
  313. } );
  314. } );
  315. } );
  316. describe( 'clean-up', () => {
  317. describe( 'convertRangeSelection', () => {
  318. it( 'should remove all ranges before adding new range', () => {
  319. test(
  320. [ 0, 2 ],
  321. 'foobar',
  322. '{fo}obar'
  323. );
  324. test(
  325. [ 3, 5 ],
  326. 'foobar',
  327. 'foo{ba}r'
  328. );
  329. expect( viewSelection.rangeCount ).to.equal( 1 );
  330. } );
  331. } );
  332. describe( 'convertCollapsedSelection', () => {
  333. it( 'should remove all ranges before adding new range', () => {
  334. test(
  335. [ 2, 2 ],
  336. 'foobar',
  337. 'fo{}obar'
  338. );
  339. test(
  340. [ 3, 3 ],
  341. 'foobar',
  342. 'foo{}bar'
  343. );
  344. expect( viewSelection.rangeCount ).to.equal( 1 );
  345. } );
  346. } );
  347. describe( 'clearAttributes', () => {
  348. it( 'should remove all ranges before adding new range', () => {
  349. test(
  350. [ 3, 3 ],
  351. 'foobar',
  352. 'foo<strong>[]</strong>bar',
  353. { bold: 'true' }
  354. );
  355. view.change( writer => {
  356. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  357. model.change( writer => {
  358. writer.setSelection( modelRange );
  359. } );
  360. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  361. } );
  362. expect( viewSelection.rangeCount ).to.equal( 1 );
  363. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  364. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  365. } );
  366. it( 'should do nothing if the attribute element had been already removed', () => {
  367. test(
  368. [ 3, 3 ],
  369. 'foobar',
  370. 'foo<strong>[]</strong>bar',
  371. { bold: 'true' }
  372. );
  373. view.change( writer => {
  374. // Remove <strong></strong> manually.
  375. writer.mergeAttributes( viewSelection.getFirstPosition() );
  376. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  377. model.change( writer => {
  378. writer.setSelection( modelRange );
  379. } );
  380. dispatcher.convertSelection( modelDoc.selection, model.markers, writer );
  381. } );
  382. expect( viewSelection.rangeCount ).to.equal( 1 );
  383. const viewString = stringifyView( viewRoot, viewSelection, { showType: false } );
  384. expect( viewString ).to.equal( '<div>f{}oobar</div>' );
  385. } );
  386. it( 'should clear fake selection', () => {
  387. const modelRange = ModelRange.createFromParentsAndOffsets( modelRoot, 1, modelRoot, 1 );
  388. view.change( writer => {
  389. writer.setSelection( modelRange, { fake: true } );
  390. dispatcher.convertSelection( docSelection, model.markers, writer );
  391. } );
  392. expect( viewSelection.isFake ).to.be.false;
  393. } );
  394. } );
  395. } );
  396. describe( 'table cell selection converter', () => {
  397. beforeEach( () => {
  398. model.schema.register( 'table' );
  399. model.schema.register( 'tr' );
  400. model.schema.register( 'td' );
  401. model.schema.extend( 'table', { allowIn: '$root' } );
  402. model.schema.extend( 'tr', { allowIn: 'table' } );
  403. model.schema.extend( 'td', { allowIn: 'tr' } );
  404. model.schema.extend( '$text', { allowIn: 'td' } );
  405. // "Universal" converter to convert table structure.
  406. const containerCreator = ( modelElement, viewWriter ) => viewWriter.createContainerElement( modelElement.name );
  407. const tableConverter = insertElement( containerCreator );
  408. dispatcher.on( 'insert:table', tableConverter );
  409. dispatcher.on( 'insert:tr', tableConverter );
  410. dispatcher.on( 'insert:td', tableConverter );
  411. // Special converter for table cells.
  412. dispatcher.on( 'selection', ( evt, data, conversionApi ) => {
  413. const selection = data.selection;
  414. if ( !conversionApi.consumable.test( selection, 'selection' ) || selection.isCollapsed ) {
  415. return;
  416. }
  417. for ( const range of selection.getRanges() ) {
  418. const node = range.start.nodeAfter;
  419. if ( node == range.end.nodeBefore && node instanceof ModelElement && node.name == 'td' ) {
  420. conversionApi.consumable.consume( selection, 'selection' );
  421. const viewNode = conversionApi.mapper.toViewElement( node );
  422. conversionApi.writer.addClass( 'selected', viewNode );
  423. }
  424. }
  425. } );
  426. } );
  427. it( 'should not be used to convert selection that is not on table cell', () => {
  428. test(
  429. [ 1, 5 ],
  430. 'f{o<$text bold="true">ob</$text>a}r',
  431. 'f{o<strong>ob</strong>a}r'
  432. );
  433. } );
  434. it( 'should add a class to the selected table cell', () => {
  435. test(
  436. // table tr#0 |td#0, table tr#0 td#0|
  437. [ [ 0, 0, 0 ], [ 0, 0, 1 ] ],
  438. '<table><tr><td>foo</td></tr><tr><td>bar</td></tr></table>',
  439. '<table><tr><td class="selected">foo</td></tr><tr><td>bar</td></tr></table>'
  440. );
  441. } );
  442. it( 'should not be used if selection contains more than just a table cell', () => {
  443. test(
  444. // table tr td#1, table tr#2
  445. [ [ 0, 0, 0, 1 ], [ 0, 0, 2 ] ],
  446. '<table><tr><td>foo</td><td>bar</td></tr></table>',
  447. '<table><tr><td>f{oo</td><td>bar</td>]</tr></table>'
  448. );
  449. } );
  450. } );
  451. // Tests if the selection got correctly converted.
  452. // Because `setData` might use selection converters itself to set the selection, we can't use it
  453. // to set the selection (because then we would test converters using converters).
  454. // Instead, the `test` function expects to be passed `selectionPaths` which is an array containing two numbers or two arrays,
  455. // that are offsets or paths of selection positions in root element.
  456. function test( selectionPaths, modelInput, expectedView, selectionAttributes = {} ) {
  457. // Parse passed `modelInput` string and set it as current model.
  458. setModelData( model, modelInput );
  459. // Manually set selection ranges using passed `selectionPaths`.
  460. const startPath = typeof selectionPaths[ 0 ] == 'number' ? [ selectionPaths[ 0 ] ] : selectionPaths[ 0 ];
  461. const endPath = typeof selectionPaths[ 1 ] == 'number' ? [ selectionPaths[ 1 ] ] : selectionPaths[ 1 ];
  462. const startPos = new ModelPosition( modelRoot, startPath );
  463. const endPos = new ModelPosition( modelRoot, endPath );
  464. const isBackward = selectionPaths[ 2 ] === 'backward';
  465. model.change( writer => {
  466. writer.setSelection( new ModelRange( startPos, endPos ), { backward: isBackward } );
  467. // And add or remove passed attributes.
  468. for ( const key in selectionAttributes ) {
  469. const value = selectionAttributes[ key ];
  470. if ( value ) {
  471. writer.setSelectionAttribute( key, value );
  472. } else {
  473. writer.removeSelectionAttribute( key );
  474. }
  475. }
  476. } );
  477. // Remove view children manually (without firing additional conversion).
  478. viewRoot._removeChildren( 0, viewRoot.childCount );
  479. // Convert model to view.
  480. view.change( writer => {
  481. dispatcher.convertInsert( ModelRange.createIn( modelRoot ), writer );
  482. dispatcher.convertSelection( docSelection, model.markers, writer );
  483. } );
  484. // Stringify view and check if it is same as expected.
  485. expect( stringifyView( viewRoot, viewSelection, { showType: false } ) ).to.equal( '<div>' + expectedView + '</div>' );
  486. }
  487. } );