wip: start to work but wait on #2034

Author: EagleoutIce

src/dataflow/environments/append.ts

@@ -1,5 +1,5 @@
 import { guard } from '../../util/assert';
-import { type IEnvironment, type REnvironmentInformation ,  Environment } from './environment';
+import { type REnvironmentInformation ,  Environment } from './environment';
 import type { IdentifierDefinition } from './identifier';
 
 function uniqueMergeValues(old: IdentifierDefinition[], value: readonly IdentifierDefinition[]): IdentifierDefinition[] {
@@ -13,7 +13,7 @@ function uniqueMergeValues(old: IdentifierDefinition[], value: readonly Identifi
 	return result;
 }
 
-function appendIEnvironmentWith(base: IEnvironment | undefined, next: IEnvironment | undefined): IEnvironment {
+function appendIEnvironmentWith(base: Environment | undefined, next: Environment | undefined): Environment {
 	guard(base !== undefined && next !== undefined, 'can not append environments with undefined');
 	const map = new Map(base.memory);
 	for(const [key, value] of next.memory) {

src/dataflow/environments/clone.ts

@@ -1,8 +1,8 @@
-import { type IEnvironment, type REnvironmentInformation ,  Environment } from './environment';
+import { type REnvironmentInformation, Environment } from './environment';
 import type { Identifier, IdentifierDefinition } from './identifier';
 
-function cloneEnvironment(environment: IEnvironment, recurseParents: boolean): IEnvironment
-function cloneEnvironment(environment: IEnvironment | undefined, recurseParents: boolean): IEnvironment | undefined {
+function cloneEnvironment(environment: Environment, recurseParents: boolean): Environment
+function cloneEnvironment(environment: Environment | undefined, recurseParents: boolean): Environment | undefined {
 	if(environment === undefined) {
 		return undefined;
 	} else if(environment.builtInEnv) {
@@ -16,9 +16,8 @@ function cloneEnvironment(environment: IEnvironment | undefined, recurseParents:
 
 /**
  * Produce a clone of the given environment information.
- * @param environment        - The environment information to clone.
- * @param builtInEnvironment - The built-in environment
- * @param recurseParents     - Whether to clone the parent environments as well.
+ * @param environment    - The environment information to clone.
+ * @param recurseParents - Whether to clone the parent environments as well.
  */
 export function cloneEnvironmentInformation(environment: REnvironmentInformation, recurseParents = true): REnvironmentInformation {
 	return {

src/dataflow/environments/define.ts

@@ -1,11 +1,11 @@
 import { guard, isNotUndefined } from '../../util/assert';
-import type { IEnvironment, REnvironmentInformation } from './environment';
+import type { Environment, REnvironmentInformation } from './environment';
 import { cloneEnvironmentInformation } from './clone';
 import type { IdentifierDefinition, InGraphIdentifierDefinition } from './identifier';
 import { type ContainerIndex, type ContainerIndices , isParentContainerIndex, isSameIndex } from '../graph/vertex';
 import type { FlowrConfigOptions } from '../../config';
 
-function defInEnv(newEnvironments: IEnvironment, name: string, definition: IdentifierDefinition, config: FlowrConfigOptions) {
+function defInEnv(newEnvironments: Environment, name: string, definition: IdentifierDefinition, config: FlowrConfigOptions) {
 	const existing = newEnvironments.memory.get(name);
 
 	// When there are defined indices, merge the definitions

src/dataflow/environments/environment.ts

@@ -58,20 +58,6 @@ export function makeAllMaybe(references: readonly IdentifierReference[] | undefi
 	return references?.map(ref => makeReferenceMaybe(ref, graph, environments, includeDefs, defaultCd)) ?? [];
 }
 
-/** A single entry/scope within an {@link REnvironmentInformation} */
-export interface IEnvironment {
-	/** Unique and internally generated identifier -- will not be used for comparison but helps with debugging for tracking identities */
-	readonly id: number
-	/** Lexical parent of the environment, if any (can be manipulated by R code) */
-	parent:      IEnvironment
-	/** Maps to exactly one definition of an identifier if the source is known, otherwise to a list of all possible definitions */
-	memory:      BuiltInMemory
-	/**
-	 * Is this a built-in environment that is not allowed to change? Please use this carefully and only for the top-most envs!
-	 */
-	builtInEnv?: true | undefined
-}
-
 /**
  * Please use this function only if you do not know the object type.
  * Otherwise, rely on {@link IEnvironment#builtInEnv}
@@ -82,14 +68,18 @@ export function isDefaultBuiltInEnvironment(obj: unknown) {
 
 let environmentIdCounter = 1; // Zero is reserved for built-in environment
 
-/** @see REnvironmentInformation */
-export class Environment implements IEnvironment {
-	readonly id;
-	parent:      IEnvironment;
+/** A single entry/scope within an {@link REnvironmentInformation} */
+export class Environment {
+	/** Unique and internally generated identifier -- will not be used for comparison but helps with debugging for tracking identities */
+	readonly id: number;
+	/** Lexical parent of the environment, if any (can be manipulated by R code) */
+	parent:      Environment;
+	/** Maps to exactly one definition of an identifier if the source is known, otherwise to a list of all possible definitions */
 	memory:      BuiltInMemory;
+	/** Is this a built-in environment that is not allowed to change? Please use this carefully and only for the top-most envs! */
 	builtInEnv?: true;
 
-	constructor(parent: IEnvironment, isBuiltInDefault: true | undefined = undefined) {
+	constructor(parent: Environment, isBuiltInDefault: true | undefined = undefined) {
 		this.id = isBuiltInDefault ? 0 : environmentIdCounter++;
 		this.parent = parent;
 		this.memory = new Map();
@@ -126,8 +116,8 @@ export interface WorkingDirectoryReference {
  * @see {@link overwriteEnvironment} - to overwrite the definitions in the current environment with those of another one
  */
 export interface REnvironmentInformation {
-	/**  The currently active environment (the stack is represented by the currently active {@link IEnvironment#parent}). Environments are maintained within the dataflow graph. */
-	readonly current: IEnvironment
+	/**  The currently active environment (the stack is represented by the currently active {@link Environment#parent}). Environments are maintained within the dataflow graph. */
+	readonly current: Environment
 	/** nesting level of the environment, will be `0` for the global/root environment */
 	readonly level:   number
 }
@@ -136,7 +126,7 @@ export interface REnvironmentInformation {
  * Initialize a new {@link REnvironmentInformation|environment} with the built-ins.
  */
 export function initializeCleanEnvironments(memory?: BuiltInMemory, fullBuiltIns = true): REnvironmentInformation {
-	const builtInEnv = new Environment(undefined as unknown as IEnvironment, true);
+	const builtInEnv = new Environment(undefined as unknown as Environment, true);
 	builtInEnv.memory = memory ?? (fullBuiltIns ? getDefaultBuiltInDefinitions().builtInMemory : getDefaultBuiltInDefinitions().emptyBuiltInMemory);
 
 	return {

src/dataflow/environments/overwrite.ts

@@ -16,11 +16,7 @@ function anyIsMaybeOrEmpty(values: readonly IdentifierDefinition[]): boolean {
 	return false;
 }
 
-
-/**
- *
- */
-export function overwriteIEnvironmentWith(base: IEnvironment | undefined, next: IEnvironment | undefined, includeParent = true, applyCds?: readonly ControlDependency[]): IEnvironment {
+function overwriteIEnvironmentWith(base: IEnvironment | undefined, next: IEnvironment | undefined, includeParent = true, applyCds?: readonly ControlDependency[]): IEnvironment {
 	guard(base !== undefined && next !== undefined, 'can not overwrite environments with undefined');
 	const map = new Map(base.memory);
 	for(const [key, values] of next.memory) {

src/dataflow/eval/resolve/alias-tracking.ts

@@ -7,8 +7,8 @@ import { envFingerprint } from '../../../slicing/static/fingerprint';
 import { VisitingQueue } from '../../../slicing/static/visiting-queue';
 import { guard } from '../../../util/assert';
 import type { BuiltInIdentifierConstant } from '../../environments/built-in';
-import { type IEnvironment, type REnvironmentInformation , initializeCleanEnvironments } from '../../environments/environment';
-import { type Identifier , ReferenceType } from '../../environments/identifier';
+import { type Environment, type REnvironmentInformation, initializeCleanEnvironments } from '../../environments/environment';
+import { type Identifier, ReferenceType } from '../../environments/identifier';
 import { resolveByName } from '../../environments/resolve-by-name';
 import { EdgeType } from '../../graph/edge';
 import type { DataflowGraph } from '../../graph/graph';
@@ -22,7 +22,7 @@ import { resolveNode } from './resolve';
 
 export type ResolveResult = Lift<ValueSet<Value[]>>;
 
-type AliasHandler = (s: NodeId, d: DataflowGraph, e: REnvironmentInformation, def: IEnvironment) => NodeId[] | undefined;
+type AliasHandler = (s: NodeId, d: DataflowGraph, e: REnvironmentInformation, def: Environment) => NodeId[] | undefined;
 const AliasHandler = {
 	[VertexType.Value]:              (sourceId: NodeId) => [sourceId],
 	[VertexType.Use]:                getUseAlias,

src/dataflow/graph/dataflowgraph-builder.ts

@@ -2,7 +2,7 @@ import { deepMergeObject } from '../../util/objects';
 import { type NodeId , normalizeIdToNumberIfPossible } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { AstIdMap } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 import { type DataflowFunctionFlowInformation, type FunctionArgument , DataflowGraph, isPositionalArgument } from './graph';
-import { type IEnvironment, type REnvironmentInformation , initializeCleanEnvironments } from '../environments/environment';
+import type { Environment , type REnvironmentInformation , initializeCleanEnvironments } from '../environments/environment';
 import { type DataflowGraphVertexAstLink, type DataflowGraphVertexUse, type FunctionOriginInformation , VertexType } from './vertex';
 import { EmptyArgument } from '../../r-bridge/lang-4.x/ast/model/nodes/r-function-call';
 import { isBuiltIn } from '../environments/built-in';
@@ -42,7 +42,7 @@ export class DataflowGraphBuilder extends DataflowGraph {
 	 */
 	public defineFunction(id: NodeId,
 		exitPoints: readonly NodeId[], subflow: DataflowFunctionFlowInformation,
-		info?: { environment?: REnvironmentInformation, builtInEnvironment?: IEnvironment, controlDependencies?: ControlDependency[] },
+		info?: { environment?: REnvironmentInformation, builtInEnvironment?: Environment, controlDependencies?: ControlDependency[] },
 		asRoot: boolean = true) {
 		return this.addVertex({
 			tag:     VertexType.FunctionDefinition,
@@ -76,7 +76,7 @@ export class DataflowGraphBuilder extends DataflowGraph {
 			reads?:               readonly NodeId[],
 			onlyBuiltIn?:         boolean,
 			environment?:         REnvironmentInformation,
-			builtInEnvironment?:  IEnvironment,
+			builtInEnvironment?:  Environment,
 			controlDependencies?: ControlDependency[],
 			origin?:              FunctionOriginInformation[]
 			link?:                DataflowGraphVertexAstLink

src/dataflow/internal/process/functions/call/built-in/built-in-expression-list.ts

@@ -9,11 +9,10 @@ import { linkFunctionCalls } from '../../../../linker';
 import { guard, isNotUndefined } from '../../../../../../util/assert';
 import { unpackArgument } from '../argument/unpack-argument';
 import { patchFunctionCall } from '../common';
-import {
-	type IEnvironment,
-	type REnvironmentInformation
-	,
-	makeAllMaybe } from '../../../../../environments/environment';
+import { type Environment,
+	type REnvironmentInformation,
+	makeAllMaybe
+} from '../../../../../environments/environment';
 import type { NodeId } from '../../../../../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import { DataflowGraph } from '../../../../../graph/graph';
 import { type IdentifierReference , ReferenceType } from '../../../../../environments/identifier';
@@ -94,7 +93,7 @@ function updateSideEffectsForCalledFunctions(calledEnvs: {
 				environment = popLocalEnvironment(environment);
 			}
 			// update alle definitions to be defined at this function call
-			let current: IEnvironment | undefined = environment.current;
+			let current: Environment | undefined = environment.current;
 
 			let hasUpdate = false;
 			while(!current?.builtInEnv) {