@eagleoutice/flowr 2.4.8 → 2.6.0

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

@@ -1,16 +1,13 @@
 import type { RShell } from '../../r-bridge/shell';
-import type { Queries, QueryResults, SupportedQueryTypes } from '../../queries/query';
-import { DEFAULT_DATAFLOW_PIPELINE } from '../../core/steps/pipeline/default-pipelines';
+import type { Queries, SupportedQueryTypes } from '../../queries/query';
 import type { SupportedVirtualQueryTypes } from '../../queries/virtual-query/virtual-queries';
 import type { VirtualCompoundConstraint } from '../../queries/virtual-query/compound-query';
-import type { PipelineOutput } from '../../core/steps/pipeline/pipeline';
-export interface ShowQueryOptions<Base extends SupportedQueryTypes> {
+export interface ShowQueryOptions {
     readonly showCode?: boolean;
     readonly collapseResult?: boolean;
     readonly collapseQuery?: boolean;
-    readonly addOutput?: (result: QueryResults<Base>, pipeline: PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>) => string;
 }
-export declare function showQuery<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(shell: RShell, code: string, queries: Queries<Base, VirtualArguments>, { showCode, collapseResult, collapseQuery, addOutput }?: ShowQueryOptions<Base>): Promise<string>;
+export declare function showQuery<Base extends SupportedQueryTypes, VirtualArguments extends VirtualCompoundConstraint<Base> = VirtualCompoundConstraint<Base>>(shell: RShell, code: string, queries: Queries<Base, VirtualArguments>, { showCode, collapseResult, collapseQuery }?: ShowQueryOptions): Promise<string>;
 export interface QueryDocumentation {
     readonly name: string;
     readonly type: 'virtual' | 'active';

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

@@ -6,9 +6,6 @@ exports.registerQueryDocumentation = registerQueryDocumentation;
 exports.linkToQueryOfName = linkToQueryOfName;
 exports.tocForQueryType = tocForQueryType;
 exports.explainQueries = explainQueries;
-const query_1 = require("../../queries/query");
-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/text/ansi");
@@ -17,19 +14,12 @@ const doc_dfg_1 = require("./doc-dfg");
 const doc_code_1 = require("./doc-code");
 const time_1 = require("../../util/text/time");
 const query_print_1 = require("../../queries/query-print");
+const flowr_analyzer_builder_1 = require("../../project/flowr-analyzer-builder");
 const doc_cli_option_1 = require("./doc-cli-option");
-const config_1 = require("../../config");
-async function showQuery(shell, code, queries, { showCode, collapseResult, collapseQuery, addOutput = () => '' } = {}) {
+async function showQuery(shell, code, queries, { showCode, collapseResult, collapseQuery } = {}) {
     const now = performance.now();
-    const analysis = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
-        parser: shell,
-        request: (0, retriever_1.requestFromInput)(code)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
-    const results = await Promise.resolve((0, query_1.executeQueries)({
-        dataflow: analysis.dataflow,
-        ast: analysis.normalize,
-        config: (0, config_1.cloneConfig)(config_1.defaultConfigOptions)
-    }, queries));
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder((0, retriever_1.requestFromInput)(code)).setParser(shell).build();
+    const results = await analyzer.query(queries);
     const duration = performance.now() - now;
     const metaInfo = `
 The analysis required _${(0, time_1.printAsMs)(duration)}_ (including parsing and normalization and the query) within the generation environment.
@@ -52,7 +42,7 @@ ${collapseResult ? ' <details> <summary style="color:gray">Show Results</summary
 
 _Results (prettified and summarized):_
 
-${(0, query_print_1.asciiSummaryOfQueryResult)(ansi_1.markdownFormatter, duration, results, analysis, queries)}
+${await (0, query_print_1.asciiSummaryOfQueryResult)(ansi_1.markdownFormatter, duration, results, analyzer, queries)}
 
 <details> <summary style="color:gray">Show Detailed Results as Json</summary>
 
@@ -75,8 +65,6 @@ ${await (0, doc_dfg_1.printDfGraphForCode)(shell, code, { switchCodeAndGraph: tr
 
 ${collapseResult ? '</details>' : ''}
 
-${addOutput(results, analysis)}
-
 	`;
 }
 exports.RegisteredQueries = {

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

@@ -6,29 +6,26 @@ exports.registerQueryDocumentation = registerQueryDocumentation;
 exports.linkToQueryOfName = linkToQueryOfName;
 exports.tocForQueryType = tocForQueryType;
 exports.explainQueries = explainQueries;
-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 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/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");
 const dfg_1 = require("../../util/mermaid/dfg");
-const config_1 = require("../../config");
+const flowr_analyzer_builder_1 = require("../../project/flowr-analyzer-builder");
 async function showSearch(shell, code, search, { collapseResult = true } = {}) {
     const now = performance.now();
-    const analysis = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
-        parser: shell,
-        request: (0, retriever_1.requestFromInput)(code)
-    }, config_1.defaultConfigOptions).allRemainingSteps();
-    const result = (0, flowr_search_executor_1.runSearch)(search, { ...analysis, config: config_1.defaultConfigOptions });
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder((0, retriever_1.requestFromInput)(code))
+        .setParser(shell)
+        .build();
+    const result = await analyzer.runSearch(search);
     const duration = performance.now() - now;
     const metaInfo = `
 The search required _${(0, time_1.printAsMs)(duration)}_ (including parsing and normalization and the query) within the generation environment.
 	`.trim();
+    const dataflow = await analyzer.dataflow();
     return `
 
 ${(0, doc_code_1.codeBlock)('ts', (0, flowr_search_printer_1.flowrSearchToCode)(search))}
@@ -53,7 +50,7 @@ ${(0, doc_code_1.codeBlock)('json', JSON.stringify(search, null, 2))}
 ${collapseResult ? ' <details> <summary style="color:gray">Show Results</summary>' : ''}
 
 The query returns the following vetices (all references to \`x\` in the code):
-${result.getElements().map(({ node }) => `<b>${node.info.id} ('${(0, node_id_1.recoverContent)(node.info.id, analysis.dataflow.graph)}')</b> at L${(0, dfg_1.formatRange)(node.location)}`).join(', ')}
+${result.getElements().map(({ node }) => `<b>${node.info.id} ('${(0, node_id_1.recoverContent)(node.info.id, dataflow.graph)}')</b> at L${(0, dfg_1.formatRange)(node.location)}`).join(', ')}
 
 ${metaInfo}	
 

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

@@ -11,3 +11,7 @@ export interface BlockOptions {
 }
 export declare function block({ type, content }: BlockOptions): string;
 export declare function section(title: string, depth?: 1 | 2 | 3 | 4 | 5 | 6, anchor?: string): string;
+/**
+ * Supported pattern: `Name@link`
+ */
+export declare function collapsibleToc(content: Record<string, Record<string, Record<string, undefined> | undefined> | undefined>): string;

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

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.details = details;
 exports.block = block;
 exports.section = section;
+exports.collapsibleToc = collapsibleToc;
 const doc_general_1 = require("./doc-general");
 const mermaid_1 = require("../../util/mermaid/mermaid");
+const strings_1 = require("../../util/text/strings");
 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>
@@ -23,4 +25,30 @@ ${(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}>`;
 }
+function strToLink(str) {
+    const match = str.match(/^(.*?)@(.*)$/);
+    if (match) {
+        const [, name, link] = match;
+        return `[${name}](${link})`;
+    }
+    return `[${str}](#${(0, mermaid_1.escapeId)(str)})`;
+}
+/**
+ * Supported pattern: `Name@link`
+ */
+function collapsibleToc(content) {
+    let output = '';
+    for (const [section, subsections] of Object.entries(content)) {
+        output += `- ${strToLink(section)}\n`;
+        if (subsections) {
+            for (const [subsection, items] of Object.entries(subsections)) {
+                output += `  - ${strToLink(subsection)}  \n`;
+                if (items) {
+                    output += `    ${(0, strings_1.joinWithLast)(Object.keys(items).map(strToLink))}\n`;
+                }
+            }
+        }
+    }
+    return output;
+}
 //# sourceMappingURL=doc-structure.js.map

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

@@ -62,8 +62,12 @@ export declare function printHierarchy({ program, info, root, collapseFromNestin
 interface FnInfo {
     info: TypeElementInSource[];
     program: ts.Program;
+    dropLinesStart?: number;
+    dropLinesEnd?: number;
+    doNotAutoGobble?: boolean;
+    hideDefinedAt?: boolean;
 }
-export declare function printCodeOfElement({ program, info }: FnInfo, name: string): string;
+export declare function printCodeOfElement({ program, info, dropLinesEnd, dropLinesStart, doNotAutoGobble, hideDefinedAt }: 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)

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

@@ -387,14 +387,40 @@ function printHierarchy({ program, info, root, collapseFromNesting = 1, initialN
         return thisLine + (out ? '\n' + out : '');
     }
 }
-function printCodeOfElement({ program, info }, name) {
+function printCodeOfElement({ program, info, dropLinesEnd = 0, dropLinesStart = 0, doNotAutoGobble, hideDefinedAt }, 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`;
+    let code = node.node.getFullText(program.getSourceFile(node.node.getSourceFile().fileName)).trim();
+    if (dropLinesStart > 0 || dropLinesEnd > 0) {
+        const lines = code.split(/\n/g);
+        if (dropLinesStart + dropLinesEnd >= lines.length) {
+            return '';
+        }
+        code = lines.slice(dropLinesStart, lines.length - dropLinesEnd).join('\n');
+    }
+    if (!doNotAutoGobble) {
+        // gobble leading spaces
+        const lines = code.replaceAll('\t', '    ').split(/\n/g);
+        let gobble = Number.POSITIVE_INFINITY;
+        for (const line of lines) {
+            const match = line.match(/^(\s+)\S+/);
+            if (match) {
+                gobble = Math.min(gobble, match[1].length);
+            }
+        }
+        if (gobble !== Number.POSITIVE_INFINITY && gobble > 0) {
+            code = lines.map(line => line.startsWith(' '.repeat(gobble)) ? line.slice(gobble) : line).join('\n');
+        }
+    }
+    if (hideDefinedAt) {
+        return (0, doc_code_1.codeBlock)('ts', code);
+    }
+    else {
+        return `${(0, doc_code_1.codeBlock)('ts', code)}\n<i>Defined at <a href="${getTypePathLink(node)}">${getTypePathLink(node, '.')}</a></i>\n`;
+    }
 }
 function fuzzyCompare(a, b) {
     const aStr = a.toLowerCase().replace(/[^a-z0-9]/g, '-').trim();

package/documentation/print-analyzer-wiki.d.ts

@@ -0,0 +1 @@
+export {};

package/documentation/print-analyzer-wiki.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const shell_1 = require("../r-bridge/shell");
+const log_1 = require("../../test/functionality/_helper/log");
+const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
+const doc_types_1 = require("./doc-util/doc-types");
+const path_1 = __importDefault(require("path"));
+const flowr_analyzer_1 = require("../project/flowr-analyzer");
+const flowr_analyzer_builder_1 = require("../project/flowr-analyzer-builder");
+const doc_structure_1 = require("./doc-util/doc-structure");
+const doc_files_1 = require("./doc-util/doc-files");
+async function analyzerQuickExample() {
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
+        .addRequestFromInput('x <- 1; print(x)')
+        .setEngine('tree-sitter')
+        .build();
+    // get the dataflow
+    const df = await analyzer.dataflow();
+    // obtain the identified loading order
+    console.log(analyzer.inspectContext().files.loadingOrder.getLoadingOrder());
+    // run a dependency query
+    const results = await analyzer.query([{ type: 'dependencies' }]);
+    return { analyzer, df, results };
+}
+async function getText(shell) {
+    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
+    const types = (0, doc_types_1.getTypesFromFolder)({
+        rootFolder: path_1.default.resolve('src/'),
+        inlineTypes: doc_types_1.mermaidHide
+    });
+    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'analyzer', rVersion: rversion })}
+
+We are currently working on documenting the capabilities of the analyzer (with the plugins, their loading order, etc.). In general, the code documentation
+starting with the ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, types.info)} and the ${(0, doc_types_1.shortLink)(flowr_analyzer_builder_1.FlowrAnalyzerBuilder.name, types.info)} 
+should be the best starting point.
+
+${(0, doc_structure_1.collapsibleToc)({
+        'Overview': undefined,
+        'Builder Configuration': undefined,
+        'Plugins': {
+            'Plugin Types': {
+                'Dependency Identification': undefined,
+                'Project Discovery': undefined,
+                'File Loading': undefined,
+                'Loading Order': undefined
+            },
+            'How to add a new plugin': undefined,
+            'How to add a new plugin type': undefined
+        },
+        'Context Information': {
+            'Files Context': undefined,
+            'Loading Order Context': undefined,
+            'Dependencies Context': undefined
+        },
+        'Analyzer Internals': undefined
+    })}
+
+
+${(0, doc_structure_1.section)('Overview', 2)}
+
+No matter whether you want to analyze a single R script, a couple of R notebooks, or a complete project,
+your journey starts with the ${(0, doc_types_1.shortLink)(flowr_analyzer_builder_1.FlowrAnalyzerBuilder.name, types.info)} (further described in [Builder Configuration](#builder-configuration) below).
+This builder allows you to configure the analysis in many different ways, for example, by specifying which files to analyze, which plugins to use, or
+what [Engine](${doc_files_1.FlowrWikiBaseRef}/Engines) to use for the analysis.
+ 
+${(0, doc_structure_1.block)({
+        type: 'NOTE',
+        content: `If you want to quickly try out the analyzer, you can use the following code snippet that analyzes a simple R expression:
+	
+${(0, doc_types_1.printCodeOfElement)({ program: types.program, info: types.info, dropLinesStart: 1, dropLinesEnd: 2, hideDefinedAt: true }, analyzerQuickExample.name)}
+		`
+    })} 
+
+**TODO**: mention [Context](#Context_Information) 
+
+${(0, doc_structure_1.section)('Builder Configuration', 2)}
+
+**TODO** also explain buildSync and that TreeSitter has to be initialized for this 
+
+${(0, doc_structure_1.section)('Plugins', 2)}
+
+${(0, doc_structure_1.section)('Plugin Types', 3)}
+
+During the construction of a new ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, types.info)}, plugins of different types are applied at different stages of the analysis.
+These plugins are grouped by their ${(0, doc_types_1.shortLink)('PluginType', types.info)} and are applied in the following order (as shown in the documentation of the ${(0, doc_types_1.shortLink)('PluginType', types.info)}):
+
+${(() => {
+        const doc = (0, doc_types_1.getDocumentationForType)('PluginType', types.info);
+        // skip until the first ```text
+        const lines = doc.split('\n');
+        const start = lines.findIndex(l => l.trim().startsWith('```text'));
+        const end = lines.findIndex((l, i) => i > start && l.trim().startsWith('```'));
+        // github rendering pls fix xD
+        return start >= 0 && end > start ? '```text\n' + lines.slice(start + 1, end).join('\n').replaceAll('▶', '>') + '\n```' : doc;
+    })()}
+
+We describe the different plugin types in more detail below.
+
+
+${(0, doc_structure_1.section)('Project Discovery', 4)}
+
+${(0, doc_structure_1.section)('File Loading', 4)}
+
+${(0, doc_structure_1.section)('Dependency Identification', 4)}
+
+${(0, doc_structure_1.section)('Loading Order', 4)}
+
+${(0, doc_structure_1.section)('How to add a new plugin', 3)}
+
+${(0, doc_structure_1.section)('How to add a new plugin type', 3)}
+
+${(0, doc_structure_1.section)('Context Information', 2)}
+
+${(0, doc_structure_1.section)('Files Context', 3)}
+
+${(0, doc_structure_1.section)('Loading Order Context', 3)}
+
+${(0, doc_structure_1.section)('Dependencies Context', 3)}
+
+${(0, doc_structure_1.section)('Analyzer Internals', 2)}
+
+`;
+}
+/** if we run this script, we want a Markdown representation of the capabilities */
+if (require.main === module) {
+    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
+    const shell = new shell_1.RShell();
+    void getText(shell).then(str => {
+        console.log(str);
+    }).finally(() => {
+        shell.close();
+    });
+}
+//# sourceMappingURL=print-analyzer-wiki.js.map

package/documentation/print-core-wiki.d.ts

@@ -1 +1,2 @@
-export {};
+import { FlowrAnalyzer } from '../project/flowr-analyzer';
+export declare function inspectContextExample(analyzer: FlowrAnalyzer): void;

package/documentation/print-core-wiki.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.inspectContextExample = inspectContextExample;
 const shell_1 = require("../r-bridge/shell");
 const log_1 = require("../../test/functionality/_helper/log");
 const log_2 = require("../util/log");
@@ -43,6 +44,36 @@ const pipeline_executor_1 = require("../core/pipeline-executor");
 const pipeline_1 = require("../core/steps/pipeline/pipeline");
 const static_slicer_1 = require("../slicing/static/static-slicer");
 const config_1 = require("../config");
+const flowr_analyzer_builder_1 = require("../project/flowr-analyzer-builder");
+const flowr_analyzer_1 = require("../project/flowr-analyzer");
+async function makeAnalyzerExample() {
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
+        .addRequestFromInput('x <- 1; y <- x; print(y);')
+        .amendConfig(c => {
+        c.ignoreSourceCalls = true;
+    })
+        .setEngine('tree-sitter')
+        .build();
+    return analyzer;
+}
+async function extractStepsExample(analyzer) {
+    const normalizedAst = await analyzer.normalize();
+    const dataflow = await analyzer.dataflow();
+    const cfg = await analyzer.controlflow();
+    return { normalizedAst, dataflow, cfg };
+}
+async function sliceQueryExample(analyzer) {
+    const result = await analyzer.query([{
+            type: 'static-slice',
+            criteria: ['1@y']
+        }]);
+    return result;
+}
+function inspectContextExample(analyzer) {
+    const ctx = analyzer.inspectContext();
+    console.log('dplyr version', ctx.deps.getDependency('dplyr'));
+    console.log('loading order', ctx.files.loadingOrder.getLoadingOrder());
+}
 async function getText(shell) {
     const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
     const sampleCode = 'x <- 1; print(x)';
@@ -80,6 +111,7 @@ See the [Getting flowR to Talk](#getting-flowr-to-talk) section below for more i
 `
     })}
 	
+* [Creating and Using a flowR Analyzer Instance](#creating-and-using-a-flowr-analyzer-instance)
 * [Pipelines and their Execution](#pipelines-and-their-execution)
 * [How flowR Produces Dataflow Graphs](#how-flowr-produces-dataflow-graphs)
   * [Overview](#overview)
@@ -89,10 +121,33 @@ See the [Getting flowR to Talk](#getting-flowr-to-talk) section below for more i
 * [Beyond the Dataflow Graph](#beyond-the-dataflow-graph)
   * [Static Backward Slicing](#static-backward-slicing)
 * [Getting flowR to Talk](#getting-flowr-to-talk)
-	
+
+## Creating and Using a flowR Analyzer Instance
+
+The ${(0, doc_types_1.shortLink)(flowr_analyzer_builder_1.FlowrAnalyzerBuilder.name, info)} class should be used as a starting point to create analyses in _flowR_.
+It provides a fluent interface for the configuration and creation of a ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, info)} instance:
+
+${(0, doc_types_1.printCodeOfElement)({ program, info, dropLinesStart: 1, dropLinesEnd: 2, hideDefinedAt: true }, makeAnalyzerExample.name)}
+
+Have a look at the [Engine](${doc_files_1.FlowrWikiBaseRef}/Engines) wiki page to understand the different engines and parsers you can use.
+
+The analyzer instance can then be used to access analysis results like the [normalized AST](${doc_files_1.FlowrWikiBaseRef}/Normalized-AST),
+the [dataflow graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow-Graph), and the [controlflow graph](${doc_files_1.FlowrWikiBaseRef}/Control-Flow-Graph):
+
+${(0, doc_types_1.printCodeOfElement)({ program, info, dropLinesStart: 1, dropLinesEnd: 2, hideDefinedAt: true }, extractStepsExample.name)}
+
+The underlying ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, info)} instance will take care of caching, updates, and running the appropriate steps.
+It also exposes the [query API](${doc_files_1.FlowrWikiBaseRef}/Query-API):
+
+${(0, doc_types_1.printCodeOfElement)({ program, info, dropLinesStart: 1, dropLinesEnd: 2, hideDefinedAt: true }, sliceQueryExample.name)}
+
+One of the additional advantages of using the ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, info)} is that it provides you with context information about the analyzed files:
+
+${(0, doc_types_1.printCodeOfElement)({ program, info, dropLinesStart: 1, dropLinesEnd: 1, hideDefinedAt: true }, inspectContextExample.name)}
+
 ## Pipelines and their Execution
 
-At the core of every analysis by flowR is the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, info)} class which takes a sequence of analysis steps (in the form of a ${(0, doc_types_1.shortLink)('Pipeline', info)}) and executes it
+At the core of every analysis done via a ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, info)} is the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, info)} class which takes a sequence of analysis steps (in the form of a ${(0, doc_types_1.shortLink)('Pipeline', info)}) and executes it
 on a given input. In general, these pipeline steps are analysis agnostic and may use arbitrary input and ordering. However, two important and predefined pipelines, 
 the ${(0, doc_types_1.shortLink)('DEFAULT_DATAFLOW_PIPELINE', info)} and the ${(0, doc_types_1.shortLink)('TREE_SITTER_DATAFLOW_PIPELINE', info)} adequately cover the most common analysis steps 
 (differentiated only by the [Engine](${doc_files_1.FlowrWikiBaseRef}/Engines) used).
@@ -115,10 +170,9 @@ const executor = new PipelineExecutor(TREE_SITTER_DATAFLOW_PIPELINE, {
 const result = await executor.allRemainingSteps();
 `)}
 
-This is, roughly, what the ${(0, doc_types_1.shortLink)('replGetDataflow', info)} function does for the ${(0, doc_cli_option_1.getReplCommand)('dataflow')} REPL command when using the [\`tree-sitter\` engine](${doc_files_1.FlowrWikiBaseRef}/Engines).
+This is, roughly, what the ${(0, doc_types_1.shortLink)('dataflow', info)} function does when using the [\`tree-sitter\` engine](${doc_files_1.FlowrWikiBaseRef}/Engines).
 We create a new ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, info)} with the ${(0, doc_types_1.shortLink)('TREE_SITTER_DATAFLOW_PIPELINE', info)} and then use ${(0, doc_types_1.shortLink)(`${pipeline_executor_1.PipelineExecutor.name}::${new pipeline_executor_1.PipelineExecutor(default_pipelines_1.TREE_SITTER_PARSE_PIPELINE, { parser: new tree_sitter_executor_1.TreeSitterExecutor(), request: (0, retriever_1.requestFromInput)('') }, config_1.defaultConfigOptions).allRemainingSteps.name}`, info)} 
 to cause the execution of all contained steps (in general, pipelines can be executed step-by-step, but this is usually not required if you just want the result).
-${(0, doc_types_1.shortLink)(retriever_1.requestFromInput.name, info)} is merely a convenience function to create a request object from a code string.
 
 In general, however, most flowR-internal functions which are tasked with generating dataflow prefer the use of ${(0, doc_types_1.shortLink)(default_pipelines_1.createDataflowPipeline.name, info)} as this function
 automatically selects the correct pipeline based on the engine used.

package/documentation/print-dataflow-graph-wiki.js

@@ -11,7 +11,6 @@ const dataflowgraph_builder_1 = require("../dataflow/graph/dataflowgraph-builder
 const assert_1 = require("../util/assert");
 const doc_dfg_1 = require("./doc-util/doc-dfg");
 const doc_files_1 = require("./doc-util/doc-files");
-const pipeline_executor_1 = require("../core/pipeline-executor");
 const retriever_1 = require("../r-bridge/retriever");
 const json_1 = require("../util/json");
 const doc_env_1 = require("./doc-util/doc-env");
@@ -39,6 +38,7 @@ const doc_issue_1 = require("./doc-util/doc-issue");
 const unnamed_call_handling_1 = require("../dataflow/internal/process/functions/call/unnamed-call-handling");
 const environment_builder_1 = require("../../test/functionality/_helper/dataflow/environment-builder");
 const config_1 = require("../config");
+const flowr_analyzer_builder_1 = require("../project/flowr-analyzer-builder");
 async function subExplanation(shell, { description, code, expectedSubgraph }) {
     expectedSubgraph = await (0, doc_dfg_1.verifyExpectedSubgraph)(shell, code, expectedSubgraph);
     const marks = [];
@@ -742,12 +742,9 @@ ${(0, doc_structure_1.details)('Example: While-Loop Body', await (0, doc_dfg_1.p
     return results.join('\n');
 }
 async function dummyDataflow() {
-    const shell = new shell_1.RShell();
-    const result = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
-        parser: shell,
-        request: (0, retriever_1.requestFromInput)('x <- 1\nx + 1')
-    }, config_1.defaultConfigOptions).allRemainingSteps();
-    shell.close();
+    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder((0, retriever_1.requestFromInput)('x <- 1\nx + 1')).build();
+    const result = await analyzer.dataflow();
+    analyzer.close();
     return result;
 }
 async function getText(shell) {
@@ -879,16 +876,12 @@ ${(0, doc_structure_1.details)('Example: Nested Conditionals', await (0, doc_dfg
 
 ${(0, doc_structure_1.section)('Dataflow Information', 2, 'dataflow-information')}
 
-Using _flowR's_ code interface (see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more), you can generate the dataflow information
-for a given piece of R code (in this case \`x <- 1; x + 1\`) as follows (using the ${(0, doc_types_1.shortLink)(shell_1.RShell.name, vertexType.info)} and the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, vertexType.info)} classes):
+Using _flowR's_ code interface (see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface#creating-flowr-analyses) wiki page for more), you can generate the dataflow information
+for a given piece of R code (in this case \`x <- 1; x + 1\`) as follows:
 
 ${(0, doc_code_1.codeBlock)('ts', `
-const shell = new ${shell_1.RShell.name}()
-const result = await new ${pipeline_executor_1.PipelineExecutor.name}(DEFAULT_DATAFLOW_PIPELINE, {
-    shell,
-    request:   ${retriever_1.requestFromInput.name}('x <- 1; x + 1')
-}).allRemainingSteps();
-shell.close();
+const analyzer = await new FlowrAnalyzerBuilder(requestFromInput('x <- 1\nx + 1')).build();
+const result = await analyzer.dataflow();
 `)}
 
 <details>
@@ -906,7 +899,7 @@ Now, you can find the dataflow _information_ with \`result.dataflow\`. More spec
 
 ${await (async () => {
         const result = await dummyDataflow();
-        const dfGraphString = (0, doc_dfg_1.printDfGraph)(result.dataflow.graph);
+        const dfGraphString = (0, doc_dfg_1.printDfGraph)(result.graph);
         return `
 ${dfGraphString}
 
@@ -917,7 +910,7 @@ However, the dataflow information contains more, quite a lot of information in f
 <summary style="color:gray">Dataflow Information as Json</summary>
 
 _As the information is pretty long, we inhibit pretty printing and syntax highlighting:_
-${(0, doc_code_1.codeBlock)('text', JSON.stringify(result.dataflow, json_1.jsonReplacer))}
+${(0, doc_code_1.codeBlock)('text', JSON.stringify(result, json_1.jsonReplacer))}
 
 </details>
 
@@ -925,16 +918,16 @@ You may be interested in its implementation:
 
 ${(0, doc_types_1.printHierarchy)({ program: vertexType.program, info: vertexType.info, root: 'DataflowInformation' })}
 
-Let's start by looking at the properties of the dataflow information object: ${Object.keys(result.dataflow).map(k => `\`${k}\``).join(', ')}.
+Let's start by looking at the properties of the dataflow information object: ${Object.keys(result).map(k => `\`${k}\``).join(', ')}.
 
 ${(() => {
             /* this includes the meta field for timing */
-            (0, assert_1.guard)(Object.keys(result.dataflow).length === 8, () => 'Update Dataflow Documentation!');
+            (0, assert_1.guard)(Object.keys(result).length === 8, () => 'Update Dataflow Documentation!');
             return '';
         })()}
 
 There are three sets of references.
-**in** (ids: ${JSON.stringify(new Set(result.dataflow.in.map(n => n.nodeId)), json_1.jsonReplacer)}) and **out** (ids: ${JSON.stringify(new Set(result.dataflow.out.map(n => n.nodeId)), json_1.jsonReplacer)}) contain the 
+**in** (ids: ${JSON.stringify(new Set(result.in.map(n => n.nodeId)), json_1.jsonReplacer)}) and **out** (ids: ${JSON.stringify(new Set(result.out.map(n => n.nodeId)), json_1.jsonReplacer)}) contain the 
 ingoing and outgoing references of the subgraph at hand (in this case, the whole code, as we are at the end of the dataflow analysis).
 Besides the Ids, they also contain important meta-information (e.g., what is to be read).
 The third set, **unknownReferences**, contains all references that are not yet identified as read or written 
@@ -944,12 +937,12 @@ The **environment** property contains the active environment information of the
 In other words, this is a linked list of tables (scopes), mapping identifiers to their respective definitions.
 A summarized version of the produced environment looks like this:
 
-${(0, doc_env_1.printEnvironmentToMarkdown)(result.dataflow.environment.current)}
+${(0, doc_env_1.printEnvironmentToMarkdown)(result.environment.current)}
 
 This shows us that the local environment contains a single definition for \`x\` (with id 0) and that the parent environment is the built-in environment.
 Additionally, we get the information that the node with the id 2 was responsible for the definition of \`x\`.
 
-Last but not least, the information contains the single **entry point** (${JSON.stringify(result.dataflow.entryPoint)}) and a set of **exit points** (${JSON.stringify(result.dataflow.exitPoints.map(e => e.nodeId))}). 
+Last but not least, the information contains the single **entry point** (${JSON.stringify(result.entryPoint)}) and a set of **exit points** (${JSON.stringify(result.exitPoints.map(e => e.nodeId))}). 
 Besides marking potential exits, the exit points also provide information about why the exit occurs and which control dependencies affect the exit.
 
 ### Unknown Side Effects

package/documentation/print-interface-wiki.js

@@ -25,6 +25,7 @@ const doc_structure_1 = require("./doc-util/doc-structure");
 const doc_types_1 = require("./doc-util/doc-types");
 const path_1 = __importDefault(require("path"));
 const tree_sitter_executor_1 = require("../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor");
+const flowr_analyzer_1 = require("../project/flowr-analyzer");
 async function explainServer(shell) {
     (0, doc_data_server_messages_1.documentAllServerMessages)();
     return `
@@ -295,13 +296,29 @@ ${(0, doc_types_1.shortLink)(shell_1.RShell.name + '::' + shell.sendCommandWithO
 
 Besides that, the command ${(0, doc_types_1.shortLink)(shell_1.RShell.name + '::' + shell.tryToInjectHomeLibPath.name, types.info)} may be of interest, as it enables all libraries available on the host system.
 
+### Creating _flowR_ analyses
+
+Nowadays, instances of ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, types.info)} should be used as central frontend to get analysis results from _flowR_.
+For example, a program slice can be created like this:
+
+${(0, doc_code_1.codeBlock)('ts', `
+const analyzer = await new FlowrAnalyzerBuilder(requestFromInput('x <- 1\\ny <- x\\nx')).build();
+const result = await analyzer.query([
+	{
+		type:     'static-slice',
+		criteria: ['3@x']
+	}
+]);
+//console.log(result['static-slice']);
+`)}
+        
 ### The Pipeline Executor
 
 Once, in the beginning, _flowR_ was meant to produce a dataflow graph merely to provide *program slices*. 
 However, with continuous updates, the [dataflow graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow%20Graph) repeatedly proves to be the more interesting part.
 With this, we restructured _flowR_'s originally *hardcoded* pipeline to be far more flexible. 
 Now, it can be theoretically extended or replaced with arbitrary steps, optional steps, and what we call 'decorations' of these steps. 
-In short, if you still "just want to slice" you can do it like this with the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, types.info)}:
+In short, a slicing pipeline using the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, types.info)} looks like this:
 
 ${(0, doc_code_1.codeBlock)('ts', `
 const slicer = new ${pipeline_executor_1.PipelineExecutor.name}(DEFAULT_SLICING_PIPELINE, {

package/documentation/print-linter-wiki.js

@@ -87,10 +87,14 @@ See [here](${(0, doc_types_1.getTypePathLink)({ filePath: report.source.fileName
 }
 function registerRules(rVersion, shell, tagTypes, format = 'short') {
     const ruleExplanations = new Map();
-    rule(shell, 'deprecated-functions', 'DeprecatedFunctionsConfig', 'DEPRECATED_FUNCTIONS', 'lint-deprecated-functions', `
+    rule(shell, 'deprecated-functions', 'FunctionsToDetectConfig', 'DEPRECATED_FUNCTIONS', 'lint-deprecated-functions', `
 first <- data.frame(x = c(1, 2, 3), y = c(1, 2, 3))
 second <- data.frame(x = c(1, 3, 2), y = c(1, 3, 2))
 dplyr::all_equal(first, second)
+`, tagTypes);
+    rule(shell, 'network-functions', 'NetworkFunctionsConfig', 'NETWORK_FUNCTIONS', 'lint-network-functions', `
+read.csv("https://example.com/data.csv")
+download.file("https://foo.bar")
 `, tagTypes);
     rule(shell, 'file-path-validity', 'FilePathValidityConfig', 'FILE_PATH_VALIDITY', 'lint-file-path-validity', `
 my_data <- read.csv("C:/Users/me/Documents/My R Scripts/Reproducible.csv")