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;
8 use hir_expand::MacroDefKind;
9 use once_cell::sync::Lazy;
10 use rustc_hash::{FxHashMap, FxHashSet};
14 db::DefDatabase, per_ns::PerNs, visibility::Visibility, AdtId, BuiltinType, ImplId,
15 LocalModuleId, MacroDefId, ModuleDefId, ModuleId, TraitId,
18 #[derive(Copy, Clone)]
19 pub(crate) enum ImportType {
24 #[derive(Debug, Default)]
25 pub struct PerNsGlobImports {
26 types: FxHashSet<(LocalModuleId, Name)>,
27 values: FxHashSet<(LocalModuleId, Name)>,
28 macros: FxHashSet<(LocalModuleId, Name)>,
31 #[derive(Debug, Default, PartialEq, Eq)]
32 pub struct ItemScope {
33 types: FxHashMap<Name, (ModuleDefId, Visibility)>,
34 values: FxHashMap<Name, (ModuleDefId, Visibility)>,
35 macros: FxHashMap<Name, (MacroDefId, Visibility)>,
36 unresolved: FxHashSet<Name>,
38 defs: Vec<ModuleDefId>,
40 /// Traits imported via `use Trait as _;`.
41 unnamed_trait_imports: FxHashMap<TraitId, Visibility>,
42 /// Macros visible in current module in legacy textual scope
44 /// For macros invoked by an unqualified identifier like `bar!()`, `legacy_macros` will be searched in first.
45 /// If it yields no result, then it turns to module scoped `macros`.
46 /// It macros with name qualified with a path like `crate::foo::bar!()`, `legacy_macros` will be skipped,
47 /// and only normal scoped `macros` will be searched in.
49 /// Note that this automatically inherit macros defined textually before the definition of module itself.
51 /// Module scoped macros will be inserted into `items` instead of here.
52 // FIXME: Macro shadowing in one module is not properly handled. Non-item place macros will
53 // be all resolved to the last one defined if shadowing happens.
54 legacy_macros: FxHashMap<Name, MacroDefId>,
57 pub(crate) static BUILTIN_SCOPE: Lazy<FxHashMap<Name, PerNs>> = Lazy::new(|| {
60 .map(|(name, ty)| (name.clone(), PerNs::types(ty.clone().into(), Visibility::Public)))
64 /// Shadow mode for builtin type which can be shadowed by module.
65 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
66 pub(crate) enum BuiltinShadowMode {
67 /// Prefer user-defined modules (or other types) over builtins.
69 /// Prefer builtins over user-defined modules (but not other types).
73 /// Legacy macros can only be accessed through special methods like `get_legacy_macros`.
74 /// Other methods will only resolve values, types and module scoped macros only.
76 pub fn entries<'a>(&'a self) -> impl Iterator<Item = (&'a Name, PerNs)> + 'a {
78 let keys: FxHashSet<_> = self
81 .chain(self.values.keys())
82 .chain(self.macros.keys())
83 .chain(self.unresolved.iter())
86 keys.into_iter().map(move |name| (name, self.get(name)))
89 pub fn declarations(&self) -> impl Iterator<Item = ModuleDefId> + '_ {
90 self.defs.iter().copied()
93 pub fn impls(&self) -> impl Iterator<Item = ImplId> + ExactSizeIterator + '_ {
94 self.impls.iter().copied()
99 ) -> impl Iterator<Item = (ModuleDefId, Visibility)> + ExactSizeIterator + '_ {
100 self.values.values().copied()
103 pub fn visibility_of(&self, def: ModuleDefId) -> Option<Visibility> {
104 self.name_of(ItemInNs::Types(def))
105 .or_else(|| self.name_of(ItemInNs::Values(def)))
109 /// Iterate over all module scoped macros
110 pub(crate) fn macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
111 self.entries().filter_map(|(name, def)| def.take_macros().map(|macro_| (name, macro_)))
114 /// Iterate over all legacy textual scoped macros visible at the end of the module
115 pub(crate) fn legacy_macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
116 self.legacy_macros.iter().map(|(name, def)| (name, *def))
119 /// Get a name from current module scope, legacy macros are not included
120 pub(crate) fn get(&self, name: &Name) -> PerNs {
122 types: self.types.get(name).copied(),
123 values: self.values.get(name).copied(),
124 macros: self.macros.get(name).copied(),
128 pub(crate) fn name_of(&self, item: ItemInNs) -> Option<(&Name, Visibility)> {
129 for (name, per_ns) in self.entries() {
130 if let Some(vis) = item.match_with(per_ns) {
131 return Some((name, vis));
137 pub(crate) fn traits<'a>(&'a self) -> impl Iterator<Item = TraitId> + 'a {
140 .filter_map(|(def, _)| match def {
141 ModuleDefId::TraitId(t) => Some(*t),
144 .chain(self.unnamed_trait_imports.keys().copied())
147 pub(crate) fn define_def(&mut self, def: ModuleDefId) {
151 pub(crate) fn get_legacy_macro(&self, name: &Name) -> Option<MacroDefId> {
152 self.legacy_macros.get(name).copied()
155 pub(crate) fn define_impl(&mut self, imp: ImplId) {
159 pub(crate) fn define_legacy_macro(&mut self, name: Name, mac: MacroDefId) {
160 self.legacy_macros.insert(name, mac);
163 pub(crate) fn unnamed_trait_vis(&self, tr: TraitId) -> Option<Visibility> {
164 self.unnamed_trait_imports.get(&tr).copied()
167 pub(crate) fn push_unnamed_trait(&mut self, tr: TraitId, vis: Visibility) {
168 self.unnamed_trait_imports.insert(tr, vis);
171 pub(crate) fn push_res_with_import(
173 glob_imports: &mut PerNsGlobImports,
174 lookup: (LocalModuleId, Name),
176 def_import_type: ImportType,
178 let mut changed = false;
180 macro_rules! check_changed {
183 ( $this:ident / $def:ident ) . $field:ident,
184 $glob_imports:ident [ $lookup:ident ],
185 $def_import_type:ident
187 let existing = $this.$field.entry($lookup.1.clone());
188 match (existing, $def.$field) {
189 (Entry::Vacant(entry), Some(_)) => {
190 match $def_import_type {
191 ImportType::Glob => {
192 $glob_imports.$field.insert($lookup.clone());
194 ImportType::Named => {
195 $glob_imports.$field.remove(&$lookup);
199 if let Some(fld) = $def.$field {
204 (Entry::Occupied(mut entry), Some(_))
205 if $glob_imports.$field.contains(&$lookup)
206 && matches!($def_import_type, ImportType::Named) =>
208 cov_mark::hit!(import_shadowed);
209 $glob_imports.$field.remove(&$lookup);
210 if let Some(fld) = $def.$field {
220 check_changed!(changed, (self / def).types, glob_imports[lookup], def_import_type);
221 check_changed!(changed, (self / def).values, glob_imports[lookup], def_import_type);
222 check_changed!(changed, (self / def).macros, glob_imports[lookup], def_import_type);
225 if self.unresolved.insert(lookup.1) {
233 pub(crate) fn resolutions<'a>(&'a self) -> impl Iterator<Item = (Option<Name>, PerNs)> + 'a {
234 self.entries().map(|(name, res)| (Some(name.clone()), res)).chain(
235 self.unnamed_trait_imports
237 .map(|(tr, vis)| (None, PerNs::types(ModuleDefId::TraitId(*tr), *vis))),
241 pub(crate) fn collect_legacy_macros(&self) -> FxHashMap<Name, MacroDefId> {
242 self.legacy_macros.clone()
245 /// Marks everything that is not a procedural macro as private to `this_module`.
246 pub(crate) fn censor_non_proc_macros(&mut self, this_module: ModuleId) {
249 .chain(self.values.values_mut())
251 .chain(self.unnamed_trait_imports.values_mut())
252 .for_each(|vis| *vis = Visibility::Module(this_module));
254 for (mac, vis) in self.macros.values_mut() {
255 if let MacroDefKind::ProcMacro(..) = mac.kind {
256 // FIXME: Technically this is insufficient since reexports of proc macros are also
257 // forbidden. Practically nobody does that.
261 *vis = Visibility::Module(this_module);
265 pub(crate) fn dump(&self, buf: &mut String) {
266 let mut entries: Vec<_> = self.resolutions().collect();
267 entries.sort_by_key(|(name, _)| name.clone());
269 for (name, def) in entries {
270 format_to!(buf, "{}:", name.map_or("_".to_string(), |name| name.to_string()));
272 if def.types.is_some() {
275 if def.values.is_some() {
278 if def.macros.is_some() {
291 pub(crate) fn from_def(def: ModuleDefId, v: Visibility, has_constructor: bool) -> PerNs {
293 ModuleDefId::ModuleId(_) => PerNs::types(def, v),
294 ModuleDefId::FunctionId(_) => PerNs::values(def, v),
295 ModuleDefId::AdtId(adt) => match adt {
296 AdtId::UnionId(_) => PerNs::types(def, v),
297 AdtId::EnumId(_) => PerNs::types(def, v),
298 AdtId::StructId(_) => {
300 PerNs::both(def, def, v)
306 ModuleDefId::EnumVariantId(_) => PerNs::both(def, def, v),
307 ModuleDefId::ConstId(_) | ModuleDefId::StaticId(_) => PerNs::values(def, v),
308 ModuleDefId::TraitId(_) => PerNs::types(def, v),
309 ModuleDefId::TypeAliasId(_) => PerNs::types(def, v),
310 ModuleDefId::BuiltinType(_) => PerNs::types(def, v),
315 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
323 fn match_with(self, per_ns: PerNs) -> Option<Visibility> {
325 ItemInNs::Types(def) => {
326 per_ns.types.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
328 ItemInNs::Values(def) => {
329 per_ns.values.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
331 ItemInNs::Macros(def) => {
332 per_ns.macros.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
337 pub fn as_module_def_id(self) -> Option<ModuleDefId> {
339 ItemInNs::Types(id) | ItemInNs::Values(id) => Some(id),
340 ItemInNs::Macros(_) => None,
344 /// Returns the crate defining this item (or `None` if `self` is built-in).
345 pub fn krate(&self, db: &dyn DefDatabase) -> Option<CrateId> {
347 ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate),
348 ItemInNs::Macros(id) => Some(id.krate),