@eagleoutice/flowr 1.3.13 → 1.4.1

package/util/{cfg.js → cfg/cfg.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cfg2quads = exports.equalCfg = exports.extractCFG = exports.emptyControlFlowInformation = exports.ControlFlowGraph = void 0;
-const r_bridge_1 = require("../r-bridge");
-const set_1 = require("./set");
-const quads_1 = require("./quads");
-const log_1 = require("./log");
-const json_1 = require("./json");
+const r_bridge_1 = require("../../r-bridge");
+const set_1 = require("../set");
+const quads_1 = require("../quads");
+const log_1 = require("../log");
+const json_1 = require("../json");
 /**
  * This class represents the control flow graph of an R program.
  * The control flow may be hierarchical when confronted with function definitions (see {@link CfgVertex} and {@link CFG#rootVertexIds|rootVertexIds()}).
@@ -65,10 +65,10 @@ function emptyControlFlowInformation() {
 }
 exports.emptyControlFlowInformation = emptyControlFlowInformation;
 const cfgFolds = {
-    foldNumber: cfgLeaf,
-    foldString: cfgLeaf,
-    foldLogical: cfgLeaf,
-    foldSymbol: cfgLeaf,
+    foldNumber: cfgLeaf("expression" /* CfgVertexType.Expression */),
+    foldString: cfgLeaf("expression" /* CfgVertexType.Expression */),
+    foldLogical: cfgLeaf("expression" /* CfgVertexType.Expression */),
+    foldSymbol: cfgLeaf("expression" /* CfgVertexType.Expression */),
     foldAccess: cfgAccess,
     binaryOp: {
         foldLogicalOp: cfgBinaryOp,
@@ -107,24 +107,29 @@ function extractCFG(ast) {
     return (0, r_bridge_1.foldAst)(ast.ast, cfgFolds);
 }
 exports.extractCFG = extractCFG;
-function cfgLeaf(leaf) {
-    const graph = new ControlFlowGraph();
-    graph.addVertex({ id: leaf.info.id, name: leaf.type });
-    return { graph, breaks: [], nexts: [], returns: [], exitPoints: [leaf.info.id], entryPoints: [leaf.info.id] };
+function cfgLeaf(type) {
+    return (leaf) => {
+        const graph = new ControlFlowGraph();
+        graph.addVertex({ id: leaf.info.id, name: leaf.type, type });
+        return { graph, breaks: [], nexts: [], returns: [], exitPoints: [leaf.info.id], entryPoints: [leaf.info.id] };
+    };
 }
 function cfgBreak(leaf) {
-    return { ...cfgLeaf(leaf), breaks: [leaf.info.id] };
+    return { ...cfgLeaf("statement" /* CfgVertexType.Statement */)(leaf), breaks: [leaf.info.id] };
 }
 function cfgNext(leaf) {
-    return { ...cfgLeaf(leaf), nexts: [leaf.info.id] };
+    return { ...cfgLeaf("statement" /* CfgVertexType.Statement */)(leaf), nexts: [leaf.info.id] };
 }
 function cfgIgnore(_leaf) {
     return { graph: new ControlFlowGraph(), breaks: [], nexts: [], returns: [], exitPoints: [], entryPoints: [] };
 }
+function identifyMayStatementType(node) {
+    return node.info.role === "expr-list-child" /* RoleInParent.ExpressionListChild */ ? "statement" /* CfgVertexType.Statement */ : "expression" /* CfgVertexType.Expression */;
+}
 function cfgIfThenElse(ifNode, condition, then, otherwise) {
     const graph = new ControlFlowGraph();
-    graph.addVertex({ id: ifNode.info.id, name: ifNode.type });
-    graph.addVertex({ id: ifNode.info.id + '-exit', name: 'if-exit' });
+    graph.addVertex({ id: ifNode.info.id, name: ifNode.type, type: identifyMayStatementType(ifNode) });
+    graph.addVertex({ id: ifNode.info.id + '-exit', name: 'if-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     graph.merge(condition.graph);
     graph.merge(then.graph);
     if (otherwise) {
@@ -160,8 +165,8 @@ function cfgIfThenElse(ifNode, condition, then, otherwise) {
 }
 function cfgRepeat(repeat, body) {
     const graph = body.graph;
-    graph.addVertex({ id: repeat.info.id, name: repeat.type });
-    graph.addVertex({ id: repeat.info.id + '-exit', name: 'repeat-exit' });
+    graph.addVertex({ id: repeat.info.id, name: repeat.type, type: identifyMayStatementType(repeat) });
+    graph.addVertex({ id: repeat.info.id + '-exit', name: 'repeat-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     for (const entryPoint of body.entryPoints) {
         graph.addEdge(repeat.info.id, entryPoint, { label: 'FD' });
     }
@@ -176,8 +181,8 @@ function cfgRepeat(repeat, body) {
 }
 function cfgWhile(whileLoop, condition, body) {
     const graph = condition.graph;
-    graph.addVertex({ id: whileLoop.info.id, name: whileLoop.type });
-    graph.addVertex({ id: whileLoop.info.id + '-exit', name: 'while-exit' });
+    graph.addVertex({ id: whileLoop.info.id, name: whileLoop.type, type: identifyMayStatementType(whileLoop) });
+    graph.addVertex({ id: whileLoop.info.id + '-exit', name: 'while-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     graph.merge(body.graph);
     for (const entry of condition.entryPoints) {
         graph.addEdge(entry, whileLoop.info.id, { label: 'FD' });
@@ -204,8 +209,8 @@ function cfgWhile(whileLoop, condition, body) {
 }
 function cfgFor(forLoop, variable, vector, body) {
     const graph = variable.graph;
-    graph.addVertex({ id: forLoop.info.id, name: forLoop.type });
-    graph.addVertex({ id: forLoop.info.id + '-exit', name: 'for-exit' });
+    graph.addVertex({ id: forLoop.info.id, name: forLoop.type, type: identifyMayStatementType(forLoop) });
+    graph.addVertex({ id: forLoop.info.id + '-exit', name: 'for-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     graph.merge(vector.graph);
     graph.merge(body.graph);
     for (const entry of vector.entryPoints) {
@@ -236,9 +241,9 @@ function cfgFor(forLoop, variable, vector, body) {
 function cfgFunctionDefinition(fn, params, body) {
     const graph = new ControlFlowGraph();
     const children = [fn.info.id + '-params', fn.info.id + '-exit'];
-    graph.addVertex({ id: fn.info.id + '-params', name: 'function-parameters' }, false);
-    graph.addVertex({ id: fn.info.id + '-exit', name: 'function-exit' }, false);
-    graph.addVertex({ id: fn.info.id, name: fn.type, children });
+    graph.addVertex({ id: fn.info.id + '-params', name: 'function-parameters', type: "mid-marker" /* CfgVertexType.MidMarker */ }, false);
+    graph.addVertex({ id: fn.info.id + '-exit', name: 'function-exit', type: "end-marker" /* CfgVertexType.EndMarker */ }, false);
+    graph.addVertex({ id: fn.info.id, name: fn.type, children, type: identifyMayStatementType(fn) });
     graph.merge(body.graph, true);
     children.push(...body.graph.rootVertexIds());
     for (const param of params) {
@@ -263,15 +268,15 @@ function cfgFunctionDefinition(fn, params, body) {
 function cfgFunctionCall(call, name, args) {
     const graph = name.graph;
     const info = { graph, breaks: [...name.breaks], nexts: [...name.nexts], returns: [...name.returns], exitPoints: [call.info.id + '-exit'], entryPoints: [call.info.id] };
-    graph.addVertex({ id: call.info.id, name: call.type });
+    graph.addVertex({ id: call.info.id, name: call.type, type: identifyMayStatementType(call) });
     for (const entryPoint of name.entryPoints) {
         graph.addEdge(entryPoint, call.info.id, { label: 'FD' });
     }
-    graph.addVertex({ id: call.info.id + '-name', name: 'call-name' });
+    graph.addVertex({ id: call.info.id + '-name', name: 'call-name', type: "mid-marker" /* CfgVertexType.MidMarker */ });
     for (const exitPoint of name.exitPoints) {
         graph.addEdge(call.info.id + '-name', exitPoint, { label: 'FD' });
     }
-    graph.addVertex({ id: call.info.id + '-exit', name: 'call-exit' });
+    graph.addVertex({ id: call.info.id + '-exit', name: 'call-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     let lastArgExits = [call.info.id + '-name'];
     for (const arg of args) {
         if (arg === undefined) {
@@ -297,7 +302,7 @@ function cfgFunctionCall(call, name, args) {
 function cfgArgumentOrParameter(node, name, value) {
     const graph = new ControlFlowGraph();
     const info = { graph, breaks: [], nexts: [], returns: [], exitPoints: [node.info.id + '-exit'], entryPoints: [node.info.id] };
-    graph.addVertex({ id: node.info.id, name: node.type });
+    graph.addVertex({ id: node.info.id, name: node.type, type: "expression" /* CfgVertexType.Expression */ });
     let currentExitPoint = [node.info.id];
     if (name) {
         graph.merge(name.graph);
@@ -309,7 +314,7 @@ function cfgArgumentOrParameter(node, name, value) {
         }
         currentExitPoint = name.exitPoints;
     }
-    graph.addVertex({ id: node.info.id + '-before-value', name: 'before-value' });
+    graph.addVertex({ id: node.info.id + '-before-value', name: 'before-value', type: "mid-marker" /* CfgVertexType.MidMarker */ });
     for (const exitPoints of currentExitPoint) {
         graph.addEdge(node.info.id + '-before-value', exitPoints, { label: 'FD' });
     }
@@ -326,7 +331,7 @@ function cfgArgumentOrParameter(node, name, value) {
         }
         currentExitPoint = value.exitPoints;
     }
-    graph.addVertex({ id: node.info.id + '-exit', name: 'exit' });
+    graph.addVertex({ id: node.info.id + '-exit', name: 'exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     for (const exit of currentExitPoint) {
         graph.addEdge(node.info.id + '-exit', exit, { label: 'FD' });
     }
@@ -335,8 +340,8 @@ function cfgArgumentOrParameter(node, name, value) {
 function cfgBinaryOp(binOp, lhs, rhs) {
     const graph = new ControlFlowGraph().merge(lhs.graph).merge(rhs.graph);
     const result = { graph, breaks: [...lhs.breaks, ...rhs.breaks], nexts: [...lhs.nexts, ...rhs.nexts], returns: [...lhs.returns, ...rhs.returns], entryPoints: [binOp.info.id], exitPoints: [binOp.info.id + '-exit'] };
-    graph.addVertex({ id: binOp.info.id, name: binOp.type });
-    graph.addVertex({ id: binOp.info.id + '-exit', name: 'binOp-exit' });
+    graph.addVertex({ id: binOp.info.id, name: binOp.type, type: binOp.flavor === 'assignment' ? "statement" /* CfgVertexType.Statement */ : "expression" /* CfgVertexType.Expression */ });
+    graph.addVertex({ id: binOp.info.id + '-exit', name: 'binOp-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     for (const exitPoint of lhs.exitPoints) {
         for (const entryPoint of rhs.entryPoints) {
             result.graph.addEdge(entryPoint, exitPoint, { label: 'FD' });
@@ -353,8 +358,8 @@ function cfgBinaryOp(binOp, lhs, rhs) {
 function cfgAccess(access, name, accessors) {
     const result = name;
     const graph = result.graph;
-    graph.addVertex({ id: access.info.id, name: access.type });
-    graph.addVertex({ id: access.info.id + '-exit', name: 'access-exit' });
+    graph.addVertex({ id: access.info.id, name: access.type, type: "expression" /* CfgVertexType.Expression */ });
+    graph.addVertex({ id: access.info.id + '-exit', name: 'access-exit', type: "end-marker" /* CfgVertexType.EndMarker */ });
     for (const entry of name.entryPoints) {
         graph.addEdge(entry, access.info.id, { label: 'FD' });
     }
@@ -383,7 +388,7 @@ function cfgAccess(access, name, accessors) {
 function cfgUnaryOp(unary, operand) {
     const graph = operand.graph;
     const result = { ...operand, graph, exitPoints: [unary.info.id] };
-    graph.addVertex({ id: unary.info.id, name: unary.type });
+    graph.addVertex({ id: unary.info.id, name: unary.type, type: "end-marker" /* CfgVertexType.EndMarker */ });
     return result;
 }
 function cfgExprList(_node, expressions) {

package/util/cfg/visitor.d.ts

@@ -0,0 +1,14 @@
+import type { NodeId } from '../../r-bridge';
+import type { CfgEdge, CfgVertex, ControlFlowInformation } from './cfg';
+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;

package/util/cfg/visitor.js

@@ -0,0 +1,64 @@
+"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
+            });
+        }
+    }
+    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 });
+            }
+        }
+        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 });
+        }
+    }
+}
+function visitCfg(cfg, onVisit) {
+    return new ControlFlowGraphExecutionTraceVisitor(onVisit).visit(cfg);
+}
+exports.visitCfg = visitCfg;
+//# sourceMappingURL=visitor.js.map

package/util/diff.d.ts

@@ -4,7 +4,7 @@
  *
  * @module
  */
-import { MergeableRecord } from './objects';
+import type { MergeableRecord } from './objects';
 /**
  * Unifies the shape of all difference reports.
  * They should have an array of comments on the potential differences/equality of

package/util/files.d.ts

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

package/util/mermaid/ast.d.ts

@@ -1,4 +1,4 @@
-import { RNodeWithParent } from '../../r-bridge';
+import type { RNodeWithParent } from '../../r-bridge';
 export declare function normalizedAstToMermaid(ast: RNodeWithParent, prefix?: string): string;
 /**
  * Use mermaid to visualize the normalized AST.

package/util/mermaid/cfg.d.ts

@@ -1,5 +1,5 @@
-import { NormalizedAst } from '../../r-bridge';
-import { ControlFlowInformation } from '../cfg';
+import type { NormalizedAst } from '../../r-bridge';
+import type { ControlFlowInformation } from '../cfg/cfg';
 export declare function cfgToMermaid(cfg: ControlFlowInformation, normalizedAst: NormalizedAst, prefix?: string): string;
 /**
  * Use mermaid to visualize the normalized AST.

package/util/mermaid/dfg.d.ts

@@ -1,6 +1,6 @@
-import { NodeId } from '../../r-bridge';
-import { SourceRange } from '../range';
-import { DataflowGraph, DataflowMap } from '../../dataflow';
+import type { NodeId } from '../../r-bridge';
+import type { SourceRange } from '../range';
+import type { DataflowGraph, DataflowMap } from '../../dataflow';
 export declare function formatRange(range: SourceRange | undefined): string;
 export declare function graphToMermaid(graph: DataflowGraph, dataflowIdMap: DataflowMap | undefined, prefix?: string | null, idPrefix?: string, includeEnvironments?: boolean, mark?: Set<NodeId>, rootGraph?: DataflowGraph): string;
 /**

package/util/objects.d.ts

@@ -1,4 +1,4 @@
-import { DeepPartial, DeepRequired } from 'ts-essentials';
+import type { DeepPartial, DeepRequired } from 'ts-essentials';
 /**
  * checks if `item` is an object (it may be an array, ...)
  */

package/util/quads.d.ts

@@ -7,8 +7,8 @@
  *
  * @module
  */
-import { MergeableRecord } from './objects';
-import { NodeId } from '../r-bridge';
+import type { MergeableRecord } from './objects';
+import type { NodeId } from '../r-bridge';
 type RecordForQuad = Record<string, unknown>;
 type DataForQuad = Record<string, unknown> | ArrayLike<unknown>;
 type ContextForQuad = string;

package/util/summarizer/benchmark/data.d.ts

@@ -1,4 +1,4 @@
-import { CommonSlicerMeasurements, PerSliceMeasurements, SlicerStats, SlicerStatsDataflow, SlicerStatsInput } from '../../../benchmark';
+import type { CommonSlicerMeasurements, PerSliceMeasurements, SlicerStats, SlicerStatsDataflow, SlicerStatsInput } from '../../../benchmark';
 export interface SummarizedMeasurement<T = number> {
     min: T;
     max: T;

package/util/summarizer/benchmark/first-phase/process.d.ts

@@ -1,6 +1,6 @@
-import { SummarizedMeasurement, SummarizedSlicerStats } from '../data';
-import { PerSliceStats, SlicerStats } from '../../../../benchmark';
-import { SlicingCriteria } from '../../../../slicing';
+import type { SummarizedMeasurement, SummarizedSlicerStats } from '../data';
+import type { PerSliceStats, SlicerStats } from '../../../../benchmark';
+import type { SlicingCriteria } from '../../../../slicing';
 /**
  * Summarizes the given stats by calculating the min, max, median, mean, and the standard deviation for each measurement.
  * @see Slicer

package/util/summarizer/benchmark/second-phase/graph.d.ts

@@ -1,2 +1,2 @@
-import { UltimateSlicerStats } from '../data';
+import type { UltimateSlicerStats } from '../data';
 export declare function writeGraphOutput(ultimate: UltimateSlicerStats, outputGraphPath: string): void;

package/util/summarizer/benchmark/second-phase/process.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="node" />
-import { SummarizedSlicerStats, UltimateSlicerStats } from '../data';
+import type { SummarizedSlicerStats, UltimateSlicerStats } from '../data';
 export declare function summarizeAllSummarizedStats(stats: SummarizedSlicerStats[]): UltimateSlicerStats;
 export declare function processNextSummary(line: Buffer, allSummarized: SummarizedSlicerStats[]): void;

package/util/summarizer/benchmark/summarizer.d.ts

@@ -2,8 +2,9 @@
  * This module is tasked with processing the results of the benchmarking (see {@link SlicerStats}).
  * @module
  */
-import { CommonSummarizerConfiguration, Summarizer } from '../summarizer';
-import { UltimateSlicerStats } from './data';
+import type { CommonSummarizerConfiguration } from '../summarizer';
+import { Summarizer } from '../summarizer';
+import type { UltimateSlicerStats } from './data';
 export interface BenchmarkSummarizerConfiguration extends CommonSummarizerConfiguration {
     /**
      * If given, produce graph data output (e.g. for the benchmark visualization) to the given path

package/util/summarizer/benchmark/summarizer.js

@@ -4,10 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BenchmarkSummarizer = void 0;
-/**
- * This module is tasked with processing the results of the benchmarking (see {@link SlicerStats}).
- * @module
- */
 const summarizer_1 = require("../summarizer");
 const fs_1 = __importDefault(require("fs"));
 const input_1 = require("./first-phase/input");

package/util/summarizer/statistics/post-process/clusterer.d.ts

@@ -1,6 +1,6 @@
 import { DefaultMap } from '../../../defaultmap';
-import { NodeId } from '../../../../r-bridge';
-import { MergeableRecord } from '../../../objects';
+import type { NodeId } from '../../../../r-bridge';
+import type { MergeableRecord } from '../../../objects';
 export type ContextsWithCount = DefaultMap<NodeId, number>;
 export type ClusterContextIdMap = DefaultMap<string | undefined, NodeId>;
 export type ClusterValueInfoMap = DefaultMap<string, ContextsWithCount>;

package/util/summarizer/statistics/post-process/file-based-count.d.ts

@@ -1,4 +1,4 @@
-import { ClusterReport } from './clusterer';
+import type { ClusterReport } from './clusterer';
 export interface FileBasedTable {
     header: string[];
     rows: string[][];

package/util/summarizer/statistics/post-process/histogram.d.ts

@@ -1,5 +1,5 @@
-import { ClusterReport } from './clusterer';
-import { Table } from '../../../files';
+import type { ClusterReport } from './clusterer';
+import type { Table } from '../../../files';
 /**
  * A conventional histogram (e.g., created by {@link histogramFromNumbers}).
  * Can be converted to a {@link Table} by {@link histograms2table}.

package/util/summarizer/statistics/post-process/post-process-output.d.ts

@@ -1,5 +1,5 @@
-import { FeatureSelection } from '../../../../statistics';
-import { ClusterReport } from './clusterer';
+import type { FeatureSelection } from '../../../../statistics';
+import type { ClusterReport } from './clusterer';
 /**
  * Post process the collections in a given folder, reducing them in a memory preserving way.
  *

package/util/summarizer/statistics/second-phase/process.d.ts

@@ -1,5 +1,5 @@
-import { CommonSummarizerConfiguration } from '../../summarizer';
-import { StatisticsSummarizerConfiguration } from '../summarizer';
+import type { CommonSummarizerConfiguration } from '../../summarizer';
+import type { StatisticsSummarizerConfiguration } from '../summarizer';
 /**
  * Post process the collections in a given folder, retrieving the final summaries.
  *

package/util/summarizer/statistics/summarizer.d.ts

@@ -1,5 +1,6 @@
-import { CommonSummarizerConfiguration, Summarizer } from '../summarizer';
-import { FeatureSelection } from '../../../statistics';
+import type { CommonSummarizerConfiguration } from '../summarizer';
+import { Summarizer } from '../summarizer';
+import type { FeatureSelection } from '../../../statistics';
 export interface StatisticsSummarizerConfiguration extends CommonSummarizerConfiguration {
     /**
      * The input path to read all zips from

package/util/summarizer/summarizer.d.ts

@@ -1,4 +1,4 @@
-import { MergeableRecord } from '../objects';
+import type { MergeableRecord } from '../objects';
 export declare const enum SummarizerType {
     Benchmark = "benchmark",
     Statistics = "statistics"