@eclipse-glsp/client 0.9.0-next.6d10f92e → 0.9.0-next.75608185

package/src/features/hints/type-hints.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 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,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { inject, injectable } from "inversify";
+import { Action, EdgeTypeHint, isSetTypeHintsAction, ShapeTypeHint, TypeHint } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
 import {
-    Action,
     CommandExecutionContext,
     CommandReturn,
     Connectable,
@@ -28,81 +28,17 @@ import {
     moveFeature,
     SEdge,
     SModelElement,
-    SModelElementSchema,
     SModelRoot,
     SShapeElement,
     TYPES
-} from "sprotty";
-
-import { GLSP_TYPES } from "../../base/types";
-import { getElementTypeId, hasCompatibleType } from "../../utils/smodel-util";
-import { resizeFeature } from "../change-bounds/model";
-import { reconnectFeature } from "../reconnect/model";
-import { IFeedbackActionDispatcher } from "../tool-feedback/feedback-action-dispatcher";
-import { FeedbackCommand } from "../tool-feedback/model";
-import { Containable, containerFeature, reparentFeature } from "./model";
-import { isSetTypeHintsAction } from "./request-type-hints-action";
-
-export abstract class TypeHint {
-    /**
-    The id of the element.
-    */
-    readonly elementTypeId: string;
-
-    /**
-    * Specifies whether the element can be relocated.
-    */
-    readonly repositionable: boolean;
-
-    /**
-     * Specifices wheter the element can be deleted
-     */
-    readonly deletable: boolean;
-}
-
-export class ShapeTypeHint extends TypeHint {
-    /**
-     * Specifies whether the element can be resized.
-     */
-    readonly resizable: boolean;
-
-    /**
-     * Specifies whether the element can be moved to another parent
-     */
-    readonly reparentable: boolean;
-
-    /**
-     * The types of elements that can be contained by this element (if any)
-     */
-    readonly containableElementTypeIds?: string[];
-}
-
-export class EdgeTypeHint extends TypeHint {
-    /**
-     * Specifies whether the routing of this element can be changed.
-     */
-    readonly routable: boolean;
-
-    /**
-     * Allowed source element types for this edge type
-     */
-    readonly sourceElementTypeIds: string[];
-
-    /**
-    * Allowed targe element types for this edge type
-    */
-    readonly targetElementTypeIds: string[];
-
-    isAllowedSource(input: SModelElement | SModelElementSchema | string): boolean {
-        const type = getElementTypeId(input);
-        return this.sourceElementTypeIds.includes(type);
-
-    }
-    isAllowedTarget(input: SModelElement | SModelElementSchema | string): boolean {
-        const type = getElementTypeId(input);
-        return this.targetElementTypeIds.includes(type);
-    }
-}
+} from 'sprotty';
+import { GLSP_TYPES } from '../../base/types';
+import { getElementTypeId, hasCompatibleType } from '../../utils/smodel-util';
+import { resizeFeature } from '../change-bounds/model';
+import { reconnectFeature } from '../reconnect/model';
+import { IFeedbackActionDispatcher } from '../tool-feedback/feedback-action-dispatcher';
+import { FeedbackCommand } from '../tool-feedback/model';
+import { Containable, containerFeature, reparentFeature } from './model';
 
 @injectable()
 export class ApplyTypeHintsAction implements Action {
@@ -111,8 +47,7 @@ export class ApplyTypeHintsAction implements Action {
 
 @injectable()
 export class ApplyTypeHintsCommand extends FeedbackCommand {
-
-    public static KIND = "applyTypeHints";
+    public static KIND = 'applyTypeHints';
     public readonly priority = 10;
 
     @inject(GLSP_TYPES.ITypeHintProvider) protected typeHintProvider: ITypeHintProvider;
@@ -122,19 +57,17 @@ export class ApplyTypeHintsCommand extends FeedbackCommand {
     }
 
     execute(context: CommandExecutionContext): CommandReturn {
-        context.root.index.all()
-            .forEach(element => {
-                if (element instanceof SShapeElement || element instanceof SModelRoot) {
-                    this.applyShapeTypeHint(element);
-
-                } else if (element instanceof SEdge) {
-                    return this.applyEdgeTypeHint(element);
-                }
-            });
+        context.root.index.all().forEach(element => {
+            if (element instanceof SShapeElement || element instanceof SModelRoot) {
+                this.applyShapeTypeHint(element);
+            } else if (element instanceof SEdge) {
+                return this.applyEdgeTypeHint(element);
+            }
+        });
         return context.root;
     }
 
-    protected applyEdgeTypeHint(element: SModelElement) {
+    protected applyEdgeTypeHint(element: SModelElement): void {
         const hint = this.typeHintProvider.getEdgeTypeHint(element);
         if (hint && isModifiableFetureSet(element.features)) {
             addOrRemove(element.features, deletableFeature, hint.deletable);
@@ -143,7 +76,7 @@ export class ApplyTypeHintsCommand extends FeedbackCommand {
         }
     }
 
-    protected applyShapeTypeHint(element: SModelElement) {
+    protected applyShapeTypeHint(element: SModelElement): void {
         const hint = this.typeHintProvider.getShapeTypeHint(element);
         if (hint && isModifiableFetureSet(element.features)) {
             addOrRemove(element.features, deletableFeature, hint.deletable);
@@ -156,8 +89,8 @@ export class ApplyTypeHintsCommand extends FeedbackCommand {
             Object.assign(element, containable);
 
             addOrRemove(element.features, connectableFeature, true);
-            const validSourceEdges = this.typeHintProvider.getValidEdgeElementTypes(element, "source");
-            const validTargetEdges = this.typeHintProvider.getValidEdgeElementTypes(element, "target");
+            const validSourceEdges = this.typeHintProvider.getValidEdgeElementTypes(element, 'source');
+            const validTargetEdges = this.typeHintProvider.getValidEdgeElementTypes(element, 'target');
             const connectable = createConnectable(validSourceEdges, validTargetEdges);
             Object.assign(element, connectable);
         }
@@ -167,22 +100,18 @@ export class ApplyTypeHintsCommand extends FeedbackCommand {
 function createConnectable(validSourceEdges: string[], validTargetEdges: string[]): Connectable {
     return {
         canConnect: (routable, role) =>
-            role === "source" ?
-                validSourceEdges.includes(routable.type) :
-                validTargetEdges.includes(routable.type)
+            role === 'source' ? validSourceEdges.includes(routable.type) : validTargetEdges.includes(routable.type)
     };
 }
 
 function createContainable(hint: ShapeTypeHint): Containable {
     return {
-        isContainableElement: (element) =>
-            hint.containableElementTypeIds ?
-                hint.containableElementTypeIds.includes(getElementTypeId(element)) :
-                false
+        isContainableElement: element =>
+            hint.containableElementTypeIds ? hint.containableElementTypeIds.includes(getElementTypeId(element)) : false
     };
 }
 
-function addOrRemove(features: Set<symbol>, feature: symbol, add: boolean) {
+function addOrRemove(features: Set<symbol>, feature: symbol, add: boolean): void {
     if (add && !features.has(feature)) {
         features.add(feature);
     } else if (!add && features.has(feature)) {
@@ -197,17 +126,16 @@ function isModifiableFetureSet(featureSet?: FeatureSet): featureSet is FeatureSe
 export interface ITypeHintProvider {
     getShapeTypeHint(input: SModelElement | SModelElement | string): ShapeTypeHint | undefined;
     getEdgeTypeHint(input: SModelElement | SModelElement | string): EdgeTypeHint | undefined;
-    getValidEdgeElementTypes(input: SModelElement | SModelElement | string, role: "source" | "target"): string[];
+    getValidEdgeElementTypes(input: SModelElement | SModelElement | string, role: 'source' | 'target'): string[];
 }
 
 @injectable()
 export class TypeHintProvider implements IActionHandler, ITypeHintProvider {
-
     @inject(GLSP_TYPES.IFeedbackActionDispatcher)
     protected feedbackActionDispatcher: IFeedbackActionDispatcher;
 
-    protected shapeHints: Map<string, ShapeTypeHint> = new Map;
-    protected edgeHints: Map<string, EdgeTypeHint> = new Map;
+    protected shapeHints: Map<string, ShapeTypeHint> = new Map();
+    protected edgeHints: Map<string, EdgeTypeHint> = new Map();
 
     handle(action: Action): ICommand | Action | void {
         if (isSetTypeHintsAction(action)) {
@@ -217,26 +145,32 @@ export class TypeHintProvider implements IActionHandler, ITypeHintProvider {
         }
     }
 
-    getValidEdgeElementTypes(input: SModelElement | SModelElement | string, role: "source" | "target"): string[] {
+    getValidEdgeElementTypes(input: SModelElement | SModelElement | string, role: 'source' | 'target'): string[] {
         const elementTypeId = getElementTypeId(input);
-        if (role === "source") {
+        if (role === 'source') {
             return Array.from(
                 Array.from(this.edgeHints.values())
-                    .filter(hint => hint.sourceElementTypeIds.some(sourceElementTypeId => hasCompatibleType(elementTypeId, sourceElementTypeId)))
-                    .map(hint => hint.elementTypeId));
+                    .filter(hint =>
+                        hint.sourceElementTypeIds.some(sourceElementTypeId => hasCompatibleType(elementTypeId, sourceElementTypeId))
+                    )
+                    .map(hint => hint.elementTypeId)
+            );
         } else {
             return Array.from(
                 Array.from(this.edgeHints.values())
-                    .filter(hint => hint.targetElementTypeIds.some(targetElementTypeId => hasCompatibleType(elementTypeId, targetElementTypeId)))
-                    .map(hint => hint.elementTypeId));
+                    .filter(hint =>
+                        hint.targetElementTypeIds.some(targetElementTypeId => hasCompatibleType(elementTypeId, targetElementTypeId))
+                    )
+                    .map(hint => hint.elementTypeId)
+            );
         }
     }
 
-    getShapeTypeHint(input: SModelElement | SModelElement | string) {
+    getShapeTypeHint(input: SModelElement | SModelElement | string): ShapeTypeHint | undefined {
         return getTypeHint(input, this.shapeHints);
     }
 
-    getEdgeTypeHint(input: SModelElement | SModelElement | string) {
+    getEdgeTypeHint(input: SModelElement | SModelElement | string): EdgeTypeHint | undefined {
         return getTypeHint(input, this.edgeHints);
     }
 }
@@ -246,12 +180,11 @@ function getTypeHint<T extends TypeHint>(input: SModelElement | SModelElement |
     let hint = hints.get(type);
     // Check subtypes
     if (hint === undefined) {
-        const subtypes = type.split(":");
+        const subtypes = type.split(':');
         while (hint === undefined && subtypes.length > 0) {
             subtypes.pop();
-            hint = hints.get(subtypes.join(":"));
+            hint = hints.get(subtypes.join(':'));
         }
     }
     return hint;
 }
-

package/src/features/hover/di.config.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,7 +13,7 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { ContainerModule } from "inversify";
+import { ContainerModule } from 'inversify';
 import {
     CenterCommand,
     ClosePopupActionHandler,
@@ -28,11 +28,10 @@ import {
     SetPopupModelCommand,
     SetViewportCommand,
     TYPES
-} from "sprotty";
-import { PopupPositionUpdater } from "sprotty/lib/features/hover/popup-position-updater";
-
-import { FocusStateChangedAction } from "../../base/actions/focus-change-action";
-import { GlspHoverMouseListener } from "./hover";
+} from 'sprotty';
+import { PopupPositionUpdater } from 'sprotty/lib/features/hover/popup-position-updater';
+import { FocusStateChangedAction } from '../../base/actions/focus-change-action';
+import { GlspHoverMouseListener } from './hover';
 
 const glspHoverModule = new ContainerModule((bind, _unbind, isBound) => {
     bind(TYPES.PopupVNodePostprocessor).to(PopupPositionUpdater).inSingletonScope();

package/src/features/hover/hover.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,27 +13,22 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { injectable } from "inversify";
+import { Action, Bounds, RequestPopupModelAction, SetPopupModelAction } from '@eclipse-glsp/protocol';
+import { injectable } from 'inversify';
 import {
-    Action,
-    Bounds,
     EMPTY_ROOT,
     HoverMouseListener,
     PreRenderedElementSchema,
-    RequestPopupModelAction,
-    SetPopupModelAction,
     SIssueMarker,
     SIssueSeverity,
     SModelElement,
     SModelElementSchema,
     SModelRootSchema
-} from "sprotty";
-
-import { GIssueMarker } from "../validation/issue-marker";
+} from 'sprotty';
+import { GIssueMarker } from '../validation/issue-marker';
 
 @injectable()
 export class GlspHoverMouseListener extends HoverMouseListener {
-
     protected startMouseOverTimer(target: SModelElement, event: MouseEvent): Promise<Action> {
         this.stopMouseOverTimer();
         return new Promise(resolve => {
@@ -65,11 +60,11 @@ export class GlspHoverMouseListener extends HoverMouseListener {
 
     protected createMarkerIssuePopup(marker: GIssueMarker): SModelElementSchema {
         const message = this.createIssueMessage(marker);
-        return <PreRenderedElementSchema>{
+        return {
             type: 'pre-rendered',
             id: 'popup-title',
             code: `<div class="${getSeverity(marker)}"><div class="sprotty-popup-title">${message}</div></div>`
-        };
+        } as PreRenderedElementSchema;
     }
 
     protected createIssueMessage(marker: GIssueMarker): string {
@@ -84,10 +79,12 @@ export class GlspHoverMouseListener extends HoverMouseListener {
 export function getSeverity(marker: SIssueMarker): SIssueSeverity {
     let currentSeverity: SIssueSeverity = 'info';
     for (const severity of marker.issues.map(s => s.severity)) {
-        if (severity === 'error')
+        if (severity === 'error') {
             return severity;
-        if (severity === 'warning' && currentSeverity === 'info')
+        }
+        if (severity === 'warning' && currentSeverity === 'info') {
             currentSeverity = severity;
+        }
     }
     return currentSeverity;
 }

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

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 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,14 +13,40 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { ContainerModule } from "inversify";
-import { configureCommand } from "sprotty";
+import { ContainerModule, inject, injectable, multiInject, optional } from 'inversify';
+import { configureCommand, configureLayout, ILogger, LayoutRegistration, LayoutRegistry, TYPES } from 'sprotty';
+import { FreeFormLayouter } from './freeform-layout';
+import { AlignElementsCommand, ResizeElementsCommand } from './layout-commands';
+import { VBoxLayouterExt } from './vbox-layout';
 
-import { AlignElementsCommand, ResizeElementsCommand } from "./layout-commands";
-
-const layoutCommandsModule = new ContainerModule((bind, _unbind, isBound) => {
+const layoutCommandsModule = new ContainerModule((bind, _unbind, isBound, rebind) => {
     configureCommand({ bind, isBound }, ResizeElementsCommand);
     configureCommand({ bind, isBound }, AlignElementsCommand);
+
+    configureLayout({ bind, isBound }, VBoxLayouterExt.KIND, VBoxLayouterExt);
+    configureLayout({ bind, isBound }, FreeFormLayouter.KIND, FreeFormLayouter);
+
+    bind(OverridableLayoutRegistry).toSelf().inSingletonScope();
+    rebind(TYPES.LayoutRegistry).toService(OverridableLayoutRegistry);
 });
 
 export default layoutCommandsModule;
+
+@injectable()
+export class OverridableLayoutRegistry extends LayoutRegistry {
+    // ensure logger is already used in constructor as otherwise not usable
+    constructor(
+        @multiInject(TYPES.LayoutRegistration) @optional() layouts: LayoutRegistration[] = [],
+        @inject(TYPES.ILogger) logger: ILogger
+    ) {
+        super();
+        layouts.forEach(layout => {
+            if (this.hasKey(layout.layoutKind)) {
+                logger.warn('Layout kind is already defined and will be overridden: ', layout.layoutKind);
+                this.deregister(layout.layoutKind);
+            }
+            // allow overriding an existing layout kind
+            this.register(layout.layoutKind, layout.factory());
+        });
+    }
+}

package/src/features/layout/freeform-layout.ts

@@ -0,0 +1,133 @@
+/********************************************************************************
+ * 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 {
+    Bounds,
+    BoundsData,
+    Dimension,
+    isValidDimension,
+    LayoutContainer,
+    Point,
+    SChildElement,
+    SParentElement,
+    StatefulLayouter
+} from 'sprotty';
+import { AbstractLayout } from 'sprotty/lib/features/bounds/abstract-layout';
+import { AbstractLayoutOptions } from 'sprotty/lib/features/bounds/layout-options';
+
+/**
+ * Layouts children of a container with explit X/Y positions
+ */
+@injectable()
+export class FreeFormLayouter extends AbstractLayout<AbstractLayoutOptions> {
+    static KIND = 'freeform';
+
+    layout(container: SParentElement & LayoutContainer, layouter: StatefulLayouter): void {
+        const boundsData = layouter.getBoundsData(container);
+        const options = this.getLayoutOptions(container);
+        const childrenSize = this.getChildrenSize(container, options, layouter);
+
+        // The real size of the compartment will be determined by the parent node layout;
+        // we only need to compute the bounds required to layout the children.
+
+        const maxWidth = childrenSize.width > 0 ? childrenSize.width + options.paddingLeft + options.paddingRight : 0;
+        const maxHeight = childrenSize.height > 0 ? childrenSize.height + options.paddingTop + options.paddingBottom : 0;
+        if (maxWidth > 0 && maxHeight > 0) {
+            const offset = this.layoutChildren(container, layouter, options, maxWidth, maxHeight);
+            boundsData.bounds = this.getFinalContainerBounds(container, offset, options, maxWidth, maxHeight);
+            boundsData.boundsChanged = true;
+        } else {
+            boundsData.bounds = { x: boundsData.bounds!.x, y: boundsData.bounds!.y, width: 0, height: 0 };
+            boundsData.boundsChanged = true;
+        }
+    }
+
+    protected getChildrenSize(
+        container: SParentElement & LayoutContainer,
+        containerOptions: AbstractLayoutOptions,
+        layouter: StatefulLayouter
+    ): Dimension {
+        let maxX = 0;
+        let maxY = 0;
+        container.children.forEach(child => {
+            const bounds = layouter.getBoundsData(child).bounds;
+            if (bounds !== undefined && isValidDimension(bounds)) {
+                const childMaxX = bounds.x + bounds.width;
+                const childMaxY = bounds.y + bounds.height;
+                maxX = Math.max(maxX, childMaxX);
+                maxY = Math.max(maxY, childMaxY);
+            }
+        });
+        return {
+            width: maxX,
+            height: maxY
+        };
+    }
+
+    protected layoutChild(
+        child: SChildElement,
+        boundsData: BoundsData,
+        bounds: Bounds,
+        childOptions: AbstractLayoutOptions,
+        containerOptions: AbstractLayoutOptions,
+        currentOffset: Point,
+        maxWidth: number,
+        maxHeight: number
+    ): Point {
+        boundsData.bounds = {
+            x: (child as any).bounds.x,
+            y: (child as any).bounds.y,
+            width: bounds.width,
+            height: bounds.height
+        };
+        boundsData.boundsChanged = true;
+        return currentOffset;
+    }
+
+    protected getFinalContainerBounds(
+        container: SParentElement & LayoutContainer,
+        lastOffset: Point,
+        options: AbstractLayoutOptions,
+        maxWidth: number,
+        maxHeight: number
+    ): Bounds {
+        const result = {
+            x: container.bounds.x,
+            y: container.bounds.y,
+            width: Math.max(options.minWidth, maxWidth + options.paddingLeft + options.paddingRight),
+            height: Math.max(options.minHeight, maxHeight + options.paddingTop + options.paddingBottom)
+        };
+
+        return result;
+    }
+
+    protected getDefaultLayoutOptions(): AbstractLayoutOptions {
+        return {
+            resizeContainer: true,
+            paddingTop: 0,
+            paddingBottom: 0,
+            paddingLeft: 0,
+            paddingRight: 0,
+            paddingFactor: 1,
+            minWidth: 0,
+            minHeight: 0
+        };
+    }
+
+    protected spread(a: AbstractLayoutOptions, b: AbstractLayoutOptions): AbstractLayoutOptions {
+        return { ...a, ...b };
+    }
+}