//! Name resolution. use std::sync::Arc; use rustc_hash::{FxHashMap, FxHashSet}; use crate::{ ModuleDef, Trait, code_model::Crate, MacroDefId, db::HirDatabase, name::{Name, KnownName}, nameres::{PerNs, CrateDefMap, CrateModuleId}, generics::GenericParams, expr::{scope::{ExprScopes, ScopeId}, PatId}, impl_block::ImplBlock, path::Path, }; #[derive(Debug, Clone, Default)] pub(crate) struct Resolver { scopes: Vec, } // FIXME how to store these best #[derive(Debug, Clone)] pub(crate) struct ModuleItemMap { crate_def_map: Arc, module_id: CrateModuleId, } #[derive(Debug, Clone)] pub(crate) struct ExprScope { expr_scopes: Arc, scope_id: ScopeId, } #[derive(Debug, Clone)] pub(crate) struct PathResult { /// The actual path resolution resolution: PerNs, /// The first index in the path that we /// were unable to resolve. /// When path is fully resolved, this is 0. remaining_index: usize, } impl PathResult { /// Returns the remaining index in the result /// returns None if the path was fully resolved pub(crate) fn remaining_index(&self) -> Option { if self.remaining_index > 0 { Some(self.remaining_index) } else { None } } /// Consumes `PathResult` and returns the contained `PerNs` /// if the path was fully resolved, meaning we have no remaining items pub(crate) fn into_fully_resolved(self) -> PerNs { if self.is_fully_resolved() { self.resolution } else { PerNs::none() } } /// Consumes `PathResult` and returns the resolution and the /// remaining_index as a tuple. pub(crate) fn into_inner(self) -> (PerNs, Option) { let index = self.remaining_index(); (self.resolution, index) } /// Path is fully resolved when `remaining_index` is none /// and the resolution contains anything pub(crate) fn is_fully_resolved(&self) -> bool { !self.resolution.is_none() && self.remaining_index().is_none() } fn empty() -> PathResult { PathResult { resolution: PerNs::none(), remaining_index: 0 } } fn from_resolution(res: PerNs) -> PathResult { PathResult::from_resolution_with_index(res, 0) } fn from_resolution_with_index(res: PerNs, remaining_index: usize) -> PathResult { if res.is_none() { PathResult::empty() } else { PathResult { resolution: res, remaining_index } } } } #[derive(Debug, Clone)] pub(crate) enum Scope { /// All the items and imported names of a module ModuleScope(ModuleItemMap), /// Brings the generic parameters of an item into scope GenericParams(Arc), /// Brings `Self` into scope ImplBlockScope(ImplBlock), /// Local bindings ExprScope(ExprScope), } #[derive(Debug, Clone, PartialEq, Eq)] pub enum Resolution { /// An item Def(ModuleDef), /// A local binding (only value namespace) LocalBinding(PatId), /// A generic parameter GenericParam(u32), SelfType(ImplBlock), } impl Resolver { pub(crate) fn resolve_name(&self, db: &impl HirDatabase, name: &Name) -> PerNs { let mut resolution = PerNs::none(); for scope in self.scopes.iter().rev() { resolution = resolution.or(scope.resolve_name(db, name)); if resolution.is_both() { return resolution; } } resolution } pub(crate) fn resolve_macro_call( &self, db: &impl HirDatabase, path: Option, ) -> Option { let m = self.module()?; m.0.find_macro(db, m.1, &path?) } /// Returns the resolved path segments /// Which may be fully resolved, empty or partially resolved. pub(crate) fn resolve_path_segments(&self, db: &impl HirDatabase, path: &Path) -> PathResult { if let Some(name) = path.as_ident() { PathResult::from_resolution(self.resolve_name(db, name)) } else if path.is_self() { PathResult::from_resolution(self.resolve_name(db, &Name::self_param())) } else { let (item_map, module) = match self.module() { Some(m) => m, _ => return PathResult::empty(), }; let (module_res, segment_index) = item_map.resolve_path(db, module, path); let def = module_res.map(Resolution::Def); if let Some(index) = segment_index { PathResult::from_resolution_with_index(def, index) } else { PathResult::from_resolution(def) } } } /// Returns the fully resolved path if we were able to resolve it. /// otherwise returns `PerNs::none` pub(crate) fn resolve_path(&self, db: &impl HirDatabase, path: &Path) -> PerNs { // into_fully_resolved() returns the fully resolved path or PerNs::none() otherwise self.resolve_path_segments(db, path).into_fully_resolved() } pub(crate) fn all_names(&self, db: &impl HirDatabase) -> FxHashMap> { let mut names = FxHashMap::default(); for scope in self.scopes.iter().rev() { scope.collect_names(db, &mut |name, res| { let current: &mut PerNs = names.entry(name).or_default(); if current.types.is_none() { current.types = res.types; } if current.values.is_none() { current.values = res.values; } }); } names } pub(crate) fn traits_in_scope(&self, db: &impl HirDatabase) -> FxHashSet { let mut traits = FxHashSet::default(); for scope in &self.scopes { if let Scope::ModuleScope(m) = scope { if let Some(prelude) = m.crate_def_map.prelude() { let prelude_def_map = db.crate_def_map(prelude.krate); traits.extend(prelude_def_map[prelude.module_id].scope.traits()); } traits.extend(m.crate_def_map[m.module_id].scope.traits()); } } traits } fn module(&self) -> Option<(&CrateDefMap, CrateModuleId)> { self.scopes.iter().rev().find_map(|scope| match scope { Scope::ModuleScope(m) => Some((&*m.crate_def_map, m.module_id)), _ => None, }) } pub(crate) fn krate(&self) -> Option { self.module().map(|t| t.0.krate()) } } impl Resolver { pub(crate) fn push_scope(mut self, scope: Scope) -> Resolver { self.scopes.push(scope); self } pub(crate) fn push_generic_params_scope(self, params: Arc) -> Resolver { self.push_scope(Scope::GenericParams(params)) } pub(crate) fn push_impl_block_scope(self, impl_block: ImplBlock) -> Resolver { self.push_scope(Scope::ImplBlockScope(impl_block)) } pub(crate) fn push_module_scope( self, crate_def_map: Arc, module_id: CrateModuleId, ) -> Resolver { self.push_scope(Scope::ModuleScope(ModuleItemMap { crate_def_map, module_id })) } pub(crate) fn push_expr_scope( self, expr_scopes: Arc, scope_id: ScopeId, ) -> Resolver { self.push_scope(Scope::ExprScope(ExprScope { expr_scopes, scope_id })) } } impl Scope { fn resolve_name(&self, db: &impl HirDatabase, name: &Name) -> PerNs { match self { Scope::ModuleScope(m) => { if let Some(KnownName::SelfParam) = name.as_known_name() { PerNs::types(Resolution::Def(m.crate_def_map.mk_module(m.module_id).into())) } else { m.crate_def_map .resolve_name_in_module(db, m.module_id, name) .map(Resolution::Def) } } Scope::GenericParams(gp) => match gp.find_by_name(name) { Some(gp) => PerNs::types(Resolution::GenericParam(gp.idx)), None => PerNs::none(), }, Scope::ImplBlockScope(i) => { if name.as_known_name() == Some(KnownName::SelfType) { PerNs::types(Resolution::SelfType(i.clone())) } else { PerNs::none() } } Scope::ExprScope(e) => { let entry = e.expr_scopes.entries(e.scope_id).iter().find(|entry| entry.name() == name); match entry { Some(e) => PerNs::values(Resolution::LocalBinding(e.pat())), None => PerNs::none(), } } } } fn collect_names(&self, db: &impl HirDatabase, f: &mut dyn FnMut(Name, PerNs)) { match self { Scope::ModuleScope(m) => { // FIXME: should we provide `self` here? // f( // Name::self_param(), // PerNs::types(Resolution::Def { // def: m.module.into(), // }), // ); m.crate_def_map[m.module_id].scope.entries().for_each(|(name, res)| { f(name.clone(), res.def.map(Resolution::Def)); }); m.crate_def_map.extern_prelude().iter().for_each(|(name, def)| { f(name.clone(), PerNs::types(Resolution::Def(*def))); }); if let Some(prelude) = m.crate_def_map.prelude() { let prelude_def_map = db.crate_def_map(prelude.krate); prelude_def_map[prelude.module_id].scope.entries().for_each(|(name, res)| { f(name.clone(), res.def.map(Resolution::Def)); }); } } Scope::GenericParams(gp) => { for param in &gp.params { f(param.name.clone(), PerNs::types(Resolution::GenericParam(param.idx))) } } Scope::ImplBlockScope(i) => { f(Name::self_type(), PerNs::types(Resolution::SelfType(i.clone()))); } Scope::ExprScope(e) => { e.expr_scopes.entries(e.scope_id).iter().for_each(|e| { f(e.name().clone(), PerNs::values(Resolution::LocalBinding(e.pat()))); }); } } } }