@eagleoutice/flowr 2.6.1 → 2.6.3

package/cli/repl/server/messages/message-repl.d.ts

@@ -3,7 +3,6 @@ import type { IdMessageBase, MessageDefinition } from './all-messages';
  * Request the execution of the given expression as a REPL statement.
  * We strongly recommend that you make use of a unique {@link IdMessageBase#id}
  * in case the message responses happen in parallel.
- *
  * @see ExecuteIntermediateResponseMessage
  * @see ExecuteEndMessage
  */

package/cli/repl/server/send.d.ts

@@ -1,4 +1,10 @@
 import type { IdMessageBase } from './messages/all-messages';
 import type { Socket } from './net';
+/**
+ * Produce a new name for an unnamed socket connection
+ */
 export declare function getUnnamedSocketName(c: Socket): string;
+/**
+ * Sends a message to the given socket
+ */
 export declare function sendMessage<T extends IdMessageBase>(c: Socket, message: T): void;

package/cli/repl/server/send.js

@@ -3,9 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUnnamedSocketName = getUnnamedSocketName;
 exports.sendMessage = sendMessage;
 const json_1 = require("../../../util/json");
+/**
+ * Produce a new name for an unnamed socket connection
+ */
 function getUnnamedSocketName(c) {
     return `${c.remoteAddress ?? '?'}@${c.remotePort ?? '?'}`;
 }
+/**
+ * Sends a message to the given socket
+ */
 function sendMessage(c, message) {
     return (0, json_1.superBigJsonStringify)(message, '\n', msg => {
         c.write(msg);

package/cli/repl/server/server.d.ts

@@ -1,4 +1,4 @@
-import type { Server } from './net';
+import { type Server } from './net';
 import { FlowrLogger } from '../../../util/log';
 import type { FlowrConfigOptions, KnownEngines } from '../../../config';
 export declare const serverLog: FlowrLogger;

package/cli/repl/server/validate.d.ts

@@ -1,5 +1,5 @@
 import type * as Joi from 'joi';
-import type { FlowrMessage, IdMessageBase, MessageDefinition } from './messages/all-messages';
+import { type FlowrMessage, type IdMessageBase, type MessageDefinition } from './messages/all-messages';
 import type { Socket } from './net';
 export interface ValidationErrorResult {
     type: 'error';
@@ -10,6 +10,15 @@ export interface SuccessValidationResult<T extends IdMessageBase> {
     message: T;
 }
 export type ValidationResult<T extends IdMessageBase> = SuccessValidationResult<T> | ValidationErrorResult;
+/**
+ * Check that the serialized input is a valid base message.
+ */
 export declare function validateBaseMessageFormat(input: string): ValidationResult<IdMessageBase>;
+/**
+ * Validates that the given input matches the given message definition.
+ */
 export declare function validateMessage<T extends FlowrMessage | IdMessageBase>(input: IdMessageBase, def: MessageDefinition<T>): ValidationResult<T>;
+/**
+ * Sends an error message to the given client indicating a validation error.
+ */
 export declare function answerForValidationError(client: Socket, result: ValidationErrorResult, id?: string): void;

package/cli/repl/server/validate.js

@@ -5,6 +5,9 @@ exports.validateMessage = validateMessage;
 exports.answerForValidationError = answerForValidationError;
 const send_1 = require("./send");
 const all_messages_1 = require("./messages/all-messages");
+/**
+ * Check that the serialized input is a valid base message.
+ */
 function validateBaseMessageFormat(input) {
     try {
         return validateMessage(JSON.parse(input), all_messages_1.baseMessage);
@@ -13,6 +16,9 @@ function validateBaseMessageFormat(input) {
         return { type: 'error', reason: e };
     }
 }
+/**
+ * Validates that the given input matches the given message definition.
+ */
 function validateMessage(input, def) {
     try {
         const result = def.schema.validate(input);
@@ -22,6 +28,9 @@ function validateMessage(input, def) {
         return { type: 'error', reason: e };
     }
 }
+/**
+ * Sends an error message to the given client indicating a validation error.
+ */
 function answerForValidationError(client, result, id) {
     (0, send_1.sendMessage)(client, {
         type: 'error',

package/cli/run-script.d.ts

@@ -1,8 +1,7 @@
-import type { StdioProcessor } from './repl/execute';
+import { type StdioProcessor } from './repl/execute';
 import { scripts } from './common/scripts-info';
 /**
  * Path-safe helper of {@link waitOnScript} for other flowR scripts.
- *
  * @see waitOnScript
  */
 export declare function runScript(name: keyof typeof scripts, args: readonly string[], io?: StdioProcessor, exitOnError?: boolean): Promise<void>;

package/cli/run-script.js

@@ -9,7 +9,6 @@ const scripts_info_1 = require("./common/scripts-info");
 const path_1 = __importDefault(require("path"));
 /**
  * Path-safe helper of {@link waitOnScript} for other flowR scripts.
- *
  * @see waitOnScript
  */
 async function runScript(name, args, io, exitOnError = false) {

package/cli/script-core/statistics-core.d.ts

@@ -1,3 +1,6 @@
 import type { StatsCliOptions } from '../statistics-app';
 import type { FlowrConfigOptions } from '../../config';
+/**
+ * The core function for the 'flowr stats' script.
+ */
 export declare function flowrScriptGetStats(options: StatsCliOptions, config: FlowrConfigOptions): Promise<void>;

package/cli/script-core/statistics-core.js

@@ -57,6 +57,9 @@ async function collectFileArguments(options, verboseAdd, dumpJson, features) {
     console.log(`Total: ${counter} files (${skipped} skipped with archive existing)`);
     return files;
 }
+/**
+ * The core function for the 'flowr stats' script.
+ */
 async function flowrScriptGetStats(options, config) {
     if (options.input.length === 0) {
         console.error('No input files given. Nothing to do. See \'--help\' if this is an error.');

package/cli/script-core/statistics-helper-core.d.ts

@@ -1,3 +1,6 @@
 import type { StatsHelperCliOptions } from '../statistics-helper-app';
-import type { FlowrConfigOptions } from '../../config';
+import { type FlowrConfigOptions } from '../../config';
+/**
+ * Get statistics for a single file
+ */
 export declare function getStatsForSingleFile(options: StatsHelperCliOptions, config: FlowrConfigOptions): Promise<void>;

package/cli/script-core/statistics-helper-core.js

@@ -21,6 +21,7 @@ const time_1 = require("../../util/text/time");
 const tar_1 = require("tar");
 const ansi_1 = require("../../util/text/ansi");
 const config_1 = require("../../config");
+const flowr_analyzer_context_1 = require("../../project/context/flowr-analyzer-context");
 function compressFolder(folder, target) {
     return (0, tar_1.create)({
         gzip: true,
@@ -36,6 +37,9 @@ function compressFolder(folder, target) {
         console.error('Error during compression:', e);
     });
 }
+/**
+ * Get statistics for a single file
+ */
 async function getStatsForSingleFile(options, config) {
     if (options['no-ansi']) {
         log_1.log.info('disabling ansi colors');
@@ -59,7 +63,7 @@ async function getStatsForSingleFile(options, config) {
     if (stats.outputs.size === 1) {
         if (options['dump-json']) {
             const [, output] = [...stats.outputs.entries()][0];
-            const cfg = (0, extract_cfg_1.extractCfg)(output.normalize, config, output.dataflow.graph);
+            const cfg = (0, extract_cfg_1.extractCfg)(output.normalize, (0, flowr_analyzer_context_1.contextFromInput)('', config), output.dataflow.graph);
             statistics_file_1.statisticsFileProvider.append('output-json', 'parse', await (0, print_1.printStepResult)(_00_parse_1.PARSE_WITH_R_SHELL_STEP, output.parse, 2 /* StepOutputFormat.Json */));
             statistics_file_1.statisticsFileProvider.append('output-json', 'normalize', await (0, print_1.printStepResult)(_10_normalize_1.NORMALIZE, output.normalize, 2 /* StepOutputFormat.Json */));
             statistics_file_1.statisticsFileProvider.append('output-json', 'dataflow', await (0, print_1.printStepResult)(_20_dataflow_1.STATIC_DATAFLOW, output.dataflow, 2 /* StepOutputFormat.Json */));

package/cli/script-core/summarizer-core.d.ts

@@ -1,2 +1,5 @@
 import type { SummarizerCliOptions } from '../summarizer-app';
+/**
+ * The core function for the 'flowr summarize' script.
+ */
 export declare function flowrScriptSummarizer(options: SummarizerCliOptions): Promise<void>;

package/cli/script-core/summarizer-core.js

@@ -39,6 +39,9 @@ async function retrieveSummarizer(options, outputBase) {
         process.exit(1);
     }
 }
+/**
+ * The core function for the 'flowr summarize' script.
+ */
 async function flowrScriptSummarizer(options) {
     const outputBase = (options.output ?? options.input).replace(/\.json$|\/$/, '-summary');
     console.log(`Writing outputs to base ${outputBase}`);

package/cli/slicer-app.js

@@ -15,7 +15,6 @@ const print_1 = require("../benchmark/stats/print");
 const magic_comments_1 = require("../reconstruct/auto-select/magic-comments");
 const auto_select_defaults_1 = require("../reconstruct/auto-select/auto-select-defaults");
 const config_1 = require("../config");
-const adapter_1 = require("../util/formats/adapter");
 const options = (0, script_1.processCommandLineArgs)('slicer', ['input', 'criterion'], {
     subtitle: 'Slice R code based on a given slicing criterion',
     examples: [
@@ -32,8 +31,8 @@ async function getSlice() {
     (0, assert_1.guard)(options.criterion !== undefined, 'a slicing criterion must be given');
     const config = (0, config_1.getConfig)();
     await slicer.init(options['input-is-text']
-        ? (0, adapter_1.requestFromText)(options.input.replaceAll('\\n', '\n'))
-        : (0, adapter_1.requestFromFile)(options.input), config, options['no-magic-comments'] ? auto_select_defaults_1.doNotAutoSelect : (0, magic_comments_1.makeMagicCommentHandler)(auto_select_defaults_1.doNotAutoSelect));
+        ? { request: 'text', content: options.input.replaceAll('\\n', '\n') }
+        : { request: 'file', content: options.input }, config, options['no-magic-comments'] ? auto_select_defaults_1.doNotAutoSelect : (0, magic_comments_1.makeMagicCommentHandler)(auto_select_defaults_1.doNotAutoSelect));
     let mappedSlices = [];
     let reconstruct = undefined;
     const doSlicing = options.criterion.trim() !== '';
@@ -77,7 +76,7 @@ async function getSlice() {
         if (doSlicing && options.diff) {
             let originalCode = options.input;
             if (!options['input-is-text']) {
-                const request = (0, adapter_1.requestFromFile)(options.input);
+                const request = { request: 'file', content: options.input };
                 originalCode = request.request === 'text' ? request.content : fs_1.default.readFileSync(request.content).toString();
             }
             console.log((0, slice_diff_ansi_1.sliceDiffAnsi)(slice.result, normalize, new Set(mappedSlices.map(({ id }) => id)), originalCode));

package/cli/summarizer-app.d.ts

@@ -1,8 +1,7 @@
 /**
  * The summarizer intends to post-process and summarize the results of
- * * the benchmark tool, and
- * * the statistics extraction.
- *
+ * the benchmark tool, and
+ * the statistics extraction.
  * @module
  */
 export interface SummarizerCliOptions {

package/cli/summarizer-app.js

@@ -1,9 +1,8 @@
 "use strict";
 /**
  * The summarizer intends to post-process and summarize the results of
- * * the benchmark tool, and
- * * the statistics extraction.
- *
+ * the benchmark tool, and
+ * the statistics extraction.
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });

package/cli/wiki.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Updates and optionally re-creates all flowR wikis.
+ */
+export declare function makeAllWikis(force: boolean, filter: string[] | undefined): Promise<void>;

package/cli/wiki.js

@@ -0,0 +1,165 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeAllWikis = makeAllWikis;
+const doc_context_1 = require("../documentation/wiki-mk/doc-context");
+const shell_1 = require("../r-bridge/shell");
+const tree_sitter_executor_1 = require("../r-bridge/lang-4.x/tree-sitter/tree-sitter-executor");
+const fs_1 = __importDefault(require("fs"));
+const log_1 = require("../../test/functionality/_helper/log");
+const command_line_usage_1 = __importDefault(require("command-line-usage"));
+const command_line_args_1 = __importDefault(require("command-line-args"));
+const version_1 = require("../util/version");
+const wiki_faq_1 = require("../documentation/wiki-faq");
+const ansi_1 = require("../util/text/ansi");
+const documentation_1 = require("../documentation");
+const wiki_cfg_1 = require("../documentation/wiki-cfg");
+const wiki_onboarding_1 = require("../documentation/wiki-onboarding");
+const wiki_analyzer_1 = require("../documentation/wiki-analyzer");
+const issue_linting_rule_1 = require("../documentation/issue-linting-rule");
+const doc_readme_1 = require("../documentation/doc-readme");
+const wiki_linter_1 = require("../documentation/wiki-linter");
+const os_1 = __importDefault(require("os"));
+const Documents = [
+    new wiki_faq_1.WikiFaq(),
+    new documentation_1.WikiSearch(),
+    new wiki_cfg_1.WikiCfg(),
+    new documentation_1.WikiQuery(),
+    new wiki_onboarding_1.WikiOnboarding(),
+    new wiki_analyzer_1.WikiAnalyzer(),
+    new documentation_1.WikiEngine(),
+    new documentation_1.WikiNormalizedAst(),
+    new documentation_1.WikiCore(),
+    new documentation_1.WikiInterface(),
+    new documentation_1.WikiDataflowGraph(),
+    new documentation_1.WikiLintingAndTesting(),
+    new wiki_linter_1.WikiLinter(),
+    new issue_linting_rule_1.IssueLintingRule(),
+    new doc_readme_1.DocReadme(),
+    new documentation_1.DocCapabilities()
+];
+function sortByLeastRecentChanged(wikis) {
+    return wikis.slice().sort((a, b) => {
+        const aStat = fs_1.default.existsSync(a.getProducer()) ? fs_1.default.statSync(a.getProducer()) : undefined;
+        const bStat = fs_1.default.existsSync(b.getProducer()) ? fs_1.default.statSync(b.getProducer()) : undefined;
+        const aMTime = aStat ? aStat.mtime.getTime() : 0;
+        const bMTime = bStat ? bStat.mtime.getTime() : 0;
+        return bMTime - aMTime;
+    });
+}
+/**
+ * Updates and optionally re-creates all flowR wikis.
+ */
+async function makeAllWikis(force, filter) {
+    const setupStart = new Date();
+    console.log('Setting up wiki generation...');
+    const shell = new shell_1.RShell();
+    console.log('  * R shell initialized');
+    await tree_sitter_executor_1.TreeSitterExecutor.initTreeSitter();
+    const treeSitter = new tree_sitter_executor_1.TreeSitterExecutor();
+    console.log('  * Tree-sitter parser initialized');
+    const ctx = (0, doc_context_1.makeDocContextForTypes)(shell);
+    console.log('  * Wiki context prepared');
+    if (force) {
+        console.log(ansi_1.ansiFormatter.format('Forcing wiki regeneration (existing files will be overwritten)', { style: 1 /* FontStyles.Bold */, color: 3 /* Colors.Yellow */, effect: ansi_1.ColorEffect.Foreground }));
+    }
+    const info = {
+        ctx,
+        shell, treeSitter,
+        force,
+        readFileSync(f) {
+            try {
+                return fs_1.default.readFileSync(f);
+            }
+            catch {
+                return undefined;
+            }
+        },
+        writeFileSync: fs_1.default.writeFileSync
+    };
+    console.log(`Setup for wiki generation took ${(new Date().getTime() - setupStart.getTime())}ms`);
+    const changedWikis = new Set();
+    try {
+        const sortedDocs = sortByLeastRecentChanged(Documents);
+        console.log(`Generating ${sortedDocs.length} wikis/docs, sorted by most recently updated...`);
+        for (const doc of sortedDocs) {
+            const type = doc.getTarget().toLowerCase().includes('wiki') ? 'Wiki' : 'Doc';
+            if (filter && !filter.some(f => doc.getTarget().includes(f))) {
+                console.log(`  * Skipping ${type} (filtered out): ${doc.getTarget()}`);
+                continue;
+            }
+            const now = new Date();
+            console.log(ansi_1.ansiFormatter.format(`  [${doc.getTarget()}] Updating ${type}...`, { style: 1 /* FontStyles.Bold */, color: 6 /* Colors.Cyan */, effect: ansi_1.ColorEffect.Foreground }));
+            const changed = await doc.make(info);
+            const text = changed ? `${type} updated` : `${type} identical, no changes made`;
+            if (changed) {
+                changedWikis.add(doc.getTarget());
+            }
+            const color = changed ? 2 /* Colors.Green */ : 7 /* Colors.White */;
+            console.log(ansi_1.ansiFormatter.format(`  [${doc.getTarget()}] ${text}: ${doc.getTarget()} (took ${new Date().getTime() - now.getTime()}ms)`, { color, effect: ansi_1.ColorEffect.Foreground }));
+            for (const out of doc.getWrittenSubfiles()) {
+                changedWikis.add(out);
+                console.log(`    - Also updated: ${out}`);
+            }
+        }
+    }
+    catch (error) {
+        console.error('Error while generating documents:', error);
+    }
+    finally {
+        shell.close();
+    }
+    console.log('All wikis processed in ' + (new Date().getTime() - setupStart.getTime()) + 'ms');
+    console.log(`    * Changed ${changedWikis.size} wiki/doc files.`);
+    // write a temp file in the os temp dir with the changed wikis
+    const filename = `${os_1.default.tmpdir()}/flowr-wiki-changed-files.txt`;
+    fs_1.default.writeFileSync(`${filename}`, Array.from(changedWikis).join('\n'));
+    console.log(`    * List of changed wikis/docs written to ${filename}`);
+}
+if (require.main === module) {
+    const wikiOptions = [
+        { name: 'force', alias: 'F', type: Boolean, description: 'Overwrite existing wiki files, even if nothing changes' },
+        { name: 'filter', alias: 'f', type: String, multiple: true, description: 'Only generate wikis whose target path contains the given string' },
+        { name: 'help', alias: 'h', type: Boolean, description: 'Print this usage guide for the wiki generator' },
+        { name: 'keep-alive', type: Boolean, description: 'Keep-alive wiki generator (only sensible with a reloading script like ts-node-dev)' },
+    ];
+    const optionHelp = [
+        {
+            header: `flowR (version ${(0, version_1.flowrVersion)().toString()})`,
+            content: 'Documentation (wiki, issue, ...) generator for flowR'
+        },
+        {
+            header: 'Synopsis',
+            content: [
+                '$ wiki {bold --help}',
+                '$ wiki {bold --force}',
+                '$ wiki {bold --filter} {italic "dataflow"}'
+            ]
+        },
+        {
+            header: 'Options',
+            optionList: wikiOptions
+        }
+    ];
+    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
+    // parse args
+    const options = (0, command_line_args_1.default)(wikiOptions);
+    if (options.help) {
+        console.log((0, command_line_usage_1.default)(optionHelp));
+        process.exit(0);
+    }
+    void makeAllWikis(options.force, options.filter).catch(err => {
+        console.error('Error while generating wikis:', err);
+        process.exit(1);
+    }).then(() => {
+        if (options['keep-alive']) {
+            console.log('Wiki generator running in keep-alive mode...');
+            setInterval(() => {
+                // do nothing, just keep alive
+            }, 100);
+        }
+    });
+}
+//# sourceMappingURL=wiki.js.map

package/config.d.ts

@@ -1,4 +1,4 @@
-import type { MergeableRecord } from './util/objects';
+import { type MergeableRecord } from './util/objects';
 import Joi from 'joi';
 import type { BuiltInDefinitions } from './dataflow/environments/built-in-config';
 import type { KnownParser } from './r-bridge/parser';
@@ -59,10 +59,9 @@ export interface FlowrLaxSourcingOptions extends MergeableRecord {
      */
     readonly repeatedSourceLimit?: number;
     /**
-     * sometimes files may have a different name in the source call	(e.g., due to later replacements),
+     * sometimes files may have a different name in the source call (e.g., due to later replacements),
      * with this setting you can provide a list of replacements to apply for each sourced file.
      * Every replacement consists of a record that maps a regex to a replacement string.
-     *
      * @example
      * ```ts
      * [
@@ -99,6 +98,10 @@ export interface FlowrConfigOptions extends MergeableRecord {
             };
         };
     };
+    readonly project: {
+        /** Whether to resolve unknown paths loaded by the r project disk when trying to source/analyze files */
+        resolveUnknownPathsOnDisk: boolean;
+    };
     /**
      * The engines to use for interacting with R code. Currently, supports {@link TreeSitterEngineConfig} and {@link RShellEngineConfig}.
      * An empty array means all available engines will be used.
@@ -205,14 +208,29 @@ export type KnownEngines = {
 };
 export declare const defaultConfigOptions: FlowrConfigOptions;
 export declare const flowrConfigFileSchema: Joi.ObjectSchema<any>;
+/**
+ * Parses the given JSON string as a flowR config file.
+ */
 export declare function parseConfig(jsonString: string): FlowrConfigOptions | undefined;
 /**
  * Creates a new flowr config that has the updated values.
  */
 export declare function amendConfig(config: FlowrConfigOptions, amendmentFunc: (config: DeepWritable<FlowrConfigOptions>) => FlowrConfigOptions | void): FlowrConfigOptions;
+/**
+ * Clones the given flowr config object.
+ */
 export declare function cloneConfig(config: FlowrConfigOptions): FlowrConfigOptions;
+/**
+ * Loads the flowr config from the given file or the default locations.
+ */
 export declare function getConfig(configFile?: string, configWorkingDirectory?: string): FlowrConfigOptions;
+/**
+ * Gets the configuration for the given engine type from the config.
+ */
 export declare function getEngineConfig<T extends EngineConfig['type']>(config: FlowrConfigOptions, engine: T): EngineConfig & {
     type: T;
 } | undefined;
+/**
+ * Checks whether the given count is over the pointer analysis threshold configured in the config.
+ */
 export declare function isOverPointerAnalysisThreshold(config: FlowrConfigOptions, count: number): boolean;

package/config.js

@@ -65,6 +65,9 @@ exports.defaultConfigOptions = {
             }
         }
     },
+    project: {
+        resolveUnknownPathsOnDisk: true
+    },
     engines: [],
     defaultEngine: 'tree-sitter',
     solver: {
@@ -103,6 +106,9 @@ exports.flowrConfigFileSchema = joi_1.default.object({
             }).optional().description('Do you want to overwrite (parts) of the builtin definition?')
         }).optional().description('Semantics regarding how to handle the R environment.')
     }).description('Configure language semantics and how flowR handles them.'),
+    project: joi_1.default.object({
+        resolveUnknownPathsOnDisk: joi_1.default.boolean().optional().description('Whether to resolve unknown paths loaded by the r project disk when trying to source/analyze files.')
+    }).description('Project specific configuration options.'),
     engines: joi_1.default.array().items(joi_1.default.alternatives(joi_1.default.object({
         type: joi_1.default.string().required().valid('tree-sitter').description('Use the tree sitter engine.'),
         wasmPath: joi_1.default.string().optional().description('The path to the tree-sitter-r WASM binary to use. If this is undefined, this uses the default path.'),
@@ -142,6 +148,9 @@ exports.flowrConfigFileSchema = joi_1.default.object({
         }).description('The configuration of the shape inference for data frames.')
     }).description('The configuration options for abstract interpretation.')
 }).description('The configuration file format for flowR.');
+/**
+ * Parses the given JSON string as a flowR config file.
+ */
 function parseConfig(jsonString) {
     try {
         const parsed = JSON.parse(jsonString);
@@ -168,9 +177,15 @@ function amendConfig(config, amendmentFunc) {
     amendmentFunc(newConfig);
     return newConfig;
 }
+/**
+ * Clones the given flowr config object.
+ */
 function cloneConfig(config) {
     return JSON.parse(JSON.stringify(config));
 }
+/**
+ * Loads the flowr config from the given file or the default locations.
+ */
 function getConfig(configFile, configWorkingDirectory = process.cwd()) {
     try {
         return loadConfigFromFile(configFile, configWorkingDirectory);
@@ -180,6 +195,9 @@ function getConfig(configFile, configWorkingDirectory = process.cwd()) {
         return exports.defaultConfigOptions;
     }
 }
+/**
+ * Gets the configuration for the given engine type from the config.
+ */
 function getEngineConfig(config, engine) {
     const engines = config.engines;
     if (!engines.length) {
@@ -198,6 +216,9 @@ function getPointerAnalysisThreshold(config) {
         return pointerTracking ? 'unlimited' : 'disabled';
     }
 }
+/**
+ * Checks whether the given count is over the pointer analysis threshold configured in the config.
+ */
 function isOverPointerAnalysisThreshold(config, count) {
     const threshold = getPointerAnalysisThreshold(config);
     return threshold !== 'unlimited' && (threshold === 'disabled' || count > threshold);

package/control-flow/basic-cfg-guided-visitor.d.ts

@@ -1,4 +1,4 @@
-import type { CfgBasicBlockVertex, CfgEndMarkerVertex, CfgExpressionVertex, CfgSimpleVertex, CfgStatementVertex, ControlFlowInformation } from './control-flow-graph';
+import { type CfgBasicBlockVertex, type CfgEndMarkerVertex, type CfgExpressionVertex, type CfgSimpleVertex, type CfgStatementVertex, type ControlFlowInformation } from './control-flow-graph';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 export interface BasicCfgGuidedVisitorConfiguration<ControlFlow extends ControlFlowInformation = ControlFlowInformation> {
     readonly controlFlow: ControlFlow;
@@ -17,7 +17,6 @@ export declare class BasicCfgGuidedVisitor<ControlFlow extends ControlFlowInform
     constructor(config: Config);
     /**
      * call this function to indicate that a node is to be considered visited.
-     *
      * @returns `true` if the node was not visited before, `false` otherwise
      */
     protected visitNode(node: NodeId): boolean;

package/control-flow/basic-cfg-guided-visitor.js

@@ -19,7 +19,6 @@ class BasicCfgGuidedVisitor {
     }
     /**
      * call this function to indicate that a node is to be considered visited.
-     *
      * @returns `true` if the node was not visited before, `false` otherwise
      */
     visitNode(node) {

package/control-flow/cfg-dead-code.js

@@ -54,7 +54,12 @@ class CfgConditionalDeadCodeRemoval extends semantic_cfg_guided_visitor_1.Semant
         }
     }
     handleValuesFor(id, valueId) {
-        const values = (0, general_1.valueSetGuard)((0, alias_tracking_1.resolveIdToValue)(valueId, { graph: this.config.dfg, full: true, idMap: this.config.normalizedAst.idMap, resolve: this.config.flowrConfig.solver.variables }));
+        const values = (0, general_1.valueSetGuard)((0, alias_tracking_1.resolveIdToValue)(valueId, {
+            graph: this.config.dfg,
+            full: true,
+            idMap: this.config.normalizedAst.idMap,
+            resolve: this.config.ctx.config.solver.variables
+        }));
         if (values === undefined || values.elements.length !== 1 || values.elements[0].type != 'logical' || !(0, r_value_1.isValue)(values.elements[0].value)) {
             this.unableToCalculateValue(id);
             return;
@@ -74,7 +79,12 @@ class CfgConditionalDeadCodeRemoval extends semantic_cfg_guided_visitor_1.Semant
         if (data.call.args.length !== 1 || data.call.args[0] === r_function_call_1.EmptyArgument) {
             return undefined;
         }
-        const values = (0, general_1.valueSetGuard)((0, alias_tracking_1.resolveIdToValue)(data.call.args[0].nodeId, { graph: this.config.dfg, full: true, idMap: this.config.normalizedAst.idMap, resolve: this.config.flowrConfig.solver.variables }));
+        const values = (0, general_1.valueSetGuard)((0, alias_tracking_1.resolveIdToValue)(data.call.args[0].nodeId, {
+            graph: this.config.dfg,
+            full: true,
+            idMap: this.config.normalizedAst.idMap,
+            resolve: this.config.ctx.config.solver.variables
+        }));
         if (values === undefined || values.elements.length !== 1 || values.elements[0].type != 'logical' || !(0, r_value_1.isValue)(values.elements[0].value)) {
             return undefined;
         }
@@ -115,7 +125,7 @@ function cfgAnalyzeDeadCode(cfg, info) {
         controlFlow: cfg,
         normalizedAst: info.ast,
         dfg: info.dfg,
-        flowrConfig: info.config,
+        ctx: info.ctx,
         defaultVisitingOrder: 'forward',
     });
     visitor.start();

package/control-flow/cfg-simplification.d.ts

@@ -3,13 +3,16 @@ import type { NormalizedAst } from '../r-bridge/lang-4.x/ast/model/processing/de
 import type { DataflowGraph } from '../dataflow/graph/graph';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 import { cfgAnalyzeDeadCode } from './cfg-dead-code';
-import type { FlowrConfigOptions } from '../config';
+import type { ReadOnlyFlowrAnalyzerContext } from '../project/context/flowr-analyzer-context';
 export interface CfgPassInfo {
     ast?: NormalizedAst;
     dfg?: DataflowGraph;
-    config: FlowrConfigOptions;
+    ctx: ReadOnlyFlowrAnalyzerContext;
 }
 export type CfgSimplificationPass = (cfg: ControlFlowInformation, info: CfgPassInfo) => ControlFlowInformation;
+/**
+ * All available control flow graph simplification passes.
+ */
 export declare const CfgSimplificationPasses: {
     readonly 'unique-cf-sets': typeof uniqueControlFlowSets;
     readonly 'analyze-dead-code': typeof cfgAnalyzeDeadCode;

package/control-flow/cfg-simplification.js

@@ -6,6 +6,9 @@ exports.cfgFindAllReachable = cfgFindAllReachable;
 const cfg_to_basic_blocks_1 = require("./cfg-to-basic-blocks");
 const simple_visitor_1 = require("./simple-visitor");
 const cfg_dead_code_1 = require("./cfg-dead-code");
+/**
+ * All available control flow graph simplification passes.
+ */
 exports.CfgSimplificationPasses = {
     'unique-cf-sets': uniqueControlFlowSets,
     'analyze-dead-code': cfg_dead_code_1.cfgAnalyzeDeadCode,

package/control-flow/cfg-to-basic-blocks.d.ts

@@ -1,4 +1,4 @@
-import type { ControlFlowInformation } from './control-flow-graph';
+import { type ControlFlowInformation } from './control-flow-graph';
 /**
  * Take a control flow information of a graph without any basic blocks and convert it to a graph with basic blocks.
  */