8
0

mapper.js 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  1. /**
  2. * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. import Mapper from '../../src/conversion/mapper';
  6. import ModelElement from '../../src/model/element';
  7. import ModelRootElement from '../../src/model/rootelement';
  8. import ModelText from '../../src/model/text';
  9. import ModelPosition from '../../src/model/position';
  10. import ModelRange from '../../src/model/range';
  11. import ViewElement from '../../src/view/element';
  12. import ViewUIElement from '../../src/view/uielement';
  13. import ViewText from '../../src/view/text';
  14. import ViewPosition from '../../src/view/position';
  15. import ViewRange from '../../src/view/range';
  16. describe( 'Mapper', () => {
  17. describe( 'clearBindings', () => {
  18. it( 'should remove all mapping', () => {
  19. const viewA = new ViewElement( 'a' );
  20. const viewB = new ViewElement( 'b' );
  21. const viewC = new ViewElement( 'c' );
  22. const viewD = new ViewElement( 'd' );
  23. const modelA = new ModelElement( 'a' );
  24. const modelB = new ModelElement( 'b' );
  25. const modelC = new ModelElement( 'c' );
  26. const modelD = new ModelElement( 'd' );
  27. const mapper = new Mapper();
  28. mapper.bindElements( modelA, viewA );
  29. mapper.bindElements( modelB, viewB );
  30. mapper.bindElements( modelC, viewC );
  31. mapper.bindElements( modelD, viewD );
  32. mapper.bindElementToMarker( viewA, 'foo' );
  33. mapper.bindElementToMarker( viewD, 'foo' );
  34. mapper.bindElementToMarker( viewD, 'bar' );
  35. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  36. expect( mapper.toModelElement( viewB ) ).to.equal( modelB );
  37. expect( mapper.toModelElement( viewC ) ).to.equal( modelC );
  38. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  39. expect( mapper.toViewElement( modelB ) ).to.equal( viewB );
  40. expect( mapper.toViewElement( modelC ) ).to.equal( viewC );
  41. expect( Array.from( mapper.markerNameToElements( 'foo' ) ) ).to.deep.equal( [ viewA, viewD ] );
  42. mapper.unbindViewElement( viewD );
  43. expect( Array.from( mapper._unboundMarkers ) ).to.deep.equal( [ 'foo', 'bar' ] );
  44. mapper.clearBindings();
  45. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  46. expect( mapper.toModelElement( viewB ) ).to.be.undefined;
  47. expect( mapper.toModelElement( viewC ) ).to.be.undefined;
  48. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  49. expect( mapper.toViewElement( modelB ) ).to.be.undefined;
  50. expect( mapper.toViewElement( modelC ) ).to.be.undefined;
  51. expect( mapper.markerNameToElements( 'foo' ) ).to.be.null;
  52. expect( Array.from( mapper._unboundMarkers ) ).to.deep.equal( [] );
  53. } );
  54. } );
  55. describe( 'unbindModelElement', () => {
  56. it( 'should remove binding between given model element and view element that it was bound to', () => {
  57. const viewA = new ViewElement( 'a' );
  58. const modelA = new ModelElement( 'a' );
  59. const mapper = new Mapper();
  60. mapper.bindElements( modelA, viewA );
  61. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  62. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  63. mapper.unbindModelElement( modelA );
  64. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  65. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  66. } );
  67. it( 'should not remove binding between view and model element if view element got rebound', () => {
  68. const viewA = new ViewElement( 'a' );
  69. const modelA = new ModelElement( 'a' );
  70. const modelB = new ModelElement( 'b' );
  71. const mapper = new Mapper();
  72. mapper.bindElements( modelA, viewA );
  73. mapper.bindElements( modelB, viewA );
  74. // `modelA` is still bound to `viewA` even though `viewA` got rebound.
  75. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  76. mapper.unbindModelElement( modelA );
  77. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  78. expect( mapper.toModelElement( viewA ) ).to.equal( modelB );
  79. } );
  80. } );
  81. describe( 'unbindViewElement', () => {
  82. it( 'should remove binding between given view element and model element that it was bound to', () => {
  83. const viewA = new ViewElement( 'a' );
  84. const modelA = new ModelElement( 'a' );
  85. const mapper = new Mapper();
  86. mapper.bindElements( modelA, viewA );
  87. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  88. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  89. mapper.unbindViewElement( viewA );
  90. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  91. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  92. } );
  93. it( 'should not remove binding between model and view element if model element got rebound', () => {
  94. const viewA = new ViewElement( 'a' );
  95. const viewB = new ViewElement( 'b' );
  96. const modelA = new ModelElement( 'a' );
  97. const mapper = new Mapper();
  98. mapper.bindElements( modelA, viewA );
  99. mapper.bindElements( modelA, viewB );
  100. // `viewA` is still bound to `modelA`, even though `modelA` got rebound.
  101. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  102. mapper.unbindViewElement( viewA );
  103. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  104. expect( mapper.toViewElement( modelA ) ).to.equal( viewB );
  105. } );
  106. it( 'should add marker names to _unboundMarkers set', () => {
  107. const viewA = new ViewElement( 'a' );
  108. const modelA = new ModelElement( 'a' );
  109. const mapper = new Mapper();
  110. mapper.bindElements( modelA, viewA );
  111. mapper.bindElementToMarker( viewA, 'foo' );
  112. mapper.bindElementToMarker( viewA, 'bar' );
  113. mapper.unbindViewElement( viewA );
  114. expect( Array.from( mapper._unboundMarkers ) ).to.deep.equal( [ 'foo', 'bar' ] );
  115. } );
  116. } );
  117. describe( 'Standard mapping', () => {
  118. let modelDiv, modelP, modelImg,
  119. viewDiv, viewP, viewB, viewI, viewU, viewSup, viewImg,
  120. viewTextB, viewTextO, viewTextM, viewTextX, viewTextY, viewTextZZ, viewTextFOO, viewTextBAR,
  121. mapper;
  122. beforeEach( () => {
  123. // Tree Model:
  124. //
  125. // <div> ---> modelDiv
  126. // ├─ x
  127. // ├─ <p> ---> modelP
  128. // │ ├─ y
  129. // │ ├─ f {b,i}
  130. // │ ├─ o {b,i}
  131. // │ ├─ o {b,i}
  132. // │ ├─ b
  133. // │ ├─ a
  134. // │ ├─ r
  135. // │ ├─ <img> ---> modelImg
  136. // │ ├─ b {u}
  137. // │ ├─ o {u,sup}
  138. // │ └─ m {u}
  139. // ├─ z
  140. // └─ z
  141. //
  142. // Tree View:
  143. //
  144. // <div> ---> viewDiv
  145. // ├─ x ---> viewTextX
  146. // ├─ <p> ---> viewP
  147. // │ ├─ y ---> viewTextY
  148. // │ ├─ <b> ---> viewB
  149. // │ │ └─ <i> ---> viewI
  150. // │ │ └─ foo ---> viewTextFOO
  151. // │ ├─ bar ---> viewTextBAR
  152. // │ ├─ <img> ---> viewImg
  153. // │ └─ <u> ---> viewU
  154. // │ ├─ b ---> viewTextB
  155. // │ ├─ <sup> ---> viewSup
  156. // │ │ └─ o ---> viewTextO
  157. // │ └─ m ---> viewTextM
  158. // └─ zz ---> viewTextZZ
  159. modelImg = new ModelElement( 'img' );
  160. modelP = new ModelElement( 'p', {}, [
  161. new ModelText( 'y' ),
  162. new ModelText( 'foo', { b: true, i: true } ),
  163. new ModelText( 'bar' ),
  164. modelImg,
  165. new ModelText( 'b', { u: true } ),
  166. new ModelText( 'o', { u: true, sup: true } ),
  167. new ModelText( 'm', { u: true } )
  168. ] );
  169. modelDiv = new ModelRootElement();
  170. modelDiv._appendChild( [
  171. new ModelText( 'x' ),
  172. modelP,
  173. new ModelText( 'zz' )
  174. ] );
  175. viewTextB = new ViewText( 'b' );
  176. viewTextO = new ViewText( 'o' );
  177. viewTextM = new ViewText( 'm' );
  178. viewTextX = new ViewText( 'x' );
  179. viewTextY = new ViewText( 'y' );
  180. viewTextZZ = new ViewText( 'zz' );
  181. viewTextFOO = new ViewText( 'foo' );
  182. viewTextBAR = new ViewText( 'bar' );
  183. viewImg = new ViewElement( 'img' );
  184. viewSup = new ViewElement( 'sup', {}, [ viewTextO ] );
  185. viewU = new ViewElement( 'u', {}, [ viewTextB, viewSup, viewTextM ] );
  186. viewI = new ViewElement( 'i', {}, [ viewTextFOO ] );
  187. viewB = new ViewElement( 'b', {}, [ viewI ] );
  188. viewP = new ViewElement( 'p', {}, [ viewTextY, viewB, viewTextBAR, viewImg, viewU ] );
  189. viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewP, viewTextZZ ] );
  190. mapper = new Mapper();
  191. mapper.bindElements( modelP, viewP );
  192. mapper.bindElements( modelDiv, viewDiv );
  193. mapper.bindElements( modelImg, viewImg );
  194. } );
  195. describe( 'toModelElement', () => {
  196. it( 'should return corresponding model element', () => {
  197. expect( mapper.toModelElement( viewP ) ).to.equal( modelP );
  198. expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
  199. expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
  200. } );
  201. } );
  202. describe( 'toViewElement', () => {
  203. it( 'should return corresponding view element', () => {
  204. expect( mapper.toViewElement( modelP ) ).to.equal( viewP );
  205. expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
  206. expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
  207. } );
  208. } );
  209. describe( 'toModelPosition', () => {
  210. it( 'should fire viewToModelPosition event and return value calculated in callback to that event', () => {
  211. const viewPosition = new ViewPosition( viewDiv, 0 );
  212. const stub = {};
  213. mapper.on( 'viewToModelPosition', ( evt, data ) => {
  214. expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
  215. data.modelPosition = stub;
  216. // Do not stop the event. Test whether default algorithm was not called if data.modelPosition is already set.
  217. } );
  218. const result = mapper.toModelPosition( viewPosition );
  219. expect( result ).to.equal( stub );
  220. } );
  221. it( 'should be possible to add custom position mapping callback after default callback', () => {
  222. const viewPosition = new ViewPosition( viewDiv, 0 );
  223. // Model position to which default algorithm should map `viewPosition`.
  224. // This mapping is tested in a test below.
  225. const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
  226. const stub = {};
  227. mapper.on( 'viewToModelPosition', ( evt, data ) => {
  228. expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
  229. expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
  230. data.modelPosition = stub;
  231. }, { priority: 'low' } );
  232. const result = mapper.toModelPosition( viewPosition );
  233. expect( result ).to.equal( stub );
  234. } );
  235. // Default algorithm tests.
  236. it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
  237. it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
  238. it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
  239. it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
  240. it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
  241. it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
  242. it( 'should transform viewP 0', () => createToModelTest( viewP, 0, modelP, 0 ) );
  243. it( 'should transform viewP 1', () => createToModelTest( viewP, 1, modelP, 1 ) );
  244. it( 'should transform viewP 2', () => createToModelTest( viewP, 2, modelP, 4 ) );
  245. it( 'should transform viewP 3', () => createToModelTest( viewP, 3, modelP, 7 ) );
  246. it( 'should transform viewP 4', () => createToModelTest( viewP, 4, modelP, 8 ) );
  247. it( 'should transform viewP 5', () => createToModelTest( viewP, 5, modelP, 11 ) );
  248. it( 'should transform viewTextY 0', () => createToModelTest( viewTextY, 0, modelP, 0 ) );
  249. it( 'should transform viewTextY 1', () => createToModelTest( viewTextY, 1, modelP, 1 ) );
  250. it( 'should transform viewB 0', () => createToModelTest( viewB, 0, modelP, 1 ) );
  251. it( 'should transform viewB 1', () => createToModelTest( viewB, 1, modelP, 4 ) );
  252. it( 'should transform viewI 0', () => createToModelTest( viewI, 0, modelP, 1 ) );
  253. it( 'should transform viewI 1', () => createToModelTest( viewI, 1, modelP, 4 ) );
  254. it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelP, 1 ) );
  255. it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelP, 2 ) );
  256. it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelP, 3 ) );
  257. it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelP, 4 ) );
  258. it( 'should transform viewTextBAR 0', () => createToModelTest( viewTextBAR, 0, modelP, 4 ) );
  259. it( 'should transform viewTextBAR 1', () => createToModelTest( viewTextBAR, 1, modelP, 5 ) );
  260. it( 'should transform viewTextBAR 2', () => createToModelTest( viewTextBAR, 2, modelP, 6 ) );
  261. it( 'should transform viewTextBAR 3', () => createToModelTest( viewTextBAR, 3, modelP, 7 ) );
  262. it( 'should transform viewU 0', () => createToModelTest( viewU, 0, modelP, 8 ) );
  263. it( 'should transform viewU 1', () => createToModelTest( viewU, 1, modelP, 9 ) );
  264. it( 'should transform viewU 2', () => createToModelTest( viewU, 2, modelP, 10 ) );
  265. it( 'should transform viewU 3', () => createToModelTest( viewU, 3, modelP, 11 ) );
  266. it( 'should transform viewTextB 0', () => createToModelTest( viewTextB, 0, modelP, 8 ) );
  267. it( 'should transform viewTextB 1', () => createToModelTest( viewTextB, 1, modelP, 9 ) );
  268. it( 'should transform viewSup 0', () => createToModelTest( viewSup, 0, modelP, 9 ) );
  269. it( 'should transform viewSup 1', () => createToModelTest( viewSup, 1, modelP, 10 ) );
  270. it( 'should transform viewTextO 0', () => createToModelTest( viewTextO, 0, modelP, 9 ) );
  271. it( 'should transform viewTextO 1', () => createToModelTest( viewTextO, 1, modelP, 10 ) );
  272. it( 'should transform viewTextM 0', () => createToModelTest( viewTextM, 0, modelP, 10 ) );
  273. it( 'should transform viewTextM 1', () => createToModelTest( viewTextM, 1, modelP, 11 ) );
  274. it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
  275. it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
  276. it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
  277. } );
  278. describe( 'toViewPosition', () => {
  279. it( 'should fire modelToViewPosition event and return value calculated in callback to that event', () => {
  280. const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
  281. const stub = {};
  282. mapper.on( 'modelToViewPosition', ( evt, data ) => {
  283. expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
  284. data.viewPosition = stub;
  285. // Do not stop the event. Test whether default algorithm was not called if data.viewPosition is already set.
  286. } );
  287. const result = mapper.toViewPosition( modelPosition );
  288. expect( result ).to.equal( stub );
  289. } );
  290. it( 'should be possible to add custom position mapping callback after default callback', () => {
  291. const modelPosition = new ModelPosition( modelDiv, [ 0 ] );
  292. // View position to which default algorithm should map `viewPosition`.
  293. // This mapping is tested in a test below.
  294. const viewPosition = new ViewPosition( viewTextX, 0 );
  295. const stub = {};
  296. mapper.on( 'modelToViewPosition', ( evt, data ) => {
  297. expect( data.modelPosition.isEqual( modelPosition ) ).to.be.true;
  298. expect( data.viewPosition.isEqual( viewPosition ) ).to.be.true;
  299. data.viewPosition = stub;
  300. }, { priority: 'low' } );
  301. const result = mapper.toViewPosition( modelPosition );
  302. expect( result ).to.equal( stub );
  303. } );
  304. // Default algorithm tests.
  305. it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
  306. it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
  307. it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
  308. it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
  309. it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
  310. it( 'should transform modelP 0', () => createToViewTest( modelP, 0, viewTextY, 0 ) );
  311. it( 'should transform modelP 1', () => createToViewTest( modelP, 1, viewTextY, 1 ) );
  312. it( 'should transform modelP 2', () => createToViewTest( modelP, 2, viewTextFOO, 1 ) );
  313. it( 'should transform modelP 3', () => createToViewTest( modelP, 3, viewTextFOO, 2 ) );
  314. it( 'should transform modelP 4', () => createToViewTest( modelP, 4, viewTextBAR, 0 ) );
  315. it( 'should transform modelP 5', () => createToViewTest( modelP, 5, viewTextBAR, 1 ) );
  316. it( 'should transform modelP 6', () => createToViewTest( modelP, 6, viewTextBAR, 2 ) );
  317. it( 'should transform modelP 7', () => createToViewTest( modelP, 7, viewTextBAR, 3 ) );
  318. it( 'should transform modelP 8', () => createToViewTest( modelP, 8, viewP, 4 ) );
  319. it( 'should transform modelP 9', () => createToViewTest( modelP, 9, viewTextB, 1 ) );
  320. it( 'should transform modelP 10', () => createToViewTest( modelP, 10, viewTextM, 0 ) );
  321. it( 'should transform modelP 11', () => createToViewTest( modelP, 11, viewP, 5 ) );
  322. } );
  323. describe( 'toModelRange', () => {
  324. it( 'should transform range', () => {
  325. const viewRange = ViewRange._createFromParentsAndOffsets( viewDiv, 0, viewTextFOO, 2 );
  326. const modelRange = mapper.toModelRange( viewRange );
  327. expect( modelRange.start.parent ).to.equal( modelDiv );
  328. expect( modelRange.start.offset ).to.equal( 0 );
  329. expect( modelRange.end.parent ).to.equal( modelP );
  330. expect( modelRange.end.offset ).to.equal( 3 );
  331. } );
  332. } );
  333. describe( 'toViewRange', () => {
  334. it( 'should transform range', () => {
  335. const modelRange = new ModelRange( ModelPosition._createAt( modelDiv, 0 ), ModelPosition._createAt( modelP, 3 ) );
  336. const viewRange = mapper.toViewRange( modelRange );
  337. expect( viewRange.start.parent ).to.equal( viewTextX );
  338. expect( viewRange.start.offset ).to.equal( 0 );
  339. expect( viewRange.end.parent ).to.equal( viewTextFOO );
  340. expect( viewRange.end.offset ).to.equal( 2 );
  341. } );
  342. } );
  343. function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
  344. const modelPosition = ModelPosition._createAt( modelElement, modelOffset );
  345. const viewPosition = mapper.toViewPosition( modelPosition );
  346. expect( viewPosition.parent ).to.equal( viewElement );
  347. expect( viewPosition.offset ).to.equal( viewOffset );
  348. }
  349. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  350. const viewPosition = new ViewPosition( viewElement, viewOffset );
  351. const modelPosition = mapper.toModelPosition( viewPosition );
  352. expect( modelPosition.parent ).to.equal( modelElement );
  353. expect( modelPosition.offset ).to.equal( modelOffset );
  354. }
  355. } );
  356. describe( 'Widget mapping', () => {
  357. let modelDiv, modelWidget, modelImg, modelCaption,
  358. viewDiv, viewWidget, viewMask, viewWrapper, viewImg, viewCaption,
  359. viewTextX, viewTextFOO, viewTextZZ, viewTextLABEL,
  360. mapper;
  361. before( () => {
  362. // Tree Model:
  363. //
  364. // <div> ---> modelDiv
  365. // ├─ x
  366. // ├─ <widget> ---> modelWidget
  367. // │ ├─ <img> ---> modelImg
  368. // │ └─ <caption> ---> modelCaption
  369. // │ ├─ f
  370. // │ ├─ o
  371. // │ └─ o
  372. // ├─ z
  373. // └─ z
  374. //
  375. // Tree View:
  376. //
  377. // <div> ---> viewDiv
  378. // ├─ x ---> viewTextX
  379. // ├─ <widget> ---> viewWidget
  380. // │ ├─ <mask> ---> viewMask
  381. // │ │ └─ label ---> viewTextLABEL
  382. // │ └─ <wrapper> ---> viewWrapper
  383. // │ ├─ <img> ---> viewImg
  384. // │ └─ <caption> ---> viewCaption
  385. // │ └─ foo ---> viewTextFOO
  386. // └─ zz ---> viewTextZZ
  387. modelImg = new ModelElement( 'img' );
  388. modelCaption = new ModelElement( 'caption', {}, new ModelText( 'foo' ) );
  389. modelWidget = new ModelElement( 'widget', {}, [ modelImg, modelCaption ] );
  390. modelDiv = new ModelRootElement();
  391. modelDiv._appendChild( [ new ModelText( 'x' ), modelWidget, new ModelText( 'zz' ) ] );
  392. viewTextX = new ViewText( 'y' );
  393. viewTextZZ = new ViewText( 'zz' );
  394. viewTextFOO = new ViewText( 'foo' );
  395. viewTextLABEL = new ViewText( 'label' );
  396. viewImg = new ViewElement( 'img' );
  397. viewMask = new ViewElement( 'mask', {}, [ viewTextLABEL ] );
  398. viewCaption = new ViewElement( 'caption', {}, [ viewTextFOO ] );
  399. viewWrapper = new ViewElement( 'wrapper', {}, [ viewImg, viewCaption ] );
  400. viewWidget = new ViewElement( 'widget', [ viewMask, viewWrapper ] );
  401. viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewWidget, viewTextZZ ] );
  402. mapper = new Mapper();
  403. mapper.bindElements( modelDiv, viewDiv );
  404. mapper.bindElements( modelWidget, viewWidget );
  405. mapper.bindElements( modelImg, viewImg );
  406. mapper.bindElements( modelCaption, viewCaption );
  407. } );
  408. describe( 'toModelElement', () => {
  409. it( 'should return corresponding model element', () => {
  410. expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
  411. expect( mapper.toModelElement( viewWidget ) ).to.equal( modelWidget );
  412. expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
  413. expect( mapper.toModelElement( viewCaption ) ).to.equal( modelCaption );
  414. } );
  415. } );
  416. describe( 'toViewElement', () => {
  417. it( 'should return corresponding view element', () => {
  418. expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
  419. expect( mapper.toViewElement( modelWidget ) ).to.equal( viewWidget );
  420. expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
  421. expect( mapper.toViewElement( modelCaption ) ).to.equal( viewCaption );
  422. } );
  423. } );
  424. describe( 'toModelPosition', () => {
  425. it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
  426. it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
  427. it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
  428. it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
  429. it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
  430. it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
  431. it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
  432. it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
  433. it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
  434. it( 'should transform viewImg 0', () => createToModelTest( viewImg, 0, modelImg, 0 ) );
  435. it( 'should transform viewCaption 0', () => createToModelTest( viewCaption, 0, modelCaption, 0 ) );
  436. it( 'should transform viewCaption 1', () => createToModelTest( viewCaption, 1, modelCaption, 3 ) );
  437. it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelCaption, 0 ) );
  438. it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelCaption, 1 ) );
  439. it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelCaption, 2 ) );
  440. it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelCaption, 3 ) );
  441. } );
  442. describe( 'toViewPosition', () => {
  443. it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
  444. it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
  445. it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
  446. it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
  447. it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
  448. it( 'should transform modelImg 0', () => createToViewTest( modelImg, 0, viewImg, 0 ) );
  449. it( 'should transform modelCaption 0', () => createToViewTest( modelCaption, 0, viewTextFOO, 0 ) );
  450. it( 'should transform modelCaption 1', () => createToViewTest( modelCaption, 1, viewTextFOO, 1 ) );
  451. it( 'should transform modelCaption 2', () => createToViewTest( modelCaption, 2, viewTextFOO, 2 ) );
  452. it( 'should transform modelCaption 3', () => createToViewTest( modelCaption, 3, viewTextFOO, 3 ) );
  453. } );
  454. function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
  455. const modelPosition = ModelPosition._createAt( modelElement, modelOffset );
  456. const viewPosition = mapper.toViewPosition( modelPosition );
  457. expect( viewPosition.parent ).to.equal( viewElement );
  458. expect( viewPosition.offset ).to.equal( viewOffset );
  459. }
  460. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  461. const viewPosition = new ViewPosition( viewElement, viewOffset );
  462. const modelPosition = mapper.toModelPosition( viewPosition );
  463. expect( modelPosition.parent ).to.equal( modelElement );
  464. expect( modelPosition.offset ).to.equal( modelOffset );
  465. }
  466. } );
  467. describe( 'List mapping (test registerViewToModelLength)', () => {
  468. let mapper, modelRoot, viewRoot,
  469. modelListItem1, modelListItem2,
  470. modelListItem11, modelListItem12,
  471. viewList, viewListNested,
  472. viewListItem1, viewListItem2,
  473. viewListItem11, viewListItem12;
  474. before( () => {
  475. modelListItem1 = new ModelElement( 'listItem', null, new ModelText( 'aaa' ) );
  476. modelListItem11 = new ModelElement( 'listItem', null, new ModelText( 'bbb' ) );
  477. modelListItem12 = new ModelElement( 'listItem', null, new ModelText( 'ccc' ) );
  478. modelListItem2 = new ModelElement( 'listItem', null, new ModelText( 'xxx' ) );
  479. modelRoot = new ModelRootElement( 'root', null, [ modelListItem1, modelListItem11, modelListItem12, modelListItem2 ] );
  480. viewListItem11 = new ViewElement( 'li', null, new ViewText( 'bbb' ) );
  481. viewListItem12 = new ViewElement( 'li', null, new ViewText( 'ccc' ) );
  482. viewListNested = new ViewElement( 'ul', null, [ viewListItem11, viewListItem12 ] );
  483. viewListItem1 = new ViewElement( 'li', null, [ new ViewText( 'aaa' ), viewListNested ] );
  484. viewListItem2 = new ViewElement( 'li', null, new ViewText( 'ddd' ) );
  485. viewList = new ViewElement( 'ul', null, [ viewListItem1, viewListItem2 ] );
  486. viewRoot = new ViewElement( 'div', null, viewList );
  487. mapper = new Mapper();
  488. mapper.bindElements( modelRoot, viewRoot );
  489. mapper.bindElements( modelListItem1, viewListItem1 );
  490. mapper.bindElements( modelListItem11, viewListItem11 );
  491. mapper.bindElements( modelListItem12, viewListItem12 );
  492. mapper.bindElements( modelListItem2, viewListItem2 );
  493. function getViewListItemLength( element ) {
  494. let length = 1;
  495. for ( const child of element.getChildren() ) {
  496. if ( child.name == 'ul' || child.name == 'ol' ) {
  497. for ( const item of child.getChildren() ) {
  498. length += getViewListItemLength( item );
  499. }
  500. }
  501. }
  502. return length;
  503. }
  504. mapper.registerViewToModelLength( 'li', getViewListItemLength );
  505. } );
  506. describe( 'toModelPosition', () => {
  507. it( 'should transform viewRoot 0', () => createToModelTest( viewRoot, 0, modelRoot, 0 ) );
  508. it( 'should transform viewRoot 1', () => createToModelTest( viewRoot, 1, modelRoot, 4 ) );
  509. it( 'should transform viewList 0', () => createToModelTest( viewList, 0, modelRoot, 0 ) );
  510. it( 'should transform viewList 1', () => createToModelTest( viewList, 1, modelRoot, 3 ) );
  511. it( 'should transform viewList 2', () => createToModelTest( viewList, 2, modelRoot, 4 ) );
  512. } );
  513. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  514. const viewPosition = new ViewPosition( viewElement, viewOffset );
  515. const modelPosition = mapper.toModelPosition( viewPosition );
  516. expect( modelPosition.parent ).to.equal( modelElement );
  517. expect( modelPosition.offset ).to.equal( modelOffset );
  518. }
  519. } );
  520. describe( 'Markers mapping', () => {
  521. let mapper;
  522. beforeEach( () => {
  523. mapper = new Mapper();
  524. } );
  525. it( 'should bind element to a marker name', () => {
  526. const view = new ViewElement( 'a' );
  527. mapper.bindElementToMarker( view, 'marker' );
  528. const elements = mapper.markerNameToElements( 'marker' );
  529. expect( elements ).to.be.instanceof( Set );
  530. expect( elements.size ).to.equal( 1 );
  531. expect( elements.has( view ) ).to.be.true;
  532. } );
  533. it( 'should bind multiple elements to a marker name', () => {
  534. const viewA = new ViewElement( 'a' );
  535. const viewB = new ViewElement( 'b' );
  536. const viewC = new ViewElement( 'c' );
  537. mapper.bindElementToMarker( viewA, 'marker' );
  538. mapper.bindElementToMarker( viewB, 'marker' );
  539. mapper.bindElementToMarker( viewC, 'marker' );
  540. const elements = Array.from( mapper.markerNameToElements( 'marker' ) );
  541. expect( elements ).to.deep.equal( [ viewA, viewB, viewC ] );
  542. } );
  543. it( 'should unbind element from a marker name', () => {
  544. const viewA = new ViewElement( 'a' );
  545. const viewB = new ViewElement( 'b' );
  546. mapper.bindElementToMarker( viewA, 'marker' );
  547. mapper.bindElementToMarker( viewA, 'markerB' );
  548. mapper.bindElementToMarker( viewB, 'marker' );
  549. mapper.unbindElementFromMarkerName( viewA, 'marker' );
  550. expect( Array.from( mapper.markerNameToElements( 'marker' ) ) ).to.deep.equal( [ viewB ] );
  551. expect( Array.from( mapper.markerNameToElements( 'markerB' ) ) ).to.deep.equal( [ viewA ] );
  552. mapper.unbindElementFromMarkerName( viewB, 'marker' );
  553. expect( mapper.markerNameToElements( 'marker' ) ).to.be.null;
  554. // Removing an element from non-existing group or non-bound element should not cause a crash.
  555. mapper.unbindElementFromMarkerName( viewB, 'marker' );
  556. expect( mapper.markerNameToElements( 'marker' ) ).to.be.null;
  557. } );
  558. } );
  559. it( 'should pass isPhantom flag to model-to-view position mapping callback', () => {
  560. const mapper = new Mapper();
  561. mapper.on( 'modelToViewPosition', ( evt, data ) => {
  562. expect( data.isPhantom ).to.be.true;
  563. evt.stop();
  564. } );
  565. mapper.toViewPosition( {}, { isPhantom: true } );
  566. } );
  567. describe( 'getModelLength', () => {
  568. let mapper;
  569. beforeEach( () => {
  570. mapper = new Mapper();
  571. } );
  572. it( 'should return length according to callback added by registerViewToModelLength', () => {
  573. const viewElement = new ViewElement( 'span' );
  574. mapper.registerViewToModelLength( 'span', () => 4 );
  575. expect( mapper.getModelLength( viewElement ) ).to.equal( 4 );
  576. } );
  577. it( 'should return 1 for mapped elements', () => {
  578. const viewElement = new ViewElement( 'span' );
  579. const modelElement = new ModelElement( 'span' );
  580. mapper.bindElements( modelElement, viewElement );
  581. expect( mapper.getModelLength( viewElement ) ).to.equal( 1 );
  582. } );
  583. it( 'should return 0 for ui elements', () => {
  584. const viewUiElement = new ViewUIElement( 'span' );
  585. expect( mapper.getModelLength( viewUiElement ) ).to.equal( 0 );
  586. } );
  587. it( 'should return length of data for text nodes', () => {
  588. const viewText = new ViewText( 'foo' );
  589. expect( mapper.getModelLength( viewText ) ).to.equal( 3 );
  590. } );
  591. it( 'should return sum of length of children for unmapped element', () => {
  592. const modelP = new ModelElement( 'p' );
  593. const viewP = new ViewElement( 'p' );
  594. const viewUi = new ViewUIElement( 'span' );
  595. const viewFoo = new ViewText( 'foo' );
  596. const viewCallback = new ViewElement( 'xxx' );
  597. const viewDiv = new ViewElement( 'div', null, [ viewP, viewUi, viewFoo, viewCallback ] );
  598. mapper.bindElements( modelP, viewP );
  599. mapper.registerViewToModelLength( 'xxx', () => 2 );
  600. expect( mapper.getModelLength( viewDiv ) ).to.equal( 6 );
  601. } );
  602. } );
  603. describe( 'findMappedViewAncestor()', () => {
  604. it( 'should return for given view position the closest ancestor which is mapped to a model element', () => {
  605. const mapper = new Mapper();
  606. const modelP = new ModelElement( 'p' );
  607. const modelDiv = new ModelElement( 'div' );
  608. const viewText = new ViewText( 'foo' );
  609. const viewSpan = new ViewElement( 'span', null, viewText );
  610. const viewP = new ViewElement( 'p', null, viewSpan );
  611. const viewDiv = new ViewElement( 'div', null, viewP );
  612. mapper.bindElements( modelP, viewP );
  613. mapper.bindElements( modelDiv, viewDiv );
  614. // <div><p><span>f{}oo</span></p></div>
  615. const viewPosition = new ViewPosition( viewText, 1 );
  616. const viewMappedAncestor = mapper.findMappedViewAncestor( viewPosition );
  617. expect( viewMappedAncestor ).to.equal( viewP );
  618. } );
  619. } );
  620. } );