ckeditor/ckeditor5-engine

/**
 * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
 */

/**
 * @module engine/model/operation/detachoperation
 */

import Operation from './operation';
import Range from '../range';
import { _remove } from './utils';
import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';

// @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;

/**
 * Operation to permanently remove node from detached root.
 * Note this operation is only a local operation and won't be send to the other clients.
 *
 * @extends module:engine/model/operation/operation~Operation
 */
export default class DetachOperation extends Operation {
    /**
     * Creates an insert operation.
     *
     * @param {module:engine/model/position~Position} sourcePosition
     * Position before the first {@link module:engine/model/item~Item model item} to move.
     * @param {Number} howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
     * `sourcePosition` with offset shifted by `howMany`.
     */
    constructor( sourcePosition, howMany ) {
        super( null );

        /**
         * Position before the first {@link module:engine/model/item~Item model item} to detach.
         *
         * @member {module:engine/model/position~Position} #sourcePosition
         */
        this.sourcePosition = sourcePosition.clone();

        /**
         * Offset size of moved range.
         *
         * @member {Number} #howMany
         */
        this.howMany = howMany;
    }

    /**
     * @inheritDoc
     */
    get type() {
        return 'detach';
    }

    /**
     * @inheritDoc
     */
    toJSON() {
        const json = super.toJSON();

        json.sourcePosition = this.sourcePosition.toJSON();

        return json;
    }

    /**
     * @inheritDoc
     */
    _validate() {
        if ( this.sourcePosition.root.document ) {
            /**
             * Cannot detach document node.
             *
             * @error detach-operation-on-document-node
             */
            throw new CKEditorError( 'detach-operation-on-document-node: Cannot detach document node.', this );
        }
    }

    /**
     * @inheritDoc
     */
    _execute() {
        _remove( Range._createFromPositionAndShift( this.sourcePosition, this.howMany ) );
    }

    /**
     * @inheritDoc
     */
    static get className() {
        return 'DetachOperation';
    }

    // @if CK_DEBUG_ENGINE // toString() {
    // @if CK_DEBUG_ENGINE // const range = ModelRange._createFromPositionAndShift( this.sourcePosition, this.howMany );
    // @if CK_DEBUG_ENGINE //    const nodes = Array.from( range.getItems() );
    // @if CK_DEBUG_ENGINE //    const nodeString = nodes.length > 1 ? `[ ${ nodes.length } ]` : nodes[ 0 ];

    // @if CK_DEBUG_ENGINE //    return `DetachOperation( ${ this.baseVersion } ): ${ nodeString } -> ${ range }`;
    // @if CK_DEBUG_ENGINE // }
}