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.
14 use syntax::parse::token::DelimToken;
15 use syntax::source_map::{BytePos, SourceMap, Span};
16 use syntax::{ast, ptr};
18 use crate::chains::rewrite_chain;
21 combine_strs_with_missing_comments, contains_comment, recover_comment_removed, rewrite_comment,
22 rewrite_missing_comment, CharClasses, FindUncommented,
24 use crate::config::lists::*;
25 use crate::config::{Config, ControlBraceStyle, IndentStyle, Version};
27 definitive_tactic, itemize_list, shape_for_tactic, struct_lit_formatting, struct_lit_shape,
28 struct_lit_tactic, write_list, ListFormatting, ListItem, Separator,
30 use crate::macros::{rewrite_macro, MacroPosition};
31 use crate::matches::rewrite_match;
32 use crate::overflow::{self, IntoOverflowableItem, OverflowableItem};
33 use crate::pairs::{rewrite_all_pairs, rewrite_pair, PairParts};
34 use crate::patterns::is_short_pattern;
35 use crate::rewrite::{Rewrite, RewriteContext};
36 use crate::shape::{Indent, Shape};
37 use crate::source_map::{LineRangeUtils, SpanUtils};
38 use crate::spanned::Spanned;
39 use crate::string::{rewrite_string, StringFormat};
40 use crate::types::{rewrite_path, PathContext};
42 colon_spaces, contains_skip, count_newlines, first_line_ends_with, inner_attributes,
43 last_line_extendable, last_line_width, mk_sp, outer_attributes, ptr_vec_to_ref_vec,
44 semicolon_for_expr, semicolon_for_stmt, wrap_str,
46 use crate::vertical::rewrite_with_alignment;
47 use crate::visitor::FmtVisitor;
49 impl Rewrite for ast::Expr {
50 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
51 format_expr(self, ExprType::SubExpression, context, shape)
55 #[derive(Copy, Clone, PartialEq)]
64 context: &RewriteContext,
67 skip_out_of_file_lines_range!(context, expr.span);
69 if contains_skip(&*expr.attrs) {
70 return Some(context.snippet(expr.span()).to_owned());
72 let shape = if expr_type == ExprType::Statement && semicolon_for_expr(context, expr) {
78 let expr_rw = match expr.node {
79 ast::ExprKind::Array(ref expr_vec) => rewrite_array(
85 choose_separator_tactic(context, expr.span),
88 ast::ExprKind::Lit(ref l) => rewrite_literal(context, l, shape),
89 ast::ExprKind::Call(ref callee, ref args) => {
90 let inner_span = mk_sp(callee.span.hi(), expr.span.hi());
91 let callee_str = callee.rewrite(context, shape)?;
92 rewrite_call(context, &callee_str, args, inner_span, shape)
94 ast::ExprKind::Paren(ref subexpr) => rewrite_paren(context, subexpr, shape, expr.span),
95 ast::ExprKind::Binary(op, ref lhs, ref rhs) => {
96 // FIXME: format comments between operands and operator
97 rewrite_all_pairs(expr, shape, context).or_else(|| {
101 PairParts::infix(&format!(" {} ", context.snippet(op.span))),
104 context.config.binop_separator(),
108 ast::ExprKind::Unary(op, ref subexpr) => rewrite_unary_op(context, op, subexpr, shape),
109 ast::ExprKind::Struct(ref path, ref fields, ref base) => rewrite_struct_lit(
113 base.as_ref().map(|e| &**e),
117 ast::ExprKind::Tup(ref items) => {
118 rewrite_tuple(context, items.iter(), expr.span, shape, items.len() == 1)
120 ast::ExprKind::If(..)
121 | ast::ExprKind::IfLet(..)
122 | ast::ExprKind::ForLoop(..)
123 | ast::ExprKind::Loop(..)
124 | ast::ExprKind::While(..)
125 | ast::ExprKind::WhileLet(..) => to_control_flow(expr, expr_type)
126 .and_then(|control_flow| control_flow.rewrite(context, shape)),
127 ast::ExprKind::Block(ref block, opt_label) => {
129 ExprType::Statement => {
130 if is_unsafe_block(block) {
131 rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)
132 } else if let rw @ Some(_) =
133 rewrite_empty_block(context, block, Some(&expr.attrs), opt_label, "", shape)
135 // Rewrite block without trying to put it in a single line.
138 let prefix = block_prefix(context, block, shape)?;
140 rewrite_block_with_visitor(
151 ExprType::SubExpression => {
152 rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)
156 ast::ExprKind::Match(ref cond, ref arms) => {
157 rewrite_match(context, cond, arms, shape, expr.span, &expr.attrs)
159 ast::ExprKind::Path(ref qself, ref path) => {
160 rewrite_path(context, PathContext::Expr, qself.as_ref(), path, shape)
162 ast::ExprKind::Assign(ref lhs, ref rhs) => {
163 rewrite_assignment(context, lhs, rhs, None, shape)
165 ast::ExprKind::AssignOp(ref op, ref lhs, ref rhs) => {
166 rewrite_assignment(context, lhs, rhs, Some(op), shape)
168 ast::ExprKind::Continue(ref opt_label) => {
169 let id_str = match *opt_label {
170 Some(label) => format!(" {}", label.ident),
171 None => String::new(),
173 Some(format!("continue{}", id_str))
175 ast::ExprKind::Break(ref opt_label, ref opt_expr) => {
176 let id_str = match *opt_label {
177 Some(label) => format!(" {}", label.ident),
178 None => String::new(),
181 if let Some(ref expr) = *opt_expr {
182 rewrite_unary_prefix(context, &format!("break{} ", id_str), &**expr, shape)
184 Some(format!("break{}", id_str))
187 ast::ExprKind::Yield(ref opt_expr) => {
188 if let Some(ref expr) = *opt_expr {
189 rewrite_unary_prefix(context, "yield ", &**expr, shape)
191 Some("yield".to_string())
194 ast::ExprKind::Closure(capture, asyncness, movability, ref fn_decl, ref body, _) => {
195 closures::rewrite_closure(
196 capture, asyncness, movability, fn_decl, body, expr.span, context, shape,
199 ast::ExprKind::Try(..) | ast::ExprKind::Field(..) | ast::ExprKind::MethodCall(..) => {
200 rewrite_chain(expr, context, shape)
202 ast::ExprKind::Mac(ref mac) => {
203 rewrite_macro(mac, None, context, shape, MacroPosition::Expression).or_else(|| {
205 context.snippet(expr.span).to_owned(),
206 context.config.max_width(),
211 ast::ExprKind::Ret(None) => Some("return".to_owned()),
212 ast::ExprKind::Ret(Some(ref expr)) => {
213 rewrite_unary_prefix(context, "return ", &**expr, shape)
215 ast::ExprKind::Box(ref expr) => rewrite_unary_prefix(context, "box ", &**expr, shape),
216 ast::ExprKind::AddrOf(mutability, ref expr) => {
217 rewrite_expr_addrof(context, mutability, expr, shape)
219 ast::ExprKind::Cast(ref expr, ref ty) => rewrite_pair(
222 PairParts::infix(" as "),
225 SeparatorPlace::Front,
227 ast::ExprKind::Type(ref expr, ref ty) => rewrite_pair(
230 PairParts::infix(": "),
233 SeparatorPlace::Back,
235 ast::ExprKind::Index(ref expr, ref index) => {
236 rewrite_index(&**expr, &**index, context, shape)
238 ast::ExprKind::Repeat(ref expr, ref repeats) => rewrite_pair(
241 PairParts::new("[", "; ", "]"),
244 SeparatorPlace::Back,
246 ast::ExprKind::Range(ref lhs, ref rhs, limits) => {
247 let delim = match limits {
248 ast::RangeLimits::HalfOpen => "..",
249 ast::RangeLimits::Closed => "..=",
252 fn needs_space_before_range(context: &RewriteContext, lhs: &ast::Expr) -> bool {
254 ast::ExprKind::Lit(ref lit) => match lit.node {
255 ast::LitKind::FloatUnsuffixed(..) => {
256 context.snippet(lit.span).ends_with('.')
264 fn needs_space_after_range(rhs: &ast::Expr) -> bool {
266 // Don't format `.. ..` into `....`, which is invalid.
268 // This check is unnecessary for `lhs`, because a range
269 // starting from another range needs parentheses as `(x ..) ..`
270 // (`x .. ..` is a range from `x` to `..`).
271 ast::ExprKind::Range(None, _, _) => true,
276 let default_sp_delim = |lhs: Option<&ast::Expr>, rhs: Option<&ast::Expr>| {
277 let space_if = |b: bool| if b { " " } else { "" };
281 lhs.map_or("", |lhs| space_if(needs_space_before_range(context, lhs))),
283 rhs.map_or("", |rhs| space_if(needs_space_after_range(rhs))),
287 match (lhs.as_ref().map(|x| &**x), rhs.as_ref().map(|x| &**x)) {
288 (Some(lhs), Some(rhs)) => {
289 let sp_delim = if context.config.spaces_around_ranges() {
290 format!(" {} ", delim)
292 default_sp_delim(Some(lhs), Some(rhs))
297 PairParts::infix(&sp_delim),
300 context.config.binop_separator(),
303 (None, Some(rhs)) => {
304 let sp_delim = if context.config.spaces_around_ranges() {
305 format!("{} ", delim)
307 default_sp_delim(None, Some(rhs))
309 rewrite_unary_prefix(context, &sp_delim, &*rhs, shape)
311 (Some(lhs), None) => {
312 let sp_delim = if context.config.spaces_around_ranges() {
313 format!(" {}", delim)
315 default_sp_delim(Some(lhs), None)
317 rewrite_unary_suffix(context, &sp_delim, &*lhs, shape)
319 (None, None) => Some(delim.to_owned()),
322 // We do not format these expressions yet, but they should still
323 // satisfy our width restrictions.
324 ast::ExprKind::InlineAsm(..) => Some(context.snippet(expr.span).to_owned()),
325 ast::ExprKind::TryBlock(ref block) => {
326 if let rw @ Some(_) =
327 rewrite_single_line_block(context, "try ", block, Some(&expr.attrs), None, shape)
332 let budget = shape.width.saturating_sub(9);
341 Shape::legacy(budget, shape.indent)
346 ast::ExprKind::ObsoleteInPlace(ref lhs, ref rhs) => lhs
347 .rewrite(context, shape)
349 .and_then(|lhs| rewrite_assign_rhs(context, lhs, &**rhs, shape)),
350 ast::ExprKind::Async(capture_by, _node_id, ref block) => {
351 let mover = if capture_by == ast::CaptureBy::Value {
356 if let rw @ Some(_) = rewrite_single_line_block(
358 format!("{}{}", "async ", mover).as_str(),
367 let budget = shape.width.saturating_sub(6);
377 Shape::legacy(budget, shape.indent)
382 ast::ExprKind::Err => None,
386 .and_then(|expr_str| recover_comment_removed(expr_str, expr.span, context))
387 .and_then(|expr_str| {
388 let attrs = outer_attributes(&expr.attrs);
389 let attrs_str = attrs.rewrite(context, shape)?;
391 attrs.last().map_or(expr.span.lo(), |attr| attr.span.hi()),
394 combine_strs_with_missing_comments(context, &attrs_str, &expr_str, span, shape, false)
398 pub fn rewrite_array<'a, T: 'a + IntoOverflowableItem<'a>>(
400 exprs: impl Iterator<Item = &'a T>,
402 context: &'a RewriteContext,
404 force_separator_tactic: Option<SeparatorTactic>,
405 delim_token: Option<DelimToken>,
406 ) -> Option<String> {
407 overflow::rewrite_with_square_brackets(
413 force_separator_tactic,
418 fn rewrite_empty_block(
419 context: &RewriteContext,
421 attrs: Option<&[ast::Attribute]>,
422 label: Option<ast::Label>,
425 ) -> Option<String> {
426 if !block.stmts.is_empty() {
430 let label_str = rewrite_label(label);
431 if attrs.map_or(false, |a| !inner_attributes(a).is_empty()) {
435 if !block_contains_comment(block, context.source_map) && shape.width >= 2 {
436 return Some(format!("{}{}{{}}", prefix, label_str));
439 // If a block contains only a single-line comment, then leave it on one line.
440 let user_str = context.snippet(block.span);
441 let user_str = user_str.trim();
442 if user_str.starts_with('{') && user_str.ends_with('}') {
443 let comment_str = user_str[1..user_str.len() - 1].trim();
444 if block.stmts.is_empty()
445 && !comment_str.contains('\n')
446 && !comment_str.starts_with("//")
447 && comment_str.len() + 4 <= shape.width
449 return Some(format!("{}{}{{ {} }}", prefix, label_str, comment_str));
456 fn block_prefix(context: &RewriteContext, block: &ast::Block, shape: Shape) -> Option<String> {
457 Some(match block.rules {
458 ast::BlockCheckMode::Unsafe(..) => {
459 let snippet = context.snippet(block.span);
460 let open_pos = snippet.find_uncommented("{")?;
461 // Extract comment between unsafe and block start.
462 let trimmed = &snippet[6..open_pos].trim();
464 if !trimmed.is_empty() {
465 // 9 = "unsafe {".len(), 7 = "unsafe ".len()
466 let budget = shape.width.checked_sub(9)?;
472 Shape::legacy(budget, shape.indent + 7),
480 ast::BlockCheckMode::Default => String::new(),
484 fn rewrite_single_line_block(
485 context: &RewriteContext,
488 attrs: Option<&[ast::Attribute]>,
489 label: Option<ast::Label>,
491 ) -> Option<String> {
492 if is_simple_block(block, attrs, context.source_map) {
493 let expr_shape = shape.offset_left(last_line_width(prefix))?;
494 let expr_str = block.stmts[0].rewrite(context, expr_shape)?;
495 let label_str = rewrite_label(label);
496 let result = format!("{}{}{{ {} }}", prefix, label_str, expr_str);
497 if result.len() <= shape.width && !result.contains('\n') {
504 pub fn rewrite_block_with_visitor(
505 context: &RewriteContext,
508 attrs: Option<&[ast::Attribute]>,
509 label: Option<ast::Label>,
512 ) -> Option<String> {
513 if let rw @ Some(_) = rewrite_empty_block(context, block, attrs, label, prefix, shape) {
517 let mut visitor = FmtVisitor::from_context(context);
518 visitor.block_indent = shape.indent;
519 visitor.is_if_else_block = context.is_if_else_block();
520 match (block.rules, label) {
521 (ast::BlockCheckMode::Unsafe(..), _) | (ast::BlockCheckMode::Default, Some(_)) => {
522 let snippet = context.snippet(block.span);
523 let open_pos = snippet.find_uncommented("{")?;
524 visitor.last_pos = block.span.lo() + BytePos(open_pos as u32)
526 (ast::BlockCheckMode::Default, None) => visitor.last_pos = block.span.lo(),
529 let inner_attrs = attrs.map(inner_attributes);
530 let label_str = rewrite_label(label);
531 visitor.visit_block(block, inner_attrs.as_ref().map(|a| &**a), has_braces);
532 Some(format!("{}{}{}", prefix, label_str, visitor.buffer))
535 impl Rewrite for ast::Block {
536 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
537 rewrite_block(self, None, None, context, shape)
543 attrs: Option<&[ast::Attribute]>,
544 label: Option<ast::Label>,
545 context: &RewriteContext,
547 ) -> Option<String> {
548 let prefix = block_prefix(context, block, shape)?;
550 // shape.width is used only for the single line case: either the empty block `{}`,
551 // or an unsafe expression `unsafe { e }`.
552 if let rw @ Some(_) = rewrite_empty_block(context, block, attrs, label, &prefix, shape) {
556 let result = rewrite_block_with_visitor(context, &prefix, block, attrs, label, shape, true);
557 if let Some(ref result_str) = result {
558 if result_str.lines().count() <= 3 {
559 if let rw @ Some(_) =
560 rewrite_single_line_block(context, &prefix, block, attrs, label, shape)
570 impl Rewrite for ast::Stmt {
571 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
572 skip_out_of_file_lines_range!(context, self.span());
574 let result = match self.node {
575 ast::StmtKind::Local(ref local) => local.rewrite(context, shape),
576 ast::StmtKind::Expr(ref ex) | ast::StmtKind::Semi(ref ex) => {
577 let suffix = if semicolon_for_stmt(context, self) {
583 let shape = shape.sub_width(suffix.len())?;
584 format_expr(ex, ExprType::Statement, context, shape).map(|s| s + suffix)
586 ast::StmtKind::Mac(..) | ast::StmtKind::Item(..) => None,
588 result.and_then(|res| recover_comment_removed(res, self.span(), context))
592 // Rewrite condition if the given expression has one.
593 pub fn rewrite_cond(context: &RewriteContext, expr: &ast::Expr, shape: Shape) -> Option<String> {
595 ast::ExprKind::Match(ref cond, _) => {
597 let cond_shape = match context.config.indent_style() {
598 IndentStyle::Visual => shape.shrink_left(6).and_then(|s| s.sub_width(2))?,
599 IndentStyle::Block => shape.offset_left(8)?,
601 cond.rewrite(context, cond_shape)
603 _ => to_control_flow(expr, ExprType::SubExpression).and_then(|control_flow| {
605 String::from("\n") + &shape.indent.block_only().to_string(context.config);
607 .rewrite_cond(context, shape, &alt_block_sep)
608 .and_then(|rw| Some(rw.0))
613 // Abstraction over control flow expressions
615 struct ControlFlow<'a> {
616 cond: Option<&'a ast::Expr>,
617 block: &'a ast::Block,
618 else_block: Option<&'a ast::Expr>,
619 label: Option<ast::Label>,
620 pats: Vec<&'a ast::Pat>,
624 allow_single_line: bool,
625 // True if this is an `if` expression in an `else if` :-( hacky
630 fn to_control_flow(expr: &ast::Expr, expr_type: ExprType) -> Option<ControlFlow> {
632 ast::ExprKind::If(ref cond, ref if_block, ref else_block) => Some(ControlFlow::new_if(
636 else_block.as_ref().map(|e| &**e),
637 expr_type == ExprType::SubExpression,
641 ast::ExprKind::IfLet(ref pat, ref cond, ref if_block, ref else_block) => {
642 Some(ControlFlow::new_if(
644 ptr_vec_to_ref_vec(pat),
646 else_block.as_ref().map(|e| &**e),
647 expr_type == ExprType::SubExpression,
652 ast::ExprKind::ForLoop(ref pat, ref cond, ref block, label) => {
653 Some(ControlFlow::new_for(pat, cond, block, label, expr.span))
655 ast::ExprKind::Loop(ref block, label) => {
656 Some(ControlFlow::new_loop(block, label, expr.span))
658 ast::ExprKind::While(ref cond, ref block, label) => Some(ControlFlow::new_while(
665 ast::ExprKind::WhileLet(ref pat, ref cond, ref block, label) => Some(
666 ControlFlow::new_while(ptr_vec_to_ref_vec(pat), cond, block, label, expr.span),
672 fn choose_matcher(pats: &[&ast::Pat]) -> &'static str {
680 impl<'a> ControlFlow<'a> {
683 pats: Vec<&'a ast::Pat>,
684 block: &'a ast::Block,
685 else_block: Option<&'a ast::Expr>,
686 allow_single_line: bool,
689 ) -> ControlFlow<'a> {
690 let matcher = choose_matcher(&pats);
706 fn new_loop(block: &'a ast::Block, label: Option<ast::Label>, span: Span) -> ControlFlow<'a> {
716 allow_single_line: false,
723 pats: Vec<&'a ast::Pat>,
725 block: &'a ast::Block,
726 label: Option<ast::Label>,
728 ) -> ControlFlow<'a> {
729 let matcher = choose_matcher(&pats);
739 allow_single_line: false,
748 block: &'a ast::Block,
749 label: Option<ast::Label>,
751 ) -> ControlFlow<'a> {
761 allow_single_line: false,
767 fn rewrite_single_line(
770 context: &RewriteContext,
772 ) -> Option<String> {
773 assert!(self.allow_single_line);
774 let else_block = self.else_block?;
775 let fixed_cost = self.keyword.len() + " { } else { }".len();
777 if let ast::ExprKind::Block(ref else_node, _) = else_block.node {
778 if !is_simple_block(self.block, None, context.source_map)
779 || !is_simple_block(else_node, None, context.source_map)
780 || pat_expr_str.contains('\n')
785 let new_width = width.checked_sub(pat_expr_str.len() + fixed_cost)?;
786 let expr = &self.block.stmts[0];
787 let if_str = expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;
789 let new_width = new_width.checked_sub(if_str.len())?;
790 let else_expr = &else_node.stmts[0];
791 let else_str = else_expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;
793 if if_str.contains('\n') || else_str.contains('\n') {
797 let result = format!(
798 "{} {} {{ {} }} else {{ {} }}",
799 self.keyword, pat_expr_str, if_str, else_str
802 if result.len() <= width {
811 /// Returns true if the last line of pat_str has leading whitespace and it is wider than the
813 fn last_line_offsetted(start_column: usize, pat_str: &str) -> bool {
814 let mut leading_whitespaces = 0;
815 for c in pat_str.chars().rev() {
818 _ if c.is_whitespace() => leading_whitespaces += 1,
819 _ => leading_whitespaces = 0,
822 leading_whitespaces > start_column
825 impl<'a> ControlFlow<'a> {
828 context: &RewriteContext,
832 ) -> Option<String> {
833 debug!("rewrite_pat_expr {:?} {:?} {:?}", shape, self.pats, expr);
835 let cond_shape = shape.offset_left(offset)?;
836 if !self.pats.is_empty() {
837 let matcher = if self.matcher.is_empty() {
838 self.matcher.to_owned()
840 format!("{} ", self.matcher)
842 let pat_shape = cond_shape
843 .offset_left(matcher.len())?
844 .sub_width(self.connector.len())?;
845 let pat_string = rewrite_multiple_patterns(context, &self.pats, pat_shape)?;
846 let result = format!("{}{}{}", matcher, pat_string, self.connector);
847 return rewrite_assign_rhs(context, result, expr, cond_shape);
850 let expr_rw = expr.rewrite(context, cond_shape);
851 // The expression may (partially) fit on the current line.
852 // We do not allow splitting between `if` and condition.
853 if self.keyword == "if" || expr_rw.is_some() {
857 // The expression won't fit on the current line, jump to next.
858 let nested_shape = shape
859 .block_indent(context.config.tab_spaces())
860 .with_max_width(context.config);
861 let nested_indent_str = nested_shape.indent.to_string_with_newline(context.config);
862 expr.rewrite(context, nested_shape)
863 .map(|expr_rw| format!("{}{}", nested_indent_str, expr_rw))
868 context: &RewriteContext,
871 ) -> Option<(String, usize)> {
872 // Do not take the rhs overhead from the upper expressions into account
873 // when rewriting pattern.
874 let new_width = context.budget(shape.used_width());
875 let fresh_shape = Shape {
879 let constr_shape = if self.nested_if {
880 // We are part of an if-elseif-else chain. Our constraints are tightened.
881 // 7 = "} else " .len()
882 fresh_shape.offset_left(7)?
887 let label_string = rewrite_label(self.label);
888 // 1 = space after keyword.
889 let offset = self.keyword.len() + label_string.len() + 1;
891 let pat_expr_string = match self.cond {
892 Some(cond) => self.rewrite_pat_expr(context, cond, constr_shape, offset)?,
893 None => String::new(),
897 if context.config.control_brace_style() != ControlBraceStyle::AlwaysNextLine {
903 let one_line_budget = context
906 .saturating_sub(constr_shape.used_width() + offset + brace_overhead);
907 let force_newline_brace = (pat_expr_string.contains('\n')
908 || pat_expr_string.len() > one_line_budget)
909 && (!last_line_extendable(&pat_expr_string)
910 || last_line_offsetted(shape.used_width(), &pat_expr_string));
912 // Try to format if-else on single line.
913 if self.allow_single_line
917 .single_line_if_else_max_width
920 let trial = self.rewrite_single_line(&pat_expr_string, context, shape.width);
922 if let Some(cond_str) = trial {
927 .single_line_if_else_max_width
929 return Some((cond_str, 0));
934 let cond_span = if let Some(cond) = self.cond {
937 mk_sp(self.block.span.lo(), self.block.span.lo())
940 // `for event in event`
941 // Do not include label in the span.
944 .map_or(self.span.lo(), |label| label.ident.span.hi());
945 let between_kwd_cond = mk_sp(
948 .span_after(mk_sp(lo, self.span.hi()), self.keyword.trim()),
949 if self.pats.is_empty() {
951 } else if self.matcher.is_empty() {
952 self.pats[0].span.lo()
956 .span_before(self.span, self.matcher.trim())
960 let between_kwd_cond_comment = extract_comment(between_kwd_cond, context, shape);
962 let after_cond_comment =
963 extract_comment(mk_sp(cond_span.hi(), self.block.span.lo()), context, shape);
965 let block_sep = if self.cond.is_none() && between_kwd_cond_comment.is_some() {
967 } else if context.config.control_brace_style() == ControlBraceStyle::AlwaysNextLine
968 || force_newline_brace
975 let used_width = if pat_expr_string.contains('\n') {
976 last_line_width(&pat_expr_string)
978 // 2 = spaces after keyword and condition.
979 label_string.len() + self.keyword.len() + pat_expr_string.len() + 2
987 between_kwd_cond_comment.as_ref().map_or(
988 if pat_expr_string.is_empty() || pat_expr_string.starts_with('\n') {
996 after_cond_comment.as_ref().map_or(block_sep, |s| &**s)
1003 impl<'a> Rewrite for ControlFlow<'a> {
1004 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1005 debug!("ControlFlow::rewrite {:?} {:?}", self, shape);
1007 let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
1008 let (cond_str, used_width) = self.rewrite_cond(context, shape, alt_block_sep)?;
1009 // If `used_width` is 0, it indicates that whole control flow is written in a single line.
1010 if used_width == 0 {
1011 return Some(cond_str);
1014 let block_width = shape.width.saturating_sub(used_width);
1015 // This is used only for the empty block case: `{}`. So, we use 1 if we know
1016 // we should avoid the single line case.
1017 let block_width = if self.else_block.is_some() || self.nested_if {
1022 let block_shape = Shape {
1027 let old_val = context.is_if_else_block.replace(self.else_block.is_some());
1029 rewrite_block_with_visitor(context, "", self.block, None, None, block_shape, true);
1030 context.is_if_else_block.replace(old_val);
1034 let mut result = format!("{}{}", cond_str, block_str);
1036 if let Some(else_block) = self.else_block {
1037 let shape = Shape::indented(shape.indent, context.config);
1038 let mut last_in_chain = false;
1039 let rewrite = match else_block.node {
1040 // If the else expression is another if-else expression, prevent it
1041 // from being formatted on a single line.
1042 // Note how we're passing the original shape, as the
1043 // cost of "else" should not cascade.
1044 ast::ExprKind::IfLet(ref pat, ref cond, ref if_block, ref next_else_block) => {
1045 ControlFlow::new_if(
1047 ptr_vec_to_ref_vec(pat),
1049 next_else_block.as_ref().map(|e| &**e),
1052 mk_sp(else_block.span.lo(), self.span.hi()),
1054 .rewrite(context, shape)
1056 ast::ExprKind::If(ref cond, ref if_block, ref next_else_block) => {
1057 ControlFlow::new_if(
1061 next_else_block.as_ref().map(|e| &**e),
1064 mk_sp(else_block.span.lo(), self.span.hi()),
1066 .rewrite(context, shape)
1069 last_in_chain = true;
1070 // When rewriting a block, the width is only used for single line
1071 // blocks, passing 1 lets us avoid that.
1072 let else_shape = Shape {
1073 width: min(1, shape.width),
1076 format_expr(else_block, ExprType::Statement, context, else_shape)
1080 let between_kwd_else_block = mk_sp(
1081 self.block.span.hi(),
1084 .span_before(mk_sp(self.block.span.hi(), else_block.span.lo()), "else"),
1086 let between_kwd_else_block_comment =
1087 extract_comment(between_kwd_else_block, context, shape);
1089 let after_else = mk_sp(
1092 .span_after(mk_sp(self.block.span.hi(), else_block.span.lo()), "else"),
1093 else_block.span.lo(),
1095 let after_else_comment = extract_comment(after_else, context, shape);
1097 let between_sep = match context.config.control_brace_style() {
1098 ControlBraceStyle::AlwaysNextLine | ControlBraceStyle::ClosingNextLine => {
1101 ControlBraceStyle::AlwaysSameLine => " ",
1103 let after_sep = match context.config.control_brace_style() {
1104 ControlBraceStyle::AlwaysNextLine if last_in_chain => &*alt_block_sep,
1108 result.push_str(&format!(
1110 between_kwd_else_block_comment
1112 .map_or(between_sep, |s| &**s),
1113 after_else_comment.as_ref().map_or(after_sep, |s| &**s),
1115 result.push_str(&rewrite?);
1122 fn rewrite_label(opt_label: Option<ast::Label>) -> Cow<'static, str> {
1124 Some(label) => Cow::from(format!("{}: ", label.ident)),
1125 None => Cow::from(""),
1129 fn extract_comment(span: Span, context: &RewriteContext, shape: Shape) -> Option<String> {
1130 match rewrite_missing_comment(span, shape, context) {
1131 Some(ref comment) if !comment.is_empty() => Some(format!(
1132 "{indent}{}{indent}",
1134 indent = shape.indent.to_string_with_newline(context.config)
1140 pub fn block_contains_comment(block: &ast::Block, source_map: &SourceMap) -> bool {
1141 let snippet = source_map.span_to_snippet(block.span).unwrap();
1142 contains_comment(&snippet)
1145 // Checks that a block contains no statements, an expression and no comments or
1147 // FIXME: incorrectly returns false when comment is contained completely within
1149 pub fn is_simple_block(
1151 attrs: Option<&[ast::Attribute]>,
1152 source_map: &SourceMap,
1154 (block.stmts.len() == 1
1155 && stmt_is_expr(&block.stmts[0])
1156 && !block_contains_comment(block, source_map)
1157 && attrs.map_or(true, |a| a.is_empty()))
1160 /// Checks whether a block contains at most one statement or expression, and no
1161 /// comments or attributes.
1162 pub fn is_simple_block_stmt(
1164 attrs: Option<&[ast::Attribute]>,
1165 source_map: &SourceMap,
1167 block.stmts.len() <= 1
1168 && !block_contains_comment(block, source_map)
1169 && attrs.map_or(true, |a| a.is_empty())
1172 /// Checks whether a block contains no statements, expressions, comments, or
1173 /// inner attributes.
1174 pub fn is_empty_block(
1176 attrs: Option<&[ast::Attribute]>,
1177 source_map: &SourceMap,
1179 block.stmts.is_empty()
1180 && !block_contains_comment(block, source_map)
1181 && attrs.map_or(true, |a| inner_attributes(a).is_empty())
1184 pub fn stmt_is_expr(stmt: &ast::Stmt) -> bool {
1186 ast::StmtKind::Expr(..) => true,
1191 pub fn is_unsafe_block(block: &ast::Block) -> bool {
1192 if let ast::BlockCheckMode::Unsafe(..) = block.rules {
1199 pub fn rewrite_multiple_patterns(
1200 context: &RewriteContext,
1203 ) -> Option<String> {
1206 .map(|p| p.rewrite(context, shape))
1207 .collect::<Option<Vec<_>>>()?;
1209 let use_mixed_layout = pats
1211 .zip(pat_strs.iter())
1212 .all(|(pat, pat_str)| is_short_pattern(pat, pat_str));
1213 let items: Vec<_> = pat_strs.into_iter().map(ListItem::from_str).collect();
1214 let tactic = if use_mixed_layout {
1215 DefinitiveListTactic::Mixed
1219 ListTactic::HorizontalVertical,
1220 Separator::VerticalBar,
1224 let fmt = ListFormatting::new(shape, context.config)
1227 .separator_place(context.config.binop_separator())
1228 .ends_with_newline(false);
1229 write_list(&items, &fmt)
1232 pub fn rewrite_literal(context: &RewriteContext, l: &ast::Lit, shape: Shape) -> Option<String> {
1234 ast::LitKind::Str(_, ast::StrStyle::Cooked) => rewrite_string_lit(context, l.span, shape),
1236 context.snippet(l.span).to_owned(),
1237 context.config.max_width(),
1243 fn rewrite_string_lit(context: &RewriteContext, span: Span, shape: Shape) -> Option<String> {
1244 let string_lit = context.snippet(span);
1246 if !context.config.format_strings() {
1251 .all(|line| line.ends_with('\\'))
1253 let new_indent = shape.visual_indent(1).indent;
1254 let indented_string_lit = String::from(
1260 new_indent.to_string(context.config),
1264 .collect::<Vec<_>>()
1268 return if context.config.version() == Version::Two {
1269 Some(indented_string_lit)
1271 wrap_str(indented_string_lit, context.config.max_width(), shape)
1274 return wrap_str(string_lit.to_owned(), context.config.max_width(), shape);
1278 // Remove the quote characters.
1279 let str_lit = &string_lit[1..string_lit.len() - 1];
1283 &StringFormat::new(shape.visual_indent(0), context.config),
1284 shape.width.saturating_sub(2),
1288 fn choose_separator_tactic(context: &RewriteContext, span: Span) -> Option<SeparatorTactic> {
1289 if context.inside_macro() {
1290 if span_ends_with_comma(context, span) {
1291 Some(SeparatorTactic::Always)
1293 Some(SeparatorTactic::Never)
1300 pub fn rewrite_call(
1301 context: &RewriteContext,
1303 args: &[ptr::P<ast::Expr>],
1306 ) -> Option<String> {
1307 overflow::rewrite_with_parens(
1313 context.config.width_heuristics().fn_call_width,
1314 choose_separator_tactic(context, span),
1318 pub fn is_simple_expr(expr: &ast::Expr) -> bool {
1320 ast::ExprKind::Lit(..) => true,
1321 ast::ExprKind::Path(ref qself, ref path) => qself.is_none() && path.segments.len() <= 1,
1322 ast::ExprKind::AddrOf(_, ref expr)
1323 | ast::ExprKind::Box(ref expr)
1324 | ast::ExprKind::Cast(ref expr, _)
1325 | ast::ExprKind::Field(ref expr, _)
1326 | ast::ExprKind::Try(ref expr)
1327 | ast::ExprKind::Unary(_, ref expr) => is_simple_expr(expr),
1328 ast::ExprKind::Index(ref lhs, ref rhs) => is_simple_expr(lhs) && is_simple_expr(rhs),
1329 ast::ExprKind::Repeat(ref lhs, ref rhs) => {
1330 is_simple_expr(lhs) && is_simple_expr(&*rhs.value)
1336 pub fn is_every_expr_simple(lists: &[OverflowableItem]) -> bool {
1337 lists.iter().all(OverflowableItem::is_simple)
1340 pub fn can_be_overflowed_expr(context: &RewriteContext, expr: &ast::Expr, args_len: usize) -> bool {
1342 ast::ExprKind::Match(..) => {
1343 (context.use_block_indent() && args_len == 1)
1344 || (context.config.indent_style() == IndentStyle::Visual && args_len > 1)
1346 ast::ExprKind::If(..)
1347 | ast::ExprKind::IfLet(..)
1348 | ast::ExprKind::ForLoop(..)
1349 | ast::ExprKind::Loop(..)
1350 | ast::ExprKind::While(..)
1351 | ast::ExprKind::WhileLet(..) => {
1352 context.config.combine_control_expr() && context.use_block_indent() && args_len == 1
1355 // Handle always block-like expressions
1356 ast::ExprKind::Block(..) | ast::ExprKind::Closure(..) => true,
1358 // Handle `[]` and `{}`-like expressions
1359 ast::ExprKind::Array(..) | ast::ExprKind::Struct(..) => {
1360 context.config.overflow_delimited_expr()
1361 || (context.use_block_indent() && args_len == 1)
1363 ast::ExprKind::Mac(ref macro_) => {
1364 match (macro_.node.delim, context.config.overflow_delimited_expr()) {
1365 (ast::MacDelimiter::Bracket, true) | (ast::MacDelimiter::Brace, true) => true,
1366 _ => context.use_block_indent() && args_len == 1,
1370 // Handle parenthetical expressions
1371 ast::ExprKind::Call(..) | ast::ExprKind::MethodCall(..) | ast::ExprKind::Tup(..) => {
1372 context.use_block_indent() && args_len == 1
1375 // Handle unary-like expressions
1376 ast::ExprKind::AddrOf(_, ref expr)
1377 | ast::ExprKind::Box(ref expr)
1378 | ast::ExprKind::Try(ref expr)
1379 | ast::ExprKind::Unary(_, ref expr)
1380 | ast::ExprKind::Cast(ref expr, _) => can_be_overflowed_expr(context, expr, args_len),
1385 pub fn is_nested_call(expr: &ast::Expr) -> bool {
1387 ast::ExprKind::Call(..) | ast::ExprKind::Mac(..) => true,
1388 ast::ExprKind::AddrOf(_, ref expr)
1389 | ast::ExprKind::Box(ref expr)
1390 | ast::ExprKind::Try(ref expr)
1391 | ast::ExprKind::Unary(_, ref expr)
1392 | ast::ExprKind::Cast(ref expr, _) => is_nested_call(expr),
1397 /// Return true if a function call or a method call represented by the given span ends with a
1398 /// trailing comma. This function is used when rewriting macro, as adding or removing a trailing
1399 /// comma from macro can potentially break the code.
1400 pub fn span_ends_with_comma(context: &RewriteContext, span: Span) -> bool {
1401 let mut result: bool = Default::default();
1402 let mut prev_char: char = Default::default();
1403 let closing_delimiters = &[')', '}', ']'];
1405 for (kind, c) in CharClasses::new(context.snippet(span).chars()) {
1407 _ if kind.is_comment() || c.is_whitespace() => continue,
1408 c if closing_delimiters.contains(&c) => {
1409 result &= !closing_delimiters.contains(&prev_char);
1411 ',' => result = true,
1412 _ => result = false,
1421 context: &RewriteContext,
1422 mut subexpr: &ast::Expr,
1425 ) -> Option<String> {
1426 debug!("rewrite_paren, shape: {:?}", shape);
1428 // Extract comments within parens.
1431 let mut pre_comment;
1432 let mut post_comment;
1433 let remove_nested_parens = context.config.remove_nested_parens();
1436 pre_span = mk_sp(span.lo() + BytePos(1), subexpr.span.lo());
1437 post_span = mk_sp(subexpr.span.hi(), span.hi() - BytePos(1));
1438 pre_comment = rewrite_missing_comment(pre_span, shape, context)?;
1439 post_comment = rewrite_missing_comment(post_span, shape, context)?;
1441 // Remove nested parens if there are no comments.
1442 if let ast::ExprKind::Paren(ref subsubexpr) = subexpr.node {
1443 if remove_nested_parens && pre_comment.is_empty() && post_comment.is_empty() {
1444 span = subexpr.span;
1445 subexpr = subsubexpr;
1454 let sub_shape = shape.offset_left(1)?.sub_width(1)?;
1455 let subexpr_str = subexpr.rewrite(context, sub_shape)?;
1456 let fits_single_line = !pre_comment.contains("//") && !post_comment.contains("//");
1457 if fits_single_line {
1458 Some(format!("({}{}{})", pre_comment, &subexpr_str, post_comment))
1460 rewrite_paren_in_multi_line(context, subexpr, shape, pre_span, post_span)
1464 fn rewrite_paren_in_multi_line(
1465 context: &RewriteContext,
1466 subexpr: &ast::Expr,
1470 ) -> Option<String> {
1471 let nested_indent = shape.indent.block_indent(context.config);
1472 let nested_shape = Shape::indented(nested_indent, context.config);
1473 let pre_comment = rewrite_missing_comment(pre_span, nested_shape, context)?;
1474 let post_comment = rewrite_missing_comment(post_span, nested_shape, context)?;
1475 let subexpr_str = subexpr.rewrite(context, nested_shape)?;
1477 let mut result = String::with_capacity(subexpr_str.len() * 2);
1479 if !pre_comment.is_empty() {
1480 result.push_str(&nested_indent.to_string_with_newline(context.config));
1481 result.push_str(&pre_comment);
1483 result.push_str(&nested_indent.to_string_with_newline(context.config));
1484 result.push_str(&subexpr_str);
1485 if !post_comment.is_empty() {
1486 result.push_str(&nested_indent.to_string_with_newline(context.config));
1487 result.push_str(&post_comment);
1489 result.push_str(&shape.indent.to_string_with_newline(context.config));
1498 context: &RewriteContext,
1500 ) -> Option<String> {
1501 let expr_str = expr.rewrite(context, shape)?;
1503 let offset = last_line_width(&expr_str) + 1;
1504 let rhs_overhead = shape.rhs_overhead(context.config);
1505 let index_shape = if expr_str.contains('\n') {
1506 Shape::legacy(context.config.max_width(), shape.indent)
1507 .offset_left(offset)
1508 .and_then(|shape| shape.sub_width(1 + rhs_overhead))
1510 match context.config.indent_style() {
1511 IndentStyle::Block => shape
1512 .offset_left(offset)
1513 .and_then(|shape| shape.sub_width(1)),
1514 IndentStyle::Visual => shape.visual_indent(offset).sub_width(offset + 1),
1517 let orig_index_rw = index_shape.and_then(|s| index.rewrite(context, s));
1519 // Return if index fits in a single line.
1520 match orig_index_rw {
1521 Some(ref index_str) if !index_str.contains('\n') => {
1522 return Some(format!("{}[{}]", expr_str, index_str));
1527 // Try putting index on the next line and see if it fits in a single line.
1528 let indent = shape.indent.block_indent(context.config);
1529 let index_shape = Shape::indented(indent, context.config).offset_left(1)?;
1530 let index_shape = index_shape.sub_width(1 + rhs_overhead)?;
1531 let new_index_rw = index.rewrite(context, index_shape);
1532 match (orig_index_rw, new_index_rw) {
1533 (_, Some(ref new_index_str)) if !new_index_str.contains('\n') => Some(format!(
1536 indent.to_string_with_newline(context.config),
1539 (None, Some(ref new_index_str)) => Some(format!(
1542 indent.to_string_with_newline(context.config),
1545 (Some(ref index_str), _) => Some(format!("{}[{}]", expr_str, index_str)),
1550 fn struct_lit_can_be_aligned(fields: &[ast::Field], base: Option<&ast::Expr>) -> bool {
1555 fields.iter().all(|field| !field.is_shorthand)
1558 fn rewrite_struct_lit<'a>(
1559 context: &RewriteContext,
1561 fields: &'a [ast::Field],
1562 base: Option<&'a ast::Expr>,
1565 ) -> Option<String> {
1566 debug!("rewrite_struct_lit: shape {:?}", shape);
1568 enum StructLitField<'a> {
1569 Regular(&'a ast::Field),
1570 Base(&'a ast::Expr),
1574 let path_shape = shape.sub_width(2)?;
1575 let path_str = rewrite_path(context, PathContext::Expr, None, path, path_shape)?;
1577 if fields.is_empty() && base.is_none() {
1578 return Some(format!("{} {{}}", path_str));
1581 // Foo { a: Foo } - indent is +3, width is -5.
1582 let (h_shape, v_shape) = struct_lit_shape(shape, context, path_str.len() + 3, 2)?;
1584 let one_line_width = h_shape.map_or(0, |shape| shape.width);
1585 let body_lo = context.snippet_provider.span_after(span, "{");
1586 let fields_str = if struct_lit_can_be_aligned(fields, base)
1587 && context.config.struct_field_align_threshold() > 0
1589 rewrite_with_alignment(
1593 mk_sp(body_lo, span.hi()),
1597 let field_iter = fields
1599 .map(StructLitField::Regular)
1600 .chain(base.into_iter().map(StructLitField::Base));
1602 let span_lo = |item: &StructLitField| match *item {
1603 StructLitField::Regular(field) => field.span().lo(),
1604 StructLitField::Base(expr) => {
1605 let last_field_hi = fields.last().map_or(span.lo(), |field| field.span.hi());
1606 let snippet = context.snippet(mk_sp(last_field_hi, expr.span.lo()));
1607 let pos = snippet.find_uncommented("..").unwrap();
1608 last_field_hi + BytePos(pos as u32)
1611 let span_hi = |item: &StructLitField| match *item {
1612 StructLitField::Regular(field) => field.span().hi(),
1613 StructLitField::Base(expr) => expr.span.hi(),
1615 let rewrite = |item: &StructLitField| match *item {
1616 StructLitField::Regular(field) => {
1617 // The 1 taken from the v_budget is for the comma.
1618 rewrite_field(context, field, v_shape.sub_width(1)?, 0)
1620 StructLitField::Base(expr) => {
1622 expr.rewrite(context, v_shape.offset_left(2)?)
1623 .map(|s| format!("..{}", s))
1627 let items = itemize_list(
1628 context.snippet_provider,
1639 let item_vec = items.collect::<Vec<_>>();
1641 let tactic = struct_lit_tactic(h_shape, context, &item_vec);
1642 let nested_shape = shape_for_tactic(tactic, h_shape, v_shape);
1644 let ends_with_comma = span_ends_with_comma(context, span);
1645 let force_no_trailing_comma = context.inside_macro() && !ends_with_comma;
1647 let fmt = struct_lit_formatting(
1651 force_no_trailing_comma || base.is_some() || !context.use_block_indent(),
1654 write_list(&item_vec, &fmt)?
1657 let fields_str = wrap_struct_field(context, &fields_str, shape, v_shape, one_line_width);
1658 Some(format!("{} {{{}}}", path_str, fields_str))
1660 // FIXME if context.config.indent_style() == Visual, but we run out
1661 // of space, we should fall back to BlockIndent.
1664 pub fn wrap_struct_field(
1665 context: &RewriteContext,
1668 nested_shape: Shape,
1669 one_line_width: usize,
1671 if context.config.indent_style() == IndentStyle::Block
1672 && (fields_str.contains('\n')
1673 || !context.config.struct_lit_single_line()
1674 || fields_str.len() > one_line_width)
1678 nested_shape.indent.to_string_with_newline(context.config),
1680 shape.indent.to_string_with_newline(context.config)
1683 // One liner or visual indent.
1684 format!(" {} ", fields_str)
1688 pub fn struct_lit_field_separator(config: &Config) -> &str {
1689 colon_spaces(config.space_before_colon(), config.space_after_colon())
1692 pub fn rewrite_field(
1693 context: &RewriteContext,
1696 prefix_max_width: usize,
1697 ) -> Option<String> {
1698 if contains_skip(&field.attrs) {
1699 return Some(context.snippet(field.span()).to_owned());
1701 let mut attrs_str = field.attrs.rewrite(context, shape)?;
1702 if !attrs_str.is_empty() {
1703 attrs_str.push_str(&shape.indent.to_string_with_newline(context.config));
1705 let name = context.snippet(field.ident.span);
1706 if field.is_shorthand {
1707 Some(attrs_str + name)
1709 let mut separator = String::from(struct_lit_field_separator(context.config));
1710 for _ in 0..prefix_max_width.saturating_sub(name.len()) {
1711 separator.push(' ');
1713 let overhead = name.len() + separator.len();
1714 let expr_shape = shape.offset_left(overhead)?;
1715 let expr = field.expr.rewrite(context, expr_shape);
1718 Some(ref e) if e.as_str() == name && context.config.use_field_init_shorthand() => {
1719 Some(attrs_str + name)
1721 Some(e) => Some(format!("{}{}{}{}", attrs_str, name, separator, e)),
1723 let expr_offset = shape.indent.block_indent(context.config);
1726 .rewrite(context, Shape::indented(expr_offset, context.config));
1732 expr_offset.to_string(context.config),
1741 fn rewrite_tuple_in_visual_indent_style<'a, T: 'a + IntoOverflowableItem<'a>>(
1742 context: &RewriteContext,
1743 mut items: impl Iterator<Item = &'a T>,
1746 is_singleton_tuple: bool,
1747 ) -> Option<String> {
1748 // In case of length 1, need a trailing comma
1749 debug!("rewrite_tuple_in_visual_indent_style {:?}", shape);
1750 if is_singleton_tuple {
1752 let nested_shape = shape.sub_width(3)?.visual_indent(1);
1756 .rewrite(context, nested_shape)
1757 .map(|s| format!("({},)", s));
1760 let list_lo = context.snippet_provider.span_after(span, "(");
1761 let nested_shape = shape.sub_width(2)?.visual_indent(1);
1762 let items = itemize_list(
1763 context.snippet_provider,
1767 |item| item.span().lo(),
1768 |item| item.span().hi(),
1769 |item| item.rewrite(context, nested_shape),
1771 span.hi() - BytePos(1),
1774 let item_vec: Vec<_> = items.collect();
1775 let tactic = definitive_tactic(
1777 ListTactic::HorizontalVertical,
1781 let fmt = ListFormatting::new(nested_shape, context.config)
1783 .ends_with_newline(false);
1784 let list_str = write_list(&item_vec, &fmt)?;
1786 Some(format!("({})", list_str))
1789 pub fn rewrite_tuple<'a, T: 'a + IntoOverflowableItem<'a>>(
1790 context: &'a RewriteContext,
1791 items: impl Iterator<Item = &'a T>,
1794 is_singleton_tuple: bool,
1795 ) -> Option<String> {
1796 debug!("rewrite_tuple {:?}", shape);
1797 if context.use_block_indent() {
1798 // We use the same rule as function calls for rewriting tuples.
1799 let force_tactic = if context.inside_macro() {
1800 if span_ends_with_comma(context, span) {
1801 Some(SeparatorTactic::Always)
1803 Some(SeparatorTactic::Never)
1805 } else if is_singleton_tuple {
1806 Some(SeparatorTactic::Always)
1810 overflow::rewrite_with_parens(
1816 context.config.width_heuristics().fn_call_width,
1820 rewrite_tuple_in_visual_indent_style(context, items, span, shape, is_singleton_tuple)
1824 pub fn rewrite_unary_prefix<R: Rewrite>(
1825 context: &RewriteContext,
1829 ) -> Option<String> {
1831 .rewrite(context, shape.offset_left(prefix.len())?)
1832 .map(|r| format!("{}{}", prefix, r))
1835 // FIXME: this is probably not correct for multi-line Rewrites. we should
1836 // subtract suffix.len() from the last line budget, not the first!
1837 pub fn rewrite_unary_suffix<R: Rewrite>(
1838 context: &RewriteContext,
1842 ) -> Option<String> {
1844 .rewrite(context, shape.sub_width(suffix.len())?)
1851 fn rewrite_unary_op(
1852 context: &RewriteContext,
1856 ) -> Option<String> {
1857 // For some reason, an UnOp is not spanned like BinOp!
1858 rewrite_unary_prefix(context, ast::UnOp::to_string(op), expr, shape)
1861 fn rewrite_assignment(
1862 context: &RewriteContext,
1865 op: Option<&ast::BinOp>,
1867 ) -> Option<String> {
1868 let operator_str = match op {
1869 Some(op) => context.snippet(op.span),
1873 // 1 = space between lhs and operator.
1874 let lhs_shape = shape.sub_width(operator_str.len() + 1)?;
1875 let lhs_str = format!("{} {}", lhs.rewrite(context, lhs_shape)?, operator_str);
1877 rewrite_assign_rhs(context, lhs_str, rhs, shape)
1880 /// Controls where to put the rhs.
1881 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
1882 pub enum RhsTactics {
1885 /// Put the rhs on the next line if it uses multiple line, without extra indentation.
1886 ForceNextLineWithoutIndent,
1889 // The left hand side must contain everything up to, and including, the
1890 // assignment operator.
1891 pub fn rewrite_assign_rhs<S: Into<String>, R: Rewrite>(
1892 context: &RewriteContext,
1896 ) -> Option<String> {
1897 rewrite_assign_rhs_with(context, lhs, ex, shape, RhsTactics::Default)
1900 pub fn rewrite_assign_rhs_with<S: Into<String>, R: Rewrite>(
1901 context: &RewriteContext,
1905 rhs_tactics: RhsTactics,
1906 ) -> Option<String> {
1907 let lhs = lhs.into();
1908 let last_line_width = last_line_width(&lhs).saturating_sub(if lhs.contains('\n') {
1909 shape.indent.width()
1913 // 1 = space between operator and rhs.
1914 let orig_shape = shape.offset_left(last_line_width + 1).unwrap_or(Shape {
1916 offset: shape.offset + last_line_width + 1,
1919 let rhs = choose_rhs(
1923 ex.rewrite(context, orig_shape),
1929 fn choose_rhs<R: Rewrite>(
1930 context: &RewriteContext,
1933 orig_rhs: Option<String>,
1934 rhs_tactics: RhsTactics,
1935 ) -> Option<String> {
1937 Some(ref new_str) if !new_str.contains('\n') && new_str.len() <= shape.width => {
1938 Some(format!(" {}", new_str))
1941 // Expression did not fit on the same line as the identifier.
1942 // Try splitting the line and see if that works better.
1943 let new_shape = shape_from_rhs_tactic(context, shape, rhs_tactics)?;
1944 let new_rhs = expr.rewrite(context, new_shape);
1945 let new_indent_str = &shape
1947 .block_indent(context.config)
1948 .to_string_with_newline(context.config);
1950 match (orig_rhs, new_rhs) {
1951 (Some(ref orig_rhs), Some(ref new_rhs))
1952 if wrap_str(new_rhs.clone(), context.config.max_width(), new_shape)
1955 Some(format!(" {}", orig_rhs))
1957 (Some(ref orig_rhs), Some(ref new_rhs))
1958 if prefer_next_line(orig_rhs, new_rhs, rhs_tactics) =>
1960 Some(format!("{}{}", new_indent_str, new_rhs))
1962 (None, Some(ref new_rhs)) => Some(format!("{}{}", new_indent_str, new_rhs)),
1963 (None, None) => None,
1964 (Some(orig_rhs), _) => Some(format!(" {}", orig_rhs)),
1970 fn shape_from_rhs_tactic(
1971 context: &RewriteContext,
1973 rhs_tactic: RhsTactics,
1974 ) -> Option<Shape> {
1976 RhsTactics::ForceNextLineWithoutIndent => shape
1977 .with_max_width(context.config)
1978 .sub_width(shape.indent.width()),
1979 RhsTactics::Default => {
1980 Shape::indented(shape.indent.block_indent(context.config), context.config)
1981 .sub_width(shape.rhs_overhead(context.config))
1986 pub fn prefer_next_line(orig_rhs: &str, next_line_rhs: &str, rhs_tactics: RhsTactics) -> bool {
1987 rhs_tactics == RhsTactics::ForceNextLineWithoutIndent
1988 || !next_line_rhs.contains('\n')
1989 || count_newlines(orig_rhs) > count_newlines(next_line_rhs) + 1
1990 || first_line_ends_with(orig_rhs, '(') && !first_line_ends_with(next_line_rhs, '(')
1991 || first_line_ends_with(orig_rhs, '{') && !first_line_ends_with(next_line_rhs, '{')
1992 || first_line_ends_with(orig_rhs, '[') && !first_line_ends_with(next_line_rhs, '[')
1995 fn rewrite_expr_addrof(
1996 context: &RewriteContext,
1997 mutability: ast::Mutability,
2000 ) -> Option<String> {
2001 let operator_str = match mutability {
2002 ast::Mutability::Immutable => "&",
2003 ast::Mutability::Mutable => "&mut ",
2005 rewrite_unary_prefix(context, operator_str, expr, shape)
2008 pub fn is_method_call(expr: &ast::Expr) -> bool {
2010 ast::ExprKind::MethodCall(..) => true,
2011 ast::ExprKind::AddrOf(_, ref expr)
2012 | ast::ExprKind::Box(ref expr)
2013 | ast::ExprKind::Cast(ref expr, _)
2014 | ast::ExprKind::Try(ref expr)
2015 | ast::ExprKind::Unary(_, ref expr) => is_method_call(expr),
2022 use super::last_line_offsetted;
2025 fn test_last_line_offsetted() {
2026 let lines = "one\n two";
2027 assert_eq!(last_line_offsetted(2, lines), true);
2028 assert_eq!(last_line_offsetted(4, lines), false);
2029 assert_eq!(last_line_offsetted(6, lines), false);
2031 let lines = "one two";
2032 assert_eq!(last_line_offsetted(2, lines), false);
2033 assert_eq!(last_line_offsetted(0, lines), false);
2035 let lines = "\ntwo";
2036 assert_eq!(last_line_offsetted(2, lines), false);
2037 assert_eq!(last_line_offsetted(0, lines), false);
2039 let lines = "one\n two three";
2040 assert_eq!(last_line_offsetted(2, lines), true);
2041 let lines = "one\n two three";
2042 assert_eq!(last_line_offsetted(2, lines), false);