8
0

treewalker.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357
  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;
  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. } );
  41. describe( 'constructor', () => {
  42. it( 'should throw if neither boundaries nor starting position is set', () => {
  43. expect( () => {
  44. new TreeWalker();
  45. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  46. expect( () => {
  47. new TreeWalker( {} );
  48. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  49. expect( () => {
  50. new TreeWalker( { mergeCharacters: true } );
  51. } ).to.throw( CKEditorError, /^tree-walker-no-start-position/ );
  52. } );
  53. } );
  54. describe( 'iterate', () => {
  55. beforeEach( () => {
  56. expected = [
  57. { type: 'ELEMENT_START', item: img1 },
  58. { type: 'ELEMENT_END', item: img1 },
  59. { type: 'ELEMENT_START', item: paragraph },
  60. { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] },
  61. { type: 'TEXT', text: 'r', attrs: [] },
  62. { type: 'ELEMENT_START', item: img2 },
  63. { type: 'ELEMENT_END', item: img2 },
  64. { type: 'TEXT', text: 'x', attrs: [] },
  65. { type: 'ELEMENT_END', item: paragraph }
  66. ];
  67. } );
  68. it( 'should provide iterator methods', () => {
  69. let iterator = new TreeWalker( { startPosition: rootBeginning } );
  70. for ( let i = 0; i <= 8; i++ ) {
  71. expectItem( iterator.next(), expected[ i ] );
  72. }
  73. expect( iterator.next() ).to.have.property( 'done' ).that.is.true;
  74. } );
  75. it( 'should provide iterator interface', () => {
  76. let iterator = new TreeWalker( { startPosition: rootBeginning } );
  77. let i = 0;
  78. for ( let value of iterator ) {
  79. expectValue( value, expected[ i ] );
  80. i++;
  81. }
  82. expect( i ).to.equal( expected.length );
  83. } );
  84. it( 'should start at the startPosition', () => {
  85. let iterator = new TreeWalker( { startPosition: new Position( root, [ 1 ] ) } );
  86. let i = 2;
  87. for ( let value of iterator ) {
  88. expectValue( value, expected[ i ] );
  89. i++;
  90. }
  91. expect( i ).to.equal( expected.length );
  92. } );
  93. } );
  94. describe( 'range', () => {
  95. it( 'should iterating over the range', () => {
  96. expected = [
  97. { type: 'ELEMENT_START', item: paragraph },
  98. { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] },
  99. { type: 'TEXT', text: 'r', attrs: [] },
  100. { type: 'ELEMENT_START', item: img2 },
  101. { type: 'ELEMENT_END', item: img2 }
  102. ];
  103. let start = new Position( root, [ 1 ] );
  104. let end = new Position( root, [ 1, 4 ] );
  105. let range = new Range( start, end );
  106. let iterator = new TreeWalker( { boundaries: range } );
  107. let i = 0;
  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 return part of the text if range starts inside the text', () => {
  115. expected = [
  116. { type: 'TEXT', text: 'a', attrs: [ [ 'bold', true ] ] },
  117. { type: 'TEXT', text: 'r', attrs: [] },
  118. { type: 'ELEMENT_START', item: img2 },
  119. { type: 'ELEMENT_END', item: img2 }
  120. ];
  121. let start = new Position( root, [ 1, 1 ] );
  122. let end = new Position( root, [ 1, 4 ] );
  123. let range = new Range( start, end );
  124. let iterator = new TreeWalker( { boundaries: range } );
  125. let i = 0;
  126. for ( let value of iterator ) {
  127. expectValue( value, expected[ i ] );
  128. i++;
  129. }
  130. expect( i ).to.equal( expected.length );
  131. } );
  132. it( 'should return part of the text if range ends inside the text', () => {
  133. expected = [
  134. { type: 'ELEMENT_START', item: img1 },
  135. { type: 'ELEMENT_END', item: img1 },
  136. { type: 'ELEMENT_START', item: paragraph },
  137. { type: 'TEXT', text: 'b', attrs: [ [ 'bold', true ] ] }
  138. ];
  139. let start = rootBeginning;
  140. let end = new Position( root, [ 1, 1 ] );
  141. let range = new Range( start, end );
  142. let iterator = new TreeWalker( { boundaries: range } );
  143. let i = 0;
  144. for ( let value of iterator ) {
  145. expectValue( value, expected[ i ] );
  146. i++;
  147. }
  148. expect( i ).to.equal( expected.length );
  149. } );
  150. } );
  151. describe( 'singleCharacters', () => {
  152. beforeEach( () => {
  153. expected = [
  154. { type: 'ELEMENT_START', item: img1 },
  155. { type: 'ELEMENT_END', item: img1 },
  156. { type: 'ELEMENT_START', item: paragraph },
  157. { type: 'CHARACTER', text: 'b', attrs: [ [ 'bold', true ] ] },
  158. { type: 'CHARACTER', text: 'a', attrs: [ [ 'bold', true ] ] },
  159. { type: 'CHARACTER', text: 'r', attrs: [] },
  160. { type: 'ELEMENT_START', item: img2 },
  161. { type: 'ELEMENT_END', item: img2 },
  162. { type: 'CHARACTER', text: 'x', attrs: [] },
  163. { type: 'ELEMENT_END', item: paragraph }
  164. ];
  165. } );
  166. it( 'should return single characters', () => {
  167. let iterator = new TreeWalker( { startPosition: rootBeginning, singleCharacters: true } );
  168. let i = 0;
  169. for ( let value of iterator ) {
  170. expectValue( value, expected[ i ] );
  171. i++;
  172. }
  173. expect( i ).to.equal( expected.length );
  174. } );
  175. it( 'should respect boundaries', () => {
  176. let start = new Position( root, [ 1, 0 ] ); // p, 0
  177. let end = new Position( root, [ 1, 3, 0 ] ); // img, 0
  178. let iterator = new TreeWalker( { boundaries: new Range( start, end ), singleCharacters: true } );
  179. let i = 3;
  180. for ( let value of iterator ) {
  181. expectValue( value, expected[ i ] );
  182. i++;
  183. }
  184. expect( i ).to.equal( 7 );
  185. } );
  186. } );
  187. describe( 'shallow', () => {
  188. beforeEach( () => {
  189. expected = [
  190. { type: 'ELEMENT_START', item: img1 },
  191. { type: 'ELEMENT_START', item: paragraph }
  192. ];
  193. } );
  194. it( 'should not enter elements', () => {
  195. let iterator = new TreeWalker( { startPosition: rootBeginning, shallow: true } );
  196. let i = 0;
  197. for ( let value of iterator ) {
  198. expectValue( value, expected[ i ], { shallow: true } );
  199. i++;
  200. }
  201. expect( i ).to.equal( expected.length );
  202. } );
  203. } );
  204. describe( 'ignoreElementEnd', () => {
  205. it( 'should iterate ignoring ELEMENT_END', () => {
  206. expected = [
  207. { type: 'ELEMENT_START', item: img1 },
  208. { type: 'ELEMENT_START', item: paragraph },
  209. { type: 'TEXT', text: 'ba', attrs: [ [ 'bold', true ] ] },
  210. { type: 'TEXT', text: 'r', attrs: [] },
  211. { type: 'ELEMENT_START', item: img2 },
  212. { type: 'TEXT', text: 'x', attrs: [] }
  213. ];
  214. let iterator = new TreeWalker( { startPosition: rootBeginning, ignoreElementEnd: true } );
  215. let i = 0;
  216. for ( let value of iterator ) {
  217. expectValue( value, expected[ i ] );
  218. i++;
  219. }
  220. expect( i ).to.equal( expected.length );
  221. } );
  222. it( 'should return single characters ignoring ELEMENT_END', () => {
  223. expected = [
  224. { type: 'ELEMENT_START', item: img1 },
  225. { type: 'ELEMENT_START', item: paragraph },
  226. { type: 'CHARACTER', text: 'b', attrs: [ [ 'bold', true ] ] },
  227. { type: 'CHARACTER', text: 'a', attrs: [ [ 'bold', true ] ] },
  228. { type: 'CHARACTER', text: 'r', attrs: [] },
  229. { type: 'ELEMENT_START', item: img2 },
  230. { type: 'CHARACTER', text: 'x', attrs: [] }
  231. ];
  232. let iterator = new TreeWalker( {
  233. startPosition: rootBeginning,
  234. singleCharacters: true,
  235. ignoreElementEnd: true
  236. } );
  237. let i = 0;
  238. for ( let value of iterator ) {
  239. expectValue( value, expected[ i ] );
  240. i++;
  241. }
  242. expect( i ).to.equal( expected.length );
  243. } );
  244. } );
  245. } );
  246. function expectItem( item, expected, options ) {
  247. expect( item.done ).to.be.false;
  248. expectValue( item.value, expected, options );
  249. }
  250. function expectValue( value, expected, options ) {
  251. expect( value.type ).to.equal( expected.type );
  252. if ( value.type == 'TEXT' ) {
  253. expectText( value, expected, options );
  254. } else if ( value.type == 'CHARACTER' ) {
  255. expectCharacter( value, expected, options );
  256. } else if ( value.type == 'ELEMENT_START' ) {
  257. expectStart( value, expected, options );
  258. } else if ( value.type == 'ELEMENT_END' ) {
  259. expectEnd( value, expected, options );
  260. }
  261. }
  262. function expectText( value, expected ) {
  263. expect( value.item.text ).to.equal( expected.text );
  264. expect( Array.from( value.item.first._attrs ) ).to.deep.equal( expected.attrs );
  265. expect( value.length ).to.equal( value.item.text.length );
  266. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item.first ) );
  267. expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item.last ) );
  268. }
  269. function expectCharacter( value, expected ) {
  270. expect( value.item.character ).to.equal( expected.text );
  271. expect( Array.from( value.item._attrs ) ).to.deep.equal( expected.attrs );
  272. expect( value.length ).to.equal( value.item.character.length );
  273. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) );
  274. expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) );
  275. }
  276. function expectStart( value, expected, options ) {
  277. expect( value.item ).to.equal( expected.item );
  278. expect( value.length ).to.equal( 1 );
  279. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) );
  280. if ( options && options.shallow ) {
  281. expect( value.previousPosition ).to.deep.equal( Position.createBefore( value.item ) );
  282. } else {
  283. expect( value.nextPosition ).to.deep.equal( Position.createFromParentAndOffset( value.item, 0 ) );
  284. }
  285. }
  286. function expectEnd( value, expected ) {
  287. expect( value.item ).to.equal( expected.item );
  288. expect( value.length ).to.be.undefined;
  289. expect( value.previousPosition ).to.deep.equal(
  290. Position.createFromParentAndOffset( value.item, value.item.getChildCount() ) );
  291. expect( value.nextPosition ).to.deep.equal( Position.createAfter( value.item ) );
  292. }