1 //! Completion of paths, i.e. `some::prefix::$0`.
6 use rustc_hash::FxHashSet;
7 use syntax::{ast, AstNode};
10 context::{PathCompletionContext, PathKind},
11 patterns::ImmediateLocation,
12 CompletionContext, Completions,
15 pub(crate) fn complete_qualified_path(acc: &mut Completions, ctx: &CompletionContext) {
16 if ctx.is_path_disallowed() || ctx.has_impl_or_trait_prev_sibling() {
19 let (path, use_tree_parent, kind) = match ctx.path_context {
20 // let ... else, syntax would come in really handy here right now
21 Some(PathCompletionContext {
22 qualifier: Some(ref qualifier),
26 }) => (qualifier, use_tree_parent, kind),
30 let resolution = match ctx.sema.resolve_path(path) {
35 let context_module = ctx.scope.module();
37 match ctx.completion_location {
38 Some(ImmediateLocation::ItemList | ImmediateLocation::Trait | ImmediateLocation::Impl) => {
39 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
40 for (name, def) in module.scope(ctx.db, context_module) {
41 if let ScopeDef::MacroDef(macro_def) = def {
42 if macro_def.is_fn_like() {
43 acc.add_macro(ctx, Some(name.clone()), macro_def);
46 if let ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) = def {
47 acc.add_resolution(ctx, name, &def);
57 Some(PathKind::Vis { .. }) => {
58 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
59 if let Some(current_module) = ctx.scope.module() {
60 if let Some(next) = current_module
63 .take_while(|&it| it != module)
66 if let Some(name) = next.name(ctx.db) {
67 acc.add_resolution(ctx, name, &ScopeDef::ModuleDef(next.into()));
74 Some(PathKind::Attr) => {
75 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
76 for (name, def) in module.scope(ctx.db, context_module) {
77 let add_resolution = match def {
78 ScopeDef::MacroDef(mac) => mac.is_attr(),
79 ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) => true,
83 acc.add_resolution(ctx, name, &def);
89 Some(PathKind::Use) => {
90 if iter::successors(Some(path.clone()), |p| p.qualifier())
91 .all(|p| p.segment().and_then(|s| s.super_token()).is_some())
93 acc.add_keyword(ctx, "super::");
95 // only show `self` in a new use-tree when the qualifier doesn't end in self
98 path.segment().and_then(|it| it.kind()),
99 Some(ast::PathSegmentKind::SelfKw)
102 acc.add_keyword(ctx, "self");
108 if !matches!(kind, Some(PathKind::Pat)) {
109 // Add associated types on type parameters and `Self`.
110 resolution.assoc_type_shorthand_candidates(ctx.db, |_, alias| {
111 acc.add_type_alias(ctx, alias);
117 hir::PathResolution::Def(hir::ModuleDef::Module(module)) => {
118 let module_scope = module.scope(ctx.db, context_module);
119 for (name, def) in module_scope {
120 if let Some(PathKind::Use) = kind {
121 if let ScopeDef::Unknown = def {
122 if let Some(ast::NameLike::NameRef(name_ref)) = ctx.name_syntax.as_ref() {
123 if name_ref.syntax().text() == name.to_smol_str().as_str() {
124 // for `use self::foo$0`, don't suggest `foo` as a completion
125 cov_mark::hit!(dont_complete_current_use);
132 let add_resolution = match def {
133 // Don't suggest attribute macros and derives.
134 ScopeDef::MacroDef(mac) => mac.is_fn_like(),
135 // no values in type places
137 hir::ModuleDef::Function(_)
138 | hir::ModuleDef::Variant(_)
139 | hir::ModuleDef::Static(_),
141 | ScopeDef::Local(_) => !ctx.expects_type(),
142 // unless its a constant in a generic arg list position
143 ScopeDef::ModuleDef(hir::ModuleDef::Const(_)) => {
144 !ctx.expects_type() || ctx.expects_generic_arg()
150 acc.add_resolution(ctx, name, &def);
154 hir::PathResolution::Def(
157 (hir::ModuleDef::Adt(_)
158 | hir::ModuleDef::TypeAlias(_)
159 | hir::ModuleDef::BuiltinType(_)),
161 if let hir::ModuleDef::Adt(hir::Adt::Enum(e)) = def {
162 add_enum_variants(acc, ctx, e);
165 hir::ModuleDef::Adt(adt) => adt.ty(ctx.db),
166 hir::ModuleDef::TypeAlias(a) => {
167 let ty = a.ty(ctx.db);
168 if let Some(hir::Adt::Enum(e)) = ty.as_adt() {
169 cov_mark::hit!(completes_variant_through_alias);
170 add_enum_variants(acc, ctx, e);
174 hir::ModuleDef::BuiltinType(builtin) => {
175 let module = match ctx.scope.module() {
179 cov_mark::hit!(completes_primitive_assoc_const);
180 builtin.ty(ctx.db, module)
185 // XXX: For parity with Rust bug #22519, this does not complete Ty::AssocType.
186 // (where AssocType is defined on a trait, not an inherent impl)
188 let krate = ctx.krate;
189 if let Some(krate) = krate {
190 let traits_in_scope = ctx.scope.visible_traits();
191 ty.iterate_path_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, item| {
192 add_assoc_item(acc, ctx, item);
196 // Iterate assoc types separately
197 ty.iterate_assoc_items(ctx.db, krate, |item| {
198 if let hir::AssocItem::TypeAlias(ty) = item {
199 acc.add_type_alias(ctx, ty)
205 hir::PathResolution::Def(hir::ModuleDef::Trait(t)) => {
206 // Handles `Trait::assoc` as well as `<Ty as Trait>::assoc`.
207 for item in t.items(ctx.db) {
208 add_assoc_item(acc, ctx, item);
211 hir::PathResolution::TypeParam(_) | hir::PathResolution::SelfType(_) => {
212 if let Some(krate) = ctx.krate {
213 let ty = match resolution {
214 hir::PathResolution::TypeParam(param) => param.ty(ctx.db),
215 hir::PathResolution::SelfType(impl_def) => impl_def.self_ty(ctx.db),
219 if let Some(hir::Adt::Enum(e)) = ty.as_adt() {
220 add_enum_variants(acc, ctx, e);
223 let traits_in_scope = ctx.scope.visible_traits();
224 let mut seen = FxHashSet::default();
225 ty.iterate_path_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, item| {
226 // We might iterate candidates of a trait multiple times here, so deduplicate
228 if seen.insert(item) {
229 add_assoc_item(acc, ctx, item);
235 hir::PathResolution::Macro(mac) => acc.add_macro(ctx, None, mac),
240 fn add_assoc_item(acc: &mut Completions, ctx: &CompletionContext, item: hir::AssocItem) {
242 hir::AssocItem::Function(func) if !ctx.expects_type() => acc.add_function(ctx, func, None),
243 hir::AssocItem::Const(ct) if !ctx.expects_type() || ctx.expects_generic_arg() => {
244 acc.add_const(ctx, ct)
246 hir::AssocItem::TypeAlias(ty) => acc.add_type_alias(ctx, ty),
251 fn add_enum_variants(acc: &mut Completions, ctx: &CompletionContext, e: hir::Enum) {
252 if ctx.expects_type() {
255 e.variants(ctx.db).into_iter().for_each(|variant| acc.add_enum_variant(ctx, variant, None));
260 use expect_test::{expect, Expect};
262 use crate::tests::{check_edit, completion_list_no_kw};
264 fn check(ra_fixture: &str, expect: Expect) {
265 let actual = completion_list_no_kw(ra_fixture);
266 expect.assert_eq(&actual);
270 fn associated_item_visibility() {
273 //- /lib.rs crate:lib new_source_root:library
277 pub fn public_method() { }
278 fn private_method() { }
279 pub type PublicType = u32;
280 type PrivateType = u32;
281 pub const PUBLIC_CONST: u32 = 1;
282 const PRIVATE_CONST: u32 = 1;
285 //- /main.rs crate:main deps:lib new_source_root:local
286 fn foo() { let _ = lib::S::$0 }
289 fn public_method() fn()
290 ct PUBLIC_CONST pub const PUBLIC_CONST: u32;
291 ta PublicType pub type PublicType;
297 fn completes_union_associated_method() {
301 impl U { fn m() { } }
303 fn foo() { let _ = U::$0 }
312 fn completes_trait_associated_method_1() {
315 trait Trait { fn m(); }
317 fn foo() { let _ = Trait::$0 }
320 fn m() (as Trait) fn()
326 fn completes_trait_associated_method_2() {
329 trait Trait { fn m(); }
334 fn foo() { let _ = S::$0 }
337 fn m() (as Trait) fn()
343 fn completes_trait_associated_method_3() {
346 trait Trait { fn m(); }
351 fn foo() { let _ = <S as Trait>::$0 }
354 fn m() (as Trait) fn()
360 fn completes_ty_param_assoc_ty() {
374 fn submethod(&self) {}
377 fn foo<T: Sub>() { T::$0 }
380 ta SubTy (as Sub) type SubTy;
381 ta Ty (as Super) type Ty;
382 ct C2 (as Sub) const C2: ();
383 fn subfunc() (as Sub) fn()
384 me submethod(…) (as Sub) fn(&self)
385 ct CONST (as Super) const CONST: u8;
386 fn func() (as Super) fn()
387 me method(…) (as Super) fn(&self)
393 fn completes_self_param_assoc_ty() {
407 fn submethod(&self) {}
411 impl<T> Super for Wrap<T> {}
412 impl<T> Sub for Wrap<T> {
414 // Should be able to assume `Self: Sub + Super`
420 ta SubTy (as Sub) type SubTy;
421 ta Ty (as Super) type Ty;
422 ct CONST (as Super) const CONST: u8;
423 fn func() (as Super) fn()
424 me method(…) (as Super) fn(&self)
425 ct C2 (as Sub) const C2: ();
426 fn subfunc() (as Sub) fn()
427 me submethod(…) (as Sub) fn(&self)
433 fn completes_type_alias() {
437 impl S { fn foo() {} }
439 impl T { fn bar() {} }
451 fn completes_qualified_macros() {
455 macro_rules! foo { () => {} }
457 fn main() { let _ = crate::$0 }
461 ma foo!(…) #[macro_export] macro_rules! foo
467 fn does_not_complete_non_fn_macros() {
471 #[rustc_builtin_macro]
482 #[rustc_builtin_macro]
493 fn completes_reexported_items_under_correct_name() {
496 fn foo() { self::m::$0 }
499 pub use super::p::wrong_fn as right_fn;
500 pub use super::p::WRONG_CONST as RIGHT_CONST;
501 pub use super::p::WrongType as RightType;
505 const WRONG_CONST: u32 = 1;
519 fn foo() { self::m::$0 }
522 pub use super::p::wrong_fn as right_fn;
523 pub use super::p::WRONG_CONST as RIGHT_CONST;
524 pub use super::p::WrongType as RightType;
528 const WRONG_CONST: u32 = 1;
533 fn foo() { self::m::RightType }
536 pub use super::p::wrong_fn as right_fn;
537 pub use super::p::WRONG_CONST as RIGHT_CONST;
538 pub use super::p::WrongType as RightType;
542 const WRONG_CONST: u32 = 1;
550 fn completes_in_simple_macro_call() {
553 macro_rules! m { ($e:expr) => { $e } }
554 fn main() { m!(self::f$0); }
565 fn function_mod_share_name() {
568 fn foo() { self::m::$0 }
583 fn completes_hashmap_new() {
587 struct HashMap<K, V, S = RandomState> {}
589 impl<K, V> HashMap<K, V, RandomState> {
590 pub fn new() -> HashMap<K, V, RandomState> { }
597 fn new() fn() -> HashMap<K, V, RandomState>
603 fn dont_complete_attr() {
606 mod foo { pub struct Foo; }
615 fn completes_variant_through_self() {
638 fn completes_primitive_assoc_const() {
639 cov_mark::check!(completes_primitive_assoc_const);
642 //- /lib.rs crate:lib deps:core
647 //- /core.rs crate:core
650 pub const MAX: Self = 255;
656 ct MAX pub const MAX: Self;
663 fn completes_variant_through_alias() {
664 cov_mark::check!(completes_variant_through_alias);
682 fn respects_doc_hidden() {
683 cov_mark::check!(qualified_path_doc_hidden);
686 //- /lib.rs crate:lib deps:dep
691 //- /dep.rs crate:dep