All files / src/compiler/phases/3-transform/client/visitors/shared events.js

98.93% Statements 186/188
93.47% Branches 43/46
100% Functions 4/4
98.91% Lines 183/185

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 1862x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 300x 300x 300x 300x 2x 2x 2x 300x 300x 300x 300x 300x 300x 300x 300x 300x 285x 285x 285x 194x 194x 285x 285x 285x 228x 189x 189x 189x 189x 228x 228x 228x 228x 228x 228x 228x 228x 228x 285x 57x 57x 285x 285x 285x 285x 285x 285x 300x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 15x 11x 11x 15x 4x 4x 15x 300x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 457x 457x 457x 457x 457x 457x 457x 457x 457x 2x 2x 2x 2x 2x 2x 2x 2x 2x 769x 21x 21x 21x 21x 21x 21x 21x 748x 748x 748x 748x 769x 521x 521x 227x 227x 227x 768x 173x 769x 173x 173x 54x 767x 10x 10x 10x 10x 10x 10x 54x 54x 54x 54x 767x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 54x 54x 54x 2x 2x 2x 2x 4x 4x 4x 4x 4x 3x 4x 1x 1x 3x 4x     3x 3x 3x  
/** @import { Expression } from 'estree' */
/** @import { AST, ExpressionMetadata, SvelteNode } from '#compiler' */
/** @import { ComponentContext } from '../../types' */
import { is_capture_event, is_passive_event } from '../../../../../../utils.js';
import { dev, locator } from '../../../../../state.js';
import * as b from '../../../../../utils/builders.js';
 
/**
 * @param {AST.Attribute} node
 * @param {ComponentContext} context
 */
export function visit_event_attribute(node, context) {
	let capture = false;
 
	let event_name = node.name.slice(2);
	if (is_capture_event(event_name)) {
		event_name = event_name.slice(0, -7);
		capture = true;
	}
 
	// we still need to support the weird `onclick="{() => {...}}" form
	const tag = Array.isArray(node.value)
		? /** @type {AST.ExpressionTag} */ (node.value[0])
		: /** @type {AST.ExpressionTag} */ (node.value);
 
	let handler = build_event_handler(tag.expression, tag.metadata.expression, context);
 
	if (node.metadata.delegated) {
		let delegated_assignment;
 
		if (!context.state.events.has(event_name)) {
			context.state.events.add(event_name);
		}
 
		// Hoist function if we can, otherwise we leave the function as is
		if (node.metadata.delegated.hoisted) {
			if (node.metadata.delegated.function === tag.expression) {
				const func_name = context.state.scope.root.unique('on_' + event_name);
				context.state.hoisted.push(b.var(func_name, handler));
				handler = func_name;
			}
 
			const hoisted_params = /** @type {Expression[]} */ (
				node.metadata.delegated.function.metadata.hoisted_params
			);
 
			// When we hoist a function we assign an array with the function and all
			// hoisted closure params.
			const args = [handler, ...hoisted_params];
			delegated_assignment = b.array(args);
		} else {
			delegated_assignment = handler;
		}
 
		context.state.init.push(
			b.stmt(
				b.assignment('=', b.member(context.state.node, '__' + event_name), delegated_assignment)
			)
		);
	} else {
		const statement = b.stmt(
			build_event(
				event_name,
				context.state.node,
				handler,
				capture,
				is_passive_event(event_name) ? true : undefined
			)
		);
 
		const type = /** @type {SvelteNode} */ (context.path.at(-1)).type;
 
		if (type === 'SvelteDocument' || type === 'SvelteWindow' || type === 'SvelteBody') {
			// These nodes are above the component tree, and its events should run parent first
			context.state.init.push(statement);
		} else {
			context.state.after_update.push(statement);
		}
	}
}
 
/**
 * Creates a `$.event(...)` call for non-delegated event handlers
 * @param {string} event_name
 * @param {Expression} node
 * @param {Expression} handler
 * @param {boolean} capture
 * @param {boolean | undefined} passive
 */
export function build_event(event_name, node, handler, capture, passive) {
	return b.call(
		'$.event',
		b.literal(event_name),
		node,
		handler,
		capture && b.true,
		passive === undefined ? undefined : b.literal(passive)
	);
}
 
/**
 * Creates an event handler
 * @param {Expression | null} node
 * @param {ExpressionMetadata} metadata
 * @param {ComponentContext} context
 * @returns {Expression}
 */
export function build_event_handler(node, metadata, context) {
	if (node === null) {
		// bubble event
		return b.function(
			null,
			[b.id('$$arg')],
			b.block([b.stmt(b.call('$.bubble_event.call', b.this, b.id('$$props'), b.id('$$arg')))])
		);
	}
 
	let handler = /** @type {Expression} */ (context.visit(node));
 
	// inline handler
	if (handler.type === 'ArrowFunctionExpression' || handler.type === 'FunctionExpression') {
		return handler;
	}
 
	// function declared in the script
	if (
		handler.type === 'Identifier' &&
		context.state.scope.get(handler.name)?.declaration_kind !== 'import'
	) {
		return handler;
	}
 
	if (metadata.has_call) {
		// memoize where necessary
		const id = b.id(context.state.scope.generate('event_handler'));
 
		context.state.init.push(b.var(id, b.call('$.derived', b.thunk(handler))));
		handler = b.call('$.get', id);
	}
 
	// wrap the handler in a function, so the expression is re-evaluated for each event
	let call = b.call(b.member(handler, 'apply', false, true), b.this, b.id('$$args'));
 
	if (dev) {
		const loc = locator(/** @type {number} */ (node.start));
 
		const remove_parens =
			node.type === 'CallExpression' &&
			node.arguments.length === 0 &&
			node.callee.type === 'Identifier';
 
		call = b.call(
			'$.apply',
			b.thunk(handler),
			b.this,
			b.id('$$args'),
			b.id(context.state.analysis.name),
			loc && b.array([b.literal(loc.line), b.literal(loc.column)]),
			has_side_effects(node) && b.true,
			remove_parens && b.true
		);
	}
 
	return b.function(null, [b.rest(b.id('$$args'))], b.block([b.stmt(call)]));
}
 
/**
 * @param {Expression} node
 */
function has_side_effects(node) {
	if (
		node.type === 'CallExpression' ||
		node.type === 'NewExpression' ||
		node.type === 'AssignmentExpression' ||
		node.type === 'UpdateExpression'
	) {
		return true;
	}
 
	if (node.type === 'SequenceExpression') {
		return node.expressions.some(has_side_effects);
	}
 
	return false;
}