| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/model/liveselection
- */
- import Position from './position.js';
- import Range from './range.js';
- import LiveRange from './liverange.js';
- import Text from './text.js';
- import TextProxy from './textproxy.js';
- import toMap from '../../utils/tomap.js';
- import CKEditorError from '../../utils/ckeditorerror.js';
- import log from '../../utils/log.js';
- import Selection from './selection.js';
- const storePrefix = 'selection:';
- const attrOpTypes = new Set(
- [ 'addAttribute', 'removeAttribute', 'changeAttribute', 'addRootAttribute', 'removeRootAttribute', 'changeRootAttribute' ]
- );
- /**
- * `LiveSelection` is a type of {@link module:engine/model/selection~Selection selection} that listens to changes on a
- * {@link module:engine/model/document~Document document} and has it ranges updated accordingly. Internal implementation of this
- * mechanism bases on {@link module:engine/model/liverange~LiveRange live ranges}.
- *
- * Differences between {@link module:engine/model/selection~Selection} and `LiveSelection` are two:
- * * there is always a range in `LiveSelection` - even if no ranges were added there is a
- * {@link module:engine/model/liveselection~LiveSelection#_getDefaultRange "default range"} present in the selection,
- * * ranges added to this selection updates automatically when the document changes.
- *
- * Since `LiveSelection` uses {@link module:engine/model/liverange~LiveRange live ranges}
- * and is updated when {@link module:engine/model/document~Document document}
- * changes, it cannot be set on {@link module:engine/model/node~Node nodes}
- * that are inside {@link module:engine/model/documentfragment~DocumentFragment document fragment}.
- * If you need to represent a selection in document fragment,
- * use {@link module:engine/model/selection~Selection "normal" selection} instead.
- *
- * @extends module:engine/model/selection~Selection
- */
- export default class LiveSelection extends Selection {
- /**
- * Creates an empty live selection for given {@link module:engine/model/document~Document}.
- *
- * @param {module:engine/model/document~Document} document Document which owns this selection.
- */
- constructor( document ) {
- super();
- /**
- * Document which owns this selection.
- *
- * @protected
- * @member {module:engine/model/document~Document} module:engine/model/liveselection~LiveSelection#_document
- */
- this._document = document;
- /**
- * Keeps mapping of attribute name to priority with which the attribute got modified (added/changed/removed)
- * last time. Possible values of priority are: `'low'` and `'normal'`.
- *
- * Priorities are used by internal `LiveSelection` mechanisms. All attributes set using `LiveSelection`
- * attributes API are set with `'normal'` priority.
- *
- * @private
- * @member {Map} module:engine/model/liveselection~LiveSelection#_attributePriority
- */
- this._attributePriority = new Map();
- // Whenever attribute operation is performed on document, update attributes. This is not the most efficient
- // way to update selection attributes, but should be okay for now. `_updateAttributes` will be fired too often,
- // but it won't change attributes or fire `change:attribute` event if not needed.
- this.listenTo( this._document, 'change', ( evt, type ) => {
- if ( attrOpTypes.has( type ) ) {
- this._updateAttributes( false );
- }
- } );
- }
- /**
- * @inheritDoc
- */
- get isCollapsed() {
- const length = this._ranges.length;
- return length === 0 ? true : super.isCollapsed;
- }
- /**
- * @inheritDoc
- */
- get anchor() {
- return super.anchor || this._document._getDefaultRange().start;
- }
- /**
- * @inheritDoc
- */
- get focus() {
- return super.focus || this._document._getDefaultRange().start;
- }
- /**
- * @inheritDoc
- */
- get rangeCount() {
- return this._ranges.length ? this._ranges.length : 1;
- }
- /**
- * Unbinds all events previously bound by document selection.
- */
- destroy() {
- for ( let i = 0; i < this._ranges.length; i++ ) {
- this._ranges[ i ].detach();
- }
- this.stopListening();
- }
- /**
- * @inheritDoc
- */
- *getRanges() {
- if ( this._ranges.length ) {
- yield *super.getRanges();
- } else {
- yield this._document._getDefaultRange();
- }
- }
- /**
- * @inheritDoc
- */
- getFirstRange() {
- return super.getFirstRange() || this._document._getDefaultRange();
- }
- /**
- * @inheritDoc
- */
- getLastRange() {
- return super.getLastRange() || this._document._getDefaultRange();
- }
- /**
- * @inheritDoc
- */
- addRange( range, isBackward = false ) {
- super.addRange( range, isBackward );
- this.refreshAttributes();
- }
- /**
- * @inheritDoc
- */
- removeAllRanges() {
- super.removeAllRanges();
- this.refreshAttributes();
- }
- /**
- * @inheritDoc
- */
- setRanges( newRanges, isLastBackward = false ) {
- super.setRanges( newRanges, isLastBackward );
- this.refreshAttributes();
- }
- /**
- * @inheritDoc
- */
- setAttribute( key, value ) {
- // Store attribute in parent element if the selection is collapsed in an empty node.
- if ( this.isCollapsed && this.anchor.parent.childCount === 0 ) {
- this._storeAttribute( key, value );
- }
- if ( this._setAttribute( key, value ) ) {
- // Fire event with exact data.
- const attributeKeys = [ key ];
- this.fire( 'change:attribute', { attributeKeys, directChange: true } );
- }
- }
- /**
- * @inheritDoc
- */
- removeAttribute( key ) {
- // Remove stored attribute from parent element if the selection is collapsed in an empty node.
- if ( this.isCollapsed && this.anchor.parent.childCount === 0 ) {
- this._removeStoredAttribute( key );
- }
- if ( this._removeAttribute( key ) ) {
- // Fire event with exact data.
- const attributeKeys = [ key ];
- this.fire( 'change:attribute', { attributeKeys, directChange: true } );
- }
- }
- /**
- * @inheritDoc
- */
- setAttributesTo( attrs ) {
- attrs = toMap( attrs );
- if ( this.isCollapsed && this.anchor.parent.childCount === 0 ) {
- this._setStoredAttributesTo( attrs );
- }
- const changed = this._setAttributesTo( attrs );
- if ( changed.size > 0 ) {
- // Fire event with exact data (fire only if anything changed).
- const attributeKeys = Array.from( changed );
- this.fire( 'change:attribute', { attributeKeys, directChange: true } );
- }
- }
- /**
- * @inheritDoc
- */
- clearAttributes() {
- this.setAttributesTo( [] );
- }
- /**
- * Removes all attributes from the selection and sets attributes according to the surrounding nodes.
- */
- refreshAttributes() {
- this._updateAttributes( true );
- }
- /**
- * Creates and returns an instance of `LiveSelection` that is a clone of given selection, meaning that it has same
- * ranges and same direction as this selection.
- *
- * @params {module:engine/model/selection~Selection} otherSelection Selection to be cloned.
- * @returns {module:engine/model/liveselection~LiveSelection} `Selection` instance that is a clone of given selection.
- */
- static createFromSelection( otherSelection ) {
- const selection = new this( otherSelection._document );
- selection.setTo( otherSelection );
- return selection;
- }
- /**
- * @inheritDoc
- */
- _popRange() {
- this._ranges.pop().detach();
- }
- /**
- * @inheritDoc
- */
- _pushRange( range ) {
- const liveRange = this._prepareRange( range );
- // `undefined` is returned when given `range` is in graveyard root.
- if ( liveRange ) {
- this._ranges.push( liveRange );
- }
- }
- /**
- * Prepares given range to be added to selection. Checks if it is correct,
- * converts it to {@link module:engine/model/liverange~LiveRange LiveRange}
- * and sets listeners listening to the range's change event.
- *
- * @private
- * @param {module:engine/model/range~Range} range
- */
- _prepareRange( range ) {
- if ( !( range instanceof Range ) ) {
- /**
- * Trying to add an object that is not an instance of Range.
- *
- * @error model-selection-added-not-range
- */
- throw new CKEditorError( 'model-selection-added-not-range: Trying to add an object that is not an instance of Range.' );
- }
- if ( range.root == this._document.graveyard ) {
- /**
- * Trying to add a Range that is in the graveyard root. Range rejected.
- *
- * @warning model-selection-range-in-graveyard
- */
- log.warn( 'model-selection-range-in-graveyard: Trying to add a Range that is in the graveyard root. Range rejected.' );
- return;
- }
- this._checkRange( range );
- const liveRange = LiveRange.createFromRange( range );
- this.listenTo( liveRange, 'change', ( evt, oldRange ) => {
- if ( liveRange.root == this._document.graveyard ) {
- this._fixGraveyardSelection( liveRange, oldRange );
- }
- this.fire( 'change:range', { directChange: false } );
- } );
- return liveRange;
- }
- /**
- * Updates this selection attributes according to its ranges and the {@link module:engine/model/document~Document model document}.
- *
- * @protected
- * @param {Boolean} clearAll
- * @fires change:attribute
- */
- _updateAttributes( clearAll ) {
- const newAttributes = toMap( this._getSurroundingAttributes() );
- const oldAttributes = toMap( this.getAttributes() );
- if ( clearAll ) {
- // If `clearAll` remove all attributes and reset priorities.
- this._attributePriority = new Map();
- this._attrs = new Map();
- } else {
- // If not, remove only attributes added with `low` priority.
- for ( let [ key, priority ] of this._attributePriority ) {
- if ( priority == 'low' ) {
- this._attrs.delete( key );
- this._attributePriority.delete( key );
- }
- }
- }
- this._setAttributesTo( newAttributes, false );
- // Let's evaluate which attributes really changed.
- const changed = [];
- // First, loop through all attributes that are set on selection right now.
- // Check which of them are different than old attributes.
- for ( let [ newKey, newValue ] of this.getAttributes() ) {
- if ( !oldAttributes.has( newKey ) || oldAttributes.get( newKey ) !== newValue ) {
- changed.push( newKey );
- }
- }
- // Then, check which of old attributes got removed.
- for ( let [ oldKey ] of oldAttributes ) {
- if ( !this.hasAttribute( oldKey ) ) {
- changed.push( oldKey );
- }
- }
- // Fire event with exact data (fire only if anything changed).
- if ( changed.length > 0 ) {
- this.fire( 'change:attribute', { attributeKeys: changed, directChange: false } );
- }
- }
- /**
- * Generates and returns an attribute key for selection attributes store, basing on original attribute key.
- *
- * @protected
- * @param {String} key Attribute key to convert.
- * @returns {String} Converted attribute key, applicable for selection store.
- */
- static _getStoreAttributeKey( key ) {
- return storePrefix + key;
- }
- /**
- * Internal method for setting `LiveSelection` attribute. Supports attribute priorities (through `directChange`
- * parameter).
- *
- * @private
- * @param {String} key Attribute key.
- * @param {*} value Attribute value.
- * @param {Boolean} [directChange=true] `true` if the change is caused by `Selection` API, `false` if change
- * is caused by `Batch` API.
- * @returns {Boolean} Whether value has changed.
- */
- _setAttribute( key, value, directChange = true ) {
- const priority = directChange ? 'normal' : 'low';
- if ( priority == 'low' && this._attributePriority.get( key ) == 'normal' ) {
- // Priority too low.
- return false;
- }
- const oldValue = super.getAttribute( key );
- // Don't do anything if value has not changed.
- if ( oldValue === value ) {
- return false;
- }
- this._attrs.set( key, value );
- // Update priorities map.
- this._attributePriority.set( key, priority );
- return true;
- }
- /**
- * Internal method for removing `LiveSelection` attribute. Supports attribute priorities (through `directChange`
- * parameter).
- *
- * @private
- * @param {String} key Attribute key.
- * @param {Boolean} [directChange=true] `true` if the change is caused by `Selection` API, `false` if change
- * is caused by `Batch` API.
- * @returns {Boolean} Whether attribute was removed. May not be true if such attributes didn't exist or the
- * existing attribute had higher priority.
- */
- _removeAttribute( key, directChange = true ) {
- const priority = directChange ? 'normal' : 'low';
- if ( priority == 'low' && this._attributePriority.get( key ) == 'normal' ) {
- // Priority too low.
- return false;
- }
- // Don't do anything if value has not changed.
- if ( !super.hasAttribute( key ) ) {
- return false;
- }
- this._attrs.delete( key );
- // Update priorities map.
- this._attributePriority.set( key, priority );
- return true;
- }
- /**
- * Internal method for setting multiple `LiveSelection` attributes. Supports attribute priorities (through
- * `directChange` parameter).
- *
- * @private
- * @param {Iterable|Object} attrs Iterable object containing attributes to be set.
- * @param {Boolean} [directChange=true] `true` if the change is caused by `Selection` API, `false` if change
- * is caused by `Batch` API.
- * @returns {Set.<String>} Changed attribute keys.
- */
- _setAttributesTo( attrs, directChange = true ) {
- const changed = new Set();
- for ( let [ oldKey, oldValue ] of this.getAttributes() ) {
- // Do not remove attribute if attribute with same key and value is about to be set.
- if ( attrs.get( oldKey ) === oldValue ) {
- continue;
- }
- // Attribute still might not get removed because of priorities.
- if ( this._removeAttribute( oldKey, directChange ) ) {
- changed.add( oldKey );
- }
- }
- for ( let [ key, value ] of attrs ) {
- // Attribute may not be set because of attributes or because same key/value is already added.
- const gotAdded = this._setAttribute( key, value, directChange );
- if ( gotAdded ) {
- changed.add( key );
- }
- }
- return changed;
- }
- /**
- * Returns an iterator that iterates through all selection attributes stored in current selection's parent.
- *
- * @private
- * @returns {Iterable.<*>}
- */
- *_getStoredAttributes() {
- const selectionParent = this.getFirstPosition().parent;
- if ( this.isCollapsed && selectionParent.childCount === 0 ) {
- for ( let key of selectionParent.getAttributeKeys() ) {
- if ( key.indexOf( storePrefix ) === 0 ) {
- const realKey = key.substr( storePrefix.length );
- yield [ realKey, selectionParent.getAttribute( key ) ];
- }
- }
- }
- }
- /**
- * Removes attribute with given key from attributes stored in current selection's parent node.
- *
- * @private
- * @param {String} key Key of attribute to remove.
- */
- _removeStoredAttribute( key ) {
- const storeKey = LiveSelection._getStoreAttributeKey( key );
- this._document.batch().removeAttribute( this.anchor.parent, storeKey );
- }
- /**
- * Stores given attribute key and value in current selection's parent node.
- *
- * @private
- * @param {String} key Key of attribute to set.
- * @param {*} value Attribute value.
- */
- _storeAttribute( key, value ) {
- const storeKey = LiveSelection._getStoreAttributeKey( key );
- this._document.batch().setAttribute( this.anchor.parent, storeKey, value );
- }
- /**
- * Sets selection attributes stored in current selection's parent node to given set of attributes.
- *
- * @private
- * @param {Iterable|Object} attrs Iterable object containing attributes to be set.
- */
- _setStoredAttributesTo( attrs ) {
- const selectionParent = this.anchor.parent;
- const batch = this._document.batch();
- for ( let [ oldKey ] of this._getStoredAttributes() ) {
- const storeKey = LiveSelection._getStoreAttributeKey( oldKey );
- batch.removeAttribute( selectionParent, storeKey );
- }
- for ( let [ key, value ] of attrs ) {
- const storeKey = LiveSelection._getStoreAttributeKey( key );
- batch.setAttribute( selectionParent, storeKey, value );
- }
- }
- /**
- * Checks model text nodes that are closest to the selection's first position and returns attributes of first
- * found element. If there are no text nodes in selection's first position parent, it returns selection
- * attributes stored in that parent.
- *
- * @private
- * @returns {Iterable.<*>} Collection of attributes.
- */
- _getSurroundingAttributes() {
- const position = this.getFirstPosition();
- let attrs = null;
- if ( !this.isCollapsed ) {
- // 1. If selection is a range...
- const range = this.getFirstRange();
- // ...look for a first character node in that range and take attributes from it.
- for ( let item of range ) {
- // This is not an optimal solution because of https://github.com/ckeditor/ckeditor5-engine/issues/454.
- // It can be done better by using `break;` instead of checking `attrs === null`.
- if ( item.type == 'text' && attrs === null ) {
- attrs = item.item.getAttributes();
- }
- }
- } else {
- // 2. If the selection is a caret or the range does not contain a character node...
- const nodeBefore = position.textNode ? position.textNode : position.nodeBefore;
- const nodeAfter = position.textNode ? position.textNode : position.nodeAfter;
- // ...look at the node before caret and take attributes from it if it is a character node.
- attrs = getAttrsIfCharacter( nodeBefore );
- // 3. If not, look at the node after caret...
- if ( !attrs ) {
- attrs = getAttrsIfCharacter( nodeAfter );
- }
- // 4. If not, try to find the first character on the left, that is in the same node.
- if ( !attrs ) {
- let node = nodeBefore;
- while ( node && !attrs ) {
- node = node.previousSibling;
- attrs = getAttrsIfCharacter( node );
- }
- }
- // 5. If not found, try to find the first character on the right, that is in the same node.
- if ( !attrs ) {
- let node = nodeAfter;
- while ( node && !attrs ) {
- node = node.nextSibling;
- attrs = getAttrsIfCharacter( node );
- }
- }
- // 6. If not found, selection should retrieve attributes from parent.
- if ( !attrs ) {
- attrs = this._getStoredAttributes();
- }
- }
- return attrs;
- }
- /**
- * Fixes a selection range after it ends up in graveyard root.
- *
- * @private
- * @param {module:engine/model/liverange~LiveRange} gyRange The range added in selection, that ended up in graveyard root.
- * @param {module:engine/model/range~Range} oldRange The state of that range before it was added to graveyard root.
- */
- _fixGraveyardSelection( gyRange, oldRange ) {
- const gyPath = gyRange.start.path;
- const newPathLength = oldRange.start.path.length - ( gyPath.length - 2 );
- const newPath = oldRange.start.path.slice( 0, newPathLength );
- newPath[ newPath.length - 1 ] -= gyPath[ 1 ];
- const newPosition = new Position( oldRange.root, newPath );
- const selectionPosition = this._document.getNearestSelectionPosition( newPosition );
- const newRange = this._prepareRange( new Range( selectionPosition ) );
- const index = this._ranges.indexOf( gyRange );
- this._ranges.splice( index, 1, newRange );
- gyRange.detach();
- }
- }
- /**
- * @event change:attribute
- */
- // Helper function for {@link module:engine/model/liveselection~LiveSelection#_updateAttributes}. 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`.
- //
- // @param {module:engine/model/item~Item} node
- // @returns {Boolean}
- function getAttrsIfCharacter( node ) {
- if ( node instanceof TextProxy || node instanceof Text ) {
- return node.getAttributes();
- }
- return null;
- }
|