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

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

@@ -0,0 +1,256 @@
+/********************************************************************************
+ * 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,
+    EMPTY_BOUNDS,
+    isBoundsAware,
+    isLayoutableChild,
+    isValidDimension,
+    LayoutContainer,
+    Point,
+    SChildElement,
+    SModelElement,
+    SParentElement,
+    StatefulLayouter,
+    VBoxLayouter,
+    VBoxLayoutOptions
+} from 'sprotty';
+
+export interface VBoxLayoutOptionsExt extends VBoxLayoutOptions {
+    hGrab: boolean;
+    vGrab: boolean;
+    prefWidth: number | null;
+    prefHeight: number | null;
+}
+
+/**
+ * Extends VBoxLayouter to support additional layout options
+ */
+@injectable()
+export class VBoxLayouterExt extends VBoxLayouter {
+    static KIND = VBoxLayouter.KIND;
+
+    layout(container: SParentElement & LayoutContainer, layouter: StatefulLayouter): void {
+        const boundsData = layouter.getBoundsData(container);
+        const options = this.getLayoutOptions(container);
+        const childrenSize = this.getChildrenSize(container, options, layouter);
+
+        const fixedSize = this.getFixedContainerBounds(container, options, layouter);
+
+        const maxWidth =
+            options.paddingFactor *
+            (options.resizeContainer
+                ? Math.max(fixedSize.width - options.paddingLeft - options.paddingRight, childrenSize.width)
+                : Math.max(0, fixedSize.width - options.paddingLeft - options.paddingRight));
+        const maxHeight =
+            options.paddingFactor *
+            (options.resizeContainer
+                ? Math.max(fixedSize.height - options.paddingTop - options.paddingBottom, childrenSize.height)
+                : Math.max(0, fixedSize.height - options.paddingTop - options.paddingBottom));
+
+        // Remaining size that can be grabbed by children with the vGrab option
+        const grabHeight: number = maxHeight - childrenSize.height;
+        // Number of children that request vGrab
+        // FIXME: This approach works fine when only 1 child uses VGrab, but may cause rounding issues
+        // when the grabHeight can't be equally shared by all children.
+        const grabbingChildren = container.children
+            .map(child => this.getChildLayoutOptions(child, options))
+            .filter(opt => opt.vGrab).length;
+
+        if (maxWidth > 0 && maxHeight > 0) {
+            const offset = this.layoutChildren(container, layouter, options, maxWidth, maxHeight, grabHeight, grabbingChildren);
+            boundsData.bounds = this.getFinalContainerBounds(container, offset, options, childrenSize.width, childrenSize.height);
+            boundsData.boundsChanged = true;
+        }
+    }
+
+    protected getChildrenSize(
+        container: SParentElement & LayoutContainer,
+        containerOptions: VBoxLayoutOptionsExt,
+        layouter: StatefulLayouter
+    ): Dimension {
+        let maxWidth = -1;
+        let maxHeight = 0;
+        let isFirst = true;
+        container.children.forEach(child => {
+            if (isLayoutableChild(child)) {
+                const bounds = layouter.getBoundsData(child).bounds;
+                if (bounds !== undefined && isValidDimension(bounds)) {
+                    maxHeight += bounds.height;
+                    if (isFirst) {
+                        isFirst = false;
+                    } else {
+                        maxHeight += containerOptions.vGap;
+                    }
+                    maxWidth = Math.max(maxWidth, bounds.width);
+                }
+            }
+        });
+        const result = {
+            width: maxWidth,
+            height: maxHeight
+        };
+        return result;
+    }
+
+    protected layoutChildren(
+        container: SParentElement & LayoutContainer,
+        layouter: StatefulLayouter,
+        containerOptions: VBoxLayoutOptionsExt,
+        maxWidth: number,
+        maxHeight: number,
+        grabHeight?: number,
+        grabbingChildren?: number
+    ): Point {
+        let currentOffset: Point = {
+            x: containerOptions.paddingLeft + 0.5 * (maxWidth - maxWidth / containerOptions.paddingFactor),
+            y: containerOptions.paddingTop + 0.5 * (maxHeight - maxHeight / containerOptions.paddingFactor)
+        };
+
+        container.children.forEach(child => {
+            if (isLayoutableChild(child)) {
+                const boundsData = layouter.getBoundsData(child);
+                const bounds = boundsData.bounds;
+                const childOptions = this.getChildLayoutOptions(child, containerOptions);
+                if (bounds !== undefined && isValidDimension(bounds)) {
+                    currentOffset = this.layoutChild(
+                        child,
+                        boundsData,
+                        bounds,
+                        childOptions,
+                        containerOptions,
+                        currentOffset,
+                        maxWidth,
+                        maxHeight,
+                        grabHeight,
+                        grabbingChildren
+                    );
+                }
+            }
+        });
+        return currentOffset;
+    }
+
+    protected layoutChild(
+        child: SChildElement,
+        boundsData: BoundsData,
+        bounds: Bounds,
+        childOptions: VBoxLayoutOptionsExt,
+        containerOptions: VBoxLayoutOptionsExt,
+        currentOffset: Point,
+        maxWidth: number,
+        maxHeight: number,
+        grabHeight?: number,
+        grabbingChildren?: number
+    ): Point {
+        let offset = super.layoutChild(child, boundsData, bounds, childOptions, containerOptions, currentOffset, maxWidth, maxHeight);
+        if (childOptions.hGrab) {
+            boundsData.bounds = {
+                x: boundsData.bounds!.x,
+                y: boundsData.bounds!.y,
+                width: maxWidth,
+                height: boundsData.bounds!.height
+            };
+            boundsData.boundsChanged = true;
+        }
+        if (childOptions.vGrab && grabHeight && grabbingChildren) {
+            const height = boundsData.bounds!.height + grabHeight / grabbingChildren;
+            boundsData.bounds = {
+                x: boundsData.bounds!.x,
+                y: boundsData.bounds!.y,
+                width: boundsData.bounds!.width,
+                height: height
+            };
+            boundsData.boundsChanged = true;
+            offset = { x: currentOffset.x, y: currentOffset.y + height };
+        }
+        return offset;
+    }
+
+    protected getFixedContainerBounds(container: SModelElement, layoutOptions: VBoxLayoutOptionsExt, layouter: StatefulLayouter): Bounds {
+        const currentContainer = container;
+        // eslint-disable-next-line no-constant-condition
+        if (isBoundsAware(currentContainer)) {
+            const bounds = currentContainer.bounds;
+            const elementOptions = this.getElementLayoutOptions(currentContainer);
+            const width = elementOptions?.prefWidth ?? 0;
+            const height = elementOptions?.prefHeight ?? 0;
+            return { ...bounds, width, height };
+        }
+        return EMPTY_BOUNDS;
+    }
+
+    protected getChildLayoutOptions(child: SChildElement, containerOptions: VBoxLayoutOptionsExt): VBoxLayoutOptionsExt {
+        return super.getChildLayoutOptions(child, containerOptions) as VBoxLayoutOptionsExt;
+    }
+
+    protected getLayoutOptions(element: SModelElement): VBoxLayoutOptionsExt {
+        return super.getLayoutOptions(element) as VBoxLayoutOptionsExt;
+    }
+
+    protected getElementLayoutOptions(element: SModelElement): VBoxLayoutOptionsExt | undefined {
+        return (element as any).layoutOptions;
+    }
+
+    protected getFinalContainerBounds(
+        container: SParentElement & LayoutContainer,
+        lastOffset: Point,
+        options: VBoxLayoutOptionsExt,
+        maxWidth: number,
+        maxHeight: number
+    ): Bounds {
+        const elementOptions = this.getElementLayoutOptions(container);
+        const width = elementOptions?.prefWidth ?? options.minWidth;
+        const height = elementOptions?.prefHeight ?? options.minHeight;
+
+        const result = {
+            x: container.bounds.x,
+            y: container.bounds.y,
+            width: Math.max(width, maxWidth + options.paddingLeft + options.paddingRight),
+            height: Math.max(height, maxHeight + options.paddingTop + options.paddingBottom)
+        };
+
+        return result;
+    }
+
+    protected getDefaultLayoutOptions(): VBoxLayoutOptionsExt {
+        return {
+            resizeContainer: true,
+            paddingTop: 5,
+            paddingBottom: 5,
+            paddingLeft: 5,
+            paddingRight: 5,
+            paddingFactor: 1,
+            vGap: 1,
+            hAlign: 'center',
+            minWidth: 0,
+            minHeight: 0,
+            hGrab: false,
+            vGrab: false,
+            // eslint-disable-next-line no-null/no-null
+            prefHeight: null,
+            // eslint-disable-next-line no-null/no-null
+            prefWidth: null
+        };
+    }
+
+    protected spread(a: VBoxLayoutOptionsExt, b: VBoxLayoutOptionsExt): VBoxLayoutOptionsExt {
+        return { ...a, ...b };
+    }
+}

package/src/features/model-source-watcher/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,11 +13,10 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { ContainerModule } from "inversify";
-import { configureActionHandler } from "sprotty/lib";
-
-import { ModelSourceChangedAction } from "./model-source-changed-action";
-import { ModelSourceChangedActionHandler } from "./model-source-changed-action-handler";
+import { ModelSourceChangedAction } from '@eclipse-glsp/protocol';
+import { ContainerModule } from 'inversify';
+import { configureActionHandler } from 'sprotty';
+import { ModelSourceChangedActionHandler } from './model-source-changed-action-handler';
 
 const modelSourceWatcherModule = new ContainerModule((bind, _unbind, isBound) => {
     configureActionHandler({ bind, isBound }, ModelSourceChangedAction.KIND, ModelSourceChangedActionHandler);

package/src/features/model-source-watcher/model-source-changed-action-handler.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,15 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { inject, injectable, optional } from "inversify";
-import { Action, IActionDispatcher, IActionHandler, TYPES, ViewerOptions } from "sprotty/lib";
-
-import { GLSPServerStatusAction, ServerMessageAction } from "../../model-source/glsp-server-status";
-import { isModelSourceChangedAction, ModelSourceChangedAction } from "./model-source-changed-action";
+import {
+    Action,
+    GLSPServerStatusAction,
+    isModelSourceChangedAction,
+    ModelSourceChangedAction,
+    ServerMessageAction
+} from '@eclipse-glsp/protocol';
+import { inject, injectable, optional } from 'inversify';
+import { IActionDispatcher, IActionHandler, TYPES, ViewerOptions } from 'sprotty';
 
 /**
  * An external handler of the model source change event.
@@ -36,17 +40,17 @@ export abstract class ExternalModelSourceChangedHandler {
 
 @injectable()
 export class ModelSourceChangedActionHandler implements IActionHandler {
-
     @inject(TYPES.IActionDispatcher)
     protected dispatcher: IActionDispatcher;
 
     @inject(TYPES.ViewerOptions)
     protected options: ViewerOptions;
 
-    @inject(ExternalModelSourceChangedHandler) @optional()
+    @inject(ExternalModelSourceChangedHandler)
+    @optional()
     protected externalModelSourceChangedHandler?: ExternalModelSourceChangedHandler;
 
-    handle(action: Action) {
+    handle(action: Action): void {
         if (isModelSourceChangedAction(action)) {
             if (this.externalModelSourceChangedHandler) {
                 this.externalModelSourceChangedHandler
@@ -58,13 +62,13 @@ export class ModelSourceChangedActionHandler implements IActionHandler {
         }
     }
 
-    protected showSimpleNotification(action: ModelSourceChangedAction) {
+    protected showSimpleNotification(action: ModelSourceChangedAction): void {
         const message = `The model source ${action.modelSourceName} has changed. You might want to consider reloading.`;
         const timeout = 0;
         const severity = 'WARNING';
         this.dispatcher.dispatchAll([
-            <GLSPServerStatusAction>{ kind: GLSPServerStatusAction.KIND, severity, timeout, message },
-            <ServerMessageAction>{ kind: ServerMessageAction.KIND, severity, timeout, message }
+            { kind: GLSPServerStatusAction.KIND, severity, timeout, message } as GLSPServerStatusAction,
+            { kind: ServerMessageAction.KIND, severity, timeout, message } as ServerMessageAction
         ]);
     }
 }

package/src/features/mouse-tool/di.config.ts

@@ -13,11 +13,11 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { ContainerModule } from "inversify";
-import { MouseTool } from "sprotty";
+import { ContainerModule } from 'inversify';
+import { MouseTool } from 'sprotty';
 
-import { GLSP_TYPES } from "../../base/types";
-import { RankingMouseTool } from "./mouse-tool";
+import { GLSP_TYPES } from '../../base/types';
+import { RankingMouseTool } from './mouse-tool';
 
 const glspMouseToolModule = new ContainerModule((bind, _unbind, _isBound, rebind) => {
     bind(RankingMouseTool).toSelf().inSingletonScope();

package/src/features/mouse-tool/mouse-tool.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,11 +13,11 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { injectable, multiInject, optional } from "inversify";
-import { VNode } from "snabbdom/vnode";
-import { Action, isAction, MouseListener, MouseTool, SModelElement, SModelRoot, TYPES } from "sprotty";
-
-import { getRank } from "../rank/model";
+import { Action, isAction } from '@eclipse-glsp/protocol';
+import { injectable, multiInject, optional } from 'inversify';
+import { On, VNode, VNodeData } from 'snabbdom';
+import { MouseListener, MouseTool, SModelElement, SModelRoot, TYPES } from 'sprotty';
+import { getRank } from '../rank/model';
 
 export interface IMouseTool {
     register(mouseListener: MouseListener): void;
@@ -33,39 +33,39 @@ export class RankingMouseTool extends MouseTool implements IMouseTool {
         this.rankedMouseListeners = groupBy(mouseListeners, listener => getRank(listener));
     }
 
-    register(mouseListener: MouseListener) {
+    register(mouseListener: MouseListener): void {
         super.register(mouseListener);
         this.rankedMouseListeners = groupBy(this.mouseListeners, listener => getRank(listener));
     }
 
-    deregister(mouseListener: MouseListener) {
+    deregister(mouseListener: MouseListener): void {
         super.deregister(mouseListener);
         this.rankedMouseListeners = groupBy(this.mouseListeners, listener => getRank(listener));
     }
 
-    decorate(vnode: VNode, element: SModelElement) {
+    decorate(vnode: VNode, element: SModelElement): VNode {
         // we need to overwrite the existing event handlers registered by the original mouse tool
         if (element instanceof SModelRoot) {
-            overwriteOn(vnode, 'mouseover', this.mouseOver.bind(this), element);
-            overwriteOn(vnode, 'mouseout', this.mouseOut.bind(this), element);
-            overwriteOn(vnode, 'mouseenter', this.mouseEnter.bind(this), element);
-            overwriteOn(vnode, 'mouseleave', this.mouseLeave.bind(this), element);
-            overwriteOn(vnode, 'mousedown', this.mouseDown.bind(this), element);
-            overwriteOn(vnode, 'mouseup', this.mouseUp.bind(this), element);
-            overwriteOn(vnode, 'mousemove', this.mouseMove.bind(this), element);
-            overwriteOn(vnode, 'wheel', this.wheel.bind(this), element);
-            overwriteOn(vnode, 'contextmenu', (_target: SModelElement, event: any) => {
-                event.preventDefault();
-            }, element);
-            overwriteOn(vnode, 'dblclick', this.doubleClick.bind(this), element);
+            overwriteOn(vnode, 'mouseover', this.mouseOver.bind(this, element), element);
+            overwriteOn(vnode, 'mouseout', this.mouseOut.bind(this, element), element);
+            overwriteOn(vnode, 'mouseenter', this.mouseEnter.bind(this, element), element);
+            overwriteOn(vnode, 'mouseleave', this.mouseLeave.bind(this, element), element);
+            overwriteOn(vnode, 'mousedown', this.mouseDown.bind(this, element), element);
+            overwriteOn(vnode, 'mouseup', this.mouseUp.bind(this, element), element);
+            overwriteOn(vnode, 'mousemove', this.mouseMove.bind(this, element), element);
+            overwriteOn(vnode, 'wheel', this.wheel.bind(this, element), element);
+            overwriteOn(vnode, 'contextmenu', this.contextMenu.bind(this, element), element);
+            overwriteOn(vnode, 'dblclick', this.doubleClick.bind(this, element), element);
         }
-        vnode = this.mouseListeners.reduce(
-            (n: VNode, listener: MouseListener) => listener.decorate(n, element),
-            vnode);
+        vnode = this.mouseListeners.reduce((n: VNode, listener: MouseListener) => listener.decorate(n, element), vnode);
         return vnode;
     }
 
-    protected handleEvent<K extends keyof MouseListener>(methodName: K, model: SModelRoot, event: MouseEvent) {
+    contextMenu(model: SModelRoot, event: MouseEvent): void {
+        event.preventDefault();
+    }
+
+    protected handleEvent<K extends keyof MouseListener>(methodName: K, model: SModelRoot, event: MouseEvent): void {
         this.focusOnMouseEvent(methodName, model);
         const element = this.getTargetElement(model, event);
         if (!element) {
@@ -74,13 +74,23 @@ export class RankingMouseTool extends MouseTool implements IMouseTool {
         this.notifyListenersByRank(element, methodName, model, event);
     }
 
-    async notifyListenersByRank<K extends keyof MouseListener>(element: SModelElement, methodName: K, model: SModelRoot, event: MouseEvent) {
+    async notifyListenersByRank<K extends keyof MouseListener>(
+        element: SModelElement,
+        methodName: K,
+        model: SModelRoot,
+        event: MouseEvent
+    ): Promise<void> {
         for (const rank of this.rankedMouseListeners) {
             await this.dispatchActions(rank[1], methodName, element, event);
         }
     }
 
-    async dispatchActions<K extends keyof MouseListener>(mouseListeners: MouseListener[], methodName: K, element: SModelElement, event: MouseEvent): Promise<void> {
+    async dispatchActions<K extends keyof MouseListener>(
+        mouseListeners: MouseListener[],
+        methodName: K,
+        element: SModelElement,
+        event: MouseEvent
+    ): Promise<void> {
         const actions = mouseListeners
             .map(listener => listener[methodName].apply(listener, [element, event]))
             .reduce((a, b) => a.concat(b));
@@ -115,21 +125,23 @@ function groupBy<K, T>(array: Array<T>, keyFunction: (x: T) => K): Map<K, T[]> {
     return new Map<K, T[]>([...unsortedMap.entries()].sort());
 }
 
-function overwriteOn(vnode: VNode, event: string, listener: (model: SModelElement, event: Event) => void, element: SModelElement) {
+function overwriteOn(vnode: VNode, event: string, listener: (model: SModelElement, _event: Event) => void, element: SModelElement): void {
     const val = getOn(vnode);
     // ignore any previous val[event] registrations
     (val as any)[event] = [listener, element];
 }
 
-function getOn(vnode: VNode) {
+function getOn(vnode: VNode): On {
     const data = getData(vnode);
-    if (!data.on)
+    if (!data.on) {
         data.on = {};
+    }
     return data.on;
 }
 
-function getData(vnode: VNode) {
-    if (!vnode.data)
+function getData(vnode: VNode): VNodeData {
+    if (!vnode.data) {
         vnode.data = {};
+    }
     return vnode.data;
 }

package/src/features/navigation/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,17 +13,11 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { ContainerModule } from "inversify";
-import { configureActionHandler } from "sprotty/lib";
-
-import {
-    NavigateAction,
-    NavigateToExternalTargetAction,
-    NavigateToTargetAction,
-    NavigationActionHandler,
-    ProcessNavigationArgumentsAction
-} from "./navigation-action-handler";
-import { NavigationTargetResolver } from "./navigation-target-resolver";
+import { NavigateToExternalTargetAction, NavigateToTargetAction } from '@eclipse-glsp/protocol';
+import { ContainerModule } from 'inversify';
+import { configureActionHandler } from 'sprotty';
+import { NavigateAction, NavigationActionHandler, ProcessNavigationArgumentsAction } from './navigation-action-handler';
+import { NavigationTargetResolver } from './navigation-target-resolver';
 
 export const navigationModule = new ContainerModule((bind, _unbind, isBound) => {
     bind(NavigationTargetResolver).toSelf().inSingletonScope();