Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'crates/hir-def/src/find_path.rs')
| -rw-r--r-- | crates/hir-def/src/find_path.rs | 98 |
1 files changed, 78 insertions, 20 deletions
diff --git a/crates/hir-def/src/find_path.rs b/crates/hir-def/src/find_path.rs index 8308203693..44e4d002de 100644 --- a/crates/hir-def/src/find_path.rs +++ b/crates/hir-def/src/find_path.rs @@ -177,7 +177,7 @@ fn find_path_for_module( path: ModPath::from_segments(PathKind::Crate, None), path_text_len: 5, stability: Stable, - prefer_due_to_prelude: false, + has_prelude_segment: false, }); } // - otherwise if the item is the crate root of a dependency crate, return the name from the extern prelude @@ -205,7 +205,7 @@ fn find_path_for_module( } else { PathKind::Plain }; - return Some(Choice::new(ctx.cfg.prefer_prelude, kind, name.clone(), Stable)); + return Some(Choice::new(kind, name.clone(), Stable)); } } @@ -223,12 +223,7 @@ fn find_path_for_module( ); if let Some(scope_name) = scope_name { // - if the item is already in scope, return the name under which it is - return Some(Choice::new( - ctx.cfg.prefer_prelude, - ctx.prefix.path_kind(), - scope_name, - Stable, - )); + return Some(Choice::new(ctx.prefix.path_kind(), scope_name, Stable)); } } @@ -240,7 +235,7 @@ fn find_path_for_module( path: ModPath::from_segments(kind, None), path_text_len: path_kind_len(kind), stability: Stable, - prefer_due_to_prelude: false, + has_prelude_segment: false, }); } @@ -302,7 +297,7 @@ fn find_in_prelude( }); if found_and_same_def.unwrap_or(true) { - Some(Choice::new(false, PathKind::Plain, name.clone(), Stable)) + Some(Choice::new(PathKind::Plain, name.clone(), Stable)) } else { None } @@ -419,6 +414,19 @@ fn find_in_sysroot( }); } +/// Computes the maximum path length allowed for a container module when searching for an item. +/// +/// When `prefer_prelude` is false and the current best path goes through a `prelude` module, +/// we relax the limit by 1 so that non-prelude paths one segment longer can still be found +/// and then preferred by `Choice::try_select`. +fn container_max_len(prefer_prelude: bool, max_len: usize, best_choice: &Option<Choice>) -> usize { + match best_choice { + Some(best) if !prefer_prelude && best.has_prelude_segment => best.path.len(), + Some(best) => best.path.len() - 1, + None => max_len, + } +} + fn find_in_dep( ctx: &FindPathCtx<'_>, visited_modules: &mut FxHashSet<(ItemInNs, ModuleId)>, @@ -444,7 +452,7 @@ fn find_in_dep( visited_modules, info.container, true, - best_choice.as_ref().map_or(max_len, |it| it.path.len()) - 1, + container_max_len(ctx.cfg.prefer_prelude, max_len, best_choice), ); let Some(mut choice) = choice else { continue; @@ -478,7 +486,7 @@ fn calculate_best_path_local( visited_modules, module_id, false, - best_choice.as_ref().map_or(max_len, |it| it.path.len()) - 1, + container_max_len(ctx.cfg.prefer_prelude, max_len, best_choice), ) { Choice::try_select(best_choice, choice, ctx.cfg.prefer_prelude, name.clone()); } @@ -492,23 +500,23 @@ struct Choice { path_text_len: usize, /// The stability of the path stability: Stability, - /// Whether this path contains a prelude segment and preference for it has been signaled - prefer_due_to_prelude: bool, + /// Whether any segment of this path is named `prelude` + has_prelude_segment: bool, } impl Choice { - fn new(prefer_prelude: bool, kind: PathKind, name: Name, stability: Stability) -> Self { + fn new(kind: PathKind, name: Name, stability: Stability) -> Self { Self { path_text_len: path_kind_len(kind) + name.as_str().len(), stability, - prefer_due_to_prelude: prefer_prelude && name == sym::prelude, + has_prelude_segment: name == sym::prelude, path: ModPath::from_segments(kind, iter::once(name)), } } - fn push(mut self, prefer_prelude: bool, name: Name) -> Self { + fn push(mut self, name: Name) -> Self { self.path_text_len += name.as_str().len(); - self.prefer_due_to_prelude |= prefer_prelude && name == sym::prelude; + self.has_prelude_segment |= name == sym::prelude; self.path.push_segment(name); self } @@ -520,13 +528,19 @@ impl Choice { name: Name, ) { let Some(current) = current else { - *current = Some(other.push(prefer_prelude, name)); + *current = Some(other.push(name)); return; }; match other .stability .cmp(¤t.stability) - .then_with(|| other.prefer_due_to_prelude.cmp(¤t.prefer_due_to_prelude)) + .then_with(|| { + if prefer_prelude { + other.has_prelude_segment.cmp(¤t.has_prelude_segment) + } else { + current.has_prelude_segment.cmp(&other.has_prelude_segment) + } + }) .then_with(|| (current.path.len()).cmp(&(other.path.len() + 1))) { Ordering::Less => return, @@ -2032,6 +2046,50 @@ pub mod foo { } #[test] + fn avoids_prelude_when_prefer_prelude_false() { + let ra_fixture = r#" +//- /main.rs crate:main deps:krate +$0 +//- /krate.rs crate:krate +pub mod prelude { + pub use crate::module::sub::*; +} +pub mod module { + pub mod sub { + pub struct Foo; + } +} +"#; + // krate::prelude::Foo (3 segs) is shorter than krate::module::sub::Foo (4 segs), + // but prefer_prelude=false should pick the longer canonical path. + check_found_path( + ra_fixture, + "krate::module::sub::Foo", + expect![[r#" + Plain (imports ✔): krate::module::sub::Foo + Plain (imports ✖): krate::module::sub::Foo + ByCrate(imports ✔): krate::module::sub::Foo + ByCrate(imports ✖): krate::module::sub::Foo + BySelf (imports ✔): krate::module::sub::Foo + BySelf (imports ✖): krate::module::sub::Foo + "#]], + ); + // prefer_prelude=true should still pick the shorter prelude path. + check_found_path_prelude( + ra_fixture, + "krate::prelude::Foo", + expect![[r#" + Plain (imports ✔): krate::prelude::Foo + Plain (imports ✖): krate::prelude::Foo + ByCrate(imports ✔): krate::prelude::Foo + ByCrate(imports ✖): krate::prelude::Foo + BySelf (imports ✔): krate::prelude::Foo + BySelf (imports ✖): krate::prelude::Foo + "#]], + ); + } + + #[test] fn respects_absolute_setting() { let ra_fixture = r#" //- /main.rs crate:main deps:krate |