@eagleoutice/flowr 2.2.1 → 2.2.3

package/queries/catalog/call-context-query/call-context-query-executor.js

@@ -167,7 +167,7 @@ function executeCallContextQueries({ dataflow: { graph }, ast }, queries) {
     const { promotedQueries, requiresCfg } = promoteQueryCallNames(queries);
     let cfg = undefined;
     if (requiresCfg) {
-        cfg = (0, cfg_1.extractCFG)(ast);
+        cfg = (0, cfg_1.extractCFG)(ast, graph);
     }
     const queriesWhichWantAliases = promotedQueries.filter(q => q.includeAliases);
     for (const [nodeId, info] of graph.vertices(true)) {

package/queries/catalog/happens-before-query/happens-before-query-executor.d.ts

@@ -1,3 +1,3 @@
 import type { BasicQueryData } from '../../base-query-format';
 import type { HappensBeforeQuery, HappensBeforeQueryResult } from './happens-before-query-format';
-export declare function executeHappensBefore({ ast }: BasicQueryData, queries: readonly HappensBeforeQuery[]): HappensBeforeQueryResult;
+export declare function executeHappensBefore({ ast, dataflow }: BasicQueryData, queries: readonly HappensBeforeQuery[]): HappensBeforeQueryResult;

package/queries/catalog/happens-before-query/happens-before-query-executor.js

@@ -6,10 +6,10 @@ const log_1 = require("../../../util/log");
 const cfg_1 = require("../../../util/cfg/cfg");
 const happens_before_1 = require("../../../util/cfg/happens-before");
 const parse_1 = require("../../../slicing/criterion/parse");
-function executeHappensBefore({ ast }, queries) {
+function executeHappensBefore({ ast, dataflow }, queries) {
     const start = Date.now();
     const results = {};
-    const cfg = (0, cfg_1.extractCFG)(ast);
+    const cfg = (0, cfg_1.extractCFG)(ast, dataflow.graph);
     for (const query of queries) {
         const { a, b } = query;
         const fingerprint = `${a}<${b}`;

package/queries/catalog/happens-before-query/happens-before-query-format.js

@@ -22,6 +22,6 @@ exports.HappensBeforeQueryDefinition = {
         type: joi_1.default.string().valid('happens-before').required().description('The type of the query.'),
         a: joi_1.default.string().required().description('The first slicing criterion.'),
         b: joi_1.default.string().required().description('The second slicing criterion.')
-    }).description('The id map query retrieves the id map from the normalized AST.')
+    }).description('Happens-Before tracks whether a always happens before b.')
 };
 //# sourceMappingURL=happens-before-query-format.js.map

package/queries/catalog/resolve-value-query/resolve-value-query-executor.d.ts

@@ -0,0 +1,4 @@
+import type { ResolveValueQuery, ResolveValueQueryResult } from './resolve-value-query-format';
+import type { BasicQueryData } from '../../base-query-format';
+export declare function fingerPrintOfQuery(query: ResolveValueQuery): string;
+export declare function executeResolveValueQuery({ dataflow: { graph, environment }, ast }: BasicQueryData, queries: readonly ResolveValueQuery[]): ResolveValueQueryResult;

package/queries/catalog/resolve-value-query/resolve-value-query-executor.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fingerPrintOfQuery = fingerPrintOfQuery;
+exports.executeResolveValueQuery = executeResolveValueQuery;
+const log_1 = require("../../../util/log");
+const parse_1 = require("../../../slicing/criterion/parse");
+const resolve_by_name_1 = require("../../../dataflow/environments/resolve-by-name");
+const node_id_1 = require("../../../r-bridge/lang-4.x/ast/model/processing/node-id");
+function fingerPrintOfQuery(query) {
+    return JSON.stringify(query);
+}
+function executeResolveValueQuery({ dataflow: { graph, environment }, ast }, queries) {
+    const start = Date.now();
+    const results = {};
+    for (const query of queries) {
+        const key = fingerPrintOfQuery(query);
+        if (results[key]) {
+            log_1.log.warn(`Duplicate Key for resolve-value-query: ${key}, skipping...`);
+        }
+        const values = query.criteria
+            .map(criteria => (0, node_id_1.recoverName)((0, parse_1.slicingCriterionToId)(criteria, ast.idMap), ast.idMap))
+            .flatMap(ident => (0, resolve_by_name_1.resolveToValues)(ident, environment, graph.idMap ?? ast.idMap));
+        results[key] = {
+            values: [...new Set(values)]
+        };
+    }
+    return {
+        '.meta': {
+            timing: Date.now() - start
+        },
+        results
+    };
+}
+//# sourceMappingURL=resolve-value-query-executor.js.map

package/queries/catalog/resolve-value-query/resolve-value-query-format.d.ts

@@ -0,0 +1,72 @@
+import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
+import type { SlicingCriteria } from '../../../slicing/criterion/parse';
+import Joi from 'joi';
+import { executeResolveValueQuery } from './resolve-value-query-executor';
+export interface ResolveValueQuery extends BaseQueryFormat {
+    readonly type: 'resolve-value';
+    /** The slicing criteria to use */
+    readonly criteria: SlicingCriteria;
+}
+export interface ResolveValueQueryResult extends BaseQueryResult {
+    results: Record<string, {
+        values: unknown[];
+    }>;
+}
+export declare const ResolveValueQueryDefinition: {
+    readonly executor: typeof executeResolveValueQuery;
+    readonly asciiSummarizer: (formatter: import("../../../util/ansi").OutputFormatter, _processed: import("../../../core/steps/pipeline/pipeline").PipelineOutput<import("../../../core/steps/pipeline/pipeline").Pipeline<{
+        readonly name: "parse";
+        readonly humanReadableName: "parse with R shell";
+        readonly description: "Parse the given R code into an AST";
+        readonly processor: (_results: unknown, input: Partial<import("../../../r-bridge/parser").ParseRequiredInput<string>>) => Promise<import("../../../r-bridge/parser").ParseStepOutput<string>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: {
+                (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+                (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+            };
+            readonly 5: ({ parsed }: import("../../../r-bridge/parser").ParseStepOutput<string>, config: import("../../../util/quads").QuadSerializationConfiguration) => string;
+        };
+        readonly dependencies: readonly [];
+        readonly requiredInput: import("../../../r-bridge/parser").ParseRequiredInput<string>;
+    } | {
+        readonly name: "normalize";
+        readonly humanReadableName: "normalize";
+        readonly description: "Normalize the AST to flowR's AST";
+        readonly processor: (results: {
+            parse?: import("../../../r-bridge/parser").ParseStepOutput<string>;
+        }, input: Partial<import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput>) => import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../../../r-bridge/lang-4.x/ast/model/model").RNode<import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/normalize-printer").normalizedAstToJson;
+            readonly 5: typeof import("../../../core/print/normalize-printer").normalizedAstToQuads;
+            readonly 3: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaid;
+            readonly 4: typeof import("../../../core/print/normalize-printer").printNormalizedAstToMermaidUrl;
+        };
+        readonly dependencies: readonly ["parse"];
+        readonly requiredInput: import("../../../core/steps/all/core/10-normalize").NormalizeRequiredInput;
+    } | {
+        readonly humanReadableName: "dataflow";
+        readonly processor: (results: {
+            normalize?: import("../../../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+        }, input: {
+            request?: import("../../../r-bridge/retriever").RParseRequests;
+            parser?: import("../../../r-bridge/parser").Parser<import("../../../r-bridge/parser").KnownParserType>;
+        }) => import("../../../dataflow/info").DataflowInformation;
+        readonly requiredInput: {};
+        readonly name: "dataflow";
+        readonly description: "Construct the dataflow graph";
+        readonly executed: import("../../../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+        readonly printer: {
+            readonly 0: typeof import("../../../core/print/print").internalPrinter;
+            readonly 2: typeof import("../../../core/print/dataflow-printer").dataflowGraphToJson;
+            readonly 5: typeof import("../../../core/print/dataflow-printer").dataflowGraphToQuads;
+            readonly 3: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaid;
+            readonly 4: typeof import("../../../core/print/dataflow-printer").dataflowGraphToMermaidUrl;
+        };
+        readonly dependencies: readonly ["normalize"];
+    }>>, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly schema: Joi.ObjectSchema<any>;
+};

package/queries/catalog/resolve-value-query/resolve-value-query-format.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolveValueQueryDefinition = void 0;
+const ansi_1 = require("../../../util/ansi");
+const time_1 = require("../../../util/time");
+const joi_1 = __importDefault(require("joi"));
+const resolve_value_query_executor_1 = require("./resolve-value-query-executor");
+function rValueToAscii(value) {
+    if (value === null || value === undefined) {
+        return 'undefined';
+    }
+    else if (typeof value === 'string') {
+        return value;
+    }
+    else if (typeof value === 'object') {
+        if ('num' in value) {
+            return value.num.toString();
+        }
+        else if ('str' in value) {
+            return `${value.quotes}${value.str}${value.quotes}`;
+        }
+        else {
+            console.warn('omega lul');
+            return JSON.stringify(value);
+        }
+    }
+    return value;
+}
+exports.ResolveValueQueryDefinition = {
+    executor: resolve_value_query_executor_1.executeResolveValueQuery,
+    asciiSummarizer: (formatter, _processed, queryResults, result) => {
+        const out = queryResults;
+        result.push(`Query: ${(0, ansi_1.bold)('resolve-value', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
+        for (const [fingerprint, obj] of Object.entries(out.results)) {
+            const { criteria } = JSON.parse(fingerprint);
+            result.push(`   ╰ Values for {${criteria.join(', ')}}`);
+            result.push(`   	╰ ${obj.values.map(v => rValueToAscii(v)).join(', ')}`);
+        }
+        return true;
+    },
+    schema: joi_1.default.object({
+        type: joi_1.default.string().valid('resolve-value').required().description('The type of the query.'),
+        criteria: joi_1.default.array().items(joi_1.default.string()).min(1).required().description('The slicing criteria to use.'),
+    }).description('The resolve value query used to get definitions of an identifier')
+};
+//# sourceMappingURL=resolve-value-query-format.js.map

package/queries/catalog/search-query/search-query-format.js

@@ -24,6 +24,6 @@ exports.SearchQueryDefinition = {
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('search').required().description('The type of the query.'),
         search: joi_1.default.object().required().description('The search query to execute.')
-    }).description('The id map query retrieves the id map from the normalized AST.')
+    }).description('The search query searches the normalized AST and dataflow graph for nodes that match the given search query.')
 };
 //# sourceMappingURL=search-query-format.js.map

package/queries/query.d.ts

@@ -17,7 +17,8 @@ import type { LocationMapQuery } from './catalog/location-map-query/location-map
 import type { ConfigQuery } from './catalog/config-query/config-query-format';
 import type { SearchQuery } from './catalog/search-query/search-query-format';
 import type { HappensBeforeQuery } from './catalog/happens-before-query/happens-before-query-format';
-export type Query = CallContextQuery | ConfigQuery | SearchQuery | DataflowQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | LineageQuery | DependenciesQuery | LocationMapQuery | HappensBeforeQuery;
+import type { ResolveValueQuery } from './catalog/resolve-value-query/resolve-value-query-format';
+export type Query = CallContextQuery | ConfigQuery | SearchQuery | DataflowQuery | NormalizedAstQuery | IdMapQuery | DataflowClusterQuery | StaticSliceQuery | LineageQuery | DependenciesQuery | LocationMapQuery | HappensBeforeQuery | ResolveValueQuery;
 export type QueryArgumentsWithType<QueryType extends BaseQueryFormat['type']> = Query & {
     type: QueryType;
 };
@@ -568,6 +569,64 @@ export declare const SupportedQueries: {
         }>>, queryResults: BaseQueryResult, result: string[]) => true;
         readonly schema: Joi.ObjectSchema<any>;
     };
+    readonly 'resolve-value': {
+        readonly executor: typeof import("./catalog/resolve-value-query/resolve-value-query-executor").executeResolveValueQuery;
+        readonly asciiSummarizer: (formatter: OutputFormatter, _processed: PipelineOutput<import("../core/steps/pipeline/pipeline").Pipeline<{
+            readonly name: "parse";
+            readonly humanReadableName: "parse with R shell";
+            readonly description: "Parse the given R code into an AST";
+            readonly processor: (_results: unknown, input: Partial<import("../r-bridge/parser").ParseRequiredInput<string>>) => Promise<import("../r-bridge/parser").ParseStepOutput<string>>;
+            readonly executed: import("../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+            readonly printer: {
+                readonly 0: typeof import("../core/print/print").internalPrinter;
+                readonly 2: {
+                    (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+                    (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+                };
+                readonly 5: ({ parsed }: import("../r-bridge/parser").ParseStepOutput<string>, config: import("../util/quads").QuadSerializationConfiguration) => string;
+            };
+            readonly dependencies: readonly [];
+            readonly requiredInput: import("../r-bridge/parser").ParseRequiredInput<string>;
+        } | {
+            readonly name: "normalize";
+            readonly humanReadableName: "normalize";
+            readonly description: "Normalize the AST to flowR's AST";
+            readonly processor: (results: {
+                parse?: import("../r-bridge/parser").ParseStepOutput<string>;
+            }, input: Partial<import("../core/steps/all/core/10-normalize").NormalizeRequiredInput>) => import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation, import("../r-bridge/lang-4.x/ast/model/model").RNode<import("../r-bridge/lang-4.x/ast/model/processing/decorate").ParentInformation>>;
+            readonly executed: import("../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+            readonly printer: {
+                readonly 0: typeof import("../core/print/print").internalPrinter;
+                readonly 2: typeof import("../core/print/normalize-printer").normalizedAstToJson;
+                readonly 5: typeof import("../core/print/normalize-printer").normalizedAstToQuads;
+                readonly 3: typeof import("../core/print/normalize-printer").printNormalizedAstToMermaid;
+                readonly 4: typeof import("../core/print/normalize-printer").printNormalizedAstToMermaidUrl;
+            };
+            readonly dependencies: readonly ["parse"];
+            readonly requiredInput: import("../core/steps/all/core/10-normalize").NormalizeRequiredInput;
+        } | {
+            readonly humanReadableName: "dataflow";
+            readonly processor: (results: {
+                normalize?: import("../r-bridge/lang-4.x/ast/model/processing/decorate").NormalizedAst;
+            }, input: {
+                request?: import("../r-bridge/retriever").RParseRequests;
+                parser?: import("../r-bridge/parser").Parser<import("../r-bridge/parser").KnownParserType>;
+            }) => import("../dataflow/info").DataflowInformation;
+            readonly requiredInput: {};
+            readonly name: "dataflow";
+            readonly description: "Construct the dataflow graph";
+            readonly executed: import("../core/steps/pipeline-step").PipelineStepStage.OncePerFile;
+            readonly printer: {
+                readonly 0: typeof import("../core/print/print").internalPrinter;
+                readonly 2: typeof import("../core/print/dataflow-printer").dataflowGraphToJson;
+                readonly 5: typeof import("../core/print/dataflow-printer").dataflowGraphToQuads;
+                readonly 3: typeof import("../core/print/dataflow-printer").dataflowGraphToMermaid;
+                readonly 4: typeof import("../core/print/dataflow-printer").dataflowGraphToMermaidUrl;
+            };
+            readonly dependencies: readonly ["normalize"];
+        }>>, queryResults: BaseQueryResult, result: string[]) => true;
+        readonly schema: Joi.ObjectSchema<any>;
+    };
 };
 export type SupportedQueryTypes = keyof typeof SupportedQueries;
 export type QueryResult<Type extends Query['type']> = ReturnType<typeof SupportedQueries[Type]['executor']>;

package/queries/query.js

@@ -25,6 +25,7 @@ const location_map_query_format_1 = require("./catalog/location-map-query/locati
 const config_query_format_1 = require("./catalog/config-query/config-query-format");
 const search_query_format_1 = require("./catalog/search-query/search-query-format");
 const happens_before_query_format_1 = require("./catalog/happens-before-query/happens-before-query-format");
+const resolve_value_query_format_1 = require("./catalog/resolve-value-query/resolve-value-query-format");
 exports.SupportedQueries = {
     'call-context': call_context_query_format_1.CallContextQueryDefinition,
     'config': config_query_format_1.ConfigQueryDefinition,
@@ -37,7 +38,8 @@ exports.SupportedQueries = {
     'dependencies': dependencies_query_format_1.DependenciesQueryDefinition,
     'location-map': location_map_query_format_1.LocationMapQueryDefinition,
     'search': search_query_format_1.SearchQueryDefinition,
-    'happens-before': happens_before_query_format_1.HappensBeforeQueryDefinition
+    'happens-before': happens_before_query_format_1.HappensBeforeQueryDefinition,
+    'resolve-value': resolve_value_query_format_1.ResolveValueQueryDefinition
 };
 function executeQueriesOfSameType(data, ...queries) {
     (0, assert_1.guard)(queries.length > 0, 'At least one query must be provided');

package/r-bridge/data/data.d.ts

@@ -1,10 +1,12 @@
 export declare const flowrCapabilities: {
     readonly name: "Capabilities of flowR";
     readonly description: "This is an evolving representation of what started with #636 to formulate capabilities in a structured format.";
-    readonly version: "0.0.1";
+    readonly version: "0.0.2";
     readonly capabilities: readonly [{
         readonly name: "Names and Identifiers";
         readonly id: "names-and-identifiers";
+        readonly description: "The recognition of syntactical and non-syntactical names, including their resolutions to corresponding definitions.";
+        readonly example: (parser: import("../parser").KnownParser) => Promise<string>;
         readonly capabilities: readonly [{
             readonly name: "Form";
             readonly id: "form";
@@ -12,17 +14,41 @@ export declare const flowrCapabilities: {
                 readonly name: "Normal";
                 readonly id: "name-normal";
                 readonly supported: "fully";
-                readonly description: "_Recognize constructs like `a`, `plot`, ..._";
+                readonly description: "_Recognize symbol uses like `a`, `plot`, ..._  (i.e., \"normal variables or function calls\").";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/names-values.html#binding-basics";
+                }, {
+                    readonly name: string;
+                    readonly href: "https://cran.r-project.org/doc/manuals/r-release/R-lang.html#Identifiers-1";
+                }];
             }, {
                 readonly name: "Quoted";
                 readonly id: "name-quoted";
                 readonly supported: "fully";
-                readonly description: "_Recognize `\"a\"`, `'plot'`, ..._";
+                readonly description: "_Recognize `\"a\"`, `'plot'`, ..._ In general, R allows to envelop names in quotations to allow for special characters such as spaces in variable names. However, this only works in the context of definitions. To access these names as variables, one has to either use function such as `get` or escape the name with backticks.";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/names-values.html#non-syntactic";
+                }];
             }, {
                 readonly name: "Escaped";
                 readonly id: "name-escaped";
                 readonly supported: "fully";
                 readonly description: "_Recognize `` `a` ``, `` `plot` ``, ..._";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/names-values.html#non-syntactic";
+                }];
+            }, {
+                readonly name: "Created";
+                readonly id: "name-created";
+                readonly supported: "partially";
+                readonly description: "_Recognize functions which resolve strings as identifiers, such as `get`, ..._";
+                readonly url: [{
+                    readonly name: "flowr#633";
+                    readonly href: string;
+                }];
             }];
         }, {
             readonly name: "Resolution";
@@ -190,8 +216,8 @@ export declare const flowrCapabilities: {
                     readonly supported: "fully";
                     readonly description: "_Detect calls like `x[]`, `x[2,,42]`, ..._";
                 }, {
-                    readonly name: "Subsetting";
-                    readonly id: "subsetting";
+                    readonly name: "Subsetting (Multiple Indices)";
+                    readonly id: "subsetting-multiple";
                     readonly supported: "fully";
                     readonly description: "_Detect calls like `x[i > 3]`, `x[c(1,3)]`, ..._";
                 }];
@@ -538,25 +564,40 @@ export declare const flowrCapabilities: {
             readonly capabilities: readonly [{
                 readonly name: "S3";
                 readonly id: "oop-s3";
-                readonly note: "https://adv-r.hadley.nz/s3.html";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/s3.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle S3 classes and methods as one unit (with attributes etc.). Including Dispatch and Inheritance._ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }, {
                 readonly name: "S4";
                 readonly id: "oop-s4";
-                readonly note: "https://adv-r.hadley.nz/s4.html";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/s4.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle S4 classes and methods as one unit. Including Dispatch and Inheritance_ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }, {
                 readonly name: "R6";
                 readonly id: "oop-r6";
-                readonly note: "https://adv-r.hadley.nz/r6.html";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/r6.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle R6 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Access Control, Finalizers, and Introspection._ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }, {
                 readonly name: "R7/S7";
                 readonly id: "r7-s7";
-                readonly note: "https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/, https://cran.r-project.org/web/packages/S7/index.html";
+                readonly url: [{
+                    readonly name: "R7";
+                    readonly href: "https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/";
+                }, {
+                    readonly name: "S7";
+                    readonly href: "https://cran.r-project.org/web/packages/S7/index.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle R7 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Validators, ..._ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }];

package/r-bridge/data/data.js

@@ -1,14 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.flowrCapabilities = void 0;
+const doc_files_1 = require("../../documentation/doc-util/doc-files");
+const doc_code_1 = require("../../documentation/doc-util/doc-code");
+const doc_dfg_1 = require("../../documentation/doc-util/doc-dfg");
+const Joiner = '/';
+const AdvancedR = (subname) => 'Advanced R' + Joiner + subname;
+const RLang = (subname) => 'R Definition' + Joiner + subname;
+const Issue = (num) => `${doc_files_1.FlowrGithubBaseRef}/flowr/issues/${num}`;
+const LinkTo = (id, label = id) => `[${label}](#${id})`;
 exports.flowrCapabilities = {
     name: 'Capabilities of flowR',
     description: 'This is an evolving representation of what started with #636 to formulate capabilities in a structured format.',
-    version: '0.0.1',
+    version: '0.0.2',
     capabilities: [
         {
             name: 'Names and Identifiers',
             id: 'names-and-identifiers',
+            description: 'The recognition of syntactical and non-syntactical names, including their resolutions to corresponding definitions.',
+            example: async (parser) => {
+                const code = '"f" <- function(x) { get("x") } \n`y x` <- 2\nprint(`y x` + f(3))';
+                return `
+Consider the following R code:
+${(0, doc_code_1.codeBlock)('r', code)}
+Identifiers of interest are:
+
+- The symbols \`x\` (${LinkTo('name-normal')}), \`f\` (${LinkTo('name-quoted')}), and \`\` \`y x\` \`\` (${LinkTo('name-escaped')}).
+- The function calls \`<-\`, \`function\`, \`{\`, \`get\`, \`+\`, and \`print\` (${LinkTo('function-calls')}, all given with ${LinkTo('name-normal')}).
+  Especially \`{\` is identified as a ${LinkTo('grouping')} of the ${LinkTo('function-definitions', 'function-definitions\'')} body.
+- The quoted name created by a function call \`get\` (${LinkTo('name-created')}).
+
+Besides the parameter \`x\`, which is resolved in its ${LinkTo('lexicographic-scope')}, the other identifiers are resolved in the ${LinkTo('global-scope')}.
+
+${await (0, doc_dfg_1.printDfGraphForCode)(parser, code, { simplified: true })}
+			`;
+            },
             capabilities: [
                 {
                     name: 'Form',
@@ -18,19 +44,38 @@ exports.flowrCapabilities = {
                             name: 'Normal',
                             id: 'name-normal',
                             supported: 'fully',
-                            description: '_Recognize constructs like `a`, `plot`, ..._'
+                            description: '_Recognize symbol uses like `a`, `plot`, ..._  (i.e., "normal variables or function calls").',
+                            url: [
+                                { name: AdvancedR('Bindings'), href: 'https://adv-r.hadley.nz/names-values.html#binding-basics' },
+                                { name: RLang('Identifiers'), href: 'https://cran.r-project.org/doc/manuals/r-release/R-lang.html#Identifiers-1' }
+                            ]
                         },
                         {
                             name: 'Quoted',
                             id: 'name-quoted',
                             supported: 'fully',
-                            description: "_Recognize `\"a\"`, `'plot'`, ..._"
+                            description: "_Recognize `\"a\"`, `'plot'`, ..._ In general, R allows to envelop names in quotations to allow for special characters such as spaces in variable names. However, this only works in the context of definitions. To access these names as variables, one has to either use function such as `get` or escape the name with backticks.",
+                            url: [
+                                { name: AdvancedR('Non-Syntactic Names'), href: 'https://adv-r.hadley.nz/names-values.html#non-syntactic' }
+                            ]
                         },
                         {
                             name: 'Escaped',
                             id: 'name-escaped',
                             supported: 'fully',
-                            description: '_Recognize `` `a` ``, `` `plot` ``, ..._'
+                            description: '_Recognize `` `a` ``, `` `plot` ``, ..._',
+                            url: [
+                                { name: AdvancedR('Non-Syntactic Names'), href: 'https://adv-r.hadley.nz/names-values.html#non-syntactic' }
+                            ]
+                        },
+                        {
+                            name: 'Created',
+                            id: 'name-created',
+                            supported: 'partially',
+                            description: '_Recognize functions which resolve strings as identifiers, such as `get`, ..._',
+                            url: [
+                                { name: 'flowr#633', href: Issue(633) }
+                            ]
                         }
                     ]
                 },
@@ -237,8 +282,8 @@ exports.flowrCapabilities = {
                                     description: '_Detect calls like `x[]`, `x[2,,42]`, ..._'
                                 },
                                 {
-                                    name: 'Subsetting',
-                                    id: 'subsetting',
+                                    name: 'Subsetting (Multiple Indices)',
+                                    id: 'subsetting-multiple',
                                     supported: 'fully',
                                     description: '_Detect calls like `x[i > 3]`, `x[c(1,3)]`, ..._'
                                 }
@@ -671,28 +716,37 @@ exports.flowrCapabilities = {
                         {
                             name: 'S3',
                             id: 'oop-s3',
-                            note: 'https://adv-r.hadley.nz/s3.html',
+                            url: [
+                                { name: AdvancedR('S3'), href: 'https://adv-r.hadley.nz/s3.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle S3 classes and methods as one unit (with attributes etc.). Including Dispatch and Inheritance._ We do not support typing currently and do not handle objects of these classes "as units."'
                         },
                         {
                             name: 'S4',
                             id: 'oop-s4',
-                            note: 'https://adv-r.hadley.nz/s4.html',
+                            url: [
+                                { name: AdvancedR('S4'), href: 'https://adv-r.hadley.nz/s4.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle S4 classes and methods as one unit. Including Dispatch and Inheritance_ We do not support typing currently and do not handle objects of these classes "as units."'
                         },
                         {
                             name: 'R6',
                             id: 'oop-r6',
-                            note: 'https://adv-r.hadley.nz/r6.html',
+                            url: [
+                                { name: AdvancedR('R6'), href: 'https://adv-r.hadley.nz/r6.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle R6 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Access Control, Finalizers, and Introspection._ We do not support typing currently and do not handle objects of these classes "as units."'
                         },
                         {
                             name: 'R7/S7',
                             id: 'r7-s7',
-                            note: 'https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/, https://cran.r-project.org/web/packages/S7/index.html',
+                            url: [
+                                { name: 'R7', href: 'https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/' },
+                                { name: 'S7', href: 'https://cran.r-project.org/web/packages/S7/index.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle R7 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Validators, ..._ We do not support typing currently and do not handle objects of these classes "as units."'
                         }

package/r-bridge/data/types.d.ts

@@ -1,3 +1,4 @@
+import type { KnownParser } from '../parser';
 declare const enum RequiredFeature {
     /** https://github.com/flowr-analysis/flowr/labels/typing */
     Typing = 0,
@@ -15,7 +16,12 @@ export interface FlowrCapability {
     /** A list of features that are required for the capability, extend at need. */
     readonly needs?: RequiredFeature[];
     readonly description?: string;
-    readonly note?: string;
+    readonly example?: string | ((parser: KnownParser) => Promise<string>);
+    /** A list of URLs that provide additional information about the capability */
+    readonly url?: {
+        name: string;
+        href: string;
+    }[];
     /** The level of support for the capability, undefined if it is a meta-capability that does not need such an attribute */
     readonly supported?: 'not' | 'partially' | 'fully';
     readonly capabilities?: readonly FlowrCapability[];

package/r-bridge/lang-4.x/ast/model/processing/decorate.d.ts

@@ -74,6 +74,8 @@ export interface NormalizedAst<OtherInfo = ParentInformation, Node = RNode<Other
     idMap: AstIdMap<OtherInfo>;
     /** The root of the AST with parent information */
     ast: Node;
+    /** marks whether the AST contains potential syntax errors */
+    hasError?: boolean;
 }
 export interface NormalizedAstDecorationConfiguration<OtherInfo> {
     /** The id generator: must generate a unique id für each passed node */

package/r-bridge/lang-4.x/ast/model/processing/node-id.js

@@ -27,10 +27,7 @@ function recoverName(id, idMap) {
  */
 function recoverContent(id, graph) {
     const vertex = graph.getVertex(id);
-    if (vertex === undefined) {
-        return undefined;
-    }
-    if (vertex.tag === vertex_1.VertexType.FunctionCall && vertex.name) {
+    if (vertex && vertex.tag === vertex_1.VertexType.FunctionCall && vertex.name) {
         return vertex.name;
     }
     const node = graph.idMap?.get(id);
@@ -38,7 +35,7 @@ function recoverContent(id, graph) {
         return undefined;
     }
     const lexeme = node.lexeme ?? node.info.fullLexeme ?? '';
-    if (vertex.tag === vertex_1.VertexType.Use) {
+    if (vertex?.tag === vertex_1.VertexType.Use) {
         return (0, retriever_1.removeRQuotes)(lexeme);
     }
     return lexeme;

package/r-bridge/lang-4.x/ast/parser/json/format.d.ts

@@ -36,6 +36,12 @@ export interface NamedJsonEntry {
     name: RawRType;
     content: JsonEntry;
 }
+/**
+ * Takes the raw {@link RShell} output and extracts the csv information contained
+ */
 export declare function prepareParsedData(data: string): CsvEntry[];
+/**
+ * Takes the CSV-Entries and maps them to the old json format for compatibility.
+ */
 export declare function convertPreparedParsedData(roots: readonly CsvEntry[]): JsonEntry;
 export {};