crates/hir_def/src/nameres.rs

   1 //! This module implements import-resolution/macro expansion algorithm.
   2 //!
   3 //! The result of this module is `DefMap`: a data structure which contains:
   4 //!
   5 //!   * a tree of modules for the crate
   6 //!   * for each module, a set of items visible in the module (directly declared
   7 //!     or imported)
   8 //!
   9 //! Note that `DefMap` contains fully macro expanded code.
  10 //!
  11 //! Computing `DefMap` can be partitioned into several logically
  12 //! independent "phases". The phases are mutually recursive though, there's no
  13 //! strict ordering.
  14 //!
  15 //! ## Collecting RawItems
  16 //!
  17 //! This happens in the `raw` module, which parses a single source file into a
  18 //! set of top-level items. Nested imports are desugared to flat imports in this
  19 //! phase. Macro calls are represented as a triple of (Path, Option<Name>,
  20 //! TokenTree).
  21 //!
  22 //! ## Collecting Modules
  23 //!
  24 //! This happens in the `collector` module. In this phase, we recursively walk
  25 //! tree of modules, collect raw items from submodules, populate module scopes
  26 //! with defined items (so, we assign item ids in this phase) and record the set
  27 //! of unresolved imports and macros.
  28 //!
  29 //! While we walk tree of modules, we also record macro_rules definitions and
  30 //! expand calls to macro_rules defined macros.
  31 //!
  32 //! ## Resolving Imports
  33 //!
  34 //! We maintain a list of currently unresolved imports. On every iteration, we
  35 //! try to resolve some imports from this list. If the import is resolved, we
  36 //! record it, by adding an item to current module scope and, if necessary, by
  37 //! recursively populating glob imports.
  38 //!
  39 //! ## Resolving Macros
  40 //!
  41 //! macro_rules from the same crate use a global mutable namespace. We expand
  42 //! them immediately, when we collect modules.
  43 //!
  44 //! Macros from other crates (including proc-macros) can be used with
  45 //! `foo::bar!` syntax. We handle them similarly to imports. There's a list of
  46 //! unexpanded macros. On every iteration, we try to resolve each macro call
  47 //! path and, upon success, we run macro expansion and "collect module" phase on
  48 //! the result
  49
  50 pub mod attr_resolution;
  51 pub mod diagnostics;
  52 mod collector;
  53 mod mod_resolution;
  54 mod path_resolution;
  55 mod proc_macro;
  56
  57 #[cfg(test)]
  58 mod tests;
  59
  60 use std::sync::Arc;
  61
  62 use base_db::{CrateId, Edition, FileId};
  63 use hir_expand::{name::Name, InFile, MacroDefId};
  64 use la_arena::Arena;
  65 use profile::Count;
  66 use rustc_hash::FxHashMap;
  67 use stdx::format_to;
  68 use syntax::{ast, SmolStr};
  69
  70 use crate::{
  71     db::DefDatabase,
  72     item_scope::{BuiltinShadowMode, ItemScope},
  73     item_tree::TreeId,
  74     nameres::{diagnostics::DefDiagnostic, path_resolution::ResolveMode},
  75     path::ModPath,
  76     per_ns::PerNs,
  77     visibility::Visibility,
  78     AstId, BlockId, BlockLoc, LocalModuleId, ModuleDefId, ModuleId,
  79 };
  80
  81 use self::proc_macro::ProcMacroDef;
  82
  83 /// Contains the results of (early) name resolution.
  84 ///
  85 /// A `DefMap` stores the module tree and the definitions that are in scope in every module after
  86 /// item-level macros have been expanded.
  87 ///
  88 /// Every crate has a primary `DefMap` whose root is the crate's main file (`main.rs`/`lib.rs`),
  89 /// computed by the `crate_def_map` query. Additionally, every block expression introduces the
  90 /// opportunity to write arbitrary item and module hierarchies, and thus gets its own `DefMap` that
  91 /// is computed by the `block_def_map` query.
  92 #[derive(Debug, PartialEq, Eq)]
  93 pub struct DefMap {
  94     _c: Count<Self>,
  95     block: Option<BlockInfo>,
  96     root: LocalModuleId,
  97     modules: Arena<ModuleData>,
  98     krate: CrateId,
  99     /// The prelude module for this crate. This either comes from an import
 100     /// marked with the `prelude_import` attribute, or (in the normal case) from
 101     /// a dependency (`std` or `core`).
 102     prelude: Option<ModuleId>,
 103     extern_prelude: FxHashMap<Name, ModuleDefId>,
 104
 105     /// Side table with additional proc. macro info, for use by name resolution in downstream
 106     /// crates.
 107     ///
 108     /// (the primary purpose is to resolve derive helpers and fetch a proc-macros name)
 109     exported_proc_macros: FxHashMap<MacroDefId, ProcMacroDef>,
 110
 111     /// Custom attributes registered with `#![register_attr]`.
 112     registered_attrs: Vec<SmolStr>,
 113     /// Custom tool modules registered with `#![register_tool]`.
 114     registered_tools: Vec<SmolStr>,
 115
 116     edition: Edition,
 117     diagnostics: Vec<DefDiagnostic>,
 118 }
 119
 120 /// For `DefMap`s computed for a block expression, this stores its location in the parent map.
 121 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
 122 struct BlockInfo {
 123     /// The `BlockId` this `DefMap` was created from.
 124     block: BlockId,
 125     /// The containing module.
 126     parent: ModuleId,
 127 }
 128
 129 impl std::ops::Index<LocalModuleId> for DefMap {
 130     type Output = ModuleData;
 131     fn index(&self, id: LocalModuleId) -> &ModuleData {
 132         &self.modules[id]
 133     }
 134 }
 135
 136 #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
 137 pub enum ModuleOrigin {
 138     CrateRoot {
 139         definition: FileId,
 140     },
 141     /// Note that non-inline modules, by definition, live inside non-macro file.
 142     File {
 143         is_mod_rs: bool,
 144         declaration: AstId<ast::Module>,
 145         definition: FileId,
 146     },
 147     Inline {
 148         definition: AstId<ast::Module>,
 149     },
 150     /// Pseudo-module introduced by a block scope (contains only inner items).
 151     BlockExpr {
 152         block: AstId<ast::BlockExpr>,
 153     },
 154 }
 155
 156 impl ModuleOrigin {
 157     pub fn declaration(&self) -> Option<AstId<ast::Module>> {
 158         match self {
 159             ModuleOrigin::File { declaration: module, .. }
 160             | ModuleOrigin::Inline { definition: module, .. } => Some(*module),
 161             ModuleOrigin::CrateRoot { .. } | ModuleOrigin::BlockExpr { .. } => None,
 162         }
 163     }
 164
 165     pub fn file_id(&self) -> Option<FileId> {
 166         match self {
 167             ModuleOrigin::File { definition, .. } | ModuleOrigin::CrateRoot { definition } => {
 168                 Some(*definition)
 169             }
 170             _ => None,
 171         }
 172     }
 173
 174     pub fn is_inline(&self) -> bool {
 175         match self {
 176             ModuleOrigin::Inline { .. } | ModuleOrigin::BlockExpr { .. } => true,
 177             ModuleOrigin::CrateRoot { .. } | ModuleOrigin::File { .. } => false,
 178         }
 179     }
 180
 181     /// Returns a node which defines this module.
 182     /// That is, a file or a `mod foo {}` with items.
 183     fn definition_source(&self, db: &dyn DefDatabase) -> InFile<ModuleSource> {
 184         match self {
 185             ModuleOrigin::File { definition, .. } | ModuleOrigin::CrateRoot { definition } => {
 186                 let file_id = *definition;
 187                 let sf = db.parse(file_id).tree();
 188                 InFile::new(file_id.into(), ModuleSource::SourceFile(sf))
 189             }
 190             ModuleOrigin::Inline { definition } => InFile::new(
 191                 definition.file_id,
 192                 ModuleSource::Module(definition.to_node(db.upcast())),
 193             ),
 194             ModuleOrigin::BlockExpr { block } => {
 195                 InFile::new(block.file_id, ModuleSource::BlockExpr(block.to_node(db.upcast())))
 196             }
 197         }
 198     }
 199 }
 200
 201 #[derive(Debug, PartialEq, Eq)]
 202 pub struct ModuleData {
 203     /// Where does this module come from?
 204     pub origin: ModuleOrigin,
 205     /// Declared visibility of this module.
 206     pub visibility: Visibility,
 207
 208     pub parent: Option<LocalModuleId>,
 209     pub children: FxHashMap<Name, LocalModuleId>,
 210     pub scope: ItemScope,
 211 }
 212
 213 impl DefMap {
 214     pub(crate) fn crate_def_map_query(db: &dyn DefDatabase, krate: CrateId) -> Arc<DefMap> {
 215         let _p = profile::span("crate_def_map_query").detail(|| {
 216             db.crate_graph()[krate].display_name.as_deref().unwrap_or_default().to_string()
 217         });
 218
 219         let crate_graph = db.crate_graph();
 220
 221         let edition = crate_graph[krate].edition;
 222         let origin = ModuleOrigin::CrateRoot { definition: crate_graph[krate].root_file_id };
 223         let def_map = DefMap::empty(krate, edition, origin);
 224         let def_map = collector::collect_defs(
 225             db,
 226             def_map,
 227             TreeId::new(crate_graph[krate].root_file_id.into(), None),
 228         );
 229
 230         Arc::new(def_map)
 231     }
 232
 233     pub(crate) fn block_def_map_query(
 234         db: &dyn DefDatabase,
 235         block_id: BlockId,
 236     ) -> Option<Arc<DefMap>> {
 237         let block: BlockLoc = db.lookup_intern_block(block_id);
 238
 239         let tree_id = TreeId::new(block.ast_id.file_id, Some(block_id));
 240         let item_tree = tree_id.item_tree(db);
 241         if item_tree.top_level_items().is_empty() {
 242             return None;
 243         }
 244
 245         let block_info = BlockInfo { block: block_id, parent: block.module };
 246
 247         let parent_map = block.module.def_map(db);
 248         let mut def_map = DefMap::empty(
 249             block.module.krate,
 250             parent_map.edition,
 251             ModuleOrigin::BlockExpr { block: block.ast_id },
 252         );
 253         def_map.block = Some(block_info);
 254
 255         let def_map = collector::collect_defs(db, def_map, tree_id);
 256         Some(Arc::new(def_map))
 257     }
 258
 259     fn empty(krate: CrateId, edition: Edition, root_module_origin: ModuleOrigin) -> DefMap {
 260         let mut modules: Arena<ModuleData> = Arena::default();
 261
 262         let local_id = LocalModuleId::from_raw(la_arena::RawIdx::from(0));
 263         // NB: we use `None` as block here, which would be wrong for implicit
 264         // modules declared by blocks with items. At the moment, we don't use
 265         // this visibility for anything outside IDE, so that's probably OK.
 266         let visibility = Visibility::Module(ModuleId { krate, local_id, block: None });
 267         let root = modules.alloc(ModuleData::new(root_module_origin, visibility));
 268         assert_eq!(local_id, root);
 269
 270         DefMap {
 271             _c: Count::new(),
 272             block: None,
 273             krate,
 274             edition,
 275             extern_prelude: FxHashMap::default(),
 276             exported_proc_macros: FxHashMap::default(),
 277             prelude: None,
 278             root,
 279             modules,
 280             registered_attrs: Vec::new(),
 281             registered_tools: Vec::new(),
 282             diagnostics: Vec::new(),
 283         }
 284     }
 285
 286     pub fn modules_for_file(&self, file_id: FileId) -> impl Iterator<Item = LocalModuleId> + '_ {
 287         self.modules
 288             .iter()
 289             .filter(move |(_id, data)| data.origin.file_id() == Some(file_id))
 290             .map(|(id, _data)| id)
 291     }
 292
 293     pub fn modules(&self) -> impl Iterator<Item = (LocalModuleId, &ModuleData)> + '_ {
 294         self.modules.iter()
 295     }
 296     pub fn exported_proc_macros(&self) -> impl Iterator<Item = (MacroDefId, Name)> + '_ {
 297         self.exported_proc_macros.iter().map(|(id, def)| (*id, def.name.clone()))
 298     }
 299     pub fn registered_tools(&self) -> &[SmolStr] {
 300         &self.registered_tools
 301     }
 302     pub fn registered_attrs(&self) -> &[SmolStr] {
 303         &self.registered_attrs
 304     }
 305     pub fn root(&self) -> LocalModuleId {
 306         self.root
 307     }
 308
 309     pub(crate) fn krate(&self) -> CrateId {
 310         self.krate
 311     }
 312
 313     pub(crate) fn block_id(&self) -> Option<BlockId> {
 314         self.block.as_ref().map(|block| block.block)
 315     }
 316
 317     pub(crate) fn prelude(&self) -> Option<ModuleId> {
 318         self.prelude
 319     }
 320
 321     pub(crate) fn extern_prelude(&self) -> impl Iterator<Item = (&Name, &ModuleDefId)> + '_ {
 322         self.extern_prelude.iter()
 323     }
 324
 325     pub fn module_id(&self, local_id: LocalModuleId) -> ModuleId {
 326         let block = self.block.as_ref().map(|b| b.block);
 327         ModuleId { krate: self.krate, local_id, block }
 328     }
 329
 330     pub(crate) fn crate_root(&self, db: &dyn DefDatabase) -> ModuleId {
 331         self.with_ancestor_maps(db, self.root, &mut |def_map, _module| {
 332             if def_map.block.is_none() {
 333                 Some(def_map.module_id(def_map.root))
 334             } else {
 335                 None
 336             }
 337         })
 338         .expect("DefMap chain without root")
 339     }
 340
 341     pub(crate) fn resolve_path(
 342         &self,
 343         db: &dyn DefDatabase,
 344         original_module: LocalModuleId,
 345         path: &ModPath,
 346         shadow: BuiltinShadowMode,
 347     ) -> (PerNs, Option<usize>) {
 348         let res =
 349             self.resolve_path_fp_with_macro(db, ResolveMode::Other, original_module, path, shadow);
 350         (res.resolved_def, res.segment_index)
 351     }
 352
 353     pub(crate) fn resolve_path_locally(
 354         &self,
 355         db: &dyn DefDatabase,
 356         original_module: LocalModuleId,
 357         path: &ModPath,
 358         shadow: BuiltinShadowMode,
 359     ) -> (PerNs, Option<usize>) {
 360         let res = self.resolve_path_fp_with_macro_single(
 361             db,
 362             ResolveMode::Other,
 363             original_module,
 364             path,
 365             shadow,
 366         );
 367         (res.resolved_def, res.segment_index)
 368     }
 369
 370     /// Ascends the `DefMap` hierarchy and calls `f` with every `DefMap` and containing module.
 371     ///
 372     /// If `f` returns `Some(val)`, iteration is stopped and `Some(val)` is returned. If `f` returns
 373     /// `None`, iteration continues.
 374     pub fn with_ancestor_maps<T>(
 375         &self,
 376         db: &dyn DefDatabase,
 377         local_mod: LocalModuleId,
 378         f: &mut dyn FnMut(&DefMap, LocalModuleId) -> Option<T>,
 379     ) -> Option<T> {
 380         if let Some(it) = f(self, local_mod) {
 381             return Some(it);
 382         }
 383         let mut block = self.block;
 384         while let Some(block_info) = block {
 385             let parent = block_info.parent.def_map(db);
 386             if let Some(it) = f(&parent, block_info.parent.local_id) {
 387                 return Some(it);
 388             }
 389             block = parent.block;
 390         }
 391
 392         None
 393     }
 394
 395     /// If this `DefMap` is for a block expression, returns the module containing the block (which
 396     /// might again be a block, or a module inside a block).
 397     pub fn parent(&self) -> Option<ModuleId> {
 398         Some(self.block?.parent)
 399     }
 400
 401     /// Returns the module containing `local_mod`, either the parent `mod`, or the module containing
 402     /// the block, if `self` corresponds to a block expression.
 403     pub fn containing_module(&self, local_mod: LocalModuleId) -> Option<ModuleId> {
 404         match &self[local_mod].parent {
 405             Some(parent) => Some(self.module_id(*parent)),
 406             None => self.block.as_ref().map(|block| block.parent),
 407         }
 408     }
 409
 410     // FIXME: this can use some more human-readable format (ideally, an IR
 411     // even), as this should be a great debugging aid.
 412     pub fn dump(&self, db: &dyn DefDatabase) -> String {
 413         let mut buf = String::new();
 414         let mut arc;
 415         let mut current_map = self;
 416         while let Some(block) = &current_map.block {
 417             go(&mut buf, current_map, "block scope", current_map.root);
 418             buf.push('\n');
 419             arc = block.parent.def_map(db);
 420             current_map = &*arc;
 421         }
 422         go(&mut buf, current_map, "crate", current_map.root);
 423         return buf;
 424
 425         fn go(buf: &mut String, map: &DefMap, path: &str, module: LocalModuleId) {
 426             format_to!(buf, "{}\n", path);
 427
 428             map.modules[module].scope.dump(buf);
 429
 430             for (name, child) in map.modules[module].children.iter() {
 431                 let path = format!("{}::{}", path, name);
 432                 buf.push('\n');
 433                 go(buf, map, &path, *child);
 434             }
 435         }
 436     }
 437
 438     pub fn dump_block_scopes(&self, db: &dyn DefDatabase) -> String {
 439         let mut buf = String::new();
 440         let mut arc;
 441         let mut current_map = self;
 442         while let Some(block) = &current_map.block {
 443             format_to!(buf, "{:?} in {:?}\n", block.block, block.parent);
 444             arc = block.parent.def_map(db);
 445             current_map = &*arc;
 446         }
 447
 448         format_to!(buf, "crate scope\n");
 449         buf
 450     }
 451
 452     fn shrink_to_fit(&mut self) {
 453         // Exhaustive match to require handling new fields.
 454         let Self {
 455             _c: _,
 456             exported_proc_macros,
 457             extern_prelude,
 458             diagnostics,
 459             modules,
 460             registered_attrs,
 461             registered_tools,
 462             block: _,
 463             edition: _,
 464             krate: _,
 465             prelude: _,
 466             root: _,
 467         } = self;
 468
 469         extern_prelude.shrink_to_fit();
 470         exported_proc_macros.shrink_to_fit();
 471         diagnostics.shrink_to_fit();
 472         modules.shrink_to_fit();
 473         registered_attrs.shrink_to_fit();
 474         registered_tools.shrink_to_fit();
 475         for (_, module) in modules.iter_mut() {
 476             module.children.shrink_to_fit();
 477             module.scope.shrink_to_fit();
 478         }
 479     }
 480
 481     /// Get a reference to the def map's diagnostics.
 482     pub fn diagnostics(&self) -> &[DefDiagnostic] {
 483         self.diagnostics.as_slice()
 484     }
 485 }
 486
 487 impl ModuleData {
 488     pub(crate) fn new(origin: ModuleOrigin, visibility: Visibility) -> Self {
 489         ModuleData {
 490             origin,
 491             visibility,
 492             parent: None,
 493             children: FxHashMap::default(),
 494             scope: ItemScope::default(),
 495         }
 496     }
 497
 498     /// Returns a node which defines this module. That is, a file or a `mod foo {}` with items.
 499     pub fn definition_source(&self, db: &dyn DefDatabase) -> InFile<ModuleSource> {
 500         self.origin.definition_source(db)
 501     }
 502
 503     /// Returns a node which declares this module, either a `mod foo;` or a `mod foo {}`.
 504     /// `None` for the crate root or block.
 505     pub fn declaration_source(&self, db: &dyn DefDatabase) -> Option<InFile<ast::Module>> {
 506         let decl = self.origin.declaration()?;
 507         let value = decl.to_node(db.upcast());
 508         Some(InFile { file_id: decl.file_id, value })
 509     }
 510 }
 511
 512 #[derive(Debug, Clone, PartialEq, Eq)]
 513 pub enum ModuleSource {
 514     SourceFile(ast::SourceFile),
 515     Module(ast::Module),
 516     BlockExpr(ast::BlockExpr),
 517 }