1 // Copyright 2015 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.
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.
13 use std::iter::{repeat, ExactSizeIterator};
15 use syntax::{ast, ptr};
16 use syntax::codemap::{BytePos, CodeMap, Span};
18 use chains::rewrite_chain;
20 use codemap::{LineRangeUtils, SpanUtils};
21 use comment::{combine_strs_with_missing_comments, contains_comment, recover_comment_removed,
22 rewrite_comment, rewrite_missing_comment, FindUncommented};
23 use config::{Config, ControlBraceStyle, IndentStyle};
24 use lists::{definitive_tactic, itemize_list, shape_for_tactic, struct_lit_formatting,
25 struct_lit_shape, struct_lit_tactic, write_list, DefinitiveListTactic, ListFormatting,
26 ListItem, ListTactic, Separator, SeparatorPlace, SeparatorTactic};
27 use macros::{rewrite_macro, MacroArg, MacroPosition};
28 use patterns::{can_be_overflowed_pat, TuplePatField};
29 use rewrite::{Rewrite, RewriteContext};
30 use shape::{Indent, Shape};
32 use string::{rewrite_string, StringFormat};
33 use types::{can_be_overflowed_type, rewrite_path, PathContext};
34 use utils::{colon_spaces, contains_skip, extra_offset, first_line_width, inner_attributes,
35 last_line_extendable, last_line_width, mk_sp, outer_attributes, paren_overhead,
36 ptr_vec_to_ref_vec, semicolon_for_stmt, trimmed_last_line_width, wrap_str};
37 use vertical::rewrite_with_alignment;
38 use visitor::FmtVisitor;
40 impl Rewrite for ast::Expr {
41 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
42 format_expr(self, ExprType::SubExpression, context, shape)
46 #[derive(Copy, Clone, PartialEq)]
55 context: &RewriteContext,
58 skip_out_of_file_lines_range!(context, expr.span);
60 if contains_skip(&*expr.attrs) {
61 return Some(context.snippet(expr.span()).to_owned());
64 let expr_rw = match expr.node {
65 ast::ExprKind::Array(ref expr_vec) => rewrite_array(
66 &ptr_vec_to_ref_vec(expr_vec),
67 mk_sp(context.codemap.span_after(expr.span, "["), expr.span.hi()),
72 ast::ExprKind::Lit(ref l) => rewrite_literal(context, l, shape),
73 ast::ExprKind::Call(ref callee, ref args) => {
74 let inner_span = mk_sp(callee.span.hi(), expr.span.hi());
75 let callee_str = callee.rewrite(context, shape)?;
76 rewrite_call(context, &callee_str, args, inner_span, shape)
78 ast::ExprKind::Paren(ref subexpr) => rewrite_paren(context, subexpr, shape),
79 ast::ExprKind::Binary(ref op, ref lhs, ref rhs) => {
80 // FIXME: format comments between operands and operator
84 PairParts::new("", &format!(" {} ", context.snippet(op.span)), ""),
87 context.config.binop_separator(),
90 ast::ExprKind::Unary(ref op, ref subexpr) => rewrite_unary_op(context, op, subexpr, shape),
91 ast::ExprKind::Struct(ref path, ref fields, ref base) => rewrite_struct_lit(
95 base.as_ref().map(|e| &**e),
99 ast::ExprKind::Tup(ref items) => {
100 rewrite_tuple(context, &ptr_vec_to_ref_vec(items), expr.span, shape)
102 ast::ExprKind::If(..)
103 | ast::ExprKind::IfLet(..)
104 | ast::ExprKind::ForLoop(..)
105 | ast::ExprKind::Loop(..)
106 | ast::ExprKind::While(..)
107 | ast::ExprKind::WhileLet(..) => to_control_flow(expr, expr_type)
108 .and_then(|control_flow| control_flow.rewrite(context, shape)),
109 ast::ExprKind::Block(ref block) => {
111 ExprType::Statement => {
112 if is_unsafe_block(block) {
113 block.rewrite(context, shape)
114 } else if let rw @ Some(_) = rewrite_empty_block(context, block, shape) {
115 // Rewrite block without trying to put it in a single line.
118 let prefix = block_prefix(context, block, shape)?;
119 rewrite_block_with_visitor(context, &prefix, block, shape, true)
122 ExprType::SubExpression => block.rewrite(context, shape),
125 ast::ExprKind::Match(ref cond, ref arms) => {
126 rewrite_match(context, cond, arms, shape, expr.span, &expr.attrs)
128 ast::ExprKind::Path(ref qself, ref path) => {
129 rewrite_path(context, PathContext::Expr, qself.as_ref(), path, shape)
131 ast::ExprKind::Assign(ref lhs, ref rhs) => {
132 rewrite_assignment(context, lhs, rhs, None, shape)
134 ast::ExprKind::AssignOp(ref op, ref lhs, ref rhs) => {
135 rewrite_assignment(context, lhs, rhs, Some(op), shape)
137 ast::ExprKind::Continue(ref opt_ident) => {
138 let id_str = match *opt_ident {
139 Some(ident) => format!(" {}", ident.node),
140 None => String::new(),
142 Some(format!("continue{}", id_str))
144 ast::ExprKind::Break(ref opt_ident, ref opt_expr) => {
145 let id_str = match *opt_ident {
146 Some(ident) => format!(" {}", ident.node),
147 None => String::new(),
150 if let Some(ref expr) = *opt_expr {
151 rewrite_unary_prefix(context, &format!("break{} ", id_str), &**expr, shape)
153 Some(format!("break{}", id_str))
156 ast::ExprKind::Yield(ref opt_expr) => if let Some(ref expr) = *opt_expr {
157 rewrite_unary_prefix(context, "yield ", &**expr, shape)
159 Some("yield".to_string())
161 ast::ExprKind::Closure(capture, ref fn_decl, ref body, _) => {
162 closures::rewrite_closure(capture, fn_decl, body, expr.span, context, shape)
164 ast::ExprKind::Try(..)
165 | ast::ExprKind::Field(..)
166 | ast::ExprKind::TupField(..)
167 | ast::ExprKind::MethodCall(..) => rewrite_chain(expr, context, shape),
168 ast::ExprKind::Mac(ref mac) => {
169 rewrite_macro(mac, None, context, shape, MacroPosition::Expression).or_else(|| {
171 context.snippet(expr.span).to_owned(),
172 context.config.max_width(),
177 ast::ExprKind::Ret(None) => Some("return".to_owned()),
178 ast::ExprKind::Ret(Some(ref expr)) => {
179 rewrite_unary_prefix(context, "return ", &**expr, shape)
181 ast::ExprKind::Box(ref expr) => rewrite_unary_prefix(context, "box ", &**expr, shape),
182 ast::ExprKind::AddrOf(mutability, ref expr) => {
183 rewrite_expr_addrof(context, mutability, expr, shape)
185 ast::ExprKind::Cast(ref expr, ref ty) => rewrite_pair(
188 PairParts::new("", " as ", ""),
191 SeparatorPlace::Front,
193 ast::ExprKind::Type(ref expr, ref ty) => rewrite_pair(
196 PairParts::new("", ": ", ""),
199 SeparatorPlace::Back,
201 ast::ExprKind::Index(ref expr, ref index) => {
202 rewrite_index(&**expr, &**index, context, shape)
204 ast::ExprKind::Repeat(ref expr, ref repeats) => {
205 let (lbr, rbr) = if context.config.spaces_within_parens_and_brackets() {
213 PairParts::new(lbr, "; ", rbr),
216 SeparatorPlace::Back,
219 ast::ExprKind::Range(ref lhs, ref rhs, limits) => {
220 let delim = match limits {
221 ast::RangeLimits::HalfOpen => "..",
222 ast::RangeLimits::Closed => "..=",
225 fn needs_space_before_range(context: &RewriteContext, lhs: &ast::Expr) -> bool {
227 ast::ExprKind::Lit(ref lit) => match lit.node {
228 ast::LitKind::FloatUnsuffixed(..) => {
229 context.snippet(lit.span).ends_with('.')
237 match (lhs.as_ref().map(|x| &**x), rhs.as_ref().map(|x| &**x)) {
238 (Some(lhs), Some(rhs)) => {
239 let sp_delim = if context.config.spaces_around_ranges() {
240 format!(" {} ", delim)
241 } else if needs_space_before_range(context, lhs) {
242 format!(" {}", delim)
249 PairParts::new("", &sp_delim, ""),
252 SeparatorPlace::Front,
255 (None, Some(rhs)) => {
256 let sp_delim = if context.config.spaces_around_ranges() {
257 format!("{} ", delim)
261 rewrite_unary_prefix(context, &sp_delim, &*rhs, shape)
263 (Some(lhs), None) => {
264 let sp_delim = if context.config.spaces_around_ranges() {
265 format!(" {}", delim)
269 rewrite_unary_suffix(context, &sp_delim, &*lhs, shape)
271 (None, None) => Some(delim.to_owned()),
274 // We do not format these expressions yet, but they should still
275 // satisfy our width restrictions.
276 ast::ExprKind::InPlace(..) | ast::ExprKind::InlineAsm(..) => {
277 Some(context.snippet(expr.span).to_owned())
279 ast::ExprKind::Catch(ref block) => {
280 if let rw @ Some(_) = rewrite_single_line_block(context, "do catch ", block, shape) {
284 let budget = shape.width.checked_sub(9).unwrap_or(0);
288 block.rewrite(context, Shape::legacy(budget, shape.indent))?
295 .and_then(|expr_str| recover_comment_removed(expr_str, expr.span, context))
296 .and_then(|expr_str| {
297 let attrs = outer_attributes(&expr.attrs);
298 let attrs_str = attrs.rewrite(context, shape)?;
300 attrs.last().map_or(expr.span.lo(), |attr| attr.span.hi()),
303 combine_strs_with_missing_comments(context, &attrs_str, &expr_str, span, shape, false)
307 #[derive(new, Clone, Copy)]
308 pub struct PairParts<'a> {
314 pub fn rewrite_pair<LHS, RHS>(
318 context: &RewriteContext,
320 separator_place: SeparatorPlace,
326 let lhs_overhead = match separator_place {
327 SeparatorPlace::Back => shape.used_width() + pp.prefix.len() + pp.infix.trim_right().len(),
328 SeparatorPlace::Front => shape.used_width(),
330 let lhs_shape = Shape {
331 width: context.budget(lhs_overhead),
334 let lhs_result = lhs.rewrite(context, lhs_shape)
335 .map(|lhs_str| format!("{}{}", pp.prefix, lhs_str))?;
337 // Try to the both lhs and rhs on the same line.
338 let rhs_orig_result = shape
339 .offset_left(last_line_width(&lhs_result) + pp.infix.len())
340 .and_then(|s| s.sub_width(pp.suffix.len()))
341 .and_then(|rhs_shape| rhs.rewrite(context, rhs_shape));
342 if let Some(ref rhs_result) = rhs_orig_result {
343 // If the rhs looks like block expression, we allow it to stay on the same line
344 // with the lhs even if it is multi-lined.
345 let allow_same_line = rhs_result
348 .map(|first_line| first_line.ends_with('{'))
350 if !rhs_result.contains('\n') || allow_same_line {
351 let one_line_width = last_line_width(&lhs_result) + pp.infix.len()
352 + first_line_width(rhs_result) + pp.suffix.len();
353 if one_line_width <= shape.width {
356 lhs_result, pp.infix, rhs_result, pp.suffix
362 // We have to use multiple lines.
363 // Re-evaluate the rhs because we have more space now:
364 let mut rhs_shape = match context.config.indent_style() {
365 IndentStyle::Visual => shape
366 .sub_width(pp.suffix.len() + pp.prefix.len())?
367 .visual_indent(pp.prefix.len()),
368 IndentStyle::Block => {
369 // Try to calculate the initial constraint on the right hand side.
370 let rhs_overhead = shape.rhs_overhead(context.config);
371 Shape::indented(shape.indent.block_indent(context.config), context.config)
372 .sub_width(rhs_overhead)?
375 let infix = match separator_place {
376 SeparatorPlace::Back => pp.infix.trim_right(),
377 SeparatorPlace::Front => pp.infix.trim_left(),
379 if separator_place == SeparatorPlace::Front {
380 rhs_shape = rhs_shape.offset_left(infix.len())?;
382 let rhs_result = rhs.rewrite(context, rhs_shape)?;
383 let indent_str = rhs_shape.indent.to_string(context.config);
384 let infix_with_sep = match separator_place {
385 SeparatorPlace::Back => format!("{}\n{}", infix, indent_str),
386 SeparatorPlace::Front => format!("\n{}{}", indent_str, infix),
390 lhs_result, infix_with_sep, rhs_result, pp.suffix
394 pub fn rewrite_array<T: Rewrite + Spanned + ToExpr>(
397 context: &RewriteContext,
399 trailing_comma: bool,
400 ) -> Option<String> {
401 let bracket_size = if context.config.spaces_within_parens_and_brackets() {
407 let nested_shape = match context.config.indent_style() {
408 IndentStyle::Block => shape
410 .block_indent(context.config.tab_spaces())
411 .with_max_width(context.config)
413 IndentStyle::Visual => shape
414 .visual_indent(bracket_size)
415 .sub_width(bracket_size * 2)?,
418 let items = itemize_list(
423 |item| item.span().lo(),
424 |item| item.span().hi(),
425 |item| item.rewrite(context, nested_shape),
429 ).collect::<Vec<_>>();
431 if items.is_empty() {
432 if context.config.spaces_within_parens_and_brackets() {
433 return Some("[ ]".to_string());
435 return Some("[]".to_string());
439 let tactic = array_tactic(context, shape, nested_shape, exprs, &items, bracket_size);
440 let ends_with_newline = tactic.ends_with_newline(context.config.indent_style());
442 let fmt = ListFormatting {
445 trailing_separator: if trailing_comma {
446 SeparatorTactic::Always
447 } else if context.inside_macro && !exprs.is_empty() {
448 let ends_with_bracket = context.snippet(span).ends_with(']');
449 let bracket_offset = if ends_with_bracket { 1 } else { 0 };
450 let snippet = context.snippet(mk_sp(span.lo(), span.hi() - BytePos(bracket_offset)));
451 let last_char_index = snippet.rfind(|c: char| !c.is_whitespace())?;
452 if &snippet[last_char_index..last_char_index + 1] == "," {
453 SeparatorTactic::Always
455 SeparatorTactic::Never
457 } else if context.config.indent_style() == IndentStyle::Visual {
458 SeparatorTactic::Never
460 SeparatorTactic::Vertical
462 separator_place: SeparatorPlace::Back,
464 ends_with_newline: ends_with_newline,
465 preserve_newline: false,
466 config: context.config,
468 let list_str = write_list(&items, &fmt)?;
470 let result = if context.config.indent_style() == IndentStyle::Visual
471 || tactic == DefinitiveListTactic::Horizontal
473 if context.config.spaces_within_parens_and_brackets() && !list_str.is_empty() {
474 format!("[ {} ]", list_str)
476 format!("[{}]", list_str)
481 nested_shape.indent.to_string(context.config),
483 shape.block().indent.to_string(context.config)
490 fn array_tactic<T: Rewrite + Spanned + ToExpr>(
491 context: &RewriteContext,
497 ) -> DefinitiveListTactic {
498 let has_long_item = items
500 .any(|li| li.item.as_ref().map(|s| s.len() > 10).unwrap_or(false));
502 match context.config.indent_style() {
503 IndentStyle::Block => {
504 let tactic = match shape.width.checked_sub(2 * bracket_size) {
506 let tactic = ListTactic::LimitedHorizontalVertical(
507 context.config.width_heuristics().array_width,
509 definitive_tactic(items, tactic, Separator::Comma, width)
511 None => DefinitiveListTactic::Vertical,
513 if tactic == DefinitiveListTactic::Vertical && !has_long_item
514 && is_every_args_simple(exprs)
516 DefinitiveListTactic::Mixed
521 IndentStyle::Visual => {
522 if has_long_item || items.iter().any(ListItem::is_multiline) {
525 ListTactic::LimitedHorizontalVertical(
526 context.config.width_heuristics().array_width,
532 DefinitiveListTactic::Mixed
538 fn nop_block_collapse(block_str: Option<String>, budget: usize) -> Option<String> {
539 debug!("nop_block_collapse {:?} {}", block_str, budget);
540 block_str.map(|block_str| {
541 if block_str.starts_with('{') && budget >= 2
542 && (block_str[1..].find(|c: char| !c.is_whitespace()).unwrap() == block_str.len() - 2)
551 fn rewrite_empty_block(
552 context: &RewriteContext,
555 ) -> Option<String> {
556 if block.stmts.is_empty() && !block_contains_comment(block, context.codemap) && shape.width >= 2
558 return Some("{}".to_owned());
561 // If a block contains only a single-line comment, then leave it on one line.
562 let user_str = context.snippet(block.span);
563 let user_str = user_str.trim();
564 if user_str.starts_with('{') && user_str.ends_with('}') {
565 let comment_str = user_str[1..user_str.len() - 1].trim();
566 if block.stmts.is_empty() && !comment_str.contains('\n') && !comment_str.starts_with("//")
567 && comment_str.len() + 4 <= shape.width
569 return Some(format!("{{ {} }}", comment_str));
576 fn block_prefix(context: &RewriteContext, block: &ast::Block, shape: Shape) -> Option<String> {
577 Some(match block.rules {
578 ast::BlockCheckMode::Unsafe(..) => {
579 let snippet = context.snippet(block.span);
580 let open_pos = snippet.find_uncommented("{")?;
581 // Extract comment between unsafe and block start.
582 let trimmed = &snippet[6..open_pos].trim();
584 if !trimmed.is_empty() {
585 // 9 = "unsafe {".len(), 7 = "unsafe ".len()
586 let budget = shape.width.checked_sub(9)?;
592 Shape::legacy(budget, shape.indent + 7),
600 ast::BlockCheckMode::Default => String::new(),
604 fn rewrite_single_line_block(
605 context: &RewriteContext,
609 ) -> Option<String> {
610 if is_simple_block(block, context.codemap) {
611 let expr_shape = shape.offset_left(last_line_width(prefix))?;
612 let expr_str = block.stmts[0].rewrite(context, expr_shape)?;
613 let result = format!("{}{{ {} }}", prefix, expr_str);
614 if result.len() <= shape.width && !result.contains('\n') {
621 pub fn rewrite_block_with_visitor(
622 context: &RewriteContext,
627 ) -> Option<String> {
628 if let rw @ Some(_) = rewrite_empty_block(context, block, shape) {
632 let mut visitor = FmtVisitor::from_context(context);
633 visitor.block_indent = shape.indent;
634 visitor.is_if_else_block = context.is_if_else_block;
636 ast::BlockCheckMode::Unsafe(..) => {
637 let snippet = context.snippet(block.span);
638 let open_pos = snippet.find_uncommented("{")?;
639 visitor.last_pos = block.span.lo() + BytePos(open_pos as u32)
641 ast::BlockCheckMode::Default => visitor.last_pos = block.span.lo(),
644 visitor.visit_block(block, None, has_braces);
645 Some(format!("{}{}", prefix, visitor.buffer))
648 impl Rewrite for ast::Block {
649 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
650 // shape.width is used only for the single line case: either the empty block `{}`,
651 // or an unsafe expression `unsafe { e }`.
652 if let rw @ Some(_) = rewrite_empty_block(context, self, shape) {
656 let prefix = block_prefix(context, self, shape)?;
658 let result = rewrite_block_with_visitor(context, &prefix, self, shape, true);
659 if let Some(ref result_str) = result {
660 if result_str.lines().count() <= 3 {
661 if let rw @ Some(_) = rewrite_single_line_block(context, &prefix, self, shape) {
671 impl Rewrite for ast::Stmt {
672 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
673 skip_out_of_file_lines_range!(context, self.span());
675 let result = match self.node {
676 ast::StmtKind::Local(ref local) => local.rewrite(context, shape),
677 ast::StmtKind::Expr(ref ex) | ast::StmtKind::Semi(ref ex) => {
678 let suffix = if semicolon_for_stmt(context, self) {
684 let shape = shape.sub_width(suffix.len())?;
685 format_expr(ex, ExprType::Statement, context, shape).map(|s| s + suffix)
687 ast::StmtKind::Mac(..) | ast::StmtKind::Item(..) => None,
689 result.and_then(|res| recover_comment_removed(res, self.span(), context))
693 // Rewrite condition if the given expression has one.
694 pub fn rewrite_cond(context: &RewriteContext, expr: &ast::Expr, shape: Shape) -> Option<String> {
696 ast::ExprKind::Match(ref cond, _) => {
698 let cond_shape = match context.config.indent_style() {
699 IndentStyle::Visual => shape.shrink_left(6).and_then(|s| s.sub_width(2))?,
700 IndentStyle::Block => shape.offset_left(8)?,
702 cond.rewrite(context, cond_shape)
704 _ => to_control_flow(expr, ExprType::SubExpression).and_then(|control_flow| {
706 String::from("\n") + &shape.indent.block_only().to_string(context.config);
708 .rewrite_cond(context, shape, &alt_block_sep)
709 .and_then(|rw| Some(rw.0))
714 // Abstraction over control flow expressions
716 struct ControlFlow<'a> {
717 cond: Option<&'a ast::Expr>,
718 block: &'a ast::Block,
719 else_block: Option<&'a ast::Expr>,
720 label: Option<ast::SpannedIdent>,
721 pat: Option<&'a ast::Pat>,
725 allow_single_line: bool,
726 // True if this is an `if` expression in an `else if` :-( hacky
731 fn to_control_flow(expr: &ast::Expr, expr_type: ExprType) -> Option<ControlFlow> {
733 ast::ExprKind::If(ref cond, ref if_block, ref else_block) => Some(ControlFlow::new_if(
737 else_block.as_ref().map(|e| &**e),
738 expr_type == ExprType::SubExpression,
742 ast::ExprKind::IfLet(ref pat, ref cond, ref if_block, ref else_block) => {
743 Some(ControlFlow::new_if(
747 else_block.as_ref().map(|e| &**e),
748 expr_type == ExprType::SubExpression,
753 ast::ExprKind::ForLoop(ref pat, ref cond, ref block, label) => {
754 Some(ControlFlow::new_for(pat, cond, block, label, expr.span))
756 ast::ExprKind::Loop(ref block, label) => {
757 Some(ControlFlow::new_loop(block, label, expr.span))
759 ast::ExprKind::While(ref cond, ref block, label) => {
760 Some(ControlFlow::new_while(None, cond, block, label, expr.span))
762 ast::ExprKind::WhileLet(ref pat, ref cond, ref block, label) => Some(
763 ControlFlow::new_while(Some(pat), cond, block, label, expr.span),
769 impl<'a> ControlFlow<'a> {
772 pat: Option<&'a ast::Pat>,
773 block: &'a ast::Block,
774 else_block: Option<&'a ast::Expr>,
775 allow_single_line: bool,
778 ) -> ControlFlow<'a> {
782 else_block: else_block,
791 allow_single_line: allow_single_line,
792 nested_if: nested_if,
798 block: &'a ast::Block,
799 label: Option<ast::SpannedIdent>,
801 ) -> ControlFlow<'a> {
811 allow_single_line: false,
818 pat: Option<&'a ast::Pat>,
820 block: &'a ast::Block,
821 label: Option<ast::SpannedIdent>,
823 ) -> ControlFlow<'a> {
836 allow_single_line: false,
845 block: &'a ast::Block,
846 label: Option<ast::SpannedIdent>,
848 ) -> ControlFlow<'a> {
858 allow_single_line: false,
864 fn rewrite_single_line(
867 context: &RewriteContext,
869 ) -> Option<String> {
870 assert!(self.allow_single_line);
871 let else_block = self.else_block?;
872 let fixed_cost = self.keyword.len() + " { } else { }".len();
874 if let ast::ExprKind::Block(ref else_node) = else_block.node {
875 if !is_simple_block(self.block, context.codemap)
876 || !is_simple_block(else_node, context.codemap)
877 || pat_expr_str.contains('\n')
882 let new_width = width.checked_sub(pat_expr_str.len() + fixed_cost)?;
883 let expr = &self.block.stmts[0];
884 let if_str = expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;
886 let new_width = new_width.checked_sub(if_str.len())?;
887 let else_expr = &else_node.stmts[0];
888 let else_str = else_expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;
890 if if_str.contains('\n') || else_str.contains('\n') {
894 let result = format!(
895 "{} {} {{ {} }} else {{ {} }}",
896 self.keyword, pat_expr_str, if_str, else_str
899 if result.len() <= width {
908 impl<'a> ControlFlow<'a> {
911 context: &RewriteContext,
914 ) -> Option<(String, usize)> {
915 // Do not take the rhs overhead from the upper expressions into account
916 // when rewriting pattern.
917 let new_width = context
920 .checked_sub(shape.used_width())
922 let fresh_shape = Shape {
926 let constr_shape = if self.nested_if {
927 // We are part of an if-elseif-else chain. Our constraints are tightened.
928 // 7 = "} else " .len()
929 fresh_shape.offset_left(7)?
934 let label_string = rewrite_label(self.label);
935 // 1 = space after keyword.
936 let offset = self.keyword.len() + label_string.len() + 1;
938 let pat_expr_string = match self.cond {
939 Some(cond) => rewrite_pat_expr(
949 None => String::new(),
953 if context.config.control_brace_style() != ControlBraceStyle::AlwaysNextLine {
959 let one_line_budget = context
962 .checked_sub(constr_shape.used_width() + offset + brace_overhead)
964 let force_newline_brace = (pat_expr_string.contains('\n')
965 || pat_expr_string.len() > one_line_budget)
966 && !last_line_extendable(&pat_expr_string);
968 // Try to format if-else on single line.
969 if self.allow_single_line
973 .single_line_if_else_max_width > 0
975 let trial = self.rewrite_single_line(&pat_expr_string, context, shape.width);
977 if let Some(cond_str) = trial {
982 .single_line_if_else_max_width
984 return Some((cond_str, 0));
989 let cond_span = if let Some(cond) = self.cond {
992 mk_sp(self.block.span.lo(), self.block.span.lo())
995 // `for event in event`
996 // Do not include label in the span.
997 let lo = self.label.map_or(self.span.lo(), |label| label.span.hi());
998 let between_kwd_cond = mk_sp(
1001 .span_after(mk_sp(lo, self.span.hi()), self.keyword.trim()),
1002 self.pat.map_or(cond_span.lo(), |p| {
1003 if self.matcher.is_empty() {
1006 context.codemap.span_before(self.span, self.matcher.trim())
1011 let between_kwd_cond_comment = extract_comment(between_kwd_cond, context, shape);
1013 let after_cond_comment =
1014 extract_comment(mk_sp(cond_span.hi(), self.block.span.lo()), context, shape);
1016 let block_sep = if self.cond.is_none() && between_kwd_cond_comment.is_some() {
1018 } else if context.config.control_brace_style() == ControlBraceStyle::AlwaysNextLine
1019 || force_newline_brace
1026 let used_width = if pat_expr_string.contains('\n') {
1027 last_line_width(&pat_expr_string)
1029 // 2 = spaces after keyword and condition.
1030 label_string.len() + self.keyword.len() + pat_expr_string.len() + 2
1038 between_kwd_cond_comment.as_ref().map_or(
1039 if pat_expr_string.is_empty() || pat_expr_string.starts_with('\n') {
1047 after_cond_comment.as_ref().map_or(block_sep, |s| &**s)
1054 impl<'a> Rewrite for ControlFlow<'a> {
1055 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1056 debug!("ControlFlow::rewrite {:?} {:?}", self, shape);
1058 let alt_block_sep = String::from("\n") + &shape.indent.to_string(context.config);
1059 let (cond_str, used_width) = self.rewrite_cond(context, shape, &alt_block_sep)?;
1060 // If `used_width` is 0, it indicates that whole control flow is written in a single line.
1061 if used_width == 0 {
1062 return Some(cond_str);
1065 let block_width = shape.width.checked_sub(used_width).unwrap_or(0);
1066 // This is used only for the empty block case: `{}`. So, we use 1 if we know
1067 // we should avoid the single line case.
1068 let block_width = if self.else_block.is_some() || self.nested_if {
1073 let block_shape = Shape {
1077 let mut block_context = context.clone();
1078 block_context.is_if_else_block = self.else_block.is_some();
1080 rewrite_block_with_visitor(&block_context, "", self.block, block_shape, true)?;
1082 let mut result = format!("{}{}", cond_str, block_str);
1084 if let Some(else_block) = self.else_block {
1085 let shape = Shape::indented(shape.indent, context.config);
1086 let mut last_in_chain = false;
1087 let rewrite = match else_block.node {
1088 // If the else expression is another if-else expression, prevent it
1089 // from being formatted on a single line.
1090 // Note how we're passing the original shape, as the
1091 // cost of "else" should not cascade.
1092 ast::ExprKind::IfLet(ref pat, ref cond, ref if_block, ref next_else_block) => {
1093 ControlFlow::new_if(
1097 next_else_block.as_ref().map(|e| &**e),
1100 mk_sp(else_block.span.lo(), self.span.hi()),
1101 ).rewrite(context, shape)
1103 ast::ExprKind::If(ref cond, ref if_block, ref next_else_block) => {
1104 ControlFlow::new_if(
1108 next_else_block.as_ref().map(|e| &**e),
1111 mk_sp(else_block.span.lo(), self.span.hi()),
1112 ).rewrite(context, shape)
1115 last_in_chain = true;
1116 // When rewriting a block, the width is only used for single line
1117 // blocks, passing 1 lets us avoid that.
1118 let else_shape = Shape {
1119 width: min(1, shape.width),
1122 format_expr(else_block, ExprType::Statement, context, else_shape)
1126 let between_kwd_else_block = mk_sp(
1127 self.block.span.hi(),
1130 .span_before(mk_sp(self.block.span.hi(), else_block.span.lo()), "else"),
1132 let between_kwd_else_block_comment =
1133 extract_comment(between_kwd_else_block, context, shape);
1135 let after_else = mk_sp(
1138 .span_after(mk_sp(self.block.span.hi(), else_block.span.lo()), "else"),
1139 else_block.span.lo(),
1141 let after_else_comment = extract_comment(after_else, context, shape);
1143 let between_sep = match context.config.control_brace_style() {
1144 ControlBraceStyle::AlwaysNextLine | ControlBraceStyle::ClosingNextLine => {
1147 ControlBraceStyle::AlwaysSameLine => " ",
1149 let after_sep = match context.config.control_brace_style() {
1150 ControlBraceStyle::AlwaysNextLine if last_in_chain => &*alt_block_sep,
1154 result.push_str(&format!(
1156 between_kwd_else_block_comment
1158 .map_or(between_sep, |s| &**s),
1159 after_else_comment.as_ref().map_or(after_sep, |s| &**s),
1161 result.push_str(&rewrite?);
1168 fn rewrite_label(label: Option<ast::SpannedIdent>) -> Cow<'static, str> {
1170 Some(ident) => Cow::from(format!("{}: ", ident.node)),
1171 None => Cow::from(""),
1175 fn extract_comment(span: Span, context: &RewriteContext, shape: Shape) -> Option<String> {
1176 match rewrite_missing_comment(span, shape, context) {
1177 Some(ref comment) if !comment.is_empty() => Some(format!(
1178 "\n{indent}{}\n{indent}",
1180 indent = shape.indent.to_string(context.config)
1186 pub fn block_contains_comment(block: &ast::Block, codemap: &CodeMap) -> bool {
1187 let snippet = codemap.span_to_snippet(block.span).unwrap();
1188 contains_comment(&snippet)
1191 // Checks that a block contains no statements, an expression and no comments.
1192 // FIXME: incorrectly returns false when comment is contained completely within
1194 pub fn is_simple_block(block: &ast::Block, codemap: &CodeMap) -> bool {
1195 (block.stmts.len() == 1 && stmt_is_expr(&block.stmts[0])
1196 && !block_contains_comment(block, codemap))
1199 /// Checks whether a block contains at most one statement or expression, and no comments.
1200 pub fn is_simple_block_stmt(block: &ast::Block, codemap: &CodeMap) -> bool {
1201 block.stmts.len() <= 1 && !block_contains_comment(block, codemap)
1204 /// Checks whether a block contains no statements, expressions, or comments.
1205 pub fn is_empty_block(block: &ast::Block, codemap: &CodeMap) -> bool {
1206 block.stmts.is_empty() && !block_contains_comment(block, codemap)
1209 pub fn stmt_is_expr(stmt: &ast::Stmt) -> bool {
1211 ast::StmtKind::Expr(..) => true,
1216 pub fn is_unsafe_block(block: &ast::Block) -> bool {
1217 if let ast::BlockCheckMode::Unsafe(..) = block.rules {
1224 // A simple wrapper type against ast::Arm. Used inside write_list().
1225 struct ArmWrapper<'a> {
1226 pub arm: &'a ast::Arm,
1227 // True if the arm is the last one in match expression. Used to decide on whether we should add
1228 // trailing comma to the match arm when `config.trailing_comma() == Never`.
1232 impl<'a> ArmWrapper<'a> {
1233 pub fn new(arm: &'a ast::Arm, is_last: bool) -> ArmWrapper<'a> {
1234 ArmWrapper { arm, is_last }
1238 impl<'a> Rewrite for ArmWrapper<'a> {
1239 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1240 rewrite_match_arm(context, self.arm, shape, self.is_last)
1245 context: &RewriteContext,
1250 attrs: &[ast::Attribute],
1251 ) -> Option<String> {
1252 // Do not take the rhs overhead from the upper expressions into account
1253 // when rewriting match condition.
1254 let cond_shape = Shape {
1255 width: context.budget(shape.used_width()),
1259 let cond_shape = match context.config.indent_style() {
1260 IndentStyle::Visual => cond_shape.shrink_left(6)?,
1261 IndentStyle::Block => cond_shape.offset_left(6)?,
1263 let cond_str = cond.rewrite(context, cond_shape)?;
1264 let alt_block_sep = String::from("\n") + &shape.indent.to_string(context.config);
1265 let block_sep = match context.config.control_brace_style() {
1266 ControlBraceStyle::AlwaysNextLine => &alt_block_sep,
1267 _ if last_line_extendable(&cond_str) => " ",
1269 _ if cond_str.contains('\n') || cond_str.len() + 2 > cond_shape.width => &alt_block_sep,
1273 let nested_indent_str = shape
1275 .block_indent(context.config)
1276 .to_string(context.config);
1277 // Inner attributes.
1278 let inner_attrs = &inner_attributes(attrs);
1279 let inner_attrs_str = if inner_attrs.is_empty() {
1283 .rewrite(context, shape)
1284 .map(|s| format!("{}{}\n", nested_indent_str, s))?
1287 let open_brace_pos = if inner_attrs.is_empty() {
1288 let hi = if arms.is_empty() {
1293 context.codemap.span_after(mk_sp(cond.span.hi(), hi), "{")
1295 inner_attrs[inner_attrs.len() - 1].span().hi()
1298 if arms.is_empty() {
1299 let snippet = context.snippet(mk_sp(open_brace_pos, span.hi() - BytePos(1)));
1300 if snippet.trim().is_empty() {
1301 Some(format!("match {} {{}}", cond_str))
1303 // Empty match with comments or inner attributes? We are not going to bother, sorry ;)
1304 Some(context.snippet(span).to_owned())
1308 "match {}{}{{\n{}{}{}\n{}}}",
1313 rewrite_match_arms(context, arms, shape, span, open_brace_pos)?,
1314 shape.indent.to_string(context.config),
1319 fn arm_comma(config: &Config, body: &ast::Expr, is_last: bool) -> &'static str {
1320 if is_last && config.trailing_comma() == SeparatorTactic::Never {
1322 } else if config.match_block_trailing_comma() {
1324 } else if let ast::ExprKind::Block(ref block) = body.node {
1325 if let ast::BlockCheckMode::Default = block.rules {
1335 fn rewrite_match_arms(
1336 context: &RewriteContext,
1340 open_brace_pos: BytePos,
1341 ) -> Option<String> {
1342 let arm_shape = shape
1343 .block_indent(context.config.tab_spaces())
1344 .with_max_width(context.config);
1346 let arm_len = arms.len();
1347 let is_last_iter = repeat(false)
1348 .take(arm_len.checked_sub(1).unwrap_or(0))
1349 .chain(repeat(true));
1350 let items = itemize_list(
1354 .map(|(arm, is_last)| ArmWrapper::new(arm, is_last)),
1357 |arm| arm.arm.span().lo(),
1358 |arm| arm.arm.span().hi(),
1359 |arm| arm.rewrite(context, arm_shape),
1364 let arms_vec: Vec<_> = items.collect();
1365 let fmt = ListFormatting {
1366 tactic: DefinitiveListTactic::Vertical,
1367 // We will add/remove commas inside `arm.rewrite()`, and hence no separator here.
1369 trailing_separator: SeparatorTactic::Never,
1370 separator_place: SeparatorPlace::Back,
1372 ends_with_newline: true,
1373 preserve_newline: true,
1374 config: context.config,
1377 write_list(&arms_vec, &fmt)
1380 fn rewrite_match_arm(
1381 context: &RewriteContext,
1385 ) -> Option<String> {
1386 let (missing_span, attrs_str) = if !arm.attrs.is_empty() {
1387 if contains_skip(&arm.attrs) {
1388 let (_, body) = flatten_arm_body(context, &arm.body);
1389 // `arm.span()` does not include trailing comma, add it manually.
1390 return Some(format!(
1392 context.snippet(arm.span()),
1393 arm_comma(context.config, body, is_last),
1396 let missing_span = mk_sp(
1397 arm.attrs[arm.attrs.len() - 1].span.hi(),
1398 arm.pats[0].span.lo(),
1400 (missing_span, arm.attrs.rewrite(context, shape)?)
1402 (mk_sp(arm.span().lo(), arm.span().lo()), String::new())
1405 rewrite_match_pattern(context, &arm.pats, &arm.guard, shape).and_then(|pats_str| {
1406 combine_strs_with_missing_comments(
1420 arm.guard.is_some(),
1425 /// Returns true if the given pattern is short. A short pattern is defined by the following grammer:
1429 /// - `&[single-line, ntp]`
1432 /// - `[small, ntp]`
1433 /// - unary tuple constructor `([small, ntp])`
1435 fn is_short_pattern(pat: &ast::Pat, pat_str: &str) -> bool {
1436 // We also require that the pattern is reasonably 'small' with its literal width.
1437 pat_str.len() <= 20 && !pat_str.contains('\n') && is_short_pattern_inner(pat)
1440 fn is_short_pattern_inner(pat: &ast::Pat) -> bool {
1442 ast::PatKind::Wild | ast::PatKind::Lit(_) => true,
1443 ast::PatKind::Ident(_, _, ref pat) => pat.is_none(),
1444 ast::PatKind::Struct(..)
1445 | ast::PatKind::Mac(..)
1446 | ast::PatKind::Slice(..)
1447 | ast::PatKind::Path(..)
1448 | ast::PatKind::Range(..) => false,
1449 ast::PatKind::Tuple(ref subpats, _) => subpats.len() <= 1,
1450 ast::PatKind::TupleStruct(ref path, ref subpats, _) => {
1451 path.segments.len() <= 1 && subpats.len() <= 1
1453 ast::PatKind::Box(ref p) | ast::PatKind::Ref(ref p, _) => is_short_pattern_inner(&*p),
1457 fn rewrite_match_pattern(
1458 context: &RewriteContext,
1459 pats: &[ptr::P<ast::Pat>],
1460 guard: &Option<ptr::P<ast::Expr>>,
1462 ) -> Option<String> {
1465 let pat_shape = shape.sub_width(5)?;
1467 let pat_strs = pats.iter()
1468 .map(|p| p.rewrite(context, pat_shape))
1469 .collect::<Option<Vec<_>>>()?;
1471 let use_mixed_layout = pats.iter()
1472 .zip(pat_strs.iter())
1473 .all(|(pat, pat_str)| is_short_pattern(pat, pat_str));
1474 let items: Vec<_> = pat_strs.into_iter().map(ListItem::from_str).collect();
1475 let tactic = if use_mixed_layout {
1476 DefinitiveListTactic::Mixed
1480 ListTactic::HorizontalVertical,
1481 Separator::VerticalBar,
1485 let fmt = ListFormatting {
1488 trailing_separator: SeparatorTactic::Never,
1489 separator_place: context.config.binop_separator(),
1491 ends_with_newline: false,
1492 preserve_newline: false,
1493 config: context.config,
1495 let pats_str = write_list(&items, &fmt)?;
1498 let guard_str = rewrite_guard(context, guard, shape, trimmed_last_line_width(&pats_str))?;
1500 Some(format!("{}{}", pats_str, guard_str))
1504 // @extend: true if the arm body can be put next to `=>`
1505 // @body: flattened body, if the body is block with a single expression
1506 fn flatten_arm_body<'a>(context: &'a RewriteContext, body: &'a ast::Expr) -> (bool, &'a ast::Expr) {
1508 ast::ExprKind::Block(ref block)
1509 if !is_unsafe_block(block) && is_simple_block(block, context.codemap) =>
1511 if let ast::StmtKind::Expr(ref expr) = block.stmts[0].node {
1513 !context.config.force_multiline_blocks() && can_extend_match_arm_body(expr),
1521 !context.config.force_multiline_blocks() && body.can_be_overflowed(context, 1),
1527 fn rewrite_match_body(
1528 context: &RewriteContext,
1529 body: &ptr::P<ast::Expr>,
1534 ) -> Option<String> {
1535 let (extend, body) = flatten_arm_body(context, body);
1536 let (is_block, is_empty_block) = if let ast::ExprKind::Block(ref block) = body.node {
1537 (true, is_empty_block(block, context.codemap))
1542 let comma = arm_comma(context.config, body, is_last);
1543 let alt_block_sep = String::from("\n") + &shape.indent.to_string(context.config);
1544 let alt_block_sep = alt_block_sep.as_str();
1546 let combine_orig_body = |body_str: &str| {
1547 let block_sep = match context.config.control_brace_style() {
1548 ControlBraceStyle::AlwaysNextLine if is_block => alt_block_sep,
1552 Some(format!("{} =>{}{}{}", pats_str, block_sep, body_str, comma))
1555 let forbid_same_line = has_guard && pats_str.contains('\n') && !is_empty_block;
1556 let next_line_indent = if !is_block || is_empty_block {
1557 shape.indent.block_indent(context.config)
1561 let combine_next_line_body = |body_str: &str| {
1563 return Some(format!(
1566 next_line_indent.to_string(context.config),
1571 let indent_str = shape.indent.to_string(context.config);
1572 let nested_indent_str = next_line_indent.to_string(context.config);
1573 let (body_prefix, body_suffix) = if context.config.match_arm_blocks() {
1574 let comma = if context.config.match_block_trailing_comma() {
1579 ("{", format!("\n{}}}{}", indent_str, comma))
1581 ("", String::from(","))
1584 let block_sep = match context.config.control_brace_style() {
1585 ControlBraceStyle::AlwaysNextLine => format!("{}{}\n", alt_block_sep, body_prefix),
1586 _ if body_prefix.is_empty() => "\n".to_owned(),
1587 _ if forbid_same_line => format!("{}{}\n", alt_block_sep, body_prefix),
1588 _ => format!(" {}\n", body_prefix),
1589 } + &nested_indent_str;
1593 pats_str, block_sep, body_str, body_suffix
1597 // Let's try and get the arm body on the same line as the condition.
1599 let orig_body_shape = shape
1600 .offset_left(extra_offset(pats_str, shape) + 4)
1601 .and_then(|shape| shape.sub_width(comma.len()));
1602 let orig_body = if let Some(body_shape) = orig_body_shape {
1603 let rewrite = nop_block_collapse(
1604 format_expr(body, ExprType::Statement, context, body_shape),
1610 if !forbid_same_line
1612 || (!body_str.contains('\n') && body_str.len() <= body_shape.width)) =>
1614 return combine_orig_body(body_str);
1621 let orig_budget = orig_body_shape.map_or(0, |shape| shape.width);
1623 // Try putting body on the next line and see if it looks better.
1624 let next_line_body_shape = Shape::indented(next_line_indent, context.config);
1625 let next_line_body = nop_block_collapse(
1626 format_expr(body, ExprType::Statement, context, next_line_body_shape),
1627 next_line_body_shape.width,
1629 match (orig_body, next_line_body) {
1630 (Some(ref orig_str), Some(ref next_line_str))
1631 if forbid_same_line || prefer_next_line(orig_str, next_line_str) =>
1633 combine_next_line_body(next_line_str)
1635 (Some(ref orig_str), _) if extend && first_line_width(orig_str) <= orig_budget => {
1636 combine_orig_body(orig_str)
1638 (Some(ref orig_str), Some(ref next_line_str)) if orig_str.contains('\n') => {
1639 combine_next_line_body(next_line_str)
1641 (None, Some(ref next_line_str)) => combine_next_line_body(next_line_str),
1642 (None, None) => None,
1643 (Some(ref orig_str), _) => combine_orig_body(orig_str),
1647 // The `if ...` guard on a match arm.
1649 context: &RewriteContext,
1650 guard: &Option<ptr::P<ast::Expr>>,
1652 // The amount of space used up on this line for the pattern in
1653 // the arm (excludes offset).
1654 pattern_width: usize,
1655 ) -> Option<String> {
1656 if let Some(ref guard) = *guard {
1657 // First try to fit the guard string on the same line as the pattern.
1658 // 4 = ` if `, 5 = ` => {`
1659 let cond_shape = shape
1660 .offset_left(pattern_width + 4)
1661 .and_then(|s| s.sub_width(5));
1662 if let Some(cond_shape) = cond_shape {
1663 if let Some(cond_str) = guard.rewrite(context, cond_shape) {
1664 if !cond_str.contains('\n') || pattern_width <= context.config.tab_spaces() {
1665 return Some(format!(" if {}", cond_str));
1670 // Not enough space to put the guard after the pattern, try a newline.
1671 // 3 = `if `, 5 = ` => {`
1672 let cond_shape = Shape::indented(shape.indent.block_indent(context.config), context.config)
1674 .and_then(|s| s.sub_width(5));
1675 if let Some(cond_shape) = cond_shape {
1676 if let Some(cond_str) = guard.rewrite(context, cond_shape) {
1677 return Some(format!(
1679 cond_shape.indent.to_string(context.config),
1691 fn rewrite_pat_expr(
1692 context: &RewriteContext,
1693 pat: Option<&ast::Pat>,
1696 // Connecting piece between pattern and expression,
1697 // *without* trailing space.
1702 ) -> Option<String> {
1703 debug!("rewrite_pat_expr {:?} {:?} {:?}", shape, pat, expr);
1704 let cond_shape = shape.offset_left(offset)?;
1705 if let Some(pat) = pat {
1706 let matcher = if matcher.is_empty() {
1709 format!("{} ", matcher)
1711 let pat_shape = cond_shape
1712 .offset_left(matcher.len())?
1713 .sub_width(connector.len())?;
1714 let pat_string = pat.rewrite(context, pat_shape)?;
1715 let result = format!("{}{}{}", matcher, pat_string, connector);
1716 return rewrite_assign_rhs(context, result, expr, cond_shape);
1719 let expr_rw = expr.rewrite(context, cond_shape);
1720 // The expression may (partially) fit on the current line.
1721 // We do not allow splitting between `if` and condition.
1722 if keyword == "if" || expr_rw.is_some() {
1726 // The expression won't fit on the current line, jump to next.
1727 let nested_shape = shape
1728 .block_indent(context.config.tab_spaces())
1729 .with_max_width(context.config);
1730 let nested_indent_str = nested_shape.indent.to_string(context.config);
1731 expr.rewrite(context, nested_shape)
1732 .map(|expr_rw| format!("\n{}{}", nested_indent_str, expr_rw))
1735 fn can_extend_match_arm_body(body: &ast::Expr) -> bool {
1737 // We do not allow `if` to stay on the same line, since we could easily mistake
1738 // `pat => if cond { ... }` and `pat if cond => { ... }`.
1739 ast::ExprKind::If(..) | ast::ExprKind::IfLet(..) => false,
1740 ast::ExprKind::ForLoop(..)
1741 | ast::ExprKind::Loop(..)
1742 | ast::ExprKind::While(..)
1743 | ast::ExprKind::WhileLet(..)
1744 | ast::ExprKind::Match(..)
1745 | ast::ExprKind::Block(..)
1746 | ast::ExprKind::Closure(..)
1747 | ast::ExprKind::Array(..)
1748 | ast::ExprKind::Call(..)
1749 | ast::ExprKind::MethodCall(..)
1750 | ast::ExprKind::Mac(..)
1751 | ast::ExprKind::Struct(..)
1752 | ast::ExprKind::Tup(..) => true,
1753 ast::ExprKind::AddrOf(_, ref expr)
1754 | ast::ExprKind::Box(ref expr)
1755 | ast::ExprKind::Try(ref expr)
1756 | ast::ExprKind::Unary(_, ref expr)
1757 | ast::ExprKind::Cast(ref expr, _) => can_extend_match_arm_body(expr),
1762 pub fn rewrite_literal(context: &RewriteContext, l: &ast::Lit, shape: Shape) -> Option<String> {
1764 ast::LitKind::Str(_, ast::StrStyle::Cooked) => rewrite_string_lit(context, l.span, shape),
1766 context.snippet(l.span).to_owned(),
1767 context.config.max_width(),
1773 fn rewrite_string_lit(context: &RewriteContext, span: Span, shape: Shape) -> Option<String> {
1774 let string_lit = context.snippet(span);
1776 if !context.config.format_strings() {
1781 .all(|line| line.ends_with('\\'))
1783 let new_indent = shape.visual_indent(1).indent;
1784 let indented_string_lit = String::from(
1790 new_indent.to_string(context.config),
1794 .collect::<Vec<_>>()
1798 return wrap_str(indented_string_lit, context.config.max_width(), shape);
1800 return wrap_str(string_lit.to_owned(), context.config.max_width(), shape);
1804 // Remove the quote characters.
1805 let str_lit = &string_lit[1..string_lit.len() - 1];
1809 &StringFormat::new(shape.visual_indent(0), context.config),
1814 /// A list of `format!`-like macros, that take a long format string and a list of arguments to
1817 /// Organized as a list of `(&str, usize)` tuples, giving the name of the macro and the number of
1818 /// arguments before the format string (none for `format!("format", ...)`, one for `assert!(result,
1819 /// "format", ...)`, two for `assert_eq!(left, right, "format", ...)`).
1820 const SPECIAL_MACRO_WHITELIST: &[(&str, usize)] = &[
1821 // format! like macros
1822 // From the Rust Standard Library.
1826 ("format_args!", 0),
1830 ("unreachable!", 0),
1831 // From the `log` crate.
1836 // write! like macros
1838 ("debug_assert!", 1),
1841 // assert_eq! like macros
1844 ("debug_assert_eq!", 2),
1845 ("debug_assert_ne!", 2),
1848 pub fn rewrite_call(
1849 context: &RewriteContext,
1851 args: &[ptr::P<ast::Expr>],
1854 ) -> Option<String> {
1855 let force_trailing_comma = if context.inside_macro {
1856 span_ends_with_comma(context, span)
1863 &ptr_vec_to_ref_vec(args),
1866 context.config.width_heuristics().fn_call_width,
1867 force_trailing_comma,
1871 pub fn rewrite_call_inner<'a, T>(
1872 context: &RewriteContext,
1877 args_max_width: usize,
1878 force_trailing_comma: bool,
1881 T: Rewrite + Spanned + ToExpr + 'a,
1883 // 2 = `( `, 1 = `(`
1884 let paren_overhead = if context.config.spaces_within_parens_and_brackets() {
1889 let used_width = extra_offset(callee_str, shape);
1890 let one_line_width = shape.width.checked_sub(used_width + 2 * paren_overhead)?;
1893 let one_line_shape = shape
1894 .offset_left(last_line_width(callee_str) + 1)?
1896 let nested_shape = shape_from_indent_style(
1899 used_width + 2 * paren_overhead,
1900 used_width + paren_overhead,
1903 let span_lo = context.codemap.span_after(span, "(");
1904 let args_span = mk_sp(span_lo, span.hi());
1906 let (extendable, list_str) = rewrite_call_args(
1914 force_trailing_comma,
1918 if !context.use_block_indent() && need_block_indent(&list_str, nested_shape) && !extendable {
1919 let mut new_context = context.clone();
1920 new_context.use_block = true;
1921 return rewrite_call_inner(
1928 force_trailing_comma,
1932 let args_shape = shape.sub_width(last_line_width(callee_str))?;
1936 wrap_args_with_parens(context, &list_str, extendable, args_shape, nested_shape)
1940 fn need_block_indent(s: &str, shape: Shape) -> bool {
1941 s.lines().skip(1).any(|s| {
1942 s.find(|c| !char::is_whitespace(c))
1943 .map_or(false, |w| w + 1 < shape.indent.width())
1947 fn rewrite_call_args<'a, T>(
1948 context: &RewriteContext,
1951 one_line_shape: Shape,
1952 nested_shape: Shape,
1953 one_line_width: usize,
1954 args_max_width: usize,
1955 force_trailing_comma: bool,
1957 ) -> Option<(bool, String)>
1959 T: Rewrite + Spanned + ToExpr + 'a,
1961 let items = itemize_list(
1966 |item| item.span().lo(),
1967 |item| item.span().hi(),
1968 |item| item.rewrite(context, nested_shape),
1973 let mut item_vec: Vec<_> = items.collect();
1975 // Try letting the last argument overflow to the next line with block
1976 // indentation. If its first line fits on one line with the other arguments,
1977 // we format the function arguments horizontally.
1978 let tactic = try_overflow_last_arg(
1989 let fmt = ListFormatting {
1992 trailing_separator: if force_trailing_comma {
1993 SeparatorTactic::Always
1994 } else if context.inside_macro || !context.use_block_indent() {
1995 SeparatorTactic::Never
1997 context.config.trailing_comma()
1999 separator_place: SeparatorPlace::Back,
2000 shape: nested_shape,
2001 ends_with_newline: context.use_block_indent() && tactic == DefinitiveListTactic::Vertical,
2002 preserve_newline: false,
2003 config: context.config,
2006 write_list(&item_vec, &fmt)
2007 .map(|args_str| (tactic == DefinitiveListTactic::Horizontal, args_str))
2010 fn try_overflow_last_arg<'a, T>(
2011 context: &RewriteContext,
2012 item_vec: &mut Vec<ListItem>,
2014 one_line_shape: Shape,
2015 nested_shape: Shape,
2016 one_line_width: usize,
2017 args_max_width: usize,
2019 ) -> DefinitiveListTactic
2021 T: Rewrite + Spanned + ToExpr + 'a,
2024 let combine_arg_with_callee =
2025 callee_str.len() + 1 <= context.config.tab_spaces() && args.len() == 1;
2026 let overflow_last = combine_arg_with_callee || can_be_overflowed(context, args);
2028 // Replace the last item with its first line to see if it fits with
2030 let placeholder = if overflow_last {
2031 let mut context = context.clone();
2032 if !combine_arg_with_callee {
2033 if let Some(expr) = args[args.len() - 1].to_expr() {
2034 if let ast::ExprKind::MethodCall(..) = expr.node {
2035 context.force_one_line_chain = true;
2039 last_arg_shape(args, item_vec, one_line_shape, args_max_width).and_then(|arg_shape| {
2040 rewrite_last_arg_with_overflow(&context, args, &mut item_vec[args.len() - 1], arg_shape)
2046 let mut tactic = definitive_tactic(
2048 ListTactic::LimitedHorizontalVertical(args_max_width),
2053 // Replace the stub with the full overflowing last argument if the rewrite
2054 // succeeded and its first line fits with the other arguments.
2055 match (overflow_last, tactic, placeholder) {
2056 (true, DefinitiveListTactic::Horizontal, placeholder @ Some(..)) => {
2057 item_vec[args.len() - 1].item = placeholder;
2059 _ if args.len() >= 1 => {
2060 item_vec[args.len() - 1].item = args.last()
2061 .and_then(|last_arg| last_arg.rewrite(context, nested_shape));
2063 let default_tactic = || {
2066 ListTactic::LimitedHorizontalVertical(args_max_width),
2072 // Use horizontal layout for a function with a single argument as long as
2073 // everything fits in a single line.
2075 && args_max_width != 0 // Vertical layout is forced.
2076 && !item_vec[0].has_comment()
2077 && !item_vec[0].inner_as_ref().contains('\n')
2078 && ::lists::total_item_width(&item_vec[0]) <= one_line_width
2080 tactic = DefinitiveListTactic::Horizontal;
2082 tactic = default_tactic();
2084 if tactic == DefinitiveListTactic::Vertical {
2085 if let Some((all_simple, num_args_before)) =
2086 maybe_get_args_offset(callee_str, args)
2088 let one_line = all_simple
2089 && definitive_tactic(
2090 &item_vec[..num_args_before],
2091 ListTactic::HorizontalVertical,
2094 ) == DefinitiveListTactic::Horizontal
2095 && definitive_tactic(
2096 &item_vec[num_args_before + 1..],
2097 ListTactic::HorizontalVertical,
2100 ) == DefinitiveListTactic::Horizontal;
2103 tactic = DefinitiveListTactic::SpecialMacro(num_args_before);
2115 fn is_simple_arg(expr: &ast::Expr) -> bool {
2117 ast::ExprKind::Lit(..) => true,
2118 ast::ExprKind::Path(ref qself, ref path) => qself.is_none() && path.segments.len() <= 1,
2119 ast::ExprKind::AddrOf(_, ref expr)
2120 | ast::ExprKind::Box(ref expr)
2121 | ast::ExprKind::Cast(ref expr, _)
2122 | ast::ExprKind::Field(ref expr, _)
2123 | ast::ExprKind::Try(ref expr)
2124 | ast::ExprKind::TupField(ref expr, _)
2125 | ast::ExprKind::Unary(_, ref expr) => is_simple_arg(expr),
2126 ast::ExprKind::Index(ref lhs, ref rhs) | ast::ExprKind::Repeat(ref lhs, ref rhs) => {
2127 is_simple_arg(lhs) && is_simple_arg(rhs)
2133 fn is_every_args_simple<T: ToExpr>(lists: &[&T]) -> bool {
2136 .all(|arg| arg.to_expr().map_or(false, is_simple_arg))
2139 /// In case special-case style is required, returns an offset from which we start horizontal layout.
2140 fn maybe_get_args_offset<T: ToExpr>(callee_str: &str, args: &[&T]) -> Option<(bool, usize)> {
2141 if let Some(&(_, num_args_before)) = SPECIAL_MACRO_WHITELIST
2143 .find(|&&(s, _)| s == callee_str)
2145 let all_simple = args.len() >= num_args_before && is_every_args_simple(args);
2147 Some((all_simple, num_args_before))
2153 /// Returns a shape for the last argument which is going to be overflowed.
2154 fn last_arg_shape<T>(
2158 args_max_width: usize,
2161 T: Rewrite + Spanned + ToExpr,
2163 let is_nested_call = lists
2166 .and_then(|item| item.to_expr())
2167 .map_or(false, is_nested_call);
2168 if items.len() == 1 && !is_nested_call {
2171 let offset = items.iter().rev().skip(1).fold(0, |acc, i| {
2173 acc + 2 + i.inner_as_ref().len()
2176 width: min(args_max_width, shape.width),
2178 }.offset_left(offset)
2181 fn rewrite_last_arg_with_overflow<'a, T>(
2182 context: &RewriteContext,
2184 last_item: &mut ListItem,
2188 T: Rewrite + Spanned + ToExpr + 'a,
2190 let last_arg = args[args.len() - 1];
2191 let rewrite = if let Some(expr) = last_arg.to_expr() {
2193 // When overflowing the closure which consists of a single control flow expression,
2194 // force to use block if its condition uses multi line.
2195 ast::ExprKind::Closure(..) => {
2196 // If the argument consists of multiple closures, we do not overflow
2197 // the last closure.
2198 if closures::args_have_many_closure(args) {
2201 closures::rewrite_last_closure(context, expr, shape)
2204 _ => expr.rewrite(context, shape),
2207 last_arg.rewrite(context, shape)
2210 if let Some(rewrite) = rewrite {
2211 let rewrite_first_line = Some(rewrite[..first_line_width(&rewrite)].to_owned());
2212 last_item.item = rewrite_first_line;
2219 fn can_be_overflowed<'a, T>(context: &RewriteContext, args: &[&T]) -> bool
2221 T: Rewrite + Spanned + ToExpr + 'a,
2224 .map_or(false, |x| x.can_be_overflowed(context, args.len()))
2227 pub fn can_be_overflowed_expr(context: &RewriteContext, expr: &ast::Expr, args_len: usize) -> bool {
2229 ast::ExprKind::Match(..) => {
2230 (context.use_block_indent() && args_len == 1)
2231 || (context.config.indent_style() == IndentStyle::Visual && args_len > 1)
2233 ast::ExprKind::If(..)
2234 | ast::ExprKind::IfLet(..)
2235 | ast::ExprKind::ForLoop(..)
2236 | ast::ExprKind::Loop(..)
2237 | ast::ExprKind::While(..)
2238 | ast::ExprKind::WhileLet(..) => {
2239 context.config.combine_control_expr() && context.use_block_indent() && args_len == 1
2241 ast::ExprKind::Block(..) | ast::ExprKind::Closure(..) => {
2242 context.use_block_indent()
2243 || context.config.indent_style() == IndentStyle::Visual && args_len > 1
2245 ast::ExprKind::Array(..)
2246 | ast::ExprKind::Call(..)
2247 | ast::ExprKind::Mac(..)
2248 | ast::ExprKind::MethodCall(..)
2249 | ast::ExprKind::Struct(..)
2250 | ast::ExprKind::Tup(..) => context.use_block_indent() && args_len == 1,
2251 ast::ExprKind::AddrOf(_, ref expr)
2252 | ast::ExprKind::Box(ref expr)
2253 | ast::ExprKind::Try(ref expr)
2254 | ast::ExprKind::Unary(_, ref expr)
2255 | ast::ExprKind::Cast(ref expr, _) => can_be_overflowed_expr(context, expr, args_len),
2260 fn is_nested_call(expr: &ast::Expr) -> bool {
2262 ast::ExprKind::Call(..) | ast::ExprKind::Mac(..) => true,
2263 ast::ExprKind::AddrOf(_, ref expr)
2264 | ast::ExprKind::Box(ref expr)
2265 | ast::ExprKind::Try(ref expr)
2266 | ast::ExprKind::Unary(_, ref expr)
2267 | ast::ExprKind::Cast(ref expr, _) => is_nested_call(expr),
2272 pub fn wrap_args_with_parens(
2273 context: &RewriteContext,
2275 is_extendable: bool,
2277 nested_shape: Shape,
2279 if !context.use_block_indent()
2280 || (context.inside_macro && !args_str.contains('\n')
2281 && args_str.len() + paren_overhead(context) <= shape.width) || is_extendable
2283 if context.config.spaces_within_parens_and_brackets() && !args_str.is_empty() {
2284 format!("( {} )", args_str)
2286 format!("({})", args_str)
2291 nested_shape.indent.to_string(context.config),
2293 shape.block().indent.to_string(context.config)
2298 /// Return true if a function call or a method call represented by the given span ends with a
2299 /// trailing comma. This function is used when rewriting macro, as adding or removing a trailing
2300 /// comma from macro can potentially break the code.
2301 fn span_ends_with_comma(context: &RewriteContext, span: Span) -> bool {
2302 let mut encountered_closing_paren = false;
2303 for c in context.snippet(span).chars().rev() {
2306 ')' => if encountered_closing_paren {
2309 encountered_closing_paren = true;
2311 _ if c.is_whitespace() => continue,
2318 fn rewrite_paren(context: &RewriteContext, subexpr: &ast::Expr, shape: Shape) -> Option<String> {
2319 debug!("rewrite_paren, shape: {:?}", shape);
2320 let total_paren_overhead = paren_overhead(context);
2321 let paren_overhead = total_paren_overhead / 2;
2322 let sub_shape = shape
2323 .offset_left(paren_overhead)
2324 .and_then(|s| s.sub_width(paren_overhead))?;
2326 let paren_wrapper = |s: &str| {
2327 if context.config.spaces_within_parens_and_brackets() && !s.is_empty() {
2328 format!("( {} )", s)
2334 let subexpr_str = subexpr.rewrite(context, sub_shape)?;
2335 debug!("rewrite_paren, subexpr_str: `{:?}`", subexpr_str);
2337 if subexpr_str.contains('\n')
2338 || first_line_width(&subexpr_str) + total_paren_overhead <= shape.width
2340 Some(paren_wrapper(&subexpr_str))
2349 context: &RewriteContext,
2351 ) -> Option<String> {
2352 let expr_str = expr.rewrite(context, shape)?;
2354 let (lbr, rbr) = if context.config.spaces_within_parens_and_brackets() {
2360 let offset = last_line_width(&expr_str) + lbr.len();
2361 let rhs_overhead = shape.rhs_overhead(context.config);
2362 let index_shape = if expr_str.contains('\n') {
2363 Shape::legacy(context.config.max_width(), shape.indent)
2364 .offset_left(offset)
2365 .and_then(|shape| shape.sub_width(rbr.len() + rhs_overhead))
2367 shape.visual_indent(offset).sub_width(offset + rbr.len())
2369 let orig_index_rw = index_shape.and_then(|s| index.rewrite(context, s));
2371 // Return if index fits in a single line.
2372 match orig_index_rw {
2373 Some(ref index_str) if !index_str.contains('\n') => {
2374 return Some(format!("{}{}{}{}", expr_str, lbr, index_str, rbr));
2379 // Try putting index on the next line and see if it fits in a single line.
2380 let indent = shape.indent.block_indent(context.config);
2381 let index_shape = Shape::indented(indent, context.config).offset_left(lbr.len())?;
2382 let index_shape = index_shape.sub_width(rbr.len() + rhs_overhead)?;
2383 let new_index_rw = index.rewrite(context, index_shape);
2384 match (orig_index_rw, new_index_rw) {
2385 (_, Some(ref new_index_str)) if !new_index_str.contains('\n') => Some(format!(
2388 indent.to_string(context.config),
2393 (None, Some(ref new_index_str)) => Some(format!(
2396 indent.to_string(context.config),
2401 (Some(ref index_str), _) => Some(format!("{}{}{}{}", expr_str, lbr, index_str, rbr)),
2406 fn struct_lit_can_be_aligned(fields: &[ast::Field], base: &Option<&ast::Expr>) -> bool {
2411 fields.iter().all(|field| !field.is_shorthand)
2414 fn rewrite_struct_lit<'a>(
2415 context: &RewriteContext,
2417 fields: &'a [ast::Field],
2418 base: Option<&'a ast::Expr>,
2421 ) -> Option<String> {
2422 debug!("rewrite_struct_lit: shape {:?}", shape);
2424 enum StructLitField<'a> {
2425 Regular(&'a ast::Field),
2426 Base(&'a ast::Expr),
2430 let path_shape = shape.sub_width(2)?;
2431 let path_str = rewrite_path(context, PathContext::Expr, None, path, path_shape)?;
2433 if fields.is_empty() && base.is_none() {
2434 return Some(format!("{} {{}}", path_str));
2437 // Foo { a: Foo } - indent is +3, width is -5.
2438 let (h_shape, v_shape) = struct_lit_shape(shape, context, path_str.len() + 3, 2)?;
2440 let one_line_width = h_shape.map_or(0, |shape| shape.width);
2441 let body_lo = context.codemap.span_after(span, "{");
2442 let fields_str = if struct_lit_can_be_aligned(fields, &base)
2443 && context.config.struct_field_align_threshold() > 0
2445 rewrite_with_alignment(
2449 mk_sp(body_lo, span.hi()),
2453 let field_iter = fields
2455 .map(StructLitField::Regular)
2456 .chain(base.into_iter().map(StructLitField::Base));
2458 let span_lo = |item: &StructLitField| match *item {
2459 StructLitField::Regular(field) => field.span().lo(),
2460 StructLitField::Base(expr) => {
2461 let last_field_hi = fields.last().map_or(span.lo(), |field| field.span.hi());
2462 let snippet = context.snippet(mk_sp(last_field_hi, expr.span.lo()));
2463 let pos = snippet.find_uncommented("..").unwrap();
2464 last_field_hi + BytePos(pos as u32)
2467 let span_hi = |item: &StructLitField| match *item {
2468 StructLitField::Regular(field) => field.span().hi(),
2469 StructLitField::Base(expr) => expr.span.hi(),
2471 let rewrite = |item: &StructLitField| match *item {
2472 StructLitField::Regular(field) => {
2473 // The 1 taken from the v_budget is for the comma.
2474 rewrite_field(context, field, v_shape.sub_width(1)?, 0)
2476 StructLitField::Base(expr) => {
2478 expr.rewrite(context, v_shape.offset_left(2)?)
2479 .map(|s| format!("..{}", s))
2483 let items = itemize_list(
2495 let item_vec = items.collect::<Vec<_>>();
2497 let tactic = struct_lit_tactic(h_shape, context, &item_vec);
2498 let nested_shape = shape_for_tactic(tactic, h_shape, v_shape);
2499 let fmt = struct_lit_formatting(nested_shape, tactic, context, base.is_some());
2501 write_list(&item_vec, &fmt)?
2504 let fields_str = wrap_struct_field(context, &fields_str, shape, v_shape, one_line_width);
2505 Some(format!("{} {{{}}}", path_str, fields_str))
2507 // FIXME if context.config.indent_style() == Visual, but we run out
2508 // of space, we should fall back to BlockIndent.
2511 pub fn wrap_struct_field(
2512 context: &RewriteContext,
2515 nested_shape: Shape,
2516 one_line_width: usize,
2518 if context.config.indent_style() == IndentStyle::Block
2519 && (fields_str.contains('\n') || !context.config.struct_lit_single_line()
2520 || fields_str.len() > one_line_width)
2524 nested_shape.indent.to_string(context.config),
2526 shape.indent.to_string(context.config)
2529 // One liner or visual indent.
2530 format!(" {} ", fields_str)
2534 pub fn struct_lit_field_separator(config: &Config) -> &str {
2535 colon_spaces(config.space_before_colon(), config.space_after_colon())
2538 pub fn rewrite_field(
2539 context: &RewriteContext,
2542 prefix_max_width: usize,
2543 ) -> Option<String> {
2544 if contains_skip(&field.attrs) {
2545 return Some(context.snippet(field.span()).to_owned());
2547 let name = &field.ident.node.to_string();
2548 if field.is_shorthand {
2549 Some(name.to_string())
2551 let mut separator = String::from(struct_lit_field_separator(context.config));
2552 for _ in 0..prefix_max_width.checked_sub(name.len()).unwrap_or(0) {
2553 separator.push(' ');
2555 let overhead = name.len() + separator.len();
2556 let expr_shape = shape.offset_left(overhead)?;
2557 let expr = field.expr.rewrite(context, expr_shape);
2559 let mut attrs_str = field.attrs.rewrite(context, shape)?;
2560 if !attrs_str.is_empty() {
2561 attrs_str.push_str(&format!("\n{}", shape.indent.to_string(context.config)));
2565 Some(e) => Some(format!("{}{}{}{}", attrs_str, name, separator, e)),
2567 let expr_offset = shape.indent.block_indent(context.config);
2570 .rewrite(context, Shape::indented(expr_offset, context.config));
2576 expr_offset.to_string(context.config),
2585 fn shape_from_indent_style(
2586 context: &RewriteContext,
2590 ) -> Option<Shape> {
2591 if context.use_block_indent() {
2595 .block_indent(context.config.tab_spaces())
2596 .with_max_width(context.config)
2599 shape.visual_indent(offset).sub_width(overhead)
2603 fn rewrite_tuple_in_visual_indent_style<'a, T>(
2604 context: &RewriteContext,
2610 T: Rewrite + Spanned + ToExpr + 'a,
2612 let mut items = items.iter();
2613 // In case of length 1, need a trailing comma
2614 debug!("rewrite_tuple_in_visual_indent_style {:?}", shape);
2615 if items.len() == 1 {
2617 let nested_shape = shape.sub_width(3)?.visual_indent(1);
2621 .rewrite(context, nested_shape)
2623 if context.config.spaces_within_parens_and_brackets() {
2624 format!("( {}, )", s)
2631 let list_lo = context.codemap.span_after(span, "(");
2632 let nested_shape = shape.sub_width(2)?.visual_indent(1);
2633 let items = itemize_list(
2638 |item| item.span().lo(),
2639 |item| item.span().hi(),
2640 |item| item.rewrite(context, nested_shape),
2642 span.hi() - BytePos(1),
2645 let item_vec: Vec<_> = items.collect();
2646 let tactic = definitive_tactic(
2648 ListTactic::HorizontalVertical,
2652 let fmt = ListFormatting {
2655 trailing_separator: SeparatorTactic::Never,
2656 separator_place: SeparatorPlace::Back,
2658 ends_with_newline: false,
2659 preserve_newline: false,
2660 config: context.config,
2662 let list_str = write_list(&item_vec, &fmt)?;
2664 if context.config.spaces_within_parens_and_brackets() && !list_str.is_empty() {
2665 Some(format!("( {} )", list_str))
2667 Some(format!("({})", list_str))
2671 pub fn rewrite_tuple<'a, T>(
2672 context: &RewriteContext,
2678 T: Rewrite + Spanned + ToExpr + 'a,
2680 debug!("rewrite_tuple {:?}", shape);
2681 if context.use_block_indent() {
2682 // We use the same rule as function calls for rewriting tuples.
2683 let force_trailing_comma = if context.inside_macro {
2684 span_ends_with_comma(context, span)
2694 context.config.width_heuristics().fn_call_width,
2695 force_trailing_comma,
2698 rewrite_tuple_in_visual_indent_style(context, items, span, shape)
2702 pub fn rewrite_unary_prefix<R: Rewrite>(
2703 context: &RewriteContext,
2707 ) -> Option<String> {
2709 .rewrite(context, shape.offset_left(prefix.len())?)
2710 .map(|r| format!("{}{}", prefix, r))
2713 // FIXME: this is probably not correct for multi-line Rewrites. we should
2714 // subtract suffix.len() from the last line budget, not the first!
2715 pub fn rewrite_unary_suffix<R: Rewrite>(
2716 context: &RewriteContext,
2720 ) -> Option<String> {
2722 .rewrite(context, shape.sub_width(suffix.len())?)
2729 fn rewrite_unary_op(
2730 context: &RewriteContext,
2734 ) -> Option<String> {
2735 // For some reason, an UnOp is not spanned like BinOp!
2736 let operator_str = match *op {
2737 ast::UnOp::Deref => "*",
2738 ast::UnOp::Not => "!",
2739 ast::UnOp::Neg => "-",
2741 rewrite_unary_prefix(context, operator_str, expr, shape)
2744 fn rewrite_assignment(
2745 context: &RewriteContext,
2748 op: Option<&ast::BinOp>,
2750 ) -> Option<String> {
2751 let operator_str = match op {
2752 Some(op) => context.snippet(op.span),
2756 // 1 = space between lhs and operator.
2757 let lhs_shape = shape.sub_width(operator_str.len() + 1)?;
2758 let lhs_str = format!("{} {}", lhs.rewrite(context, lhs_shape)?, operator_str);
2760 rewrite_assign_rhs(context, lhs_str, rhs, shape)
2763 // The left hand side must contain everything up to, and including, the
2764 // assignment operator.
2765 pub fn rewrite_assign_rhs<S: Into<String>, R: Rewrite>(
2766 context: &RewriteContext,
2770 ) -> Option<String> {
2771 let lhs = lhs.into();
2772 let last_line_width = last_line_width(&lhs)
2773 .checked_sub(if lhs.contains('\n') {
2774 shape.indent.width()
2779 // 1 = space between operator and rhs.
2780 let orig_shape = shape.offset_left(last_line_width + 1).unwrap_or(Shape {
2782 offset: shape.offset + last_line_width + 1,
2785 let rhs = choose_rhs(context, ex, orig_shape, ex.rewrite(context, orig_shape))?;
2789 pub fn choose_rhs<R: Rewrite>(
2790 context: &RewriteContext,
2793 orig_rhs: Option<String>,
2794 ) -> Option<String> {
2796 Some(ref new_str) if !new_str.contains('\n') && new_str.len() <= shape.width => {
2797 Some(format!(" {}", new_str))
2800 // Expression did not fit on the same line as the identifier.
2801 // Try splitting the line and see if that works better.
2803 Shape::indented(shape.indent.block_indent(context.config), context.config)
2804 .sub_width(shape.rhs_overhead(context.config))?;
2805 let new_rhs = expr.rewrite(context, new_shape);
2806 let new_indent_str = &new_shape.indent.to_string(context.config);
2808 match (orig_rhs, new_rhs) {
2809 (Some(ref orig_rhs), Some(ref new_rhs))
2810 if wrap_str(new_rhs.clone(), context.config.max_width(), new_shape)
2813 Some(format!(" {}", orig_rhs))
2815 (Some(ref orig_rhs), Some(ref new_rhs)) if prefer_next_line(orig_rhs, new_rhs) => {
2816 Some(format!("\n{}{}", new_indent_str, new_rhs))
2818 (None, Some(ref new_rhs)) => Some(format!("\n{}{}", new_indent_str, new_rhs)),
2819 (None, None) => None,
2820 (Some(ref orig_rhs), _) => Some(format!(" {}", orig_rhs)),
2826 fn prefer_next_line(orig_rhs: &str, next_line_rhs: &str) -> bool {
2827 use utils::count_newlines;
2828 !next_line_rhs.contains('\n') || count_newlines(orig_rhs) > count_newlines(next_line_rhs) + 1
2831 fn rewrite_expr_addrof(
2832 context: &RewriteContext,
2833 mutability: ast::Mutability,
2836 ) -> Option<String> {
2837 let operator_str = match mutability {
2838 ast::Mutability::Immutable => "&",
2839 ast::Mutability::Mutable => "&mut ",
2841 rewrite_unary_prefix(context, operator_str, expr, shape)
2845 fn to_expr(&self) -> Option<&ast::Expr>;
2846 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool;
2849 impl ToExpr for ast::Expr {
2850 fn to_expr(&self) -> Option<&ast::Expr> {
2854 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool {
2855 can_be_overflowed_expr(context, self, len)
2859 impl ToExpr for ast::Ty {
2860 fn to_expr(&self) -> Option<&ast::Expr> {
2864 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool {
2865 can_be_overflowed_type(context, self, len)
2869 impl<'a> ToExpr for TuplePatField<'a> {
2870 fn to_expr(&self) -> Option<&ast::Expr> {
2874 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool {
2875 can_be_overflowed_pat(context, self, len)
2879 impl<'a> ToExpr for ast::StructField {
2880 fn to_expr(&self) -> Option<&ast::Expr> {
2884 fn can_be_overflowed(&self, _: &RewriteContext, _: usize) -> bool {
2889 impl<'a> ToExpr for MacroArg {
2890 fn to_expr(&self) -> Option<&ast::Expr> {
2892 MacroArg::Expr(ref expr) => Some(expr),
2897 fn can_be_overflowed(&self, context: &RewriteContext, len: usize) -> bool {
2899 MacroArg::Expr(ref expr) => can_be_overflowed_expr(context, expr, len),
2900 MacroArg::Ty(ref ty) => can_be_overflowed_type(context, ty, len),
2901 MacroArg::Pat(..) => false,