src/tools/rustfmt/src/matches.rs

   1 //! Format match expression.
   2
   3 use std::iter::repeat;
   4
   5 use rustc_ast::{ast, ptr};
   6 use rustc_span::{BytePos, Span};
   7
   8 use crate::comment::{combine_strs_with_missing_comments, rewrite_comment};
   9 use crate::config::lists::*;
  10 use crate::config::{Config, ControlBraceStyle, IndentStyle, MatchArmLeadingPipe, Version};
  11 use crate::expr::{
  12     format_expr, is_empty_block, is_simple_block, is_unsafe_block, prefer_next_line, rewrite_cond,
  13     ExprType, RhsTactics,
  14 };
  15 use crate::lists::{itemize_list, write_list, ListFormatting};
  16 use crate::rewrite::{Rewrite, RewriteContext};
  17 use crate::shape::Shape;
  18 use crate::source_map::SpanUtils;
  19 use crate::spanned::Spanned;
  20 use crate::utils::{
  21     contains_skip, extra_offset, first_line_width, inner_attributes, last_line_extendable, mk_sp,
  22     semicolon_for_expr, trimmed_last_line_width, unicode_str_width,
  23 };
  24
  25 /// A simple wrapper type against `ast::Arm`. Used inside `write_list()`.
  26 struct ArmWrapper<'a> {
  27     arm: &'a ast::Arm,
  28     /// `true` if the arm is the last one in match expression. Used to decide on whether we should
  29     /// add trailing comma to the match arm when `config.trailing_comma() == Never`.
  30     is_last: bool,
  31     /// Holds a byte position of `|` at the beginning of the arm pattern, if available.
  32     beginning_vert: Option<BytePos>,
  33 }
  34
  35 impl<'a> ArmWrapper<'a> {
  36     fn new(arm: &'a ast::Arm, is_last: bool, beginning_vert: Option<BytePos>) -> ArmWrapper<'a> {
  37         ArmWrapper {
  38             arm,
  39             is_last,
  40             beginning_vert,
  41         }
  42     }
  43 }
  44
  45 impl<'a> Spanned for ArmWrapper<'a> {
  46     fn span(&self) -> Span {
  47         if let Some(lo) = self.beginning_vert {
  48             let lo = std::cmp::min(lo, self.arm.span().lo());
  49             mk_sp(lo, self.arm.span().hi())
  50         } else {
  51             self.arm.span()
  52         }
  53     }
  54 }
  55
  56 impl<'a> Rewrite for ArmWrapper<'a> {
  57     fn rewrite(&self, context: &RewriteContext<'_>, shape: Shape) -> Option<String> {
  58         rewrite_match_arm(
  59             context,
  60             self.arm,
  61             shape,
  62             self.is_last,
  63             self.beginning_vert.is_some(),
  64         )
  65     }
  66 }
  67
  68 pub(crate) fn rewrite_match(
  69     context: &RewriteContext<'_>,
  70     cond: &ast::Expr,
  71     arms: &[ast::Arm],
  72     shape: Shape,
  73     span: Span,
  74     attrs: &[ast::Attribute],
  75 ) -> Option<String> {
  76     // Do not take the rhs overhead from the upper expressions into account
  77     // when rewriting match condition.
  78     let cond_shape = Shape {
  79         width: context.budget(shape.used_width()),
  80         ..shape
  81     };
  82     // 6 = `match `
  83     let cond_shape = match context.config.indent_style() {
  84         IndentStyle::Visual => cond_shape.shrink_left(6)?,
  85         IndentStyle::Block => cond_shape.offset_left(6)?,
  86     };
  87     let cond_str = cond.rewrite(context, cond_shape)?;
  88     let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
  89     let block_sep = match context.config.control_brace_style() {
  90         ControlBraceStyle::AlwaysNextLine => alt_block_sep,
  91         _ if last_line_extendable(&cond_str) => " ",
  92         // 2 = ` {`
  93         _ if cond_str.contains('\n') || cond_str.len() + 2 > cond_shape.width => alt_block_sep,
  94         _ => " ",
  95     };
  96
  97     let nested_indent_str = shape
  98         .indent
  99         .block_indent(context.config)
 100         .to_string(context.config);
 101     // Inner attributes.
 102     let inner_attrs = &inner_attributes(attrs);
 103     let inner_attrs_str = if inner_attrs.is_empty() {
 104         String::new()
 105     } else {
 106         inner_attrs
 107             .rewrite(context, shape)
 108             .map(|s| format!("{}{}\n", nested_indent_str, s))?
 109     };
 110
 111     let open_brace_pos = if inner_attrs.is_empty() {
 112         let hi = if arms.is_empty() {
 113             span.hi()
 114         } else {
 115             arms[0].span().lo()
 116         };
 117         context
 118             .snippet_provider
 119             .span_after(mk_sp(cond.span.hi(), hi), "{")
 120     } else {
 121         inner_attrs[inner_attrs.len() - 1].span.hi()
 122     };
 123
 124     if arms.is_empty() {
 125         let snippet = context.snippet(mk_sp(open_brace_pos, span.hi() - BytePos(1)));
 126         if snippet.trim().is_empty() {
 127             Some(format!("match {} {{}}", cond_str))
 128         } else {
 129             // Empty match with comments or inner attributes? We are not going to bother, sorry ;)
 130             Some(context.snippet(span).to_owned())
 131         }
 132     } else {
 133         let span_after_cond = mk_sp(cond.span.hi(), span.hi());
 134         Some(format!(
 135             "match {}{}{{\n{}{}{}\n{}}}",
 136             cond_str,
 137             block_sep,
 138             inner_attrs_str,
 139             nested_indent_str,
 140             rewrite_match_arms(context, arms, shape, span_after_cond, open_brace_pos)?,
 141             shape.indent.to_string(context.config),
 142         ))
 143     }
 144 }
 145
 146 fn arm_comma(config: &Config, body: &ast::Expr, is_last: bool) -> &'static str {
 147     if is_last && config.trailing_comma() == SeparatorTactic::Never {
 148         ""
 149     } else if config.match_block_trailing_comma() {
 150         ","
 151     } else if let ast::ExprKind::Block(ref block, _) = body.kind {
 152         if let ast::BlockCheckMode::Default = block.rules {
 153             ""
 154         } else {
 155             ","
 156         }
 157     } else {
 158         ","
 159     }
 160 }
 161
 162 /// Collect a byte position of the beginning `|` for each arm, if available.
 163 fn collect_beginning_verts(
 164     context: &RewriteContext<'_>,
 165     arms: &[ast::Arm],
 166 ) -> Vec<Option<BytePos>> {
 167     arms.iter()
 168         .map(|a| {
 169             context
 170                 .snippet(a.pat.span)
 171                 .starts_with('|')
 172                 .then(|| a.pat.span().lo())
 173         })
 174         .collect()
 175 }
 176
 177 fn rewrite_match_arms(
 178     context: &RewriteContext<'_>,
 179     arms: &[ast::Arm],
 180     shape: Shape,
 181     span: Span,
 182     open_brace_pos: BytePos,
 183 ) -> Option<String> {
 184     let arm_shape = shape
 185         .block_indent(context.config.tab_spaces())
 186         .with_max_width(context.config);
 187
 188     let arm_len = arms.len();
 189     let is_last_iter = repeat(false)
 190         .take(arm_len.saturating_sub(1))
 191         .chain(repeat(true));
 192     let beginning_verts = collect_beginning_verts(context, arms);
 193     let items = itemize_list(
 194         context.snippet_provider,
 195         arms.iter()
 196             .zip(is_last_iter)
 197             .zip(beginning_verts.into_iter())
 198             .map(|((arm, is_last), beginning_vert)| ArmWrapper::new(arm, is_last, beginning_vert)),
 199         "}",
 200         "|",
 201         |arm| arm.span().lo(),
 202         |arm| arm.span().hi(),
 203         |arm| arm.rewrite(context, arm_shape),
 204         open_brace_pos,
 205         span.hi(),
 206         false,
 207     );
 208     let arms_vec: Vec<_> = items.collect();
 209     // We will add/remove commas inside `arm.rewrite()`, and hence no separator here.
 210     let fmt = ListFormatting::new(arm_shape, context.config)
 211         .separator("")
 212         .preserve_newline(true);
 213
 214     write_list(&arms_vec, &fmt)
 215 }
 216
 217 fn rewrite_match_arm(
 218     context: &RewriteContext<'_>,
 219     arm: &ast::Arm,
 220     shape: Shape,
 221     is_last: bool,
 222     has_leading_pipe: bool,
 223 ) -> Option<String> {
 224     let (missing_span, attrs_str) = if !arm.attrs.is_empty() {
 225         if contains_skip(&arm.attrs) {
 226             let (_, body) = flatten_arm_body(context, &arm.body, None);
 227             // `arm.span()` does not include trailing comma, add it manually.
 228             return Some(format!(
 229                 "{}{}",
 230                 context.snippet(arm.span()),
 231                 arm_comma(context.config, body, is_last),
 232             ));
 233         }
 234         let missing_span = mk_sp(arm.attrs[arm.attrs.len() - 1].span.hi(), arm.pat.span.lo());
 235         (missing_span, arm.attrs.rewrite(context, shape)?)
 236     } else {
 237         (mk_sp(arm.span().lo(), arm.span().lo()), String::new())
 238     };
 239
 240     // Leading pipe offset
 241     // 2 = `| `
 242     let (pipe_offset, pipe_str) = match context.config.match_arm_leading_pipes() {
 243         MatchArmLeadingPipe::Never => (0, ""),
 244         MatchArmLeadingPipe::Preserve if !has_leading_pipe => (0, ""),
 245         MatchArmLeadingPipe::Preserve | MatchArmLeadingPipe::Always => (2, "| "),
 246     };
 247
 248     // Patterns
 249     // 5 = ` => {`
 250     let pat_shape = shape.sub_width(5)?.offset_left(pipe_offset)?;
 251     let pats_str = arm.pat.rewrite(context, pat_shape)?;
 252
 253     // Guard
 254     let block_like_pat = trimmed_last_line_width(&pats_str) <= context.config.tab_spaces();
 255     let new_line_guard = pats_str.contains('\n') && !block_like_pat;
 256     let guard_str = rewrite_guard(
 257         context,
 258         &arm.guard,
 259         shape,
 260         trimmed_last_line_width(&pats_str),
 261         new_line_guard,
 262     )?;
 263
 264     let lhs_str = combine_strs_with_missing_comments(
 265         context,
 266         &attrs_str,
 267         &format!("{}{}{}", pipe_str, pats_str, guard_str),
 268         missing_span,
 269         shape,
 270         false,
 271     )?;
 272
 273     let arrow_span = mk_sp(arm.pat.span.hi(), arm.body.span().lo());
 274     rewrite_match_body(
 275         context,
 276         &arm.body,
 277         &lhs_str,
 278         shape,
 279         guard_str.contains('\n'),
 280         arrow_span,
 281         is_last,
 282     )
 283 }
 284
 285 fn stmt_is_expr_mac(stmt: &ast::Stmt) -> bool {
 286     if let ast::StmtKind::Expr(expr) = &stmt.kind {
 287         if let ast::ExprKind::MacCall(_) = &expr.kind {
 288             return true;
 289         }
 290     }
 291     false
 292 }
 293
 294 fn block_can_be_flattened<'a>(
 295     context: &RewriteContext<'_>,
 296     expr: &'a ast::Expr,
 297 ) -> Option<&'a ast::Block> {
 298     match expr.kind {
 299         ast::ExprKind::Block(ref block, _)
 300             if !is_unsafe_block(block)
 301                 && !context.inside_macro()
 302                 && is_simple_block(context, block, Some(&expr.attrs))
 303                 && !stmt_is_expr_mac(&block.stmts[0]) =>
 304         {
 305             Some(&*block)
 306         }
 307         _ => None,
 308     }
 309 }
 310
 311 // (extend, body)
 312 // @extend: true if the arm body can be put next to `=>`
 313 // @body: flattened body, if the body is block with a single expression
 314 fn flatten_arm_body<'a>(
 315     context: &'a RewriteContext<'_>,
 316     body: &'a ast::Expr,
 317     opt_shape: Option<Shape>,
 318 ) -> (bool, &'a ast::Expr) {
 319     let can_extend =
 320         |expr| !context.config.force_multiline_blocks() && can_flatten_block_around_this(expr);
 321
 322     if let Some(block) = block_can_be_flattened(context, body) {
 323         if let ast::StmtKind::Expr(ref expr) = block.stmts[0].kind {
 324             if let ast::ExprKind::Block(..) = expr.kind {
 325                 flatten_arm_body(context, expr, None)
 326             } else {
 327                 let cond_becomes_muti_line = opt_shape
 328                     .and_then(|shape| rewrite_cond(context, expr, shape))
 329                     .map_or(false, |cond| cond.contains('\n'));
 330                 if cond_becomes_muti_line {
 331                     (false, &*body)
 332                 } else {
 333                     (can_extend(expr), &*expr)
 334                 }
 335             }
 336         } else {
 337             (false, &*body)
 338         }
 339     } else {
 340         (can_extend(body), &*body)
 341     }
 342 }
 343
 344 fn rewrite_match_body(
 345     context: &RewriteContext<'_>,
 346     body: &ptr::P<ast::Expr>,
 347     pats_str: &str,
 348     shape: Shape,
 349     has_guard: bool,
 350     arrow_span: Span,
 351     is_last: bool,
 352 ) -> Option<String> {
 353     let (extend, body) = flatten_arm_body(
 354         context,
 355         body,
 356         shape.offset_left(extra_offset(pats_str, shape) + 4),
 357     );
 358     let (is_block, is_empty_block) = if let ast::ExprKind::Block(ref block, _) = body.kind {
 359         (true, is_empty_block(context, block, Some(&body.attrs)))
 360     } else {
 361         (false, false)
 362     };
 363
 364     let comma = arm_comma(context.config, body, is_last);
 365     let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
 366
 367     let combine_orig_body = |body_str: &str| {
 368         let block_sep = match context.config.control_brace_style() {
 369             ControlBraceStyle::AlwaysNextLine if is_block => alt_block_sep,
 370             _ => " ",
 371         };
 372
 373         Some(format!("{} =>{}{}{}", pats_str, block_sep, body_str, comma))
 374     };
 375
 376     let next_line_indent = if !is_block || is_empty_block {
 377         shape.indent.block_indent(context.config)
 378     } else {
 379         shape.indent
 380     };
 381
 382     let forbid_same_line =
 383         (has_guard && pats_str.contains('\n') && !is_empty_block) || !body.attrs.is_empty();
 384
 385     // Look for comments between `=>` and the start of the body.
 386     let arrow_comment = {
 387         let arrow_snippet = context.snippet(arrow_span).trim();
 388         // search for the arrow starting from the end of the snippet since there may be a match
 389         // expression within the guard
 390         let arrow_index = arrow_snippet.rfind("=>").unwrap();
 391         // 2 = `=>`
 392         let comment_str = arrow_snippet[arrow_index + 2..].trim();
 393         if comment_str.is_empty() {
 394             String::new()
 395         } else {
 396             rewrite_comment(comment_str, false, shape, context.config)?
 397         }
 398     };
 399
 400     let combine_next_line_body = |body_str: &str| {
 401         let nested_indent_str = next_line_indent.to_string_with_newline(context.config);
 402
 403         if is_block {
 404             let mut result = pats_str.to_owned();
 405             result.push_str(" =>");
 406             if !arrow_comment.is_empty() {
 407                 result.push_str(&nested_indent_str);
 408                 result.push_str(&arrow_comment);
 409             }
 410             result.push_str(&nested_indent_str);
 411             result.push_str(body_str);
 412             result.push_str(comma);
 413             return Some(result);
 414         }
 415
 416         let indent_str = shape.indent.to_string_with_newline(context.config);
 417         let (body_prefix, body_suffix) =
 418             if context.config.match_arm_blocks() && !context.inside_macro() {
 419                 let comma = if context.config.match_block_trailing_comma() {
 420                     ","
 421                 } else {
 422                     ""
 423                 };
 424                 let semicolon = if context.config.version() == Version::One {
 425                     ""
 426                 } else {
 427                     if semicolon_for_expr(context, body) {
 428                         ";"
 429                     } else {
 430                         ""
 431                     }
 432                 };
 433                 ("{", format!("{}{}}}{}", semicolon, indent_str, comma))
 434             } else {
 435                 ("", String::from(","))
 436             };
 437
 438         let block_sep = match context.config.control_brace_style() {
 439             ControlBraceStyle::AlwaysNextLine => format!("{}{}", alt_block_sep, body_prefix),
 440             _ if body_prefix.is_empty() => "".to_owned(),
 441             _ if forbid_same_line || !arrow_comment.is_empty() => {
 442                 format!("{}{}", alt_block_sep, body_prefix)
 443             }
 444             _ => format!(" {}", body_prefix),
 445         } + &nested_indent_str;
 446
 447         let mut result = pats_str.to_owned();
 448         result.push_str(" =>");
 449         if !arrow_comment.is_empty() {
 450             result.push_str(&indent_str);
 451             result.push_str(&arrow_comment);
 452         }
 453         result.push_str(&block_sep);
 454         result.push_str(body_str);
 455         result.push_str(&body_suffix);
 456         Some(result)
 457     };
 458
 459     // Let's try and get the arm body on the same line as the condition.
 460     // 4 = ` => `.len()
 461     let orig_body_shape = shape
 462         .offset_left(extra_offset(pats_str, shape) + 4)
 463         .and_then(|shape| shape.sub_width(comma.len()));
 464     let orig_body = if forbid_same_line || !arrow_comment.is_empty() {
 465         None
 466     } else if let Some(body_shape) = orig_body_shape {
 467         let rewrite = nop_block_collapse(
 468             format_expr(body, ExprType::Statement, context, body_shape),
 469             body_shape.width,
 470         );
 471
 472         match rewrite {
 473             Some(ref body_str)
 474                 if is_block
 475                     || (!body_str.contains('\n')
 476                         && unicode_str_width(body_str) <= body_shape.width) =>
 477             {
 478                 return combine_orig_body(body_str);
 479             }
 480             _ => rewrite,
 481         }
 482     } else {
 483         None
 484     };
 485     let orig_budget = orig_body_shape.map_or(0, |shape| shape.width);
 486
 487     // Try putting body on the next line and see if it looks better.
 488     let next_line_body_shape = Shape::indented(next_line_indent, context.config);
 489     let next_line_body = nop_block_collapse(
 490         format_expr(body, ExprType::Statement, context, next_line_body_shape),
 491         next_line_body_shape.width,
 492     );
 493     match (orig_body, next_line_body) {
 494         (Some(ref orig_str), Some(ref next_line_str))
 495             if prefer_next_line(orig_str, next_line_str, RhsTactics::Default) =>
 496         {
 497             combine_next_line_body(next_line_str)
 498         }
 499         (Some(ref orig_str), _) if extend && first_line_width(orig_str) <= orig_budget => {
 500             combine_orig_body(orig_str)
 501         }
 502         (Some(ref orig_str), Some(ref next_line_str)) if orig_str.contains('\n') => {
 503             combine_next_line_body(next_line_str)
 504         }
 505         (None, Some(ref next_line_str)) => combine_next_line_body(next_line_str),
 506         (None, None) => None,
 507         (Some(ref orig_str), _) => combine_orig_body(orig_str),
 508     }
 509 }
 510
 511 // The `if ...` guard on a match arm.
 512 fn rewrite_guard(
 513     context: &RewriteContext<'_>,
 514     guard: &Option<ptr::P<ast::Expr>>,
 515     shape: Shape,
 516     // The amount of space used up on this line for the pattern in
 517     // the arm (excludes offset).
 518     pattern_width: usize,
 519     multiline_pattern: bool,
 520 ) -> Option<String> {
 521     if let Some(ref guard) = *guard {
 522         // First try to fit the guard string on the same line as the pattern.
 523         // 4 = ` if `, 5 = ` => {`
 524         let cond_shape = shape
 525             .offset_left(pattern_width + 4)
 526             .and_then(|s| s.sub_width(5));
 527         if !multiline_pattern {
 528             if let Some(cond_shape) = cond_shape {
 529                 if let Some(cond_str) = guard.rewrite(context, cond_shape) {
 530                     if !cond_str.contains('\n') || pattern_width <= context.config.tab_spaces() {
 531                         return Some(format!(" if {}", cond_str));
 532                     }
 533                 }
 534             }
 535         }
 536
 537         // Not enough space to put the guard after the pattern, try a newline.
 538         // 3 = `if `, 5 = ` => {`
 539         let cond_shape = Shape::indented(shape.indent.block_indent(context.config), context.config)
 540             .offset_left(3)
 541             .and_then(|s| s.sub_width(5));
 542         if let Some(cond_shape) = cond_shape {
 543             if let Some(cond_str) = guard.rewrite(context, cond_shape) {
 544                 return Some(format!(
 545                     "{}if {}",
 546                     cond_shape.indent.to_string_with_newline(context.config),
 547                     cond_str
 548                 ));
 549             }
 550         }
 551
 552         None
 553     } else {
 554         Some(String::new())
 555     }
 556 }
 557
 558 fn nop_block_collapse(block_str: Option<String>, budget: usize) -> Option<String> {
 559     debug!("nop_block_collapse {:?} {}", block_str, budget);
 560     block_str.map(|block_str| {
 561         if block_str.starts_with('{')
 562             && budget >= 2
 563             && (block_str[1..].find(|c: char| !c.is_whitespace()).unwrap() == block_str.len() - 2)
 564         {
 565             String::from("{}")
 566         } else {
 567             block_str
 568         }
 569     })
 570 }
 571
 572 fn can_flatten_block_around_this(body: &ast::Expr) -> bool {
 573     match body.kind {
 574         // We do not allow `if` to stay on the same line, since we could easily mistake
 575         // `pat => if cond { ... }` and `pat if cond => { ... }`.
 576         ast::ExprKind::If(..) => false,
 577         // We do not allow collapsing a block around expression with condition
 578         // to avoid it being cluttered with match arm.
 579         ast::ExprKind::ForLoop(..) | ast::ExprKind::While(..) => false,
 580         ast::ExprKind::Loop(..)
 581         | ast::ExprKind::Match(..)
 582         | ast::ExprKind::Block(..)
 583         | ast::ExprKind::Closure(..)
 584         | ast::ExprKind::Array(..)
 585         | ast::ExprKind::Call(..)
 586         | ast::ExprKind::MethodCall(..)
 587         | ast::ExprKind::MacCall(..)
 588         | ast::ExprKind::Struct(..)
 589         | ast::ExprKind::Tup(..) => true,
 590         ast::ExprKind::AddrOf(_, _, ref expr)
 591         | ast::ExprKind::Box(ref expr)
 592         | ast::ExprKind::Try(ref expr)
 593         | ast::ExprKind::Unary(_, ref expr)
 594         | ast::ExprKind::Index(ref expr, _)
 595         | ast::ExprKind::Cast(ref expr, _) => can_flatten_block_around_this(expr),
 596         _ => false,
 597     }
 598 }