treewalker.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. import Document from '../../src/model/document';
  6. import Element from '../../src/model/element';
  7. import Text from '../../src/model/text';
  8. import TreeWalker from '../../src/model/treewalker';
  9. import Position from '../../src/model/position';
  10. import Range from '../../src/model/range';
  11. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  12. describe( 'TreeWalker', () => {
  13. let doc, root, img1, paragraph, ba, r, img2, x;
  14. let rootBeginning, rootEnding;
  15. before( () => {
  16. doc = new Document();
  17. root = doc.createRoot();
  18. // root
  19. // |- img1
  20. // |- p
  21. // |- B -bold
  22. // |- A -bold
  23. // |- R
  24. // |
  25. // |- img2
  26. // |
  27. // |- X
  28. ba = new Text( 'ba', { bold: true } );
  29. r = new Text( 'r' );
  30. img2 = new Element( 'img2' );
  31. x = new Text( 'x' );
  32. paragraph = new Element( 'p', [], [ ba, r, img2, x ] );
  33. img1 = new Element( 'img1' );
  34. root.insertChildren( 0, [ img1, paragraph ] );
  35. rootBeginning = new Position( root, [ 0 ] );
  36. rootEnding = new Position( root, [ 2 ] );
  37. } );
  38. describe( 'constructor()', () => {
  39. it( 'should throw if neither boundaries nor starting position is set', () => {
  40. expect( () => {
  41. new TreeWalker();
  42. } ).to.throw( CKEditorError, /^model-tree-walker-no-start-position/ );
  43. expect( () => {
  44. new TreeWalker( {} );
  45. } ).to.throw( CKEditorError, /^model-tree-walker-no-start-position/ );
  46. expect( () => {
  47. new TreeWalker( { singleCharacters: true } );
  48. } ).to.throw( CKEditorError, /^model-tree-walker-no-start-position/ );
  49. } );
  50. it( 'should throw if walking direction is unknown', () => {
  51. expect( () => {
  52. new TreeWalker( { startPosition: rootBeginning, direction: 'unknown' } );
  53. } ).to.throw( CKEditorError, /^model-tree-walker-unknown-direction/ );
  54. } );
  55. } );
  56. describe( 'iterate from start position `startPosition`', () => {
  57. let expected;
  58. beforeEach( () => {
  59. expected = [
  60. { type: 'elementStart', item: img1 },
  61. { type: 'elementEnd', item: img1 },
  62. { type: 'elementStart', item: paragraph },
  63. { type: 'text', data: 'ba', attrs: [ [ 'bold', true ] ] },
  64. { type: 'text', data: 'r', attrs: [] },
  65. { type: 'elementStart', item: img2 },
  66. { type: 'elementEnd', item: img2 },
  67. { type: 'text', data: 'x', attrs: [] },
  68. { type: 'elementEnd', item: paragraph }
  69. ];
  70. } );
  71. it( 'should provide iterator interface with default forward direction', () => {
  72. let iterator = new TreeWalker( { startPosition: rootBeginning } );
  73. let i = 0;
  74. for ( let value of iterator ) {
  75. expectValue( value, expected[ i ] );
  76. i++;
  77. }
  78. expect( i ).to.equal( expected.length );
  79. } );
  80. it( 'should provide iterator interface with forward direction', () => {
  81. let iterator = new TreeWalker( { startPosition: rootBeginning, direction: 'forward' } );
  82. let i = 0;
  83. for ( let value of iterator ) {
  84. expectValue( value, expected[ i ] );
  85. i++;
  86. }
  87. expect( i ).to.equal( expected.length );
  88. } );
  89. it( 'should provide iterator interface which backward direction', () => {
  90. let iterator = new TreeWalker( { startPosition: rootEnding, direction: 'backward' } );
  91. let i = expected.length;
  92. for ( let value of iterator ) {
  93. expectValue( value, expected[ --i ], { direction: 'backward' } );
  94. }
  95. expect( i ).to.equal( 0 );
  96. } );
  97. it( 'should start iterating at the startPosition witch is not a root bound', () => {
  98. let iterator = new TreeWalker( { startPosition: new Position( root, [ 1 ] ) } );
  99. let i = 2;
  100. for ( let value of iterator ) {
  101. expectValue( value, expected[ i ] );
  102. i++;
  103. }
  104. expect( i ).to.equal( expected.length );
  105. } );
  106. it( 'should start iterating at the startPosition witch is not a root bound, going backward', () => {
  107. let expected = [
  108. { type: 'elementStart', item: img1 },
  109. { type: 'elementEnd', item: img1 }
  110. ];
  111. let iterator = new TreeWalker( { startPosition: new Position( root, [ 1 ] ), direction: 'backward' } );
  112. let i = expected.length;
  113. for ( let value of iterator ) {
  114. expectValue( value, expected[ --i ], { direction: 'backward' } );
  115. }
  116. expect( i ).to.equal( 0 );
  117. } );
  118. } );
  119. describe( 'iterate trough the range `boundary`', () => {
  120. describe( 'range starts between elements', () => {
  121. let expected, range;
  122. before( () => {
  123. expected = [
  124. { type: 'elementStart', item: paragraph },
  125. { type: 'text', data: 'ba', attrs: [ [ 'bold', true ] ] },
  126. { type: 'text', data: 'r', attrs: [] },
  127. { type: 'elementStart', item: img2 },
  128. { type: 'elementEnd', item: img2 }
  129. ];
  130. range = new Range( new Position( root, [ 1 ] ), new Position( root, [ 1, 4 ] ) );
  131. } );
  132. it( 'should iterate over the range', () => {
  133. let iterator = new TreeWalker( { boundaries: range } );
  134. let i = 0;
  135. for ( let value of iterator ) {
  136. expectValue( value, expected[ i ] );
  137. i++;
  138. }
  139. expect( i ).to.equal( expected.length );
  140. } );
  141. it( 'should iterate over the range going backward', () => {
  142. let iterator = new TreeWalker( { boundaries: range, direction: 'backward' } );
  143. let i = expected.length;
  144. for ( let value of iterator ) {
  145. expectValue( value, expected[ --i ], { direction: 'backward' } );
  146. }
  147. expect( i ).to.equal( 0 );
  148. } );
  149. } );
  150. describe( 'range starts inside the text', () => {
  151. let expected, range;
  152. before( () => {
  153. expected = [
  154. { type: 'text', data: 'a', attrs: [ [ 'bold', true ] ] },
  155. { type: 'text', data: 'r', attrs: [] },
  156. { type: 'elementStart', item: img2 },
  157. { type: 'elementEnd', item: img2 }
  158. ];
  159. range = new Range( new Position( root, [ 1, 1 ] ), new Position( root, [ 1, 4 ] ) );
  160. } );
  161. it( 'should return part of the text', () => {
  162. let iterator = new TreeWalker( { boundaries: range } );
  163. let i = 0;
  164. for ( let value of iterator ) {
  165. expectValue( value, expected[ i ] );
  166. i++;
  167. }
  168. expect( i ).to.equal( expected.length );
  169. } );
  170. it( 'should return part of the text going backward', () => {
  171. let iterator = new TreeWalker( {
  172. boundaries: range,
  173. direction: 'backward' }
  174. );
  175. let i = expected.length;
  176. for ( let value of iterator ) {
  177. expectValue( value, expected[ --i ], { direction: 'backward' } );
  178. }
  179. expect( i ).to.equal( 0 );
  180. } );
  181. } );
  182. describe( 'range ends inside the text', () => {
  183. let expected, range;
  184. before( () => {
  185. expected = [
  186. { type: 'elementStart', item: img1 },
  187. { type: 'elementEnd', item: img1 },
  188. { type: 'elementStart', item: paragraph },
  189. { type: 'text', data: 'b', attrs: [ [ 'bold', true ] ] }
  190. ];
  191. range = new Range( rootBeginning, new Position( root, [ 1, 1 ] ) );
  192. } );
  193. it( 'should return part of the text', () => {
  194. let iterator = new TreeWalker( { boundaries: range } );
  195. let i = 0;
  196. for ( let value of iterator ) {
  197. expectValue( value, expected[ i ] );
  198. i++;
  199. }
  200. expect( i ).to.equal( expected.length );
  201. } );
  202. it( 'should return part of the text going backward', () => {
  203. let iterator = new TreeWalker( {
  204. boundaries: range,
  205. startPosition: range.end,
  206. direction: 'backward'
  207. } );
  208. let i = expected.length;
  209. for ( let value of iterator ) {
  210. expectValue( value, expected[ --i ], { direction: 'backward' } );
  211. }
  212. expect( i ).to.equal( 0 );
  213. } );
  214. } );
  215. describe( 'custom start position', () => {
  216. it( 'should iterating from the start position', () => {
  217. let expected = [
  218. { type: 'text', data: 'r', attrs: [] },
  219. { type: 'elementStart', item: img2 },
  220. { type: 'elementEnd', item: img2 }
  221. ];
  222. let range = new Range( new Position( root, [ 1 ] ), new Position( root, [ 1, 4 ] ) );
  223. let iterator = new TreeWalker( {
  224. boundaries: range,
  225. startPosition: new Position( root, [ 1, 2 ] )
  226. } );
  227. let i = 0;
  228. for ( let value of iterator ) {
  229. expectValue( value, expected[ i ] );
  230. i++;
  231. }
  232. expect( i ).to.equal( expected.length );
  233. } );
  234. it( 'should iterating from the start position going backward', () => {
  235. let expected = [
  236. { type: 'text', data: 'r', attrs: [] },
  237. { type: 'elementStart', item: img2 },
  238. { type: 'elementEnd', item: img2 }
  239. ];
  240. let range = new Range( new Position( root, [ 1, 2 ] ), new Position( root, [ 1, 6 ] ) );
  241. let iterator = new TreeWalker( {
  242. boundaries: range,
  243. startPosition: new Position( root, [ 1, 4 ] ),
  244. direction: 'backward'
  245. } );
  246. let i = expected.length;
  247. for ( let value of iterator ) {
  248. expectValue( value, expected[ --i ], { direction: 'backward' } );
  249. }
  250. expect( i ).to.equal( 0 );
  251. } );
  252. } );
  253. } );
  254. describe( 'iterate by every single characters `singleCharacter`', () => {
  255. describe( 'whole root', () => {
  256. let expected;
  257. before( () => {
  258. expected = [
  259. { type: 'elementStart', item: img1 },
  260. { type: 'elementEnd', item: img1 },
  261. { type: 'elementStart', item: paragraph },
  262. { type: 'text', data: 'b', attrs: [ [ 'bold', true ] ] },
  263. { type: 'text', data: 'a', attrs: [ [ 'bold', true ] ] },
  264. { type: 'text', data: 'r', attrs: [] },
  265. { type: 'elementStart', item: img2 },
  266. { type: 'elementEnd', item: img2 },
  267. { type: 'text', data: 'x', attrs: [] },
  268. { type: 'elementEnd', item: paragraph }
  269. ];
  270. } );
  271. it( 'should return single characters', () => {
  272. let iterator = new TreeWalker( { startPosition: rootBeginning, singleCharacters: true } );
  273. let i = 0;
  274. for ( let value of iterator ) {
  275. expectValue( value, expected[ i ] );
  276. i++;
  277. }
  278. expect( i ).to.equal( expected.length );
  279. } );
  280. it( 'should return single characters going backward', () => {
  281. let iterator = new TreeWalker( {
  282. startPosition: rootEnding,
  283. singleCharacters: true,
  284. direction: 'backward' }
  285. );
  286. let i = expected.length;
  287. for ( let value of iterator ) {
  288. expectValue( value, expected[ --i ], { direction: 'backward' } );
  289. }
  290. expect( i ).to.equal( 0 );
  291. } );
  292. } );
  293. describe( 'range', () => {
  294. let start, end, range, expected;
  295. before( () => {
  296. expected = [
  297. { type: 'text', data: 'b', attrs: [ [ 'bold', true ] ] },
  298. { type: 'text', data: 'a', attrs: [ [ 'bold', true ] ] },
  299. { type: 'text', data: 'r', attrs: [] },
  300. { type: 'elementStart', item: img2 }
  301. ];
  302. start = new Position( root, [ 1, 0 ] ); // p, 0
  303. end = new Position( root, [ 1, 3, 0 ] ); // img2, 0
  304. range = new Range( start, end );
  305. } );
  306. it( 'should respect boundaries', () => {
  307. let iterator = new TreeWalker( { boundaries: range, singleCharacters: true } );
  308. let i = 0;
  309. for ( let value of iterator ) {
  310. expectValue( value, expected[ i ] );
  311. i++;
  312. }
  313. expect( i ).to.equal( expected.length );
  314. } );
  315. it( 'should respect boundaries going backward', () => {
  316. let iterator = new TreeWalker( {
  317. boundaries: range,
  318. singleCharacters: true,
  319. startPosition: range.end,
  320. direction: 'backward'
  321. } );
  322. let i = expected.length;
  323. for ( let value of iterator ) {
  324. expectValue( value, expected[ --i ], { direction: 'backward' } );
  325. }
  326. expect( i ).to.equal( 0 );
  327. } );
  328. } );
  329. } );
  330. describe( 'iterate omitting child nodes and elementEnd `shallow`', () => {
  331. let expected;
  332. before( () => {
  333. expected = [
  334. { type: 'elementStart', item: img1 },
  335. { type: 'elementStart', item: paragraph }
  336. ];
  337. } );
  338. it( 'should not enter elements', () => {
  339. let iterator = new TreeWalker( { startPosition: rootBeginning, shallow: true } );
  340. let i = 0;
  341. for ( let value of iterator ) {
  342. expectValue( value, expected[ i ], { shallow: true } );
  343. i++;
  344. }
  345. expect( i ).to.equal( expected.length );
  346. } );
  347. it( 'should not enter elements going backward', () => {
  348. let iterator = new TreeWalker( { startPosition: rootEnding, shallow: true, direction: 'backward' } );
  349. let i = expected.length;
  350. for ( let value of iterator ) {
  351. expectValue( value, expected[ --i ], { shallow: true, direction: 'backward' } );
  352. }
  353. expect( i ).to.equal( 0 );
  354. } );
  355. } );
  356. describe( 'iterate omitting elementEnd `ignoreElementEnd`', () => {
  357. describe( 'merged text', () => {
  358. let expected;
  359. before( () => {
  360. expected = [
  361. { type: 'elementStart', item: img1 },
  362. { type: 'elementStart', item: paragraph },
  363. { type: 'text', data: 'ba', attrs: [ [ 'bold', true ] ] },
  364. { type: 'text', data: 'r', attrs: [] },
  365. { type: 'elementStart', item: img2 },
  366. { type: 'text', data: 'x', attrs: [] }
  367. ];
  368. } );
  369. it( 'should iterate ignoring elementEnd', () => {
  370. let iterator = new TreeWalker( { startPosition: rootBeginning, ignoreElementEnd: true } );
  371. let i = 0;
  372. for ( let value of iterator ) {
  373. expectValue( value, expected[ i ] );
  374. i++;
  375. }
  376. expect( i ).to.equal( expected.length );
  377. } );
  378. it( 'should iterate ignoring elementEnd going backward', () => {
  379. let iterator = new TreeWalker( {
  380. startPosition: rootEnding,
  381. ignoreElementEnd: true,
  382. direction: 'backward'
  383. } );
  384. let i = expected.length;
  385. for ( let value of iterator ) {
  386. expectValue( value, expected[ --i ], { direction: 'backward' } );
  387. }
  388. expect( i ).to.equal( 0 );
  389. } );
  390. } );
  391. describe( 'single character', () => {
  392. let expected;
  393. before( () => {
  394. expected = [
  395. { type: 'elementStart', item: img1 },
  396. { type: 'elementStart', item: paragraph },
  397. { type: 'text', data: 'b', attrs: [ [ 'bold', true ] ] },
  398. { type: 'text', data: 'a', attrs: [ [ 'bold', true ] ] },
  399. { type: 'text', data: 'r', attrs: [] },
  400. { type: 'elementStart', item: img2 },
  401. { type: 'text', data: 'x', attrs: [] }
  402. ];
  403. } );
  404. it( 'should return single characters ignoring elementEnd', () => {
  405. let iterator = new TreeWalker( {
  406. startPosition: rootBeginning,
  407. singleCharacters: true,
  408. ignoreElementEnd: true
  409. } );
  410. let i = 0;
  411. for ( let value of iterator ) {
  412. expectValue( value, expected[ i ] );
  413. i++;
  414. }
  415. expect( i ).to.equal( expected.length );
  416. } );
  417. it( 'should return single characters ignoring elementEnd going backward', () => {
  418. let iterator = new TreeWalker( {
  419. startPosition: rootEnding,
  420. singleCharacters: true,
  421. ignoreElementEnd: true,
  422. direction: 'backward'
  423. } );
  424. let i = expected.length;
  425. for ( let value of iterator ) {
  426. expectValue( value, expected[ --i ], { direction: 'backward' } );
  427. }
  428. expect( i ).to.equal( 0 );
  429. } );
  430. } );
  431. } );
  432. } );
  433. function expectValue( value, expected, options ) {
  434. expect( value.type ).to.equal( expected.type );
  435. if ( value.type == 'text' ) {
  436. expectText( value, expected, options );
  437. } else if ( value.type == 'elementStart' ) {
  438. expectStart( value, expected, options );
  439. } else if ( value.type == 'elementEnd' ) {
  440. expectEnd( value, expected, options );
  441. }
  442. }
  443. function expectText( value, expected, options = {} ) {
  444. let previousPosition, nextPosition;
  445. expect( value.item.data ).to.equal( expected.data );
  446. expect( Array.from( value.item.getAttributes() ) ).to.deep.equal( expected.attrs );
  447. expect( value.length ).to.equal( value.item.data.length );
  448. if ( options.direction == 'backward' ) {
  449. previousPosition = Position.createAfter( value.item );
  450. nextPosition = Position.createBefore( value.item );
  451. } else {
  452. previousPosition = Position.createBefore( value.item );
  453. nextPosition = Position.createAfter( value.item );
  454. }
  455. expect( value.previousPosition ).to.deep.equal( previousPosition );
  456. expect( value.nextPosition ).to.deep.equal( nextPosition );
  457. }
  458. function expectStart( value, expected, options = {} ) {
  459. let previousPosition, nextPosition;
  460. expect( value.item ).to.equal( expected.item );
  461. expect( value.length ).to.equal( 1 );
  462. if ( options.direction == 'backward' ) {
  463. previousPosition = Position.createAfter( value.item );
  464. nextPosition = Position.createBefore( value.item );
  465. } else {
  466. previousPosition = Position.createBefore( value.item );
  467. nextPosition = Position.createFromParentAndOffset( value.item, 0 );
  468. }
  469. if ( options.shallow ) {
  470. expect( value.previousPosition ).to.deep.equal( previousPosition );
  471. } else {
  472. expect( value.nextPosition ).to.deep.equal( nextPosition );
  473. }
  474. }
  475. function expectEnd( value, expected, options = {} ) {
  476. let previousPosition, nextPosition;
  477. expect( value.item ).to.equal( expected.item );
  478. expect( value.length ).to.be.undefined;
  479. if ( options.direction == 'backward' ) {
  480. previousPosition = Position.createAfter( value.item );
  481. nextPosition = Position.createFromParentAndOffset( value.item, value.item.maxOffset );
  482. } else {
  483. previousPosition = Position.createFromParentAndOffset( value.item, value.item.maxOffset );
  484. nextPosition = Position.createAfter( value.item );
  485. }
  486. expect( value.previousPosition ).to.deep.equal( previousPosition );
  487. expect( value.nextPosition ).to.deep.equal( nextPosition );
  488. }