treewalker.js 6.8 KB

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