@eagleoutice/flowr 2.2.12 → 2.2.14

package/dataflow/internal/process/functions/call/unnamed-call-handling.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnnamedFunctionCallPrefix = void 0;
+exports.UnnamedFunctionCallOrigin = exports.UnnamedFunctionCallPrefix = void 0;
 exports.processUnnamedFunctionCall = processUnnamedFunctionCall;
 const processor_1 = require("../../../../processor");
 const common_1 = require("./common");
@@ -12,6 +12,7 @@ const type_1 = require("../../../../../r-bridge/lang-4.x/ast/model/type");
 const logger_1 = require("../../../../logger");
 const identifier_1 = require("../../../../environments/identifier");
 exports.UnnamedFunctionCallPrefix = 'unnamed-function-call-';
+exports.UnnamedFunctionCallOrigin = 'unnamed';
 function processUnnamedFunctionCall(functionCall, data) {
     const calledFunction = (0, processor_1.processDataflowFor)(functionCall.calledFunction, data);
     const finalGraph = new graph_1.DataflowGraph(data.completeAst.idMap);
@@ -39,15 +40,16 @@ function processUnnamedFunctionCall(functionCall, data) {
         /* can never be a direct built-in-call */
         onlyBuiltin: false,
         cds: data.controlDependencies,
-        args: callArgs // same reference
+        args: callArgs, // same reference
+        origin: [exports.UnnamedFunctionCallOrigin]
     });
-    const inIds = remainingReadInArgs;
+    let inIds = remainingReadInArgs;
     inIds.push({ nodeId: functionRootId, name: functionCallName, controlDependencies: data.controlDependencies, type: identifier_1.ReferenceType.Function });
     if (functionCall.calledFunction.type === type_1.RType.FunctionDefinition) {
         (0, linker_1.linkArgumentsOnCall)(callArgs, functionCall.calledFunction.parameters, finalGraph);
     }
     // push the called function to the ids:
-    inIds.push(...calledFunction.in, ...calledFunction.unknownReferences);
+    inIds = inIds.concat(calledFunction.in, calledFunction.unknownReferences);
     return {
         unknownReferences: [],
         in: inIds,

package/dataflow/internal/process/process-named-call.d.ts

@@ -6,4 +6,4 @@ import type { EmptyArgument } from '../../../r-bridge/lang-4.x/ast/model/nodes/r
 /**
  * Helper function for {@link processNamedCall} using the given `functionName` as the name of the function.
  */
-export declare function processAsNamedCall<OtherInfo>(functionName: RNode<OtherInfo & ParentInformation> & Base<OtherInfo> & Location, data: DataflowProcessorInformation<OtherInfo & ParentInformation>, name: string, args: readonly (RNode<OtherInfo & ParentInformation> | typeof EmptyArgument | undefined)[]): DataflowInformation;
+export declare function processAsNamedCall<OtherInfo>({ info, lexeme, location }: RNode<OtherInfo & ParentInformation> & Base<OtherInfo> & Location, data: DataflowProcessorInformation<OtherInfo & ParentInformation>, name: string, args: readonly (RNode<OtherInfo & ParentInformation> | typeof EmptyArgument | undefined)[]): DataflowInformation;

package/dataflow/internal/process/process-named-call.js

@@ -7,14 +7,14 @@ const type_1 = require("../../../r-bridge/lang-4.x/ast/model/type");
 /**
  * Helper function for {@link processNamedCall} using the given `functionName` as the name of the function.
  */
-function processAsNamedCall(functionName, data, name, args) {
+function processAsNamedCall({ info, lexeme, location }, data, name, args) {
     return (0, named_call_handling_1.processNamedCall)({
         type: type_1.RType.Symbol,
-        info: functionName.info,
+        info,
         content: name,
-        lexeme: functionName.lexeme,
-        location: functionName.location,
+        lexeme,
+        location,
         namespace: undefined
-    }, (0, make_argument_1.wrapArgumentsUnnamed)(args, data.completeAst.idMap), functionName.info.id, data);
+    }, (0, make_argument_1.wrapArgumentsUnnamed)(args, data.completeAst.idMap), info.id, data);
 }
 //# sourceMappingURL=process-named-call.js.map

package/dataflow/origin/dfg-get-origin.d.ts

@@ -0,0 +1,82 @@
+import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import type { DataflowGraph } from '../graph/graph';
+export declare const enum OriginType {
+    ReadVariableOrigin = 0,
+    WriteVariableOrigin = 1,
+    FunctionCallOrigin = 2,
+    BuiltInFunctionOrigin = 3,
+    ConstantOrigin = 4
+}
+/**
+ * An origin that indicates that the definition is read, written, or simply a constant.
+ * These origins only reference the 'direct' dependencies. There is no transitivity.
+ *
+ * @example
+ * ```r
+ * x <- 2
+ * print(x)
+ * ```
+ *
+ * - Requesting the origins for the use of `x` in `print(x)` returns a {@link ReadVariableOrigin} for the definition of `x` in the first line.
+ * - Asking for the origin of the `2` in `x <- 2` returns a {@link ConstantOrigin} for itself.
+ * - Asking for the origin of `x` in `x <- 2` returns a {@link WriteVariableOrigin} for the variable `x`.
+ */
+export interface SimpleOrigin {
+    readonly type: OriginType.ReadVariableOrigin | OriginType.WriteVariableOrigin | OriginType.ConstantOrigin;
+    readonly id: NodeId;
+}
+/**
+ * Determines the (transitive) origin of a function call (i.e., all anonymous function definitions within the program that
+ * can be called).
+ *
+ * @example
+ * ```r
+ * f <- function(x) {
+ *  function(y) { y + x }
+ * }
+ * g <- f(2)
+ * g(3)
+ * ```
+ *
+ * - Requesting the origin of `g(3)` returns a {@link FunctionCallOrigin} for the anonymous function defined and returned within the body of `f`.
+ * - Requesting the origin of `f(2)` returns a {@link FunctionCallOrigin} for the anonymous function bound to f.
+ *
+ * Either also return the {@link SimpleOrigin} for the read of the respective variable definition.
+ */
+export interface FunctionCallOrigin {
+    readonly type: OriginType.FunctionCallOrigin;
+    readonly id: NodeId;
+}
+/**
+ * This is similar to a {@link FunctionCallOrigin}, but used for built-in functions that have no direct correspondence in the dataflow graph.
+ */
+export interface BuiltInFunctionOrigin {
+    readonly type: OriginType.BuiltInFunctionOrigin;
+    /** processor that is used to process the built-in function */
+    readonly id: NodeId;
+    readonly proc: string;
+    readonly fn: OriginIdentifier;
+}
+interface OriginIdentifier {
+    readonly name: string;
+    readonly namespace?: string;
+}
+export type Origin = SimpleOrigin | FunctionCallOrigin | BuiltInFunctionOrigin;
+/**
+ * Obtain the (dataflow) origin of a given node in the dfg.
+ * @example consider the following code:
+ * ```r
+ * x <- 2
+ * if(u) {
+ *   x <- 3
+ * }
+ * print(x)
+ * ```
+ * Requesting the origin of `x` in the `print(x)` node yields two {@link SimpleOriginOrigin|variable origins} for both
+ * definitions of `x`.
+ * Similarly, requesting the origin of `print` returns a {@link BuiltInFunctionOrigin|`BuiltInFunctionOrigin`}.
+ *
+ * This returns undefined only if there is no dataflow correspondence (e.g. in case of unevaluated non-standard eval).
+ */
+export declare function getOriginInDfg(dfg: DataflowGraph, id: NodeId): Origin[] | undefined;
+export {};

package/dataflow/origin/dfg-get-origin.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOriginInDfg = getOriginInDfg;
+const vertex_1 = require("../graph/vertex");
+const edge_1 = require("../graph/edge");
+const linker_1 = require("../internal/linker");
+const assert_1 = require("../../util/assert");
+const built_in_1 = require("../environments/built-in");
+/**
+ * Obtain the (dataflow) origin of a given node in the dfg.
+ * @example consider the following code:
+ * ```r
+ * x <- 2
+ * if(u) {
+ *   x <- 3
+ * }
+ * print(x)
+ * ```
+ * Requesting the origin of `x` in the `print(x)` node yields two {@link SimpleOriginOrigin|variable origins} for both
+ * definitions of `x`.
+ * Similarly, requesting the origin of `print` returns a {@link BuiltInFunctionOrigin|`BuiltInFunctionOrigin`}.
+ *
+ * This returns undefined only if there is no dataflow correspondence (e.g. in case of unevaluated non-standard eval).
+ */
+function getOriginInDfg(dfg, id) {
+    const vtx = dfg.getVertex(id);
+    switch (vtx?.tag) {
+        case undefined:
+            return undefined;
+        case vertex_1.VertexType.Value:
+            return [{ type: 4 /* OriginType.ConstantOrigin */, id }];
+        case vertex_1.VertexType.FunctionDefinition:
+            return [{ type: 4 /* OriginType.ConstantOrigin */, id }];
+        case vertex_1.VertexType.VariableDefinition:
+            return getVariableDefinitionOrigin(dfg, vtx);
+        case vertex_1.VertexType.Use:
+            return getVariableUseOrigin(dfg, vtx);
+        case vertex_1.VertexType.FunctionCall:
+            return getCallTarget(dfg, vtx);
+    }
+}
+const WantedVariableTypes = edge_1.EdgeType.Reads | edge_1.EdgeType.DefinedByOnCall;
+const UnwantedVariableTypes = edge_1.EdgeType.NonStandardEvaluation;
+function getVariableUseOrigin(dfg, use) {
+    // to identify the origins we have to track read edges and definitions on function calls
+    const origins = [];
+    for (const [target, { types }] of dfg.outgoingEdges(use.id) ?? []) {
+        if ((0, edge_1.edgeDoesNotIncludeType)(types, WantedVariableTypes) || (0, edge_1.edgeIncludesType)(types, UnwantedVariableTypes)) {
+            continue;
+        }
+        const targetVtx = dfg.getVertex(target);
+        if (!targetVtx) {
+            continue;
+        }
+        if (targetVtx.tag === vertex_1.VertexType.VariableDefinition) {
+            origins.push({
+                type: 0 /* OriginType.ReadVariableOrigin */,
+                id: target
+            });
+        }
+    }
+    return origins.length > 0 ? origins : undefined;
+}
+function getVariableDefinitionOrigin(dfg, vtx) {
+    const pool = [{ type: 1 /* OriginType.WriteVariableOrigin */, id: vtx.id }];
+    const outgoingReads = dfg.outgoingEdges(vtx.id) ?? [];
+    for (const [target, { types }] of outgoingReads) {
+        if ((0, edge_1.edgeIncludesType)(types, edge_1.EdgeType.Reads)) {
+            const targetVtx = dfg.getVertex(target);
+            if (!targetVtx) {
+                continue;
+            }
+            if (targetVtx.tag === vertex_1.VertexType.VariableDefinition) {
+                pool.push({
+                    type: 0 /* OriginType.ReadVariableOrigin */,
+                    id: target
+                });
+            }
+        }
+    }
+    return pool;
+}
+function getCallTarget(dfg, call) {
+    // check for built-ins:
+    const builtInTarget = call.origin !== 'unnamed' && call.origin.filter(o => o.startsWith('builtin:'));
+    let origins = builtInTarget ? builtInTarget.map(o => ({
+        type: 3 /* OriginType.BuiltInFunctionOrigin */,
+        fn: { name: call.name },
+        id: call.id,
+        proc: o
+    })) : undefined;
+    const targets = new Set((0, linker_1.getAllFunctionCallTargets)(call.id, dfg));
+    if (targets.size === 0) {
+        return origins;
+    }
+    origins = (origins ?? []).concat([...targets].map(target => {
+        if ((0, built_in_1.isBuiltIn)(target)) {
+            return {
+                type: 3 /* OriginType.BuiltInFunctionOrigin */,
+                fn: { name: call.name },
+                id: call.id,
+                proc: target
+            };
+        }
+        const get = dfg.getVertex(target);
+        if (get?.tag !== vertex_1.VertexType.FunctionDefinition && get?.tag !== vertex_1.VertexType.VariableDefinition) {
+            return undefined;
+        }
+        return {
+            type: get.tag === vertex_1.VertexType.FunctionDefinition ? 2 /* OriginType.FunctionCallOrigin */ : 0 /* OriginType.ReadVariableOrigin */,
+            id: target
+        };
+    }).filter(assert_1.isNotUndefined));
+    return origins;
+}
+//# sourceMappingURL=dfg-get-origin.js.map

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

@@ -1,16 +1,23 @@
-import type { ControlFlowInformation } from '../../util/cfg/cfg';
 import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import type { KnownParser } from '../../r-bridge/parser';
 import type { DataflowInformation } from '../../dataflow/info';
-export declare function getCfg(parser: KnownParser, code: string): Promise<{
+import type { ControlFlowInformation } from '../../control-flow/control-flow-graph';
+import type { CfgSimplificationPassName } from '../../control-flow/cfg-simplification';
+type GetCfgReturn = {
     info: ControlFlowInformation;
     ast: NormalizedAst;
-    dataflow: DataflowInformation;
-}>;
-export declare function printCfg(cfg: ControlFlowInformation, ast: NormalizedAst, prefix?: string): string;
+    dataflow?: DataflowInformation;
+};
+export declare function getCfg(parser: KnownParser, code: string, simplifications?: readonly CfgSimplificationPassName[], useDfg?: true): Promise<Required<GetCfgReturn>>;
+export declare function getCfg(parser: KnownParser, code: string, simplifications?: readonly CfgSimplificationPassName[], useDfg?: boolean): Promise<GetCfgReturn>;
+export declare function printCfg(cfg: ControlFlowInformation, ast: NormalizedAst, prefix?: string, simplify?: boolean): string;
 export interface PrintCfgOptions {
     readonly showCode?: boolean;
     readonly openCode?: boolean;
     readonly prefix?: string;
+    readonly simplifications?: readonly CfgSimplificationPassName[];
+    readonly simplify?: boolean;
+    readonly useDfg?: boolean;
 }
-export declare function printCFGCode(parser: KnownParser, code: string, { showCode, openCode, prefix }?: PrintCfgOptions): Promise<string>;
+export declare function printCfgCode(parser: KnownParser, code: string, { showCode, openCode, prefix, simplifications, simplify, useDfg }?: PrintCfgOptions): Promise<string>;
+export {};

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

@@ -2,36 +2,41 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCfg = getCfg;
 exports.printCfg = printCfg;
-exports.printCFGCode = printCFGCode;
-const cfg_1 = require("../../util/cfg/cfg");
+exports.printCfgCode = printCfgCode;
+const extract_cfg_1 = require("../../control-flow/extract-cfg");
 const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines");
 const retriever_1 = require("../../r-bridge/retriever");
-const time_1 = require("../../util/time");
+const time_1 = require("../../util/text/time");
 const doc_files_1 = require("./doc-files");
-const cfg_2 = require("../../util/mermaid/cfg");
+const cfg_1 = require("../../util/mermaid/cfg");
 const doc_code_1 = require("./doc-code");
-async function getCfg(parser, code) {
-    const result = await (0, default_pipelines_1.createDataflowPipeline)(parser, {
+const cfg_simplification_1 = require("../../control-flow/cfg-simplification");
+async function getCfg(parser, code, simplifications = [], useDfg = true) {
+    const result = useDfg ? await (0, default_pipelines_1.createDataflowPipeline)(parser, {
+        request: (0, retriever_1.requestFromInput)(code)
+    }).allRemainingSteps() : await (0, default_pipelines_1.createNormalizePipeline)(parser, {
         request: (0, retriever_1.requestFromInput)(code)
     }).allRemainingSteps();
-    const cfg = (0, cfg_1.extractCFG)(result.normalize, result.dataflow.graph);
+    const cfg = (0, extract_cfg_1.extractCfg)(result.normalize, useDfg ? result.dataflow.graph : undefined, [...cfg_simplification_1.DefaultCfgSimplificationOrder, ...simplifications]);
     return {
         info: cfg,
         ast: result.normalize,
-        dataflow: result.dataflow
+        dataflow: 'dataflow' in result ? result.dataflow : undefined
     };
 }
-function printCfg(cfg, ast, prefix = 'flowchart TD\n') {
+function printCfg(cfg, ast, prefix = 'flowchart BT\n', simplify = false) {
     return `
-${(0, doc_code_1.codeBlock)('mermaid', (0, cfg_2.cfgToMermaid)(cfg, ast, prefix))}
+${(0, doc_code_1.codeBlock)('mermaid', (0, cfg_1.cfgToMermaid)(cfg, ast, prefix, simplify))}
 	`;
 }
-async function printCFGCode(parser, code, { showCode = true, openCode = false, prefix = 'flowchart BT\n' } = {}) {
+async function printCfgCode(parser, code, { showCode = true, openCode = false, prefix = 'flowchart BT\n', simplifications = [], simplify = false, useDfg = true } = {}) {
     const now = performance.now();
-    const res = await getCfg(parser, code);
+    const res = await getCfg(parser, code, simplifications, useDfg);
     const duration = performance.now() - now;
-    const metaInfo = `The analysis required _${(0, time_1.printAsMs)(duration)}_ (including the dataflow analysis, normalization, and parsing with the [${parser.name}](${doc_files_1.FlowrWikiBaseRef}/Engines) engine) within the generation environment.`;
-    return '\n\n' + printCfg(res.info, res.ast, prefix) + (showCode ? `
+    const metaInfo = `The analysis required _${(0, time_1.printAsMs)(duration)}_ (including the ${useDfg ? 'dataflow analysis, ' : ''} normalization${useDfg ? ', ' : ''} and parsing with the [${parser.name}](${doc_files_1.FlowrWikiBaseRef}/Engines) engine) within the generation environment.
+We used the following simplification${(simplifications?.length ?? 0) + cfg_simplification_1.DefaultCfgSimplificationOrder.length != 1 ? 's' : ''}: ${[...cfg_simplification_1.DefaultCfgSimplificationOrder, ...simplifications].map(s => '`' + s + '`').join(', ')} ${simplify ? ' and render a simplified/compacted version' : ''}.
+	`;
+    return '\n\n' + printCfg(res.info, res.ast, prefix, simplify) + (showCode ? `
 <details${openCode ? ' open' : ''}>
 
 <summary style="color:gray">R Code of the CFG</summary>
@@ -42,6 +47,6 @@ ${(0, doc_code_1.codeBlock)('r', code)}
 
 </details>
 
-` : '\n(' + metaInfo + ')\n\n');
+` : '\n_(' + metaInfo + ')_\n\n');
 }
 //# sourceMappingURL=doc-cfg.js.map

package/documentation/doc-util/doc-cli-option.js

@@ -9,16 +9,18 @@ const assert_1 = require("../../util/assert");
 const html_hover_over_1 = require("../../util/html-hover-over");
 const flowr_main_options_1 = require("../../cli/flowr-main-options");
 const repl_commands_1 = require("../../cli/repl/commands/repl-commands");
+const doc_escape_1 = require("./doc-escape");
 function getCliLongOptionOf(scriptName, optionName, withAlias = false, quote = true) {
     const script = scriptName === 'flowr' ? flowr_main_options_1.flowrMainOptionDefinitions : scripts_info_1.scripts[scriptName].options;
     (0, assert_1.guard)(script !== undefined, () => `Unknown script ${scriptName}, pick one of ${JSON.stringify(Object.keys(scripts_info_1.scripts))}.`);
     const option = script.find(({ name }) => name === optionName);
     (0, assert_1.guard)(option !== undefined, () => `Unknown option ${optionName}, pick one of ${JSON.stringify(script.map(o => o.name))}.`);
     const char = quote ? '`' : '';
-    const alias = withAlias && option.alias ? ' (alias:' + (0, html_hover_over_1.textWithTooltip)(`${char}-${option.alias}${char}`, option.description) + ')' : '';
+    const description = (0, doc_escape_1.escapeHTML)(option.description);
+    const alias = withAlias && option.alias ? ' (alias:' + (0, html_hover_over_1.textWithTooltip)(`${char}-${option.alias}${char}`, description) + ')' : '';
     const ligatureBreaker = quote ? '' : '<span/>';
     // span ensures split even with ligatures
-    return (0, html_hover_over_1.textWithTooltip)(`${char}-${ligatureBreaker}-${optionName}${char}`, 'Description (Command Line Argument): ' + option.description) + alias;
+    return (0, html_hover_over_1.textWithTooltip)(`${char}-${ligatureBreaker}-${optionName}${char}`, 'Description (Command Line Argument): ' + description) + alias;
 }
 function multipleCliOptions(scriptName, ...options) {
     return options.map(o => getCliLongOptionOf(scriptName, o, false, true)).join(' ');

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

@@ -10,9 +10,9 @@ const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines
 const retriever_1 = require("../../r-bridge/retriever");
 const decorate_1 = require("../../r-bridge/lang-4.x/ast/model/processing/decorate");
 const resolve_graph_1 = require("../../dataflow/graph/resolve-graph");
-const diff_1 = require("../../dataflow/graph/diff");
+const diff_dataflow_graph_1 = require("../../dataflow/graph/diff-dataflow-graph");
 const assert_1 = require("../../util/assert");
-const time_1 = require("../../util/time");
+const time_1 = require("../../util/text/time");
 const doc_files_1 = require("./doc-files");
 const doc_code_1 = require("./doc-code");
 function printDfGraph(graph, mark, simplified = false) {
@@ -79,7 +79,7 @@ async function verifyExpectedSubgraph(shell, code, expectedSubgraph) {
     }).allRemainingSteps();
     expectedSubgraph.setIdMap(info.normalize.idMap);
     expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph);
-    const report = (0, diff_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
+    const report = (0, diff_dataflow_graph_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
         leftIsSubgraph: true
     });
     (0, assert_1.guard)(report.isEqual(), () => `report:\n * ${report.comments()?.join('\n * ') ?? ''}`);

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

@@ -0,0 +1,7 @@
+/**
+ * Escapes HTML special characters in a string.
+ *
+ * @param str - The string to escape
+ * @returns The escaped string
+ */
+export declare function escapeHTML(str: string | undefined): string | undefined;

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.escapeHTML = escapeHTML;
+/**
+ * Escapes HTML special characters in a string.
+ *
+ * @param str - The string to escape
+ * @returns The escaped string
+ */
+function escapeHTML(str) {
+    return str?.replace(/[&<>"']/g, (tag) => ({
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+        '"': '&quot;',
+        "'": '&#39;',
+    }[tag] ?? tag));
+}
+//# sourceMappingURL=doc-escape.js.map

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

@@ -6,6 +6,7 @@ export declare const FlowrNpmRef = "https://www.npmjs.com/package/@eagleoutice/f
 export declare const FlowrDockerRef = "https://hub.docker.com/r/eagleoutice/flowr";
 export declare const FlowrCodecovRef = "https://app.codecov.io/gh/flowr-analysis/flowr";
 export declare const FlowrVsCode = "https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr";
+export declare const FlowrPositron = "https://open-vsx.org/extension/code-inspect/vscode-flowr";
 export declare function getFilePathMd(path: string): string;
 export declare function getFileContentFromRoot(path: string): string;
 export declare function linkFlowRSourceFile(path: string): string;

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

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlowrVsCode = exports.FlowrCodecovRef = exports.FlowrDockerRef = exports.FlowrNpmRef = exports.FlowrWikiBaseRef = exports.RemoteFlowrFilePathBaseRef = exports.FlowrSiteBaseRef = exports.FlowrGithubBaseRef = void 0;
+exports.FlowrPositron = exports.FlowrVsCode = exports.FlowrCodecovRef = exports.FlowrDockerRef = exports.FlowrNpmRef = exports.FlowrWikiBaseRef = exports.RemoteFlowrFilePathBaseRef = exports.FlowrSiteBaseRef = exports.FlowrGithubBaseRef = void 0;
 exports.getFilePathMd = getFilePathMd;
 exports.getFileContentFromRoot = getFileContentFromRoot;
 exports.linkFlowRSourceFile = linkFlowRSourceFile;
@@ -16,6 +16,7 @@ exports.FlowrNpmRef = 'https://www.npmjs.com/package/@eagleoutice/flowr';
 exports.FlowrDockerRef = 'https://hub.docker.com/r/eagleoutice/flowr';
 exports.FlowrCodecovRef = 'https://app.codecov.io/gh/flowr-analysis/flowr';
 exports.FlowrVsCode = 'https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr';
+exports.FlowrPositron = 'https://open-vsx.org/extension/code-inspect/vscode-flowr';
 function getFilePathMd(path) {
     // we go one up as we are in doc-util now :D #convenience
     const fullpath = require.resolve('../' + path);

package/documentation/doc-util/doc-normalized-ast.js

@@ -7,10 +7,10 @@ const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines
 const retriever_1 = require("../../r-bridge/retriever");
 const decorate_1 = require("../../r-bridge/lang-4.x/ast/model/processing/decorate");
 const resolve_graph_1 = require("../../dataflow/graph/resolve-graph");
-const diff_1 = require("../../dataflow/graph/diff");
+const diff_dataflow_graph_1 = require("../../dataflow/graph/diff-dataflow-graph");
 const assert_1 = require("../../util/assert");
 const ast_1 = require("../../util/mermaid/ast");
-const time_1 = require("../../util/time");
+const time_1 = require("../../util/text/time");
 const doc_files_1 = require("./doc-files");
 function printNormalizedAst(ast, prefix = 'flowchart TD\n') {
     return `
@@ -60,7 +60,7 @@ async function verifyExpectedSubgraph(shell, code, expectedSubgraph) {
     }).allRemainingSteps();
     expectedSubgraph.setIdMap(info.normalize.idMap);
     expectedSubgraph = (0, resolve_graph_1.resolveDataflowGraph)(expectedSubgraph);
-    const report = (0, diff_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
+    const report = (0, diff_dataflow_graph_1.diffOfDataflowGraphs)({ name: 'expected', graph: expectedSubgraph }, { name: 'got', graph: info.dataflow.graph }, {
         leftIsSubgraph: true
     });
     (0, assert_1.guard)(report.isEqual(), () => `report:\n * ${report.comments()?.join('\n * ') ?? ''}`);

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

@@ -11,11 +11,11 @@ const pipeline_executor_1 = require("../../core/pipeline-executor");
 const default_pipelines_1 = require("../../core/steps/pipeline/default-pipelines");
 const retriever_1 = require("../../r-bridge/retriever");
 const json_1 = require("../../util/json");
-const ansi_1 = require("../../util/ansi");
+const ansi_1 = require("../../util/text/ansi");
 const doc_files_1 = require("./doc-files");
 const doc_dfg_1 = require("./doc-dfg");
 const doc_code_1 = require("./doc-code");
-const time_1 = require("../../util/time");
+const time_1 = require("../../util/text/time");
 const query_print_1 = require("../../queries/query-print");
 async function showQuery(shell, code, queries, { showCode, collapseResult, collapseQuery } = {}) {
     const now = performance.now();

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

@@ -6,7 +6,7 @@ const repl_commands_1 = require("../../cli/repl/commands/repl-commands");
 const doc_cli_option_1 = require("./doc-cli-option");
 const html_hover_over_1 = require("../../util/html-hover-over");
 const core_1 = require("../../cli/repl/core");
-const ansi_1 = require("../../util/ansi");
+const ansi_1 = require("../../util/text/ansi");
 const doc_docker_1 = require("./doc-docker");
 const prompt_1 = require("../../cli/repl/prompt");
 const doc_code_1 = require("./doc-code");

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

@@ -12,7 +12,7 @@ const retriever_1 = require("../../r-bridge/retriever");
 const doc_files_1 = require("./doc-files");
 const doc_dfg_1 = require("./doc-dfg");
 const doc_code_1 = require("./doc-code");
-const time_1 = require("../../util/time");
+const time_1 = require("../../util/text/time");
 const flowr_search_executor_1 = require("../../search/flowr-search-executor");
 const flowr_search_printer_1 = require("../../search/flowr-search-printer");
 const node_id_1 = require("../../r-bridge/lang-4.x/ast/model/processing/node-id");

package/documentation/doc-util/doc-server-message.js

@@ -6,11 +6,11 @@ exports.inServerContext = inServerContext;
 exports.documentServerMessageResponse = documentServerMessageResponse;
 const doc_files_1 = require("./doc-files");
 const schema_1 = require("../../util/schema");
-const ansi_1 = require("../../util/ansi");
+const ansi_1 = require("../../util/text/ansi");
 const net_1 = require("../../../test/functionality/_helper/net");
 const doc_code_1 = require("./doc-code");
 const assert_1 = require("../../util/assert");
-const time_1 = require("../../util/time");
+const time_1 = require("../../util/text/time");
 const messages = [];
 function documentServerMessage(description) {
     messages.push(description);

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

@@ -10,3 +10,4 @@ export interface BlockOptions {
     readonly content: string;
 }
 export declare function block({ type, content }: BlockOptions): string;
+export declare function section(title: string, depth?: 1 | 2 | 3 | 4 | 5 | 6, anchor?: string): string;

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

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.details = details;
 exports.block = block;
+exports.section = section;
 const doc_general_1 = require("./doc-general");
+const mermaid_1 = require("../../util/mermaid/mermaid");
 function details(title, content, { color, open = false, hideIfEmpty = true, prefixInit = '' } = {}) {
     return hideIfEmpty && content.trim().length === 0 ? '' : `
 ${prefixInit}<details${open ? ' open' : ''}><summary style="${color ? 'color:' + color : ''}">${title}</summary>
@@ -18,4 +20,7 @@ function block({ type, content }) {
 ${(0, doc_general_1.prefixLines)(content, '> ')}
 `;
 }
+function section(title, depth = 2, anchor = (0, mermaid_1.escapeId)(title)) {
+    return `<h${depth} id="${anchor}">${title}</h${depth}>`;
+}
 //# sourceMappingURL=doc-structure.js.map

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

@@ -37,6 +37,11 @@ export interface PrintHierarchyArguments {
 }
 export declare const mermaidHide: string[];
 export declare function printHierarchy({ program, info, root, collapseFromNesting, initialNesting, maxDepth, openTop }: PrintHierarchyArguments): string;
+interface FnInfo {
+    info: TypeElementInSource[];
+    program: ts.Program;
+}
+export declare function printCodeOfElement({ program, info }: FnInfo, name: string): string;
 /**
  * Create a short link to a type in the documentation
  * @param name      - The name of the type, e.g. `MyType`, may include a container, e.g.,`MyContainer::MyType` (this works with function nestings too)
@@ -46,4 +51,5 @@ export declare function printHierarchy({ program, info, root, collapseFromNestin
  * @param realNameWrapper - How to highlight the function in name in the `x::y` format?
  */
 export declare function shortLink(name: string, hierarchy: readonly TypeElementInSource[], codeStyle?: boolean, realNameWrapper?: string): string;
-export declare function getDocumentationForType(name: string, hierarchy: TypeElementInSource[]): string;
+export declare function getDocumentationForType(name: string, hierarchy: TypeElementInSource[], prefix?: string): string;
+export {};

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

@@ -10,6 +10,7 @@ exports.getTypePathLink = getTypePathLink;
 exports.getTypesFromFolderAsMermaid = getTypesFromFolderAsMermaid;
 exports.implSnippet = implSnippet;
 exports.printHierarchy = printHierarchy;
+exports.printCodeOfElement = printCodeOfElement;
 exports.shortLink = shortLink;
 exports.getDocumentationForType = getDocumentationForType;
 const typescript_1 = __importDefault(require("typescript"));
@@ -21,6 +22,7 @@ const mermaid_1 = require("../../util/mermaid/mermaid");
 const doc_code_1 = require("./doc-code");
 const doc_structure_1 = require("./doc-structure");
 const html_hover_over_1 = require("../../util/html-hover-over");
+const doc_general_1 = require("./doc-general");
 function getSourceFiles(fileNames) {
     try {
         const program = typescript_1.default.createProgram(fileNames, { target: typescript_1.default.ScriptTarget.ESNext });
@@ -345,6 +347,15 @@ function printHierarchy({ program, info, root, collapseFromNesting = 1, initialN
         return thisLine + (out ? '\n' + out : '');
     }
 }
+function printCodeOfElement({ program, info }, name) {
+    const node = info.find(e => e.name === name);
+    if (!node) {
+        console.error(`Could not find node ${name} when resolving function!`);
+        return '';
+    }
+    const code = node.node.getFullText(program.getSourceFile(node.node.getSourceFile().fileName));
+    return `${(0, doc_code_1.codeBlock)('ts', code)}\n<i>Defined at <a href="${getTypePathLink(node)}">${getTypePathLink(node, '.')}</a></i>\n`;
+}
 function retrieveNode(name, hierarchy) {
     let container = undefined;
     if (name.includes('::')) {
@@ -385,12 +396,12 @@ function shortLink(name, hierarchy, codeStyle = true, realNameWrapper = 'b') {
     return `[${codeStyle ? '<code>' : ''}${(node.comments?.length ?? 0) > 0 ?
         (0, html_hover_over_1.textWithTooltip)(pkg ? `${pkg}::<${realNameWrapper}>${mainName}</${realNameWrapper}>` : mainName, comments.length > 400 ? comments.slice(0, 400) + '...' : comments) : node.name}${codeStyle ? '</code>' : ''}](${getTypePathLink(node)})`;
 }
-function getDocumentationForType(name, hierarchy) {
+function getDocumentationForType(name, hierarchy, prefix = '') {
     const res = retrieveNode(name, hierarchy);
     if (!res) {
         return '';
     }
     const [, , node] = res;
-    return node.comments?.join('\n') ?? '';
+    return (0, doc_general_1.prefixLines)(node.comments?.join('\n') ?? '', prefix);
 }
 //# sourceMappingURL=doc-types.js.map