@ckeditor/ckeditor5-engine 44.1.0 → 44.2.0-alpha.1

package/dist/conversion/mapper.d.ts

@@ -1,507 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module engine/conversion/mapper
- */
-import ModelPosition from '../model/position.js';
-import ModelRange from '../model/range.js';
-import ViewPosition from '../view/position.js';
-import ViewRange from '../view/range.js';
-import type ViewDocumentFragment from '../view/documentfragment.js';
-import type ViewElement from '../view/element.js';
-import type ModelElement from '../model/element.js';
-import type ModelDocumentFragment from '../model/documentfragment.js';
-import type ViewNode from '../view/node.js';
-declare const Mapper_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Emitter;
-    prototype: import("@ckeditor/ckeditor5-utils").Emitter;
-};
-/**
- * Maps elements, positions and markers between the {@link module:engine/view/document~Document view} and
- * the {@link module:engine/model/model model}.
- *
- * The instance of the Mapper used for the editing pipeline is available in
- * {@link module:engine/controller/editingcontroller~EditingController#mapper `editor.editing.mapper`}.
- *
- * Mapper uses bound elements to find corresponding elements and positions, so, to get proper results,
- * all model elements should be {@link module:engine/conversion/mapper~Mapper#bindElements bound}.
- *
- * To map the complex model to/from view relations, you may provide custom callbacks for the
- * {@link module:engine/conversion/mapper~Mapper#event:modelToViewPosition modelToViewPosition event} and
- * {@link module:engine/conversion/mapper~Mapper#event:viewToModelPosition viewToModelPosition event} that are fired whenever
- * a position mapping request occurs.
- * Those events are fired by the {@link module:engine/conversion/mapper~Mapper#toViewPosition toViewPosition}
- * and {@link module:engine/conversion/mapper~Mapper#toModelPosition toModelPosition} methods. `Mapper` adds its own default callbacks
- * with `'lowest'` priority. To override default `Mapper` mapping, add custom callback with higher priority and
- * stop the event.
- */
-export default class Mapper extends /* #__PURE__ */ Mapper_base {
-    /**
-     * Model element to view element mapping.
-     */
-    private _modelToViewMapping;
-    /**
-     * View element to model element mapping.
-     */
-    private _viewToModelMapping;
-    /**
-     * A map containing callbacks between view element names and functions evaluating length of view elements
-     * in model.
-     */
-    private _viewToModelLengthCallbacks;
-    /**
-     * Model marker name to view elements mapping.
-     *
-     * Keys are `String`s while values are `Set`s with {@link module:engine/view/element~Element view elements}.
-     * One marker (name) can be mapped to multiple elements.
-     */
-    private _markerNameToElements;
-    /**
-     * View element to model marker names mapping.
-     *
-     * This is reverse to {@link ~Mapper#_markerNameToElements} map.
-     */
-    private _elementToMarkerNames;
-    /**
-     * The map of removed view elements with their current root (used for deferred unbinding).
-     */
-    private _deferredBindingRemovals;
-    /**
-     * Stores marker names of markers which have changed due to unbinding a view element (so it is assumed that the view element
-     * has been removed, moved or renamed).
-     */
-    private _unboundMarkerNames;
-    /**
-     * Creates an instance of the mapper.
-     */
-    constructor();
-    /**
-     * Marks model and view elements as corresponding. Corresponding elements can be retrieved by using
-     * the {@link module:engine/conversion/mapper~Mapper#toModelElement toModelElement} and
-     * {@link module:engine/conversion/mapper~Mapper#toViewElement toViewElement} methods.
-     * The information that elements are bound is also used to translate positions.
-     *
-     * @param modelElement Model element.
-     * @param viewElement View element.
-     */
-    bindElements(modelElement: ModelElement | ModelDocumentFragment, viewElement: ViewElement | ViewDocumentFragment): void;
-    /**
-     * Unbinds the given {@link module:engine/view/element~Element view element} from the map.
-     *
-     * **Note:** view-to-model binding will be removed, if it existed. However, corresponding model-to-view binding
-     * will be removed only if model element is still bound to the passed `viewElement`.
-     *
-     * This behavior allows for re-binding model element to another view element without fear of losing the new binding
-     * when the previously bound view element is unbound.
-     *
-     * @param viewElement View element to unbind.
-     * @param options The options object.
-     * @param options.defer Controls whether the binding should be removed immediately or deferred until a
-     * {@link #flushDeferredBindings `flushDeferredBindings()`} call.
-     */
-    unbindViewElement(viewElement: ViewElement, options?: {
-        defer?: boolean;
-    }): void;
-    /**
-     * Unbinds the given {@link module:engine/model/element~Element model element} from the map.
-     *
-     * **Note:** the model-to-view binding will be removed, if it existed. However, the corresponding view-to-model binding
-     * will be removed only if the view element is still bound to the passed `modelElement`.
-     *
-     * This behavior lets for re-binding view element to another model element without fear of losing the new binding
-     * when the previously bound model element is unbound.
-     *
-     * @param modelElement Model element to unbind.
-     */
-    unbindModelElement(modelElement: ModelElement): void;
-    /**
-     * Binds the given marker name with the given {@link module:engine/view/element~Element view element}. The element
-     * will be added to the current set of elements bound with the given marker name.
-     *
-     * @param element Element to bind.
-     * @param name Marker name.
-     */
-    bindElementToMarker(element: ViewElement, name: string): void;
-    /**
-     * Unbinds an element from given marker name.
-     *
-     * @param element Element to unbind.
-     * @param name Marker name.
-     */
-    unbindElementFromMarkerName(element: ViewElement, name: string): void;
-    /**
-     * Returns all marker names of markers which have changed due to unbinding a view element (so it is assumed that the view element
-     * has been removed, moved or renamed) since the last flush. After returning, the marker names list is cleared.
-     */
-    flushUnboundMarkerNames(): Array<string>;
-    /**
-     * Unbinds all deferred binding removals of view elements that in the meantime were not re-attached to some root or document fragment.
-     *
-     * See: {@link #unbindViewElement `unbindViewElement()`}.
-     */
-    flushDeferredBindings(): void;
-    /**
-     * Removes all model to view and view to model bindings.
-     */
-    clearBindings(): void;
-    /**
-     * Gets the corresponding model element.
-     *
-     * **Note:** {@link module:engine/view/uielement~UIElement} does not have corresponding element in model.
-     *
-     * @label ELEMENT
-     * @param viewElement View element.
-     * @returns Corresponding model element or `undefined` if not found.
-     */
-    toModelElement(viewElement: ViewElement): ModelElement | undefined;
-    /**
-     * Gets the corresponding model document fragment.
-     *
-     * @label DOCUMENT_FRAGMENT
-     * @param viewDocumentFragment View document fragment.
-     * @returns Corresponding model document fragment or `undefined` if not found.
-     */
-    toModelElement(viewDocumentFragment: ViewDocumentFragment): ModelDocumentFragment | undefined;
-    /**
-     * Gets the corresponding view element.
-     *
-     * @label ELEMENT
-     * @param modelElement Model element.
-     * @returns Corresponding view element or `undefined` if not found.
-     */
-    toViewElement(modelElement: ModelElement): ViewElement | undefined;
-    /**
-     * Gets the corresponding view document fragment.
-     *
-     * @label DOCUMENT_FRAGMENT
-     * @param modelDocumentFragment Model document fragment.
-     * @returns Corresponding view document fragment or `undefined` if not found.
-     */
-    toViewElement(modelDocumentFragment: ModelDocumentFragment): ViewDocumentFragment | undefined;
-    /**
-     * Gets the corresponding model range.
-     *
-     * @param viewRange View range.
-     * @returns Corresponding model range.
-     */
-    toModelRange(viewRange: ViewRange): ModelRange;
-    /**
-     * Gets the corresponding view range.
-     *
-     * @param modelRange Model range.
-     * @returns Corresponding view range.
-     */
-    toViewRange(modelRange: ModelRange): ViewRange;
-    /**
-     * Gets the corresponding model position.
-     *
-     * @fires viewToModelPosition
-     * @param viewPosition View position.
-     * @returns Corresponding model position.
-     */
-    toModelPosition(viewPosition: ViewPosition): ModelPosition;
-    /**
-     * Gets the corresponding view position.
-     *
-     * @fires modelToViewPosition
-     * @param modelPosition Model position.
-     * @param options Additional options for position mapping process.
-     * @param options.isPhantom Should be set to `true` if the model position to map is pointing to a place
-     * in model tree which no longer exists. For example, it could be an end of a removed model range.
-     * @returns Corresponding view position.
-     */
-    toViewPosition(modelPosition: ModelPosition, options?: {
-        isPhantom?: boolean;
-    }): ViewPosition;
-    /**
-     * Gets all view elements bound to the given marker name.
-     *
-     * @param name Marker name.
-     * @returns View elements bound with the given marker name or `null`
-     * if no elements are bound to the given marker name.
-     */
-    markerNameToElements(name: string): Set<ViewElement> | null;
-    /**
-     * Registers a callback that evaluates the length in the model of a view element with the given name.
-     *
-     * The callback is fired with one argument, which is a view element instance. The callback is expected to return
-     * a number representing the length of the view element in the model.
-     *
-     * ```ts
-     * // List item in view may contain nested list, which have other list items. In model though,
-     * // the lists are represented by flat structure. Because of those differences, length of list view element
-     * // may be greater than one. In the callback it's checked how many nested list items are in evaluated list item.
-     *
-     * function getViewListItemLength( element ) {
-     * 	let length = 1;
-     *
-     * 	for ( let child of element.getChildren() ) {
-     * 		if ( child.name == 'ul' || child.name == 'ol' ) {
-     * 			for ( let item of child.getChildren() ) {
-     * 				length += getViewListItemLength( item );
-     * 			}
-     * 		}
-     * 	}
-     *
-     * 	return length;
-     * }
-     *
-     * mapper.registerViewToModelLength( 'li', getViewListItemLength );
-     * ```
-     *
-     * @param viewElementName Name of view element for which callback is registered.
-     * @param lengthCallback Function return a length of view element instance in model.
-     */
-    registerViewToModelLength(viewElementName: string, lengthCallback: (element: ViewElement) => number): void;
-    /**
-     * For the given `viewPosition`, finds and returns the closest ancestor of this position that has a mapping to
-     * the model.
-     *
-     * @param viewPosition Position for which a mapped ancestor should be found.
-     */
-    findMappedViewAncestor(viewPosition: ViewPosition): ViewElement;
-    /**
-     * Calculates model offset based on the view position and the block element.
-     *
-     * Example:
-     *
-     * ```html
-     * <p>foo<b>ba|r</b></p> // _toModelOffset( b, 2, p ) -> 5
-     * ```
-     *
-     * Is a sum of:
-     *
-     * ```html
-     * <p>foo|<b>bar</b></p> // _toModelOffset( p, 3, p ) -> 3
-     * <p>foo<b>ba|r</b></p> // _toModelOffset( b, 2, b ) -> 2
-     * ```
-     *
-     * @param viewParent Position parent.
-     * @param viewOffset Position offset.
-     * @param viewBlock Block used as a base to calculate offset.
-     * @returns Offset in the model.
-     */
-    private _toModelOffset;
-    /**
-     * Gets the length of the view element in the model.
-     *
-     * The length is calculated as follows:
-     * * if a {@link #registerViewToModelLength length mapping callback} is provided for the given `viewNode`, it is used to
-     * evaluate the model length (`viewNode` is used as first and only parameter passed to the callback),
-     * * length of a {@link module:engine/view/text~Text text node} is equal to the length of its
-     * {@link module:engine/view/text~Text#data data},
-     * * length of a {@link module:engine/view/uielement~UIElement ui element} is equal to 0,
-     * * length of a mapped {@link module:engine/view/element~Element element} is equal to 1,
-     * * length of a non-mapped {@link module:engine/view/element~Element element} is equal to the length of its children.
-     *
-     * Examples:
-     *
-     * ```
-     * foo                          -> 3 // Text length is equal to its data length.
-     * <p>foo</p>                   -> 1 // Length of an element which is mapped is by default equal to 1.
-     * <b>foo</b>                   -> 3 // Length of an element which is not mapped is a length of its children.
-     * <div><p>x</p><p>y</p></div>  -> 2 // Assuming that <div> is not mapped and <p> are mapped.
-     * ```
-     *
-     * @param viewNode View node.
-     * @returns Length of the node in the tree model.
-     */
-    getModelLength(viewNode: ViewNode | ViewDocumentFragment): number;
-    /**
-     * Finds the position in the view node (or in its children) with the expected model offset.
-     *
-     * Example:
-     *
-     * ```
-     * <p>fo<b>bar</b>bom</p> -> expected offset: 4
-     *
-     * findPositionIn( p, 4 ):
-     * <p>|fo<b>bar</b>bom</p> -> expected offset: 4, actual offset: 0
-     * <p>fo|<b>bar</b>bom</p> -> expected offset: 4, actual offset: 2
-     * <p>fo<b>bar</b>|bom</p> -> expected offset: 4, actual offset: 5 -> we are too far
-     *
-     * findPositionIn( b, 4 - ( 5 - 3 ) ):
-     * <p>fo<b>|bar</b>bom</p> -> expected offset: 2, actual offset: 0
-     * <p>fo<b>bar|</b>bom</p> -> expected offset: 2, actual offset: 3 -> we are too far
-     *
-     * findPositionIn( bar, 2 - ( 3 - 3 ) ):
-     * We are in the text node so we can simple find the offset.
-     * <p>fo<b>ba|r</b>bom</p> -> expected offset: 2, actual offset: 2 -> position found
-     * ```
-     *
-     * @param viewParent Tree view element in which we are looking for the position.
-     * @param expectedOffset Expected offset.
-     * @returns Found position.
-     */
-    findPositionIn(viewParent: ViewNode | ViewDocumentFragment, expectedOffset: number): ViewPosition;
-    /**
-     * Because we prefer positions in the text nodes over positions next to text nodes, if the view position was next to a text node,
-     * it moves it into the text node instead.
-     *
-     * ```
-     * <p>[]<b>foo</b></p> -> <p>[]<b>foo</b></p> // do not touch if position is not directly next to text
-     * <p>foo[]<b>foo</b></p> -> <p>foo{}<b>foo</b></p> // move to text node
-     * <p><b>[]foo</b></p> -> <p><b>{}foo</b></p> // move to text node
-     * ```
-     *
-     * @param viewPosition Position potentially next to the text node.
-     * @returns Position in the text node if possible.
-     */
-    private _moveViewPositionToTextNode;
-}
-/**
- * Fired for each model-to-view position mapping request. The purpose of this event is to enable custom model-to-view position
- * mapping. Callbacks added to this event take {@link module:engine/model/position~Position model position} and are expected to
- * calculate the {@link module:engine/view/position~Position view position}. The calculated view position should be added as
- * a `viewPosition` value in the `data` object that is passed as one of parameters to the event callback.
- *
- * ```ts
- * // Assume that "captionedImage" model element is converted to <img> and following <span> elements in view,
- * // and the model element is bound to <img> element. Force mapping model positions inside "captionedImage" to that
- * // <span> element.
- * mapper.on( 'modelToViewPosition', ( evt, data ) => {
- * 	const positionParent = modelPosition.parent;
- *
- * 	if ( positionParent.name == 'captionedImage' ) {
- * 		const viewImg = data.mapper.toViewElement( positionParent );
- * 		const viewCaption = viewImg.nextSibling; // The <span> element.
- *
- * 		data.viewPosition = new ViewPosition( viewCaption, modelPosition.offset );
- *
- * 		// Stop the event if other callbacks should not modify calculated value.
- * 		evt.stop();
- * 	}
- * } );
- * ```
- *
- * **Note:** keep in mind that sometimes a "phantom" model position is being converted. A "phantom" model position is
- * a position that points to a nonexistent place in model. Such a position might still be valid for conversion, though
- * (it would point to a correct place in the view when converted). One example of such a situation is when a range is
- * removed from the model, there may be a need to map the range's end (which is no longer a valid model position). To
- * handle such situations, check the `data.isPhantom` flag:
- *
- * ```ts
- * // Assume that there is a "customElement" model element and whenever the position is before it,
- * // we want to move it to the inside of the view element bound to "customElement".
- * mapper.on( 'modelToViewPosition', ( evt, data ) => {
- * 	if ( data.isPhantom ) {
- * 		return;
- * 	}
- *
- * 	// Below line might crash for phantom position that does not exist in model.
- * 	const sibling = data.modelPosition.nodeBefore;
- *
- * 	// Check if this is the element we are interested in.
- * 	if ( !sibling.is( 'element', 'customElement' ) ) {
- * 		return;
- * 	}
- *
- * 	const viewElement = data.mapper.toViewElement( sibling );
- *
- * 	data.viewPosition = new ViewPosition( sibling, 0 );
- *
- * 	evt.stop();
- * } );
- * ```
- *
- * **Note:** the default mapping callback is provided with a `low` priority setting and does not cancel the event, so it is possible to
- * attach a custom callback after a default callback and also use `data.viewPosition` calculated by the default callback
- * (for example to fix it).
- *
- * **Note:** the default mapping callback will not fire if `data.viewPosition` is already set.
- *
- * **Note:** these callbacks are called **very often**. For efficiency reasons, it is advised to use them only when position
- * mapping between the given model and view elements is unsolvable by using just elements mapping and default algorithm.
- * Also, the condition that checks if a special case scenario happened should be as simple as possible.
- *
- * @eventName ~Mapper#modelToViewPosition
- */
-export type MapperModelToViewPositionEvent = {
-    name: 'modelToViewPosition';
-    args: [MapperModelToViewPositionEventData];
-};
-/**
- * Data pipeline object that can store and pass data between callbacks. The callback should add
- * the `viewPosition` value to that object with calculated the {@link module:engine/view/position~Position view position}.
- */
-export type MapperModelToViewPositionEventData = {
-    /**
-     * Mapper instance that fired the event.
-     */
-    mapper: Mapper;
-    /**
-     * The model position.
-     */
-    modelPosition: ModelPosition;
-    /**
-     * The callback should add the `viewPosition` value to that object with calculated the
-     * {@link module:engine/view/position~Position view position}.
-     */
-    viewPosition?: ViewPosition;
-    /**
-     * Should be set to `true` if the model position to map is pointing to a place
-     * in model tree which no longer exists. For example, it could be an end of a removed model range.
-     */
-    isPhantom?: boolean;
-};
-/**
- * Fired for each view-to-model position mapping request. See {@link module:engine/conversion/mapper~Mapper#event:modelToViewPosition}.
- *
- * ```ts
- * // See example in `modelToViewPosition` event description.
- * // This custom mapping will map positions from <span> element next to <img> to the "captionedImage" element.
- * mapper.on( 'viewToModelPosition', ( evt, data ) => {
- * 	const positionParent = viewPosition.parent;
- *
- * 	if ( positionParent.hasClass( 'image-caption' ) ) {
- * 		const viewImg = positionParent.previousSibling;
- * 		const modelImg = data.mapper.toModelElement( viewImg );
- *
- * 		data.modelPosition = new ModelPosition( modelImg, viewPosition.offset );
- * 		evt.stop();
- * 	}
- * } );
- * ```
- *
- * **Note:** the default mapping callback is provided with a `low` priority setting and does not cancel the event, so it is possible to
- * attach a custom callback after the default callback and also use `data.modelPosition` calculated by the default callback
- * (for example to fix it).
- *
- * **Note:** the default mapping callback will not fire if `data.modelPosition` is already set.
- *
- * **Note:** these callbacks are called **very often**. For efficiency reasons, it is advised to use them only when position
- * mapping between the given model and view elements is unsolvable by using just elements mapping and default algorithm.
- * Also, the condition that checks if special case scenario happened should be as simple as possible.
- *
- * @eventName ~Mapper#viewToModelPosition
- */
-export type MapperViewToModelPositionEvent = {
-    name: 'viewToModelPosition';
-    args: [MapperViewToModelPositionEventData];
-};
-/**
- * Data pipeline object that can store and pass data between callbacks. The callback should add
- * `modelPosition` value to that object with calculated {@link module:engine/model/position~Position model position}.
- */
-export type MapperViewToModelPositionEventData = {
-    /**
-     * Mapper instance that fired the event.
-     */
-    mapper: Mapper;
-    /**
-     * The callback should add `modelPosition` value to that object with calculated
-     * {@link module:engine/model/position~Position model position}.
-     */
-    modelPosition?: ModelPosition;
-    /**
-     * The view position.
-     */
-    viewPosition: ViewPosition;
-};
-export {};