1use cairo_lang_debug::DebugWithDb;
2use cairo_lang_defs as defs;
3use cairo_lang_defs::diagnostic_utils::StableLocation;
4use cairo_lang_diagnostics::{Diagnostics, Maybe};
5use cairo_lang_filesystem::ids::SmolStrId;
6use cairo_lang_semantic as semantic;
7use cairo_lang_semantic::corelib::{
8 CorelibSemantic, ErrorPropagationType, bounded_int_ty, get_enum_concrete_variant,
9 try_get_ty_by_name, unwrap_error_propagation_type,
10};
11use cairo_lang_semantic::expr::compute::unwrap_pattern_type;
12use cairo_lang_semantic::items::constant::ConstValueId;
13use cairo_lang_semantic::items::function_with_body::FunctionWithBodySemantic;
14use cairo_lang_semantic::items::functions::{
15 FunctionsSemantic, GenericFunctionId, ImplGenericFunctionId,
16};
17use cairo_lang_semantic::items::imp::ImplLongId;
18use cairo_lang_semantic::items::structure::StructSemantic;
19use cairo_lang_semantic::items::trt::TraitSemantic;
20use cairo_lang_semantic::usage::MemberPath;
21use cairo_lang_semantic::{
22 ConcreteFunction, ConcreteTraitLongId, ExprVar, LocalVariable, VarId, corelib,
23};
24use cairo_lang_syntax::node::TypedStablePtr;
25use cairo_lang_syntax::node::ids::SyntaxStablePtrId;
26use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
27use cairo_lang_utils::unordered_hash_map::{Entry, UnorderedHashMap};
28use cairo_lang_utils::{Intern, extract_matches};
29use context::handle_lowering_flow_error;
30use defs::ids::TopLevelLanguageElementId;
31use flow_control::create_graph::{
32 create_graph_expr_if, create_graph_expr_match, create_graph_expr_while_let,
33};
34use flow_control::lower_graph::lower_graph;
35use itertools::{Itertools, chain, izip, zip_eq};
36use num_bigint::{BigInt, Sign};
37use num_traits::ToPrimitive;
38use refs::{ClosureInfo, member_access_components};
39use salsa::Database;
40use semantic::corelib::{
41 core_submodule, get_core_function_id, get_core_ty_by_name, get_function_id, never_ty, unit_ty,
42};
43use semantic::items::constant::ConstValue;
44use semantic::types::wrap_in_snapshots;
45use semantic::{
46 ExprFunctionCallArg, ExprId, ExprPropagateError, ExprVarMemberPath, GenericArgumentId,
47 MatchArmSelector, MemberAccessKind, SemanticDiagnostic, TypeLongId,
48};
49
50use self::block_builder::{BlockBuilder, SealedBlockBuilder, SealedGotoCallsite};
51use self::context::{
52 EncapsulatingLoweringContext, LoweredExpr, LoweredExprExternEnum, LoweringContext,
53 LoweringFlowError,
54};
55use self::external::{extern_facade_expr, extern_facade_return_tys};
56use self::logical_op::lower_logical_op;
57use crate::blocks::Blocks;
58use crate::diagnostic::LoweringDiagnosticKind::*;
59use crate::diagnostic::LoweringDiagnosticsBuilder;
60use crate::ids::{
61 EnrichedSemanticSignature, FunctionLongId, FunctionWithBodyId, FunctionWithBodyLongId,
62 GeneratedFunction, GeneratedFunctionKey, LocationId, SemanticFunctionIdEx,
63 parameter_as_member_path,
64};
65use crate::lower::context::{LoopContext, LoopEarlyReturnInfo, LoweringResult, RefArg, VarRequest};
66use crate::lower::generators::StructDestructure;
67use crate::{
68 BlockId, Lowered, MatchArm, MatchEnumInfo, MatchExternInfo, MatchInfo, VarUsage, VariableId,
69};
70
71mod block_builder;
72pub mod context;
73mod external;
74mod flow_control;
75pub mod generators;
76mod logical_op;
77mod lower_let_else;
78pub mod refs;
79
80#[cfg(test)]
81mod test_utils;
82
83#[cfg(test)]
84mod block_builder_test;
85
86#[cfg(test)]
87mod generated_test;
88
89#[cfg(test)]
90mod specialized_test;
91
92#[derive(Clone, Debug, PartialEq, Eq, salsa::Update)]
94pub struct MultiLowering<'db> {
95 pub main_lowering: Lowered<'db>,
96 pub generated_lowerings: OrderedHashMap<GeneratedFunctionKey<'db>, Lowered<'db>>,
97}
98
99pub fn lower_semantic_function<'db>(
101 db: &'db dyn Database,
102 semantic_function_id: defs::ids::FunctionWithBodyId<'db>,
103) -> Maybe<MultiLowering<'db>> {
104 let declaration_diagnostics = db.function_declaration_diagnostics(semantic_function_id);
105 check_error_free_or_warn(db, declaration_diagnostics, semantic_function_id, "declaration")?;
106 let body_diagnostics = db.function_body_diagnostics(semantic_function_id);
107 check_error_free_or_warn(db, body_diagnostics, semantic_function_id, "body")?;
108
109 let mut encapsulating_ctx = EncapsulatingLoweringContext::new(db, semantic_function_id)?;
110 let function_id = FunctionWithBodyLongId::Semantic(semantic_function_id).intern(db);
111 let signature = db.function_with_body_signature(semantic_function_id)?;
112
113 for semantic_var in &signature.params {
115 encapsulating_ctx.semantic_defs.insert(
116 semantic::VarId::Param(semantic_var.id),
117 semantic::Binding::Param(semantic_var.clone()),
118 );
119 }
120
121 let block_expr_id = encapsulating_ctx.function_body.body_expr;
122 let main_lowering = lower_function(
123 &mut encapsulating_ctx,
124 function_id,
125 EnrichedSemanticSignature::from_semantic(db, signature),
126 block_expr_id,
127 )?;
128 Ok(MultiLowering { main_lowering, generated_lowerings: encapsulating_ctx.lowerings })
129}
130
131pub fn lower_function<'db>(
133 encapsulating_ctx: &mut EncapsulatingLoweringContext<'db>,
134 function_id: FunctionWithBodyId<'db>,
135 signature: EnrichedSemanticSignature<'db>,
136 block_expr_id: semantic::ExprId,
137) -> Maybe<Lowered<'db>> {
138 log::trace!("Lowering a free function.");
139 let return_type = signature.return_type;
140 let mut ctx = LoweringContext::new(encapsulating_ctx, function_id, signature, return_type)?;
141
142 let semantic_block =
144 extract_matches!(&ctx.function_body.arenas.exprs[block_expr_id], semantic::Expr::Block)
145 .clone();
146
147 let root_block_id = alloc_empty_block(&mut ctx);
149 let mut builder = BlockBuilder::root(root_block_id);
150
151 let parameters = ctx
152 .signature
153 .params
154 .clone()
155 .into_iter()
156 .map(|param| {
157 let location = ctx.get_location(param.stable_ptr().untyped());
158 let var = ctx.new_var(VarRequest { ty: param.ty(), location });
159 let param_var = extract_matches!(param, ExprVarMemberPath::Var);
161 builder.put_semantic(param_var.var, var);
162 var
163 })
164 .collect_vec();
165
166 let root_ok = {
167 let maybe_sealed_block = lower_block(&mut ctx, builder, &semantic_block);
168 maybe_sealed_block.and_then(|block_sealed| {
169 wrap_sealed_block_as_function(
170 &mut ctx,
171 block_sealed,
172 semantic_block.stable_ptr.untyped(),
173 )?;
174 Ok(root_block_id)
175 })
176 };
177 let blocks = root_ok
178 .map(|_| ctx.blocks.build().expect("Root block must exist."))
179 .unwrap_or_else(Blocks::new_errored);
180 Ok(Lowered {
181 diagnostics: ctx.diagnostics.build(),
182 variables: ctx.variables.variables,
183 blocks,
184 signature: ctx.signature.into(),
185 parameters,
186 })
187}
188
189pub fn lower_for_loop<'db, 'mt>(
191 ctx: &mut LoweringContext<'db, 'mt>,
192 builder: &mut BlockBuilder<'db>,
193 loop_expr: semantic::ExprFor<'db>,
194 loop_expr_id: semantic::ExprId,
195) -> LoweringResult<'db, LoweredExpr<'db>> {
196 let db = ctx.db;
197 let for_location = ctx.get_location(loop_expr.stable_ptr.untyped());
198 let next_semantic_signature =
199 db.concrete_function_signature(loop_expr.next_function_id).unwrap();
200 let into_iter = builder.get_ref(ctx, &loop_expr.into_iter_member_path).unwrap();
201 let next_call = generators::Call {
202 function: loop_expr.next_function_id.lowered(db),
203 inputs: vec![into_iter],
204 coupon_input: None,
205 extra_ret_tys: vec![next_semantic_signature.params.first().unwrap().ty],
206 ret_tys: vec![next_semantic_signature.return_type],
207 location: for_location,
208 }
209 .add(ctx, &mut builder.statements);
210 let next_iterator = next_call.extra_outputs.first().unwrap();
211 let next_value = next_call.returns.first().unwrap();
212 let ErrorPropagationType::Option { some_variant, none_variant } =
213 unwrap_error_propagation_type(db, ctx.variables[next_value.var_id].ty)
214 .expect("Expected Option type for next function return.")
215 else {
216 unreachable!("Return type for next function must be Option.")
217 };
218 let next_value_type = some_variant.ty;
219 builder.update_ref(ctx, &loop_expr.into_iter_member_path, next_iterator.var_id);
220 let unit_ty = corelib::unit_ty(db);
221 let some_block: cairo_lang_semantic::ExprBlock<'_> =
222 extract_matches!(&ctx.function_body.arenas.exprs[loop_expr.body], semantic::Expr::Block)
223 .clone();
224 let mut some_subscope = create_subscope(ctx, builder);
225 let some_subscope_block_id = some_subscope.block_id;
226 let some_var_id = ctx.new_var(VarRequest {
227 ty: next_value_type,
228 location: ctx.get_location(some_block.stable_ptr.untyped()),
229 });
230 let variant_expr = LoweredExpr::AtVariable(VarUsage {
231 var_id: some_var_id,
232 location: ctx.get_location(some_block.stable_ptr.untyped()),
233 });
234 let lowered_pattern =
235 lower_single_pattern(ctx, &mut some_subscope, loop_expr.pattern, variant_expr);
236 let sealed_some = match lowered_pattern {
237 Ok(_) => {
238 let block_expr = (|| {
239 lower_expr_block(ctx, &mut some_subscope, &some_block)?;
240 recursively_call_loop_func(
241 ctx,
242 &mut some_subscope,
243 loop_expr_id,
244 loop_expr.stable_ptr.untyped(),
245 )
246 })();
247 lowered_expr_to_block_scope_end(ctx, some_subscope, block_expr)
248 }
249 Err(err) => handle_lowering_flow_error(ctx, some_subscope.clone(), err).map(|_| None),
250 }
251 .map_err(LoweringFlowError::Failed)?;
252
253 let none_subscope = create_subscope(ctx, builder);
254 let none_var_id = ctx.new_var(VarRequest {
255 ty: unit_ty,
256 location: ctx.get_location(some_block.stable_ptr.untyped()),
257 });
258 let none_subscope_block_id = none_subscope.block_id;
259 let sealed_none = return_a_unit(ctx, none_subscope, for_location, false)?;
260
261 let match_info = MatchInfo::Enum(MatchEnumInfo {
262 concrete_enum_id: some_variant.concrete_enum_id,
263 input: *next_value,
264 arms: vec![
265 MatchArm {
266 arm_selector: MatchArmSelector::VariantId(some_variant),
267 block_id: some_subscope_block_id,
268 var_ids: vec![some_var_id],
269 },
270 MatchArm {
271 arm_selector: MatchArmSelector::VariantId(none_variant),
272 block_id: none_subscope_block_id,
273 var_ids: vec![none_var_id],
274 },
275 ],
276 location: for_location,
277 });
278 builder.merge_and_end_with_match(ctx, match_info, vec![sealed_some, sealed_none], for_location)
279}
280
281pub fn lower_while_loop<'db>(
283 ctx: &mut LoweringContext<'db, '_>,
284 builder: &mut BlockBuilder<'db>,
285 loop_expr: semantic::ExprWhile<'db>,
286 loop_expr_id: semantic::ExprId,
287) -> LoweringResult<'db, LoweredExpr<'db>> {
288 let while_location = ctx.get_location(loop_expr.stable_ptr.untyped());
289 let semantic_condition = match &loop_expr.condition {
290 semantic::Condition::BoolExpr(semantic_condition) => *semantic_condition,
291 semantic::Condition::Let(match_expr, patterns) => {
292 return (|| {
293 let ret_var = lower_expr_while_let(
294 ctx,
295 builder,
296 &loop_expr,
297 *match_expr,
298 patterns,
299 loop_expr_id,
300 loop_expr.stable_ptr.untyped(),
301 )?
302 .as_var_usage(ctx, builder)?;
303
304 lower_return(ctx, builder, ret_var, while_location, false)
305 })();
306 }
307 };
308 let condition = lower_expr_to_var_usage(ctx, builder, semantic_condition)?;
309 let db = ctx.db;
310 let unit_ty = corelib::unit_ty(db);
311
312 let mut subscope_main = create_subscope(ctx, builder);
314 let block_main_id = subscope_main.block_id;
315 let main_block =
316 extract_matches!(&ctx.function_body.arenas.exprs[loop_expr.body], semantic::Expr::Block)
317 .clone();
318 let main_block_var_id = ctx.new_var(VarRequest {
319 ty: unit_ty,
320 location: ctx.get_location(main_block.stable_ptr.untyped()),
321 });
322
323 let block_expr = (|| {
324 lower_expr_block(ctx, &mut subscope_main, &main_block)?;
325 recursively_call_loop_func(
326 ctx,
327 &mut subscope_main,
328 loop_expr_id,
329 loop_expr.stable_ptr.untyped(),
330 )
331 })();
332 let block_main = lowered_expr_to_block_scope_end(ctx, subscope_main, block_expr)
333 .map_err(LoweringFlowError::Failed)?;
334
335 let subscope_else = create_subscope(ctx, builder);
337 let block_else_id = subscope_else.block_id;
338 let else_block_input_var_id = ctx.new_var(VarRequest { ty: unit_ty, location: while_location });
339 let block_else = return_a_unit(ctx, subscope_else, while_location, false)?;
340
341 let match_info = MatchInfo::Enum(MatchEnumInfo {
342 concrete_enum_id: corelib::core_bool_enum(db),
343 input: condition,
344 arms: vec![
345 MatchArm {
346 arm_selector: MatchArmSelector::VariantId(corelib::false_variant(db)),
347 block_id: block_else_id,
348 var_ids: vec![else_block_input_var_id],
349 },
350 MatchArm {
351 arm_selector: MatchArmSelector::VariantId(corelib::true_variant(db)),
352 block_id: block_main_id,
353 var_ids: vec![main_block_var_id],
354 },
355 ],
356 location: while_location,
357 });
358 builder.merge_and_end_with_match(ctx, match_info, vec![block_main, block_else], while_location)
359}
360
361pub fn lower_expr_while_let<'db>(
363 ctx: &mut LoweringContext<'db, '_>,
364 builder: &mut BlockBuilder<'db>,
365 loop_expr: &semantic::ExprWhile<'db>,
366 matched_expr: semantic::ExprId,
367 patterns: &[semantic::PatternId],
368 loop_expr_id: semantic::ExprId,
369 loop_stable_ptr: SyntaxStablePtrId<'db>,
370) -> LoweringResult<'db, LoweredExpr<'db>> {
371 log::trace!("Lowering a match expression: {:?}", loop_expr.debug(&ctx.expr_formatter));
372 let location = ctx.get_location(loop_expr.stable_ptr.untyped());
373
374 let graph = create_graph_expr_while_let(
375 ctx,
376 patterns,
377 matched_expr,
378 loop_expr.body,
379 loop_expr_id,
380 loop_stable_ptr,
381 );
382 lower_graph(ctx, builder, &graph, location)
383}
384
385pub fn lower_loop_function<'db>(
389 encapsulating_ctx: &mut EncapsulatingLoweringContext<'db>,
390 function_id: FunctionWithBodyId<'db>,
391 loop_signature: EnrichedSemanticSignature<'db>,
392 loop_ctx: LoopContext<'db>,
393 return_type: semantic::TypeId<'db>,
394) -> Maybe<Lowered<'db>> {
395 let loop_expr_id = loop_ctx.loop_expr_id;
396 let mut ctx =
397 LoweringContext::new(encapsulating_ctx, function_id, loop_signature, return_type)?;
398 let old_loop_ctx = ctx.current_loop_ctx.replace(loop_ctx);
399
400 let root_block_id = alloc_empty_block(&mut ctx);
402 let mut builder = BlockBuilder::root(root_block_id);
403
404 let snapped_params = ctx.usages.usages[&loop_expr_id].snap_usage.clone();
405 let parameters = ctx
406 .signature
407 .params
408 .clone()
409 .into_iter()
410 .map(|param| {
411 let location = ctx.get_location(param.stable_ptr().untyped());
412 let var = ctx.new_var(VarRequest { ty: param.ty(), location });
413 if snapped_params.contains_key::<MemberPath<'_>>(&(¶m).into()) {
414 ctx.snapped_semantics.insert((¶m).into(), var);
415 } else {
416 builder.introduce((¶m).into(), var);
417 }
418 var
419 })
420 .collect_vec();
421
422 let root_ok = (|| {
423 let (block_expr, stable_ptr) = match ctx.function_body.arenas.exprs[loop_expr_id].clone() {
424 semantic::Expr::Loop(semantic::ExprLoop { body, stable_ptr, .. }) => {
425 let semantic_block =
427 extract_matches!(&ctx.function_body.arenas.exprs[body], semantic::Expr::Block)
428 .clone();
429
430 let block_expr = (|| {
431 lower_expr_block(&mut ctx, &mut builder, &semantic_block)?;
432 recursively_call_loop_func(
433 &mut ctx,
434 &mut builder,
435 loop_expr_id,
436 stable_ptr.untyped(),
437 )
438 })();
439 (block_expr, stable_ptr)
440 }
441
442 semantic::Expr::While(while_expr) => {
443 let stable_ptr = while_expr.stable_ptr;
444 let location = ctx.get_location(stable_ptr.untyped());
445 let block_expr = (|| {
446 let ret_var =
447 lower_while_loop(&mut ctx, &mut builder, while_expr, loop_expr_id)?
448 .as_var_usage(&mut ctx, &mut builder)?;
449
450 lower_return(&mut ctx, &mut builder, ret_var, location, false)
451 })();
452 (block_expr, stable_ptr)
453 }
454
455 semantic::Expr::For(for_expr) => {
456 let stable_ptr: cairo_lang_syntax::node::ast::ExprPtr<'_> = for_expr.stable_ptr;
457 let block_expr: Result<LoweredExpr<'_>, LoweringFlowError<'_>> =
458 lower_for_loop(&mut ctx, &mut builder, for_expr, loop_expr_id);
459 (block_expr, stable_ptr)
460 }
461 _ => unreachable!("Loop expression must be either loop, while or for."),
462 };
463
464 let ctx_ref = &mut ctx;
465 let block_sealed = lowered_expr_to_block_scope_end(ctx_ref, builder, block_expr)?;
466 wrap_sealed_block_as_function(ctx_ref, block_sealed, stable_ptr.untyped())?;
467
468 Ok(root_block_id)
469 })();
470 ctx.current_loop_ctx = old_loop_ctx;
471
472 let blocks = root_ok
473 .map(|_| ctx.blocks.build().expect("Root block must exist."))
474 .unwrap_or_else(Blocks::new_errored);
475 Ok(Lowered {
476 diagnostics: ctx.diagnostics.build(),
477 variables: ctx.variables.variables,
478 blocks,
479 signature: ctx.signature.into(),
480 parameters,
481 })
482}
483
484fn wrap_sealed_block_as_function<'db>(
486 ctx: &mut LoweringContext<'db, '_>,
487 block_sealed: SealedBlockBuilder<'db>,
488 stable_ptr: SyntaxStablePtrId<'db>,
489) -> Maybe<()> {
490 let Some(SealedGotoCallsite { mut builder, expr }) = block_sealed else {
491 return Ok(());
492 };
493 let location = ctx.get_location(stable_ptr);
494 match &expr {
495 Some(expr) if ctx.variables[expr.var_id].ty == never_ty(ctx.db) => {
496 let semantic::TypeLongId::Concrete(semantic::ConcreteTypeId::Enum(concrete_enum_id)) =
499 ctx.variables[expr.var_id].ty.long(ctx.db)
500 else {
501 unreachable!("Never type must be a concrete enum.");
502 };
503 builder.unreachable_match(
504 ctx,
505 MatchInfo::Enum(MatchEnumInfo {
506 concrete_enum_id: *concrete_enum_id,
507 input: *expr,
508 arms: vec![],
509 location,
510 }),
511 );
512 Ok(())
513 }
514 _ => {
515 let var_usage = expr.unwrap_or_else(|| {
517 generators::StructConstruct { inputs: vec![], ty: unit_ty(ctx.db), location }
518 .add(ctx, &mut builder.statements)
519 });
520 builder.ret(ctx, var_usage, location)
521 }
522 }
523}
524
525fn lower_block<'db, 'mt>(
527 ctx: &mut LoweringContext<'db, 'mt>,
528 mut builder: BlockBuilder<'db>,
529 semantic_block: &semantic::ExprBlock<'db>,
530) -> Maybe<SealedBlockBuilder<'db>> {
531 let block_expr = lower_expr_block(ctx, &mut builder, semantic_block);
532 lowered_expr_to_block_scope_end(ctx, builder, block_expr)
533}
534
535fn lower_expr_block<'db, 'mt>(
537 ctx: &mut LoweringContext<'db, 'mt>,
538 builder: &mut BlockBuilder<'db>,
539 expr_block: &semantic::ExprBlock<'db>,
540) -> LoweringResult<'db, LoweredExpr<'db>> {
541 log::trace!("Lowering a block.");
542 for (i, stmt_id) in expr_block.statements.iter().enumerate() {
543 let stmt = ctx.function_body.arenas.statements[*stmt_id].clone();
544 let Err(err) = lower_statement(ctx, builder, &stmt) else {
545 continue;
546 };
547 if err.is_unreachable() {
548 let stmt_ptr = |id| ctx.function_body.arenas.statements[id].stable_ptr().untyped();
549 let tail_ptr =
550 expr_block.tail.map(|id| ctx.function_body.arenas.exprs[id].stable_ptr().untyped());
551 if let Some(start_ptr) =
553 expr_block.statements.get(i + 1).copied().map(stmt_ptr).or(tail_ptr)
554 {
555 let end_ptr = tail_ptr
556 .or_else(|| expr_block.statements.last().copied().map(stmt_ptr))
557 .unwrap();
558 ctx.diagnostics.report(start_ptr, Unreachable { block_end_ptr: end_ptr });
560 }
561 }
562 return Err(err);
563 }
564 let location = ctx.get_location(expr_block.stable_ptr.untyped());
566 expr_block
567 .tail
568 .map(|expr| lower_expr(ctx, builder, expr))
569 .unwrap_or_else(|| Ok(LoweredExpr::Tuple { exprs: vec![], location }))
570}
571
572pub fn lower_tail_expr<'db>(
575 ctx: &mut LoweringContext<'db, '_>,
576 mut builder: BlockBuilder<'db>,
577 expr: semantic::ExprId,
578) -> Maybe<SealedBlockBuilder<'db>> {
579 log::trace!("Lowering a tail expression.");
580 let lowered_expr = lower_expr(ctx, &mut builder, expr);
581 lowered_expr_to_block_scope_end(ctx, builder, lowered_expr)
582}
583
584pub fn lowered_expr_to_block_scope_end<'db>(
586 ctx: &mut LoweringContext<'db, '_>,
587 mut builder: BlockBuilder<'db>,
588 lowered_expr: LoweringResult<'db, LoweredExpr<'db>>,
589) -> Maybe<SealedBlockBuilder<'db>> {
590 Ok(match lowered_expr {
591 Ok(LoweredExpr::Tuple { exprs, .. }) if exprs.is_empty() => builder.goto_callsite(None),
592 Ok(lowered_expr) => match lowered_expr.as_var_usage(ctx, &mut builder) {
593 Ok(var) => builder.goto_callsite(Some(var)),
594 Err(err) => handle_lowering_flow_error(ctx, builder, err).map(|_| None)?,
595 },
596 Err(err) => handle_lowering_flow_error(ctx, builder, err).map(|_| None)?,
597 })
598}
599
600pub fn lower_return<'db>(
604 ctx: &mut LoweringContext<'db, '_>,
605 builder: &mut BlockBuilder<'db>,
606 mut ret_var: VarUsage<'db>,
607 location: LocationId<'db>,
608 is_early_return: bool,
609) -> LoweringResult<'db, LoweredExpr<'db>> {
610 if let Some(LoopContext {
611 early_return_info: Some(LoopEarlyReturnInfo { normal_return_variant, early_return_variant }),
612 ..
613 }) = &ctx.current_loop_ctx
614 {
615 let variant = if is_early_return { early_return_variant } else { normal_return_variant };
616
617 ret_var = generators::EnumConstruct { input: ret_var, variant: *variant, location }
618 .add(ctx, &mut builder.statements);
619 }
620
621 Err(LoweringFlowError::Return(ret_var, location))
622}
623
624pub fn return_a_unit<'db>(
626 ctx: &mut LoweringContext<'db, '_>,
627 mut builder: BlockBuilder<'db>,
628 location: LocationId<'db>,
629 is_early_return: bool,
630) -> LoweringResult<'db, SealedBlockBuilder<'db>> {
631 let ret_var = LoweredExpr::Tuple { exprs: vec![], location }.as_var_usage(ctx, &mut builder)?;
632
633 let ret_expr = lower_return(ctx, &mut builder, ret_var, location, is_early_return);
634 lowered_expr_to_block_scope_end(ctx, builder, ret_expr).map_err(LoweringFlowError::Failed)
635}
636
637pub fn lower_statement<'db>(
639 ctx: &mut LoweringContext<'db, '_>,
640 builder: &mut BlockBuilder<'db>,
641 stmt: &semantic::Statement<'db>,
642) -> LoweringResult<'db, ()> {
643 match stmt {
644 semantic::Statement::Expr(semantic::StatementExpr { expr, stable_ptr: _ }) => {
645 log::trace!("Lowering an expression statement.");
646 let lowered_expr = lower_expr(ctx, builder, *expr)?;
647 if let LoweredExpr::ExternEnum(x) = lowered_expr {
650 x.as_var_usage(ctx, builder)?;
651 }
652 }
653 semantic::Statement::Let(semantic::StatementLet {
654 pattern,
655 expr,
656 else_clause,
657 stable_ptr,
658 }) => {
659 if let Some(else_clause) = else_clause {
660 log::trace!("Lowering a let-else statement.");
661 lower_let_else::lower_let_else(
662 ctx,
663 builder,
664 *pattern,
665 *expr,
666 *else_clause,
667 stable_ptr,
668 )?;
669 } else {
670 log::trace!("Lowering a let statement.");
671 let lowered_expr = lower_expr(ctx, builder, *expr)?;
672 lower_single_pattern(ctx, builder, *pattern, lowered_expr)?;
673 }
674 }
675 semantic::Statement::Continue(semantic::StatementContinue { stable_ptr }) => {
676 log::trace!("Lowering a continue statement.");
677 recursively_call_loop_func(
678 ctx,
679 builder,
680 ctx.current_loop_ctx.as_ref().unwrap().loop_expr_id,
681 stable_ptr.untyped(),
682 )?;
683 return Ok(());
684 }
685 semantic::Statement::Return(semantic::StatementReturn { expr_option, stable_ptr })
686 | semantic::Statement::Break(semantic::StatementBreak { expr_option, stable_ptr }) => {
687 log::trace!("Lowering a return | break statement.");
688 let location = ctx.get_location(stable_ptr.untyped());
689 let ret_var = match expr_option {
690 None => {
691 LoweredExpr::Tuple { exprs: vec![], location }.as_var_usage(ctx, builder)?
692 }
693 Some(expr) => lower_expr_to_var_usage(ctx, builder, *expr)?,
694 };
695
696 lower_return(
697 ctx,
698 builder,
699 ret_var,
700 location,
701 matches!(stmt, semantic::Statement::Return(_)),
702 )?;
703 }
704 semantic::Statement::Item(_) => {}
705 }
706 Ok(())
707}
708
709fn lower_single_pattern<'db>(
717 ctx: &mut LoweringContext<'db, '_>,
718 builder: &mut BlockBuilder<'db>,
719 pattern_id: semantic::PatternId,
720 lowered_expr: LoweredExpr<'db>,
721) -> LoweringResult<'db, ()> {
722 log::trace!("Lowering a single pattern.");
723 let pattern = &ctx.function_body.arenas.patterns[pattern_id];
724 match pattern {
725 semantic::Pattern::Literal(_)
726 | semantic::Pattern::StringLiteral(_)
727 | semantic::Pattern::EnumVariant(_) => {
728 return Err(LoweringFlowError::Failed(
729 ctx.diagnostics.report(pattern.stable_ptr(), RefutablePattern),
730 ));
731 }
732 semantic::Pattern::Variable(semantic::PatternVariable {
733 name: _,
734 var: sem_var,
735 stable_ptr,
736 }) => {
737 let sem_var = semantic::Binding::LocalVar(sem_var.clone());
738 let stable_ptr = *stable_ptr;
739 let var = lowered_expr.as_var_usage(ctx, builder)?.var_id;
741 ctx.variables.variables[var].location = ctx.get_location(stable_ptr.untyped());
743 builder.put_semantic(sem_var.id(), var);
744 ctx.semantic_defs.insert(sem_var.id(), sem_var);
746 }
747 semantic::Pattern::Struct(structure) => {
748 let members = ctx
749 .db
750 .concrete_struct_members(structure.concrete_struct_id)
751 .map_err(LoweringFlowError::Failed)?;
752 let mut required_members = UnorderedHashMap::<_, _>::from_iter(
753 structure.field_patterns.iter().map(|(pattern, member)| (member.id, *pattern)),
754 );
755 let wrapping_info = structure.wrapping_info;
756 let stable_ptr = structure.stable_ptr.untyped();
757 let generator = generators::StructDestructure {
758 input: lowered_expr.as_var_usage(ctx, builder)?,
759 var_reqs: members
760 .iter()
761 .map(|(_, member)| VarRequest {
762 ty: wrapping_info.wrap(ctx.db, member.ty),
763 location: ctx.get_location(
764 required_members
765 .get(&member.id)
766 .map(|pattern| {
767 ctx.function_body.arenas.patterns[*pattern]
768 .stable_ptr()
769 .untyped()
770 })
771 .unwrap_or_else(|| stable_ptr),
772 ),
773 })
774 .collect(),
775 };
776 for (var_id, (_, member)) in
777 izip!(generator.add(ctx, &mut builder.statements), members.iter())
778 {
779 if let Some(member_pattern) = required_members.remove(&member.id) {
780 let stable_ptr = ctx.function_body.arenas.patterns[member_pattern].stable_ptr();
781 lower_single_pattern(
782 ctx,
783 builder,
784 member_pattern,
785 LoweredExpr::AtVariable(VarUsage {
786 var_id,
787 location: ctx.get_location(stable_ptr.untyped()),
788 }),
789 )?;
790 }
791 }
792 }
793 semantic::Pattern::Tuple(semantic::PatternTuple {
794 field_patterns: patterns, ty, ..
795 })
796 | semantic::Pattern::FixedSizeArray(semantic::PatternFixedSizeArray {
797 elements_patterns: patterns,
798 ty,
799 ..
800 }) => {
801 lower_tuple_like_pattern_helper(
802 ctx,
803 builder,
804 lowered_expr,
805 patterns,
806 *ty,
807 pattern.stable_ptr().untyped(),
808 )?;
809 }
810 semantic::Pattern::Otherwise(pattern) => {
811 let stable_ptr = pattern.stable_ptr.untyped();
812 let var = lowered_expr.as_var_usage(ctx, builder)?.var_id;
813 ctx.variables.variables[var].location = ctx.get_location(stable_ptr);
814 }
815 semantic::Pattern::Missing(_) => unreachable!("Missing pattern in semantic model."),
816 }
817 Ok(())
818}
819
820fn lower_tuple_like_pattern_helper<'db>(
822 ctx: &mut LoweringContext<'db, '_>,
823 builder: &mut BlockBuilder<'db>,
824 lowered_expr: LoweredExpr<'db>,
825 patterns: &[semantic::PatternId],
826 ty: semantic::TypeId<'db>,
827 stable_ptr: SyntaxStablePtrId<'db>,
828) -> LoweringResult<'db, ()> {
829 let outputs = match lowered_expr {
830 LoweredExpr::Tuple { exprs, .. } => exprs,
831 LoweredExpr::FixedSizeArray { exprs, .. } => exprs,
832 _ => {
833 let (long_type_id, wrapping_info) = unwrap_pattern_type(ctx.db, ty);
834 let tys = match long_type_id {
835 TypeLongId::Tuple(tys) => tys,
836 TypeLongId::FixedSizeArray { type_id, size } => {
837 let size = size
838 .to_int(ctx.db)
839 .expect("Expected ConstValue::Int for size")
840 .to_usize()
841 .unwrap();
842 vec![type_id; size]
843 }
844 TypeLongId::Concrete(_) => {
847 return Err(LoweringFlowError::Failed(
848 ctx.diagnostics.report(stable_ptr, RefutablePattern),
849 ));
850 }
851 _ => unreachable!("Tuple-like pattern must be a tuple or fixed size array."),
852 };
853 let reqs = patterns
854 .iter()
855 .zip_eq(tys)
856 .map(|(pattern, ty)| VarRequest {
857 ty: wrapping_info.wrap(ctx.db, ty),
858 location: ctx.get_location(
859 ctx.function_body.arenas.patterns[*pattern].stable_ptr().untyped(),
860 ),
861 })
862 .collect();
863 generators::StructDestructure {
864 input: lowered_expr.as_var_usage(ctx, builder)?,
865 var_reqs: reqs,
866 }
867 .add(ctx, &mut builder.statements)
868 .into_iter()
869 .map(|var_id| {
870 LoweredExpr::AtVariable(VarUsage {
871 var_id,
872 location: ctx.variables[var_id].location,
873 })
874 })
875 .collect()
876 }
877 };
878 for (var, pattern) in zip_eq(outputs, patterns) {
879 lower_single_pattern(ctx, builder, *pattern, var)?;
880 }
881 Ok(())
882}
883
884fn lower_expr_to_var_usage<'db>(
892 ctx: &mut LoweringContext<'db, '_>,
893 builder: &mut BlockBuilder<'db>,
894 expr_id: semantic::ExprId,
895) -> LoweringResult<'db, VarUsage<'db>> {
896 lower_expr(ctx, builder, expr_id)?.as_var_usage(ctx, builder)
897}
898
899fn lower_expr<'db>(
901 ctx: &mut LoweringContext<'db, '_>,
902 builder: &mut BlockBuilder<'db>,
903 expr_id: semantic::ExprId,
904) -> LoweringResult<'db, LoweredExpr<'db>> {
905 let expr = ctx.function_body.arenas.exprs[expr_id].clone();
906 match expr {
907 semantic::Expr::Constant(expr) => lower_expr_constant(ctx, &expr, builder),
908 semantic::Expr::Tuple(expr) => lower_expr_tuple(ctx, &expr, builder),
909 semantic::Expr::Snapshot(expr) => lower_expr_snapshot(ctx, &expr, builder),
910 semantic::Expr::Desnap(expr) => lower_expr_desnap(ctx, &expr, builder),
911 semantic::Expr::Assignment(expr) => lower_expr_assignment(ctx, &expr, builder),
912 semantic::Expr::LogicalOperator(expr) => lower_logical_op(ctx, builder, &expr),
913 semantic::Expr::Block(expr) => lower_expr_block(ctx, builder, &expr),
914 semantic::Expr::FunctionCall(expr) => lower_expr_function_call(ctx, &expr, builder),
915 semantic::Expr::Match(expr) => lower_expr_match(ctx, &expr, builder),
916 semantic::Expr::If(expr) => lower_expr_if(ctx, builder, &expr),
917 semantic::Expr::Loop(_) | semantic::Expr::While(_) | semantic::Expr::For(_) => {
918 lower_expr_loop(ctx, builder, expr_id)
919 }
920 semantic::Expr::Var(expr) => {
921 let member_path = ExprVarMemberPath::Var(expr.clone());
922 log::trace!("Lowering a variable: {:?}", expr.debug(ctx.db));
923 Ok(LoweredExpr::MemberPath(member_path, ctx.get_location(expr.stable_ptr.untyped())))
924 }
925 semantic::Expr::Literal(expr) => lower_expr_literal(ctx, &expr, builder),
926 semantic::Expr::StringLiteral(expr) => lower_expr_string_literal(ctx, &expr, builder),
927 semantic::Expr::MemberAccess(expr) => lower_expr_member_access(ctx, &expr, builder),
928 semantic::Expr::StructCtor(expr) => lower_expr_struct_ctor(ctx, &expr, builder),
929 semantic::Expr::EnumVariantCtor(expr) => lower_expr_enum_ctor(ctx, &expr, builder),
930 semantic::Expr::FixedSizeArray(expr) => lower_expr_fixed_size_array(ctx, &expr, builder),
931 semantic::Expr::ExprClosure(expr) => lower_expr_closure(ctx, &expr, expr_id, builder),
932 semantic::Expr::PropagateError(expr) => lower_expr_error_propagate(ctx, &expr, builder),
933 semantic::Expr::Missing(semantic::ExprMissing { diag_added, .. }) => {
934 Err(LoweringFlowError::Failed(diag_added))
935 }
936 }
937}
938
939fn lower_expr_literal<'db>(
941 ctx: &mut LoweringContext<'db, '_>,
942 expr: &semantic::ExprNumericLiteral<'db>,
943 builder: &mut BlockBuilder<'db>,
944) -> LoweringResult<'db, LoweredExpr<'db>> {
945 log::trace!("Lowering a literal: {:?}", expr.debug(&ctx.expr_formatter));
946 Ok(LoweredExpr::AtVariable(lower_expr_literal_to_var_usage(
947 ctx,
948 expr.stable_ptr.untyped(),
949 expr.ty,
950 &expr.value,
951 builder,
952 )))
953}
954
955fn lower_expr_literal_to_var_usage<'db>(
957 ctx: &mut LoweringContext<'db, '_>,
958 stable_ptr: SyntaxStablePtrId<'db>,
959 ty: semantic::TypeId<'db>,
960 value: &BigInt,
961 builder: &mut BlockBuilder<'db>,
962) -> VarUsage<'db> {
963 let value = ConstValueId::from_int(ctx.db, ty, value);
964 let location = ctx.get_location(stable_ptr);
965 generators::Const { value, ty, location }.add(ctx, &mut builder.statements)
966}
967
968fn lower_expr_string_literal<'db>(
969 ctx: &mut LoweringContext<'db, '_>,
970 expr: &semantic::ExprStringLiteral<'db>,
971 builder: &mut BlockBuilder<'db>,
972) -> LoweringResult<'db, LoweredExpr<'db>> {
973 log::trace!("Lowering a string literal: {:?}", expr.debug(&ctx.expr_formatter));
974 let db = ctx.db;
975
976 let bytes31_ty = get_core_ty_by_name(db, SmolStrId::from(db, "bytes31"), vec![]);
978 let data_array_ty = get_core_ty_by_name(
979 db,
980 SmolStrId::from(db, "Array"),
981 vec![GenericArgumentId::Type(bytes31_ty)],
982 );
983 let byte_array_ty = get_core_ty_by_name(db, SmolStrId::from(db, "ByteArray"), vec![]);
984
985 let array_submodule = core_submodule(db, SmolStrId::from(db, "array"));
986 let data_array_new_function = FunctionLongId::Semantic(get_function_id(
987 db,
988 array_submodule,
989 SmolStrId::from(db, "array_new"),
990 vec![GenericArgumentId::Type(bytes31_ty)],
991 ))
992 .intern(db);
993 let data_array_append_function = FunctionLongId::Semantic(get_function_id(
994 db,
995 array_submodule,
996 SmolStrId::from(db, "array_append"),
997 vec![GenericArgumentId::Type(bytes31_ty)],
998 ))
999 .intern(db);
1000
1001 let mut data_array_usage =
1003 build_empty_data_array(ctx, builder, expr, data_array_new_function, data_array_ty);
1004 let remainder = add_chunks_to_data_array(
1005 ctx,
1006 builder,
1007 expr,
1008 bytes31_ty,
1009 &mut data_array_usage,
1010 data_array_append_function,
1011 data_array_ty,
1012 );
1013 let (pending_word_usage, pending_word_len_usage) =
1014 add_pending_word(ctx, builder, expr, remainder);
1015
1016 let byte_array_usage = generators::StructConstruct {
1018 inputs: vec![data_array_usage, pending_word_usage, pending_word_len_usage],
1019 ty: byte_array_ty,
1020 location: ctx.get_location(expr.stable_ptr.untyped()),
1021 }
1022 .add(ctx, &mut builder.statements);
1023
1024 Ok(LoweredExpr::AtVariable(byte_array_usage))
1025}
1026
1027fn build_empty_data_array<'db>(
1029 ctx: &mut LoweringContext<'db, '_>,
1030 builder: &mut BlockBuilder<'db>,
1031 expr: &semantic::ExprStringLiteral<'db>,
1032 data_array_new_function: crate::ids::FunctionId<'db>,
1033 data_array_ty: semantic::TypeId<'db>,
1034) -> VarUsage<'db> {
1035 generators::Call {
1036 function: data_array_new_function,
1037 inputs: vec![],
1038 coupon_input: None,
1039 extra_ret_tys: vec![],
1040 ret_tys: vec![data_array_ty],
1041 location: ctx.get_location(expr.stable_ptr.untyped()),
1042 }
1043 .add(ctx, &mut builder.statements)
1044 .returns[0]
1045}
1046
1047fn add_chunks_to_data_array<'db, 'r>(
1049 ctx: &mut LoweringContext<'db, '_>,
1050 builder: &mut BlockBuilder<'db>,
1051 expr: &'r semantic::ExprStringLiteral<'db>,
1052 bytes31_ty: semantic::TypeId<'db>,
1053 data_array_usage: &mut VarUsage<'db>,
1054 data_array_append_function: crate::ids::FunctionId<'db>,
1055 data_array_ty: semantic::TypeId<'db>,
1056) -> &'r [u8] {
1057 let expr_stable_ptr = expr.stable_ptr.untyped();
1058
1059 let chunks = expr.value.as_bytes().chunks_exact(31);
1060 let remainder = chunks.remainder();
1061 for chunk in chunks {
1062 let chunk_usage = generators::Const {
1063 value: ConstValue::Int(BigInt::from_bytes_be(Sign::Plus, chunk), bytes31_ty)
1064 .intern(ctx.db),
1065 ty: bytes31_ty,
1066 location: ctx.get_location(expr_stable_ptr),
1067 }
1068 .add(ctx, &mut builder.statements);
1069
1070 *data_array_usage = generators::Call {
1071 function: data_array_append_function,
1072 inputs: vec![*data_array_usage, chunk_usage],
1073 coupon_input: None,
1074 extra_ret_tys: vec![data_array_ty],
1075 ret_tys: vec![],
1076 location: ctx.get_location(expr_stable_ptr),
1077 }
1078 .add(ctx, &mut builder.statements)
1079 .extra_outputs[0];
1080 }
1081 remainder
1082}
1083
1084fn add_pending_word<'db>(
1087 ctx: &mut LoweringContext<'db, '_>,
1088 builder: &mut BlockBuilder<'db>,
1089 expr: &semantic::ExprStringLiteral<'db>,
1090 pending_word_bytes: &[u8],
1091) -> (VarUsage<'db>, VarUsage<'db>) {
1092 let expr_stable_ptr = expr.stable_ptr.untyped();
1093
1094 let pending_word_len_ty = bounded_int_ty(ctx.db, BigInt::ZERO, 30.into());
1095 let felt252_ty = ctx.db.core_info().felt252;
1096
1097 let pending_word_usage = generators::Const {
1098 value: ConstValue::Int(BigInt::from_bytes_be(Sign::Plus, pending_word_bytes), felt252_ty)
1099 .intern(ctx.db),
1100 ty: felt252_ty,
1101 location: ctx.get_location(expr_stable_ptr),
1102 }
1103 .add(ctx, &mut builder.statements);
1104
1105 let pending_word_len = expr.value.len() % 31;
1106 let pending_word_len_usage = generators::Const {
1107 value: ConstValue::Int(pending_word_len.into(), pending_word_len_ty).intern(ctx.db),
1108 ty: pending_word_len_ty,
1109 location: ctx.get_location(expr_stable_ptr),
1110 }
1111 .add(ctx, &mut builder.statements);
1112 (pending_word_usage, pending_word_len_usage)
1113}
1114
1115fn lower_expr_constant<'db>(
1116 ctx: &mut LoweringContext<'db, '_>,
1117 expr: &semantic::ExprConstant<'db>,
1118 builder: &mut BlockBuilder<'db>,
1119) -> LoweringResult<'db, LoweredExpr<'db>> {
1120 log::trace!("Lowering a constant: {:?}", expr.debug(&ctx.expr_formatter));
1121 let location = ctx.get_location(expr.stable_ptr.untyped());
1122 Ok(LoweredExpr::AtVariable(
1123 generators::Const { value: expr.const_value_id, ty: expr.ty, location }
1124 .add(ctx, &mut builder.statements),
1125 ))
1126}
1127
1128fn lower_expr_tuple<'db>(
1130 ctx: &mut LoweringContext<'db, '_>,
1131 expr: &semantic::ExprTuple<'db>,
1132 builder: &mut BlockBuilder<'db>,
1133) -> LoweringResult<'db, LoweredExpr<'db>> {
1134 log::trace!("Lowering a tuple: {:?}", expr.debug(&ctx.expr_formatter));
1135 let location = ctx.get_location(expr.stable_ptr.untyped());
1136 let inputs = expr
1137 .items
1138 .iter()
1139 .map(|arg_expr_id| lower_expr(ctx, builder, *arg_expr_id))
1140 .collect::<Result<Vec<_>, _>>()?;
1141 Ok(LoweredExpr::Tuple { exprs: inputs, location })
1142}
1143
1144fn lower_expr_fixed_size_array<'db>(
1146 ctx: &mut LoweringContext<'db, '_>,
1147 expr: &semantic::ExprFixedSizeArray<'db>,
1148 builder: &mut BlockBuilder<'db>,
1149) -> LoweringResult<'db, LoweredExpr<'db>> {
1150 log::trace!("Lowering a fixed size array: {:?}", expr.debug(&ctx.expr_formatter));
1151 let location = ctx.get_location(expr.stable_ptr.untyped());
1152 let exprs = match &expr.items {
1153 semantic::FixedSizeArrayItems::Items(items) => items
1154 .iter()
1155 .map(|arg_expr_id| lower_expr(ctx, builder, *arg_expr_id))
1156 .collect::<Result<Vec<_>, _>>()?,
1157 semantic::FixedSizeArrayItems::ValueAndSize(value, size) => {
1158 let lowered_value = lower_expr(ctx, builder, *value)?;
1159 let var_usage = lowered_value.as_var_usage(ctx, builder)?;
1160 let size =
1161 size.to_int(ctx.db).expect("Expected ConstValue::Int for size").to_usize().unwrap();
1162 if size == 0 {
1163 return Err(LoweringFlowError::Failed(
1164 ctx.diagnostics
1165 .report(expr.stable_ptr.untyped(), EmptyRepeatedElementFixedSizeArray),
1166 ));
1167 }
1168 if size > 1 && ctx.variables[var_usage.var_id].info.copyable.is_err() {
1171 return Err(LoweringFlowError::Failed(
1172 ctx.diagnostics.report(expr.stable_ptr.0, FixedSizeArrayNonCopyableType),
1173 ));
1174 }
1175 let expr = LoweredExpr::AtVariable(var_usage);
1176 vec![expr; size]
1177 }
1178 };
1179 Ok(LoweredExpr::FixedSizeArray { exprs, location, ty: expr.ty })
1180}
1181
1182fn lower_expr_snapshot<'db>(
1184 ctx: &mut LoweringContext<'db, '_>,
1185 expr: &semantic::ExprSnapshot<'db>,
1186 builder: &mut BlockBuilder<'db>,
1187) -> LoweringResult<'db, LoweredExpr<'db>> {
1188 log::trace!("Lowering a snapshot: {:?}", expr.debug(&ctx.expr_formatter));
1189 let mut snap_count = 1;
1191 let mut inner = expr.inner;
1192 while let semantic::Expr::Snapshot(next) = &ctx.function_body.arenas.exprs[inner] {
1193 snap_count += 1;
1194 inner = next.inner;
1195 }
1196 while let semantic::Expr::Desnap(next) = &ctx.function_body.arenas.exprs[inner]
1198 && snap_count > 0
1199 {
1200 snap_count -= 1;
1201 inner = next.inner;
1202 }
1203 let mut result = lower_expr(ctx, builder, inner)?;
1205 let mut expr = expr;
1206 for _ in 0..snap_count {
1208 let location = ctx.get_location(expr.stable_ptr.untyped());
1209 result = LoweredExpr::Snapshot { expr: result.into(), location };
1210 if let semantic::Expr::Snapshot(next) = &ctx.function_body.arenas.exprs[expr.inner] {
1211 expr = next;
1212 } else {
1213 break;
1216 };
1217 }
1218 Ok(result)
1219}
1220
1221fn lower_expr_desnap<'db>(
1223 ctx: &mut LoweringContext<'db, '_>,
1224 expr: &semantic::ExprDesnap<'db>,
1225 builder: &mut BlockBuilder<'db>,
1226) -> LoweringResult<'db, LoweredExpr<'db>> {
1227 log::trace!("Lowering a desnap: {:?}", expr.debug(&ctx.expr_formatter));
1228 let location = ctx.get_location(expr.stable_ptr.untyped());
1229 let expr = lower_expr(ctx, builder, expr.inner)?;
1230 if let LoweredExpr::Snapshot { expr, .. } = expr {
1231 return Ok(*expr);
1232 }
1233 let input = expr.as_var_usage(ctx, builder)?;
1234
1235 Ok(LoweredExpr::AtVariable(
1236 generators::Desnap { input, location }.add(ctx, &mut builder.statements),
1237 ))
1238}
1239
1240fn lower_expr_if<'db>(
1242 ctx: &mut LoweringContext<'db, '_>,
1243 builder: &mut BlockBuilder<'db>,
1244 expr: &semantic::ExprIf<'db>,
1245) -> LoweringResult<'db, LoweredExpr<'db>> {
1246 let graph = create_graph_expr_if(ctx, expr);
1247 lower_graph(ctx, builder, &graph, ctx.get_location(expr.stable_ptr.untyped()))
1248}
1249
1250fn lower_expr_match<'db>(
1252 ctx: &mut LoweringContext<'db, '_>,
1253 expr: &semantic::ExprMatch<'db>,
1254 builder: &mut BlockBuilder<'db>,
1255) -> LoweringResult<'db, LoweredExpr<'db>> {
1256 log::trace!("Lowering a match expression: {:?}", expr.debug(&ctx.expr_formatter));
1257 let graph = create_graph_expr_match(ctx, expr);
1258 lower_graph(ctx, builder, &graph, ctx.get_location(expr.stable_ptr.untyped()))
1259}
1260
1261fn lower_expr_function_call<'db>(
1263 ctx: &mut LoweringContext<'db, '_>,
1264 expr: &semantic::ExprFunctionCall<'db>,
1265 builder: &mut BlockBuilder<'db>,
1266) -> LoweringResult<'db, LoweredExpr<'db>> {
1267 log::trace!("Lowering a function call expression: {:?}", expr.debug(&ctx.expr_formatter));
1268 let location = ctx.get_location(expr.stable_ptr.untyped());
1269
1270 let arg_inputs = lower_exprs_to_var_usages(ctx, &expr.args, builder)?;
1272 let ref_args = expr
1273 .args
1274 .iter()
1275 .filter_map(|arg| match arg {
1276 ExprFunctionCallArg::Value(_) => None,
1277 ExprFunctionCallArg::Reference(ref_arg) => Some(RefArg::Ref(ref_arg.clone())),
1278 ExprFunctionCallArg::TempReference(expr_id) => {
1279 Some(RefArg::Temp(ctx.function_body.arenas.exprs[*expr_id].ty()))
1280 }
1281 })
1282 .collect_vec();
1283 let extra_ret_tys = ref_args.iter().map(|ref_arg| ref_arg.ty()).collect();
1284
1285 let coupon_input = if let Some(coupon_arg) = expr.coupon_arg {
1286 Some(lower_expr_to_var_usage(ctx, builder, coupon_arg)?)
1287 } else {
1288 None
1289 };
1290
1291 if expr.function == get_core_function_id(ctx.db, SmolStrId::from(ctx.db, "panic"), vec![]) {
1293 let [input] = <[_; 1]>::try_from(arg_inputs).ok().unwrap();
1294 return Err(LoweringFlowError::Panic(input, location));
1295 }
1296
1297 if expr.function.try_get_extern_function_id(ctx.db).is_some()
1299 && let semantic::TypeLongId::Concrete(semantic::ConcreteTypeId::Enum(concrete_enum_id)) =
1300 expr.ty.long(ctx.db)
1301 {
1302 let lowered_expr = LoweredExprExternEnum {
1303 function: expr.function,
1304 concrete_enum_id: *concrete_enum_id,
1305 inputs: arg_inputs,
1306 ref_args,
1307 location,
1308 };
1309
1310 return Ok(LoweredExpr::ExternEnum(lowered_expr));
1316 }
1317
1318 let (ref_outputs, res) = perform_function_call(
1319 ctx,
1320 builder,
1321 FunctionCallInfo {
1322 function: expr.function,
1323 inputs: arg_inputs,
1324 coupon_input,
1325 extra_ret_tys,
1326 ret_ty: expr.ty,
1327 },
1328 location,
1329 )?;
1330
1331 for (ref_arg, output_var) in zip_eq(ref_args, ref_outputs) {
1333 if let RefArg::Ref(ref_arg) = ref_arg {
1334 builder.update_ref(ctx, &ref_arg, output_var.var_id);
1335 }
1336 }
1337
1338 Ok(res)
1339}
1340
1341struct FunctionCallInfo<'db> {
1343 function: semantic::FunctionId<'db>,
1344 inputs: Vec<VarUsage<'db>>,
1345 coupon_input: Option<VarUsage<'db>>,
1346 extra_ret_tys: Vec<semantic::TypeId<'db>>,
1347 ret_ty: semantic::TypeId<'db>,
1348}
1349
1350fn perform_function_call<'db>(
1354 ctx: &mut LoweringContext<'db, '_>,
1355 builder: &mut BlockBuilder<'db>,
1356 function_call_info: FunctionCallInfo<'db>,
1357 location: LocationId<'db>,
1358) -> LoweringResult<'db, (Vec<VarUsage<'db>>, LoweredExpr<'db>)> {
1359 let FunctionCallInfo { function, inputs, coupon_input, extra_ret_tys, ret_ty } =
1360 function_call_info;
1361
1362 let Some(extern_function_id) = function.try_get_extern_function_id(ctx.db) else {
1364 let call_result = generators::Call {
1365 function: function.lowered(ctx.db),
1366 inputs,
1367 coupon_input,
1368 extra_ret_tys,
1369 ret_tys: vec![ret_ty],
1370 location,
1371 }
1372 .add(ctx, &mut builder.statements);
1373
1374 if ret_ty == never_ty(ctx.db) {
1375 return Err(LoweringFlowError::Match(MatchInfo::Enum(MatchEnumInfo {
1386 concrete_enum_id: *extract_matches!(
1387 extract_matches!(ret_ty.long(ctx.db), semantic::TypeLongId::Concrete),
1388 semantic::ConcreteTypeId::Enum
1389 ),
1390 input: VarUsage { var_id: call_result.returns[0].var_id, location },
1391 arms: vec![],
1392 location,
1393 })));
1394 }
1395
1396 let res = LoweredExpr::AtVariable(call_result.returns.into_iter().next().unwrap());
1397 return Ok((call_result.extra_outputs, res));
1398 };
1399
1400 assert!(coupon_input.is_none(), "Extern functions cannot have a __coupon__ argument.");
1402
1403 let info = ctx.db.core_info();
1406 if extern_function_id == info.into_box {
1407 assert!(extra_ret_tys.is_empty(), "into_box should not have extra return types");
1408 let input = inputs.into_iter().exactly_one().expect("into_box expects exactly one input");
1409 let res = generators::IntoBox { input, location }.add(ctx, &mut builder.statements);
1410 return Ok((vec![], LoweredExpr::AtVariable(res)));
1411 }
1412 if extern_function_id == info.unbox {
1413 assert!(extra_ret_tys.is_empty(), "unbox should not have extra return types");
1414 let input = inputs.into_iter().exactly_one().expect("unbox expects exactly one input");
1415 let res = generators::Unbox { input, location }.add(ctx, &mut builder.statements);
1416 return Ok((vec![], LoweredExpr::AtVariable(res)));
1417 }
1418
1419 let ret_tys = extern_facade_return_tys(ctx.db, &ret_ty).to_vec();
1420 let call_result = generators::Call {
1421 function: function.lowered(ctx.db),
1422 inputs,
1423 coupon_input: None,
1424 extra_ret_tys,
1425 ret_tys,
1426 location,
1427 }
1428 .add(ctx, &mut builder.statements);
1429
1430 Ok((
1431 call_result.extra_outputs,
1432 extern_facade_expr(
1433 ctx,
1434 ret_ty,
1435 call_result.returns.into_iter().map(|var_usage| var_usage.var_id),
1436 location,
1437 ),
1438 ))
1439}
1440
1441fn lower_expr_loop<'db>(
1443 ctx: &mut LoweringContext<'db, '_>,
1444 builder: &mut BlockBuilder<'db>,
1445 loop_expr_id: ExprId,
1446) -> LoweringResult<'db, LoweredExpr<'db>> {
1447 let db = ctx.db;
1448 let (stable_ptr, return_type) = match ctx.function_body.arenas.exprs[loop_expr_id].clone() {
1449 semantic::Expr::Loop(semantic::ExprLoop { stable_ptr, ty, .. }) => (stable_ptr, ty),
1450 semantic::Expr::While(semantic::ExprWhile { stable_ptr, ty, .. }) => (stable_ptr, ty),
1451 semantic::Expr::For(semantic::ExprFor {
1452 stable_ptr,
1453 ty,
1454 into_iter,
1455 expr_id,
1456 into_iter_member_path,
1457 ..
1458 }) => {
1459 let var_id = lower_expr(ctx, builder, expr_id)?.as_var_usage(ctx, builder)?;
1460 let into_iter_return_type =
1461 db.concrete_function_signature(into_iter).unwrap().return_type;
1462 let into_iter_call = generators::Call {
1463 function: into_iter.lowered(db),
1464 inputs: vec![var_id],
1465 coupon_input: None,
1466 extra_ret_tys: vec![],
1467 ret_tys: vec![into_iter_return_type],
1468 location: ctx.get_location(stable_ptr.untyped()),
1469 }
1470 .add(ctx, &mut builder.statements);
1471 let into_iter_var = into_iter_call.returns.into_iter().next().unwrap();
1472 let sem_var = LocalVariable {
1473 ty: into_iter_return_type,
1474 is_mut: true,
1475 id: extract_matches!(into_iter_member_path.base_var(), VarId::Local),
1476 allow_unused: true, };
1478 builder.put_semantic(into_iter_member_path.base_var(), into_iter_var.var_id);
1479
1480 ctx.semantic_defs
1481 .insert(into_iter_member_path.base_var(), semantic::Binding::LocalVar(sem_var));
1482
1483 (stable_ptr, ty)
1484 }
1485 _ => unreachable!("Loop expression must be either loop, while or for."),
1486 };
1487
1488 let usage = &ctx.usages.usages[&loop_expr_id];
1489 let has_normal_return = return_type != never_ty(db);
1490
1491 let (loop_return_ty, early_return_info) = if !has_normal_return {
1492 (ctx.return_type, None)
1495 } else if !usage.has_early_return {
1496 (return_type, None)
1497 } else {
1498 let generic_args =
1499 vec![GenericArgumentId::Type(return_type), GenericArgumentId::Type(ctx.return_type)];
1500
1501 let internal_module = core_submodule(db, SmolStrId::from(db, "internal"));
1502 let ret_ty = try_get_ty_by_name(
1503 db,
1504 internal_module,
1505 SmolStrId::from(db, "LoopResult"),
1506 generic_args.clone(),
1507 )
1508 .unwrap();
1509 (
1510 ret_ty,
1511 Some(LoopEarlyReturnInfo {
1512 normal_return_variant: get_enum_concrete_variant(
1513 db,
1514 internal_module,
1515 SmolStrId::from(db, "LoopResult"),
1516 generic_args.clone(),
1517 SmolStrId::from(db, "Normal"),
1518 ),
1519 early_return_variant: get_enum_concrete_variant(
1520 db,
1521 internal_module,
1522 SmolStrId::from(db, "LoopResult"),
1523 generic_args,
1524 SmolStrId::from(db, "EarlyReturn"),
1525 ),
1526 }),
1527 )
1528 };
1529
1530 let params = usage
1532 .usage
1533 .iter()
1534 .map(|(_, expr)| expr.clone())
1535 .chain(usage.snap_usage.iter().map(|(_, expr)| match expr {
1536 ExprVarMemberPath::Var(var) => {
1537 ExprVarMemberPath::Var(ExprVar { ty: wrap_in_snapshots(db, var.ty, 1), ..*var })
1538 }
1539 ExprVarMemberPath::Member { parent, kind, stable_ptr, ty } => {
1540 ExprVarMemberPath::Member {
1541 parent: parent.clone(),
1542 kind: kind.clone(),
1543 stable_ptr: *stable_ptr,
1544 ty: wrap_in_snapshots(db, *ty, 1),
1545 }
1546 }
1547 }))
1548 .collect_vec();
1549 let extra_rets = usage.changes.iter().map(|(_, expr)| expr.clone()).collect_vec();
1550
1551 let loop_location = ctx.get_location(stable_ptr.untyped());
1552 let loop_signature = EnrichedSemanticSignature {
1553 params,
1554 extra_rets,
1555 return_type: loop_return_ty,
1556 implicits: vec![],
1557 panicable: ctx.signature.panicable,
1558 location: loop_location,
1559 };
1560
1561 let function = FunctionWithBodyLongId::Generated {
1563 parent: ctx.semantic_function_id,
1564 key: GeneratedFunctionKey::Loop(stable_ptr),
1565 }
1566 .intern(db);
1567
1568 let encapsulating_ctx = ctx.encapsulating_ctx.as_mut().unwrap();
1570 let lowered = lower_loop_function(
1571 encapsulating_ctx,
1572 function,
1573 loop_signature.clone(),
1574 LoopContext { loop_expr_id, early_return_info: early_return_info.clone() },
1575 ctx.return_type,
1576 )
1577 .map_err(LoweringFlowError::Failed)?;
1578 encapsulating_ctx.lowerings.insert(GeneratedFunctionKey::Loop(stable_ptr), lowered);
1579 let call_loop_expr = call_loop_func_ex(
1580 ctx,
1581 loop_signature,
1582 builder,
1583 loop_expr_id,
1584 stable_ptr.untyped(),
1585 |ctx, builder, param| {
1586 if let Some(var) = builder.get_snap_ref(ctx, param) {
1587 return Some(var);
1588 };
1589 let input = builder.get_ref(ctx, param)?;
1590 let location = ctx.get_location(param.stable_ptr().untyped());
1591 let (original, snapped) =
1592 generators::Snapshot { input, location }.add(ctx, &mut builder.statements);
1593 builder.update_ref(ctx, param, original);
1594 Some(VarUsage { var_id: snapped, location })
1595 },
1596 )?;
1597
1598 let Some(LoopEarlyReturnInfo { normal_return_variant, early_return_variant }) =
1599 early_return_info
1600 else {
1601 if !has_normal_return {
1602 let ret_var_usage = call_loop_expr.as_var_usage(ctx, builder)?;
1603 return Err(LoweringFlowError::Return(ret_var_usage, loop_location));
1604 }
1605
1606 return Ok(call_loop_expr);
1607 };
1608
1609 let loop_res = call_loop_expr.as_var_usage(ctx, builder)?;
1610
1611 let normal_return_subscope = create_subscope(ctx, builder);
1612 let normal_return_subscope_block_id = normal_return_subscope.block_id;
1613 let normal_return_var_id = ctx.new_var(VarRequest { ty: return_type, location: loop_location });
1614 let sealed_normal_return = lowered_expr_to_block_scope_end(
1615 ctx,
1616 normal_return_subscope,
1617 Ok(LoweredExpr::AtVariable(VarUsage {
1618 var_id: normal_return_var_id,
1619 location: loop_location,
1620 })),
1621 )
1622 .map_err(LoweringFlowError::Failed)?;
1623
1624 let mut early_return_subscope = create_subscope(ctx, builder);
1625 let early_return_var_id =
1626 ctx.new_var(VarRequest { ty: ctx.signature.return_type, location: loop_location });
1627 let early_return_subscope_block_id = early_return_subscope.block_id;
1628 let ret_expr = lower_return(
1629 ctx,
1630 &mut early_return_subscope,
1631 VarUsage { var_id: early_return_var_id, location: loop_location },
1632 loop_location,
1633 true,
1634 );
1635 let sealed_early_return = lowered_expr_to_block_scope_end(ctx, early_return_subscope, ret_expr)
1636 .map_err(LoweringFlowError::Failed)?;
1637
1638 let match_info = MatchInfo::Enum(MatchEnumInfo {
1639 concrete_enum_id: normal_return_variant.concrete_enum_id,
1640 input: loop_res,
1641 arms: vec![
1642 MatchArm {
1643 arm_selector: MatchArmSelector::VariantId(normal_return_variant),
1644 block_id: normal_return_subscope_block_id,
1645 var_ids: vec![normal_return_var_id],
1646 },
1647 MatchArm {
1648 arm_selector: MatchArmSelector::VariantId(early_return_variant),
1649 block_id: early_return_subscope_block_id,
1650 var_ids: vec![early_return_var_id],
1651 },
1652 ],
1653 location: loop_location,
1654 });
1655
1656 builder.merge_and_end_with_match(
1657 ctx,
1658 match_info,
1659 vec![sealed_normal_return, sealed_early_return],
1660 loop_location,
1661 )
1662}
1663
1664fn recursively_call_loop_func<'db>(
1666 ctx: &mut LoweringContext<'db, '_>,
1667 builder: &mut BlockBuilder<'db>,
1668 loop_expr_id: ExprId,
1669 stable_ptr: SyntaxStablePtrId<'db>,
1670) -> LoweringResult<'db, LoweredExpr<'db>> {
1671 let loop_res = call_loop_func_ex(
1672 ctx,
1673 ctx.signature.clone(),
1674 builder,
1675 loop_expr_id,
1676 stable_ptr,
1677 |ctx, builder, param| builder.get_snap_ref(ctx, param),
1678 )?
1679 .as_var_usage(ctx, builder)?;
1680 Err(LoweringFlowError::Return(loop_res, ctx.get_location(stable_ptr)))
1681}
1682
1683fn call_loop_func_ex<'db>(
1685 ctx: &mut LoweringContext<'db, '_>,
1686 loop_signature: EnrichedSemanticSignature<'db>,
1687 builder: &mut BlockBuilder<'db>,
1688 loop_expr_id: ExprId,
1689 stable_ptr: SyntaxStablePtrId<'db>,
1690 handle_snap: impl Fn(
1691 &mut LoweringContext<'db, '_>,
1692 &mut BlockBuilder<'db>,
1693 &ExprVarMemberPath<'db>,
1694 ) -> Option<VarUsage<'db>>,
1695) -> LoweringResult<'db, LoweredExpr<'db>> {
1696 let location = ctx.get_location(stable_ptr);
1697 let loop_stable_ptr = ctx.function_body.arenas.exprs[loop_expr_id].stable_ptr();
1698 let function = FunctionLongId::Generated(GeneratedFunction {
1700 parent: ctx.concrete_function_id.base_semantic_function(ctx.db),
1701 key: GeneratedFunctionKey::Loop(loop_stable_ptr),
1702 })
1703 .intern(ctx.db);
1704 let inputs = loop_signature
1705 .params
1706 .into_iter()
1707 .map(|param| {
1708 if let Some(var) = builder.get_ref_of_type(ctx, ¶m, param.ty()) {
1709 return Ok(var);
1710 }
1711
1712 if let Some(var) = handle_snap(ctx, builder, ¶m)
1713 && ctx.variables[var.var_id].ty == param.ty()
1714 {
1715 return Ok(var);
1716 }
1717
1718 Err(LoweringFlowError::Failed(
1721 ctx.diagnostics.report(param.stable_ptr(), MemberPathLoop),
1722 ))
1723 })
1724 .collect::<LoweringResult<'db, Vec<_>>>()?;
1725 let extra_ret_tys = loop_signature.extra_rets.iter().map(|path| path.ty()).collect_vec();
1726 let call_result = generators::Call {
1727 function,
1728 inputs,
1729 coupon_input: None,
1730 extra_ret_tys,
1731 ret_tys: vec![loop_signature.return_type],
1732 location,
1733 }
1734 .add(ctx, &mut builder.statements);
1735
1736 for (ref_arg, output_var) in zip_eq(&loop_signature.extra_rets, call_result.extra_outputs) {
1738 builder.update_ref(ctx, ref_arg, output_var.var_id);
1739 }
1740
1741 Ok(LoweredExpr::AtVariable(call_result.returns.into_iter().next().unwrap()))
1742}
1743
1744fn lower_exprs_to_var_usages<'db>(
1747 ctx: &mut LoweringContext<'db, '_>,
1748 args: &[semantic::ExprFunctionCallArg<'db>],
1749 builder: &mut BlockBuilder<'db>,
1750) -> LoweringResult<'db, Vec<VarUsage<'db>>> {
1751 let mut value_iter = args
1757 .iter()
1758 .filter_map(|arg| match arg {
1759 ExprFunctionCallArg::Value(expr_id) | ExprFunctionCallArg::TempReference(expr_id) => {
1760 Some(lower_expr_to_var_usage(ctx, builder, *expr_id))
1761 }
1762 ExprFunctionCallArg::Reference(_) => None,
1763 })
1764 .collect::<Result<Vec<_>, _>>()?
1765 .into_iter();
1766 Ok(args
1767 .iter()
1768 .map(|arg| match arg {
1769 semantic::ExprFunctionCallArg::Reference(arg) => builder.get_ref(ctx, arg).unwrap(),
1770 ExprFunctionCallArg::Value(_) | ExprFunctionCallArg::TempReference(_) => {
1771 value_iter.next().unwrap()
1772 }
1773 })
1774 .collect())
1775}
1776
1777fn lower_expr_enum_ctor<'db>(
1779 ctx: &mut LoweringContext<'db, '_>,
1780 expr: &semantic::ExprEnumVariantCtor<'db>,
1781 builder: &mut BlockBuilder<'db>,
1782) -> LoweringResult<'db, LoweredExpr<'db>> {
1783 log::trace!(
1784 "Started lowering of an enum c'tor expression: {:?}",
1785 expr.debug(&ctx.expr_formatter)
1786 );
1787 let location = ctx.get_location(expr.stable_ptr.untyped());
1788 Ok(LoweredExpr::AtVariable(
1789 generators::EnumConstruct {
1790 input: lower_expr_to_var_usage(ctx, builder, expr.value_expr)?,
1791 variant: expr.variant,
1792 location,
1793 }
1794 .add(ctx, &mut builder.statements),
1795 ))
1796}
1797
1798fn lower_expr_member_access<'db>(
1800 ctx: &mut LoweringContext<'db, '_>,
1801 expr: &semantic::ExprMemberAccess<'db>,
1802 builder: &mut BlockBuilder<'db>,
1803) -> LoweringResult<'db, LoweredExpr<'db>> {
1804 log::trace!("Lowering a member-access expression: {:?}", expr.debug(&ctx.expr_formatter));
1805 if let Some(member_path) = &expr.member_path {
1806 return Ok(LoweredExpr::MemberPath(
1807 member_path.clone(),
1808 ctx.get_location(expr.stable_ptr.untyped()),
1809 ));
1810 }
1811 let location = ctx.get_location(expr.stable_ptr.untyped());
1812 let input = lower_expr_to_var_usage(ctx, builder, expr.expr)?;
1813 let (member_tys, member_idx) =
1814 member_access_components(ctx, ctx.variables[input.var_id].ty, &expr.kind).ok_or_else(
1815 || {
1816 LoweringFlowError::Failed(
1817 ctx.diagnostics.report(expr.stable_ptr.untyped(), UnexpectedError),
1818 )
1819 },
1820 )?;
1821 Ok(LoweredExpr::AtVariable(
1822 generators::StructMemberAccess { input, member_tys, member_idx, location }
1823 .add(ctx, &mut builder.statements),
1824 ))
1825}
1826
1827fn lower_expr_struct_ctor<'db>(
1829 ctx: &mut LoweringContext<'db, '_>,
1830 expr: &semantic::ExprStructCtor<'db>,
1831 builder: &mut BlockBuilder<'db>,
1832) -> LoweringResult<'db, LoweredExpr<'db>> {
1833 log::trace!("Lowering a struct c'tor expression: {:?}", expr.debug(&ctx.expr_formatter));
1834 let location = ctx.get_location(expr.stable_ptr.untyped());
1835 let members = ctx
1836 .db
1837 .concrete_struct_members(expr.concrete_struct_id)
1838 .map_err(LoweringFlowError::Failed)?;
1839 let mut member_expr_usages =
1840 UnorderedHashMap::<_, _>::from_iter(expr.members.iter().map(|(expr, id)| {
1841 let usage = lower_expr_to_var_usage(ctx, builder, *expr);
1842 (*id, usage)
1843 }));
1844 if members.len() != member_expr_usages.len() {
1845 let base_struct = lower_expr(ctx, builder, expr.base_struct.unwrap())?;
1847 if let LoweredExpr::MemberPath(path, location) = base_struct {
1848 for (_, member) in members.iter() {
1849 let Entry::Vacant(entry) = member_expr_usages.entry(member.id) else {
1850 continue;
1851 };
1852 let member_path = ExprVarMemberPath::Member {
1853 parent: Box::new(path.clone()),
1854 kind: MemberAccessKind::Struct {
1855 concrete_struct_id: expr.concrete_struct_id,
1856 member_id: member.id,
1857 },
1858 stable_ptr: path.stable_ptr(),
1859 ty: member.ty,
1860 };
1861 entry
1862 .insert(Ok(LoweredExpr::MemberPath(member_path, location)
1863 .as_var_usage(ctx, builder)?));
1864 }
1865 } else {
1866 for (base_member, (_, member)) in izip!(
1867 StructDestructure {
1868 input: base_struct.as_var_usage(ctx, builder)?,
1869 var_reqs: members
1870 .iter()
1871 .map(|(_, member)| VarRequest { ty: member.ty, location })
1872 .collect(),
1873 }
1874 .add(ctx, &mut builder.statements),
1875 members.iter()
1876 ) {
1877 match member_expr_usages.entry(member.id) {
1878 Entry::Occupied(_) => {}
1879 Entry::Vacant(entry) => {
1880 entry.insert(Ok(VarUsage { var_id: base_member, location }));
1881 }
1882 }
1883 }
1884 }
1885 }
1886 Ok(LoweredExpr::AtVariable(
1887 generators::StructConstruct {
1888 inputs: members
1889 .iter()
1890 .map(|(_, member)| member_expr_usages.remove(&member.id).unwrap())
1891 .collect::<Result<Vec<_>, _>>()?,
1892 ty: expr.ty,
1893 location,
1894 }
1895 .add(ctx, &mut builder.statements),
1896 ))
1897}
1898
1899fn add_capture_destruct_impl<'db>(
1901 ctx: &mut LoweringContext<'db, '_>,
1902 capture_var_usage: VarUsage<'db>,
1903 closure_info: &ClosureInfo<'db>,
1904 location: StableLocation<'db>,
1905) -> Maybe<()> {
1906 let capture_ty_info = &ctx.variables.variables[capture_var_usage.var_id].info;
1907 let Some(Ok(impl_id)) = [&capture_ty_info.destruct_impl, &capture_ty_info.panic_destruct_impl]
1909 .iter()
1910 .find(|infer_result| infer_result.is_ok())
1911 else {
1912 return Ok(());
1913 };
1914
1915 let db = ctx.db;
1916 let concrete_trait = impl_id.concrete_trait(db)?;
1917
1918 let trait_functions = db.trait_functions(concrete_trait.trait_id(db))?;
1919
1920 assert_eq!(trait_functions.len(), 1);
1921 let trait_function = *trait_functions.values().next().unwrap();
1922
1923 let generic_function = GenericFunctionId::Impl(ImplGenericFunctionId {
1924 impl_id: *impl_id,
1925 function: trait_function,
1926 });
1927
1928 let function = semantic::FunctionLongId {
1929 function: ConcreteFunction { generic_function, generic_args: vec![] },
1930 }
1931 .intern(db);
1932
1933 let signature =
1934 EnrichedSemanticSignature::from_semantic(db, db.concrete_function_signature(function)?);
1935
1936 let func_key = GeneratedFunctionKey::TraitFunc(trait_function, location);
1937 let function_id =
1938 FunctionWithBodyLongId::Generated { parent: ctx.semantic_function_id, key: func_key }
1939 .intern(db);
1940
1941 let location_id = LocationId::from_stable_location(db, location);
1942
1943 let encapsulating_ctx = ctx.encapsulating_ctx.as_mut().unwrap();
1944 let return_type = signature.return_type;
1945 let lowered_impl_res = get_destruct_lowering(
1946 LoweringContext::new(encapsulating_ctx, function_id, signature, return_type)?,
1947 location_id,
1948 closure_info,
1949 )?;
1950 ctx.lowerings.insert(func_key, lowered_impl_res);
1951 Ok(())
1952}
1953
1954fn get_destruct_lowering<'db>(
1956 mut ctx: LoweringContext<'db, '_>,
1957 location_id: LocationId<'db>,
1958 closure_info: &ClosureInfo<'db>,
1959) -> Maybe<Lowered<'db>> {
1960 let root_block_id = alloc_empty_block(&mut ctx);
1961 let mut builder = BlockBuilder::root(root_block_id);
1962
1963 let parameters = ctx
1964 .signature
1965 .params
1966 .clone()
1967 .into_iter()
1968 .map(|param| {
1969 let var = ctx.new_var(VarRequest { ty: param.ty(), location: location_id });
1970 builder.introduce((¶m).into(), var);
1971 var
1972 })
1973 .collect_vec();
1974
1975 builder.destructure_closure(&mut ctx, location_id, parameters[0], closure_info);
1976 let var_usage =
1977 generators::StructConstruct { inputs: vec![], ty: unit_ty(ctx.db), location: location_id }
1978 .add(&mut ctx, &mut builder.statements);
1979 builder.ret(&mut ctx, var_usage, location_id)?;
1980 let lowered_impl = Lowered {
1981 diagnostics: ctx.diagnostics.build(),
1982 variables: ctx.variables.variables,
1983 blocks: ctx.blocks.build().unwrap(),
1984 signature: ctx.signature.into(),
1985 parameters,
1986 };
1987 Ok(lowered_impl)
1988}
1989
1990fn add_closure_call_function<'db>(
1992 encapsulated_ctx: &mut LoweringContext<'db, '_>,
1993 expr: &semantic::ExprClosure<'db>,
1994 closure_info: &ClosureInfo<'db>,
1995 trait_id: cairo_lang_defs::ids::TraitId<'db>,
1996) -> Maybe<()> {
1997 let db = encapsulated_ctx.db;
1998 let closure_ty = extract_matches!(expr.ty.long(db), TypeLongId::Closure);
1999 let expr_location = encapsulated_ctx.get_location(expr.stable_ptr.untyped());
2000 let parameters_ty = TypeLongId::Tuple(closure_ty.param_tys.clone()).intern(db);
2001 let concrete_trait = ConcreteTraitLongId {
2002 trait_id,
2003 generic_args: vec![
2004 GenericArgumentId::Type(expr.ty),
2005 GenericArgumentId::Type(parameters_ty),
2006 ],
2007 }
2008 .intern(db);
2009 let Ok(impl_id) = semantic::types::get_impl_at_context(
2010 db,
2011 encapsulated_ctx.variables.lookup_context,
2012 concrete_trait,
2013 None,
2014 ) else {
2015 return Ok(());
2018 };
2019 if !matches!(impl_id.long(db), ImplLongId::GeneratedImpl(_)) {
2020 return Ok(());
2022 }
2023
2024 let trait_function: cairo_lang_defs::ids::TraitFunctionId<'_> = db
2025 .trait_function_by_name(trait_id, SmolStrId::from(db, "call"))
2026 .unwrap()
2027 .expect("Call function must exist for an Fn trait.");
2028
2029 let generic_function =
2030 GenericFunctionId::Impl(ImplGenericFunctionId { impl_id, function: trait_function });
2031 let function = semantic::FunctionLongId {
2032 function: ConcreteFunction { generic_function, generic_args: vec![] },
2033 }
2034 .intern(db);
2035 let function_with_body_id = FunctionWithBodyLongId::Generated {
2036 parent: encapsulated_ctx.semantic_function_id,
2037 key: GeneratedFunctionKey::TraitFunc(trait_function, closure_ty.params_location),
2038 }
2039 .intern(db);
2040 let signature =
2041 EnrichedSemanticSignature::from_semantic(db, db.concrete_function_signature(function)?);
2042
2043 let return_type = signature.return_type;
2044 let mut ctx =
2045 LoweringContext::new(encapsulated_ctx, function_with_body_id, signature, return_type)?;
2046
2047 let root_block_id = alloc_empty_block(&mut ctx);
2048 let mut builder = BlockBuilder::root(root_block_id);
2049
2050 let info = db.core_info();
2051 let (closure_param_var_id, closure_var) = if trait_id == info.fn_once_trt {
2052 let closure_param_var = ctx.new_var(VarRequest { ty: expr.ty, location: expr_location });
2054 let closure_var = VarUsage { var_id: closure_param_var, location: expr_location };
2055 (closure_param_var, closure_var)
2056 } else {
2057 let closure_param_var = ctx
2059 .new_var(VarRequest { ty: wrap_in_snapshots(db, expr.ty, 1), location: expr_location });
2060
2061 let closure_var = generators::Desnap {
2062 input: VarUsage { var_id: closure_param_var, location: expr_location },
2063 location: expr_location,
2064 }
2065 .add(&mut ctx, &mut builder.statements);
2066 (closure_param_var, closure_var)
2067 };
2068 let parameters: Vec<VariableId> = [
2069 closure_param_var_id,
2070 ctx.new_var(VarRequest { ty: parameters_ty, location: expr_location }),
2071 ]
2072 .into();
2073 let captured_vars = generators::StructDestructure {
2074 input: closure_var,
2075 var_reqs: chain!(closure_info.members.iter(), closure_info.snapshots.iter())
2076 .map(|(_, ty)| VarRequest { ty: *ty, location: expr_location })
2077 .collect_vec(),
2078 }
2079 .add(&mut ctx, &mut builder.statements);
2080 for (i, (param, _)) in closure_info.members.iter().enumerate() {
2081 builder.introduce(param.clone(), captured_vars[i]);
2082 }
2083 for (i, (param, _)) in closure_info.snapshots.iter().enumerate() {
2084 ctx.snapped_semantics.insert(param.clone(), captured_vars[i + closure_info.members.len()]);
2085 }
2086 let param_vars = generators::StructDestructure {
2087 input: VarUsage { var_id: parameters[1], location: expr_location },
2088 var_reqs: closure_ty
2089 .param_tys
2090 .iter()
2091 .map(|ty| VarRequest { ty: *ty, location: expr_location })
2092 .collect_vec(),
2093 }
2094 .add(&mut ctx, &mut builder.statements);
2095 for (param_var, param) in param_vars.into_iter().zip(expr.params.iter()) {
2096 builder.introduce((¶meter_as_member_path(param.clone())).into(), param_var);
2097 ctx.semantic_defs
2098 .insert(semantic::VarId::Param(param.id), semantic::Binding::Param(param.clone()));
2099 }
2100 let lowered_expr = lower_expr(&mut ctx, &mut builder, expr.body);
2101 let maybe_sealed_block = lowered_expr_to_block_scope_end(&mut ctx, builder, lowered_expr);
2102 let root_ok = maybe_sealed_block.and_then(|block_sealed| {
2103 wrap_sealed_block_as_function(&mut ctx, block_sealed, expr.stable_ptr.untyped())?;
2104 Ok(root_block_id)
2105 });
2106 let blocks = root_ok
2107 .map(|_| ctx.blocks.build().expect("Root block must exist."))
2108 .unwrap_or_else(Blocks::new_errored);
2109
2110 let lowered = Lowered {
2111 diagnostics: ctx.diagnostics.build(),
2112 variables: ctx.variables.variables,
2113 blocks,
2114 signature: ctx.signature.into(),
2115 parameters,
2116 };
2117 encapsulated_ctx.lowerings.insert(
2118 GeneratedFunctionKey::TraitFunc(trait_function, closure_ty.params_location),
2119 lowered,
2120 );
2121 Ok(())
2122}
2123
2124fn lower_expr_closure<'db>(
2126 ctx: &mut LoweringContext<'db, '_>,
2127 expr: &semantic::ExprClosure<'db>,
2128 expr_id: semantic::ExprId,
2129 builder: &mut BlockBuilder<'db>,
2130) -> LoweringResult<'db, LoweredExpr<'db>> {
2131 log::trace!("Lowering a closure expression: {:?}", expr.debug(&ctx.expr_formatter));
2132
2133 let usage = ctx.usages.usages[&expr_id].clone();
2134 let (capture_var_usage, closure_info) = builder.capture(ctx, usage, expr);
2135 let closure_variable = LoweredExpr::AtVariable(capture_var_usage);
2136 let closure_ty = extract_matches!(expr.ty.long(ctx.db), TypeLongId::Closure);
2137 add_capture_destruct_impl(ctx, capture_var_usage, &closure_info, closure_ty.params_location)
2138 .map_err(LoweringFlowError::Failed)?;
2139 add_closure_call_function(
2140 ctx,
2141 expr,
2142 &closure_info,
2143 if ctx.variables[capture_var_usage.var_id].info.copyable.is_ok() {
2144 ctx.db.core_info().fn_trt
2145 } else {
2146 ctx.db.core_info().fn_once_trt
2147 },
2148 )
2149 .map_err(LoweringFlowError::Failed)?;
2150
2151 Ok(closure_variable)
2152}
2153
2154fn lower_expr_error_propagate<'db>(
2156 ctx: &mut LoweringContext<'db, '_>,
2157 expr: &semantic::ExprPropagateError<'db>,
2158 builder: &mut BlockBuilder<'db>,
2159) -> LoweringResult<'db, LoweredExpr<'db>> {
2160 log::trace!(
2161 "Started lowering of an error-propagate expression: {:?}",
2162 expr.debug(&ctx.expr_formatter)
2163 );
2164 let location = ctx.get_location(expr.stable_ptr.untyped());
2165 let lowered_expr = lower_expr(ctx, builder, expr.inner)?;
2166 let ExprPropagateError { ok_variant, err_variant, func_err_variant, .. } = expr;
2167 if let LoweredExpr::ExternEnum(extern_enum) = lowered_expr {
2168 return lower_optimized_extern_error_propagate(
2169 ctx,
2170 builder,
2171 extern_enum,
2172 ok_variant,
2173 err_variant,
2174 func_err_variant,
2175 location,
2176 );
2177 }
2178
2179 let match_input = lowered_expr.as_var_usage(ctx, builder)?;
2180 let subscope_ok = create_subscope(ctx, builder);
2182 let block_ok_id = subscope_ok.block_id;
2183 let expr_var = ctx.new_var(VarRequest { ty: ok_variant.ty, location });
2184 let sealed_block_ok = subscope_ok.goto_callsite(Some(VarUsage { var_id: expr_var, location }));
2185
2186 let mut subscope_err = create_subscope(ctx, builder);
2188 let block_err_id = subscope_err.block_id;
2189 let err_value = ctx.new_var(VarRequest { ty: err_variant.ty, location });
2190 let err_res = generators::EnumConstruct {
2191 input: VarUsage { var_id: err_value, location },
2192 variant: *func_err_variant,
2193 location,
2194 }
2195 .add(ctx, &mut subscope_err.statements);
2196 let ret_expr = lower_return(ctx, &mut subscope_err, err_res, location, true);
2197 let sealed_block_err = lowered_expr_to_block_scope_end(ctx, subscope_err, ret_expr)
2198 .map_err(LoweringFlowError::Failed)?;
2199
2200 let match_info = MatchInfo::Enum(MatchEnumInfo {
2202 concrete_enum_id: ok_variant.concrete_enum_id,
2203 input: match_input,
2204 arms: vec![
2205 MatchArm {
2206 arm_selector: MatchArmSelector::VariantId(*ok_variant),
2207 block_id: block_ok_id,
2208 var_ids: vec![expr_var],
2209 },
2210 MatchArm {
2211 arm_selector: MatchArmSelector::VariantId(*err_variant),
2212 block_id: block_err_id,
2213 var_ids: vec![err_value],
2214 },
2215 ],
2216 location,
2217 });
2218 builder.merge_and_end_with_match(
2219 ctx,
2220 match_info,
2221 vec![sealed_block_ok, sealed_block_err],
2222 location,
2223 )
2224}
2225
2226fn lower_optimized_extern_error_propagate<'db>(
2228 ctx: &mut LoweringContext<'db, '_>,
2229 builder: &mut BlockBuilder<'db>,
2230 extern_enum: LoweredExprExternEnum<'db>,
2231 ok_variant: &semantic::ConcreteVariant<'db>,
2232 err_variant: &semantic::ConcreteVariant<'db>,
2233 func_err_variant: &semantic::ConcreteVariant<'db>,
2234 location: LocationId<'db>,
2235) -> LoweringResult<'db, LoweredExpr<'db>> {
2236 log::trace!("Started lowering of an optimized error-propagate expression.");
2237
2238 let mut subscope_ok = create_subscope(ctx, builder);
2240 let block_ok_id = subscope_ok.block_id;
2241 let block_ok_input_vars: Vec<VariableId> =
2242 match_extern_variant_arm_input_types(ctx.db, &ok_variant.ty, &extern_enum)
2243 .map(|ty| ctx.new_var(VarRequest { ty, location }))
2244 .collect();
2245 let returns =
2246 match_extern_arm_ref_args_bind(ctx, &block_ok_input_vars, &extern_enum, &mut subscope_ok);
2247 let expr = extern_facade_expr(ctx, ok_variant.ty, returns.iter().copied(), location)
2248 .as_var_usage(ctx, &mut subscope_ok)?;
2249 let sealed_block_ok = subscope_ok.goto_callsite(Some(expr));
2250
2251 let mut subscope_err = create_subscope(ctx, builder);
2253 let block_err_id = subscope_err.block_id;
2254 let block_err_input_vars: Vec<VariableId> =
2255 match_extern_variant_arm_input_types(ctx.db, &err_variant.ty, &extern_enum)
2256 .map(|ty| ctx.new_var(VarRequest { ty, location }))
2257 .collect();
2258
2259 let returns =
2260 match_extern_arm_ref_args_bind(ctx, &block_err_input_vars, &extern_enum, &mut subscope_err);
2261 let expr = extern_facade_expr(ctx, err_variant.ty, returns.iter().copied(), location);
2262 let input = expr.as_var_usage(ctx, &mut subscope_err)?;
2263 let err_res = generators::EnumConstruct { input, variant: *func_err_variant, location }
2264 .add(ctx, &mut subscope_err.statements);
2265
2266 let ret_expr = lower_return(ctx, &mut subscope_err, err_res, location, true);
2267 let sealed_block_err = lowered_expr_to_block_scope_end(ctx, subscope_err, ret_expr)
2268 .map_err(LoweringFlowError::Failed)?;
2269
2270 let match_info = MatchInfo::Extern(MatchExternInfo {
2272 function: extern_enum.function.lowered(ctx.db),
2273 inputs: extern_enum.inputs,
2274 arms: vec![
2275 MatchArm {
2276 arm_selector: MatchArmSelector::VariantId(*ok_variant),
2277 block_id: block_ok_id,
2278 var_ids: block_ok_input_vars,
2279 },
2280 MatchArm {
2281 arm_selector: MatchArmSelector::VariantId(*err_variant),
2282 block_id: block_err_id,
2283 var_ids: block_err_input_vars,
2284 },
2285 ],
2286 location,
2287 });
2288 builder.merge_and_end_with_match(
2289 ctx,
2290 match_info,
2291 vec![sealed_block_ok, sealed_block_err],
2292 location,
2293 )
2294}
2295
2296fn match_extern_variant_arm_input_types<'db>(
2298 db: &'db dyn salsa::Database,
2299 ty: &semantic::TypeId<'db>,
2300 extern_enum: &LoweredExprExternEnum<'db>,
2301) -> impl Iterator<Item = semantic::TypeId<'db>> {
2302 chain!(
2303 extern_enum.ref_args.iter().map(|ref_arg| ref_arg.ty()),
2304 extern_facade_return_tys(db, ty).iter().copied()
2305 )
2306}
2307
2308fn match_extern_arm_ref_args_bind<'db, 'vars>(
2311 ctx: &mut LoweringContext<'db, '_>,
2312 arm_inputs: &'vars [VariableId],
2313 extern_enum: &LoweredExprExternEnum<'db>,
2314 subscope: &mut BlockBuilder<'db>,
2315) -> &'vars [VariableId] {
2316 let (ref_outputs, others) = arm_inputs.split_at(extern_enum.ref_args.len());
2317 for (ref_arg, output_var) in zip_eq(&extern_enum.ref_args, ref_outputs) {
2319 if let RefArg::Ref(ref_arg) = ref_arg {
2320 subscope.update_ref(ctx, ref_arg, *output_var);
2321 }
2322 }
2323 others
2324}
2325
2326fn lower_expr_assignment<'db>(
2328 ctx: &mut LoweringContext<'db, '_>,
2329 expr: &semantic::ExprAssignment<'db>,
2330 builder: &mut BlockBuilder<'db>,
2331) -> LoweringResult<'db, LoweredExpr<'db>> {
2332 log::trace!(
2333 "Started lowering of an assignment expression: {:?}",
2334 expr.debug(&ctx.expr_formatter)
2335 );
2336 let location = ctx.get_location(expr.stable_ptr.untyped());
2337 let var = lower_expr(ctx, builder, expr.rhs)?.as_var_usage(ctx, builder)?.var_id;
2338 builder.update_ref(ctx, &expr.ref_arg, var);
2339 Ok(LoweredExpr::Tuple { exprs: vec![], location })
2340}
2341
2342fn alloc_empty_block<'db>(ctx: &mut LoweringContext<'db, '_>) -> BlockId {
2344 ctx.blocks.alloc_empty()
2345}
2346
2347fn create_subscope<'db>(
2349 ctx: &mut LoweringContext<'db, '_>,
2350 builder: &BlockBuilder<'db>,
2351) -> BlockBuilder<'db> {
2352 builder.child_block_builder(alloc_empty_block(ctx))
2353}
2354
2355fn check_error_free_or_warn<'db>(
2357 db: &dyn Database,
2358 diagnostics: Diagnostics<'db, SemanticDiagnostic<'db>>,
2359 semantic_function_id: defs::ids::FunctionWithBodyId<'db>,
2360 diagnostics_description: &str,
2361) -> Maybe<()> {
2362 let declaration_error_free = diagnostics.check_error_free();
2363 declaration_error_free.inspect_err(|_| {
2364 log::warn!(
2365 "Function `{function_path}` has semantic diagnostics in its \
2366 {diagnostics_description}:\n{diagnostics_format}",
2367 function_path = semantic_function_id.full_path(db),
2368 diagnostics_format = diagnostics.format(db)
2369 );
2370 })
2371}