Merge #3031

3031: Move imports locator to ide_db r=matklad a=matklad



Co-authored-by: Aleksey Kladov <[email protected]>

7 files changed, 57 insertions, 328 deletions

diff --git a/crates/ra_ide/src/assists.rs b/crates/ra_ide/src/assists.rs
index f26047570..4a7d8cfa9 100644
--- a/crates/ra_ide/src/assists.rs
+++ b/crates/ra_ide/src/assists.rs
@@ -3,9 +3,9 @@
 use either::Either;
 use ra_assists::{AssistAction, AssistLabel};
 use ra_db::{FilePosition, FileRange};
-use ra_ide_db::RootDatabase;
+use ra_ide_db::{imports_locator::ImportsLocatorIde, RootDatabase};
 
-use crate::{imports_locator::ImportsLocatorIde, FileId, SourceChange, SourceFileEdit};
+use crate::{FileId, SourceChange, SourceFileEdit};
 
 pub use ra_assists::AssistId;
 
diff --git a/crates/ra_ide/src/imports_locator.rs b/crates/ra_ide/src/imports_locator.rs
deleted file mode 100644
index cfd58aafe..000000000
--- a/crates/ra_ide/src/imports_locator.rs
+++ /dev/null
@@ -1,76 +0,0 @@
-//! This module contains an import search funcionality that is provided to the ra_assists module.
-//! Later, this should be moved away to a separate crate that is accessible from the ra_assists module.
-
-use hir::{db::HirDatabase, ModuleDef, SourceBinder};
-use ra_assists::ImportsLocator;
-use ra_ide_db::{
-    symbol_index::{self, FileSymbol},
-    RootDatabase,
-};
-use ra_prof::profile;
-use ra_syntax::{ast, AstNode, SyntaxKind::NAME};
-
-use crate::{
-    references::{classify_name, NameDefinition, NameKind},
-    Query,
-};
-
-pub(crate) struct ImportsLocatorIde<'a> {
-    source_binder: SourceBinder<'a, RootDatabase>,
-}
-
-impl<'a> ImportsLocatorIde<'a> {
-    pub(crate) fn new(db: &'a RootDatabase) -> Self {
-        Self { source_binder: SourceBinder::new(db) }
-    }
-
-    fn get_name_definition(
-        &mut self,
-        db: &impl HirDatabase,
-        import_candidate: &FileSymbol,
-    ) -> Option<NameDefinition> {
-        let _p = profile("get_name_definition");
-        let file_id = import_candidate.file_id.into();
-        let candidate_node = import_candidate.ptr.to_node(&db.parse_or_expand(file_id)?);
-        let candidate_name_node = if candidate_node.kind() != NAME {
-            candidate_node.children().find(|it| it.kind() == NAME)?
-        } else {
-            candidate_node
-        };
-        classify_name(
-            &mut self.source_binder,
-            hir::InFile { file_id, value: &ast::Name::cast(candidate_name_node)? },
-        )
-    }
-}
-
-impl ImportsLocator for ImportsLocatorIde<'_> {
-    fn find_imports(&mut self, name_to_import: &str) -> Vec<ModuleDef> {
-        let _p = profile("search_for_imports");
-        let db = self.source_binder.db;
-
-        let project_results = {
-            let mut query = Query::new(name_to_import.to_string());
-            query.exact();
-            query.limit(40);
-            symbol_index::world_symbols(db, query)
-        };
-        let lib_results = {
-            let mut query = Query::new(name_to_import.to_string());
-            query.libs();
-            query.exact();
-            query.limit(40);
-            symbol_index::world_symbols(db, query)
-        };
-
-        project_results
-            .into_iter()
-            .chain(lib_results.into_iter())
-            .filter_map(|import_candidate| self.get_name_definition(db, &import_candidate))
-            .filter_map(|name_definition_to_import| match name_definition_to_import.kind {
-                NameKind::Def(module_def) => Some(module_def),
-                _ => None,
-            })
-            .collect()
-    }
-}
diff --git a/crates/ra_ide/src/lib.rs b/crates/ra_ide/src/lib.rs
index 5fb111a90..689921f3f 100644
--- a/crates/ra_ide/src/lib.rs
+++ b/crates/ra_ide/src/lib.rs
@@ -26,7 +26,6 @@ mod syntax_highlighting;
 mod parent_module;
 mod references;
 mod impls;
-mod imports_locator;
 mod assists;
 mod diagnostics;
 mod syntax_tree;
diff --git a/crates/ra_ide/src/references.rs b/crates/ra_ide/src/references.rs
index b47f8bcd9..c215040f4 100644
--- a/crates/ra_ide/src/references.rs
+++ b/crates/ra_ide/src/references.rs
@@ -10,7 +10,6 @@
 //! resolved to the search element definition, we get a reference.
 
 mod classify;
-mod name_definition;
 mod rename;
 mod search_scope;
 
@@ -29,9 +28,9 @@ use crate::{display::ToNav, FilePosition, FileRange, NavigationTarget, RangeInfo
 
 pub(crate) use self::{
     classify::{classify_name, classify_name_ref},
-    name_definition::{NameDefinition, NameKind},
     rename::rename,
 };
+pub(crate) use ra_ide_db::defs::{NameDefinition, NameKind};
 
 pub use self::search_scope::SearchScope;
 
@@ -137,7 +136,7 @@ pub(crate) fn find_all_refs(
     };
 
     let search_scope = {
-        let base = def.search_scope(db);
+        let base = SearchScope::for_def(&def, db);
         match search_scope {
             None => base,
             Some(scope) => base.intersection(&scope),
diff --git a/crates/ra_ide/src/references/classify.rs b/crates/ra_ide/src/references/classify.rs
index 758ea4e8b..0326fd379 100644
--- a/crates/ra_ide/src/references/classify.rs
+++ b/crates/ra_ide/src/references/classify.rs
@@ -2,119 +2,13 @@
 
 use hir::{InFile, PathResolution, SourceBinder};
 use ra_prof::profile;
-use ra_syntax::{ast, match_ast, AstNode};
+use ra_syntax::{ast, AstNode};
 use test_utils::tested_by;
 
-use super::{
-    name_definition::{from_assoc_item, from_module_def, from_struct_field},
-    NameDefinition, NameKind,
-};
+use super::{NameDefinition, NameKind};
 use ra_ide_db::RootDatabase;
 
-pub(crate) fn classify_name(
-    sb: &mut SourceBinder<RootDatabase>,
-    name: InFile<&ast::Name>,
-) -> Option<NameDefinition> {
-    let _p = profile("classify_name");
-    let parent = name.value.syntax().parent()?;
-
-    match_ast! {
-        match parent {
-            ast::BindPat(it) => {
-                let src = name.with_value(it);
-                let local = sb.to_def(src)?;
-                Some(NameDefinition {
-                    visibility: None,
-                    container: local.module(sb.db),
-                    kind: NameKind::Local(local),
-                })
-            },
-            ast::RecordFieldDef(it) => {
-                let src = name.with_value(it);
-                let field: hir::StructField = sb.to_def(src)?;
-                Some(from_struct_field(sb.db, field))
-            },
-            ast::Module(it) => {
-                let def = sb.to_def(name.with_value(it))?;
-                Some(from_module_def(sb.db, def.into(), None))
-            },
-            ast::StructDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::Struct = sb.to_def(src)?;
-                Some(from_module_def(sb.db, def.into(), None))
-            },
-            ast::EnumDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::Enum = sb.to_def(src)?;
-                Some(from_module_def(sb.db, def.into(), None))
-            },
-            ast::TraitDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::Trait = sb.to_def(src)?;
-                Some(from_module_def(sb.db, def.into(), None))
-            },
-            ast::StaticDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::Static = sb.to_def(src)?;
-                Some(from_module_def(sb.db, def.into(), None))
-            },
-            ast::EnumVariant(it) => {
-                let src = name.with_value(it);
-                let def: hir::EnumVariant = sb.to_def(src)?;
-                Some(from_module_def(sb.db, def.into(), None))
-            },
-            ast::FnDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::Function = sb.to_def(src)?;
-                if parent.parent().and_then(ast::ItemList::cast).is_some() {
-                    Some(from_assoc_item(sb.db, def.into()))
-                } else {
-                    Some(from_module_def(sb.db, def.into(), None))
-                }
-            },
-            ast::ConstDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::Const = sb.to_def(src)?;
-                if parent.parent().and_then(ast::ItemList::cast).is_some() {
-                    Some(from_assoc_item(sb.db, def.into()))
-                } else {
-                    Some(from_module_def(sb.db, def.into(), None))
-                }
-            },
-            ast::TypeAliasDef(it) => {
-                let src = name.with_value(it);
-                let def: hir::TypeAlias = sb.to_def(src)?;
-                if parent.parent().and_then(ast::ItemList::cast).is_some() {
-                    Some(from_assoc_item(sb.db, def.into()))
-                } else {
-                    Some(from_module_def(sb.db, def.into(), None))
-                }
-            },
-            ast::MacroCall(it) => {
-                let src = name.with_value(it);
-                let def = sb.to_def(src.clone())?;
-
-                let module = sb.to_module_def(src.file_id.original_file(sb.db))?;
-
-                Some(NameDefinition {
-                    visibility: None,
-                    container: module,
-                    kind: NameKind::Macro(def),
-                })
-            },
-            ast::TypeParam(it) => {
-                let src = name.with_value(it);
-                let def = sb.to_def(src)?;
-                Some(NameDefinition {
-                    visibility: None,
-                    container: def.module(sb.db),
-                    kind: NameKind::TypeParam(def),
-                })
-            },
-            _ => None,
-        }
-    }
-}
+pub use ra_ide_db::defs::{classify_name, from_assoc_item, from_module_def, from_struct_field};
 
 pub(crate) fn classify_name_ref(
     sb: &mut SourceBinder<RootDatabase>,
diff --git a/crates/ra_ide/src/references/name_definition.rs b/crates/ra_ide/src/references/name_definition.rs
deleted file mode 100644
index 71565e6d3..000000000
--- a/crates/ra_ide/src/references/name_definition.rs
+++ /dev/null
@@ -1,85 +0,0 @@
-//! `NameDefinition` keeps information about the element we want to search references for.
-//! The element is represented by `NameKind`. It's located inside some `container` and
-//! has a `visibility`, which defines a search scope.
-//! Note that the reference search is possible for not all of the classified items.
-
-use hir::{
-    Adt, AssocItem, HasSource, ImplBlock, Local, MacroDef, Module, ModuleDef, StructField,
-    TypeParam, VariantDef,
-};
-use ra_syntax::{ast, ast::VisibilityOwner};
-
-use ra_ide_db::RootDatabase;
-
-#[derive(Debug, PartialEq, Eq)]
-pub enum NameKind {
-    Macro(MacroDef),
-    Field(StructField),
-    AssocItem(AssocItem),
-    Def(ModuleDef),
-    SelfType(ImplBlock),
-    Local(Local),
-    TypeParam(TypeParam),
-}
-
-#[derive(PartialEq, Eq)]
-pub(crate) struct NameDefinition {
-    pub visibility: Option<ast::Visibility>,
-    /// FIXME: this doesn't really make sense. For example, builtin types don't
-    /// really have a module.
-    pub container: Module,
-    pub kind: NameKind,
-}
-
-pub(super) fn from_assoc_item(db: &RootDatabase, item: AssocItem) -> NameDefinition {
-    let container = item.module(db);
-    let visibility = match item {
-        AssocItem::Function(f) => f.source(db).value.visibility(),
-        AssocItem::Const(c) => c.source(db).value.visibility(),
-        AssocItem::TypeAlias(a) => a.source(db).value.visibility(),
-    };
-    let kind = NameKind::AssocItem(item);
-    NameDefinition { kind, container, visibility }
-}
-
-pub(super) fn from_struct_field(db: &RootDatabase, field: StructField) -> NameDefinition {
-    let kind = NameKind::Field(field);
-    let parent = field.parent_def(db);
-    let container = parent.module(db);
-    let visibility = match parent {
-        VariantDef::Struct(s) => s.source(db).value.visibility(),
-        VariantDef::Union(e) => e.source(db).value.visibility(),
-        VariantDef::EnumVariant(e) => e.source(db).value.parent_enum().visibility(),
-    };
-    NameDefinition { kind, container, visibility }
-}
-
-pub(super) fn from_module_def(
-    db: &RootDatabase,
-    def: ModuleDef,
-    module: Option<Module>,
-) -> NameDefinition {
-    let kind = NameKind::Def(def);
-    let (container, visibility) = match def {
-        ModuleDef::Module(it) => {
-            let container = it.parent(db).or_else(|| Some(it)).unwrap();
-            let visibility = it.declaration_source(db).and_then(|s| s.value.visibility());
-            (container, visibility)
-        }
-        ModuleDef::EnumVariant(it) => {
-            let container = it.module(db);
-            let visibility = it.source(db).value.parent_enum().visibility();
-            (container, visibility)
-        }
-        ModuleDef::Function(it) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::Const(it) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::Static(it) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::Trait(it) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::TypeAlias(it) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::Adt(Adt::Struct(it)) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::Adt(Adt::Union(it)) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::Adt(Adt::Enum(it)) => (it.module(db), it.source(db).value.visibility()),
-        ModuleDef::BuiltinType(..) => (module.unwrap(), None),
-    };
-    NameDefinition { kind, container, visibility }
-}
diff --git a/crates/ra_ide/src/references/search_scope.rs b/crates/ra_ide/src/references/search_scope.rs
index 97c65c2cd..279f57be0 100644
--- a/crates/ra_ide/src/references/search_scope.rs
+++ b/crates/ra_ide/src/references/search_scope.rs
@@ -19,59 +19,13 @@ pub struct SearchScope {
 }
 
 impl SearchScope {
-    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()
-    }
-}
-
-impl NameDefinition {
-    pub(crate) fn search_scope(&self, db: &RootDatabase) -> SearchScope {
+    pub(crate) fn for_def(def: &NameDefinition, db: &RootDatabase) -> SearchScope {
         let _p = profile("search_scope");
 
-        let module_src = self.container.definition_source(db);
+        let module_src = def.container.definition_source(db);
         let file_id = module_src.file_id.original_file(db);
 
-        if let NameKind::Local(var) = self.kind {
+        if let NameKind::Local(var) = def.kind {
             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(),
@@ -82,10 +36,10 @@ impl NameDefinition {
             return SearchScope::new(res);
         }
 
-        let vis = self.visibility.as_ref().map(|v| v.syntax().to_string()).unwrap_or_default();
+        let vis = def.visibility.as_ref().map(|v| v.syntax().to_string()).unwrap_or_default();
 
         if vis.as_str() == "pub(super)" {
-            if let Some(parent_module) = self.container.parent(db) {
+            if let Some(parent_module) = def.container.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);
@@ -118,7 +72,7 @@ impl NameDefinition {
                 return SearchScope::new(res);
             }
             if vis.as_str() == "pub" {
-                let krate = self.container.krate();
+                let krate = def.container.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);
@@ -137,4 +91,48 @@ impl NameDefinition {
         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()
+    }
 }