mapper.js 33 KB

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