@eagleoutice/flowr 2.2.2 → 2.2.4

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.
  *
@@ -16,11 +17,13 @@ import type { DataflowGraph } from '../graph/graph';
  */
 export declare function resolveByName(name: Identifier, environment: REnvironmentInformation, target?: ReferenceType): IdentifierDefinition[] | undefined;
 export declare function resolvesToBuiltInConstant(name: Identifier | undefined, environment: REnvironmentInformation, wantedValue: unknown): Ternary;
+/** Please use {@link resolveValueOfVariable} */
 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;
+/** Please use {@link resolveValueOfVariable} */
+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

@@ -90,6 +90,7 @@ function resolvesToBuiltInConstant(name, environment, wantedValue) {
         return some ? logic_1.Ternary.Maybe : logic_1.Ternary.Never;
     }
 }
+/** Please use {@link resolveValueOfVariable} */
 function resolveToConstants(name, environment) {
     if (name === undefined) {
         return undefined;
@@ -147,7 +148,8 @@ function getAliases(sourceIds, dataflow, environment) {
     }
     return [...definitions];
 }
-function resolveToValues(identifier, environment, graph) {
+/** Please use {@link resolveValueOfVariable} */
+function resolveToValues(identifier, environment, idMap) {
     if (identifier === undefined) {
         return undefined;
     }
@@ -169,7 +171,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 +187,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/graph/resolve-graph.js

@@ -22,7 +22,7 @@ function resolveDataflowGraph(graph, idMap) {
         try {
             resolved = (0, parse_1.slicingCriterionToId)(id, resolveMap);
         }
-        catch (e) {
+        catch {
             /* just keep it :D */
             resolved = id;
         }

package/dataflow/internal/process/functions/call/built-in/built-in-assignment.d.ts

@@ -47,4 +47,4 @@ export interface AssignmentToSymbolParameters<OtherInfo> extends AssignmentConfi
 export declare function markAsAssignment(information: {
     environment: REnvironmentInformation;
     graph: DataflowGraph;
-}, nodeToDefine: InGraphIdentifierDefinition, sourceIds: readonly NodeId[], rootIdOfAssignment: NodeId, config?: AssignmentConfiguration | undefined): void;
+}, nodeToDefine: InGraphIdentifierDefinition, sourceIds: readonly NodeId[], rootIdOfAssignment: NodeId, config?: AssignmentConfiguration): void;

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) {

package/dataflow/internal/process/functions/call/built-in/built-in-source.js

@@ -21,6 +21,8 @@ const log_1 = require("../../../../../../util/log");
 const fs_1 = __importDefault(require("fs"));
 const parser_1 = require("../../../../../../r-bridge/lang-4.x/ast/parser/json/parser");
 const shell_executor_1 = require("../../../../../../r-bridge/shell-executor");
+const resolve_by_name_1 = require("../../../../../environments/resolve-by-name");
+const assert_1 = require("../../../../../../util/assert");
 let sourceProvider = (0, retriever_1.requestProviderFromFile)();
 function setSourceProvider(provider) {
     sourceProvider = provider;
@@ -29,14 +31,28 @@ function processSourceCall(name, args, rootId, data, config) {
     const information = config.includeFunctionCall ?
         (0, known_call_handling_1.processKnownFunctionCall)({ name, args, rootId, data }).information
         : (0, info_1.initializeCleanDataflowInformation)(rootId, data);
-    const sourceFile = args[0];
+    const sourceFileArgument = args[0];
     if (!config.forceFollow && (0, config_1.getConfig)().ignoreSourceCalls) {
-        (0, log_1.expensiveTrace)(logger_1.dataflowLogger, () => `Skipping source call ${JSON.stringify(sourceFile)} (disabled in config file)`);
+        (0, log_1.expensiveTrace)(logger_1.dataflowLogger, () => `Skipping source call ${JSON.stringify(sourceFileArgument)} (disabled in config file)`);
         information.graph.markIdForUnknownSideEffects(rootId);
         return information;
     }
-    if (sourceFile !== r_function_call_1.EmptyArgument && sourceFile?.value?.type === type_1.RType.String) {
-        const path = (0, retriever_1.removeRQuotes)(sourceFile.lexeme);
+    let sourceFile;
+    if (sourceFileArgument !== r_function_call_1.EmptyArgument && sourceFileArgument?.value?.type === type_1.RType.String) {
+        sourceFile = [(0, retriever_1.removeRQuotes)(sourceFileArgument.lexeme)];
+    }
+    else if (sourceFileArgument !== r_function_call_1.EmptyArgument) {
+        sourceFile = (0, resolve_by_name_1.resolveValueOfVariable)(sourceFileArgument.value?.lexeme, data.environment, data.completeAst.idMap)?.map(x => {
+            if (typeof x === 'object' && x && 'str' in x) {
+                return x.str;
+            }
+            else {
+                return undefined;
+            }
+        }).filter(assert_1.isNotUndefined);
+    }
+    if (sourceFile && sourceFile.length === 1) {
+        const path = (0, retriever_1.removeRQuotes)(sourceFile[0]);
         const request = sourceProvider.createRequest(path);
         // check if the sourced file has already been dataflow analyzed, and if so, skip it
         if (data.referenceChain.includes((0, retriever_1.requestFingerprint)(request))) {

package/documentation/data/server/doc-data-server-messages.js

@@ -69,7 +69,7 @@ Requests for the [REPL](#message-request-repl) are independent of that.
 The request allows the server to analyze a file and prepare it for slicing.
 The message can contain a \`filetoken\`, which is used to identify the file in later slice or lineage requests (if you do not add one, the request will not be stored and therefore, it is not available for subsequent requests).
 
-> [!IMPORTANT]
+> **Please note!**\\
 > If you want to send and process a lot of analysis requests, but do not want to slice them, please do not pass the \`filetoken\` field. This will save the server a lot of memory allocation.
 
 Furthermore, the request must contain either a \`content\` field to directly pass the file's content or a \`filepath\` field which contains the path to the file (this path must be accessible for the server to be useful).
@@ -420,7 +420,6 @@ See [above](#message-request-file-analysis) for the general structure of the res
                                 {
                                     type: 'compound',
                                     query: 'call-context',
-                                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- otherwise we would have to carry generic typing information through the test infrastrcuture
                                     commonArguments: {
                                         kind: 'visualize',
                                         subkind: 'text',

package/documentation/doc-util/doc-auto-gen.d.ts

@@ -5,3 +5,4 @@ export interface AutoGenHeaderArguments {
     readonly purpose: string;
 }
 export declare function autoGenHeader({ rVersion, filename, purpose, currentDateAndTime }: AutoGenHeaderArguments): string;
+export declare function fileNameForGenHeader(filename: string): string;

package/documentation/doc-util/doc-auto-gen.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.autoGenHeader = autoGenHeader;
+exports.fileNameForGenHeader = fileNameForGenHeader;
 const version_1 = require("../../util/version");
 const doc_files_1 = require("./doc-files");
 function autoGenHeader({ rVersion, filename, purpose, currentDateAndTime = new Date().toISOString().replace('T', ', ').replace(/\.\d+Z$/, ' UTC') }) {
+    return `_This document was generated from '${fileNameForGenHeader(filename)}' on ${currentDateAndTime} presenting an overview of flowR's ${purpose} (v${(0, version_1.flowrVersion)().format()}${rVersion ? ', using R v' + rVersion : ''}). Please do not edit this file/wiki page directly._`;
+}
+function fileNameForGenHeader(filename) {
     const shortenFilename = filename.replace(/^.*src\//, 'src/');
-    return `_This document was generated from '${(0, doc_files_1.linkFlowRSourceFile)(shortenFilename)}' on ${currentDateAndTime} presenting an overview of flowR's ${purpose} (v${(0, version_1.flowrVersion)().format()}${rVersion ? ', using R v' + rVersion : ''}). Please do not edit this file/wiki page directly._`;
+    return (0, doc_files_1.linkFlowRSourceFile)(shortenFilename);
 }
 //# sourceMappingURL=doc-auto-gen.js.map

package/documentation/doc-util/doc-benchmarks.d.ts

@@ -0,0 +1,23 @@
+interface BenchmarkData {
+    readonly lastUpdate: number;
+    readonly repoUrl: string;
+    readonly entries: Record<string, [BenchmarkElement]>;
+}
+interface BenchmarkElement {
+    readonly commit: Record<string, unknown>;
+    readonly date: number;
+    readonly tool: string;
+    readonly benches: BenchmarkElementBench[];
+}
+interface BenchmarkElementBench {
+    readonly name: string;
+    readonly value: number;
+    readonly unit: string;
+    readonly range: number;
+    readonly extra: string;
+}
+export declare function loadBenchmarkData(): Promise<BenchmarkData>;
+export declare function getLatestBenchmark(suite: string): Promise<BenchmarkElement>;
+export declare function getLastBenchmarkUpdate(): Promise<number>;
+export declare function getLatestDfAnalysisTime(suite: string): Promise<number>;
+export {};

package/documentation/doc-util/doc-benchmarks.js

@@ -0,0 +1,76 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadBenchmarkData = loadBenchmarkData;
+exports.getLatestBenchmark = getLatestBenchmark;
+exports.getLastBenchmarkUpdate = getLastBenchmarkUpdate;
+exports.getLatestDfAnalysisTime = getLatestDfAnalysisTime;
+const path_1 = __importDefault(require("path"));
+const assert_1 = require("../../util/assert");
+const BenchmarkDataPath = path_1.default.resolve(__dirname, '..', '..', '..', 'wiki', 'stats', 'benchmark', 'data.js');
+let benchmarkData = null;
+async function loadBenchmarkData() {
+    if (benchmarkData === null) {
+        // provide a window object to attach to in the import
+        globalThis['window'] = {};
+        await Promise.resolve(`${BenchmarkDataPath}`).then(s => __importStar(require(s)));
+        // @ts-expect-error -- we know that the data is there
+        benchmarkData = window['BENCHMARK_DATA'];
+    }
+    return benchmarkData;
+}
+async function getLatestBenchmark(suite) {
+    // provide a window object to attach to in the import
+    const suiteData = (await loadBenchmarkData()).entries[suite];
+    (0, assert_1.guard)(suiteData, `No benchmark data for suite '${suite}' found!`);
+    return suiteData.sort((a, b) => b.date - a.date)[0];
+}
+async function getLastBenchmarkUpdate() {
+    return (await loadBenchmarkData()).lastUpdate;
+}
+function getBenchmarkElement(bench, name) {
+    const element = bench.benches.find(b => b.name === name);
+    (0, assert_1.guard)(element, `No benchmark data for '${name}' found!`);
+    return element;
+}
+async function getLatestDfAnalysisTime(suite) {
+    const elem = await getLatestBenchmark(suite);
+    const [parse, normalize, analyze] = ['Retrieve AST from R code', 'Normalize R AST', 'Produce dataflow information'].map(name => getBenchmarkElement(elem, name));
+    return parse.value + normalize.value + analyze.value;
+}
+//# sourceMappingURL=doc-benchmarks.js.map

package/documentation/doc-util/doc-code.d.ts

@@ -1,2 +1,3 @@
 export declare function codeBlock(language: string, code: string | undefined): string;
+export declare function codeInline(code: string): string;
 export declare function jsonWithLimit(object: object, maxLength?: number, tooLongText?: string): string;

package/documentation/doc-util/doc-code.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.codeBlock = codeBlock;
+exports.codeInline = codeInline;
 exports.jsonWithLimit = jsonWithLimit;
 const json_1 = require("../../util/json");
 function codeBlock(language, code) {
     return `\n\`\`\`${language}\n${code?.trim() ?? ''}\n\`\`\`\n`;
 }
+function codeInline(code) {
+    return `<code>${code}</code>`;
+}
 function jsonWithLimit(object, maxLength = 5_000, tooLongText = '_As the code is pretty long, we inhibit pretty printing and syntax highlighting (JSON):_') {
     const prettyPrinted = JSON.stringify(object, json_1.jsonReplacer, 2);
     return `

package/documentation/doc-util/doc-dfg.d.ts

@@ -3,19 +3,21 @@ import type { RShell } from '../../r-bridge/shell';
 import type { MermaidMarkdownMark } from '../../util/mermaid/dfg';
 import { DEFAULT_DATAFLOW_PIPELINE } from '../../core/steps/pipeline/default-pipelines';
 import type { PipelineOutput } from '../../core/steps/pipeline/pipeline';
-export declare function printDfGraph(graph: DataflowGraph, mark?: ReadonlySet<MermaidMarkdownMark>): string;
+import type { KnownParser } from '../../r-bridge/parser';
+export declare function printDfGraph(graph: DataflowGraph, mark?: ReadonlySet<MermaidMarkdownMark>, simplified?: boolean): string;
 export interface PrintDataflowGraphOptions {
     readonly mark?: ReadonlySet<MermaidMarkdownMark>;
     readonly showCode?: boolean;
     readonly codeOpen?: boolean;
     readonly exposeResult?: boolean;
     readonly switchCodeAndGraph?: boolean;
+    readonly simplified?: boolean;
 }
 export declare function formatSideEffect(ef: UnknownSidEffect): string;
-export declare function printDfGraphForCode(shell: RShell, code: string, options: PrintDataflowGraphOptions & {
+export declare function printDfGraphForCode(parser: KnownParser, code: string, options: PrintDataflowGraphOptions & {
     exposeResult: true;
 }): Promise<[string, PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>]>;
-export declare function printDfGraphForCode(shell: RShell, code: string, options?: PrintDataflowGraphOptions & {
+export declare function printDfGraphForCode(parser: KnownParser, code: string, options?: PrintDataflowGraphOptions & {
     exposeResult?: false | undefined;
 }): Promise<string>;
 /** returns resolved expected df graph */