crates/hir_def/src/item_scope.rs

   1 //! Describes items defined or visible (ie, imported) in a certain scope.
   2 //! This is shared between modules and blocks.
   3
   4 use std::collections::hash_map::Entry;
   5
   6 use base_db::CrateId;
   7 use hir_expand::name::Name;
   8 use hir_expand::MacroDefKind;
   9 use once_cell::sync::Lazy;
  10 use rustc_hash::{FxHashMap, FxHashSet};
  11 use stdx::format_to;
  12
  13 use crate::{
  14     db::DefDatabase, per_ns::PerNs, visibility::Visibility, AdtId, BuiltinType, ConstId, ImplId,
  15     LocalModuleId, MacroDefId, ModuleDefId, ModuleId, TraitId,
  16 };
  17
  18 #[derive(Copy, Clone)]
  19 pub(crate) enum ImportType {
  20     Glob,
  21     Named,
  22 }
  23
  24 #[derive(Debug, Default)]
  25 pub struct PerNsGlobImports {
  26     types: FxHashSet<(LocalModuleId, Name)>,
  27     values: FxHashSet<(LocalModuleId, Name)>,
  28     macros: FxHashSet<(LocalModuleId, Name)>,
  29 }
  30
  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>,
  37
  38     defs: Vec<ModuleDefId>,
  39     impls: Vec<ImplId>,
  40     unnamed_consts: Vec<ConstId>,
  41     /// Traits imported via `use Trait as _;`.
  42     unnamed_trait_imports: FxHashMap<TraitId, Visibility>,
  43     /// Macros visible in current module in legacy textual scope
  44     ///
  45     /// For macros invoked by an unqualified identifier like `bar!()`, `legacy_macros` will be searched in first.
  46     /// If it yields no result, then it turns to module scoped `macros`.
  47     /// It macros with name qualified with a path like `crate::foo::bar!()`, `legacy_macros` will be skipped,
  48     /// and only normal scoped `macros` will be searched in.
  49     ///
  50     /// Note that this automatically inherit macros defined textually before the definition of module itself.
  51     ///
  52     /// Module scoped macros will be inserted into `items` instead of here.
  53     // FIXME: Macro shadowing in one module is not properly handled. Non-item place macros will
  54     // be all resolved to the last one defined if shadowing happens.
  55     legacy_macros: FxHashMap<Name, MacroDefId>,
  56 }
  57
  58 pub(crate) static BUILTIN_SCOPE: Lazy<FxHashMap<Name, PerNs>> = Lazy::new(|| {
  59     BuiltinType::ALL
  60         .iter()
  61         .map(|(name, ty)| (name.clone(), PerNs::types(ty.clone().into(), Visibility::Public)))
  62         .collect()
  63 });
  64
  65 /// Shadow mode for builtin type which can be shadowed by module.
  66 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
  67 pub(crate) enum BuiltinShadowMode {
  68     /// Prefer user-defined modules (or other types) over builtins.
  69     Module,
  70     /// Prefer builtins over user-defined modules (but not other types).
  71     Other,
  72 }
  73
  74 /// Legacy macros can only be accessed through special methods like `get_legacy_macros`.
  75 /// Other methods will only resolve values, types and module scoped macros only.
  76 impl ItemScope {
  77     pub fn entries<'a>(&'a self) -> impl Iterator<Item = (&'a Name, PerNs)> + 'a {
  78         // FIXME: shadowing
  79         let keys: FxHashSet<_> = self
  80             .types
  81             .keys()
  82             .chain(self.values.keys())
  83             .chain(self.macros.keys())
  84             .chain(self.unresolved.iter())
  85             .collect();
  86
  87         keys.into_iter().map(move |name| (name, self.get(name)))
  88     }
  89
  90     pub fn declarations(&self) -> impl Iterator<Item = ModuleDefId> + '_ {
  91         self.defs.iter().copied()
  92     }
  93
  94     pub fn impls(&self) -> impl Iterator<Item = ImplId> + ExactSizeIterator + '_ {
  95         self.impls.iter().copied()
  96     }
  97
  98     pub fn values(
  99         &self,
 100     ) -> impl Iterator<Item = (ModuleDefId, Visibility)> + ExactSizeIterator + '_ {
 101         self.values.values().copied()
 102     }
 103
 104     pub fn visibility_of(&self, def: ModuleDefId) -> Option<Visibility> {
 105         self.name_of(ItemInNs::Types(def))
 106             .or_else(|| self.name_of(ItemInNs::Values(def)))
 107             .map(|(_, v)| v)
 108     }
 109
 110     /// Iterate over all module scoped macros
 111     pub(crate) fn macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
 112         self.entries().filter_map(|(name, def)| def.take_macros().map(|macro_| (name, macro_)))
 113     }
 114
 115     /// Iterate over all legacy textual scoped macros visible at the end of the module
 116     pub(crate) fn legacy_macros<'a>(&'a self) -> impl Iterator<Item = (&'a Name, MacroDefId)> + 'a {
 117         self.legacy_macros.iter().map(|(name, def)| (name, *def))
 118     }
 119
 120     /// Get a name from current module scope, legacy macros are not included
 121     pub(crate) fn get(&self, name: &Name) -> PerNs {
 122         PerNs {
 123             types: self.types.get(name).copied(),
 124             values: self.values.get(name).copied(),
 125             macros: self.macros.get(name).copied(),
 126         }
 127     }
 128
 129     pub(crate) fn name_of(&self, item: ItemInNs) -> Option<(&Name, Visibility)> {
 130         for (name, per_ns) in self.entries() {
 131             if let Some(vis) = item.match_with(per_ns) {
 132                 return Some((name, vis));
 133             }
 134         }
 135         None
 136     }
 137
 138     pub(crate) fn traits<'a>(&'a self) -> impl Iterator<Item = TraitId> + 'a {
 139         self.types
 140             .values()
 141             .filter_map(|(def, _)| match def {
 142                 ModuleDefId::TraitId(t) => Some(*t),
 143                 _ => None,
 144             })
 145             .chain(self.unnamed_trait_imports.keys().copied())
 146     }
 147
 148     pub(crate) fn define_def(&mut self, def: ModuleDefId) {
 149         self.defs.push(def)
 150     }
 151
 152     pub(crate) fn get_legacy_macro(&self, name: &Name) -> Option<MacroDefId> {
 153         self.legacy_macros.get(name).copied()
 154     }
 155
 156     pub(crate) fn define_impl(&mut self, imp: ImplId) {
 157         self.impls.push(imp)
 158     }
 159
 160     pub(crate) fn define_unnamed_const(&mut self, konst: ConstId) {
 161         self.unnamed_consts.push(konst);
 162     }
 163
 164     pub(crate) fn define_legacy_macro(&mut self, name: Name, mac: MacroDefId) {
 165         self.legacy_macros.insert(name, mac);
 166     }
 167
 168     pub(crate) fn unnamed_trait_vis(&self, tr: TraitId) -> Option<Visibility> {
 169         self.unnamed_trait_imports.get(&tr).copied()
 170     }
 171
 172     pub(crate) fn push_unnamed_trait(&mut self, tr: TraitId, vis: Visibility) {
 173         self.unnamed_trait_imports.insert(tr, vis);
 174     }
 175
 176     pub(crate) fn push_res_with_import(
 177         &mut self,
 178         glob_imports: &mut PerNsGlobImports,
 179         lookup: (LocalModuleId, Name),
 180         def: PerNs,
 181         def_import_type: ImportType,
 182     ) -> bool {
 183         let mut changed = false;
 184
 185         macro_rules! check_changed {
 186             (
 187                 $changed:ident,
 188                 ( $this:ident / $def:ident ) . $field:ident,
 189                 $glob_imports:ident [ $lookup:ident ],
 190                 $def_import_type:ident
 191             ) => {{
 192                 let existing = $this.$field.entry($lookup.1.clone());
 193                 match (existing, $def.$field) {
 194                     (Entry::Vacant(entry), Some(_)) => {
 195                         match $def_import_type {
 196                             ImportType::Glob => {
 197                                 $glob_imports.$field.insert($lookup.clone());
 198                             }
 199                             ImportType::Named => {
 200                                 $glob_imports.$field.remove(&$lookup);
 201                             }
 202                         }
 203
 204                         if let Some(fld) = $def.$field {
 205                             entry.insert(fld);
 206                         }
 207                         $changed = true;
 208                     }
 209                     (Entry::Occupied(mut entry), Some(_))
 210                         if $glob_imports.$field.contains(&$lookup)
 211                             && matches!($def_import_type, ImportType::Named) =>
 212                     {
 213                         cov_mark::hit!(import_shadowed);
 214                         $glob_imports.$field.remove(&$lookup);
 215                         if let Some(fld) = $def.$field {
 216                             entry.insert(fld);
 217                         }
 218                         $changed = true;
 219                     }
 220                     _ => {}
 221                 }
 222             }};
 223         }
 224
 225         check_changed!(changed, (self / def).types, glob_imports[lookup], def_import_type);
 226         check_changed!(changed, (self / def).values, glob_imports[lookup], def_import_type);
 227         check_changed!(changed, (self / def).macros, glob_imports[lookup], def_import_type);
 228
 229         if def.is_none() {
 230             if self.unresolved.insert(lookup.1) {
 231                 changed = true;
 232             }
 233         }
 234
 235         changed
 236     }
 237
 238     pub(crate) fn resolutions<'a>(&'a self) -> impl Iterator<Item = (Option<Name>, PerNs)> + 'a {
 239         self.entries().map(|(name, res)| (Some(name.clone()), res)).chain(
 240             self.unnamed_trait_imports
 241                 .iter()
 242                 .map(|(tr, vis)| (None, PerNs::types(ModuleDefId::TraitId(*tr), *vis))),
 243         )
 244     }
 245
 246     pub(crate) fn collect_legacy_macros(&self) -> FxHashMap<Name, MacroDefId> {
 247         self.legacy_macros.clone()
 248     }
 249
 250     /// Marks everything that is not a procedural macro as private to `this_module`.
 251     pub(crate) fn censor_non_proc_macros(&mut self, this_module: ModuleId) {
 252         self.types
 253             .values_mut()
 254             .chain(self.values.values_mut())
 255             .map(|(_, v)| v)
 256             .chain(self.unnamed_trait_imports.values_mut())
 257             .for_each(|vis| *vis = Visibility::Module(this_module));
 258
 259         for (mac, vis) in self.macros.values_mut() {
 260             if let MacroDefKind::ProcMacro(..) = mac.kind {
 261                 // FIXME: Technically this is insufficient since reexports of proc macros are also
 262                 // forbidden. Practically nobody does that.
 263                 continue;
 264             }
 265
 266             *vis = Visibility::Module(this_module);
 267         }
 268     }
 269
 270     pub(crate) fn dump(&self, buf: &mut String) {
 271         let mut entries: Vec<_> = self.resolutions().collect();
 272         entries.sort_by_key(|(name, _)| name.clone());
 273
 274         for (name, def) in entries {
 275             format_to!(buf, "{}:", name.map_or("_".to_string(), |name| name.to_string()));
 276
 277             if def.types.is_some() {
 278                 buf.push_str(" t");
 279             }
 280             if def.values.is_some() {
 281                 buf.push_str(" v");
 282             }
 283             if def.macros.is_some() {
 284                 buf.push_str(" m");
 285             }
 286             if def.is_none() {
 287                 buf.push_str(" _");
 288             }
 289
 290             buf.push('\n');
 291         }
 292     }
 293
 294     pub(crate) fn shrink_to_fit(&mut self) {
 295         // Exhaustive match to require handling new fields.
 296         let Self {
 297             types,
 298             values,
 299             macros,
 300             unresolved,
 301             defs,
 302             impls,
 303             unnamed_consts,
 304             unnamed_trait_imports,
 305             legacy_macros,
 306         } = self;
 307         types.shrink_to_fit();
 308         values.shrink_to_fit();
 309         macros.shrink_to_fit();
 310         unresolved.shrink_to_fit();
 311         defs.shrink_to_fit();
 312         impls.shrink_to_fit();
 313         unnamed_consts.shrink_to_fit();
 314         unnamed_trait_imports.shrink_to_fit();
 315         legacy_macros.shrink_to_fit();
 316     }
 317 }
 318
 319 impl PerNs {
 320     pub(crate) fn from_def(def: ModuleDefId, v: Visibility, has_constructor: bool) -> PerNs {
 321         match def {
 322             ModuleDefId::ModuleId(_) => PerNs::types(def, v),
 323             ModuleDefId::FunctionId(_) => PerNs::values(def, v),
 324             ModuleDefId::AdtId(adt) => match adt {
 325                 AdtId::UnionId(_) => PerNs::types(def, v),
 326                 AdtId::EnumId(_) => PerNs::types(def, v),
 327                 AdtId::StructId(_) => {
 328                     if has_constructor {
 329                         PerNs::both(def, def, v)
 330                     } else {
 331                         PerNs::types(def, v)
 332                     }
 333                 }
 334             },
 335             ModuleDefId::EnumVariantId(_) => PerNs::both(def, def, v),
 336             ModuleDefId::ConstId(_) | ModuleDefId::StaticId(_) => PerNs::values(def, v),
 337             ModuleDefId::TraitId(_) => PerNs::types(def, v),
 338             ModuleDefId::TypeAliasId(_) => PerNs::types(def, v),
 339             ModuleDefId::BuiltinType(_) => PerNs::types(def, v),
 340         }
 341     }
 342 }
 343
 344 #[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
 345 pub enum ItemInNs {
 346     Types(ModuleDefId),
 347     Values(ModuleDefId),
 348     Macros(MacroDefId),
 349 }
 350
 351 impl ItemInNs {
 352     fn match_with(self, per_ns: PerNs) -> Option<Visibility> {
 353         match self {
 354             ItemInNs::Types(def) => {
 355                 per_ns.types.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
 356             }
 357             ItemInNs::Values(def) => {
 358                 per_ns.values.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
 359             }
 360             ItemInNs::Macros(def) => {
 361                 per_ns.macros.filter(|(other_def, _)| *other_def == def).map(|(_, vis)| vis)
 362             }
 363         }
 364     }
 365
 366     pub fn as_module_def_id(self) -> Option<ModuleDefId> {
 367         match self {
 368             ItemInNs::Types(id) | ItemInNs::Values(id) => Some(id),
 369             ItemInNs::Macros(_) => None,
 370         }
 371     }
 372
 373     /// Returns the crate defining this item (or `None` if `self` is built-in).
 374     pub fn krate(&self, db: &dyn DefDatabase) -> Option<CrateId> {
 375         match self {
 376             ItemInNs::Types(did) | ItemInNs::Values(did) => did.module(db).map(|m| m.krate),
 377             ItemInNs::Macros(id) => Some(id.krate),
 378         }
 379     }
 380 }