treewalker.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615
  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, 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 AttributeElement( 'b', null, [ textBa ] );
  35. charR = new Text( 'r' );
  36. img2 = new ContainerElement( 'img2' );
  37. charX = new Text( 'x' );
  38. paragraph = new ContainerElement( 'p', null, [ bold, charR, img2, charX ] );
  39. img1 = new ContainerElement( '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. }
  85. expect( i ).to.equal( expected.length );
  86. } );
  87. it( 'should provide iterator interface with FORWARD direction', () => {
  88. let iterator = new TreeWalker( { startPosition: rootBeginning, direction: 'FORWARD' } );
  89. let i = 0;
  90. for ( let value of iterator ) {
  91. expectValue( value, expected[ i++ ] );
  92. }
  93. expect( i ).to.equal( expected.length );
  94. } );
  95. it( 'should provide iterator interface which BACKWARD direction', () => {
  96. let iterator = new TreeWalker( { startPosition: rootEnding, direction: 'BACKWARD' } );
  97. let i = expected.length;
  98. for ( let value of iterator ) {
  99. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  100. }
  101. expect( i ).to.equal( 0 );
  102. } );
  103. it( 'should start iterating at the startPosition witch is not a root bound', () => {
  104. let iterator = new TreeWalker( { startPosition: new Position( root, 1 ) } );
  105. let i = 2;
  106. for ( let value of iterator ) {
  107. expectValue( value, expected[ i++ ] );
  108. }
  109. expect( i ).to.equal( expected.length );
  110. } );
  111. it( 'should start iterating at the startPosition witch is not a root bound, going backward', () => {
  112. let expected = [
  113. { type: 'ELEMENT_START', item: img1 },
  114. { type: 'ELEMENT_END', item: img1 }
  115. ];
  116. let iterator = new TreeWalker( { startPosition: new Position( root, 1 ), direction: 'BACKWARD' } );
  117. let i = expected.length;
  118. for ( let value of iterator ) {
  119. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  120. }
  121. expect( i ).to.equal( 0 );
  122. } );
  123. } );
  124. describe( 'iterate trough the range `boundary`', () => {
  125. describe( 'range starts between elements', () => {
  126. let expected, range;
  127. before( () => {
  128. expected = [
  129. { type: 'ELEMENT_START', item: paragraph },
  130. { type: 'ELEMENT_START', item: bold },
  131. { type: 'TEXT', text: 'ba' },
  132. { type: 'ELEMENT_END', item: bold },
  133. { type: 'TEXT', text: 'r' },
  134. { type: 'ELEMENT_START', item: img2 },
  135. { type: 'ELEMENT_END', item: img2 }
  136. ];
  137. range = Range.createFromParentsAndOffsets( root, 1, paragraph, 3 );
  138. } );
  139. it( 'should iterating over the range', () => {
  140. let iterator = new TreeWalker( { boundaries: range } );
  141. let i = 0;
  142. for ( let value of iterator ) {
  143. expectValue( value, expected[ i++ ] );
  144. }
  145. expect( i ).to.equal( expected.length );
  146. } );
  147. it( 'should iterating over the range going backward', () => {
  148. let iterator = new TreeWalker( { boundaries: range, direction: 'BACKWARD' } );
  149. let i = expected.length;
  150. for ( let value of iterator ) {
  151. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  152. }
  153. expect( i ).to.equal( 0 );
  154. } );
  155. } );
  156. describe( 'range starts inside the text', () => {
  157. let expected, range;
  158. before( () => {
  159. expected = [
  160. { type: 'TEXT', text: 'a' },
  161. { type: 'ELEMENT_END', item: bold },
  162. { type: 'TEXT', text: 'r' },
  163. { type: 'ELEMENT_START', item: img2 },
  164. { type: 'ELEMENT_END', item: img2 }
  165. ];
  166. range = Range.createFromParentsAndOffsets( textBa, 1, paragraph, 3 );
  167. } );
  168. it( 'should return part of the text', () => {
  169. let iterator = new TreeWalker( { boundaries: range } );
  170. let i = 0;
  171. for ( let value of iterator ) {
  172. expectValue( value, expected[ i++ ] );
  173. }
  174. expect( i ).to.equal( expected.length );
  175. } );
  176. it( 'should return part of the text going backward', () => {
  177. let iterator = new TreeWalker( {
  178. boundaries: range,
  179. direction: 'BACKWARD'
  180. }
  181. );
  182. let i = expected.length;
  183. for ( let value of iterator ) {
  184. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  185. }
  186. expect( i ).to.equal( 0 );
  187. } );
  188. } );
  189. describe( 'range ends inside the text', () => {
  190. let expected, range;
  191. before( () => {
  192. expected = [
  193. { type: 'ELEMENT_START', item: img1 },
  194. { type: 'ELEMENT_END', item: img1 },
  195. { type: 'ELEMENT_START', item: paragraph },
  196. { type: 'ELEMENT_START', item: bold },
  197. { type: 'TEXT', text: 'b' }
  198. ];
  199. range = new Range( rootBeginning, new Position( textBa, 1 ) );
  200. } );
  201. it( 'should return part of the text', () => {
  202. let iterator = new TreeWalker( { boundaries: range } );
  203. let i = 0;
  204. for ( let value of iterator ) {
  205. expectValue( value, expected[ i++ ] );
  206. }
  207. expect( i ).to.equal( expected.length );
  208. } );
  209. it( 'should return part of the text going backward', () => {
  210. let iterator = new TreeWalker( {
  211. boundaries: range,
  212. startPosition: range.end,
  213. direction: 'BACKWARD'
  214. } );
  215. let i = expected.length;
  216. for ( let value of iterator ) {
  217. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  218. }
  219. expect( i ).to.equal( 0 );
  220. } );
  221. } );
  222. describe( 'custom start position', () => {
  223. it( 'should iterating from the start position', () => {
  224. let expected = [
  225. { type: 'TEXT', text: 'r' },
  226. { type: 'ELEMENT_START', item: img2 },
  227. { type: 'ELEMENT_END', item: img2 }
  228. ];
  229. let range = Range.createFromParentsAndOffsets( bold, 1, paragraph, 3 );
  230. let iterator = new TreeWalker( {
  231. boundaries: range,
  232. startPosition: new Position( paragraph, 1 )
  233. } );
  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 iterating from the start position going backward', () => {
  241. let expected = [
  242. { type: 'TEXT', text: 'r' },
  243. { type: 'ELEMENT_END', item: bold },
  244. { type: 'TEXT', text: 'a' }
  245. ];
  246. let range = new Range( new Position( textBa, 1 ), new Position( paragraph, 3 ) );
  247. let iterator = new TreeWalker( {
  248. boundaries: range,
  249. startPosition: new Position( paragraph, 2 ),
  250. direction: 'BACKWARD'
  251. } );
  252. let i = 0;
  253. for ( let value of iterator ) {
  254. expectValue( value, expected[ i++ ], { direction: 'BACKWARD' } );
  255. }
  256. expect( i ).to.equal( expected.length );
  257. } );
  258. } );
  259. } );
  260. describe( 'iterate by every single characters `singleCharacter`', () => {
  261. describe( 'whole root', () => {
  262. let expected;
  263. before( () => {
  264. expected = [
  265. { type: 'ELEMENT_START', item: img1 },
  266. { type: 'ELEMENT_END', item: img1 },
  267. { type: 'ELEMENT_START', item: paragraph },
  268. { type: 'ELEMENT_START', item: bold },
  269. { type: 'TEXT', text: 'b' },
  270. { type: 'TEXT', text: 'a' },
  271. { type: 'ELEMENT_END', item: bold },
  272. { type: 'TEXT', text: 'r' },
  273. { type: 'ELEMENT_START', item: img2 },
  274. { type: 'ELEMENT_END', item: img2 },
  275. { type: 'TEXT', text: 'x' },
  276. { type: 'ELEMENT_END', item: paragraph }
  277. ];
  278. } );
  279. it( 'should return single characters', () => {
  280. let iterator = new TreeWalker( { startPosition: rootBeginning, singleCharacters: true } );
  281. let i = 0;
  282. for ( let value of iterator ) {
  283. expectValue( value, expected[ i++ ] );
  284. }
  285. expect( i ).to.equal( expected.length );
  286. } );
  287. it( 'should return single characters going backward', () => {
  288. let iterator = new TreeWalker( {
  289. startPosition: rootEnding,
  290. singleCharacters: true,
  291. direction: 'BACKWARD'
  292. } );
  293. let i = expected.length;
  294. for ( let value of iterator ) {
  295. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  296. }
  297. expect( i ).to.equal( 0 );
  298. } );
  299. } );
  300. describe( 'range', () => {
  301. let range, expected;
  302. before( () => {
  303. expected = [
  304. { type: 'TEXT', text: 'b' },
  305. { type: 'TEXT', text: 'a' },
  306. { type: 'ELEMENT_END', item: bold },
  307. { type: 'TEXT', text: 'r' },
  308. { type: 'ELEMENT_START', item: img2 }
  309. ];
  310. range = new Range( new Position( bold, 0 ), new Position( img2, 0 ) );
  311. } );
  312. it( 'should respect boundaries', () => {
  313. let iterator = new TreeWalker( { boundaries: range, 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 respect boundaries going backward', () => {
  321. let iterator = new TreeWalker( {
  322. boundaries: range,
  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. } );
  334. describe( 'iterate omitting child nodes and ELEMENT_END `shallow`', () => {
  335. let expected;
  336. before( () => {
  337. expected = [
  338. { type: 'ELEMENT_START', item: img1 },
  339. { type: 'ELEMENT_START', item: paragraph }
  340. ];
  341. } );
  342. it( 'should not enter elements', () => {
  343. let iterator = new TreeWalker( { startPosition: rootBeginning, shallow: true } );
  344. let i = 0;
  345. for ( let value of iterator ) {
  346. expectValue( value, expected[ i++ ], { shallow: true } );
  347. }
  348. expect( i ).to.equal( expected.length );
  349. } );
  350. it( 'should not enter elements going backward', () => {
  351. let iterator = new TreeWalker( { startPosition: rootEnding, shallow: true, direction: 'BACKWARD' } );
  352. let i = expected.length;
  353. for ( let value of iterator ) {
  354. expectValue( value, expected[ --i ], { shallow: true, direction: 'BACKWARD' } );
  355. }
  356. expect( i ).to.equal( 0 );
  357. } );
  358. } );
  359. describe( 'iterate omitting ELEMENT_END `ignoreElementEnd`', () => {
  360. describe( 'merged text', () => {
  361. let expected;
  362. before( () => {
  363. expected = [
  364. { type: 'ELEMENT_START', item: img1 },
  365. { type: 'ELEMENT_START', item: paragraph },
  366. { type: 'ELEMENT_START', item: bold },
  367. { type: 'TEXT', text: 'ba' },
  368. { type: 'TEXT', text: 'r' },
  369. { type: 'ELEMENT_START', item: img2 },
  370. { type: 'TEXT', text: 'x' }
  371. ];
  372. } );
  373. it( 'should iterate ignoring ELEMENT_END', () => {
  374. let iterator = new TreeWalker( { startPosition: rootBeginning, ignoreElementEnd: true } );
  375. let i = 0;
  376. for ( let value of iterator ) {
  377. expectValue( value, expected[ i++ ] );
  378. }
  379. expect( i ).to.equal( expected.length );
  380. } );
  381. it( 'should iterate ignoring ELEMENT_END going backward', () => {
  382. let iterator = new TreeWalker( {
  383. startPosition: rootEnding,
  384. ignoreElementEnd: true,
  385. direction: 'BACKWARD'
  386. } );
  387. let i = expected.length;
  388. for ( let value of iterator ) {
  389. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  390. }
  391. expect( i ).to.equal( 0 );
  392. } );
  393. } );
  394. describe( 'single character', () => {
  395. let expected;
  396. before( () => {
  397. expected = [
  398. { type: 'ELEMENT_START', item: img1 },
  399. { type: 'ELEMENT_START', item: paragraph },
  400. { type: 'ELEMENT_START', item: bold },
  401. { type: 'TEXT', text: 'b' },
  402. { type: 'TEXT', text: 'a' },
  403. { type: 'TEXT', text: 'r' },
  404. { type: 'ELEMENT_START', item: img2 },
  405. { type: 'TEXT', text: 'x' }
  406. ];
  407. } );
  408. it( 'should return single characters ignoring ELEMENT_END', () => {
  409. let iterator = new TreeWalker( {
  410. startPosition: rootBeginning,
  411. singleCharacters: true,
  412. ignoreElementEnd: true
  413. } );
  414. let i = 0;
  415. for ( let value of iterator ) {
  416. expectValue( value, expected[ i++ ] );
  417. }
  418. expect( i ).to.equal( expected.length );
  419. } );
  420. it( 'should return single characters ignoring ELEMENT_END going backward', () => {
  421. let iterator = new TreeWalker( {
  422. startPosition: rootEnding,
  423. singleCharacters: true,
  424. ignoreElementEnd: true,
  425. direction: 'BACKWARD'
  426. } );
  427. let i = expected.length;
  428. for ( let value of iterator ) {
  429. expectValue( value, expected[ --i ], { direction: 'BACKWARD' } );
  430. }
  431. expect( i ).to.equal( 0 );
  432. } );
  433. } );
  434. } );
  435. } );
  436. function expectValue( value, expected, options = {} ) {
  437. expect( value.type ).to.equal( expected.type );
  438. if ( value.type == 'TEXT' ) {
  439. expectText( value, expected, options );
  440. } else if ( value.type == 'ELEMENT_START' ) {
  441. expectStart( value, expected, options );
  442. } else if ( value.type == 'ELEMENT_END' ) {
  443. expectEnd( value, expected, options );
  444. }
  445. }
  446. function expectText( value, expected, options ) {
  447. let previousPosition, nextPosition;
  448. expect( value.item._data ).to.equal( expected.text );
  449. expect( value.length ).to.equal( value.item._data.length );
  450. if ( options.direction == 'BACKWARD' ) {
  451. previousPosition = Position.createAfter( value.item );
  452. nextPosition = Position.createBefore( value.item );
  453. } else {
  454. previousPosition = Position.createBefore( value.item );
  455. nextPosition = Position.createAfter( value.item );
  456. }
  457. expect( value.previousPosition ).to.deep.equal( previousPosition );
  458. expect( value.nextPosition ).to.deep.equal( nextPosition );
  459. }
  460. function expectStart( value, expected, options ) {
  461. let previousPosition, nextPosition;
  462. expect( value.item ).to.equal( expected.item );
  463. expect( value.length ).to.equal( 1 );
  464. if ( options.direction == 'BACKWARD' ) {
  465. previousPosition = Position.createAfter( value.item );
  466. nextPosition = Position.createBefore( value.item );
  467. } else {
  468. previousPosition = Position.createBefore( value.item );
  469. nextPosition = new Position( value.item, 0 );
  470. }
  471. if ( options.shallow ) {
  472. expect( value.previousPosition ).to.deep.equal( previousPosition );
  473. } else {
  474. expect( value.nextPosition ).to.deep.equal( nextPosition );
  475. }
  476. }
  477. function expectEnd( value, expected, options ) {
  478. let previousPosition, nextPosition;
  479. expect( value.item ).to.equal( expected.item );
  480. expect( value.length ).to.be.undefined;
  481. if ( options.direction == 'BACKWARD' ) {
  482. previousPosition = Position.createAfter( value.item );
  483. nextPosition = new Position( value.item, value.item.getChildCount() );
  484. } else {
  485. previousPosition = new Position( value.item, value.item.getChildCount() );
  486. nextPosition = Position.createAfter( value.item );
  487. }
  488. expect( value.previousPosition ).to.deep.equal( previousPosition );
  489. expect( value.nextPosition ).to.deep.equal( nextPosition );
  490. }