treewalker.js 16 KB

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