treewalker.js 15 KB

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