treewalker.js 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  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, expectedItemsSingle, 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. expectedItemsSingle = [
  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. expectValue( item.value, expected );
  64. }
  65. function expectValue( value, expected ) {
  66. expect( value.type ).to.equal( expected.type );
  67. if ( value.type == 'TEXT' ) {
  68. expectText( value, expected );
  69. } else if ( value.type == 'CHARACTER' ) {
  70. expectCharacter( value, expected );
  71. } else if ( value.type == 'ELEMENT_START' ) {
  72. expectStart( value, expected );
  73. } else if ( value.type == 'ELEMENT_END' ) {
  74. expectEnd( value, expected );
  75. }
  76. }
  77. function expectText( value, expected ) {
  78. expect( value.item.text ).to.equal( expected.text );
  79. expect( Array.from( value.item.first._attrs ) ).to.deep.equal( expected.attrs );
  80. expect( value.length ).to.equal( value.item.text.length );
  81. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item.first ) );
  82. expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item.last ) );
  83. }
  84. function expectCharacter( value, expected ) {
  85. expect( value.item.character ).to.equal( expected.text );
  86. expect( Array.from( value.item._attrs ) ).to.deep.equal( expected.attrs );
  87. expect( value.length ).to.equal( value.item.character.length );
  88. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) );
  89. expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) );
  90. }
  91. function expectStart( value, expected ) {
  92. expect( value.item ).to.equal( expected.item );
  93. expect( value.length ).to.equal( 1 );
  94. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) );
  95. expect( value.nextPosition ).to.deep.equal( Position.createFromParentAndOffset( value.item, 0 ) );
  96. }
  97. function expectEnd( value, expected ) {
  98. expect( value.item ).to.equal( expected.item );
  99. expect( value.length ).to.be.undefined;
  100. expect( value.previousPosition ).to.deep.equal(
  101. Position.createFromParentAndOffset( value.item, value.item.getChildCount() ) );
  102. expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) );
  103. }
  104. describe( 'merged characters', () => {
  105. it( 'should iterate over the range using next', () => {
  106. let start = new Position( root, [ 1 ] );
  107. let end = new Position( root, [ 1, 4 ] );
  108. let range = new Range( start, end );
  109. let iterator = new TreeWalker( { boundaries: range, position: range.start } );
  110. let i;
  111. for ( i = 2; i <= 6; i++ ) {
  112. expectItem( iterator.next(), expectedItemsMerged[ i ] );
  113. }
  114. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  115. } );
  116. it( 'should iterate over the range using previous', () => {
  117. let start = new Position( root, [ 1 ] );
  118. let end = new Position( root, [ 1, 4 ] );
  119. let range = new Range( start, end );
  120. let iterator = new TreeWalker( { boundaries: range, position: range.end } );
  121. for ( let i = 6; i >= 2; i-- ) {
  122. expectItem( iterator.previous(), expectedItemsMerged[ i ] );
  123. }
  124. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  125. } );
  126. it( 'should respect boundaries when iterating using next', () => {
  127. let start = new Position( root, [ 1, 0 ] );
  128. let end = new Position( root, [ 1, 1 ] );
  129. let range = new Range( start, end );
  130. let iterator = new TreeWalker( { boundaries: range, position: range.start } );
  131. let val = iterator.next();
  132. expect( val.done ).to.be.false;
  133. expect( val.value.item.text ).to.equal( 'b' );
  134. val = iterator.next();
  135. expect( val.done ).to.be.true;
  136. } );
  137. it( 'should respect boundaries when iterating using previous', () => {
  138. let start = new Position( root, [ 1, 1 ] );
  139. let end = new Position( root, [ 1, 2 ] );
  140. let range = new Range( start, end );
  141. let iterator = new TreeWalker( { boundaries: range, position: range.end } );
  142. let val = iterator.previous();
  143. expect( val.done ).to.be.false;
  144. expect( val.value.item.text ).to.equal( 'a' );
  145. val = iterator.previous();
  146. expect( val.done ).to.be.true;
  147. } );
  148. } );
  149. describe( 'single characters', () => {
  150. it( 'should iterate over the range using next', () => {
  151. let iterator = new TreeWalker( { position: new Position( root, [ 0 ] ), singleCharacters: true } ); // beginning of root
  152. let i, len;
  153. for ( i = 0, len = expectedItemsSingle.length; i < len; i++ ) {
  154. expectItem( iterator.next(), expectedItemsSingle[ i ] );
  155. }
  156. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  157. } );
  158. it( 'should iterate over the range using previous', () => {
  159. let iterator = new TreeWalker( { position: new Position( root, [ 2 ] ), singleCharacters: true } ); // ending of root
  160. for ( let i = expectedItemsSingle.length - 1; i >= 0; i-- ) {
  161. expectItem( iterator.previous(), expectedItemsSingle[ i ] );
  162. }
  163. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  164. } );
  165. it( 'should respect boundaries when iterating using next', () => {
  166. let start = new Position( root, [ 1, 0 ] ); // p, 0
  167. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  168. let iterator = new TreeWalker( { boundaries: new Range( start, end ), singleCharacters: true } );
  169. let i, len;
  170. for ( i = 3, len = expectedItemsSingle.length; i < 7; i++ ) {
  171. expectItem( iterator.next(), expectedItemsSingle[ i ] );
  172. }
  173. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  174. } );
  175. it( 'should respect boundaries when iterating using previous', () => {
  176. let start = new Position( root, [ 1, 0 ] ); // p, 0
  177. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  178. let iterator = new TreeWalker( { boundaries: new Range( start, end ), position: end, singleCharacters: true } );
  179. let i, len;
  180. for ( i = 6, len = expectedItemsSingle.length; i > 2; i-- ) {
  181. expectItem( iterator.previous(), expectedItemsSingle[ i ] );
  182. }
  183. expect( iterator.previous() ).to.have.property( 'done' ).that.is.true;
  184. } );
  185. } );
  186. it( 'should provide iterator interface', () => {
  187. let iterator = new TreeWalker( { position: new Position( root, [ 0 ] ) } );
  188. let i = 0;
  189. for ( let value of iterator ) {
  190. expectValue( value, expectedItemsMerged[ i ] );
  191. i++;
  192. }
  193. expect( i ).to.equal( 9 );
  194. } );
  195. it( 'should throw if neither boundaries nor starting position is set', () => {
  196. expect( () => {
  197. new TreeWalker();
  198. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  199. expect( () => {
  200. new TreeWalker( {} );
  201. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  202. expect( () => {
  203. new TreeWalker( { mergeCharacters: true } );
  204. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  205. } );
  206. } );