treewalker.js 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treemodel */
  6. 'use strict';
  7. import Document from '/ckeditor5/core/treemodel/document.js';
  8. import Element from '/ckeditor5/core/treemodel/element.js';
  9. import Text from '/ckeditor5/core/treemodel/text.js';
  10. import TreeWalker from '/ckeditor5/core/treemodel/treewalker.js';
  11. import Position from '/ckeditor5/core/treemodel/position.js';
  12. import Range from '/ckeditor5/core/treemodel/range.js';
  13. import CKEditorError from '/ckeditor5/core/ckeditorerror.js';
  14. describe( 'range iterator', () => {
  15. let doc, expectedItems, expectedItemsMerged, root, img1, paragraph, b, a, r, img2, x;
  16. before( () => {
  17. doc = new Document();
  18. root = doc.createRoot( 'root' );
  19. // root
  20. // |- img1
  21. // |- p
  22. // |- B
  23. // |- A
  24. // |- R
  25. // |
  26. // |- img2
  27. // |
  28. // |- X
  29. b = new Text( 'b', { bold: true } );
  30. a = new Text( 'a', { bold: true } );
  31. r = new Text( 'r' );
  32. img2 = new Element( 'img2' );
  33. x = new Text( 'x' );
  34. paragraph = new Element( 'p', [], [ b, a, r, img2, x ] );
  35. img1 = new Element( 'img1' );
  36. root.insertChildren( 0, [ img1, paragraph ] );
  37. expectedItems = [
  38. { type: 'ELEMENT_START', item: img1 },
  39. { type: 'ELEMENT_END', item: img1 },
  40. { type: 'ELEMENT_START', item: paragraph },
  41. { type: 'CHARACTER', text: 'b', attrs: [ [ 'bold', true ] ] },
  42. { type: 'CHARACTER', text: 'a', attrs: [ [ 'bold', true ] ] },
  43. { type: 'CHARACTER', text: 'r', attrs: [] },
  44. { type: 'ELEMENT_START', item: img2 },
  45. { type: 'ELEMENT_END', item: img2 },
  46. { type: 'CHARACTER', text: 'x', attrs: [] },
  47. { type: 'ELEMENT_END', item: paragraph }
  48. ];
  49. expectedItemsMerged = [
  50. { type: 'ELEMENT_START', item: img1 },
  51. { type: 'ELEMENT_END', item: img1 },
  52. { type: 'ELEMENT_START', item: paragraph },
  53. { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] },
  54. { type: 'TEXT', text: 'r', attrs: [] },
  55. { type: 'ELEMENT_START', item: img2 },
  56. { type: 'ELEMENT_END', item: img2 },
  57. { type: 'TEXT', text: 'x', attrs: [] },
  58. { type: 'ELEMENT_END', item: paragraph }
  59. ];
  60. } );
  61. function expectItem( item, expected ) {
  62. expect( item.done ).to.be.false;
  63. if ( item.value.type == 'TEXT' || item.value.type == 'CHARACTER' ) {
  64. let text = item.value.item.text || item.value.item.character;
  65. let attrs = item.value.item._attrs || item.value.item.first._attrs;
  66. expect( text ).to.equal( expected.text );
  67. expect( Array.from( attrs ) ).to.deep.equal( expected.attrs );
  68. } else {
  69. expect( item.value ).to.deep.equal( expected );
  70. }
  71. }
  72. it( 'should return next position', () => {
  73. let iterator = new TreeWalker( { position: new Position( root, [ 0 ] ) } ); // beginning of root
  74. let i, len;
  75. for ( i = 0, len = expectedItems.length; i < len; i++ ) {
  76. expectItem( iterator.next(), expectedItems[ i ] );
  77. }
  78. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  79. } );
  80. it( 'should return previous position', () => {
  81. let iterator = new TreeWalker( { position: new Position( root, [ 2 ] ) } ); // ending of root
  82. for ( let i = expectedItems.length - 1; i >= 0; i-- ) {
  83. expectItem( iterator.previous(), expectedItems[ i ] );
  84. }
  85. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  86. } );
  87. it( 'should return next position in the boundaries', () => {
  88. let start = new Position( root, [ 1, 0 ] ); // p, 0
  89. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  90. let iterator = new TreeWalker( { boundaries: new Range( start, end ) } );
  91. let i, len;
  92. for ( i = 3, len = expectedItems.length; i < 7; i++ ) {
  93. expectItem( iterator.next(), expectedItems[ i ] );
  94. }
  95. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  96. } );
  97. it( 'should return previous position in the boundaries', () => {
  98. let start = new Position( root, [ 1, 0 ] ); // p, 0
  99. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  100. let iterator = new TreeWalker( { boundaries: new Range( start, end ), position: end } );
  101. let i, len;
  102. for ( i = 6, len = expectedItems.length; i > 2; i-- ) {
  103. expectItem( iterator.previous(), expectedItems[ i ] );
  104. }
  105. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  106. } );
  107. it( 'should merge characters when iterating over the range using next', () => {
  108. let start = new Position( root, [ 1 ] );
  109. let end = new Position( root, [ 1, 4 ] );
  110. let range = new Range( start, end );
  111. let iterator = new TreeWalker( { boundaries: range, position: range.start, mergeCharacters: true } );
  112. let i;
  113. for ( i = 2; i <= 6; i++ ) {
  114. expectItem( iterator.next(), expectedItemsMerged[ i ] );
  115. }
  116. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  117. } );
  118. it( 'should merge characters when iterating over the range using previous', () => {
  119. let start = new Position( root, [ 1 ] );
  120. let end = new Position( root, [ 1, 4 ] );
  121. let range = new Range( start, end );
  122. let iterator = new TreeWalker( { boundaries: range, position: range.end, mergeCharacters: true } );
  123. for ( let i = 6; i >= 2; i-- ) {
  124. expectItem( iterator.previous(), expectedItemsMerged[ i ] );
  125. }
  126. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  127. } );
  128. it( 'should respect boundaries when iterating using next and merging characters', () => {
  129. let start = new Position( root, [ 1, 0 ] );
  130. let end = new Position( root, [ 1, 1 ] );
  131. let range = new Range( start, end );
  132. let iterator = new TreeWalker( { boundaries: range, position: range.start, mergeCharacters: true } );
  133. let val = iterator.next();
  134. expect( val.done ).to.be.false;
  135. expect( val.value.item.text ).to.equal( 'b' );
  136. val = iterator.next();
  137. expect( val.done ).to.be.true;
  138. } );
  139. it( 'should respect boundaries when iterating using previous and merging characters', () => {
  140. let start = new Position( root, [ 1, 1 ] );
  141. let end = new Position( root, [ 1, 2 ] );
  142. let range = new Range( start, end );
  143. let iterator = new TreeWalker( { boundaries: range, position: range.end, mergeCharacters: true } );
  144. let val = iterator.previous();
  145. expect( val.done ).to.be.false;
  146. expect( val.value.item.text ).to.equal( 'a' );
  147. val = iterator.previous();
  148. expect( val.done ).to.be.true;
  149. } );
  150. it( 'should throw if neither boundaries nor starting position is set', () => {
  151. expect( () => {
  152. new TreeWalker();
  153. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  154. expect( () => {
  155. new TreeWalker( {} );
  156. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  157. expect( () => {
  158. new TreeWalker( { mergeCharacters: true } );
  159. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  160. } );
  161. } );