1 //! Completion of paths, i.e. `some::prefix::$0`.
5 use hir::{ScopeDef, Trait};
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 // special case `<_>::$0` as this doesn't resolve to anything.
31 if path.qualifier().is_none() {
33 path.segment().and_then(|it| it.kind()),
34 Some(ast::PathSegmentKind::Type {
35 type_ref: Some(ast::Type::InferType(_)),
39 cov_mark::hit!(completion_type_anchor_empty);
43 .flat_map(|it| Trait::from(it).items(ctx.sema.db))
44 .for_each(|item| add_assoc_item(acc, ctx, item));
49 let resolution = match ctx.sema.resolve_path(path) {
54 let context_module = ctx.scope.module();
56 match ctx.completion_location {
57 Some(ImmediateLocation::ItemList | ImmediateLocation::Trait | ImmediateLocation::Impl) => {
58 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
59 for (name, def) in module.scope(ctx.db, context_module) {
60 if let ScopeDef::MacroDef(macro_def) = def {
61 if macro_def.is_fn_like() {
62 acc.add_macro(ctx, Some(name.clone()), macro_def);
65 if let ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) = def {
66 acc.add_resolution(ctx, name, def);
76 Some(PathKind::Vis { .. }) => {
77 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
78 if let Some(current_module) = ctx.scope.module() {
79 if let Some(next) = current_module
82 .take_while(|&it| it != module)
85 if let Some(name) = next.name(ctx.db) {
86 acc.add_resolution(ctx, name, ScopeDef::ModuleDef(next.into()));
93 Some(PathKind::Attr) => {
94 if let hir::PathResolution::Def(hir::ModuleDef::Module(module)) = resolution {
95 for (name, def) in module.scope(ctx.db, context_module) {
96 let add_resolution = match def {
97 ScopeDef::MacroDef(mac) => mac.is_attr(),
98 ScopeDef::ModuleDef(hir::ModuleDef::Module(_)) => true,
102 acc.add_resolution(ctx, name, def);
108 Some(PathKind::Use) => {
109 if iter::successors(Some(path.clone()), |p| p.qualifier())
110 .all(|p| p.segment().and_then(|s| s.super_token()).is_some())
112 acc.add_keyword(ctx, "super::");
114 // only show `self` in a new use-tree when the qualifier doesn't end in self
117 path.segment().and_then(|it| it.kind()),
118 Some(ast::PathSegmentKind::SelfKw)
121 acc.add_keyword(ctx, "self");
127 if !matches!(kind, Some(PathKind::Pat)) {
128 // Add associated types on type parameters and `Self`.
129 resolution.assoc_type_shorthand_candidates(ctx.db, |_, alias| {
130 acc.add_type_alias(ctx, alias);
136 hir::PathResolution::Def(hir::ModuleDef::Module(module)) => {
137 let module_scope = module.scope(ctx.db, context_module);
138 for (name, def) in module_scope {
139 if let Some(PathKind::Use) = kind {
140 if let ScopeDef::Unknown = def {
141 if let Some(ast::NameLike::NameRef(name_ref)) = ctx.name_syntax.as_ref() {
142 if name_ref.syntax().text() == name.to_smol_str().as_str() {
143 // for `use self::foo$0`, don't suggest `foo` as a completion
144 cov_mark::hit!(dont_complete_current_use);
151 let add_resolution = match def {
152 // Don't suggest attribute macros and derives.
153 ScopeDef::MacroDef(mac) => mac.is_fn_like(),
154 // no values in type places
156 hir::ModuleDef::Function(_)
157 | hir::ModuleDef::Variant(_)
158 | hir::ModuleDef::Static(_),
160 | ScopeDef::Local(_) => !ctx.expects_type(),
161 // unless its a constant in a generic arg list position
162 ScopeDef::ModuleDef(hir::ModuleDef::Const(_)) => {
163 !ctx.expects_type() || ctx.expects_generic_arg()
169 acc.add_resolution(ctx, name, def);
173 hir::PathResolution::Def(
176 (hir::ModuleDef::Adt(_)
177 | hir::ModuleDef::TypeAlias(_)
178 | hir::ModuleDef::BuiltinType(_)),
180 if let hir::ModuleDef::Adt(hir::Adt::Enum(e)) = def {
181 add_enum_variants(acc, ctx, e);
184 hir::ModuleDef::Adt(adt) => adt.ty(ctx.db),
185 hir::ModuleDef::TypeAlias(a) => {
186 let ty = a.ty(ctx.db);
187 if let Some(hir::Adt::Enum(e)) = ty.as_adt() {
188 cov_mark::hit!(completes_variant_through_alias);
189 add_enum_variants(acc, ctx, e);
193 hir::ModuleDef::BuiltinType(builtin) => {
194 let module = match ctx.scope.module() {
198 cov_mark::hit!(completes_primitive_assoc_const);
199 builtin.ty(ctx.db, module)
204 // XXX: For parity with Rust bug #22519, this does not complete Ty::AssocType.
205 // (where AssocType is defined on a trait, not an inherent impl)
207 let krate = ctx.krate;
208 if let Some(krate) = krate {
209 let traits_in_scope = ctx.scope.visible_traits();
210 ty.iterate_path_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, item| {
211 add_assoc_item(acc, ctx, item);
215 // Iterate assoc types separately
216 ty.iterate_assoc_items(ctx.db, krate, |item| {
217 if let hir::AssocItem::TypeAlias(ty) = item {
218 acc.add_type_alias(ctx, ty)
224 hir::PathResolution::Def(hir::ModuleDef::Trait(t)) => {
225 // Handles `Trait::assoc` as well as `<Ty as Trait>::assoc`.
226 for item in t.items(ctx.db) {
227 add_assoc_item(acc, ctx, item);
230 hir::PathResolution::TypeParam(_) | hir::PathResolution::SelfType(_) => {
231 if let Some(krate) = ctx.krate {
232 let ty = match resolution {
233 hir::PathResolution::TypeParam(param) => param.ty(ctx.db),
234 hir::PathResolution::SelfType(impl_def) => impl_def.self_ty(ctx.db),
238 if let Some(hir::Adt::Enum(e)) = ty.as_adt() {
239 add_enum_variants(acc, ctx, e);
242 let traits_in_scope = ctx.scope.visible_traits();
243 let mut seen = FxHashSet::default();
244 ty.iterate_path_candidates(ctx.db, krate, &traits_in_scope, None, |_ty, item| {
245 // We might iterate candidates of a trait multiple times here, so deduplicate
247 if seen.insert(item) {
248 add_assoc_item(acc, ctx, item);
254 hir::PathResolution::Macro(mac) => acc.add_macro(ctx, None, mac),
259 fn add_assoc_item(acc: &mut Completions, ctx: &CompletionContext, item: hir::AssocItem) {
261 hir::AssocItem::Function(func) if !ctx.expects_type() => acc.add_function(ctx, func, None),
262 hir::AssocItem::Const(ct) if !ctx.expects_type() || ctx.expects_generic_arg() => {
263 acc.add_const(ctx, ct)
265 hir::AssocItem::TypeAlias(ty) => acc.add_type_alias(ctx, ty),
270 fn add_enum_variants(acc: &mut Completions, ctx: &CompletionContext, e: hir::Enum) {
271 if ctx.expects_type() {
274 e.variants(ctx.db).into_iter().for_each(|variant| acc.add_enum_variant(ctx, variant, None));
279 use expect_test::{expect, Expect};
281 use crate::tests::{check_edit, completion_list_no_kw};
283 fn check(ra_fixture: &str, expect: Expect) {
284 let actual = completion_list_no_kw(ra_fixture);
285 expect.assert_eq(&actual);
289 fn associated_item_visibility() {
292 //- /lib.rs crate:lib new_source_root:library
296 pub fn public_method() { }
297 fn private_method() { }
298 pub type PublicType = u32;
299 type PrivateType = u32;
300 pub const PUBLIC_CONST: u32 = 1;
301 const PRIVATE_CONST: u32 = 1;
304 //- /main.rs crate:main deps:lib new_source_root:local
305 fn foo() { let _ = lib::S::$0 }
308 fn public_method() fn()
309 ct PUBLIC_CONST pub const PUBLIC_CONST: u32
310 ta PublicType pub type PublicType = u32
316 fn completes_union_associated_method() {
320 impl U { fn m() { } }
322 fn foo() { let _ = U::$0 }
331 fn completes_trait_associated_method_1() {
334 trait Trait { fn m(); }
336 fn foo() { let _ = Trait::$0 }
339 fn m() (as Trait) fn()
345 fn completes_trait_associated_method_2() {
348 trait Trait { fn m(); }
353 fn foo() { let _ = S::$0 }
356 fn m() (as Trait) fn()
362 fn completes_trait_associated_method_3() {
365 trait Trait { fn m(); }
370 fn foo() { let _ = <S as Trait>::$0 }
373 fn m() (as Trait) fn()
379 fn completes_ty_param_assoc_ty() {
393 fn submethod(&self) {}
396 fn foo<T: Sub>() { T::$0 }
399 ta SubTy (as Sub) type SubTy
400 ta Ty (as Super) type Ty
401 ct C2 (as Sub) const C2: ()
402 fn subfunc() (as Sub) fn()
403 me submethod(…) (as Sub) fn(&self)
404 ct CONST (as Super) const CONST: u8
405 fn func() (as Super) fn()
406 me method(…) (as Super) fn(&self)
412 fn completes_self_param_assoc_ty() {
426 fn submethod(&self) {}
430 impl<T> Super for Wrap<T> {}
431 impl<T> Sub for Wrap<T> {
433 // Should be able to assume `Self: Sub + Super`
439 ta SubTy (as Sub) type SubTy
440 ta Ty (as Super) type Ty
441 ct CONST (as Super) const CONST: u8
442 fn func() (as Super) fn()
443 me method(…) (as Super) fn(&self)
444 ct C2 (as Sub) const C2: ()
445 fn subfunc() (as Sub) fn()
446 me submethod(…) (as Sub) fn(&self)
452 fn completes_type_alias() {
456 impl S { fn foo() {} }
458 impl T { fn bar() {} }
470 fn completes_qualified_macros() {
474 macro_rules! foo { () => {} }
476 fn main() { let _ = crate::$0 }
480 ma foo!(…) #[macro_export] macro_rules! foo
486 fn does_not_complete_non_fn_macros() {
490 #[rustc_builtin_macro]
501 #[rustc_builtin_macro]
512 fn completes_reexported_items_under_correct_name() {
515 fn foo() { self::m::$0 }
518 pub use super::p::wrong_fn as right_fn;
519 pub use super::p::WRONG_CONST as RIGHT_CONST;
520 pub use super::p::WrongType as RightType;
524 const WRONG_CONST: u32 = 1;
538 fn foo() { self::m::$0 }
541 pub use super::p::wrong_fn as right_fn;
542 pub use super::p::WRONG_CONST as RIGHT_CONST;
543 pub use super::p::WrongType as RightType;
547 const WRONG_CONST: u32 = 1;
552 fn foo() { self::m::RightType }
555 pub use super::p::wrong_fn as right_fn;
556 pub use super::p::WRONG_CONST as RIGHT_CONST;
557 pub use super::p::WrongType as RightType;
561 const WRONG_CONST: u32 = 1;
569 fn completes_in_simple_macro_call() {
572 macro_rules! m { ($e:expr) => { $e } }
573 fn main() { m!(self::f$0); }
584 fn function_mod_share_name() {
587 fn foo() { self::m::$0 }
602 fn completes_hashmap_new() {
606 struct HashMap<K, V, S = RandomState> {}
608 impl<K, V> HashMap<K, V, RandomState> {
609 pub fn new() -> HashMap<K, V, RandomState> { }
616 fn new() fn() -> HashMap<K, V, RandomState>
622 fn dont_complete_attr() {
625 mod foo { pub struct Foo; }
634 fn completes_variant_through_self() {
657 fn completes_primitive_assoc_const() {
658 cov_mark::check!(completes_primitive_assoc_const);
661 //- /lib.rs crate:lib deps:core
666 //- /core.rs crate:core
669 pub const MAX: Self = 255;
675 ct MAX pub const MAX: Self
682 fn completes_variant_through_alias() {
683 cov_mark::check!(completes_variant_through_alias);
701 fn respects_doc_hidden() {
702 cov_mark::check!(qualified_path_doc_hidden);
705 //- /lib.rs crate:lib deps:dep
710 //- /dep.rs crate:dep
731 fn type_anchor_empty() {
732 cov_mark::check!(completion_type_anchor_empty);
749 fn foo() (as Foo) fn() -> Self