treewalker.js 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  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. let attrs = item.value.item._attrs || item.value.item.first._attrs;
  68. expect( text ).to.equal( expected.text );
  69. expect( Array.from( attrs ) ).to.deep.equal( expected.attrs );
  70. } else {
  71. expect( item.value ).to.deep.equal( expected );
  72. }
  73. }
  74. it( 'should return next position', () => {
  75. let iterator = new TreeWalker( { position: new Position( root, [ 0 ] ) } ); // beginning of root
  76. let i, len;
  77. for ( i = 0, len = expectedItems.length; i < len; i++ ) {
  78. expectItem( iterator.next(), expectedItems[ i ] );
  79. }
  80. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  81. } );
  82. it( 'should return previous position', () => {
  83. let iterator = new TreeWalker( { position: new Position( root, [ 2 ] ) } ); // ending of root
  84. for ( let i = expectedItems.length - 1; i >= 0; i-- ) {
  85. expectItem( iterator.previous(), expectedItems[ i ] );
  86. }
  87. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  88. } );
  89. it( 'should return next position in the boundaries', () => {
  90. let start = new Position( root, [ 1, 0 ] ); // p, 0
  91. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  92. let iterator = new TreeWalker( { boundaries: new Range( start, end ) } );
  93. let i, len;
  94. for ( i = 3, len = expectedItems.length; i < 7; i++ ) {
  95. expectItem( iterator.next(), expectedItems[ i ] );
  96. }
  97. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  98. } );
  99. it( 'should return previous position in the boundaries', () => {
  100. let start = new Position( root, [ 1, 0 ] ); // p, 0
  101. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  102. let iterator = new TreeWalker( { boundaries: new Range( start, end ), position: end } );
  103. let i, len;
  104. for ( i = 6, len = expectedItems.length; i > 2; i-- ) {
  105. expectItem( iterator.previous(), expectedItems[ i ] );
  106. }
  107. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  108. } );
  109. it( 'should merge characters when iterating over the range using next', () => {
  110. let start = new Position( root, [ 1 ] );
  111. let end = new Position( root, [ 1, 4 ] );
  112. let range = new Range( start, end );
  113. let iterator = new TreeWalker( { boundaries: range, position: range.start, mergeCharacters: true } );
  114. let i;
  115. for ( i = 2; i <= 6; i++ ) {
  116. expectItem( iterator.next(), expectedItemsMerged[ i ] );
  117. }
  118. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  119. } );
  120. it( 'should merge characters when iterating over the range using previous', () => {
  121. let start = new Position( root, [ 1 ] );
  122. let end = new Position( root, [ 1, 4 ] );
  123. let range = new Range( start, end );
  124. let iterator = new TreeWalker( { boundaries: range, position: range.end, mergeCharacters: true } );
  125. for ( let i = 6; i >= 2; i-- ) {
  126. expectItem( iterator.previous(), expectedItemsMerged[ i ] );
  127. }
  128. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  129. } );
  130. it( 'should respect boundaries when iterating using next and merging characters', () => {
  131. let start = new Position( root, [ 1, 0 ] );
  132. let end = new Position( root, [ 1, 1 ] );
  133. let range = new Range( start, end );
  134. let iterator = new TreeWalker( { boundaries: range, position: range.start, mergeCharacters: true } );
  135. let val = iterator.next();
  136. expect( val.done ).to.be.false;
  137. expect( val.value.item.text ).to.equal( 'b' );
  138. val = iterator.next();
  139. expect( val.done ).to.be.true;
  140. } );
  141. it( 'should respect boundaries when iterating using previous and merging characters', () => {
  142. let start = new Position( root, [ 1, 1 ] );
  143. let end = new Position( root, [ 1, 2 ] );
  144. let range = new Range( start, end );
  145. let iterator = new TreeWalker( { boundaries: range, position: range.end, mergeCharacters: true } );
  146. let val = iterator.previous();
  147. expect( val.done ).to.be.false;
  148. expect( val.value.item.text ).to.equal( 'a' );
  149. val = iterator.previous();
  150. expect( val.done ).to.be.true;
  151. } );
  152. it( 'should throw if neither boundaries nor starting position is set', () => {
  153. expect( () => {
  154. new TreeWalker();
  155. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  156. expect( () => {
  157. new TreeWalker( {} );
  158. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  159. expect( () => {
  160. new TreeWalker( { mergeCharacters: true } );
  161. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  162. } );
  163. } );