1 //! `render` module provides utilities for rendering completion suggestions
2 //! into code pieces that will be presented to user.
5 pub(crate) mod function;
6 pub(crate) mod enum_variant;
8 pub(crate) mod pattern;
9 pub(crate) mod type_alias;
13 use hir::{Documentation, HasAttrs, HirDisplay, Mutability, ScopeDef, Type};
14 use ide_db::{helpers::SnippetCap, RootDatabase};
15 use syntax::TextRange;
19 item::ImportEdit, CompletionContext, CompletionItem, CompletionItemKind, CompletionKind,
23 use crate::render::{enum_variant::render_variant, function::render_fn, macro_::render_macro};
25 pub(crate) fn render_field<'a>(
26 ctx: RenderContext<'a>,
30 Render::new(ctx).add_field(field, ty)
33 pub(crate) fn render_tuple_field<'a>(
34 ctx: RenderContext<'a>,
38 Render::new(ctx).add_tuple_field(field, ty)
41 pub(crate) fn render_resolution<'a>(
42 ctx: RenderContext<'a>,
44 resolution: &ScopeDef,
45 ) -> Option<CompletionItem> {
46 Render::new(ctx).render_resolution(local_name, None, resolution)
49 pub(crate) fn render_resolution_with_import<'a>(
50 ctx: RenderContext<'a>,
51 import_edit: ImportEdit,
52 resolution: &ScopeDef,
53 ) -> Option<CompletionItem> {
54 Render::new(ctx).render_resolution(
55 import_edit.import_path.segments.last()?.to_string(),
61 /// Interface for data and methods required for items rendering.
63 pub(crate) struct RenderContext<'a> {
64 completion: &'a CompletionContext<'a>,
67 impl<'a> RenderContext<'a> {
68 pub(crate) fn new(completion: &'a CompletionContext<'a>) -> RenderContext<'a> {
69 RenderContext { completion }
72 fn snippet_cap(&self) -> Option<SnippetCap> {
73 self.completion.config.snippet_cap.clone()
76 fn db(&self) -> &'a RootDatabase {
80 fn source_range(&self) -> TextRange {
81 self.completion.source_range()
84 fn is_deprecated(&self, node: impl HasAttrs) -> bool {
85 node.attrs(self.db()).by_key("deprecated").exists()
88 fn docs(&self, node: impl HasAttrs) -> Option<Documentation> {
92 fn active_name_and_type(&self) -> Option<(String, Type)> {
93 if let Some(record_field) = &self.completion.record_field_syntax {
94 mark::hit!(record_field_type_match);
95 let (struct_field, _local) = self.completion.sema.resolve_record_field(record_field)?;
96 Some((struct_field.name(self.db()).to_string(), struct_field.signature_ty(self.db())))
97 } else if let Some(active_parameter) = &self.completion.active_parameter {
98 mark::hit!(active_param_type_match);
99 Some((active_parameter.name.clone(), active_parameter.ty.clone()))
106 /// Generic renderer for completion items.
109 ctx: RenderContext<'a>,
112 impl<'a> Render<'a> {
113 fn new(ctx: RenderContext<'a>) -> Render<'a> {
117 fn add_field(&mut self, field: hir::Field, ty: &Type) -> CompletionItem {
118 let is_deprecated = self.ctx.is_deprecated(field);
119 let name = field.name(self.ctx.db());
120 let mut item = CompletionItem::new(
121 CompletionKind::Reference,
122 self.ctx.source_range(),
125 .kind(CompletionItemKind::Field)
126 .detail(ty.display(self.ctx.db()).to_string())
127 .set_documentation(field.docs(self.ctx.db()))
128 .set_deprecated(is_deprecated);
130 if let Some(score) = compute_score(&self.ctx, &ty, &name.to_string()) {
131 item = item.set_score(score);
137 fn add_tuple_field(&mut self, field: usize, ty: &Type) -> CompletionItem {
138 CompletionItem::new(CompletionKind::Reference, self.ctx.source_range(), field.to_string())
139 .kind(CompletionItemKind::Field)
140 .detail(ty.display(self.ctx.db()).to_string())
144 fn render_resolution(
147 import_to_add: Option<ImportEdit>,
148 resolution: &ScopeDef,
149 ) -> Option<CompletionItem> {
150 let _p = profile::span("render_resolution");
151 use hir::ModuleDef::*;
153 let completion_kind = match resolution {
154 ScopeDef::ModuleDef(BuiltinType(..)) => CompletionKind::BuiltinType,
155 _ => CompletionKind::Reference,
158 let kind = match resolution {
159 ScopeDef::ModuleDef(Function(func)) => {
160 return render_fn(self.ctx, import_to_add, Some(local_name), *func);
162 ScopeDef::ModuleDef(Variant(_))
163 if self.ctx.completion.is_pat_binding_or_const
164 | self.ctx.completion.is_irrefutable_pat_binding =>
166 CompletionItemKind::EnumVariant
168 ScopeDef::ModuleDef(Variant(var)) => {
169 let item = render_variant(self.ctx, import_to_add, Some(local_name), *var, None);
172 ScopeDef::MacroDef(mac) => {
173 let item = render_macro(self.ctx, import_to_add, local_name, *mac);
177 ScopeDef::ModuleDef(Module(..)) => CompletionItemKind::Module,
178 ScopeDef::ModuleDef(Adt(hir::Adt::Struct(_))) => CompletionItemKind::Struct,
179 // FIXME: add CompletionItemKind::Union
180 ScopeDef::ModuleDef(Adt(hir::Adt::Union(_))) => CompletionItemKind::Struct,
181 ScopeDef::ModuleDef(Adt(hir::Adt::Enum(_))) => CompletionItemKind::Enum,
182 ScopeDef::ModuleDef(Const(..)) => CompletionItemKind::Const,
183 ScopeDef::ModuleDef(Static(..)) => CompletionItemKind::Static,
184 ScopeDef::ModuleDef(Trait(..)) => CompletionItemKind::Trait,
185 ScopeDef::ModuleDef(TypeAlias(..)) => CompletionItemKind::TypeAlias,
186 ScopeDef::ModuleDef(BuiltinType(..)) => CompletionItemKind::BuiltinType,
187 ScopeDef::GenericParam(..) => CompletionItemKind::TypeParam,
188 ScopeDef::Local(..) => CompletionItemKind::Binding,
189 // (does this need its own kind?)
190 ScopeDef::AdtSelfType(..) | ScopeDef::ImplSelfType(..) => CompletionItemKind::TypeParam,
191 ScopeDef::Unknown => {
192 let item = CompletionItem::new(
193 CompletionKind::Reference,
194 self.ctx.source_range(),
197 .kind(CompletionItemKind::UnresolvedReference)
198 .add_import(import_to_add)
204 let docs = self.docs(resolution);
207 CompletionItem::new(completion_kind, self.ctx.source_range(), local_name.clone());
208 if let ScopeDef::Local(local) = resolution {
209 let ty = local.ty(self.ctx.db());
210 if !ty.is_unknown() {
211 item = item.detail(ty.display(self.ctx.db()).to_string());
215 let mut ref_match = None;
216 if let ScopeDef::Local(local) = resolution {
217 if let Some((active_name, active_type)) = self.ctx.active_name_and_type() {
218 let ty = local.ty(self.ctx.db());
220 compute_score_from_active(&active_type, &active_name, &ty, &local_name)
222 item = item.set_score(score);
224 ref_match = refed_type_matches(&active_type, &active_name, &ty, &local_name);
228 // Add `<>` for generic types
229 if self.ctx.completion.is_path_type
230 && !self.ctx.completion.has_type_args
231 && self.ctx.completion.config.add_call_parenthesis
233 if let Some(cap) = self.ctx.snippet_cap() {
234 let has_non_default_type_params = match resolution {
235 ScopeDef::ModuleDef(Adt(it)) => it.has_non_default_type_params(self.ctx.db()),
236 ScopeDef::ModuleDef(TypeAlias(it)) => {
237 it.has_non_default_type_params(self.ctx.db())
241 if has_non_default_type_params {
242 mark::hit!(inserts_angle_brackets_for_generics);
244 .lookup_by(local_name.clone())
245 .label(format!("{}<…>", local_name))
246 .insert_snippet(cap, format!("{}<$0>", local_name));
253 .add_import(import_to_add)
254 .set_documentation(docs)
255 .set_ref_match(ref_match)
260 fn docs(&self, resolution: &ScopeDef) -> Option<Documentation> {
261 use hir::ModuleDef::*;
263 ScopeDef::ModuleDef(Module(it)) => it.docs(self.ctx.db()),
264 ScopeDef::ModuleDef(Adt(it)) => it.docs(self.ctx.db()),
265 ScopeDef::ModuleDef(Variant(it)) => it.docs(self.ctx.db()),
266 ScopeDef::ModuleDef(Const(it)) => it.docs(self.ctx.db()),
267 ScopeDef::ModuleDef(Static(it)) => it.docs(self.ctx.db()),
268 ScopeDef::ModuleDef(Trait(it)) => it.docs(self.ctx.db()),
269 ScopeDef::ModuleDef(TypeAlias(it)) => it.docs(self.ctx.db()),
275 fn compute_score_from_active(
280 ) -> Option<CompletionScore> {
283 if active_type != ty {
287 let mut res = CompletionScore::TypeMatch;
289 // If same type + same name then go top position
290 if active_name == name {
291 res = CompletionScore::TypeAndNameMatch
296 fn refed_type_matches(
301 ) -> Option<(Mutability, CompletionScore)> {
302 let derefed_active = active_type.remove_ref()?;
303 let score = compute_score_from_active(&derefed_active, &active_name, &ty, &name)?;
305 if active_type.is_mutable_reference() { Mutability::Mut } else { Mutability::Shared },
310 fn compute_score(ctx: &RenderContext, ty: &Type, name: &str) -> Option<CompletionScore> {
311 let (active_name, active_type) = ctx.active_name_and_type()?;
312 compute_score_from_active(&active_type, &active_name, ty, name)
317 use std::cmp::Reverse;
319 use expect_test::{expect, Expect};
320 use test_utils::mark;
323 test_utils::{check_edit, do_completion, get_all_items, TEST_CONFIG},
324 CompletionKind, CompletionScore,
327 fn check(ra_fixture: &str, expect: Expect) {
328 let actual = do_completion(ra_fixture, CompletionKind::Reference);
329 expect.assert_debug_eq(&actual);
332 fn check_scores(ra_fixture: &str, expect: Expect) {
333 fn display_score(score: Option<CompletionScore>) -> &'static str {
335 Some(CompletionScore::TypeMatch) => "[type]",
336 Some(CompletionScore::TypeAndNameMatch) => "[type+name]",
341 let mut completions = get_all_items(TEST_CONFIG, ra_fixture);
342 completions.sort_by_key(|it| (Reverse(it.score()), it.label().to_string()));
343 let actual = completions
345 .filter(|it| it.completion_kind == CompletionKind::Reference)
347 let tag = it.kind().unwrap().tag();
348 let score = display_score(it.score());
349 format!("{} {} {}\n", tag, it.label(), score)
351 .collect::<String>();
352 expect.assert_eq(&actual);
356 fn enum_detail_includes_record_fields() {
359 enum Foo { Foo { x: i32, y: i32 } }
361 fn main() { Foo::Fo<|> }
367 source_range: 54..56,
371 detail: "{ x: i32, y: i32 }",
379 fn enum_detail_doesnt_include_tuple_fields() {
382 enum Foo { Foo (i32, i32) }
384 fn main() { Foo::Fo<|> }
390 source_range: 46..48,
395 detail: "(i32, i32)",
396 trigger_call_info: true,
404 fn enum_detail_just_parentheses_for_unit() {
409 fn main() { Foo::Fo<|> }
415 source_range: 35..37,
427 fn lookup_enums_by_two_qualifiers() {
431 pub enum Spam { Foo, Bar(i32) }
433 fn main() { let _: m::Spam = S<|> }
438 label: "Spam::Bar(…)",
439 source_range: 75..76,
441 insert: "Spam::Bar($0)",
445 trigger_call_info: true,
449 source_range: 75..76,
455 label: "m::Spam::Foo",
456 source_range: 75..76,
458 insert: "m::Spam::Foo",
465 source_range: 75..76,
478 fn sets_deprecated_flag_in_items() {
482 fn something_deprecated() {}
483 #[deprecated(since = "1.0.0")]
484 fn something_else_deprecated() {}
492 source_range: 121..124,
500 label: "something_deprecated()",
501 source_range: 121..124,
503 insert: "something_deprecated()$0",
505 lookup: "something_deprecated",
506 detail: "fn something_deprecated()",
510 label: "something_else_deprecated()",
511 source_range: 121..124,
513 insert: "something_else_deprecated()$0",
515 lookup: "something_else_deprecated",
516 detail: "fn something_else_deprecated()",
525 struct A { #[deprecated] the_field: u32 }
526 fn foo() { A { the<|> } }
532 source_range: 57..60,
554 fn bar(self) { self.<|> }
560 source_range: 94..94,
565 detail: "fn bar(self)",
566 documentation: Documentation(
572 source_range: 94..94,
577 documentation: Documentation(
603 source_range: 10..12,
607 documentation: Documentation(
613 source_range: 10..12,
618 documentation: Documentation(
624 source_range: 10..12,
628 documentation: Documentation(
638 fn dont_render_attrs() {
644 fn the_method(&self) { }
646 fn foo(s: S) { s.<|> }
651 label: "the_method()",
652 source_range: 81..81,
654 insert: "the_method()$0",
656 lookup: "the_method",
657 detail: "fn the_method(&self)",
665 fn no_call_parens_if_fn_ptr_needed() {
666 mark::check!(no_call_parens_if_fn_ptr_needed);
670 fn foo(foo: u8, bar: u8) {}
671 struct ManualVtable { f: fn(u8, u8) }
673 fn main() -> ManualVtable {
674 ManualVtable { f: f<|> }
678 fn foo(foo: u8, bar: u8) {}
679 struct ManualVtable { f: fn(u8, u8) }
681 fn main() -> ManualVtable {
682 ManualVtable { f: foo }
689 fn no_parens_in_use_item() {
690 mark::check!(no_parens_in_use_item);
694 mod m { pub fn foo() {} }
698 mod m { pub fn foo() {} }
705 fn no_parens_in_call() {
710 fn main() { f<|>(); }
721 impl Foo { fn foo(&self){} }
722 fn f(foo: &Foo) { foo.f<|>(); }
726 impl Foo { fn foo(&self){} }
727 fn f(foo: &Foo) { foo.foo(); }
733 fn inserts_angle_brackets_for_generics() {
734 mark::check!(inserts_angle_brackets_for_generics);
760 struct Vec<T = i128> {}
764 struct Vec<T = i128> {}
772 fn foo(xs: Ve<|><i128>)
776 fn foo(xs: Vec<i128>)
782 fn active_param_score() {
783 mark::check!(active_param_type_match);
786 struct S { foo: i64, bar: u32, baz: u32 }
787 fn test(bar: u32) { }
788 fn foo(s: S) { test(s.<|>) }
799 fn record_field_scores() {
800 mark::check!(record_field_type_match);
803 struct A { foo: i64, bar: u32, baz: u32 }
804 struct B { x: (), y: f32, bar: u32 }
805 fn foo(a: A) { B { bar: a.<|> }; }
816 fn record_field_and_call_scores() {
819 struct A { foo: i64, bar: u32, baz: u32 }
820 struct B { x: (), y: f32, bar: u32 }
822 fn foo(a: A) { B { bar: f(a.<|>) }; }
832 struct A { foo: i64, bar: u32, baz: u32 }
833 struct B { x: (), y: f32, bar: u32 }
835 fn foo(a: A) { f(B { bar: a.<|> }); }
846 fn prioritize_exact_ref_match() {
849 struct WorldSnapshot { _f: () };
850 fn go(world: &WorldSnapshot) { go(w<|>) }
861 fn too_many_arguments() {
865 fn f(foo: &Foo) { f(foo, w<|>) }