@eclipse-glsp/graph 0.9.0-next.0193b16.17

package/src/gbutton.ts

@@ -0,0 +1,34 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { DefaultTypes } from '@eclipse-glsp/protocol';
+import { GModelElementConstructor } from './gmodel-element';
+import { GShapeElement, GShapeElementBuilder } from './gshape-element';
+
+export class GButton extends GShapeElement {
+    static builder<G extends GButton = GButton>(constructor?: GModelElementConstructor<G>): GButtonBuilder {
+        return new GButtonBuilder(constructor ?? GButton).type(DefaultTypes.BUTTON_EXPAND);
+    }
+
+    override type = DefaultTypes.BUTTON_EXPAND;
+    enabled = true;
+}
+
+export class GButtonBuilder<G extends GButton = GButton> extends GShapeElementBuilder<G> {
+    enabled(enabled: boolean): this {
+        this.proxy.enabled = enabled;
+        return this;
+    }
+}

package/src/gcompartment.ts

@@ -0,0 +1,47 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { Args, DefaultTypes, JsonPrimitive } from '@eclipse-glsp/protocol';
+import { GLayoutContainer, GLayoutContainerBuilder } from './glayout-container';
+import { GLayoutable, GLayoutableBuilder } from './glayoutable';
+import { GShapeElement, GShapeElementBuilder } from './gshape-element';
+
+export class GCompartment extends GShapeElement implements GLayoutContainer, GLayoutable {
+    static builder(): GCompartmentBuilder {
+        return new GCompartmentBuilder(GCompartment).type(DefaultTypes.COMPARTMENT);
+    }
+
+    override type = DefaultTypes.COMPARTMENT;
+    layout?: string;
+    override layoutOptions?: Args;
+    [GLayoutContainer] = true;
+    [GLayoutable] = true;
+}
+
+export class GCompartmentBuilder<G extends GCompartment = GCompartment> extends GShapeElementBuilder<G> {
+    layout(layout?: string): this {
+        return GLayoutContainerBuilder.layout(this, layout);
+    }
+
+    override addLayoutOption(key: string, value: JsonPrimitive): this {
+        return GLayoutableBuilder.addLayoutOption(this, key, value);
+    }
+
+    override addLayoutOptions(layoutOptions: Args): this;
+    override addLayoutOptions(layoutOptions: Map<string, JsonPrimitive>): this;
+    override addLayoutOptions(layoutOptions: Args | Map<string, JsonPrimitive>): this {
+        return GLayoutableBuilder.addLayoutOptions(this, layoutOptions);
+    }
+}

package/src/gedge-layoutable.ts

@@ -0,0 +1,45 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { GModelElement, GModelElementBuilder } from './gmodel-element';
+
+export type EdgeSide = 'left' | 'right' | 'top' | 'bottom' | 'on';
+
+export class EdgePlacement extends Object {
+    rotate: boolean;
+    side: EdgeSide;
+    position: number;
+    offset: number;
+}
+
+export const GEdgeLayoutable = Symbol('GEdgeLayoutable');
+
+export interface GEdgeLayoutable {
+    edgePlacement?: EdgePlacement;
+    [GEdgeLayoutable]: boolean;
+}
+
+export function isGEdgeLayoutable<G extends GModelElement>(element: G): element is G & GEdgeLayoutable {
+    return ((element as any)[GEdgeLayoutable] = true);
+}
+
+export type GEdgeLayoutableBuilder<G extends GModelElement = GModelElement> = GModelElementBuilder<G & GEdgeLayoutable>;
+
+export namespace GEdgeLayoutableBuilder {
+    export function edgePlacement<B extends GEdgeLayoutableBuilder>(builder: B, placement?: EdgePlacement): B {
+        builder['proxy'].edgePlacement = placement;
+        return builder;
+    }
+}

package/src/gedge.ts

@@ -0,0 +1,80 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { DefaultTypes, flatPush, MaybeArray, Point } from '@eclipse-glsp/protocol';
+import { GModelElement, GModelElementBuilder } from './gmodel-element';
+
+export class GEdge extends GModelElement {
+    static builder(): GEdgeBuilder {
+        return new GEdgeBuilder(GEdge).type(DefaultTypes.EDGE);
+    }
+
+    override type = DefaultTypes.EDGE;
+    routingPoints: Point[] = [];
+    sourceId: string;
+    targetId: string;
+    routerKind?: string;
+}
+
+export namespace GEdge {
+    export function is(object: unknown): object is GEdge {
+        return GEdge.is(object);
+    }
+}
+
+export class GEdgeBuilder<G extends GEdge = GEdge> extends GModelElementBuilder<G> {
+    source(source: GModelElement): this {
+        this.proxy.sourceId = source.id;
+        return this;
+    }
+
+    sourceId(sourceId: string): this {
+        this.proxy.sourceId = sourceId;
+        return this;
+    }
+
+    target(target: GModelElement): this {
+        this.proxy.targetId = target.id;
+        return this;
+    }
+
+    targetId(targetId: string): this {
+        this.proxy.targetId = targetId;
+        return this;
+    }
+
+    routerKind(routerKind: string): this {
+        this.proxy.routerKind = routerKind;
+        return this;
+    }
+
+    addRoutingPoint(x: number, y: number): this;
+    addRoutingPoint(point: Point): this;
+    addRoutingPoint(xOrPoint: Point | number, y?: number): this {
+        if (typeof xOrPoint === 'object') {
+            this.proxy.routingPoints.push(xOrPoint);
+        } else if (y) {
+            this.proxy.routingPoints.push({ x: xOrPoint, y });
+        }
+        return this;
+    }
+
+    addRoutingPoints(routingPoints: Point[]): this;
+    addRoutingPoints(...routingPoints: Point[]): this;
+    addRoutingPoints(...routingPoints: MaybeArray<Point>[]): this {
+        flatPush(this.proxy.routingPoints, routingPoints);
+        return this;
+    }
+}

package/src/ggraph.ts

@@ -0,0 +1,49 @@
+/********************************************************************************
+ * Copyright (c) 2022 StMicroelectronics.
+ *
+ * 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
+ ********************************************************************************/
+/**
+ * TS implementation of the GLSP graph definition
+ * (https://github.com/eclipse-glsp/glsp-server/tree/master/plugins/org.eclipse.glsp.graph/src-gen/org/eclipse/glsp/graph)
+ * Parts of the implementation is derived from Sprotty's SModel API
+ * (https://github.com/eclipse/sprotty/blob/master/packages/sprotty/src/base/model/smodel.ts)
+ */
+import { DefaultTypes as types, Dimension, Point } from '@eclipse-glsp/protocol';
+import { GBoundsAware, GBoundsAwareBuilder } from './gbound-aware';
+import { GModelRoot, GModelRootBuilder } from './gmodel-element';
+
+export class GGraph extends GModelRoot implements GBoundsAware {
+    static override builder(): GGraphBuilder {
+        return new GGraphBuilder(GGraph);
+    }
+
+    override type = types.GRAPH;
+    position: Point = Point.ORIGIN;
+    size?: Dimension;
+    [GBoundsAware] = true;
+}
+
+export class GGraphBuilder<G extends GGraph = GGraph> extends GModelRootBuilder<G> {
+    position(x: number, y: number): this;
+    position(position: Point): this;
+    position(positionOrX: Point | number, y?: number): this {
+        return GBoundsAwareBuilder.position(this, positionOrX, y);
+    }
+
+    size(width: number, height: number): this;
+    size(size: Dimension): this;
+    size(sizeOrWidth: Dimension | number, height?: number): this {
+        return GBoundsAwareBuilder.size(this, sizeOrWidth, height);
+    }
+}

package/src/gissue-marker.ts

@@ -0,0 +1,49 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { DefaultTypes, flatPush, MaybeArray } from '@eclipse-glsp/protocol';
+import { GShapeElement, GShapeElementBuilder } from './gshape-element';
+
+export type GIssueSeverity = 'error' | 'warning' | 'info';
+
+export class GIssue {
+    message: string;
+    severity: GIssueSeverity;
+}
+
+export class GIssueMarker extends GShapeElement {
+    override type = DefaultTypes.ISSUE_MARKER;
+    issues: GIssue[] = [];
+}
+
+export class GIssueMarkerBuilder<G extends GIssueMarker = GIssueMarker> extends GShapeElementBuilder<G> {
+    addIssue(issue: GIssue): this;
+    addIssue(message: string, severity: GIssueSeverity): this;
+    addIssue(issueOrMessage: GIssue | string, severity?: GIssueSeverity): this {
+        if (typeof issueOrMessage === 'object') {
+            this.proxy.issues.push(issueOrMessage);
+        } else if (severity) {
+            this.proxy.issues.push({ message: issueOrMessage, severity });
+        }
+        return this;
+    }
+
+    addIssues(issues: GIssue[]): this;
+    addIssues(...issues: GIssue[]): this;
+    addIssues(...issues: MaybeArray<GIssue>[]): this {
+        flatPush(this.proxy.issues, issues);
+        return this;
+    }
+}

package/src/glabel.ts

@@ -0,0 +1,50 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { DefaultTypes, Point } from '@eclipse-glsp/protocol';
+import { GAlignable, GAlignableBuilder } from './galignable';
+import { EdgePlacement, GEdgeLayoutable, GEdgeLayoutableBuilder } from './gedge-layoutable';
+import { GModelElementConstructor } from './gmodel-element';
+import { GShapeElement, GShapeElementBuilder } from './gshape-element';
+
+export class GLabel extends GShapeElement implements GAlignable, GEdgeLayoutable {
+    static builder<G extends GLabel = GLabel>(constructor?: GModelElementConstructor<G>): GLabelBuilder {
+        return new GLabelBuilder(constructor ?? GLabel).type(DefaultTypes.LABEL);
+    }
+
+    override type = DefaultTypes.LABEL;
+    text: string;
+    alignment: Point = Point.ORIGIN;
+    edgePlacement?: EdgePlacement;
+    [GAlignable] = true;
+    [GEdgeLayoutable] = true;
+}
+
+export class GLabelBuilder<G extends GLabel = GLabel> extends GShapeElementBuilder<G> {
+    alignment(x: number, y: number): this;
+    alignment(alignment: Point): this;
+    alignment(xOrAlign: number | Point, y?: number): this {
+        return GAlignableBuilder.alignment(this, xOrAlign, y);
+    }
+
+    text(text: string): this {
+        this.proxy.text = text;
+        return this;
+    }
+
+    edgePlacement(placement: EdgePlacement): this {
+        return GEdgeLayoutableBuilder.edgePlacement(this, placement);
+    }
+}

package/src/glayout-container.ts

@@ -0,0 +1,36 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { GModelElement, GModelElementBuilder } from './gmodel-element';
+
+export const GLayoutContainer = Symbol('GLayoutContainer');
+
+export interface GLayoutContainer {
+    layout?: string;
+    [GLayoutContainer]: boolean;
+}
+
+export function isGLayoutContainer<G extends GModelElement>(element: G): element is G & GLayoutContainer {
+    return ((element as any)[GLayoutContainer] = true);
+}
+
+export type GLayoutContainerBuilder = GModelElementBuilder<GModelElement & GLayoutContainer>;
+
+export namespace GLayoutContainerBuilder {
+    export function layout<B extends GLayoutContainerBuilder>(builder: B, newLayout?: string): B {
+        builder['proxy'].layout = newLayout;
+        return builder;
+    }
+}

package/src/glayoutable.ts

@@ -0,0 +1,57 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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 { Args, JsonPrimitive } from '@eclipse-glsp/protocol';
+import { GModelElement, GModelElementBuilder } from './gmodel-element';
+
+export const GLayoutable = Symbol('GLayoutable');
+
+export interface GLayoutable {
+    layoutOptions?: Args;
+    [GLayoutable]: boolean;
+}
+
+export function isGLayoutable<G extends GModelElement>(element: G): element is G & GLayoutable {
+    return ((element as any)[GLayoutable] = true);
+}
+
+export type GLayoutableBuilder = GModelElementBuilder<GModelElement & GLayoutable>;
+
+export namespace GLayoutableBuilder {
+    export function addLayoutOption<B extends GLayoutableBuilder>(builder: B, key: string, value: JsonPrimitive): B {
+        const proxy = builder['proxy'];
+        if (!proxy.layoutOptions) {
+            proxy.layoutOptions = {};
+        }
+        proxy.layoutOptions[key] = value;
+        return builder;
+    }
+
+    export function addLayoutOptions<B extends GLayoutableBuilder>(builder: B, layoutOptions: Args | Map<string, JsonPrimitive>): B {
+        const toAssign: Args = {};
+        const proxy = builder['proxy'];
+        if (layoutOptions instanceof Map) {
+            [...layoutOptions.keys()].forEach(key => (toAssign[key] = layoutOptions.get(key)!));
+        } else {
+            Object.keys(layoutOptions).forEach(key => (toAssign[key] = layoutOptions[key]));
+        }
+        if (proxy.layoutOptions) {
+            Object.assign(proxy.layoutOptions, toAssign);
+        } else {
+            proxy.layoutOptions = toAssign;
+        }
+        return builder;
+    }
+}

package/src/gmodel-element.spec.ts

@@ -0,0 +1,18 @@
+/********************************************************************************
+ * Copyright (c) 2022 STMicroelectronics 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
+ ********************************************************************************/
+describe('foo', () => {
+    // Test stub
+});