1 //! Postfix completions, like `Ok(10).ifl$0` => `if let Ok() = Ok(10) { $0 }`.
5 use hir::Documentation;
7 helpers::{insert_use::ImportScope, FamousDefs, SnippetCap},
11 ast::{self, AstNode, AstToken},
12 SyntaxKind::{EXPR_STMT, STMT_LIST},
15 use text_edit::TextEdit;
18 completions::postfix::format_like::add_format_like_completions,
19 context::CompletionContext,
20 item::{Builder, CompletionKind},
21 patterns::ImmediateLocation,
22 CompletionItem, CompletionItemKind, CompletionRelevance, Completions, SnippetScope,
25 pub(crate) fn complete_postfix(acc: &mut Completions, ctx: &CompletionContext) {
26 if !ctx.config.enable_postfix_completions {
30 let (dot_receiver, receiver_is_ambiguous_float_literal) = match &ctx.completion_location {
31 Some(ImmediateLocation::MethodCall { receiver: Some(it), .. }) => (it, false),
32 Some(ImmediateLocation::FieldAccess {
34 receiver_is_ambiguous_float_literal,
35 }) => (it, *receiver_is_ambiguous_float_literal),
39 let receiver_text = get_receiver_text(dot_receiver, receiver_is_ambiguous_float_literal);
41 let receiver_ty = match ctx.sema.type_of_expr(dot_receiver) {
42 Some(it) => it.original,
46 // Suggest .await syntax for types that implement Future trait
47 if receiver_ty.impls_future(ctx.db) {
48 let mut item = CompletionItem::new(CompletionKind::Keyword, ctx.source_range(), "await");
49 item.kind(CompletionItemKind::Keyword).detail("expr.await");
53 let cap = match ctx.config.snippet_cap {
58 let postfix_snippet = match build_postfix_snippet_builder(ctx, cap, &dot_receiver) {
63 if !ctx.config.snippets.is_empty() {
64 add_custom_postfix_completions(acc, ctx, &postfix_snippet, &receiver_text);
67 let try_enum = TryEnum::from_ty(&ctx.sema, &receiver_ty.strip_references());
68 if let Some(try_enum) = &try_enum {
74 &format!("if let Ok($1) = {} {{\n $0\n}}", receiver_text),
81 &format!("while let Ok($1) = {} {{\n $0\n}}", receiver_text),
89 &format!("if let Some($1) = {} {{\n $0\n}}", receiver_text),
96 &format!("while let Some($1) = {} {{\n $0\n}}", receiver_text),
101 } else if receiver_ty.is_bool() || receiver_ty.is_unknown() {
102 postfix_snippet("if", "if expr {}", &format!("if {} {{\n $0\n}}", receiver_text))
107 &format!("while {} {{\n $0\n}}", receiver_text),
110 postfix_snippet("not", "!expr", &format!("!{}", receiver_text)).add_to(acc);
111 } else if let Some(trait_) = FamousDefs(&ctx.sema, ctx.krate).core_iter_IntoIterator() {
112 if receiver_ty.impls_trait(ctx.db, trait_, &[]) {
115 "for ele in expr {}",
116 &format!("for ele in {} {{\n $0\n}}", receiver_text),
122 postfix_snippet("ref", "&expr", &format!("&{}", receiver_text)).add_to(acc);
123 postfix_snippet("refm", "&mut expr", &format!("&mut {}", receiver_text)).add_to(acc);
125 // The rest of the postfix completions create an expression that moves an argument,
126 // so it's better to consider references now to avoid breaking the compilation
127 let dot_receiver = include_references(dot_receiver);
128 let receiver_text = get_receiver_text(&dot_receiver, receiver_is_ambiguous_float_literal);
129 let postfix_snippet = match build_postfix_snippet_builder(ctx, cap, &dot_receiver) {
135 Some(try_enum) => match try_enum {
140 &format!("match {} {{\n Ok(${{1:_}}) => {{$2}},\n Err(${{3:_}}) => {{$0}},\n}}", receiver_text),
149 "match {} {{\n Some(${{1:_}}) => {{$2}},\n None => {{$0}},\n}}",
160 &format!("match {} {{\n ${{1:_}} => {{$0}},\n}}", receiver_text),
166 postfix_snippet("box", "Box::new(expr)", &format!("Box::new({})", receiver_text)).add_to(acc);
167 postfix_snippet("ok", "Ok(expr)", &format!("Ok({})", receiver_text)).add_to(acc);
168 postfix_snippet("err", "Err(expr)", &format!("Err({})", receiver_text)).add_to(acc);
169 postfix_snippet("some", "Some(expr)", &format!("Some({})", receiver_text)).add_to(acc);
170 postfix_snippet("dbg", "dbg!(expr)", &format!("dbg!({})", receiver_text)).add_to(acc);
171 postfix_snippet("dbgr", "dbg!(&expr)", &format!("dbg!(&{})", receiver_text)).add_to(acc);
172 postfix_snippet("call", "function(expr)", &format!("${{1}}({})", receiver_text)).add_to(acc);
174 if let Some(parent) = dot_receiver.syntax().parent().and_then(|p| p.parent()) {
175 if matches!(parent.kind(), STMT_LIST | EXPR_STMT) {
176 postfix_snippet("let", "let", &format!("let $0 = {};", receiver_text)).add_to(acc);
177 postfix_snippet("letm", "let mut", &format!("let mut $0 = {};", receiver_text))
182 if let ast::Expr::Literal(literal) = dot_receiver.clone() {
183 if let Some(literal_text) = ast::String::cast(literal.token()) {
184 add_format_like_completions(acc, ctx, &dot_receiver, cap, &literal_text);
189 fn get_receiver_text(receiver: &ast::Expr, receiver_is_ambiguous_float_literal: bool) -> String {
190 if receiver_is_ambiguous_float_literal {
191 let text = receiver.syntax().text();
192 let without_dot = ..text.len() - TextSize::of('.');
193 text.slice(without_dot).to_string()
199 fn include_references(initial_element: &ast::Expr) -> ast::Expr {
200 let mut resulting_element = initial_element.clone();
201 while let Some(parent_ref_element) =
202 resulting_element.syntax().parent().and_then(ast::RefExpr::cast)
204 resulting_element = ast::Expr::from(parent_ref_element);
209 fn build_postfix_snippet_builder<'ctx>(
210 ctx: &'ctx CompletionContext,
212 receiver: &'ctx ast::Expr,
213 ) -> Option<impl Fn(&str, &str, &str) -> Builder + 'ctx> {
214 let receiver_syntax = receiver.syntax();
215 let receiver_range = ctx.sema.original_range_opt(receiver_syntax)?.range;
216 let delete_range = TextRange::new(receiver_range.start(), ctx.source_range().end());
218 // Wrapping impl Fn in an option ruins lifetime inference for the parameters in a way that
219 // can't be annotated for the closure, hence fix it by constructing it without the Option first
221 ctx: &'ctx CompletionContext,
223 delete_range: TextRange,
224 ) -> impl Fn(&str, &str, &str) -> Builder + 'ctx {
225 move |label, detail, snippet| {
226 let edit = TextEdit::replace(delete_range, snippet.to_string());
227 let mut item = CompletionItem::new(CompletionKind::Postfix, ctx.source_range(), label);
228 item.detail(detail).kind(CompletionItemKind::Snippet).snippet_edit(cap, edit);
229 if ctx.original_token.text() == label {
231 CompletionRelevance { exact_postfix_snippet_match: true, ..Default::default() };
232 item.set_relevance(relevance);
238 Some(build(ctx, cap, delete_range))
241 fn add_custom_postfix_completions(
242 acc: &mut Completions,
243 ctx: &CompletionContext,
244 postfix_snippet: impl Fn(&str, &str, &str) -> Builder,
248 ImportScope::find_insert_use_container_with_macros(&ctx.token.parent()?, &ctx.sema)?;
249 ctx.config.postfix_snippets().filter(|(_, snip)| snip.scope == SnippetScope::Expr).for_each(
250 |(trigger, snippet)| {
251 let imports = match snippet.imports(ctx, &import_scope) {
252 Some(imports) => imports,
255 let body = snippet.postfix_snippet(&receiver_text);
257 postfix_snippet(trigger, snippet.description.as_deref().unwrap_or_default(), &body);
258 builder.documentation(Documentation::new(format!("```rust\n{}\n```", body)));
259 for import in imports.into_iter() {
260 builder.add_import(import);
270 use expect_test::{expect, Expect};
273 tests::{check_edit, check_edit_with_config, completion_list, TEST_CONFIG},
274 CompletionConfig, Snippet,
277 fn check(ra_fixture: &str, expect: Expect) {
278 let actual = completion_list(ra_fixture);
279 expect.assert_eq(&actual)
283 fn postfix_completion_works_for_trivial_path_expression() {
293 sn while while expr {}
297 sn match match expr {}
298 sn box Box::new(expr)
304 sn call function(expr)
312 fn postfix_completion_works_for_function_calln() {
315 fn foo(elt: bool) -> bool {
326 sn while while expr {}
330 sn match match expr {}
331 sn box Box::new(expr)
337 sn call function(expr)
343 fn postfix_type_filtering() {
354 sn match match expr {}
355 sn box Box::new(expr)
361 sn call function(expr)
369 fn let_middle_block() {
379 sn while while expr {}
383 sn match match expr {}
384 sn box Box::new(expr)
390 sn call function(expr)
404 let bar = Some(true);
410 let bar = Some(true);
411 if let Some($1) = bar {
443 fn postfix_completion_works_for_ambiguous_float_literal() {
444 check_edit("refm", r#"fn main() { 42.$0 }"#, r#"fn main() { &mut 42 }"#)
448 fn works_in_simple_macro() {
452 macro_rules! m { ($e:expr) => { $e } }
459 macro_rules! m { ($e:expr) => { $e } }
469 fn postfix_completion_for_references() {
470 check_edit("dbg", r#"fn main() { &&42.$0 }"#, r#"fn main() { dbg!(&&42) }"#);
471 check_edit("refm", r#"fn main() { &&42.$0 }"#, r#"fn main() { &&&mut 42 }"#);
477 let bar = &Some(true);
483 let bar = &Some(true);
484 if let Some($1) = bar {
493 fn custom_postfix_completion() {
494 check_edit_with_config(
496 snippets: vec![Snippet::new(
499 &["ControlFlow::Break(${receiver})".into()],
501 &["core::ops::ControlFlow".into()],
502 crate::SnippetScope::Expr,
513 use core::ops::ControlFlow;
515 fn main() { ControlFlow::Break(42) }
521 fn postfix_completion_for_format_like_strings() {
524 r#"fn main() { "{some_var:?}".$0 }"#,
525 r#"fn main() { format!("{:?}", some_var) }"#,
529 r#"fn main() { "Panic with {a}".$0 }"#,
530 r#"fn main() { panic!("Panic with {}", a) }"#,
534 r#"fn main() { "{ 2+2 } { SomeStruct { val: 1, other: 32 } :?}".$0 }"#,
535 r#"fn main() { println!("{} {:?}", 2+2, SomeStruct { val: 1, other: 32 }) }"#,
539 r#"fn main() { "{2+2}".$0 }"#,
540 r#"fn main() { log::error!("{}", 2+2) }"#,
544 r#"fn main() { "{2+2}".$0 }"#,
545 r#"fn main() { log::trace!("{}", 2+2) }"#,
549 r#"fn main() { "{2+2}".$0 }"#,
550 r#"fn main() { log::debug!("{}", 2+2) }"#,
552 check_edit("logi", r#"fn main() { "{2+2}".$0 }"#, r#"fn main() { log::info!("{}", 2+2) }"#);
553 check_edit("logw", r#"fn main() { "{2+2}".$0 }"#, r#"fn main() { log::warn!("{}", 2+2) }"#);
556 r#"fn main() { "{2+2}".$0 }"#,
557 r#"fn main() { log::error!("{}", 2+2) }"#,