treewalker.js 16 KB

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