treewalker.js 6.6 KB

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