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