cairo_lang_defs/
db.rs

1use std::collections::VecDeque;
2use std::sync::Arc;
3
4use cairo_lang_diagnostics::{DiagnosticNote, Maybe, PluginFileDiagnosticNotes, ToMaybe};
5use cairo_lang_filesystem::db::FilesGroup;
6use cairo_lang_filesystem::ids::{CrateId, Directory, FileId, FileKind, FileLongId, VirtualFile};
7use cairo_lang_parser::db::ParserGroup;
8use cairo_lang_syntax::attribute::consts::{
9    ALLOW_ATTR, ALLOW_ATTR_ATTR, DEPRECATED_ATTR, FEATURE_ATTR, FMT_SKIP_ATTR,
10    IMPLICIT_PRECEDENCE_ATTR, INLINE_ATTR, INTERNAL_ATTR, MUST_USE_ATTR, PHANTOM_ATTR,
11    STARKNET_INTERFACE_ATTR, UNSTABLE_ATTR,
12};
13use cairo_lang_syntax::attribute::structured::AttributeStructurize;
14use cairo_lang_syntax::node::ast::MaybeModuleBody;
15use cairo_lang_syntax::node::db::SyntaxGroup;
16use cairo_lang_syntax::node::element_list::ElementList;
17use cairo_lang_syntax::node::helpers::QueryAttrs;
18use cairo_lang_syntax::node::ids::SyntaxStablePtrId;
19use cairo_lang_syntax::node::{Terminal, TypedStablePtr, TypedSyntaxNode, ast};
20use cairo_lang_utils::ordered_hash_map::OrderedHashMap;
21use cairo_lang_utils::ordered_hash_set::OrderedHashSet;
22use cairo_lang_utils::{Intern, LookupIntern, Upcast};
23use itertools::{Itertools, chain};
24use salsa::InternKey;
25
26use crate::ids::*;
27use crate::plugin::{DynGeneratedFileAuxData, MacroPlugin, MacroPluginMetadata, PluginDiagnostic};
28use crate::plugin_utils::try_extract_unnamed_arg;
29
30/// Salsa database interface.
31/// See [`super::ids`] for further details.
32#[salsa::query_group(DefsDatabase)]
33pub trait DefsGroup:
34    FilesGroup + SyntaxGroup + Upcast<dyn SyntaxGroup> + ParserGroup + Upcast<dyn FilesGroup>
35{
36    #[salsa::interned]
37    fn intern_constant(&self, id: ConstantLongId) -> ConstantId;
38    #[salsa::interned]
39    fn intern_submodule(&self, id: SubmoduleLongId) -> SubmoduleId;
40    #[salsa::interned]
41    fn intern_use(&self, id: UseLongId) -> UseId;
42    #[salsa::interned]
43    fn intern_global_use(&self, id: GlobalUseLongId) -> GlobalUseId;
44    #[salsa::interned]
45    fn intern_free_function(&self, id: FreeFunctionLongId) -> FreeFunctionId;
46    #[salsa::interned]
47    fn intern_impl_type_def(&self, id: ImplTypeDefLongId) -> ImplTypeDefId;
48    #[salsa::interned]
49    fn intern_impl_constant_def(&self, id: ImplConstantDefLongId) -> ImplConstantDefId;
50    #[salsa::interned]
51    fn intern_impl_impl_def(&self, id: ImplImplDefLongId) -> ImplImplDefId;
52    #[salsa::interned]
53    fn intern_impl_function(&self, id: ImplFunctionLongId) -> ImplFunctionId;
54    #[salsa::interned]
55    fn intern_struct(&self, id: StructLongId) -> StructId;
56    #[salsa::interned]
57    fn intern_enum(&self, id: EnumLongId) -> EnumId;
58    #[salsa::interned]
59    fn intern_module_type_alias(&self, id: ModuleTypeAliasLongId) -> ModuleTypeAliasId;
60    #[salsa::interned]
61    fn intern_impl_alias(&self, id: ImplAliasLongId) -> ImplAliasId;
62    #[salsa::interned]
63    fn intern_member(&self, id: MemberLongId) -> MemberId;
64    #[salsa::interned]
65    fn intern_variant(&self, id: VariantLongId) -> VariantId;
66    #[salsa::interned]
67    fn intern_trait(&self, id: TraitLongId) -> TraitId;
68    #[salsa::interned]
69    fn intern_trait_type(&self, id: TraitTypeLongId) -> TraitTypeId;
70    #[salsa::interned]
71    fn intern_trait_constant(&self, id: TraitConstantLongId) -> TraitConstantId;
72    #[salsa::interned]
73    fn intern_trait_impl(&self, id: TraitImplLongId) -> TraitImplId;
74    #[salsa::interned]
75    fn intern_trait_function(&self, id: TraitFunctionLongId) -> TraitFunctionId;
76    #[salsa::interned]
77    fn intern_impl_def(&self, id: ImplDefLongId) -> ImplDefId;
78    #[salsa::interned]
79    fn intern_extern_type(&self, id: ExternTypeLongId) -> ExternTypeId;
80    #[salsa::interned]
81    fn intern_extern_function(&self, id: ExternFunctionLongId) -> ExternFunctionId;
82    #[salsa::interned]
83    fn intern_param(&self, id: ParamLongId) -> ParamId;
84    #[salsa::interned]
85    fn intern_generic_param(&self, id: GenericParamLongId) -> GenericParamId;
86    #[salsa::interned]
87    fn intern_local_var(&self, id: LocalVarLongId) -> LocalVarId;
88    #[salsa::interned]
89    fn intern_statement_const(&self, id: StatementConstLongId) -> StatementConstId;
90    #[salsa::interned]
91    fn intern_statement_use(&self, id: StatementUseLongId) -> StatementUseId;
92    #[salsa::interned]
93    fn intern_plugin_generated_file(&self, id: PluginGeneratedFileLongId) -> PluginGeneratedFileId;
94
95    // Plugins.
96    // ========
97
98    #[salsa::input]
99    fn default_macro_plugins(&self) -> Arc<[MacroPluginId]>;
100
101    #[salsa::input]
102    fn macro_plugin_overrides(&self) -> Arc<OrderedHashMap<CrateId, Arc<[MacroPluginId]>>>;
103
104    #[salsa::interned]
105    fn intern_macro_plugin(&self, plugin: MacroPluginLongId) -> MacroPluginId;
106
107    /// Returns [`MacroPluginId`]s of the plugins set for the crate with [`CrateId`].
108    /// Provides an override if it has been set with
109    /// [`DefsGroupEx::set_override_crate_macro_plugins`] or the default
110    /// ([`DefsGroup::default_macro_plugins`]) otherwise.
111    fn crate_macro_plugins(&self, crate_id: CrateId) -> Arc<[MacroPluginId]>;
112
113    #[salsa::input]
114    fn default_inline_macro_plugins(&self) -> Arc<OrderedHashMap<String, InlineMacroExprPluginId>>;
115
116    #[salsa::input]
117    fn inline_macro_plugin_overrides(
118        &self,
119    ) -> Arc<OrderedHashMap<CrateId, Arc<OrderedHashMap<String, InlineMacroExprPluginId>>>>;
120
121    #[salsa::interned]
122    fn intern_inline_macro_plugin(
123        &self,
124        plugin: InlineMacroExprPluginLongId,
125    ) -> InlineMacroExprPluginId;
126
127    /// Returns [`InlineMacroExprPluginId`]s of the plugins set for the crate with [`CrateId`].
128    /// Provides an override if it has been set with
129    /// [`DefsGroupEx::set_override_crate_inline_macro_plugins`] or the default
130    /// ([`DefsGroup::default_inline_macro_plugins`]) otherwise.
131    fn crate_inline_macro_plugins(
132        &self,
133        crate_id: CrateId,
134    ) -> Arc<OrderedHashMap<String, InlineMacroExprPluginId>>;
135
136    /// Returns the set of attributes allowed anywhere.
137    /// An attribute on any item that is not in this set will be handled as an unknown attribute.
138    fn allowed_attributes(&self, crate_id: CrateId) -> Arc<OrderedHashSet<String>>;
139
140    /// Returns the set of attributes allowed on statements.
141    /// An attribute on a statement that is not in this set will be handled as an unknown attribute.
142    fn allowed_statement_attributes(&self) -> Arc<OrderedHashSet<String>>;
143
144    /// Returns the set of `derive` that were declared as by a plugin.
145    /// A derive that is not in this set will be handled as an unknown derive.
146    fn declared_derives(&self, crate_id: CrateId) -> Arc<OrderedHashSet<String>>;
147
148    /// Returns the set of attributes that were declared as phantom type attributes by a plugin,
149    /// i.e. a type marked with this attribute is considered a phantom type.
150    fn declared_phantom_type_attributes(&self, crate_id: CrateId) -> Arc<OrderedHashSet<String>>;
151
152    /// Checks whether the submodule is defined as inline.
153    fn is_submodule_inline(&self, submodule_id: SubmoduleId) -> bool;
154
155    // Module to syntax.
156    /// Gets the main file of the module.
157    /// A module might have more virtual files generated by plugins.
158    fn module_main_file(&self, module_id: ModuleId) -> Maybe<FileId>;
159    /// Gets all the files of a module - main files and generated virtual files.
160    fn module_files(&self, module_id: ModuleId) -> Maybe<Arc<[FileId]>>;
161    /// Gets a file from a module and a FileIndex (i.e. ModuleFileId).
162    fn module_file(&self, module_id: ModuleFileId) -> Maybe<FileId>;
163    /// Gets the directory of a module.
164    fn module_dir(&self, module_id: ModuleId) -> Maybe<Directory>;
165
166    // File to module.
167    fn crate_modules(&self, crate_id: CrateId) -> Arc<[ModuleId]>;
168    fn priv_file_to_module_mapping(&self) -> Arc<OrderedHashMap<FileId, Vec<ModuleId>>>;
169    fn file_modules(&self, file_id: FileId) -> Maybe<Arc<[ModuleId]>>;
170
171    // Module level resolving.
172    fn priv_module_data(&self, module_id: ModuleId) -> Maybe<ModuleData>;
173    // Returns the information about sub-files generated by the file in the module.
174    fn priv_module_sub_files(
175        &self,
176        module_id: ModuleId,
177        file_id: FileId,
178    ) -> Maybe<Arc<PrivModuleSubFiles>>;
179    fn module_submodules(
180        &self,
181        module_id: ModuleId,
182    ) -> Maybe<Arc<OrderedHashMap<SubmoduleId, ast::ItemModule>>>;
183    fn module_submodules_ids(&self, module_id: ModuleId) -> Maybe<Arc<[SubmoduleId]>>;
184    fn module_constants(
185        &self,
186        module_id: ModuleId,
187    ) -> Maybe<Arc<OrderedHashMap<ConstantId, ast::ItemConstant>>>;
188    fn module_constants_ids(&self, module_id: ModuleId) -> Maybe<Arc<[ConstantId]>>;
189    fn module_constant_by_id(&self, constant_id: ConstantId) -> Maybe<Option<ast::ItemConstant>>;
190    fn module_free_functions(
191        &self,
192        module_id: ModuleId,
193    ) -> Maybe<Arc<OrderedHashMap<FreeFunctionId, ast::FunctionWithBody>>>;
194    fn module_free_functions_ids(&self, module_id: ModuleId) -> Maybe<Arc<[FreeFunctionId]>>;
195    fn module_free_function_by_id(
196        &self,
197        free_function_id: FreeFunctionId,
198    ) -> Maybe<Option<ast::FunctionWithBody>>;
199    fn module_items(&self, module_id: ModuleId) -> Maybe<Arc<[ModuleItemId]>>;
200    fn module_global_uses(
201        &self,
202        module_id: ModuleId,
203    ) -> Maybe<Arc<OrderedHashMap<GlobalUseId, ast::UsePathStar>>>;
204    /// Returns the stable ptr of the name of a module item.
205    fn module_item_name_stable_ptr(
206        &self,
207        module_id: ModuleId,
208        item_id: ModuleItemId,
209    ) -> Maybe<SyntaxStablePtrId>;
210    fn module_uses(
211        &self,
212        module_id: ModuleId,
213    ) -> Maybe<Arc<OrderedHashMap<UseId, ast::UsePathLeaf>>>;
214    fn module_uses_ids(&self, module_id: ModuleId) -> Maybe<Arc<[UseId]>>;
215    fn module_use_by_id(&self, use_id: UseId) -> Maybe<Option<ast::UsePathLeaf>>;
216    fn module_global_use_by_id(
217        &self,
218        global_use_id: GlobalUseId,
219    ) -> Maybe<Option<ast::UsePathStar>>;
220    fn module_structs(
221        &self,
222        module_id: ModuleId,
223    ) -> Maybe<Arc<OrderedHashMap<StructId, ast::ItemStruct>>>;
224    fn module_structs_ids(&self, module_id: ModuleId) -> Maybe<Arc<[StructId]>>;
225    fn module_struct_by_id(&self, struct_id: StructId) -> Maybe<Option<ast::ItemStruct>>;
226    fn module_enums(
227        &self,
228        module_id: ModuleId,
229    ) -> Maybe<Arc<OrderedHashMap<EnumId, ast::ItemEnum>>>;
230    fn module_enums_ids(&self, module_id: ModuleId) -> Maybe<Arc<[EnumId]>>;
231    fn module_enum_by_id(&self, enum_id: EnumId) -> Maybe<Option<ast::ItemEnum>>;
232    fn module_type_aliases(
233        &self,
234        module_id: ModuleId,
235    ) -> Maybe<Arc<OrderedHashMap<ModuleTypeAliasId, ast::ItemTypeAlias>>>;
236    fn module_type_aliases_ids(&self, module_id: ModuleId) -> Maybe<Arc<[ModuleTypeAliasId]>>;
237    fn module_type_alias_by_id(
238        &self,
239        module_type_alias_id: ModuleTypeAliasId,
240    ) -> Maybe<Option<ast::ItemTypeAlias>>;
241    fn module_impl_aliases(
242        &self,
243        module_id: ModuleId,
244    ) -> Maybe<Arc<OrderedHashMap<ImplAliasId, ast::ItemImplAlias>>>;
245    fn module_impl_aliases_ids(&self, module_id: ModuleId) -> Maybe<Arc<[ImplAliasId]>>;
246    fn module_impl_alias_by_id(
247        &self,
248        impl_alias_id: ImplAliasId,
249    ) -> Maybe<Option<ast::ItemImplAlias>>;
250    fn module_traits(
251        &self,
252        module_id: ModuleId,
253    ) -> Maybe<Arc<OrderedHashMap<TraitId, ast::ItemTrait>>>;
254    fn module_traits_ids(&self, module_id: ModuleId) -> Maybe<Arc<[TraitId]>>;
255    fn module_trait_by_id(&self, trait_id: TraitId) -> Maybe<Option<ast::ItemTrait>>;
256    fn module_impls(
257        &self,
258        module_id: ModuleId,
259    ) -> Maybe<Arc<OrderedHashMap<ImplDefId, ast::ItemImpl>>>;
260    fn module_impls_ids(&self, module_id: ModuleId) -> Maybe<Arc<[ImplDefId]>>;
261    fn module_impl_by_id(&self, impl_id: ImplDefId) -> Maybe<Option<ast::ItemImpl>>;
262    fn module_extern_types(
263        &self,
264        module_id: ModuleId,
265    ) -> Maybe<Arc<OrderedHashMap<ExternTypeId, ast::ItemExternType>>>;
266    fn module_extern_types_ids(&self, module_id: ModuleId) -> Maybe<Arc<[ExternTypeId]>>;
267    fn module_extern_type_by_id(
268        &self,
269        extern_type_id: ExternTypeId,
270    ) -> Maybe<Option<ast::ItemExternType>>;
271    fn module_extern_functions(
272        &self,
273        module_id: ModuleId,
274    ) -> Maybe<Arc<OrderedHashMap<ExternFunctionId, ast::ItemExternFunction>>>;
275    fn module_extern_functions_ids(&self, module_id: ModuleId) -> Maybe<Arc<[ExternFunctionId]>>;
276    fn module_extern_function_by_id(
277        &self,
278        extern_function_id: ExternFunctionId,
279    ) -> Maybe<Option<ast::ItemExternFunction>>;
280    fn module_ancestors(&self, module_id: ModuleId) -> OrderedHashSet<ModuleId>;
281    fn module_generated_file_aux_data(
282        &self,
283        module_id: ModuleId,
284    ) -> Maybe<Arc<[Option<DynGeneratedFileAuxData>]>>;
285    fn module_plugin_diagnostics(
286        &self,
287        module_id: ModuleId,
288    ) -> Maybe<Arc<[(ModuleFileId, PluginDiagnostic)]>>;
289    /// Diagnostic notes for diagnostics originating in the plugin generated files identified by
290    /// [`FileId`].
291    fn module_plugin_diagnostics_notes(
292        &self,
293        module_id: ModuleId,
294    ) -> Maybe<Arc<PluginFileDiagnosticNotes>>;
295}
296
297/// Initializes the [`DefsGroup`] database to a proper state.
298pub fn init_defs_group(db: &mut dyn DefsGroup) {
299    db.set_macro_plugin_overrides(Arc::new(OrderedHashMap::default()));
300    db.set_inline_macro_plugin_overrides(Arc::new(OrderedHashMap::default()));
301}
302
303fn crate_macro_plugins(db: &dyn DefsGroup, crate_id: CrateId) -> Arc<[MacroPluginId]> {
304    db.macro_plugin_overrides()
305        .get(&crate_id)
306        .cloned()
307        .unwrap_or_else(|| db.default_macro_plugins())
308}
309
310fn crate_inline_macro_plugins(
311    db: &dyn DefsGroup,
312    crate_id: CrateId,
313) -> Arc<OrderedHashMap<String, InlineMacroExprPluginId>> {
314    db.inline_macro_plugin_overrides()
315        .get(&crate_id)
316        .cloned()
317        .unwrap_or_else(|| db.default_inline_macro_plugins())
318}
319
320fn allowed_attributes(db: &dyn DefsGroup, crate_id: CrateId) -> Arc<OrderedHashSet<String>> {
321    let base_attrs = [
322        INLINE_ATTR,
323        MUST_USE_ATTR,
324        UNSTABLE_ATTR,
325        DEPRECATED_ATTR,
326        INTERNAL_ATTR,
327        ALLOW_ATTR,
328        ALLOW_ATTR_ATTR,
329        FEATURE_ATTR,
330        PHANTOM_ATTR,
331        IMPLICIT_PRECEDENCE_ATTR,
332        FMT_SKIP_ATTR,
333        // TODO(orizi): Remove this once `starknet` is removed from corelib.
334        STARKNET_INTERFACE_ATTR,
335    ];
336
337    let crate_plugins = db.crate_macro_plugins(crate_id);
338
339    Arc::new(OrderedHashSet::from_iter(chain!(
340        base_attrs.map(|attr| attr.into()),
341        crate_plugins
342            .iter()
343            .flat_map(|plugin| db.lookup_intern_macro_plugin(*plugin).declared_attributes())
344    )))
345}
346
347fn allowed_statement_attributes(_db: &dyn DefsGroup) -> Arc<OrderedHashSet<String>> {
348    let all_attributes = [FMT_SKIP_ATTR, ALLOW_ATTR, FEATURE_ATTR];
349    Arc::new(OrderedHashSet::from_iter(all_attributes.map(|attr| attr.into())))
350}
351
352fn declared_derives(db: &dyn DefsGroup, crate_id: CrateId) -> Arc<OrderedHashSet<String>> {
353    Arc::new(OrderedHashSet::from_iter(
354        db.crate_macro_plugins(crate_id)
355            .iter()
356            .flat_map(|plugin| db.lookup_intern_macro_plugin(*plugin).declared_derives()),
357    ))
358}
359
360fn declared_phantom_type_attributes(
361    db: &dyn DefsGroup,
362    crate_id: CrateId,
363) -> Arc<OrderedHashSet<String>> {
364    let crate_plugins = db.crate_macro_plugins(crate_id);
365
366    Arc::new(OrderedHashSet::from_iter(chain!(
367        [PHANTOM_ATTR.into()],
368        crate_plugins
369            .iter()
370            .flat_map(|plugin| db.lookup_intern_macro_plugin(*plugin).phantom_type_attributes())
371    )))
372}
373
374fn is_submodule_inline(db: &dyn DefsGroup, submodule_id: SubmoduleId) -> bool {
375    match submodule_id.stable_ptr(db).lookup(db.upcast()).body(db.upcast()) {
376        MaybeModuleBody::Some(_) => true,
377        MaybeModuleBody::None(_) => false,
378    }
379}
380
381fn module_main_file(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<FileId> {
382    Ok(match module_id {
383        ModuleId::CrateRoot(crate_id) => {
384            db.crate_config(crate_id).to_maybe()?.root.file(db.upcast(), "lib.cairo".into())
385        }
386        ModuleId::Submodule(submodule_id) => {
387            let parent = submodule_id.parent_module(db);
388            if db.is_submodule_inline(submodule_id) {
389                // This is an inline module, we return the file where the inline module was
390                // defined. It can be either the file of the parent module
391                // or a plugin-generated virtual file.
392                db.module_file(submodule_id.module_file_id(db))?
393            } else {
394                let name = submodule_id.name(db);
395                db.module_dir(parent)?.file(db.upcast(), format!("{name}.cairo").into())
396            }
397        }
398    })
399}
400
401fn module_files(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[FileId]>> {
402    Ok(db.priv_module_data(module_id)?.files.into())
403}
404
405fn module_file(db: &dyn DefsGroup, module_file_id: ModuleFileId) -> Maybe<FileId> {
406    Ok(db.module_files(module_file_id.0)?[module_file_id.1.0])
407}
408
409fn module_dir(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Directory> {
410    match module_id {
411        ModuleId::CrateRoot(crate_id) => {
412            db.crate_config(crate_id).to_maybe().map(|config| config.root)
413        }
414        ModuleId::Submodule(submodule_id) => {
415            let parent = submodule_id.parent_module(db);
416            let name = submodule_id.name(db);
417            Ok(db.module_dir(parent)?.subdir(name))
418        }
419    }
420}
421
422/// Appends all the modules under the given module, including nested modules.
423fn collect_modules_under(db: &dyn DefsGroup, modules: &mut Vec<ModuleId>, module_id: ModuleId) {
424    modules.push(module_id);
425    if let Ok(submodule_ids) = db.module_submodules_ids(module_id) {
426        for submodule_module_id in submodule_ids.iter().copied() {
427            collect_modules_under(db, modules, ModuleId::Submodule(submodule_module_id));
428        }
429    }
430}
431
432/// Returns all the modules in the crate, including recursively.
433fn crate_modules(db: &dyn DefsGroup, crate_id: CrateId) -> Arc<[ModuleId]> {
434    let mut modules = Vec::new();
435    collect_modules_under(db, &mut modules, ModuleId::CrateRoot(crate_id));
436    modules.into()
437}
438
439fn priv_file_to_module_mapping(db: &dyn DefsGroup) -> Arc<OrderedHashMap<FileId, Vec<ModuleId>>> {
440    let mut mapping = OrderedHashMap::<FileId, Vec<ModuleId>>::default();
441    for crate_id in db.crates() {
442        for module_id in db.crate_modules(crate_id).iter().copied() {
443            if let Ok(files) = db.module_files(module_id) {
444                for file_id in files.iter().copied() {
445                    match mapping.get_mut(&file_id) {
446                        Some(file_modules) => {
447                            file_modules.push(module_id);
448                        }
449                        None => {
450                            mapping.insert(file_id, vec![module_id]);
451                        }
452                    }
453                }
454            }
455        }
456    }
457    mapping.into()
458}
459fn file_modules(db: &dyn DefsGroup, file_id: FileId) -> Maybe<Arc<[ModuleId]>> {
460    Ok(db.priv_file_to_module_mapping().get(&file_id).to_maybe()?.clone().into())
461}
462
463#[derive(Clone, Debug, PartialEq, Eq)]
464pub struct ModuleData {
465    /// The list of IDs of all items in the module. Each ID here is guaranteed to be a key in one
466    /// of the specific-item-kind maps.
467    items: Arc<[ModuleItemId]>,
468
469    // Specific-item-kind maps
470    constants: Arc<OrderedHashMap<ConstantId, ast::ItemConstant>>,
471    submodules: Arc<OrderedHashMap<SubmoduleId, ast::ItemModule>>,
472    uses: Arc<OrderedHashMap<UseId, ast::UsePathLeaf>>,
473    free_functions: Arc<OrderedHashMap<FreeFunctionId, ast::FunctionWithBody>>,
474    structs: Arc<OrderedHashMap<StructId, ast::ItemStruct>>,
475    enums: Arc<OrderedHashMap<EnumId, ast::ItemEnum>>,
476    type_aliases: Arc<OrderedHashMap<ModuleTypeAliasId, ast::ItemTypeAlias>>,
477    impl_aliases: Arc<OrderedHashMap<ImplAliasId, ast::ItemImplAlias>>,
478    traits: Arc<OrderedHashMap<TraitId, ast::ItemTrait>>,
479    impls: Arc<OrderedHashMap<ImplDefId, ast::ItemImpl>>,
480    extern_types: Arc<OrderedHashMap<ExternTypeId, ast::ItemExternType>>,
481    extern_functions: Arc<OrderedHashMap<ExternFunctionId, ast::ItemExternFunction>>,
482    global_uses: Arc<OrderedHashMap<GlobalUseId, ast::UsePathStar>>,
483
484    files: Vec<FileId>,
485    /// Generation info for each file. Virtual files have Some. Other files have None.
486    generated_file_aux_data: Vec<Option<DynGeneratedFileAuxData>>,
487    plugin_diagnostics: Vec<(ModuleFileId, PluginDiagnostic)>,
488    /// Diagnostic notes for diagnostics originating in the plugin generated files identified by
489    /// [`FileId`].
490    /// Diagnostic notes are added with `note: ` prefix at the end of diagnostic display.
491    diagnostics_notes: PluginFileDiagnosticNotes,
492}
493
494/// Information about generated files from running on a module file.
495#[derive(Clone, Debug, Eq, PartialEq)]
496pub struct PrivModuleSubFiles {
497    /// The files generated by plugins running on items.
498    files: OrderedHashMap<FileId, VirtualFile>,
499    /// The aux data per such file.
500    aux_data: Vec<Option<DynGeneratedFileAuxData>>,
501    /// The items not filtered out by plugins.
502    items: Vec<ast::ModuleItem>,
503    /// The diagnostics generated by the plugins.
504    plugin_diagnostics: Vec<PluginDiagnostic>,
505    /// Diagnostic notes for diagnostics originating in the plugin generated files identified by
506    /// [`FileId`].
507    /// Diagnostic notes are added with `note: ` prefix at the end of diagnostic display.
508    diagnostics_notes: PluginFileDiagnosticNotes,
509}
510
511fn priv_module_data(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<ModuleData> {
512    let syntax_db = db.upcast();
513    let module_file = db.module_main_file(module_id)?;
514    let main_file_aux_data = if let ModuleId::Submodule(submodule_id) = module_id {
515        let parent_module_data = db.priv_module_data(submodule_id.parent_module(db))?;
516        let item_module_ast = &parent_module_data.submodules[&submodule_id];
517        if matches!(item_module_ast.body(syntax_db), MaybeModuleBody::Some(_)) {
518            // TODO(spapini): Diagnostics in this module that get mapped to parent module
519            // should lie in that modules ModuleData, or somehow collected by its
520            // diagnostics collector function.
521
522            // If this is an inline module, copy its generation file info from the parent
523            // module, from the file where this submodule was defined.
524            parent_module_data
525                .generated_file_aux_data
526                .into_iter()
527                .nth(submodule_id.file_index(db).0)
528                .unwrap()
529        } else {
530            None
531        }
532    } else {
533        None
534    };
535    let mut file_queue = VecDeque::new();
536    file_queue.push_back(module_file);
537    let mut constants = OrderedHashMap::default();
538    let mut submodules = OrderedHashMap::default();
539    let mut uses = OrderedHashMap::default();
540    let mut free_functions = OrderedHashMap::default();
541    let mut structs = OrderedHashMap::default();
542    let mut enums = OrderedHashMap::default();
543    let mut type_aliases = OrderedHashMap::default();
544    let mut impl_aliases = OrderedHashMap::default();
545    let mut traits = OrderedHashMap::default();
546    let mut impls = OrderedHashMap::default();
547    let mut extern_types = OrderedHashMap::default();
548    let mut extern_functions = OrderedHashMap::default();
549    let mut global_uses = OrderedHashMap::default();
550    let mut aux_data = Vec::new();
551    let mut files = Vec::new();
552    let mut plugin_diagnostics = Vec::new();
553    let mut diagnostics_notes = OrderedHashMap::default();
554
555    let mut items = vec![];
556    aux_data.push(main_file_aux_data);
557    while let Some(file_id) = file_queue.pop_front() {
558        let file_index = FileIndex(files.len());
559        let module_file_id = ModuleFileId(module_id, file_index);
560        files.push(file_id);
561
562        let priv_module_data = db.priv_module_sub_files(module_id, file_id)?;
563        diagnostics_notes.extend(priv_module_data.diagnostics_notes.clone().into_iter());
564        file_queue.extend(priv_module_data.files.keys().copied());
565        for diag in &priv_module_data.plugin_diagnostics {
566            plugin_diagnostics.push((module_file_id, diag.clone()));
567        }
568        aux_data.extend(priv_module_data.aux_data.iter().cloned());
569        for item_ast in &priv_module_data.items {
570            match item_ast.clone() {
571                ast::ModuleItem::Constant(constant) => {
572                    let item_id = ConstantLongId(module_file_id, constant.stable_ptr()).intern(db);
573                    constants.insert(item_id, constant);
574                    items.push(ModuleItemId::Constant(item_id));
575                }
576                ast::ModuleItem::Module(module) => {
577                    let item_id = SubmoduleLongId(module_file_id, module.stable_ptr()).intern(db);
578                    submodules.insert(item_id, module);
579                    items.push(ModuleItemId::Submodule(item_id));
580                }
581                ast::ModuleItem::Use(us) => {
582                    for leaf in get_all_path_leaves(db.upcast(), &us) {
583                        let id = UseLongId(module_file_id, leaf.stable_ptr()).intern(db);
584                        uses.insert(id, leaf);
585                        items.push(ModuleItemId::Use(id));
586                    }
587                    for star in get_all_path_stars(db.upcast(), &us) {
588                        let id = GlobalUseLongId(module_file_id, star.stable_ptr()).intern(db);
589                        global_uses.insert(id, star);
590                    }
591                }
592                ast::ModuleItem::FreeFunction(function) => {
593                    let item_id =
594                        FreeFunctionLongId(module_file_id, function.stable_ptr()).intern(db);
595                    free_functions.insert(item_id, function);
596                    items.push(ModuleItemId::FreeFunction(item_id));
597                }
598                ast::ModuleItem::ExternFunction(extern_function) => {
599                    let item_id =
600                        ExternFunctionLongId(module_file_id, extern_function.stable_ptr())
601                            .intern(db);
602                    extern_functions.insert(item_id, extern_function);
603                    items.push(ModuleItemId::ExternFunction(item_id));
604                }
605                ast::ModuleItem::ExternType(extern_type) => {
606                    let item_id =
607                        ExternTypeLongId(module_file_id, extern_type.stable_ptr()).intern(db);
608                    extern_types.insert(item_id, extern_type);
609                    items.push(ModuleItemId::ExternType(item_id));
610                }
611                ast::ModuleItem::Trait(trt) => {
612                    let item_id = TraitLongId(module_file_id, trt.stable_ptr()).intern(db);
613                    traits.insert(item_id, trt);
614                    items.push(ModuleItemId::Trait(item_id));
615                }
616                ast::ModuleItem::Impl(imp) => {
617                    let item_id = ImplDefLongId(module_file_id, imp.stable_ptr()).intern(db);
618                    impls.insert(item_id, imp);
619                    items.push(ModuleItemId::Impl(item_id));
620                }
621                ast::ModuleItem::Struct(structure) => {
622                    let item_id = StructLongId(module_file_id, structure.stable_ptr()).intern(db);
623                    structs.insert(item_id, structure);
624                    items.push(ModuleItemId::Struct(item_id));
625                }
626                ast::ModuleItem::Enum(enm) => {
627                    let item_id = EnumLongId(module_file_id, enm.stable_ptr()).intern(db);
628                    enums.insert(item_id, enm);
629                    items.push(ModuleItemId::Enum(item_id));
630                }
631                ast::ModuleItem::TypeAlias(type_alias) => {
632                    let item_id =
633                        ModuleTypeAliasLongId(module_file_id, type_alias.stable_ptr()).intern(db);
634                    type_aliases.insert(item_id, type_alias);
635                    items.push(ModuleItemId::TypeAlias(item_id));
636                }
637                ast::ModuleItem::ImplAlias(impl_alias) => {
638                    let item_id =
639                        ImplAliasLongId(module_file_id, impl_alias.stable_ptr()).intern(db);
640                    impl_aliases.insert(item_id, impl_alias);
641                    items.push(ModuleItemId::ImplAlias(item_id));
642                }
643                ast::ModuleItem::InlineMacro(inline_macro_ast) => plugin_diagnostics.push((
644                    module_file_id,
645                    PluginDiagnostic::error(
646                        &inline_macro_ast,
647                        format!(
648                            "Unknown inline item macro: '{}'.",
649                            inline_macro_ast.name(db.upcast()).text(db.upcast())
650                        ),
651                    ),
652                )),
653                ast::ModuleItem::HeaderDoc(_) => {}
654                ast::ModuleItem::Missing(_) => {}
655            }
656        }
657    }
658    let res = ModuleData {
659        items: items.into(),
660        constants: constants.into(),
661        submodules: submodules.into(),
662        uses: uses.into(),
663        free_functions: free_functions.into(),
664        structs: structs.into(),
665        enums: enums.into(),
666        type_aliases: type_aliases.into(),
667        impl_aliases: impl_aliases.into(),
668        traits: traits.into(),
669        impls: impls.into(),
670        extern_types: extern_types.into(),
671        extern_functions: extern_functions.into(),
672        global_uses: global_uses.into(),
673        files,
674        generated_file_aux_data: aux_data,
675        plugin_diagnostics,
676        diagnostics_notes,
677    };
678    Ok(res)
679}
680
681/// Returns the `VirtualFile` matching the given external id.
682pub fn try_ext_as_virtual_impl(
683    db: &dyn DefsGroup,
684    external_id: salsa::InternId,
685) -> Option<VirtualFile> {
686    let long_id = PluginGeneratedFileId::from_intern_id(external_id).lookup_intern(db);
687    let file_id = FileLongId::External(external_id).intern(db);
688    let data = db
689        .priv_module_sub_files(long_id.module_id, long_id.stable_ptr.file_id(db.upcast()))
690        .unwrap();
691    data.files.get(&file_id).cloned()
692}
693
694fn priv_module_sub_files(
695    db: &dyn DefsGroup,
696    module_id: ModuleId,
697    file_id: FileId,
698) -> Maybe<Arc<PrivModuleSubFiles>> {
699    let syntax_db = db.upcast();
700    let module_main_file = db.module_main_file(module_id)?;
701    let file_syntax = db.file_module_syntax(file_id)?;
702    let item_asts = if module_main_file == file_id {
703        if let ModuleId::Submodule(submodule_id) = module_id {
704            let data = db.priv_module_data(submodule_id.parent_module(db))?;
705            if let MaybeModuleBody::Some(body) = data.submodules[&submodule_id].body(db.upcast()) {
706                Some(body.items(syntax_db))
707            } else {
708                None
709            }
710        } else {
711            None
712        }
713    } else {
714        None
715    }
716    .unwrap_or_else(|| file_syntax.items(syntax_db));
717
718    let crate_id = module_id.owning_crate(db);
719
720    let allowed_attributes = db.allowed_attributes(crate_id);
721    // TODO(orizi): Actually extract the allowed features per module.
722    let allowed_features = Default::default();
723
724    let cfg_set = db
725        .crate_config(crate_id)
726        .and_then(|cfg| cfg.settings.cfg_set.map(Arc::new))
727        .unwrap_or(db.cfg_set());
728    let edition = db
729        .crate_config(module_id.owning_crate(db))
730        .map(|cfg| cfg.settings.edition)
731        .unwrap_or_default();
732    let metadata = MacroPluginMetadata {
733        cfg_set: &cfg_set,
734        declared_derives: &db.declared_derives(crate_id),
735        allowed_features: &allowed_features,
736        edition,
737    };
738
739    let mut files = OrderedHashMap::<_, _>::default();
740    let mut aux_data = Vec::new();
741    let mut items = Vec::new();
742    let mut plugin_diagnostics = Vec::new();
743    let mut diagnostics_notes = OrderedHashMap::default();
744    for item_ast in item_asts.elements(syntax_db) {
745        let mut remove_original_item = false;
746        // Iterate the plugins by their order. The first one to change something (either
747        // generate new code, remove the original code, or both), breaks the loop. If more
748        // plugins might have act on the item, they can do it on the generated code.
749        for plugin_id in db.crate_macro_plugins(crate_id).iter() {
750            let plugin = db.lookup_intern_macro_plugin(*plugin_id);
751
752            let result = plugin.generate_code(db.upcast(), item_ast.clone(), &metadata);
753            plugin_diagnostics.extend(result.diagnostics);
754            if result.remove_original_item {
755                remove_original_item = true;
756            }
757
758            if let Some(generated) = result.code {
759                let generated_file_id = FileLongId::External(
760                    PluginGeneratedFileLongId {
761                        module_id,
762                        stable_ptr: item_ast.stable_ptr().untyped(),
763                        name: generated.name.clone(),
764                    }
765                    .intern(db)
766                    .as_intern_id(),
767                )
768                .intern(db);
769                if let Some(text) = generated.diagnostics_note {
770                    diagnostics_notes
771                        .insert(generated_file_id, DiagnosticNote { text, location: None });
772                }
773                files.insert(
774                    generated_file_id,
775                    VirtualFile {
776                        parent: Some(file_id),
777                        name: generated.name,
778                        content: generated.content.into(),
779                        code_mappings: generated.code_mappings.into(),
780                        kind: FileKind::Module,
781                    },
782                );
783                aux_data.push(generated.aux_data);
784            }
785            if remove_original_item {
786                break;
787            }
788        }
789        if remove_original_item {
790            // Don't add the original item to the module data.
791            continue;
792        }
793        validate_attributes(syntax_db, &allowed_attributes, &item_ast, &mut plugin_diagnostics);
794        items.push(item_ast);
795    }
796    let res = PrivModuleSubFiles { files, aux_data, items, plugin_diagnostics, diagnostics_notes };
797    Ok(res.into())
798}
799
800/// Collects attributes allowed by `allow_attr` attribute.
801fn collect_extra_allowed_attributes(
802    db: &dyn SyntaxGroup,
803    item: &impl QueryAttrs,
804    plugin_diagnostics: &mut Vec<PluginDiagnostic>,
805) -> OrderedHashSet<String> {
806    let mut extra_allowed_attributes = OrderedHashSet::default();
807    for attr in item.attributes_elements(db) {
808        if attr.attr(db).as_syntax_node().get_text_without_trivia(db) == ALLOW_ATTR_ATTR {
809            let args = attr.clone().structurize(db).args;
810            if args.is_empty() {
811                plugin_diagnostics.push(PluginDiagnostic::error(
812                    attr.stable_ptr(),
813                    "Expected arguments.".to_string(),
814                ));
815                continue;
816            }
817            for arg in args {
818                if let Some(ast::Expr::Path(path)) = try_extract_unnamed_arg(db, &arg.arg) {
819                    if let [ast::PathSegment::Simple(segment)] = &path.elements(db)[..] {
820                        extra_allowed_attributes.insert(segment.ident(db).text(db).into());
821                        continue;
822                    }
823                }
824                plugin_diagnostics.push(PluginDiagnostic::error(
825                    &arg.arg,
826                    "Expected simple identifier.".to_string(),
827                ));
828            }
829        }
830    }
831    extra_allowed_attributes
832}
833
834/// Validates that all attributes on the given item are in the allowed set or adds diagnostics.
835pub fn validate_attributes_flat(
836    db: &dyn SyntaxGroup,
837    allowed_attributes: &OrderedHashSet<String>,
838    extra_allowed_attributes: &OrderedHashSet<String>,
839    item: &impl QueryAttrs,
840    plugin_diagnostics: &mut Vec<PluginDiagnostic>,
841) {
842    let local_extra_attributes = collect_extra_allowed_attributes(db, item, plugin_diagnostics);
843    for attr in item.attributes_elements(db) {
844        let attr_text = attr.attr(db).as_syntax_node().get_text_without_trivia(db);
845        if !(allowed_attributes.contains(&attr_text)
846            || extra_allowed_attributes.contains(&attr_text)
847            || local_extra_attributes.contains(&attr_text))
848        {
849            plugin_diagnostics
850                .push(PluginDiagnostic::error(&attr, "Unsupported attribute.".to_string()));
851        }
852    }
853}
854
855/// Validates that all attributes on all items in the given element list are in the allowed set or
856/// adds diagnostics.
857fn validate_attributes_element_list<Item: QueryAttrs + TypedSyntaxNode, const STEP: usize>(
858    db: &dyn SyntaxGroup,
859    allowed_attributes: &OrderedHashSet<String>,
860    extra_allowed_attributes: &OrderedHashSet<String>,
861    items: &ElementList<Item, STEP>,
862    plugin_diagnostics: &mut Vec<PluginDiagnostic>,
863) {
864    for item in items.elements(db) {
865        validate_attributes_flat(
866            db,
867            allowed_attributes,
868            extra_allowed_attributes,
869            &item,
870            plugin_diagnostics,
871        );
872    }
873}
874
875/// Validates that all attributes on an item and on items contained within it are in the allowed set
876/// or adds diagnostics.
877fn validate_attributes(
878    db: &dyn SyntaxGroup,
879    allowed_attributes: &OrderedHashSet<String>,
880    item_ast: &ast::ModuleItem,
881    plugin_diagnostics: &mut Vec<PluginDiagnostic>,
882) {
883    let extra_allowed_attributes =
884        collect_extra_allowed_attributes(db, item_ast, plugin_diagnostics);
885    validate_attributes_flat(
886        db,
887        allowed_attributes,
888        &extra_allowed_attributes,
889        item_ast,
890        plugin_diagnostics,
891    );
892
893    match item_ast {
894        ast::ModuleItem::Trait(item) => {
895            if let ast::MaybeTraitBody::Some(body) = item.body(db) {
896                validate_attributes_element_list(
897                    db,
898                    allowed_attributes,
899                    &extra_allowed_attributes,
900                    &body.items(db),
901                    plugin_diagnostics,
902                );
903            }
904        }
905        ast::ModuleItem::Impl(item) => {
906            if let ast::MaybeImplBody::Some(body) = item.body(db) {
907                validate_attributes_element_list(
908                    db,
909                    allowed_attributes,
910                    &extra_allowed_attributes,
911                    &body.items(db),
912                    plugin_diagnostics,
913                );
914            }
915        }
916        ast::ModuleItem::Struct(item) => {
917            validate_attributes_element_list(
918                db,
919                allowed_attributes,
920                &extra_allowed_attributes,
921                &item.members(db),
922                plugin_diagnostics,
923            );
924        }
925        ast::ModuleItem::Enum(item) => {
926            validate_attributes_element_list(
927                db,
928                allowed_attributes,
929                &extra_allowed_attributes,
930                &item.variants(db),
931                plugin_diagnostics,
932            );
933        }
934        _ => {}
935    }
936}
937
938/// Returns all the path leaves under a given use item.
939pub fn get_all_path_leaves(db: &dyn SyntaxGroup, use_item: &ast::ItemUse) -> Vec<ast::UsePathLeaf> {
940    let mut res = vec![];
941    let mut stack = vec![use_item.use_path(db)];
942    while let Some(use_path) = stack.pop() {
943        match use_path {
944            ast::UsePath::Leaf(use_path) => res.push(use_path),
945            ast::UsePath::Single(use_path) => stack.push(use_path.use_path(db)),
946            ast::UsePath::Multi(use_path) => {
947                stack.extend(use_path.use_paths(db).elements(db).into_iter().rev())
948            }
949            ast::UsePath::Star(_) => {}
950        }
951    }
952    res
953}
954
955/// Returns all the path stars under a given use item.
956pub fn get_all_path_stars(db: &dyn SyntaxGroup, use_item: &ast::ItemUse) -> Vec<ast::UsePathStar> {
957    let mut res = vec![];
958    let mut stack = vec![use_item.use_path(db)];
959    while let Some(use_path) = stack.pop() {
960        match use_path {
961            ast::UsePath::Leaf(_) => {}
962            ast::UsePath::Single(use_path) => stack.push(use_path.use_path(db)),
963            ast::UsePath::Multi(use_path) => {
964                stack.extend(use_path.use_paths(db).elements(db).into_iter().rev())
965            }
966            ast::UsePath::Star(use_path) => res.push(use_path),
967        }
968    }
969    res
970}
971
972/// Returns all the constant definitions of the given module.
973pub fn module_constants(
974    db: &dyn DefsGroup,
975    module_id: ModuleId,
976) -> Maybe<Arc<OrderedHashMap<ConstantId, ast::ItemConstant>>> {
977    Ok(db.priv_module_data(module_id)?.constants)
978}
979pub fn module_constants_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[ConstantId]>> {
980    Ok(db.module_constants(module_id)?.keys().copied().collect_vec().into())
981}
982pub fn module_constant_by_id(
983    db: &dyn DefsGroup,
984    constant_id: ConstantId,
985) -> Maybe<Option<ast::ItemConstant>> {
986    let module_constants = db.module_constants(constant_id.module_file_id(db.upcast()).0)?;
987    Ok(module_constants.get(&constant_id).cloned())
988}
989
990/// Returns all the *direct* submodules of the given module - including those generated by macro
991/// plugins. To get all the submodules including nested modules, use [`collect_modules_under`].
992fn module_submodules(
993    db: &dyn DefsGroup,
994    module_id: ModuleId,
995) -> Maybe<Arc<OrderedHashMap<SubmoduleId, ast::ItemModule>>> {
996    Ok(db.priv_module_data(module_id)?.submodules)
997}
998fn module_submodules_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[SubmoduleId]>> {
999    Ok(db.module_submodules(module_id)?.keys().copied().collect_vec().into())
1000}
1001pub fn module_submodule_by_id(
1002    db: &dyn DefsGroup,
1003    submodule_id: SubmoduleId,
1004) -> Maybe<Option<ast::ItemModule>> {
1005    let module_submodules = db.module_submodules(submodule_id.module_file_id(db.upcast()).0)?;
1006    Ok(module_submodules.get(&submodule_id).cloned())
1007}
1008
1009/// Returns all the free functions of the given module.
1010pub fn module_free_functions(
1011    db: &dyn DefsGroup,
1012    module_id: ModuleId,
1013) -> Maybe<Arc<OrderedHashMap<FreeFunctionId, ast::FunctionWithBody>>> {
1014    Ok(db.priv_module_data(module_id)?.free_functions)
1015}
1016pub fn module_free_functions_ids(
1017    db: &dyn DefsGroup,
1018    module_id: ModuleId,
1019) -> Maybe<Arc<[FreeFunctionId]>> {
1020    Ok(db.module_free_functions(module_id)?.keys().copied().collect_vec().into())
1021}
1022pub fn module_free_function_by_id(
1023    db: &dyn DefsGroup,
1024    free_function_id: FreeFunctionId,
1025) -> Maybe<Option<ast::FunctionWithBody>> {
1026    let module_free_functions =
1027        db.module_free_functions(free_function_id.module_file_id(db.upcast()).0)?;
1028    Ok(module_free_functions.get(&free_function_id).cloned())
1029}
1030
1031/// Returns all the uses of the given module.
1032pub fn module_uses(
1033    db: &dyn DefsGroup,
1034    module_id: ModuleId,
1035) -> Maybe<Arc<OrderedHashMap<UseId, ast::UsePathLeaf>>> {
1036    Ok(db.priv_module_data(module_id)?.uses)
1037}
1038pub fn module_uses_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[UseId]>> {
1039    Ok(db.module_uses(module_id)?.keys().copied().collect_vec().into())
1040}
1041pub fn module_use_by_id(db: &dyn DefsGroup, use_id: UseId) -> Maybe<Option<ast::UsePathLeaf>> {
1042    let module_uses = db.module_uses(use_id.module_file_id(db.upcast()).0)?;
1043    Ok(module_uses.get(&use_id).cloned())
1044}
1045
1046/// Returns the `use *` of the given module, by its ID.
1047pub fn module_global_use_by_id(
1048    db: &dyn DefsGroup,
1049    global_use_id: GlobalUseId,
1050) -> Maybe<Option<ast::UsePathStar>> {
1051    let module_global_uses = db.module_global_uses(global_use_id.module_file_id(db.upcast()).0)?;
1052    Ok(module_global_uses.get(&global_use_id).cloned())
1053}
1054
1055/// Returns all the structs of the given module.
1056pub fn module_structs(
1057    db: &dyn DefsGroup,
1058    module_id: ModuleId,
1059) -> Maybe<Arc<OrderedHashMap<StructId, ast::ItemStruct>>> {
1060    Ok(db.priv_module_data(module_id)?.structs)
1061}
1062pub fn module_structs_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[StructId]>> {
1063    Ok(db.module_structs(module_id)?.keys().copied().collect_vec().into())
1064}
1065pub fn module_struct_by_id(
1066    db: &dyn DefsGroup,
1067    struct_id: StructId,
1068) -> Maybe<Option<ast::ItemStruct>> {
1069    let module_structs = db.module_structs(struct_id.module_file_id(db.upcast()).0)?;
1070    Ok(module_structs.get(&struct_id).cloned())
1071}
1072
1073/// Returns all the enums of the given module.
1074pub fn module_enums(
1075    db: &dyn DefsGroup,
1076    module_id: ModuleId,
1077) -> Maybe<Arc<OrderedHashMap<EnumId, ast::ItemEnum>>> {
1078    Ok(db.priv_module_data(module_id)?.enums)
1079}
1080pub fn module_enums_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[EnumId]>> {
1081    Ok(db.module_enums(module_id)?.keys().copied().collect_vec().into())
1082}
1083pub fn module_enum_by_id(db: &dyn DefsGroup, enum_id: EnumId) -> Maybe<Option<ast::ItemEnum>> {
1084    let module_enums = db.module_enums(enum_id.module_file_id(db.upcast()).0)?;
1085    Ok(module_enums.get(&enum_id).cloned())
1086}
1087
1088/// Returns all the type aliases of the given module.
1089pub fn module_type_aliases(
1090    db: &dyn DefsGroup,
1091    module_id: ModuleId,
1092) -> Maybe<Arc<OrderedHashMap<ModuleTypeAliasId, ast::ItemTypeAlias>>> {
1093    Ok(db.priv_module_data(module_id)?.type_aliases)
1094}
1095pub fn module_type_aliases_ids(
1096    db: &dyn DefsGroup,
1097    module_id: ModuleId,
1098) -> Maybe<Arc<[ModuleTypeAliasId]>> {
1099    Ok(db.module_type_aliases(module_id)?.keys().copied().collect_vec().into())
1100}
1101pub fn module_type_alias_by_id(
1102    db: &dyn DefsGroup,
1103    module_type_alias_id: ModuleTypeAliasId,
1104) -> Maybe<Option<ast::ItemTypeAlias>> {
1105    let module_type_aliases =
1106        db.module_type_aliases(module_type_alias_id.module_file_id(db.upcast()).0)?;
1107    Ok(module_type_aliases.get(&module_type_alias_id).cloned())
1108}
1109
1110/// Returns all the impl aliases of the given module.
1111pub fn module_impl_aliases(
1112    db: &dyn DefsGroup,
1113    module_id: ModuleId,
1114) -> Maybe<Arc<OrderedHashMap<ImplAliasId, ast::ItemImplAlias>>> {
1115    Ok(db.priv_module_data(module_id)?.impl_aliases)
1116}
1117pub fn module_impl_aliases_ids(
1118    db: &dyn DefsGroup,
1119    module_id: ModuleId,
1120) -> Maybe<Arc<[ImplAliasId]>> {
1121    Ok(db.module_impl_aliases(module_id)?.keys().copied().collect_vec().into())
1122}
1123pub fn module_impl_alias_by_id(
1124    db: &dyn DefsGroup,
1125    impl_alias_id: ImplAliasId,
1126) -> Maybe<Option<ast::ItemImplAlias>> {
1127    let module_impl_aliases =
1128        db.module_impl_aliases(impl_alias_id.module_file_id(db.upcast()).0)?;
1129    Ok(module_impl_aliases.get(&impl_alias_id).cloned())
1130}
1131
1132/// Returns all the traits of the given module.
1133pub fn module_traits(
1134    db: &dyn DefsGroup,
1135    module_id: ModuleId,
1136) -> Maybe<Arc<OrderedHashMap<TraitId, ast::ItemTrait>>> {
1137    Ok(db.priv_module_data(module_id)?.traits)
1138}
1139pub fn module_traits_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[TraitId]>> {
1140    Ok(db.module_traits(module_id)?.keys().copied().collect_vec().into())
1141}
1142pub fn module_trait_by_id(db: &dyn DefsGroup, trait_id: TraitId) -> Maybe<Option<ast::ItemTrait>> {
1143    let module_traits = db.module_traits(trait_id.module_file_id(db.upcast()).0)?;
1144    Ok(module_traits.get(&trait_id).cloned())
1145}
1146
1147/// Returns all the impls of the given module.
1148pub fn module_impls(
1149    db: &dyn DefsGroup,
1150    module_id: ModuleId,
1151) -> Maybe<Arc<OrderedHashMap<ImplDefId, ast::ItemImpl>>> {
1152    Ok(db.priv_module_data(module_id)?.impls)
1153}
1154pub fn module_impls_ids(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[ImplDefId]>> {
1155    Ok(db.module_impls(module_id)?.keys().copied().collect_vec().into())
1156}
1157pub fn module_impl_by_id(
1158    db: &dyn DefsGroup,
1159    impl_def_id: ImplDefId,
1160) -> Maybe<Option<ast::ItemImpl>> {
1161    let module_impls = db.module_impls(impl_def_id.module_file_id(db.upcast()).0)?;
1162    Ok(module_impls.get(&impl_def_id).cloned())
1163}
1164
1165/// Returns all the extern_types of the given module.
1166pub fn module_extern_types(
1167    db: &dyn DefsGroup,
1168    module_id: ModuleId,
1169) -> Maybe<Arc<OrderedHashMap<ExternTypeId, ast::ItemExternType>>> {
1170    Ok(db.priv_module_data(module_id)?.extern_types)
1171}
1172pub fn module_extern_types_ids(
1173    db: &dyn DefsGroup,
1174    module_id: ModuleId,
1175) -> Maybe<Arc<[ExternTypeId]>> {
1176    Ok(db.module_extern_types(module_id)?.keys().copied().collect_vec().into())
1177}
1178pub fn module_extern_type_by_id(
1179    db: &dyn DefsGroup,
1180    extern_type_id: ExternTypeId,
1181) -> Maybe<Option<ast::ItemExternType>> {
1182    let module_extern_types =
1183        db.module_extern_types(extern_type_id.module_file_id(db.upcast()).0)?;
1184    Ok(module_extern_types.get(&extern_type_id).cloned())
1185}
1186
1187/// Returns all the extern_functions of the given module.
1188pub fn module_extern_functions(
1189    db: &dyn DefsGroup,
1190    module_id: ModuleId,
1191) -> Maybe<Arc<OrderedHashMap<ExternFunctionId, ast::ItemExternFunction>>> {
1192    Ok(db.priv_module_data(module_id)?.extern_functions)
1193}
1194pub fn module_extern_functions_ids(
1195    db: &dyn DefsGroup,
1196    module_id: ModuleId,
1197) -> Maybe<Arc<[ExternFunctionId]>> {
1198    Ok(db.module_extern_functions(module_id)?.keys().copied().collect_vec().into())
1199}
1200pub fn module_extern_function_by_id(
1201    db: &dyn DefsGroup,
1202    extern_function_id: ExternFunctionId,
1203) -> Maybe<Option<ast::ItemExternFunction>> {
1204    let module_extern_functions =
1205        db.module_extern_functions(extern_function_id.module_file_id(db.upcast()).0)?;
1206    Ok(module_extern_functions.get(&extern_function_id).cloned())
1207}
1208
1209pub fn module_ancestors(db: &dyn DefsGroup, module_id: ModuleId) -> OrderedHashSet<ModuleId> {
1210    let mut current = module_id;
1211    let mut ancestors = OrderedHashSet::default();
1212    while let ModuleId::Submodule(submodule_id) = current {
1213        let parent = submodule_id.parent_module(db);
1214        ancestors.insert(parent);
1215        current = parent
1216    }
1217    ancestors
1218}
1219
1220/// Returns the generated_file_infos of the given module.
1221pub fn module_generated_file_aux_data(
1222    db: &dyn DefsGroup,
1223    module_id: ModuleId,
1224) -> Maybe<Arc<[Option<DynGeneratedFileAuxData>]>> {
1225    Ok(db.priv_module_data(module_id)?.generated_file_aux_data.into())
1226}
1227
1228/// Returns all the plugin diagnostics of the given module.
1229pub fn module_plugin_diagnostics(
1230    db: &dyn DefsGroup,
1231    module_id: ModuleId,
1232) -> Maybe<Arc<[(ModuleFileId, PluginDiagnostic)]>> {
1233    Ok(db.priv_module_data(module_id)?.plugin_diagnostics.into())
1234}
1235
1236/// Diagnostic notes for diagnostics originating in the plugin generated files identified by
1237/// [`FileId`].
1238pub fn module_plugin_diagnostics_notes(
1239    db: &dyn DefsGroup,
1240    module_id: ModuleId,
1241) -> Maybe<Arc<PluginFileDiagnosticNotes>> {
1242    Ok(db.priv_module_data(module_id)?.diagnostics_notes.into())
1243}
1244
1245fn module_items(db: &dyn DefsGroup, module_id: ModuleId) -> Maybe<Arc<[ModuleItemId]>> {
1246    Ok(db.priv_module_data(module_id)?.items)
1247}
1248
1249fn module_global_uses(
1250    db: &dyn DefsGroup,
1251    module_id: ModuleId,
1252) -> Maybe<Arc<OrderedHashMap<GlobalUseId, ast::UsePathStar>>> {
1253    Ok(db.priv_module_data(module_id)?.global_uses)
1254}
1255
1256fn module_item_name_stable_ptr(
1257    db: &dyn DefsGroup,
1258    module_id: ModuleId,
1259    item_id: ModuleItemId,
1260) -> Maybe<SyntaxStablePtrId> {
1261    let data = db.priv_module_data(module_id)?;
1262    let db = db.upcast();
1263    Ok(match &item_id {
1264        ModuleItemId::Constant(id) => data.constants[id].name(db).stable_ptr().untyped(),
1265        ModuleItemId::Submodule(id) => data.submodules[id].name(db).stable_ptr().untyped(),
1266        ModuleItemId::Use(id) => data.uses[id].name_stable_ptr(db),
1267        ModuleItemId::FreeFunction(id) => {
1268            data.free_functions[id].declaration(db).name(db).stable_ptr().untyped()
1269        }
1270        ModuleItemId::Struct(id) => data.structs[id].name(db).stable_ptr().untyped(),
1271        ModuleItemId::Enum(id) => data.enums[id].name(db).stable_ptr().untyped(),
1272        ModuleItemId::TypeAlias(id) => data.type_aliases[id].name(db).stable_ptr().untyped(),
1273        ModuleItemId::ImplAlias(id) => data.impl_aliases[id].name(db).stable_ptr().untyped(),
1274        ModuleItemId::Trait(id) => data.traits[id].name(db).stable_ptr().untyped(),
1275        ModuleItemId::Impl(id) => data.impls[id].name(db).stable_ptr().untyped(),
1276        ModuleItemId::ExternType(id) => data.extern_types[id].name(db).stable_ptr().untyped(),
1277        ModuleItemId::ExternFunction(id) => {
1278            data.extern_functions[id].declaration(db).name(db).stable_ptr().untyped()
1279        }
1280    })
1281}
1282
1283pub trait DefsGroupEx: DefsGroup {
1284    /// Overrides the default macro plugins available for [`CrateId`] with `plugins`.
1285    ///
1286    /// *Note*: Sets the following Salsa input: `DefsGroup::macro_plugin_overrides`.
1287    fn set_override_crate_macro_plugins(
1288        &mut self,
1289        crate_id: CrateId,
1290        plugins: Arc<[MacroPluginId]>,
1291    ) {
1292        let mut overrides = self.macro_plugin_overrides().as_ref().clone();
1293        overrides.insert(crate_id, plugins);
1294        self.set_macro_plugin_overrides(Arc::new(overrides));
1295    }
1296
1297    /// Overrides the default inline macro plugins available for [`CrateId`] with `plugins`.
1298    ///
1299    /// *Note*: Sets the following Salsa input: `DefsGroup::inline_macro_plugin_overrides`.
1300    fn set_override_crate_inline_macro_plugins(
1301        &mut self,
1302        crate_id: CrateId,
1303        plugins: Arc<OrderedHashMap<String, InlineMacroExprPluginId>>,
1304    ) {
1305        let mut overrides = self.inline_macro_plugin_overrides().as_ref().clone();
1306        overrides.insert(crate_id, plugins);
1307        self.set_inline_macro_plugin_overrides(Arc::new(overrides));
1308    }
1309}
1310
1311impl<T: DefsGroup + ?Sized> DefsGroupEx for T {}
cairo_lang_defs/db.rs

cairo_lang_defs/
db.rs
