@eclipse-glsp/client 0.9.0-next.e4ef6900 → 0.9.0-next.f12e3d87

package/src/features/decoration/decoration-placer.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
@@ -14,20 +14,10 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 import { injectable } from 'inversify';
-import {
-    Decoration,
-    DecorationPlacer,
-    isSizeable,
-    ORIGIN_POINT,
-    Point,
-    SChildElement,
-    SModelElement,
-    SRoutableElement
-} from 'sprotty';
+import { Decoration, DecorationPlacer, isSizeable, ORIGIN_POINT, Point, SChildElement, SModelElement, SRoutableElement } from 'sprotty';
 
 @injectable()
 export class GlspDecorationPlacer extends DecorationPlacer {
-
     protected static readonly DECORATION_OFFSET: Point = { x: 12, y: 10 };
 
     protected getPosition(element: SModelElement & Decoration): Point {
@@ -42,5 +32,4 @@ export class GlspDecorationPlacer extends DecorationPlacer {
         }
         return ORIGIN_POINT;
     }
-
 }

package/src/features/edit-label/edit-label-validator.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
@@ -26,11 +26,7 @@ import {
 } from 'sprotty';
 
 import { GLSPActionDispatcher } from '../../base/action-dispatcher';
-import {
-    isSetEditValidationResultAction,
-    RequestEditValidationAction,
-    ValidationStatus
-} from '../../base/actions/edit-validation-actions';
+import { isSetEditValidationResultAction, RequestEditValidationAction, ValidationStatus } from '../../base/actions/edit-validation-actions';
 
 export namespace LabelEditValidation {
     export const CONTEXT_ID = 'label-edit';
@@ -55,7 +51,6 @@ export class ValidateLabelEditAction extends RequestEditValidationAction {
 
 @injectable()
 export class ServerEditLabelValidator implements IEditLabelValidator {
-
     @inject(TYPES.IActionDispatcher) protected actionDispatcher: GLSPActionDispatcher;
 
     validate(value: string, label: EditableLabel & SModelElement): Promise<EditLabelValidationResult> {
@@ -69,12 +64,10 @@ export class ServerEditLabelValidator implements IEditLabelValidator {
         }
         return { severity: 'ok' as Severity };
     }
-
 }
 
 @injectable()
 export class BalloonLabelValidationDecorator implements IEditLabelValidationDecorator {
-
     decorate(input: HTMLInputElement, result: EditLabelValidationResult): void {
         const containerElement = input.parentElement;
         if (!containerElement) {
@@ -86,9 +79,15 @@ export class BalloonLabelValidationDecorator implements IEditLabelValidationDeco
             containerElement.setAttribute('data-balloon-visible', 'true');
         }
         switch (result.severity) {
-            case 'ok': containerElement.classList.add('validation-ok'); break;
-            case 'warning': containerElement.classList.add('validation-warning'); break;
-            case 'error': containerElement.classList.add('validation-error'); break;
+            case 'ok':
+                containerElement.classList.add('validation-ok');
+                break;
+            case 'warning':
+                containerElement.classList.add('validation-warning');
+                break;
+            case 'error':
+                containerElement.classList.add('validation-error');
+                break;
         }
     }
 

package/src/features/hints/model.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
@@ -27,7 +27,7 @@ export function isContainable(element: SModelElement): element is SModelElement
 
 export const reparentFeature = Symbol('reparentFeature');
 
-export interface Reparentable extends SModelExtension { }
+export interface Reparentable extends SModelExtension {}
 
 export function isReparentable(element: SModelElement): element is SModelElement & Reparentable {
     return element.hasFeature(reparentFeature);

package/src/features/hints/request-type-hints-action.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
@@ -19,7 +19,7 @@ import { EdgeTypeHint, ShapeTypeHint } from './type-hints';
 
 export class RequestTypeHintsAction implements Action {
     static readonly KIND = 'requestTypeHints';
-    constructor(public readonly diagramType?: string, public readonly kind: string = RequestTypeHintsAction.KIND) { }
+    constructor(public readonly diagramType?: string, public readonly kind: string = RequestTypeHintsAction.KIND) {}
 }
 
 export class SetTypeHintsAction implements Action {
@@ -27,10 +27,15 @@ export class SetTypeHintsAction implements Action {
     constructor(
         public readonly shapeHints: ShapeTypeHint[],
         public readonly edgeHints: EdgeTypeHint[],
-        public readonly kind: string = SetTypeHintsAction.KIND) { }
+        public readonly kind: string = SetTypeHintsAction.KIND
+    ) {}
 }
 
 export function isSetTypeHintsAction(action: Action): action is SetTypeHintsAction {
-    return action !== undefined && (action.kind === SetTypeHintsAction.KIND)
-        && (action as SetTypeHintsAction).shapeHints !== undefined && (action as SetTypeHintsAction).edgeHints !== undefined;
+    return (
+        action !== undefined &&
+        action.kind === SetTypeHintsAction.KIND &&
+        (action as SetTypeHintsAction).shapeHints !== undefined &&
+        (action as SetTypeHintsAction).edgeHints !== undefined
+    );
 }

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
@@ -50,8 +50,8 @@ export abstract class TypeHint {
     readonly elementTypeId: string;
 
     /**
-    * Specifies whether the element can be relocated.
-    */
+     * Specifies whether the element can be relocated.
+     */
     readonly repositionable: boolean;
 
     /**
@@ -89,14 +89,13 @@ export class EdgeTypeHint extends TypeHint {
     readonly sourceElementTypeIds: string[];
 
     /**
-    * Allowed targe element types for this edge type
-    */
+     * 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);
@@ -111,7 +110,6 @@ export class ApplyTypeHintsAction implements Action {
 
 @injectable()
 export class ApplyTypeHintsCommand extends FeedbackCommand {
-
     public static KIND = 'applyTypeHints';
     public readonly priority = 10;
 
@@ -122,15 +120,13 @@ 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;
     }
 
@@ -167,18 +163,14 @@ 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
+            hint.containableElementTypeIds ? hint.containableElementTypeIds.includes(getElementTypeId(element)) : false
     };
 }
 
@@ -202,12 +194,11 @@ export interface ITypeHintProvider {
 
 @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)) {
@@ -222,13 +213,19 @@ export class TypeHintProvider implements IActionHandler, ITypeHintProvider {
         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)
+            );
         }
     }
 
@@ -254,4 +251,3 @@ function getTypeHint<T extends TypeHint>(input: SModelElement | SModelElement |
     }
     return hint;
 }
-

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
@@ -33,7 +33,6 @@ 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 => {

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,39 @@
  *
  * 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';
 
-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,132 @@
+/********************************************************************************
+ * 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 };
+    }
+
+}