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, 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 local_name: Option<hir::Name>,
31 ) -> Option<CompletionItem> {
32 let _p = profile::span("render_method");
33 Some(FunctionRender::new(ctx, local_name, fn_, true)?.render(import_to_add))
37 struct FunctionRender<'a> {
38 ctx: RenderContext<'a>,
45 impl<'a> FunctionRender<'a> {
47 ctx: RenderContext<'a>,
48 local_name: Option<hir::Name>,
51 ) -> Option<FunctionRender<'a>> {
52 let name = local_name.unwrap_or_else(|| fn_.name(ctx.db())).to_string();
53 let ast_node = fn_.source(ctx.db())?.value;
55 Some(FunctionRender { ctx, name, func: fn_, ast_node, is_method })
58 fn render(self, import_to_add: Option<ImportEdit>) -> CompletionItem {
59 let params = self.params();
60 let mut item = CompletionItem::new(
61 CompletionKind::Reference,
62 self.ctx.source_range(),
65 item.kind(self.kind())
66 .set_documentation(self.ctx.docs(self.func))
68 self.ctx.is_deprecated(self.func) || self.ctx.is_deprecated_assoc_item(self.func),
70 .detail(self.detail())
71 .add_call_parens(self.ctx.completion, self.name.clone(), params)
72 .add_import(import_to_add);
74 let ret_type = self.func.ret_type(self.ctx.db());
75 item.set_relevance(CompletionRelevance {
76 type_match: compute_type_match(self.ctx.completion, &ret_type),
77 exact_name_match: compute_exact_name_match(self.ctx.completion, &self.name),
78 ..CompletionRelevance::default()
81 if let Some(ref_match) = compute_ref_match(self.ctx.completion, &ret_type) {
83 // For now we don't properly calculate the edits for ref match
84 // completions on methods, so we've disabled them. See #8058.
86 item.ref_match(ref_match);
93 fn detail(&self) -> String {
94 let ret_ty = self.func.ret_type(self.ctx.db());
95 let ret = if ret_ty.is_unit() {
96 // Omit the return type if it is the unit type
99 format!(" {}", self.ty_display())
102 format!("fn({}){}", self.params_display(), ret)
105 fn params_display(&self) -> String {
106 if let Some(self_param) = self.func.self_param(self.ctx.db()) {
109 .assoc_fn_params(self.ctx.db())
111 .skip(1) // skip the self param because we are manually handling that
112 .map(|p| p.ty().display(self.ctx.db()).to_string());
114 std::iter::once(self_param.display(self.ctx.db()).to_owned()).chain(params).join(", ")
118 .assoc_fn_params(self.ctx.db())
120 .map(|p| p.ty().display(self.ctx.db()).to_string())
126 fn ty_display(&self) -> String {
127 let ret_ty = self.func.ret_type(self.ctx.db());
129 format!("-> {}", ret_ty.display(self.ctx.db()))
132 fn add_arg(&self, arg: &str, ty: &hir::Type) -> String {
133 if let Some(derefed_ty) = ty.remove_ref() {
134 for (name, local) in self.ctx.completion.locals.iter() {
135 if name == arg && local.ty(self.ctx.db()) == derefed_ty {
136 let mutability = if ty.is_mutable_reference() { "&mut " } else { "&" };
137 return format!("{}{}", mutability, arg);
144 fn params(&self) -> Params {
145 let ast_params = match self.ast_node.param_list() {
147 None => return Params::Named(Vec::new()),
150 let mut params_pats = Vec::new();
151 let params_ty = if self.ctx.completion.dot_receiver.is_some() {
152 self.func.method_params(self.ctx.db()).unwrap_or_default()
154 if let Some(s) = ast_params.self_param() {
155 cov_mark::hit!(parens_for_method_call_as_assoc_fn);
156 params_pats.push(Some(s.to_string()));
158 self.func.assoc_fn_params(self.ctx.db())
161 .extend(ast_params.params().into_iter().map(|it| it.pat().map(|it| it.to_string())));
163 let params = params_pats
166 .flat_map(|(pat, param_ty)| {
169 let arg = name.trim_start_matches("mut ").trim_start_matches('_');
170 Some(self.add_arg(arg, param_ty.ty()))
173 Params::Named(params)
176 fn kind(&self) -> CompletionItemKind {
177 if self.func.self_param(self.ctx.db()).is_some() {
178 CompletionItemKind::Method
180 SymbolKind::Function.into()
188 test_utils::{check_edit, check_edit_with_config, TEST_CONFIG},
193 fn inserts_parens_for_function_calls() {
194 cov_mark::check!(inserts_parens_for_function_calls);
203 fn main() { no_args()$0 }
210 fn with_args(x: i32, y: String) {}
211 fn main() { with_$0 }
214 fn with_args(x: i32, y: String) {}
215 fn main() { with_args(${1:x}, ${2:y})$0 }
226 fn bar(s: &S) { s.f$0 }
233 fn bar(s: &S) { s.foo()$0 }
242 fn foo(&self, x: i32) {}
251 fn foo(&self, x: i32) {}
261 fn parens_for_method_call_as_assoc_fn() {
262 cov_mark::check!(parens_for_method_call_as_assoc_fn);
277 fn main() { S::foo(${1:&self})$0 }
283 fn suppress_arg_snippets() {
284 cov_mark::check!(suppress_arg_snippets);
285 check_edit_with_config(
286 CompletionConfig { add_call_argument_snippets: false, ..TEST_CONFIG },
289 fn with_args(x: i32, y: String) {}
290 fn main() { with_$0 }
293 fn with_args(x: i32, y: String) {}
294 fn main() { with_args($0) }
300 fn strips_underscores_from_args() {
304 fn foo(_foo: i32, ___bar: bool, ho_ge_: String) {}
308 fn foo(_foo: i32, ___bar: bool, ho_ge_: String) {}
309 fn main() { foo(${1:foo}, ${2:bar}, ${3:ho_ge_})$0 }
315 fn insert_ref_when_matching_local_in_scope() {
320 fn ref_arg(x: &Foo) {}
328 fn ref_arg(x: &Foo) {}
338 fn insert_mut_ref_when_matching_local_in_scope() {
343 fn ref_arg(x: &mut Foo) {}
351 fn ref_arg(x: &mut Foo) {}
354 ref_arg(${1:&mut x})$0
361 fn insert_ref_when_matching_local_in_scope_for_method() {
368 fn apply_foo(&self, x: &Foo) {}
381 fn apply_foo(&self, x: &Foo) {}
387 y.apply_foo(${1:&x})$0
394 fn trim_mut_keyword_in_func_completion() {
398 fn take_mutably(mut x: &i32) {}
405 fn take_mutably(mut x: &i32) {}
408 take_mutably(${1:x})$0