mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2025-10-01 14:21:44 +00:00
Merge #3440
3440: Move search to ra_ide_db r=matklad a=matklad
bors r+
🤖
Co-authored-by: Aleksey Kladov <aleksey.kladov@gmail.com>
This commit is contained in:
commit
02b02061b6
9 changed files with 344 additions and 335 deletions
2
Cargo.lock
generated
2
Cargo.lock
generated
|
@ -1039,7 +1039,6 @@ dependencies = [
|
||||||
"itertools",
|
"itertools",
|
||||||
"join_to_string",
|
"join_to_string",
|
||||||
"log",
|
"log",
|
||||||
"once_cell",
|
|
||||||
"ra_assists",
|
"ra_assists",
|
||||||
"ra_cfg",
|
"ra_cfg",
|
||||||
"ra_db",
|
"ra_db",
|
||||||
|
@ -1060,6 +1059,7 @@ version = "0.1.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"fst",
|
"fst",
|
||||||
"log",
|
"log",
|
||||||
|
"once_cell",
|
||||||
"ra_db",
|
"ra_db",
|
||||||
"ra_hir",
|
"ra_hir",
|
||||||
"ra_prof",
|
"ra_prof",
|
||||||
|
|
|
@ -19,7 +19,6 @@ join_to_string = "0.1.3"
|
||||||
log = "0.4.8"
|
log = "0.4.8"
|
||||||
rustc-hash = "1.1.0"
|
rustc-hash = "1.1.0"
|
||||||
rand = { version = "0.7.3", features = ["small_rng"] }
|
rand = { version = "0.7.3", features = ["small_rng"] }
|
||||||
once_cell = "1.3.1"
|
|
||||||
|
|
||||||
ra_syntax = { path = "../ra_syntax" }
|
ra_syntax = { path = "../ra_syntax" }
|
||||||
ra_text_edit = { path = "../ra_text_edit" }
|
ra_text_edit = { path = "../ra_text_edit" }
|
||||||
|
|
|
@ -68,9 +68,7 @@ pub use crate::{
|
||||||
folding_ranges::{Fold, FoldKind},
|
folding_ranges::{Fold, FoldKind},
|
||||||
hover::HoverResult,
|
hover::HoverResult,
|
||||||
inlay_hints::{InlayHint, InlayKind},
|
inlay_hints::{InlayHint, InlayKind},
|
||||||
references::{
|
references::{Declaration, Reference, ReferenceAccess, ReferenceKind, ReferenceSearchResult},
|
||||||
Declaration, Reference, ReferenceAccess, ReferenceKind, ReferenceSearchResult, SearchScope,
|
|
||||||
},
|
|
||||||
runnables::{Runnable, RunnableKind, TestId},
|
runnables::{Runnable, RunnableKind, TestId},
|
||||||
source_change::{FileSystemEdit, SourceChange, SourceFileEdit},
|
source_change::{FileSystemEdit, SourceChange, SourceFileEdit},
|
||||||
ssr::SsrError,
|
ssr::SsrError,
|
||||||
|
@ -88,6 +86,7 @@ pub use ra_ide_db::{
|
||||||
feature_flags::FeatureFlags,
|
feature_flags::FeatureFlags,
|
||||||
line_index::{LineCol, LineIndex},
|
line_index::{LineCol, LineIndex},
|
||||||
line_index_utils::translate_offset_with_edit,
|
line_index_utils::translate_offset_with_edit,
|
||||||
|
search::SearchScope,
|
||||||
symbol_index::Query,
|
symbol_index::Query,
|
||||||
RootDatabase,
|
RootDatabase,
|
||||||
};
|
};
|
||||||
|
|
|
@ -10,28 +10,25 @@
|
||||||
//! resolved to the search element definition, we get a reference.
|
//! resolved to the search element definition, we get a reference.
|
||||||
|
|
||||||
mod rename;
|
mod rename;
|
||||||
mod search_scope;
|
|
||||||
|
|
||||||
use hir::Semantics;
|
use hir::Semantics;
|
||||||
use once_cell::unsync::Lazy;
|
|
||||||
use ra_db::SourceDatabaseExt;
|
|
||||||
use ra_ide_db::{
|
use ra_ide_db::{
|
||||||
defs::{classify_name, classify_name_ref, Definition},
|
defs::{classify_name, classify_name_ref, Definition},
|
||||||
|
search::SearchScope,
|
||||||
RootDatabase,
|
RootDatabase,
|
||||||
};
|
};
|
||||||
use ra_prof::profile;
|
use ra_prof::profile;
|
||||||
use ra_syntax::{
|
use ra_syntax::{
|
||||||
algo::find_node_at_offset,
|
algo::find_node_at_offset,
|
||||||
ast::{self, NameOwner},
|
ast::{self, NameOwner},
|
||||||
match_ast, AstNode, SyntaxKind, SyntaxNode, TextRange, TextUnit, TokenAtOffset,
|
AstNode, SyntaxKind, SyntaxNode, TextRange, TokenAtOffset,
|
||||||
};
|
};
|
||||||
use test_utils::tested_by;
|
|
||||||
|
|
||||||
use crate::{display::TryToNav, FilePosition, FileRange, NavigationTarget, RangeInfo};
|
use crate::{display::TryToNav, FilePosition, FileRange, NavigationTarget, RangeInfo};
|
||||||
|
|
||||||
pub(crate) use self::rename::rename;
|
pub(crate) use self::rename::rename;
|
||||||
|
|
||||||
pub use self::search_scope::SearchScope;
|
pub use ra_ide_db::search::{Reference, ReferenceAccess, ReferenceKind};
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
#[derive(Debug, Clone)]
|
||||||
pub struct ReferenceSearchResult {
|
pub struct ReferenceSearchResult {
|
||||||
|
@ -46,25 +43,6 @@ pub struct Declaration {
|
||||||
pub access: Option<ReferenceAccess>,
|
pub access: Option<ReferenceAccess>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
pub struct Reference {
|
|
||||||
pub file_range: FileRange,
|
|
||||||
pub kind: ReferenceKind,
|
|
||||||
pub access: Option<ReferenceAccess>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, PartialEq)]
|
|
||||||
pub enum ReferenceKind {
|
|
||||||
StructLiteral,
|
|
||||||
Other,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq)]
|
|
||||||
pub enum ReferenceAccess {
|
|
||||||
Read,
|
|
||||||
Write,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ReferenceSearchResult {
|
impl ReferenceSearchResult {
|
||||||
pub fn declaration(&self) -> &Declaration {
|
pub fn declaration(&self) -> &Declaration {
|
||||||
&self.declaration
|
&self.declaration
|
||||||
|
@ -125,7 +103,8 @@ pub(crate) fn find_all_refs(
|
||||||
|
|
||||||
let RangeInfo { range, info: def } = find_name(&sema, &syntax, position, opt_name)?;
|
let RangeInfo { range, info: def } = find_name(&sema, &syntax, position, opt_name)?;
|
||||||
|
|
||||||
let references = find_refs_to_def(db, &def, search_scope)
|
let references = def
|
||||||
|
.find_usages(db, search_scope)
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.filter(|r| search_kind == ReferenceKind::Other || search_kind == r.kind)
|
.filter(|r| search_kind == ReferenceKind::Other || search_kind == r.kind)
|
||||||
.collect();
|
.collect();
|
||||||
|
@ -141,27 +120,6 @@ pub(crate) fn find_all_refs(
|
||||||
Some(RangeInfo::new(range, ReferenceSearchResult { declaration, references }))
|
Some(RangeInfo::new(range, ReferenceSearchResult { declaration, references }))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn find_refs_to_def(
|
|
||||||
db: &RootDatabase,
|
|
||||||
def: &Definition,
|
|
||||||
search_scope: Option<SearchScope>,
|
|
||||||
) -> Vec<Reference> {
|
|
||||||
let search_scope = {
|
|
||||||
let base = SearchScope::for_def(&def, db);
|
|
||||||
match search_scope {
|
|
||||||
None => base,
|
|
||||||
Some(scope) => base.intersection(&scope),
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
let name = match def.name(db) {
|
|
||||||
None => return Vec::new(),
|
|
||||||
Some(it) => it.to_string(),
|
|
||||||
};
|
|
||||||
|
|
||||||
process_definition(db, def, name, search_scope)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn find_name(
|
fn find_name(
|
||||||
sema: &Semantics<RootDatabase>,
|
sema: &Semantics<RootDatabase>,
|
||||||
syntax: &SyntaxNode,
|
syntax: &SyntaxNode,
|
||||||
|
@ -179,72 +137,6 @@ fn find_name(
|
||||||
Some(RangeInfo::new(range, def))
|
Some(RangeInfo::new(range, def))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn process_definition(
|
|
||||||
db: &RootDatabase,
|
|
||||||
def: &Definition,
|
|
||||||
name: String,
|
|
||||||
scope: SearchScope,
|
|
||||||
) -> Vec<Reference> {
|
|
||||||
let _p = profile("process_definition");
|
|
||||||
|
|
||||||
let pat = name.as_str();
|
|
||||||
let mut refs = vec![];
|
|
||||||
|
|
||||||
for (file_id, search_range) in scope {
|
|
||||||
let text = db.file_text(file_id);
|
|
||||||
let search_range =
|
|
||||||
search_range.unwrap_or(TextRange::offset_len(0.into(), TextUnit::of_str(&text)));
|
|
||||||
|
|
||||||
let sema = Semantics::new(db);
|
|
||||||
let tree = Lazy::new(|| sema.parse(file_id).syntax().clone());
|
|
||||||
|
|
||||||
for (idx, _) in text.match_indices(pat) {
|
|
||||||
let offset = TextUnit::from_usize(idx);
|
|
||||||
if !search_range.contains_inclusive(offset) {
|
|
||||||
tested_by!(search_filters_by_range);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let name_ref =
|
|
||||||
if let Some(name_ref) = find_node_at_offset::<ast::NameRef>(&tree, offset) {
|
|
||||||
name_ref
|
|
||||||
} else {
|
|
||||||
// Handle macro token cases
|
|
||||||
let token = match tree.token_at_offset(offset) {
|
|
||||||
TokenAtOffset::None => continue,
|
|
||||||
TokenAtOffset::Single(t) => t,
|
|
||||||
TokenAtOffset::Between(_, t) => t,
|
|
||||||
};
|
|
||||||
let expanded = sema.descend_into_macros(token);
|
|
||||||
match ast::NameRef::cast(expanded.parent()) {
|
|
||||||
Some(name_ref) => name_ref,
|
|
||||||
_ => continue,
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
if let Some(d) = classify_name_ref(&sema, &name_ref) {
|
|
||||||
let d = d.definition();
|
|
||||||
if &d == def {
|
|
||||||
let kind =
|
|
||||||
if is_record_lit_name_ref(&name_ref) || is_call_expr_name_ref(&name_ref) {
|
|
||||||
ReferenceKind::StructLiteral
|
|
||||||
} else {
|
|
||||||
ReferenceKind::Other
|
|
||||||
};
|
|
||||||
|
|
||||||
let file_range = sema.original_range(name_ref.syntax());
|
|
||||||
refs.push(Reference {
|
|
||||||
file_range,
|
|
||||||
kind,
|
|
||||||
access: reference_access(&d, &name_ref),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
refs
|
|
||||||
}
|
|
||||||
|
|
||||||
fn decl_access(def: &Definition, syntax: &SyntaxNode, range: TextRange) -> Option<ReferenceAccess> {
|
fn decl_access(def: &Definition, syntax: &SyntaxNode, range: TextRange) -> Option<ReferenceAccess> {
|
||||||
match def {
|
match def {
|
||||||
Definition::Local(_) | Definition::StructField(_) => {}
|
Definition::Local(_) | Definition::StructField(_) => {}
|
||||||
|
@ -264,48 +156,6 @@ fn decl_access(def: &Definition, syntax: &SyntaxNode, range: TextRange) -> Optio
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
|
|
||||||
fn reference_access(def: &Definition, name_ref: &ast::NameRef) -> Option<ReferenceAccess> {
|
|
||||||
// Only Locals and Fields have accesses for now.
|
|
||||||
match def {
|
|
||||||
Definition::Local(_) | Definition::StructField(_) => {}
|
|
||||||
_ => return None,
|
|
||||||
};
|
|
||||||
|
|
||||||
let mode = name_ref.syntax().ancestors().find_map(|node| {
|
|
||||||
match_ast! {
|
|
||||||
match (node) {
|
|
||||||
ast::BinExpr(expr) => {
|
|
||||||
if expr.op_kind()?.is_assignment() {
|
|
||||||
// If the variable or field ends on the LHS's end then it's a Write (covers fields and locals).
|
|
||||||
// FIXME: This is not terribly accurate.
|
|
||||||
if let Some(lhs) = expr.lhs() {
|
|
||||||
if lhs.syntax().text_range().end() == name_ref.syntax().text_range().end() {
|
|
||||||
return Some(ReferenceAccess::Write);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some(ReferenceAccess::Read)
|
|
||||||
},
|
|
||||||
_ => {None}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
// Default Locals and Fields to read
|
|
||||||
mode.or(Some(ReferenceAccess::Read))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn is_record_lit_name_ref(name_ref: &ast::NameRef) -> bool {
|
|
||||||
name_ref
|
|
||||||
.syntax()
|
|
||||||
.ancestors()
|
|
||||||
.find_map(ast::RecordLit::cast)
|
|
||||||
.and_then(|l| l.path())
|
|
||||||
.and_then(|p| p.segment())
|
|
||||||
.map(|p| p.name_ref().as_ref() == Some(name_ref))
|
|
||||||
.unwrap_or(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn get_struct_def_name_for_struc_litetal_search(
|
fn get_struct_def_name_for_struc_litetal_search(
|
||||||
syntax: &SyntaxNode,
|
syntax: &SyntaxNode,
|
||||||
position: FilePosition,
|
position: FilePosition,
|
||||||
|
@ -324,20 +174,6 @@ fn get_struct_def_name_for_struc_litetal_search(
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_call_expr_name_ref(name_ref: &ast::NameRef) -> bool {
|
|
||||||
name_ref
|
|
||||||
.syntax()
|
|
||||||
.ancestors()
|
|
||||||
.find_map(ast::CallExpr::cast)
|
|
||||||
.and_then(|c| match c.expr()? {
|
|
||||||
ast::Expr::PathExpr(p) => {
|
|
||||||
Some(p.path()?.segment()?.name_ref().as_ref() == Some(name_ref))
|
|
||||||
}
|
|
||||||
_ => None,
|
|
||||||
})
|
|
||||||
.unwrap_or(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use test_utils::covers;
|
use test_utils::covers;
|
||||||
|
@ -451,7 +287,7 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn search_filters_by_range() {
|
fn search_filters_by_range() {
|
||||||
covers!(search_filters_by_range);
|
covers!(ra_ide_db::search_filters_by_range);
|
||||||
let code = r#"
|
let code = r#"
|
||||||
fn foo() {
|
fn foo() {
|
||||||
let spam<|> = 92;
|
let spam<|> = 92;
|
||||||
|
@ -767,7 +603,10 @@ mod tests {
|
||||||
fn check_result(res: ReferenceSearchResult, expected_decl: &str, expected_refs: &[&str]) {
|
fn check_result(res: ReferenceSearchResult, expected_decl: &str, expected_refs: &[&str]) {
|
||||||
res.declaration().assert_match(expected_decl);
|
res.declaration().assert_match(expected_decl);
|
||||||
assert_eq!(res.references.len(), expected_refs.len());
|
assert_eq!(res.references.len(), expected_refs.len());
|
||||||
res.references().iter().enumerate().for_each(|(i, r)| r.assert_match(expected_refs[i]));
|
res.references()
|
||||||
|
.iter()
|
||||||
|
.enumerate()
|
||||||
|
.for_each(|(i, r)| ref_assert_match(r, expected_refs[i]));
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Declaration {
|
impl Declaration {
|
||||||
|
@ -785,21 +624,16 @@ mod tests {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Reference {
|
fn ref_debug_render(r: &Reference) -> String {
|
||||||
fn debug_render(&self) -> String {
|
let mut s = format!("{:?} {:?} {:?}", r.file_range.file_id, r.file_range.range, r.kind);
|
||||||
let mut s = format!(
|
if let Some(access) = r.access {
|
||||||
"{:?} {:?} {:?}",
|
s.push_str(&format!(" {:?}", access));
|
||||||
self.file_range.file_id, self.file_range.range, self.kind
|
|
||||||
);
|
|
||||||
if let Some(access) = self.access {
|
|
||||||
s.push_str(&format!(" {:?}", access));
|
|
||||||
}
|
|
||||||
s
|
|
||||||
}
|
}
|
||||||
|
s
|
||||||
|
}
|
||||||
|
|
||||||
fn assert_match(&self, expected: &str) {
|
fn ref_assert_match(r: &Reference, expected: &str) {
|
||||||
let actual = self.debug_render();
|
let actual = ref_debug_render(r);
|
||||||
test_utils::assert_eq_text!(expected.trim(), actual.trim(),);
|
test_utils::assert_eq_text!(expected.trim(), actual.trim(),);
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,145 +0,0 @@
|
||||||
//! Generally, `search_scope` returns files that might contain references for the element.
|
|
||||||
//! For `pub(crate)` things it's a crate, for `pub` things it's a crate and dependant crates.
|
|
||||||
//! In some cases, the location of the references is known to within a `TextRange`,
|
|
||||||
//! e.g. for things like local variables.
|
|
||||||
use std::mem;
|
|
||||||
|
|
||||||
use hir::{DefWithBody, HasSource, ModuleSource};
|
|
||||||
use ra_db::{FileId, SourceDatabaseExt};
|
|
||||||
use ra_prof::profile;
|
|
||||||
use ra_syntax::{AstNode, TextRange};
|
|
||||||
use rustc_hash::FxHashMap;
|
|
||||||
|
|
||||||
use ra_ide_db::RootDatabase;
|
|
||||||
|
|
||||||
use super::Definition;
|
|
||||||
|
|
||||||
pub struct SearchScope {
|
|
||||||
entries: FxHashMap<FileId, Option<TextRange>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl SearchScope {
|
|
||||||
fn empty() -> SearchScope {
|
|
||||||
SearchScope { entries: FxHashMap::default() }
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn for_def(def: &Definition, db: &RootDatabase) -> SearchScope {
|
|
||||||
let _p = profile("search_scope");
|
|
||||||
let module = match def.module(db) {
|
|
||||||
Some(it) => it,
|
|
||||||
None => return SearchScope::empty(),
|
|
||||||
};
|
|
||||||
let module_src = module.definition_source(db);
|
|
||||||
let file_id = module_src.file_id.original_file(db);
|
|
||||||
|
|
||||||
if let Definition::Local(var) = def {
|
|
||||||
let range = match var.parent(db) {
|
|
||||||
DefWithBody::Function(f) => f.source(db).value.syntax().text_range(),
|
|
||||||
DefWithBody::Const(c) => c.source(db).value.syntax().text_range(),
|
|
||||||
DefWithBody::Static(s) => s.source(db).value.syntax().text_range(),
|
|
||||||
};
|
|
||||||
let mut res = FxHashMap::default();
|
|
||||||
res.insert(file_id, Some(range));
|
|
||||||
return SearchScope::new(res);
|
|
||||||
}
|
|
||||||
|
|
||||||
let vis = def.visibility(db).as_ref().map(|v| v.syntax().to_string()).unwrap_or_default();
|
|
||||||
|
|
||||||
if vis.as_str() == "pub(super)" {
|
|
||||||
if let Some(parent_module) = module.parent(db) {
|
|
||||||
let mut res = FxHashMap::default();
|
|
||||||
let parent_src = parent_module.definition_source(db);
|
|
||||||
let file_id = parent_src.file_id.original_file(db);
|
|
||||||
|
|
||||||
match parent_src.value {
|
|
||||||
ModuleSource::Module(m) => {
|
|
||||||
let range = Some(m.syntax().text_range());
|
|
||||||
res.insert(file_id, range);
|
|
||||||
}
|
|
||||||
ModuleSource::SourceFile(_) => {
|
|
||||||
res.insert(file_id, None);
|
|
||||||
res.extend(parent_module.children(db).map(|m| {
|
|
||||||
let src = m.definition_source(db);
|
|
||||||
(src.file_id.original_file(db), None)
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return SearchScope::new(res);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if vis.as_str() != "" {
|
|
||||||
let source_root_id = db.file_source_root(file_id);
|
|
||||||
let source_root = db.source_root(source_root_id);
|
|
||||||
let mut res = source_root.walk().map(|id| (id, None)).collect::<FxHashMap<_, _>>();
|
|
||||||
|
|
||||||
// FIXME: add "pub(in path)"
|
|
||||||
|
|
||||||
if vis.as_str() == "pub(crate)" {
|
|
||||||
return SearchScope::new(res);
|
|
||||||
}
|
|
||||||
if vis.as_str() == "pub" {
|
|
||||||
let krate = module.krate();
|
|
||||||
for rev_dep in krate.reverse_dependencies(db) {
|
|
||||||
let root_file = rev_dep.root_file(db);
|
|
||||||
let source_root_id = db.file_source_root(root_file);
|
|
||||||
let source_root = db.source_root(source_root_id);
|
|
||||||
res.extend(source_root.walk().map(|id| (id, None)));
|
|
||||||
}
|
|
||||||
return SearchScope::new(res);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let mut res = FxHashMap::default();
|
|
||||||
let range = match module_src.value {
|
|
||||||
ModuleSource::Module(m) => Some(m.syntax().text_range()),
|
|
||||||
ModuleSource::SourceFile(_) => None,
|
|
||||||
};
|
|
||||||
res.insert(file_id, range);
|
|
||||||
SearchScope::new(res)
|
|
||||||
}
|
|
||||||
|
|
||||||
fn new(entries: FxHashMap<FileId, Option<TextRange>>) -> SearchScope {
|
|
||||||
SearchScope { entries }
|
|
||||||
}
|
|
||||||
pub fn single_file(file: FileId) -> SearchScope {
|
|
||||||
SearchScope::new(std::iter::once((file, None)).collect())
|
|
||||||
}
|
|
||||||
pub(crate) fn intersection(&self, other: &SearchScope) -> SearchScope {
|
|
||||||
let (mut small, mut large) = (&self.entries, &other.entries);
|
|
||||||
if small.len() > large.len() {
|
|
||||||
mem::swap(&mut small, &mut large)
|
|
||||||
}
|
|
||||||
|
|
||||||
let res = small
|
|
||||||
.iter()
|
|
||||||
.filter_map(|(file_id, r1)| {
|
|
||||||
let r2 = large.get(file_id)?;
|
|
||||||
let r = intersect_ranges(*r1, *r2)?;
|
|
||||||
Some((*file_id, r))
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
return SearchScope::new(res);
|
|
||||||
|
|
||||||
fn intersect_ranges(
|
|
||||||
r1: Option<TextRange>,
|
|
||||||
r2: Option<TextRange>,
|
|
||||||
) -> Option<Option<TextRange>> {
|
|
||||||
match (r1, r2) {
|
|
||||||
(None, r) | (r, None) => Some(r),
|
|
||||||
(Some(r1), Some(r2)) => {
|
|
||||||
let r = r1.intersection(&r2)?;
|
|
||||||
Some(Some(r))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl IntoIterator for SearchScope {
|
|
||||||
type Item = (FileId, Option<TextRange>);
|
|
||||||
type IntoIter = std::collections::hash_map::IntoIter<FileId, Option<TextRange>>;
|
|
||||||
fn into_iter(self) -> Self::IntoIter {
|
|
||||||
self.entries.into_iter()
|
|
||||||
}
|
|
||||||
}
|
|
|
@ -16,6 +16,7 @@ rayon = "1.3.0"
|
||||||
fst = { version = "0.3.5", default-features = false }
|
fst = { version = "0.3.5", default-features = false }
|
||||||
rustc-hash = "1.1.0"
|
rustc-hash = "1.1.0"
|
||||||
superslice = "1.0.0"
|
superslice = "1.0.0"
|
||||||
|
once_cell = "1.3.1"
|
||||||
|
|
||||||
ra_syntax = { path = "../ra_syntax" }
|
ra_syntax = { path = "../ra_syntax" }
|
||||||
ra_text_edit = { path = "../ra_text_edit" }
|
ra_text_edit = { path = "../ra_text_edit" }
|
||||||
|
|
|
@ -9,6 +9,7 @@ pub mod feature_flags;
|
||||||
pub mod symbol_index;
|
pub mod symbol_index;
|
||||||
pub mod change;
|
pub mod change;
|
||||||
pub mod defs;
|
pub mod defs;
|
||||||
|
pub mod search;
|
||||||
pub mod imports_locator;
|
pub mod imports_locator;
|
||||||
mod wasm_shims;
|
mod wasm_shims;
|
||||||
|
|
||||||
|
|
|
@ -6,4 +6,5 @@ test_utils::marks![
|
||||||
goto_def_for_fields
|
goto_def_for_fields
|
||||||
goto_def_for_record_fields
|
goto_def_for_record_fields
|
||||||
goto_def_for_field_init_shorthand
|
goto_def_for_field_init_shorthand
|
||||||
|
search_filters_by_range
|
||||||
];
|
];
|
||||||
|
|
319
crates/ra_ide_db/src/search.rs
Normal file
319
crates/ra_ide_db/src/search.rs
Normal file
|
@ -0,0 +1,319 @@
|
||||||
|
//! Implementation of find-usages functionality.
|
||||||
|
//!
|
||||||
|
//! It is based on the standard ide trick: first, we run a fast text search to
|
||||||
|
//! get a super-set of matches. Then, we we confirm each match using precise
|
||||||
|
//! name resolution.
|
||||||
|
|
||||||
|
use std::mem;
|
||||||
|
|
||||||
|
use hir::{DefWithBody, HasSource, ModuleSource, Semantics};
|
||||||
|
use once_cell::unsync::Lazy;
|
||||||
|
use ra_db::{FileId, FileRange, SourceDatabaseExt};
|
||||||
|
use ra_prof::profile;
|
||||||
|
use ra_syntax::{
|
||||||
|
algo::find_node_at_offset, ast, match_ast, AstNode, TextRange, TextUnit, TokenAtOffset,
|
||||||
|
};
|
||||||
|
use rustc_hash::FxHashMap;
|
||||||
|
use test_utils::tested_by;
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
defs::{classify_name_ref, Definition},
|
||||||
|
RootDatabase,
|
||||||
|
};
|
||||||
|
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct Reference {
|
||||||
|
pub file_range: FileRange,
|
||||||
|
pub kind: ReferenceKind,
|
||||||
|
pub access: Option<ReferenceAccess>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq)]
|
||||||
|
pub enum ReferenceKind {
|
||||||
|
StructLiteral,
|
||||||
|
Other,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Copy, Clone, PartialEq)]
|
||||||
|
pub enum ReferenceAccess {
|
||||||
|
Read,
|
||||||
|
Write,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generally, `search_scope` returns files that might contain references for the element.
|
||||||
|
/// For `pub(crate)` things it's a crate, for `pub` things it's a crate and dependant crates.
|
||||||
|
/// In some cases, the location of the references is known to within a `TextRange`,
|
||||||
|
/// e.g. for things like local variables.
|
||||||
|
pub struct SearchScope {
|
||||||
|
entries: FxHashMap<FileId, Option<TextRange>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SearchScope {
|
||||||
|
fn new(entries: FxHashMap<FileId, Option<TextRange>>) -> SearchScope {
|
||||||
|
SearchScope { entries }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn empty() -> SearchScope {
|
||||||
|
SearchScope::new(FxHashMap::default())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn single_file(file: FileId) -> SearchScope {
|
||||||
|
SearchScope::new(std::iter::once((file, None)).collect())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn intersection(&self, other: &SearchScope) -> SearchScope {
|
||||||
|
let (mut small, mut large) = (&self.entries, &other.entries);
|
||||||
|
if small.len() > large.len() {
|
||||||
|
mem::swap(&mut small, &mut large)
|
||||||
|
}
|
||||||
|
|
||||||
|
let res = small
|
||||||
|
.iter()
|
||||||
|
.filter_map(|(file_id, r1)| {
|
||||||
|
let r2 = large.get(file_id)?;
|
||||||
|
let r = intersect_ranges(*r1, *r2)?;
|
||||||
|
Some((*file_id, r))
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
return SearchScope::new(res);
|
||||||
|
|
||||||
|
fn intersect_ranges(
|
||||||
|
r1: Option<TextRange>,
|
||||||
|
r2: Option<TextRange>,
|
||||||
|
) -> Option<Option<TextRange>> {
|
||||||
|
match (r1, r2) {
|
||||||
|
(None, r) | (r, None) => Some(r),
|
||||||
|
(Some(r1), Some(r2)) => {
|
||||||
|
let r = r1.intersection(&r2)?;
|
||||||
|
Some(Some(r))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl IntoIterator for SearchScope {
|
||||||
|
type Item = (FileId, Option<TextRange>);
|
||||||
|
type IntoIter = std::collections::hash_map::IntoIter<FileId, Option<TextRange>>;
|
||||||
|
|
||||||
|
fn into_iter(self) -> Self::IntoIter {
|
||||||
|
self.entries.into_iter()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Definition {
|
||||||
|
fn search_scope(&self, db: &RootDatabase) -> SearchScope {
|
||||||
|
let _p = profile("search_scope");
|
||||||
|
let module = match self.module(db) {
|
||||||
|
Some(it) => it,
|
||||||
|
None => return SearchScope::empty(),
|
||||||
|
};
|
||||||
|
let module_src = module.definition_source(db);
|
||||||
|
let file_id = module_src.file_id.original_file(db);
|
||||||
|
|
||||||
|
if let Definition::Local(var) = self {
|
||||||
|
let range = match var.parent(db) {
|
||||||
|
DefWithBody::Function(f) => f.source(db).value.syntax().text_range(),
|
||||||
|
DefWithBody::Const(c) => c.source(db).value.syntax().text_range(),
|
||||||
|
DefWithBody::Static(s) => s.source(db).value.syntax().text_range(),
|
||||||
|
};
|
||||||
|
let mut res = FxHashMap::default();
|
||||||
|
res.insert(file_id, Some(range));
|
||||||
|
return SearchScope::new(res);
|
||||||
|
}
|
||||||
|
|
||||||
|
let vis = self.visibility(db).as_ref().map(|v| v.syntax().to_string()).unwrap_or_default();
|
||||||
|
|
||||||
|
if vis.as_str() == "pub(super)" {
|
||||||
|
if let Some(parent_module) = module.parent(db) {
|
||||||
|
let mut res = FxHashMap::default();
|
||||||
|
let parent_src = parent_module.definition_source(db);
|
||||||
|
let file_id = parent_src.file_id.original_file(db);
|
||||||
|
|
||||||
|
match parent_src.value {
|
||||||
|
ModuleSource::Module(m) => {
|
||||||
|
let range = Some(m.syntax().text_range());
|
||||||
|
res.insert(file_id, range);
|
||||||
|
}
|
||||||
|
ModuleSource::SourceFile(_) => {
|
||||||
|
res.insert(file_id, None);
|
||||||
|
res.extend(parent_module.children(db).map(|m| {
|
||||||
|
let src = m.definition_source(db);
|
||||||
|
(src.file_id.original_file(db), None)
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return SearchScope::new(res);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if vis.as_str() != "" {
|
||||||
|
let source_root_id = db.file_source_root(file_id);
|
||||||
|
let source_root = db.source_root(source_root_id);
|
||||||
|
let mut res = source_root.walk().map(|id| (id, None)).collect::<FxHashMap<_, _>>();
|
||||||
|
|
||||||
|
// FIXME: add "pub(in path)"
|
||||||
|
|
||||||
|
if vis.as_str() == "pub(crate)" {
|
||||||
|
return SearchScope::new(res);
|
||||||
|
}
|
||||||
|
if vis.as_str() == "pub" {
|
||||||
|
let krate = module.krate();
|
||||||
|
for rev_dep in krate.reverse_dependencies(db) {
|
||||||
|
let root_file = rev_dep.root_file(db);
|
||||||
|
let source_root_id = db.file_source_root(root_file);
|
||||||
|
let source_root = db.source_root(source_root_id);
|
||||||
|
res.extend(source_root.walk().map(|id| (id, None)));
|
||||||
|
}
|
||||||
|
return SearchScope::new(res);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut res = FxHashMap::default();
|
||||||
|
let range = match module_src.value {
|
||||||
|
ModuleSource::Module(m) => Some(m.syntax().text_range()),
|
||||||
|
ModuleSource::SourceFile(_) => None,
|
||||||
|
};
|
||||||
|
res.insert(file_id, range);
|
||||||
|
SearchScope::new(res)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn find_usages(
|
||||||
|
&self,
|
||||||
|
db: &RootDatabase,
|
||||||
|
search_scope: Option<SearchScope>,
|
||||||
|
) -> Vec<Reference> {
|
||||||
|
let _p = profile("Definition::find_usages");
|
||||||
|
|
||||||
|
let search_scope = {
|
||||||
|
let base = self.search_scope(db);
|
||||||
|
match search_scope {
|
||||||
|
None => base,
|
||||||
|
Some(scope) => base.intersection(&scope),
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let name = match self.name(db) {
|
||||||
|
None => return Vec::new(),
|
||||||
|
Some(it) => it.to_string(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let pat = name.as_str();
|
||||||
|
let mut refs = vec![];
|
||||||
|
|
||||||
|
for (file_id, search_range) in search_scope {
|
||||||
|
let text = db.file_text(file_id);
|
||||||
|
let search_range =
|
||||||
|
search_range.unwrap_or(TextRange::offset_len(0.into(), TextUnit::of_str(&text)));
|
||||||
|
|
||||||
|
let sema = Semantics::new(db);
|
||||||
|
let tree = Lazy::new(|| sema.parse(file_id).syntax().clone());
|
||||||
|
|
||||||
|
for (idx, _) in text.match_indices(pat) {
|
||||||
|
let offset = TextUnit::from_usize(idx);
|
||||||
|
if !search_range.contains_inclusive(offset) {
|
||||||
|
tested_by!(search_filters_by_range; force);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
let name_ref =
|
||||||
|
if let Some(name_ref) = find_node_at_offset::<ast::NameRef>(&tree, offset) {
|
||||||
|
name_ref
|
||||||
|
} else {
|
||||||
|
// Handle macro token cases
|
||||||
|
let token = match tree.token_at_offset(offset) {
|
||||||
|
TokenAtOffset::None => continue,
|
||||||
|
TokenAtOffset::Single(t) => t,
|
||||||
|
TokenAtOffset::Between(_, t) => t,
|
||||||
|
};
|
||||||
|
let expanded = sema.descend_into_macros(token);
|
||||||
|
match ast::NameRef::cast(expanded.parent()) {
|
||||||
|
Some(name_ref) => name_ref,
|
||||||
|
_ => continue,
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// FIXME: reuse sb
|
||||||
|
// See https://github.com/rust-lang/rust/pull/68198#issuecomment-574269098
|
||||||
|
|
||||||
|
if let Some(d) = classify_name_ref(&sema, &name_ref) {
|
||||||
|
let d = d.definition();
|
||||||
|
if &d == self {
|
||||||
|
let kind = if is_record_lit_name_ref(&name_ref)
|
||||||
|
|| is_call_expr_name_ref(&name_ref)
|
||||||
|
{
|
||||||
|
ReferenceKind::StructLiteral
|
||||||
|
} else {
|
||||||
|
ReferenceKind::Other
|
||||||
|
};
|
||||||
|
|
||||||
|
let file_range = sema.original_range(name_ref.syntax());
|
||||||
|
refs.push(Reference {
|
||||||
|
file_range,
|
||||||
|
kind,
|
||||||
|
access: reference_access(&d, &name_ref),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
refs
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn reference_access(def: &Definition, name_ref: &ast::NameRef) -> Option<ReferenceAccess> {
|
||||||
|
// Only Locals and Fields have accesses for now.
|
||||||
|
match def {
|
||||||
|
Definition::Local(_) | Definition::StructField(_) => {}
|
||||||
|
_ => return None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let mode = name_ref.syntax().ancestors().find_map(|node| {
|
||||||
|
match_ast! {
|
||||||
|
match (node) {
|
||||||
|
ast::BinExpr(expr) => {
|
||||||
|
if expr.op_kind()?.is_assignment() {
|
||||||
|
// If the variable or field ends on the LHS's end then it's a Write (covers fields and locals).
|
||||||
|
// FIXME: This is not terribly accurate.
|
||||||
|
if let Some(lhs) = expr.lhs() {
|
||||||
|
if lhs.syntax().text_range().end() == name_ref.syntax().text_range().end() {
|
||||||
|
return Some(ReferenceAccess::Write);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Some(ReferenceAccess::Read)
|
||||||
|
},
|
||||||
|
_ => {None}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Default Locals and Fields to read
|
||||||
|
mode.or(Some(ReferenceAccess::Read))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn is_call_expr_name_ref(name_ref: &ast::NameRef) -> bool {
|
||||||
|
name_ref
|
||||||
|
.syntax()
|
||||||
|
.ancestors()
|
||||||
|
.find_map(ast::CallExpr::cast)
|
||||||
|
.and_then(|c| match c.expr()? {
|
||||||
|
ast::Expr::PathExpr(p) => {
|
||||||
|
Some(p.path()?.segment()?.name_ref().as_ref() == Some(name_ref))
|
||||||
|
}
|
||||||
|
_ => None,
|
||||||
|
})
|
||||||
|
.unwrap_or(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn is_record_lit_name_ref(name_ref: &ast::NameRef) -> bool {
|
||||||
|
name_ref
|
||||||
|
.syntax()
|
||||||
|
.ancestors()
|
||||||
|
.find_map(ast::RecordLit::cast)
|
||||||
|
.and_then(|l| l.path())
|
||||||
|
.and_then(|p| p.segment())
|
||||||
|
.map(|p| p.name_ref().as_ref() == Some(name_ref))
|
||||||
|
.unwrap_or(false)
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue