1 //! Format match expression.
5 use rustc_ast::{ast, ptr};
6 use rustc_span::{BytePos, Span};
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};
12 format_expr, is_empty_block, is_simple_block, is_unsafe_block, prefer_next_line, rewrite_cond,
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;
21 contains_skip, extra_offset, first_line_width, inner_attributes, last_line_extendable, mk_sp,
22 mk_sp_lo_plus_one, semicolon_for_expr, trimmed_last_line_width, unicode_str_width,
25 /// A simple wrapper type against `ast::Arm`. Used inside `write_list()`.
26 struct ArmWrapper<'a> {
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`.
31 /// Holds a byte position of `|` at the beginning of the arm pattern, if available.
32 beginning_vert: Option<BytePos>,
35 impl<'a> ArmWrapper<'a> {
36 fn new(arm: &'a ast::Arm, is_last: bool, beginning_vert: Option<BytePos>) -> ArmWrapper<'a> {
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())
56 impl<'a> Rewrite for ArmWrapper<'a> {
57 fn rewrite(&self, context: &RewriteContext<'_>, shape: Shape) -> Option<String> {
63 self.beginning_vert.is_some(),
68 pub(crate) fn rewrite_match(
69 context: &RewriteContext<'_>,
74 attrs: &[ast::Attribute],
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()),
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)?,
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) => " ",
93 _ if cond_str.contains('\n') || cond_str.len() + 2 > cond_shape.width => alt_block_sep,
97 let nested_indent_str = shape
99 .block_indent(context.config)
100 .to_string(context.config);
102 let inner_attrs = &inner_attributes(attrs);
103 let inner_attrs_str = if inner_attrs.is_empty() {
107 .rewrite(context, shape)
108 .map(|s| format!("{}{}\n", nested_indent_str, s))?
111 let open_brace_pos = if inner_attrs.is_empty() {
112 let hi = if arms.is_empty() {
119 .span_after(mk_sp(cond.span.hi(), hi), "{")
121 inner_attrs[inner_attrs.len() - 1].span.hi()
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))
129 // Empty match with comments or inner attributes? We are not going to bother, sorry ;)
130 Some(context.snippet(span).to_owned())
133 let span_after_cond = mk_sp(cond.span.hi(), span.hi());
135 "match {}{}{{\n{}{}{}\n{}}}",
140 rewrite_match_arms(context, arms, shape, span_after_cond, open_brace_pos)?,
141 shape.indent.to_string(context.config),
146 fn arm_comma(config: &Config, body: &ast::Expr, is_last: bool) -> &'static str {
147 if is_last && config.trailing_comma() == SeparatorTactic::Never {
149 } else if config.match_block_trailing_comma() {
151 } else if let ast::ExprKind::Block(ref block, _) = body.kind {
152 if let ast::BlockCheckMode::Default = block.rules {
162 /// Collect a byte position of the beginning `|` for each arm, if available.
163 fn collect_beginning_verts(
164 context: &RewriteContext<'_>,
166 ) -> Vec<Option<BytePos>> {
171 .opt_span_before(mk_sp_lo_plus_one(a.pat.span.lo()), "|")
176 fn rewrite_match_arms(
177 context: &RewriteContext<'_>,
181 open_brace_pos: BytePos,
182 ) -> Option<String> {
183 let arm_shape = shape
184 .block_indent(context.config.tab_spaces())
185 .with_max_width(context.config);
187 let arm_len = arms.len();
188 let is_last_iter = repeat(false)
189 .take(arm_len.saturating_sub(1))
190 .chain(repeat(true));
191 let beginning_verts = collect_beginning_verts(context, arms);
192 let items = itemize_list(
193 context.snippet_provider,
196 .zip(beginning_verts.into_iter())
197 .map(|((arm, is_last), beginning_vert)| ArmWrapper::new(arm, is_last, beginning_vert)),
200 |arm| arm.span().lo(),
201 |arm| arm.span().hi(),
202 |arm| arm.rewrite(context, arm_shape),
207 let arms_vec: Vec<_> = items.collect();
208 // We will add/remove commas inside `arm.rewrite()`, and hence no separator here.
209 let fmt = ListFormatting::new(arm_shape, context.config)
211 .preserve_newline(true);
213 write_list(&arms_vec, &fmt)
216 fn rewrite_match_arm(
217 context: &RewriteContext<'_>,
221 has_leading_pipe: bool,
222 ) -> Option<String> {
223 let (missing_span, attrs_str) = if !arm.attrs.is_empty() {
224 if contains_skip(&arm.attrs) {
225 let (_, body) = flatten_arm_body(context, &arm.body, None);
226 // `arm.span()` does not include trailing comma, add it manually.
229 context.snippet(arm.span()),
230 arm_comma(context.config, body, is_last),
233 let missing_span = mk_sp(arm.attrs[arm.attrs.len() - 1].span.hi(), arm.pat.span.lo());
234 (missing_span, arm.attrs.rewrite(context, shape)?)
236 (mk_sp(arm.span().lo(), arm.span().lo()), String::new())
239 // Leading pipe offset
241 let (pipe_offset, pipe_str) = match context.config.match_arm_leading_pipes() {
242 MatchArmLeadingPipe::Never => (0, ""),
243 MatchArmLeadingPipe::Preserve if !has_leading_pipe => (0, ""),
244 MatchArmLeadingPipe::Preserve | MatchArmLeadingPipe::Always => (2, "| "),
249 let pat_shape = shape.sub_width(5)?.offset_left(pipe_offset)?;
250 let pats_str = arm.pat.rewrite(context, pat_shape)?;
253 let block_like_pat = trimmed_last_line_width(&pats_str) <= context.config.tab_spaces();
254 let new_line_guard = pats_str.contains('\n') && !block_like_pat;
255 let guard_str = rewrite_guard(
259 trimmed_last_line_width(&pats_str),
263 let lhs_str = combine_strs_with_missing_comments(
266 &format!("{}{}{}", pipe_str, pats_str, guard_str),
272 let arrow_span = mk_sp(arm.pat.span.hi(), arm.body.span().lo());
278 guard_str.contains('\n'),
284 fn stmt_is_expr_mac(stmt: &ast::Stmt) -> bool {
285 if let ast::StmtKind::Expr(expr) = &stmt.kind {
286 if let ast::ExprKind::MacCall(_) = &expr.kind {
293 fn block_can_be_flattened<'a>(
294 context: &RewriteContext<'_>,
296 ) -> Option<&'a ast::Block> {
298 ast::ExprKind::Block(ref block, _)
299 if !is_unsafe_block(block)
300 && !context.inside_macro()
301 && is_simple_block(context, block, Some(&expr.attrs))
302 && !stmt_is_expr_mac(&block.stmts[0]) =>
311 // @extend: true if the arm body can be put next to `=>`
312 // @body: flattened body, if the body is block with a single expression
313 fn flatten_arm_body<'a>(
314 context: &'a RewriteContext<'_>,
316 opt_shape: Option<Shape>,
317 ) -> (bool, &'a ast::Expr) {
319 |expr| !context.config.force_multiline_blocks() && can_flatten_block_around_this(expr);
321 if let Some(ref block) = block_can_be_flattened(context, body) {
322 if let ast::StmtKind::Expr(ref expr) = block.stmts[0].kind {
323 if let ast::ExprKind::Block(..) = expr.kind {
324 flatten_arm_body(context, expr, None)
326 let cond_becomes_muti_line = opt_shape
327 .and_then(|shape| rewrite_cond(context, expr, shape))
328 .map_or(false, |cond| cond.contains('\n'));
329 if cond_becomes_muti_line {
332 (can_extend(expr), &*expr)
339 (can_extend(body), &*body)
343 fn rewrite_match_body(
344 context: &RewriteContext<'_>,
345 body: &ptr::P<ast::Expr>,
351 ) -> Option<String> {
352 let (extend, body) = flatten_arm_body(
355 shape.offset_left(extra_offset(pats_str, shape) + 4),
357 let (is_block, is_empty_block) = if let ast::ExprKind::Block(ref block, _) = body.kind {
358 (true, is_empty_block(context, block, Some(&body.attrs)))
363 let comma = arm_comma(context.config, body, is_last);
364 let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
366 let combine_orig_body = |body_str: &str| {
367 let block_sep = match context.config.control_brace_style() {
368 ControlBraceStyle::AlwaysNextLine if is_block => alt_block_sep,
372 Some(format!("{} =>{}{}{}", pats_str, block_sep, body_str, comma))
375 let next_line_indent = if !is_block || is_empty_block {
376 shape.indent.block_indent(context.config)
381 let forbid_same_line =
382 (has_guard && pats_str.contains('\n') && !is_empty_block) || !body.attrs.is_empty();
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 // search for the arrow starting from the end of the snippet since there may be a match
388 // expression within the guard
389 let arrow_index = arrow_snippet.rfind("=>").unwrap();
391 let comment_str = arrow_snippet[arrow_index + 2..].trim();
392 if comment_str.is_empty() {
395 rewrite_comment(comment_str, false, shape, &context.config)?
399 let combine_next_line_body = |body_str: &str| {
400 let nested_indent_str = next_line_indent.to_string_with_newline(context.config);
403 let mut result = pats_str.to_owned();
404 result.push_str(" =>");
405 if !arrow_comment.is_empty() {
406 result.push_str(&nested_indent_str);
407 result.push_str(&arrow_comment);
409 result.push_str(&nested_indent_str);
410 result.push_str(&body_str);
414 let indent_str = shape.indent.to_string_with_newline(context.config);
415 let (body_prefix, body_suffix) =
416 if context.config.match_arm_blocks() && !context.inside_macro() {
417 let comma = if context.config.match_block_trailing_comma() {
422 let semicolon = if context.config.version() == Version::One {
425 if semicolon_for_expr(context, body) {
431 ("{", format!("{}{}}}{}", semicolon, indent_str, comma))
433 ("", String::from(","))
436 let block_sep = match context.config.control_brace_style() {
437 ControlBraceStyle::AlwaysNextLine => format!("{}{}", alt_block_sep, body_prefix),
438 _ if body_prefix.is_empty() => "".to_owned(),
439 _ if forbid_same_line || !arrow_comment.is_empty() => {
440 format!("{}{}", alt_block_sep, body_prefix)
442 _ => format!(" {}", body_prefix),
443 } + &nested_indent_str;
445 let mut result = pats_str.to_owned();
446 result.push_str(" =>");
447 if !arrow_comment.is_empty() {
448 result.push_str(&indent_str);
449 result.push_str(&arrow_comment);
451 result.push_str(&block_sep);
452 result.push_str(&body_str);
453 result.push_str(&body_suffix);
457 // Let's try and get the arm body on the same line as the condition.
459 let orig_body_shape = shape
460 .offset_left(extra_offset(pats_str, shape) + 4)
461 .and_then(|shape| shape.sub_width(comma.len()));
462 let orig_body = if forbid_same_line || !arrow_comment.is_empty() {
464 } else if let Some(body_shape) = orig_body_shape {
465 let rewrite = nop_block_collapse(
466 format_expr(body, ExprType::Statement, context, body_shape),
473 || (!body_str.contains('\n')
474 && unicode_str_width(body_str) <= body_shape.width) =>
476 return combine_orig_body(body_str);
483 let orig_budget = orig_body_shape.map_or(0, |shape| shape.width);
485 // Try putting body on the next line and see if it looks better.
486 let next_line_body_shape = Shape::indented(next_line_indent, context.config);
487 let next_line_body = nop_block_collapse(
488 format_expr(body, ExprType::Statement, context, next_line_body_shape),
489 next_line_body_shape.width,
491 match (orig_body, next_line_body) {
492 (Some(ref orig_str), Some(ref next_line_str))
493 if prefer_next_line(orig_str, next_line_str, RhsTactics::Default) =>
495 combine_next_line_body(next_line_str)
497 (Some(ref orig_str), _) if extend && first_line_width(orig_str) <= orig_budget => {
498 combine_orig_body(orig_str)
500 (Some(ref orig_str), Some(ref next_line_str)) if orig_str.contains('\n') => {
501 combine_next_line_body(next_line_str)
503 (None, Some(ref next_line_str)) => combine_next_line_body(next_line_str),
504 (None, None) => None,
505 (Some(ref orig_str), _) => combine_orig_body(orig_str),
509 // The `if ...` guard on a match arm.
511 context: &RewriteContext<'_>,
512 guard: &Option<ptr::P<ast::Expr>>,
514 // The amount of space used up on this line for the pattern in
515 // the arm (excludes offset).
516 pattern_width: usize,
517 multiline_pattern: bool,
518 ) -> Option<String> {
519 if let Some(ref guard) = *guard {
520 // First try to fit the guard string on the same line as the pattern.
521 // 4 = ` if `, 5 = ` => {`
522 let cond_shape = shape
523 .offset_left(pattern_width + 4)
524 .and_then(|s| s.sub_width(5));
525 if !multiline_pattern {
526 if let Some(cond_shape) = cond_shape {
527 if let Some(cond_str) = guard.rewrite(context, cond_shape) {
528 if !cond_str.contains('\n') || pattern_width <= context.config.tab_spaces() {
529 return Some(format!(" if {}", cond_str));
535 // Not enough space to put the guard after the pattern, try a newline.
536 // 3 = `if `, 5 = ` => {`
537 let cond_shape = Shape::indented(shape.indent.block_indent(context.config), context.config)
539 .and_then(|s| s.sub_width(5));
540 if let Some(cond_shape) = cond_shape {
541 if let Some(cond_str) = guard.rewrite(context, cond_shape) {
544 cond_shape.indent.to_string_with_newline(context.config),
556 fn nop_block_collapse(block_str: Option<String>, budget: usize) -> Option<String> {
557 debug!("nop_block_collapse {:?} {}", block_str, budget);
558 block_str.map(|block_str| {
559 if block_str.starts_with('{')
561 && (block_str[1..].find(|c: char| !c.is_whitespace()).unwrap() == block_str.len() - 2)
570 fn can_flatten_block_around_this(body: &ast::Expr) -> bool {
572 // We do not allow `if` to stay on the same line, since we could easily mistake
573 // `pat => if cond { ... }` and `pat if cond => { ... }`.
574 ast::ExprKind::If(..) => false,
575 // We do not allow collapsing a block around expression with condition
576 // to avoid it being cluttered with match arm.
577 ast::ExprKind::ForLoop(..) | ast::ExprKind::While(..) => false,
578 ast::ExprKind::Loop(..)
579 | ast::ExprKind::Match(..)
580 | ast::ExprKind::Block(..)
581 | ast::ExprKind::Closure(..)
582 | ast::ExprKind::Array(..)
583 | ast::ExprKind::Call(..)
584 | ast::ExprKind::MethodCall(..)
585 | ast::ExprKind::MacCall(..)
586 | ast::ExprKind::Struct(..)
587 | ast::ExprKind::Tup(..) => true,
588 ast::ExprKind::AddrOf(_, _, ref expr)
589 | ast::ExprKind::Box(ref expr)
590 | ast::ExprKind::Try(ref expr)
591 | ast::ExprKind::Unary(_, ref expr)
592 | ast::ExprKind::Index(ref expr, _)
593 | ast::ExprKind::Cast(ref expr, _) => can_flatten_block_around_this(expr),