src/matches.rs

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