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, ConstParamId, ContainerId, DefWithBodyId, EnumId,
24 EnumVariantId, FunctionId, GenericDefId, GenericParamId, HasModule, ImplId, LifetimeParamId,
25 LocalModuleId, Lookup, ModuleDefId, ModuleId, StaticId, StructId, TraitId, TypeAliasId,
26 TypeParamId, VariantId,
29 #[derive(Debug, Clone, Default)]
31 // FIXME: all usages generally call `.rev`, so maybe reverse once in construction?
35 // FIXME how to store these best
36 #[derive(Debug, Clone)]
37 struct ModuleItemMap {
38 crate_def_map: Arc<DefMap>,
39 module_id: LocalModuleId,
42 #[derive(Debug, Clone)]
45 expr_scopes: Arc<ExprScopes>,
49 #[derive(Debug, Clone)]
51 /// All the items and imported names of a module
52 ModuleScope(ModuleItemMap),
53 /// Brings the generic parameters of an item into scope
54 GenericParams { def: GenericDefId, params: Arc<GenericParams> },
55 /// Brings `Self` in `impl` block into scope
57 /// Brings `Self` in enum, struct and union definitions into scope
61 /// Temporary hack to support local items.
62 LocalItemsScope(Arc<Body>),
65 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
68 GenericParam(TypeParamId),
71 // Yup, enum variants are added to the types ns, but any usage of variant as
73 EnumVariantId(EnumVariantId),
74 TypeAliasId(TypeAliasId),
75 BuiltinType(BuiltinType),
77 // Module belong to type ns, but the resolver is used when all module paths
78 // are fully resolved.
82 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
83 pub enum ResolveValueResult {
85 Partial(TypeNs, usize),
88 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
92 FunctionId(FunctionId),
96 EnumVariantId(EnumVariantId),
97 GenericParam(ConstParamId),
101 /// Resolve known trait from std, like `std::futures::Future`
102 pub fn resolve_known_trait(&self, db: &dyn DefDatabase, path: &ModPath) -> Option<TraitId> {
103 let res = self.resolve_module_path(db, path, BuiltinShadowMode::Other).take_types()?;
105 ModuleDefId::TraitId(it) => Some(it),
110 /// Resolve known struct from std, like `std::boxed::Box`
111 pub fn resolve_known_struct(&self, db: &dyn DefDatabase, path: &ModPath) -> Option<StructId> {
112 let res = self.resolve_module_path(db, path, BuiltinShadowMode::Other).take_types()?;
114 ModuleDefId::AdtId(AdtId::StructId(it)) => Some(it),
119 /// Resolve known enum from std, like `std::result::Result`
120 pub fn resolve_known_enum(&self, db: &dyn DefDatabase, path: &ModPath) -> Option<EnumId> {
121 let res = self.resolve_module_path(db, path, BuiltinShadowMode::Other).take_types()?;
123 ModuleDefId::AdtId(AdtId::EnumId(it)) => Some(it),
128 fn resolve_module_path(
130 db: &dyn DefDatabase,
132 shadow: BuiltinShadowMode,
134 let (item_map, module) = match self.module_scope() {
136 None => return PerNs::none(),
138 let (module_res, segment_index) = item_map.resolve_path(db, module, &path, shadow);
139 if segment_index.is_some() {
140 return PerNs::none();
145 pub fn resolve_module_path_in_items(&self, db: &dyn DefDatabase, path: &ModPath) -> PerNs {
146 self.resolve_module_path(db, path, BuiltinShadowMode::Module)
149 pub fn resolve_path_in_type_ns(
151 db: &dyn DefDatabase,
153 ) -> Option<(TypeNs, Option<usize>)> {
154 let first_name = path.segments.first()?;
155 let skip_to_mod = path.kind != PathKind::Plain;
156 for scope in self.scopes.iter().rev() {
158 Scope::ExprScope(_) => continue,
159 Scope::GenericParams { .. }
160 | Scope::ImplDefScope(_)
161 | Scope::LocalItemsScope(_)
167 Scope::GenericParams { params, def } => {
168 if let Some(local_id) = params.find_type_by_name(first_name) {
169 let idx = if path.segments.len() == 1 { None } else { Some(1) };
171 TypeNs::GenericParam(TypeParamId { local_id, parent: *def }),
176 Scope::ImplDefScope(impl_) => {
177 if first_name == &name![Self] {
178 let idx = if path.segments.len() == 1 { None } else { Some(1) };
179 return Some((TypeNs::SelfType(*impl_), idx));
182 Scope::AdtScope(adt) => {
183 if first_name == &name![Self] {
184 let idx = if path.segments.len() == 1 { None } else { Some(1) };
185 return Some((TypeNs::AdtSelfType(*adt), idx));
188 Scope::ModuleScope(m) => {
189 let (module_def, idx) = m.crate_def_map.resolve_path(
193 BuiltinShadowMode::Other,
195 let res = to_type_ns(module_def)?;
196 return Some((res, idx));
198 Scope::LocalItemsScope(body) => {
199 let def = body.item_scope.get(first_name);
200 if let Some(res) = to_type_ns(def) {
201 return Some((res, None));
207 fn to_type_ns(per_ns: PerNs) -> Option<TypeNs> {
208 let res = match per_ns.take_types()? {
209 ModuleDefId::AdtId(it) => TypeNs::AdtId(it),
210 ModuleDefId::EnumVariantId(it) => TypeNs::EnumVariantId(it),
212 ModuleDefId::TypeAliasId(it) => TypeNs::TypeAliasId(it),
213 ModuleDefId::BuiltinType(it) => TypeNs::BuiltinType(it),
215 ModuleDefId::TraitId(it) => TypeNs::TraitId(it),
217 ModuleDefId::FunctionId(_)
218 | ModuleDefId::ConstId(_)
219 | ModuleDefId::StaticId(_)
220 | ModuleDefId::ModuleId(_) => return None,
226 pub fn resolve_path_in_type_ns_fully(
228 db: &dyn DefDatabase,
230 ) -> Option<TypeNs> {
231 let (res, unresolved) = self.resolve_path_in_type_ns(db, path)?;
232 if unresolved.is_some() {
238 pub fn resolve_visibility(
240 db: &dyn DefDatabase,
241 visibility: &RawVisibility,
242 ) -> Option<Visibility> {
244 RawVisibility::Module(_) => {
245 let (item_map, module) = match self.module_scope() {
249 item_map.resolve_visibility(db, module, visibility)
251 RawVisibility::Public => Some(Visibility::Public),
255 pub fn resolve_path_in_value_ns(
257 db: &dyn DefDatabase,
259 ) -> Option<ResolveValueResult> {
260 let n_segments = path.segments.len();
261 let tmp = name![self];
262 let first_name = if path.is_self() { &tmp } else { path.segments.first()? };
263 let skip_to_mod = path.kind != PathKind::Plain && !path.is_self();
264 for scope in self.scopes.iter().rev() {
267 | Scope::ExprScope(_)
268 | Scope::GenericParams { .. }
269 | Scope::ImplDefScope(_)
270 | Scope::LocalItemsScope(_)
276 Scope::ExprScope(scope) if n_segments <= 1 => {
279 .entries(scope.scope_id)
281 .find(|entry| entry.name() == first_name);
283 if let Some(e) = entry {
284 return Some(ResolveValueResult::ValueNs(ValueNs::LocalBinding(e.pat())));
287 Scope::ExprScope(_) => continue,
289 Scope::GenericParams { params, def } if n_segments > 1 => {
290 if let Some(local_id) = params.find_type_by_name(first_name) {
291 let ty = TypeNs::GenericParam(TypeParamId { local_id, parent: *def });
292 return Some(ResolveValueResult::Partial(ty, 1));
295 Scope::GenericParams { params, def } if n_segments == 1 => {
296 if let Some(local_id) = params.find_const_by_name(first_name) {
297 let val = ValueNs::GenericParam(ConstParamId { local_id, parent: *def });
298 return Some(ResolveValueResult::ValueNs(val));
301 Scope::GenericParams { .. } => continue,
303 Scope::ImplDefScope(impl_) => {
304 if first_name == &name![Self] {
306 let ty = TypeNs::SelfType(*impl_);
307 return Some(ResolveValueResult::Partial(ty, 1));
309 return Some(ResolveValueResult::ValueNs(ValueNs::ImplSelf(*impl_)));
313 Scope::AdtScope(adt) => {
315 // bare `Self` doesn't work in the value namespace in a struct/enum definition
318 if first_name == &name![Self] {
319 let ty = TypeNs::AdtSelfType(*adt);
320 return Some(ResolveValueResult::Partial(ty, 1));
324 Scope::ModuleScope(m) => {
325 let (module_def, idx) = m.crate_def_map.resolve_path(
329 BuiltinShadowMode::Other,
333 let value = to_value_ns(module_def)?;
334 Some(ResolveValueResult::ValueNs(value))
337 let ty = match module_def.take_types()? {
338 ModuleDefId::AdtId(it) => TypeNs::AdtId(it),
339 ModuleDefId::TraitId(it) => TypeNs::TraitId(it),
340 ModuleDefId::TypeAliasId(it) => TypeNs::TypeAliasId(it),
341 ModuleDefId::BuiltinType(it) => TypeNs::BuiltinType(it),
343 ModuleDefId::ModuleId(_)
344 | ModuleDefId::FunctionId(_)
345 | ModuleDefId::EnumVariantId(_)
346 | ModuleDefId::ConstId(_)
347 | ModuleDefId::StaticId(_) => return None,
349 Some(ResolveValueResult::Partial(ty, idx))
353 Scope::LocalItemsScope(body) => {
354 // we don't bother looking in the builtin scope here because there are no builtin values
355 let def = to_value_ns(body.item_scope.get(first_name));
357 if let Some(res) = def {
358 return Some(ResolveValueResult::ValueNs(res));
365 fn to_value_ns(per_ns: PerNs) -> Option<ValueNs> {
366 let res = match per_ns.take_values()? {
367 ModuleDefId::FunctionId(it) => ValueNs::FunctionId(it),
368 ModuleDefId::AdtId(AdtId::StructId(it)) => ValueNs::StructId(it),
369 ModuleDefId::EnumVariantId(it) => ValueNs::EnumVariantId(it),
370 ModuleDefId::ConstId(it) => ValueNs::ConstId(it),
371 ModuleDefId::StaticId(it) => ValueNs::StaticId(it),
373 ModuleDefId::AdtId(AdtId::EnumId(_))
374 | ModuleDefId::AdtId(AdtId::UnionId(_))
375 | ModuleDefId::TraitId(_)
376 | ModuleDefId::TypeAliasId(_)
377 | ModuleDefId::BuiltinType(_)
378 | ModuleDefId::ModuleId(_) => return None,
384 pub fn resolve_path_in_value_ns_fully(
386 db: &dyn DefDatabase,
388 ) -> Option<ValueNs> {
389 match self.resolve_path_in_value_ns(db, path)? {
390 ResolveValueResult::ValueNs(it) => Some(it),
391 ResolveValueResult::Partial(..) => None,
395 pub fn resolve_path_as_macro(
397 db: &dyn DefDatabase,
399 ) -> Option<MacroDefId> {
400 // Search item scope legacy macro first
401 if let Some(def) = self.resolve_local_macro_def(path) {
405 let (item_map, module) = self.module_scope()?;
406 item_map.resolve_path(db, module, &path, BuiltinShadowMode::Other).0.take_macros()
409 pub fn process_all_names(&self, db: &dyn DefDatabase, f: &mut dyn FnMut(Name, ScopeDef)) {
410 for scope in self.scopes.iter().rev() {
411 scope.process_names(db, f);
415 pub fn traits_in_scope(&self, db: &dyn DefDatabase) -> FxHashSet<TraitId> {
416 let mut traits = FxHashSet::default();
417 for scope in &self.scopes {
418 if let Scope::ModuleScope(m) = scope {
419 if let Some(prelude) = m.crate_def_map.prelude {
420 let prelude_def_map = db.crate_def_map(prelude.krate);
421 traits.extend(prelude_def_map[prelude.local_id].scope.traits());
423 traits.extend(m.crate_def_map[m.module_id].scope.traits());
429 fn module_scope(&self) -> Option<(&DefMap, LocalModuleId)> {
430 self.scopes.iter().rev().find_map(|scope| match scope {
431 Scope::ModuleScope(m) => Some((&*m.crate_def_map, m.module_id)),
437 fn resolve_local_macro_def(&self, path: &ModPath) -> Option<MacroDefId> {
438 let name = path.as_ident()?;
439 self.scopes.iter().rev().find_map(|scope| {
440 if let Scope::LocalItemsScope(body) = scope {
441 return body.item_scope.get_legacy_macro(name);
447 pub fn module(&self) -> Option<ModuleId> {
448 let (def_map, local_id) = self.module_scope()?;
449 Some(ModuleId { krate: def_map.krate, local_id })
452 pub fn krate(&self) -> Option<CrateId> {
453 self.module_scope().map(|t| t.0.krate)
456 pub fn where_predicates_in_scope<'a>(
458 ) -> impl Iterator<Item = &'a crate::generics::WherePredicate> + 'a {
462 .filter_map(|scope| match scope {
463 Scope::GenericParams { params, .. } => Some(params),
466 .flat_map(|params| params.where_predicates.iter())
469 pub fn generic_def(&self) -> Option<GenericDefId> {
470 self.scopes.iter().rev().find_map(|scope| match scope {
471 Scope::GenericParams { def, .. } => Some(*def),
476 pub fn body_owner(&self) -> Option<DefWithBodyId> {
477 self.scopes.iter().rev().find_map(|scope| match scope {
478 Scope::ExprScope(it) => Some(it.owner),
486 ImplSelfType(ImplId),
488 GenericParam(GenericParamId),
493 fn process_names(&self, db: &dyn DefDatabase, f: &mut dyn FnMut(Name, ScopeDef)) {
494 let mut seen = FxHashSet::default();
496 Scope::ModuleScope(m) => {
497 // FIXME: should we provide `self` here?
499 // Name::self_param(),
500 // PerNs::types(Resolution::Def {
501 // def: m.module.into(),
504 m.crate_def_map[m.module_id].scope.entries().for_each(|(name, def)| {
505 f(name.clone(), ScopeDef::PerNs(def));
507 m.crate_def_map[m.module_id].scope.legacy_macros().for_each(|(name, macro_)| {
508 let scope = PerNs::macros(macro_, Visibility::Public);
509 seen.insert((name.clone(), scope));
510 f(name.clone(), ScopeDef::PerNs(scope));
512 m.crate_def_map.extern_prelude.iter().for_each(|(name, &def)| {
513 f(name.clone(), ScopeDef::PerNs(PerNs::types(def, Visibility::Public)));
515 BUILTIN_SCOPE.iter().for_each(|(name, &def)| {
516 f(name.clone(), ScopeDef::PerNs(def));
518 if let Some(prelude) = m.crate_def_map.prelude {
519 let prelude_def_map = db.crate_def_map(prelude.krate);
520 prelude_def_map[prelude.local_id].scope.entries().for_each(|(name, def)| {
521 let seen_tuple = (name.clone(), def);
522 if !seen.contains(&seen_tuple) {
523 f(seen_tuple.0, ScopeDef::PerNs(def));
528 Scope::LocalItemsScope(body) => body.item_scope.entries().for_each(|(name, def)| {
529 f(name.clone(), ScopeDef::PerNs(def));
531 &Scope::GenericParams { ref params, def: parent } => {
532 for (local_id, param) in params.types.iter() {
533 if let Some(ref name) = param.name {
534 let id = TypeParamId { local_id, parent };
535 f(name.clone(), ScopeDef::GenericParam(id.into()))
538 for (local_id, param) in params.consts.iter() {
539 let id = ConstParamId { local_id, parent };
540 f(param.name.clone(), ScopeDef::GenericParam(id.into()))
542 for (local_id, param) in params.lifetimes.iter() {
543 let id = LifetimeParamId { local_id, parent };
544 f(param.name.clone(), ScopeDef::GenericParam(id.into()))
547 Scope::ImplDefScope(i) => {
548 f(name![Self], ScopeDef::ImplSelfType(*i));
550 Scope::AdtScope(i) => {
551 f(name![Self], ScopeDef::AdtSelfType(*i));
553 Scope::ExprScope(scope) => {
554 scope.expr_scopes.entries(scope.scope_id).iter().for_each(|e| {
555 f(e.name().clone(), ScopeDef::Local(e.pat()));
562 // needs arbitrary_self_types to be a method... or maybe move to the def?
563 pub fn resolver_for_expr(db: &dyn DefDatabase, owner: DefWithBodyId, expr_id: ExprId) -> Resolver {
564 let scopes = db.expr_scopes(owner);
565 resolver_for_scope(db, owner, scopes.scope_for(expr_id))
568 pub fn resolver_for_scope(
569 db: &dyn DefDatabase,
570 owner: DefWithBodyId,
571 scope_id: Option<ScopeId>,
573 let mut r = owner.resolver(db);
574 r = r.push_local_items_scope(db.body(owner));
575 let scopes = db.expr_scopes(owner);
576 let scope_chain = scopes.scope_chain(scope_id).collect::<Vec<_>>();
577 for scope in scope_chain.into_iter().rev() {
578 r = r.push_expr_scope(owner, Arc::clone(&scopes), scope);
584 fn push_scope(mut self, scope: Scope) -> Resolver {
585 self.scopes.push(scope);
589 fn push_generic_params_scope(self, db: &dyn DefDatabase, def: GenericDefId) -> Resolver {
590 let params = db.generic_params(def);
591 self.push_scope(Scope::GenericParams { def, params })
594 fn push_impl_def_scope(self, impl_def: ImplId) -> Resolver {
595 self.push_scope(Scope::ImplDefScope(impl_def))
598 fn push_module_scope(self, crate_def_map: Arc<DefMap>, module_id: LocalModuleId) -> Resolver {
599 self.push_scope(Scope::ModuleScope(ModuleItemMap { crate_def_map, module_id }))
602 fn push_local_items_scope(self, body: Arc<Body>) -> Resolver {
603 self.push_scope(Scope::LocalItemsScope(body))
608 owner: DefWithBodyId,
609 expr_scopes: Arc<ExprScopes>,
612 self.push_scope(Scope::ExprScope(ExprScope { owner, expr_scopes, scope_id }))
616 pub trait HasResolver: Copy {
617 /// Builds a resolver for type references inside this def.
618 fn resolver(self, db: &dyn DefDatabase) -> Resolver;
621 impl HasResolver for ModuleId {
622 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
623 let def_map = db.crate_def_map(self.krate);
624 Resolver::default().push_module_scope(def_map, self.local_id)
628 impl HasResolver for TraitId {
629 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
630 self.lookup(db).container.resolver(db).push_generic_params_scope(db, self.into())
634 impl<T: Into<AdtId> + Copy> HasResolver for T {
635 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
636 let def = self.into();
639 .push_generic_params_scope(db, def.into())
640 .push_scope(Scope::AdtScope(def))
644 impl HasResolver for FunctionId {
645 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
646 self.lookup(db).container.resolver(db).push_generic_params_scope(db, self.into())
650 impl HasResolver for ConstId {
651 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
652 self.lookup(db).container.resolver(db)
656 impl HasResolver for StaticId {
657 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
658 self.lookup(db).container.resolver(db)
662 impl HasResolver for TypeAliasId {
663 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
664 self.lookup(db).container.resolver(db).push_generic_params_scope(db, self.into())
668 impl HasResolver for ImplId {
669 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
673 .push_generic_params_scope(db, self.into())
674 .push_impl_def_scope(self)
678 impl HasResolver for DefWithBodyId {
679 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
681 DefWithBodyId::ConstId(c) => c.resolver(db),
682 DefWithBodyId::FunctionId(f) => f.resolver(db),
683 DefWithBodyId::StaticId(s) => s.resolver(db),
688 impl HasResolver for ContainerId {
689 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
691 ContainerId::ModuleId(it) => it.resolver(db),
692 ContainerId::DefWithBodyId(it) => it.module(db).resolver(db),
697 impl HasResolver for AssocContainerId {
698 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
700 AssocContainerId::ContainerId(it) => it.resolver(db),
701 AssocContainerId::TraitId(it) => it.resolver(db),
702 AssocContainerId::ImplId(it) => it.resolver(db),
707 impl HasResolver for GenericDefId {
708 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
710 GenericDefId::FunctionId(inner) => inner.resolver(db),
711 GenericDefId::AdtId(adt) => adt.resolver(db),
712 GenericDefId::TraitId(inner) => inner.resolver(db),
713 GenericDefId::TypeAliasId(inner) => inner.resolver(db),
714 GenericDefId::ImplId(inner) => inner.resolver(db),
715 GenericDefId::EnumVariantId(inner) => inner.parent.resolver(db),
716 GenericDefId::ConstId(inner) => inner.resolver(db),
721 impl HasResolver for VariantId {
722 fn resolver(self, db: &dyn DefDatabase) -> Resolver {
724 VariantId::EnumVariantId(it) => it.parent.resolver(db),
725 VariantId::StructId(it) => it.resolver(db),
726 VariantId::UnionId(it) => it.resolver(db),