1 //! Renderer for function calls.
3 use hir::{HasSource, HirDisplay};
4 use ide_db::SymbolKind;
5 use itertools::Itertools;
9 item::{CompletionItem, CompletionItemKind, CompletionKind, CompletionRelevance, ImportEdit},
11 builder_ext::Params, compute_exact_name_match, compute_ref_match, compute_type_match,
16 pub(crate) fn render_fn<'a>(
17 ctx: RenderContext<'a>,
18 import_to_add: Option<ImportEdit>,
19 local_name: Option<hir::Name>,
21 ) -> Option<CompletionItem> {
22 let _p = profile::span("render_fn");
23 Some(FunctionRender::new(ctx, None, local_name, fn_, false)?.render(import_to_add))
26 pub(crate) fn render_method<'a>(
27 ctx: RenderContext<'a>,
28 import_to_add: Option<ImportEdit>,
29 receiver: Option<hir::Name>,
30 local_name: Option<hir::Name>,
32 ) -> Option<CompletionItem> {
33 let _p = profile::span("render_method");
34 Some(FunctionRender::new(ctx, receiver, local_name, fn_, true)?.render(import_to_add))
38 struct FunctionRender<'a> {
39 ctx: RenderContext<'a>,
41 receiver: Option<hir::Name>,
47 impl<'a> FunctionRender<'a> {
49 ctx: RenderContext<'a>,
50 receiver: Option<hir::Name>,
51 local_name: Option<hir::Name>,
54 ) -> Option<FunctionRender<'a>> {
55 let name = local_name.unwrap_or_else(|| fn_.name(ctx.db())).to_string();
56 let ast_node = fn_.source(ctx.db())?.value;
58 Some(FunctionRender { ctx, name, receiver, func: fn_, ast_node, is_method })
61 fn render(self, import_to_add: Option<ImportEdit>) -> CompletionItem {
62 let params = self.params();
63 let call = if let Some(receiver) = &self.receiver {
64 format!("{}.{}", receiver, &self.name)
69 CompletionItem::new(CompletionKind::Reference, self.ctx.source_range(), call.clone());
70 item.kind(self.kind())
71 .set_documentation(self.ctx.docs(self.func))
73 self.ctx.is_deprecated(self.func) || self.ctx.is_deprecated_assoc_item(self.func),
75 .detail(self.detail())
76 .add_call_parens(self.ctx.completion, call.clone(), params)
77 .add_import(import_to_add)
78 .lookup_by(self.name);
80 let ret_type = self.func.ret_type(self.ctx.db());
81 item.set_relevance(CompletionRelevance {
82 type_match: compute_type_match(self.ctx.completion, &ret_type),
83 exact_name_match: compute_exact_name_match(self.ctx.completion, &call),
84 ..CompletionRelevance::default()
87 if let Some(ref_match) = compute_ref_match(self.ctx.completion, &ret_type) {
89 // For now we don't properly calculate the edits for ref match
90 // completions on methods, so we've disabled them. See #8058.
92 item.ref_match(ref_match);
99 fn detail(&self) -> String {
100 let ret_ty = self.func.ret_type(self.ctx.db());
101 let ret = if ret_ty.is_unit() {
102 // Omit the return type if it is the unit type
105 format!(" {}", self.ty_display())
108 format!("fn({}){}", self.params_display(), ret)
111 fn params_display(&self) -> String {
112 if let Some(self_param) = self.func.self_param(self.ctx.db()) {
115 .assoc_fn_params(self.ctx.db())
117 .skip(1) // skip the self param because we are manually handling that
118 .map(|p| p.ty().display(self.ctx.db()).to_string());
120 std::iter::once(self_param.display(self.ctx.db()).to_owned()).chain(params).join(", ")
124 .assoc_fn_params(self.ctx.db())
126 .map(|p| p.ty().display(self.ctx.db()).to_string())
132 fn ty_display(&self) -> String {
133 let ret_ty = self.func.ret_type(self.ctx.db());
135 format!("-> {}", ret_ty.display(self.ctx.db()))
138 fn add_arg(&self, arg: &str, ty: &hir::Type) -> String {
139 if let Some(derefed_ty) = ty.remove_ref() {
140 for (name, local) in self.ctx.completion.locals.iter() {
141 if name == arg && local.ty(self.ctx.db()) == derefed_ty {
142 let mutability = if ty.is_mutable_reference() { "&mut " } else { "&" };
143 return format!("{}{}", mutability, arg);
150 fn params(&self) -> Params {
151 let ast_params = match self.ast_node.param_list() {
153 None => return Params::Named(Vec::new()),
156 let mut params_pats = Vec::new();
157 let params_ty = if self.ctx.completion.has_dot_receiver() || self.receiver.is_some() {
158 self.func.method_params(self.ctx.db()).unwrap_or_default()
160 if let Some(s) = ast_params.self_param() {
161 cov_mark::hit!(parens_for_method_call_as_assoc_fn);
162 params_pats.push(Some(s.to_string()));
164 self.func.assoc_fn_params(self.ctx.db())
167 .extend(ast_params.params().into_iter().map(|it| it.pat().map(|it| it.to_string())));
169 let params = params_pats
172 .flat_map(|(pat, param_ty)| {
175 let arg = name.trim_start_matches("mut ").trim_start_matches('_');
176 Some(self.add_arg(arg, param_ty.ty()))
179 Params::Named(params)
182 fn kind(&self) -> CompletionItemKind {
183 if self.func.self_param(self.ctx.db()).is_some() {
184 CompletionItemKind::Method
186 SymbolKind::Function.into()
194 test_utils::{check_edit, check_edit_with_config, TEST_CONFIG},
199 fn inserts_parens_for_function_calls() {
200 cov_mark::check!(inserts_parens_for_function_calls);
209 fn main() { no_args()$0 }
216 fn with_args(x: i32, y: String) {}
217 fn main() { with_$0 }
220 fn with_args(x: i32, y: String) {}
221 fn main() { with_args(${1:x}, ${2:y})$0 }
232 fn bar(s: &S) { s.f$0 }
239 fn bar(s: &S) { s.foo()$0 }
248 fn foo(&self, x: i32) {}
257 fn foo(&self, x: i32) {}
270 fn foo(&self, x: i32) {
278 fn foo(&self, x: i32) {
287 fn parens_for_method_call_as_assoc_fn() {
288 cov_mark::check!(parens_for_method_call_as_assoc_fn);
303 fn main() { S::foo(${1:&self})$0 }
309 fn suppress_arg_snippets() {
310 cov_mark::check!(suppress_arg_snippets);
311 check_edit_with_config(
312 CompletionConfig { add_call_argument_snippets: false, ..TEST_CONFIG },
315 fn with_args(x: i32, y: String) {}
316 fn main() { with_$0 }
319 fn with_args(x: i32, y: String) {}
320 fn main() { with_args($0) }
326 fn strips_underscores_from_args() {
330 fn foo(_foo: i32, ___bar: bool, ho_ge_: String) {}
334 fn foo(_foo: i32, ___bar: bool, ho_ge_: String) {}
335 fn main() { foo(${1:foo}, ${2:bar}, ${3:ho_ge_})$0 }
341 fn insert_ref_when_matching_local_in_scope() {
346 fn ref_arg(x: &Foo) {}
354 fn ref_arg(x: &Foo) {}
364 fn insert_mut_ref_when_matching_local_in_scope() {
369 fn ref_arg(x: &mut Foo) {}
377 fn ref_arg(x: &mut Foo) {}
380 ref_arg(${1:&mut x})$0
387 fn insert_ref_when_matching_local_in_scope_for_method() {
394 fn apply_foo(&self, x: &Foo) {}
407 fn apply_foo(&self, x: &Foo) {}
413 y.apply_foo(${1:&x})$0
420 fn trim_mut_keyword_in_func_completion() {
424 fn take_mutably(mut x: &i32) {}
431 fn take_mutably(mut x: &i32) {}
434 take_mutably(${1:x})$0