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 attr::AttrId, db::DefDatabase, per_ns::PerNs, visibility::Visibility, AdtId, BuiltinType,
16 ConstId, ImplId, 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>,
64 derive_macros: FxHashMap<AstId<ast::Item>, (AttrId, MacroCallId)>,
67 pub(crate) static BUILTIN_SCOPE: Lazy<FxHashMap<Name, PerNs>> = Lazy::new(|| {
70 .map(|(name, ty)| (name.clone(), PerNs::types((*ty).into(), Visibility::Public)))
74 /// Shadow mode for builtin type which can be shadowed by module.
75 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
76 pub(crate) enum BuiltinShadowMode {
77 /// Prefer user-defined modules (or other types) over builtins.
79 /// Prefer builtins over user-defined modules (but not other types).
83 /// Legacy macros can only be accessed through special methods like `get_legacy_macros`.
84 /// Other methods will only resolve values, types and module scoped macros only.
86 pub fn entries<'a>(&'a self) -> impl Iterator<Item = (&'a Name, PerNs)> + 'a {
88 let keys: FxHashSet<_> = self
91 .chain(self.values.keys())
92 .chain(self.macros.keys())
93 .chain(self.unresolved.iter())
96 keys.into_iter().map(move |name| (name, self.get(name)))
99 pub fn declarations(&self) -> impl Iterator<Item = ModuleDefId> + '_ {
100 self.declarations.iter().copied()
103 pub fn impls(&self) -> impl Iterator<Item = ImplId> + ExactSizeIterator + '_ {
104 self.impls.iter().copied()
109 ) -> impl Iterator<Item = (ModuleDefId, Visibility)> + ExactSizeIterator + '_ {
110 self.values.values().copied()
113 pub fn unnamed_consts(&self) -> impl Iterator<Item = ConstId> + '_ {
114 self.unnamed_consts.iter().copied()
117 /// Iterate over all module scoped macros
118 pub(crate) fn macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
119 self.entries().filter_map(|(name, def)| def.take_macros().map(|macro_| (name, macro_)))
122 /// Iterate over all legacy textual scoped macros visible at the end of the module
123 pub(crate) fn legacy_macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
124 self.legacy_macros.iter().map(|(name, def)| (name, *def))
127 /// Get a name from current module scope, legacy macros are not included
128 pub(crate) fn get(&self, name: &Name) -> PerNs {
130 types: self.types.get(name).copied(),
131 values: self.values.get(name).copied(),
132 macros: self.macros.get(name).copied(),
136 /// XXX: this is O(N) rather than O(1), try to not introduce new usages.
137 pub(crate) fn name_of(&self, item: ItemInNs) -> Option<(&Name, Visibility)> {
138 for (name, per_ns) in self.entries() {
139 if let Some(vis) = item.match_with(per_ns) {
140 return Some((name, vis));
146 pub(crate) fn traits<'a>(&'a self) -> impl Iterator<Item = TraitId> + 'a {
149 .filter_map(|(def, _)| match def {
150 ModuleDefId::TraitId(t) => Some(*t),
153 .chain(self.unnamed_trait_imports.keys().copied())
156 pub(crate) fn declare(&mut self, def: ModuleDefId) {
157 self.declarations.push(def)
160 pub(crate) fn get_legacy_macro(&self, name: &Name) -> Option<MacroDefId> {
161 self.legacy_macros.get(name).copied()
164 pub(crate) fn define_impl(&mut self, imp: ImplId) {
168 pub(crate) fn define_unnamed_const(&mut self, konst: ConstId) {
169 self.unnamed_consts.push(konst);
172 pub(crate) fn define_legacy_macro(&mut self, name: Name, mac: MacroDefId) {
173 self.legacy_macros.insert(name, mac);
176 pub(crate) fn add_attr_macro_invoc(&mut self, item: AstId<ast::Item>, call: MacroCallId) {
177 self.attr_macros.insert(item, call);
180 pub(crate) fn attr_macro_invocs(
182 ) -> impl Iterator<Item = (AstId<ast::Item>, MacroCallId)> + '_ {
183 self.attr_macros.iter().map(|(k, v)| (*k, *v))
186 pub(crate) fn add_derive_macro_invoc(
188 item: AstId<ast::Item>,
192 self.derive_macros.insert(item, (attr_id, call));
195 pub(crate) fn derive_macro_invocs(
197 ) -> impl Iterator<Item = (AstId<ast::Item>, (AttrId, MacroCallId))> + '_ {
198 self.derive_macros.iter().map(|(k, v)| (*k, *v))
201 pub(crate) fn unnamed_trait_vis(&self, tr: TraitId) -> Option<Visibility> {
202 self.unnamed_trait_imports.get(&tr).copied()
205 pub(crate) fn push_unnamed_trait(&mut self, tr: TraitId, vis: Visibility) {
206 self.unnamed_trait_imports.insert(tr, vis);
209 pub(crate) fn push_res_with_import(
211 glob_imports: &mut PerNsGlobImports,
212 lookup: (LocalModuleId, Name),
214 def_import_type: ImportType,
216 let mut changed = false;
218 macro_rules! check_changed {
221 ( $this:ident / $def:ident ) . $field:ident,
222 $glob_imports:ident [ $lookup:ident ],
223 $def_import_type:ident
225 let existing = $this.$field.entry($lookup.1.clone());
226 match (existing, $def.$field) {
227 (Entry::Vacant(entry), Some(_)) => {
228 match $def_import_type {
229 ImportType::Glob => {
230 $glob_imports.$field.insert($lookup.clone());
232 ImportType::Named => {
233 $glob_imports.$field.remove(&$lookup);
237 if let Some(fld) = $def.$field {
242 (Entry::Occupied(mut entry), Some(_))
243 if $glob_imports.$field.contains(&$lookup)
244 && matches!($def_import_type, ImportType::Named) =>
246 cov_mark::hit!(import_shadowed);
247 $glob_imports.$field.remove(&$lookup);
248 if let Some(fld) = $def.$field {
258 check_changed!(changed, (self / def).types, glob_imports[lookup], def_import_type);
259 check_changed!(changed, (self / def).values, glob_imports[lookup], def_import_type);
260 check_changed!(changed, (self / def).macros, glob_imports[lookup], def_import_type);
262 if def.is_none() && self.unresolved.insert(lookup.1) {
269 pub(crate) fn resolutions<'a>(&'a self) -> impl Iterator<Item = (Option<Name>, PerNs)> + 'a {
270 self.entries().map(|(name, res)| (Some(name.clone()), res)).chain(
271 self.unnamed_trait_imports
273 .map(|(tr, vis)| (None, PerNs::types(ModuleDefId::TraitId(*tr), *vis))),
277 pub(crate) fn collect_legacy_macros(&self) -> FxHashMap<Name, MacroDefId> {
278 self.legacy_macros.clone()
281 /// Marks everything that is not a procedural macro as private to `this_module`.
282 pub(crate) fn censor_non_proc_macros(&mut self, this_module: ModuleId) {
285 .chain(self.values.values_mut())
287 .chain(self.unnamed_trait_imports.values_mut())
288 .for_each(|vis| *vis = Visibility::Module(this_module));
290 for (mac, vis) in self.macros.values_mut() {
291 if let MacroDefKind::ProcMacro(..) = mac.kind {
292 // FIXME: Technically this is insufficient since reexports of proc macros are also
293 // forbidden. Practically nobody does that.
297 *vis = Visibility::Module(this_module);
301 pub(crate) fn dump(&self, buf: &mut String) {
302 let mut entries: Vec<_> = self.resolutions().collect();
303 entries.sort_by_key(|(name, _)| name.clone());
305 for (name, def) in entries {
306 format_to!(buf, "{}:", name.map_or("_".to_string(), |name| name.to_string()));
308 if def.types.is_some() {
311 if def.values.is_some() {
314 if def.macros.is_some() {
325 pub(crate) fn shrink_to_fit(&mut self) {
326 // Exhaustive match to require handling new fields.
336 unnamed_trait_imports,
341 types.shrink_to_fit();
342 values.shrink_to_fit();
343 macros.shrink_to_fit();
344 unresolved.shrink_to_fit();
345 defs.shrink_to_fit();
346 impls.shrink_to_fit();
347 unnamed_consts.shrink_to_fit();
348 unnamed_trait_imports.shrink_to_fit();
349 legacy_macros.shrink_to_fit();
350 attr_macros.shrink_to_fit();
351 derive_macros.shrink_to_fit();
356 pub(crate) fn from_def(def: ModuleDefId, v: Visibility, has_constructor: bool) -> PerNs {
358 ModuleDefId::ModuleId(_) => PerNs::types(def, v),
359 ModuleDefId::FunctionId(_) => PerNs::values(def, v),
360 ModuleDefId::AdtId(adt) => match adt {
361 AdtId::UnionId(_) => PerNs::types(def, v),
362 AdtId::EnumId(_) => PerNs::types(def, v),
363 AdtId::StructId(_) => {
365 PerNs::both(def, def, v)
371 ModuleDefId::EnumVariantId(_) => PerNs::both(def, def, v),
372 ModuleDefId::ConstId(_) | ModuleDefId::StaticId(_) => PerNs::values(def, v),
373 ModuleDefId::TraitId(_) => PerNs::types(def, v),
374 ModuleDefId::TypeAliasId(_) => PerNs::types(def, v),
375 ModuleDefId::BuiltinType(_) => PerNs::types(def, v),
380 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
388 fn match_with(self, per_ns: PerNs) -> Option<Visibility> {
390 ItemInNs::Types(def) => {
391 per_ns.types.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
393 ItemInNs::Values(def) => {
394 per_ns.values.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
396 ItemInNs::Macros(def) => {
397 per_ns.macros.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
402 pub fn as_module_def_id(self) -> Option<ModuleDefId> {
404 ItemInNs::Types(id) | ItemInNs::Values(id) => Some(id),
405 ItemInNs::Macros(_) => None,
409 /// Returns the crate defining this item (or `None` if `self` is built-in).
410 pub fn krate(&self, db: &dyn DefDatabase) -> Option<CrateId> {
412 ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate),
413 ItemInNs::Macros(id) => Some(id.krate),