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;
  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, self.beginning_vert)
  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         config: context.config,
 228     };
 229
 230     write_list(&arms_vec, &fmt)
 231 }
 232
 233 fn rewrite_match_arm(
 234     context: &RewriteContext,
 235     arm: &ast::Arm,
 236     shape: Shape,
 237     is_last: bool,
 238     beginning_vert: Option<BytePos>,
 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 = rewrite_match_pattern(
 259         context,
 260         &ptr_vec_to_ref_vec(&arm.pats),
 261         &arm.guard,
 262         beginning_vert.is_some(),
 263         shape,
 264     ).and_then(|pats_str| {
 265         combine_strs_with_missing_comments(
 266             context,
 267             &attrs_str,
 268             &pats_str,
 269             missing_span,
 270             shape,
 271             false,
 272         )
 273     })?;
 274     rewrite_match_body(
 275         context,
 276         &arm.body,
 277         &pats_str,
 278         shape,
 279         arm.guard.is_some(),
 280         is_last,
 281     )
 282 }
 283
 284 fn rewrite_match_pattern(
 285     context: &RewriteContext,
 286     pats: &[&ast::Pat],
 287     guard: &Option<ptr::P<ast::Expr>>,
 288     has_beginning_vert: bool,
 289     shape: Shape,
 290 ) -> Option<String> {
 291     // Patterns
 292     // 5 = ` => {`
 293     // 2 = `| `
 294     let pat_shape = shape
 295         .sub_width(5)?
 296         .offset_left(if has_beginning_vert { 2 } else { 0 })?;
 297     let pats_str = rewrite_multiple_patterns(context, pats, pat_shape)?;
 298     let beginning_vert = if has_beginning_vert { "| " } else { "" };
 299
 300     // Guard
 301     let guard_str = rewrite_guard(context, guard, shape, trimmed_last_line_width(&pats_str))?;
 302
 303     Some(format!("{}{}{}", beginning_vert, pats_str, guard_str))
 304 }
 305
 306 // (extend, body)
 307 // @extend: true if the arm body can be put next to `=>`
 308 // @body: flattened body, if the body is block with a single expression
 309 fn flatten_arm_body<'a>(context: &'a RewriteContext, body: &'a ast::Expr) -> (bool, &'a ast::Expr) {
 310     match body.node {
 311         ast::ExprKind::Block(ref block)
 312             if !is_unsafe_block(block)
 313                 && is_simple_block(block, Some(&body.attrs), context.codemap) =>
 314         {
 315             if let ast::StmtKind::Expr(ref expr) = block.stmts[0].node {
 316                 (
 317                     !context.config.force_multiline_blocks() && can_flatten_block_around_this(expr),
 318                     &*expr,
 319                 )
 320             } else {
 321                 (false, &*body)
 322             }
 323         }
 324         _ => (
 325             !context.config.force_multiline_blocks() && body.can_be_overflowed(context, 1),
 326             &*body,
 327         ),
 328     }
 329 }
 330
 331 fn rewrite_match_body(
 332     context: &RewriteContext,
 333     body: &ptr::P<ast::Expr>,
 334     pats_str: &str,
 335     shape: Shape,
 336     has_guard: bool,
 337     is_last: bool,
 338 ) -> Option<String> {
 339     let (extend, body) = flatten_arm_body(context, body);
 340     let (is_block, is_empty_block) = if let ast::ExprKind::Block(ref block) = body.node {
 341         (
 342             true,
 343             is_empty_block(block, Some(&body.attrs), context.codemap),
 344         )
 345     } else {
 346         (false, false)
 347     };
 348
 349     let comma = arm_comma(context.config, body, is_last);
 350     let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
 351
 352     let combine_orig_body = |body_str: &str| {
 353         let block_sep = match context.config.control_brace_style() {
 354             ControlBraceStyle::AlwaysNextLine if is_block => alt_block_sep,
 355             _ => " ",
 356         };
 357
 358         Some(format!("{} =>{}{}{}", pats_str, block_sep, body_str, comma))
 359     };
 360
 361     let forbid_same_line = has_guard && pats_str.contains('\n') && !is_empty_block;
 362     let next_line_indent = if !is_block || is_empty_block {
 363         shape.indent.block_indent(context.config)
 364     } else {
 365         shape.indent
 366     };
 367     let combine_next_line_body = |body_str: &str| {
 368         if is_block {
 369             return Some(format!(
 370                 "{} =>{}{}",
 371                 pats_str,
 372                 next_line_indent.to_string_with_newline(context.config),
 373                 body_str
 374             ));
 375         }
 376
 377         let indent_str = shape.indent.to_string_with_newline(context.config);
 378         let nested_indent_str = next_line_indent.to_string_with_newline(context.config);
 379         let (body_prefix, body_suffix) = if context.config.match_arm_blocks() {
 380             let comma = if context.config.match_block_trailing_comma() {
 381                 ","
 382             } else {
 383                 ""
 384             };
 385             ("{", format!("{}}}{}", indent_str, comma))
 386         } else {
 387             ("", String::from(","))
 388         };
 389
 390         let block_sep = match context.config.control_brace_style() {
 391             ControlBraceStyle::AlwaysNextLine => format!("{}{}", alt_block_sep, body_prefix),
 392             _ if body_prefix.is_empty() => "".to_owned(),
 393             _ if forbid_same_line => format!("{}{}", alt_block_sep, body_prefix),
 394             _ => format!(" {}", body_prefix),
 395         } + &nested_indent_str;
 396
 397         Some(format!(
 398             "{} =>{}{}{}",
 399             pats_str, block_sep, body_str, body_suffix
 400         ))
 401     };
 402
 403     // Let's try and get the arm body on the same line as the condition.
 404     // 4 = ` => `.len()
 405     let orig_body_shape = shape
 406         .offset_left(extra_offset(pats_str, shape) + 4)
 407         .and_then(|shape| shape.sub_width(comma.len()));
 408     let orig_body = if let Some(body_shape) = orig_body_shape {
 409         let rewrite = nop_block_collapse(
 410             format_expr(body, ExprType::Statement, context, body_shape),
 411             body_shape.width,
 412         );
 413
 414         match rewrite {
 415             Some(ref body_str)
 416                 if !forbid_same_line
 417                     && (is_block
 418                         || (!body_str.contains('\n') && body_str.len() <= body_shape.width)) =>
 419             {
 420                 return combine_orig_body(body_str);
 421             }
 422             _ => rewrite,
 423         }
 424     } else {
 425         None
 426     };
 427     let orig_budget = orig_body_shape.map_or(0, |shape| shape.width);
 428
 429     // Try putting body on the next line and see if it looks better.
 430     let next_line_body_shape = Shape::indented(next_line_indent, context.config);
 431     let next_line_body = nop_block_collapse(
 432         format_expr(body, ExprType::Statement, context, next_line_body_shape),
 433         next_line_body_shape.width,
 434     );
 435     match (orig_body, next_line_body) {
 436         (Some(ref orig_str), Some(ref next_line_str))
 437             if forbid_same_line
 438                 || prefer_next_line(orig_str, next_line_str, RhsTactics::Default) =>
 439         {
 440             combine_next_line_body(next_line_str)
 441         }
 442         (Some(ref orig_str), _) if extend && first_line_width(orig_str) <= orig_budget => {
 443             combine_orig_body(orig_str)
 444         }
 445         (Some(ref orig_str), Some(ref next_line_str)) if orig_str.contains('\n') => {
 446             combine_next_line_body(next_line_str)
 447         }
 448         (None, Some(ref next_line_str)) => combine_next_line_body(next_line_str),
 449         (None, None) => None,
 450         (Some(ref orig_str), _) => combine_orig_body(orig_str),
 451     }
 452 }
 453
 454 // The `if ...` guard on a match arm.
 455 fn rewrite_guard(
 456     context: &RewriteContext,
 457     guard: &Option<ptr::P<ast::Expr>>,
 458     shape: Shape,
 459     // The amount of space used up on this line for the pattern in
 460     // the arm (excludes offset).
 461     pattern_width: usize,
 462 ) -> Option<String> {
 463     if let Some(ref guard) = *guard {
 464         // First try to fit the guard string on the same line as the pattern.
 465         // 4 = ` if `, 5 = ` => {`
 466         let cond_shape = shape
 467             .offset_left(pattern_width + 4)
 468             .and_then(|s| s.sub_width(5));
 469         if let Some(cond_shape) = cond_shape {
 470             if let Some(cond_str) = guard.rewrite(context, cond_shape) {
 471                 if !cond_str.contains('\n') || pattern_width <= context.config.tab_spaces() {
 472                     return Some(format!(" if {}", cond_str));
 473                 }
 474             }
 475         }
 476
 477         // Not enough space to put the guard after the pattern, try a newline.
 478         // 3 = `if `, 5 = ` => {`
 479         let cond_shape = Shape::indented(shape.indent.block_indent(context.config), context.config)
 480             .offset_left(3)
 481             .and_then(|s| s.sub_width(5));
 482         if let Some(cond_shape) = cond_shape {
 483             if let Some(cond_str) = guard.rewrite(context, cond_shape) {
 484                 return Some(format!(
 485                     "{}if {}",
 486                     cond_shape.indent.to_string_with_newline(context.config),
 487                     cond_str
 488                 ));
 489             }
 490         }
 491
 492         None
 493     } else {
 494         Some(String::new())
 495     }
 496 }
 497
 498 fn nop_block_collapse(block_str: Option<String>, budget: usize) -> Option<String> {
 499     debug!("nop_block_collapse {:?} {}", block_str, budget);
 500     block_str.map(|block_str| {
 501         if block_str.starts_with('{')
 502             && budget >= 2
 503             && (block_str[1..].find(|c: char| !c.is_whitespace()).unwrap() == block_str.len() - 2)
 504         {
 505             "{}".to_owned()
 506         } else {
 507             block_str.to_owned()
 508         }
 509     })
 510 }
 511
 512 fn can_flatten_block_around_this(body: &ast::Expr) -> bool {
 513     match body.node {
 514         // We do not allow `if` to stay on the same line, since we could easily mistake
 515         // `pat => if cond { ... }` and `pat if cond => { ... }`.
 516         ast::ExprKind::If(..) | ast::ExprKind::IfLet(..) => false,
 517         // We do not allow collapsing a block around expression with condition
 518         // to avoid it being cluttered with match arm.
 519         ast::ExprKind::ForLoop(..) | ast::ExprKind::While(..) | ast::ExprKind::WhileLet(..) => {
 520             false
 521         }
 522         ast::ExprKind::Loop(..)
 523         | ast::ExprKind::Match(..)
 524         | ast::ExprKind::Block(..)
 525         | ast::ExprKind::Closure(..)
 526         | ast::ExprKind::Array(..)
 527         | ast::ExprKind::Call(..)
 528         | ast::ExprKind::MethodCall(..)
 529         | ast::ExprKind::Mac(..)
 530         | ast::ExprKind::Struct(..)
 531         | ast::ExprKind::Tup(..) => true,
 532         ast::ExprKind::AddrOf(_, ref expr)
 533         | ast::ExprKind::Box(ref expr)
 534         | ast::ExprKind::Try(ref expr)
 535         | ast::ExprKind::Unary(_, ref expr)
 536         | ast::ExprKind::Cast(ref expr, _) => can_flatten_block_around_this(expr),
 537         _ => false,
 538     }
 539 }