@eclipse-glsp/theia-integration/src/browser/diagram/glsp-diagram-commands.ts

Glue code to integrate GLSP clients into Eclipse Theia

/********************************************************************************
 * Copyright (c) 2017-2026 TypeFox and others.
 * Modifications: (c) 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
 ********************************************************************************/
// based on: https://github.com/eclipse-sprotty/sprotty-theia/blob/v0.12.0/src/theia/diagram-commands.ts
import { CenterAction, FitToScreenAction, RedoAction, SelectAllAction, TriggerLayoutAction, UndoAction } from '@eclipse-glsp/client';
import { ApplicationShell, CommonCommands, QuickInputService } from '@theia/core/lib/browser';
import {
    CommandContribution,
    CommandRegistry,
    MAIN_MENU_BAR,
    MenuContribution,
    MenuModelRegistry,
    MenuPath,
    MessageService
} from '@theia/core/lib/common';
import { FileDialogService } from '@theia/filesystem/lib/browser/file-dialog/file-dialog-service';
import { FileService } from '@theia/filesystem/lib/browser/file-service';
import { inject, injectable } from 'inversify';
import { TheiaExportCommandHandler } from './features/export/theia-export-command-handler';
import { GLSPCommandHandler } from './glsp-command-handler';

export namespace GLSPDiagramCommands {
    export const CENTER = 'glsp.diagram:center';
    export const FIT = 'glsp.diagram:fit';
    export const EXPORT = 'glsp.diagram:export';
    export const SELECT_ALL = 'glsp.diagram.selectAll';
    export const DELETE = 'glsp.diagram.delete';
    export const LAYOUT = 'glsp.diagram.layout';
}

export namespace GLSPDiagramMenus {
    export const DIAGRAM: MenuPath = MAIN_MENU_BAR.concat('3_glsp_diagram');
}

@injectable()
export class GLSPDiagramMenuContribution implements MenuContribution {
    registerMenus(registry: MenuModelRegistry): void {
        registry.registerSubmenu(GLSPDiagramMenus.DIAGRAM, 'Diagram');

        registry.registerMenuAction(GLSPDiagramMenus.DIAGRAM, {
            commandId: GLSPDiagramCommands.CENTER
        });
        registry.registerMenuAction(GLSPDiagramMenus.DIAGRAM, {
            commandId: GLSPDiagramCommands.FIT
        });
        registry.registerMenuAction(GLSPDiagramMenus.DIAGRAM, {
            commandId: GLSPDiagramCommands.EXPORT
        });
        registry.registerMenuAction(GLSPDiagramMenus.DIAGRAM, {
            commandId: GLSPDiagramCommands.LAYOUT
        });
        registry.registerMenuAction(GLSPDiagramMenus.DIAGRAM, {
            commandId: GLSPDiagramCommands.SELECT_ALL
        });
    }
}

@injectable()
export class GLSPDiagramCommandContribution implements CommandContribution {
    @inject(ApplicationShell)
    protected readonly shell: ApplicationShell;

    @inject(FileService)
    protected readonly fileService: FileService;

    @inject(FileDialogService)
    protected readonly fileDialogService: FileDialogService;

    @inject(QuickInputService)
    protected readonly quickInputService: QuickInputService;

    @inject(MessageService)
    protected readonly messageService: MessageService;

    registerCommands(registry: CommandRegistry): void {
        registry.registerCommand({
            id: GLSPDiagramCommands.CENTER,
            label: 'Center'
        });
        registry.registerCommand({
            id: GLSPDiagramCommands.FIT,
            label: 'Fit to screen'
        });
        registry.registerCommand({
            id: GLSPDiagramCommands.EXPORT,
            label: 'Export'
        });
        registry.registerCommand({
            id: GLSPDiagramCommands.LAYOUT,
            label: 'Layout'
        });
        registry.registerCommand({
            id: GLSPDiagramCommands.SELECT_ALL,
            label: 'Select all'
        });

        registry.registerHandler(
            GLSPDiagramCommands.CENTER,
            new GLSPCommandHandler(this.shell, { actions: () => CenterAction.create([]), alwaysVisible: true })
        );
        registry.registerHandler(
            GLSPDiagramCommands.FIT,
            new GLSPCommandHandler(this.shell, { actions: () => FitToScreenAction.create([]), alwaysVisible: true })
        );
        registry.registerHandler(
            GLSPDiagramCommands.EXPORT,
            new TheiaExportCommandHandler(this.shell, this.fileService, this.fileDialogService, this.quickInputService, this.messageService)
        );
        registry.registerHandler(
            GLSPDiagramCommands.LAYOUT,
            new GLSPCommandHandler(this.shell, { actions: () => TriggerLayoutAction.create(), alwaysVisible: true })
        );
        registry.registerHandler(
            GLSPDiagramCommands.SELECT_ALL,
            new GLSPCommandHandler(this.shell, { actions: () => SelectAllAction.create(true), alwaysVisible: true })
        );
        registry.registerHandler(
            CommonCommands.UNDO.id,
            new GLSPCommandHandler(this.shell, { actions: () => UndoAction.create(), alwaysVisible: true })
        );
        registry.registerHandler(
            CommonCommands.REDO.id,
            new GLSPCommandHandler(this.shell, { actions: () => RedoAction.create(), alwaysVisible: true })
        );
    }
}