@eagleoutice/flowr 2.6.2 → 2.6.3

package/project/context/flowr-analyzer-context.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowrAnalyzerContext = void 0;
+exports.contextFromInput = contextFromInput;
+exports.contextFromSources = contextFromSources;
 const flowr_analyzer_files_context_1 = require("./flowr-analyzer-files-context");
 const flowr_analyzer_dependencies_context_1 = require("./flowr-analyzer-dependencies-context");
 const flowr_analyzer_plugin_1 = require("../plugins/flowr-analyzer-plugin");
 const flowr_analyzer_loading_order_context_1 = require("./flowr-analyzer-loading-order-context");
+const arrays_1 = require("../../util/collections/arrays");
+const retriever_1 = require("../../r-bridge/retriever");
+const config_1 = require("../../config");
+const flowr_file_1 = require("./flowr-file");
 /**
  * This summarizes the other context layers used by the {@link FlowrAnalyzer}.
  * Have a look at the attributes and layers listed below (e.g., {@link files} and {@link deps})
@@ -20,7 +26,9 @@ const flowr_analyzer_loading_order_context_1 = require("./flowr-analyzer-loading
 class FlowrAnalyzerContext {
     files;
     deps;
-    constructor(plugins) {
+    config;
+    constructor(config, plugins) {
+        this.config = config;
         const loadingOrder = new flowr_analyzer_loading_order_context_1.FlowrAnalyzerLoadingOrderContext(this, plugins.get(flowr_analyzer_plugin_1.PluginType.LoadingOrder));
         this.files = new flowr_analyzer_files_context_1.FlowrAnalyzerFilesContext(loadingOrder, (plugins.get(flowr_analyzer_plugin_1.PluginType.ProjectDiscovery) ?? []), (plugins.get(flowr_analyzer_plugin_1.PluginType.FileLoad) ?? []));
         this.deps = new flowr_analyzer_dependencies_context_1.FlowrAnalyzerDependenciesContext(this, (plugins.get(flowr_analyzer_plugin_1.PluginType.DependencyIdentification) ?? []));
@@ -29,9 +37,11 @@ class FlowrAnalyzerContext {
     addRequests(requests) {
         this.files.addRequests(requests);
     }
-    /** delegate request addition */
-    addRequest(request) {
-        this.files.addRequest(request);
+    addFile(f) {
+        this.files.addFile(f);
+    }
+    addFiles(f) {
+        this.files.addFiles(f);
     }
     /** this conducts all the step that can be done before the main analysis run */
     resolvePreAnalysis() {
@@ -55,4 +65,38 @@ class FlowrAnalyzerContext {
     }
 }
 exports.FlowrAnalyzerContext = FlowrAnalyzerContext;
+/**
+ * Lifting {@link requestFromInput} to create a full {@link FlowrAnalyzerContext} from input requests.
+ * Please use this only for a "quick" setup, or to have compatibility with the pre-project flowR era.
+ * Otherwise, refer to a {@link FlowrAnalyzerBuilder} to create a fully customized {@link FlowrAnalyzer} instance.
+ * @see {@link requestFromInput} - for details on how inputs are processed into requests.
+ * @see {@link contextFromSources} - to create a context from source code strings directly.
+ */
+function contextFromInput(input, config = config_1.defaultConfigOptions, plugins) {
+    const context = new FlowrAnalyzerContext(config, (0, arrays_1.arraysGroupBy)(plugins ?? [], (p) => p.type));
+    if (typeof input === 'string' || Array.isArray(input) && input.every(i => typeof i === 'string')) {
+        const requests = (0, retriever_1.requestFromInput)(input);
+        context.addRequests(Array.isArray(requests) ? requests : [requests]);
+    }
+    else {
+        const requests = Array.isArray(input) ? input : [input];
+        context.addRequests(requests);
+    }
+    return context;
+}
+/**
+ * Create a {@link FlowrAnalyzerContext} from a set of source code strings.
+ * @param sources - A record mapping file paths to their source code content.
+ * @param config  - Configuration options for the analyzer.
+ * @param plugins - Optional plugins to extend the analyzer's functionality.
+ * @see {@link contextFromInput}    - to create a context from input requests.
+ * @see {@link FlowrInlineTextFile} - to create inline text files for the sources.
+ */
+function contextFromSources(sources, config = config_1.defaultConfigOptions, plugins) {
+    const context = new FlowrAnalyzerContext(config, (0, arrays_1.arraysGroupBy)(plugins ?? [], (p) => p.type));
+    for (const [p, c] of Object.entries(sources)) {
+        context.addFile(new flowr_file_1.FlowrInlineTextFile(p, c));
+    }
+    return context;
+}
 //# sourceMappingURL=flowr-analyzer-context.js.map

package/project/context/flowr-analyzer-files-context.d.ts

@@ -1,9 +1,9 @@
 import { AbstractFlowrAnalyzerContext } from './abstract-flowr-analyzer-context';
-import { type RParseRequest, type RParseRequestFromFile } from '../../r-bridge/retriever';
+import type { RParseRequestFromText, RParseRequest, RParseRequestFromFile } from '../../r-bridge/retriever';
 import type { FlowrAnalyzerLoadingOrderContext, ReadOnlyFlowrAnalyzerLoadingOrderContext } from './flowr-analyzer-loading-order-context';
 import { FlowrAnalyzerProjectDiscoveryPlugin } from '../plugins/project-discovery/flowr-analyzer-project-discovery-plugin';
 import { FlowrAnalyzerFilePlugin } from '../plugins/file-plugins/flowr-analyzer-file-plugin';
-import { type FlowrFile, type FlowrFileProvider, SpecialFileRole } from './flowr-file';
+import { FlowrFile, type FlowrFileProvider, FileRole } from './flowr-file';
 import type { FlowrDescriptionFile } from '../plugins/file-plugins/flowr-description-file';
 /**
  * This is a request to process a folder as a project, which will be expanded by the registered {@link FlowrAnalyzerProjectDiscoveryPlugin}s.
@@ -16,11 +16,12 @@ export interface RProjectAnalysisRequest {
     readonly content: string;
 }
 export type RAnalysisRequest = RParseRequest | RProjectAnalysisRequest;
-export type SpecialFiles = {
-    [SpecialFileRole.Description]: FlowrDescriptionFile[];
-    [SpecialFileRole.Namespace]: FlowrFileProvider[];
-    [SpecialFileRole.Data]: FlowrFileProvider[];
-    [SpecialFileRole.Other]: FlowrFileProvider[];
+export type RoleBasedFiles = {
+    [FileRole.Description]: FlowrDescriptionFile[];
+    [FileRole.Namespace]: FlowrFileProvider[];
+    [FileRole.Source]: FlowrFileProvider[];
+    [FileRole.Data]: FlowrFileProvider[];
+    [FileRole.Other]: FlowrFileProvider[];
 };
 /**
  * This is the read-only interface for the files context, which is used to manage all files known to the {@link FlowrAnalyzer}.
@@ -43,7 +44,37 @@ export interface ReadOnlyFlowrAnalyzerFilesContext {
      * getFilesByRole(SpecialFileRole.Description)
      * ```
      */
-    getFilesByRole<Role extends SpecialFileRole>(role: Role): SpecialFiles[Role];
+    getFilesByRole<Role extends FileRole>(role: Role): RoleBasedFiles[Role];
+    /**
+     * Check if the context has a file with the given path.
+     * Please note, that this may also check the file system, depending on the configuration
+     * (see {@link FlowrConfigOptions.project.resolveUnknownPathsOnDisk}).
+     * @param path - The path to the file.
+     *
+     * If you do not know the exact path or, e.g., casing of the file, use {@link exists} instead.
+     */
+    hasFile(path: string): boolean;
+    /**
+     * Check if a file exists at the given path, optionally ignoring case.
+     * @param path - The path to the file.
+     * @param ignoreCase - Whether to ignore case when checking for the file.
+     *
+     * Please note that this method checks the file system based on the configuration (see {@link FlowrConfigOptions.project.resolveUnknownPathsOnDisk}).
+     * @returns The actual path of the file if it exists, otherwise `undefined`.
+     */
+    exists(path: string, ignoreCase: boolean): string | undefined;
+    /**
+     * Until parsers support multiple request types from the virtual context system,
+     * we resolve their contents.
+     */
+    resolveRequest(r: RParseRequest): {
+        r: RParseRequestFromText;
+        path?: string;
+    };
+    /**
+     * Get all files that have been considered during dataflow analysis.
+     */
+    consideredFilesList(): readonly string[];
 }
 /**
  * This is the analyzer file context to be modified by all plugins that affect the files.
@@ -54,10 +85,21 @@ export declare class FlowrAnalyzerFilesContext extends AbstractFlowrAnalyzerCont
     readonly name = "flowr-analyzer-files-context";
     readonly loadingOrder: FlowrAnalyzerLoadingOrderContext;
     private files;
+    private inlineFiles;
     private readonly fileLoaders;
-    private specialFiles;
+    /** these are all the paths of files that have been considered by the dataflow graph (even if not added) */
+    private readonly consideredFiles;
+    private byRole;
     constructor(loadingOrder: FlowrAnalyzerLoadingOrderContext, plugins: readonly FlowrAnalyzerProjectDiscoveryPlugin[], fileLoaders: readonly FlowrAnalyzerFilePlugin[]);
     reset(): void;
+    /**
+     * Record that a file has been considered during dataflow analysis.
+     */
+    addConsideredFile(path: string): void;
+    /**
+     * Get all files that have been considered during dataflow analysis.
+     */
+    consideredFilesList(): readonly string[];
     /**
      * Add multiple requests to the context. This is just a convenience method that calls {@link addRequest} for each request.
      */
@@ -65,21 +107,29 @@ export declare class FlowrAnalyzerFilesContext extends AbstractFlowrAnalyzerCont
     /**
      * Add a request to the context. If the request is of type `project`, it will be expanded using the registered {@link FlowrAnalyzerProjectDiscoveryPlugin}s.
      */
-    addRequest(request: RAnalysisRequest): void;
+    private addRequest;
     /**
      * Add multiple files to the context. This is just a convenience method that calls {@link addFile} for each file.
      */
-    addFiles(...files: (string | FlowrFileProvider<string> | RParseRequestFromFile)[]): void;
+    addFiles(files: (string | FlowrFileProvider | RParseRequestFromFile)[]): void;
     /**
      * Add a file to the context. If the file has a special role, it will be added to the corresponding list of special files.
      * This method also applies any registered {@link FlowrAnalyzerFilePlugin}s to the file before adding it to the context.
      */
-    addFile(file: string | FlowrFileProvider<string> | RParseRequestFromFile, role?: SpecialFileRole): void;
+    addFile(file: string | FlowrFileProvider | RParseRequestFromFile, role?: FileRole): FlowrFileProvider<{
+        toString(): string;
+    }>;
+    hasFile(path: string): boolean;
+    exists(p: string, ignoreCase: boolean): string | undefined;
     private fileLoadPlugins;
+    resolveRequest(r: RParseRequest): {
+        r: RParseRequestFromText;
+        path?: string;
+    };
     /**
      * Get all requests that have been added to this context.
      * This is a convenience method that calls {@link FlowrAnalyzerLoadingOrderContext.getLoadingOrder}.
      */
     computeLoadingOrder(): readonly RParseRequest[];
-    getFilesByRole<Role extends SpecialFileRole>(role: Role): SpecialFiles[Role];
+    getFilesByRole<Role extends FileRole>(role: Role): RoleBasedFiles[Role];
 }

package/project/context/flowr-analyzer-files-context.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowrAnalyzerFilesContext = void 0;
 const abstract_flowr_analyzer_context_1 = require("./abstract-flowr-analyzer-context");
@@ -8,23 +11,19 @@ const flowr_analyzer_project_discovery_plugin_1 = require("../plugins/project-di
 const flowr_analyzer_file_plugin_1 = require("../plugins/file-plugins/flowr-analyzer-file-plugin");
 const flowr_file_1 = require("./flowr-file");
 const log_1 = require("../../util/log");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
 const fileLog = log_1.log.getSubLogger({ name: 'flowr-analyzer-files-context' });
-function obtainFileAndPath(file, role) {
-    let f;
-    let p;
+function wrapFile(file, role) {
     if (typeof file === 'string') {
-        f = new flowr_file_1.FlowrTextFile(file, role);
-        p = file;
+        return new flowr_file_1.FlowrTextFile(file, role);
     }
     else if ('request' in file) {
-        f = file;
-        p = file.content;
+        return flowr_file_1.FlowrFile.fromRequest(file);
     }
     else {
-        f = file;
-        p = file.path().toString();
+        return file;
     }
-    return { f, p };
 }
 /**
  * This is the analyzer file context to be modified by all plugins that affect the files.
@@ -34,15 +33,19 @@ function obtainFileAndPath(file, role) {
 class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.AbstractFlowrAnalyzerContext {
     name = 'flowr-analyzer-files-context';
     loadingOrder;
-    /* all project files etc., this contains *all* files, loading orders etc. are to be handled by plugins */
+    /* all project files etc., this contains *all* (non-inline) files, loading orders etc. are to be handled by plugins */
     files = new Map();
+    inlineFiles = [];
     fileLoaders;
+    /** these are all the paths of files that have been considered by the dataflow graph (even if not added) */
+    consideredFiles = [];
     /* files that are part of the analysis, e.g. source files */
-    specialFiles = {
-        [flowr_file_1.SpecialFileRole.Description]: [],
-        [flowr_file_1.SpecialFileRole.Namespace]: [],
-        [flowr_file_1.SpecialFileRole.Data]: [],
-        [flowr_file_1.SpecialFileRole.Other]: []
+    byRole = {
+        [flowr_file_1.FileRole.Description]: [],
+        [flowr_file_1.FileRole.Namespace]: [],
+        [flowr_file_1.FileRole.Source]: [],
+        [flowr_file_1.FileRole.Data]: [],
+        [flowr_file_1.FileRole.Other]: []
     };
     constructor(loadingOrder, plugins, fileLoaders) {
         super(loadingOrder.getAttachedContext(), flowr_analyzer_project_discovery_plugin_1.FlowrAnalyzerProjectDiscoveryPlugin.defaultPlugin(), plugins);
@@ -53,6 +56,18 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
         this.loadingOrder.reset();
         this.files = new Map();
     }
+    /**
+     * Record that a file has been considered during dataflow analysis.
+     */
+    addConsideredFile(path) {
+        this.consideredFiles.push(path);
+    }
+    /**
+     * Get all files that have been considered during dataflow analysis.
+     */
+    consideredFilesList() {
+        return this.consideredFiles;
+    }
     /**
      * Add multiple requests to the context. This is just a convenience method that calls {@link addRequest} for each request.
      */
@@ -67,9 +82,6 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
     addRequest(request) {
         if (request.request !== 'project') {
             this.loadingOrder.addRequest(request);
-            if (request.request === 'file') {
-                this.files.set(request.content, request);
-            }
             return;
         }
         const expandedRequests = this.applyPlugins(request).flat();
@@ -85,7 +97,7 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
     /**
      * Add multiple files to the context. This is just a convenience method that calls {@link addFile} for each file.
      */
-    addFiles(...files) {
+    addFiles(files) {
         for (const file of files) {
             this.addFile(file);
         }
@@ -95,29 +107,88 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
      * This method also applies any registered {@link FlowrAnalyzerFilePlugin}s to the file before adding it to the context.
      */
     addFile(file, role) {
-        const { f, p } = obtainFileAndPath(file, role);
-        const { f: fA, p: pA } = this.fileLoadPlugins(f, p);
-        const exist = this.files.get(pA);
-        (0, assert_1.guard)(exist === undefined || exist === fA, `File ${pA} already added to the context.`);
-        this.files.set(pA, fA);
-        if (!(0, retriever_1.isParseRequest)(fA) && fA.role) {
-            this.specialFiles[fA.role].push(fA);
+        const f = this.fileLoadPlugins(wrapFile(file, role));
+        if (f.path() === flowr_file_1.FlowrFile.INLINE_PATH) {
+            this.inlineFiles.push(f);
+        }
+        else {
+            const exist = this.files.get(f.path());
+            (0, assert_1.guard)(exist === undefined || exist === f, `File ${f.path()} already added to the context.`);
+            this.files.set(f.path(), f);
+        }
+        if (f.role) {
+            this.byRole[f.role].push(f);
+        }
+        return f;
+    }
+    hasFile(path) {
+        return this.files.has(path)
+            || (this.ctx.config.project.resolveUnknownPathsOnDisk && fs_1.default.existsSync(path));
+    }
+    exists(p, ignoreCase) {
+        try {
+            if (!ignoreCase) {
+                return this.hasFile(p) ? p : undefined;
+            }
+            // walk the directory and find the first match
+            const dir = path_1.default.dirname(p);
+            const file = path_1.default.basename(p);
+            // try to find in local known files first
+            const localFound = Array.from(this.files.keys()).find(f => {
+                return path_1.default.dirname(f) === dir && path_1.default.basename(f).toLowerCase() === file.toLowerCase();
+            });
+            if (localFound) {
+                return localFound;
+            }
+            if (this.ctx.config.project.resolveUnknownPathsOnDisk) {
+                const files = fs_1.default.readdirSync(dir);
+                const found = files.find(f => f.toLowerCase() === file.toLowerCase());
+                return found ? path_1.default.join(dir, found) : undefined;
+            }
+            return undefined;
+        }
+        catch {
+            return undefined;
         }
     }
-    fileLoadPlugins(f, p) {
+    fileLoadPlugins(f) {
         let fFinal = f;
-        let pFinal = p;
-        if (!(0, retriever_1.isParseRequest)(f)) { // we have to change the types when we integrate the adapters
-            for (const loader of this.fileLoaders) {
-                if (loader.applies(p)) {
-                    fileLog.debug(`Applying file loader ${loader.name} to file ${p}`);
-                    fFinal = loader.processor(this.ctx, f);
-                    pFinal = f.path().toString();
-                    break;
-                }
+        for (const loader of this.fileLoaders) {
+            if (loader.applies(f.path())) {
+                fileLog.debug(`Applying file loader ${loader.name} to file ${f.path()}`);
+                fFinal = loader.processor(this.ctx, f);
+                break;
+            }
+        }
+        return fFinal;
+    }
+    resolveRequest(r) {
+        if (r.request === 'text') {
+            return { r };
+        }
+        const file = this.files.get(r.content);
+        if (file === undefined && this.ctx.config.project.resolveUnknownPathsOnDisk) {
+            fileLog.debug(`File ${r.content} not found in context, trying to load from disk.`);
+            if (fs_1.default.existsSync(r.content)) {
+                const loadedFile = this.addFile(new flowr_file_1.FlowrTextFile(r.content));
+                return {
+                    r: {
+                        request: 'text',
+                        content: loadedFile.content().toString(),
+                    },
+                    path: loadedFile.path()
+                };
             }
         }
-        return { f: fFinal, p: pFinal };
+        (0, assert_1.guard)(file !== undefined && file !== null, `File ${r.content} not found in context.`);
+        const content = file.content();
+        return {
+            r: {
+                request: 'text',
+                content: typeof content === 'string' ? content : '',
+            },
+            path: file.path()
+        };
     }
     /**
      * Get all requests that have been added to this context.
@@ -127,7 +198,7 @@ class FlowrAnalyzerFilesContext extends abstract_flowr_analyzer_context_1.Abstra
         return this.loadingOrder.getLoadingOrder();
     }
     getFilesByRole(role) {
-        return this.specialFiles[role];
+        return this.byRole[role];
     }
 }
 exports.FlowrAnalyzerFilesContext = FlowrAnalyzerFilesContext;

package/project/context/flowr-file.d.ts

@@ -1,4 +1,5 @@
 import type { PathLike } from 'fs';
+import type { RParseRequest } from '../../r-bridge/retriever';
 /**
  * Just a readable alias for file paths, mostly for documentation purposes.
  * We separate {@link PathLike} types from string paths that are used for project paths.
@@ -9,16 +10,26 @@ export type FilePath = string;
  * This list may be extended in the future and reflects files that the {@link FlowrAnalyzer} can do something interesting with.
  * If you add an interesting file that is only part of your plugin infrastructure, please use the `other` role.
  */
-export declare enum SpecialFileRole {
+export declare enum FileRole {
     /** The `DESCRIPTION` file in R packages, this is the only currently supported special file. */
     Description = "description",
     /** The `NAMESPACE` file in R packages, currently not specially supported. */
     Namespace = "namespace",
     /** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
     Data = "data",
+    /**
+     * Catch-all for any file that provides usable R source code to incorporate into the analysis.
+     * Please note, that the loading order/inclusion and even potential relevance of these source files
+     * is determined by the loading order plugins (cf. {@link PluginType.LoadingOrder})
+     * in the {@link FlowrAnalyzerLoadingOrderContext}.
+     */
+    Source = "source",
     /** Other special files that are not specifically supported by flowR but may be interesting for some analyses. */
     Other = "other"
 }
+export type StringableContent = {
+    toString(): string;
+};
 /**
  * This is the basic interface for all files known to the FlowrAnalyzer.
  * You can implement this interface to provide custom file loading mechanisms.
@@ -30,19 +41,23 @@ export declare enum SpecialFileRole {
  * If you want to pass in inline text files, see {@link FlowrInlineTextFile}.
  * @typeParam Content - The type of the content returned by the `content()` method.
  */
-export interface FlowrFileProvider<Content = unknown> {
+export interface FlowrFileProvider<Content extends {
+    toString(): string;
+} = {
+    toString(): string;
+}> {
     /**
      * The role of this file, if any, in general your file should _not_ decide for itself what role it has in the project context,
      * this is for the loaders plugins to decide (cf. {@link PluginType}) as they can, e.g., respect ignore files, updated mappings, etc.
      * However, they will 1) set this role as soon as they decide on it (using {@link assignRole}) and 2) try to respect an already assigned role (however, user configurations may override this).
      */
-    role?: SpecialFileRole;
+    role?: FileRole;
     /**
      * The path to the file, this is used for identification and logging purposes.
      * If the file does not exist on disk, this can be a virtual path (e.g. for inline files).
      * Even though this is a getter, please make sure that the operation is cheap and deterministic (some decorators may overwrite the path, e.g., because they support other protocols).
      */
-    path(): PathLike;
+    path(): string;
     /**
      * The content of the file, this may be cached by the implementation and does not have to be expensive.
      * You can used stream based implementations but right now there is no external, project-wide expressions of life cycles for files.
@@ -53,22 +68,29 @@ export interface FlowrFileProvider<Content = unknown> {
      * Assign a role to this file, this should be done by the loader plugins (cf. {@link PluginType}).
      * **Do not call this method yourself unless you are a file-loader plugin and/or really know what you are doing, this may break plugin assumptions!**
      */
-    assignRole(role: SpecialFileRole): void;
+    assignRole(role: FileRole): void;
 }
 /**
  * A basic implementation of the {@link FlowrFileProvider} interface that caches the content after the first load (i.e., updates on disk are ignored).
  *
  * See {@link FlowrTextFile} for a text-file specific implementation and {@link FlowrInlineTextFile} for inline text files.
  */
-export declare abstract class FlowrFile<Content = unknown> implements FlowrFileProvider<Content> {
+export declare abstract class FlowrFile<Content extends StringableContent = StringableContent> implements FlowrFileProvider<Content> {
     private contentCache;
     protected filePath: PathLike;
-    readonly role?: SpecialFileRole;
-    constructor(filePath: PathLike, role?: SpecialFileRole);
-    path(): PathLike;
+    readonly role?: FileRole;
+    static readonly INLINE_PATH = "@inline";
+    constructor(filePath: PathLike, role?: FileRole);
+    path(): string;
     content(): Content;
     protected abstract loadContent(): Content;
-    assignRole(role: SpecialFileRole): void;
+    assignRole(role: FileRole): void;
+    /**
+     * Creates a {@link FlowrFile} from a given {@link RParseRequest}.
+     * @see {@link FlowrTextFile}
+     * @see {@link FlowrInlineTextFile}
+     */
+    static fromRequest(request: RParseRequest): FlowrFile<string>;
 }
 /**
  * A basic implementation of the {@link FlowrFileProvider} interface for text files that caches the content after the first load (i.e., updates on disk are ignored).

package/project/context/flowr-file.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.FlowrInlineTextFile = exports.FlowrTextFile = exports.FlowrFile = exports.SpecialFileRole = void 0;
+exports.FlowrInlineTextFile = exports.FlowrTextFile = exports.FlowrFile = exports.FileRole = void 0;
 const fs_1 = __importDefault(require("fs"));
 const assert_1 = require("../../util/assert");
 /**
@@ -11,17 +11,24 @@ const assert_1 = require("../../util/assert");
  * This list may be extended in the future and reflects files that the {@link FlowrAnalyzer} can do something interesting with.
  * If you add an interesting file that is only part of your plugin infrastructure, please use the `other` role.
  */
-var SpecialFileRole;
-(function (SpecialFileRole) {
+var FileRole;
+(function (FileRole) {
     /** The `DESCRIPTION` file in R packages, this is the only currently supported special file. */
-    SpecialFileRole["Description"] = "description";
+    FileRole["Description"] = "description";
     /** The `NAMESPACE` file in R packages, currently not specially supported. */
-    SpecialFileRole["Namespace"] = "namespace";
+    FileRole["Namespace"] = "namespace";
     /** Data files, e.g., `R/sysdata.rda`, currently not specially supported. */
-    SpecialFileRole["Data"] = "data";
+    FileRole["Data"] = "data";
+    /**
+     * Catch-all for any file that provides usable R source code to incorporate into the analysis.
+     * Please note, that the loading order/inclusion and even potential relevance of these source files
+     * is determined by the loading order plugins (cf. {@link PluginType.LoadingOrder})
+     * in the {@link FlowrAnalyzerLoadingOrderContext}.
+     */
+    FileRole["Source"] = "source";
     /** Other special files that are not specifically supported by flowR but may be interesting for some analyses. */
-    SpecialFileRole["Other"] = "other";
-})(SpecialFileRole || (exports.SpecialFileRole = SpecialFileRole = {}));
+    FileRole["Other"] = "other";
+})(FileRole || (exports.FileRole = FileRole = {}));
 /**
  * A basic implementation of the {@link FlowrFileProvider} interface that caches the content after the first load (i.e., updates on disk are ignored).
  *
@@ -31,12 +38,13 @@ class FlowrFile {
     contentCache;
     filePath;
     role;
+    static INLINE_PATH = '@inline';
     constructor(filePath, role) {
         this.filePath = filePath;
         this.role = role;
     }
     path() {
-        return this.filePath;
+        return this.filePath.toString();
     }
     content() {
         if (this.contentCache === undefined) {
@@ -48,6 +56,19 @@ class FlowrFile {
         (0, assert_1.guard)(this.role === undefined || this.role === role, `File ${this.filePath.toString()} already has a role assigned: ${this.role}`);
         this.role = role;
     }
+    /**
+     * Creates a {@link FlowrFile} from a given {@link RParseRequest}.
+     * @see {@link FlowrTextFile}
+     * @see {@link FlowrInlineTextFile}
+     */
+    static fromRequest(request) {
+        if (request.request === 'file') {
+            return new FlowrTextFile(request.content);
+        }
+        else {
+            return new FlowrInlineTextFile(FlowrFile.INLINE_PATH, request.content);
+        }
+    }
 }
 exports.FlowrFile = FlowrFile;
 /**