@eagleoutice/flowr 2.2.2 → 2.2.3

package/cli/repl/commands/repl-dataflow.js

@@ -9,9 +9,12 @@ const retriever_1 = require("../../../r-bridge/retriever");
 const dfg_1 = require("../../../util/mermaid/dfg");
 const clipboardy_1 = __importDefault(require("clipboardy"));
 const ansi_1 = require("../../../util/ansi");
-async function dataflow(parser, remainingLine) {
+/**
+ * Obtain the dataflow graph using a known parser (such as the {@link RShell} or {@link TreeSitterExecutor}).
+ */
+async function replGetDataflow(parser, code) {
     return await (0, default_pipelines_1.createDataflowPipeline)(parser, {
-        request: (0, retriever_1.requestFromInput)(remainingLine.trim())
+        request: (0, retriever_1.requestFromInput)(code.trim())
     }).allRemainingSteps();
 }
 function handleString(code) {
@@ -26,7 +29,7 @@ exports.dataflowCommand = {
     aliases: ['d', 'df'],
     script: false,
     fn: async (output, shell, remainingLine) => {
-        const result = await dataflow(shell, handleString(remainingLine));
+        const result = await replGetDataflow(shell, handleString(remainingLine));
         const mermaid = (0, dfg_1.graphToMermaid)({ graph: result.dataflow.graph, includeEnvironments: false }).string;
         output.stdout(mermaid);
         try {
@@ -42,7 +45,7 @@ exports.dataflowStarCommand = {
     aliases: ['d*', 'df*'],
     script: false,
     fn: async (output, shell, remainingLine) => {
-        const result = await dataflow(shell, handleString(remainingLine));
+        const result = await replGetDataflow(shell, handleString(remainingLine));
         const mermaid = (0, dfg_1.graphToMermaidUrl)(result.dataflow.graph, false);
         output.stdout(mermaid);
         try {

package/cli/repl/commands/repl-parse.js

@@ -17,7 +17,41 @@ function toDepthMap(entry) {
         result.push({ ...current, leaf: children.length === 0 });
         children.reverse();
         const nextDepth = current.depth + 1;
-        visit.push(...children.map(c => ({ depth: nextDepth, node: c })));
+        for (const c of children) {
+            visit.push({ depth: nextDepth, node: c });
+        }
+    }
+    return result;
+}
+function treeSitterToJsonEntry(node) {
+    return {
+        token: node.type,
+        children: [],
+        text: node.text,
+        id: node.id,
+        parent: node.parent?.id ?? -1,
+        terminal: node.isNamed,
+        line1: node.startPosition.row + 1,
+        col1: node.startPosition.column + 1,
+        line2: node.endPosition.row + 1,
+        col2: node.endPosition.column + 1
+    };
+}
+function treeSitterToDepthList(node) {
+    const visit = [{ depth: 0, node }];
+    const result = [];
+    while (visit.length > 0) {
+        const current = visit.pop();
+        if (current === undefined) {
+            continue;
+        }
+        const children = current.node.children;
+        result.push({ depth: current.depth, node: treeSitterToJsonEntry(current.node), leaf: children.length === 0 });
+        children.reverse();
+        const nextDepth = current.depth + 1;
+        for (const c of children) {
+            visit.push({ depth: nextDepth, node: c });
+        }
     }
     return result;
 }
@@ -57,6 +91,9 @@ function retrieveLocationString(locationRaw) {
     if (extracted[0] === extracted[2] && extracted[1] === extracted[3]) {
         return ` (${extracted[0]}:${extracted[1]})`;
     }
+    else if (extracted[0] === extracted[2]) {
+        return ` (${extracted[0]}:${extracted[1]}─${extracted[3]})`;
+    }
     else {
         return ` (${extracted[0]}:${extracted[1]}─${extracted[2]}:${extracted[3]})`;
     }
@@ -66,6 +103,10 @@ function depthListToTextTree(list, f) {
     const deadDepths = new Set();
     let i = 0;
     for (const { depth, node, leaf } of list) {
+        if (depth > 10) {
+            result += '...';
+            break;
+        }
         const nextDepth = i + 1 < list.length ? list[i + 1].depth : 0;
         deadDepths.delete(depth);
         result += initialIndentation(i, depth, deadDepths, nextDepth, list, f);
@@ -99,7 +140,7 @@ exports.parseCommand = {
         }
         else {
             // print the tree-sitter ast
-            output.stdout(JSON.stringify(result.parse.parsed, null, 2));
+            output.stdout(depthListToTextTree(treeSitterToDepthList(result.parse.parsed.rootNode), output.formatter));
         }
     }
 };

package/cli/repl/print-version.d.ts

@@ -1,2 +1,3 @@
 import type { KnownParser } from '../../r-bridge/parser';
+export declare function versionReplString(parser: KnownParser): Promise<string>;
 export declare function printVersionRepl(parser: KnownParser): Promise<void>;

package/cli/repl/print-version.js

@@ -1,9 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.versionReplString = versionReplString;
 exports.printVersionRepl = printVersionRepl;
 const repl_version_1 = require("./commands/repl-version");
-async function printVersionRepl(parser) {
+async function versionReplString(parser) {
     const version = await (0, repl_version_1.retrieveVersionInformation)(parser);
-    console.log(`flowR repl using flowR ${version.flowr}, R ${version.r}, engine ${version.engine}`);
+    const rVersion = version.r === 'none' ? '' : version.r === 'unknown' ? ', R version unknown' : `, R v${version.r}`;
+    return `flowR repl using flowR v${version.flowr}${rVersion} (${version.engine} engine)`;
+}
+async function printVersionRepl(parser) {
+    console.log(await versionReplString(parser));
 }
 //# sourceMappingURL=print-version.js.map

package/cli/repl/server/connection.js

@@ -38,9 +38,6 @@ const core_1 = require("../core");
 const cfg_1 = require("../../../util/cfg/cfg");
 const quads_1 = require("../../../util/quads");
 const print_1 = require("../../../core/print/print");
-const _00_parse_1 = require("../../../core/steps/all/core/00-parse");
-const _10_normalize_1 = require("../../../core/steps/all/core/10-normalize");
-const _20_dataflow_1 = require("../../../core/steps/all/core/20-dataflow");
 const ansi_1 = require("../../../util/ansi");
 const default_pipelines_1 = require("../../../core/steps/pipeline/default-pipelines");
 const graph_1 = require("../../../dataflow/graph/graph");
@@ -136,7 +133,7 @@ class FlowRServerConnection {
         }
         const tempFile = tmp.fileSync({ postfix: '.R' });
         const slicer = this.createPipelineExecutorForRequest(message, tempFile.name);
-        await slicer.allRemainingSteps(false).then(async (results) => await this.sendFileAnalysisResponse(results, message))
+        await slicer.allRemainingSteps(false).then(async (results) => await this.sendFileAnalysisResponse(slicer, results, message))
             .catch(e => {
             this.logger.error(`[${this.name}] Error while analyzing file ${message.filename ?? 'unknown file'}: ${String(e)}`);
             (0, send_1.sendMessage)(this.socket, {
@@ -149,13 +146,18 @@ class FlowRServerConnection {
         // this is an interestingly named function that means "I am a callback that removes a file" - so this deletes the file
         tempFile.removeCallback();
     }
-    async sendFileAnalysisResponse(results, message) {
+    async sendFileAnalysisResponse(slicer, results, message) {
         let cfg = undefined;
         if (message.cfg) {
             cfg = (0, cfg_1.extractCFG)(results.normalize, results.dataflow?.graph);
         }
         const config = () => ({ context: message.filename ?? 'unknown', getId: (0, quads_1.defaultQuadIdGenerator)() });
         const sanitizedResults = sanitizeAnalysisResults(results);
+        const pipeline = slicer.getPipeline();
+        const parseStep = pipeline.steps.get('parse');
+        const normalizedStep = pipeline.steps.get('normalize');
+        const dataflowStep = pipeline.steps.get('dataflow');
+        (0, assert_1.guard)(parseStep !== undefined && normalizedStep !== undefined && dataflowStep !== undefined, 'All steps must be present');
         if (message.format === 'n-quads') {
             (0, send_1.sendMessage)(this.socket, {
                 type: 'response-file-analysis',
@@ -163,9 +165,9 @@ class FlowRServerConnection {
                 id: message.id,
                 cfg: cfg ? (0, cfg_1.cfg2quads)(cfg, config()) : undefined,
                 results: {
-                    parse: await (0, print_1.printStepResult)(_00_parse_1.PARSE_WITH_R_SHELL_STEP, sanitizedResults.parse, 5 /* StepOutputFormat.RdfQuads */, config()),
-                    normalize: await (0, print_1.printStepResult)(_10_normalize_1.NORMALIZE, sanitizedResults.normalize, 5 /* StepOutputFormat.RdfQuads */, config()),
-                    dataflow: await (0, print_1.printStepResult)(_20_dataflow_1.STATIC_DATAFLOW, sanitizedResults.dataflow, 5 /* StepOutputFormat.RdfQuads */, config())
+                    parse: await (0, print_1.printStepResult)(parseStep, sanitizedResults.parse, 5 /* StepOutputFormat.RdfQuads */, config()),
+                    normalize: await (0, print_1.printStepResult)(normalizedStep, sanitizedResults.normalize, 5 /* StepOutputFormat.RdfQuads */, config()),
+                    dataflow: await (0, print_1.printStepResult)(dataflowStep, sanitizedResults.dataflow, 5 /* StepOutputFormat.RdfQuads */, config())
                 }
             });
         }

package/core/pipeline-executor.d.ts

@@ -95,10 +95,16 @@ export declare class PipelineExecutor<P extends Pipeline> {
      * Construct a new pipeline executor.
      * The required additional input is specified by the {@link IPipelineStep#requiredInput|required input configuration} of each step in the `pipeline`.
      *
+     * Please see {@link createDataflowPipeline} and friends for engine agnostic shortcuts to create a pipeline executor.
+     *
      * @param pipeline - The {@link Pipeline} to execute, probably created with {@link createPipeline}.
      * @param input    - External {@link PipelineInput|configuration and input} required to execute the given pipeline.
      */
     constructor(pipeline: P, input: PipelineInput<P>);
+    /**
+     * Retrieve the {@link Pipeline|pipeline} that is currently being.
+     */
+    getPipeline(): P;
     /**
      * Retrieve the current {@link PipelineStepStage|stage} the pipeline executor is in.
      *

package/core/pipeline-executor.js

@@ -99,6 +99,8 @@ class PipelineExecutor {
      * Construct a new pipeline executor.
      * The required additional input is specified by the {@link IPipelineStep#requiredInput|required input configuration} of each step in the `pipeline`.
      *
+     * Please see {@link createDataflowPipeline} and friends for engine agnostic shortcuts to create a pipeline executor.
+     *
      * @param pipeline - The {@link Pipeline} to execute, probably created with {@link createPipeline}.
      * @param input    - External {@link PipelineInput|configuration and input} required to execute the given pipeline.
      */
@@ -114,6 +116,12 @@ class PipelineExecutor {
         }
         (0, built_in_config_1.registerBuiltInDefinitions)(builtIns.definitions);
     }
+    /**
+     * Retrieve the {@link Pipeline|pipeline} that is currently being.
+     */
+    getPipeline() {
+        return this.pipeline;
+    }
     /**
      * Retrieve the current {@link PipelineStepStage|stage} the pipeline executor is in.
      *

package/core/print/dataflow-printer.js

@@ -16,6 +16,9 @@ function mayObjectJson(d) {
     }
 }
 function objectJson(df) {
+    if (df === null) {
+        return 'null';
+    }
     const elems = [];
     for (const [key, value] of Object.entries(df)) {
         switch (typeof value) {

package/core/steps/all/core/01-parse-tree-sitter.d.ts

@@ -5,6 +5,13 @@ import type { ParseRequiredInput } from '../../../../r-bridge/parser';
 export interface ParseStepOutputTS {
     readonly parsed: Tree;
 }
+export interface TreeSitterParseJson {
+    readonly '.meta': {
+        readonly tokenCount: number;
+        readonly tokenCountNoComments: number;
+    };
+    readonly str: string;
+}
 export declare const PARSE_WITH_TREE_SITTER_STEP: {
     readonly name: "parse";
     readonly humanReadableName: "parse with tree-sitter";

package/core/steps/pipeline/default-pipelines.d.ts

@@ -1,9 +1,11 @@
 /**
- * Contains the default pipeline for working with flowr
+ * Contains the default pipeline for working with flowR
  */
 import type { PipelineInput } from './pipeline';
 import type { KnownParser, Parser } from '../../../r-bridge/parser';
 import { PipelineExecutor } from '../../pipeline-executor';
+import type { RShell } from '../../../r-bridge/shell';
+import type { TreeSitterExecutor } from '../../../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor';
 export declare const DEFAULT_SLICING_PIPELINE: import("./pipeline").Pipeline<{
     readonly name: "parse";
     readonly humanReadableName: "parse with R shell";
@@ -256,21 +258,6 @@ export declare const TREE_SITTER_SLICING_PIPELINE: import("./pipeline").Pipeline
         readonly 4: typeof import("../../print/dataflow-printer").dataflowGraphToMermaidUrl;
     };
     readonly dependencies: readonly ["normalize"];
-} | {
-    readonly name: "parse";
-    readonly humanReadableName: "parse with tree-sitter";
-    readonly description: "Parse the given R code into an AST using tree-sitter";
-    readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<import("web-tree-sitter").Tree>>;
-    readonly executed: import("../pipeline-step").PipelineStepStage.OncePerFile;
-    readonly printer: {
-        readonly 0: typeof import("../../print/print").internalPrinter;
-        readonly 2: {
-            (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
-            (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
-        };
-    };
-    readonly dependencies: readonly [];
-    readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>;
 } | {
     readonly name: "slice";
     readonly humanReadableName: "static slice";
@@ -299,6 +286,21 @@ export declare const TREE_SITTER_SLICING_PIPELINE: import("./pipeline").Pipeline
     };
     readonly dependencies: readonly ["slice"];
     readonly requiredInput: import("../all/static-slicing/10-reconstruct").ReconstructRequiredInput;
+} | {
+    readonly name: "parse";
+    readonly humanReadableName: "parse with tree-sitter";
+    readonly description: "Parse the given R code into an AST using tree-sitter";
+    readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<import("web-tree-sitter").Tree>>;
+    readonly executed: import("../pipeline-step").PipelineStepStage.OncePerFile;
+    readonly printer: {
+        readonly 0: typeof import("../../print/print").internalPrinter;
+        readonly 2: {
+            (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+            (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+        };
+    };
+    readonly dependencies: readonly [];
+    readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>;
 } | {
     readonly name: "normalize";
     readonly humanReadableName: "normalize tree-sitter tree";
@@ -337,21 +339,6 @@ export declare const TREE_SITTER_SLICE_AND_RECONSTRUCT_PIPELINE: import("./pipel
         readonly 4: typeof import("../../print/dataflow-printer").dataflowGraphToMermaidUrl;
     };
     readonly dependencies: readonly ["normalize"];
-} | {
-    readonly name: "parse";
-    readonly humanReadableName: "parse with tree-sitter";
-    readonly description: "Parse the given R code into an AST using tree-sitter";
-    readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<import("web-tree-sitter").Tree>>;
-    readonly executed: import("../pipeline-step").PipelineStepStage.OncePerFile;
-    readonly printer: {
-        readonly 0: typeof import("../../print/print").internalPrinter;
-        readonly 2: {
-            (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
-            (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
-        };
-    };
-    readonly dependencies: readonly [];
-    readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>;
 } | {
     readonly name: "slice";
     readonly humanReadableName: "static slice";
@@ -380,6 +367,21 @@ export declare const TREE_SITTER_SLICE_AND_RECONSTRUCT_PIPELINE: import("./pipel
     };
     readonly dependencies: readonly ["slice"];
     readonly requiredInput: import("../all/static-slicing/10-reconstruct").ReconstructRequiredInput;
+} | {
+    readonly name: "parse";
+    readonly humanReadableName: "parse with tree-sitter";
+    readonly description: "Parse the given R code into an AST using tree-sitter";
+    readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<import("web-tree-sitter").Tree>>;
+    readonly executed: import("../pipeline-step").PipelineStepStage.OncePerFile;
+    readonly printer: {
+        readonly 0: typeof import("../../print/print").internalPrinter;
+        readonly 2: {
+            (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+            (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+        };
+    };
+    readonly dependencies: readonly [];
+    readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>;
 } | {
     readonly name: "normalize";
     readonly humanReadableName: "normalize tree-sitter tree";
@@ -418,6 +420,20 @@ export declare const TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE: import("./p
         readonly 4: typeof import("../../print/dataflow-printer").dataflowGraphToMermaidUrl;
     };
     readonly dependencies: readonly ["normalize"];
+} | {
+    readonly name: "slice";
+    readonly humanReadableName: "static slice";
+    readonly description: "Calculate the actual static slice from the dataflow graph and the given slicing criteria";
+    readonly processor: (results: {
+        dataflow?: import("../../../dataflow/info").DataflowInformation;
+        normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+    }, input: Partial<import("../all/static-slicing/00-slice").SliceRequiredInput>) => Readonly<import("../../../slicing/static/slicer-types").SliceResult>;
+    readonly executed: import("../pipeline-step").PipelineStepStage.OncePerRequest;
+    readonly printer: {
+        readonly 0: typeof import("../../print/print").internalPrinter;
+    };
+    readonly dependencies: readonly ["dataflow"];
+    readonly requiredInput: import("../all/static-slicing/00-slice").SliceRequiredInput;
 } | {
     readonly name: "parse";
     readonly humanReadableName: "parse with tree-sitter";
@@ -433,20 +449,6 @@ export declare const TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE: import("./p
     };
     readonly dependencies: readonly [];
     readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>;
-} | {
-    readonly name: "slice";
-    readonly humanReadableName: "static slice";
-    readonly description: "Calculate the actual static slice from the dataflow graph and the given slicing criteria";
-    readonly processor: (results: {
-        dataflow?: import("../../../dataflow/info").DataflowInformation;
-        normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
-    }, input: Partial<import("../all/static-slicing/00-slice").SliceRequiredInput>) => Readonly<import("../../../slicing/static/slicer-types").SliceResult>;
-    readonly executed: import("../pipeline-step").PipelineStepStage.OncePerRequest;
-    readonly printer: {
-        readonly 0: typeof import("../../print/print").internalPrinter;
-    };
-    readonly dependencies: readonly ["dataflow"];
-    readonly requiredInput: import("../all/static-slicing/00-slice").SliceRequiredInput;
 } | {
     readonly name: "normalize";
     readonly humanReadableName: "normalize tree-sitter tree";
@@ -466,8 +468,8 @@ export declare const TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE: import("./p
     readonly requiredInput: import("../all/core/10-normalize").NormalizeRequiredInput;
 }>;
 /**
- * The default pipeline for working with flowr, including the dataflow step,
- * see the {@link DEFAULT_NORMALIZE_PIPELINE} for the pipeline without the dataflow step,
+ * The default pipeline for working with flowR, including the dataflow step.
+ * See the {@link DEFAULT_NORMALIZE_PIPELINE} for the pipeline without the dataflow step
  * and the {@link DEFAULT_SLICE_AND_RECONSTRUCT_PIPELINE} for the pipeline with slicing and reconstructing steps
  */
 export declare const DEFAULT_DATAFLOW_PIPELINE: import("./pipeline").Pipeline<{
@@ -678,7 +680,15 @@ export declare const TREE_SITTER_PARSE_PIPELINE: import("./pipeline").Pipeline<{
     readonly dependencies: readonly [];
     readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<import("web-tree-sitter").Tree>;
 }>;
+export declare function createParsePipeline(parser: TreeSitterExecutor, inputs: Omit<PipelineInput<typeof DEFAULT_PARSE_PIPELINE>, 'parser'>): PipelineExecutor<typeof TREE_SITTER_PARSE_PIPELINE>;
+export declare function createParsePipeline(parser: RShell, inputs: Omit<PipelineInput<typeof DEFAULT_PARSE_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_PARSE_PIPELINE>;
 export declare function createParsePipeline(parser: KnownParser, inputs: Omit<PipelineInput<typeof DEFAULT_PARSE_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_PARSE_PIPELINE> | PipelineExecutor<typeof TREE_SITTER_PARSE_PIPELINE>;
+export declare function createSlicePipeline(parser: TreeSitterExecutor, inputs: Omit<PipelineInput<typeof DEFAULT_SLICING_PIPELINE>, 'parser'>): PipelineExecutor<typeof TREE_SITTER_SLICING_PIPELINE>;
+export declare function createSlicePipeline(parser: RShell, inputs: Omit<PipelineInput<typeof DEFAULT_SLICING_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_SLICING_PIPELINE>;
 export declare function createSlicePipeline(parser: KnownParser, inputs: Omit<PipelineInput<typeof DEFAULT_SLICING_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_SLICING_PIPELINE> | PipelineExecutor<typeof TREE_SITTER_SLICING_PIPELINE>;
+export declare function createNormalizePipeline(parser: TreeSitterExecutor, inputs: Omit<PipelineInput<typeof DEFAULT_NORMALIZE_PIPELINE>, 'parser'>): PipelineExecutor<typeof TREE_SITTER_NORMALIZE_PIPELINE>;
+export declare function createNormalizePipeline(parser: RShell, inputs: Omit<PipelineInput<typeof DEFAULT_NORMALIZE_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_NORMALIZE_PIPELINE>;
 export declare function createNormalizePipeline(parser: KnownParser, inputs: Omit<PipelineInput<typeof DEFAULT_NORMALIZE_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_NORMALIZE_PIPELINE> | PipelineExecutor<typeof TREE_SITTER_NORMALIZE_PIPELINE>;
+export declare function createDataflowPipeline(parser: TreeSitterExecutor, inputs: Omit<PipelineInput<typeof DEFAULT_DATAFLOW_PIPELINE>, 'parser'>): PipelineExecutor<typeof TREE_SITTER_DATAFLOW_PIPELINE>;
+export declare function createDataflowPipeline(parser: RShell, inputs: Omit<PipelineInput<typeof DEFAULT_DATAFLOW_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_DATAFLOW_PIPELINE>;
 export declare function createDataflowPipeline(parser: KnownParser, inputs: Omit<PipelineInput<typeof DEFAULT_DATAFLOW_PIPELINE>, 'parser'>): PipelineExecutor<typeof DEFAULT_DATAFLOW_PIPELINE> | PipelineExecutor<typeof TREE_SITTER_DATAFLOW_PIPELINE>;

package/core/steps/pipeline/default-pipelines.js

@@ -21,8 +21,8 @@ exports.TREE_SITTER_SLICING_PIPELINE = (0, pipeline_1.createPipeline)(_01_parse_
 exports.TREE_SITTER_SLICE_AND_RECONSTRUCT_PIPELINE = exports.TREE_SITTER_SLICING_PIPELINE;
 exports.TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE = (0, pipeline_1.createPipeline)(_01_parse_tree_sitter_1.PARSE_WITH_TREE_SITTER_STEP, _11_normalize_tree_sitter_1.NORMALIZE_TREE_SITTER, _20_dataflow_1.STATIC_DATAFLOW, _00_slice_1.STATIC_SLICE);
 /**
- * The default pipeline for working with flowr, including the dataflow step,
- * see the {@link DEFAULT_NORMALIZE_PIPELINE} for the pipeline without the dataflow step,
+ * The default pipeline for working with flowR, including the dataflow step.
+ * See the {@link DEFAULT_NORMALIZE_PIPELINE} for the pipeline without the dataflow step
  * and the {@link DEFAULT_SLICE_AND_RECONSTRUCT_PIPELINE} for the pipeline with slicing and reconstructing steps
  */
 exports.DEFAULT_DATAFLOW_PIPELINE = (0, pipeline_1.createPipeline)(_00_parse_1.PARSE_WITH_R_SHELL_STEP, _10_normalize_1.NORMALIZE, _20_dataflow_1.STATIC_DATAFLOW);
@@ -32,6 +32,11 @@ exports.DEFAULT_NORMALIZE_PIPELINE = (0, pipeline_1.createPipeline)(_00_parse_1.
 exports.TREE_SITTER_NORMALIZE_PIPELINE = (0, pipeline_1.createPipeline)(_01_parse_tree_sitter_1.PARSE_WITH_TREE_SITTER_STEP, _11_normalize_tree_sitter_1.NORMALIZE_TREE_SITTER);
 exports.DEFAULT_PARSE_PIPELINE = (0, pipeline_1.createPipeline)(_00_parse_1.PARSE_WITH_R_SHELL_STEP);
 exports.TREE_SITTER_PARSE_PIPELINE = (0, pipeline_1.createPipeline)(_01_parse_tree_sitter_1.PARSE_WITH_TREE_SITTER_STEP);
+/**
+ * Returns either a {@link DEFAULT_PARSE_PIPELINE} or a {@link TREE_SITTER_PARSE_PIPELINE} depending on the parser used.
+ *
+ * @see {@link createNormalizePipeline}, {@link createDataflowPipeline}, {@link createSlicePipeline}
+ */
 function createParsePipeline(parser, inputs) {
     const base = parser.name === 'tree-sitter' ? exports.TREE_SITTER_PARSE_PIPELINE : exports.DEFAULT_PARSE_PIPELINE;
     return new pipeline_executor_1.PipelineExecutor(base, {
@@ -39,6 +44,11 @@ function createParsePipeline(parser, inputs) {
         ...inputs
     });
 }
+/**
+ * Returns either a {@link DEFAULT_SLICING_PIPELINE} or a {@link TREE_SITTER_SLICING_PIPELINE} depending on the parser used.
+ *
+ * @see {@link createParsePipeline}, {@link createNormalizePipeline}, {@link createDataflowPipeline}
+ */
 function createSlicePipeline(parser, inputs) {
     const base = parser.name === 'tree-sitter' ? exports.TREE_SITTER_SLICING_PIPELINE : exports.DEFAULT_SLICING_PIPELINE;
     return new pipeline_executor_1.PipelineExecutor(base, {
@@ -46,6 +56,11 @@ function createSlicePipeline(parser, inputs) {
         ...inputs
     });
 }
+/**
+ * Returns either a {@link DEFAULT_NORMALIZE_PIPELINE} or a {@link TREE_SITTER_NORMALIZE_PIPELINE} depending on the parser used.
+ *
+ * @see {@link createParsePipeline}, {@link createDataflowPipeline}, {@link createSlicePipeline}
+ */
 function createNormalizePipeline(parser, inputs) {
     const base = parser.name === 'tree-sitter' ? exports.TREE_SITTER_NORMALIZE_PIPELINE : exports.DEFAULT_NORMALIZE_PIPELINE;
     return new pipeline_executor_1.PipelineExecutor(base, {
@@ -53,6 +68,12 @@ function createNormalizePipeline(parser, inputs) {
         ...inputs
     });
 }
+/**
+ * Returns either a {@link DEFAULT_DATAFLOW_PIPELINE} or a {@link TREE_SITTER_DATAFLOW_PIPELINE} depending on the parser used.
+ *
+ * @see {@link createParsePipeline}, {@link createNormalizePipeline}, {@link createSlicePipeline}
+ *
+ */
 function createDataflowPipeline(parser, inputs) {
     const base = parser.name === 'tree-sitter' ? exports.TREE_SITTER_DATAFLOW_PIPELINE : exports.DEFAULT_DATAFLOW_PIPELINE;
     return new pipeline_executor_1.PipelineExecutor(base, {

package/core/steps/pipeline/pipeline.d.ts

@@ -120,7 +120,7 @@ export type PipelineOutput<P extends Pipeline> = {
  *
  * 0) the collection of {@link IPipelineStep|steps} is not empty
  * 1) all {@link IPipelineStepOrder#name|names} of {@link IPipelineStep|steps} are unique for the given pipeline
- * 2) all {@link IPipelineStepOrder#dependencies|dependencies} of all {@link IPipelineStep|steps} are exist
+ * 2) all {@link IPipelineStepOrder#dependencies|dependencies} of all {@link IPipelineStep|steps} exist
  * 3) there are no cycles in the dependency graph
  * 4) the target of a {@link IPipelineStepOrder#decorates|step's decoration} exists
  * 5) if a {@link IPipelineStepOrder#decorates|decoration} applies, all of its {@link IPipelineStepOrder#dependencies|dependencies} are already in the pipeline

package/core/steps/pipeline/pipeline.js

@@ -9,7 +9,7 @@ const create_pipeline_1 = require("./create-pipeline");
  *
  * 0) the collection of {@link IPipelineStep|steps} is not empty
  * 1) all {@link IPipelineStepOrder#name|names} of {@link IPipelineStep|steps} are unique for the given pipeline
- * 2) all {@link IPipelineStepOrder#dependencies|dependencies} of all {@link IPipelineStep|steps} are exist
+ * 2) all {@link IPipelineStepOrder#dependencies|dependencies} of all {@link IPipelineStep|steps} exist
  * 3) there are no cycles in the dependency graph
  * 4) the target of a {@link IPipelineStepOrder#decorates|step's decoration} exists
  * 5) if a {@link IPipelineStepOrder#decorates|decoration} applies, all of its {@link IPipelineStepOrder#dependencies|dependencies} are already in the pipeline

package/core/steps/pipeline-step.d.ts

@@ -67,9 +67,7 @@ export interface IPipelineStep<Name extends PipelineStepName = PipelineStepName,
     readonly description: string;
     /** The main processor that essentially performs the logic of this step */
     readonly processor: (...input: Parameters<Fn>) => ReturnType<Fn>;
-    /**
-     * How to visualize the results of the respective step to the user?
-     */
+    /** How to visualize the results of the respective step to the user? */
     readonly printer: {
         [K in StepOutputFormat]?: IPipelineStepPrinter<Fn, K, never[]>;
     } & {

package/dataflow/environments/resolve-by-name.d.ts

@@ -4,6 +4,7 @@ import type { Identifier, IdentifierDefinition } from './identifier';
 import { ReferenceType } from './identifier';
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { DataflowGraph } from '../graph/graph';
+import type { AstIdMap } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 /**
  * Resolves a given identifier name to a list of its possible definition location using R scoping and resolving rules.
  *
@@ -18,9 +19,9 @@ export declare function resolveByName(name: Identifier, environment: REnvironmen
 export declare function resolvesToBuiltInConstant(name: Identifier | undefined, environment: REnvironmentInformation, wantedValue: unknown): Ternary;
 export declare function resolveToConstants(name: Identifier | undefined, environment: REnvironmentInformation): unknown[] | undefined;
 export declare function getAliases(sourceIds: readonly NodeId[], dataflow: DataflowGraph, environment: REnvironmentInformation): NodeId[] | undefined;
-export declare function resolveToValues(identifier: Identifier | undefined, environment: REnvironmentInformation, graph: DataflowGraph): unknown[] | undefined;
+export declare function resolveToValues(identifier: Identifier | undefined, environment: REnvironmentInformation, idMap?: AstIdMap): unknown[] | undefined;
 /**
  * Convenience function using the variable resolver as specified within the configuration file
  * In the future we may want to have this set once at the start of the analysis
  */
-export declare function resolveValueOfVariable(identifier: Identifier | undefined, environment: REnvironmentInformation, graph: DataflowGraph): unknown[] | undefined;
+export declare function resolveValueOfVariable(identifier: Identifier | undefined, environment: REnvironmentInformation, idMap?: AstIdMap): unknown[] | undefined;

package/dataflow/environments/resolve-by-name.js

@@ -147,7 +147,7 @@ function getAliases(sourceIds, dataflow, environment) {
     }
     return [...definitions];
 }
-function resolveToValues(identifier, environment, graph) {
+function resolveToValues(identifier, environment, idMap) {
     if (identifier === undefined) {
         return undefined;
     }
@@ -169,7 +169,7 @@ function resolveToValues(identifier, environment, graph) {
                 return undefined;
             }
             for (const id of def.value) {
-                const value = graph.idMap?.get(id)?.content;
+                const value = idMap?.get(id)?.content;
                 if (value !== undefined) {
                     values.push(value);
                 }
@@ -185,10 +185,10 @@ function resolveToValues(identifier, environment, graph) {
  * Convenience function using the variable resolver as specified within the configuration file
  * In the future we may want to have this set once at the start of the analysis
  */
-function resolveValueOfVariable(identifier, environment, graph) {
+function resolveValueOfVariable(identifier, environment, idMap) {
     const resolve = (0, config_1.getConfig)().solver.variables;
     switch (resolve) {
-        case config_1.VariableResolve.Alias: return resolveToValues(identifier, environment, graph);
+        case config_1.VariableResolve.Alias: return resolveToValues(identifier, environment, idMap);
         case config_1.VariableResolve.Builtin: return resolveToConstants(identifier, environment);
         case config_1.VariableResolve.Disabled: return [];
         default: (0, assert_1.assertUnreachable)(resolve);

package/dataflow/extractor.d.ts

@@ -3,5 +3,15 @@ import type { DataflowProcessors } from './processor';
 import type { NormalizedAst, ParentInformation } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { RParseRequests } from '../r-bridge/retriever';
 import type { KnownParserType, Parser } from '../r-bridge/parser';
+/**
+ * The best friend of {@link produceDataFlowGraph} and {@link processDataflowFor}.
+ * Maps every {@link RType} in the normalized AST to a processor.
+ */
 export declare const processors: DataflowProcessors<ParentInformation>;
+/**
+ * This is the main function to produce the dataflow graph from a given request and normalized AST.
+ * Note, that this requires knowledge of the active parser in case the dataflow analysis uncovers other files that have to be parsed and integrated into the analysis
+ * (e.g., in the event of a `source` call).
+ * For the actual, canonical fold entry point, see {@link processDataflowFor}.
+ */
 export declare function produceDataFlowGraph<OtherInfo>(parser: Parser<KnownParserType>, request: RParseRequests, ast: NormalizedAst<OtherInfo & ParentInformation>): DataflowInformation;

package/dataflow/extractor.js

@@ -21,6 +21,10 @@ const cfg_1 = require("../util/cfg/cfg");
 const edge_1 = require("./graph/edge");
 const identify_link_to_last_call_relation_1 = require("../queries/catalog/call-context-query/identify-link-to-last-call-relation");
 const built_in_function_definition_1 = require("./internal/process/functions/call/built-in/built-in-function-definition");
+/**
+ * The best friend of {@link produceDataFlowGraph} and {@link processDataflowFor}.
+ * Maps every {@link RType} in the normalized AST to a processor.
+ */
 exports.processors = {
     [type_1.RType.Number]: process_value_1.processValue,
     [type_1.RType.String]: process_value_1.processValue,
@@ -68,6 +72,12 @@ function resolveLinkToSideEffects(ast, graph) {
         }
     }
 }
+/**
+ * This is the main function to produce the dataflow graph from a given request and normalized AST.
+ * Note, that this requires knowledge of the active parser in case the dataflow analysis uncovers other files that have to be parsed and integrated into the analysis
+ * (e.g., in the event of a `source` call).
+ * For the actual, canonical fold entry point, see {@link processDataflowFor}.
+ */
 function produceDataFlowGraph(parser, request, ast) {
     const multifile = Array.isArray(request);
     let firstRequest;

package/dataflow/internal/process/functions/call/built-in/built-in-if-then-else.js

@@ -33,7 +33,7 @@ function processIfThenElse(name, args, rootId, data) {
     let then;
     let makeThenMaybe = false;
     // we should defer this to the abstract interpretation
-    const values = (0, resolve_by_name_1.resolveValueOfVariable)(condArg?.lexeme, data.environment, cond.graph);
+    const values = (0, resolve_by_name_1.resolveValueOfVariable)(condArg?.lexeme, data.environment, data.completeAst.idMap);
     const conditionIsAlwaysFalse = values?.every(d => d === false) ?? false;
     const conditionIsAlwaysTrue = values?.every(d => d === true) ?? false;
     if (!conditionIsAlwaysFalse) {