| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/model/selection
- */
- import Position from './position';
- import Element from './element';
- import Range from './range';
- import EmitterMixin from '@ckeditor/ckeditor5-utils/src/emittermixin';
- import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- import toMap from '@ckeditor/ckeditor5-utils/src/tomap';
- import mapsEqual from '@ckeditor/ckeditor5-utils/src/mapsequal';
- /**
- * `Selection` is a group of {@link module:engine/model/range~Range ranges} which has a direction specified by
- * {@link module:engine/model/selection~Selection#anchor anchor} and {@link module:engine/model/selection~Selection#focus focus}.
- * Additionally, `Selection` may have it's own attributes.
- */
- export default class Selection {
- /**
- * Creates new selection instance.
- *
- * @param {Iterable.<module:engine/view/range~Range>} [ranges] An optional iterable object of ranges to set.
- * @param {Boolean} [isLastBackward] An optional flag describing if last added range was selected forward - from start to end
- * (`false`) or backward - from end to start (`true`). Defaults to `false`.
- */
- constructor( ranges, isLastBackward ) {
- /**
- * Specifies whether the last added range was added as a backward or forward range.
- *
- * @private
- * @member {Boolean}
- */
- this._lastRangeBackward = false;
- /**
- * Stores selection ranges.
- *
- * @protected
- * @member {Array.<module:engine/model/range~Range>}
- */
- this._ranges = [];
- /**
- * List of attributes set on current selection.
- *
- * @protected
- * @member {Map} module:engine/model/selection~Selection#_attrs
- */
- this._attrs = new Map();
- if ( ranges ) {
- this.setRanges( ranges, isLastBackward );
- }
- }
- /**
- * Selection anchor. Anchor may be described as a position where the most recent part of the selection starts.
- * Together with {@link #focus} they define the direction of selection, which is important
- * when expanding/shrinking selection. Anchor is always {@link module:engine/model/range~Range#start start} or
- * {@link module:engine/model/range~Range#end end} position of the most recently added range.
- *
- * Is set to `null` if there are no ranges in selection.
- *
- * @see #focus
- * @readonly
- * @type {module:engine/model/position~Position|null}
- */
- get anchor() {
- if ( this._ranges.length > 0 ) {
- const range = this._ranges[ this._ranges.length - 1 ];
- return this._lastRangeBackward ? range.end : range.start;
- }
- return null;
- }
- /**
- * Selection focus. Focus is a position where the selection ends.
- *
- * Is set to `null` if there are no ranges in selection.
- *
- * @see #anchor
- * @readonly
- * @type {module:engine/model/position~Position|null}
- */
- get focus() {
- if ( this._ranges.length > 0 ) {
- const range = this._ranges[ this._ranges.length - 1 ];
- return this._lastRangeBackward ? range.start : range.end;
- }
- return null;
- }
- /**
- * Returns whether the selection is collapsed. Selection is collapsed when there is exactly one range which is
- * collapsed.
- *
- * @readonly
- * @type {Boolean}
- */
- get isCollapsed() {
- const length = this._ranges.length;
- if ( length === 1 ) {
- return this._ranges[ 0 ].isCollapsed;
- } else {
- return false;
- }
- }
- /**
- * Returns number of ranges in selection.
- *
- * @type {Number}
- */
- get rangeCount() {
- return this._ranges.length;
- }
- /**
- * Specifies whether the {@link #focus}
- * precedes {@link #anchor}.
- *
- * @type {Boolean}
- */
- get isBackward() {
- return !this.isCollapsed && this._lastRangeBackward;
- }
- /**
- * Checks whether this selection is equal to given selection. Selections are equal if they have same directions,
- * same number of ranges and all ranges from one selection equal to a range from other selection.
- *
- * @param {module:engine/model/selection~Selection} otherSelection Selection to compare with.
- * @returns {Boolean} `true` if selections are equal, `false` otherwise.
- */
- isEqual( otherSelection ) {
- if ( this.rangeCount != otherSelection.rangeCount ) {
- return false;
- } else if ( this.rangeCount === 0 ) {
- return true;
- }
- if ( !this.anchor.isEqual( otherSelection.anchor ) || !this.focus.isEqual( otherSelection.focus ) ) {
- return false;
- }
- for ( const thisRange of this._ranges ) {
- let found = false;
- for ( const otherRange of otherSelection._ranges ) {
- if ( thisRange.isEqual( otherRange ) ) {
- found = true;
- break;
- }
- }
- if ( !found ) {
- return false;
- }
- }
- return true;
- }
- /**
- * Returns an iterator that iterates over copies of selection ranges.
- *
- * @returns {Iterator.<module:engine/model/range~Range>}
- */
- * getRanges() {
- for ( const range of this._ranges ) {
- yield Range.createFromRange( range );
- }
- }
- /**
- * Returns a copy of the first range in the selection.
- * First range is the one which {@link module:engine/model/range~Range#start start} position
- * {@link module:engine/model/position~Position#isBefore is before} start position of all other ranges
- * (not to confuse with the first range added to the selection).
- *
- * Returns `null` if there are no ranges in selection.
- *
- * @returns {module:engine/model/range~Range|null}
- */
- getFirstRange() {
- let first = null;
- for ( const range of this._ranges ) {
- if ( !first || range.start.isBefore( first.start ) ) {
- first = range;
- }
- }
- return first ? Range.createFromRange( first ) : null;
- }
- /**
- * Returns a copy of the last range in the selection.
- * Last range is the one which {@link module:engine/model/range~Range#end end} position
- * {@link module:engine/model/position~Position#isAfter is after} end position of all other ranges (not to confuse with the range most
- * recently added to the selection).
- *
- * Returns `null` if there are no ranges in selection.
- *
- * @returns {module:engine/model/range~Range|null}
- */
- getLastRange() {
- let last = null;
- for ( const range of this._ranges ) {
- if ( !last || range.end.isAfter( last.end ) ) {
- last = range;
- }
- }
- return last ? Range.createFromRange( last ) : null;
- }
- /**
- * Returns the first position in the selection.
- * First position is the position that {@link module:engine/model/position~Position#isBefore is before}
- * any other position in the selection.
- *
- * Returns `null` if there are no ranges in selection.
- *
- * @returns {module:engine/model/position~Position|null}
- */
- getFirstPosition() {
- const first = this.getFirstRange();
- return first ? Position.createFromPosition( first.start ) : null;
- }
- /**
- * Returns the last position in the selection.
- * Last position is the position that {@link module:engine/model/position~Position#isAfter is after}
- * any other position in the selection.
- *
- * Returns `null` if there are no ranges in selection.
- *
- * @returns {module:engine/model/position~Position|null}
- */
- getLastPosition() {
- const lastRange = this.getLastRange();
- return lastRange ? Position.createFromPosition( lastRange.end ) : null;
- }
- /**
- * Adds a range to this selection. Added range is copied. This means that passed range is not saved in `Selection`
- * instance and operating on it will not change `Selection` state.
- *
- * Accepts a flag describing in which way the selection is made - passed range might be selected from
- * {@link module:engine/model/range~Range#start start} to {@link module:engine/model/range~Range#end end}
- * or from {@link module:engine/model/range~Range#end end}
- * to {@link module:engine/model/range~Range#start start}.
- * The flag is used to set {@link #anchor} and
- * {@link #focus} properties.
- *
- * @fires change:range
- * @param {module:engine/model/range~Range} range Range to add.
- * @param {Boolean} [isBackward=false] Flag describing if added range was selected forward - from start to end (`false`)
- * or backward - from end to start (`true`).
- */
- addRange( range, isBackward = false ) {
- this._pushRange( range );
- this._lastRangeBackward = !!isBackward;
- this.fire( 'change:range', { directChange: true } );
- }
- /**
- * Removes all ranges that were added to the selection.
- *
- * @fires change:range
- */
- removeAllRanges() {
- if ( this._ranges.length > 0 ) {
- this._removeAllRanges();
- this.fire( 'change:range', { directChange: true } );
- }
- }
- /**
- * Replaces all ranges that were added to the selection with given array of ranges. Last range of the array
- * is treated like the last added range and is used to set {@link module:engine/model/selection~Selection#anchor} and
- * {@link module:engine/model/selection~Selection#focus}. Accepts a flag describing in which direction the selection is made
- * (see {@link module:engine/model/selection~Selection#addRange}).
- *
- * @fires change:range
- * @param {Iterable.<module:engine/model/range~Range>} newRanges Ranges to set.
- * @param {Boolean} [isLastBackward=false] Flag describing if last added range was selected forward - from start to end (`false`)
- * or backward - from end to start (`true`).
- */
- setRanges( newRanges, isLastBackward = false ) {
- newRanges = Array.from( newRanges );
- // Check whether there is any range in new ranges set that is different than all already added ranges.
- const anyNewRange = newRanges.some( newRange => {
- if ( !( newRange instanceof Range ) ) {
- throw new CKEditorError( 'model-selection-added-not-range: Trying to add an object that is not an instance of Range.' );
- }
- return this._ranges.every( oldRange => {
- return !oldRange.isEqual( newRange );
- } );
- } );
- // Don't do anything if nothing changed.
- if ( newRanges.length === this._ranges.length && !anyNewRange ) {
- return;
- }
- this._removeAllRanges();
- for ( const range of newRanges ) {
- this._pushRange( range );
- }
- this._lastRangeBackward = !!isLastBackward;
- this.fire( 'change:range', { directChange: true } );
- }
- /**
- * Sets this selection's ranges and direction to the ranges and direction of the given selection.
- *
- * @param {module:engine/model/selection~Selection} otherSelection
- */
- setTo( otherSelection ) {
- this.setRanges( otherSelection.getRanges(), otherSelection.isBackward );
- }
- /**
- * Sets collapsed selection in the specified location.
- *
- * The location can be specified in the same form as {@link module:engine/model/position~Position.createAt} parameters.
- *
- * @fires change:range
- * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
- * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
- * first parameter is a {@link module:engine/model/item~Item model item}.
- */
- collapse( itemOrPosition, offset ) {
- const pos = Position.createAt( itemOrPosition, offset );
- const range = new Range( pos, pos );
- this.setRanges( [ range ] );
- }
- /**
- * Collapses selection to the selection's {@link module:engine/model/selection~Selection#getFirstPosition first position}.
- * All ranges, besides the collapsed one, will be removed. Nothing will change if there are no ranges stored
- * inside selection.
- *
- * @fires change
- */
- collapseToStart() {
- const startPosition = this.getFirstPosition();
- if ( startPosition !== null ) {
- this.setRanges( [ new Range( startPosition, startPosition ) ] );
- }
- }
- /**
- * Collapses selection to the selection's {@link module:engine/model/selection~Selection#getLastPosition last position}.
- * All ranges, besides the collapsed one, will be removed. Nothing will change if there are no ranges stored
- * inside selection.
- *
- * @fires change
- */
- collapseToEnd() {
- const endPosition = this.getLastPosition();
- if ( endPosition !== null ) {
- this.setRanges( [ new Range( endPosition, endPosition ) ] );
- }
- }
- /**
- * Sets {@link module:engine/model/selection~Selection#focus} to the specified location.
- *
- * The location can be specified in the same form as {@link module:engine/model/position~Position.createAt} parameters.
- *
- * @fires change:range
- * @param {module:engine/model/item~Item|module:engine/model/position~Position} itemOrPosition
- * @param {Number|'end'|'before'|'after'} [offset=0] Offset or one of the flags. Used only when
- * first parameter is a {@link module:engine/model/item~Item model item}.
- */
- setFocus( itemOrPosition, offset ) {
- if ( this.anchor === null ) {
- /**
- * Cannot set selection focus if there are no ranges in selection.
- *
- * @error model-selection-setFocus-no-ranges
- */
- throw new CKEditorError(
- 'model-selection-setFocus-no-ranges: Cannot set selection focus if there are no ranges in selection.'
- );
- }
- const newFocus = Position.createAt( itemOrPosition, offset );
- if ( newFocus.compareWith( this.focus ) == 'same' ) {
- return;
- }
- const anchor = this.anchor;
- if ( this._ranges.length ) {
- this._popRange();
- }
- if ( newFocus.compareWith( anchor ) == 'before' ) {
- this.addRange( new Range( newFocus, anchor ), true );
- } else {
- this.addRange( new Range( anchor, newFocus ) );
- }
- }
- /**
- * Gets an attribute value for given key or `undefined` if that attribute is not set on the selection.
- *
- * @param {String} key Key of attribute to look for.
- * @returns {*} Attribute value or `undefined`.
- */
- getAttribute( key ) {
- return this._attrs.get( key );
- }
- /**
- * Returns iterator that iterates over this selection's attributes.
- *
- * Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value.
- * This format is accepted by native `Map` object and also can be passed in `Node` constructor.
- *
- * @returns {Iterable.<*>}
- */
- getAttributes() {
- return this._attrs.entries();
- }
- /**
- * Returns iterator that iterates over this selection's attribute keys.
- *
- * @returns {Iterator.<String>}
- */
- getAttributeKeys() {
- return this._attrs.keys();
- }
- /**
- * Checks if the selection has an attribute for given key.
- *
- * @param {String} key Key of attribute to check.
- * @returns {Boolean} `true` if attribute with given key is set on selection, `false` otherwise.
- */
- hasAttribute( key ) {
- return this._attrs.has( key );
- }
- /**
- * Removes all attributes from the selection.
- *
- * If there were any attributes in selection, fires the {@link #event:change} event with
- * removed attributes' keys.
- *
- * @fires change:attribute
- */
- clearAttributes() {
- if ( this._attrs.size > 0 ) {
- const attributeKeys = Array.from( this._attrs.keys() );
- this._attrs.clear();
- this.fire( 'change:attribute', { attributeKeys, directChange: true } );
- }
- }
- /**
- * Removes an attribute with given key from the selection.
- *
- * If given attribute was set on the selection, fires the {@link #event:change} event with
- * removed attribute key.
- *
- * @fires change:attribute
- * @param {String} key Key of attribute to remove.
- */
- removeAttribute( key ) {
- if ( this.hasAttribute( key ) ) {
- this._attrs.delete( key );
- this.fire( 'change:attribute', { attributeKeys: [ key ], directChange: true } );
- }
- }
- /**
- * Sets attribute on the selection. If attribute with the same key already is set, it's value is overwritten.
- *
- * If the attribute value has changed, fires the {@link #event:change} event with
- * the attribute key.
- *
- * @fires change:attribute
- * @param {String} key Key of attribute to set.
- * @param {*} value Attribute value.
- */
- setAttribute( key, value ) {
- if ( this.getAttribute( key ) !== value ) {
- this._attrs.set( key, value );
- this.fire( 'change:attribute', { attributeKeys: [ key ], directChange: true } );
- }
- }
- /**
- * Removes all attributes from the selection and sets given attributes.
- *
- * If given set of attributes is different than set of attributes already added to selection, fires
- * {@link #event:change change event} with keys of attributes that changed.
- *
- * @fires event:change:attribute
- * @param {Iterable|Object} attrs Iterable object containing attributes to be set.
- */
- setAttributesTo( attrs ) {
- attrs = toMap( attrs );
- if ( !mapsEqual( attrs, this._attrs ) ) {
- // Create a set from keys of old and new attributes.
- const changed = new Set( Array.from( attrs.keys() ).concat( Array.from( this._attrs.keys() ) ) );
- for ( const [ key, value ] of attrs ) {
- // If the attribute remains unchanged, remove it from changed set.
- if ( this._attrs.get( key ) === value ) {
- changed.delete( key );
- }
- }
- this._attrs = attrs;
- this.fire( 'change:attribute', { attributeKeys: Array.from( changed ), directChange: true } );
- }
- }
- /**
- * Returns the selected element. {@link module:engine/model/element~Element Element} is considered as selected if there is only
- * one range in the selection, and that range contains exactly one element.
- * Returns `null` if there is no selected element.
- *
- * @returns {module:engine/model/element~Element|null}
- */
- getSelectedElement() {
- if ( this.rangeCount !== 1 ) {
- return null;
- }
- const range = this.getFirstRange();
- const nodeAfterStart = range.start.nodeAfter;
- const nodeBeforeEnd = range.end.nodeBefore;
- return ( nodeAfterStart instanceof Element && nodeAfterStart == nodeBeforeEnd ) ? nodeAfterStart : null;
- }
- /**
- * Gets elements of type "block" touched by the selection.
- *
- * This method's result can be used for example to apply block styling to all blocks covered by this selection.
- *
- * **Note:** `getSelectedBlocks()` always returns the deepest block.
- *
- * In this case the function will return exactly all 3 paragraphs:
- *
- * <paragraph>[a</paragraph>
- * <quote>
- * <paragraph>b</paragraph>
- * </quote>
- * <paragraph>c]d</paragraph>
- *
- * In this case the paragraph will also be returned, despite the collapsed selection:
- *
- * <paragraph>[]a</paragraph>
- *
- * **Special case**: If a selection ends at the beginning of a block, that block is not returned as from user perspective
- * this block wasn't selected. See [#984](https://github.com/ckeditor/ckeditor5-engine/issues/984) for more details.
- *
- * <paragraph>[a</paragraph>
- * <paragraph>b</paragraph>
- * <paragraph>]c</paragraph> // this block will not be returned
- *
- * @returns {Iterator.<module:engine/model/element~Element>}
- */
- * getSelectedBlocks() {
- const visited = new WeakSet();
- for ( const range of this.getRanges() ) {
- const startBlock = getParentBlock( range.start, visited );
- if ( startBlock ) {
- yield startBlock;
- }
- for ( const value of range.getWalker() ) {
- if ( value.type == 'elementEnd' && isUnvisitedBlockContainer( value.item, visited ) ) {
- yield value.item;
- }
- }
- const endBlock = getParentBlock( range.end, visited );
- // #984. Don't return the end block if the range ends right at its beginning.
- if ( endBlock && !range.end.isTouching( Position.createAt( endBlock ) ) ) {
- yield endBlock;
- }
- }
- }
- /**
- * Creates and returns an instance of `Selection` 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/selection~Selection} `Selection` instance that is a clone of given selection.
- */
- static createFromSelection( otherSelection ) {
- const selection = new this();
- selection.setTo( otherSelection );
- return selection;
- }
- /**
- * Adds given range to internal {@link #_ranges ranges array}. Throws an error
- * if given range is intersecting with any range that is already stored in this selection.
- *
- * @protected
- * @param {module:engine/model/range~Range} range Range to add.
- */
- _pushRange( range ) {
- if ( !( range instanceof Range ) ) {
- throw new CKEditorError( 'model-selection-added-not-range: Trying to add an object that is not an instance of Range.' );
- }
- this._checkRange( range );
- this._ranges.push( Range.createFromRange( range ) );
- }
- /**
- * Checks if given range intersects with ranges that are already in the selection. Throws an error if it does.
- *
- * @protected
- * @param {module:engine/model/range~Range} range Range to check.
- */
- _checkRange( range ) {
- for ( let i = 0; i < this._ranges.length; i++ ) {
- if ( range.isIntersecting( this._ranges[ i ] ) ) {
- /**
- * Trying to add a range that intersects with another range from selection.
- *
- * @error selection-range-intersects
- * @param {module:engine/model/range~Range} addedRange Range that was added to the selection.
- * @param {module:engine/model/range~Range} intersectingRange Range from selection that intersects with `addedRange`.
- */
- throw new CKEditorError(
- 'model-selection-range-intersects: Trying to add a range that intersects with another range from selection.',
- { addedRange: range, intersectingRange: this._ranges[ i ] }
- );
- }
- }
- }
- /**
- * Removes most recently added range from the selection.
- *
- * @protected
- */
- _popRange() {
- this._ranges.pop();
- }
- /**
- * Deletes ranges from internal range array. Uses {@link #_popRange _popRange} to
- * ensure proper ranges removal.
- *
- * @private
- */
- _removeAllRanges() {
- while ( this._ranges.length > 0 ) {
- this._popRange();
- }
- }
- /**
- * @event change
- */
- /**
- * Fired whenever selection ranges are changed.
- *
- * @event change:range
- * @param {Boolean} directChange Specifies whether the range change was caused by direct usage of `Selection` API (`true`)
- * or by changes done to {@link module:engine/model/document~Document model document}
- * using {@link module:engine/model/batch~Batch Batch} API (`false`).
- */
- /**
- * Fired whenever selection attributes are changed.
- *
- * @event change:attribute
- * @param {Boolean} directChange Specifies whether the attributes changed by direct usage of the Selection API (`true`)
- * or by changes done to the {@link module:engine/model/document~Document model document}
- * using the {@link module:engine/model/batch~Batch Batch} API (`false`).
- * @param {Array.<String>} attributeKeys Array containing keys of attributes that changed.
- */
- }
- mix( Selection, EmitterMixin );
- // Checks whether the given element extends $block in the schema and has a parent (is not a root).
- // Marks it as already visited.
- function isUnvisitedBlockContainer( element, visited ) {
- if ( visited.has( element ) ) {
- return false;
- }
- visited.add( element );
- // TODO https://github.com/ckeditor/ckeditor5-engine/issues/532#issuecomment-278900072.
- // This should not be a `$block` check.
- return element.document.schema.itemExtends( element.name, '$block' ) && element.parent;
- }
- // Finds the lowest element in position's ancestors which is a block.
- // Marks all ancestors as already visited to not include any of them later on.
- function getParentBlock( position, visited ) {
- const ancestors = position.parent.getAncestors( { parentFirst: true, includeSelf: true } );
- const block = ancestors.find( element => isUnvisitedBlockContainer( element, visited ) );
- // Mark all ancestors of this position's parent, because find() might've stopped early and
- // the found block may be a child of another block.
- ancestors.forEach( element => visited.add( element ) );
- return block;
- }
|