crates/ide_completion/src/completions/postfix.rs

   1 //! Postfix completions, like `Ok(10).ifl$0` => `if let Ok() = Ok(10) { $0 }`.
   2
   3 mod format_like;
   4
   5 use hir::{Documentation, HasAttrs};
   6 use ide_db::{
   7     helpers::{insert_use::ImportScope, SnippetCap},
   8     ty_filter::TryEnum,
   9 };
  10 use syntax::{
  11     ast::{self, AstNode, AstToken},
  12     SyntaxKind::{EXPR_STMT, STMT_LIST},
  13     TextRange, TextSize,
  14 };
  15 use text_edit::TextEdit;
  16
  17 use crate::{
  18     completions::postfix::format_like::add_format_like_completions, context::CompletionContext,
  19     item::Builder, patterns::ImmediateLocation, CompletionItem, CompletionItemKind,
  20     CompletionRelevance, Completions, SnippetScope,
  21 };
  22
  23 pub(crate) fn complete_postfix(acc: &mut Completions, ctx: &CompletionContext) {
  24     if !ctx.config.enable_postfix_completions {
  25         return;
  26     }
  27
  28     let (dot_receiver, receiver_is_ambiguous_float_literal) = match &ctx.completion_location {
  29         Some(ImmediateLocation::MethodCall { receiver: Some(it), .. }) => (it, false),
  30         Some(ImmediateLocation::FieldAccess {
  31             receiver: Some(it),
  32             receiver_is_ambiguous_float_literal,
  33         }) => (it, *receiver_is_ambiguous_float_literal),
  34         _ => return,
  35     };
  36
  37     let receiver_text = get_receiver_text(dot_receiver, receiver_is_ambiguous_float_literal);
  38
  39     let receiver_ty = match ctx.sema.type_of_expr(dot_receiver) {
  40         Some(it) => it.original,
  41         None => return,
  42     };
  43
  44     // Suggest .await syntax for types that implement Future trait
  45     if receiver_ty.impls_future(ctx.db) {
  46         let mut item =
  47             CompletionItem::new(CompletionItemKind::Keyword, ctx.source_range(), "await");
  48         item.detail("expr.await");
  49         item.add_to(acc);
  50     }
  51
  52     let cap = match ctx.config.snippet_cap {
  53         Some(it) => it,
  54         None => return,
  55     };
  56
  57     let postfix_snippet = match build_postfix_snippet_builder(ctx, cap, &dot_receiver) {
  58         Some(it) => it,
  59         None => return,
  60     };
  61
  62     if let Some(drop_trait) = ctx.famous_defs().core_ops_Drop() {
  63         if receiver_ty.impls_trait(ctx.db, drop_trait, &[]) {
  64             if let &[hir::AssocItem::Function(drop_fn)] = &*drop_trait.items(ctx.db) {
  65                 cov_mark::hit!(postfix_drop_completion);
  66                 // FIXME: check that `drop` is in scope, use fully qualified path if it isn't/if shadowed
  67                 let mut item = postfix_snippet(
  68                     "drop",
  69                     "fn drop(&mut self)",
  70                     &format!("drop($0{})", receiver_text),
  71                 );
  72                 item.set_documentation(drop_fn.docs(ctx.db));
  73                 item.add_to(acc);
  74             }
  75         }
  76     }
  77
  78     if !ctx.config.snippets.is_empty() {
  79         add_custom_postfix_completions(acc, ctx, &postfix_snippet, &receiver_text);
  80     }
  81
  82     let try_enum = TryEnum::from_ty(&ctx.sema, &receiver_ty.strip_references());
  83     if let Some(try_enum) = &try_enum {
  84         match try_enum {
  85             TryEnum::Result => {
  86                 postfix_snippet(
  87                     "ifl",
  88                     "if let Ok {}",
  89                     &format!("if let Ok($1) = {} {{\n    $0\n}}", receiver_text),
  90                 )
  91                 .add_to(acc);
  92
  93                 postfix_snippet(
  94                     "while",
  95                     "while let Ok {}",
  96                     &format!("while let Ok($1) = {} {{\n    $0\n}}", receiver_text),
  97                 )
  98                 .add_to(acc);
  99             }
 100             TryEnum::Option => {
 101                 postfix_snippet(
 102                     "ifl",
 103                     "if let Some {}",
 104                     &format!("if let Some($1) = {} {{\n    $0\n}}", receiver_text),
 105                 )
 106                 .add_to(acc);
 107
 108                 postfix_snippet(
 109                     "while",
 110                     "while let Some {}",
 111                     &format!("while let Some($1) = {} {{\n    $0\n}}", receiver_text),
 112                 )
 113                 .add_to(acc);
 114             }
 115         }
 116     } else if receiver_ty.is_bool() || receiver_ty.is_unknown() {
 117         postfix_snippet("if", "if expr {}", &format!("if {} {{\n    $0\n}}", receiver_text))
 118             .add_to(acc);
 119         postfix_snippet(
 120             "while",
 121             "while expr {}",
 122             &format!("while {} {{\n    $0\n}}", receiver_text),
 123         )
 124         .add_to(acc);
 125         postfix_snippet("not", "!expr", &format!("!{}", receiver_text)).add_to(acc);
 126     } else if let Some(trait_) = ctx.famous_defs().core_iter_IntoIterator() {
 127         if receiver_ty.impls_trait(ctx.db, trait_, &[]) {
 128             postfix_snippet(
 129                 "for",
 130                 "for ele in expr {}",
 131                 &format!("for ele in {} {{\n    $0\n}}", receiver_text),
 132             )
 133             .add_to(acc);
 134         }
 135     }
 136
 137     postfix_snippet("ref", "&expr", &format!("&{}", receiver_text)).add_to(acc);
 138     postfix_snippet("refm", "&mut expr", &format!("&mut {}", receiver_text)).add_to(acc);
 139
 140     // The rest of the postfix completions create an expression that moves an argument,
 141     // so it's better to consider references now to avoid breaking the compilation
 142     let dot_receiver = include_references(dot_receiver);
 143     let receiver_text = get_receiver_text(&dot_receiver, receiver_is_ambiguous_float_literal);
 144     let postfix_snippet = match build_postfix_snippet_builder(ctx, cap, &dot_receiver) {
 145         Some(it) => it,
 146         None => return,
 147     };
 148
 149     match try_enum {
 150         Some(try_enum) => match try_enum {
 151             TryEnum::Result => {
 152                 postfix_snippet(
 153                     "match",
 154                     "match expr {}",
 155                     &format!("match {} {{\n    Ok(${{1:_}}) => {{$2}},\n    Err(${{3:_}}) => {{$0}},\n}}", receiver_text),
 156                 )
 157                 .add_to(acc);
 158             }
 159             TryEnum::Option => {
 160                 postfix_snippet(
 161                     "match",
 162                     "match expr {}",
 163                     &format!(
 164                         "match {} {{\n    Some(${{1:_}}) => {{$2}},\n    None => {{$0}},\n}}",
 165                         receiver_text
 166                     ),
 167                 )
 168                 .add_to(acc);
 169             }
 170         },
 171         None => {
 172             postfix_snippet(
 173                 "match",
 174                 "match expr {}",
 175                 &format!("match {} {{\n    ${{1:_}} => {{$0}},\n}}", receiver_text),
 176             )
 177             .add_to(acc);
 178         }
 179     }
 180
 181     postfix_snippet("box", "Box::new(expr)", &format!("Box::new({})", receiver_text)).add_to(acc);
 182     postfix_snippet("dbg", "dbg!(expr)", &format!("dbg!({})", receiver_text)).add_to(acc);
 183     postfix_snippet("dbgr", "dbg!(&expr)", &format!("dbg!(&{})", receiver_text)).add_to(acc);
 184     postfix_snippet("call", "function(expr)", &format!("${{1}}({})", receiver_text)).add_to(acc);
 185
 186     if let Some(parent) = dot_receiver.syntax().parent().and_then(|p| p.parent()) {
 187         if matches!(parent.kind(), STMT_LIST | EXPR_STMT) {
 188             postfix_snippet("let", "let", &format!("let $0 = {};", receiver_text)).add_to(acc);
 189             postfix_snippet("letm", "let mut", &format!("let mut $0 = {};", receiver_text))
 190                 .add_to(acc);
 191         }
 192     }
 193
 194     if let ast::Expr::Literal(literal) = dot_receiver.clone() {
 195         if let Some(literal_text) = ast::String::cast(literal.token()) {
 196             add_format_like_completions(acc, ctx, &dot_receiver, cap, &literal_text);
 197         }
 198     }
 199 }
 200
 201 fn get_receiver_text(receiver: &ast::Expr, receiver_is_ambiguous_float_literal: bool) -> String {
 202     if receiver_is_ambiguous_float_literal {
 203         let text = receiver.syntax().text();
 204         let without_dot = ..text.len() - TextSize::of('.');
 205         text.slice(without_dot).to_string()
 206     } else {
 207         receiver.to_string()
 208     }
 209 }
 210
 211 fn include_references(initial_element: &ast::Expr) -> ast::Expr {
 212     let mut resulting_element = initial_element.clone();
 213     while let Some(parent_ref_element) =
 214         resulting_element.syntax().parent().and_then(ast::RefExpr::cast)
 215     {
 216         resulting_element = ast::Expr::from(parent_ref_element);
 217     }
 218     resulting_element
 219 }
 220
 221 fn build_postfix_snippet_builder<'ctx>(
 222     ctx: &'ctx CompletionContext,
 223     cap: SnippetCap,
 224     receiver: &'ctx ast::Expr,
 225 ) -> Option<impl Fn(&str, &str, &str) -> Builder + 'ctx> {
 226     let receiver_syntax = receiver.syntax();
 227     let receiver_range = ctx.sema.original_range_opt(receiver_syntax)?.range;
 228     let delete_range = TextRange::new(receiver_range.start(), ctx.source_range().end());
 229
 230     // Wrapping impl Fn in an option ruins lifetime inference for the parameters in a way that
 231     // can't be annotated for the closure, hence fix it by constructing it without the Option first
 232     fn build<'ctx>(
 233         ctx: &'ctx CompletionContext,
 234         cap: SnippetCap,
 235         delete_range: TextRange,
 236     ) -> impl Fn(&str, &str, &str) -> Builder + 'ctx {
 237         move |label, detail, snippet| {
 238             let edit = TextEdit::replace(delete_range, snippet.to_string());
 239             let mut item =
 240                 CompletionItem::new(CompletionItemKind::Snippet, ctx.source_range(), label);
 241             item.detail(detail).snippet_edit(cap, edit);
 242             if ctx.original_token.text() == label {
 243                 let relevance =
 244                     CompletionRelevance { exact_postfix_snippet_match: true, ..Default::default() };
 245                 item.set_relevance(relevance);
 246             }
 247
 248             item
 249         }
 250     }
 251     Some(build(ctx, cap, delete_range))
 252 }
 253
 254 fn add_custom_postfix_completions(
 255     acc: &mut Completions,
 256     ctx: &CompletionContext,
 257     postfix_snippet: impl Fn(&str, &str, &str) -> Builder,
 258     receiver_text: &str,
 259 ) -> Option<()> {
 260     let import_scope = ImportScope::find_insert_use_container(&ctx.token.parent()?, &ctx.sema)?;
 261     ctx.config.postfix_snippets().filter(|(_, snip)| snip.scope == SnippetScope::Expr).for_each(
 262         |(trigger, snippet)| {
 263             let imports = match snippet.imports(ctx, &import_scope) {
 264                 Some(imports) => imports,
 265                 None => return,
 266             };
 267             let body = snippet.postfix_snippet(&receiver_text);
 268             let mut builder =
 269                 postfix_snippet(trigger, snippet.description.as_deref().unwrap_or_default(), &body);
 270             builder.documentation(Documentation::new(format!("```rust\n{}\n```", body)));
 271             for import in imports.into_iter() {
 272                 builder.add_import(import);
 273             }
 274             builder.add_to(acc);
 275         },
 276     );
 277     None
 278 }
 279
 280 #[cfg(test)]
 281 mod tests {
 282     use expect_test::{expect, Expect};
 283
 284     use crate::{
 285         tests::{check_edit, check_edit_with_config, completion_list, TEST_CONFIG},
 286         CompletionConfig, Snippet,
 287     };
 288
 289     fn check(ra_fixture: &str, expect: Expect) {
 290         let actual = completion_list(ra_fixture);
 291         expect.assert_eq(&actual)
 292     }
 293
 294     #[test]
 295     fn postfix_completion_works_for_trivial_path_expression() {
 296         check(
 297             r#"
 298 fn main() {
 299     let bar = true;
 300     bar.$0
 301 }
 302 "#,
 303             expect![[r#"
 304                 sn if    if expr {}
 305                 sn while while expr {}
 306                 sn not   !expr
 307                 sn ref   &expr
 308                 sn refm  &mut expr
 309                 sn match match expr {}
 310                 sn box   Box::new(expr)
 311                 sn dbg   dbg!(expr)
 312                 sn dbgr  dbg!(&expr)
 313                 sn call  function(expr)
 314                 sn let   let
 315                 sn letm  let mut
 316             "#]],
 317         );
 318     }
 319
 320     #[test]
 321     fn postfix_completion_works_for_function_calln() {
 322         check(
 323             r#"
 324 fn foo(elt: bool) -> bool {
 325     !elt
 326 }
 327
 328 fn main() {
 329     let bar = true;
 330     foo(bar.$0)
 331 }
 332 "#,
 333             expect![[r#"
 334                 sn if    if expr {}
 335                 sn while while expr {}
 336                 sn not   !expr
 337                 sn ref   &expr
 338                 sn refm  &mut expr
 339                 sn match match expr {}
 340                 sn box   Box::new(expr)
 341                 sn dbg   dbg!(expr)
 342                 sn dbgr  dbg!(&expr)
 343                 sn call  function(expr)
 344             "#]],
 345         );
 346     }
 347
 348     #[test]
 349     fn postfix_type_filtering() {
 350         check(
 351             r#"
 352 fn main() {
 353     let bar: u8 = 12;
 354     bar.$0
 355 }
 356 "#,
 357             expect![[r#"
 358                 sn ref   &expr
 359                 sn refm  &mut expr
 360                 sn match match expr {}
 361                 sn box   Box::new(expr)
 362                 sn dbg   dbg!(expr)
 363                 sn dbgr  dbg!(&expr)
 364                 sn call  function(expr)
 365                 sn let   let
 366                 sn letm  let mut
 367             "#]],
 368         )
 369     }
 370
 371     #[test]
 372     fn let_middle_block() {
 373         check(
 374             r#"
 375 fn main() {
 376     baz.l$0
 377     res
 378 }
 379 "#,
 380             expect![[r#"
 381                 sn if    if expr {}
 382                 sn while while expr {}
 383                 sn not   !expr
 384                 sn ref   &expr
 385                 sn refm  &mut expr
 386                 sn match match expr {}
 387                 sn box   Box::new(expr)
 388                 sn dbg   dbg!(expr)
 389                 sn dbgr  dbg!(&expr)
 390                 sn call  function(expr)
 391                 sn let   let
 392                 sn letm  let mut
 393             "#]],
 394         );
 395     }
 396
 397     #[test]
 398     fn option_iflet() {
 399         check_edit(
 400             "ifl",
 401             r#"
 402 //- minicore: option
 403 fn main() {
 404     let bar = Some(true);
 405     bar.$0
 406 }
 407 "#,
 408             r#"
 409 fn main() {
 410     let bar = Some(true);
 411     if let Some($1) = bar {
 412     $0
 413 }
 414 }
 415 "#,
 416         );
 417     }
 418
 419     #[test]
 420     fn result_match() {
 421         check_edit(
 422             "match",
 423             r#"
 424 //- minicore: result
 425 fn main() {
 426     let bar = Ok(true);
 427     bar.$0
 428 }
 429 "#,
 430             r#"
 431 fn main() {
 432     let bar = Ok(true);
 433     match bar {
 434     Ok(${1:_}) => {$2},
 435     Err(${3:_}) => {$0},
 436 }
 437 }
 438 "#,
 439         );
 440     }
 441
 442     #[test]
 443     fn postfix_completion_works_for_ambiguous_float_literal() {
 444         check_edit("refm", r#"fn main() { 42.$0 }"#, r#"fn main() { &mut 42 }"#)
 445     }
 446
 447     #[test]
 448     fn works_in_simple_macro() {
 449         check_edit(
 450             "dbg",
 451             r#"
 452 macro_rules! m { ($e:expr) => { $e } }
 453 fn main() {
 454     let bar: u8 = 12;
 455     m!(bar.d$0)
 456 }
 457 "#,
 458             r#"
 459 macro_rules! m { ($e:expr) => { $e } }
 460 fn main() {
 461     let bar: u8 = 12;
 462     m!(dbg!(bar))
 463 }
 464 "#,
 465         );
 466     }
 467
 468     #[test]
 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 }"#);
 472         check_edit(
 473             "ifl",
 474             r#"
 475 //- minicore: option
 476 fn main() {
 477     let bar = &Some(true);
 478     bar.$0
 479 }
 480 "#,
 481             r#"
 482 fn main() {
 483     let bar = &Some(true);
 484     if let Some($1) = bar {
 485     $0
 486 }
 487 }
 488 "#,
 489         )
 490     }
 491
 492     #[test]
 493     fn custom_postfix_completion() {
 494         check_edit_with_config(
 495             CompletionConfig {
 496                 snippets: vec![Snippet::new(
 497                     &[],
 498                     &["break".into()],
 499                     &["ControlFlow::Break(${receiver})".into()],
 500                     "",
 501                     &["core::ops::ControlFlow".into()],
 502                     crate::SnippetScope::Expr,
 503                 )
 504                 .unwrap()],
 505                 ..TEST_CONFIG
 506             },
 507             "break",
 508             r#"
 509 //- minicore: try
 510 fn main() { 42.$0 }
 511 "#,
 512             r#"
 513 use core::ops::ControlFlow;
 514
 515 fn main() { ControlFlow::Break(42) }
 516 "#,
 517         );
 518     }
 519
 520     #[test]
 521     fn postfix_completion_for_format_like_strings() {
 522         check_edit(
 523             "format",
 524             r#"fn main() { "{some_var:?}".$0 }"#,
 525             r#"fn main() { format!("{:?}", some_var) }"#,
 526         );
 527         check_edit(
 528             "panic",
 529             r#"fn main() { "Panic with {a}".$0 }"#,
 530             r#"fn main() { panic!("Panic with {}", a) }"#,
 531         );
 532         check_edit(
 533             "println",
 534             r#"fn main() { "{ 2+2 } { SomeStruct { val: 1, other: 32 } :?}".$0 }"#,
 535             r#"fn main() { println!("{} {:?}", 2+2, SomeStruct { val: 1, other: 32 }) }"#,
 536         );
 537         check_edit(
 538             "loge",
 539             r#"fn main() { "{2+2}".$0 }"#,
 540             r#"fn main() { log::error!("{}", 2+2) }"#,
 541         );
 542         check_edit(
 543             "logt",
 544             r#"fn main() { "{2+2}".$0 }"#,
 545             r#"fn main() { log::trace!("{}", 2+2) }"#,
 546         );
 547         check_edit(
 548             "logd",
 549             r#"fn main() { "{2+2}".$0 }"#,
 550             r#"fn main() { log::debug!("{}", 2+2) }"#,
 551         );
 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) }"#);
 554         check_edit(
 555             "loge",
 556             r#"fn main() { "{2+2}".$0 }"#,
 557             r#"fn main() { log::error!("{}", 2+2) }"#,
 558         );
 559     }
 560 }