1 //! Describes items defined or visible (ie, imported) in a certain scope.
2 //! This is shared between modules and blocks.
4 use std::collections::hash_map::Entry;
7 use hir_expand::{name::Name, AstId, MacroCallId, MacroDefKind};
8 use once_cell::sync::Lazy;
10 use rustc_hash::{FxHashMap, FxHashSet};
15 db::DefDatabase, per_ns::PerNs, visibility::Visibility, AdtId, BuiltinType, ConstId, ImplId,
16 LocalModuleId, MacroDefId, ModuleDefId, ModuleId, TraitId,
19 #[derive(Copy, Clone)]
20 pub(crate) enum ImportType {
25 #[derive(Debug, Default)]
26 pub struct PerNsGlobImports {
27 types: FxHashSet<(LocalModuleId, Name)>,
28 values: FxHashSet<(LocalModuleId, Name)>,
29 macros: FxHashSet<(LocalModuleId, Name)>,
32 #[derive(Debug, Default, PartialEq, Eq)]
33 pub struct ItemScope {
36 /// Defs visible in this scope. This includes `declarations`, but also
38 types: FxHashMap<Name, (ModuleDefId, Visibility)>,
39 values: FxHashMap<Name, (ModuleDefId, Visibility)>,
40 macros: FxHashMap<Name, (MacroDefId, Visibility)>,
41 unresolved: FxHashSet<Name>,
43 /// The defs declared in this scope. Each def has a single scope where it is
45 declarations: Vec<ModuleDefId>,
47 unnamed_consts: Vec<ConstId>,
48 /// Traits imported via `use Trait as _;`.
49 unnamed_trait_imports: FxHashMap<TraitId, Visibility>,
50 /// Macros visible in current module in legacy textual scope
52 /// For macros invoked by an unqualified identifier like `bar!()`, `legacy_macros` will be searched in first.
53 /// If it yields no result, then it turns to module scoped `macros`.
54 /// It macros with name qualified with a path like `crate::foo::bar!()`, `legacy_macros` will be skipped,
55 /// and only normal scoped `macros` will be searched in.
57 /// Note that this automatically inherit macros defined textually before the definition of module itself.
59 /// Module scoped macros will be inserted into `items` instead of here.
60 // FIXME: Macro shadowing in one module is not properly handled. Non-item place macros will
61 // be all resolved to the last one defined if shadowing happens.
62 legacy_macros: FxHashMap<Name, MacroDefId>,
63 attr_macros: FxHashMap<AstId<ast::Item>, MacroCallId>,
66 pub(crate) static BUILTIN_SCOPE: Lazy<FxHashMap<Name, PerNs>> = Lazy::new(|| {
69 .map(|(name, ty)| (name.clone(), PerNs::types((*ty).into(), Visibility::Public)))
73 /// Shadow mode for builtin type which can be shadowed by module.
74 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
75 pub(crate) enum BuiltinShadowMode {
76 /// Prefer user-defined modules (or other types) over builtins.
78 /// Prefer builtins over user-defined modules (but not other types).
82 /// Legacy macros can only be accessed through special methods like `get_legacy_macros`.
83 /// Other methods will only resolve values, types and module scoped macros only.
85 pub fn entries<'a>(&'a self) -> impl Iterator<Item = (&'a Name, PerNs)> + 'a {
87 let keys: FxHashSet<_> = self
90 .chain(self.values.keys())
91 .chain(self.macros.keys())
92 .chain(self.unresolved.iter())
95 keys.into_iter().map(move |name| (name, self.get(name)))
98 pub fn declarations(&self) -> impl Iterator<Item = ModuleDefId> + '_ {
99 self.declarations.iter().copied()
102 pub fn impls(&self) -> impl Iterator<Item = ImplId> + ExactSizeIterator + '_ {
103 self.impls.iter().copied()
108 ) -> impl Iterator<Item = (ModuleDefId, Visibility)> + ExactSizeIterator + '_ {
109 self.values.values().copied()
112 pub fn unnamed_consts(&self) -> impl Iterator<Item = ConstId> + '_ {
113 self.unnamed_consts.iter().copied()
116 /// Iterate over all module scoped macros
117 pub(crate) fn macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
118 self.entries().filter_map(|(name, def)| def.take_macros().map(|macro_| (name, macro_)))
121 /// Iterate over all legacy textual scoped macros visible at the end of the module
122 pub(crate) fn legacy_macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
123 self.legacy_macros.iter().map(|(name, def)| (name, *def))
126 /// Get a name from current module scope, legacy macros are not included
127 pub(crate) fn get(&self, name: &Name) -> PerNs {
129 types: self.types.get(name).copied(),
130 values: self.values.get(name).copied(),
131 macros: self.macros.get(name).copied(),
135 /// XXX: this is O(N) rather than O(1), try to not introduce new usages.
136 pub(crate) fn name_of(&self, item: ItemInNs) -> Option<(&Name, Visibility)> {
137 for (name, per_ns) in self.entries() {
138 if let Some(vis) = item.match_with(per_ns) {
139 return Some((name, vis));
145 pub(crate) fn traits<'a>(&'a self) -> impl Iterator<Item = TraitId> + 'a {
148 .filter_map(|(def, _)| match def {
149 ModuleDefId::TraitId(t) => Some(*t),
152 .chain(self.unnamed_trait_imports.keys().copied())
155 pub(crate) fn declare(&mut self, def: ModuleDefId) {
156 self.declarations.push(def)
159 pub(crate) fn get_legacy_macro(&self, name: &Name) -> Option<MacroDefId> {
160 self.legacy_macros.get(name).copied()
163 pub(crate) fn define_impl(&mut self, imp: ImplId) {
167 pub(crate) fn define_unnamed_const(&mut self, konst: ConstId) {
168 self.unnamed_consts.push(konst);
171 pub(crate) fn define_legacy_macro(&mut self, name: Name, mac: MacroDefId) {
172 self.legacy_macros.insert(name, mac);
175 pub(crate) fn add_attr_macro_invoc(&mut self, item: AstId<ast::Item>, call: MacroCallId) {
176 self.attr_macros.insert(item, call);
179 pub(crate) fn attr_macro_invocs(
181 ) -> impl Iterator<Item = (AstId<ast::Item>, MacroCallId)> + '_ {
182 self.attr_macros.iter().map(|(k, v)| (*k, *v))
185 pub(crate) fn unnamed_trait_vis(&self, tr: TraitId) -> Option<Visibility> {
186 self.unnamed_trait_imports.get(&tr).copied()
189 pub(crate) fn push_unnamed_trait(&mut self, tr: TraitId, vis: Visibility) {
190 self.unnamed_trait_imports.insert(tr, vis);
193 pub(crate) fn push_res_with_import(
195 glob_imports: &mut PerNsGlobImports,
196 lookup: (LocalModuleId, Name),
198 def_import_type: ImportType,
200 let mut changed = false;
202 macro_rules! check_changed {
205 ( $this:ident / $def:ident ) . $field:ident,
206 $glob_imports:ident [ $lookup:ident ],
207 $def_import_type:ident
209 let existing = $this.$field.entry($lookup.1.clone());
210 match (existing, $def.$field) {
211 (Entry::Vacant(entry), Some(_)) => {
212 match $def_import_type {
213 ImportType::Glob => {
214 $glob_imports.$field.insert($lookup.clone());
216 ImportType::Named => {
217 $glob_imports.$field.remove(&$lookup);
221 if let Some(fld) = $def.$field {
226 (Entry::Occupied(mut entry), Some(_))
227 if $glob_imports.$field.contains(&$lookup)
228 && matches!($def_import_type, ImportType::Named) =>
230 cov_mark::hit!(import_shadowed);
231 $glob_imports.$field.remove(&$lookup);
232 if let Some(fld) = $def.$field {
242 check_changed!(changed, (self / def).types, glob_imports[lookup], def_import_type);
243 check_changed!(changed, (self / def).values, glob_imports[lookup], def_import_type);
244 check_changed!(changed, (self / def).macros, glob_imports[lookup], def_import_type);
246 if def.is_none() && self.unresolved.insert(lookup.1) {
253 pub(crate) fn resolutions<'a>(&'a self) -> impl Iterator<Item = (Option<Name>, PerNs)> + 'a {
254 self.entries().map(|(name, res)| (Some(name.clone()), res)).chain(
255 self.unnamed_trait_imports
257 .map(|(tr, vis)| (None, PerNs::types(ModuleDefId::TraitId(*tr), *vis))),
261 pub(crate) fn collect_legacy_macros(&self) -> FxHashMap<Name, MacroDefId> {
262 self.legacy_macros.clone()
265 /// Marks everything that is not a procedural macro as private to `this_module`.
266 pub(crate) fn censor_non_proc_macros(&mut self, this_module: ModuleId) {
269 .chain(self.values.values_mut())
271 .chain(self.unnamed_trait_imports.values_mut())
272 .for_each(|vis| *vis = Visibility::Module(this_module));
274 for (mac, vis) in self.macros.values_mut() {
275 if let MacroDefKind::ProcMacro(..) = mac.kind {
276 // FIXME: Technically this is insufficient since reexports of proc macros are also
277 // forbidden. Practically nobody does that.
281 *vis = Visibility::Module(this_module);
285 pub(crate) fn dump(&self, buf: &mut String) {
286 let mut entries: Vec<_> = self.resolutions().collect();
287 entries.sort_by_key(|(name, _)| name.clone());
289 for (name, def) in entries {
290 format_to!(buf, "{}:", name.map_or("_".to_string(), |name| name.to_string()));
292 if def.types.is_some() {
295 if def.values.is_some() {
298 if def.macros.is_some() {
309 pub(crate) fn shrink_to_fit(&mut self) {
310 // Exhaustive match to require handling new fields.
320 unnamed_trait_imports,
324 types.shrink_to_fit();
325 values.shrink_to_fit();
326 macros.shrink_to_fit();
327 unresolved.shrink_to_fit();
328 defs.shrink_to_fit();
329 impls.shrink_to_fit();
330 unnamed_consts.shrink_to_fit();
331 unnamed_trait_imports.shrink_to_fit();
332 legacy_macros.shrink_to_fit();
333 attr_macros.shrink_to_fit();
338 pub(crate) fn from_def(def: ModuleDefId, v: Visibility, has_constructor: bool) -> PerNs {
340 ModuleDefId::ModuleId(_) => PerNs::types(def, v),
341 ModuleDefId::FunctionId(_) => PerNs::values(def, v),
342 ModuleDefId::AdtId(adt) => match adt {
343 AdtId::UnionId(_) => PerNs::types(def, v),
344 AdtId::EnumId(_) => PerNs::types(def, v),
345 AdtId::StructId(_) => {
347 PerNs::both(def, def, v)
353 ModuleDefId::EnumVariantId(_) => PerNs::both(def, def, v),
354 ModuleDefId::ConstId(_) | ModuleDefId::StaticId(_) => PerNs::values(def, v),
355 ModuleDefId::TraitId(_) => PerNs::types(def, v),
356 ModuleDefId::TypeAliasId(_) => PerNs::types(def, v),
357 ModuleDefId::BuiltinType(_) => PerNs::types(def, v),
362 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
370 fn match_with(self, per_ns: PerNs) -> Option<Visibility> {
372 ItemInNs::Types(def) => {
373 per_ns.types.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
375 ItemInNs::Values(def) => {
376 per_ns.values.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
378 ItemInNs::Macros(def) => {
379 per_ns.macros.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
384 pub fn as_module_def_id(self) -> Option<ModuleDefId> {
386 ItemInNs::Types(id) | ItemInNs::Values(id) => Some(id),
387 ItemInNs::Macros(_) => None,
391 /// Returns the crate defining this item (or `None` if `self` is built-in).
392 pub fn krate(&self, db: &dyn DefDatabase) -> Option<CrateId> {
394 ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate),
395 ItemInNs::Macros(id) => Some(id.krate),