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

package/src/utils/gmodel-util.ts

@@ -0,0 +1,321 @@
+/********************************************************************************
+ * 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 {
+    BoundsAware,
+    distinctAdd,
+    EdgeRouterRegistry,
+    ElementAndBounds,
+    ElementAndRoutingPoints,
+    FluentIterable,
+    isBoundsAware,
+    isMoveable,
+    isSelectable,
+    isSelected,
+    ModelIndexImpl,
+    Point,
+    remove,
+    RoutedPoint,
+    Selectable,
+    GModelElement,
+    GRoutableElement,
+    GRoutingHandle,
+    TypeGuard,
+    GModelElementSchema
+} from '@eclipse-glsp/sprotty';
+
+/**
+ * Helper type to represent a filter predicate for {@link GModelElement}s. This is used to retrieve
+ * elements from the {@link ModelIndexImpl} that also conform to a second type `T`. Its mainly used for
+ * retrieving elements that also implement a certain model features (e.g. selectable)
+ */
+export type ModelFilterPredicate<T> = (modelElement: GModelElement) => modelElement is GModelElement & T;
+
+/**
+ * Retrieves all elements from the given {@link ModelIndexImpl} that match the given {@link ModelFilterPredicate}
+ * @param index The {@link ModelIndexImpl}.
+ * @param predicate The {@link ModelFilterPredicate} that should be used.
+ * @returns A {@link FluentIterable} of all indexed element that match the predicate
+ * (correctly casted to also include the additional type of the predicate).
+ */
+export function filter<T>(index: ModelIndexImpl, predicate: ModelFilterPredicate<T>): FluentIterable<GModelElement & T> {
+    return index.all().filter(predicate) as FluentIterable<GModelElement & T>;
+}
+
+/**
+ * Retrieves all elements from the given {@link ModelIndexImpl} that match the given {@link ModelFilterPredicate} and executes
+ * the given runnable for each element of the result set.
+ * @param index The {@link ModelIndexImpl}.
+ * @param predicate The {@link ModelFilterPredicate} that should be used.
+ * @param runnable The runnable that should be executed for each matching element.
+ */
+export function forEachElement<T>(
+    index: ModelIndexImpl,
+    predicate: ModelFilterPredicate<T>,
+    runnable: (modelElement: GModelElement & T) => void
+): void {
+    filter(index, predicate).forEach(runnable);
+}
+
+/**
+ * Retrieves an array of all elements that match the given {@link ModelFilterPredicate} from the given {@link ModelIndexImpl}.
+ * @param index The {@link ModelIndexImpl}.
+ * @param predicate The {@link ModelFilterPredicate} that should be used.
+ * @returns An array of all indexed element that match the predicate
+ * (correctly casted to also include the additional type of the predicate).
+ */
+export function getMatchingElements<T>(index: ModelIndexImpl, predicate: ModelFilterPredicate<T>): (GModelElement & T)[] {
+    return Array.from(filter(index, predicate));
+}
+
+/**
+ * Invokes the given model index to retrieve the corresponding model elements for the given set of ids. Ids that
+ * have no corresponding element in the index will be ignored.
+ * @param index THe model index.
+ * @param elementsIDs The element ids.
+ * @param guard Optional typeguard. If defined only elements that match the guard will be returned.
+ * @returns An array of the model elements that correspond to the given ids and filter predicate.
+ */
+export function getElements<S extends GModelElement>(index: ModelIndexImpl, elementsIDs: string[], guard?: TypeGuard<S>): S[] {
+    // Internal filter function that filters out undefined model elements and runs an optional typeguard check.
+    const filterFn = (element?: GModelElement): element is S => {
+        if (element !== undefined) {
+            return guard ? guard(element) : true;
+        }
+        return false;
+    };
+    return elementsIDs.map(id => index.getById(id)).filter(filterFn);
+}
+/**
+ * Retrieves the amount of currently selected elements in the given {@link ModelIndexImpl}.
+ * @param index The {@link ModelIndexImpl}.
+ * @returns The amount of selected elements.
+ */
+export function getSelectedElementCount(index: ModelIndexImpl): number {
+    let selected = 0;
+    forEachElement(index, isSelected, element => selected++);
+    return selected;
+}
+
+/**
+ * Helper function to check wether an any element is selected in the given {@link ModelIndexImpl}.
+ * @param index The {@link ModelIndexImpl}.
+ * @returns `true` if at least one element is selected, `false` otherwise.
+ */
+export function hasSelectedElements(index: ModelIndexImpl): boolean {
+    return getSelectedElementCount(index) > 0;
+}
+
+/**
+ * Helper function to check wether an element is defined. Can be used as {@link ModelFilterPredicate}.
+ * @param element The element that should be checked.
+ * @returns the type predicate for `T`
+ */
+export function isNotUndefined<T>(element: T | undefined): element is T {
+    return element !== undefined;
+}
+
+/**
+ * Adds a set of css classes to the given {@link GModelElement}.
+ * @param element The element to which the css classes should be added.
+ * @param cssClasses The set of css classes as string array.
+ */
+export function addCssClasses(element: GModelElement, cssClasses: string[]): void {
+    const elementCssClasses: string[] = element.cssClasses ?? [];
+    distinctAdd(elementCssClasses, ...cssClasses);
+    element.cssClasses = elementCssClasses;
+}
+
+/**
+ * Removes a set of css classes from the given {@link GModelElement}.
+ * @param element The element from which the css classes should be removed.
+ * @param cssClasses The set of css classes as string array.
+ */
+export function removeCssClasses(root: GModelElement, cssClasses: string[]): void {
+    if (!root.cssClasses || root.cssClasses.length === 0) {
+        return;
+    }
+    remove(root.cssClasses, ...cssClasses);
+}
+
+export function isNonRoutableSelectedMovableBoundsAware(element: GModelElement): element is SelectableBoundsAware {
+    return isNonRoutableSelectedBoundsAware(element) && isMoveable(element);
+}
+
+/**
+ * A typeguard function to check wether a given {@link GModelElement} implements the {@link BoundsAware} model feature,
+ * the {@link Selectable} model feature and is actually selected. In addition, the element must not be a {@link GRoutableElement}.
+ * @param element The element to check.
+ * @returns A type predicate indicating wether the element is of type {@link SelectableBoundsAware}.
+ */
+export function isNonRoutableSelectedBoundsAware(element: GModelElement): element is SelectableBoundsAware {
+    return isBoundsAware(element) && isSelected(element) && !isRoutable(element);
+}
+
+/**
+ * A type guard function to check wether a given {@link GModelElement} is a {@link GRoutableElement}.
+ * @param element The element to check.
+ * @returns A type predicate indicating wether the element is a {@link GRoutableElement}.
+ */
+export function isRoutable<T extends GModelElement>(element: T): element is T & GRoutableElement {
+    return element instanceof GRoutableElement && (element as any).routingPoints !== undefined;
+}
+
+/**
+ * A typeguard function to check wether a given {@link GModelElement} is a {@link SRoutingHandle}.
+ * @param element The element to check.
+ * @returns A type predicate indicating wether the element is a {@link SRoutingHandle}
+ */
+export function isRoutingHandle(element: GModelElement | undefined): element is GRoutingHandle {
+    return element !== undefined && element instanceof GRoutingHandle;
+}
+
+/**
+ * A typeguard function to check wether a given {@link GModelElement} implements the {@link Selectable} model feature and
+ * the {@link BoundsAware} model feature.
+ * @returns A type predicate indicating wether the element is of type {@link SelectableBoundsAware}.
+ */
+export function isSelectableAndBoundsAware(element: GModelElement): element is SelectableBoundsAware {
+    return isSelectable(element) && isBoundsAware(element);
+}
+
+/**
+ * Union type to describe {@link GModelElement}s that implement the {@link Selectable} and {@link BoundsAware} feature.
+ */
+export type SelectableBoundsAware = GModelElement & BoundsAware & Selectable;
+
+/**
+ * Union type to describe {@link GModelElement}s that implement the {@link BoundsAware} feature.
+ */
+export type BoundsAwareModelElement = GModelElement & BoundsAware;
+
+/**
+ * Helper function to translate a given {@link GModelElement} into its corresponding {@link ElementAndBounds} representation.
+ * @param element The element to translate.
+ * @returns The corresponding {@link ElementAndBounds} for the given element.
+ */
+export function toElementAndBounds(element: BoundsAwareModelElement): ElementAndBounds {
+    return {
+        elementId: element.id,
+        newPosition: {
+            x: element.bounds.x,
+            y: element.bounds.y
+        },
+        newSize: {
+            width: element.bounds.width,
+            height: element.bounds.height
+        }
+    };
+}
+
+/**
+ * Helper function to translate a given {@link GRoutableElement} into its corresponding
+ * {@link ElementAndRoutingPoints} representation.
+ * @param element The element to translate.
+ * @returns The corresponding {@link ElementAndRoutingPoints} for the given element.
+ */
+export function toElementAndRoutingPoints(element: GRoutableElement): ElementAndRoutingPoints {
+    return {
+        elementId: element.id,
+        newRoutingPoints: element.routingPoints
+    };
+}
+/** All routing points. */
+export const ALL_ROUTING_POINTS = undefined;
+
+/** Pure routing point data kinds. */
+export const ROUTING_POINT_KINDS = ['linear', 'bezier-junction'];
+
+/** Pure route data kinds. */
+export const ROUTE_KINDS = [...ROUTING_POINT_KINDS, 'source', 'target'];
+
+/**
+ * Helper function to calculate the {@link ElementAndRoutingPoints} for a given {@link GRoutableElement}.
+ * If client layout is activated, i.e., the edge routing registry is given and has a router for the element, then the routing
+ * points from the calculated route are used, otherwise we use the already specified routing points of the {@link GRoutableElement}.
+ * @param element The element to translate.
+ * @param routerRegistry the edge router registry.
+ * @returns The corresponding {@link ElementAndRoutingPoints} for the given element.
+ */
+export function calcElementAndRoutingPoints(element: GRoutableElement, routerRegistry?: EdgeRouterRegistry): ElementAndRoutingPoints {
+    const newRoutingPoints = routerRegistry ? calcRoute(element, routerRegistry, ROUTING_POINT_KINDS) : element.routingPoints;
+    return { elementId: element.id, newRoutingPoints };
+}
+
+/**
+ * Helper function to calculate the route for a given {@link GRoutableElement}.
+ * If client layout is activated, i.e., the edge routing registry is given and has a router for the element, then the points
+ * from the calculated route are used, otherwise we use the already specified routing points of the {@link GRoutableElement}.
+ * @param element The element to translate.
+ * @param routerRegistry the edge router registry.
+ * @returns The corresponding route for the given element.
+ */
+export function calcElementAndRoute(element: GRoutableElement, routerRegistry?: EdgeRouterRegistry): ElementAndRoutingPoints {
+    let route: Point[] | undefined = routerRegistry ? calcRoute(element, routerRegistry, ROUTE_KINDS) : undefined;
+    if (!route) {
+        // add source and target to the routing points
+        route = [...element.routingPoints];
+        route.splice(0, 0, element.source?.position || Point.ORIGIN);
+        route.push(element.target?.position || Point.ORIGIN);
+    }
+    return { elementId: element.id, newRoutingPoints: route };
+}
+
+/**
+ * Helper function to calculate the route for a given {@link GRoutableElement} by filtering duplicate points.
+ * @param element The element to translate.
+ * @param routerRegistry the edge router registry.
+ * @param pointKinds the routing point kinds that should be considered.
+ * @param tolerance the tolerance applied to a point's coordinates to determine duplicates.
+ * @returns The corresponding route for the given element.
+ */
+export function calcRoute(
+    element: GRoutableElement,
+    routerRegistry: EdgeRouterRegistry,
+    pointKinds: string[] | undefined = ALL_ROUTING_POINTS,
+    tolerance = Number.EPSILON
+): RoutedPoint[] | undefined {
+    const route = routerRegistry.get(element.routerKind).route(element);
+    const calculatedRoute: RoutedPoint[] = [];
+    for (const point of route) {
+        // only include points we are actually interested in
+        if (pointKinds && !pointKinds.includes(point.kind)) {
+            continue;
+        }
+        // check if we are a duplicate based on coordinates in the already calculated route
+        if (
+            ROUTING_POINT_KINDS.includes(point.kind) &&
+            calculatedRoute.find(calculatedPoint => Point.maxDistance(point, calculatedPoint) < tolerance)
+        ) {
+            continue;
+        }
+        calculatedRoute.push(point);
+    }
+    return calculatedRoute;
+}
+
+/**
+ * Convenience function to retrieve the model element type from a given input. The input
+ * can either be a {@link GModelElement}, {@link GModelElementSchema} or a string.
+ * @param input The type input.
+ * @returns The corresponding model type as string.
+ */
+export function getElementTypeId(input: GModelElement | GModelElementSchema | string): string {
+    if (typeof input === 'string') {
+        return input;
+    } else {
+        return input.type;
+    }
+}

package/src/utils/html-utils.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019 EclipseSource and others.
+ * Copyright (c) 2019-2020 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

package/src/utils/layout-utils.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2022 EclipseSource and others.
+ * 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
@@ -13,11 +13,19 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Dimension, ElementAndBounds, Point, Writable } from '@eclipse-glsp/protocol';
-import { BoundsAware, ElementMove, ModelLayoutOptions, SModelElement } from 'sprotty';
+import {
+    BoundsAware,
+    Dimension,
+    ElementAndBounds,
+    ElementMove,
+    ModelLayoutOptions,
+    Point,
+    GModelElement,
+    Writable
+} from '@eclipse-glsp/sprotty';
 import { IMovementRestrictor } from '../features/change-bounds/movement-restrictor';
 
-export function minWidth(element: SModelElement & BoundsAware): number {
+export function minWidth(element: GModelElement & BoundsAware): number {
     const layoutOptions = getLayoutOptions(element);
     if (layoutOptions !== undefined && typeof layoutOptions.minWidth === 'number') {
         return layoutOptions.minWidth;
@@ -25,7 +33,7 @@ export function minWidth(element: SModelElement & BoundsAware): number {
     return 1;
 }
 
-export function minHeight(element: SModelElement & BoundsAware): number {
+export function minHeight(element: GModelElement & BoundsAware): number {
     const layoutOptions = getLayoutOptions(element);
     if (layoutOptions !== undefined && typeof layoutOptions.minHeight === 'number') {
         return layoutOptions.minHeight;
@@ -33,7 +41,7 @@ export function minHeight(element: SModelElement & BoundsAware): number {
     return 1;
 }
 
-export function getLayoutOptions(element: SModelElement): ModelLayoutOptions | undefined {
+export function getLayoutOptions(element: GModelElement): ModelLayoutOptions | undefined {
     const layoutOptions = (element as any).layoutOptions;
     if (layoutOptions !== undefined) {
         return layoutOptions as ModelLayoutOptions;
@@ -41,11 +49,11 @@ export function getLayoutOptions(element: SModelElement): ModelLayoutOptions | u
     return undefined;
 }
 
-export function isValidSize(element: SModelElement & BoundsAware, size: Dimension): boolean {
+export function isValidSize(element: GModelElement & BoundsAware, size: Dimension): boolean {
     return size.width >= minWidth(element) && size.height >= minHeight(element);
 }
 
-export function isValidMove(element: SModelElement & BoundsAware, newPosition?: Point, movementRestrictor?: IMovementRestrictor): boolean {
+export function isValidMove(element: GModelElement & BoundsAware, newPosition?: Point, movementRestrictor?: IMovementRestrictor): boolean {
     if (movementRestrictor) {
         return movementRestrictor.validate(element, newPosition);
     }
@@ -53,7 +61,7 @@ export function isValidMove(element: SModelElement & BoundsAware, newPosition?:
 }
 
 export function toValidElementMove(
-    element: SModelElement & BoundsAware,
+    element: GModelElement & BoundsAware,
     move: ElementMove,
     movementRestrictor?: IMovementRestrictor
 ): ElementMove | undefined {
@@ -64,7 +72,7 @@ export function toValidElementMove(
 }
 
 export function toValidElementAndBounds(
-    element: SModelElement & BoundsAware,
+    element: GModelElement & BoundsAware,
     bounds: Writable<ElementAndBounds>,
     movementRestrictor?: IMovementRestrictor
 ): ElementAndBounds | undefined {

package/src/utils/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,24 +13,24 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { MarkerKind } from '@eclipse-glsp/protocol';
-import { SIssueMarker, SParentElement } from 'sprotty';
+import { GParentElement, MarkerKind } from '@eclipse-glsp/sprotty';
+import { GIssueMarker } from '../features/validation/issue-marker';
 
 export namespace MarkerPredicates {
     export const ALL = (): boolean => true;
-    export const ERRORS = (marker: SIssueMarker): boolean => hasIssueWithSeverity(marker, MarkerKind.ERROR);
-    export const WARNINGS = (marker: SIssueMarker): boolean => hasIssueWithSeverity(marker, MarkerKind.WARNING);
-    export const INFOS = (marker: SIssueMarker): boolean => hasIssueWithSeverity(marker, MarkerKind.INFO);
+    export const ERRORS = (marker: GIssueMarker): boolean => hasIssueWithSeverity(marker, MarkerKind.ERROR);
+    export const WARNINGS = (marker: GIssueMarker): boolean => hasIssueWithSeverity(marker, MarkerKind.WARNING);
+    export const INFOS = (marker: GIssueMarker): boolean => hasIssueWithSeverity(marker, MarkerKind.INFO);
 
-    export function hasIssueWithSeverity(marker: SIssueMarker, severity: 'info' | 'warning' | 'error'): boolean {
+    export function hasIssueWithSeverity(marker: GIssueMarker, severity: 'info' | 'warning' | 'error'): boolean {
         return marker.issues.find(issue => issue.severity === severity) !== undefined;
     }
 }
 
-export function collectIssueMarkers(root: SParentElement): SIssueMarker[] {
+export function collectIssueMarkers(root: GParentElement): GIssueMarker[] {
     const markers = [];
     for (const child of root.children) {
-        if (child instanceof SIssueMarker) {
+        if (child instanceof GIssueMarker) {
             markers.push(child);
         }
         markers.push(...collectIssueMarkers(child));

package/src/utils/viewpoint-util.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2019-2022 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
@@ -14,8 +14,21 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { Bounds, Dimension, Point, Viewport } from '@eclipse-glsp/protocol';
-import { BoundsAware, findParentByFeature, isAlignable, isViewport, SModelElement, translateBounds } from 'sprotty';
+import {
+    Bounds,
+    BoundsAware,
+    Dimension,
+    GChildElement,
+    Point,
+    GModelElement,
+    Viewport,
+    findParentByFeature,
+    isAlignable,
+    isBoundsAware,
+    isViewport,
+    translateBounds
+} from '@eclipse-glsp/sprotty';
+import { BoundsAwareModelElement } from './gmodel-util';
 
 /**
  * Return the position corresponding to this mouse event (Browser coordinates)
@@ -30,9 +43,12 @@ import { BoundsAware, findParentByFeature, isAlignable, isViewport, SModelElemen
  * @param mouseEvent
  *  A mouseEvent
  */
-export function getAbsolutePosition(target: SModelElement, mouseEvent: MouseEvent): Point {
-    let xPos = mouseEvent.pageX;
-    let yPos = mouseEvent.pageY;
+export function getAbsolutePosition(target: GModelElement, mouseEvent: MouseEvent): Point {
+    return getAbsolutePositionByPoint(target, { x: mouseEvent.pageX, y: mouseEvent.pageY });
+}
+export function getAbsolutePositionByPoint(target: GModelElement, point: Point): Point {
+    let xPos = point.x;
+    let yPos = point.y;
     const canvasBounds = target.root.canvasBounds;
     xPos -= canvasBounds.x;
     yPos -= canvasBounds.y;
@@ -60,7 +76,7 @@ export function getAbsolutePosition(target: SModelElement, mouseEvent: MouseEven
  *
  * @param target  A bounds-aware element from the diagram
  */
-export function toAbsoluteBounds(element: SModelElement & BoundsAware): Bounds {
+export function toAbsoluteBounds(element: GModelElement & BoundsAware): Bounds {
     const location = isAlignable(element) ? element.alignment : Point.ORIGIN;
     const x = location.x;
     const y = location.y;
@@ -75,7 +91,7 @@ export function toAbsoluteBounds(element: SModelElement & BoundsAware): Bounds {
  *
  * @param target  A bounds-aware element from the diagram
  */
-export function toAbsolutePosition(target: SModelElement & BoundsAware): Point {
+export function toAbsolutePosition(target: GModelElement & BoundsAware): Point {
     return toAbsoluteBounds(target);
 }
 
@@ -85,6 +101,35 @@ export function toAbsolutePosition(target: SModelElement & BoundsAware): Point {
  *
  * @param target  A bounds-aware element from the diagram
  */
-export function toAbsoluteSize(target: SModelElement & BoundsAware): Dimension {
+export function toAbsoluteSize(target: GModelElement & BoundsAware): Dimension {
     return toAbsoluteBounds(target);
 }
+
+/**
+ * Convert a point, specified in absolute coordinates, to a point relative
+ * to the parent of the specified child element.
+ *
+ * @param element the child element
+ * @param absolutePoint a point in absolute coordinates
+ * @returns the equivalent point, relative to the element's parent coordinates
+ */
+export function absoluteToParent(element: BoundsAwareModelElement & GChildElement, absolutePoint: Point): Point {
+    if (isBoundsAware(element.parent)) {
+        return absoluteToLocal(element.parent, absolutePoint);
+    }
+    // If the parent is not bounds-aware, assume it's at 0; 0 and proceed
+    return absoluteToLocal(element, absolutePoint);
+}
+
+/**
+ * Convert a point, specified in absolute coordinates, to a point relative
+ * to the specified element.
+ *
+ * @param element the element
+ * @param absolutePoint a point in absolute coordinates
+ * @returns the equivalent point, relative to the element's coordinates
+ */
+export function absoluteToLocal(element: BoundsAwareModelElement, absolutePoint: Point): Point {
+    const absoluteElementBounds = toAbsoluteBounds(element);
+    return { x: absolutePoint.x - absoluteElementBounds.x, y: absolutePoint.y - absoluteElementBounds.y };
+}