mapper.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: conversion */
  6. 'use strict';
  7. import Mapper from '/ckeditor5/engine/conversion/mapper.js';
  8. import ModelElement from '/ckeditor5/engine/model/element.js';
  9. import ModelRootElement from '/ckeditor5/engine/model/rootelement.js';
  10. import ModelText from '/ckeditor5/engine/model/text.js';
  11. import ModelPosition from '/ckeditor5/engine/model/position.js';
  12. import ModelRange from '/ckeditor5/engine/model/range.js';
  13. import ViewElement from '/ckeditor5/engine/view/element.js';
  14. import ViewText from '/ckeditor5/engine/view/text.js';
  15. import ViewPosition from '/ckeditor5/engine/view/position.js';
  16. import ViewRange from '/ckeditor5/engine/view/range.js';
  17. describe( 'Mapper', () => {
  18. describe( 'clearBindings', () => {
  19. it( 'should remove all mapping', () => {
  20. const viewA = new ViewElement( 'a' );
  21. const viewB = new ViewElement( 'b' );
  22. const viewC = new ViewElement( 'c' );
  23. const modelA = new ModelElement( 'a' );
  24. const modelB = new ModelElement( 'b' );
  25. const modelC = new ModelElement( 'c' );
  26. const mapper = new Mapper();
  27. mapper.bindElements( modelA, viewA );
  28. mapper.bindElements( modelB, viewB );
  29. mapper.bindElements( modelC, viewC );
  30. expect( mapper.toModelElement( viewA ) ).to.equal( modelA );
  31. expect( mapper.toModelElement( viewB ) ).to.equal( modelB );
  32. expect( mapper.toModelElement( viewC ) ).to.equal( modelC );
  33. expect( mapper.toViewElement( modelA ) ).to.equal( viewA );
  34. expect( mapper.toViewElement( modelB ) ).to.equal( viewB );
  35. expect( mapper.toViewElement( modelC ) ).to.equal( viewC );
  36. mapper.clearBindings();
  37. expect( mapper.toModelElement( viewA ) ).to.be.undefined;
  38. expect( mapper.toModelElement( viewB ) ).to.be.undefined;
  39. expect( mapper.toModelElement( viewC ) ).to.be.undefined;
  40. expect( mapper.toViewElement( modelA ) ).to.be.undefined;
  41. expect( mapper.toViewElement( modelB ) ).to.be.undefined;
  42. expect( mapper.toViewElement( modelC ) ).to.be.undefined;
  43. } );
  44. } );
  45. describe( 'Standard mapping', () => {
  46. let modelDiv, modelP, modelImg;
  47. let viewDiv, viewP, viewB, viewI, viewU, viewSup, viewImg;
  48. let viewTextB, viewTextO, viewTextM, viewTextX, viewTextY, viewTextZZ, viewTextFOO, viewTextBAR;
  49. let mapper;
  50. before( () => {
  51. // Tree Model:
  52. //
  53. // <div> ---> modelDiv
  54. // ├─ x
  55. // ├─ <p> ---> modelP
  56. // │ ├─ y
  57. // │ ├─ f {b,i}
  58. // │ ├─ o {b,i}
  59. // │ ├─ o {b,i}
  60. // │ ├─ b
  61. // │ ├─ a
  62. // │ ├─ r
  63. // │ ├─ <img> ---> modelImg
  64. // │ ├─ b {u}
  65. // │ ├─ o {u,sup}
  66. // │ └─ m {u}
  67. // ├─ z
  68. // └─ z
  69. //
  70. // Tree View:
  71. //
  72. // <div> ---> viewDiv
  73. // ├─ x ---> viewTextX
  74. // ├─ <p> ---> viewP
  75. // │ ├─ y ---> viewTextY
  76. // │ ├─ <b> ---> viewB
  77. // │ │ └─ <i> ---> viewI
  78. // │ │ └─ foo ---> viewTextFOO
  79. // │ ├─ bar ---> viewTextBAR
  80. // │ ├─ <img> ---> viewImg
  81. // │ └─ <u> ---> viewU
  82. // │ ├─ b ---> viewTextB
  83. // │ ├─ <sup> ---> viewSup
  84. // │ │ └─ o ---> viewTextO
  85. // │ └─ m ---> viewTextM
  86. // └─ zz ---> viewTextZZ
  87. modelImg = new ModelElement( 'img' );
  88. modelP = new ModelElement( 'p', {}, [
  89. 'y',
  90. new ModelText( 'foo', { b: true, i: true } ),
  91. 'bar',
  92. modelImg,
  93. new ModelText( 'b', { u: true } ),
  94. new ModelText( 'o', { u: true, sup: true } ),
  95. new ModelText( 'm', { u: true } )
  96. ] );
  97. modelDiv = new ModelRootElement();
  98. modelDiv.appendChildren( [
  99. 'x',
  100. modelP,
  101. 'zz'
  102. ] );
  103. viewTextB = new ViewText( 'b' );
  104. viewTextO = new ViewText( 'o' );
  105. viewTextM = new ViewText( 'm' );
  106. viewTextX = new ViewText( 'x' );
  107. viewTextY = new ViewText( 'y' );
  108. viewTextZZ = new ViewText( 'zz' );
  109. viewTextFOO = new ViewText( 'foo' );
  110. viewTextBAR = new ViewText( 'bar' );
  111. viewImg = new ViewElement( 'img' );
  112. viewSup = new ViewElement( 'sup', {}, [ viewTextO ] );
  113. viewU = new ViewElement( 'u', {}, [ viewTextB, viewSup, viewTextM ] );
  114. viewI = new ViewElement( 'i', {}, [ viewTextFOO ] );
  115. viewB = new ViewElement( 'b', {}, [ viewI ] );
  116. viewP = new ViewElement( 'p', {}, [ viewTextY, viewB, viewTextBAR, viewImg, viewU ] );
  117. viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewP, viewTextZZ ] );
  118. mapper = new Mapper();
  119. mapper.bindElements( modelP, viewP );
  120. mapper.bindElements( modelDiv, viewDiv );
  121. mapper.bindElements( modelImg, viewImg );
  122. } );
  123. describe( 'toModelElement', () => {
  124. it( 'should return corresponding model element', () => {
  125. expect( mapper.toModelElement( viewP ) ).to.equal( modelP );
  126. expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
  127. expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
  128. } );
  129. } );
  130. describe( 'toViewElement', () => {
  131. it( 'should return corresponding view element', () => {
  132. expect( mapper.toViewElement( modelP ) ).to.equal( viewP );
  133. expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
  134. expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
  135. } );
  136. } );
  137. describe( 'toModelPosition', () => {
  138. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  139. const viewPosition = new ViewPosition( viewElement, viewOffset );
  140. const modelPosition = mapper.toModelPosition( viewPosition );
  141. expect( modelPosition.parent ).to.equal( modelElement );
  142. expect( modelPosition.offset ).to.equal( modelOffset );
  143. }
  144. it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
  145. it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
  146. it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
  147. it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
  148. it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
  149. it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
  150. it( 'should transform viewP 0', () => createToModelTest( viewP, 0, modelP, 0 ) );
  151. it( 'should transform viewP 1', () => createToModelTest( viewP, 1, modelP, 1 ) );
  152. it( 'should transform viewP 2', () => createToModelTest( viewP, 2, modelP, 4 ) );
  153. it( 'should transform viewP 3', () => createToModelTest( viewP, 3, modelP, 7 ) );
  154. it( 'should transform viewP 4', () => createToModelTest( viewP, 4, modelP, 8 ) );
  155. it( 'should transform viewP 5', () => createToModelTest( viewP, 5, modelP, 11 ) );
  156. it( 'should transform viewTextY 0', () => createToModelTest( viewTextY, 0, modelP, 0 ) );
  157. it( 'should transform viewTextY 1', () => createToModelTest( viewTextY, 1, modelP, 1 ) );
  158. it( 'should transform viewB 0', () => createToModelTest( viewB, 0, modelP, 1 ) );
  159. it( 'should transform viewB 1', () => createToModelTest( viewB, 1, modelP, 4 ) );
  160. it( 'should transform viewI 0', () => createToModelTest( viewI, 0, modelP, 1 ) );
  161. it( 'should transform viewI 1', () => createToModelTest( viewI, 1, modelP, 4 ) );
  162. it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelP, 1 ) );
  163. it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelP, 2 ) );
  164. it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelP, 3 ) );
  165. it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelP, 4 ) );
  166. it( 'should transform viewTextBAR 0', () => createToModelTest( viewTextBAR, 0, modelP, 4 ) );
  167. it( 'should transform viewTextBAR 1', () => createToModelTest( viewTextBAR, 1, modelP, 5 ) );
  168. it( 'should transform viewTextBAR 2', () => createToModelTest( viewTextBAR, 2, modelP, 6 ) );
  169. it( 'should transform viewTextBAR 3', () => createToModelTest( viewTextBAR, 3, modelP, 7 ) );
  170. it( 'should transform viewU 0', () => createToModelTest( viewU, 0, modelP, 8 ) );
  171. it( 'should transform viewU 1', () => createToModelTest( viewU, 1, modelP, 9 ) );
  172. it( 'should transform viewU 2', () => createToModelTest( viewU, 2, modelP, 10 ) );
  173. it( 'should transform viewU 3', () => createToModelTest( viewU, 3, modelP, 11 ) );
  174. it( 'should transform viewTextB 0', () => createToModelTest( viewTextB, 0, modelP, 8 ) );
  175. it( 'should transform viewTextB 1', () => createToModelTest( viewTextB, 1, modelP, 9 ) );
  176. it( 'should transform viewSup 0', () => createToModelTest( viewSup, 0, modelP, 9 ) );
  177. it( 'should transform viewSup 1', () => createToModelTest( viewSup, 1, modelP, 10 ) );
  178. it( 'should transform viewTextO 0', () => createToModelTest( viewTextO, 0, modelP, 9 ) );
  179. it( 'should transform viewTextO 1', () => createToModelTest( viewTextO, 1, modelP, 10 ) );
  180. it( 'should transform viewTextM 0', () => createToModelTest( viewTextM, 0, modelP, 10 ) );
  181. it( 'should transform viewTextM 1', () => createToModelTest( viewTextM, 1, modelP, 11 ) );
  182. it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
  183. it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
  184. it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
  185. } );
  186. describe( 'toViewPosition', () => {
  187. function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
  188. const modelPosition = ModelPosition.createFromParentAndOffset( modelElement, modelOffset );
  189. const viewPosition = mapper.toViewPosition( modelPosition );
  190. expect( viewPosition.parent ).to.equal( viewElement );
  191. expect( viewPosition.offset ).to.equal( viewOffset );
  192. }
  193. it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
  194. it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
  195. it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
  196. it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
  197. it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
  198. it( 'should transform modelP 0', () => createToViewTest( modelP, 0, viewTextY, 0 ) );
  199. it( 'should transform modelP 1', () => createToViewTest( modelP, 1, viewTextY, 1 ) );
  200. it( 'should transform modelP 2', () => createToViewTest( modelP, 2, viewTextFOO, 1 ) );
  201. it( 'should transform modelP 3', () => createToViewTest( modelP, 3, viewTextFOO, 2 ) );
  202. it( 'should transform modelP 4', () => createToViewTest( modelP, 4, viewTextBAR, 0 ) );
  203. it( 'should transform modelP 5', () => createToViewTest( modelP, 5, viewTextBAR, 1 ) );
  204. it( 'should transform modelP 6', () => createToViewTest( modelP, 6, viewTextBAR, 2 ) );
  205. it( 'should transform modelP 7', () => createToViewTest( modelP, 7, viewTextBAR, 3 ) );
  206. it( 'should transform modelP 8', () => createToViewTest( modelP, 8, viewP, 4 ) );
  207. it( 'should transform modelP 9', () => createToViewTest( modelP, 9, viewTextB, 1 ) );
  208. it( 'should transform modelP 10', () => createToViewTest( modelP, 10, viewTextM, 0 ) );
  209. it( 'should transform modelP 11', () => createToViewTest( modelP, 11, viewP, 5 ) );
  210. } );
  211. describe( 'toModelRange', () => {
  212. it( 'should transform range', () => {
  213. const viewRange = ViewRange.createFromParentsAndOffsets( viewDiv, 0, viewTextFOO, 2 );
  214. const modelRange = mapper.toModelRange( viewRange );
  215. expect( modelRange.start.parent ).to.equal( modelDiv );
  216. expect( modelRange.start.offset ).to.equal( 0 );
  217. expect( modelRange.end.parent ).to.equal( modelP );
  218. expect( modelRange.end.offset ).to.equal( 3 );
  219. } );
  220. } );
  221. describe( 'toViewRange', () => {
  222. it( 'should transform range', () => {
  223. const modelRange = ModelRange.createFromParentsAndOffsets( modelDiv, 0, modelP, 3 );
  224. const viewRange = mapper.toViewRange( modelRange );
  225. expect( viewRange.start.parent ).to.equal( viewTextX );
  226. expect( viewRange.start.offset ).to.equal( 0 );
  227. expect( viewRange.end.parent ).to.equal( viewTextFOO );
  228. expect( viewRange.end.offset ).to.equal( 2 );
  229. } );
  230. } );
  231. } );
  232. describe( 'Widget mapping', () => {
  233. let modelDiv, modelWidget, modelImg, modelCaption;
  234. let viewDiv, viewWidget, viewMask, viewWrapper, viewImg, viewCaption;
  235. let viewTextX, viewTextFOO, viewTextZZ, viewTextLABEL;
  236. let mapper;
  237. before( () => {
  238. // Tree Model:
  239. //
  240. // <div> ---> modelDiv
  241. // ├─ x
  242. // ├─ <widget> ---> modelWidget
  243. // │ ├─ <img> ---> modelImg
  244. // │ └─ <caption> ---> modelCaption
  245. // │ ├─ f
  246. // │ ├─ o
  247. // │ └─ o
  248. // ├─ z
  249. // └─ z
  250. //
  251. // Tree View:
  252. //
  253. // <div> ---> viewDiv
  254. // ├─ x ---> viewTextX
  255. // ├─ <widget> ---> viewWidget
  256. // │ ├─ <mask> ---> viewMask
  257. // │ │ └─ label ---> viewTextLABEL
  258. // │ └─ <wrapper> ---> viewWrapper
  259. // │ ├─ <img> ---> viewImg
  260. // │ └─ <caption> ---> viewCaption
  261. // │ └─ foo ---> viewTextFOO
  262. // └─ zz ---> viewTextZZ
  263. modelImg = new ModelElement( 'img' );
  264. modelCaption = new ModelElement( 'caption', {}, 'foo' );
  265. modelWidget = new ModelElement( 'widget', {}, [ modelImg, modelCaption ] );
  266. modelDiv = new ModelRootElement();
  267. modelDiv.appendChildren( [ 'x', modelWidget, 'zz' ] );
  268. viewTextX = new ViewText( 'y' );
  269. viewTextZZ = new ViewText( 'zz' );
  270. viewTextFOO = new ViewText( 'foo' );
  271. viewTextLABEL = new ViewText( 'label' );
  272. viewImg = new ViewElement( 'img' );
  273. viewMask = new ViewElement( 'mask', {}, [ viewTextLABEL ] );
  274. viewCaption = new ViewElement( 'caption', {}, [ viewTextFOO ] );
  275. viewWrapper = new ViewElement( 'wrapper', {}, [ viewImg, viewCaption ] );
  276. viewWidget = new ViewElement( 'widget', [ viewMask, viewWrapper ] );
  277. viewDiv = new ViewElement( 'div', {}, [ viewTextX, viewWidget, viewTextZZ ] );
  278. mapper = new Mapper();
  279. mapper.bindElements( modelDiv, viewDiv );
  280. mapper.bindElements( modelWidget, viewWidget );
  281. mapper.bindElements( modelImg, viewImg );
  282. mapper.bindElements( modelCaption, viewCaption );
  283. } );
  284. describe( 'toModelElement', () => {
  285. it( 'should return corresponding model element', () => {
  286. expect( mapper.toModelElement( viewDiv ) ).to.equal( modelDiv );
  287. expect( mapper.toModelElement( viewWidget ) ).to.equal( modelWidget );
  288. expect( mapper.toModelElement( viewImg ) ).to.equal( modelImg );
  289. expect( mapper.toModelElement( viewCaption ) ).to.equal( modelCaption );
  290. } );
  291. } );
  292. describe( 'toViewElement', () => {
  293. it( 'should return corresponding view element', () => {
  294. expect( mapper.toViewElement( modelDiv ) ).to.equal( viewDiv );
  295. expect( mapper.toViewElement( modelWidget ) ).to.equal( viewWidget );
  296. expect( mapper.toViewElement( modelImg ) ).to.equal( viewImg );
  297. expect( mapper.toViewElement( modelCaption ) ).to.equal( viewCaption );
  298. } );
  299. } );
  300. describe( 'toModelPosition', () => {
  301. function createToModelTest( viewElement, viewOffset, modelElement, modelOffset ) {
  302. const viewPosition = new ViewPosition( viewElement, viewOffset );
  303. const modelPosition = mapper.toModelPosition( viewPosition );
  304. expect( modelPosition.parent ).to.equal( modelElement );
  305. expect( modelPosition.offset ).to.equal( modelOffset );
  306. }
  307. it( 'should transform viewDiv 0', () => createToModelTest( viewDiv, 0, modelDiv, 0 ) );
  308. it( 'should transform viewDiv 1', () => createToModelTest( viewDiv, 1, modelDiv, 1 ) );
  309. it( 'should transform viewDiv 2', () => createToModelTest( viewDiv, 2, modelDiv, 2 ) );
  310. it( 'should transform viewDiv 3', () => createToModelTest( viewDiv, 3, modelDiv, 4 ) );
  311. it( 'should transform viewTextX 0', () => createToModelTest( viewTextX, 0, modelDiv, 0 ) );
  312. it( 'should transform viewTextX 1', () => createToModelTest( viewTextX, 1, modelDiv, 1 ) );
  313. it( 'should transform viewTextZZ 0', () => createToModelTest( viewTextZZ, 0, modelDiv, 2 ) );
  314. it( 'should transform viewTextZZ 1', () => createToModelTest( viewTextZZ, 1, modelDiv, 3 ) );
  315. it( 'should transform viewTextZZ 2', () => createToModelTest( viewTextZZ, 2, modelDiv, 4 ) );
  316. it( 'should transform viewImg 0', () => createToModelTest( viewImg, 0, modelImg, 0 ) );
  317. it( 'should transform viewCaption 0', () => createToModelTest( viewCaption, 0, modelCaption, 0 ) );
  318. it( 'should transform viewCaption 1', () => createToModelTest( viewCaption, 1, modelCaption, 3 ) );
  319. it( 'should transform viewTextFOO 0', () => createToModelTest( viewTextFOO, 0, modelCaption, 0 ) );
  320. it( 'should transform viewTextFOO 1', () => createToModelTest( viewTextFOO, 1, modelCaption, 1 ) );
  321. it( 'should transform viewTextFOO 2', () => createToModelTest( viewTextFOO, 2, modelCaption, 2 ) );
  322. it( 'should transform viewTextFOO 3', () => createToModelTest( viewTextFOO, 3, modelCaption, 3 ) );
  323. } );
  324. describe( 'toViewPosition', () => {
  325. function createToViewTest( modelElement, modelOffset, viewElement, viewOffset ) {
  326. const modelPosition = ModelPosition.createFromParentAndOffset( modelElement, modelOffset );
  327. const viewPosition = mapper.toViewPosition( modelPosition );
  328. expect( viewPosition.parent ).to.equal( viewElement );
  329. expect( viewPosition.offset ).to.equal( viewOffset );
  330. }
  331. it( 'should transform modelDiv 0', () => createToViewTest( modelDiv, 0, viewTextX, 0 ) );
  332. it( 'should transform modelDiv 1', () => createToViewTest( modelDiv, 1, viewTextX, 1 ) );
  333. it( 'should transform modelDiv 2', () => createToViewTest( modelDiv, 2, viewTextZZ, 0 ) );
  334. it( 'should transform modelDiv 3', () => createToViewTest( modelDiv, 3, viewTextZZ, 1 ) );
  335. it( 'should transform modelDiv 4', () => createToViewTest( modelDiv, 4, viewTextZZ, 2 ) );
  336. it( 'should transform modelImg 0', () => createToViewTest( modelImg, 0, viewImg, 0 ) );
  337. it( 'should transform modelCaption 0', () => createToViewTest( modelCaption, 0, viewTextFOO, 0 ) );
  338. it( 'should transform modelCaption 1', () => createToViewTest( modelCaption, 1, viewTextFOO, 1 ) );
  339. it( 'should transform modelCaption 2', () => createToViewTest( modelCaption, 2, viewTextFOO, 2 ) );
  340. it( 'should transform modelCaption 3', () => createToViewTest( modelCaption, 3, viewTextFOO, 3 ) );
  341. } );
  342. } );
  343. } );