language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-09-28 12:54:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Auto merge of #17340 - Veykril:find-path2, r=Veykril

Browse source 
internal: Improve `find_path` performance

cc https://github.com/rust-lang/rust-analyzer/issues/17339, db80216dac should fix a case where we don't reduce our search space appropriately. This also adds a fuel system which really shouldn't ever be hit, hence why it warns
This commit is contained in:
bors 2024-06-03 18:08:17 +00:00
commit 09d7dcc143
11 changed files with 180 additions and 214 deletions
Download patch file Download diff file Expand all files Collapse all files

303
crates/hir-def/src/find_path.rs
View file

@ -1,6 +1,6 @@
//! An algorithm to find a path to refer to a certain item. //! An algorithm to find a path to refer to a certain item.
use std::{cmp::Ordering, iter}; use std::{cell::Cell, cmp::Ordering, iter};
use hir_expand::{ use hir_expand::{
name::{known, AsName, Name}, name::{known, AsName, Name},
@ -23,15 +23,40 @@ pub fn find_path(
db: &dyn DefDatabase, db: &dyn DefDatabase,
item: ItemInNs, item: ItemInNs,
from: ModuleId, from: ModuleId,
prefix_kind: PrefixKind, mut prefix_kind: PrefixKind,
ignore_local_imports: bool, ignore_local_imports: bool,
cfg: ImportPathConfig, mut cfg: ImportPathConfig,
) -> Option<ModPath> { ) -> Option<ModPath> {
let _p = tracing::span!(tracing::Level::INFO, "find_path").entered(); let _p = tracing::span!(tracing::Level::INFO, "find_path").entered();
find_path_inner(FindPathCtx { db, prefix: prefix_kind, cfg, ignore_local_imports }, item, from)
// - if the item is a builtin, it's in scope
if let ItemInNs::Types(ModuleDefId::BuiltinType(builtin)) = item {
return Some(ModPath::from_segments(PathKind::Plain, iter::once(builtin.as_name())));
} }
#[derive(Copy, Clone, Debug)] // within block modules, forcing a `self` or `crate` prefix will not allow using inner items, so
// default to plain paths.
if item.module(db).is_some_and(ModuleId::is_within_block) {
prefix_kind = PrefixKind::Plain;
}
cfg.prefer_no_std = cfg.prefer_no_std || db.crate_supports_no_std(from.krate());
find_path_inner(
&FindPathCtx {
db,
prefix: prefix_kind,
cfg,
ignore_local_imports,
from,
from_def_map: &from.def_map(db),
fuel: Cell::new(FIND_PATH_FUEL),
},
item,
MAX_PATH_LEN,
)
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
enum Stability { enum Stability {
Unstable, Unstable,
Stable, Stable,
@ -46,6 +71,7 @@ fn zip_stability(a: Stability, b: Stability) -> Stability {
} }
const MAX_PATH_LEN: usize = 15; const MAX_PATH_LEN: usize = 15;
const FIND_PATH_FUEL: usize = 10000;
#[derive(Copy, Clone, Debug, PartialEq, Eq)] #[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum PrefixKind { pub enum PrefixKind {
@ -63,79 +89,54 @@ impl PrefixKind {
#[inline] #[inline]
fn path_kind(self) -> PathKind { fn path_kind(self) -> PathKind {
match self { match self {
PrefixKind::BySelf => PathKind::Super(0), PrefixKind::BySelf => PathKind::SELF,
PrefixKind::Plain => PathKind::Plain, PrefixKind::Plain => PathKind::Plain,
PrefixKind::ByCrate => PathKind::Crate, PrefixKind::ByCrate => PathKind::Crate,
} }
} }
} }
#[derive(Copy, Clone)]
struct FindPathCtx<'db> { struct FindPathCtx<'db> {
db: &'db dyn DefDatabase, db: &'db dyn DefDatabase,
prefix: PrefixKind, prefix: PrefixKind,
cfg: ImportPathConfig, cfg: ImportPathConfig,
ignore_local_imports: bool, ignore_local_imports: bool,
from: ModuleId,
from_def_map: &'db DefMap,
fuel: Cell<usize>,
} }
/// Attempts to find a path to refer to the given `item` visible from the `from` ModuleId /// Attempts to find a path to refer to the given `item` visible from the `from` ModuleId
fn find_path_inner(ctx: FindPathCtx<'_>, item: ItemInNs, from: ModuleId) -> Option<ModPath> { fn find_path_inner(ctx: &FindPathCtx<'_>, item: ItemInNs, max_len: usize) -> Option<ModPath> {
// - if the item is a builtin, it's in scope
if let ItemInNs::Types(ModuleDefId::BuiltinType(builtin)) = item {
return Some(ModPath::from_segments(PathKind::Plain, iter::once(builtin.as_name())));
}
let def_map = from.def_map(ctx.db);
let crate_root = from.derive_crate_root();
// - if the item is a module, jump straight to module search // - if the item is a module, jump straight to module search
if let ItemInNs::Types(ModuleDefId::ModuleId(module_id)) = item { if let ItemInNs::Types(ModuleDefId::ModuleId(module_id)) = item {
let mut visited_modules = FxHashSet::default(); let mut visited_modules = FxHashSet::default();
return find_path_for_module( return find_path_for_module(ctx, &mut visited_modules, module_id, max_len)
FindPathCtx {
cfg: ImportPathConfig {
prefer_no_std: ctx.cfg.prefer_no_std
|| ctx.db.crate_supports_no_std(crate_root.krate),
..ctx.cfg
},
..ctx
},
&def_map,
&mut visited_modules,
from,
module_id,
MAX_PATH_LEN,
)
.map(|(item, _)| item); .map(|(item, _)| item);
} }
let prefix = if item.module(ctx.db).is_some_and(|it| it.is_within_block()) { let may_be_in_scope = match ctx.prefix {
PrefixKind::Plain
} else {
ctx.prefix
};
let may_be_in_scope = match prefix {
PrefixKind::Plain | PrefixKind::BySelf => true, PrefixKind::Plain | PrefixKind::BySelf => true,
PrefixKind::ByCrate => from.is_crate_root(), PrefixKind::ByCrate => ctx.from.is_crate_root(),
}; };
if may_be_in_scope { if may_be_in_scope {
// - if the item is already in scope, return the name under which it is // - if the item is already in scope, return the name under which it is
let scope_name = find_in_scope(ctx.db, &def_map, from, item, ctx.ignore_local_imports); let scope_name =
find_in_scope(ctx.db, ctx.from_def_map, ctx.from, item, ctx.ignore_local_imports);
if let Some(scope_name) = scope_name { if let Some(scope_name) = scope_name {
return Some(ModPath::from_segments(prefix.path_kind(), iter::once(scope_name))); return Some(ModPath::from_segments(ctx.prefix.path_kind(), iter::once(scope_name)));
} }
} }
// - if the item is in the prelude, return the name from there // - if the item is in the prelude, return the name from there
if let value @ Some(_) = if let Some(value) = find_in_prelude(ctx.db, ctx.from_def_map, item, ctx.from) {
find_in_prelude(ctx.db, &crate_root.def_map(ctx.db), &def_map, item, from) return Some(value);
{
return value;
} }
if let Some(ModuleDefId::EnumVariantId(variant)) = item.as_module_def_id() { if let Some(ModuleDefId::EnumVariantId(variant)) = item.as_module_def_id() {
// - if the item is an enum variant, refer to it via the enum // - if the item is an enum variant, refer to it via the enum
if let Some(mut path) = if let Some(mut path) =
find_path_inner(ctx, ItemInNs::Types(variant.lookup(ctx.db).parent.into()), from) find_path_inner(ctx, ItemInNs::Types(variant.lookup(ctx.db).parent.into()), max_len)
{ {
path.push_segment(ctx.db.enum_variant_data(variant).name.clone()); path.push_segment(ctx.db.enum_variant_data(variant).name.clone());
return Some(path); return Some(path);
@ -147,53 +148,32 @@ fn find_path_inner(ctx: FindPathCtx<'_>, item: ItemInNs, from: ModuleId) -> Opti
let mut visited_modules = FxHashSet::default(); let mut visited_modules = FxHashSet::default();
calculate_best_path( calculate_best_path(ctx, &mut visited_modules, item, max_len).map(|(item, _)| item)
FindPathCtx {
cfg: ImportPathConfig {
prefer_no_std: ctx.cfg.prefer_no_std
|| ctx.db.crate_supports_no_std(crate_root.krate),
..ctx.cfg
},
..ctx
},
&def_map,
&mut visited_modules,
MAX_PATH_LEN,
item,
from,
)
.map(|(item, _)| item)
} }
#[tracing::instrument(skip_all)] #[tracing::instrument(skip_all)]
fn find_path_for_module( fn find_path_for_module(
ctx: FindPathCtx<'_>, ctx: &FindPathCtx<'_>,
def_map: &DefMap,
visited_modules: &mut FxHashSet<ModuleId>, visited_modules: &mut FxHashSet<ModuleId>,
from: ModuleId,
module_id: ModuleId, module_id: ModuleId,
max_len: usize, max_len: usize,
) -> Option<(ModPath, Stability)> { ) -> Option<(ModPath, Stability)> {
if max_len == 0 { if let Some(crate_root) = module_id.as_crate_root() {
return None; if crate_root == ctx.from.derive_crate_root() {
}
let is_crate_root = module_id.as_crate_root();
// - if the item is the crate root, return `crate` // - if the item is the crate root, return `crate`
if is_crate_root.is_some_and(|it| it == from.derive_crate_root()) {
return Some((ModPath::from_segments(PathKind::Crate, None), Stable)); return Some((ModPath::from_segments(PathKind::Crate, None), Stable));
} }
// - otherwise if the item is the crate root of a dependency crate, return the name from the extern prelude
let root_def_map = from.derive_crate_root().def_map(ctx.db); let root_def_map = ctx.from.derive_crate_root().def_map(ctx.db);
// - if the item is the crate root of a dependency crate, return the name from the extern prelude
if let Some(crate_root) = is_crate_root {
// rev here so we prefer looking at renamed extern decls first // rev here so we prefer looking at renamed extern decls first
for (name, (def_id, _extern_crate)) in root_def_map.extern_prelude().rev() { for (name, (def_id, _extern_crate)) in root_def_map.extern_prelude().rev() {
if crate_root != def_id { if crate_root != def_id {
continue; continue;
} }
let name_already_occupied_in_type_ns = def_map let name_already_occupied_in_type_ns = ctx
.with_ancestor_maps(ctx.db, from.local_id, &mut |def_map, local_id| { .from_def_map
.with_ancestor_maps(ctx.db, ctx.from.local_id, &mut |def_map, local_id| {
def_map[local_id] def_map[local_id]
.scope .scope
.type_(name) .type_(name)
@ -209,30 +189,30 @@ fn find_path_for_module(
return Some((ModPath::from_segments(kind, iter::once(name.clone())), Stable)); return Some((ModPath::from_segments(kind, iter::once(name.clone())), Stable));
} }
} }
let prefix = if module_id.is_within_block() { PrefixKind::Plain } else { ctx.prefix };
let may_be_in_scope = match prefix { let may_be_in_scope = match ctx.prefix {
PrefixKind::Plain | PrefixKind::BySelf => true, PrefixKind::Plain | PrefixKind::BySelf => true,
PrefixKind::ByCrate => from.is_crate_root(), PrefixKind::ByCrate => ctx.from.is_crate_root(),
}; };
if may_be_in_scope { if may_be_in_scope {
let scope_name = find_in_scope( let scope_name = find_in_scope(
ctx.db, ctx.db,
def_map, ctx.from_def_map,
from, ctx.from,
ItemInNs::Types(module_id.into()), ItemInNs::Types(module_id.into()),
ctx.ignore_local_imports, ctx.ignore_local_imports,
); );
if let Some(scope_name) = scope_name { if let Some(scope_name) = scope_name {
// - if the item is already in scope, return the name under which it is // - if the item is already in scope, return the name under which it is
return Some(( return Some((
ModPath::from_segments(prefix.path_kind(), iter::once(scope_name)), ModPath::from_segments(ctx.prefix.path_kind(), iter::once(scope_name)),
Stable, Stable,
)); ));
} }
} }
// - if the module can be referenced as self, super or crate, do that // - if the module can be referenced as self, super or crate, do that
if let Some(mod_path) = is_kw_kind_relative_to_from(def_map, module_id, from) { if let Some(mod_path) = is_kw_kind_relative_to_from(ctx.from_def_map, module_id, ctx.from) {
if ctx.prefix != PrefixKind::ByCrate || mod_path.kind == PathKind::Crate { if ctx.prefix != PrefixKind::ByCrate || mod_path.kind == PathKind::Crate {
return Some((mod_path, Stable)); return Some((mod_path, Stable));
} }
@ -240,21 +220,13 @@ fn find_path_for_module(
// - if the module is in the prelude, return it by that path // - if the module is in the prelude, return it by that path
if let Some(mod_path) = if let Some(mod_path) =
find_in_prelude(ctx.db, &root_def_map, def_map, ItemInNs::Types(module_id.into()), from) find_in_prelude(ctx.db, ctx.from_def_map, ItemInNs::Types(module_id.into()), ctx.from)
{ {
return Some((mod_path, Stable)); return Some((mod_path, Stable));
} }
calculate_best_path( calculate_best_path(ctx, visited_modules, ItemInNs::Types(module_id.into()), max_len)
ctx,
def_map,
visited_modules,
max_len,
ItemInNs::Types(module_id.into()),
from,
)
} }
// FIXME: Do we still need this now that we record import origins, and hence aliases?
fn find_in_scope( fn find_in_scope(
db: &dyn DefDatabase, db: &dyn DefDatabase,
def_map: &DefMap, def_map: &DefMap,
@ -274,13 +246,11 @@ fn find_in_scope(
/// name doesn't clash in current scope. /// name doesn't clash in current scope.
fn find_in_prelude( fn find_in_prelude(
db: &dyn DefDatabase, db: &dyn DefDatabase,
root_def_map: &DefMap,
local_def_map: &DefMap, local_def_map: &DefMap,
item: ItemInNs, item: ItemInNs,
from: ModuleId, from: ModuleId,
) -> Option<ModPath> { ) -> Option<ModPath> {
let (prelude_module, _) = root_def_map.prelude()?; let (prelude_module, _) = local_def_map.prelude()?;
// Preludes in block DefMaps are ignored, only the crate DefMap is searched
let prelude_def_map = prelude_module.def_map(db); let prelude_def_map = prelude_module.def_map(db);
let prelude_scope = &prelude_def_map[prelude_module.local_id].scope; let prelude_scope = &prelude_def_map[prelude_module.local_id].scope;
let (name, vis, _declared) = prelude_scope.name_of(item)?; let (name, vis, _declared) = prelude_scope.name_of(item)?;
@ -319,7 +289,7 @@ fn is_kw_kind_relative_to_from(
let from = from.local_id; let from = from.local_id;
if item == from { if item == from {
// - if the item is the module we're in, use `self` // - if the item is the module we're in, use `self`
Some(ModPath::from_segments(PathKind::Super(0), None)) Some(ModPath::from_segments(PathKind::SELF, None))
} else if let Some(parent_id) = def_map[from].parent { } else if let Some(parent_id) = def_map[from].parent {
if item == parent_id { if item == parent_id {
// - if the item is the parent module, use `super` (this is not used recursively, since `super::super` is ugly) // - if the item is the parent module, use `super` (this is not used recursively, since `super::super` is ugly)
@ -337,60 +307,71 @@ fn is_kw_kind_relative_to_from(
#[tracing::instrument(skip_all)] #[tracing::instrument(skip_all)]
fn calculate_best_path( fn calculate_best_path(
ctx: FindPathCtx<'_>, ctx: &FindPathCtx<'_>,
def_map: &DefMap,
visited_modules: &mut FxHashSet<ModuleId>, visited_modules: &mut FxHashSet<ModuleId>,
max_len: usize,
item: ItemInNs, item: ItemInNs,
from: ModuleId, max_len: usize,
) -> Option<(ModPath, Stability)> { ) -> Option<(ModPath, Stability)> {
if max_len <= 1 { if max_len <= 1 {
// recursive base case, we can't find a path prefix of length 0, one segment is occupied by
// the item's name itself.
return None; return None;
} }
let mut best_path = None; let fuel = ctx.fuel.get();
let update_best_path = if fuel == 0 {
|best_path: &mut Option<_>, new_path: (ModPath, Stability)| match best_path { // we ran out of fuel, so we stop searching here
Some((old_path, old_stability)) => { tracing::warn!(
*old_path = new_path.0; "ran out of fuel while searching for a path for item {item:?} of krate {:?} from krate {:?}",
*old_stability = zip_stability(*old_stability, new_path.1); item.krate(ctx.db),
ctx.from.krate()
);
return None;
} }
None => *best_path = Some(new_path), ctx.fuel.set(fuel - 1);
};
// Recursive case:
// - otherwise, look for modules containing (reexporting) it and import it from one of those
if item.krate(ctx.db) == Some(from.krate) {
let mut best_path_len = max_len;
// Item was defined in the same crate that wants to import it. It cannot be found in any
// dependency in this case.
for (module_id, name) in find_local_import_locations(ctx.db, item, from) {
if !visited_modules.insert(module_id) {
continue;
}
if let Some(mut path) = find_path_for_module(
ctx,
def_map,
visited_modules,
from,
module_id,
best_path_len - 1,
) {
path.0.push_segment(name);
let mut best_path = None;
let mut best_path_len = max_len;
let mut process = |mut path: (ModPath, Stability), name, best_path_len: &mut _| {
path.0.push_segment(name);
let new_path = match best_path.take() { let new_path = match best_path.take() {
Some(best_path) => select_best_path(best_path, path, ctx.cfg), Some(best_path) => select_best_path(best_path, path, ctx.cfg),
None => path, None => path,
}; };
best_path_len = new_path.0.len(); if new_path.1 == Stable {
update_best_path(&mut best_path, new_path); *best_path_len = new_path.0.len();
} }
match &mut best_path {
Some((old_path, old_stability)) => {
*old_path = new_path.0;
*old_stability = zip_stability(*old_stability, new_path.1);
} }
None => best_path = Some(new_path),
}
};
let db = ctx.db;
if item.krate(db) == Some(ctx.from.krate) {
// Item was defined in the same crate that wants to import it. It cannot be found in any
// dependency in this case.
// FIXME: cache the `find_local_import_locations` output?
find_local_import_locations(db, item, ctx.from, ctx.from_def_map, |name, module_id| {
if !visited_modules.insert(module_id) {
return;
}
// we are looking for paths of length up to best_path_len, any longer will make it be
// less optimal. The -1 is due to us pushing name onto it afterwards.
if let Some(path) =
find_path_for_module(ctx, visited_modules, module_id, best_path_len - 1)
{
process(path, name.clone(), &mut best_path_len);
}
})
} else { } else {
// Item was defined in some upstream crate. This means that it must be exported from one, // Item was defined in some upstream crate. This means that it must be exported from one,
// too (unless we can't name it at all). It could *also* be (re)exported by the same crate // too (unless we can't name it at all). It could *also* be (re)exported by the same crate
// that wants to import it here, but we always prefer to use the external path here. // that wants to import it here, but we always prefer to use the external path here.
for dep in &ctx.db.crate_graph()[from.krate].dependencies { for dep in &db.crate_graph()[ctx.from.krate].dependencies {
let import_map = ctx.db.import_map(dep.crate_id); let import_map = db.import_map(dep.crate_id);
let Some(import_info_for) = import_map.import_info_for(item) else { continue }; let Some(import_info_for) = import_map.import_info_for(item) else { continue };
for info in import_info_for { for info in import_info_for {
if info.is_doc_hidden { if info.is_doc_hidden {
@ -400,29 +381,18 @@ fn calculate_best_path(
// Determine best path for containing module and append last segment from `info`. // Determine best path for containing module and append last segment from `info`.
// FIXME: we should guide this to look up the path locally, or from the same crate again? // FIXME: we should guide this to look up the path locally, or from the same crate again?
let Some((mut path, path_stability)) = find_path_for_module( let path =
ctx, find_path_for_module(ctx, visited_modules, info.container, best_path_len - 1);
def_map, let Some((path, path_stability)) = path else {
visited_modules,
from,
info.container,
max_len - 1,
) else {
continue; continue;
}; };
cov_mark::hit!(partially_imported); cov_mark::hit!(partially_imported);
path.push_segment(info.name.clone()); let path = (
let path_with_stab = (
path, path,
zip_stability(path_stability, if info.is_unstable { Unstable } else { Stable }), zip_stability(path_stability, if info.is_unstable { Unstable } else { Stable }),
); );
let new_path_with_stab = match best_path.take() { process(path, info.name.clone(), &mut best_path_len);
Some(best_path) => select_best_path(best_path, path_with_stab, ctx.cfg),
None => path_with_stab,
};
update_best_path(&mut best_path, new_path_with_stab);
} }
} }
} }
@ -430,7 +400,7 @@ fn calculate_best_path(
} }
/// Select the best (most relevant) path between two paths. /// Select the best (most relevant) path between two paths.
/// This accounts for stability, path length whether std should be chosen over alloc/core paths as /// This accounts for stability, path length whether, std should be chosen over alloc/core paths as
/// well as ignoring prelude like paths or not. /// well as ignoring prelude like paths or not.
fn select_best_path( fn select_best_path(
old_path @ (_, old_stability): (ModPath, Stability), old_path @ (_, old_stability): (ModPath, Stability),
@ -496,36 +466,33 @@ fn select_best_path(
} }
} }
// FIXME: Remove allocations
/// Finds locations in `from.krate` from which `item` can be imported by `from`. /// Finds locations in `from.krate` from which `item` can be imported by `from`.
fn find_local_import_locations( fn find_local_import_locations(
db: &dyn DefDatabase, db: &dyn DefDatabase,
item: ItemInNs, item: ItemInNs,
from: ModuleId, from: ModuleId,
) -> Vec<(ModuleId, Name)> { def_map: &DefMap,
mut cb: impl FnMut(&Name, ModuleId),
) {
let _p = tracing::span!(tracing::Level::INFO, "find_local_import_locations").entered(); let _p = tracing::span!(tracing::Level::INFO, "find_local_import_locations").entered();
// `from` can import anything below `from` with visibility of at least `from`, and anything // `from` can import anything below `from` with visibility of at least `from`, and anything
// above `from` with any visibility. That means we do not need to descend into private siblings // above `from` with any visibility. That means we do not need to descend into private siblings
// of `from` (and similar). // of `from` (and similar).
let def_map = from.def_map(db);
// Compute the initial worklist. We start with all direct child modules of `from` as well as all // Compute the initial worklist. We start with all direct child modules of `from` as well as all
// of its (recursive) parent modules. // of its (recursive) parent modules.
let data = &def_map[from.local_id]; let mut worklist = def_map[from.local_id]
let mut worklist = .children
data.children.values().map(|child| def_map.module_id(*child)).collect::<Vec<_>>(); .values()
.map(|child| def_map.module_id(*child))
// FIXME: do we need to traverse out of block expressions here? // FIXME: do we need to traverse out of block expressions here?
for ancestor in iter::successors(from.containing_module(db), |m| m.containing_module(db)) { .chain(iter::successors(from.containing_module(db), |m| m.containing_module(db)))
worklist.push(ancestor); .collect::<Vec<_>>();
} let mut seen: FxHashSet<_> = FxHashSet::default();
let def_map = def_map.crate_root().def_map(db); let def_map = def_map.crate_root().def_map(db);
let mut seen: FxHashSet<_> = FxHashSet::default();
let mut locations = Vec::new();
while let Some(module) = worklist.pop() { while let Some(module) = worklist.pop() {
if !seen.insert(module) { if !seen.insert(module) {
continue; // already processed this module continue; // already processed this module
@ -566,7 +533,7 @@ fn find_local_import_locations(
// the item and we're a submodule of it, so can we. // the item and we're a submodule of it, so can we.
// Also this keeps the cached data smaller. // Also this keeps the cached data smaller.
if declared || is_pub_or_explicit { if declared || is_pub_or_explicit {
locations.push((module, name.clone())); cb(name, module);
} }
} }
} }
@ -578,8 +545,6 @@ fn find_local_import_locations(
} }
} }
} }
locations
} }
#[cfg(test)] #[cfg(test)]
@ -633,15 +598,13 @@ mod tests {
.into_iter() .into_iter()
.cartesian_product([false, true]) .cartesian_product([false, true])
{ {
let found_path = find_path_inner( let found_path = find_path(
FindPathCtx { &db,
db: &db,
prefix,
cfg: ImportPathConfig { prefer_no_std: false, prefer_prelude },
ignore_local_imports,
},
resolved, resolved,
module, module,
prefix,
ignore_local_imports,
ImportPathConfig { prefer_no_std: false, prefer_prelude },
); );
format_to!( format_to!(
res, res,

12
crates/hir-def/src/item_tree.rs
View file

@ -242,11 +242,11 @@ impl ItemVisibilities {
match &vis { match &vis {
RawVisibility::Public => RawVisibilityId::PUB, RawVisibility::Public => RawVisibilityId::PUB,
RawVisibility::Module(path, explicitiy) if path.segments().is_empty() => { RawVisibility::Module(path, explicitiy) if path.segments().is_empty() => {
match (&path.kind, explicitiy) { match (path.kind, explicitiy) {
(PathKind::Super(0), VisibilityExplicitness::Explicit) => { (PathKind::SELF, VisibilityExplicitness::Explicit) => {
RawVisibilityId::PRIV_EXPLICIT RawVisibilityId::PRIV_EXPLICIT
} }
(PathKind::Super(0), VisibilityExplicitness::Implicit) => { (PathKind::SELF, VisibilityExplicitness::Implicit) => {
RawVisibilityId::PRIV_IMPLICIT RawVisibilityId::PRIV_IMPLICIT
} }
(PathKind::Crate, _) => RawVisibilityId::PUB_CRATE, (PathKind::Crate, _) => RawVisibilityId::PUB_CRATE,
@ -586,11 +586,11 @@ impl Index<RawVisibilityId> for ItemTree {
fn index(&self, index: RawVisibilityId) -> &Self::Output { fn index(&self, index: RawVisibilityId) -> &Self::Output {
static VIS_PUB: RawVisibility = RawVisibility::Public; static VIS_PUB: RawVisibility = RawVisibility::Public;
static VIS_PRIV_IMPLICIT: RawVisibility = RawVisibility::Module( static VIS_PRIV_IMPLICIT: RawVisibility = RawVisibility::Module(
ModPath::from_kind(PathKind::Super(0)), ModPath::from_kind(PathKind::SELF),
VisibilityExplicitness::Implicit, VisibilityExplicitness::Implicit,
); );
static VIS_PRIV_EXPLICIT: RawVisibility = RawVisibility::Module( static VIS_PRIV_EXPLICIT: RawVisibility = RawVisibility::Module(
ModPath::from_kind(PathKind::Super(0)), ModPath::from_kind(PathKind::SELF),
VisibilityExplicitness::Explicit, VisibilityExplicitness::Explicit,
); );
static VIS_PUB_CRATE: RawVisibility = RawVisibility::Module( static VIS_PUB_CRATE: RawVisibility = RawVisibility::Module(
@ -928,7 +928,7 @@ impl UseTree {
_ => None, _ => None,
} }
} }
(Some(prefix), PathKind::Super(0)) if path.segments().is_empty() => { (Some(prefix), PathKind::SELF) if path.segments().is_empty() => {
// `some::path::self` == `some::path` // `some::path::self` == `some::path`
Some((prefix, ImportKind::TypeOnly)) Some((prefix, ImportKind::TypeOnly))
} }

38
crates/hir-def/src/lib.rs
View file

@ -396,6 +396,23 @@ impl PartialEq<ModuleId> for CrateRootModuleId {
other.block.is_none() && other.local_id == DefMap::ROOT && self.krate == other.krate other.block.is_none() && other.local_id == DefMap::ROOT && self.krate == other.krate
} }
} }
impl PartialEq<CrateRootModuleId> for ModuleId {
fn eq(&self, other: &CrateRootModuleId) -> bool {
other == self
}
}
impl From<CrateRootModuleId> for ModuleId {
fn from(CrateRootModuleId { krate }: CrateRootModuleId) -> Self {
ModuleId { krate, block: None, local_id: DefMap::ROOT }
}
}
impl From<CrateRootModuleId> for ModuleDefId {
fn from(value: CrateRootModuleId) -> Self {
ModuleDefId::ModuleId(value.into())
}
}
impl From<CrateId> for CrateRootModuleId { impl From<CrateId> for CrateRootModuleId {
fn from(krate: CrateId) -> Self { fn from(krate: CrateId) -> Self {
@ -472,6 +489,7 @@ impl ModuleId {
self.block.is_some() self.block.is_some()
} }
/// Returns the [`CrateRootModuleId`] for this module if it is the crate root module.
pub fn as_crate_root(&self) -> Option<CrateRootModuleId> { pub fn as_crate_root(&self) -> Option<CrateRootModuleId> {
if self.local_id == DefMap::ROOT && self.block.is_none() { if self.local_id == DefMap::ROOT && self.block.is_none() {
Some(CrateRootModuleId { krate: self.krate }) Some(CrateRootModuleId { krate: self.krate })
@ -480,33 +498,17 @@ impl ModuleId {
} }
} }
/// Returns the [`CrateRootModuleId`] for this module.
pub fn derive_crate_root(&self) -> CrateRootModuleId { pub fn derive_crate_root(&self) -> CrateRootModuleId {
CrateRootModuleId { krate: self.krate } CrateRootModuleId { krate: self.krate }
} }
/// Whether this module represents the crate root module
fn is_crate_root(&self) -> bool { fn is_crate_root(&self) -> bool {
self.local_id == DefMap::ROOT && self.block.is_none() self.local_id == DefMap::ROOT && self.block.is_none()
} }
} }
impl PartialEq<CrateRootModuleId> for ModuleId {
fn eq(&self, other: &CrateRootModuleId) -> bool {
other == self
}
}
impl From<CrateRootModuleId> for ModuleId {
fn from(CrateRootModuleId { krate }: CrateRootModuleId) -> Self {
ModuleId { krate, block: None, local_id: DefMap::ROOT }
}
}
impl From<CrateRootModuleId> for ModuleDefId {
fn from(value: CrateRootModuleId) -> Self {
ModuleDefId::ModuleId(value.into())
}
}
/// An ID of a module, **local** to a `DefMap`. /// An ID of a module, **local** to a `DefMap`.
pub type LocalModuleId = Idx<nameres::ModuleData>; pub type LocalModuleId = Idx<nameres::ModuleData>;

4
crates/hir-def/src/nameres/path_resolution.rs
View file

@ -283,7 +283,7 @@ impl DefMap {
// If we have a different `DefMap` from `self` (the original `DefMap` we started // If we have a different `DefMap` from `self` (the original `DefMap` we started
// with), resolve the remaining path segments in that `DefMap`. // with), resolve the remaining path segments in that `DefMap`.
let path = let path =
ModPath::from_segments(PathKind::Super(0), path.segments().iter().cloned()); ModPath::from_segments(PathKind::SELF, path.segments().iter().cloned());
return def_map.resolve_path_fp_with_macro( return def_map.resolve_path_fp_with_macro(
db, db,
mode, mode,
@ -333,7 +333,7 @@ impl DefMap {
ModuleDefId::ModuleId(module) => { ModuleDefId::ModuleId(module) => {
if module.krate != self.krate { if module.krate != self.krate {
let path = ModPath::from_segments( let path = ModPath::from_segments(
PathKind::Super(0), PathKind::SELF,
path.segments()[i..].iter().cloned(), path.segments()[i..].iter().cloned(),
); );
tracing::debug!("resolving {:?} in other crate", path); tracing::debug!("resolving {:?} in other crate", path);

4
crates/hir-def/src/path/lower.rs
View file

@ -122,7 +122,7 @@ pub(super) fn lower_path(ctx: &LowerCtx<'_>, mut path: ast::Path) -> Option<Path
// don't break out if `self` is the last segment of a path, this mean we got a // don't break out if `self` is the last segment of a path, this mean we got a
// use tree like `foo::{self}` which we want to resolve as `foo` // use tree like `foo::{self}` which we want to resolve as `foo`
if !segments.is_empty() { if !segments.is_empty() {
kind = PathKind::Super(0); kind = PathKind::SELF;
break; break;
} }
} }
@ -144,7 +144,7 @@ pub(super) fn lower_path(ctx: &LowerCtx<'_>, mut path: ast::Path) -> Option<Path
if segments.is_empty() && kind == PathKind::Plain && type_anchor.is_none() { if segments.is_empty() && kind == PathKind::Plain && type_anchor.is_none() {
// plain empty paths don't exist, this means we got a single `self` segment as our path // plain empty paths don't exist, this means we got a single `self` segment as our path
kind = PathKind::Super(0); kind = PathKind::SELF;
} }
// handle local_inner_macros : // handle local_inner_macros :

2
crates/hir-def/src/pretty.rs
View file

@ -57,7 +57,7 @@ pub(crate) fn print_path(db: &dyn DefDatabase, path: &Path, buf: &mut dyn Write)
} }
None => match path.kind() { None => match path.kind() {
PathKind::Plain => {} PathKind::Plain => {}
PathKind::Super(0) => write!(buf, "self")?, &PathKind::SELF => write!(buf, "self")?,
PathKind::Super(n) => { PathKind::Super(n) => {
for i in 0..*n { for i in 0..*n {
if i == 0 { if i == 0 {

7
crates/hir-def/src/visibility.rs
View file

@ -27,10 +27,7 @@ pub enum RawVisibility {
impl RawVisibility { impl RawVisibility {
pub(crate) const fn private() -> RawVisibility { pub(crate) const fn private() -> RawVisibility {
RawVisibility::Module( RawVisibility::Module(ModPath::from_kind(PathKind::SELF), VisibilityExplicitness::Implicit)
ModPath::from_kind(PathKind::Super(0)),
VisibilityExplicitness::Implicit,
)
} }
pub(crate) fn from_ast( pub(crate) fn from_ast(
@ -60,7 +57,7 @@ impl RawVisibility {
} }
ast::VisibilityKind::PubCrate => ModPath::from_kind(PathKind::Crate), ast::VisibilityKind::PubCrate => ModPath::from_kind(PathKind::Crate),
ast::VisibilityKind::PubSuper => ModPath::from_kind(PathKind::Super(1)), ast::VisibilityKind::PubSuper => ModPath::from_kind(PathKind::Super(1)),
ast::VisibilityKind::PubSelf => ModPath::from_kind(PathKind::Super(0)), ast::VisibilityKind::PubSelf => ModPath::from_kind(PathKind::SELF),
ast::VisibilityKind::Pub => return RawVisibility::Public, ast::VisibilityKind::Pub => return RawVisibility::Public,
}; };
RawVisibility::Module(path, VisibilityExplicitness::Explicit) RawVisibility::Module(path, VisibilityExplicitness::Explicit)

12
crates/hir-expand/src/mod_path.rs
View file

@ -44,6 +44,10 @@ pub enum PathKind {
DollarCrate(CrateId), DollarCrate(CrateId),
} }
impl PathKind {
pub const SELF: PathKind = PathKind::Super(0);
}
impl ModPath { impl ModPath {
pub fn from_src( pub fn from_src(
db: &dyn ExpandDatabase, db: &dyn ExpandDatabase,
@ -96,7 +100,7 @@ impl ModPath {
pub fn textual_len(&self) -> usize { pub fn textual_len(&self) -> usize {
let base = match self.kind { let base = match self.kind {
PathKind::Plain => 0, PathKind::Plain => 0,
PathKind::Super(0) => "self".len(), PathKind::SELF => "self".len(),
PathKind::Super(i) => "super".len() * i as usize, PathKind::Super(i) => "super".len() * i as usize,
PathKind::Crate => "crate".len(), PathKind::Crate => "crate".len(),
PathKind::Abs => 0, PathKind::Abs => 0,
@ -113,7 +117,7 @@ impl ModPath {
} }
pub fn is_self(&self) -> bool { pub fn is_self(&self) -> bool {
self.kind == PathKind::Super(0) && self.segments.is_empty() self.kind == PathKind::SELF && self.segments.is_empty()
} }
#[allow(non_snake_case)] #[allow(non_snake_case)]
@ -193,7 +197,7 @@ fn display_fmt_path(
}; };
match path.kind { match path.kind {
PathKind::Plain => {} PathKind::Plain => {}
PathKind::Super(0) => add_segment("self")?, PathKind::SELF => add_segment("self")?,
PathKind::Super(n) => { PathKind::Super(n) => {
for _ in 0..n { for _ in 0..n {
add_segment("super")?; add_segment("super")?;
@ -316,7 +320,7 @@ fn convert_path_tt(db: &dyn ExpandDatabase, tt: &[tt::TokenTree]) -> Option<ModP
tt::Leaf::Ident(tt::Ident { text, span }) if text == "$crate" => { tt::Leaf::Ident(tt::Ident { text, span }) if text == "$crate" => {
resolve_crate_root(db, span.ctx).map(PathKind::DollarCrate).unwrap_or(PathKind::Crate) resolve_crate_root(db, span.ctx).map(PathKind::DollarCrate).unwrap_or(PathKind::Crate)
} }
tt::Leaf::Ident(tt::Ident { text, .. }) if text == "self" => PathKind::Super(0), tt::Leaf::Ident(tt::Ident { text, .. }) if text == "self" => PathKind::SELF,
tt::Leaf::Ident(tt::Ident { text, .. }) if text == "super" => { tt::Leaf::Ident(tt::Ident { text, .. }) if text == "super" => {
let mut deg = 1; let mut deg = 1;
while let Some(tt::Leaf::Ident(tt::Ident { text, .. })) = leaves.next() { while let Some(tt::Leaf::Ident(tt::Ident { text, .. })) = leaves.next() {

2
crates/hir-ty/src/display.rs
View file

@ -1942,7 +1942,7 @@ impl HirDisplay for Path {
(_, PathKind::Plain) => {} (_, PathKind::Plain) => {}
(_, PathKind::Abs) => {} (_, PathKind::Abs) => {}
(_, PathKind::Crate) => write!(f, "crate")?, (_, PathKind::Crate) => write!(f, "crate")?,
(_, PathKind::Super(0)) => write!(f, "self")?, (_, &PathKind::SELF) => write!(f, "self")?,
(_, PathKind::Super(n)) => { (_, PathKind::Super(n)) => {
for i in 0..*n { for i in 0..*n {
if i > 0 { if i > 0 {

2
crates/hir/src/attrs.rs
View file

@ -307,7 +307,7 @@ fn doc_modpath_from_str(link: &str) -> Option<ModPath> {
let kind = match parts.next()? { let kind = match parts.next()? {
"" => PathKind::Abs, "" => PathKind::Abs,
"crate" => PathKind::Crate, "crate" => PathKind::Crate,
"self" => PathKind::Super(0), "self" => PathKind::SELF,
"super" => { "super" => {
let mut deg = 1; let mut deg = 1;
for segment in parts.by_ref() { for segment in parts.by_ref() {

2
crates/ide-db/src/helpers.rs
View file

@ -41,7 +41,7 @@ pub fn mod_path_to_ast(path: &hir::ModPath) -> ast::Path {
let mut is_abs = false; let mut is_abs = false;
match path.kind { match path.kind {
hir::PathKind::Plain => {} hir::PathKind::Plain => {}
hir::PathKind::Super(0) => segments.push(make::path_segment_self()), hir::PathKind::SELF => segments.push(make::path_segment_self()),
hir::PathKind::Super(n) => segments.extend((0..n).map(|_| make::path_segment_super())), hir::PathKind::Super(n) => segments.extend((0..n).map(|_| make::path_segment_super())),
hir::PathKind::DollarCrate(_) | hir::PathKind::Crate => { hir::PathKind::DollarCrate(_) | hir::PathKind::Crate => {
segments.push(make::path_segment_crate()) segments.push(make::path_segment_crate())