Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

7.9 KB
Raw Blame
/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { DocumentDataModel, JSONXActions, Nullable } from '@univerjs/core';
import type { IRenderContext, IRenderModule } from '@univerjs/engine-render';
import type { Subscription } from 'rxjs';
import type { IEditorInputConfig } from '../../services/selection/doc-selection-render.service';
import {
    Disposable,
    ICommandService,
    Inject,
    Tools,
} from '@univerjs/core';
import { DocSelectionManagerService, DocSkeletonManagerService, DocStateEmitService, RichTextEditingMutation } from '@univerjs/docs';
import { IMEInputCommand } from '../../commands/commands/ime-input.command';
import { DocIMEInputManagerService } from '../../services/doc-ime-input-manager.service';
import { DocSelectionRenderService } from '../../services/selection/doc-selection-render.service';

export class DocIMEInputController extends Disposable implements IRenderModule {
    private _previousIMEContent: string = '';

    private _isCompositionStart: boolean = true;

    private _onStartSubscription: Nullable<Subscription>;

    private _onUpdateSubscription: Nullable<Subscription>;

    private _onEndSubscription: Nullable<Subscription>;

    constructor(
        private readonly _context: IRenderContext<DocumentDataModel>,
        @Inject(DocSelectionRenderService) private readonly _docSelectionRenderService: DocSelectionRenderService,
        @Inject(DocIMEInputManagerService) private readonly _docImeInputManagerService: DocIMEInputManagerService,
        @Inject(DocSkeletonManagerService) private readonly _docSkeletonManagerService: DocSkeletonManagerService,
        @Inject(DocStateEmitService) private readonly _docStateEmitService: DocStateEmitService,
        @Inject(DocSelectionManagerService) private readonly _docSelectionManagerService: DocSelectionManagerService,
        @ICommandService private readonly _commandService: ICommandService
    ) {
        super();

        this._initialize();
    }

    override dispose(): void {
        this._onStartSubscription?.unsubscribe();
        this._onUpdateSubscription?.unsubscribe();
        this._onEndSubscription?.unsubscribe();
    }

    private _initialize() {
        this._initialOnCompositionstart();

        this._initialOnCompositionUpdate();

        this._initialOnCompositionend();
    }

    private _initialOnCompositionstart() {
        this._onStartSubscription = this._docSelectionRenderService.onCompositionstart$.subscribe((config) => {
            if (config == null) {
                return;
            }

            this._resetIME();

            const { activeRange, rangeList = [] } = config;

            if (activeRange == null) {
                return;
            }

            this._docImeInputManagerService.setActiveRange(Tools.deepClone(activeRange));
            this._docImeInputManagerService.setPreviousDocRanges(Tools.deepClone([
                ...rangeList,
                ...this._docSelectionRenderService.getAllRectRanges(),
            ]));
            this._docImeInputManagerService.setPreviousSelectionOptions(
                Tools.deepClone(this._docSelectionManagerService.getSelectionInfo()?.options ?? null)
            );
        });
    }

    private _initialOnCompositionUpdate() {
        this._onUpdateSubscription = this._docSelectionRenderService.onCompositionupdate$.subscribe((config) => {
            this._updateContent(config, true);
        });
    }

    private _initialOnCompositionend() {
        this._onEndSubscription = this._docSelectionRenderService.onCompositionend$.subscribe((config) => {
            this._updateContent(config, false);
        });
    }

    private async _updateContent(config: Nullable<IEditorInputConfig>, isUpdate: boolean) {
        if (config == null) {
            return;
        }

        const unitId = this._context.unitId;

        const skeleton = this._docSkeletonManagerService.getSkeleton();

        const { event, activeRange } = config;

        if (skeleton == null || activeRange == null) {
            return;
        }

        const e = event as CompositionEvent;

        const content = e.data;

        if (isUpdate && content === '') {
            return;
        }

        if (!isUpdate && content === '') {
            if (this._previousIMEContent !== '') {
                await this._commandService.executeCommand(IMEInputCommand.id, {
                    unitId,
                    newText: '',
                    oldTextLen: this._previousIMEContent.length,
                    isCompositionStart: false,
                    isCompositionEnd: true,
                    isCompositionCanceled: true,
                });
            }
            this._resetIME();
            return;
        }

        if (content === this._previousIMEContent && isUpdate) {
            return;
        }

        /**
         * IME composition is canceled when the composition content is the same as the previous one on composition end.
         * In this case, we need to finalize the composition and reset the IME state.
         */
        if (!isUpdate && content === this._previousIMEContent) {
            this._finalizeComposition();
            this._resetIME();
            return;
        }

        await this._commandService.executeCommand(IMEInputCommand.id, {
            unitId,
            newText: content,
            oldTextLen: this._previousIMEContent.length,
            isCompositionStart: this._isCompositionStart,
            isCompositionEnd: !isUpdate,
        });

        if (isUpdate) {
            if (this._isCompositionStart) {
                this._isCompositionStart = false;
            }

            this._previousIMEContent = content;
        } else {
            this._resetIME();
        }
    }

    // When the composition is canceled, we need to emit the state change info to update the selection and other states.
    private _finalizeComposition() {
        const previousActiveRange = this._docImeInputManagerService.getActiveRange();

        if (previousActiveRange == null) {
            return;
        }

        this._docStateEmitService.emitStateChangeInfo({
            commandId: RichTextEditingMutation.id,
            unitId: this._context.unitId,
            segmentId: previousActiveRange.segmentId,
            trigger: IMEInputCommand.id,
            redoState: {
                actions: [] as JSONXActions,
                textRanges: this._docImeInputManagerService.getPreviousDocRanges().length
                    ? this._docImeInputManagerService.getPreviousDocRanges()
                    : [previousActiveRange],
            },
            undoState: {
                actions: [] as JSONXActions,
                textRanges: this._docImeInputManagerService.getPreviousDocRanges().length
                    ? this._docImeInputManagerService.getPreviousDocRanges()
                    : [previousActiveRange],
                options: this._docImeInputManagerService.getPreviousSelectionOptions() ?? undefined,
            },
            isCompositionEnd: true,
        });
    }

    private _resetIME() {
        this._previousIMEContent = '';

        this._isCompositionStart = true;

        this._docImeInputManagerService.clearUndoRedoMutationParamsCache();

        this._docImeInputManagerService.setActiveRange(null);
        this._docImeInputManagerService.setPreviousDocRanges([]);
        this._docImeInputManagerService.setPreviousSelectionOptions(null);
    }
}