mapper.js 32 KB

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