@eclipse-glsp/client 1.1.0-next.c40feb3.207 → 1.1.0-next.c5afbfa.273

package/src/features/accessibility/view-key-tools/deselect-key-tool.ts

@@ -0,0 +1,88 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { inject, injectable } from 'inversify';
+import { toArray } from 'sprotty/lib/utils/iterable';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import {
+    Action,
+    KeyListener,
+    KeyTool,
+    SModelElement,
+    SRoutableElement,
+    SelectAction,
+    SwitchEditModeAction,
+    isSelectable
+} from '~glsp-sprotty';
+import { Tool } from '../../../base/tool-manager/tool';
+import { SResizeHandle } from '../../change-bounds/model';
+
+/**
+ * Deselects the element if there is no interaction possible with element.
+ */
+@injectable()
+export class DeselectKeyTool implements Tool {
+    static ID = 'glsp.deselect-key-tool';
+
+    isEditTool = true;
+
+    protected readonly deselectKeyListener = new DeselectKeyListener();
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+
+    get id(): string {
+        return DeselectKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.deselectKeyListener);
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.deselectKeyListener);
+    }
+}
+
+export class DeselectKeyListener extends KeyListener {
+    override keyDown(target: SModelElement, event: KeyboardEvent): Action[] {
+        if (this.matchesDeselectKeystroke(event)) {
+            const isResizeHandleActive = toArray(target.root.index.all().filter(el => el instanceof SResizeHandle)).length > 0;
+
+            if (isResizeHandleActive) {
+                return [];
+            }
+
+            const deselect = toArray(target.root.index.all().filter(element => isSelectable(element) && element.selected));
+            const actions: Action[] = [];
+
+            if (deselect.length > 0) {
+                actions.push(SelectAction.create({ deselectedElementsIDs: deselect.map(e => e.id) }));
+            }
+
+            const routableDeselect = deselect.filter(e => e instanceof SRoutableElement).map(e => e.id);
+            if (routableDeselect.length > 0) {
+                actions.push(SwitchEditModeAction.create({ elementsToDeactivate: routableDeselect }));
+            }
+
+            return actions;
+        }
+        return [];
+    }
+
+    protected matchesDeselectKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Escape');
+    }
+}

package/src/features/accessibility/view-key-tools/movement-key-tool.ts

@@ -0,0 +1,129 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { inject, injectable, optional } from 'inversify';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { Action, ISnapper, KeyListener, KeyTool, SModelElement, TYPES } from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
+import { SelectionService } from '../../../base/selection-service';
+import { Tool } from '../../../base/tool-manager/tool';
+import { GridSnapper } from '../../change-bounds/snap';
+import { AccessibleKeyShortcutProvider, SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
+import { MoveElementAction, MoveViewportAction } from '../move-zoom/move-handler';
+
+/**
+ * Moves viewport and elements when its focused and arrow keys are hit.
+ */
+@injectable()
+export class MovementKeyTool implements Tool {
+    static ID = 'glsp.movement-key-tool';
+
+    isEditTool = true;
+
+    protected readonly movementKeyListener = new MoveKeyListener(this);
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+    @inject(SelectionService) selectionService: SelectionService;
+    @inject(TYPES.ISnapper) @optional() readonly snapper?: ISnapper;
+    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: GLSPActionDispatcher;
+
+    get id(): string {
+        return MovementKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.movementKeyListener);
+        this.movementKeyListener.registerShortcutKey();
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.movementKeyListener);
+    }
+}
+
+export class MoveKeyListener extends KeyListener implements AccessibleKeyShortcutProvider {
+    // Default x distance used if GridSnapper is not provided
+    static readonly defaultMoveX = 20;
+
+    // Default y distance used if GridSnapper is not provided
+    static readonly defaultMoveY = 20;
+
+    protected readonly token = MoveKeyListener.name;
+
+    protected grid = { x: MoveKeyListener.defaultMoveX, y: MoveKeyListener.defaultMoveY };
+
+    constructor(protected readonly tool: MovementKeyTool) {
+        super();
+
+        if (this.tool.snapper instanceof GridSnapper) {
+            this.grid = this.tool.snapper.grid;
+        }
+    }
+
+    registerShortcutKey(): void {
+        this.tool.actionDispatcher.onceModelInitialized().then(() => {
+            this.tool.actionDispatcher.dispatchAll([
+                SetAccessibleKeyShortcutAction.create({
+                    token: this.token,
+                    keys: [{ shortcuts: ['⬅  ⬆  ➡  ⬇'], description: 'Move element or viewport', group: 'Move', position: 0 }]
+                })
+            ]);
+        });
+    }
+
+    override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        const selectedElementIds = this.tool.selectionService.getSelectedElementIDs();
+
+        if (selectedElementIds.length > 0) {
+            if (this.matchesMoveUpKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, 0, -this.grid.x)];
+            } else if (this.matchesMoveDownKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, 0, this.grid.x)];
+            } else if (this.matchesMoveRightKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, this.grid.x, 0)];
+            } else if (this.matchesMoveLeftKeystroke(event)) {
+                return [MoveElementAction.create(selectedElementIds, -this.grid.x, 0)];
+            }
+        } else {
+            if (this.matchesMoveUpKeystroke(event)) {
+                return [MoveViewportAction.create(0, -this.grid.x)];
+            } else if (this.matchesMoveDownKeystroke(event)) {
+                return [MoveViewportAction.create(0, this.grid.x)];
+            } else if (this.matchesMoveRightKeystroke(event)) {
+                return [MoveViewportAction.create(this.grid.x, 0)];
+            } else if (this.matchesMoveLeftKeystroke(event)) {
+                return [MoveViewportAction.create(-this.grid.x, 0)];
+            }
+        }
+        return [];
+    }
+
+    protected matchesMoveUpKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowUp');
+    }
+
+    protected matchesMoveDownKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowDown');
+    }
+
+    protected matchesMoveRightKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowRight');
+    }
+
+    protected matchesMoveLeftKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'ArrowLeft');
+    }
+}

package/src/features/accessibility/view-key-tools/view-key-tools-module.ts

@@ -0,0 +1,31 @@
+/********************************************************************************
+ * Copyright (c) 2019-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 { bindAsService, BindingContext, FeatureModule, TYPES } from '~glsp-sprotty';
+import { DeselectKeyTool } from './deselect-key-tool';
+import { MovementKeyTool } from './movement-key-tool';
+import { ZoomKeyTool } from './zoom-key-tool';
+
+export const viewKeyToolsModule = new FeatureModule((bind, _unbind, isBound, rebind) => {
+    const context = { bind, isBound, rebind };
+    configureViewKeyTools(context);
+});
+
+export function configureViewKeyTools(context: Pick<BindingContext, 'bind'>): void {
+    bindAsService(context, TYPES.IDefaultTool, MovementKeyTool);
+    bindAsService(context, TYPES.IDefaultTool, ZoomKeyTool);
+    bindAsService(context, TYPES.IDefaultTool, DeselectKeyTool);
+}

package/src/features/accessibility/view-key-tools/zoom-key-tool.ts

@@ -0,0 +1,113 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { inject, injectable } from 'inversify';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { Action, CenterAction, KeyListener, KeyTool, SModelElement, TYPES } from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
+import { SelectionService } from '../../../base/selection-service';
+import { Tool } from '../../../base/tool-manager/tool';
+import { SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
+import { ZoomElementAction, ZoomViewportAction } from '../move-zoom/zoom-handler';
+
+/**
+ * Zoom viewport and elements when its focused and arrow keys are hit.
+ */
+@injectable()
+export class ZoomKeyTool implements Tool {
+    static ID = 'glsp.zoom-key-tool';
+
+    isEditTool = false;
+
+    protected readonly zoomKeyListener = new ZoomKeyListener(this);
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: GLSPActionDispatcher;
+    @inject(SelectionService) selectionService: SelectionService;
+
+    get id(): string {
+        return ZoomKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.zoomKeyListener);
+        this.zoomKeyListener.registerShortcutKey();
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.zoomKeyListener);
+    }
+}
+
+export class ZoomKeyListener extends KeyListener {
+    static readonly defaultZoomInFactor = 1.1;
+    static readonly defaultZoomOutFactor = 0.9;
+    protected readonly token = ZoomKeyListener.name;
+
+    constructor(protected tool: ZoomKeyTool) {
+        super();
+    }
+
+    registerShortcutKey(): void {
+        this.tool.actionDispatcher.onceModelInitialized().then(() => {
+            this.tool.actionDispatcher.dispatchAll([
+                SetAccessibleKeyShortcutAction.create({
+                    token: this.token,
+                    keys: [
+                        { shortcuts: ['+'], description: 'Zoom in to element or viewport', group: 'Zoom', position: 0 },
+                        { shortcuts: ['-'], description: 'Zoom out to element or viewport', group: 'Zoom', position: 1 },
+                        { shortcuts: ['CTRL', '0'], description: 'Reset zoom to default', group: 'Zoom', position: 2 },
+                        { shortcuts: ['CTRL', '+'], description: 'Zoom in via Grid', group: 'Zoom', position: 3 }
+                    ]
+                })
+            ]);
+        });
+    }
+
+    override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        const selectedElementIds = this.tool.selectionService.getSelectedElementIDs();
+
+        if (this.matchesZoomOutKeystroke(event)) {
+            if (selectedElementIds.length > 0) {
+                return [ZoomElementAction.create(selectedElementIds, ZoomKeyListener.defaultZoomOutFactor)];
+            } else {
+                return [ZoomViewportAction.create(ZoomKeyListener.defaultZoomOutFactor)];
+            }
+        } else if (this.matchesZoomInKeystroke(event)) {
+            if (selectedElementIds.length > 0) {
+                return [ZoomElementAction.create(selectedElementIds, ZoomKeyListener.defaultZoomInFactor)];
+            } else {
+                return [ZoomViewportAction.create(ZoomKeyListener.defaultZoomInFactor)];
+            }
+        } else if (this.matchesMinZoomLevelKeystroke(event)) {
+            return [CenterAction.create(selectedElementIds)];
+        }
+        return [];
+    }
+
+    protected matchesZoomInKeystroke(event: KeyboardEvent): boolean {
+        /** here event.key is used for '+', as keycode 187 is already declared for 'Equals' in {@link matchesKeystroke}.*/
+        return event.key === '+' || matchesKeystroke(event, 'NumpadAdd');
+    }
+
+    protected matchesMinZoomLevelKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Digit0', 'ctrl') || matchesKeystroke(event, 'Numpad0', 'ctrl');
+    }
+
+    protected matchesZoomOutKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Minus') || matchesKeystroke(event, 'NumpadSubtract');
+    }
+}

package/src/features/autocomplete-palette/autocomplete-suggestion-providers.ts

@@ -0,0 +1,37 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { LabeledAction, SModelElement, SModelRoot } from '~glsp-sprotty';
+
+/**
+ * Interface for a provider that provides suggestions that can be used to fill the autocomplete
+ */
+export interface IAutocompleteSuggestionProvider {
+    /**
+     * Returns the suggestions based on the provided parameters.
+     * @param root: The root model
+     * @param text: The text input provided by the user.
+     */
+    retrieveSuggestions(root: Readonly<SModelRoot>, text: string): Promise<AutocompleteSuggestion[]>;
+}
+
+/**
+ * Interface for autocomplete suggestions.
+ */
+export interface AutocompleteSuggestion {
+    element: SModelElement;
+    action: LabeledAction;
+}

package/src/features/autocomplete-palette/base-autocomplete-palette.ts

@@ -0,0 +1,87 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) 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 { inject } from 'inversify';
+import { AbstractUIExtension, Action, LabeledAction, SModelRoot, TYPES } from '~glsp-sprotty';
+import '../../../css/autocomplete-palette.css';
+import { GLSPActionDispatcher } from '../../base/action-dispatcher';
+import { AutoCompleteWidget, CloseReason, toActionArray } from '../../base/auto-complete/auto-complete-widget';
+
+export abstract class BaseAutocompletePalette extends AbstractUIExtension {
+    protected readonly autoSuggestionSettings = {
+        noSuggestionsMessage: 'No suggestions available',
+        suggestionsClass: 'command-palette-suggestions',
+        debounceWaitMs: 50,
+        showOnFocus: true
+    };
+
+    protected root?: Readonly<SModelRoot>;
+    protected autocompleteWidget: AutoCompleteWidget;
+
+    @inject(TYPES.IActionDispatcher)
+    protected actionDispatcher: GLSPActionDispatcher;
+
+    containerClass(): string {
+        return 'autocomplete-palette';
+    }
+
+    override show(root: Readonly<SModelRoot>, ...contextElementIds: string[]): void {
+        super.show(root, ...contextElementIds);
+        this.root = root;
+        this.autocompleteWidget.open(root);
+    }
+
+    override hide(): void {
+        this.autocompleteWidget.dispose();
+        this.root = undefined;
+        super.hide();
+    }
+
+    protected initializeContents(containerElement: HTMLElement): void {
+        containerElement.classList.add('command-palette');
+
+        this.autocompleteWidget = new AutoCompleteWidget(
+            this.autoSuggestionSettings,
+            { provideSuggestions: input => this.retrieveSuggestions(this.root!, input) },
+            { executeFromSuggestion: input => this.executeSuggestion(input) },
+            reason => this.autocompleteHide(reason),
+            this.logger,
+            {
+                visibleSuggestionsChanged: suggestions => this.visibleSuggestionsChanged(this.root!, suggestions),
+                selectedSuggestionChanged: suggestion => this.selectedSuggestionChanged(this.root!, suggestion)
+            }
+        );
+        this.autocompleteWidget.initialize(containerElement);
+    }
+
+    protected abstract retrieveSuggestions(root: Readonly<SModelRoot>, input: string): Promise<LabeledAction[]>;
+
+    protected async visibleSuggestionsChanged(root: Readonly<SModelRoot>, labeledActions: LabeledAction[]): Promise<void> {
+        return;
+    }
+
+    protected async selectedSuggestionChanged(root: Readonly<SModelRoot>, labeledAction?: LabeledAction): Promise<void> {
+        return;
+    }
+
+    protected autocompleteHide(reason: CloseReason): void {
+        this.hide();
+    }
+
+    protected executeSuggestion(input: LabeledAction | Action[] | Action): void {
+        this.actionDispatcher.dispatchAll(toActionArray(input));
+    }
+}

package/src/features/bounds/bounds-module.ts

@@ -0,0 +1,47 @@
+/********************************************************************************
+ * Copyright (c) 2022-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 {
+    FeatureModule,
+    HBoxLayouter,
+    HiddenBoundsUpdater,
+    LayoutRegistry,
+    Layouter,
+    RequestBoundsCommand,
+    SetBoundsCommand,
+    TYPES,
+    VBoxLayouter,
+    bindAsService,
+    configureCommand,
+    configureLayout
+} from '~glsp-sprotty';
+import { FreeFormLayouter } from './freeform-layout';
+import { GLSPHiddenBoundsUpdater } from './glsp-hidden-bounds-updater';
+import { HBoxLayouterExt } from './hbox-layout';
+import { VBoxLayouterExt } from './vbox-layout';
+
+export const boundsModule = new FeatureModule((bind, _unbind, isBound, _rebind) => {
+    const context = { bind, isBound };
+    configureCommand(context, SetBoundsCommand);
+    configureCommand(context, RequestBoundsCommand);
+    bind(HiddenBoundsUpdater).toSelf().inSingletonScope();
+    bindAsService(context, TYPES.HiddenVNodePostprocessor, GLSPHiddenBoundsUpdater);
+    bind(TYPES.Layouter).to(Layouter).inSingletonScope();
+    bind(TYPES.LayoutRegistry).to(LayoutRegistry).inSingletonScope();
+
+    configureLayout(context, VBoxLayouter.KIND, VBoxLayouterExt);
+    configureLayout(context, HBoxLayouter.KIND, HBoxLayouterExt);
+    configureLayout(context, FreeFormLayouter.KIND, FreeFormLayouter);
+});