cairo-lang-plugins 2.18.0

Cairo core plugin implementations.
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
87
88
89
90
91
92
93
94
95

use cairo_lang_defs::diagnostic_utils::StableLocation;
use cairo_lang_defs::ids::{LanguageElementId, ModuleId, ModuleItemId};
use cairo_lang_defs::plugin::PluginDiagnostic;
use cairo_lang_diagnostics::{DiagnosticEntry, DiagnosticsBuilder, ErrorCode, Severity};
use cairo_lang_filesystem::ids::SpanInFile;
use cairo_lang_syntax::node::kind::SyntaxKind;
use cairo_lang_syntax::node::{TypedStablePtr, TypedSyntaxNode, ast};
use cairo_lang_utils::unordered_hash_set::UnorderedHashSet;
use salsa::Database;

/// Returns the expanded code for `module_id` after running all plugins and extends `diagnostics`
/// with all the plugins diagnostics.
pub fn expand_module_text<'db>(
    db: &'db dyn Database,
    module_id: ModuleId<'db>,
    diagnostics: &mut Vec<String>,
) -> String {
    let mut output = String::new();
    // A collection of all the use statements in the module.
    let mut uses_list = UnorderedHashSet::<_>::default();
    // Collect the module diagnostics.
    let mut builder = DiagnosticsBuilder::default();
    for (_file_id, diag) in module_id.module_data(db).unwrap().plugin_diagnostics(db).iter() {
        builder.add(TestDiagnosticEntry(diag.clone()));
    }
    let build = builder.build();
    let file_notes = module_id.module_data(db).unwrap().diagnostics_notes(db);
    let formatted = build.format_with_severity(db, file_notes);
    diagnostics.extend(
        formatted
            .into_iter()
            .map(|formatted| format!("{}: {}", Severity::Error, formatted.message())),
    );
    for item_id in module_id.module_data(db).unwrap().items(db).iter() {
        if let ModuleItemId::Submodule(item) = item_id {
            let submodule_item = item.stable_ptr(db).lookup(db);
            if let ast::MaybeModuleBody::Some(body) = submodule_item.body(db) {
                // Recursively expand inline submodules.
                output.extend([
                    submodule_item.attributes(db).as_syntax_node().get_text(db),
                    submodule_item.visibility(db).as_syntax_node().get_text(db),
                    submodule_item.module_kw(db).as_syntax_node().get_text(db),
                    submodule_item.name(db).as_syntax_node().get_text(db),
                    body.lbrace(db).as_syntax_node().get_text(db),
                    &expand_module_text(db, ModuleId::Submodule(*item), diagnostics),
                    body.rbrace(db).as_syntax_node().get_text(db),
                ]);
                continue;
            }
        } else if let ModuleItemId::Use(use_id) = item_id {
            let mut use_item = use_id.stable_ptr(db).lookup(db).as_syntax_node();
            // Climb up the AST until the syntax kind is ItemUse. This is needed since the use item
            // points to the use leaf as one use statement can represent multiple use items.
            while let Some(parent) = use_item.parent(db) {
                use_item = parent;
                if use_item.kind(db) == SyntaxKind::ItemUse {
                    break;
                }
            }
            if uses_list.insert(use_item) {
                output.push_str(use_item.get_text(db));
            }
            continue;
        }
        let syntax_item = item_id.untyped_stable_ptr(db);
        // Output other items as is.
        output.push_str(syntax_item.lookup(db).get_text(db));
    }
    output
}

#[derive(Clone, Debug, Eq, Hash, PartialEq, salsa::Update)]
struct TestDiagnosticEntry<'a>(pub PluginDiagnostic<'a>);
impl<'a> DiagnosticEntry<'a> for TestDiagnosticEntry<'a> {
    fn format(&self, _db: &dyn Database) -> String {
        self.0.message.to_string()
    }
    fn location(&self, db: &'a dyn Database) -> SpanInFile<'a> {
        match self.0.inner_span {
            Some(inner_span) => {
                StableLocation::with_inner_span(self.0.stable_ptr, inner_span).span_in_file(db)
            }
            None => StableLocation::new(self.0.stable_ptr).span_in_file(db),
        }
    }
    fn severity(&self) -> Severity {
        self.0.severity
    }
    fn error_code(&self) -> Option<ErrorCode> {
        None
    }
    fn is_same_kind(&self, other: &Self) -> bool {
        self.0 == other.0
    }
}