1 //! Completion for associated items in a trait implementation.
3 //! This module adds the completion items related to implementing associated
4 //! items within a `impl Trait for Struct` block. The current context node
5 //! must be within either a `FN`, `TYPE_ALIAS`, or `CONST` node
6 //! and an direct child of an `IMPL`.
10 //! Considering the following trait `impl`:
17 //! impl SomeTrait for () {
22 //! may result in the completion of the following method:
25 //! # trait SomeTrait {
29 //! impl SomeTrait for () {
34 use hir::{self, HasAttrs, HasSource};
35 use ide_db::traits::get_missing_assoc_items;
37 ast::{self, edit, Impl},
38 display::function_declaration,
39 AstNode, SyntaxKind, SyntaxNode, TextRange, T,
41 use text_edit::TextEdit;
49 // display::function_declaration,
52 #[derive(Debug, PartialEq, Eq)]
53 enum ImplCompletionKind {
60 pub(crate) fn complete_trait_impl(acc: &mut Completions, ctx: &CompletionContext) {
61 if let Some((kind, trigger, impl_def)) = completion_match(ctx) {
62 get_missing_assoc_items(&ctx.sema, &impl_def).into_iter().for_each(|item| match item {
63 hir::AssocItem::Function(fn_item)
64 if kind == ImplCompletionKind::All || kind == ImplCompletionKind::Fn =>
66 add_function_impl(&trigger, acc, ctx, fn_item)
68 hir::AssocItem::TypeAlias(type_item)
69 if kind == ImplCompletionKind::All || kind == ImplCompletionKind::TypeAlias =>
71 add_type_alias_impl(&trigger, acc, ctx, type_item)
73 hir::AssocItem::Const(const_item)
74 if kind == ImplCompletionKind::All || kind == ImplCompletionKind::Const =>
76 add_const_impl(&trigger, acc, ctx, const_item)
83 fn completion_match(ctx: &CompletionContext) -> Option<(ImplCompletionKind, SyntaxNode, Impl)> {
84 let mut token = ctx.token.clone();
85 // For keywork without name like `impl .. { fn <|> }`, the current position is inside
86 // the whitespace token, which is outside `FN` syntax node.
87 // We need to follow the previous token in this case.
88 if token.kind() == SyntaxKind::WHITESPACE {
89 token = token.prev_token()?;
92 let impl_item_offset = match token.kind() {
93 // `impl .. { const <|> }`
96 SyntaxKind::CONST_KW => 0,
97 // `impl .. { fn/type <|> }`
100 SyntaxKind::FN_KW | SyntaxKind::TYPE_KW => 0,
101 // `impl .. { fn/type/const foo<|> }`
102 // FN/TYPE_ALIAS/CONST 1
105 SyntaxKind::IDENT if token.parent().kind() == SyntaxKind::NAME => 1,
106 // `impl .. { foo<|> }`
112 SyntaxKind::IDENT if token.parent().kind() == SyntaxKind::NAME_REF => 3,
116 let impl_item = token.ancestors().nth(impl_item_offset)?;
117 // Must directly belong to an impl block.
121 let impl_def = ast::Impl::cast(impl_item.parent()?.parent()?)?;
122 let kind = match impl_item.kind() {
123 // `impl ... { const <|> fn/type/const }`
124 _ if token.kind() == SyntaxKind::CONST_KW => ImplCompletionKind::Const,
125 SyntaxKind::CONST | SyntaxKind::ERROR => ImplCompletionKind::Const,
126 SyntaxKind::TYPE_ALIAS => ImplCompletionKind::TypeAlias,
127 SyntaxKind::FN => ImplCompletionKind::Fn,
128 SyntaxKind::MACRO_CALL => ImplCompletionKind::All,
131 Some((kind, impl_item, impl_def))
134 fn add_function_impl(
135 fn_def_node: &SyntaxNode,
136 acc: &mut Completions,
137 ctx: &CompletionContext,
140 let fn_name = func.name(ctx.db).to_string();
142 let label = if func.assoc_fn_params(ctx.db).is_empty() {
143 format!("fn {}()", fn_name)
145 format!("fn {}(..)", fn_name)
148 let builder = CompletionItem::new(CompletionKind::Magic, ctx.source_range(), label)
150 .set_documentation(func.docs(ctx.db));
152 let completion_kind = if func.self_param(ctx.db).is_some() {
153 CompletionItemKind::Method
155 CompletionItemKind::Function
157 let range = TextRange::new(fn_def_node.text_range().start(), ctx.source_range().end());
159 if let Some(src) = func.source(ctx.db) {
160 let function_decl = function_declaration(&src.value);
161 match ctx.config.snippet_cap {
163 let snippet = format!("{} {{\n $0\n}}", function_decl);
164 builder.snippet_edit(cap, TextEdit::replace(range, snippet))
167 let header = format!("{} {{", function_decl);
168 builder.text_edit(TextEdit::replace(range, header))
171 .kind(completion_kind)
176 fn add_type_alias_impl(
177 type_def_node: &SyntaxNode,
178 acc: &mut Completions,
179 ctx: &CompletionContext,
180 type_alias: hir::TypeAlias,
182 let alias_name = type_alias.name(ctx.db).to_string();
184 let snippet = format!("type {} = ", alias_name);
186 let range = TextRange::new(type_def_node.text_range().start(), ctx.source_range().end());
188 CompletionItem::new(CompletionKind::Magic, ctx.source_range(), snippet.clone())
189 .text_edit(TextEdit::replace(range, snippet))
190 .lookup_by(alias_name)
191 .kind(CompletionItemKind::TypeAlias)
192 .set_documentation(type_alias.docs(ctx.db))
197 const_def_node: &SyntaxNode,
198 acc: &mut Completions,
199 ctx: &CompletionContext,
202 let const_name = const_.name(ctx.db).map(|n| n.to_string());
204 if let Some(const_name) = const_name {
205 if let Some(source) = const_.source(ctx.db) {
206 let snippet = make_const_compl_syntax(&source.value);
209 TextRange::new(const_def_node.text_range().start(), ctx.source_range().end());
211 CompletionItem::new(CompletionKind::Magic, ctx.source_range(), snippet.clone())
212 .text_edit(TextEdit::replace(range, snippet))
213 .lookup_by(const_name)
214 .kind(CompletionItemKind::Const)
215 .set_documentation(const_.docs(ctx.db))
221 fn make_const_compl_syntax(const_: &ast::Const) -> String {
222 let const_ = edit::remove_attrs_and_docs(const_);
224 let const_start = const_.syntax().text_range().start();
225 let const_end = const_.syntax().text_range().end();
228 const_.syntax().first_child_or_token().map_or(const_start, |f| f.text_range().start());
232 .children_with_tokens()
233 .find(|s| s.kind() == T![;] || s.kind() == T![=])
234 .map_or(const_end, |f| f.text_range().start());
236 let len = end - start;
237 let range = TextRange::new(0.into(), len);
239 let syntax = const_.syntax().text().slice(range).to_string();
241 format!("{} = ", syntax.trim_end())
246 use expect_test::{expect, Expect};
249 test_utils::{check_edit, completion_list},
253 fn check(ra_fixture: &str, expect: Expect) {
254 let actual = completion_list(ra_fixture, CompletionKind::Magic);
255 expect.assert_eq(&actual)
259 fn name_ref_function_type_const() {
264 const TEST_CONST: u16;
274 ta type TestType = \n\
275 ct const TEST_CONST: u16 = \n\
282 fn no_completion_inside_fn() {
285 trait Test { fn test(); fn test2(); }
299 trait Test { fn test(); fn test2(); }
313 trait Test { fn test(); fn test2(); }
325 // https://github.com/rust-analyzer/rust-analyzer/pull/5976#issuecomment-692332191
328 trait Test { fn test(); fn test2(); }
342 trait Test { fn test(_: i32); fn test2(); }
354 trait Test { fn test(_: fn()); fn test2(); }
366 fn no_completion_inside_const() {
369 trait Test { const TEST: fn(); const TEST2: u32; type Test; fn test(); }
381 trait Test { const TEST: u32; const TEST2: u32; type Test; fn test(); }
393 trait Test { const TEST: u32; const TEST2: u32; type Test; fn test(); }
397 const TEST: u32 = f<|>
405 trait Test { const TEST: u32; const TEST2: u32; type Test; fn test(); }
419 trait Test { const TEST: u32; const TEST2: u32; type Test; fn test(); }
433 trait Test { const TEST: u32; const TEST2: u32; type Test; fn test(); }
447 fn no_completion_inside_type() {
450 trait Test { type Test; type Test2; fn test(); }
462 trait Test { type Test; type Test2; fn test(); }
474 fn name_ref_single_function() {
503 fn single_function() {
532 fn hide_implemented_fn() {
583 fn foo<T>() where T: Into<String>;
593 fn foo<T>() where T: Into<String>;
599 where T: Into<String> {
608 fn associated_type() {
633 fn associated_const() {
638 const SOME_CONST: u16;
647 const SOME_CONST: u16;
651 const SOME_CONST: u16 = \n\
660 const SOME_CONST: u16 = 92;
669 const SOME_CONST: u16 = 92;
673 const SOME_CONST: u16 = \n\
680 fn complete_without_name() {
681 let test = |completion: &str, hint: &str, completed: &str, next_sibling: &str| {
683 "completion='{}', hint='{}', next_sibling='{}'",
684 completion, hint, next_sibling
719 completed, next_sibling
724 // Enumerate some possible next siblings.
725 for next_sibling in &[
727 "fn other_fn() {}", // `const <|> fn` -> `const fn`
728 "type OtherType = i32;",
729 "const OTHER_CONST: i32 = 0;",
730 "async fn other_fn() {}",
731 "unsafe fn other_fn() {}",
732 "default fn other_fn() {}",
733 "default type OtherType = i32;",
734 "default const OTHER_CONST: i32 = 0;",
736 test("bar", "fn <|>", "fn bar() {\n $0\n}", next_sibling);
737 test("Foo", "type <|>", "type Foo = ", next_sibling);
738 test("CONST", "const <|>", "const CONST: u16 = ", next_sibling);