@eclipse-glsp/theia-integration/src/browser/diagram/features/source-model-watcher/theia-source-model-changed-handler.ts

Glue code to integrate GLSP clients into Eclipse Theia

/********************************************************************************
 * Copyright (c) 2020-2023 EclipseSource and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/
import { Action, ExternalSourceModelChangedHandler, ViewerOptions } from '@eclipse-glsp/client';
import { ApplicationShell, ConfirmDialog, Widget } from '@theia/core/lib/browser';
import { inject, injectable } from '@theia/core/shared/inversify';
import { getDiagramWidget } from '../../glsp-diagram-widget';

/**
 * Default {@link ExternalSourceModelChangedHandler} for Theia. Notifies the user if the underlying source model
 * has changed. Optional a model reload can be triggered.
 *
 * (bound in Diagram child DI container)
 */
@injectable()
export class TheiaSourceModelChangedHandler extends ExternalSourceModelChangedHandler {
    @inject(ApplicationShell) protected readonly shell: ApplicationShell;

    async notifySourceModelChange(sourceModelName: string, options: ViewerOptions): Promise<Action[]> {
        const element = document.getElementById(options.baseDiv);
        if (element) {
            const widget = this.shell.findWidgetForElement(element);
            if (widget) {
                return this.notifySourceModelChangedWithWidget(widget, sourceModelName);
            }
        }
        return [];
    }

    protected async notifySourceModelChangedWithWidget(widget: Widget, sourceModelName: string): Promise<Action[]> {
        const diagramWidget = getDiagramWidget(widget);
        if (!diagramWidget) {
            return [];
        }
        if (this.autoReload() && !diagramWidget.saveable.dirty) {
            await diagramWidget.reloadModel();
            return [];
        }
        await this.shell.activateWidget(widget.id);
        const reload = await this.showDialog(widget.title.label, sourceModelName);
        if (reload === true) {
            await diagramWidget.reloadModel();
        }
        return [];
    }

    protected autoReload(): boolean {
        return false;
    }

    protected showDialog(widgetTitle: string, sourceModelName: string): Promise<boolean | undefined> {
        const dialog = new ConfirmDialog({
            title: `Source of editor '${widgetTitle}' changed`,
            msg: `The source model '${sourceModelName}' changed. Do you want to omit
            local changes and reload the editor or continue editing and ignore the changes?`,
            cancel: 'Continue editing',
            ok: 'Reload editor',
            wordWrap: 'normal',
            maxWidth: 640
        });
        return dialog.open();
    }
}