8
0

range.js 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: view */
  6. import Range from '/ckeditor5/engine/view/range.js';
  7. import Position from '/ckeditor5/engine/view/position.js';
  8. import Element from '/ckeditor5/engine/view/element.js';
  9. import DocumentFragment from '/ckeditor5/engine/view/documentfragment.js';
  10. import Text from '/ckeditor5/engine/view/text.js';
  11. import TreeWalker from '/ckeditor5/engine/view/treewalker.js';
  12. import { parse } from '/tests/engine/_utils/view.js';
  13. function getRange( view, options = {} ) {
  14. const { selection } = parse( view, options );
  15. return selection.getFirstRange();
  16. }
  17. describe( 'Range', () => {
  18. describe( 'constructor', () => {
  19. it( 'creates range from provided positions', () => {
  20. const start = new Position( {}, 1 );
  21. const end = new Position( {}, 2 );
  22. const range = new Range( start, end );
  23. expect( range ).to.be.an.instanceof( Range );
  24. expect( range ).to.have.property( 'start' ).that.not.equals( start );
  25. expect( range ).to.have.property( 'end' ).that.not.equals( end );
  26. expect( range.start.parent ).to.equal( start.parent );
  27. expect( range.end.parent ).to.equal( end.parent );
  28. expect( range.start.offset ).to.equal( start.offset );
  29. expect( range.end.offset ).to.equal( end.offset );
  30. } );
  31. } );
  32. describe( 'iterator', () => {
  33. it( 'should iterate over the range returning tree walker values', () => {
  34. const range = getRange( '<p>fo{o</p><p>bar</p><p>xy}z</p>' );
  35. const values = Array.from( range );
  36. expect( values.length ).to.equal( 5 );
  37. expect( values[ 0 ].item.data ).to.equal( 'o' );
  38. expect( values[ 1 ].item.name ).to.equal( 'p' );
  39. expect( values[ 2 ].item.data ).to.equal( 'bar' );
  40. expect( values[ 3 ].item.name ).to.equal( 'p' );
  41. expect( values[ 4 ].item.data ).to.equal( 'xy' );
  42. } );
  43. } );
  44. describe( 'isFlat', () => {
  45. it( 'should be true if range start and range end are in same parent', () => {
  46. const range = getRange( '<p>f{oo}</p><p>bar</p>' );
  47. expect( range.isFlat ).to.be.true;
  48. } );
  49. it( 'should be false if range start and range end are in different parents', () => {
  50. const range = getRange( '<p>fo{o</p><p>b}ar</p>' );
  51. expect( range.isFlat ).to.be.false;
  52. } );
  53. } );
  54. describe( 'getRoot', () => {
  55. it( 'should return root element in which range is created', () => {
  56. const viewRoot = new Element( 'div' );
  57. const range = getRange( '<p>f{oo</p><p>ba}r</p>', { rootElement: viewRoot } );
  58. expect( range.root ).to.equal( viewRoot );
  59. } );
  60. it( 'should return document fragment in which range is created', () => {
  61. const viewFrag = new DocumentFragment();
  62. const range = getRange( '<p>f{oo</p><p>ba}r</p>', { rootElement: viewFrag } );
  63. expect( range.root ).to.equal( viewFrag );
  64. } );
  65. } );
  66. describe( 'isEqual', () => {
  67. it( 'should return true for the same range', () => {
  68. const start = new Position( {}, 1 );
  69. const end = new Position( {}, 2 );
  70. const range = new Range( start, end );
  71. expect( range.isEqual( range ) ).to.be.true;
  72. } );
  73. it( 'should return true for ranges with same start and end positions', () => {
  74. const start = new Position( {}, 1 );
  75. const end = new Position( {}, 2 );
  76. const range1 = new Range( start, end );
  77. const range2 = new Range( start, end );
  78. expect( range1.isEqual( range2 ) ).to.be.true;
  79. } );
  80. it( 'should return false if start position is different', () => {
  81. const start1 = new Position( {}, 1 );
  82. const start2 = new Position( {}, 1 );
  83. const end = new Position( {}, 2 );
  84. const range1 = new Range( start1, end );
  85. const range2 = new Range( start2, end );
  86. expect( range1.isEqual( range2 ) ).to.be.false;
  87. } );
  88. it( 'should return false if end position is different', () => {
  89. const start = new Position( {}, 1 );
  90. const end1 = new Position( {}, 2 );
  91. const end2 = new Position( {}, 2 );
  92. const range1 = new Range( start, end1 );
  93. const range2 = new Range( start, end2 );
  94. expect( range1.isEqual( range2 ) ).to.be.false;
  95. } );
  96. it( 'should return false for ranges with same root and different offsets', () => {
  97. const mockObject = {};
  98. const range1 = new Range( new Position( mockObject, 0 ), new Position( mockObject, 10 ) );
  99. const range2 = new Range( new Position( mockObject, 2 ), new Position( mockObject, 10 ) );
  100. expect( range1.isEqual( range2 ) ).to.be.false;
  101. } );
  102. } );
  103. describe( 'containsPosition', () => {
  104. let viewRoot, range;
  105. beforeEach( () => {
  106. viewRoot = new Element( 'div' );
  107. range = getRange( '<p>fo{o</p><p>bar</p><p>xy}z</p>', { rootElement: viewRoot } );
  108. } );
  109. it( 'should return false if position is before range', () => {
  110. const position = new Position( viewRoot.getChild( 0 ).getChild( 0 ), 1 ); // After "f".
  111. expect( range.containsPosition( position ) ).to.be.false;
  112. } );
  113. it( 'should return false if position is after range', () => {
  114. const position = new Position( viewRoot.getChild( 2 ).getChild( 0 ), 3 ); // After "z".
  115. expect( range.containsPosition( position ) ).to.be.false;
  116. } );
  117. it( 'should return true if position is inside range', () => {
  118. const position = new Position( viewRoot.getChild( 1 ).getChild( 0 ), 1 ); // After "b".
  119. expect( range.containsPosition( position ) ).to.be.true;
  120. } );
  121. } );
  122. describe( 'containsRange', () => {
  123. let viewRoot, range, beforeF, afterF, beforeB, afterX;
  124. beforeEach( () => {
  125. viewRoot = new Element( 'div' );
  126. range = getRange( '<p>fo{o</p><p>bar</p><p>xy}z</p>', { rootElement: viewRoot } );
  127. beforeF = new Position( viewRoot.getChild( 0 ).getChild( 0 ), 0 );
  128. afterF = new Position( viewRoot.getChild( 0 ).getChild( 0 ), 1 );
  129. beforeB = new Position( viewRoot.getChild( 1 ).getChild( 0 ), 0 );
  130. afterX = new Position( viewRoot.getChild( 2 ).getChild( 0 ), 1 );
  131. } );
  132. it( 'should return false if ranges do not intersect', () => {
  133. const otherRange = new Range( beforeF, afterF );
  134. expect( range.containsRange( otherRange ) ).to.be.false;
  135. } );
  136. it( 'should return false if ranges intersect but only partially', () => {
  137. const otherRange = new Range( afterF, afterX );
  138. expect( range.containsRange( otherRange ) ).to.be.false;
  139. } );
  140. it( 'should return false if ranges are equal', () => {
  141. const otherRange = Range.createFromRange( range );
  142. expect( range.containsRange( otherRange ) ).to.be.false;
  143. } );
  144. it( 'should return true if given range is inside range', () => {
  145. const otherRange = new Range( beforeB, afterX );
  146. expect( range.containsRange( otherRange ) ).to.be.true;
  147. } );
  148. } );
  149. describe( 'other range interaction', () => {
  150. let root, p1, p2, t1, t2, t3;
  151. // root
  152. // __________|__________
  153. // | |
  154. // ___p1___ p2
  155. // | | |
  156. // t1 t2 t3
  157. beforeEach( () => {
  158. t1 = new Text( 'foo' );
  159. t2 = new Text( 'bar' );
  160. t3 = new Text( 'baz' );
  161. p1 = new Element( 'p', null, [ t1, t2 ] );
  162. p2 = new Element( 'p', null, t3 );
  163. root = new Element( 'div', null, [ p1, p2 ] );
  164. } );
  165. describe( 'isIntersecting', () => {
  166. it( 'should return true if given range is equal', () => {
  167. const range = Range.createFromParentsAndOffsets( t1, 0, t3, 2 );
  168. const otherRange = Range.createFromRange( range );
  169. expect( range.isIntersecting( otherRange ) ).to.be.true;
  170. expect( otherRange.isIntersecting( range ) ).to.be.true;
  171. } );
  172. it( 'should return true if given range contains this range', () => {
  173. const range = Range.createFromParentsAndOffsets( t1, 0, t3, 3 );
  174. const otherRange = Range.createFromParentsAndOffsets( p1, 1, t2, 2 );
  175. expect( range.isIntersecting( otherRange ) ).to.be.true;
  176. expect( otherRange.isIntersecting( range ) ).to.be.true;
  177. } );
  178. it( 'should return true if given range ends in this range', () => {
  179. const range = Range.createFromParentsAndOffsets( root, 1, t3, 3 );
  180. const otherRange = Range.createFromParentsAndOffsets( t1, 0, p2, 0 );
  181. expect( range.isIntersecting( otherRange ) ).to.be.true;
  182. expect( otherRange.isIntersecting( range ) ).to.be.true;
  183. } );
  184. it( 'should return true if given range starts in this range', () => {
  185. const range = Range.createFromParentsAndOffsets( t1, 0, t2, 3 );
  186. const otherRange = Range.createFromParentsAndOffsets( p1, 1, p2, 0 );
  187. expect( range.isIntersecting( otherRange ) ).to.be.true;
  188. expect( otherRange.isIntersecting( range ) ).to.be.true;
  189. } );
  190. it( 'should return false if given range is fully before/after this range', () => {
  191. const range = Range.createFromParentsAndOffsets( t1, 0, t2, 3 );
  192. const otherRange = Range.createFromParentsAndOffsets( root, 1, t3, 0 );
  193. expect( range.isIntersecting( otherRange ) ).to.be.false;
  194. expect( otherRange.isIntersecting( range ) ).to.be.false;
  195. } );
  196. it( 'should return false if ranges are in different roots', () => {
  197. const range = Range.createFromParentsAndOffsets( t1, 0, t2, 3 );
  198. const otherRange = Range.createFromParentsAndOffsets( new Element( 'div' ), 1, t3, 0 );
  199. expect( range.isIntersecting( otherRange ) ).to.be.false;
  200. expect( otherRange.isIntersecting( range ) ).to.be.false;
  201. } );
  202. } );
  203. describe( 'getDifference', () => {
  204. it( 'should return range equal to original range if other range does not intersect with it', () => {
  205. const range = Range.createFromParentsAndOffsets( t1, 0, t2, 3 );
  206. const otherRange = Range.createFromParentsAndOffsets( root, 1, t3, 0 );
  207. const difference = range.getDifference( otherRange );
  208. expect( difference.length ).to.equal( 1 );
  209. expect( difference[ 0 ].isEqual( range ) ).to.be.true;
  210. } );
  211. it( 'should return shrunken range if other range intersects with it', () => {
  212. const range = Range.createFromParentsAndOffsets( root, 1, t3, 3 );
  213. const otherRange = Range.createFromParentsAndOffsets( t1, 0, p2, 0 );
  214. const difference = range.getDifference( otherRange );
  215. expect( difference.length ).to.equal( 1 );
  216. expect( difference[ 0 ].start.parent ).to.equal( p2 );
  217. expect( difference[ 0 ].start.offset ).to.equal( 0 );
  218. expect( difference[ 0 ].end.parent ).to.equal( t3 );
  219. expect( difference[ 0 ].end.offset ).to.equal( 3 );
  220. } );
  221. it( 'should return an empty array if other range contains or is same as the original range', () => {
  222. const range = Range.createFromParentsAndOffsets( p1, 1, t2, 2 );
  223. const otherRange = Range.createFromParentsAndOffsets( t1, 0, t3, 3 );
  224. const difference = range.getDifference( otherRange );
  225. expect( difference.length ).to.equal( 0 );
  226. } );
  227. it( 'should two ranges if other range is contained by the original range', () => {
  228. const range = Range.createFromParentsAndOffsets( t1, 0, t3, 3 );
  229. const otherRange = Range.createFromParentsAndOffsets( p1, 1, t2, 2 );
  230. const difference = range.getDifference( otherRange );
  231. expect( difference.length ).to.equal( 2 );
  232. expect( difference[ 0 ].start.parent ).to.equal( t1 );
  233. expect( difference[ 0 ].start.offset ).to.equal( 0 );
  234. expect( difference[ 0 ].end.parent ).to.equal( p1 );
  235. expect( difference[ 0 ].end.offset ).to.equal( 1 );
  236. expect( difference[ 1 ].start.parent ).to.equal( t2 );
  237. expect( difference[ 1 ].start.offset ).to.equal( 2 );
  238. expect( difference[ 1 ].end.parent ).to.equal( t3 );
  239. expect( difference[ 1 ].end.offset ).to.equal( 3 );
  240. } );
  241. } );
  242. describe( 'getIntersection', () => {
  243. it( 'should return range equal to original range if other range contains it', () => {
  244. const range = Range.createFromParentsAndOffsets( t2, 0, t3, 0 );
  245. const otherRange = Range.createFromParentsAndOffsets( t1, 1, t3, 1 );
  246. const intersection = range.getIntersection( otherRange );
  247. expect( intersection.isEqual( range ) ).to.be.true;
  248. } );
  249. it( 'should return range equal to other range if it is contained in original range', () => {
  250. const range = Range.createFromParentsAndOffsets( t1, 1, t3, 1 );
  251. const otherRange = Range.createFromParentsAndOffsets( t2, 0, t3, 0 );
  252. const intersection = range.getIntersection( otherRange );
  253. expect( intersection.isEqual( otherRange ) ).to.be.true;
  254. } );
  255. it( 'should return null if ranges do not intersect', () => {
  256. const range = Range.createFromParentsAndOffsets( t1, 0, t2, 3 );
  257. const otherRange = Range.createFromParentsAndOffsets( t3, 0, t3, 3 );
  258. const intersection = range.getIntersection( otherRange );
  259. expect( intersection ).to.be.null;
  260. } );
  261. it( 'should return common part if ranges intersect partially', () => {
  262. const range = Range.createFromParentsAndOffsets( t1, 0, t2, 3 );
  263. const otherRange = Range.createFromParentsAndOffsets( t2, 0, t3, 3 );
  264. const intersection = range.getIntersection( otherRange );
  265. expect( intersection.start.parent ).to.equal( t2 );
  266. expect( intersection.start.offset ).to.equal( 0 );
  267. expect( intersection.end.parent ).to.equal( t2 );
  268. expect( intersection.end.offset ).to.equal( 3 );
  269. } );
  270. } );
  271. } );
  272. describe( 'getWalker', () => {
  273. it( 'should be possible to iterate using this method', () => {
  274. const range = getRange( '<p>fo{o</p><p>ba}r</p><p>xyz</p>' );
  275. const values = [];
  276. for ( let value of range.getWalker() ) {
  277. values.push( value );
  278. }
  279. expect( values.length ).to.equal( 4 );
  280. expect( values[ 0 ].item.data ).to.equal( 'o' );
  281. expect( values[ 1 ].item.name ).to.equal( 'p' );
  282. expect( values[ 1 ].type ).to.equal( 'elementEnd' );
  283. expect( values[ 2 ].item.name ).to.equal( 'p' );
  284. expect( values[ 2 ].type ).to.equal( 'elementStart' );
  285. expect( values[ 3 ].item.data ).to.equal( 'ba' );
  286. } );
  287. it( 'should accept TreeWalker options', () => {
  288. const range = getRange( '<p>foo</p><p>b{ar</p><p>xy}z</p>' );
  289. const walker = range.getWalker( { singleCharacters: true, ignoreElementEnd: true } );
  290. const values = [];
  291. for ( let value of walker ) {
  292. values.push( value );
  293. }
  294. expect( walker ).to.be.instanceof( TreeWalker );
  295. expect( walker ).to.have.property( 'singleCharacters' ).that.is.true;
  296. expect( values.length ).to.equal( 5 );
  297. expect( values[ 0 ].item.data ).to.equal( 'a' );
  298. expect( values[ 1 ].item.data ).to.equal( 'r' );
  299. expect( values[ 2 ].item.name ).to.equal( 'p' );
  300. expect( values[ 3 ].item.data ).to.equal( 'x' );
  301. expect( values[ 4 ].item.data ).to.equal( 'y' );
  302. } );
  303. } );
  304. describe( 'getItems', () => {
  305. it( 'should return iterator that iterates over all view items in the range', () => {
  306. const range = getRange( '<p>fo{o</p><p>bar</p><p>xy}z</p>' );
  307. const nodes = [];
  308. for ( let node of range.getItems() ) {
  309. nodes.push( node );
  310. }
  311. expect( nodes.length ).to.equal( 5 );
  312. expect( nodes[ 0 ].data ).to.equal( 'o' );
  313. expect( nodes[ 1 ].name ).to.equal( 'p' );
  314. expect( nodes[ 2 ].data ).to.equal( 'bar' );
  315. expect( nodes[ 3 ].name ).to.equal( 'p' );
  316. expect( nodes[ 4 ].data ).to.equal( 'xy' );
  317. } );
  318. it( 'should accept TreeWalker options', () => {
  319. const range = getRange( '<p>foo</p><p>b{ar</p><p>xy}z</p>' );
  320. const nodes = [];
  321. for ( let node of range.getItems( { singleCharacters: true } ) ) {
  322. nodes.push( node );
  323. }
  324. expect( nodes.length ).to.equal( 5 );
  325. expect( nodes[ 0 ].data ).to.equal( 'a' );
  326. expect( nodes[ 1 ].data ).to.equal( 'r' );
  327. expect( nodes[ 2 ].name ).to.equal( 'p' );
  328. expect( nodes[ 3 ].data ).to.equal( 'x' );
  329. expect( nodes[ 4 ].data ).to.equal( 'y' );
  330. } );
  331. } );
  332. describe( 'getPositions', () => {
  333. it( 'should return iterator that iterates over all positions in the range', () => {
  334. const range = getRange( '<p>fo{o</p><p>b}ar</p><p>xyz</p>' );
  335. const positions = [];
  336. for ( let position of range.getPositions() ) {
  337. positions.push( position );
  338. }
  339. expect( positions.length ).to.equal( 5 );
  340. expect( positions[ 0 ].parent.data ).to.equal( 'foo' ); // Inside text node "foo".
  341. expect( positions[ 0 ].offset ).to.equal( 2 );
  342. expect( positions[ 1 ].parent.name ).to.equal( 'p' ); // At the end of the first P element.
  343. expect( positions[ 1 ].offset ).to.equal( 1 );
  344. expect( positions[ 2 ].parent ).to.be.instanceof( DocumentFragment ); // In document fragment, between Ps.
  345. expect( positions[ 2 ].offset ).to.equal( 1 );
  346. expect( positions[ 3 ].parent.name ).to.equal( 'p' ); // At the beginning of the second P element.
  347. expect( positions[ 3 ].offset ).to.equal( 0 );
  348. expect( positions[ 4 ].parent.data ).to.equal( 'bar' ); // Inside text node "bar".
  349. expect( positions[ 4 ].offset ).to.equal( 1 );
  350. } );
  351. it( 'should accept TreeWalker options', () => {
  352. const range = getRange( '<p>foo</p><p>b{ar</p><p>xy}z</p>' );
  353. const positions = [];
  354. for ( let position of range.getPositions( { singleCharacters: true } ) ) {
  355. positions.push( position );
  356. }
  357. expect( positions.length ).to.equal( 7 );
  358. expect( positions[ 0 ].parent.data ).to.equal( 'bar' ); // "b^ar".
  359. expect( positions[ 0 ].offset ).to.equal( 1 );
  360. expect( positions[ 1 ].parent.data ).to.equal( 'bar' ); // "ba^r".
  361. expect( positions[ 1 ].offset ).to.equal( 2 );
  362. expect( positions[ 2 ].parent.name ).to.equal( 'p' ); // <p>bar^</p> -- at the end of P node.
  363. expect( positions[ 2 ].offset ).to.equal( 1 );
  364. expect( positions[ 3 ].parent ).to.be.instanceof( DocumentFragment ); // "</p>^<p>" -- between P nodes.
  365. expect( positions[ 3 ].offset ).to.equal( 2 );
  366. expect( positions[ 4 ].parent.name ).to.equal( 'p' ); // <p>^xyz</p> -- at the start of P node.
  367. expect( positions[ 4 ].offset ).to.equal( 0 );
  368. expect( positions[ 5 ].parent.data ).to.equal( 'xyz' ); // "x^yz".
  369. expect( positions[ 5 ].offset ).to.equal( 1 );
  370. expect( positions[ 6 ].parent.data ).to.equal( 'xyz' ); // "xy^z".
  371. expect( positions[ 6 ].offset ).to.equal( 2 );
  372. } );
  373. } );
  374. describe( 'static constructors', () => {
  375. let div, p, foz;
  376. beforeEach( () => {
  377. foz = new Text( 'foz' );
  378. p = new Element( 'p', null, foz );
  379. div = new Element( 'div', null, p );
  380. } );
  381. describe( 'createFromElement', () => {
  382. it( 'should return range', () => {
  383. const range = Range.createFromElement( p );
  384. expect( range.start.parent ).to.deep.equal( p );
  385. expect( range.start.offset ).to.deep.equal( 0 );
  386. expect( range.end.parent ).to.deep.equal( p );
  387. expect( range.end.offset ).to.deep.equal( 1 );
  388. } );
  389. } );
  390. describe( 'createFromParentsAndOffsets', () => {
  391. it( 'should return range', () => {
  392. const range = Range.createFromParentsAndOffsets( div, 0, foz, 1 );
  393. expect( range.start.parent ).to.deep.equal( div );
  394. expect( range.start.offset ).to.deep.equal( 0 );
  395. expect( range.end.parent ).to.deep.equal( foz );
  396. expect( range.end.offset ).to.deep.equal( 1 );
  397. } );
  398. } );
  399. describe( 'createFromPositionAndShift', () => {
  400. it( 'should make range from start position and offset', () => {
  401. const position = new Position( foz, 1 );
  402. const range = Range.createFromPositionAndShift( position, 2 );
  403. expect( range ).to.be.instanceof( Range );
  404. expect( range.start.isEqual( position ) ).to.be.true;
  405. expect( range.end.parent ).to.equal( foz );
  406. expect( range.end.offset ).to.deep.equal( 3 );
  407. } );
  408. it( 'should accept negative shift value', () => {
  409. const position = new Position( foz, 3 );
  410. const range = Range.createFromPositionAndShift( position, -1 );
  411. expect( range ).to.be.instanceof( Range );
  412. expect( range.end.isEqual( position ) ).to.be.true;
  413. expect( range.start.parent ).to.equal( foz );
  414. expect( range.start.offset ).to.deep.equal( 2 );
  415. } );
  416. } );
  417. describe( 'createFromRange', () => {
  418. it( 'should create a new instance of Range that is equal to passed range', () => {
  419. const range = new Range( new Position( foz, 0 ), new Position( foz, 2 ) );
  420. const clone = Range.createFromRange( range );
  421. expect( clone ).not.to.be.equal( range ); // clone is not pointing to the same object as position
  422. expect( clone.isEqual( range ) ).to.be.true; // but they are equal in the position-sense
  423. } );
  424. } );
  425. } );
  426. } );