1 //! Name resolution façade.
9 use rustc_hash::FxHashSet;
12 body::scope::{ExprScopes, ScopeId},
14 builtin_type::BuiltinType,
16 expr::{ExprId, PatId},
17 generics::GenericParams,
18 item_scope::{BuiltinShadowMode, BUILTIN_SCOPE},
20 path::{ModPath, PathKind},
22 visibility::{RawVisibility, Visibility},
23 AdtId, AssocContainerId, ConstId, ContainerId, DefWithBodyId, EnumId, EnumVariantId,
24 FunctionId, GenericDefId, HasModule, ImplId, LocalModuleId, Lookup, ModuleDefId, ModuleId,
25 StaticId, StructId, TraitId, TypeAliasId, TypeParamId, VariantId,
28 #[derive(Debug, Clone, Default)]
30 // FIXME: all usages generally call `.rev`, so maybe reverse once in consturciton?
34 // FIXME how to store these best
35 #[derive(Debug, Clone)]
36 struct ModuleItemMap {
37 crate_def_map: Arc<CrateDefMap>,
38 module_id: LocalModuleId,
41 #[derive(Debug, Clone)]
44 expr_scopes: Arc<ExprScopes>,
48 #[derive(Debug, Clone)]
50 /// All the items and imported names of a module
51 ModuleScope(ModuleItemMap),
52 /// Brings the generic parameters of an item into scope
53 GenericParams { def: GenericDefId, params: Arc<GenericParams> },
54 /// Brings `Self` in `impl` block into scope
56 /// Brings `Self` in enum, struct and union definitions into scope
60 /// Temporary hack to support local items.
61 LocalItemsScope(Arc<Body>),
64 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
67 GenericParam(TypeParamId),
70 // Yup, enum variants are added to the types ns, but any usage of variant as
72 EnumVariantId(EnumVariantId),
73 TypeAliasId(TypeAliasId),
74 BuiltinType(BuiltinType),
76 // Module belong to type ns, but the resolver is used when all module paths
77 // are fully resolved.
81 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
82 pub enum ResolveValueResult {
84 Partial(TypeNs, usize),
87 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
91 FunctionId(FunctionId),
95 EnumVariantId(EnumVariantId),
99 /// Resolve known trait from std, like `std::futures::Future`
100 pub fn resolve_known_trait(&self, db: &dyn DefDatabase, path: &ModPath) -> Option<TraitId> {
101 let res = self.resolve_module_path(db, path, BuiltinShadowMode::Other).take_types()?;
103 ModuleDefId::TraitId(it) => Some(it),
108 /// Resolve known struct from std, like `std::boxed::Box`
109 pub fn resolve_known_struct(&self, db: &dyn DefDatabase, path: &ModPath) -> Option<StructId> {
110 let res = self.resolve_module_path(db, path, BuiltinShadowMode::Other).take_types()?;
112 ModuleDefId::AdtId(AdtId::StructId(it)) => Some(it),
117 /// Resolve known enum from std, like `std::result::Result`
118 pub fn resolve_known_enum(&self, db: &dyn DefDatabase, path: &ModPath) -> Option<EnumId> {
119 let res = self.resolve_module_path(db, path, BuiltinShadowMode::Other).take_types()?;
121 ModuleDefId::AdtId(AdtId::EnumId(it)) => Some(it),
126 fn resolve_module_path(
128 db: &dyn DefDatabase,
130 shadow: BuiltinShadowMode,
132 let (item_map, module) = match self.module_scope() {
134 None => return PerNs::none(),
136 let (module_res, segment_index) = item_map.resolve_path(db, module, &path, shadow);
137 if segment_index.is_some() {
138 return PerNs::none();
143 pub fn resolve_module_path_in_items(&self, db: &dyn DefDatabase, path: &ModPath) -> PerNs {
144 self.resolve_module_path(db, path, BuiltinShadowMode::Module)
147 pub fn resolve_path_in_type_ns(
149 db: &dyn DefDatabase,
151 ) -> Option<(TypeNs, Option<usize>)> {
152 let first_name = path.segments.first()?;
153 let skip_to_mod = path.kind != PathKind::Plain;
154 for scope in self.scopes.iter().rev() {
156 Scope::ExprScope(_) => continue,
157 Scope::GenericParams { .. }
158 | Scope::ImplDefScope(_)
159 | Scope::LocalItemsScope(_)
165 Scope::GenericParams { params, def } => {
166 if let Some(local_id) = params.find_by_name(first_name) {
167 let idx = if path.segments.len() == 1 { None } else { Some(1) };
169 TypeNs::GenericParam(TypeParamId { local_id, parent: *def }),
174 Scope::ImplDefScope(impl_) => {
175 if first_name == &name![Self] {
176 let idx = if path.segments.len() == 1 { None } else { Some(1) };
177 return Some((TypeNs::SelfType(*impl_), idx));
180 Scope::AdtScope(adt) => {
181 if first_name == &name![Self] {
182 let idx = if path.segments.len() == 1 { None } else { Some(1) };
183 return Some((TypeNs::AdtSelfType(*adt), idx));
186 Scope::ModuleScope(m) => {
187 let (module_def, idx) = m.crate_def_map.resolve_path(
191 BuiltinShadowMode::Other,
193 let res = to_type_ns(module_def)?;
194 return Some((res, idx));
196 Scope::LocalItemsScope(body) => {
197 let def = body.item_scope.get(first_name);
198 if let Some(res) = to_type_ns(def) {
199 return Some((res, None));
205 fn to_type_ns(per_ns: PerNs) -> Option<TypeNs> {
206 let res = match per_ns.take_types()? {
207 ModuleDefId::AdtId(it) => TypeNs::AdtId(it),
208 ModuleDefId::EnumVariantId(it) => TypeNs::EnumVariantId(it),
210 ModuleDefId::TypeAliasId(it) => TypeNs::TypeAliasId(it),
211 ModuleDefId::BuiltinType(it) => TypeNs::BuiltinType(it),
213 ModuleDefId::TraitId(it) => TypeNs::TraitId(it),
215 ModuleDefId::FunctionId(_)
216 | ModuleDefId::ConstId(_)
217 | ModuleDefId::StaticId(_)
218 | ModuleDefId::ModuleId(_) => return None,
224 pub fn resolve_path_in_type_ns_fully(
226 db: &dyn DefDatabase,
228 ) -> Option<TypeNs> {
229 let (res, unresolved) = self.resolve_path_in_type_ns(db, path)?;
230 if unresolved.is_some() {
236 pub fn resolve_visibility(
238 db: &dyn DefDatabase,
239 visibility: &RawVisibility,
240 ) -> Option<Visibility> {
242 RawVisibility::Module(_) => {
243 let (item_map, module) = match self.module_scope() {
247 item_map.resolve_visibility(db, module, visibility)
249 RawVisibility::Public => Some(Visibility::Public),
253 pub fn resolve_path_in_value_ns(
255 db: &dyn DefDatabase,
257 ) -> Option<ResolveValueResult> {
258 let n_segments = path.segments.len();
259 let tmp = name![self];
260 let first_name = if path.is_self() { &tmp } else { &path.segments.first()? };
261 let skip_to_mod = path.kind != PathKind::Plain && !path.is_self();
262 for scope in self.scopes.iter().rev() {
265 | Scope::ExprScope(_)
266 | Scope::GenericParams { .. }
267 | Scope::ImplDefScope(_)
268 | Scope::LocalItemsScope(_)
274 Scope::ExprScope(scope) if n_segments <= 1 => {
277 .entries(scope.scope_id)
279 .find(|entry| entry.name() == first_name);
281 if let Some(e) = entry {
282 return Some(ResolveValueResult::ValueNs(ValueNs::LocalBinding(e.pat())));
285 Scope::ExprScope(_) => continue,
287 Scope::GenericParams { params, def } if n_segments > 1 => {
288 if let Some(local_id) = params.find_by_name(first_name) {
289 let ty = TypeNs::GenericParam(TypeParamId { local_id, parent: *def });
290 return Some(ResolveValueResult::Partial(ty, 1));
293 Scope::GenericParams { .. } => continue,
295 Scope::ImplDefScope(impl_) => {
296 if first_name == &name![Self] {
298 let ty = TypeNs::SelfType(*impl_);
299 return Some(ResolveValueResult::Partial(ty, 1));
301 return Some(ResolveValueResult::ValueNs(ValueNs::ImplSelf(*impl_)));
305 Scope::AdtScope(adt) => {
307 // bare `Self` doesn't work in the value namespace in a struct/enum definition
310 if first_name == &name![Self] {
311 let ty = TypeNs::AdtSelfType(*adt);
312 return Some(ResolveValueResult::Partial(ty, 1));
316 Scope::ModuleScope(m) => {
317 let (module_def, idx) = m.crate_def_map.resolve_path(
321 BuiltinShadowMode::Other,
325 let value = to_value_ns(module_def)?;
326 Some(ResolveValueResult::ValueNs(value))
329 let ty = match module_def.take_types()? {
330 ModuleDefId::AdtId(it) => TypeNs::AdtId(it),
331 ModuleDefId::TraitId(it) => TypeNs::TraitId(it),
332 ModuleDefId::TypeAliasId(it) => TypeNs::TypeAliasId(it),
333 ModuleDefId::BuiltinType(it) => TypeNs::BuiltinType(it),
335 ModuleDefId::ModuleId(_)
336 | ModuleDefId::FunctionId(_)
337 | ModuleDefId::EnumVariantId(_)
338 | ModuleDefId::ConstId(_)
339 | ModuleDefId::StaticId(_) => return None,
341 Some(ResolveValueResult::Partial(ty, idx))
345 Scope::LocalItemsScope(body) => {
346 // we don't bother looking in the builtin scope here because there are no builtin values
347 let def = to_value_ns(body.item_scope.get(first_name));
349 if let Some(res) = def {
350 return Some(ResolveValueResult::ValueNs(res));
357 fn to_value_ns(per_ns: PerNs) -> Option<ValueNs> {
358 let res = match per_ns.take_values()? {
359 ModuleDefId::FunctionId(it) => ValueNs::FunctionId(it),
360 ModuleDefId::AdtId(AdtId::StructId(it)) => ValueNs::StructId(it),
361 ModuleDefId::EnumVariantId(it) => ValueNs::EnumVariantId(it),
362 ModuleDefId::ConstId(it) => ValueNs::ConstId(it),
363 ModuleDefId::StaticId(it) => ValueNs::StaticId(it),
365 ModuleDefId::AdtId(AdtId::EnumId(_))
366 | ModuleDefId::AdtId(AdtId::UnionId(_))
367 | ModuleDefId::TraitId(_)
368 | ModuleDefId::TypeAliasId(_)
369 | ModuleDefId::BuiltinType(_)
370 | ModuleDefId::ModuleId(_) => return None,
376 pub fn resolve_path_in_value_ns_fully(
378 db: &dyn DefDatabase,
380 ) -> Option<ValueNs> {
381 match self.resolve_path_in_value_ns(db, path)? {
382 ResolveValueResult::ValueNs(it) => Some(it),
383 ResolveValueResult::Partial(..) => None,
387 pub fn resolve_path_as_macro(
389 db: &dyn DefDatabase,
391 ) -> Option<MacroDefId> {
392 // Search item scope legacy macro first
393 if let Some(def) = self.resolve_local_macro_def(path) {
397 let (item_map, module) = self.module_scope()?;
398 item_map.resolve_path(db, module, &path, BuiltinShadowMode::Other).0.take_macros()
401 pub fn process_all_names(&self, db: &dyn DefDatabase, f: &mut dyn FnMut(Name, ScopeDef)) {
402 for scope in self.scopes.iter().rev() {
403 scope.process_names(db, f);
407 pub fn traits_in_scope(&self, db: &dyn DefDatabase) -> FxHashSet<TraitId> {
408 let mut traits = FxHashSet::default();
409 for scope in &self.scopes {
410 if let Scope::ModuleScope(m) = scope {
411 if let Some(prelude) = m.crate_def_map.prelude {
412 let prelude_def_map = db.crate_def_map(prelude.krate);
413 traits.extend(prelude_def_map[prelude.local_id].scope.traits());
415 traits.extend(m.crate_def_map[m.module_id].scope.traits());
421 fn module_scope(&self) -> Option<(&CrateDefMap, LocalModuleId)> {
422 self.scopes.iter().rev().find_map(|scope| match scope {
423 Scope::ModuleScope(m) => Some((&*m.crate_def_map, m.module_id)),
429 fn resolve_local_macro_def(&self, path: &ModPath) -> Option<MacroDefId> {
430 let name = path.as_ident()?;
431 self.scopes.iter().rev().find_map(|scope| {
432 if let Scope::LocalItemsScope(body) = scope {
433 return body.item_scope.get_legacy_macro(name);
439 pub fn module(&self) -> Option<ModuleId> {
440 let (def_map, local_id) = self.module_scope()?;
441 Some(ModuleId { krate: def_map.krate, local_id })
444 pub fn krate(&self) -> Option<CrateId> {
445 self.module_scope().map(|t| t.0.krate)
448 pub fn where_predicates_in_scope<'a>(
450 ) -> impl Iterator<Item = &'a crate::generics::WherePredicate> + 'a {
454 .filter_map(|scope| match scope {
455 Scope::GenericParams { params, .. } => Some(params),
458 .flat_map(|params| params.where_predicates.iter())
461 pub fn generic_def(&self) -> Option<GenericDefId> {
462 self.scopes.iter().rev().find_map(|scope| match scope {
463 Scope::GenericParams { def, .. } => Some(*def),
468 pub fn body_owner(&self) -> Option<DefWithBodyId> {
469 self.scopes.iter().rev().find_map(|scope| match scope {
470 Scope::ExprScope(it) => Some(it.owner),
478 ImplSelfType(ImplId),
480 GenericParam(TypeParamId),
485 fn process_names(&self, db: &dyn DefDatabase, f: &mut dyn FnMut(Name, ScopeDef)) {
486 let mut seen = FxHashSet::default();
488 Scope::ModuleScope(m) => {
489 // FIXME: should we provide `self` here?
491 // Name::self_param(),
492 // PerNs::types(Resolution::Def {
493 // def: m.module.into(),
496 m.crate_def_map[m.module_id].scope.entries().for_each(|(name, def)| {
497 f(name.clone(), ScopeDef::PerNs(def));
499 m.crate_def_map[m.module_id].scope.legacy_macros().for_each(|(name, macro_)| {
500 let scope = PerNs::macros(macro_, Visibility::Public);
501 seen.insert((name.clone(), scope));
502 f(name.clone(), ScopeDef::PerNs(scope));
504 m.crate_def_map.extern_prelude.iter().for_each(|(name, &def)| {
505 f(name.clone(), ScopeDef::PerNs(PerNs::types(def, Visibility::Public)));
507 BUILTIN_SCOPE.iter().for_each(|(name, &def)| {
508 f(name.clone(), ScopeDef::PerNs(def));
510 if let Some(prelude) = m.crate_def_map.prelude {
511 let prelude_def_map = db.crate_def_map(prelude.krate);
512 prelude_def_map[prelude.local_id].scope.entries().for_each(|(name, def)| {
513 let seen_tuple = (name.clone(), def);
514 if !seen.contains(&seen_tuple) {
515 f(seen_tuple.0, ScopeDef::PerNs(def));
520 Scope::LocalItemsScope(body) => body.item_scope.entries().for_each(|(name, def)| {
521 f(name.clone(), ScopeDef::PerNs(def));
523 Scope::GenericParams { params, def } => {
524 for (local_id, param) in params.types.iter() {
525 if let Some(name) = ¶m.name {
528 ScopeDef::GenericParam(TypeParamId { local_id, parent: *def }),
533 Scope::ImplDefScope(i) => {
534 f(name![Self], ScopeDef::ImplSelfType(*i));
536 Scope::AdtScope(i) => {
537 f(name![Self], ScopeDef::AdtSelfType(*i));
539 Scope::ExprScope(scope) => {
540 scope.expr_scopes.entries(scope.scope_id).iter().for_each(|e| {
541 f(e.name().clone(), ScopeDef::Local(e.pat()));
548 // needs arbitrary_self_types to be a method... or maybe move to the def?
549 pub fn resolver_for_expr(db: &dyn DefDatabase, owner: DefWithBodyId, expr_id: ExprId) -> Resolver {
550 let scopes = db.expr_scopes(owner);
551 resolver_for_scope(db, owner, scopes.scope_for(expr_id))
554 pub fn resolver_for_scope(
555 db: &dyn DefDatabase,
556 owner: DefWithBodyId,
557 scope_id: Option<ScopeId>,
559 let mut r = owner.resolver(db);
560 r = r.push_local_items_scope(db.body(owner));
561 let scopes = db.expr_scopes(owner);
562 let scope_chain = scopes.scope_chain(scope_id).collect::<Vec<_>>();
563 for scope in scope_chain.into_iter().rev() {
564 r = r.push_expr_scope(owner, Arc::clone(&scopes), scope);
570 fn push_scope(mut self, scope: Scope) -> Resolver {
571 self.scopes.push(scope);
575 fn push_generic_params_scope(self, db: &dyn DefDatabase, def: GenericDefId) -> Resolver {
576 let params = db.generic_params(def);
577 self.push_scope(Scope::GenericParams { def, params })
580 fn push_impl_def_scope(self, impl_def: ImplId) -> Resolver {
581 self.push_scope(Scope::ImplDefScope(impl_def))
584 fn push_module_scope(
586 crate_def_map: Arc<CrateDefMap>,
587 module_id: LocalModuleId,
589 self.push_scope(Scope::ModuleScope(ModuleItemMap { crate_def_map, module_id }))
592 fn push_local_items_scope(self, body: Arc<Body>) -> Resolver {
593 self.push_scope(Scope::LocalItemsScope(body))
598 owner: DefWithBodyId,
599 expr_scopes: Arc<ExprScopes>,
602 self.push_scope(Scope::ExprScope(ExprScope { owner, expr_scopes, scope_id }))
606 pub trait HasResolver: Copy {
607 /// Builds a resolver for type references inside this def.
608 fn resolver(self, db: &dyn DefDatabase) -> Resolver;
611 impl HasResolver for ModuleId {
612 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
613 let def_map = db.crate_def_map(self.krate);
614 Resolver::default().push_module_scope(def_map, self.local_id)
618 impl HasResolver for TraitId {
619 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
620 self.lookup(db).container.resolver(db).push_generic_params_scope(db, self.into())
624 impl<T: Into<AdtId> + Copy> HasResolver for T {
625 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
626 let def = self.into();
629 .push_generic_params_scope(db, def.into())
630 .push_scope(Scope::AdtScope(def))
634 impl HasResolver for FunctionId {
635 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
636 self.lookup(db).container.resolver(db).push_generic_params_scope(db, self.into())
640 impl HasResolver for ConstId {
641 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
642 self.lookup(db).container.resolver(db)
646 impl HasResolver for StaticId {
647 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
648 self.lookup(db).container.resolver(db)
652 impl HasResolver for TypeAliasId {
653 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
654 self.lookup(db).container.resolver(db).push_generic_params_scope(db, self.into())
658 impl HasResolver for ImplId {
659 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
663 .push_generic_params_scope(db, self.into())
664 .push_impl_def_scope(self)
668 impl HasResolver for DefWithBodyId {
669 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
671 DefWithBodyId::ConstId(c) => c.resolver(db),
672 DefWithBodyId::FunctionId(f) => f.resolver(db),
673 DefWithBodyId::StaticId(s) => s.resolver(db),
678 impl HasResolver for ContainerId {
679 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
681 ContainerId::ModuleId(it) => it.resolver(db),
682 ContainerId::DefWithBodyId(it) => it.module(db).resolver(db),
687 impl HasResolver for AssocContainerId {
688 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
690 AssocContainerId::ContainerId(it) => it.resolver(db),
691 AssocContainerId::TraitId(it) => it.resolver(db),
692 AssocContainerId::ImplId(it) => it.resolver(db),
697 impl HasResolver for GenericDefId {
698 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
700 GenericDefId::FunctionId(inner) => inner.resolver(db),
701 GenericDefId::AdtId(adt) => adt.resolver(db),
702 GenericDefId::TraitId(inner) => inner.resolver(db),
703 GenericDefId::TypeAliasId(inner) => inner.resolver(db),
704 GenericDefId::ImplId(inner) => inner.resolver(db),
705 GenericDefId::EnumVariantId(inner) => inner.parent.resolver(db),
706 GenericDefId::ConstId(inner) => inner.resolver(db),
711 impl HasResolver for VariantId {
712 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
714 VariantId::EnumVariantId(it) => it.parent.resolver(db),
715 VariantId::StructId(it) => it.resolver(db),
716 VariantId::UnionId(it) => it.resolver(db),