Jep/utility

.vscode/launch.json

@@ -34,7 +34,7 @@
 				"webpack:///./~/*": "${workspaceFolder}/extension/node_modules/*",
 				"webpack://?:*/*": "${workspaceFolder}/extension/*"
 			},
-            "type": "pwa-node"
+            "type": "node"
         }
     ]
 }

extension/package.json

@@ -150,6 +150,11 @@
                 "command": "stpa.SBM.generation",
                 "title": "Generate Safe Behavioral Model (SBM)",
                 "category": "STPA SBM"
+            },
+            {
+                "command": "stpa.md.creation",
+                "title": "Create a Markdown file",
+                "category": "STPA PDF Creation"
             }
         ],
         "menus": {
@@ -201,6 +206,10 @@
                 {
                     "command": "stpa.SBM.generation",
                     "when": "editorLangId == 'stpa'"
+                },
+                {
+                    "command": "stpa.md.creation",
+                    "when": "editorLangId == 'stpa'"
                 }
             ],
             "editor/context": [
@@ -217,12 +226,17 @@
                 {
                     "submenu": "stpa.checks",
                     "when": "editorLangId == 'stpa'",
-                    "group": "checks"
+                    "group": "stpa"
                 },
                 {
                     "command": "stpa.SBM.generation",
                     "when": "editorLangId == 'stpa'",
-                    "group": "navigation"
+                    "group": "stpa"
+                },
+                {
+                    "command": "stpa.md.creation",
+                    "when": "editorLangId == 'stpa'",
+                    "group": "stpa"
                 }
             ],
             "stpa.checks": [
@@ -339,7 +353,8 @@
         "feather-icons": "^4.28.0",
         "sprotty-vscode-webview": "^0.5.0",
         "@kieler/table-webview": "^0.0.3",
-        "snabbdom": "^3.5.1"
+        "snabbdom": "^3.5.1",
+        "dayjs": "^1.11.8"
     },
     "devDependencies": {
         "@types/node": "^12.12.6",
@@ -365,7 +380,7 @@
         "langium:generate": "langium generate",
         "langium:watch": "langium generate --watch",
         "lint": "eslint .",
-        "build": "yarn run langium:generate && webpack --mode development --devtool eval-source-map",
+        "build": "yarn run langium:generate && webpack --mode development",
         "watch": "webpack --watch",
         "package": "vsce package --yarn -o pasta.vsix",
         "predistribute": "yarn run package",

extension/src-language-server/handler.ts

@@ -28,22 +28,27 @@ import { elementWithName } from "./stpa/utils";
  */
 export function addNotificationHandler(connection: Connection, shared: LangiumSprottySharedServices): void {
     // diagram
-    connection.onNotification('diagram/selected', (msg: {label: string, uri: string}) => {
+    connection.onNotification("diagram/selected", async (msg: { label: string; uri: string }) => {
         // get the current model
-        const model = getModel(msg.uri, shared);
+        const model = await getModel(msg.uri, shared);
 
         // determine the range in the editor of the component identified by "label"
         const range = getRangeOfNode(model, msg.label);
         if (range) {
             // notify extension to highlight the range in the editor
-            connection.sendNotification('editor/highlight', ({ startLine: range.start.line, startChar: range.start.character, endLine: range.end.line, endChar: range.end.character, uri: msg.uri }));
+            connection.sendNotification("editor/highlight", {
+                startLine: range.start.line,
+                startChar: range.start.character,
+                endLine: range.end.line,
+                endChar: range.end.character,
+                uri: msg.uri,
+            });
         } else {
             console.log("The selected UCA could not be found in the editor.");
         }
     });
 }
 
-
 /**
  * Determines the range of the component identified by {@code label} in the editor,
  * @param model The current STPA model.
@@ -52,16 +57,29 @@ export function addNotificationHandler(connection: Connection, shared: LangiumSp
  */
 function getRangeOfNode(model: Model, label: string): Range | undefined {
     let range: Range | undefined = undefined;
-    const elements: elementWithName[] = [...model.losses, ...model.hazards, ...model.hazards.flatMap(hazard => hazard.subComps), ...model.systemLevelConstraints, ...model.systemLevelConstraints.flatMap(constraint => constraint.subComps), ...model.responsibilities.flatMap(resp => resp.responsiblitiesForOneSystem),
-    ...model.allUCAs.flatMap(ucas => ucas.ucas), ...model.rules.flatMap(rule => rule.contexts), ...model.controllerConstraints, ...model.scenarios, ...model.safetyCons];
+    const elements: elementWithName[] = [
+        ...model.losses,
+        ...model.hazards,
+        ...model.hazards.flatMap((hazard) => hazard.subComponents),
+        ...model.systemLevelConstraints,
+        ...model.systemLevelConstraints.flatMap((constraint) => constraint.subComponents),
+        ...model.responsibilities.flatMap((resp) => resp.responsiblitiesForOneSystem),
+        ...model.allUCAs.flatMap((ucas) =>
+            ucas.providingUcas.concat(ucas.notProvidingUcas, ucas.wrongTimingUcas, ucas.continousUcas)
+        ),
+        ...model.rules.flatMap((rule) => rule.contexts),
+        ...model.controllerConstraints,
+        ...model.scenarios,
+        ...model.safetyCons,
+    ];
     if (model.controlStructure) {
         elements.push(...model.controlStructure.nodes);
     }
-    elements.forEach(component => {
+    elements.forEach((component) => {
         if (component.name === label) {
             range = component.$cstNode?.range;
             return;
         }
     });
     return range;
-}
+}

extension/src-language-server/stpa.langium

@@ -22,10 +22,10 @@ entry Model:
     ('Hazards' hazards+=Hazard*)?
     ('SystemConstraints' systemLevelConstraints+=SystemConstraint*)?
     ('ControlStructure' controlStructure=Graph)?
-    ('Responsibilities' responsibilities+=Resps*)?
+    ('Responsibilities' responsibilities+=SystemResponsibilities*)?
     (('UCAs' allUCAs+=ActionUCAs*) | ('Context-Table' rules+=Rule*))?
     ('DCAs' allDCAs+=DCARule*)?
-    ('ControllerConstraints' controllerConstraints+=ContConstraint*)?
+    ('ControllerConstraints' controllerConstraints+=ControllerConstraint*)?
     ('LossScenarios' scenarios+=LossScenario*)?
     ('SafetyRequirements' safetyCons+=SafetyConstraint*)?;
 
@@ -48,14 +48,14 @@ Loss:
 Hazard:
     name=SubID description=STRING 
     ('['refs+=[Loss] (',' refs+=[Loss])*']')?
-    ('{' (header=STRING? subComps+=Hazard+)*'}')?;
+    ('{' (header=STRING? subComponents+=Hazard+)*'}')?;
 
 SystemConstraint:
     name=SubID description=STRING 
     '[' 
     refs+=[Hazard:SubID] (',' refs+=[Hazard:SubID])*
     ']'
-    ('{' (header=STRING? subComps+=SystemConstraint+)*'}')?;
+    ('{' (header=STRING? subComponents+=SystemConstraint+)*'}')?;
 
 Graph:
     name=ID '{'(nodes+=Node /* | edges+=Edge */)*'}';
@@ -67,8 +67,8 @@ Node:
         ('processModel' '{'variables+=Variable*'}')?
         ('input' '[' inputs+=Command (',' inputs+=Command)* ']')?
         ('output' '[' outputs+=Command (',' outputs+=Command)* ']')?
-        ('controlActions' '{'actions+=VE*'}')?
-        ('feedback' '{'feedbacks+=VE*'}')?
+        ('controlActions' '{'actions+=VerticalEdge*'}')?
+        ('feedback' '{'feedbacks+=VerticalEdge*'}')?
     '}';
 
 /* Edge:
@@ -85,13 +85,13 @@ VariableValue:
         firstValue=(QualifiedName | INT | 'MIN' | 'true' | 'false') (',' secondValue=(QualifiedName | INT | 'MAX'))? 
     secondParenthesis=(']'|')'))?;
 
-VE:
+VerticalEdge:
     '[' comms+=Command (',' comms+=Command)* ']' '->' target=[Node];
 
 Command:
     name=ID label=STRING;
 
-Resps:
+SystemResponsibilities:
     system=[Node] '{'responsiblitiesForOneSystem+=Responsibility*'}';
 
 Responsibility:
@@ -102,10 +102,10 @@ Responsibility:
 ActionUCAs:
     system=[Node]'.'
     action=[Command] '{'
-        'notProviding' '{'ucas+=UCA*'}'
-        'providing' '{'ucas+=UCA*'}'
-        'tooEarly/Late' '{'ucas+=UCA*'}'
-        'stoppedTooSoon' '{'ucas+=UCA*'}'
+        'notProviding' '{'notProvidingUcas+=UCA*'}'
+        'providing' '{'providingUcas+=UCA*'}'
+        'tooEarly/Late' '{'wrongTimingUcas+=UCA*'}'
+        'stoppedTooSoon' '{'continousUcas+=UCA*'}'
     '}';
 
 UCA:
@@ -123,7 +123,7 @@ DCARule:
 DCAContext:
     name=ID '['vars+=[Variable] '=' values+=QualifiedName (',' vars+=[Variable] '=' values+=QualifiedName)*']';
 
-ContConstraint:
+ControllerConstraint:
     name=ID description=STRING '['refs+=[UCA] (',' refs+=[UCA])*']';
 
 LossScenario:

extension/src-language-server/stpa/ID-enforcer.ts

@@ -214,7 +214,7 @@ export class IDEnforcer {
         const hazards = collectElementsWithSubComps(model.hazards) as Hazard[];
         const sysCons = collectElementsWithSubComps(model.systemLevelConstraints) as SystemConstraint[];
         const responsibilities = model.responsibilities?.map(r => r.responsiblitiesForOneSystem).flat(1);
-        const ucas = model.allUCAs?.map(sysUCA => sysUCA.ucas).flat(1);
+        const ucas = model.allUCAs?.map(sysUCA => sysUCA.providingUcas.concat(sysUCA.notProvidingUcas, sysUCA.wrongTimingUcas, sysUCA.continousUcas)).flat(1);
         const contexts = model.rules?.map(rule => rule.contexts).flat(1);
         const scenarioHazards = model.scenarios.map(scenario => scenario.list);
         const scenarioUCAs = model.scenarios;
@@ -277,9 +277,9 @@ export class IDEnforcer {
                 edits = edits.concat(edit.changes[this.currentUri]);
             }
             // rename children
-            if ((isHazard(element) || isSystemConstraint(element)) && element.subComps.length !== 0) {
+            if ((isHazard(element) || isSystemConstraint(element)) && element.subComponents.length !== 0) {
                 let index = 1;
-                for (const child of element.subComps) {
+                for (const child of element.subComponents) {
                     edits = edits.concat(await this.renameID(child, prefix + counter + ".", index));
                     index++;
                 }
@@ -340,7 +340,7 @@ export class IDEnforcer {
             elements = model.responsibilities.flatMap(resp => resp.responsiblitiesForOneSystem);
             prefix = IDPrefix.Responsibility;
         } else if (offset < ucaConstraintOffset && offset > ucaOffset) {
-            elements = model.allUCAs.flatMap(uca => uca.ucas);
+            elements = model.allUCAs.flatMap(sysUCA => sysUCA.providingUcas.concat(sysUCA.notProvidingUcas, sysUCA.wrongTimingUcas, sysUCA.continousUcas));
             elements = elements.concat(model.rules.flatMap(rule => rule.contexts));
             prefix = IDPrefix.UCA;
             // rules must be handled separately since they are mixed with the UCAs
@@ -380,8 +380,8 @@ export class IDEnforcer {
         // check whether the children are affected
         // if the children are affected, it must be checked whether they have again affected children
         // otherwise the current elements are the affected ones
-        if (element.subComps.length !== 0 && element.subComps[0].$cstNode && element.subComps[0].$cstNode.offset <= offset) {
-            const modified = this.findAffectedSubComponents(element.subComps, element.name + ".", offset);
+        if (element.subComponents.length !== 0 && element.subComponents[0].$cstNode && element.subComponents[0].$cstNode.offset <= offset) {
+            const modified = this.findAffectedSubComponents(element.subComponents, element.name + ".", offset);
             elements = modified.elements;
             prefix = modified.prefix;
         }

extension/src-language-server/stpa/actions.ts

@@ -0,0 +1,81 @@
+/*
+ * KIELER - Kiel Integrated Environment for Layout Eclipse RichClient
+ *
+ * http://rtsys.informatik.uni-kiel.de/kieler
+ *
+ * Copyright 2023 by
+ * + Kiel University
+ *   + Department of Computer Science
+ *     + Real-Time and Embedded Systems Group
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+import { Action, JsonMap, RequestAction, generateRequestId, ResponseAction } from "sprotty-protocol";
+
+/** Send to server to generate SVGs for the STPA result report */
+export interface GenerateSVGsAction extends Action {
+    kind: typeof GenerateSVGsAction.KIND
+    uri: string
+    options?: JsonMap;
+}
+
+export namespace GenerateSVGsAction {
+    export const KIND = "generateSVGs";
+
+
+    export function create(
+        uri: string,
+        options?: JsonMap
+    ): GenerateSVGsAction {
+        return {
+            kind: KIND,
+            uri,
+            options
+        };
+    }
+
+    export function isThisAction(action: Action): action is GenerateSVGsAction {
+        return action.kind === GenerateSVGsAction.KIND;
+    }
+}
+
+/** Requests the current SVG from the client. */
+export interface RequestSvgAction extends RequestAction<SvgAction> {
+    kind: typeof RequestSvgAction.KIND
+}
+
+export namespace RequestSvgAction {
+    export const KIND = 'requestSvg';
+
+    export function create(): RequestSvgAction {
+        return {
+            kind: KIND,
+            requestId: generateRequestId()
+        };
+    }
+}
+
+/** Send from client to server containing the requested SVG and its width. */
+export interface SvgAction extends ResponseAction {
+    kind: typeof SvgAction.KIND;
+    svg: string
+    width: number
+    responseId: string
+}
+export namespace SvgAction {
+    export const KIND = 'svg';
+
+    export function create(svg: string, width: number, requestId: string): SvgAction {
+        return {
+            kind: KIND,
+            svg,
+            width,
+            responseId: requestId
+        };
+    }
+}