@eagleoutice/flowr 1.4.1 → 1.5.0

package/README.md

@@ -1,12 +1,12 @@
 [![flowR logo](https://raw.githubusercontent.com/wiki/Code-Inspect/flowr/img/flowR.png)](https://github.com/Code-Inspect/flowr/wiki)\
-[![QA (and potentially deploy)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml) [![codecov](https://codecov.io/gh/Code-Inspect/flowr/graph/badge.svg)](https://codecov.io/gh/Code-Inspect/flowr) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr) [![latest tag](https://badgen.net/github/tag/Code-Inspect/flowr?label=latest&color=purple)](https://github.com/Code-Inspect/flowr/releases/latest)
+[![QA (and potentially deploy)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/Code-Inspect/flowr/actions/workflows/qa.yaml) [![codecov](https://codecov.io/gh/Code-Inspect/flowr/graph/badge.svg)](https://codecov.io/gh/Code-Inspect/flowr) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr) [![latest tag](https://badgen.net/github/tag/Code-Inspect/flowr?label=latest&color=purple)](https://github.com/Code-Inspect/flowr/releases/latest) [![Marketplace](https://badgen.net/vs-marketplace/v/code-inspect.vscode-flowr)](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr)
 
 
-*flowR* is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) for the [*R*](https://www.r-project.org/) programming language (currently tested for versions `4.x`).
+*flowR* is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/Code-Inspect/flowr/wiki/Terminology#program-slice) for the [*R*](https://www.r-project.org/) programming language (currently tested for versions `4.x`). It is available as a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr) and as a [docker image](https://hub.docker.com/r/eagleoutice/flowr).
 
 ## ⭐ Getting Started
 
-To get started with _flowR_, please check out the [Overview](https://github.com/Code-Inspect/flowr/wiki/Overview). The [Setup](https://github.com/Code-Inspect/flowr/wiki/Setup) wiki page explains how you can download and setup _flowR_ on your system. With docker 🐳️, the following line should be enough (and drop you directly into the REPL):
+To get started with _flowR_, please check out the [Overview](https://github.com/Code-Inspect/flowr/wiki/Overview). The [Setup](https://github.com/Code-Inspect/flowr/wiki/Setup) wiki page explains how you can download and setup _flowR_ on your system. For Visual Studio Code, please see the [marketplace entry](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr). With docker 🐳️, the following line should be enough (and drop you directly into the REPL):
 
 ```shell
 docker run -it --rm eagleoutice/flowr

package/abstract-interpretation/processor.js

@@ -11,9 +11,15 @@ const log_1 = require("../util/log");
 exports.aiLogger = log_1.log.getSubLogger({ name: 'abstract-interpretation' });
 class Stack {
     backingStore = [];
-    size() { return this.backingStore.length; }
-    peek() { return this.backingStore[this.size() - 1]; }
-    pop() { return this.backingStore.pop(); }
+    size() {
+        return this.backingStore.length;
+    }
+    peek() {
+        return this.backingStore[this.size() - 1];
+    }
+    pop() {
+        return this.backingStore.pop();
+    }
     push(item) {
         this.backingStore.push(item);
         return item;

package/config.d.ts

@@ -0,0 +1,16 @@
+import type { MergeableRecord } from './util/objects';
+export interface FlowrConfigOptions extends MergeableRecord {
+    /**
+     * Whether source calls should be ignored, causing {@link processSourceCall}'s behavior to be skipped
+     */
+    ignoreSourceCalls: boolean;
+    /**
+     * The path to the R executable to use. If this is undefined, {@link DEFAULT_R_PATH} will be used.
+     */
+    rPath: string | undefined;
+}
+export declare const defaultConfigOptions: FlowrConfigOptions;
+export declare const defaultConfigFile = "flowr.json";
+export declare function setConfigFile(workingDirectory?: string, file?: string, forceLoad?: boolean): void;
+export declare function setConfig(config: FlowrConfigOptions): void;
+export declare function getConfig(): FlowrConfigOptions;

package/config.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = exports.setConfig = exports.setConfigFile = exports.defaultConfigFile = exports.defaultConfigOptions = void 0;
+const objects_1 = require("./util/objects");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const log_1 = require("./util/log");
+const files_1 = require("./util/files");
+const joi_1 = __importDefault(require("joi"));
+exports.defaultConfigOptions = {
+    ignoreSourceCalls: false,
+    rPath: undefined
+};
+exports.defaultConfigFile = 'flowr.json';
+const schema = joi_1.default.object({
+    ignoreSourceCalls: joi_1.default.boolean().optional()
+});
+let configWorkingDirectory = process.cwd();
+let configFile = exports.defaultConfigFile;
+let currentConfig;
+function setConfigFile(workingDirectory = process.cwd(), file = exports.defaultConfigFile, forceLoad = false) {
+    configWorkingDirectory = workingDirectory;
+    configFile = file;
+    // reset the config so it gets reloaded
+    currentConfig = undefined;
+    if (forceLoad) {
+        getConfig();
+    }
+}
+exports.setConfigFile = setConfigFile;
+function setConfig(config) {
+    currentConfig = config;
+}
+exports.setConfig = setConfig;
+function getConfig() {
+    // lazy-load the config based on the current settings
+    if (currentConfig === undefined) {
+        setConfig(parseConfigOptions(configWorkingDirectory, configFile));
+    }
+    return currentConfig;
+}
+exports.getConfig = getConfig;
+function parseConfigOptions(workingDirectory, configFile) {
+    let searchPath = path_1.default.resolve(workingDirectory);
+    do {
+        const configPath = path_1.default.join(searchPath, configFile);
+        if (fs_1.default.existsSync(configPath)) {
+            try {
+                const text = fs_1.default.readFileSync(configPath, { encoding: 'utf-8' });
+                const parsed = JSON.parse(text);
+                const validate = schema.validate(parsed);
+                if (!validate.error) {
+                    // assign default values to all config options except for the specified ones
+                    const ret = (0, objects_1.deepMergeObject)(exports.defaultConfigOptions, parsed);
+                    log_1.log.info(`Using config ${JSON.stringify(ret)} from ${configPath}`);
+                    return ret;
+                }
+                else {
+                    log_1.log.error(`Failed to validate config file at ${configPath}: ${validate.error.message}`);
+                }
+            }
+            catch (e) {
+                log_1.log.error(`Failed to parse config file at ${configPath}: ${e.message}`);
+            }
+        }
+        // move up to parent directory
+        searchPath = (0, files_1.getParentDirectory)(searchPath);
+    } while (fs_1.default.existsSync(searchPath));
+    log_1.log.info(`Using default config ${JSON.stringify(exports.defaultConfigOptions)}`);
+    return exports.defaultConfigOptions;
+}
+//# sourceMappingURL=config.js.map

package/core/input.d.ts

@@ -27,7 +27,7 @@ interface BaseSteppingSlicerInput<InterestedIn extends StepName | undefined> ext
     /** If you want to auto-select something in the reconstruction add it here, otherwise, it will use the default defined alongside {@link reconstructToCode}*/
     autoSelectIf?: AutoSelectPredicate;
 }
-interface NormalizeSteppingSlicerInput<InterestedIn extends 'ai' | 'dataflow' | 'normalize'> extends BaseSteppingSlicerInput<InterestedIn> {
+interface NormalizeSteppingSlicerInput<InterestedIn extends 'dataflow' | 'normalize'> extends BaseSteppingSlicerInput<InterestedIn> {
     stepOfInterest: InterestedIn;
 }
 interface SliceSteppingSlicerInput<InterestedIn extends 'reconstruct' | 'slice' | undefined> extends BaseSteppingSlicerInput<InterestedIn> {

package/core/output.d.ts

@@ -9,8 +9,7 @@ type StepResultsHelper<InterestedIn extends StepName> = {
     'parse': Out<'parse'>;
     'normalize': StepResultsHelper<'parse'> & Out<'normalize'>;
     'dataflow': StepResultsHelper<'normalize'> & Out<'dataflow'>;
-    'ai': StepResultsHelper<'dataflow'> & Out<'ai'>;
-    'slice': StepResultsHelper<'ai'> & Out<'slice'>;
+    'slice': StepResultsHelper<'dataflow'> & Out<'slice'>;
     'reconstruct': StepResultsHelper<'slice'> & Out<'reconstruct'>;
 }[InterestedIn];
 export {};

package/core/print/parse-printer.d.ts

@@ -1,3 +1,2 @@
 import type { QuadSerializationConfiguration } from '../../util/quads';
-import type { XmlParserConfig } from '../../r-bridge';
-export declare function parseToQuads(code: string, config: QuadSerializationConfiguration, parseConfig: XmlParserConfig): Promise<string>;
+export declare function parseToQuads(code: string, config: QuadSerializationConfiguration): string;

package/core/print/parse-printer.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseToQuads = void 0;
 const quads_1 = require("../../util/quads");
-const internal_1 = require("../../r-bridge/lang-4.x/ast/parser/xml/internal");
+const r_bridge_1 = require("../../r-bridge");
+const format_1 = require("../../r-bridge/lang-4.x/ast/parser/json/format");
+const parser_1 = require("../../r-bridge/lang-4.x/ast/parser/json/parser");
 function filterObject(obj, keys) {
     if (typeof obj !== 'object') {
         return obj;
@@ -20,10 +22,10 @@ function filterObject(obj, keys) {
             .map(([k, v]) => [k, filterObject(v, keys)]));
     }
 }
-async function parseToQuads(code, config, parseConfig) {
-    const obj = await (0, internal_1.xlm2jsonObject)(parseConfig, code);
+function parseToQuads(code, config) {
+    const obj = (0, parser_1.convertPreparedParsedData)((0, format_1.prepareParsedData)(code));
     // recursively filter so that if the object contains one of the keys 'a', 'b' or 'c', all other keys are ignored
-    return (0, quads_1.serialize2quads)(filterObject(obj, new Set([parseConfig.attributeName, parseConfig.childrenName, parseConfig.contentName])), config);
+    return (0, quads_1.serialize2quads)(filterObject(obj, new Set([r_bridge_1.attributesKey, r_bridge_1.childrenKey, r_bridge_1.contentKey])), config);
 }
 exports.parseToQuads = parseToQuads;
 //# sourceMappingURL=parse-printer.js.map

package/core/print/slice-diff-ansi.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sliceDiffAnsi = void 0;
 const range_1 = require("../../util/range");
 const assert_1 = require("../../util/assert");
-const statistics_1 = require("../../statistics");
+const ansi_1 = require("../../../src/util/ansi");
 function grayOut() {
-    return statistics_1.ansiFormatter.getFormatString({ color: 7 /* Colors.White */, effect: statistics_1.ColorEffect.Foreground, style: 2 /* FontStyles.Faint */ });
+    return ansi_1.ansiFormatter.getFormatString({ color: 7 /* Colors.White */, effect: ansi_1.ColorEffect.Foreground, style: 2 /* FontStyles.Faint */ });
 }
 function mergeJointRangesInSorted(loc) {
     return loc.reduce((acc, curr) => {
@@ -23,15 +23,15 @@ function mergeJointRangesInSorted(loc) {
     }, [loc[0]]);
 }
 function highlight(s, selected) {
-    const primary = statistics_1.ansiFormatter.format(s, { color: 3 /* Colors.Yellow */, effect: statistics_1.ColorEffect.Foreground, style: 1 /* FontStyles.Bold */ });
-    return selected ? statistics_1.ansiFormatter.format(primary, { style: 4 /* FontStyles.Underline */ }) : primary;
+    const primary = ansi_1.ansiFormatter.format(s, { color: 3 /* Colors.Yellow */, effect: ansi_1.ColorEffect.Foreground, style: 1 /* FontStyles.Bold */ });
+    return selected ? ansi_1.ansiFormatter.format(primary, { style: 4 /* FontStyles.Underline */ }) : primary;
 }
 function sliceDiffAnsi(slice, normalized, criteriaIds, originalCode) {
     let importantLocations = Array.from(normalized.idMap.entries())
         .filter(([id, { location }]) => slice.has(id) && (0, assert_1.isNotUndefined)(location))
         .map(([id, { location }]) => ({ selected: criteriaIds.has(id), location: location }));
     if (importantLocations.length === 0) {
-        return `${grayOut()}${originalCode}${statistics_1.ansiFormatter.reset()}`;
+        return `${grayOut()}${originalCode}${ansi_1.ansiFormatter.reset()}`;
     }
     // we sort all locations from back to front so that replacements do not screw up the indices
     importantLocations.sort((a, b) => -(0, range_1.rangeCompare)(a.location, b.location));
@@ -41,9 +41,9 @@ function sliceDiffAnsi(slice, normalized, criteriaIds, originalCode) {
     for (const { selected, location } of importantLocations) {
         const { start, end } = location;
         const line = lines[start.line - 1];
-        lines[start.line - 1] = `${line.substring(0, start.column - 1)}${statistics_1.ansiFormatter.reset()}${highlight(line.substring(start.column - 1, end.column), selected)}${grayOut()}${line.substring(end.column)}`;
+        lines[start.line - 1] = `${line.substring(0, start.column - 1)}${ansi_1.ansiFormatter.reset()}${highlight(line.substring(start.column - 1, end.column), selected)}${grayOut()}${line.substring(end.column)}`;
     }
-    return `${grayOut()}${lines.join('\n')}${statistics_1.ansiFormatter.reset()}`;
+    return `${grayOut()}${lines.join('\n')}${ansi_1.ansiFormatter.reset()}`;
 }
 exports.sliceDiffAnsi = sliceDiffAnsi;
 //# sourceMappingURL=slice-diff-ansi.js.map

package/core/slicer.js

@@ -162,22 +162,18 @@ class SteppingSlicer {
                 break;
             case 1:
                 step = guardStep('normalize');
-                result = await (0, steps_1.executeSingleSubStep)(step, this.results.parse, await this.shell.tokenMap(), this.hooks, this.getId);
+                result = (0, steps_1.executeSingleSubStep)(step, this.results.parse, this.hooks, this.getId);
                 break;
             case 2:
                 step = guardStep('dataflow');
-                result = (0, steps_1.executeSingleSubStep)(step, this.results.normalize);
+                result = (0, steps_1.executeSingleSubStep)(step, this.request, this.results.normalize);
                 break;
             case 3:
-                step = guardStep('ai');
-                result = (0, steps_1.executeSingleSubStep)(step, this.results.normalize, this.results.dataflow);
-                break;
-            case 4:
                 (0, assert_1.guard)(this.criterion !== undefined, 'Cannot decode criteria without a criterion');
                 step = guardStep('slice');
-                result = (0, steps_1.executeSingleSubStep)(step, this.results.ai.graph, this.results.normalize, this.criterion);
+                result = (0, steps_1.executeSingleSubStep)(step, this.results.dataflow.graph, this.results.normalize, this.criterion);
                 break;
-            case 5:
+            case 4:
                 step = guardStep('reconstruct');
                 result = (0, steps_1.executeSingleSubStep)(step, this.results.normalize, this.results.slice.result);
                 break;