src/tools/rust-analyzer/crates/ide-db/src/search.rs

   1 //! Implementation of find-usages functionality.
   2 //!
   3 //! It is based on the standard ide trick: first, we run a fast text search to
   4 //! get a super-set of matches. Then, we we confirm each match using precise
   5 //! name resolution.
   6
   7 use std::{mem, sync::Arc};
   8
   9 use base_db::{FileId, FileRange, SourceDatabase, SourceDatabaseExt};
  10 use hir::{DefWithBody, HasAttrs, HasSource, InFile, ModuleSource, Semantics, Visibility};
  11 use once_cell::unsync::Lazy;
  12 use stdx::hash::NoHashHashMap;
  13 use syntax::{ast, match_ast, AstNode, TextRange, TextSize};
  14
  15 use crate::{
  16     defs::{Definition, NameClass, NameRefClass},
  17     traits::{as_trait_assoc_def, convert_to_def_in_trait},
  18     RootDatabase,
  19 };
  20
  21 #[derive(Debug, Default, Clone)]
  22 pub struct UsageSearchResult {
  23     pub references: NoHashHashMap<FileId, Vec<FileReference>>,
  24 }
  25
  26 impl UsageSearchResult {
  27     pub fn is_empty(&self) -> bool {
  28         self.references.is_empty()
  29     }
  30
  31     pub fn len(&self) -> usize {
  32         self.references.len()
  33     }
  34
  35     pub fn iter(&self) -> impl Iterator<Item = (&FileId, &[FileReference])> + '_ {
  36         self.references.iter().map(|(file_id, refs)| (file_id, &**refs))
  37     }
  38
  39     pub fn file_ranges(&self) -> impl Iterator<Item = FileRange> + '_ {
  40         self.references.iter().flat_map(|(&file_id, refs)| {
  41             refs.iter().map(move |&FileReference { range, .. }| FileRange { file_id, range })
  42         })
  43     }
  44 }
  45
  46 impl IntoIterator for UsageSearchResult {
  47     type Item = (FileId, Vec<FileReference>);
  48     type IntoIter = <NoHashHashMap<FileId, Vec<FileReference>> as IntoIterator>::IntoIter;
  49
  50     fn into_iter(self) -> Self::IntoIter {
  51         self.references.into_iter()
  52     }
  53 }
  54
  55 #[derive(Debug, Clone)]
  56 pub struct FileReference {
  57     /// The range of the reference in the original file
  58     pub range: TextRange,
  59     /// The node of the reference in the (macro-)file
  60     pub name: ast::NameLike,
  61     pub category: Option<ReferenceCategory>,
  62 }
  63
  64 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
  65 pub enum ReferenceCategory {
  66     // FIXME: Add this variant and delete the `retain_adt_literal_usages` function.
  67     // Create
  68     Write,
  69     Read,
  70     // FIXME: Some day should be able to search in doc comments. Would probably
  71     // need to switch from enum to bitflags then?
  72     // DocComment
  73 }
  74
  75 /// Generally, `search_scope` returns files that might contain references for the element.
  76 /// For `pub(crate)` things it's a crate, for `pub` things it's a crate and dependant crates.
  77 /// In some cases, the location of the references is known to within a `TextRange`,
  78 /// e.g. for things like local variables.
  79 #[derive(Clone, Debug)]
  80 pub struct SearchScope {
  81     entries: NoHashHashMap<FileId, Option<TextRange>>,
  82 }
  83
  84 impl SearchScope {
  85     fn new(entries: NoHashHashMap<FileId, Option<TextRange>>) -> SearchScope {
  86         SearchScope { entries }
  87     }
  88
  89     /// Build a search scope spanning the entire crate graph of files.
  90     fn crate_graph(db: &RootDatabase) -> SearchScope {
  91         let mut entries = NoHashHashMap::default();
  92
  93         let graph = db.crate_graph();
  94         for krate in graph.iter() {
  95             let root_file = graph[krate].root_file_id;
  96             let source_root_id = db.file_source_root(root_file);
  97             let source_root = db.source_root(source_root_id);
  98             entries.extend(source_root.iter().map(|id| (id, None)));
  99         }
 100         SearchScope { entries }
 101     }
 102
 103     /// Build a search scope spanning all the reverse dependencies of the given crate.
 104     fn reverse_dependencies(db: &RootDatabase, of: hir::Crate) -> SearchScope {
 105         let mut entries = NoHashHashMap::default();
 106         for rev_dep in of.transitive_reverse_dependencies(db) {
 107             let root_file = rev_dep.root_file(db);
 108             let source_root_id = db.file_source_root(root_file);
 109             let source_root = db.source_root(source_root_id);
 110             entries.extend(source_root.iter().map(|id| (id, None)));
 111         }
 112         SearchScope { entries }
 113     }
 114
 115     /// Build a search scope spanning the given crate.
 116     fn krate(db: &RootDatabase, of: hir::Crate) -> SearchScope {
 117         let root_file = of.root_file(db);
 118         let source_root_id = db.file_source_root(root_file);
 119         let source_root = db.source_root(source_root_id);
 120         SearchScope { entries: source_root.iter().map(|id| (id, None)).collect() }
 121     }
 122
 123     /// Build a search scope spanning the given module and all its submodules.
 124     fn module_and_children(db: &RootDatabase, module: hir::Module) -> SearchScope {
 125         let mut entries = NoHashHashMap::default();
 126
 127         let (file_id, range) = {
 128             let InFile { file_id, value } = module.definition_source(db);
 129             if let Some((file_id, call_source)) = file_id.original_call_node(db) {
 130                 (file_id, Some(call_source.text_range()))
 131             } else {
 132                 (
 133                     file_id.original_file(db),
 134                     match value {
 135                         ModuleSource::SourceFile(_) => None,
 136                         ModuleSource::Module(it) => Some(it.syntax().text_range()),
 137                         ModuleSource::BlockExpr(it) => Some(it.syntax().text_range()),
 138                     },
 139                 )
 140             }
 141         };
 142         entries.insert(file_id, range);
 143
 144         let mut to_visit: Vec<_> = module.children(db).collect();
 145         while let Some(module) = to_visit.pop() {
 146             if let InFile { file_id, value: ModuleSource::SourceFile(_) } =
 147                 module.definition_source(db)
 148             {
 149                 entries.insert(file_id.original_file(db), None);
 150             }
 151             to_visit.extend(module.children(db));
 152         }
 153         SearchScope { entries }
 154     }
 155
 156     /// Build an empty search scope.
 157     pub fn empty() -> SearchScope {
 158         SearchScope::new(NoHashHashMap::default())
 159     }
 160
 161     /// Build a empty search scope spanning the given file.
 162     pub fn single_file(file: FileId) -> SearchScope {
 163         SearchScope::new(std::iter::once((file, None)).collect())
 164     }
 165
 166     /// Build a empty search scope spanning the text range of the given file.
 167     pub fn file_range(range: FileRange) -> SearchScope {
 168         SearchScope::new(std::iter::once((range.file_id, Some(range.range))).collect())
 169     }
 170
 171     /// Build a empty search scope spanning the given files.
 172     pub fn files(files: &[FileId]) -> SearchScope {
 173         SearchScope::new(files.iter().map(|f| (*f, None)).collect())
 174     }
 175
 176     pub fn intersection(&self, other: &SearchScope) -> SearchScope {
 177         let (mut small, mut large) = (&self.entries, &other.entries);
 178         if small.len() > large.len() {
 179             mem::swap(&mut small, &mut large)
 180         }
 181
 182         let intersect_ranges =
 183             |r1: Option<TextRange>, r2: Option<TextRange>| -> Option<Option<TextRange>> {
 184                 match (r1, r2) {
 185                     (None, r) | (r, None) => Some(r),
 186                     (Some(r1), Some(r2)) => r1.intersect(r2).map(Some),
 187                 }
 188             };
 189         let res = small
 190             .iter()
 191             .filter_map(|(&file_id, &r1)| {
 192                 let &r2 = large.get(&file_id)?;
 193                 let r = intersect_ranges(r1, r2)?;
 194                 Some((file_id, r))
 195             })
 196             .collect();
 197
 198         SearchScope::new(res)
 199     }
 200 }
 201
 202 impl IntoIterator for SearchScope {
 203     type Item = (FileId, Option<TextRange>);
 204     type IntoIter = std::collections::hash_map::IntoIter<FileId, Option<TextRange>>;
 205
 206     fn into_iter(self) -> Self::IntoIter {
 207         self.entries.into_iter()
 208     }
 209 }
 210
 211 impl Definition {
 212     fn search_scope(&self, db: &RootDatabase) -> SearchScope {
 213         let _p = profile::span("search_scope");
 214
 215         if let Definition::BuiltinType(_) = self {
 216             return SearchScope::crate_graph(db);
 217         }
 218
 219         // def is crate root
 220         // FIXME: We don't do searches for crates currently, as a crate does not actually have a single name
 221         if let &Definition::Module(module) = self {
 222             if module.is_crate_root(db) {
 223                 return SearchScope::reverse_dependencies(db, module.krate());
 224             }
 225         }
 226
 227         let module = match self.module(db) {
 228             Some(it) => it,
 229             None => return SearchScope::empty(),
 230         };
 231         let InFile { file_id, value: module_source } = module.definition_source(db);
 232         let file_id = file_id.original_file(db);
 233
 234         if let Definition::Local(var) = self {
 235             let def = match var.parent(db) {
 236                 DefWithBody::Function(f) => f.source(db).map(|src| src.syntax().cloned()),
 237                 DefWithBody::Const(c) => c.source(db).map(|src| src.syntax().cloned()),
 238                 DefWithBody::Static(s) => s.source(db).map(|src| src.syntax().cloned()),
 239             };
 240             return match def {
 241                 Some(def) => SearchScope::file_range(def.as_ref().original_file_range(db)),
 242                 None => SearchScope::single_file(file_id),
 243             };
 244         }
 245
 246         if let Definition::SelfType(impl_) = self {
 247             return match impl_.source(db).map(|src| src.syntax().cloned()) {
 248                 Some(def) => SearchScope::file_range(def.as_ref().original_file_range(db)),
 249                 None => SearchScope::single_file(file_id),
 250             };
 251         }
 252
 253         if let Definition::GenericParam(hir::GenericParam::LifetimeParam(param)) = self {
 254             let def = match param.parent(db) {
 255                 hir::GenericDef::Function(it) => it.source(db).map(|src| src.syntax().cloned()),
 256                 hir::GenericDef::Adt(it) => it.source(db).map(|src| src.syntax().cloned()),
 257                 hir::GenericDef::Trait(it) => it.source(db).map(|src| src.syntax().cloned()),
 258                 hir::GenericDef::TypeAlias(it) => it.source(db).map(|src| src.syntax().cloned()),
 259                 hir::GenericDef::Impl(it) => it.source(db).map(|src| src.syntax().cloned()),
 260                 hir::GenericDef::Variant(it) => it.source(db).map(|src| src.syntax().cloned()),
 261                 hir::GenericDef::Const(it) => it.source(db).map(|src| src.syntax().cloned()),
 262             };
 263             return match def {
 264                 Some(def) => SearchScope::file_range(def.as_ref().original_file_range(db)),
 265                 None => SearchScope::single_file(file_id),
 266             };
 267         }
 268
 269         if let Definition::Macro(macro_def) = self {
 270             return match macro_def.kind(db) {
 271                 hir::MacroKind::Declarative => {
 272                     if macro_def.attrs(db).by_key("macro_export").exists() {
 273                         SearchScope::reverse_dependencies(db, module.krate())
 274                     } else {
 275                         SearchScope::krate(db, module.krate())
 276                     }
 277                 }
 278                 hir::MacroKind::BuiltIn => SearchScope::crate_graph(db),
 279                 hir::MacroKind::Derive | hir::MacroKind::Attr | hir::MacroKind::ProcMacro => {
 280                     SearchScope::reverse_dependencies(db, module.krate())
 281                 }
 282             };
 283         }
 284
 285         if let Definition::DeriveHelper(_) = self {
 286             return SearchScope::reverse_dependencies(db, module.krate());
 287         }
 288
 289         let vis = self.visibility(db);
 290         if let Some(Visibility::Public) = vis {
 291             return SearchScope::reverse_dependencies(db, module.krate());
 292         }
 293         if let Some(Visibility::Module(module)) = vis {
 294             return SearchScope::module_and_children(db, module.into());
 295         }
 296
 297         let range = match module_source {
 298             ModuleSource::Module(m) => Some(m.syntax().text_range()),
 299             ModuleSource::BlockExpr(b) => Some(b.syntax().text_range()),
 300             ModuleSource::SourceFile(_) => None,
 301         };
 302         match range {
 303             Some(range) => SearchScope::file_range(FileRange { file_id, range }),
 304             None => SearchScope::single_file(file_id),
 305         }
 306     }
 307
 308     pub fn usages<'a>(self, sema: &'a Semantics<'_, RootDatabase>) -> FindUsages<'a> {
 309         FindUsages {
 310             local_repr: match self {
 311                 Definition::Local(local) => Some(local.representative(sema.db)),
 312                 _ => None,
 313             },
 314             def: self,
 315             trait_assoc_def: as_trait_assoc_def(sema.db, self),
 316             sema,
 317             scope: None,
 318             include_self_kw_refs: None,
 319             search_self_mod: false,
 320         }
 321     }
 322 }
 323
 324 #[derive(Clone)]
 325 pub struct FindUsages<'a> {
 326     def: Definition,
 327     /// If def is an assoc item from a trait or trait impl, this is the corresponding item of the trait definition
 328     trait_assoc_def: Option<Definition>,
 329     sema: &'a Semantics<'a, RootDatabase>,
 330     scope: Option<SearchScope>,
 331     include_self_kw_refs: Option<hir::Type>,
 332     local_repr: Option<hir::Local>,
 333     search_self_mod: bool,
 334 }
 335
 336 impl<'a> FindUsages<'a> {
 337     /// Enable searching for `Self` when the definition is a type or `self` for modules.
 338     pub fn include_self_refs(mut self) -> FindUsages<'a> {
 339         self.include_self_kw_refs = def_to_ty(self.sema, &self.def);
 340         self.search_self_mod = true;
 341         self
 342     }
 343
 344     /// Limit the search to a given [`SearchScope`].
 345     pub fn in_scope(self, scope: SearchScope) -> FindUsages<'a> {
 346         self.set_scope(Some(scope))
 347     }
 348
 349     /// Limit the search to a given [`SearchScope`].
 350     pub fn set_scope(mut self, scope: Option<SearchScope>) -> FindUsages<'a> {
 351         assert!(self.scope.is_none());
 352         self.scope = scope;
 353         self
 354     }
 355
 356     pub fn at_least_one(&self) -> bool {
 357         let mut found = false;
 358         self.search(&mut |_, _| {
 359             found = true;
 360             true
 361         });
 362         found
 363     }
 364
 365     pub fn all(self) -> UsageSearchResult {
 366         let mut res = UsageSearchResult::default();
 367         self.search(&mut |file_id, reference| {
 368             res.references.entry(file_id).or_default().push(reference);
 369             false
 370         });
 371         res
 372     }
 373
 374     fn search(&self, sink: &mut dyn FnMut(FileId, FileReference) -> bool) {
 375         let _p = profile::span("FindUsages:search");
 376         let sema = self.sema;
 377
 378         let search_scope = {
 379             let base = self.trait_assoc_def.unwrap_or(self.def).search_scope(sema.db);
 380             match &self.scope {
 381                 None => base,
 382                 Some(scope) => base.intersection(scope),
 383             }
 384         };
 385
 386         let name = match self.def {
 387             // special case crate modules as these do not have a proper name
 388             Definition::Module(module) if module.is_crate_root(self.sema.db) => {
 389                 // FIXME: This assumes the crate name is always equal to its display name when it really isn't
 390                 module
 391                     .krate()
 392                     .display_name(self.sema.db)
 393                     .map(|crate_name| crate_name.crate_name().as_smol_str().clone())
 394             }
 395             _ => {
 396                 let self_kw_refs = || {
 397                     self.include_self_kw_refs.as_ref().and_then(|ty| {
 398                         ty.as_adt()
 399                             .map(|adt| adt.name(self.sema.db))
 400                             .or_else(|| ty.as_builtin().map(|builtin| builtin.name()))
 401                     })
 402                 };
 403                 // We need to unescape the name in case it is written without "r#" in earlier
 404                 // editions of Rust where it isn't a keyword.
 405                 self.def.name(sema.db).or_else(self_kw_refs).map(|it| it.unescaped().to_smol_str())
 406             }
 407         };
 408         let name = match &name {
 409             Some(s) => s.as_str(),
 410             None => return,
 411         };
 412
 413         // these can't be closures because rust infers the lifetimes wrong ...
 414         fn match_indices<'a>(
 415             text: &'a str,
 416             name: &'a str,
 417             search_range: TextRange,
 418         ) -> impl Iterator<Item = TextSize> + 'a {
 419             text.match_indices(name).filter_map(move |(idx, _)| {
 420                 let offset: TextSize = idx.try_into().unwrap();
 421                 if !search_range.contains_inclusive(offset) {
 422                     return None;
 423                 }
 424                 Some(offset)
 425             })
 426         }
 427
 428         fn scope_files<'a>(
 429             sema: &'a Semantics<'_, RootDatabase>,
 430             scope: &'a SearchScope,
 431         ) -> impl Iterator<Item = (Arc<String>, FileId, TextRange)> + 'a {
 432             scope.entries.iter().map(|(&file_id, &search_range)| {
 433                 let text = sema.db.file_text(file_id);
 434                 let search_range =
 435                     search_range.unwrap_or_else(|| TextRange::up_to(TextSize::of(text.as_str())));
 436
 437                 (text, file_id, search_range)
 438             })
 439         }
 440
 441         // FIXME: There should be optimization potential here
 442         // Currently we try to descend everything we find which
 443         // means we call `Semantics::descend_into_macros` on
 444         // every textual hit. That function is notoriously
 445         // expensive even for things that do not get down mapped
 446         // into macros.
 447         for (text, file_id, search_range) in scope_files(sema, &search_scope) {
 448             let tree = Lazy::new(move || sema.parse(file_id).syntax().clone());
 449
 450             // Search for occurrences of the items name
 451             for offset in match_indices(&text, name, search_range) {
 452                 for name in sema.find_nodes_at_offset_with_descend(&tree, offset) {
 453                     if match name {
 454                         ast::NameLike::NameRef(name_ref) => self.found_name_ref(&name_ref, sink),
 455                         ast::NameLike::Name(name) => self.found_name(&name, sink),
 456                         ast::NameLike::Lifetime(lifetime) => self.found_lifetime(&lifetime, sink),
 457                     } {
 458                         return;
 459                     }
 460                 }
 461             }
 462             // Search for occurrences of the `Self` referring to our type
 463             if let Some(self_ty) = &self.include_self_kw_refs {
 464                 for offset in match_indices(&text, "Self", search_range) {
 465                     for name_ref in sema.find_nodes_at_offset_with_descend(&tree, offset) {
 466                         if self.found_self_ty_name_ref(self_ty, &name_ref, sink) {
 467                             return;
 468                         }
 469                     }
 470                 }
 471             }
 472         }
 473
 474         // Search for `super` and `crate` resolving to our module
 475         match self.def {
 476             Definition::Module(module) => {
 477                 let scope = search_scope
 478                     .intersection(&SearchScope::module_and_children(self.sema.db, module));
 479
 480                 let is_crate_root = module.is_crate_root(self.sema.db);
 481
 482                 for (text, file_id, search_range) in scope_files(sema, &scope) {
 483                     let tree = Lazy::new(move || sema.parse(file_id).syntax().clone());
 484
 485                     for offset in match_indices(&text, "super", search_range) {
 486                         for name_ref in sema.find_nodes_at_offset_with_descend(&tree, offset) {
 487                             if self.found_name_ref(&name_ref, sink) {
 488                                 return;
 489                             }
 490                         }
 491                     }
 492                     if is_crate_root {
 493                         for offset in match_indices(&text, "crate", search_range) {
 494                             for name_ref in sema.find_nodes_at_offset_with_descend(&tree, offset) {
 495                                 if self.found_name_ref(&name_ref, sink) {
 496                                     return;
 497                                 }
 498                             }
 499                         }
 500                     }
 501                 }
 502             }
 503             _ => (),
 504         }
 505
 506         // search for module `self` references in our module's definition source
 507         match self.def {
 508             Definition::Module(module) if self.search_self_mod => {
 509                 let src = module.definition_source(sema.db);
 510                 let file_id = src.file_id.original_file(sema.db);
 511                 let (file_id, search_range) = match src.value {
 512                     ModuleSource::Module(m) => (file_id, Some(m.syntax().text_range())),
 513                     ModuleSource::BlockExpr(b) => (file_id, Some(b.syntax().text_range())),
 514                     ModuleSource::SourceFile(_) => (file_id, None),
 515                 };
 516
 517                 let search_range = if let Some(&range) = search_scope.entries.get(&file_id) {
 518                     match (range, search_range) {
 519                         (None, range) | (range, None) => range,
 520                         (Some(range), Some(search_range)) => match range.intersect(search_range) {
 521                             Some(range) => Some(range),
 522                             None => return,
 523                         },
 524                     }
 525                 } else {
 526                     return;
 527                 };
 528
 529                 let text = sema.db.file_text(file_id);
 530                 let search_range =
 531                     search_range.unwrap_or_else(|| TextRange::up_to(TextSize::of(text.as_str())));
 532
 533                 let tree = Lazy::new(|| sema.parse(file_id).syntax().clone());
 534
 535                 for offset in match_indices(&text, "self", search_range) {
 536                     for name_ref in sema.find_nodes_at_offset_with_descend(&tree, offset) {
 537                         if self.found_self_module_name_ref(&name_ref, sink) {
 538                             return;
 539                         }
 540                     }
 541                 }
 542             }
 543             _ => {}
 544         }
 545     }
 546
 547     fn found_self_ty_name_ref(
 548         &self,
 549         self_ty: &hir::Type,
 550         name_ref: &ast::NameRef,
 551         sink: &mut dyn FnMut(FileId, FileReference) -> bool,
 552     ) -> bool {
 553         match NameRefClass::classify(self.sema, name_ref) {
 554             Some(NameRefClass::Definition(Definition::SelfType(impl_)))
 555                 if impl_.self_ty(self.sema.db) == *self_ty =>
 556             {
 557                 let FileRange { file_id, range } = self.sema.original_range(name_ref.syntax());
 558                 let reference = FileReference {
 559                     range,
 560                     name: ast::NameLike::NameRef(name_ref.clone()),
 561                     category: None,
 562                 };
 563                 sink(file_id, reference)
 564             }
 565             _ => false,
 566         }
 567     }
 568
 569     fn found_self_module_name_ref(
 570         &self,
 571         name_ref: &ast::NameRef,
 572         sink: &mut dyn FnMut(FileId, FileReference) -> bool,
 573     ) -> bool {
 574         match NameRefClass::classify(self.sema, name_ref) {
 575             Some(NameRefClass::Definition(def @ Definition::Module(_))) if def == self.def => {
 576                 let FileRange { file_id, range } = self.sema.original_range(name_ref.syntax());
 577                 let reference = FileReference {
 578                     range,
 579                     name: ast::NameLike::NameRef(name_ref.clone()),
 580                     category: None,
 581                 };
 582                 sink(file_id, reference)
 583             }
 584             _ => false,
 585         }
 586     }
 587
 588     fn found_lifetime(
 589         &self,
 590         lifetime: &ast::Lifetime,
 591         sink: &mut dyn FnMut(FileId, FileReference) -> bool,
 592     ) -> bool {
 593         match NameRefClass::classify_lifetime(self.sema, lifetime) {
 594             Some(NameRefClass::Definition(def)) if def == self.def => {
 595                 let FileRange { file_id, range } = self.sema.original_range(lifetime.syntax());
 596                 let reference = FileReference {
 597                     range,
 598                     name: ast::NameLike::Lifetime(lifetime.clone()),
 599                     category: None,
 600                 };
 601                 sink(file_id, reference)
 602             }
 603             _ => false,
 604         }
 605     }
 606
 607     fn found_name_ref(
 608         &self,
 609         name_ref: &ast::NameRef,
 610         sink: &mut dyn FnMut(FileId, FileReference) -> bool,
 611     ) -> bool {
 612         match NameRefClass::classify(self.sema, name_ref) {
 613             Some(NameRefClass::Definition(def @ Definition::Local(local)))
 614                 if matches!(
 615                     self.local_repr, Some(repr) if repr == local.representative(self.sema.db)
 616                 ) =>
 617             {
 618                 let FileRange { file_id, range } = self.sema.original_range(name_ref.syntax());
 619                 let reference = FileReference {
 620                     range,
 621                     name: ast::NameLike::NameRef(name_ref.clone()),
 622                     category: ReferenceCategory::new(&def, name_ref),
 623                 };
 624                 sink(file_id, reference)
 625             }
 626             Some(NameRefClass::Definition(def))
 627                 if match self.trait_assoc_def {
 628                     Some(trait_assoc_def) => {
 629                         // we have a trait assoc item, so force resolve all assoc items to their trait version
 630                         convert_to_def_in_trait(self.sema.db, def) == trait_assoc_def
 631                     }
 632                     None => self.def == def,
 633                 } =>
 634             {
 635                 let FileRange { file_id, range } = self.sema.original_range(name_ref.syntax());
 636                 let reference = FileReference {
 637                     range,
 638                     name: ast::NameLike::NameRef(name_ref.clone()),
 639                     category: ReferenceCategory::new(&def, name_ref),
 640                 };
 641                 sink(file_id, reference)
 642             }
 643             Some(NameRefClass::Definition(def)) if self.include_self_kw_refs.is_some() => {
 644                 if self.include_self_kw_refs == def_to_ty(self.sema, &def) {
 645                     let FileRange { file_id, range } = self.sema.original_range(name_ref.syntax());
 646                     let reference = FileReference {
 647                         range,
 648                         name: ast::NameLike::NameRef(name_ref.clone()),
 649                         category: ReferenceCategory::new(&def, name_ref),
 650                     };
 651                     sink(file_id, reference)
 652                 } else {
 653                     false
 654                 }
 655             }
 656             Some(NameRefClass::FieldShorthand { local_ref: local, field_ref: field }) => {
 657                 let field = Definition::Field(field);
 658                 let FileRange { file_id, range } = self.sema.original_range(name_ref.syntax());
 659                 let access = match self.def {
 660                     Definition::Field(_) if field == self.def => {
 661                         ReferenceCategory::new(&field, name_ref)
 662                     }
 663                     Definition::Local(_) if matches!(self.local_repr, Some(repr) if repr == local.representative(self.sema.db)) => {
 664                         ReferenceCategory::new(&Definition::Local(local), name_ref)
 665                     }
 666                     _ => return false,
 667                 };
 668                 let reference = FileReference {
 669                     range,
 670                     name: ast::NameLike::NameRef(name_ref.clone()),
 671                     category: access,
 672                 };
 673                 sink(file_id, reference)
 674             }
 675             _ => false,
 676         }
 677     }
 678
 679     fn found_name(
 680         &self,
 681         name: &ast::Name,
 682         sink: &mut dyn FnMut(FileId, FileReference) -> bool,
 683     ) -> bool {
 684         match NameClass::classify(self.sema, name) {
 685             Some(NameClass::PatFieldShorthand { local_def: _, field_ref })
 686                 if matches!(
 687                     self.def, Definition::Field(_) if Definition::Field(field_ref) == self.def
 688                 ) =>
 689             {
 690                 let FileRange { file_id, range } = self.sema.original_range(name.syntax());
 691                 let reference = FileReference {
 692                     range,
 693                     name: ast::NameLike::Name(name.clone()),
 694                     // FIXME: mutable patterns should have `Write` access
 695                     category: Some(ReferenceCategory::Read),
 696                 };
 697                 sink(file_id, reference)
 698             }
 699             Some(NameClass::ConstReference(def)) if self.def == def => {
 700                 let FileRange { file_id, range } = self.sema.original_range(name.syntax());
 701                 let reference = FileReference {
 702                     range,
 703                     name: ast::NameLike::Name(name.clone()),
 704                     category: None,
 705                 };
 706                 sink(file_id, reference)
 707             }
 708             Some(NameClass::Definition(def @ Definition::Local(local))) if def != self.def => {
 709                 if matches!(
 710                     self.local_repr,
 711                     Some(repr) if local.representative(self.sema.db) == repr
 712                 ) {
 713                     let FileRange { file_id, range } = self.sema.original_range(name.syntax());
 714                     let reference = FileReference {
 715                         range,
 716                         name: ast::NameLike::Name(name.clone()),
 717                         category: None,
 718                     };
 719                     return sink(file_id, reference);
 720                 }
 721                 false
 722             }
 723             Some(NameClass::Definition(def)) if def != self.def => {
 724                 // if the def we are looking for is a trait (impl) assoc item, we'll have to resolve the items to trait definition assoc item
 725                 if !matches!(
 726                     self.trait_assoc_def,
 727                     Some(trait_assoc_def)
 728                         if convert_to_def_in_trait(self.sema.db, def) == trait_assoc_def
 729                 ) {
 730                     return false;
 731                 }
 732                 let FileRange { file_id, range } = self.sema.original_range(name.syntax());
 733                 let reference = FileReference {
 734                     range,
 735                     name: ast::NameLike::Name(name.clone()),
 736                     category: None,
 737                 };
 738                 sink(file_id, reference)
 739             }
 740             _ => false,
 741         }
 742     }
 743 }
 744
 745 fn def_to_ty(sema: &Semantics<'_, RootDatabase>, def: &Definition) -> Option<hir::Type> {
 746     match def {
 747         Definition::Adt(adt) => Some(adt.ty(sema.db)),
 748         Definition::TypeAlias(it) => Some(it.ty(sema.db)),
 749         Definition::BuiltinType(it) => Some(it.ty(sema.db)),
 750         Definition::SelfType(it) => Some(it.self_ty(sema.db)),
 751         _ => None,
 752     }
 753 }
 754
 755 impl ReferenceCategory {
 756     fn new(def: &Definition, r: &ast::NameRef) -> Option<ReferenceCategory> {
 757         // Only Locals and Fields have accesses for now.
 758         if !matches!(def, Definition::Local(_) | Definition::Field(_)) {
 759             return None;
 760         }
 761
 762         let mode = r.syntax().ancestors().find_map(|node| {
 763         match_ast! {
 764             match node {
 765                 ast::BinExpr(expr) => {
 766                     if matches!(expr.op_kind()?, ast::BinaryOp::Assignment { .. }) {
 767                         // If the variable or field ends on the LHS's end then it's a Write (covers fields and locals).
 768                         // FIXME: This is not terribly accurate.
 769                         if let Some(lhs) = expr.lhs() {
 770                             if lhs.syntax().text_range().end() == r.syntax().text_range().end() {
 771                                 return Some(ReferenceCategory::Write);
 772                             }
 773                         }
 774                     }
 775                     Some(ReferenceCategory::Read)
 776                 },
 777                 _ => None
 778             }
 779         }
 780     });
 781
 782         // Default Locals and Fields to read
 783         mode.or(Some(ReferenceCategory::Read))
 784     }
 785 }