@eagleoutice/flowr 2.7.5 → 2.8.0

package/dataflow/environments/default-builtin-config.d.ts

@@ -1,5 +1,10 @@
-import type { BuiltInDefinitions } from './built-in-config';
+import { ExitPointType } from '../info';
+import type { DataflowGraph } from '../graph/graph';
+import type { DataflowGraphVertexFunctionCall } from '../graph/vertex';
+import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
+import { CascadeAction } from '../../queries/catalog/call-context-query/cascade-action';
 import type { BuiltInMappingName } from './built-in';
+import { KnownHooks } from '../hooks';
 export declare const GgPlotCreate: readonly ["ggplot", "ggplotly", "ggMarginal", "ggcorrplot", "ggseasonplot", "ggdendrogram", "qmap", "qplot", "quickplot", "autoplot", "grid.arrange", "fviz_pca_biplot", "fviz_pca", "fviz_pca_ind", "fviz_pca_var", "fviz_screeplot", "fviz_mca_biplot", "fviz_mca", "fviz_mca_ind", "fviz_mca_var", "fviz_cluster", "fviz_dend", "ggsurvplot"];
 export declare const TinyPlotCrate: readonly ["tinyplot", "plt"];
 export declare const GraphicsPlotCreate: string[];
@@ -12,8 +17,614 @@ export declare const GgPlotAddons: string[];
 /**
  * Contains the built-in definitions recognized by flowR
  */
-export declare const DefaultBuiltinConfig: BuiltInDefinitions;
+export declare const DefaultBuiltinConfig: [{
+    readonly type: "constant";
+    readonly names: ["NULL", "NA", "NaN", "NA_integer_", "NA_real_", "NA_complex_", "NA_character_"];
+    readonly value: null;
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "constant";
+    readonly names: ["TRUE", "T"];
+    readonly value: true;
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "constant";
+    readonly names: ["FALSE", "F"];
+    readonly value: false;
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["~", "+", "-", "*", "/", "^", "!", "?", "**", "==", "!=", ">", "<", ">=", "<=", "%%", "%/%", "%*%", "%in%", ":", "rep", "seq", "seq_len", "seq_along", "seq.int", "gsub", "which", "class", "dimnames", "min", "max", "intersect", "subset", "match", "sqrt", "abs", "round", "floor", "ceiling", "signif", "trunc", "log", "log10", "log2", "sum", "mean", "unique", "paste", "paste0", "read.csv", "is.null", "numeric", "as.character", "as.integer", "as.logical", "as.numeric", "as.matrix", "rbind", "nrow", "ncol", "tryCatch", "expression", "factor", "missing", "as.data.frame", "data.frame", "na.omit", "rownames", "names", "order", "length", "any", "dim", "matrix", "cbind", "nchar", "pdf", "jpeg", "png", "windows", "postscript", "xfig", "bitmap", "pictex", "cairo_pdf", "svg", "bmp", "tiff", "X11", "quartz", "jitter"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly readAllArguments: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["t", "aperm"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly readAllArguments: true;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["rm"];
+    readonly processor: "builtin:rm";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["options"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly hasUnknownSideEffects: true;
+        readonly forceArgs: "all";
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["mapply", "Mapply"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 0;
+        readonly nameOfFunctionArgument: "FUN";
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["lapply", "sapply", "vapply"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 1;
+        readonly nameOfFunctionArgument: "FUN";
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["Lapply", "Sapply", "Vapply"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 1;
+        readonly nameOfFunctionArgument: "FUN";
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["apply", "tapply", "Tapply"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 2;
+        readonly nameOfFunctionArgument: "FUN";
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["print", "message", "warning"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly returnsNthArgument: 0;
+        readonly forceArgs: "all";
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly callName: RegExp;
+        };
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: string[];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly forceArgs: "all";
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly ignoreIf: (source: DataflowGraphVertexFunctionCall, graph: DataflowGraph) => boolean;
+            readonly callName: RegExp;
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: string[];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly forceArgs: "all";
+        readonly treatAsFnCall: {
+            readonly facet_grid: readonly ["labeller"];
+        };
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly callName: RegExp;
+            readonly ignoreIf: (source: NodeId, graph: DataflowGraph) => boolean;
+            readonly cascadeIf: (target: DataflowGraphVertexFunctionCall, _: NodeId, graph: DataflowGraph) => CascadeAction.Stop | CascadeAction.Continue;
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: string[];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly libFn: true;
+        readonly forceArgs: "all";
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly callName: RegExp;
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: string[];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly libFn: true;
+        readonly forceArgs: "all";
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly callName: RegExp;
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["image_write", "image_capture", "dev.capture", "dev.off"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly libFn: true;
+        readonly forceArgs: "all";
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly callName: RegExp;
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["("];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly returnsNthArgument: 0;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["load", "load_all", "setwd", "set.seed"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly hasUnknownSideEffects: true;
+        readonly forceArgs: readonly [true];
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["body", "formals", "environment"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly hasUnknownSideEffects: true;
+        readonly forceArgs: readonly [true];
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: [".Call", ".External", ".C", ".Fortran"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly hasUnknownSideEffects: true;
+        readonly forceArgs: readonly [true];
+        readonly treatAsFnCall: {
+            readonly '.Call': readonly [".NAME"];
+            readonly '.External': readonly [".NAME"];
+            readonly '.C': readonly [".NAME"];
+            readonly '.Fortran': readonly [".NAME"];
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["eval"];
+    readonly processor: "builtin:eval";
+    readonly config: {
+        readonly includeFunctionCall: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["cat"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly forceArgs: "all";
+        readonly hasUnknownSideEffects: {
+            readonly type: "link-to-last-call";
+            readonly callName: RegExp;
+        };
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["switch"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly forceArgs: readonly [true];
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["return"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly returnsNthArgument: 0;
+        readonly cfg: ExitPointType.Return;
+        readonly useAsProcessor: "builtin:return";
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["stop", "abort"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly useAsProcessor: "builtin:stop";
+        readonly cfg: ExitPointType.Error;
+        readonly forceArgs: readonly ["all"];
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["try"];
+    readonly processor: "builtin:try";
+    readonly config: {
+        readonly block: "expr";
+        readonly handlers: {};
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["tryCatch", "tryCatchLog"];
+    readonly processor: "builtin:try";
+    readonly config: {
+        readonly block: "expr";
+        readonly handlers: {
+            readonly error: "error";
+            readonly finally: "finally";
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["stopifnot"];
+    readonly processor: "builtin:stopifnot";
+    readonly config: {};
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["break"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly useAsProcessor: "builtin:break";
+        readonly cfg: ExitPointType.Break;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["next"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly cfg: ExitPointType.Next;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["{"];
+    readonly processor: "builtin:expression-list";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["source"];
+    readonly processor: "builtin:source";
+    readonly config: {
+        readonly includeFunctionCall: true;
+        readonly forceFollow: false;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["[", "[["];
+    readonly processor: "builtin:access";
+    readonly config: {
+        readonly treatIndicesAsString: false;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["$", "@"];
+    readonly processor: "builtin:access";
+    readonly config: {
+        readonly treatIndicesAsString: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["if", "ifelse"];
+    readonly processor: "builtin:if-then-else";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["get"];
+    readonly processor: "builtin:get";
+    readonly config: {};
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["library", "require"];
+    readonly processor: "builtin:library";
+    readonly config: {};
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["<-", "="];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly canBeReplacement: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: [":="];
+    readonly processor: "builtin:assignment";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["assign", "setGeneric", "setValidity"];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly targetVariable: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["setMethod"];
+    readonly processor: "builtin:assignment-like";
+    readonly config: {
+        readonly targetVariable: true;
+        readonly canBeReplacement: false;
+        readonly target: {
+            readonly idx: 0;
+            readonly name: "f";
+        };
+        readonly source: {
+            readonly idx: 2;
+            readonly name: "definition";
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["delayedAssign"];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly quoteSource: true;
+        readonly targetVariable: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["<<-"];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly superAssignment: true;
+        readonly canBeReplacement: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["->"];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly swapSourceAndTarget: true;
+        readonly canBeReplacement: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["->>"];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly superAssignment: true;
+        readonly swapSourceAndTarget: true;
+        readonly canBeReplacement: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["&&", "&"];
+    readonly processor: "builtin:special-bin-op";
+    readonly config: {
+        readonly lazy: true;
+        readonly evalRhsWhen: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["||", "|"];
+    readonly processor: "builtin:special-bin-op";
+    readonly config: {
+        readonly lazy: true;
+        readonly evalRhsWhen: false;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["|>", "%>%"];
+    readonly processor: "builtin:pipe";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["function", "\\"];
+    readonly processor: "builtin:function-definition";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["quote", "substitute", "bquote"];
+    readonly processor: "builtin:quote";
+    readonly config: {
+        readonly quoteArgumentsWithIndex: 0;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["for"];
+    readonly processor: "builtin:for-loop";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["repeat"];
+    readonly processor: "builtin:repeat-loop";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["while"];
+    readonly processor: "builtin:while-loop";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["do.call"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 0;
+        readonly unquoteFunction: true;
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["UseMethod", "NextMethod"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 0;
+        readonly unquoteFunction: true;
+        readonly resolveInEnvironment: "global";
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: [".Primitive", ".Internal"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly indexOfFunction: 0;
+        readonly unquoteFunction: true;
+        readonly resolveInEnvironment: "global";
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["interference"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly unquoteFunction: true;
+        readonly nameOfFunctionArgument: "propensity_integrand";
+        readonly libFn: true;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["ddply"];
+    readonly processor: "builtin:apply";
+    readonly config: {
+        readonly unquoteFunction: true;
+        readonly indexOfFunction: 2;
+        readonly nameOfFunctionArgument: ".fun";
+        readonly libFn: true;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["list"];
+    readonly processor: "builtin:list";
+    readonly config: {};
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "function";
+    readonly names: ["c"];
+    readonly processor: "builtin:vector";
+    readonly config: {};
+    readonly assumePrimitive: true;
+    readonly evalHandler: "builtin:c";
+}, {
+    readonly type: "function";
+    readonly names: ["setnames", "setNames", "setkey", "setkeyv", "setindex", "setindexv", "setattr"];
+    readonly processor: "builtin:assignment";
+    readonly config: {
+        readonly canBeReplacement: false;
+        readonly targetVariable: false;
+        readonly makeMaybe: true;
+        readonly mayHaveMoreArgs: true;
+    };
+}, {
+    readonly type: "function";
+    readonly names: ["sys.on.exit", "par", "tpar", "sink", "requireNamespace", "loadNamespace", "attachNamespace", "asNamespace", "attach", "unname", "data", "dir.create", "dir_create", "Sys.chmod", "unlink", "file.remove", "file.rename", "file.copy", "file.link", "file.append", "Sys.junction"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly hasUnknownSideEffects: true;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["tinytheme", "theme_set", "library.dynam", "install.packages", "install", "install_github", "install_gitlab", "install_bitbucket", "install_url", "install_git", "install_svn", "install_local", "install_version", "update_packages"];
+    readonly processor: "builtin:default";
+    readonly config: {
+        readonly hasUnknownSideEffects: true;
+        readonly libFn: true;
+    };
+    readonly assumePrimitive: false;
+}, {
+    readonly type: "function";
+    readonly names: ["on.exit"];
+    readonly processor: "builtin:register-hook";
+    readonly config: {
+        readonly hook: KnownHooks;
+        readonly args: {
+            readonly expr: {
+                readonly idx: 0;
+                readonly name: "expr";
+            };
+            readonly add: {
+                readonly idx: 1;
+                readonly name: "add";
+                readonly default: false;
+            };
+            readonly after: {
+                readonly idx: 2;
+                readonly name: "after";
+                readonly default: true;
+            };
+        };
+    };
+    readonly assumePrimitive: true;
+}, {
+    readonly type: "replacement";
+    readonly suffixes: ["<-", "<<-"];
+    readonly names: ["[", "[[", "names", "dimnames", "attributes", "attr", "class", "levels", "rownames", "colnames", "body", "environment", "formals"];
+    readonly config: {
+        readonly readIndices: true;
+    };
+}, {
+    readonly type: "replacement";
+    readonly suffixes: ["<-", "<<-"];
+    readonly names: ["$", "@"];
+    readonly config: {
+        readonly readIndices: false;
+    };
+}];
 /**
- *
+ * Expensive and naive lookup of the default processor for a built-in function name
  */
 export declare function getDefaultProcessor(name: string): BuiltInMappingName | 'unnamed' | undefined;