8
0

treewalker.js 6.8 KB

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