1 //! Completion of paths, i.e. `some::prefix::$0`.
5 use rustc_hash::FxHashSet;
6 use syntax::{ast, AstNode};
9 context::PathCompletionContext, patterns::ImmediateLocation, CompletionContext, Completions,
12 pub(crate) fn complete_qualified_path(acc: &mut Completions, ctx: &CompletionContext) {
13 if ctx.is_path_disallowed() || ctx.has_impl_or_trait_prev_sibling() {
16 let (path, use_tree_parent) = match &ctx.path_context {
17 Some(PathCompletionContext { qualifier: Some(qualifier), use_tree_parent, .. }) => {
18 (qualifier, *use_tree_parent)
23 let resolution = match ctx.sema.resolve_path(path) {
28 let context_module = ctx.scope.module();
30 match ctx.completion_location {
31 Some(ImmediateLocation::ItemList | ImmediateLocation::Trait | ImmediateLocation::Impl) => {
32 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
33 for (name, def) in module.scope(ctx.db, context_module) {
34 if let hir::ScopeDef::MacroDef(macro_def) = def {
35 if macro_def.is_fn_like() {
36 acc.add_macro(ctx, Some(name.clone()), macro_def);
39 if let hir::ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) = def {
40 acc.add_resolution(ctx, name, &def);
46 Some(ImmediateLocation::Visibility(_)) => {
47 if let hir::PathResolution::Def(hir::ModuleDef::Module(resolved)) = resolution {
48 if let Some(current_module) = ctx.scope.module() {
49 if let Some(next) = current_module
52 .take_while(|&it| it != resolved)
55 if let Some(name) = next.name(ctx.db) {
56 acc.add_resolution(ctx, name, &hir::ScopeDef::ModuleDef(next.into()));
66 if ctx.in_use_tree() {
67 if iter::successors(Some(path.clone()), |p| p.qualifier())
68 .all(|p| p.segment().and_then(|s| s.super_token()).is_some())
70 acc.add_keyword(ctx, "super::");
72 // only show `self` in a new use-tree when the qualifier doesn't end in self
75 path.segment().and_then(|it| it.kind()),
76 Some(ast::PathSegmentKind::SelfKw)
79 acc.add_keyword(ctx, "self");
83 // Add associated types on type parameters and `Self`.
84 resolution.assoc_type_shorthand_candidates(ctx.db, |_, alias| {
85 acc.add_type_alias(ctx, alias);
90 hir::PathResolution::Def(hir::ModuleDef::Module(module)) => {
91 let module_scope = module.scope(ctx.db, context_module);
92 for (name, def) in module_scope {
93 if ctx.in_use_tree() {
94 if let hir::ScopeDef::Unknown = def {
95 if let Some(ast::NameLike::NameRef(name_ref)) = ctx.name_syntax.as_ref() {
96 if name_ref.syntax().text() == name.to_smol_str().as_str() {
97 // for `use self::foo$0`, don't suggest `foo` as a completion
98 cov_mark::hit!(dont_complete_current_use);
105 let add_resolution = match def {
106 // Don't suggest attribute macros and derives.
107 hir::ScopeDef::MacroDef(mac) => mac.is_fn_like(),
108 // no values in type places
109 hir::ScopeDef::ModuleDef(
110 hir::ModuleDef::Function(_)
111 | hir::ModuleDef::Variant(_)
112 | hir::ModuleDef::Static(_),
114 | hir::ScopeDef::Local(_) => !ctx.expects_type(),
115 // unless its a constant in a generic arg list position
116 hir::ScopeDef::ModuleDef(hir::ModuleDef::Const(_)) => {
117 !ctx.expects_type() || ctx.expects_generic_arg()
123 acc.add_resolution(ctx, name, &def);
127 hir::PathResolution::Def(
130 (hir::ModuleDef::Adt(_)
131 | hir::ModuleDef::TypeAlias(_)
132 | hir::ModuleDef::BuiltinType(_)),
134 if let hir::ModuleDef::Adt(hir::Adt::Enum(e)) = def {
135 add_enum_variants(acc, ctx, e);
138 hir::ModuleDef::Adt(adt) => adt.ty(ctx.db),
139 hir::ModuleDef::TypeAlias(a) => {
140 let ty = a.ty(ctx.db);
141 if let Some(hir::Adt::Enum(e)) = ty.as_adt() {
142 cov_mark::hit!(completes_variant_through_alias);
143 add_enum_variants(acc, ctx, e);
147 hir::ModuleDef::BuiltinType(builtin) => {
148 let module = match ctx.scope.module() {
152 cov_mark::hit!(completes_primitive_assoc_const);
153 builtin.ty(ctx.db, module)
158 // XXX: For parity with Rust bug #22519, this does not complete Ty::AssocType.
159 // (where AssocType is defined on a trait, not an inherent impl)
161 let krate = ctx.krate;
162 if let Some(krate) = krate {
163 let traits_in_scope = ctx.scope.traits_in_scope();
164 ty.iterate_path_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, item| {
165 add_assoc_item(acc, ctx, item);
169 // Iterate assoc types separately
170 ty.iterate_assoc_items(ctx.db, krate, |item| {
171 if let hir::AssocItem::TypeAlias(ty) = item {
172 acc.add_type_alias(ctx, ty)
178 hir::PathResolution::Def(hir::ModuleDef::Trait(t)) => {
179 // Handles `Trait::assoc` as well as `<Ty as Trait>::assoc`.
180 for item in t.items(ctx.db) {
181 add_assoc_item(acc, ctx, item);
184 hir::PathResolution::TypeParam(_) | hir::PathResolution::SelfType(_) => {
185 if let Some(krate) = ctx.krate {
186 let ty = match resolution {
187 hir::PathResolution::TypeParam(param) => param.ty(ctx.db),
188 hir::PathResolution::SelfType(impl_def) => impl_def.self_ty(ctx.db),
192 if let Some(hir::Adt::Enum(e)) = ty.as_adt() {
193 add_enum_variants(acc, ctx, e);
196 let traits_in_scope = ctx.scope.traits_in_scope();
197 let mut seen = FxHashSet::default();
198 ty.iterate_path_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, item| {
199 // We might iterate candidates of a trait multiple times here, so deduplicate
201 if seen.insert(item) {
202 add_assoc_item(acc, ctx, item);
208 hir::PathResolution::Macro(mac) => acc.add_macro(ctx, None, mac),
213 fn add_assoc_item(acc: &mut Completions, ctx: &CompletionContext, item: hir::AssocItem) {
215 hir::AssocItem::Function(func) if !ctx.expects_type() => acc.add_function(ctx, func, None),
216 hir::AssocItem::Const(ct) if !ctx.expects_type() || ctx.expects_generic_arg() => {
217 acc.add_const(ctx, ct)
219 hir::AssocItem::TypeAlias(ty) => acc.add_type_alias(ctx, ty),
224 fn add_enum_variants(acc: &mut Completions, ctx: &CompletionContext, e: hir::Enum) {
225 if ctx.expects_type() {
228 e.variants(ctx.db).into_iter().for_each(|variant| acc.add_enum_variant(ctx, variant, None));
233 use expect_test::{expect, Expect};
235 use crate::tests::{check_edit, completion_list_no_kw};
237 fn check(ra_fixture: &str, expect: Expect) {
238 let actual = completion_list_no_kw(ra_fixture);
239 expect.assert_eq(&actual);
243 fn associated_item_visibility() {
246 //- /lib.rs crate:lib new_source_root:library
250 pub fn public_method() { }
251 fn private_method() { }
252 pub type PublicType = u32;
253 type PrivateType = u32;
254 pub const PUBLIC_CONST: u32 = 1;
255 const PRIVATE_CONST: u32 = 1;
258 //- /main.rs crate:main deps:lib new_source_root:local
259 fn foo() { let _ = lib::S::$0 }
262 fn public_method() fn()
263 ct PUBLIC_CONST pub const PUBLIC_CONST: u32;
264 ta PublicType pub type PublicType;
270 fn completes_union_associated_method() {
274 impl U { fn m() { } }
276 fn foo() { let _ = U::$0 }
285 fn completes_trait_associated_method_1() {
288 trait Trait { fn m(); }
290 fn foo() { let _ = Trait::$0 }
293 fn m() (as Trait) fn()
299 fn completes_trait_associated_method_2() {
302 trait Trait { fn m(); }
307 fn foo() { let _ = S::$0 }
310 fn m() (as Trait) fn()
316 fn completes_trait_associated_method_3() {
319 trait Trait { fn m(); }
324 fn foo() { let _ = <S as Trait>::$0 }
327 fn m() (as Trait) fn()
333 fn completes_ty_param_assoc_ty() {
347 fn submethod(&self) {}
350 fn foo<T: Sub>() { T::$0 }
353 ta SubTy (as Sub) type SubTy;
354 ta Ty (as Super) type Ty;
355 ct C2 (as Sub) const C2: ();
356 fn subfunc() (as Sub) fn()
357 me submethod(…) (as Sub) fn(&self)
358 ct CONST (as Super) const CONST: u8;
359 fn func() (as Super) fn()
360 me method(…) (as Super) fn(&self)
366 fn completes_self_param_assoc_ty() {
380 fn submethod(&self) {}
384 impl<T> Super for Wrap<T> {}
385 impl<T> Sub for Wrap<T> {
387 // Should be able to assume `Self: Sub + Super`
393 ta SubTy (as Sub) type SubTy;
394 ta Ty (as Super) type Ty;
395 ct CONST (as Super) const CONST: u8;
396 fn func() (as Super) fn()
397 me method(…) (as Super) fn(&self)
398 ct C2 (as Sub) const C2: ();
399 fn subfunc() (as Sub) fn()
400 me submethod(…) (as Sub) fn(&self)
406 fn completes_type_alias() {
410 impl S { fn foo() {} }
412 impl T { fn bar() {} }
424 fn completes_qualified_macros() {
428 macro_rules! foo { () => {} }
430 fn main() { let _ = crate::$0 }
434 ma foo!(…) #[macro_export] macro_rules! foo
440 fn does_not_complete_non_fn_macros() {
444 #[rustc_builtin_macro]
455 #[rustc_builtin_macro]
466 fn completes_reexported_items_under_correct_name() {
469 fn foo() { self::m::$0 }
472 pub use super::p::wrong_fn as right_fn;
473 pub use super::p::WRONG_CONST as RIGHT_CONST;
474 pub use super::p::WrongType as RightType;
478 const WRONG_CONST: u32 = 1;
492 fn foo() { self::m::$0 }
495 pub use super::p::wrong_fn as right_fn;
496 pub use super::p::WRONG_CONST as RIGHT_CONST;
497 pub use super::p::WrongType as RightType;
501 const WRONG_CONST: u32 = 1;
506 fn foo() { self::m::RightType }
509 pub use super::p::wrong_fn as right_fn;
510 pub use super::p::WRONG_CONST as RIGHT_CONST;
511 pub use super::p::WrongType as RightType;
515 const WRONG_CONST: u32 = 1;
523 fn completes_in_simple_macro_call() {
526 macro_rules! m { ($e:expr) => { $e } }
527 fn main() { m!(self::f$0); }
538 fn function_mod_share_name() {
541 fn foo() { self::m::$0 }
556 fn completes_hashmap_new() {
560 struct HashMap<K, V, S = RandomState> {}
562 impl<K, V> HashMap<K, V, RandomState> {
563 pub fn new() -> HashMap<K, V, RandomState> { }
570 fn new() fn() -> HashMap<K, V, RandomState>
576 fn dont_complete_attr() {
579 mod foo { pub struct Foo; }
588 fn completes_variant_through_self() {
611 fn completes_primitive_assoc_const() {
612 cov_mark::check!(completes_primitive_assoc_const);
615 //- /lib.rs crate:lib deps:core
620 //- /core.rs crate:core
623 pub const MAX: Self = 255;
629 ct MAX pub const MAX: Self;
636 fn completes_variant_through_alias() {
637 cov_mark::check!(completes_variant_through_alias);
655 fn respects_doc_hidden() {
656 cov_mark::check!(qualified_path_doc_hidden);
659 //- /lib.rs crate:lib deps:dep
664 //- /dep.rs crate:dep