@eagleoutice/flowr 2.0.25 → 2.1.0

package/util/arrays.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayEqual = exports.array2bag = exports.sum = exports.getUniqueCombinationsOfSize = exports.partition = exports.allPermutations = exports.partitionArray = exports.splitArrayOn = void 0;
+exports.splitArrayOn = splitArrayOn;
+exports.partitionArray = partitionArray;
+exports.allPermutations = allPermutations;
+exports.partition = partition;
+exports.getUniqueCombinationsOfSize = getUniqueCombinationsOfSize;
+exports.sum = sum;
+exports.array2bag = array2bag;
+exports.arrayEqual = arrayEqual;
 const assert_1 = require("./assert");
 /**
  * Splits the array every time the given predicate fires.
@@ -36,7 +43,6 @@ function splitArrayOn(arr, predicate) {
     }
     return result;
 }
-exports.splitArrayOn = splitArrayOn;
 /**
  * Returns a tuple of two arrays, where the first one contains all elements for which the predicate returned true,
  * and the second one contains all elements for which the predicate returned false.
@@ -54,7 +60,6 @@ function partitionArray(arr, predicate) {
     }
     return [left, right];
 }
-exports.partitionArray = partitionArray;
 /**
  * Generate all permutations of the given array using Heap's algorithm (with its non-recursive variant).
  *
@@ -82,7 +87,6 @@ function* allPermutations(arr) {
         }
     }
 }
-exports.allPermutations = allPermutations;
 function partition(arr, predicate) {
     const left = [];
     const right = [];
@@ -96,7 +100,6 @@ function partition(arr, predicate) {
     }
     return [left, right];
 }
-exports.partition = partition;
 /**
  * Generate all unique combinations of the array with the given size.
  * In other words, given `[a,b,c]`, as well as `minSize=2` and `maxSize=2`, this will generate `[a,b]`, `[a,c]` and `[b,c]`,
@@ -137,7 +140,6 @@ function* getUniqueCombinationsOfSize(array, minSize = 0, maxSize = array.length
     }
     yield* p([], 0, true);
 }
-exports.getUniqueCombinationsOfSize = getUniqueCombinationsOfSize;
 /**
  * Returns the sum of all elements in the given array
  */
@@ -148,7 +150,6 @@ function sum(arr) {
     }
     return sum;
 }
-exports.sum = sum;
 /**
  * Converts an array into a bag data-structure (in the form of a map mapping the entries/keys to their counts)
  */
@@ -159,7 +160,6 @@ function array2bag(arr) {
     }
     return result;
 }
-exports.array2bag = array2bag;
 function arrayEqual(a, b) {
     if (a === undefined || b === undefined) {
         return a === b;
@@ -174,5 +174,4 @@ function arrayEqual(a, b) {
     }
     return true;
 }
-exports.arrayEqual = arrayEqual;
 //# sourceMappingURL=arrays.js.map

package/util/assert.js

@@ -1,24 +1,24 @@
 "use strict";
 /** use this to ensure that all cases are covered in case of a selection */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.guard = exports.isNotNull = exports.isUndefined = exports.isNotUndefined = exports.assertUnreachable = void 0;
+exports.assertUnreachable = assertUnreachable;
+exports.isNotUndefined = isNotUndefined;
+exports.isUndefined = isUndefined;
+exports.isNotNull = isNotNull;
+exports.guard = guard;
 /* istanbul ignore next */
 function assertUnreachable(x) {
     throw new Error(`Unexpected object: ${JSON.stringify(x)}`);
 }
-exports.assertUnreachable = assertUnreachable;
 function isNotUndefined(x) {
     return x !== undefined;
 }
-exports.isNotUndefined = isNotUndefined;
 function isUndefined(x) {
     return x === undefined;
 }
-exports.isUndefined = isUndefined;
 function isNotNull(x) {
     return x !== null;
 }
-exports.isNotNull = isNotNull;
 class GuardError extends Error {
     constructor(message) {
         super(message);
@@ -35,5 +35,4 @@ function guard(assertion, message = 'Assertion failed') {
         throw new GuardError(typeof message === 'string' ? message : message());
     }
 }
-exports.guard = guard;
 //# sourceMappingURL=assert.js.map

package/util/bimap.d.ts

@@ -9,16 +9,16 @@ export declare class BiMap<K, V extends object> implements Map<K, V> {
     private readonly k2v;
     private v2k;
     constructor(base?: Iterable<[K, V]>);
-    [Symbol.iterator](): IterableIterator<[K, V]>;
+    [Symbol.iterator](): MapIterator<[K, V]>;
     clear(): void;
     delete(key: K): boolean;
-    entries(): IterableIterator<[K, V]>;
+    entries(): MapIterator<[K, V]>;
     forEach(callbackFunction: (value: V, key: K, map: Map<K, V>) => void): void;
     get(key: K): V | undefined;
     getKey(value: V): K | undefined;
     has(key: K): boolean;
     hasValue(value: V): boolean;
-    keys(): IterableIterator<K>;
+    keys(): MapIterator<K>;
     set(key: K, value: V): this;
-    values(): IterableIterator<V>;
+    values(): MapIterator<V>;
 }

package/util/cfg/cfg.d.ts

@@ -38,6 +38,7 @@ export declare class ControlFlowGraph {
     private edgeInformation;
     addVertex(vertex: CfgVertex, rootVertex?: boolean): this;
     addEdge(from: NodeId, to: NodeId, edge: CfgEdge): this;
+    outgoing(node: NodeId): ReadonlyMap<NodeId, CfgEdge> | undefined;
     rootVertexIds(): ReadonlySet<NodeId>;
     vertices(): ReadonlyMap<NodeId, CfgVertex>;
     edges(): ReadonlyMap<NodeId, ReadonlyMap<NodeId, CfgEdge>>;

package/util/cfg/cfg.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cfg2quads = exports.equalCfg = exports.extractCFG = exports.emptyControlFlowInformation = exports.ControlFlowGraph = void 0;
+exports.ControlFlowGraph = void 0;
+exports.emptyControlFlowInformation = emptyControlFlowInformation;
+exports.extractCFG = extractCFG;
+exports.equalCfg = equalCfg;
+exports.cfg2quads = cfg2quads;
 const set_1 = require("../set");
 const quads_1 = require("../quads");
 const log_1 = require("../log");
@@ -33,6 +37,9 @@ class ControlFlowGraph {
         this.edgeInformation.get(from)?.set(to, edge);
         return this;
     }
+    outgoing(node) {
+        return this.edgeInformation.get(node);
+    }
     rootVertexIds() {
         return this.rootVertices;
     }
@@ -65,7 +72,6 @@ function emptyControlFlowInformation() {
         graph: new ControlFlowGraph()
     };
 }
-exports.emptyControlFlowInformation = emptyControlFlowInformation;
 const cfgFolds = {
     foldNumber: cfgLeaf("expression" /* CfgVertexType.Expression */),
     foldString: cfgLeaf("expression" /* CfgVertexType.Expression */),
@@ -98,7 +104,6 @@ const cfgFolds = {
 function extractCFG(ast) {
     return (0, fold_1.foldAst)(ast.ast, cfgFolds);
 }
-exports.extractCFG = extractCFG;
 function cfgLeaf(type) {
     return (leaf) => {
         const graph = new ControlFlowGraph();
@@ -460,7 +465,6 @@ function equalCfg(a, b) {
     }
     return true;
 }
-exports.equalCfg = equalCfg;
 /**
  * @see df2quads
  * @see serialize2quads
@@ -488,5 +492,4 @@ function cfg2quads(cfg, config) {
         returns: cfg.returns
     }, config);
 }
-exports.cfg2quads = cfg2quads;
 //# sourceMappingURL=cfg.js.map

package/util/cfg/visitor.d.ts

@@ -1,14 +1,9 @@
-import type { CfgEdge, CfgVertex, ControlFlowInformation } from './cfg';
+import type { ControlFlowGraph } from './cfg';
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
-export interface NodeVisitingContext {
-    parent: {
-        vertex: NodeId;
-        edge: CfgEdge;
-    } | 'root';
-    cfg: ControlFlowInformation;
-    visited: Set<NodeId>;
-    /** contains the current vertex as well */
-    siblings: NodeId[];
-}
-export type OnEnterVisitNode = (node: CfgVertex, context: NodeVisitingContext) => void;
-export declare function visitCfg(cfg: ControlFlowInformation, onVisit: OnEnterVisitNode): void;
+/**
+ * Visit all nodes reachable from the start node in the control flow graph, traversing the dependencies but ignoring cycles.
+ * @param graph     - The control flow graph.
+ * @param startNode - The node to start the traversal from.
+ * @param visitor   - The visitor function to call for each node, if you return true the traversal from this node will be stopped.
+ */
+export declare function visitInReverseOrder(graph: ControlFlowGraph, startNode: NodeId, visitor: (node: NodeId) => boolean | void): void;

package/util/cfg/visitor.js

@@ -1,64 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.visitCfg = void 0;
-const assert_1 = require("../assert");
-class ControlFlowGraphExecutionTraceVisitor {
-    onEnter;
-    constructor(onEnter) {
-        this.onEnter = onEnter;
-    }
-    visitSingle(node, context) {
-        if (context.visited.has(node.id)) {
-            return;
-        }
-        // only visit a node if we have visited all of its successors
-        const successorEdges = context.cfg.graph.edges().get(node.id);
-        if (successorEdges) {
-            for (const [target,] of successorEdges) {
-                if (!context.visited.has(target)) {
-                    return;
-                }
-            }
-        }
-        context.visited.add(node.id);
-        this.onEnter(node, context);
-        // find all ingoing edges
-        const predecessors = this.retrieveAllPredecessors(context, node);
-        const siblings = predecessors.map(p => p.source);
-        for (const predecessor of predecessors) {
-            const { source, edge } = predecessor;
-            const sourceVertex = context.cfg.graph.vertices().get(source);
-            (0, assert_1.guard)(sourceVertex !== undefined, () => `Source vertex with id ${source} not found`);
-            this.visitSingle(sourceVertex, {
-                parent: { vertex: node.id, edge },
-                cfg: context.cfg,
-                visited: context.visited,
-                siblings
-            });
+exports.visitInReverseOrder = visitInReverseOrder;
+/**
+ * Visit all nodes reachable from the start node in the control flow graph, traversing the dependencies but ignoring cycles.
+ * @param graph     - The control flow graph.
+ * @param startNode - The node to start the traversal from.
+ * @param visitor   - The visitor function to call for each node, if you return true the traversal from this node will be stopped.
+ */
+function visitInReverseOrder(graph, startNode, 
+// eslint-disable-next-line @typescript-eslint/no-invalid-void-type -- void is used to indicate that the return value is ignored/we never stop
+visitor) {
+    const visited = new Set();
+    const queue = [startNode];
+    while (queue.length > 0) {
+        const current = queue.pop();
+        if (visited.has(current)) {
+            continue;
         }
-    }
-    retrieveAllPredecessors(context, node) {
-        const predecessors = [];
-        for (const entry of context.cfg.graph.edges().entries()) {
-            const [source, targets] = entry;
-            const target = targets.get(node.id);
-            if (target) {
-                predecessors.push({ source, edge: target });
-            }
+        visited.add(current);
+        if (visitor(current)) {
+            continue;
         }
-        return predecessors;
-    }
-    visit(cfg) {
-        const visited = new Set();
-        for (const id of cfg.entryPoints) {
-            const node = cfg.graph.vertices().get(id);
-            (0, assert_1.guard)(node !== undefined, `Node with id ${id} not present`);
-            this.visitSingle(node, { parent: 'root', cfg, siblings: [...cfg.entryPoints], visited });
+        const incoming = graph.outgoing(current) ?? [];
+        for (const [from] of incoming) {
+            queue.push(from);
         }
     }
 }
-function visitCfg(cfg, onVisit) {
-    return new ControlFlowGraphExecutionTraceVisitor(onVisit).visit(cfg);
-}
-exports.visitCfg = visitCfg;
 //# sourceMappingURL=visitor.js.map

package/util/diff.js

@@ -6,7 +6,7 @@
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setDifference = void 0;
+exports.setDifference = setDifference;
 const set_1 = require("./set");
 function setDifference(left, right, info) {
     const lWithoutR = (0, set_1.setMinus)(left, right);
@@ -27,5 +27,4 @@ function setDifference(left, right, info) {
         info.report.addComment(message);
     }
 }
-exports.setDifference = setDifference;
 //# sourceMappingURL=diff.js.map

package/util/files.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { RParseRequestFromFile } from '../r-bridge/retriever';
 /**
  * Represents a table, identified by a header and a list of rows.

package/util/files.js

@@ -26,7 +26,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParentDirectory = exports.readLineByLineSync = exports.readLineByLine = exports.writeTableAsCsv = exports.allRFilesFrom = exports.allRFiles = exports.getAllFiles = void 0;
+exports.getAllFiles = getAllFiles;
+exports.allRFiles = allRFiles;
+exports.allRFilesFrom = allRFilesFrom;
+exports.writeTableAsCsv = writeTableAsCsv;
+exports.readLineByLine = readLineByLine;
+exports.readLineByLineSync = readLineByLineSync;
+exports.getParentDirectory = getParentDirectory;
 const fs_1 = __importStar(require("fs"));
 const path_1 = __importDefault(require("path"));
 const log_1 = require("./log");
@@ -49,7 +55,6 @@ async function* getAllFiles(dir, suffix = /.*/) {
         }
     }
 }
-exports.getAllFiles = getAllFiles;
 const rFileRegex = /\.[rR]$/;
 /**
  * Retrieves all R files in a given directory (asynchronously)
@@ -81,7 +86,6 @@ async function* allRFiles(input, limit = Number.MAX_VALUE) {
     }
     return count;
 }
-exports.allRFiles = allRFiles;
 /**
  * Retrieves all R files in a given set of directories and files (asynchronously)
  *
@@ -103,12 +107,10 @@ async function* allRFilesFrom(inputs, limit) {
     }
     return count;
 }
-exports.allRFilesFrom = allRFilesFrom;
 function writeTableAsCsv(table, file, sep = ',', newline = '\n') {
     const csv = [table.header.join(sep), ...table.rows.map(row => row.join(sep))].join(newline);
     fs_1.default.writeFileSync(file, csv);
 }
-exports.writeTableAsCsv = writeTableAsCsv;
 /**
  * Reads a file line by line and calls the given function for each line.
  * The `lineNumber` starts at `0`.
@@ -124,7 +126,6 @@ async function readLineByLine(filePath, onLine) {
         await onLine(line, counter++);
     }
 }
-exports.readLineByLine = readLineByLine;
 /**
  * Reads a file line by line and calls the given function for each line.
  * The `lineNumber` starts at `0`.
@@ -132,6 +133,10 @@ exports.readLineByLine = readLineByLine;
  * See {@link readLineByLine} for an asynchronous version.
  */
 function readLineByLineSync(filePath, onLine) {
+    if (!fs_1.default.existsSync(filePath)) {
+        log_1.log.warn(`File ${filePath} does not exist`);
+        return;
+    }
     const reader = new n_readlines_1.default(filePath);
     let line;
     let counter = 0;
@@ -140,7 +145,6 @@ function readLineByLineSync(filePath, onLine) {
         onLine(line, counter++);
     }
 }
-exports.readLineByLineSync = readLineByLineSync;
 /**
  * Chops off the last part of the given directory path after a path separator, essentially returning the path's parent directory.
  * If an absolute path is passed, the returned path is also absolute.
@@ -150,5 +154,4 @@ function getParentDirectory(directory) {
     // apparently this is somehow the best way to do it in node, what
     return directory.split(path_1.default.sep).slice(0, -1).join(path_1.default.sep);
 }
-exports.getParentDirectory = getParentDirectory;
 //# sourceMappingURL=files.js.map

package/util/json.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonBigIntRetriever = exports.jsonReplacer = void 0;
+exports.jsonReplacer = jsonReplacer;
+exports.jsonBigIntRetriever = jsonBigIntRetriever;
 // to get the types within JSON.stringify
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function jsonReplacer(key, value) {
@@ -15,7 +16,6 @@ function jsonReplacer(key, value) {
         return value;
     }
 }
-exports.jsonReplacer = jsonReplacer;
 function jsonBigIntRetriever(key, value) {
     if (typeof value === 'string' && value.endsWith('n')) {
         return BigInt(value.slice(0, -1));
@@ -24,5 +24,4 @@ function jsonBigIntRetriever(key, value) {
         return value;
     }
 }
-exports.jsonBigIntRetriever = jsonBigIntRetriever;
 //# sourceMappingURL=json.js.map

package/util/mermaid/ast.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizedAstToMermaidUrl = exports.normalizedAstToMermaid = void 0;
+exports.normalizedAstToMermaid = normalizedAstToMermaid;
+exports.normalizedAstToMermaidUrl = normalizedAstToMermaidUrl;
 const mermaid_1 = require("./mermaid");
 const visitor_1 = require("../../r-bridge/lang-4.x/ast/model/processing/visitor");
-function normalizedAstToMermaid(ast, prefix = '') {
-    let output = prefix + 'flowchart TD\n';
+const type_1 = require("../../r-bridge/lang-4.x/ast/model/type");
+function normalizedAstToMermaid(ast, prefix = 'flowchart TD\n') {
+    let output = prefix;
     (0, visitor_1.visitAst)(ast, n => {
         const name = `${n.type} (${n.info.id})\\n${n.lexeme ?? ' '}`;
         output += `    n${n.info.id}(["${(0, mermaid_1.escapeMarkdown)(name)}"])\n`;
@@ -13,7 +15,7 @@ function normalizedAstToMermaid(ast, prefix = '') {
             const roleSuffix = context.role === "expr-list-child" /* RoleInParent.ExpressionListChild */ || context.role === "call-argument" /* RoleInParent.FunctionCallArgument */ || context.role === "function-def-param" /* RoleInParent.FunctionDefinitionParameter */ ? `-${context.index}` : '';
             output += `    n${n.info.parent} -->|"${context.role}${roleSuffix}"| n${n.info.id}\n`;
         }
-        if (n.type === "RExpressionList" /* RType.ExpressionList */ && n.grouping !== undefined) {
+        if (n.type === type_1.RType.ExpressionList && n.grouping !== undefined) {
             output += `    n${n.info.id} -.-|"group-open"| n${n.grouping[0].info.id}\n`;
             output += `    n${n.info.id} -.-|"group-close"| n${n.grouping[1].info.id}\n`;
         }
@@ -21,12 +23,10 @@ function normalizedAstToMermaid(ast, prefix = '') {
     });
     return output;
 }
-exports.normalizedAstToMermaid = normalizedAstToMermaid;
 /**
  * Use mermaid to visualize the normalized AST.
  */
-function normalizedAstToMermaidUrl(ast, prefix = '') {
+function normalizedAstToMermaidUrl(ast, prefix = 'flowchart TD\n') {
     return (0, mermaid_1.mermaidCodeToUrl)(normalizedAstToMermaid(ast, prefix));
 }
-exports.normalizedAstToMermaidUrl = normalizedAstToMermaidUrl;
 //# sourceMappingURL=ast.js.map

package/util/mermaid/cfg.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cfgToMermaidUrl = exports.cfgToMermaid = void 0;
+exports.cfgToMermaid = cfgToMermaid;
+exports.cfgToMermaidUrl = cfgToMermaidUrl;
 const mermaid_1 = require("./mermaid");
 function getLexeme(n) {
     return n ? n.info.fullLexeme ?? n.lexeme ?? '<unknown>' : '';
@@ -33,12 +34,10 @@ function cfgToMermaid(cfg, normalizedAst, prefix = '') {
     }
     return output;
 }
-exports.cfgToMermaid = cfgToMermaid;
 /**
  * Use mermaid to visualize the normalized AST.
  */
 function cfgToMermaidUrl(cfg, normalizedAst, prefix = '') {
     return (0, mermaid_1.mermaidCodeToUrl)(cfgToMermaid(cfg, normalizedAst, prefix));
 }
-exports.cfgToMermaidUrl = cfgToMermaidUrl;
 //# sourceMappingURL=cfg.js.map

package/util/mermaid/dfg.d.ts

@@ -1,14 +1,20 @@
 import type { SourceRange } from '../range';
 import type { DataflowGraph } from '../../dataflow/graph/graph';
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import type { IdentifierDefinition } from '../../dataflow/environments/identifier';
 type MarkVertex = NodeId;
 type MarkEdge = `${string}->${string}`;
-type Mark = MarkVertex | MarkEdge;
+export type MermaidMarkdownMark = MarkVertex | MarkEdge;
+export interface MermaidMarkStyle {
+    readonly vertex: string;
+    readonly edge: string;
+}
 interface MermaidGraph {
     nodeLines: string[];
     edgeLines: string[];
     includeEnvironments: boolean;
-    mark: ReadonlySet<Mark> | undefined;
+    mark: ReadonlySet<MermaidMarkdownMark> | undefined;
+    markStyle: MermaidMarkStyle;
     /** in the form of from-\>to because I am lazy, see {@link encodeEdge} */
     presentEdges: Set<string>;
     rootGraph: DataflowGraph;
@@ -17,12 +23,14 @@ interface MermaidGraph {
  * Prints a {@link SourceRange|range} as a human readable string.
  */
 export declare function formatRange(range: SourceRange | undefined): string;
+export declare function printIdentifier(id: IdentifierDefinition): string;
 interface MermaidGraphConfiguration {
     graph: DataflowGraph;
     prefix?: string | null;
     idPrefix?: string;
     includeEnvironments?: boolean;
-    mark?: ReadonlySet<Mark>;
+    mark?: ReadonlySet<MermaidMarkdownMark>;
+    markStyle?: MermaidMarkStyle;
     rootGraph?: DataflowGraph;
     presentEdges?: Set<string>;
 }
@@ -41,7 +49,7 @@ export declare function graphToMermaidUrl(graph: DataflowGraph, includeEnvironme
 export interface LabeledDiffGraph {
     label: string;
     graph: DataflowGraph;
-    mark?: Set<Mark>;
+    mark?: Set<MermaidMarkdownMark>;
 }
 /** uses same id map but ensures, it is different from the rhs so that mermaid can work with that */
 export declare function diffGraphsToMermaid(left: LabeledDiffGraph, right: LabeledDiffGraph, prefix: string): string;