cairo-language-server 2.20.0

The Cairo Language Server
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use cairo_lang_defs::ids::{LookupItemId, ModuleId, ModuleItemId, SubmoduleId};
use cairo_lang_doc::db::DocGroup;
use cairo_lang_doc::documentable_item::DocumentableItemId;
use cairo_lang_filesystem::ids::CrateId;
use cairo_lang_syntax::node::SyntaxNode;
use cairo_lang_syntax::node::ids::SyntaxStablePtrId;

use crate::lang::db::AnalysisDatabase;

/// Information about the definition of a module.
/// It uses [`NonMacroModuleId`] instead of [`ModuleId`] since [`ModuleId::MacroCall`] is resolved to
/// [`super::ItemDef`] to make sure it points to the macro declaration.
#[derive(Eq, PartialEq, Debug, Clone)]
pub struct ModuleDef<'db> {
    id: NonMacroModuleId<'db>,
    /// A full path to the parent module if [`ModuleId`] points to a submodule,
    /// None otherwise (i.e. for a crate root).
    parent_full_path: Option<String>,
    definition_stable_ptr: SyntaxStablePtrId<'db>,
}

/// [`ModuleId`] without [`ModuleId::MacroCall`].
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum NonMacroModuleId<'db> {
    CrateRoot(CrateId<'db>),
    Submodule(SubmoduleId<'db>),
}

impl<'db> TryFrom<ModuleId<'db>> for NonMacroModuleId<'db> {
    type Error = ();

    fn try_from(value: ModuleId<'db>) -> Result<Self, Self::Error> {
        match value {
            ModuleId::CrateRoot(id) => Ok(Self::CrateRoot(id)),
            ModuleId::Submodule(id) => Ok(Self::Submodule(id)),
            ModuleId::MacroCall { .. } => Err(()),
        }
    }
}

impl<'db> From<NonMacroModuleId<'db>> for ModuleId<'db> {
    fn from(value: NonMacroModuleId<'db>) -> Self {
        match value {
            NonMacroModuleId::CrateRoot(id) => Self::CrateRoot(id),
            NonMacroModuleId::Submodule(id) => Self::Submodule(id),
        }
    }
}

impl<'db> ModuleDef<'db> {
    /// Constructs a new [`ModuleDef`] instance.
    pub(super) fn new(
        db: &'db AnalysisDatabase,
        id: NonMacroModuleId<'db>,
        definition_node: SyntaxNode<'db>,
    ) -> Self {
        let module_id: ModuleId = id.into();
        let parent_full_path = module_id
            .full_path(db)
            .strip_suffix(module_id.name(db).to_string(db).as_str())
            .unwrap()
            // Fails when the path lacks `::`, i.e. when we import from a crate root.
            .strip_suffix("::")
            .map(String::from);

        ModuleDef { id, parent_full_path, definition_stable_ptr: definition_node.stable_ptr(db) }
    }

    /// Gets the stable pointer to the syntax node which defines this symbol.
    pub fn definition_stable_ptr(&self) -> SyntaxStablePtrId<'db> {
        self.definition_stable_ptr
    }

    /// Gets the module signature: a name preceded by a qualifier: "mod" for submodule
    /// and "crate" for crate root.
    pub fn signature(&self, db: &'db AnalysisDatabase) -> String {
        let prefix = if self.parent_full_path.is_some() { "mod" } else { "crate" };
        format!("{prefix} {}", self.name(db))
    }

    /// Gets the full path of the parent module.
    pub fn definition_path(&self) -> String {
        self.parent_full_path.clone().unwrap_or_default()
    }

    /// Gets the module's documentation if it is available.
    pub fn documentation(&self, db: &'db AnalysisDatabase) -> Option<String> {
        let doc_id = match self.id {
            NonMacroModuleId::CrateRoot(id) => DocumentableItemId::Crate(id),
            NonMacroModuleId::Submodule(id) => DocumentableItemId::LookupItem(
                LookupItemId::ModuleItem(ModuleItemId::Submodule(id)),
            ),
        };

        db.get_item_documentation(doc_id)
    }

    /// Gets the name of the module.
    pub fn name(&self, db: &'db AnalysisDatabase) -> String {
        self.module_id().name(db).to_string(db)
    }

    /// Gets the id of the module.
    pub fn non_macro_module_id(&self) -> NonMacroModuleId<'db> {
        self.id
    }

    /// Gets the id of the module.
    pub fn module_id(&self) -> ModuleId<'db> {
        self.id.into()
    }
}