@eagleoutice/flowr 2.8.6 → 2.8.7

package/util/mermaid/cfg.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MermaidExitPointDefaultMarkStyle = exports.MermaidEntryPointDefaultMarkStyle = void 0;
 exports.cfgToMermaid = cfgToMermaid;
 exports.cfgToMermaidUrl = cfgToMermaidUrl;
 const mermaid_1 = require("./mermaid");
@@ -9,6 +10,8 @@ const reconstruct_1 = require("../../reconstruct/reconstruct");
 const auto_select_defaults_1 = require("../../reconstruct/auto-select/auto-select-defaults");
 const info_1 = require("./info");
 const collect_1 = require("../../r-bridge/lang-4.x/ast/model/collect");
+exports.MermaidEntryPointDefaultMarkStyle = 'stroke:cyan,stroke-width:6.5px;';
+exports.MermaidExitPointDefaultMarkStyle = 'stroke:green,stroke-width:6.5px;';
 function getLexeme(n) {
     return n ? n.info.fullLexeme ?? n.lexeme ?? '' : undefined;
 }
@@ -25,6 +28,18 @@ function cfgOfNode(vert, normalizedVertex, id, content, output) {
     return output;
 }
 const getDirRegex = /flowchart\s+([A-Za-z]+)/;
+function shouldIncludeNode(simplify, element, include) {
+    if (simplify) {
+        // Only basic blocks are shown, so include the BB, if at least one child is selected
+        return element.type == control_flow_graph_1.CfgVertexType.Block && element.elems.filter(elem => elem.type !== control_flow_graph_1.CfgVertexType.EndMarker).some(elem => include.has(elem.id));
+    }
+    else {
+        // Basic blocks and vertices are shown, include the BB, if all children are highlighted
+        return element.type == control_flow_graph_1.CfgVertexType.Block
+            ? element.elems.filter(elem => elem.type !== control_flow_graph_1.CfgVertexType.EndMarker).every(elem => include.has(elem.id))
+            : include.has(element.id);
+    }
+}
 /**
  * Convert the control flow graph to a mermaid string.
  * @param cfg              - The control flow graph to convert.
@@ -35,7 +50,8 @@ const getDirRegex = /flowchart\s+([A-Za-z]+)/;
  * @param includeOnlyIds   - If provided, only include the vertices with the given IDs.
  * @param mark             - If provided, mark the given vertices and edges.
  */
-function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify = false, markStyle = info_1.MermaidDefaultMarkStyle, includeOnlyIds, mark } = {}) {
+function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify = false, markStyle = info_1.MermaidDefaultMarkStyle, entryPointStyle = exports.MermaidEntryPointDefaultMarkStyle, exitPointStyle = exports.MermaidExitPointDefaultMarkStyle, includeOnlyIds, mark, includeBasicBlockLabel = true } = {}) {
+    const hasBbandSimplify = simplify && cfg.graph.mayHaveBasicBlocks();
     let output = prefix;
     if (includeOnlyIds) {
         const completed = new Set(includeOnlyIds);
@@ -59,6 +75,7 @@ function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify
         includeOnlyIds = completed;
     }
     const dirIs = getDirRegex.exec(prefix)?.at(1) ?? 'LR';
+    const diagramIncludedIds = new Set();
     for (const [id, vertex] of cfg.graph.vertices(false)) {
         const normalizedVertex = normalizedAst?.idMap.get(id);
         const content = getLexeme(normalizedVertex);
@@ -68,14 +85,22 @@ function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify
         }
         if (vertex.type === control_flow_graph_1.CfgVertexType.Block) {
             if (simplify) {
+                if (includeOnlyIds && !vertex.elems.some(elem => includeOnlyIds.has(elem.id))) {
+                    continue;
+                }
                 const ids = vertex.elems?.map(e => e.id) ?? [];
                 const reconstruct = (0, reconstruct_1.reconstructToCode)(normalizedAst, { nodes: new Set(ids) }, auto_select_defaults_1.doNotAutoSelect).code;
-                const name = `"\`Basic Block (${id})\n${(0, mermaid_1.escapeMarkdown)(reconstruct)}\`"`;
+                const name = `"\`${includeBasicBlockLabel ? `Basic Block (${id})\n` : ''}${(0, mermaid_1.escapeMarkdown)(reconstruct)}\`"`;
                 output += `    n${id}[[${name}]]\n`;
+                diagramIncludedIds.add(vertex.id);
             }
             else {
+                if (includeOnlyIds && !vertex.elems.some(elem => includeOnlyIds.has(elem.id))) {
+                    continue;
+                }
                 output += `    subgraph n${vertex.id} [Block ${normalizedVertex?.info.fullLexeme ?? id}]\n`;
                 output += `        direction ${dirIs}\n`;
+                diagramIncludedIds.add(vertex.id);
                 let last = undefined;
                 for (const element of vertex.elems ?? []) {
                     if (includeOnlyIds && !includeOnlyIds.has(element.id)) {
@@ -85,6 +110,7 @@ function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify
                     const childNormalizedVertex = normalizedAst?.idMap.get(element.id);
                     const childContent = getLexeme(childNormalizedVertex);
                     output = cfgOfNode(vertex, childNormalizedVertex, element.id, childContent, output);
+                    diagramIncludedIds.add(element.id);
                     // just to keep the order
                     if (last) {
                         output += `    ${last} -.-> n${element.id}\n`;
@@ -96,17 +122,18 @@ function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify
         }
         else if (!includeOnlyIds || includeOnlyIds.has(id)) {
             output = cfgOfNode(vertex, normalizedVertex, id, content, output);
+            diagramIncludedIds.add(vertex.id);
         }
         if (vertex.name === type_1.RType.ExpressionList && vertex.type === control_flow_graph_1.CfgVertexType.EndMarker) {
             output += '    end\n';
         }
     }
     for (const [from, targets] of cfg.graph.edges()) {
-        if (includeOnlyIds && !includeOnlyIds.has(from)) {
+        if (!diagramIncludedIds.has(from)) {
             continue;
         }
         for (const [to, edge] of targets) {
-            if (includeOnlyIds && !includeOnlyIds.has(to)) {
+            if (!diagramIncludedIds.has(to)) {
                 continue;
             }
             const edgeType = edge.label === 1 /* CfgEdgeType.Cd */ ? '-->' : '-.->';
@@ -115,18 +142,20 @@ function cfgToMermaid(cfg, normalizedAst, { prefix = 'flowchart BT\n', simplify
         }
     }
     for (const entryPoint of cfg.entryPoints) {
-        if (!includeOnlyIds || includeOnlyIds.has(entryPoint)) {
-            output += `    style n${entryPoint} stroke:cyan,stroke-width:6.5px;`;
+        if (diagramIncludedIds.has(entryPoint)) {
+            output += `    style n${entryPoint} ${entryPointStyle}`;
         }
     }
     for (const exitPoint of cfg.exitPoints) {
-        if (!includeOnlyIds || includeOnlyIds.has(exitPoint)) {
-            output += `    style n${exitPoint} stroke:green,stroke-width:6.5px;`;
+        if (diagramIncludedIds.has(exitPoint)) {
+            output += `    style n${exitPoint} ${exitPointStyle}`;
         }
     }
     if (mark) {
-        for (const id of mark.values()) {
-            output += `    style n${id} ${markStyle.vertex}`;
+        for (const [_, vertex] of cfg.graph.vertices(true)) {
+            if (shouldIncludeNode(hasBbandSimplify, vertex, mark)) {
+                output += `    style n${vertex.id} ${markStyle.vertex}`;
+            }
         }
     }
     return output;

package/util/mermaid/dfg.js

@@ -85,11 +85,11 @@ function printArg(arg) {
         return '[empty]';
     }
     else if ((0, graph_1.isNamedArgument)(arg)) {
-        const deps = arg.controlDependencies ? ', :may:' + arg.controlDependencies.map(c => c.id + (c.when ? '+' : '-')).join(',') : '';
+        const deps = arg.cds ? ', :may:' + arg.cds.map(c => c.id + (c.when ? '+' : '-')).join(',') : '';
         return `${arg.name} (${arg.nodeId}${deps})`;
     }
     else if ((0, graph_1.isPositionalArgument)(arg)) {
-        const deps = arg.controlDependencies ? ' (:may:' + arg.controlDependencies.map(c => c.id + (c.when ? '+' : '-')).join(',') + ')' : '';
+        const deps = arg.cds ? ' (:may:' + arg.cds.map(c => c.id + (c.when ? '+' : '-')).join(',') + ')' : '';
         return `${arg.nodeId}${deps}`;
     }
     else {
@@ -131,7 +131,7 @@ function mermaidNodeBrackets(tag) {
  * Prints an identifier definition in a human-readable format.
  */
 function printIdentifier(id) {
-    return `**${id.name}** (id: ${id.nodeId}, type: ${identifier_1.ReferenceTypeReverseMapping.get(id.type)},${id.controlDependencies ? ' cds: {' + id.controlDependencies.map(c => c.id + (c.when ? '+' : '-')).join(',') + '},' : ''} def. @${id.definedAt})`;
+    return `**${id.name}** (id: ${id.nodeId}, type: ${identifier_1.ReferenceTypeReverseMapping.get(id.type)},${id.cds ? ' cds: {' + id.cds.map(c => c.id + (c.when ? '+' : '-')).join(',') + '},' : ''} def. @${id.definedAt})`;
 }
 function printEnvironmentToLines(env) {
     if (env === undefined) {
@@ -166,7 +166,7 @@ function vertexToMermaid(info, mermaid, id, idPrefix, mark, includeOnlyIds) {
     }
     else {
         const escapedName = (0, mermaid_1.escapeMarkdown)(node ? `[${node.type}] ${lexeme}` : '??');
-        const deps = info.controlDependencies ? ', :may:' + info.controlDependencies.map(c => c.id + (c.when ? '+' : '-')).join(',') : '';
+        const deps = info.cds ? ', :may:' + info.cds.map(c => c.id + (c.when ? '+' : '-')).join(',') : '';
         const lnks = info.link?.origin ? ', :links:' + info.link.origin.join(',') : '';
         const n = node?.info.fullRange ?? node?.location ?? (node?.type === type_1.RType.ExpressionList ? node?.grouping?.[0].location : undefined);
         mermaid.nodeLines.push(`    ${idPrefix}${id}${open}"\`${escapedName}${escapedName.length > 10 ? '\n      ' : ' '}(${id}${deps}${lnks})\n      *${formatRange(n)}*${fCall ? displayFunctionArgMapping(info.args) : ''}\`"${close}`);
@@ -182,7 +182,7 @@ function vertexToMermaid(info, mermaid, id, idPrefix, mark, includeOnlyIds) {
         mermaid.nodeLines.push('   %% No edges found for ' + id);
         return;
     }
-    const artificialCdEdges = (info.controlDependencies ?? []).map(x => [x.id, { types: new Set([x.when ? 'CD-True' : 'CD-False']) }]);
+    const artificialCdEdges = (info.cds ?? []).map(x => [x.id, { types: new Set([x.when ? 'CD-True' : 'CD-False']) }]);
     // eslint-disable-next-line prefer-const
     for (let [target, edge] of [...edges[1], ...artificialCdEdges]) {
         if (includeOnlyIds && !includeOnlyIds.has(target)) {

package/util/simple-df/dfg-view.js

@@ -28,7 +28,7 @@ function makeFilter(options, idMap) {
         return {
             ...arg,
             environment: options.keepEnv ? arg.environment : undefined,
-            controlDependencies: options.keepCd ? arg.controlDependencies : undefined,
+            cds: options.keepCd ? arg.cds : undefined,
             functionInformation: options.compactFunctions ? arg.functionInformation : undefined
         };
     };

package/util/text/ansi.d.ts

@@ -41,6 +41,10 @@ export declare function italic(s: string, f?: OutputFormatter, options?: FormatO
  * This does not work if the {@link setFormatter|formatter} is void. Tries to format the text with an italic font shape.
  */
 export declare function bold(s: string, f?: OutputFormatter, options?: FormatOptions): string;
+/**
+ * This does not work if the {@link setFormatter|formatter} is void. Tries to format the text as informational message.
+ */
+export declare function ansiInfo(s: string, f?: OutputFormatter): string;
 export declare const escape = "\u001B[";
 export declare const ansiFormatter: {
     reset(): string;

package/util/text/ansi.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatter = exports.ansiFormatter = exports.escape = exports.markdownFormatter = exports.voidFormatter = exports.ColorEffect = void 0;
 exports.italic = italic;
 exports.bold = bold;
+exports.ansiInfo = ansiInfo;
 exports.setFormatter = setFormatter;
 // noinspection JSUnusedGlobalSymbols
 var ColorEffect;
@@ -63,6 +64,12 @@ function italic(s, f = exports.formatter, options) {
 function bold(s, f = exports.formatter, options) {
     return f.format(s, { style: 1 /* FontStyles.Bold */, ...options });
 }
+/**
+ * This does not work if the {@link setFormatter|formatter} is void. Tries to format the text as informational message.
+ */
+function ansiInfo(s, f = exports.formatter) {
+    return f.format(s, { color: 7 /* Colors.White */, effect: ColorEffect.Foreground, style: 3 /* FontStyles.Italic */ });
+}
 exports.escape = '\x1b[';
 const colorSuffix = 'm';
 exports.ansiFormatter = {

package/util/version.js

@@ -6,7 +6,7 @@ exports.printVersionInformation = printVersionInformation;
 const semver_1 = require("semver");
 const assert_1 = require("./assert");
 // this is automatically replaced with the current version by release-it
-const version = '2.8.6';
+const version = '2.8.7';
 /**
  * Retrieves the current flowR version as a new {@link SemVer} object.
  */