ripple 0.3.12 → 0.3.14

package/src/compiler/scope.js

@@ -1,476 +0,0 @@
-/**
-@import {
-	Binding,
-	ScopeInterface,
-	ScopeRoot as ScopeRootInterface,
-	Context,
-	ScopeConstructorInterface,
-	ScopeConstructorParameters
-} from '#compiler';
- @import * as AST from 'estree';
- */
-
-import is_reference from 'is-reference';
-import { extract_identifiers, object, unwrap_pattern } from '../utils/ast.js';
-import { walk } from 'zimmerframe';
-import { is_reserved } from './utils.js';
-import { error } from './errors.js';
-import { IDENTIFIER_OBFUSCATION_PREFIX } from './identifier-utils.js';
-import * as b from '../utils/builders.js';
-
-/**
- * Create scopes for an AST
- * @param {AST.Node} ast - The AST to create scopes for
- * @param {ScopeRootInterface} root - Root scope manager
- * @param {ScopeInterface | null} parent - Parent scope
- * @param {ScopeConstructorInterface['error_options']} error_options - Error options
- * @returns {{ scope: ScopeInterface, scopes: Map<AST.Node, ScopeInterface> }} Scope information
- */
-export function create_scopes(ast, root, parent, error_options) {
-	/** @typedef {{ scope: ScopeInterface }} State */
-
-	/** @type {Map<AST.Node, ScopeInterface>} */
-	const scopes = new Map();
-	const scope = new Scope(root, parent, false, error_options);
-	scopes.set(ast, scope);
-
-	/** @type {State} */
-	const state = { scope };
-	/** @type {Array<[ScopeInterface, { node: AST.Identifier, path: AST.Node[] }]>} */
-	const references = [];
-	/** @type {Array<[ScopeInterface, AST.Pattern | AST.MemberExpression]>} */
-	const updates = [];
-
-	/**
-	 * Add parameters to scope
-	 * @param {ScopeInterface} scope - The scope to add parameters to
-	 * @param {AST.Pattern[]} params - Parameter nodes
-	 */
-	function add_params(scope, params) {
-		for (const param of params) {
-			for (const node of extract_identifiers(param)) {
-				scope.declare(node, 'normal', param.type === 'RestElement' ? 'rest_param' : 'param');
-			}
-		}
-	}
-
-	/**
-	 * Create a block scope
-	 * @param {AST.Node} node - AST node
-	 * @param {Context<AST.Node, State>} context - Visitor context
-	 */
-	const create_block_scope = (node, { state, next }) => {
-		const scope = state.scope.child(true);
-		scopes.set(node, scope);
-
-		if (node.type === 'ForOfStatement') {
-			if (node.index) {
-				state.scope.declare(node.index, 'normal', 'let');
-			}
-		}
-
-		next({ scope });
-	};
-
-	walk(ast, state, {
-		// references
-		Identifier(node, { path, state }) {
-			const parent = path.at(-1);
-			if (
-				parent &&
-				is_reference(node, /** @type {AST.Node} */ (parent)) &&
-				// TSTypeAnnotation, TSInterfaceDeclaration etc - these are normally already filtered out,
-				// but for the migration they aren't, so we need to filter them out here
-				// TODO -> once migration script is gone we can remove this check
-				!parent.type.startsWith('TS')
-			) {
-				references.push([state.scope, { node, path: path.slice() }]);
-			}
-		},
-
-		AssignmentExpression(node, { state, next }) {
-			updates.push([state.scope, node.left]);
-			next();
-		},
-
-		UpdateExpression(node, { state, next }) {
-			updates.push([
-				state.scope,
-				/** @type {AST.Identifier | AST.MemberExpression} */ (node.argument),
-			]);
-			next();
-		},
-
-		ImportDeclaration(node, { state }) {
-			for (const specifier of node.specifiers) {
-				state.scope.declare(specifier.local, 'normal', 'import', node);
-			}
-		},
-
-		Component(node, { state, next }) {
-			const scope = state.scope.child();
-			scopes.set(node, scope);
-
-			// Only declare the component name if it has an id (not anonymous)
-			if (node.id) {
-				scope.declare(node.id, 'normal', 'component');
-			}
-
-			add_params(scope, node.params);
-			next({ scope });
-		},
-
-		Element(node, { state, next }) {
-			const scope = state.scope.child();
-			scopes.set(node, scope);
-
-			next({ scope });
-		},
-
-		ServerBlock(node, { state, next }) {
-			const scope = state.scope.child();
-			scope.server_block = true;
-			scopes.set(node, scope);
-
-			next({ scope });
-		},
-
-		FunctionExpression(node, { state, next }) {
-			const scope = state.scope.child();
-			scopes.set(node, scope);
-
-			if (node.id) scope.declare(node.id, 'normal', 'function');
-
-			add_params(scope, node.params);
-			next({ scope });
-		},
-
-		FunctionDeclaration(node, { state, next }) {
-			if (node.id) state.scope.declare(node.id, 'normal', 'function', node);
-
-			const scope = state.scope.child();
-			scopes.set(node, scope);
-
-			add_params(scope, node.params);
-			next({ scope });
-		},
-
-		ArrowFunctionExpression(node, { state, next }) {
-			const scope = state.scope.child();
-			scopes.set(node, scope);
-
-			add_params(scope, node.params);
-			next({ scope });
-		},
-
-		ForStatement: create_block_scope,
-		ForInStatement: create_block_scope,
-		ForOfStatement: create_block_scope,
-		SwitchStatement: create_block_scope,
-		BlockStatement(node, context) {
-			const parent = context.path.at(-1);
-			if (
-				parent?.type === 'FunctionDeclaration' ||
-				parent?.type === 'FunctionExpression' ||
-				parent?.type === 'ArrowFunctionExpression'
-			) {
-				// We already created a new scope for the function
-				context.next();
-			} else {
-				create_block_scope(node, context);
-			}
-		},
-
-		ClassDeclaration(node, { state, next }) {
-			if (node.id) state.scope.declare(node.id, 'normal', 'let', node);
-			next();
-		},
-
-		VariableDeclaration(node, { state, path, next }) {
-			for (const declarator of node.declarations) {
-				/** @type {Binding[]} */
-				const bindings = [];
-
-				state.scope.declarators.set(declarator, bindings);
-
-				for (const id of extract_identifiers(declarator.id)) {
-					const binding = state.scope.declare(id, 'normal', node.kind, declarator.init);
-					bindings.push(binding);
-				}
-			}
-
-			next();
-		},
-
-		CatchClause(node, { state, next }) {
-			if (node.param) {
-				const scope = state.scope.child(true);
-				scopes.set(node, scope);
-
-				for (const id of extract_identifiers(node.param)) {
-					scope.declare(id, 'normal', 'let');
-				}
-
-				next({ scope });
-			} else {
-				next();
-			}
-		},
-	});
-
-	for (const [scope, { node, path }] of references) {
-		scope.reference(node, path);
-	}
-
-	for (const [scope, node] of updates) {
-		for (const expression of unwrap_pattern(node)) {
-			const left = object(expression);
-			const binding = left && scope.get(left.name);
-
-			if (binding !== null && left !== binding.node) {
-				binding.updated = true;
-
-				if (left === expression) {
-					binding.reassigned = true;
-				} else {
-					binding.mutated = true;
-				}
-			}
-		}
-	}
-
-	return {
-		scope,
-		scopes,
-	};
-}
-
-/** @implements {ScopeInterface} */
-export class Scope {
-	/** @type {ScopeRootInterface} */
-	root;
-
-	/**
-	 * The immediate parent scope
-	 * @type {ScopeInterface['parent']}
-	 */
-	parent;
-
-	/**
-	 * Whether or not `var` declarations are contained by this scope
-	 * @type {boolean}
-	 */
-	#porous;
-
-	/**
-	 * A map of every identifier declared by this scope, and all the
-	 * identifiers that reference it
-	 * @type {ScopeInterface['declarations']}
-	 */
-	declarations = new Map();
-
-	/**
-	 * A map of declarators to the bindings they declare
-	 * @type {ScopeInterface['declarators']}
-	 */
-	declarators = new Map();
-
-	/**
-	 * A set of all the names referenced with this scope
-	 * — useful for generating unique names
-	 * @type {ScopeInterface['references']}
-	 */
-	references = new Map();
-
-	/**
-	 * The scope depth allows us to determine if a state variable is referenced in its own scope,
-	 * which is usually an error. Block statements do not increase this value
-	 * @type {ScopeInterface['function_depth']}
-	 */
-	function_depth = 0;
-
-	/**
-	 * If tracing of reactive dependencies is enabled for this scope
-	 * @type {ScopeInterface['tracing']}
-	 */
-	tracing = null;
-
-	/**
-	 * Is this scope a top-level server block scope
-	 * @type {ScopeInterface['server_block']}
-	 */
-	server_block = false;
-
-	/** @type {ScopeConstructorInterface['error_options']} */
-	#error_options;
-
-	/**
-	 * @param {ScopeConstructorParameters} params
-	 */
-	constructor(...params) {
-		const [root, parent, porous, error_options] = params;
-		this.root = root;
-		this.parent = parent;
-		this.#porous = porous;
-		this.function_depth = parent ? parent.function_depth + (porous ? 0 : 1) : 0;
-		this.#error_options = error_options ?? {};
-	}
-
-	/**
-	 * @type {ScopeInterface['declare']}
-	 */
-	declare(node, kind, declaration_kind, initial = null) {
-		if (this.parent) {
-			if (declaration_kind === 'var' && this.#porous) {
-				return this.parent.declare(node, kind, declaration_kind);
-			}
-
-			if (declaration_kind === 'import' && !this.parent.server_block) {
-				return this.parent.declare(node, kind, declaration_kind, initial);
-			}
-		}
-
-		if (node.name.startsWith(IDENTIFIER_OBFUSCATION_PREFIX)) {
-			error(
-				`Cannot declare a variable named "${node.name}" as identifiers starting with "${IDENTIFIER_OBFUSCATION_PREFIX}" are reserved`,
-				this.#error_options.filename,
-				node,
-				this.#error_options.loose ? this.#error_options.errors : undefined,
-				this.#error_options.comments,
-			);
-		}
-
-		if (this.declarations.has(node.name)) {
-			error(
-				`'${node.name}' has already been declared in the current scope`,
-				this.#error_options.filename,
-				node,
-				this.#error_options.loose ? this.#error_options.errors : undefined,
-				this.#error_options.comments,
-			);
-		}
-
-		/** @type {Binding} */
-		const binding = {
-			node,
-			references: [],
-			initial,
-			reassigned: false,
-			mutated: false,
-			updated: false,
-			scope: this,
-			kind,
-			declaration_kind,
-			is_called: false,
-			metadata: null,
-		};
-
-		this.declarations.set(node.name, binding);
-		this.root.conflicts.add(node.name);
-		return binding;
-	}
-
-	/**
-	 * @type {ScopeInterface['child']}
-	 */
-	child(porous = false) {
-		return new Scope(this.root, this, porous, this.#error_options);
-	}
-
-	/**
-	 * @type {ScopeInterface['generate']}
-	 */
-	generate(preferred_name) {
-		if (this.#porous) {
-			return /** @type {ScopeInterface} */ (this.parent).generate(preferred_name);
-		}
-
-		preferred_name = preferred_name.replace(/[^a-zA-Z0-9_$]/g, '_').replace(/^[0-9]/, '_');
-		let name = preferred_name;
-		let n = 1;
-
-		while (
-			this.references.has(name) ||
-			this.declarations.has(name) ||
-			this.root.conflicts.has(name) ||
-			is_reserved(name)
-		) {
-			name = `${preferred_name}_${n++}`;
-		}
-
-		this.references.set(name, []);
-		this.root.conflicts.add(name);
-		return name;
-	}
-
-	/**
-	 * @type {ScopeInterface['get']}
-	 */
-	get(name) {
-		return this.declarations.get(name) ?? this.parent?.get(name) ?? null;
-	}
-
-	/**
-	 * @type {ScopeInterface['get_bindings']}
-	 */
-	get_bindings(node) {
-		const bindings = this.declarators.get(node);
-		if (!bindings) {
-			throw new Error('No binding found for declarator');
-		}
-		return bindings;
-	}
-
-	/**
-	 * @type {ScopeInterface['owner']}
-	 */
-	owner(name) {
-		return this.declarations.has(name) ? this : this.parent && this.parent.owner(name);
-	}
-
-	/**
-	 * @type {ScopeInterface['reference']}
-	 */
-	reference(node, path) {
-		path = [...path]; // ensure that mutations to path afterwards don't affect this reference
-		let references = this.references.get(node.name);
-
-		if (!references) this.references.set(node.name, (references = []));
-
-		references.push({ node, path });
-
-		const binding = this.declarations.get(node.name);
-		if (binding) {
-			binding.references.push({ node, path });
-		} else if (this.parent) {
-			this.parent.reference(node, path);
-		} else {
-			// no binding was found, and this is the top level scope,
-			// which means this is a global
-			this.root.conflicts.add(node.name);
-		}
-	}
-}
-
-/** @implements {ScopeRootInterface} */
-export class ScopeRoot {
-	/** @type {ScopeRootInterface['conflicts']} */
-	conflicts = new Set();
-
-	/**
-	 * @type {ScopeRootInterface['unique']}
-	 */
-	unique(preferred_name) {
-		preferred_name = preferred_name.replace(/[^a-zA-Z0-9_$]/g, '_');
-		let final_name = preferred_name;
-		let n = 1;
-
-		while (this.conflicts.has(final_name)) {
-			final_name = `${preferred_name}_${n++}`;
-		}
-
-		this.conflicts.add(final_name);
-		const id = b.id(final_name);
-		return id;
-	}
-}