@eclipse-glsp/client 0.9.0-next.f54fd689 → 0.9.0

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

@@ -0,0 +1,51 @@
+/********************************************************************************
+ * Copyright (c) 2021 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 } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
+import { EnableToolsAction, KeyListener, KeyTool, SModelElement } from 'sprotty';
+import { BaseGLSPTool } from '../tools/base-glsp-tool';
+import { MarqueeMouseTool } from './marquee-mouse-tool';
+
+@injectable()
+export class MarqueeTool extends BaseGLSPTool {
+    static ID = 'glsp.marquee-tool';
+
+    protected marqueeKeyListener: MarqueeKeyListener = new MarqueeKeyListener();
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+
+    get id(): string {
+        return MarqueeTool.ID;
+    }
+
+    enable(): void {
+        this.keyTool.register(this.marqueeKeyListener);
+    }
+
+    disable(): void {
+        this.keyTool.deregister(this.marqueeKeyListener);
+    }
+}
+
+@injectable()
+export class MarqueeKeyListener extends KeyListener {
+    keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        if (event.shiftKey) {
+            return [new EnableToolsAction([MarqueeMouseTool.ID])];
+        }
+        return [];
+    }
+}

package/src/features/tools/model.ts

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

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-2021 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,9 +13,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { inject, injectable, optional } from "inversify";
+import { Action, CreateNodeOperation, isTriggerNodeCreationAction, TriggerNodeCreationAction } from '@eclipse-glsp/protocol';
+import { inject, injectable, optional } from 'inversify';
 import {
-    Action,
     EnableDefaultToolsAction,
     EnableToolsAction,
     findParentByFeature,
@@ -25,22 +25,16 @@ import {
     SModelElement,
     SNode,
     TYPES
-} from "sprotty";
-
-import { DragAwareMouseListener } from "../../base/drag-aware-mouse-listener";
-import {
-    CreateNodeOperation,
-    isTriggerNodeCreationAction,
-    TriggerNodeCreationAction
-} from "../../base/operations/operation";
-import { getAbsolutePosition } from "../../utils/viewpoint-util";
-import { Containable, isContainable } from "../hints/model";
-import { CursorCSS, cursorFeedbackAction } from "../tool-feedback/css-feedback";
-import { BaseGLSPTool } from "./base-glsp-tool";
+} from 'sprotty';
+import { DragAwareMouseListener } from '../../base/drag-aware-mouse-listener';
+import { getAbsolutePosition } from '../../utils/viewpoint-util';
+import { Containable, isContainable } from '../hints/model';
+import { CursorCSS, cursorFeedbackAction } from '../tool-feedback/css-feedback';
+import { BaseGLSPTool } from './base-glsp-tool';
 
 @injectable()
 export class NodeCreationTool extends BaseGLSPTool implements IActionHandler {
-    static ID = "tool_create_node";
+    static ID = 'tool_create_node';
 
     @inject(TYPES.ISnapper) @optional() readonly snapper?: ISnapper;
 
@@ -51,7 +45,7 @@ export class NodeCreationTool extends BaseGLSPTool implements IActionHandler {
         return NodeCreationTool.ID;
     }
 
-    enable() {
+    enable(): void {
         if (this.triggerAction === undefined) {
             throw new TypeError(`Could not enable tool ${this.id}.The triggerAction cannot be undefined.`);
         }
@@ -60,7 +54,7 @@ export class NodeCreationTool extends BaseGLSPTool implements IActionHandler {
         this.dispatchFeedback([cursorFeedbackAction(CursorCSS.NODE_CREATION)]);
     }
 
-    disable() {
+    disable(): void {
         this.mouseTool.deregister(this.creationToolMouseListener);
         this.deregisterFeedback([cursorFeedbackAction()]);
     }
@@ -76,17 +70,19 @@ export class NodeCreationTool extends BaseGLSPTool implements IActionHandler {
 @injectable()
 export class NodeCreationToolMouseListener extends DragAwareMouseListener {
     protected container?: SModelElement & Containable;
+
     constructor(protected triggerAction: TriggerNodeCreationAction, protected tool: NodeCreationTool) {
         super();
     }
 
-    protected creationAllowed(elementTypeId: string) {
+    protected creationAllowed(elementTypeId: string): boolean | undefined {
         return this.container && this.container.isContainableElement(elementTypeId);
     }
 
-    get elementTypeId() {
+    get elementTypeId(): string {
         return this.triggerAction.elementTypeId;
     }
+
     nonDraggingMouseUp(target: SModelElement, event: MouseEvent): Action[] {
         const result: Action[] = [];
         if (this.creationAllowed(this.elementTypeId)) {
@@ -111,8 +107,8 @@ export class NodeCreationToolMouseListener extends DragAwareMouseListener {
         if (!this.container || currentContainer !== this.container) {
             this.container = currentContainer;
             const feedback = this.creationAllowed(this.elementTypeId)
-                ? cursorFeedbackAction(CursorCSS.NODE_CREATION) :
-                cursorFeedbackAction(CursorCSS.OPERATION_NOT_ALLOWED);
+                ? cursorFeedbackAction(CursorCSS.NODE_CREATION)
+                : cursorFeedbackAction(CursorCSS.OPERATION_NOT_ALLOWED);
             this.tool.dispatchFeedback([feedback]);
         }
         return [];

package/src/features/tools/view.tsx

@@ -0,0 +1,44 @@
+/********************************************************************************
+ * Copyright (c) 2021 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 'sprotty';
+
+import { MarqueeNode } from './model';
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const JSX = { createElement: svg };
+
+@injectable()
+export class MarqueeView extends RectangularNodeView {
+    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/validation/di.config.ts

@@ -13,10 +13,10 @@
  *
  * 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 { ContainerModule } from 'inversify';
+import { configureCommand, TYPES } from 'sprotty';
 
-import { GLSP_TYPES } from "../../base/types";
+import { GLSP_TYPES } from '../../base/types';
 import {
     LeftToRightTopToBottomComparator,
     MarkerNavigator,
@@ -24,8 +24,8 @@ import {
     MarkerNavigatorKeyListener,
     NavigateToMarkerCommand,
     SModelElementComparator
-} from "./marker-navigator";
-import { ApplyMarkersCommand, DeleteMarkersCommand, SetMarkersCommand, ValidationFeedbackEmitter } from "./validate";
+} from './marker-navigator';
+import { ApplyMarkersCommand, DeleteMarkersCommand, SetMarkersCommand, ValidationFeedbackEmitter } from './validate';
 
 export const validationModule = new ContainerModule((bind, _unbind, isBound) => {
     configureCommand({ bind, isBound }, SetMarkersCommand);

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2020 EclipseSource and others.
+ * Copyright (c) 2019-2021 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,9 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { SDecoration, SIssue, SIssueMarker, SParentElement } from "sprotty";
-
-import { Marker, MarkerKind } from "../../utils/marker";
+import { Marker, MarkerKind } from '@eclipse-glsp/protocol';
+import { SDecoration, SIssue, SIssueMarker, SParentElement } from 'sprotty';
 
 export class GIssueMarker extends SIssueMarker {
     constructor() {
@@ -38,7 +37,7 @@ export function getOrCreateSIssueMarker(modelElement: SParentElement): SIssueMar
 
     if (issueMarker === undefined) {
         issueMarker = new GIssueMarker();
-        issueMarker.type = "marker";
+        issueMarker.type = 'marker';
         issueMarker.issues = new Array<SIssue>();
         modelElement.add(issueMarker);
     }

package/src/features/validation/marker-navigator.spec.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-2021 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,11 +13,11 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import "mocha";
-import "reflect-metadata";
-
-import { expect } from "chai";
-import { Container } from "inversify";
+/* eslint-disable import/no-deprecated,no-unused-expressions */
+import { expect } from 'chai';
+import { Container } from 'inversify';
+import 'mocha';
+import 'reflect-metadata';
 import {
     BoundsAware,
     decorationModule,
@@ -29,12 +29,11 @@ import {
     SNodeSchema,
     SParentElement,
     TYPES
-} from "sprotty/lib";
-import defaultModule from "sprotty/lib/base/di.config";
-import { SGraphFactory } from "sprotty/lib/graph/sgraph-factory";
-
-import { markerNavigatorModule } from "./di.config";
-import { MarkerNavigator } from "./marker-navigator";
+} from 'sprotty';
+import defaultModule from 'sprotty/lib/base/di.config';
+import { SGraphFactory } from 'sprotty/lib/graph/sgraph-factory';
+import { markerNavigatorModule } from './di.config';
+import { MarkerNavigator } from './marker-navigator';
 
 describe('MarkerNavigator', () => {
     const container = new Container();
@@ -44,28 +43,36 @@ describe('MarkerNavigator', () => {
     const markerNavigator = container.get<MarkerNavigator>(MarkerNavigator);
 
     const rootWithoutAnyMarkers = graphFactory.createRoot({
-        id: 'root', type: 'graph', children: [
-            <SNodeSchema>{
+        id: 'root',
+        type: 'graph',
+        children: [
+            {
                 id: '1',
                 type: 'node'
-            }
+            } as SNodeSchema
         ]
     }) as SModelRoot;
 
     const rootWithMarkers = graphFactory.createRoot({
-        id: 'root', type: 'graph', children: [
-            <SNodeSchema>{
-                id: 'bottom-right', type: 'node'
-            },
-            <SNodeSchema>{
-                id: 'top-right', type: 'node'
-            },
-            <SNodeSchema>{
-                id: 'top-left', type: 'node'
-            },
-            <SNodeSchema>{
-                id: 'bottom-left', type: 'node'
-            }
+        id: 'root',
+        type: 'graph',
+        children: [
+            {
+                id: 'bottom-right',
+                type: 'node'
+            } as SNodeSchema,
+            {
+                id: 'top-right',
+                type: 'node'
+            } as SNodeSchema,
+            {
+                id: 'top-left',
+                type: 'node'
+            } as SNodeSchema,
+            {
+                id: 'bottom-left',
+                type: 'node'
+            } as SNodeSchema
         ]
     }) as SModelRoot;
 
@@ -167,14 +174,13 @@ describe('MarkerNavigator', () => {
         expect(found4).to.eql(marker2);
         expect(found5).to.eql(marker1);
     });
-
 });
 
-function clearMarker(elem: SParentElement) {
+function clearMarker(elem: SParentElement): void {
     elem.children.filter(isMarker).forEach(marker => elem.remove(marker));
 }
 
-function setIssues(elem: SParentElement, issues: SIssue[]) {
+function setIssues(elem: SParentElement, issues: SIssue[]): SIssueMarker {
     const marker = getOrCreateMarker(elem);
     marker.issues = issues;
     return marker;
@@ -196,11 +202,10 @@ function isMarker(element: SModelElement): element is SIssueMarker {
     return element instanceof SIssueMarker;
 }
 
-function createMarker(elem: SParentElement) {
+function createMarker(elem: SParentElement): SIssueMarker {
     const newMarker = new SIssueMarker();
     newMarker.type = 'marker';
     newMarker.id = `${elem.id}_marker`;
     elem.add(newMarker);
     return newMarker;
 }
-

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020 EclipseSource and others.
+ * Copyright (c) 2020-2021 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,11 +13,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { inject, injectable } from "inversify";
+import { Action, CenterAction, Point } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
 import {
-    Action,
     BoundsAware,
-    CenterAction,
     CenterCommand,
     Command,
     CommandExecutionContext,
@@ -28,20 +27,19 @@ import {
     isSelectable,
     KeyListener,
     MenuItem,
-    Point,
+    Selectable,
     SelectAction,
     SIssueMarker,
     SIssueSeverity,
     SModelElement,
     SModelRoot,
     TYPES
-} from "sprotty";
-import { matchesKeystroke } from "sprotty/lib/utils/keyboard";
-
-import { GLSP_TYPES } from "../../base/types";
-import { collectIssueMarkers, MarkerPredicates } from "../../utils/marker";
-import { isSelectableAndBoundsAware } from "../../utils/smodel-util";
-import { SelectCommand, SelectionService } from "../select/selection-service";
+} from 'sprotty';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { GLSP_TYPES } from '../../base/types';
+import { collectIssueMarkers, MarkerPredicates } from '../../utils/marker';
+import { isSelectableAndBoundsAware } from '../../utils/smodel-util';
+import { SelectCommand, SelectionService } from '../select/selection-service';
 
 export class NavigateToMarkerAction implements Action {
     static readonly KIND = 'navigateToMarker';
@@ -50,7 +48,8 @@ export class NavigateToMarkerAction implements Action {
         public readonly direction: 'next' | 'previous' = 'next',
         public readonly selectedElementIds?: string[],
         public readonly severities: SIssueSeverity[] = MarkerNavigator.ALL_SEVERITIES,
-        public kind = NavigateToMarkerAction.KIND) { }
+        public kind = NavigateToMarkerAction.KIND
+    ) {}
 }
 
 export class SModelElementComparator {
@@ -89,7 +88,11 @@ export class MarkerNavigator {
     @inject(SModelElementComparator)
     protected markerComparator: SModelElementComparator;
 
-    next(root: SModelRoot, current?: SModelElement & BoundsAware, predicate: (marker: SIssueMarker) => boolean = MarkerPredicates.ALL): SIssueMarker | undefined {
+    next(
+        root: SModelRoot,
+        current?: SModelElement & BoundsAware,
+        predicate: (marker: SIssueMarker) => boolean = MarkerPredicates.ALL
+    ): SIssueMarker | undefined {
         const markers = this.getMarkers(root, predicate);
         if (current === undefined) {
             return markers.length > 0 ? markers[0] : undefined;
@@ -97,7 +100,11 @@ export class MarkerNavigator {
         return markers[this.getNextIndex(current, markers) % markers.length];
     }
 
-    previous(root: SModelRoot, current?: SModelElement & BoundsAware, predicate: (marker: SIssueMarker) => boolean = MarkerPredicates.ALL): SIssueMarker | undefined {
+    previous(
+        root: SModelRoot,
+        current?: SModelElement & BoundsAware,
+        predicate: (marker: SIssueMarker) => boolean = MarkerPredicates.ALL
+    ): SIssueMarker | undefined {
         const markers = this.getMarkers(root, predicate);
         if (current === undefined) {
             return markers.length > 0 ? markers[0] : undefined;
@@ -105,12 +112,12 @@ export class MarkerNavigator {
         return markers[this.getPreviousIndex(current, markers) % markers.length];
     }
 
-    protected getMarkers(root: SModelRoot, predicate: (marker: SIssueMarker) => boolean) {
+    protected getMarkers(root: SModelRoot, predicate: (marker: SIssueMarker) => boolean): SIssueMarker[] {
         const markers = collectIssueMarkers(root);
         return markers.filter(predicate).sort(this.markerComparator.compare);
     }
 
-    protected getNextIndex(current: SModelElement & BoundsAware, markers: SIssueMarker[]) {
+    protected getNextIndex(current: SModelElement & BoundsAware, markers: SIssueMarker[]): number {
         for (let index = 0; index < markers.length; index++) {
             if (this.markerComparator.compare(markers[index], current) > 0) {
                 return index;
@@ -119,7 +126,7 @@ export class MarkerNavigator {
         return 0;
     }
 
-    protected getPreviousIndex(current: SModelElement & BoundsAware, markers: SIssueMarker[]) {
+    protected getPreviousIndex(current: SModelElement & BoundsAware, markers: SIssueMarker[]): number {
         for (let index = markers.length - 1; index >= 0; index--) {
             if (this.markerComparator.compare(markers[index], current) < 0) {
                 return index;
@@ -168,7 +175,7 @@ export class NavigateToMarkerCommand extends Command {
         return root;
     }
 
-    protected getSelectedElements(root: SModelRoot) {
+    protected getSelectedElements(root: SModelRoot): (SModelElement & Selectable)[] {
         let selectedIds = [];
         if (this.action.selectedElementIds !== undefined && this.action.selectedElementIds.length > 0) {
             selectedIds = this.action.selectedElementIds;
@@ -178,13 +185,13 @@ export class NavigateToMarkerCommand extends Command {
         return selectedIds.map(id => root.index.getById(id)).filter(isSelectable);
     }
 
-    protected getTarget(selected: SModelElement[], root: SModelRoot) {
+    protected getTarget(selected: SModelElement[], root: SModelRoot): SIssueMarker | undefined {
         const selectedBoundsAware = selected.filter(isBoundsAware).sort(this.markerComparator.compare);
         const currentTopmost = selectedBoundsAware.length > 0 ? selectedBoundsAware[0] : undefined;
         if (this.action.direction === 'previous') {
-            return this.markerNavigator.previous(root, currentTopmost, (marker) => this.matchesSeverities(marker));
+            return this.markerNavigator.previous(root, currentTopmost, marker => this.matchesSeverities(marker));
         } else {
-            return this.markerNavigator.next(root, currentTopmost, (marker) => this.matchesSeverities(marker));
+            return this.markerNavigator.next(root, currentTopmost, marker => this.matchesSeverities(marker));
         }
     }
 
@@ -205,7 +212,6 @@ export class NavigateToMarkerCommand extends Command {
         }
         return this.centerCommand ? this.centerCommand.redo(context) : context.root;
     }
-
 }
 
 @injectable()
@@ -217,15 +223,22 @@ export class MarkerNavigatorContextMenuItemProvider implements IContextMenuItemP
         const hasMarkers = collectIssueMarkers(root).length > 0;
         return Promise.resolve([
             {
-                id: "navigate", label: "Go to", group: "navigate", actions: [],
+                id: 'navigate',
+                label: 'Go to',
+                group: 'navigate',
+                actions: [],
                 children: [
                     {
-                        id: "next-marker", label: "Next marker", group: "marker",
+                        id: 'next-marker',
+                        label: 'Next marker',
+                        group: 'marker',
                         actions: [new NavigateToMarkerAction('next', selectedElementIds)],
                         isEnabled: () => hasMarkers
                     },
                     {
-                        id: "previous-marker", label: "Previous marker", group: "marker",
+                        id: 'previous-marker',
+                        label: 'Previous marker',
+                        group: 'marker',
                         actions: [new NavigateToMarkerAction('previous', selectedElementIds)],
                         isEnabled: () => hasMarkers
                     }