@eclipse-glsp/client 0.9.0-next.c5944e10

package/src/features/rank/model.ts

@@ -0,0 +1,29 @@
+/********************************************************************************
+ * Copyright (c) 2019 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
+ ********************************************************************************/
+
+export const DEFAULT_RANK = 0;
+
+export interface Ranked {
+    rank: number;
+}
+
+export function isRanked(arg: any): arg is Ranked {
+    return arg !== undefined && arg.rank !== undefined && typeof (arg.rank) === 'number';
+}
+
+export function getRank(arg: any): number {
+    return isRanked(arg) ? arg.rank : DEFAULT_RANK;
+}

package/src/features/reconnect/model.ts

@@ -0,0 +1,76 @@
+/********************************************************************************
+ * Copyright (c) 2019 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 {
+    edgeInProgressID,
+    edgeInProgressTargetHandleID,
+    RoutingHandleKind,
+    selectFeature,
+    SModelElement,
+    SModelExtension,
+    SRoutableElement,
+    SRoutingHandle
+} from 'sprotty';
+
+export const reconnectFeature = Symbol('reconnectFeature');
+
+export interface Reconnectable extends SModelExtension {
+}
+
+export function isReconnectable(element: SModelElement): element is SRoutableElement & Reconnectable {
+    return element instanceof SRoutableElement && element.hasFeature(reconnectFeature);
+}
+
+const ROUTING_HANDLE_SOURCE_INDEX = -2;
+
+export function isReconnectHandle(element: SModelElement | undefined): element is SReconnectHandle {
+    return element !== undefined && element instanceof SReconnectHandle;
+}
+
+export function addReconnectHandles(element: SRoutableElement): void {
+    removeReconnectHandles(element);
+    createReconnectHandle(element, 'source', ROUTING_HANDLE_SOURCE_INDEX);
+    createReconnectHandle(element, 'target', element.routingPoints.length);
+}
+
+export function removeReconnectHandles(element: SRoutableElement): void {
+    element.removeAll(child => child instanceof SReconnectHandle);
+}
+
+export function isSourceRoutingHandle(edge: SRoutableElement, routingHandle: SReconnectHandle): boolean {
+    return routingHandle.pointIndex === ROUTING_HANDLE_SOURCE_INDEX;
+}
+
+export function isTargetRoutingHandle(edge: SRoutableElement, routingHandle: SReconnectHandle): boolean {
+    return routingHandle.pointIndex === edge.routingPoints.length;
+}
+
+export function createReconnectHandle(edge: SRoutableElement, kind: RoutingHandleKind, routingPointIndex: number): SReconnectHandle {
+    const handle = new SReconnectHandle();
+    handle.kind = kind;
+    handle.pointIndex = routingPointIndex;
+    handle.type = 'routing-point';
+    if (kind === 'target' && edge.id === edgeInProgressID) {
+        handle.id = edgeInProgressTargetHandleID;
+    }
+    edge.add(handle);
+    return handle;
+}
+
+export class SReconnectHandle extends SRoutingHandle {
+    hasFeature(feature: symbol): boolean {
+        return feature !== selectFeature && super.hasFeature(feature);
+    }
+}

package/src/features/save/di.config.ts

@@ -0,0 +1,30 @@
+/********************************************************************************
+ * Copyright (c) 2019 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 { ContainerModule } from 'inversify';
+import { TYPES } from 'sprotty';
+
+import { SaveModelKeyboardListener } from './save';
+
+/**
+ * This module is not required the diagram is deployed in Theia with the `GLSPDiagramWidget`
+ * but only intended to be used in a standalone deployment of GLSP.
+ */
+const saveModule = new ContainerModule(bind => {
+    bind(TYPES.KeyListener).to(SaveModelKeyboardListener);
+
+});
+
+export default saveModule;

package/src/features/save/model.ts

@@ -0,0 +1,26 @@
+/********************************************************************************
+ * Copyright (c) 2019 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 { SModelElement, SModelExtension, SModelRoot } from 'sprotty';
+
+export const saveFeature = Symbol.for('saveFeature');
+
+export interface Saveable extends SModelExtension {
+    dirty: boolean;
+}
+
+export function isSaveable(element: SModelElement): element is SModelRoot & Saveable {
+    return element.hasFeature(saveFeature);
+}

package/src/features/save/save.ts

@@ -0,0 +1,35 @@
+/********************************************************************************
+ * Copyright (c) 2019 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, KeyListener, SModelRoot } from 'sprotty';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+
+export class SaveModelAction implements Action {
+    static readonly KIND = 'saveModel';
+    constructor(public readonly fileUri?: string, public readonly kind: string = SaveModelAction.KIND) { }
+}
+
+export function isSaveModelAction(action: Action): action is SaveModelAction {
+    return action.kind === SaveModelAction.KIND;
+}
+
+export class SaveModelKeyboardListener extends KeyListener {
+    keyDown(_element: SModelRoot, event: KeyboardEvent): Action[] {
+        if (matchesKeystroke(event, 'KeyS', 'ctrlCmd')) {
+            return [new SaveModelAction()];
+        }
+        return [];
+    }
+}

package/src/features/select/di.config.ts

@@ -0,0 +1,35 @@
+/********************************************************************************
+ * Copyright (c) 2019 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 { ContainerModule } from 'inversify';
+import { configureCommand, TYPES } from 'sprotty';
+
+import { GLSP_TYPES } from '../../base/types';
+import { SelectAllFeedbackCommand, SelectFeedbackCommand } from './select-feedback-action';
+import { RankedSelectMouseListener } from './select-mouse-listener';
+import { SelectAllCommand, SelectCommand, SelectionService } from './selection-service';
+
+const glspSelectModule = new ContainerModule((bind, _unbind, isBound) => {
+    bind(SelectionService).toSelf().inSingletonScope();
+    bind(GLSP_TYPES.SelectionService).toService(SelectionService);
+    configureCommand({ bind, isBound }, SelectCommand);
+    configureCommand({ bind, isBound }, SelectAllCommand);
+    configureCommand({ bind, isBound }, SelectFeedbackCommand);
+    configureCommand({ bind, isBound }, SelectAllFeedbackCommand);
+    bind(TYPES.MouseListener).to(RankedSelectMouseListener);
+    bind(GLSP_TYPES.SModelRootListener).toService(SelectionService);
+});
+
+export default glspSelectModule;

package/src/features/select/select-feedback-action.ts

@@ -0,0 +1,87 @@
+/********************************************************************************
+ * Copyright (c) 2019-2020 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 { inject, injectable } from 'inversify';
+import {
+    Command,
+    CommandExecutionContext,
+    SelectAllCommand as SprottySelectAllCommand,
+    SelectCommand as SprottySelectCommand,
+    SModelRoot,
+    TYPES
+} from 'sprotty';
+
+export class SelectFeedbackAction {
+    constructor(
+        public readonly selectedElementsIDs: string[] = [],
+        public readonly deselectedElementsIDs: string[] = [],
+        public readonly kind: string = SelectFeedbackCommand.KIND) {
+    }
+}
+
+export class SelectAllFeedbackAction {
+    /**
+     * If `select` is true, all elements are selected, othewise they are deselected.
+     */
+    constructor(public readonly select: boolean = true, public readonly kind: string = SelectFeedbackCommand.KIND) {
+    }
+}
+
+@injectable()
+export class SelectFeedbackCommand extends Command {
+    static readonly KIND = 'elementSelectedFeedback';
+    private sprottySelectCommand: SprottySelectCommand;
+
+    constructor(@inject(TYPES.Action) public action: SelectFeedbackAction) {
+        super();
+        this.sprottySelectCommand = new SprottySelectCommand(action);
+    }
+
+    execute(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectCommand.execute(context);
+    }
+
+    undo(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectCommand.undo(context);
+    }
+
+    redo(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectCommand.redo(context);
+    }
+}
+
+@injectable()
+export class SelectAllFeedbackCommand extends Command {
+    static readonly KIND = 'allSelectedFeedback';
+    private sprottySelectAllCommand: SprottySelectAllCommand;
+
+    constructor(@inject(TYPES.Action) public action: SelectAllFeedbackAction) {
+        super();
+        this.sprottySelectAllCommand = new SprottySelectAllCommand(action);
+    }
+
+    execute(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectAllCommand.execute(context);
+    }
+
+    undo(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectAllCommand.undo(context);
+    }
+
+    redo(context: CommandExecutionContext): SModelRoot {
+        return this.sprottySelectAllCommand.redo(context);
+    }
+}
+

package/src/features/select/select-mouse-listener.ts

@@ -0,0 +1,26 @@
+/********************************************************************************
+ * Copyright (c) 2019 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 { SelectMouseListener } from 'sprotty';
+
+import { DEFAULT_RANK, Ranked } from '../rank/model';
+
+/**
+ * Ranked select mouse listener that is executed before default mouse listeners when using the RankedMouseTool.
+ * This ensures that default mouse listeners are working on a model that has selection changes already applied.
+ */
+export class RankedSelectMouseListener extends SelectMouseListener implements Ranked {
+    rank: number = DEFAULT_RANK - 1; /* we want to be executed before all default mouse listeners */
+}