mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Only store item name instead of full path

Browse Source
This commit is contained in:
Ryo Yoshida 2023-06-30 23:24:15 +09:00
parent 860628af7c
commit 2b106648a7
No known key found for this signature in database
GPG Key ID: E25698A930586171
2 changed files with 149 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/hir-def/src/find_path.rs
View File

@ -360,7 +360,7 @@ fn calculate_best_path(
prefer_no_std, prefer_no_std,
)?; )?;
cov_mark::hit!(partially_imported); cov_mark::hit!(partially_imported);
path.push_segment(info.path.segments.last()?.clone()); path.push_segment(info.name.clone());
Some(path) Some(path)
}) })
}); });

327
crates/hir-def/src/import_map.rs
View File

@ -1,13 +1,14 @@
//! A map of all publicly exported items in a crate. //! A map of all publicly exported items in a crate.
use std::collections::hash_map::Entry;
use std::{fmt, hash::BuildHasherDefault}; use std::{fmt, hash::BuildHasherDefault};
use base_db::CrateId; use base_db::CrateId;
use fst::{self, Streamer}; use fst::{self, Streamer};
use hir_expand::name::Name; use hir_expand::name::Name;
use indexmap::{map::Entry, IndexMap}; use indexmap::IndexMap;
use itertools::Itertools; use itertools::Itertools;
use rustc_hash::{FxHashSet, FxHasher}; use rustc_hash::{FxHashMap, FxHashSet, FxHasher};
use triomphe::Arc; use triomphe::Arc;
use crate::{ use crate::{
@ -17,52 +18,23 @@ use crate::{
type FxIndexMap<K, V> = IndexMap<K, V, BuildHasherDefault<FxHasher>>; type FxIndexMap<K, V> = IndexMap<K, V, BuildHasherDefault<FxHasher>>;
// FIXME: Support aliases: an item may be exported under multiple names, so `ImportInfo` should
// have `Vec<(Name, ModuleId)>` instead of `(Name, ModuleId)`.
/// Item import details stored in the `ImportMap`. /// Item import details stored in the `ImportMap`.
#[derive(Debug, Clone, Eq, PartialEq)] #[derive(Debug, Clone, Eq, PartialEq)]
pub struct ImportInfo { pub struct ImportInfo {
/// A path that can be used to import the item, relative to the crate's root. /// A name that can be used to import the item, relative to the crate's root.
pub path: ImportPath, pub name: Name,
/// The module containing this item. /// The module containing this item.
pub container: ModuleId, pub container: ModuleId,
/// Whether the import is a trait associated item or not. /// Whether the import is a trait associated item or not.
pub is_trait_assoc_item: bool, pub is_trait_assoc_item: bool,
} }
#[derive(Debug, Clone, Eq, PartialEq)] /// A map from publicly exported items to its name.
pub struct ImportPath {
pub segments: Vec<Name>,
}
impl ImportPath {
pub fn display<'a>(&'a self, db: &'a dyn DefDatabase) -> impl fmt::Display + 'a {
struct Display<'a> {
db: &'a dyn DefDatabase,
path: &'a ImportPath,
}
impl fmt::Display for Display<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(
&self.path.segments.iter().map(|it| it.display(self.db.upcast())).format("::"),
f,
)
}
}
Display { db, path: self }
}
fn len(&self) -> usize {
self.segments.len()
}
}
/// A map from publicly exported items to the path needed to import/name them from a downstream
/// crate.
/// ///
/// Reexports of items are taken into account, ie. if something is exported under multiple /// Reexports of items are taken into account, ie. if something is exported under multiple
/// names, the one with the shortest import path will be used. /// names, the one with the shortest import path will be used.
///
/// Note that all paths are relative to the containing crate's root, so the crate name still needs
/// to be prepended to the `ModPath` before the path is valid.
#[derive(Default)] #[derive(Default)]
pub struct ImportMap { pub struct ImportMap {
map: FxIndexMap<ItemInNs, ImportInfo>, map: FxIndexMap<ItemInNs, ImportInfo>,
@ -70,84 +42,50 @@ pub struct ImportMap {
/// List of keys stored in `map`, sorted lexicographically by their `ModPath`. Indexed by the /// List of keys stored in `map`, sorted lexicographically by their `ModPath`. Indexed by the
/// values returned by running `fst`. /// values returned by running `fst`.
/// ///
/// Since a path can refer to multiple items due to namespacing, we store all items with the /// Since a name can refer to multiple items due to namespacing, we store all items with the
/// same path right after each other. This allows us to find all items after the FST gives us /// same name right after each other. This allows us to find all items after the FST gives us
/// the index of the first one. /// the index of the first one.
importables: Vec<ItemInNs>, importables: Vec<ItemInNs>,
fst: fst::Map<Vec<u8>>, fst: fst::Map<Vec<u8>>,
} }
impl ImportMap { impl ImportMap {
pub fn import_map_query(db: &dyn DefDatabase, krate: CrateId) -> Arc<Self> { pub(crate) fn import_map_query(db: &dyn DefDatabase, krate: CrateId) -> Arc<Self> {
let _p = profile::span("import_map_query"); let _p = profile::span("import_map_query");
let mut import_map = collect_import_map(db, krate); let mut import_map = collect_import_map(db, krate);
let mut importables = import_map let mut importables: Vec<_> = import_map
.map .map
.iter() .iter()
.map(|(item, info)| (item, fst_path(db, &info.path))) // We've only collected items, whose name cannot be tuple field.
.collect::<Vec<_>>(); .map(|(item, info)| (item, info.name.as_str().unwrap().to_ascii_lowercase()))
importables.sort_by(|(_, fst_path), (_, fst_path2)| fst_path.cmp(fst_path2)); .collect();
importables.sort_by(|(_, lhs_name), (_, rhs_name)| lhs_name.cmp(rhs_name));
// Build the FST, taking care not to insert duplicate values. // Build the FST, taking care not to insert duplicate values.
let mut builder = fst::MapBuilder::memory(); let mut builder = fst::MapBuilder::memory();
let mut last_batch_start = 0; let iter = importables.iter().enumerate().dedup_by(|lhs, rhs| lhs.1 .1 == rhs.1 .1);
for (start_idx, (_, name)) in iter {
for idx in 0..importables.len() { let _ = builder.insert(name, start_idx as u64);
let key = &importables[last_batch_start].1;
if let Some((_, fst_path)) = importables.get(idx + 1) {
if key == fst_path {
continue;
}
}
let _ = builder.insert(key, last_batch_start as u64);
last_batch_start = idx + 1;
} }
import_map.fst = builder.into_map(); import_map.fst = builder.into_map();
import_map.importables = importables.iter().map(|&(&item, _)| item).collect(); import_map.importables = importables.into_iter().map(|(&item, _)| item).collect();
Arc::new(import_map) Arc::new(import_map)
} }
/// Returns the `ModPath` needed to import/mention `item`, relative to this crate's root.
pub fn path_of(&self, item: ItemInNs) -> Option<&ImportPath> {
self.import_info_for(item).map(|it| &it.path)
}
pub fn import_info_for(&self, item: ItemInNs) -> Option<&ImportInfo> { pub fn import_info_for(&self, item: ItemInNs) -> Option<&ImportInfo> {
self.map.get(&item) self.map.get(&item)
} }
#[cfg(test)]
fn fmt_for_test(&self, db: &dyn DefDatabase) -> String {
let mut importable_paths: Vec<_> = self
.map
.iter()
.map(|(item, info)| {
let ns = match item {
ItemInNs::Types(_) => "t",
ItemInNs::Values(_) => "v",
ItemInNs::Macros(_) => "m",
};
format!("- {} ({ns})", info.path.display(db))
})
.collect();
importable_paths.sort();
importable_paths.join("\n")
}
fn collect_trait_assoc_items( fn collect_trait_assoc_items(
&mut self, &mut self,
db: &dyn DefDatabase, db: &dyn DefDatabase,
tr: TraitId, tr: TraitId,
is_type_in_ns: bool, is_type_in_ns: bool,
original_import_info: &ImportInfo, trait_import_info: &ImportInfo,
) { ) {
let _p = profile::span("collect_trait_assoc_items"); let _p = profile::span("collect_trait_assoc_items");
for (assoc_item_name, item) in &db.trait_data(tr).items { for (assoc_item_name, item) in &db.trait_data(tr).items {
@ -167,9 +105,11 @@ impl ImportMap {
ItemInNs::Values(module_def_id) ItemInNs::Values(module_def_id)
}; };
let mut assoc_item_info = original_import_info.clone(); let assoc_item_info = ImportInfo {
assoc_item_info.path.segments.push(assoc_item_name.to_owned()); container: trait_import_info.container,
assoc_item_info.is_trait_assoc_item = true; name: assoc_item_name.clone(),
is_trait_assoc_item: true,
};
self.map.insert(assoc_item, assoc_item_info); self.map.insert(assoc_item, assoc_item_info);
} }
} }
@ -182,10 +122,10 @@ fn collect_import_map(db: &dyn DefDatabase, krate: CrateId) -> ImportMap {
let mut import_map = ImportMap::default(); let mut import_map = ImportMap::default();
// We look only into modules that are public(ly reexported), starting with the crate root. // We look only into modules that are public(ly reexported), starting with the crate root.
let empty = ImportPath { segments: vec![] };
let root = def_map.module_id(DefMap::ROOT); let root = def_map.module_id(DefMap::ROOT);
let mut worklist = vec![(root, empty)]; let mut worklist = vec![(root, 0)];
while let Some((module, mod_path)) = worklist.pop() { let mut depth_map = FxHashMap::default();
while let Some((module, depth)) = worklist.pop() {
let ext_def_map; let ext_def_map;
let mod_data = if module.krate == krate { let mod_data = if module.krate == krate {
&def_map[module.local_id] &def_map[module.local_id]
@ -205,17 +145,25 @@ fn collect_import_map(db: &dyn DefDatabase, krate: CrateId) -> ImportMap {
}); });
for (name, per_ns) in visible_items { for (name, per_ns) in visible_items {
let mk_path = || { for item in per_ns.iter_items() {
let mut path = mod_path.clone(); let import_info = ImportInfo {
path.segments.push(name.clone()); name: name.clone(),
path container: module,
is_trait_assoc_item: false,
}; };
for item in per_ns.iter_items() { match depth_map.entry(item) {
let path = mk_path(); Entry::Vacant(entry) => {
let path_len = path.len(); entry.insert(depth);
let import_info = }
ImportInfo { path, container: module, is_trait_assoc_item: false }; Entry::Occupied(mut entry) => {
if depth < *entry.get() {
entry.insert(depth);
} else {
continue;
}
}
}
if let Some(ModuleDefId::TraitId(tr)) = item.as_module_def_id() { if let Some(ModuleDefId::TraitId(tr)) = item.as_module_def_id() {
import_map.collect_trait_assoc_items( import_map.collect_trait_assoc_items(
@ -226,25 +174,13 @@ fn collect_import_map(db: &dyn DefDatabase, krate: CrateId) -> ImportMap {
); );
} }
match import_map.map.entry(item) { import_map.map.insert(item, import_info);
Entry::Vacant(entry) => {
entry.insert(import_info);
}
Entry::Occupied(mut entry) => {
// If the new path is shorter, prefer that one.
if path_len < entry.get().path.len() {
*entry.get_mut() = import_info;
} else {
continue;
}
}
}
// If we've just added a path to a module, descend into it. We might traverse // If we've just added a module, descend into it. We might traverse modules
// modules multiple times, but only if the new path to it is shorter than the // multiple times, but only if the module depth is smaller (else we `continue`
// first (else we `continue` above). // above).
if let Some(ModuleDefId::ModuleId(mod_id)) = item.as_module_def_id() { if let Some(ModuleDefId::ModuleId(mod_id)) = item.as_module_def_id() {
worklist.push((mod_id, mk_path())); worklist.push((mod_id, depth + 1));
} }
} }
} }
@ -264,7 +200,7 @@ impl Eq for ImportMap {}
impl fmt::Debug for ImportMap { impl fmt::Debug for ImportMap {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut importable_paths: Vec<_> = self let mut importable_names: Vec<_> = self
.map .map
.iter() .iter()
.map(|(item, _)| match item { .map(|(item, _)| match item {
@ -274,18 +210,11 @@ impl fmt::Debug for ImportMap {
}) })
.collect(); .collect();
importable_paths.sort(); importable_names.sort();
f.write_str(&importable_paths.join("\n")) f.write_str(&importable_names.join("\n"))
} }
} }
fn fst_path(db: &dyn DefDatabase, path: &ImportPath) -> String {
let _p = profile::span("fst_path");
let mut s = path.display(db).to_string();
s.make_ascii_lowercase();
s
}
/// A way to match import map contents against the search query. /// A way to match import map contents against the search query.
#[derive(Debug)] #[derive(Debug)]
enum SearchMode { enum SearchMode {
@ -363,7 +292,7 @@ impl Query {
_ => {} _ => {}
} }
let mut input = import.path.segments.last().unwrap().display(db.upcast()).to_string(); let mut input = import.name.display(db.upcast()).to_string();
let case_insensitive = enforce_lowercase || !self.case_sensitive; let case_insensitive = enforce_lowercase || !self.case_sensitive;
if case_insensitive { if case_insensitive {
input.make_ascii_lowercase(); input.make_ascii_lowercase();
@ -386,7 +315,7 @@ impl Query {
} }
} }
/// Searches dependencies of `krate` for an importable path matching `query`. /// Searches dependencies of `krate` for an importable name matching `query`.
/// ///
/// This returns a list of items that could be imported from dependencies of `krate`. /// This returns a list of items that could be imported from dependencies of `krate`.
pub fn search_dependencies( pub fn search_dependencies(
@ -409,13 +338,9 @@ pub fn search_dependencies(
let mut stream = op.union(); let mut stream = op.union();
let mut all_indexed_values = FxHashSet::default();
while let Some((_, indexed_values)) = stream.next() {
all_indexed_values.extend(indexed_values.iter().copied());
}
let mut res = FxHashSet::default(); let mut res = FxHashSet::default();
for indexed_value in all_indexed_values { while let Some((_, indexed_values)) = stream.next() {
for indexed_value in indexed_values {
let import_map = &import_maps[indexed_value.index]; let import_map = &import_maps[indexed_value.index];
let importables = &import_map.importables[indexed_value.value as usize..]; let importables = &import_map.importables[indexed_value.value as usize..];
@ -424,18 +349,20 @@ pub fn search_dependencies(
continue; continue;
} }
// Path shared by the importable items in this group. // Name shared by the importable items in this group.
let common_importables_path_fst = fst_path(db, &common_importable_data.path); let common_importable_name =
// Add the items from this `ModPath` group. Those are all subsequent items in common_importable_data.name.to_smol_str().to_ascii_lowercase();
// `importables` whose paths match `path`. // Add the items from this name group. Those are all subsequent items in
// `importables` whose name match `common_importable_name`.
let iter = importables let iter = importables
.iter() .iter()
.copied() .copied()
.take_while(|item| { .take_while(|item| {
common_importables_path_fst == fst_path(db, &import_map.map[item].path) common_importable_name
== import_map.map[item].name.to_smol_str().to_ascii_lowercase()
}) })
.filter(|item| { .filter(|item| {
!query.case_sensitive // we've already checked the common importables path case-insensitively !query.case_sensitive // we've already checked the common importables name case-insensitively
|| query.import_matches(db, &import_map.map[item], false) || query.import_matches(db, &import_map.map[item], false)
}); });
res.extend(iter); res.extend(iter);
@ -444,6 +371,7 @@ pub fn search_dependencies(
return res; return res;
} }
} }
}
res res
} }
@ -457,16 +385,39 @@ mod tests {
use super::*; use super::*;
impl ImportMap {
fn fmt_for_test(&self, db: &dyn DefDatabase) -> String {
let mut importable_paths: Vec<_> = self
.map
.iter()
.map(|(item, info)| {
let path = render_path(db, info);
let ns = match item {
ItemInNs::Types(_) => "t",
ItemInNs::Values(_) => "v",
ItemInNs::Macros(_) => "m",
};
format!("- {path} ({ns})")
})
.collect();
importable_paths.sort();
importable_paths.join("\n")
}
}
fn check_search(ra_fixture: &str, crate_name: &str, query: Query, expect: Expect) { fn check_search(ra_fixture: &str, crate_name: &str, query: Query, expect: Expect) {
let db = TestDB::with_files(ra_fixture); let db = TestDB::with_files(ra_fixture);
let crate_graph = db.crate_graph(); let crate_graph = db.crate_graph();
let krate = crate_graph let krate = crate_graph
.iter() .iter()
.find(|krate| { .find(|&krate| {
crate_graph[*krate].display_name.as_ref().map(|n| n.to_string()) crate_graph[krate]
== Some(crate_name.to_string()) .display_name
.as_ref()
.is_some_and(|it| &**it.crate_name() == crate_name)
}) })
.unwrap(); .expect("could not find crate");
let actual = search_dependencies(db.upcast(), krate, query) let actual = search_dependencies(db.upcast(), krate, query)
.into_iter() .into_iter()
@ -477,7 +428,7 @@ mod tests {
let (path, mark) = match assoc_item_path(&db, &dependency_imports, dependency) { let (path, mark) = match assoc_item_path(&db, &dependency_imports, dependency) {
Some(assoc_item_path) => (assoc_item_path, "a"), Some(assoc_item_path) => (assoc_item_path, "a"),
None => ( None => (
dependency_imports.path_of(dependency)?.display(&db).to_string(), render_path(&db, dependency_imports.import_info_for(dependency)?),
match dependency { match dependency {
ItemInNs::Types(ModuleDefId::FunctionId(_)) ItemInNs::Types(ModuleDefId::FunctionId(_))
| ItemInNs::Values(ModuleDefId::FunctionId(_)) => "f", | ItemInNs::Values(ModuleDefId::FunctionId(_)) => "f",
@ -507,57 +458,25 @@ mod tests {
dependency_imports: &ImportMap, dependency_imports: &ImportMap,
dependency: ItemInNs, dependency: ItemInNs,
) -> Option<String> { ) -> Option<String> {
let dependency_assoc_item_id = match dependency { let (dependency_assoc_item_id, container) = match dependency.as_module_def_id()? {
ItemInNs::Types(ModuleDefId::FunctionId(id)) ModuleDefId::FunctionId(id) => (AssocItemId::from(id), id.lookup(db).container),
| ItemInNs::Values(ModuleDefId::FunctionId(id)) => AssocItemId::from(id), ModuleDefId::ConstId(id) => (AssocItemId::from(id), id.lookup(db).container),
ItemInNs::Types(ModuleDefId::ConstId(id)) ModuleDefId::TypeAliasId(id) => (AssocItemId::from(id), id.lookup(db).container),
| ItemInNs::Values(ModuleDefId::ConstId(id)) => AssocItemId::from(id),
ItemInNs::Types(ModuleDefId::TypeAliasId(id))
| ItemInNs::Values(ModuleDefId::TypeAliasId(id)) => AssocItemId::from(id),
_ => return None, _ => return None,
}; };
let trait_ = assoc_to_trait(db, dependency)?; let ItemContainerId::TraitId(trait_id) = container else {
if let ModuleDefId::TraitId(tr) = trait_.as_module_def_id()? { return None;
let trait_data = db.trait_data(tr);
let assoc_item_name =
trait_data.items.iter().find_map(|(assoc_item_name, assoc_item_id)| {
if &dependency_assoc_item_id == assoc_item_id {
Some(assoc_item_name)
} else {
None
}
})?;
return Some(format!(
"{}::{}",
dependency_imports.path_of(trait_)?.display(db),
assoc_item_name.display(db.upcast())
));
}
None
}
fn assoc_to_trait(db: &dyn DefDatabase, item: ItemInNs) -> Option<ItemInNs> {
let assoc: AssocItemId = match item {
ItemInNs::Types(it) | ItemInNs::Values(it) => match it {
ModuleDefId::TypeAliasId(it) => it.into(),
ModuleDefId::FunctionId(it) => it.into(),
ModuleDefId::ConstId(it) => it.into(),
_ => return None,
},
_ => return None,
}; };
let container = match assoc { let trait_info = dependency_imports.import_info_for(ItemInNs::Types(trait_id.into()))?;
AssocItemId::FunctionId(it) => it.lookup(db).container,
AssocItemId::ConstId(it) => it.lookup(db).container,
AssocItemId::TypeAliasId(it) => it.lookup(db).container,
};
match container { let trait_data = db.trait_data(trait_id);
ItemContainerId::TraitId(it) => Some(ItemInNs::Types(it.into())), let (assoc_item_name, _) = trait_data
_ => None, .items
} .iter()
.find(|(_, assoc_item_id)| &dependency_assoc_item_id == assoc_item_id)?;
Some(format!("{}::{}", render_path(db, trait_info), assoc_item_name.display(db.upcast())))
} }
fn check(ra_fixture: &str, expect: Expect) { fn check(ra_fixture: &str, expect: Expect) {
@ -580,6 +499,24 @@ mod tests {
expect.assert_eq(&actual) expect.assert_eq(&actual)
} }
fn render_path(db: &dyn DefDatabase, info: &ImportInfo) -> String {
let mut module = info.container;
let mut segments = vec![&info.name];
let def_map = module.def_map(db);
assert!(def_map.block_id().is_none(), "block local items should not be in `ImportMap`");
while let Some(parent) = module.containing_module(db) {
let parent_data = &def_map[parent.local_id];
let (name, _) =
parent_data.children.iter().find(|(_, id)| **id == module.local_id).unwrap();
segments.push(name);
module = parent;
}
segments.iter().rev().map(|it| it.display(db.upcast())).join("::")
}
#[test] #[test]
fn smoke() { fn smoke() {
check( check(
@ -696,6 +633,7 @@ mod tests {
#[test] #[test]
fn module_reexport() { fn module_reexport() {
// Reexporting modules from a dependency adds all contents to the import map. // Reexporting modules from a dependency adds all contents to the import map.
// XXX: The rendered paths are relative to the defining crate.
check( check(
r" r"
//- /main.rs crate:main deps:lib //- /main.rs crate:main deps:lib
@ -711,9 +649,9 @@ mod tests {
- module::S (t) - module::S (t)
- module::S (v) - module::S (v)
main: main:
- module::S (t)
- module::S (v)
- reexported_module (t) - reexported_module (t)
- reexported_module::S (t)
- reexported_module::S (v)
"#]], "#]],
); );
} }
@ -1025,12 +963,9 @@ mod tests {
pub fn no() {} pub fn no() {}
"#, "#,
"main", "main",
Query::new("".to_string()).fuzzy().limit(2), Query::new("".to_string()).fuzzy().limit(1),
expect![[r#" expect![[r#"
dep::Fmt (m) dep::fmt::Display (t)
dep::Fmt (t)
dep::Fmt (v)
dep::fmt (t)
"#]], "#]],
); );
} }