cairo-lang-lowering 2.17.0

Cairo lowering phase.
Documentation 
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

use cairo_lang_diagnostics::Maybe;
use cairo_lang_semantic::substitution::GenericSubstitution;
use cairo_lang_semantic::types::TypeInfo;
use cairo_lang_utils::Intern;
use salsa::Database;

use crate::ids::{FunctionId, FunctionLongId, GeneratedFunction, SemanticFunctionIdEx};
use crate::{BlockEnd, Lowered, MatchArm, Statement};

/// Rewrites a [FunctionId] with a [GenericSubstitution].
fn concretize_function<'db>(
    db: &'db dyn Database,
    substitution: &GenericSubstitution<'db>,
    function: FunctionId<'db>,
) -> Maybe<FunctionId<'db>> {
    match function.long(db) {
        FunctionLongId::Semantic(id) => {
            // We call `lowered` here in case the function will be substituted to a generated one.
            Ok(substitution.substitute(db, *id)?.lowered(db))
        }
        FunctionLongId::Generated(GeneratedFunction { parent, key }) => {
            Ok(FunctionLongId::Generated(GeneratedFunction {
                parent: substitution.substitute(db, *parent)?,
                key: *key,
            })
            .intern(db))
        }
        FunctionLongId::Specialized(_) => {
            unreachable!("Specialization of functions only occurs post concretization.")
        }
    }
}

/// Concretizes a lowered generic function by applying a generic parameter substitution on its
/// variable types, variants and called functions.
pub fn concretize_lowered<'db>(
    db: &'db dyn Database,
    lowered: &mut Lowered<'db>,
    substitution: &GenericSubstitution<'db>,
) -> Maybe<()> {
    // Substitute all types.
    for (_, var) in lowered.variables.iter_mut() {
        var.ty = substitution.substitute(db, var.ty)?;
        let TypeInfo { destruct_impl, panic_destruct_impl, .. } = &mut var.info;
        for impl_id in [destruct_impl, panic_destruct_impl].into_iter().flatten() {
            *impl_id = substitution.substitute(db, *impl_id)?;
        }
    }
    // Substitute all statements.
    for block in lowered.blocks.iter_mut() {
        for stmt in block.statements.iter_mut() {
            match stmt {
                Statement::Call(stmt) => {
                    stmt.function = concretize_function(db, substitution, stmt.function)?;
                }
                Statement::EnumConstruct(stmt) => {
                    stmt.variant = substitution.substitute(db, stmt.variant)?;
                }
                Statement::Const(stmt) => {
                    stmt.value = substitution.substitute(db, stmt.value)?;
                }
                Statement::Snapshot(_)
                | Statement::Desnap(_)
                | Statement::StructConstruct(_)
                | Statement::StructDestructure(_)
                | Statement::IntoBox(_)
                | Statement::Unbox(_) => {}
            }
        }
        if let BlockEnd::Match { info } = &mut block.end {
            for MatchArm { arm_selector: selector, .. } in match info {
                crate::MatchInfo::Enum(s) => s.arms.iter_mut(),
                crate::MatchInfo::Extern(s) => {
                    s.function = concretize_function(db, substitution, s.function)?;
                    s.arms.iter_mut()
                }
                crate::MatchInfo::Value(s) => s.arms.iter_mut(),
            } {
                *selector = substitution.substitute(db, selector.clone())?;
            }
        }
    }
    lowered.signature = substitution.substitute(db, lowered.signature.clone())?;

    Ok(())
}