cairo_lang_semantic/items/
modifiers.rs

1use cairo_lang_syntax::node::Terminal;
2use cairo_lang_syntax::node::ast::Modifier;
3use cairo_lang_syntax::node::db::SyntaxGroup;
4use smol_str::SmolStr;
5
6use crate::Mutability;
7use crate::diagnostic::SemanticDiagnosticKind::RedundantModifier;
8use crate::diagnostic::{SemanticDiagnostics, SemanticDiagnosticsBuilder};
9
10/// Returns the mutability of a variable, given the list of modifiers in the AST.
11pub fn compute_mutability(
12    diagnostics: &mut SemanticDiagnostics,
13    syntax_db: &dyn SyntaxGroup,
14    modifier_list: &[Modifier],
15) -> Mutability {
16    let mut mutability = Mutability::Immutable;
17
18    for modifier in modifier_list {
19        match mutability {
20            Mutability::Immutable => {
21                mutability = match modifier {
22                    Modifier::Ref(_) => Mutability::Reference,
23                    Modifier::Mut(_) => Mutability::Mutable,
24                };
25            }
26            Mutability::Mutable | Mutability::Reference => match modifier {
27                Modifier::Ref(terminal) => {
28                    diagnostics.report(terminal, RedundantModifier {
29                        current_modifier: terminal.text(syntax_db),
30                        previous_modifier: get_relevant_modifier(&mutability),
31                    });
32                }
33                Modifier::Mut(terminal) => {
34                    diagnostics.report(terminal, RedundantModifier {
35                        current_modifier: terminal.text(syntax_db),
36                        previous_modifier: get_relevant_modifier(&mutability),
37                    });
38                }
39            },
40        }
41    }
42    mutability
43}
44
45/// Gets the text of the modifier that causes a variable to have the given mutability status.
46fn get_relevant_modifier(mutability: &Mutability) -> SmolStr {
47    match mutability {
48        Mutability::Immutable => "",
49        Mutability::Mutable => "mut",
50        Mutability::Reference => "ref",
51    }
52    .to_string()
53    .into()
54}