1 //! `NameDefinition` keeps information about the element we want to search references for.
2 //! The element is represented by `NameKind`. It's located inside some `container` and
3 //! has a `visibility`, which defines a search scope.
4 //! Note that the reference search is possible for not all of the classified items.
6 // FIXME: this badly needs rename/rewrite (matklad, 2020-02-06).
8 use arrayvec::ArrayVec;
10 Adt, AsAssocItem, AssocItem, BuiltinAttr, BuiltinType, Const, Field, Function, GenericParam,
11 HasVisibility, Impl, ItemInNs, Label, Local, MacroDef, Module, ModuleDef, Name, PathResolution,
12 Semantics, Static, ToolModule, Trait, TypeAlias, Variant, Visibility,
17 match_ast, SyntaxKind, SyntaxNode, SyntaxToken,
20 use crate::RootDatabase;
22 // FIXME: a more precise name would probably be `Symbol`?
23 #[derive(Debug, PartialEq, Eq, Copy, Clone, Hash)]
35 BuiltinType(BuiltinType),
38 GenericParam(GenericParam),
40 BuiltinAttr(BuiltinAttr),
41 ToolModule(ToolModule),
45 pub fn canonical_module_path(&self, db: &RootDatabase) -> Option<impl Iterator<Item = Module>> {
46 self.module(db).map(|it| it.path_to_root(db).into_iter().rev())
49 pub fn module(&self, db: &RootDatabase) -> Option<Module> {
50 let module = match self {
51 Definition::Macro(it) => it.module(db)?,
52 Definition::Module(it) => it.parent(db)?,
53 Definition::Field(it) => it.parent_def(db).module(db),
54 Definition::Function(it) => it.module(db),
55 Definition::Adt(it) => it.module(db),
56 Definition::Const(it) => it.module(db),
57 Definition::Static(it) => it.module(db),
58 Definition::Trait(it) => it.module(db),
59 Definition::TypeAlias(it) => it.module(db),
60 Definition::Variant(it) => it.module(db),
61 Definition::SelfType(it) => it.module(db),
62 Definition::Local(it) => it.module(db),
63 Definition::GenericParam(it) => it.module(db),
64 Definition::Label(it) => it.module(db),
65 Definition::BuiltinAttr(_) | Definition::BuiltinType(_) | Definition::ToolModule(_) => {
72 pub fn visibility(&self, db: &RootDatabase) -> Option<Visibility> {
73 let vis = match self {
74 Definition::Field(sf) => sf.visibility(db),
75 Definition::Module(it) => it.visibility(db),
76 Definition::Function(it) => it.visibility(db),
77 Definition::Adt(it) => it.visibility(db),
78 Definition::Const(it) => it.visibility(db),
79 Definition::Static(it) => it.visibility(db),
80 Definition::Trait(it) => it.visibility(db),
81 Definition::TypeAlias(it) => it.visibility(db),
82 Definition::Variant(it) => it.visibility(db),
83 Definition::BuiltinType(_) => Visibility::Public,
84 Definition::Macro(_) => return None,
85 Definition::BuiltinAttr(_)
86 | Definition::ToolModule(_)
87 | Definition::SelfType(_)
88 | Definition::Local(_)
89 | Definition::GenericParam(_)
90 | Definition::Label(_) => return None,
95 pub fn name(&self, db: &RootDatabase) -> Option<Name> {
96 let name = match self {
97 Definition::Macro(it) => it.name(db)?,
98 Definition::Field(it) => it.name(db),
99 Definition::Module(it) => it.name(db)?,
100 Definition::Function(it) => it.name(db),
101 Definition::Adt(it) => it.name(db),
102 Definition::Variant(it) => it.name(db),
103 Definition::Const(it) => it.name(db)?,
104 Definition::Static(it) => it.name(db),
105 Definition::Trait(it) => it.name(db),
106 Definition::TypeAlias(it) => it.name(db),
107 Definition::BuiltinType(it) => it.name(),
108 Definition::SelfType(_) => return None,
109 Definition::Local(it) => it.name(db)?,
110 Definition::GenericParam(it) => it.name(db),
111 Definition::Label(it) => it.name(db),
112 Definition::BuiltinAttr(_) => return None, // FIXME
113 Definition::ToolModule(_) => return None, // FIXME
119 pub enum IdentClass {
120 NameClass(NameClass),
121 NameRefClass(NameRefClass),
125 pub fn classify_node(sema: &Semantics<RootDatabase>, node: &SyntaxNode) -> Option<IdentClass> {
128 ast::Name(name) => NameClass::classify(sema, &name).map(IdentClass::NameClass),
129 ast::NameRef(name_ref) => NameRefClass::classify(sema, &name_ref).map(IdentClass::NameRefClass),
130 ast::Lifetime(lifetime) => {
131 NameClass::classify_lifetime(sema, &lifetime)
132 .map(IdentClass::NameClass)
133 .or_else(|| NameRefClass::classify_lifetime(sema, &lifetime).map(IdentClass::NameRefClass))
140 pub fn classify_token(
141 sema: &Semantics<RootDatabase>,
143 ) -> Option<IdentClass> {
144 let parent = token.parent()?;
145 Self::classify_node(sema, &parent)
148 pub fn definitions(self) -> ArrayVec<Definition, 2> {
149 let mut res = ArrayVec::new();
151 IdentClass::NameClass(NameClass::Definition(it) | NameClass::ConstReference(it)) => {
154 IdentClass::NameClass(NameClass::PatFieldShorthand { local_def, field_ref }) => {
155 res.push(Definition::Local(local_def));
156 res.push(Definition::Field(field_ref));
158 IdentClass::NameRefClass(NameRefClass::Definition(it)) => res.push(it),
159 IdentClass::NameRefClass(NameRefClass::FieldShorthand { local_ref, field_ref }) => {
160 res.push(Definition::Local(local_ref));
161 res.push(Definition::Field(field_ref));
168 /// On a first blush, a single `ast::Name` defines a single definition at some
169 /// scope. That is, that, by just looking at the syntactical category, we can
170 /// unambiguously define the semantic category.
172 /// Sadly, that's not 100% true, there are special cases. To make sure that
173 /// callers handle all the special cases correctly via exhaustive matching, we
174 /// add a [`NameClass`] enum which lists all of them!
176 /// A model special case is `None` constant in pattern.
179 Definition(Definition),
180 /// `None` in `if let None = Some(82) {}`.
181 /// Syntactically, it is a name, but semantically it is a reference.
182 ConstReference(Definition),
183 /// `field` in `if let Foo { field } = foo`. Here, `ast::Name` both introduces
184 /// a definition into a local scope, and refers to an existing definition.
192 /// `Definition` defined by this name.
193 pub fn defined(self) -> Option<Definition> {
194 let res = match self {
195 NameClass::Definition(it) => it,
196 NameClass::ConstReference(_) => return None,
197 NameClass::PatFieldShorthand { local_def, field_ref: _ } => {
198 Definition::Local(local_def)
204 pub fn classify(sema: &Semantics<RootDatabase>, name: &ast::Name) -> Option<NameClass> {
205 let _p = profile::span("classify_name");
207 let parent = name.syntax().parent()?;
209 let def = if let Some(item) = ast::Item::cast(parent.clone()) {
211 ast::Item::MacroRules(it) => {
212 Definition::Macro(sema.to_def(&ast::Macro::MacroRules(it))?)
214 ast::Item::MacroDef(it) => {
215 Definition::Macro(sema.to_def(&ast::Macro::MacroDef(it))?)
217 ast::Item::Const(it) => Definition::Const(sema.to_def(&it)?),
218 ast::Item::Fn(it) => {
219 let def = sema.to_def(&it)?;
220 def.as_proc_macro(sema.db)
221 .map(Definition::Macro)
222 .unwrap_or(Definition::Function(def))
224 ast::Item::Module(it) => Definition::Module(sema.to_def(&it)?),
225 ast::Item::Static(it) => Definition::Static(sema.to_def(&it)?),
226 ast::Item::Trait(it) => Definition::Trait(sema.to_def(&it)?),
227 ast::Item::TypeAlias(it) => Definition::TypeAlias(sema.to_def(&it)?),
228 ast::Item::Enum(it) => Definition::Adt(hir::Adt::Enum(sema.to_def(&it)?)),
229 ast::Item::Struct(it) => Definition::Adt(hir::Adt::Struct(sema.to_def(&it)?)),
230 ast::Item::Union(it) => Definition::Adt(hir::Adt::Union(sema.to_def(&it)?)),
233 } else if let Some(it) = ast::IdentPat::cast(parent.clone()) {
234 if let Some(def) = sema.resolve_bind_pat_to_const(&it) {
235 return Some(NameClass::ConstReference(Definition::from(def)));
238 let local = sema.to_def(&it)?;
239 let pat_parent = it.syntax().parent();
240 if let Some(record_pat_field) = pat_parent.and_then(ast::RecordPatField::cast) {
241 if record_pat_field.name_ref().is_none() {
242 if let Some(field) = sema.resolve_record_pat_field(&record_pat_field) {
243 return Some(NameClass::PatFieldShorthand {
251 Definition::Local(local)
252 } else if let Some(it) = ast::Rename::cast(parent.clone()) {
253 if let Some(use_tree) = it.syntax().parent().and_then(ast::UseTree::cast) {
254 let path = use_tree.path()?;
255 let path_segment = path.segment()?;
256 let name_ref = path_segment.name_ref()?;
257 let name_ref = if name_ref.self_token().is_some() {
262 // Skip over UseTreeList
264 let use_tree = it.parent().and_then(ast::UseTree::cast)?;
265 let path = use_tree.path()?;
266 let path_segment = path.segment()?;
267 path_segment.name_ref()
273 let name_ref_class = NameRefClass::classify(sema, &name_ref)?;
275 match name_ref_class {
276 NameRefClass::Definition(def) => def,
277 NameRefClass::FieldShorthand { local_ref: _, field_ref } => {
278 Definition::Field(field_ref)
282 let extern_crate = it.syntax().parent().and_then(ast::ExternCrate::cast)?;
283 let krate = sema.resolve_extern_crate(&extern_crate)?;
284 let root_module = krate.root_module(sema.db);
285 Definition::Module(root_module)
290 ast::SelfParam(it) => Definition::Local(sema.to_def(&it)?),
291 ast::RecordField(it) => Definition::Field(sema.to_def(&it)?),
292 ast::Variant(it) => Definition::Variant(sema.to_def(&it)?),
293 ast::TypeParam(it) => Definition::GenericParam(sema.to_def(&it)?.into()),
294 ast::ConstParam(it) => Definition::GenericParam(sema.to_def(&it)?.into()),
300 Some(NameClass::Definition(def))
303 pub fn classify_lifetime(
304 sema: &Semantics<RootDatabase>,
305 lifetime: &ast::Lifetime,
306 ) -> Option<NameClass> {
307 let _p = profile::span("classify_lifetime").detail(|| lifetime.to_string());
308 let parent = lifetime.syntax().parent()?;
312 ast::LifetimeParam(it) => {
313 let def = sema.to_def(&it)?;
314 Some(NameClass::Definition(Definition::GenericParam(def.into())))
317 let def = sema.to_def(&it)?;
318 Some(NameClass::Definition(Definition::Label(def)))
326 /// This is similar to [`NameClass`], but works for [`ast::NameRef`] rather than
327 /// for [`ast::Name`]. Similarly, what looks like a reference in syntax is a
328 /// reference most of the time, but there are a couple of annoying exceptions.
330 /// A model special case is field shorthand syntax, which uses a single
331 /// reference to point to two different defs.
333 pub enum NameRefClass {
334 Definition(Definition),
335 FieldShorthand { local_ref: Local, field_ref: Field },
339 // Note: we don't have unit-tests for this rather important function.
340 // It is primarily exercised via goto definition tests in `ide`.
342 sema: &Semantics<RootDatabase>,
343 name_ref: &ast::NameRef,
344 ) -> Option<NameRefClass> {
345 let _p = profile::span("classify_name_ref").detail(|| name_ref.to_string());
347 let parent = name_ref.syntax().parent()?;
349 if let Some(record_field) = ast::RecordExprField::for_field_name(name_ref) {
350 if let Some((field, local, _)) = sema.resolve_record_field(&record_field) {
351 let res = match local {
352 None => NameRefClass::Definition(Definition::Field(field)),
354 NameRefClass::FieldShorthand { field_ref: field, local_ref: local }
361 if let Some(path) = ast::PathSegment::cast(parent.clone()).map(|it| it.parent_path()) {
362 if path.parent_path().is_none() {
363 if let Some(macro_call) = path.syntax().parent().and_then(ast::MacroCall::cast) {
364 // Only use this to resolve to macro calls for last segments as qualifiers resolve
366 if let Some(macro_def) = sema.resolve_macro_call(¯o_call) {
367 return Some(NameRefClass::Definition(Definition::Macro(macro_def)));
371 return sema.resolve_path(&path).map(Into::into).map(NameRefClass::Definition);
376 ast::MethodCallExpr(method_call) => {
377 sema.resolve_method_call(&method_call)
378 .map(Definition::Function)
379 .map(NameRefClass::Definition)
381 ast::FieldExpr(field_expr) => {
382 sema.resolve_field(&field_expr)
383 .map(Definition::Field)
384 .map(NameRefClass::Definition)
386 ast::RecordPatField(record_pat_field) => {
387 sema.resolve_record_pat_field(&record_pat_field)
388 .map(Definition::Field)
389 .map(NameRefClass::Definition)
391 ast::AssocTypeArg(_) => {
392 // `Trait<Assoc = Ty>`
394 let containing_path = name_ref.syntax().ancestors().find_map(ast::Path::cast)?;
395 let resolved = sema.resolve_path(&containing_path)?;
396 if let PathResolution::Def(ModuleDef::Trait(tr)) = resolved {
397 // FIXME: resolve in supertraits
401 .filter_map(|&assoc| match assoc {
402 hir::AssocItem::TypeAlias(it) => Some(it),
405 .find(|alias| alias.name(sema.db).to_smol_str() == name_ref.text().as_str())
407 return Some(NameRefClass::Definition(Definition::TypeAlias(ty)));
412 ast::ExternCrate(extern_crate) => {
413 let krate = sema.resolve_extern_crate(&extern_crate)?;
414 let root_module = krate.root_module(sema.db);
415 Some(NameRefClass::Definition(Definition::Module(root_module)))
422 pub fn classify_lifetime(
423 sema: &Semantics<RootDatabase>,
424 lifetime: &ast::Lifetime,
425 ) -> Option<NameRefClass> {
426 let _p = profile::span("classify_lifetime_ref").detail(|| lifetime.to_string());
427 let parent = lifetime.syntax().parent()?;
428 match parent.kind() {
429 SyntaxKind::BREAK_EXPR | SyntaxKind::CONTINUE_EXPR => {
430 sema.resolve_label(lifetime).map(Definition::Label).map(NameRefClass::Definition)
432 SyntaxKind::LIFETIME_ARG
433 | SyntaxKind::SELF_PARAM
434 | SyntaxKind::TYPE_BOUND
435 | SyntaxKind::WHERE_PRED
436 | SyntaxKind::REF_TYPE => sema
437 .resolve_lifetime_param(lifetime)
438 .map(GenericParam::LifetimeParam)
439 .map(Definition::GenericParam)
440 .map(NameRefClass::Definition),
441 // lifetime bounds, as in the 'b in 'a: 'b aren't wrapped in TypeBound nodes so we gotta check
442 // if our lifetime is in a LifetimeParam without being the constrained lifetime
443 _ if ast::LifetimeParam::cast(parent).and_then(|param| param.lifetime()).as_ref()
446 sema.resolve_lifetime_param(lifetime)
447 .map(GenericParam::LifetimeParam)
448 .map(Definition::GenericParam)
449 .map(NameRefClass::Definition)
457 Field, Module, Function, Adt, Variant, Const, Static, Trait, TypeAlias, BuiltinType, Local,
462 impl From<Impl> for Definition {
463 fn from(impl_: Impl) -> Self {
464 Definition::SelfType(impl_)
468 impl AsAssocItem for Definition {
469 fn as_assoc_item(self, db: &dyn hir::db::HirDatabase) -> Option<AssocItem> {
471 Definition::Function(it) => it.as_assoc_item(db),
472 Definition::Const(it) => it.as_assoc_item(db),
473 Definition::TypeAlias(it) => it.as_assoc_item(db),
479 impl From<AssocItem> for Definition {
480 fn from(assoc_item: AssocItem) -> Self {
482 AssocItem::Function(it) => Definition::Function(it),
483 AssocItem::Const(it) => Definition::Const(it),
484 AssocItem::TypeAlias(it) => Definition::TypeAlias(it),
489 impl From<PathResolution> for Definition {
490 fn from(path_resolution: PathResolution) -> Self {
491 match path_resolution {
492 PathResolution::Def(def) => def.into(),
493 PathResolution::AssocItem(item) => {
494 let def: ModuleDef = match item {
495 hir::AssocItem::Function(it) => it.into(),
496 hir::AssocItem::Const(it) => it.into(),
497 hir::AssocItem::TypeAlias(it) => it.into(),
501 PathResolution::Local(local) => Definition::Local(local),
502 PathResolution::TypeParam(par) => Definition::GenericParam(par.into()),
503 PathResolution::Macro(def) => Definition::Macro(def),
504 PathResolution::SelfType(impl_def) => Definition::SelfType(impl_def),
505 PathResolution::ConstParam(par) => Definition::GenericParam(par.into()),
506 PathResolution::BuiltinAttr(attr) => Definition::BuiltinAttr(attr),
507 PathResolution::ToolModule(tool) => Definition::ToolModule(tool),
512 impl From<ModuleDef> for Definition {
513 fn from(def: ModuleDef) -> Self {
515 ModuleDef::Module(it) => Definition::Module(it),
516 ModuleDef::Function(it) => Definition::Function(it),
517 ModuleDef::Adt(it) => Definition::Adt(it),
518 ModuleDef::Variant(it) => Definition::Variant(it),
519 ModuleDef::Const(it) => Definition::Const(it),
520 ModuleDef::Static(it) => Definition::Static(it),
521 ModuleDef::Trait(it) => Definition::Trait(it),
522 ModuleDef::TypeAlias(it) => Definition::TypeAlias(it),
523 ModuleDef::BuiltinType(it) => Definition::BuiltinType(it),
528 impl From<Definition> for Option<ItemInNs> {
529 fn from(def: Definition) -> Self {
530 let item = match def {
531 Definition::Module(it) => ModuleDef::Module(it),
532 Definition::Function(it) => ModuleDef::Function(it),
533 Definition::Adt(it) => ModuleDef::Adt(it),
534 Definition::Variant(it) => ModuleDef::Variant(it),
535 Definition::Const(it) => ModuleDef::Const(it),
536 Definition::Static(it) => ModuleDef::Static(it),
537 Definition::Trait(it) => ModuleDef::Trait(it),
538 Definition::TypeAlias(it) => ModuleDef::TypeAlias(it),
539 Definition::BuiltinType(it) => ModuleDef::BuiltinType(it),
542 Some(ItemInNs::from(item))