@eclipse-glsp/client 1.1.0-next.fe0b297.182 → 2.0.0

package/src/features/tools/marquee-selection/marquee-tool-feedback.ts

@@ -0,0 +1,130 @@
+/********************************************************************************
+ * Copyright (c) 2021-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 { inject, injectable } from 'inversify';
+import {
+    Action,
+    AnchorComputerRegistry,
+    CommandExecutionContext,
+    CommandReturn,
+    GChildElement,
+    MouseListener,
+    Point,
+    GModelElement,
+    GModelRoot,
+    TYPES,
+    hasObjectProp
+} from '@eclipse-glsp/sprotty';
+import { FeedbackCommand } from '../../../base/feedback/feedback-command';
+
+export interface DrawMarqueeAction extends Action {
+    kind: typeof DrawMarqueeAction.KIND;
+    startPoint: Point;
+    endPoint: Point;
+}
+
+export namespace DrawMarqueeAction {
+    export const KIND = 'drawMarquee';
+
+    export function is(object: any): object is DrawMarqueeAction {
+        return Action.hasKind(object, KIND) && hasObjectProp(object, 'startPoint') && hasObjectProp(object, 'endPoint');
+    }
+
+    export function create(options: { startPoint: Point; endPoint: Point }): DrawMarqueeAction {
+        return {
+            kind: KIND,
+            ...options
+        };
+    }
+}
+
+@injectable()
+export class DrawMarqueeCommand extends FeedbackCommand {
+    static readonly KIND = DrawMarqueeAction.KIND;
+
+    constructor(@inject(TYPES.Action) protected action: DrawMarqueeAction) {
+        super();
+    }
+
+    execute(context: CommandExecutionContext): CommandReturn {
+        drawMarquee(context, this.action.startPoint, this.action.endPoint);
+        return context.root;
+    }
+}
+
+export interface RemoveMarqueeAction extends Action {
+    kind: typeof RemoveMarqueeAction.KIND;
+}
+
+export namespace RemoveMarqueeAction {
+    export const KIND = 'removeMarquee';
+
+    export function is(object: any): object is RemoveMarqueeAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(): RemoveMarqueeAction {
+        return { kind: KIND };
+    }
+}
+
+@injectable()
+export class RemoveMarqueeCommand extends FeedbackCommand {
+    static readonly KIND = RemoveMarqueeAction.KIND;
+
+    execute(context: CommandExecutionContext): CommandReturn {
+        removeMarquee(context.root);
+        return context.root;
+    }
+}
+
+export class MarqueeEndMovingMouseListener extends MouseListener {
+    constructor(protected anchorRegistry: AnchorComputerRegistry) {
+        super();
+    }
+
+    override mouseMove(target: GModelElement, event: MouseEvent): Action[] {
+        return [];
+    }
+}
+
+export function marqueeId(root: GModelRoot): string {
+    return root.id + '_' + MARQUEE;
+}
+
+export const MARQUEE = 'marquee';
+
+export function drawMarquee(context: CommandExecutionContext, startPoint: Point, endPoint: Point): void {
+    const root = context.root;
+
+    removeMarquee(root);
+
+    const marqueeSchema = {
+        type: MARQUEE,
+        id: marqueeId(root),
+        startPoint: startPoint,
+        endPoint: endPoint
+    };
+
+    const marquee = context.modelFactory.createElement(marqueeSchema);
+    root.add(marquee);
+}
+
+export function removeMarquee(root: GModelRoot): void {
+    const marquee = root.index.getById(marqueeId(root));
+    if (marquee instanceof GChildElement) {
+        root.remove(marquee);
+    }
+}

package/src/features/tools/marquee-selection/marquee-tool.ts

@@ -0,0 +1,45 @@
+/********************************************************************************
+ * Copyright (c) 2021-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 { injectable } from 'inversify';
+import { Action, KeyListener, GModelElement } from '@eclipse-glsp/sprotty';
+import { EnableToolsAction } from '../../../base/tool-manager/tool';
+import { BaseEditTool } from '../base-tools';
+import { MarqueeMouseTool } from './marquee-mouse-tool';
+
+@injectable()
+export class MarqueeTool extends BaseEditTool {
+    static ID = 'glsp.marquee-tool';
+
+    protected marqueeKeyListener: MarqueeKeyListener = new MarqueeKeyListener();
+
+    get id(): string {
+        return MarqueeTool.ID;
+    }
+
+    enable(): void {
+        this.toDisposeOnDisable.push(this.keyTool.registerListener(this.marqueeKeyListener));
+    }
+}
+
+@injectable()
+export class MarqueeKeyListener extends KeyListener {
+    override keyDown(_element: GModelElement, event: KeyboardEvent): Action[] {
+        if (event.shiftKey) {
+            return [EnableToolsAction.create([MarqueeMouseTool.ID])];
+        }
+        return [];
+    }
+}

package/src/features/tools/marquee-selection/model.ts

@@ -0,0 +1,22 @@
+/********************************************************************************
+ * Copyright (c) 2021-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 { boundsFeature, Point, RectangularNode } from '@eclipse-glsp/sprotty';
+
+export class MarqueeNode extends RectangularNode {
+    static override readonly DEFAULT_FEATURES = [boundsFeature];
+    startPoint: Point;
+    endPoint: Point;
+}

package/src/features/tools/marquee-selection/view.tsx

@@ -0,0 +1,43 @@
+/********************************************************************************
+ * Copyright (c) 2021-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 { injectable } from 'inversify';
+import { VNode } from 'snabbdom';
+import { RectangularNodeView, RenderingContext, svg } from '@eclipse-glsp/sprotty';
+import { MarqueeNode } from './model';
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const JSX = { createElement: svg };
+
+@injectable()
+export class MarqueeView extends RectangularNodeView {
+    override render(node: MarqueeNode, context: RenderingContext): VNode {
+        const graph = (
+            <g>
+                <rect
+                    class-sprotty-node={true}
+                    class-marquee={true}
+                    x={node.startPoint.x - node.endPoint.x <= 0 ? node.startPoint.x : node.endPoint.x}
+                    y={node.startPoint.y - node.endPoint.y <= 0 ? node.startPoint.y : node.endPoint.y}
+                    rx={0}
+                    ry={0}
+                    width={Math.abs(node.startPoint.x - node.endPoint.x)}
+                    height={Math.abs(node.startPoint.y - node.endPoint.y)}
+                ></rect>
+            </g>
+        );
+        return graph;
+    }
+}

package/src/features/tools/node-creation/node-creation-module.ts

@@ -0,0 +1,23 @@
+/********************************************************************************
+ * 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 { FeatureModule, TYPES, TriggerNodeCreationAction, bindAsService, configureActionHandler } from '@eclipse-glsp/sprotty';
+import { NodeCreationTool } from './node-creation-tool';
+
+export const nodeCreationToolModule = new FeatureModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    bindAsService(context, TYPES.ITool, NodeCreationTool);
+    configureActionHandler(context, TriggerNodeCreationAction.KIND, NodeCreationTool);
+});

package/src/features/tools/node-creation/node-creation-tool.ts

@@ -0,0 +1,105 @@
+/********************************************************************************
+ * 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 { inject, injectable, optional } from 'inversify';
+import {
+    Action,
+    CreateNodeOperation,
+    ISnapper,
+    GModelElement,
+    GNode,
+    TYPES,
+    TriggerNodeCreationAction,
+    findParentByFeature,
+    isCtrlOrCmd
+} from '@eclipse-glsp/sprotty';
+import { DragAwareMouseListener } from '../../../base/drag-aware-mouse-listener';
+import { CursorCSS, cursorFeedbackAction } from '../../../base/feedback/css-feedback';
+import { EnableDefaultToolsAction } from '../../../base/tool-manager/tool';
+import { getAbsolutePosition } from '../../../utils/viewpoint-util';
+import { Containable, isContainable } from '../../hints/model';
+import { BaseCreationTool } from '../base-tools';
+
+@injectable()
+export class NodeCreationTool extends BaseCreationTool<TriggerNodeCreationAction> {
+    static ID = 'tool_create_node';
+
+    protected isTriggerAction = TriggerNodeCreationAction.is;
+
+    @inject(TYPES.ISnapper) @optional() readonly snapper?: ISnapper;
+
+    get id(): string {
+        return NodeCreationTool.ID;
+    }
+
+    doEnable(): void {
+        this.toDisposeOnDisable.push(
+            this.mouseTool.registerListener(new NodeCreationToolMouseListener(this.triggerAction, this)),
+            this.registerFeedback([cursorFeedbackAction(CursorCSS.NODE_CREATION)], this, [cursorFeedbackAction()])
+        );
+    }
+}
+
+@injectable()
+export class NodeCreationToolMouseListener extends DragAwareMouseListener {
+    protected container?: GModelElement & Containable;
+
+    constructor(protected triggerAction: TriggerNodeCreationAction, protected tool: NodeCreationTool) {
+        super();
+    }
+
+    protected creationAllowed(elementTypeId: string): boolean | undefined {
+        return this.container && this.container.isContainableElement(elementTypeId);
+    }
+
+    get elementTypeId(): string {
+        return this.triggerAction.elementTypeId;
+    }
+
+    override nonDraggingMouseUp(target: GModelElement, event: MouseEvent): Action[] {
+        const result: Action[] = [];
+        if (this.container === undefined) {
+            this.mouseOver(target, event);
+        }
+
+        if (this.creationAllowed(this.elementTypeId)) {
+            const containerId = this.container ? this.container.id : undefined;
+            let location = getAbsolutePosition(target, event);
+            if (this.tool.snapper) {
+                // Create a 0-bounds proxy element for snapping
+                const elementProxy = new GNode();
+                elementProxy.size = { width: 0, height: 0 };
+                location = this.tool.snapper.snap(location, elementProxy);
+            }
+            result.push(CreateNodeOperation.create(this.elementTypeId, { location, containerId, args: this.triggerAction.args }));
+            if (!isCtrlOrCmd(event)) {
+                result.push(EnableDefaultToolsAction.create());
+            }
+        }
+        return result;
+    }
+
+    override mouseOver(target: GModelElement, event: MouseEvent): Action[] {
+        const currentContainer = findParentByFeature(target, isContainable);
+        if (!this.container || currentContainer !== this.container) {
+            this.container = currentContainer;
+            const feedback = this.creationAllowed(this.elementTypeId)
+                ? cursorFeedbackAction(CursorCSS.NODE_CREATION)
+                : cursorFeedbackAction(CursorCSS.OPERATION_NOT_ALLOWED);
+            this.tool.registerFeedback([feedback]);
+        }
+        return [];
+    }
+}

package/src/features/tools/tool-focus-loss-module.ts

@@ -0,0 +1,39 @@
+/********************************************************************************
+ * 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 { injectable } from 'inversify';
+import { Action, FeatureModule, IActionHandler, ICommand, configureActionHandler } from '@eclipse-glsp/sprotty';
+import { FocusStateChangedAction } from '../../base/focus/focus-state-change-action';
+import { EnableDefaultToolsAction } from '../../base/tool-manager/tool';
+
+/**
+ * Action handler that enables the default tools when the diagram lost focus.
+ * @see FocusStateChangedAction
+ */
+@injectable()
+export class EnableDefaultToolsOnFocusLossHandler implements IActionHandler {
+    handle(action: Action): void | Action | ICommand {
+        if (FocusStateChangedAction.is(action) && !action.hasFocus) {
+            return EnableDefaultToolsAction.create();
+        }
+    }
+}
+
+/**
+ * Enables the default tools in the tool manager if the diagram looses focus.
+ */
+export const toolFocusLossModule = new FeatureModule((bind, _unbind, isBound) => {
+    configureActionHandler({ bind, isBound }, FocusStateChangedAction.KIND, EnableDefaultToolsOnFocusLossHandler);
+});

package/src/features/undo-redo/undo-redo-key-listener.ts

@@ -0,0 +1,32 @@
+/********************************************************************************
+ * Copyright (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
+ ********************************************************************************/
+
+import { Action, KeyListener, RedoAction, GModelElement, UndoAction, isMac, matchesKeystroke } from '@eclipse-glsp/sprotty';
+
+/**
+ * Key listener that listens to the typical keyboard shortcuts for undo/redo and dispatches the corresponding actions.
+ */
+export class GLSPUndoRedoKeyListener extends KeyListener {
+    override keyDown(element: GModelElement, event: KeyboardEvent): Action[] {
+        if (matchesKeystroke(event, 'KeyZ', 'ctrlCmd')) {
+            return [UndoAction.create()];
+        }
+        if (matchesKeystroke(event, 'KeyZ', 'ctrlCmd', 'shift') || (!isMac() && matchesKeystroke(event, 'KeyY', 'ctrlCmd'))) {
+            return [RedoAction.create()];
+        }
+        return [];
+    }
+}

package/src/features/undo-redo/undo-redo-module.ts

@@ -0,0 +1,28 @@
+/********************************************************************************
+ * Copyright (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
+ ********************************************************************************/
+
+import { ContainerModule } from 'inversify';
+import { bindAsService, TYPES } from '@eclipse-glsp/sprotty';
+import { GLSPUndoRedoKeyListener } from './undo-redo-key-listener';
+
+/**
+ * Feature module that is intended for the standalone deployment of GLSP (i.e. plain webapp)
+ * When integrated into an application frame (e.g Theia/VS Code) this module is typically omitted and/or replaced
+ * with an application native module.
+ */
+export const undoRedoModule = new ContainerModule((bind, unbind, isBound, rebind) => {
+    bindAsService(bind, TYPES.KeyListener, GLSPUndoRedoKeyListener);
+});

package/src/features/validation/issue-marker.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2021 EclipseSource and others.
+ * 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
@@ -13,17 +13,27 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Bounds, Marker, MarkerKind } from '@eclipse-glsp/protocol';
-import { isBoundsAware, Projectable, SDecoration, SIssue, SIssueMarker, SIssueSeverity, SParentElement } from 'sprotty';
+import {
+    Bounds,
+    GDecoration,
+    GIssue,
+    GIssueSeverity,
+    GParentElement,
+    Marker,
+    MarkerKind,
+    Projectable,
+    SIssueMarker,
+    isBoundsAware
+} from '@eclipse-glsp/sprotty';
 
 export class GIssueMarker extends SIssueMarker implements Projectable {
     constructor() {
         super();
-        this.features = new Set<symbol>(SDecoration.DEFAULT_FEATURES);
+        this.features = new Set<symbol>(GDecoration.DEFAULT_FEATURES);
     }
     projectionCssClasses: string[];
     projectedBounds?: Bounds;
-    override issues: SIssue[] = [];
+    override issues: GIssue[] = [];
     override type = 'marker';
 
     computeProjectionCssClasses(): void {
@@ -33,16 +43,16 @@ export class GIssueMarker extends SIssueMarker implements Projectable {
 }
 
 /**
- * Retrieves the `SIssueMarker` contained by the provided model element as
- * direct child or a newly instantiated `SIssueMarker` if no child
- * `SIssueMarker` exists.
- * @param modelElement for which the `SIssueMarker` should be retrieved or created.
- * @returns the child `SIssueMarker` or a new `SIssueMarker` if no such child exists.
+ * Retrieves the `GIssueMarker` contained by the provided model element as
+ * direct child or a newly instantiated `GIssueMarker` if no child
+ * `GIssueMarker` exists.
+ * @param modelElement for which the `GIssueMarker` should be retrieved or created.
+ * @returns the child `GIssueMarker` or a new `GIssueMarker` if no such child exists.
  */
-export function getOrCreateSIssueMarker(modelElement: SParentElement): SIssueMarker {
+export function getOrCreateGIssueMarker(modelElement: GParentElement): GIssueMarker {
     let issueMarker: GIssueMarker | undefined;
 
-    issueMarker = getSIssueMarker(modelElement);
+    issueMarker = getGIssueMarker(modelElement);
 
     if (issueMarker === undefined) {
         issueMarker = new GIssueMarker();
@@ -56,12 +66,12 @@ export function getOrCreateSIssueMarker(modelElement: SParentElement): SIssueMar
 }
 
 /**
- * Retrieves the `SIssueMarker` contained by the provided model element as
- * direct child or `undefined` if such an `SIssueMarker` does not exist.
- * @param modelElement for which the `SIssueMarker` should be retrieved.
- * @returns the child `SIssueMarker` or `undefined` if no such child exists.
+ * Retrieves the `GIssueMarker` contained by the provided model element as
+ * direct child or `undefined` if such an `GIssueMarker` does not exist.
+ * @param modelElement for which the `GIssueMarker` should be retrieved.
+ * @returns the child `GIssueMarker` or `undefined` if no such child exists.
  */
-export function getSIssueMarker(modelElement: SParentElement): GIssueMarker | undefined {
+export function getGIssueMarker(modelElement: GParentElement): GIssueMarker | undefined {
     let issueMarker: GIssueMarker | undefined;
 
     for (const child of modelElement.children) {
@@ -74,13 +84,13 @@ export function getSIssueMarker(modelElement: SParentElement): GIssueMarker | un
 }
 
 /**
- * Creates an `SIssue` with `severity` and `message` set according to
+ * Creates an `GIssue` with `severity` and `message` set according to
  * the `kind` and `description` of the provided `Marker`.
- * @param marker `Marker` for that an `SIssue` should be created.
- * @returns the created `SIssue`.
+ * @param marker `Marker` for that an `GIssue` should be created.
+ * @returns the created `GIssue`.
  */
-export function createSIssue(marker: Marker, parent?: SParentElement): SIssue {
-    const issue = new SIssue();
+export function createGIssue(marker: Marker, parent?: GParentElement): GIssue {
+    const issue = new GIssue();
     issue.message = marker.description;
 
     switch (marker.kind) {
@@ -100,8 +110,8 @@ export function createSIssue(marker: Marker, parent?: SParentElement): SIssue {
     return issue;
 }
 
-export function getSeverity(marker: SIssueMarker): SIssueSeverity {
-    let currentSeverity: SIssueSeverity = 'info';
+export function getSeverity(marker: GIssueMarker): GIssueSeverity {
+    let currentSeverity: GIssueSeverity = 'info';
     for (const severity of marker.issues.map(s => s.severity)) {
         if (severity === 'error') {
             return severity;