| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387 |
- /**
- * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/model/markercollection
- */
- import LiveRange from './liverange';
- import Position from './position';
- 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';
- /**
- * Creates, stores and manages {@link module:engine/model/markercollection~Marker markers}.
- *
- * Markers are designed to be a ready-to-use solution for having up-to-date ranges on the document with an easy access to them.
- * They're built from a name and a {@link module:engine/model/liverange~LiveRange live range}.
- * Name is used to group and identify markers. Names have to be unique, but markers can be grouped by
- * using common prefixes, separated with `:`, for example: `user:john` or `search:3`. That's useful in term of creating namespaces
- * for custom elements (e.g. comments, highlights).
- *
- * Markers can be watched for changes - both adding and removing markers from the `MarkerCollection` fires events
- * (`~MarkerCollection#event:add` and `MarkerCollection#event:remove`).
- *
- * There're two types of markers. Both type of them should be added /updated by {@link module:engine/model/writer~Writer#setMarker}
- * and removed by {@link module:engine/model/writer~Writer#removeMarker} methods.
- *
- * There're two types of markers. Both type of them should be added /updated by {@link module:engine/model/writer~Writer#setMarker}
- * and removed by {@link module:engine/model/writer~Writer#removeMarker} methods. Both of them are stored in the {@link ~MarkerCollection}.
- *
- * 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
- * This type of markers is useful for solutions like spell checking or comments.
- * Usage:
- * writer.setMarker( markerOrName, ranges, { usingOperation: true } );
- *
- * 2. Markers not added to document. They can be used as bookmarks or visual markers. They're great for showing results of the find,
- * or select link when the focus is in the input see https://github.com/ckeditor/ckeditor5-link/issues/13.
- * Usage:
- * writer.setMarker( markerOrName, ranges );
- *
- * Note: Since markers are based on {@link module:engine/model/liverange~LiveRange live ranges}, for efficiency reasons, it's
- * best to create and keep at least markers as possible.
- */
- export default class MarkerCollection {
- /**
- * Creates a markers collection.
- */
- constructor() {
- /**
- * Stores {@link ~Marker markers} added to the collection.
- *
- * @private
- * @member {Map} #_markers
- */
- this._markers = new Map();
- }
- /**
- * Iterable interface.
- *
- * Iterates over all {@link ~Marker markers} added to the collection.
- *
- * @returns {Iterable}
- */
- [ Symbol.iterator ]() {
- return this._markers.values();
- }
- /**
- * Checks if marker with given `markerName` is in the collection.
- *
- * @param {String} markerName Marker name.
- * @returns {Boolean} `true` if marker with given `markerName` is in the collection, `false` otherwise.
- */
- has( markerName ) {
- return this._markers.has( markerName );
- }
- /**
- * Returns {@link ~Marker marker} with given `markerName`.
- *
- * @param {String} markerName Name of marker to get.
- * @returns {module:engine/model/markercollection~Marker|null} Marker with given name or `null` if such marker was
- * not added to the collection.
- */
- get( markerName ) {
- return this._markers.get( markerName ) || null;
- }
- /**
- * Creates and adds a {@link ~Marker marker} to the `MarkerCollection` with given name on given
- * {@link module:engine/model/range~Range range}.
- *
- * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed) and the range to
- * set is different, the marker in collection is removed and then new marker is added. If the range was same, nothing
- * happens and `false` is returned.
- *
- * @fires module:engine/model/markercollection~MarkerCollection#event:add
- * @fires module:engine/model/markercollection~MarkerCollection#event:remove
- * @param {String|module:engine/model/markercollection~Marker} markerOrName Name of marker to add or Marker instance to update.
- * @param {module:engine/model/range~Range} range Marker range.
- * @returns {module:engine/model/markercollection~Marker} `Marker` instance added to the collection.
- */
- set( markerOrName, range ) {
- const markerName = markerOrName instanceof Marker ? markerOrName.name : markerOrName;
- const oldMarker = this._markers.get( markerName );
- if ( oldMarker ) {
- const oldRange = oldMarker.getRange();
- if ( oldRange.isEqual( range ) ) {
- return oldMarker;
- }
- this.remove( markerName );
- }
- const liveRange = LiveRange.createFromRange( range );
- const marker = new Marker( markerName, liveRange );
- this._markers.set( markerName, marker );
- this.fire( 'add:' + markerName, marker );
- return marker;
- }
- /**
- * Removes given {@link ~Marker marker} or a marker with given name from the `MarkerCollection`.
- *
- * @param {String} markerOrName Marker or name of a marker to remove.
- * @returns {Boolean} `true` if marker was found and removed, `false` otherwise.
- */
- remove( markerOrName ) {
- const markerName = markerOrName instanceof Marker ? markerOrName.name : markerOrName;
- const oldMarker = this._markers.get( markerName );
- if ( oldMarker ) {
- this._markers.delete( markerName );
- this.fire( 'remove:' + markerName, oldMarker );
- this._destroyMarker( oldMarker );
- return true;
- }
- return false;
- }
- /**
- * Returns iterator that iterates over all markers, which ranges contain given {@link module:engine/model/position~Position position}.
- *
- * @param {module:engine/model/position~Position} position
- * @returns {Iterable.<module:engine/model/markercollection~Marker>}
- */
- * getMarkersAtPosition( position ) {
- for ( const marker of this ) {
- if ( marker.getRange().containsPosition( position ) ) {
- yield marker;
- }
- }
- }
- /**
- * Destroys marker collection and all markers inside it.
- */
- destroy() {
- for ( const marker of this._markers.values() ) {
- this._destroyMarker( marker );
- }
- this._markers = null;
- this.stopListening();
- }
- /**
- * Iterates over all markers that starts with given `prefix`.
- *
- * const markerFooA = markersCollection.set( 'foo:a', rangeFooA );
- * const markerFooB = markersCollection.set( 'foo:b', rangeFooB );
- * const markerBarA = markersCollection.set( 'bar:a', rangeBarA );
- * const markerFooBarA = markersCollection.set( 'foobar:a', rangeFooBarA );
- * Array.from( markersCollection.getMarkersGroup( 'foo' ) ); // [ markerFooA, markerFooB ]
- * Array.from( markersCollection.getMarkersGroup( 'a' ) ); // []
- *
- * @param prefix
- * @returns {Iterable.<module:engine/model/markercollection~Marker>}
- */
- * getMarkersGroup( prefix ) {
- for ( const marker of this._markers.values() ) {
- if ( marker.name.startsWith( prefix + ':' ) ) {
- yield marker;
- }
- }
- }
- /**
- * Destroys the marker.
- *
- * @private
- * @param {module:engine/model/markercollection~Marker} marker Marker to destroy.
- */
- _destroyMarker( marker ) {
- marker.stopListening();
- marker._liveRange.detach();
- marker._liveRange = null;
- }
- /**
- * Fired whenever marker is added to `MarkerCollection`.
- *
- * @event add
- * @param {module:engine/model/markercollection~Marker} The added marker.
- */
- /**
- * Fired whenever marker is removed from `MarkerCollection`.
- *
- * @event remove
- * @param {module:engine/model/markercollection~Marker} marker The removed marker.
- */
- }
- mix( MarkerCollection, EmitterMixin );
- /**
- * `Marker` is a continuous parts of model (like a range), is named and represent some kind of information about marked
- * part of model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
- * model document tree, markers are not stored directly in document tree. Still, they are document data, by giving
- * additional meaning to the part of a model document between marker start and marker end.
- *
- * In this sense, markers are similar to adding and converting attributes on nodes. The difference is that attribute is
- * connected with a given node (e.g. a character is bold no matter if it gets moved or content around it changes).
- * Markers on the other hand are continuous ranges and are characterised by their start and end position. This means that
- * any character in the marker is marked by the marker. For example, if a character is moved outside of marker it stops being
- * "special" and the marker is shrunk. Similarly, when a character is moved into the marker from other place in document
- * model, it starts being "special" and the marker is enlarged.
- *
- * Markers are designed to be a ready-to-use solution for having up-to-date ranges on the document with an easy access to them.
- * They're built from a name and a {@link module:engine/model/liverange~LiveRange live range}.
- * Name is used to group and identify markers. Names have to be unique, but markers can be grouped by
- * using common prefixes, separated with `:`, for example: `user:john` or `search:3`. That's useful in term of creating namespaces
- * for custom elements (e.g. comments, highlights).
- *
- * There're two types of markers. Both type of them should be added /updated by {@link module:engine/model/writer~Writer#setMarker}
- * and removed by {@link module:engine/model/writer~Writer#removeMarker} methods. Both of them are stored in the {@link ~MarkerCollection}.
- *
- * 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
- * This type of markers is useful for solutions like spell checking or comments.
- * Usage:
- * writer.setMarker( markerOrName, ranges, { usingOperation: true } );
- *
- * 2. Markers not added to document. They can be used as bookmarks or visual markers. They're great for showing results of the find,
- * or select link when the focus is in the input see https://github.com/ckeditor/ckeditor5-link/issues/13.
- * Usage:
- * writer.setMarker( markerOrName, ranges );
- *
- * Since markers are based on {@link module:engine/model/liverange~LiveRange live ranges}, for efficiency reasons, it's
- * best to create and keep at least markers as possible.
- *
- * Markers can be converted to view by adding appropriate converters for
- * {@link module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher#event:addMarker} and
- * {@link module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher#event:removeMarker}
- * events, or by building converters for {@link module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher}
- * using {@link module:engine/conversion/buildmodelconverter~buildModelConverter model converter builder}.
- *
- * Another upside of markers is that finding marked part of document is fast and easy. Using attributes to mark some nodes
- * and then trying to find that part of document would require traversing whole document tree. Marker gives instant access
- * to the range which it is marking at the moment.
- *
- * `Marker` instances are created and destroyed only by {@link ~MarkerCollection MarkerCollection}.
- */
- class Marker {
- /**
- * Creates a marker instance.
- *
- * @param {String} name Marker name.
- * @param {module:engine/model/liverange~LiveRange} liveRange Range marked by the marker.
- */
- constructor( name, liveRange ) {
- /**
- * Marker's name.
- *
- * @readonly
- * @member {String} #name
- */
- this.name = name;
- /**
- * Range marked by the marker.
- *
- * @protected
- * @member {module:engine/model/liverange~LiveRange} #_liveRange
- */
- this._liveRange = liveRange;
- // Delegating does not work with namespaces. Alternatively, we could delegate all events (using `*`).
- this._liveRange.delegate( 'change:range' ).to( this );
- this._liveRange.delegate( 'change:content' ).to( this );
- }
- /**
- * Returns current marker start position.
- *
- * @returns {module:engine/model/position~Position}
- */
- getStart() {
- if ( !this._liveRange ) {
- throw new CKEditorError( 'marker-destroyed: Cannot use a destroyed marker instance.' );
- }
- return Position.createFromPosition( this._liveRange.start );
- }
- /**
- * Returns current marker end position.
- *
- * @returns {module:engine/model/position~Position}
- */
- getEnd() {
- if ( !this._liveRange ) {
- throw new CKEditorError( 'marker-destroyed: Cannot use a destroyed marker instance.' );
- }
- return Position.createFromPosition( this._liveRange.end );
- }
- /**
- * Returns a range that represents current state of marker.
- *
- * Keep in mind that returned value is a {@link module:engine/model/range~Range Range}, not a
- * {@link module:engine/model/liverange~LiveRange LiveRange}. This means that it is up-to-date and relevant only
- * until next model document change. Do not store values returned by this method. Instead, store {@link ~Marker#name}
- * and get `Marker` instance from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection} every
- * time there is a need to read marker properties. This will guarantee that the marker has not been removed and
- * that it's data is up-to-date.
- *
- * @returns {module:engine/model/range~Range}
- */
- getRange() {
- if ( !this._liveRange ) {
- throw new CKEditorError( 'marker-destroyed: Cannot use a destroyed marker instance.' );
- }
- return Range.createFromRange( this._liveRange );
- }
- /**
- * Fired whenever {@link ~Marker#_liveRange marker range} is changed due to changes on {@link module:engine/model/document~Document}.
- * This is a delegated {@link module:engine/model/liverange~LiveRange#event:change:range LiveRange change:range event}.
- *
- * When marker is removed from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection},
- * all event listeners listening to it should be removed. It is best to do it on
- * {@link module:engine/model/markercollection~MarkerCollection#event:remove MarkerCollection remove event}.
- *
- * @see module:engine/model/liverange~LiveRange#event:change:range
- * @event change:range
- * @param {module:engine/model/range~Range} oldRange
- * @param {Object} data
- */
- /**
- * Fired whenever change on {@link module:engine/model/document~Document} is done inside {@link ~Marker#_liveRange marker range}.
- * This is a delegated {@link module:engine/model/liverange~LiveRange#event:change:content LiveRange change:content event}.
- *
- * When marker is removed from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection},
- * all event listeners listening to it should be removed. It is best to do it on
- * {@link module:engine/model/markercollection~MarkerCollection#event:remove MarkerCollection remove event}.
- *
- * @see module:engine/model/liverange~LiveRange#event:change:content
- * @event change:content
- * @param {module:engine/model/range~Range} oldRange
- * @param {Object} data
- */
- }
- mix( Marker, EmitterMixin );
- /**
- * Cannot use a {@link module:engine/model/markercollection~MarkerCollection#destroy destroyed marker} instance.
- *
- * @error marker-destroyed
- */
|