8
0

documentselection.js 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168
  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. /**
  6. * @module engine/model/documentselection
  7. */
  8. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  9. import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
  10. import Selection from './selection';
  11. import LiveRange from './liverange';
  12. import Text from './text';
  13. import TextProxy from './textproxy';
  14. import toMap from '@ckeditor/ckeditor5-utils/src/tomap';
  15. import Collection from '@ckeditor/ckeditor5-utils/src/collection';
  16. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  17. import log from '@ckeditor/ckeditor5-utils/src/log';
  18. import uid from '@ckeditor/ckeditor5-utils/src/uid';
  19. const storePrefix = 'selection:';
  20. /**
  21. * `DocumentSelection` is a special selection which is used as the
  22. * {@link module:engine/model/document~Document#selection document's selection}.
  23. * There can be only one instance of `DocumentSelection` per document.
  24. *
  25. * Document selection can only be changed by using the {@link module:engine/model/writer~Writer} instance
  26. * inside the {@link module:engine/model/model~Model#change `change()`} block, as it provides a secure way to modify model.
  27. *
  28. * `DocumentSelection` is automatically updated upon changes in the {@link module:engine/model/document~Document document}
  29. * to always contain valid ranges. Its attributes are inherited from the text unless set explicitly.
  30. *
  31. * Differences between {@link module:engine/model/selection~Selection} and `DocumentSelection` are:
  32. * * there is always a range in `DocumentSelection` - even if no ranges were added there is a "default range"
  33. * present in the selection,
  34. * * ranges added to this selection updates automatically when the document changes,
  35. * * attributes of `DocumentSelection` are updated automatically according to selection ranges.
  36. *
  37. * Since `DocumentSelection` uses {@link module:engine/model/liverange~LiveRange live ranges}
  38. * and is updated when {@link module:engine/model/document~Document document}
  39. * changes, it cannot be set on {@link module:engine/model/node~Node nodes}
  40. * that are inside {@link module:engine/model/documentfragment~DocumentFragment document fragment}.
  41. * If you need to represent a selection in document fragment,
  42. * use {@link module:engine/model/selection~Selection Selection class} instead.
  43. *
  44. * @mixes module:utils/emittermixin~EmitterMixin
  45. */
  46. export default class DocumentSelection {
  47. /**
  48. * Creates an empty live selection for given {@link module:engine/model/document~Document}.
  49. *
  50. * @param {module:engine/model/document~Document} doc Document which owns this selection.
  51. */
  52. constructor( doc ) {
  53. /**
  54. * Selection used internally by that class (`DocumentSelection` is a proxy to that selection).
  55. *
  56. * @protected
  57. */
  58. this._selection = new LiveSelection( doc );
  59. this._selection.delegate( 'change:range' ).to( this );
  60. this._selection.delegate( 'change:attribute' ).to( this );
  61. }
  62. /**
  63. * Returns whether the selection is collapsed. Selection is collapsed when there is exactly one range which is
  64. * collapsed.
  65. *
  66. * @readonly
  67. * @type {Boolean}
  68. */
  69. get isCollapsed() {
  70. return this._selection.isCollapsed;
  71. }
  72. /**
  73. * Selection anchor. Anchor may be described as a position where the most recent part of the selection starts.
  74. * Together with {@link #focus} they define the direction of selection, which is important
  75. * when expanding/shrinking selection. Anchor is always {@link module:engine/model/range~Range#start start} or
  76. * {@link module:engine/model/range~Range#end end} position of the most recently added range.
  77. *
  78. * Is set to `null` if there are no ranges in selection.
  79. *
  80. * @see #focus
  81. * @readonly
  82. * @type {module:engine/model/position~Position|null}
  83. */
  84. get anchor() {
  85. return this._selection.anchor;
  86. }
  87. /**
  88. * Selection focus. Focus is a position where the selection ends.
  89. *
  90. * Is set to `null` if there are no ranges in selection.
  91. *
  92. * @see #anchor
  93. * @readonly
  94. * @type {module:engine/model/position~Position|null}
  95. */
  96. get focus() {
  97. return this._selection.focus;
  98. }
  99. /**
  100. * Returns number of ranges in selection.
  101. *
  102. * @readonly
  103. * @type {Number}
  104. */
  105. get rangeCount() {
  106. return this._selection.rangeCount;
  107. }
  108. /**
  109. * Describes whether `Documentselection` has own range(s) set, or if it is defaulted to
  110. * {@link module:engine/model/document~Document#_getDefaultRange document's default range}.
  111. *
  112. * @readonly
  113. * @type {Boolean}
  114. */
  115. get hasOwnRange() {
  116. return this._selection.hasOwnRange;
  117. }
  118. /**
  119. * Specifies whether the {@link #focus}
  120. * precedes {@link #anchor}.
  121. *
  122. * @readonly
  123. * @type {Boolean}
  124. */
  125. get isBackward() {
  126. return this._selection.isBackward;
  127. }
  128. /**
  129. * Describes whether the gravity is overridden (using {@link module:engine/model/writer~Writer#overrideSelectionGravity}) or not.
  130. *
  131. * Note that the gravity remains overridden as long as will not be restored the same number of times as it was overridden.
  132. *
  133. * @readonly
  134. * @returns {Boolean}
  135. */
  136. get isGravityOverridden() {
  137. return this._selection.isGravityOverridden;
  138. }
  139. /**
  140. * A collection of selection markers.
  141. * Marker is a selection marker when selection range is inside the marker range.
  142. *
  143. * @readonly
  144. * @type {module:utils/collection~Collection.<module:engine/model/markercollection~Marker>}
  145. */
  146. get markers() {
  147. return this._selection.markers;
  148. }
  149. /**
  150. * Used for the compatibility with the {@link module:engine/model/selection~Selection#isEqual} method.
  151. *
  152. * @protected
  153. */
  154. get _ranges() {
  155. return this._selection._ranges;
  156. }
  157. /**
  158. * Returns an iterable that iterates over copies of selection ranges.
  159. *
  160. * @returns {Iterable.<module:engine/model/range~Range>}
  161. */
  162. getRanges() {
  163. return this._selection.getRanges();
  164. }
  165. /**
  166. * Returns the first position in the selection.
  167. * First position is the position that {@link module:engine/model/position~Position#isBefore is before}
  168. * any other position in the selection.
  169. *
  170. * Returns `null` if there are no ranges in selection.
  171. *
  172. * @returns {module:engine/model/position~Position|null}
  173. */
  174. getFirstPosition() {
  175. return this._selection.getFirstPosition();
  176. }
  177. /**
  178. * Returns the last position in the selection.
  179. * Last position is the position that {@link module:engine/model/position~Position#isAfter is after}
  180. * any other position in the selection.
  181. *
  182. * Returns `null` if there are no ranges in selection.
  183. *
  184. * @returns {module:engine/model/position~Position|null}
  185. */
  186. getLastPosition() {
  187. return this._selection.getLastPosition();
  188. }
  189. /**
  190. * Returns a copy of the first range in the selection.
  191. * First range is the one which {@link module:engine/model/range~Range#start start} position
  192. * {@link module:engine/model/position~Position#isBefore is before} start position of all other ranges
  193. * (not to confuse with the first range added to the selection).
  194. *
  195. * Returns `null` if there are no ranges in selection.
  196. *
  197. * @returns {module:engine/model/range~Range|null}
  198. */
  199. getFirstRange() {
  200. return this._selection.getFirstRange();
  201. }
  202. /**
  203. * Returns a copy of the last range in the selection.
  204. * Last range is the one which {@link module:engine/model/range~Range#end end} position
  205. * {@link module:engine/model/position~Position#isAfter is after} end position of all other ranges (not to confuse with the range most
  206. * recently added to the selection).
  207. *
  208. * Returns `null` if there are no ranges in selection.
  209. *
  210. * @returns {module:engine/model/range~Range|null}
  211. */
  212. getLastRange() {
  213. return this._selection.getLastRange();
  214. }
  215. /**
  216. * Gets elements of type "block" touched by the selection.
  217. *
  218. * This method's result can be used for example to apply block styling to all blocks covered by this selection.
  219. *
  220. * **Note:** `getSelectedBlocks()` always returns the deepest block.
  221. *
  222. * In this case the function will return exactly all 3 paragraphs:
  223. *
  224. * <paragraph>[a</paragraph>
  225. * <quote>
  226. * <paragraph>b</paragraph>
  227. * </quote>
  228. * <paragraph>c]d</paragraph>
  229. *
  230. * In this case the paragraph will also be returned, despite the collapsed selection:
  231. *
  232. * <paragraph>[]a</paragraph>
  233. *
  234. * **Special case**: If a selection ends at the beginning of a block, that block is not returned as from user perspective
  235. * this block wasn't selected. See [#984](https://github.com/ckeditor/ckeditor5-engine/issues/984) for more details.
  236. *
  237. * <paragraph>[a</paragraph>
  238. * <paragraph>b</paragraph>
  239. * <paragraph>]c</paragraph> // this block will not be returned
  240. *
  241. * @returns {Iterable.<module:engine/model/element~Element>}
  242. */
  243. getSelectedBlocks() {
  244. return this._selection.getSelectedBlocks();
  245. }
  246. /**
  247. * Returns blocks that aren't nested in other selected blocks.
  248. *
  249. * In this case the method will return blocks A, B and E because C & D are children of block B:
  250. *
  251. * [<blockA></blockA>
  252. * <blockB>
  253. * <blockC></blockC>
  254. * <blockD></blockD>
  255. * </blockB>
  256. * <blockE></blockE>]
  257. *
  258. * **Note:** To get all selected blocks use {@link #getSelectedBlocks `getSelectedBlocks()`}.
  259. *
  260. * @returns {Iterable.<module:engine/model/element~Element>}
  261. */
  262. getTopMostBlocks() {
  263. return this._selection.getTopMostBlocks();
  264. }
  265. /**
  266. * Returns the selected element. {@link module:engine/model/element~Element Element} is considered as selected if there is only
  267. * one range in the selection, and that range contains exactly one element.
  268. * Returns `null` if there is no selected element.
  269. *
  270. * @returns {module:engine/model/element~Element|null}
  271. */
  272. getSelectedElement() {
  273. return this._selection.getSelectedElement();
  274. }
  275. /**
  276. * Checks whether the selection contains the entire content of the given element. This means that selection must start
  277. * at a position {@link module:engine/model/position~Position#isTouching touching} the element's start and ends at position
  278. * touching the element's end.
  279. *
  280. * By default, this method will check whether the entire content of the selection's current root is selected.
  281. * Useful to check if e.g. the user has just pressed <kbd>Ctrl</kbd> + <kbd>A</kbd>.
  282. *
  283. * @param {module:engine/model/element~Element} [element=this.anchor.root]
  284. * @returns {Boolean}
  285. */
  286. containsEntireContent( element ) {
  287. return this._selection.containsEntireContent( element );
  288. }
  289. /**
  290. * Unbinds all events previously bound by document selection.
  291. */
  292. destroy() {
  293. this._selection.destroy();
  294. }
  295. /**
  296. * Returns iterable that iterates over this selection's attribute keys.
  297. *
  298. * @returns {Iterable.<String>}
  299. */
  300. getAttributeKeys() {
  301. return this._selection.getAttributeKeys();
  302. }
  303. /**
  304. * Returns iterable that iterates over this selection's attributes.
  305. *
  306. * Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value.
  307. * This format is accepted by native `Map` object and also can be passed in `Node` constructor.
  308. *
  309. * @returns {Iterable.<*>}
  310. */
  311. getAttributes() {
  312. return this._selection.getAttributes();
  313. }
  314. /**
  315. * Gets an attribute value for given key or `undefined` if that attribute is not set on the selection.
  316. *
  317. * @param {String} key Key of attribute to look for.
  318. * @returns {*} Attribute value or `undefined`.
  319. */
  320. getAttribute( key ) {
  321. return this._selection.getAttribute( key );
  322. }
  323. /**
  324. * Checks if the selection has an attribute for given key.
  325. *
  326. * @param {String} key Key of attribute to check.
  327. * @returns {Boolean} `true` if attribute with given key is set on selection, `false` otherwise.
  328. */
  329. hasAttribute( key ) {
  330. return this._selection.hasAttribute( key );
  331. }
  332. /**
  333. * Refreshes selection attributes and markers according to the current position in the model.
  334. */
  335. refresh() {
  336. this._selection._updateMarkers();
  337. this._selection._updateAttributes( false );
  338. }
  339. /**
  340. * Checks whether object is of given type following the convention set by
  341. * {@link module:engine/model/node~Node#is `Node#is()`}.
  342. *
  343. * const selection = new DocumentSelection( ... );
  344. *
  345. * selection.is( 'selection' ); // true
  346. * selection.is( 'documentSelection' ); // true
  347. * selection.is( 'node' ); // false
  348. * selection.is( 'element' ); // false
  349. *
  350. * @param {String} type
  351. * @returns {Boolean}
  352. */
  353. is( type ) {
  354. return type == 'selection' || type == 'documentSelection';
  355. }
  356. /**
  357. * Moves {@link module:engine/model/documentselection~DocumentSelection#focus} to the specified location.
  358. * Should be used only within the {@link module:engine/model/writer~Writer#setSelectionFocus} method.
  359. *
  360. * The location can be specified in the same form as
  361. * {@link module:engine/model/writer~Writer#createPositionAt writer.createPositionAt()} parameters.
  362. *
  363. * @see module:engine/model/writer~Writer#setSelectionFocus
  364. * @protected
  365. * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
  366. * @param {Number|'end'|'before'|'after'} [offset] Offset or one of the flags. Used only when
  367. * first parameter is a {@link module:engine/model/item~Item model item}.
  368. */
  369. _setFocus( itemOrPosition, offset ) {
  370. this._selection.setFocus( itemOrPosition, offset );
  371. }
  372. /**
  373. * Sets this selection's ranges and direction to the specified location based on the given
  374. * {@link module:engine/model/selection~Selectable selectable}.
  375. * Should be used only within the {@link module:engine/model/writer~Writer#setSelection} method.
  376. *
  377. * @see module:engine/model/writer~Writer#setSelection
  378. * @protected
  379. * @param {module:engine/model/selection~Selectable} selectable
  380. * @param {Number|'before'|'end'|'after'|'on'|'in'} [placeOrOffset] Sets place or offset of the selection.
  381. * @param {Object} [options]
  382. * @param {Boolean} [options.backward] Sets this selection instance to be backward.
  383. */
  384. _setTo( selectable, placeOrOffset, options ) {
  385. this._selection.setTo( selectable, placeOrOffset, options );
  386. }
  387. /**
  388. * Sets attribute on the selection. If attribute with the same key already is set, it's value is overwritten.
  389. * Should be used only within the {@link module:engine/model/writer~Writer#setSelectionAttribute} method.
  390. *
  391. * @see module:engine/model/writer~Writer#setSelectionAttribute
  392. * @protected
  393. * @param {String} key Key of the attribute to set.
  394. * @param {*} value Attribute value.
  395. */
  396. _setAttribute( key, value ) {
  397. this._selection.setAttribute( key, value );
  398. }
  399. /**
  400. * Removes an attribute with given key from the selection.
  401. * If the given attribute was set on the selection, fires the {@link module:engine/model/selection~Selection#event:change:range}
  402. * event with removed attribute key.
  403. * Should be used only within the {@link module:engine/model/writer~Writer#removeSelectionAttribute} method.
  404. *
  405. * @see module:engine/model/writer~Writer#removeSelectionAttribute
  406. * @protected
  407. * @param {String} key Key of the attribute to remove.
  408. */
  409. _removeAttribute( key ) {
  410. this._selection.removeAttribute( key );
  411. }
  412. /**
  413. * Returns an iterable that iterates through all selection attributes stored in current selection's parent.
  414. *
  415. * @protected
  416. * @returns {Iterable.<*>}
  417. */
  418. _getStoredAttributes() {
  419. return this._selection._getStoredAttributes();
  420. }
  421. /**
  422. * Temporarily changes the gravity of the selection from the left to the right.
  423. *
  424. * The gravity defines from which direction the selection inherits its attributes. If it's the default left
  425. * gravity, the selection (after being moved by the the user) inherits attributes from its left hand side.
  426. * This method allows to temporarily override this behavior by forcing the gravity to the right.
  427. *
  428. * It returns an unique identifier which is required to restore the gravity. It guarantees the symmetry
  429. * of the process.
  430. *
  431. * @see module:engine/model/writer~Writer#overrideSelectionGravity
  432. * @protected
  433. * @returns {String} The unique id which allows restoring the gravity.
  434. */
  435. _overrideGravity() {
  436. return this._selection.overrideGravity();
  437. }
  438. /**
  439. * Restores the {@link ~DocumentSelection#_overrideGravity overridden gravity}.
  440. *
  441. * Restoring the gravity is only possible using the unique identifier returned by
  442. * {@link ~DocumentSelection#_overrideGravity}. Note that the gravity remains overridden as long as won't be restored
  443. * the same number of times it was overridden.
  444. *
  445. * @see module:engine/model/writer~Writer#restoreSelectionGravity
  446. * @protected
  447. * @param {String} uid The unique id returned by {@link #_overrideGravity}.
  448. */
  449. _restoreGravity( uid ) {
  450. this._selection.restoreGravity( uid );
  451. }
  452. /**
  453. * Generates and returns an attribute key for selection attributes store, basing on original attribute key.
  454. *
  455. * @protected
  456. * @param {String} key Attribute key to convert.
  457. * @returns {String} Converted attribute key, applicable for selection store.
  458. */
  459. static _getStoreAttributeKey( key ) {
  460. return storePrefix + key;
  461. }
  462. /**
  463. * Checks whether the given attribute key is an attribute stored on an element.
  464. *
  465. * @protected
  466. * @param {String} key
  467. * @returns {Boolean}
  468. */
  469. static _isStoreAttributeKey( key ) {
  470. return key.startsWith( storePrefix );
  471. }
  472. }
  473. mix( DocumentSelection, EmitterMixin );
  474. /**
  475. * Fired when selection range(s) changed.
  476. *
  477. * @event change:range
  478. * @param {Boolean} directChange In case of {@link module:engine/model/selection~Selection} class it is always set
  479. * to `true` which indicates that the selection change was caused by a direct use of selection's API.
  480. * The {@link module:engine/model/documentselection~DocumentSelection}, however, may change because its position
  481. * was directly changed through the {@link module:engine/model/writer~Writer writer} or because its position was
  482. * changed because the structure of the model has been changed (which means an indirect change).
  483. * The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live")
  484. * which mean that they are not updated once the document changes.
  485. */
  486. /**
  487. * Fired when selection attribute changed.
  488. *
  489. * @event change:attribute
  490. * @param {Boolean} directChange In case of {@link module:engine/model/selection~Selection} class it is always set
  491. * to `true` which indicates that the selection change was caused by a direct use of selection's API.
  492. * The {@link module:engine/model/documentselection~DocumentSelection}, however, may change because its attributes
  493. * were directly changed through the {@link module:engine/model/writer~Writer writer} or because its position was
  494. * changed in the model and its attributes were refreshed (which means an indirect change).
  495. * The indirect change does not occur in case of normal (detached) selections because they are "static" (as "not live")
  496. * which mean that they are not updated once the document changes.
  497. * @param {Array.<String>} attributeKeys Array containing keys of attributes that changed.
  498. */
  499. // `LiveSelection` is used internally by {@link module:engine/model/documentselection~DocumentSelection} and shouldn't be used directly.
  500. //
  501. // LiveSelection` is automatically updated upon changes in the {@link module:engine/model/document~Document document}
  502. // to always contain valid ranges. Its attributes are inherited from the text unless set explicitly.
  503. //
  504. // Differences between {@link module:engine/model/selection~Selection} and `LiveSelection` are:
  505. // * there is always a range in `LiveSelection` - even if no ranges were added there is a "default range"
  506. // present in the selection,
  507. // * ranges added to this selection updates automatically when the document changes,
  508. // * attributes of `LiveSelection` are updated automatically according to selection ranges.
  509. //
  510. // @extends module:engine/model/selection~Selection
  511. //
  512. class LiveSelection extends Selection {
  513. // Creates an empty live selection for given {@link module:engine/model/document~Document}.
  514. // @param {module:engine/model/document~Document} doc Document which owns this selection.
  515. constructor( doc ) {
  516. super();
  517. // List of selection markers.
  518. // Marker is a selection marker when selection range is inside the marker range.
  519. //
  520. // @type {module:utils/collection~Collection}
  521. this.markers = new Collection( { idProperty: 'name' } );
  522. // Document which owns this selection.
  523. //
  524. // @protected
  525. // @member {module:engine/model/model~Model}
  526. this._model = doc.model;
  527. // Document which owns this selection.
  528. //
  529. // @protected
  530. // @member {module:engine/model/document~Document}
  531. this._document = doc;
  532. // Keeps mapping of attribute name to priority with which the attribute got modified (added/changed/removed)
  533. // last time. Possible values of priority are: `'low'` and `'normal'`.
  534. //
  535. // Priorities are used by internal `LiveSelection` mechanisms. All attributes set using `LiveSelection`
  536. // attributes API are set with `'normal'` priority.
  537. //
  538. // @private
  539. // @member {Map} module:engine/model/liveselection~LiveSelection#_attributePriority
  540. this._attributePriority = new Map();
  541. // Contains data required to fix ranges which have been moved to the graveyard.
  542. // @private
  543. // @member {Array} module:engine/model/liveselection~LiveSelection#_fixGraveyardRangesData
  544. this._fixGraveyardRangesData = [];
  545. // Flag that informs whether the selection ranges have changed. It is changed on true when `LiveRange#change:range` event is fired.
  546. // @private
  547. // @member {Array} module:engine/model/liveselection~LiveSelection#_hasChangedRange
  548. this._hasChangedRange = false;
  549. // Each overriding gravity adds an UID to the set and each removal removes it.
  550. // Gravity is overridden when there's at least one UID in the set.
  551. // Gravity is restored when the set is empty.
  552. // This is to prevent conflicts when gravity is overridden by more than one feature at the same time.
  553. // @private
  554. // @type {Set}
  555. this._overriddenGravityRegister = new Set();
  556. // Ensure selection is correct after each operation.
  557. this.listenTo( this._model, 'applyOperation', ( evt, args ) => {
  558. const operation = args[ 0 ];
  559. if ( !operation.isDocumentOperation || operation.type == 'marker' || operation.type == 'rename' || operation.type == 'noop' ) {
  560. return;
  561. }
  562. while ( this._fixGraveyardRangesData.length ) {
  563. const { liveRange, sourcePosition } = this._fixGraveyardRangesData.shift();
  564. this._fixGraveyardSelection( liveRange, sourcePosition );
  565. }
  566. if ( this._hasChangedRange ) {
  567. this._hasChangedRange = false;
  568. this.fire( 'change:range', { directChange: false } );
  569. }
  570. }, { priority: 'lowest' } );
  571. // Ensure selection is correct and up to date after each range change.
  572. this.on( 'change:range', () => {
  573. for ( const range of this.getRanges() ) {
  574. if ( !this._document._validateSelectionRange( range ) ) {
  575. /**
  576. * Range from {@link module:engine/model/documentselection~DocumentSelection document selection}
  577. * starts or ends at incorrect position.
  578. *
  579. * @error document-selection-wrong-position
  580. * @param {module:engine/model/range~Range} range
  581. */
  582. throw new CKEditorError(
  583. 'document-selection-wrong-position: Range from document selection starts or ends at incorrect position.',
  584. { range }
  585. );
  586. }
  587. }
  588. } );
  589. // Update markers data stored by the selection after each marker change.
  590. this.listenTo( this._model.markers, 'update', () => this._updateMarkers() );
  591. // Ensure selection is up to date after each change block.
  592. this.listenTo( this._document, 'change', ( evt, batch ) => {
  593. clearAttributesStoredInElement( this._model, batch );
  594. } );
  595. }
  596. get isCollapsed() {
  597. const length = this._ranges.length;
  598. return length === 0 ? this._document._getDefaultRange().isCollapsed : super.isCollapsed;
  599. }
  600. get anchor() {
  601. return super.anchor || this._document._getDefaultRange().start;
  602. }
  603. get focus() {
  604. return super.focus || this._document._getDefaultRange().end;
  605. }
  606. get rangeCount() {
  607. return this._ranges.length ? this._ranges.length : 1;
  608. }
  609. // Describes whether `LiveSelection` has own range(s) set, or if it is defaulted to
  610. // {@link module:engine/model/document~Document#_getDefaultRange document's default range}.
  611. //
  612. // @readonly
  613. // @type {Boolean}
  614. get hasOwnRange() {
  615. return this._ranges.length > 0;
  616. }
  617. // When set to `true` then selection attributes on node before the caret won't be taken
  618. // into consideration while updating selection attributes.
  619. //
  620. // @protected
  621. // @type {Boolean}
  622. get isGravityOverridden() {
  623. return !!this._overriddenGravityRegister.size;
  624. }
  625. // Unbinds all events previously bound by live selection.
  626. destroy() {
  627. for ( let i = 0; i < this._ranges.length; i++ ) {
  628. this._ranges[ i ].detach();
  629. }
  630. this.stopListening();
  631. }
  632. * getRanges() {
  633. if ( this._ranges.length ) {
  634. yield* super.getRanges();
  635. } else {
  636. yield this._document._getDefaultRange();
  637. }
  638. }
  639. getFirstRange() {
  640. return super.getFirstRange() || this._document._getDefaultRange();
  641. }
  642. getLastRange() {
  643. return super.getLastRange() || this._document._getDefaultRange();
  644. }
  645. setTo( selectable, optionsOrPlaceOrOffset, options ) {
  646. super.setTo( selectable, optionsOrPlaceOrOffset, options );
  647. this._updateAttributes( true );
  648. }
  649. setFocus( itemOrPosition, offset ) {
  650. super.setFocus( itemOrPosition, offset );
  651. this._updateAttributes( true );
  652. }
  653. setAttribute( key, value ) {
  654. if ( this._setAttribute( key, value ) ) {
  655. // Fire event with exact data.
  656. const attributeKeys = [ key ];
  657. this.fire( 'change:attribute', { attributeKeys, directChange: true } );
  658. }
  659. }
  660. removeAttribute( key ) {
  661. if ( this._removeAttribute( key ) ) {
  662. // Fire event with exact data.
  663. const attributeKeys = [ key ];
  664. this.fire( 'change:attribute', { attributeKeys, directChange: true } );
  665. }
  666. }
  667. overrideGravity() {
  668. const overrideUid = uid();
  669. // Remember that another overriding has been requested. It will need to be removed
  670. // before the gravity is to be restored.
  671. this._overriddenGravityRegister.add( overrideUid );
  672. if ( this._overriddenGravityRegister.size === 1 ) {
  673. this._updateAttributes( true );
  674. }
  675. return overrideUid;
  676. }
  677. restoreGravity( uid ) {
  678. if ( !this._overriddenGravityRegister.has( uid ) ) {
  679. /**
  680. * Restoring gravity for an unknown UID is not possible. Make sure you are using a correct
  681. * UID obtained from the {@link module:engine/model/writer~Writer#overrideSelectionGravity} to restore.
  682. *
  683. * @error document-selection-gravity-wrong-restore
  684. * @param {String} uid The unique identifier returned by
  685. * {@link module:engine/model/documentselection~DocumentSelection#_overrideGravity}.
  686. */
  687. throw new CKEditorError(
  688. 'document-selection-gravity-wrong-restore: Attempting to restore the selection gravity for an unknown UID.',
  689. { uid }
  690. );
  691. }
  692. this._overriddenGravityRegister.delete( uid );
  693. // Restore gravity only when all overriding have been restored.
  694. if ( !this.isGravityOverridden ) {
  695. this._updateAttributes( true );
  696. }
  697. }
  698. _popRange() {
  699. this._ranges.pop().detach();
  700. }
  701. _pushRange( range ) {
  702. const liveRange = this._prepareRange( range );
  703. // `undefined` is returned when given `range` is in graveyard root.
  704. if ( liveRange ) {
  705. this._ranges.push( liveRange );
  706. }
  707. }
  708. // Prepares given range to be added to selection. Checks if it is correct,
  709. // converts it to {@link module:engine/model/liverange~LiveRange LiveRange}
  710. // and sets listeners listening to the range's change event.
  711. //
  712. // @private
  713. // @param {module:engine/model/range~Range} range
  714. _prepareRange( range ) {
  715. this._checkRange( range );
  716. if ( range.root == this._document.graveyard ) {
  717. /**
  718. * Trying to add a Range that is in the graveyard root. Range rejected.
  719. *
  720. * @warning model-selection-range-in-graveyard
  721. */
  722. log.warn( 'model-selection-range-in-graveyard: Trying to add a Range that is in the graveyard root. Range rejected.' );
  723. return;
  724. }
  725. const liveRange = LiveRange.fromRange( range );
  726. liveRange.on( 'change:range', ( evt, oldRange, data ) => {
  727. this._hasChangedRange = true;
  728. // If `LiveRange` is in whole moved to the graveyard, save necessary data. It will be fixed on `Model#applyOperation` event.
  729. if ( liveRange.root == this._document.graveyard ) {
  730. this._fixGraveyardRangesData.push( {
  731. liveRange,
  732. sourcePosition: data.deletionPosition
  733. } );
  734. }
  735. } );
  736. return liveRange;
  737. }
  738. _updateMarkers() {
  739. const markers = [];
  740. for ( const marker of this._model.markers ) {
  741. const markerRange = marker.getRange();
  742. for ( const selectionRange of this.getRanges() ) {
  743. if ( markerRange.containsRange( selectionRange, !selectionRange.isCollapsed ) ) {
  744. markers.push( marker );
  745. }
  746. }
  747. }
  748. for ( const marker of markers ) {
  749. if ( !this.markers.has( marker ) ) {
  750. this.markers.add( marker );
  751. }
  752. }
  753. for ( const marker of Array.from( this.markers ) ) {
  754. if ( !markers.includes( marker ) ) {
  755. this.markers.remove( marker );
  756. }
  757. }
  758. }
  759. // Updates this selection attributes according to its ranges and the {@link module:engine/model/document~Document model document}.
  760. //
  761. // @protected
  762. // @param {Boolean} clearAll
  763. // @fires change:attribute
  764. _updateAttributes( clearAll ) {
  765. const newAttributes = toMap( this._getSurroundingAttributes() );
  766. const oldAttributes = toMap( this.getAttributes() );
  767. if ( clearAll ) {
  768. // If `clearAll` remove all attributes and reset priorities.
  769. this._attributePriority = new Map();
  770. this._attrs = new Map();
  771. } else {
  772. // If not, remove only attributes added with `low` priority.
  773. for ( const [ key, priority ] of this._attributePriority ) {
  774. if ( priority == 'low' ) {
  775. this._attrs.delete( key );
  776. this._attributePriority.delete( key );
  777. }
  778. }
  779. }
  780. this._setAttributesTo( newAttributes );
  781. // Let's evaluate which attributes really changed.
  782. const changed = [];
  783. // First, loop through all attributes that are set on selection right now.
  784. // Check which of them are different than old attributes.
  785. for ( const [ newKey, newValue ] of this.getAttributes() ) {
  786. if ( !oldAttributes.has( newKey ) || oldAttributes.get( newKey ) !== newValue ) {
  787. changed.push( newKey );
  788. }
  789. }
  790. // Then, check which of old attributes got removed.
  791. for ( const [ oldKey ] of oldAttributes ) {
  792. if ( !this.hasAttribute( oldKey ) ) {
  793. changed.push( oldKey );
  794. }
  795. }
  796. // Fire event with exact data (fire only if anything changed).
  797. if ( changed.length > 0 ) {
  798. this.fire( 'change:attribute', { attributeKeys: changed, directChange: false } );
  799. }
  800. }
  801. // Internal method for setting `LiveSelection` attribute. Supports attribute priorities (through `directChange`
  802. // parameter).
  803. //
  804. // @private
  805. // @param {String} key Attribute key.
  806. // @param {*} value Attribute value.
  807. // @param {Boolean} [directChange=true] `true` if the change is caused by `Selection` API, `false` if change
  808. // is caused by `Batch` API.
  809. // @returns {Boolean} Whether value has changed.
  810. _setAttribute( key, value, directChange = true ) {
  811. const priority = directChange ? 'normal' : 'low';
  812. if ( priority == 'low' && this._attributePriority.get( key ) == 'normal' ) {
  813. // Priority too low.
  814. return false;
  815. }
  816. const oldValue = super.getAttribute( key );
  817. // Don't do anything if value has not changed.
  818. if ( oldValue === value ) {
  819. return false;
  820. }
  821. this._attrs.set( key, value );
  822. // Update priorities map.
  823. this._attributePriority.set( key, priority );
  824. return true;
  825. }
  826. // Internal method for removing `LiveSelection` attribute. Supports attribute priorities (through `directChange`
  827. // parameter).
  828. //
  829. // NOTE: Even if attribute is not present in the selection but is provided to this method, it's priority will
  830. // be changed according to `directChange` parameter.
  831. //
  832. // @private
  833. // @param {String} key Attribute key.
  834. // @param {Boolean} [directChange=true] `true` if the change is caused by `Selection` API, `false` if change
  835. // is caused by `Batch` API.
  836. // @returns {Boolean} Whether attribute was removed. May not be true if such attributes didn't exist or the
  837. // existing attribute had higher priority.
  838. _removeAttribute( key, directChange = true ) {
  839. const priority = directChange ? 'normal' : 'low';
  840. if ( priority == 'low' && this._attributePriority.get( key ) == 'normal' ) {
  841. // Priority too low.
  842. return false;
  843. }
  844. // Update priorities map.
  845. this._attributePriority.set( key, priority );
  846. // Don't do anything if value has not changed.
  847. if ( !super.hasAttribute( key ) ) {
  848. return false;
  849. }
  850. this._attrs.delete( key );
  851. return true;
  852. }
  853. // Internal method for setting multiple `LiveSelection` attributes. Supports attribute priorities (through
  854. // `directChange` parameter).
  855. //
  856. // @private
  857. // @param {Map.<String,*>} attrs Iterable object containing attributes to be set.
  858. // @returns {Set.<String>} Changed attribute keys.
  859. _setAttributesTo( attrs ) {
  860. const changed = new Set();
  861. for ( const [ oldKey, oldValue ] of this.getAttributes() ) {
  862. // Do not remove attribute if attribute with same key and value is about to be set.
  863. if ( attrs.get( oldKey ) === oldValue ) {
  864. continue;
  865. }
  866. // All rest attributes will be removed so changed attributes won't change .
  867. this._removeAttribute( oldKey, false );
  868. }
  869. for ( const [ key, value ] of attrs ) {
  870. // Attribute may not be set because of attributes or because same key/value is already added.
  871. const gotAdded = this._setAttribute( key, value, false );
  872. if ( gotAdded ) {
  873. changed.add( key );
  874. }
  875. }
  876. return changed;
  877. }
  878. // Returns an iterable that iterates through all selection attributes stored in current selection's parent.
  879. //
  880. // @protected
  881. // @returns {Iterable.<*>}
  882. * _getStoredAttributes() {
  883. const selectionParent = this.getFirstPosition().parent;
  884. if ( this.isCollapsed && selectionParent.isEmpty ) {
  885. for ( const key of selectionParent.getAttributeKeys() ) {
  886. if ( key.startsWith( storePrefix ) ) {
  887. const realKey = key.substr( storePrefix.length );
  888. yield [ realKey, selectionParent.getAttribute( key ) ];
  889. }
  890. }
  891. }
  892. }
  893. // Checks model text nodes that are closest to the selection's first position and returns attributes of first
  894. // found element. If there are no text nodes in selection's first position parent, it returns selection
  895. // attributes stored in that parent.
  896. //
  897. // @private
  898. // @returns {Iterable.<*>} Collection of attributes.
  899. _getSurroundingAttributes() {
  900. const position = this.getFirstPosition();
  901. const schema = this._model.schema;
  902. let attrs = null;
  903. if ( !this.isCollapsed ) {
  904. // 1. If selection is a range...
  905. const range = this.getFirstRange();
  906. // ...look for a first character node in that range and take attributes from it.
  907. for ( const value of range ) {
  908. // If the item is an object, we don't want to get attributes from its children.
  909. if ( value.item.is( 'element' ) && schema.isObject( value.item ) ) {
  910. break;
  911. }
  912. if ( value.type == 'text' ) {
  913. attrs = value.item.getAttributes();
  914. break;
  915. }
  916. }
  917. } else {
  918. // 2. If the selection is a caret or the range does not contain a character node...
  919. const nodeBefore = position.textNode ? position.textNode : position.nodeBefore;
  920. const nodeAfter = position.textNode ? position.textNode : position.nodeAfter;
  921. // When gravity is overridden then don't take node before into consideration.
  922. if ( !this.isGravityOverridden ) {
  923. // ...look at the node before caret and take attributes from it if it is a character node.
  924. attrs = getAttrsIfCharacter( nodeBefore );
  925. }
  926. // 3. If not, look at the node after caret...
  927. if ( !attrs ) {
  928. attrs = getAttrsIfCharacter( nodeAfter );
  929. }
  930. // 4. If not, try to find the first character on the left, that is in the same node.
  931. // When gravity is overridden then don't take node before into consideration.
  932. if ( !this.isGravityOverridden && !attrs ) {
  933. let node = nodeBefore;
  934. while ( node && !attrs ) {
  935. node = node.previousSibling;
  936. attrs = getAttrsIfCharacter( node );
  937. }
  938. }
  939. // 5. If not found, try to find the first character on the right, that is in the same node.
  940. if ( !attrs ) {
  941. let node = nodeAfter;
  942. while ( node && !attrs ) {
  943. node = node.nextSibling;
  944. attrs = getAttrsIfCharacter( node );
  945. }
  946. }
  947. // 6. If not found, selection should retrieve attributes from parent.
  948. if ( !attrs ) {
  949. attrs = this._getStoredAttributes();
  950. }
  951. }
  952. return attrs;
  953. }
  954. // Fixes a selection range after it ends up in graveyard root.
  955. //
  956. // @private
  957. // @param {module:engine/model/liverange~LiveRange} liveRange The range from selection, that ended up in the graveyard root.
  958. // @param {module:engine/model/position~Position} removedRangeStart Start position of a range which was removed.
  959. _fixGraveyardSelection( liveRange, removedRangeStart ) {
  960. // The start of the removed range is the closest position to the `liveRange` - the original selection range.
  961. // This is a good candidate for a fixed selection range.
  962. const positionCandidate = removedRangeStart.clone();
  963. // Find a range that is a correct selection range and is closest to the start of removed range.
  964. const selectionRange = this._model.schema.getNearestSelectionRange( positionCandidate );
  965. // Remove the old selection range before preparing and adding new selection range. This order is important,
  966. // because new range, in some cases, may intersect with old range (it depends on `getNearestSelectionRange()` result).
  967. const index = this._ranges.indexOf( liveRange );
  968. this._ranges.splice( index, 1 );
  969. liveRange.detach();
  970. // If nearest valid selection range has been found - add it in the place of old range.
  971. if ( selectionRange ) {
  972. // Check the range, convert it to live range, bind events, etc.
  973. const newRange = this._prepareRange( selectionRange );
  974. // Add new range in the place of old range.
  975. this._ranges.splice( index, 0, newRange );
  976. }
  977. // If nearest valid selection range cannot be found - just removing the old range is fine.
  978. }
  979. }
  980. // Helper function for {@link module:engine/model/liveselection~LiveSelection#_updateAttributes}.
  981. //
  982. // It takes model item, checks whether it is a text node (or text proxy) and, if so, returns it's attributes. If not, returns `null`.
  983. //
  984. // @param {module:engine/model/item~Item|null} node
  985. // @returns {Boolean}
  986. function getAttrsIfCharacter( node ) {
  987. if ( node instanceof TextProxy || node instanceof Text ) {
  988. return node.getAttributes();
  989. }
  990. return null;
  991. }
  992. // Removes selection attributes from element which is not empty anymore.
  993. //
  994. // @private
  995. // @param {module:engine/model/model~Model} model
  996. // @param {module:engine/model/batch~Batch} batch
  997. function clearAttributesStoredInElement( model, batch ) {
  998. const differ = model.document.differ;
  999. for ( const entry of differ.getChanges() ) {
  1000. if ( entry.type != 'insert' ) {
  1001. continue;
  1002. }
  1003. const changeParent = entry.position.parent;
  1004. const isNoLongerEmpty = entry.length === changeParent.maxOffset;
  1005. if ( isNoLongerEmpty ) {
  1006. model.enqueueChange( batch, writer => {
  1007. const storedAttributes = Array.from( changeParent.getAttributeKeys() )
  1008. .filter( key => key.startsWith( storePrefix ) );
  1009. for ( const key of storedAttributes ) {
  1010. writer.removeAttribute( key, changeParent );
  1011. }
  1012. } );
  1013. }
  1014. }
  1015. }