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;
14 AsAssocItem, Documentation, HasAttrs, HirDisplay, ModuleDef, Mutability, ScopeDef, Type,
16 use ide_db::{helpers::SnippetCap, RootDatabase, SymbolKind};
17 use syntax::TextRange;
21 item::ImportEdit, CompletionContext, CompletionItem, CompletionItemKind, CompletionKind,
25 use crate::render::{enum_variant::render_variant, function::render_fn, macro_::render_macro};
27 pub(crate) fn render_field<'a>(
28 ctx: RenderContext<'a>,
32 Render::new(ctx).add_field(field, ty)
35 pub(crate) fn render_tuple_field<'a>(
36 ctx: RenderContext<'a>,
40 Render::new(ctx).add_tuple_field(field, ty)
43 pub(crate) fn render_resolution<'a>(
44 ctx: RenderContext<'a>,
46 resolution: &ScopeDef,
47 ) -> Option<CompletionItem> {
48 Render::new(ctx).render_resolution(local_name, None, resolution)
51 pub(crate) fn render_resolution_with_import<'a>(
52 ctx: RenderContext<'a>,
53 import_edit: ImportEdit,
54 resolution: &ScopeDef,
55 ) -> Option<CompletionItem> {
56 let local_name = match resolution {
57 ScopeDef::ModuleDef(ModuleDef::Function(f)) => f.name(ctx.completion.db).to_string(),
58 ScopeDef::ModuleDef(ModuleDef::Const(c)) => c.name(ctx.completion.db)?.to_string(),
59 ScopeDef::ModuleDef(ModuleDef::TypeAlias(t)) => t.name(ctx.completion.db).to_string(),
60 _ => import_edit.import_path.segments.last()?.to_string(),
62 Render::new(ctx).render_resolution(local_name, Some(import_edit), resolution).map(|mut item| {
63 item.completion_kind = CompletionKind::Magic;
68 /// Interface for data and methods required for items rendering.
70 pub(crate) struct RenderContext<'a> {
71 completion: &'a CompletionContext<'a>,
74 impl<'a> RenderContext<'a> {
75 pub(crate) fn new(completion: &'a CompletionContext<'a>) -> RenderContext<'a> {
76 RenderContext { completion }
79 fn snippet_cap(&self) -> Option<SnippetCap> {
80 self.completion.config.snippet_cap.clone()
83 fn db(&self) -> &'a RootDatabase {
87 fn source_range(&self) -> TextRange {
88 self.completion.source_range()
91 fn is_deprecated(&self, node: impl HasAttrs) -> bool {
92 let attrs = node.attrs(self.db());
93 attrs.by_key("deprecated").exists() || attrs.by_key("rustc_deprecated").exists()
96 fn is_deprecated_assoc_item(&self, as_assoc_item: impl AsAssocItem) -> bool {
98 let assoc = match as_assoc_item.as_assoc_item(db) {
100 None => return false,
103 let is_assoc_deprecated = match assoc {
104 hir::AssocItem::Function(it) => self.is_deprecated(it),
105 hir::AssocItem::Const(it) => self.is_deprecated(it),
106 hir::AssocItem::TypeAlias(it) => self.is_deprecated(it),
109 || assoc.containing_trait(db).map(|trait_| self.is_deprecated(trait_)).unwrap_or(false)
112 fn docs(&self, node: impl HasAttrs) -> Option<Documentation> {
116 fn active_name_and_type(&self) -> Option<(String, Type)> {
117 if let Some(record_field) = &self.completion.record_field_syntax {
118 mark::hit!(record_field_type_match);
119 let (struct_field, _local) = self.completion.sema.resolve_record_field(record_field)?;
120 Some((struct_field.name(self.db()).to_string(), struct_field.signature_ty(self.db())))
121 } else if let Some(active_parameter) = &self.completion.active_parameter {
122 mark::hit!(active_param_type_match);
123 Some((active_parameter.name.clone(), active_parameter.ty.clone()))
130 /// Generic renderer for completion items.
133 ctx: RenderContext<'a>,
136 impl<'a> Render<'a> {
137 fn new(ctx: RenderContext<'a>) -> Render<'a> {
141 fn add_field(&mut self, field: hir::Field, ty: &Type) -> CompletionItem {
142 let is_deprecated = self.ctx.is_deprecated(field);
143 let name = field.name(self.ctx.db());
144 let mut item = CompletionItem::new(
145 CompletionKind::Reference,
146 self.ctx.source_range(),
149 .kind(SymbolKind::Field)
150 .detail(ty.display(self.ctx.db()).to_string())
151 .set_documentation(field.docs(self.ctx.db()))
152 .set_deprecated(is_deprecated);
154 if let Some(score) = compute_score(&self.ctx, &ty, &name.to_string()) {
155 item = item.set_score(score);
161 fn add_tuple_field(&mut self, field: usize, ty: &Type) -> CompletionItem {
162 CompletionItem::new(CompletionKind::Reference, self.ctx.source_range(), field.to_string())
163 .kind(SymbolKind::Field)
164 .detail(ty.display(self.ctx.db()).to_string())
168 fn render_resolution(
171 import_to_add: Option<ImportEdit>,
172 resolution: &ScopeDef,
173 ) -> Option<CompletionItem> {
174 let _p = profile::span("render_resolution");
175 use hir::ModuleDef::*;
177 let completion_kind = match resolution {
178 ScopeDef::ModuleDef(BuiltinType(..)) => CompletionKind::BuiltinType,
179 _ => CompletionKind::Reference,
182 let kind = match resolution {
183 ScopeDef::ModuleDef(Function(func)) => {
184 return render_fn(self.ctx, import_to_add, Some(local_name), *func);
186 ScopeDef::ModuleDef(Variant(_))
187 if self.ctx.completion.is_pat_binding_or_const
188 | self.ctx.completion.is_irrefutable_pat_binding =>
190 CompletionItemKind::SymbolKind(SymbolKind::Variant)
192 ScopeDef::ModuleDef(Variant(var)) => {
193 let item = render_variant(self.ctx, import_to_add, Some(local_name), *var, None);
196 ScopeDef::MacroDef(mac) => {
197 let item = render_macro(self.ctx, import_to_add, local_name, *mac);
201 ScopeDef::ModuleDef(Module(..)) => CompletionItemKind::SymbolKind(SymbolKind::Module),
202 ScopeDef::ModuleDef(Adt(adt)) => CompletionItemKind::SymbolKind(match adt {
203 hir::Adt::Struct(_) => SymbolKind::Struct,
204 // FIXME: add CompletionItemKind::Union
205 hir::Adt::Union(_) => SymbolKind::Struct,
206 hir::Adt::Enum(_) => SymbolKind::Enum,
208 ScopeDef::ModuleDef(Const(..)) => CompletionItemKind::SymbolKind(SymbolKind::Const),
209 ScopeDef::ModuleDef(Static(..)) => CompletionItemKind::SymbolKind(SymbolKind::Static),
210 ScopeDef::ModuleDef(Trait(..)) => CompletionItemKind::SymbolKind(SymbolKind::Trait),
211 ScopeDef::ModuleDef(TypeAlias(..)) => {
212 CompletionItemKind::SymbolKind(SymbolKind::TypeAlias)
214 ScopeDef::ModuleDef(BuiltinType(..)) => CompletionItemKind::BuiltinType,
215 ScopeDef::GenericParam(param) => CompletionItemKind::SymbolKind(match param {
216 hir::GenericParam::TypeParam(_) => SymbolKind::TypeParam,
217 hir::GenericParam::LifetimeParam(_) => SymbolKind::LifetimeParam,
218 hir::GenericParam::ConstParam(_) => SymbolKind::ConstParam,
220 ScopeDef::Local(..) => CompletionItemKind::SymbolKind(SymbolKind::Local),
221 ScopeDef::AdtSelfType(..) | ScopeDef::ImplSelfType(..) => {
222 CompletionItemKind::SymbolKind(SymbolKind::SelfParam)
224 ScopeDef::Unknown => {
225 let item = CompletionItem::new(
226 CompletionKind::Reference,
227 self.ctx.source_range(),
230 .kind(CompletionItemKind::UnresolvedReference)
231 .add_import(import_to_add)
238 CompletionItem::new(completion_kind, self.ctx.source_range(), local_name.clone());
239 if let ScopeDef::Local(local) = resolution {
240 let ty = local.ty(self.ctx.db());
241 if !ty.is_unknown() {
242 item = item.detail(ty.display(self.ctx.db()).to_string());
246 let mut ref_match = None;
247 if let ScopeDef::Local(local) = resolution {
248 if let Some((active_name, active_type)) = self.ctx.active_name_and_type() {
249 let ty = local.ty(self.ctx.db());
251 compute_score_from_active(&active_type, &active_name, &ty, &local_name)
253 item = item.set_score(score);
255 ref_match = refed_type_matches(&active_type, &active_name, &ty, &local_name);
259 // Add `<>` for generic types
260 if self.ctx.completion.is_path_type
261 && !self.ctx.completion.has_type_args
262 && self.ctx.completion.config.add_call_parenthesis
264 if let Some(cap) = self.ctx.snippet_cap() {
265 let has_non_default_type_params = match resolution {
266 ScopeDef::ModuleDef(Adt(it)) => it.has_non_default_type_params(self.ctx.db()),
267 ScopeDef::ModuleDef(TypeAlias(it)) => {
268 it.has_non_default_type_params(self.ctx.db())
272 if has_non_default_type_params {
273 mark::hit!(inserts_angle_brackets_for_generics);
275 .lookup_by(local_name.clone())
276 .label(format!("{}<…>", local_name))
277 .insert_snippet(cap, format!("{}<$0>", local_name));
284 .add_import(import_to_add)
285 .set_ref_match(ref_match)
286 .set_documentation(self.docs(resolution))
287 .set_deprecated(self.is_deprecated(resolution))
292 fn docs(&self, resolution: &ScopeDef) -> Option<Documentation> {
293 use hir::ModuleDef::*;
295 ScopeDef::ModuleDef(Module(it)) => it.docs(self.ctx.db()),
296 ScopeDef::ModuleDef(Adt(it)) => it.docs(self.ctx.db()),
297 ScopeDef::ModuleDef(Variant(it)) => it.docs(self.ctx.db()),
298 ScopeDef::ModuleDef(Const(it)) => it.docs(self.ctx.db()),
299 ScopeDef::ModuleDef(Static(it)) => it.docs(self.ctx.db()),
300 ScopeDef::ModuleDef(Trait(it)) => it.docs(self.ctx.db()),
301 ScopeDef::ModuleDef(TypeAlias(it)) => it.docs(self.ctx.db()),
306 fn is_deprecated(&self, resolution: &ScopeDef) -> bool {
308 ScopeDef::ModuleDef(it) => self.ctx.is_deprecated_assoc_item(*it),
309 ScopeDef::MacroDef(it) => self.ctx.is_deprecated(*it),
310 ScopeDef::GenericParam(it) => self.ctx.is_deprecated(*it),
311 ScopeDef::AdtSelfType(it) => self.ctx.is_deprecated(*it),
317 fn compute_score_from_active(
322 ) -> Option<CompletionScore> {
325 if active_type != ty {
329 let mut res = CompletionScore::TypeMatch;
331 // If same type + same name then go top position
332 if active_name == name {
333 res = CompletionScore::TypeAndNameMatch
338 fn refed_type_matches(
343 ) -> Option<(Mutability, CompletionScore)> {
344 let derefed_active = active_type.remove_ref()?;
345 let score = compute_score_from_active(&derefed_active, &active_name, &ty, &name)?;
347 if active_type.is_mutable_reference() { Mutability::Mut } else { Mutability::Shared },
352 fn compute_score(ctx: &RenderContext, ty: &Type, name: &str) -> Option<CompletionScore> {
353 let (active_name, active_type) = ctx.active_name_and_type()?;
354 compute_score_from_active(&active_type, &active_name, ty, name)
359 use std::cmp::Reverse;
361 use expect_test::{expect, Expect};
362 use test_utils::mark;
365 test_utils::{check_edit, do_completion, get_all_items, TEST_CONFIG},
366 CompletionKind, CompletionScore,
369 fn check(ra_fixture: &str, expect: Expect) {
370 let actual = do_completion(ra_fixture, CompletionKind::Reference);
371 expect.assert_debug_eq(&actual);
374 fn check_scores(ra_fixture: &str, expect: Expect) {
375 fn display_score(score: Option<CompletionScore>) -> &'static str {
377 Some(CompletionScore::TypeMatch) => "[type]",
378 Some(CompletionScore::TypeAndNameMatch) => "[type+name]",
383 let mut completions = get_all_items(TEST_CONFIG, ra_fixture);
384 completions.sort_by_key(|it| (Reverse(it.score()), it.label().to_string()));
385 let actual = completions
387 .filter(|it| it.completion_kind == CompletionKind::Reference)
389 let tag = it.kind().unwrap().tag();
390 let score = display_score(it.score());
391 format!("{} {} {}\n", tag, it.label(), score)
393 .collect::<String>();
394 expect.assert_eq(&actual);
398 fn enum_detail_includes_record_fields() {
401 enum Foo { Foo { x: i32, y: i32 } }
403 fn main() { Foo::Fo$0 }
409 source_range: 54..56,
415 detail: "{ x: i32, y: i32 }",
423 fn enum_detail_doesnt_include_tuple_fields() {
426 enum Foo { Foo (i32, i32) }
428 fn main() { Foo::Fo$0 }
434 source_range: 46..48,
441 detail: "(i32, i32)",
442 trigger_call_info: true,
450 fn enum_detail_just_parentheses_for_unit() {
455 fn main() { Foo::Fo$0 }
461 source_range: 35..37,
475 fn lookup_enums_by_two_qualifiers() {
479 pub enum Spam { Foo, Bar(i32) }
481 fn main() { let _: m::Spam = S$0 }
486 label: "Spam::Bar(…)",
487 source_range: 75..76,
489 insert: "Spam::Bar($0)",
495 trigger_call_info: true,
499 source_range: 75..76,
507 label: "m::Spam::Foo",
508 source_range: 75..76,
510 insert: "m::Spam::Foo",
519 source_range: 75..76,
534 fn sets_deprecated_flag_in_items() {
538 fn something_deprecated() {}
539 #[rustc_deprecated(since = "1.0.0")]
540 fn something_else_deprecated() {}
548 source_range: 127..130,
558 label: "something_deprecated()",
559 source_range: 127..130,
561 insert: "something_deprecated()$0",
565 lookup: "something_deprecated",
570 label: "something_else_deprecated()",
571 source_range: 127..130,
573 insert: "something_else_deprecated()$0",
577 lookup: "something_else_deprecated",
587 struct A { #[deprecated] the_field: u32 }
588 fn foo() { A { the$0 } }
594 source_range: 57..60,
618 fn bar(self) { self.$0 }
624 source_range: 94..94,
630 documentation: Documentation(
636 source_range: 94..94,
643 documentation: Documentation(
669 source_range: 10..12,
675 documentation: Documentation(
681 source_range: 10..12,
688 documentation: Documentation(
694 source_range: 10..12,
700 documentation: Documentation(
710 fn dont_render_attrs() {
716 fn the_method(&self) { }
718 fn foo(s: S) { s.$0 }
723 label: "the_method()",
724 source_range: 81..81,
726 insert: "the_method()$0",
728 lookup: "the_method",
737 fn no_call_parens_if_fn_ptr_needed() {
738 mark::check!(no_call_parens_if_fn_ptr_needed);
742 fn foo(foo: u8, bar: u8) {}
743 struct ManualVtable { f: fn(u8, u8) }
745 fn main() -> ManualVtable {
746 ManualVtable { f: f$0 }
750 fn foo(foo: u8, bar: u8) {}
751 struct ManualVtable { f: fn(u8, u8) }
753 fn main() -> ManualVtable {
754 ManualVtable { f: foo }
761 fn no_parens_in_use_item() {
762 mark::check!(no_parens_in_use_item);
766 mod m { pub fn foo() {} }
770 mod m { pub fn foo() {} }
777 fn no_parens_in_call() {
793 impl Foo { fn foo(&self){} }
794 fn f(foo: &Foo) { foo.f$0(); }
798 impl Foo { fn foo(&self){} }
799 fn f(foo: &Foo) { foo.foo(); }
805 fn inserts_angle_brackets_for_generics() {
806 mark::check!(inserts_angle_brackets_for_generics);
832 struct Vec<T = i128> {}
836 struct Vec<T = i128> {}
844 fn foo(xs: Ve$0<i128>)
848 fn foo(xs: Vec<i128>)
854 fn active_param_score() {
855 mark::check!(active_param_type_match);
858 struct S { foo: i64, bar: u32, baz: u32 }
859 fn test(bar: u32) { }
860 fn foo(s: S) { test(s.$0) }
871 fn record_field_scores() {
872 mark::check!(record_field_type_match);
875 struct A { foo: i64, bar: u32, baz: u32 }
876 struct B { x: (), y: f32, bar: u32 }
877 fn foo(a: A) { B { bar: a.$0 }; }
888 fn record_field_and_call_scores() {
891 struct A { foo: i64, bar: u32, baz: u32 }
892 struct B { x: (), y: f32, bar: u32 }
894 fn foo(a: A) { B { bar: f(a.$0) }; }
904 struct A { foo: i64, bar: u32, baz: u32 }
905 struct B { x: (), y: f32, bar: u32 }
907 fn foo(a: A) { f(B { bar: a.$0 }); }
918 fn prioritize_exact_ref_match() {
921 struct WorldSnapshot { _f: () };
922 fn go(world: &WorldSnapshot) { go(w$0) }
933 fn too_many_arguments() {
937 fn f(foo: &Foo) { f(foo, w$0) }