documentselection.js 38 KB

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