@eagleoutice/flowr 2.6.1 → 2.6.2

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

@@ -8,6 +8,21 @@ const ansi_1 = require("../../../util/text/ansi");
 const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const origin_query_executor_1 = require("./origin-query-executor");
+const slice_query_parser_1 = require("../../../cli/repl/parser/slice-query-parser");
+function originQueryLineParser(output, line, _config) {
+    const criterion = (0, slice_query_parser_1.sliceCriterionParser)(line[0]);
+    if (!criterion) {
+        output.stderr(output.formatter.format('Invalid origin query format, slicing criterion must be given in parentheses, e.g. (2@var), (1:5) or ($10)', { color: 1 /* Colors.Red */, effect: ansi_1.ColorEffect.Foreground, style: 1 /* FontStyles.Bold */ }));
+        return { query: [] };
+    }
+    return {
+        query: {
+            type: 'origin',
+            criterion: criterion
+        },
+        rCode: line[1]
+    };
+}
 exports.OriginQueryDefinition = {
     executor: origin_query_executor_1.executeResolveValueQuery,
     asciiSummarizer: (formatter, _analyzer, queryResults, result) => {
@@ -15,10 +30,11 @@ exports.OriginQueryDefinition = {
         result.push(`Query: ${(0, ansi_1.bold)('origin', formatter)} (${(0, time_1.printAsMs)(out['.meta'].timing, 0)})`);
         for (const [criteria, obj] of Object.entries(out.results)) {
             result.push(`   ╰ Origins for {${criteria}}`);
-            result.push(`   	╰ ${obj?.map(o => JSON.stringify(o)).join(', ')}`);
+            result.push(`     ╰ ${obj?.map(o => JSON.stringify(o)).join(', ')}`);
         }
         return true;
     },
+    fromLine: originQueryLineParser,
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('origin').required().description('The type of the query.'),
         criterion: joi_1.default.string().required().description('The slicing criteria to use'),

package/queries/catalog/project-query/project-query-executor.d.ts

@@ -1,3 +1,6 @@
 import type { ProjectQuery, ProjectQueryResult } from './project-query-format';
 import type { BasicQueryData } from '../../base-query-format';
+/**
+ * Executes the given project queries.
+ */
 export declare function executeProjectQuery({ analyzer }: BasicQueryData, queries: readonly ProjectQuery[]): Promise<ProjectQueryResult>;

package/queries/catalog/project-query/project-query-executor.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeProjectQuery = executeProjectQuery;
 const log_1 = require("../../../util/log");
+/**
+ * Executes the given project queries.
+ */
 async function executeProjectQuery({ analyzer }, queries) {
     if (queries.length !== 1) {
         log_1.log.warn('Project query expects only up to one query, but got', queries.length);

package/queries/catalog/project-query/project-query-format.d.ts

@@ -9,7 +9,7 @@ export interface ProjectQueryResult extends BaseQueryResult {
 }
 export declare const ProjectQueryDefinition: {
     readonly executor: typeof executeProjectQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").FlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
     readonly flattenInvolvedNodes: () => never[];
 };

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

@@ -1,4 +1,10 @@
 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({ analyzer }: BasicQueryData, queries: readonly ResolveValueQuery[]): Promise<ResolveValueQueryResult>;

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

@@ -5,9 +5,15 @@ exports.executeResolveValueQuery = executeResolveValueQuery;
 const log_1 = require("../../../util/log");
 const parse_1 = require("../../../slicing/criterion/parse");
 const alias_tracking_1 = require("../../../dataflow/eval/resolve/alias-tracking");
+/**
+ *
+ */
 function fingerPrintOfQuery(query) {
     return JSON.stringify(query);
 }
+/**
+ *
+ */
 async function executeResolveValueQuery({ analyzer }, queries) {
     const start = Date.now();
     const results = {};

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

@@ -1,8 +1,11 @@
 import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
 import type { SlicingCriteria } from '../../../slicing/criterion/parse';
+import type { ParsedQueryLine } from '../../query';
 import Joi from 'joi';
 import { executeResolveValueQuery } from './resolve-value-query-executor';
 import type { ResolveResult } from '../../../dataflow/eval/resolve/alias-tracking';
+import type { ReplOutput } from '../../../cli/repl/commands/repl-main';
+import type { FlowrConfigOptions } from '../../../config';
 export interface ResolveValueQuery extends BaseQueryFormat {
     readonly type: 'resolve-value';
     /** The slicing criteria to use */
@@ -13,9 +16,12 @@ export interface ResolveValueQueryResult extends BaseQueryResult {
         values: ResolveResult[];
     }>;
 }
+declare function resolveValueLineParser(output: ReplOutput, line: readonly string[], _config: FlowrConfigOptions): ParsedQueryLine<'resolve-value'>;
 export declare const ResolveValueQueryDefinition: {
     readonly executor: typeof executeResolveValueQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").FlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly fromLine: typeof resolveValueLineParser;
     readonly schema: Joi.ObjectSchema<any>;
     readonly flattenInvolvedNodes: () => never[];
 };
+export {};

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

@@ -9,6 +9,23 @@ const time_1 = require("../../../util/text/time");
 const joi_1 = __importDefault(require("joi"));
 const resolve_value_query_executor_1 = require("./resolve-value-query-executor");
 const r_value_1 = require("../../../dataflow/eval/values/r-value");
+const slice_query_parser_1 = require("../../../cli/repl/parser/slice-query-parser");
+function resolveValueLineParser(output, line, _config) {
+    const criteria = (0, slice_query_parser_1.sliceCriteriaParser)(line[0]);
+    if (!criteria || criteria.length == 0) {
+        output.stderr(output.formatter.format('Invalid resolve-value query format, slicing criteria must be given in the form "(criterion1;criterion2;...)"', { color: 1 /* Colors.Red */, effect: ansi_1.ColorEffect.Foreground, style: 1 /* FontStyles.Bold */ }));
+        return { query: [] };
+    }
+    return {
+        query: [
+            {
+                type: 'resolve-value',
+                criteria: criteria,
+            }
+        ],
+        rCode: line[1]
+    };
+}
 exports.ResolveValueQueryDefinition = {
     executor: resolve_value_query_executor_1.executeResolveValueQuery,
     asciiSummarizer: (formatter, _analyzer, queryResults, result) => {
@@ -17,10 +34,11 @@ exports.ResolveValueQueryDefinition = {
         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 => (0, r_value_1.stringifyValue)(v)).join(', ')}`);
+            result.push(`     ╰ ${obj.values.map(v => (0, r_value_1.stringifyValue)(v)).join(', ')}`);
         }
         return true;
     },
+    fromLine: resolveValueLineParser,
     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.'),

package/queries/catalog/search-query/search-query-executor.d.ts

@@ -1,3 +1,6 @@
 import type { BasicQueryData } from '../../base-query-format';
 import type { SearchQuery, SearchQueryResult } from './search-query-format';
+/**
+ * Executes the given search queries using the provided analyzer.
+ */
 export declare function executeSearch({ analyzer }: BasicQueryData, queries: readonly SearchQuery[]): Promise<SearchQueryResult>;

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

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeSearch = executeSearch;
 const flowr_search_executor_1 = require("../../../search/flowr-search-executor");
+/**
+ * Executes the given search queries using the provided analyzer.
+ */
 async function executeSearch({ analyzer }, queries) {
     const start = Date.now();
     const results = [];

package/queries/catalog/search-query/search-query-format.d.ts

@@ -15,7 +15,7 @@ export interface SearchQueryResult extends BaseQueryResult {
 }
 export declare const SearchQueryDefinition: {
     readonly executor: typeof executeSearch;
-    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").FlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
     readonly schema: Joi.ObjectSchema<any>;
     readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
 };

package/queries/catalog/static-slice-query/static-slice-query-executor.d.ts

@@ -1,4 +1,13 @@
 import type { StaticSliceQuery, StaticSliceQueryResult } from './static-slice-query-format';
 import type { BasicQueryData } from '../../base-query-format';
+/**
+ * Produce a fingerprint string for a static slice query
+ */
 export declare function fingerPrintOfQuery(query: StaticSliceQuery): string;
+/**
+ * Execute static slice queries, catching duplicates with the same fingerprint
+ * @param analyzer - The basic query data containing the analyzer
+ * @param queries - The static slice queries to execute
+ * @returns The results of the static slice queries
+ */
 export declare function executeStaticSliceQuery({ analyzer }: BasicQueryData, queries: readonly StaticSliceQuery[]): Promise<StaticSliceQueryResult>;

package/queries/catalog/static-slice-query/static-slice-query-executor.js

@@ -8,9 +8,18 @@ const auto_select_defaults_1 = require("../../../reconstruct/auto-select/auto-se
 const magic_comments_1 = require("../../../reconstruct/auto-select/magic-comments");
 const log_1 = require("../../../util/log");
 const _00_slice_1 = require("../../../core/steps/all/static-slicing/00-slice");
+/**
+ * Produce a fingerprint string for a static slice query
+ */
 function fingerPrintOfQuery(query) {
     return JSON.stringify(query);
 }
+/**
+ * Execute static slice queries, catching duplicates with the same fingerprint
+ * @param analyzer - The basic query data containing the analyzer
+ * @param queries - The static slice queries to execute
+ * @returns The results of the static slice queries
+ */
 async function executeStaticSliceQuery({ analyzer }, queries) {
     const start = Date.now();
     const results = {};

package/queries/catalog/static-slice-query/static-slice-query-format.d.ts

@@ -2,10 +2,13 @@ import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
 import type { PipelineOutput } from '../../../core/steps/pipeline/pipeline';
 import type { DEFAULT_DATAFLOW_PIPELINE, DEFAULT_SLICE_WITHOUT_RECONSTRUCT_PIPELINE, DEFAULT_SLICING_PIPELINE } from '../../../core/steps/pipeline/default-pipelines';
 import type { SlicingCriteria } from '../../../slicing/criterion/parse';
+import type { ParsedQueryLine } from '../../query';
 import Joi from 'joi';
 import { executeStaticSliceQuery } from './static-slice-query-executor';
 import { SliceDirection } from '../../../core/steps/all/static-slicing/00-slice';
 import type { NodeId } from '../../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import type { ReplOutput } from '../../../cli/repl/commands/repl-main';
+import type { FlowrConfigOptions } from '../../../config';
 /** Calculates and returns all clusters encountered in the dataflow graph. */
 export interface StaticSliceQuery extends BaseQueryFormat {
     readonly type: 'static-slice';
@@ -28,9 +31,12 @@ export interface StaticSliceQueryResult extends BaseQueryResult {
      */
     results: Record<string, Omit<PipelineOutput<typeof DEFAULT_SLICING_PIPELINE>, keyof PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>> | Omit<PipelineOutput<typeof DEFAULT_SLICE_WITHOUT_RECONSTRUCT_PIPELINE>, keyof PipelineOutput<typeof DEFAULT_DATAFLOW_PIPELINE>>>;
 }
+declare function sliceQueryLineParser(output: ReplOutput, line: readonly string[], _config: FlowrConfigOptions): ParsedQueryLine<'static-slice'>;
 export declare const StaticSliceQueryDefinition: {
     readonly executor: typeof executeStaticSliceQuery;
-    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").FlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, _analyzer: import("../../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider, queryResults: BaseQueryResult, result: string[]) => true;
+    readonly fromLine: typeof sliceQueryLineParser;
     readonly schema: Joi.ObjectSchema<any>;
     readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => NodeId[];
 };
+export {};

package/queries/catalog/static-slice-query/static-slice-query-format.js

@@ -10,6 +10,22 @@ const joi_1 = __importDefault(require("joi"));
 const static_slice_query_executor_1 = require("./static-slice-query-executor");
 const query_print_1 = require("../../query-print");
 const _00_slice_1 = require("../../../core/steps/all/static-slicing/00-slice");
+const slice_query_parser_1 = require("../../../cli/repl/parser/slice-query-parser");
+function sliceQueryLineParser(output, line, _config) {
+    const criteria = (0, slice_query_parser_1.sliceCriteriaParser)(line[0]);
+    const direction = (0, slice_query_parser_1.sliceDirectionParser)(line[0]);
+    if (!criteria || criteria.length == 0) {
+        output.stderr(output.formatter.format('Invalid static-slice query format, slicing criteria must be given in the form "(criterion1;criterion2;...)"', { color: 1 /* Colors.Red */, effect: ansi_1.ColorEffect.Foreground, style: 1 /* FontStyles.Bold */ }));
+        return { query: [] };
+    }
+    return { query: [
+            {
+                type: 'static-slice',
+                criteria: criteria,
+                direction: direction,
+            }
+        ], rCode: line[1] };
+}
 exports.StaticSliceQueryDefinition = {
     executor: static_slice_query_executor_1.executeStaticSliceQuery,
     asciiSummarizer: (formatter, _analyzer, queryResults, result) => {
@@ -34,6 +50,7 @@ exports.StaticSliceQueryDefinition = {
         }
         return true;
     },
+    fromLine: sliceQueryLineParser,
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('static-slice').required().description('The type of the query.'),
         criteria: joi_1.default.array().items(joi_1.default.string()).min(0).required().description('The slicing criteria to use.'),

package/queries/query-print.d.ts

@@ -1,8 +1,24 @@
-import type { OutputFormatter } from '../util/text/ansi';
-import type { Queries, QueryResults, SupportedQueryTypes } from './query';
+import { type OutputFormatter } from '../util/text/ansi';
+import { type Queries, type QueryResults, type SupportedQueryTypes } from './query';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { AstIdMap, ParentInformation } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { FlowrAnalysisProvider } from '../project/flowr-analyzer';
+import type { ReadonlyFlowrAnalysisProvider } from '../project/flowr-analyzer';
+/**
+ * Converts call context query results to an ASCII representation
+ */
 export declare function asciiCallContext(formatter: OutputFormatter, results: QueryResults<'call-context'>['call-context'], idMap: AstIdMap<ParentInformation>): string;
+/**
+ * Summarizes a list of node IDs, shortening the output if it is too long
+ * @example
+ * ```ts
+ * summarizeIdsIfTooLong(markdownFormatter, ['id1', 'id2', 'id3']);
+ * // returns 'id1, id2, id3'
+ * summarizeIdsIfTooLong(markdownFormatter, [<array of many ids>]);
+ * // returns 'id1, id2, id3, ... (see JSON)' with a tooltip containing the full JSON array
+ * ```
+ */
 export declare function summarizeIdsIfTooLong(formatter: OutputFormatter, ids: readonly NodeId[]): string;
-export declare function asciiSummaryOfQueryResult<S extends SupportedQueryTypes>(formatter: OutputFormatter, totalInMs: number, results: QueryResults<S>, analyzer: FlowrAnalysisProvider, queries: Queries<S>): Promise<string>;
+/**
+ * Generates an ASCII summary of the given query results
+ */
+export declare function asciiSummaryOfQueryResult<S extends SupportedQueryTypes>(formatter: OutputFormatter, totalInMs: number, results: QueryResults<S>, analyzer: ReadonlyFlowrAnalysisProvider, queries: Queries<S>): Promise<string>;

package/queries/query-print.js

@@ -10,8 +10,8 @@ const time_1 = require("../util/text/time");
 const built_in_1 = require("../dataflow/environments/built-in");
 function nodeString(nodeId, formatter, idMap) {
     const isObj = typeof nodeId === 'object' && nodeId !== null && 'id' in nodeId;
-    const id = isObj ? nodeId.id : nodeId;
-    const info = isObj ? nodeId.info : undefined;
+    const id = isObj ? nodeId?.id : nodeId;
+    const info = isObj ? nodeId?.info : undefined;
     if ((0, built_in_1.isBuiltIn)(id)) {
         return (0, ansi_1.italic)(id, formatter) + (info ? ` (${JSON.stringify(info)})` : '');
     }
@@ -43,6 +43,9 @@ function asciiCallContextSubHit(formatter, results, idMap) {
     }
     return result.join(', ');
 }
+/**
+ * Converts call context query results to an ASCII representation
+ */
 function asciiCallContext(formatter, results, idMap) {
     /* traverse over 'kinds' and within them 'subkinds' */
     const result = [];
@@ -54,6 +57,16 @@ function asciiCallContext(formatter, results, idMap) {
     }
     return result.join('\n');
 }
+/**
+ * Summarizes a list of node IDs, shortening the output if it is too long
+ * @example
+ * ```ts
+ * summarizeIdsIfTooLong(markdownFormatter, ['id1', 'id2', 'id3']);
+ * // returns 'id1, id2, id3'
+ * summarizeIdsIfTooLong(markdownFormatter, [<array of many ids>]);
+ * // returns 'id1, id2, id3, ... (see JSON)' with a tooltip containing the full JSON array
+ * ```
+ */
 function summarizeIdsIfTooLong(formatter, ids) {
     const naive = ids.join(', ');
     if (naive.length <= 20) {
@@ -69,6 +82,9 @@ function summarizeIdsIfTooLong(formatter, ids) {
     }
     return formatter === ansi_1.markdownFormatter ? (0, html_hover_over_1.textWithTooltip)(acc, JSON.stringify(ids)) : acc;
 }
+/**
+ * Generates an ASCII summary of the given query results
+ */
 async function asciiSummaryOfQueryResult(formatter, totalInMs, results, analyzer, queries) {
     const result = [];
     for (const [query, queryResults] of Object.entries(results)) {