]> git.lizzy.rs Git - rust.git/blob - src/expr.rs
Use concat() instead of join("")
[rust.git] / src / expr.rs
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.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 use std::borrow::Cow;
12 use std::cmp::min;
13
14 use config::lists::*;
15 use syntax::parse::token::DelimToken;
16 use syntax::source_map::{BytePos, SourceMap, Span};
17 use syntax::{ast, ptr};
18
19 use chains::rewrite_chain;
20 use closures;
21 use comment::{
22     combine_strs_with_missing_comments, contains_comment, recover_comment_removed, rewrite_comment,
23     rewrite_missing_comment, CharClasses, FindUncommented,
24 };
25 use config::{Config, ControlBraceStyle, IndentStyle};
26 use lists::{
27     definitive_tactic, itemize_list, shape_for_tactic, struct_lit_formatting, struct_lit_shape,
28     struct_lit_tactic, write_list, ListFormatting, ListItem, Separator,
29 };
30 use macros::{rewrite_macro, MacroPosition};
31 use matches::rewrite_match;
32 use overflow::{self, IntoOverflowableItem, OverflowableItem};
33 use pairs::{rewrite_all_pairs, rewrite_pair, PairParts};
34 use patterns::is_short_pattern;
35 use rewrite::{Rewrite, RewriteContext};
36 use shape::{Indent, Shape};
37 use source_map::{LineRangeUtils, SpanUtils};
38 use spanned::Spanned;
39 use string::{rewrite_string, StringFormat};
40 use types::{rewrite_path, PathContext};
41 use utils::{
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_stmt, wrap_str,
45 };
46 use vertical::rewrite_with_alignment;
47 use visitor::FmtVisitor;
48
49 impl Rewrite for ast::Expr {
50     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
51         format_expr(self, ExprType::SubExpression, context, shape)
52     }
53 }
54
55 #[derive(Copy, Clone, PartialEq)]
56 pub enum ExprType {
57     Statement,
58     SubExpression,
59 }
60
61 pub fn format_expr(
62     expr: &ast::Expr,
63     expr_type: ExprType,
64     context: &RewriteContext,
65     shape: Shape,
66 ) -> Option<String> {
67     skip_out_of_file_lines_range!(context, expr.span);
68
69     if contains_skip(&*expr.attrs) {
70         return Some(context.snippet(expr.span()).to_owned());
71     }
72
73     let expr_rw = match expr.node {
74         ast::ExprKind::Array(ref expr_vec) => rewrite_array(
75             "",
76             expr_vec.iter(),
77             expr.span,
78             context,
79             shape,
80             choose_separator_tactic(context, expr.span),
81             None,
82         ),
83         ast::ExprKind::Lit(ref l) => rewrite_literal(context, l, shape),
84         ast::ExprKind::Call(ref callee, ref args) => {
85             let inner_span = mk_sp(callee.span.hi(), expr.span.hi());
86             let callee_str = callee.rewrite(context, shape)?;
87             rewrite_call(context, &callee_str, args, inner_span, shape)
88         }
89         ast::ExprKind::Paren(ref subexpr) => rewrite_paren(context, subexpr, shape, expr.span),
90         ast::ExprKind::Binary(op, ref lhs, ref rhs) => {
91             // FIXME: format comments between operands and operator
92             rewrite_all_pairs(expr, shape, context).or_else(|| {
93                 rewrite_pair(
94                     &**lhs,
95                     &**rhs,
96                     PairParts::infix(&format!(" {} ", context.snippet(op.span))),
97                     context,
98                     shape,
99                     context.config.binop_separator(),
100                 )
101             })
102         }
103         ast::ExprKind::Unary(op, ref subexpr) => rewrite_unary_op(context, op, subexpr, shape),
104         ast::ExprKind::Struct(ref path, ref fields, ref base) => rewrite_struct_lit(
105             context,
106             path,
107             fields,
108             base.as_ref().map(|e| &**e),
109             expr.span,
110             shape,
111         ),
112         ast::ExprKind::Tup(ref items) => {
113             rewrite_tuple(context, items.iter(), expr.span, shape, items.len() == 1)
114         }
115         ast::ExprKind::If(..)
116         | ast::ExprKind::IfLet(..)
117         | ast::ExprKind::ForLoop(..)
118         | ast::ExprKind::Loop(..)
119         | ast::ExprKind::While(..)
120         | ast::ExprKind::WhileLet(..) => to_control_flow(expr, expr_type)
121             .and_then(|control_flow| control_flow.rewrite(context, shape)),
122         ast::ExprKind::Block(ref block, opt_label) => {
123             match expr_type {
124                 ExprType::Statement => {
125                     if is_unsafe_block(block) {
126                         rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)
127                     } else if let rw @ Some(_) =
128                         rewrite_empty_block(context, block, Some(&expr.attrs), opt_label, "", shape)
129                     {
130                         // Rewrite block without trying to put it in a single line.
131                         rw
132                     } else {
133                         let prefix = block_prefix(context, block, shape)?;
134
135                         rewrite_block_with_visitor(
136                             context,
137                             &prefix,
138                             block,
139                             Some(&expr.attrs),
140                             opt_label,
141                             shape,
142                             true,
143                         )
144                     }
145                 }
146                 ExprType::SubExpression => {
147                     rewrite_block(block, Some(&expr.attrs), opt_label, context, shape)
148                 }
149             }
150         }
151         ast::ExprKind::Match(ref cond, ref arms) => {
152             rewrite_match(context, cond, arms, shape, expr.span, &expr.attrs)
153         }
154         ast::ExprKind::Path(ref qself, ref path) => {
155             rewrite_path(context, PathContext::Expr, qself.as_ref(), path, shape)
156         }
157         ast::ExprKind::Assign(ref lhs, ref rhs) => {
158             rewrite_assignment(context, lhs, rhs, None, shape)
159         }
160         ast::ExprKind::AssignOp(ref op, ref lhs, ref rhs) => {
161             rewrite_assignment(context, lhs, rhs, Some(op), shape)
162         }
163         ast::ExprKind::Continue(ref opt_label) => {
164             let id_str = match *opt_label {
165                 Some(label) => format!(" {}", label.ident),
166                 None => String::new(),
167             };
168             Some(format!("continue{}", id_str))
169         }
170         ast::ExprKind::Break(ref opt_label, ref opt_expr) => {
171             let id_str = match *opt_label {
172                 Some(label) => format!(" {}", label.ident),
173                 None => String::new(),
174             };
175
176             if let Some(ref expr) = *opt_expr {
177                 rewrite_unary_prefix(context, &format!("break{} ", id_str), &**expr, shape)
178             } else {
179                 Some(format!("break{}", id_str))
180             }
181         }
182         ast::ExprKind::Yield(ref opt_expr) => {
183             if let Some(ref expr) = *opt_expr {
184                 rewrite_unary_prefix(context, "yield ", &**expr, shape)
185             } else {
186                 Some("yield".to_string())
187             }
188         }
189         ast::ExprKind::Closure(capture, asyncness, movability, ref fn_decl, ref body, _) => {
190             closures::rewrite_closure(
191                 capture, asyncness, movability, fn_decl, body, expr.span, context, shape,
192             )
193         }
194         ast::ExprKind::Try(..) | ast::ExprKind::Field(..) | ast::ExprKind::MethodCall(..) => {
195             rewrite_chain(expr, context, shape)
196         }
197         ast::ExprKind::Mac(ref mac) => {
198             rewrite_macro(mac, None, context, shape, MacroPosition::Expression).or_else(|| {
199                 wrap_str(
200                     context.snippet(expr.span).to_owned(),
201                     context.config.max_width(),
202                     shape,
203                 )
204             })
205         }
206         ast::ExprKind::Ret(None) => Some("return".to_owned()),
207         ast::ExprKind::Ret(Some(ref expr)) => {
208             rewrite_unary_prefix(context, "return ", &**expr, shape)
209         }
210         ast::ExprKind::Box(ref expr) => rewrite_unary_prefix(context, "box ", &**expr, shape),
211         ast::ExprKind::AddrOf(mutability, ref expr) => {
212             rewrite_expr_addrof(context, mutability, expr, shape)
213         }
214         ast::ExprKind::Cast(ref expr, ref ty) => rewrite_pair(
215             &**expr,
216             &**ty,
217             PairParts::infix(" as "),
218             context,
219             shape,
220             SeparatorPlace::Front,
221         ),
222         ast::ExprKind::Type(ref expr, ref ty) => rewrite_pair(
223             &**expr,
224             &**ty,
225             PairParts::infix(": "),
226             context,
227             shape,
228             SeparatorPlace::Back,
229         ),
230         ast::ExprKind::Index(ref expr, ref index) => {
231             rewrite_index(&**expr, &**index, context, shape)
232         }
233         ast::ExprKind::Repeat(ref expr, ref repeats) => rewrite_pair(
234             &**expr,
235             &*repeats.value,
236             PairParts::new("[", "; ", "]"),
237             context,
238             shape,
239             SeparatorPlace::Back,
240         ),
241         ast::ExprKind::Range(ref lhs, ref rhs, limits) => {
242             let delim = match limits {
243                 ast::RangeLimits::HalfOpen => "..",
244                 ast::RangeLimits::Closed => "..=",
245             };
246
247             fn needs_space_before_range(context: &RewriteContext, lhs: &ast::Expr) -> bool {
248                 match lhs.node {
249                     ast::ExprKind::Lit(ref lit) => match lit.node {
250                         ast::LitKind::FloatUnsuffixed(..) => {
251                             context.snippet(lit.span).ends_with('.')
252                         }
253                         _ => false,
254                     },
255                     _ => false,
256                 }
257             }
258
259             fn needs_space_after_range(rhs: &ast::Expr) -> bool {
260                 match rhs.node {
261                     // Don't format `.. ..` into `....`, which is invalid.
262                     //
263                     // This check is unnecessary for `lhs`, because a range
264                     // starting from another range needs parentheses as `(x ..) ..`
265                     // (`x .. ..` is a range from `x` to `..`).
266                     ast::ExprKind::Range(None, _, _) => true,
267                     _ => false,
268                 }
269             }
270
271             let default_sp_delim = |lhs: Option<&ast::Expr>, rhs: Option<&ast::Expr>| {
272                 let space_if = |b: bool| if b { " " } else { "" };
273
274                 format!(
275                     "{}{}{}",
276                     lhs.map_or("", |lhs| space_if(needs_space_before_range(context, lhs))),
277                     delim,
278                     rhs.map_or("", |rhs| space_if(needs_space_after_range(rhs))),
279                 )
280             };
281
282             match (lhs.as_ref().map(|x| &**x), rhs.as_ref().map(|x| &**x)) {
283                 (Some(lhs), Some(rhs)) => {
284                     let sp_delim = if context.config.spaces_around_ranges() {
285                         format!(" {} ", delim)
286                     } else {
287                         default_sp_delim(Some(lhs), Some(rhs))
288                     };
289                     rewrite_pair(
290                         &*lhs,
291                         &*rhs,
292                         PairParts::infix(&sp_delim),
293                         context,
294                         shape,
295                         context.config.binop_separator(),
296                     )
297                 }
298                 (None, Some(rhs)) => {
299                     let sp_delim = if context.config.spaces_around_ranges() {
300                         format!("{} ", delim)
301                     } else {
302                         default_sp_delim(None, Some(rhs))
303                     };
304                     rewrite_unary_prefix(context, &sp_delim, &*rhs, shape)
305                 }
306                 (Some(lhs), None) => {
307                     let sp_delim = if context.config.spaces_around_ranges() {
308                         format!(" {}", delim)
309                     } else {
310                         default_sp_delim(Some(lhs), None)
311                     };
312                     rewrite_unary_suffix(context, &sp_delim, &*lhs, shape)
313                 }
314                 (None, None) => Some(delim.to_owned()),
315             }
316         }
317         // We do not format these expressions yet, but they should still
318         // satisfy our width restrictions.
319         ast::ExprKind::InlineAsm(..) => Some(context.snippet(expr.span).to_owned()),
320         ast::ExprKind::TryBlock(ref block) => {
321             if let rw @ Some(_) =
322                 rewrite_single_line_block(context, "try ", block, Some(&expr.attrs), None, shape)
323             {
324                 rw
325             } else {
326                 // 9 = `try `
327                 let budget = shape.width.saturating_sub(9);
328                 Some(format!(
329                     "{}{}",
330                     "try ",
331                     rewrite_block(
332                         block,
333                         Some(&expr.attrs),
334                         None,
335                         context,
336                         Shape::legacy(budget, shape.indent)
337                     )?
338                 ))
339             }
340         }
341         ast::ExprKind::ObsoleteInPlace(ref lhs, ref rhs) => lhs
342             .rewrite(context, shape)
343             .map(|s| s + " <-")
344             .and_then(|lhs| rewrite_assign_rhs(context, lhs, &**rhs, shape)),
345         ast::ExprKind::Async(capture_by, _node_id, ref block) => {
346             let mover = if capture_by == ast::CaptureBy::Value {
347                 "move "
348             } else {
349                 ""
350             };
351             if let rw @ Some(_) = rewrite_single_line_block(
352                 context,
353                 format!("{}{}", "async ", mover).as_str(),
354                 block,
355                 Some(&expr.attrs),
356                 None,
357                 shape,
358             ) {
359                 rw
360             } else {
361                 // 6 = `async `
362                 let budget = shape.width.saturating_sub(6);
363                 Some(format!(
364                     "{}{}{}",
365                     "async ",
366                     mover,
367                     rewrite_block(
368                         block,
369                         Some(&expr.attrs),
370                         None,
371                         context,
372                         Shape::legacy(budget, shape.indent)
373                     )?
374                 ))
375             }
376         }
377     };
378
379     expr_rw
380         .and_then(|expr_str| recover_comment_removed(expr_str, expr.span, context))
381         .and_then(|expr_str| {
382             let attrs = outer_attributes(&expr.attrs);
383             let attrs_str = attrs.rewrite(context, shape)?;
384             let span = mk_sp(
385                 attrs.last().map_or(expr.span.lo(), |attr| attr.span.hi()),
386                 expr.span.lo(),
387             );
388             combine_strs_with_missing_comments(context, &attrs_str, &expr_str, span, shape, false)
389         })
390 }
391
392 pub fn rewrite_array<'a, T: 'a + IntoOverflowableItem<'a>>(
393     name: &'a str,
394     exprs: impl Iterator<Item = &'a T>,
395     span: Span,
396     context: &'a RewriteContext,
397     shape: Shape,
398     force_separator_tactic: Option<SeparatorTactic>,
399     delim_token: Option<DelimToken>,
400 ) -> Option<String> {
401     overflow::rewrite_with_square_brackets(
402         context,
403         name,
404         exprs,
405         shape,
406         span,
407         force_separator_tactic,
408         delim_token,
409     )
410 }
411
412 fn rewrite_empty_block(
413     context: &RewriteContext,
414     block: &ast::Block,
415     attrs: Option<&[ast::Attribute]>,
416     label: Option<ast::Label>,
417     prefix: &str,
418     shape: Shape,
419 ) -> Option<String> {
420     let label_str = rewrite_label(label);
421     if attrs.map_or(false, |a| !inner_attributes(a).is_empty()) {
422         return None;
423     }
424
425     if block.stmts.is_empty()
426         && !block_contains_comment(block, context.source_map)
427         && shape.width >= 2
428     {
429         return Some(format!("{}{}{{}}", prefix, label_str));
430     }
431
432     // If a block contains only a single-line comment, then leave it on one line.
433     let user_str = context.snippet(block.span);
434     let user_str = user_str.trim();
435     if user_str.starts_with('{') && user_str.ends_with('}') {
436         let comment_str = user_str[1..user_str.len() - 1].trim();
437         if block.stmts.is_empty()
438             && !comment_str.contains('\n')
439             && !comment_str.starts_with("//")
440             && comment_str.len() + 4 <= shape.width
441         {
442             return Some(format!("{}{}{{ {} }}", prefix, label_str, comment_str));
443         }
444     }
445
446     None
447 }
448
449 fn block_prefix(context: &RewriteContext, block: &ast::Block, shape: Shape) -> Option<String> {
450     Some(match block.rules {
451         ast::BlockCheckMode::Unsafe(..) => {
452             let snippet = context.snippet(block.span);
453             let open_pos = snippet.find_uncommented("{")?;
454             // Extract comment between unsafe and block start.
455             let trimmed = &snippet[6..open_pos].trim();
456
457             if !trimmed.is_empty() {
458                 // 9 = "unsafe  {".len(), 7 = "unsafe ".len()
459                 let budget = shape.width.checked_sub(9)?;
460                 format!(
461                     "unsafe {} ",
462                     rewrite_comment(
463                         trimmed,
464                         true,
465                         Shape::legacy(budget, shape.indent + 7),
466                         context.config,
467                     )?
468                 )
469             } else {
470                 "unsafe ".to_owned()
471             }
472         }
473         ast::BlockCheckMode::Default => String::new(),
474     })
475 }
476
477 fn rewrite_single_line_block(
478     context: &RewriteContext,
479     prefix: &str,
480     block: &ast::Block,
481     attrs: Option<&[ast::Attribute]>,
482     label: Option<ast::Label>,
483     shape: Shape,
484 ) -> Option<String> {
485     if is_simple_block(block, attrs, context.source_map) {
486         let expr_shape = shape.offset_left(last_line_width(prefix))?;
487         let expr_str = block.stmts[0].rewrite(context, expr_shape)?;
488         let label_str = rewrite_label(label);
489         let result = format!("{}{}{{ {} }}", prefix, label_str, expr_str);
490         if result.len() <= shape.width && !result.contains('\n') {
491             return Some(result);
492         }
493     }
494     None
495 }
496
497 pub fn rewrite_block_with_visitor(
498     context: &RewriteContext,
499     prefix: &str,
500     block: &ast::Block,
501     attrs: Option<&[ast::Attribute]>,
502     label: Option<ast::Label>,
503     shape: Shape,
504     has_braces: bool,
505 ) -> Option<String> {
506     if let rw @ Some(_) = rewrite_empty_block(context, block, attrs, label, prefix, shape) {
507         return rw;
508     }
509
510     let mut visitor = FmtVisitor::from_context(context);
511     visitor.block_indent = shape.indent;
512     visitor.is_if_else_block = context.is_if_else_block();
513     match block.rules {
514         ast::BlockCheckMode::Unsafe(..) => {
515             let snippet = context.snippet(block.span);
516             let open_pos = snippet.find_uncommented("{")?;
517             visitor.last_pos = block.span.lo() + BytePos(open_pos as u32)
518         }
519         ast::BlockCheckMode::Default => visitor.last_pos = block.span.lo(),
520     }
521
522     let inner_attrs = attrs.map(inner_attributes);
523     let label_str = rewrite_label(label);
524     visitor.visit_block(block, inner_attrs.as_ref().map(|a| &**a), has_braces);
525     Some(format!("{}{}{}", prefix, label_str, visitor.buffer))
526 }
527
528 impl Rewrite for ast::Block {
529     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
530         rewrite_block(self, None, None, context, shape)
531     }
532 }
533
534 fn rewrite_block(
535     block: &ast::Block,
536     attrs: Option<&[ast::Attribute]>,
537     label: Option<ast::Label>,
538     context: &RewriteContext,
539     shape: Shape,
540 ) -> Option<String> {
541     let prefix = block_prefix(context, block, shape)?;
542
543     // shape.width is used only for the single line case: either the empty block `{}`,
544     // or an unsafe expression `unsafe { e }`.
545     if let rw @ Some(_) = rewrite_empty_block(context, block, attrs, label, &prefix, shape) {
546         return rw;
547     }
548
549     let result = rewrite_block_with_visitor(context, &prefix, block, attrs, label, shape, true);
550     if let Some(ref result_str) = result {
551         if result_str.lines().count() <= 3 {
552             if let rw @ Some(_) =
553                 rewrite_single_line_block(context, &prefix, block, attrs, label, shape)
554             {
555                 return rw;
556             }
557         }
558     }
559
560     result
561 }
562
563 impl Rewrite for ast::Stmt {
564     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
565         skip_out_of_file_lines_range!(context, self.span());
566
567         let result = match self.node {
568             ast::StmtKind::Local(ref local) => local.rewrite(context, shape),
569             ast::StmtKind::Expr(ref ex) | ast::StmtKind::Semi(ref ex) => {
570                 let suffix = if semicolon_for_stmt(context, self) {
571                     ";"
572                 } else {
573                     ""
574                 };
575
576                 let shape = shape.sub_width(suffix.len())?;
577                 format_expr(ex, ExprType::Statement, context, shape).map(|s| s + suffix)
578             }
579             ast::StmtKind::Mac(..) | ast::StmtKind::Item(..) => None,
580         };
581         result.and_then(|res| recover_comment_removed(res, self.span(), context))
582     }
583 }
584
585 // Rewrite condition if the given expression has one.
586 pub fn rewrite_cond(context: &RewriteContext, expr: &ast::Expr, shape: Shape) -> Option<String> {
587     match expr.node {
588         ast::ExprKind::Match(ref cond, _) => {
589             // `match `cond` {`
590             let cond_shape = match context.config.indent_style() {
591                 IndentStyle::Visual => shape.shrink_left(6).and_then(|s| s.sub_width(2))?,
592                 IndentStyle::Block => shape.offset_left(8)?,
593             };
594             cond.rewrite(context, cond_shape)
595         }
596         _ => to_control_flow(expr, ExprType::SubExpression).and_then(|control_flow| {
597             let alt_block_sep =
598                 String::from("\n") + &shape.indent.block_only().to_string(context.config);
599             control_flow
600                 .rewrite_cond(context, shape, &alt_block_sep)
601                 .and_then(|rw| Some(rw.0))
602         }),
603     }
604 }
605
606 // Abstraction over control flow expressions
607 #[derive(Debug)]
608 struct ControlFlow<'a> {
609     cond: Option<&'a ast::Expr>,
610     block: &'a ast::Block,
611     else_block: Option<&'a ast::Expr>,
612     label: Option<ast::Label>,
613     pats: Vec<&'a ast::Pat>,
614     keyword: &'a str,
615     matcher: &'a str,
616     connector: &'a str,
617     allow_single_line: bool,
618     // True if this is an `if` expression in an `else if` :-( hacky
619     nested_if: bool,
620     span: Span,
621 }
622
623 fn to_control_flow(expr: &ast::Expr, expr_type: ExprType) -> Option<ControlFlow> {
624     match expr.node {
625         ast::ExprKind::If(ref cond, ref if_block, ref else_block) => Some(ControlFlow::new_if(
626             cond,
627             vec![],
628             if_block,
629             else_block.as_ref().map(|e| &**e),
630             expr_type == ExprType::SubExpression,
631             false,
632             expr.span,
633         )),
634         ast::ExprKind::IfLet(ref pat, ref cond, ref if_block, ref else_block) => {
635             Some(ControlFlow::new_if(
636                 cond,
637                 ptr_vec_to_ref_vec(pat),
638                 if_block,
639                 else_block.as_ref().map(|e| &**e),
640                 expr_type == ExprType::SubExpression,
641                 false,
642                 expr.span,
643             ))
644         }
645         ast::ExprKind::ForLoop(ref pat, ref cond, ref block, label) => {
646             Some(ControlFlow::new_for(pat, cond, block, label, expr.span))
647         }
648         ast::ExprKind::Loop(ref block, label) => {
649             Some(ControlFlow::new_loop(block, label, expr.span))
650         }
651         ast::ExprKind::While(ref cond, ref block, label) => Some(ControlFlow::new_while(
652             vec![],
653             cond,
654             block,
655             label,
656             expr.span,
657         )),
658         ast::ExprKind::WhileLet(ref pat, ref cond, ref block, label) => Some(
659             ControlFlow::new_while(ptr_vec_to_ref_vec(pat), cond, block, label, expr.span),
660         ),
661         _ => None,
662     }
663 }
664
665 fn choose_matcher(pats: &[&ast::Pat]) -> &'static str {
666     if pats.is_empty() {
667         ""
668     } else {
669         "let"
670     }
671 }
672
673 impl<'a> ControlFlow<'a> {
674     fn new_if(
675         cond: &'a ast::Expr,
676         pats: Vec<&'a ast::Pat>,
677         block: &'a ast::Block,
678         else_block: Option<&'a ast::Expr>,
679         allow_single_line: bool,
680         nested_if: bool,
681         span: Span,
682     ) -> ControlFlow<'a> {
683         let matcher = choose_matcher(&pats);
684         ControlFlow {
685             cond: Some(cond),
686             block,
687             else_block,
688             label: None,
689             pats,
690             keyword: "if",
691             matcher,
692             connector: " =",
693             allow_single_line,
694             nested_if,
695             span,
696         }
697     }
698
699     fn new_loop(block: &'a ast::Block, label: Option<ast::Label>, span: Span) -> ControlFlow<'a> {
700         ControlFlow {
701             cond: None,
702             block,
703             else_block: None,
704             label,
705             pats: vec![],
706             keyword: "loop",
707             matcher: "",
708             connector: "",
709             allow_single_line: false,
710             nested_if: false,
711             span,
712         }
713     }
714
715     fn new_while(
716         pats: Vec<&'a ast::Pat>,
717         cond: &'a ast::Expr,
718         block: &'a ast::Block,
719         label: Option<ast::Label>,
720         span: Span,
721     ) -> ControlFlow<'a> {
722         let matcher = choose_matcher(&pats);
723         ControlFlow {
724             cond: Some(cond),
725             block,
726             else_block: None,
727             label,
728             pats,
729             keyword: "while",
730             matcher,
731             connector: " =",
732             allow_single_line: false,
733             nested_if: false,
734             span,
735         }
736     }
737
738     fn new_for(
739         pat: &'a ast::Pat,
740         cond: &'a ast::Expr,
741         block: &'a ast::Block,
742         label: Option<ast::Label>,
743         span: Span,
744     ) -> ControlFlow<'a> {
745         ControlFlow {
746             cond: Some(cond),
747             block,
748             else_block: None,
749             label,
750             pats: vec![pat],
751             keyword: "for",
752             matcher: "",
753             connector: " in",
754             allow_single_line: false,
755             nested_if: false,
756             span,
757         }
758     }
759
760     fn rewrite_single_line(
761         &self,
762         pat_expr_str: &str,
763         context: &RewriteContext,
764         width: usize,
765     ) -> Option<String> {
766         assert!(self.allow_single_line);
767         let else_block = self.else_block?;
768         let fixed_cost = self.keyword.len() + "  {  } else {  }".len();
769
770         if let ast::ExprKind::Block(ref else_node, _) = else_block.node {
771             if !is_simple_block(self.block, None, context.source_map)
772                 || !is_simple_block(else_node, None, context.source_map)
773                 || pat_expr_str.contains('\n')
774             {
775                 return None;
776             }
777
778             let new_width = width.checked_sub(pat_expr_str.len() + fixed_cost)?;
779             let expr = &self.block.stmts[0];
780             let if_str = expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;
781
782             let new_width = new_width.checked_sub(if_str.len())?;
783             let else_expr = &else_node.stmts[0];
784             let else_str = else_expr.rewrite(context, Shape::legacy(new_width, Indent::empty()))?;
785
786             if if_str.contains('\n') || else_str.contains('\n') {
787                 return None;
788             }
789
790             let result = format!(
791                 "{} {} {{ {} }} else {{ {} }}",
792                 self.keyword, pat_expr_str, if_str, else_str
793             );
794
795             if result.len() <= width {
796                 return Some(result);
797             }
798         }
799
800         None
801     }
802 }
803
804 impl<'a> ControlFlow<'a> {
805     fn rewrite_pat_expr(
806         &self,
807         context: &RewriteContext,
808         expr: &ast::Expr,
809         shape: Shape,
810         offset: usize,
811     ) -> Option<String> {
812         debug!("rewrite_pat_expr {:?} {:?} {:?}", shape, self.pats, expr);
813
814         let cond_shape = shape.offset_left(offset)?;
815         if !self.pats.is_empty() {
816             let matcher = if self.matcher.is_empty() {
817                 self.matcher.to_owned()
818             } else {
819                 format!("{} ", self.matcher)
820             };
821             let pat_shape = cond_shape
822                 .offset_left(matcher.len())?
823                 .sub_width(self.connector.len())?;
824             let pat_string = rewrite_multiple_patterns(context, &self.pats, pat_shape)?;
825             let result = format!("{}{}{}", matcher, pat_string, self.connector);
826             return rewrite_assign_rhs(context, result, expr, cond_shape);
827         }
828
829         let expr_rw = expr.rewrite(context, cond_shape);
830         // The expression may (partially) fit on the current line.
831         // We do not allow splitting between `if` and condition.
832         if self.keyword == "if" || expr_rw.is_some() {
833             return expr_rw;
834         }
835
836         // The expression won't fit on the current line, jump to next.
837         let nested_shape = shape
838             .block_indent(context.config.tab_spaces())
839             .with_max_width(context.config);
840         let nested_indent_str = nested_shape.indent.to_string_with_newline(context.config);
841         expr.rewrite(context, nested_shape)
842             .map(|expr_rw| format!("{}{}", nested_indent_str, expr_rw))
843     }
844
845     fn rewrite_cond(
846         &self,
847         context: &RewriteContext,
848         shape: Shape,
849         alt_block_sep: &str,
850     ) -> Option<(String, usize)> {
851         // Do not take the rhs overhead from the upper expressions into account
852         // when rewriting pattern.
853         let new_width = context.budget(shape.used_width());
854         let fresh_shape = Shape {
855             width: new_width,
856             ..shape
857         };
858         let constr_shape = if self.nested_if {
859             // We are part of an if-elseif-else chain. Our constraints are tightened.
860             // 7 = "} else " .len()
861             fresh_shape.offset_left(7)?
862         } else {
863             fresh_shape
864         };
865
866         let label_string = rewrite_label(self.label);
867         // 1 = space after keyword.
868         let offset = self.keyword.len() + label_string.len() + 1;
869
870         let pat_expr_string = match self.cond {
871             Some(cond) => self.rewrite_pat_expr(context, cond, constr_shape, offset)?,
872             None => String::new(),
873         };
874
875         let brace_overhead =
876             if context.config.control_brace_style() != ControlBraceStyle::AlwaysNextLine {
877                 // 2 = ` {`
878                 2
879             } else {
880                 0
881             };
882         let one_line_budget = context
883             .config
884             .max_width()
885             .saturating_sub(constr_shape.used_width() + offset + brace_overhead);
886         let force_newline_brace = (pat_expr_string.contains('\n')
887             || pat_expr_string.len() > one_line_budget)
888             && !last_line_extendable(&pat_expr_string);
889
890         // Try to format if-else on single line.
891         if self.allow_single_line
892             && context
893                 .config
894                 .width_heuristics()
895                 .single_line_if_else_max_width
896                 > 0
897         {
898             let trial = self.rewrite_single_line(&pat_expr_string, context, shape.width);
899
900             if let Some(cond_str) = trial {
901                 if cond_str.len() <= context
902                     .config
903                     .width_heuristics()
904                     .single_line_if_else_max_width
905                 {
906                     return Some((cond_str, 0));
907                 }
908             }
909         }
910
911         let cond_span = if let Some(cond) = self.cond {
912             cond.span
913         } else {
914             mk_sp(self.block.span.lo(), self.block.span.lo())
915         };
916
917         // `for event in event`
918         // Do not include label in the span.
919         let lo = self
920             .label
921             .map_or(self.span.lo(), |label| label.ident.span.hi());
922         let between_kwd_cond = mk_sp(
923             context
924                 .snippet_provider
925                 .span_after(mk_sp(lo, self.span.hi()), self.keyword.trim()),
926             if self.pats.is_empty() {
927                 cond_span.lo()
928             } else if self.matcher.is_empty() {
929                 self.pats[0].span.lo()
930             } else {
931                 context
932                     .snippet_provider
933                     .span_before(self.span, self.matcher.trim())
934             },
935         );
936
937         let between_kwd_cond_comment = extract_comment(between_kwd_cond, context, shape);
938
939         let after_cond_comment =
940             extract_comment(mk_sp(cond_span.hi(), self.block.span.lo()), context, shape);
941
942         let block_sep = if self.cond.is_none() && between_kwd_cond_comment.is_some() {
943             ""
944         } else if context.config.control_brace_style() == ControlBraceStyle::AlwaysNextLine
945             || force_newline_brace
946         {
947             alt_block_sep
948         } else {
949             " "
950         };
951
952         let used_width = if pat_expr_string.contains('\n') {
953             last_line_width(&pat_expr_string)
954         } else {
955             // 2 = spaces after keyword and condition.
956             label_string.len() + self.keyword.len() + pat_expr_string.len() + 2
957         };
958
959         Some((
960             format!(
961                 "{}{}{}{}{}",
962                 label_string,
963                 self.keyword,
964                 between_kwd_cond_comment.as_ref().map_or(
965                     if pat_expr_string.is_empty() || pat_expr_string.starts_with('\n') {
966                         ""
967                     } else {
968                         " "
969                     },
970                     |s| &**s,
971                 ),
972                 pat_expr_string,
973                 after_cond_comment.as_ref().map_or(block_sep, |s| &**s)
974             ),
975             used_width,
976         ))
977     }
978 }
979
980 impl<'a> Rewrite for ControlFlow<'a> {
981     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
982         debug!("ControlFlow::rewrite {:?} {:?}", self, shape);
983
984         let alt_block_sep = &shape.indent.to_string_with_newline(context.config);
985         let (cond_str, used_width) = self.rewrite_cond(context, shape, alt_block_sep)?;
986         // If `used_width` is 0, it indicates that whole control flow is written in a single line.
987         if used_width == 0 {
988             return Some(cond_str);
989         }
990
991         let block_width = shape.width.saturating_sub(used_width);
992         // This is used only for the empty block case: `{}`. So, we use 1 if we know
993         // we should avoid the single line case.
994         let block_width = if self.else_block.is_some() || self.nested_if {
995             min(1, block_width)
996         } else {
997             block_width
998         };
999         let block_shape = Shape {
1000             width: block_width,
1001             ..shape
1002         };
1003         let block_str = {
1004             let old_val = context.is_if_else_block.replace(self.else_block.is_some());
1005             let result =
1006                 rewrite_block_with_visitor(context, "", self.block, None, None, block_shape, true);
1007             context.is_if_else_block.replace(old_val);
1008             result?
1009         };
1010
1011         let mut result = format!("{}{}", cond_str, block_str);
1012
1013         if let Some(else_block) = self.else_block {
1014             let shape = Shape::indented(shape.indent, context.config);
1015             let mut last_in_chain = false;
1016             let rewrite = match else_block.node {
1017                 // If the else expression is another if-else expression, prevent it
1018                 // from being formatted on a single line.
1019                 // Note how we're passing the original shape, as the
1020                 // cost of "else" should not cascade.
1021                 ast::ExprKind::IfLet(ref pat, ref cond, ref if_block, ref next_else_block) => {
1022                     ControlFlow::new_if(
1023                         cond,
1024                         ptr_vec_to_ref_vec(pat),
1025                         if_block,
1026                         next_else_block.as_ref().map(|e| &**e),
1027                         false,
1028                         true,
1029                         mk_sp(else_block.span.lo(), self.span.hi()),
1030                     )
1031                     .rewrite(context, shape)
1032                 }
1033                 ast::ExprKind::If(ref cond, ref if_block, ref next_else_block) => {
1034                     ControlFlow::new_if(
1035                         cond,
1036                         vec![],
1037                         if_block,
1038                         next_else_block.as_ref().map(|e| &**e),
1039                         false,
1040                         true,
1041                         mk_sp(else_block.span.lo(), self.span.hi()),
1042                     )
1043                     .rewrite(context, shape)
1044                 }
1045                 _ => {
1046                     last_in_chain = true;
1047                     // When rewriting a block, the width is only used for single line
1048                     // blocks, passing 1 lets us avoid that.
1049                     let else_shape = Shape {
1050                         width: min(1, shape.width),
1051                         ..shape
1052                     };
1053                     format_expr(else_block, ExprType::Statement, context, else_shape)
1054                 }
1055             };
1056
1057             let between_kwd_else_block = mk_sp(
1058                 self.block.span.hi(),
1059                 context
1060                     .snippet_provider
1061                     .span_before(mk_sp(self.block.span.hi(), else_block.span.lo()), "else"),
1062             );
1063             let between_kwd_else_block_comment =
1064                 extract_comment(between_kwd_else_block, context, shape);
1065
1066             let after_else = mk_sp(
1067                 context
1068                     .snippet_provider
1069                     .span_after(mk_sp(self.block.span.hi(), else_block.span.lo()), "else"),
1070                 else_block.span.lo(),
1071             );
1072             let after_else_comment = extract_comment(after_else, context, shape);
1073
1074             let between_sep = match context.config.control_brace_style() {
1075                 ControlBraceStyle::AlwaysNextLine | ControlBraceStyle::ClosingNextLine => {
1076                     &*alt_block_sep
1077                 }
1078                 ControlBraceStyle::AlwaysSameLine => " ",
1079             };
1080             let after_sep = match context.config.control_brace_style() {
1081                 ControlBraceStyle::AlwaysNextLine if last_in_chain => &*alt_block_sep,
1082                 _ => " ",
1083             };
1084
1085             result.push_str(&format!(
1086                 "{}else{}",
1087                 between_kwd_else_block_comment
1088                     .as_ref()
1089                     .map_or(between_sep, |s| &**s),
1090                 after_else_comment.as_ref().map_or(after_sep, |s| &**s),
1091             ));
1092             result.push_str(&rewrite?);
1093         }
1094
1095         Some(result)
1096     }
1097 }
1098
1099 fn rewrite_label(opt_label: Option<ast::Label>) -> Cow<'static, str> {
1100     match opt_label {
1101         Some(label) => Cow::from(format!("{}: ", label.ident)),
1102         None => Cow::from(""),
1103     }
1104 }
1105
1106 fn extract_comment(span: Span, context: &RewriteContext, shape: Shape) -> Option<String> {
1107     match rewrite_missing_comment(span, shape, context) {
1108         Some(ref comment) if !comment.is_empty() => Some(format!(
1109             "{indent}{}{indent}",
1110             comment,
1111             indent = shape.indent.to_string_with_newline(context.config)
1112         )),
1113         _ => None,
1114     }
1115 }
1116
1117 pub fn block_contains_comment(block: &ast::Block, source_map: &SourceMap) -> bool {
1118     let snippet = source_map.span_to_snippet(block.span).unwrap();
1119     contains_comment(&snippet)
1120 }
1121
1122 // Checks that a block contains no statements, an expression and no comments or
1123 // attributes.
1124 // FIXME: incorrectly returns false when comment is contained completely within
1125 // the expression.
1126 pub fn is_simple_block(
1127     block: &ast::Block,
1128     attrs: Option<&[ast::Attribute]>,
1129     source_map: &SourceMap,
1130 ) -> bool {
1131     (block.stmts.len() == 1
1132         && stmt_is_expr(&block.stmts[0])
1133         && !block_contains_comment(block, source_map)
1134         && attrs.map_or(true, |a| a.is_empty()))
1135 }
1136
1137 /// Checks whether a block contains at most one statement or expression, and no
1138 /// comments or attributes.
1139 pub fn is_simple_block_stmt(
1140     block: &ast::Block,
1141     attrs: Option<&[ast::Attribute]>,
1142     source_map: &SourceMap,
1143 ) -> bool {
1144     block.stmts.len() <= 1
1145         && !block_contains_comment(block, source_map)
1146         && attrs.map_or(true, |a| a.is_empty())
1147 }
1148
1149 /// Checks whether a block contains no statements, expressions, comments, or
1150 /// inner attributes.
1151 pub fn is_empty_block(
1152     block: &ast::Block,
1153     attrs: Option<&[ast::Attribute]>,
1154     source_map: &SourceMap,
1155 ) -> bool {
1156     block.stmts.is_empty()
1157         && !block_contains_comment(block, source_map)
1158         && attrs.map_or(true, |a| inner_attributes(a).is_empty())
1159 }
1160
1161 pub fn stmt_is_expr(stmt: &ast::Stmt) -> bool {
1162     match stmt.node {
1163         ast::StmtKind::Expr(..) => true,
1164         _ => false,
1165     }
1166 }
1167
1168 pub fn is_unsafe_block(block: &ast::Block) -> bool {
1169     if let ast::BlockCheckMode::Unsafe(..) = block.rules {
1170         true
1171     } else {
1172         false
1173     }
1174 }
1175
1176 pub fn rewrite_multiple_patterns(
1177     context: &RewriteContext,
1178     pats: &[&ast::Pat],
1179     shape: Shape,
1180 ) -> Option<String> {
1181     let pat_strs = pats
1182         .iter()
1183         .map(|p| p.rewrite(context, shape))
1184         .collect::<Option<Vec<_>>>()?;
1185
1186     let use_mixed_layout = pats
1187         .iter()
1188         .zip(pat_strs.iter())
1189         .all(|(pat, pat_str)| is_short_pattern(pat, pat_str));
1190     let items: Vec<_> = pat_strs.into_iter().map(ListItem::from_str).collect();
1191     let tactic = if use_mixed_layout {
1192         DefinitiveListTactic::Mixed
1193     } else {
1194         definitive_tactic(
1195             &items,
1196             ListTactic::HorizontalVertical,
1197             Separator::VerticalBar,
1198             shape.width,
1199         )
1200     };
1201     let fmt = ListFormatting::new(shape, context.config)
1202         .tactic(tactic)
1203         .separator(" |")
1204         .separator_place(context.config.binop_separator())
1205         .ends_with_newline(false);
1206     write_list(&items, &fmt)
1207 }
1208
1209 pub fn rewrite_literal(context: &RewriteContext, l: &ast::Lit, shape: Shape) -> Option<String> {
1210     match l.node {
1211         ast::LitKind::Str(_, ast::StrStyle::Cooked) => rewrite_string_lit(context, l.span, shape),
1212         _ => wrap_str(
1213             context.snippet(l.span).to_owned(),
1214             context.config.max_width(),
1215             shape,
1216         ),
1217     }
1218 }
1219
1220 fn rewrite_string_lit(context: &RewriteContext, span: Span, shape: Shape) -> Option<String> {
1221     let string_lit = context.snippet(span);
1222
1223     if !context.config.format_strings() {
1224         if string_lit
1225             .lines()
1226             .rev()
1227             .skip(1)
1228             .all(|line| line.ends_with('\\'))
1229         {
1230             let new_indent = shape.visual_indent(1).indent;
1231             let indented_string_lit = String::from(
1232                 string_lit
1233                     .lines()
1234                     .map(|line| {
1235                         format!(
1236                             "{}{}",
1237                             new_indent.to_string(context.config),
1238                             line.trim_left()
1239                         )
1240                     })
1241                     .collect::<Vec<_>>()
1242                     .join("\n")
1243                     .trim_left(),
1244             );
1245             return wrap_str(indented_string_lit, context.config.max_width(), shape);
1246         } else {
1247             return wrap_str(string_lit.to_owned(), context.config.max_width(), shape);
1248         }
1249     }
1250
1251     // Remove the quote characters.
1252     let str_lit = &string_lit[1..string_lit.len() - 1];
1253
1254     rewrite_string(
1255         str_lit,
1256         &StringFormat::new(shape.visual_indent(0), context.config),
1257         shape.width.saturating_sub(2),
1258     )
1259 }
1260
1261 fn choose_separator_tactic(context: &RewriteContext, span: Span) -> Option<SeparatorTactic> {
1262     if context.inside_macro() {
1263         if span_ends_with_comma(context, span) {
1264             Some(SeparatorTactic::Always)
1265         } else {
1266             Some(SeparatorTactic::Never)
1267         }
1268     } else {
1269         None
1270     }
1271 }
1272
1273 pub fn rewrite_call(
1274     context: &RewriteContext,
1275     callee: &str,
1276     args: &[ptr::P<ast::Expr>],
1277     span: Span,
1278     shape: Shape,
1279 ) -> Option<String> {
1280     overflow::rewrite_with_parens(
1281         context,
1282         callee,
1283         args.iter(),
1284         shape,
1285         span,
1286         context.config.width_heuristics().fn_call_width,
1287         choose_separator_tactic(context, span),
1288     )
1289 }
1290
1291 pub fn is_simple_expr(expr: &ast::Expr) -> bool {
1292     match expr.node {
1293         ast::ExprKind::Lit(..) => true,
1294         ast::ExprKind::Path(ref qself, ref path) => qself.is_none() && path.segments.len() <= 1,
1295         ast::ExprKind::AddrOf(_, ref expr)
1296         | ast::ExprKind::Box(ref expr)
1297         | ast::ExprKind::Cast(ref expr, _)
1298         | ast::ExprKind::Field(ref expr, _)
1299         | ast::ExprKind::Try(ref expr)
1300         | ast::ExprKind::Unary(_, ref expr) => is_simple_expr(expr),
1301         ast::ExprKind::Index(ref lhs, ref rhs) => is_simple_expr(lhs) && is_simple_expr(rhs),
1302         ast::ExprKind::Repeat(ref lhs, ref rhs) => {
1303             is_simple_expr(lhs) && is_simple_expr(&*rhs.value)
1304         }
1305         _ => false,
1306     }
1307 }
1308
1309 pub fn is_every_expr_simple(lists: &[OverflowableItem]) -> bool {
1310     lists.iter().all(OverflowableItem::is_simple)
1311 }
1312
1313 pub fn can_be_overflowed_expr(context: &RewriteContext, expr: &ast::Expr, args_len: usize) -> bool {
1314     match expr.node {
1315         ast::ExprKind::Match(..) => {
1316             (context.use_block_indent() && args_len == 1)
1317                 || (context.config.indent_style() == IndentStyle::Visual && args_len > 1)
1318         }
1319         ast::ExprKind::If(..)
1320         | ast::ExprKind::IfLet(..)
1321         | ast::ExprKind::ForLoop(..)
1322         | ast::ExprKind::Loop(..)
1323         | ast::ExprKind::While(..)
1324         | ast::ExprKind::WhileLet(..) => {
1325             context.config.combine_control_expr() && context.use_block_indent() && args_len == 1
1326         }
1327         ast::ExprKind::Block(..) | ast::ExprKind::Closure(..) => {
1328             context.use_block_indent() || context.config.indent_style() == IndentStyle::Visual
1329         }
1330         ast::ExprKind::Array(..)
1331         | ast::ExprKind::Call(..)
1332         | ast::ExprKind::Mac(..)
1333         | ast::ExprKind::MethodCall(..)
1334         | ast::ExprKind::Struct(..)
1335         | ast::ExprKind::Tup(..) => context.use_block_indent() && args_len == 1,
1336         ast::ExprKind::AddrOf(_, ref expr)
1337         | ast::ExprKind::Box(ref expr)
1338         | ast::ExprKind::Try(ref expr)
1339         | ast::ExprKind::Unary(_, ref expr)
1340         | ast::ExprKind::Cast(ref expr, _) => can_be_overflowed_expr(context, expr, args_len),
1341         _ => false,
1342     }
1343 }
1344
1345 pub fn is_nested_call(expr: &ast::Expr) -> bool {
1346     match expr.node {
1347         ast::ExprKind::Call(..) | ast::ExprKind::Mac(..) => true,
1348         ast::ExprKind::AddrOf(_, ref expr)
1349         | ast::ExprKind::Box(ref expr)
1350         | ast::ExprKind::Try(ref expr)
1351         | ast::ExprKind::Unary(_, ref expr)
1352         | ast::ExprKind::Cast(ref expr, _) => is_nested_call(expr),
1353         _ => false,
1354     }
1355 }
1356
1357 /// Return true if a function call or a method call represented by the given span ends with a
1358 /// trailing comma. This function is used when rewriting macro, as adding or removing a trailing
1359 /// comma from macro can potentially break the code.
1360 pub fn span_ends_with_comma(context: &RewriteContext, span: Span) -> bool {
1361     let mut result: bool = Default::default();
1362     let mut prev_char: char = Default::default();
1363     let closing_delimiters = &[')', '}', ']'];
1364
1365     for (kind, c) in CharClasses::new(context.snippet(span).chars()) {
1366         match c {
1367             _ if kind.is_comment() || c.is_whitespace() => continue,
1368             c if closing_delimiters.contains(&c) => {
1369                 result &= !closing_delimiters.contains(&prev_char);
1370             }
1371             ',' => result = true,
1372             _ => result = false,
1373         }
1374         prev_char = c;
1375     }
1376
1377     result
1378 }
1379
1380 fn rewrite_paren(
1381     context: &RewriteContext,
1382     mut subexpr: &ast::Expr,
1383     shape: Shape,
1384     mut span: Span,
1385 ) -> Option<String> {
1386     debug!("rewrite_paren, shape: {:?}", shape);
1387
1388     // Extract comments within parens.
1389     let mut pre_span;
1390     let mut post_span;
1391     let mut pre_comment;
1392     let mut post_comment;
1393     let remove_nested_parens = context.config.remove_nested_parens();
1394     loop {
1395         // 1 = "(" or ")"
1396         pre_span = mk_sp(span.lo() + BytePos(1), subexpr.span.lo());
1397         post_span = mk_sp(subexpr.span.hi(), span.hi() - BytePos(1));
1398         pre_comment = rewrite_missing_comment(pre_span, shape, context)?;
1399         post_comment = rewrite_missing_comment(post_span, shape, context)?;
1400
1401         // Remove nested parens if there are no comments.
1402         if let ast::ExprKind::Paren(ref subsubexpr) = subexpr.node {
1403             if remove_nested_parens && pre_comment.is_empty() && post_comment.is_empty() {
1404                 span = subexpr.span;
1405                 subexpr = subsubexpr;
1406                 continue;
1407             }
1408         }
1409
1410         break;
1411     }
1412
1413     // 1 = `(` and `)`
1414     let sub_shape = shape.offset_left(1)?.sub_width(1)?;
1415     let subexpr_str = subexpr.rewrite(context, sub_shape)?;
1416     let fits_single_line = !pre_comment.contains("//") && !post_comment.contains("//");
1417     if fits_single_line {
1418         Some(format!("({}{}{})", pre_comment, &subexpr_str, post_comment))
1419     } else {
1420         rewrite_paren_in_multi_line(context, subexpr, shape, pre_span, post_span)
1421     }
1422 }
1423
1424 fn rewrite_paren_in_multi_line(
1425     context: &RewriteContext,
1426     subexpr: &ast::Expr,
1427     shape: Shape,
1428     pre_span: Span,
1429     post_span: Span,
1430 ) -> Option<String> {
1431     let nested_indent = shape.indent.block_indent(context.config);
1432     let nested_shape = Shape::indented(nested_indent, context.config);
1433     let pre_comment = rewrite_missing_comment(pre_span, nested_shape, context)?;
1434     let post_comment = rewrite_missing_comment(post_span, nested_shape, context)?;
1435     let subexpr_str = subexpr.rewrite(context, nested_shape)?;
1436
1437     let mut result = String::with_capacity(subexpr_str.len() * 2);
1438     result.push('(');
1439     if !pre_comment.is_empty() {
1440         result.push_str(&nested_indent.to_string_with_newline(context.config));
1441         result.push_str(&pre_comment);
1442     }
1443     result.push_str(&nested_indent.to_string_with_newline(context.config));
1444     result.push_str(&subexpr_str);
1445     if !post_comment.is_empty() {
1446         result.push_str(&nested_indent.to_string_with_newline(context.config));
1447         result.push_str(&post_comment);
1448     }
1449     result.push_str(&shape.indent.to_string_with_newline(context.config));
1450     result.push(')');
1451
1452     Some(result)
1453 }
1454
1455 fn rewrite_index(
1456     expr: &ast::Expr,
1457     index: &ast::Expr,
1458     context: &RewriteContext,
1459     shape: Shape,
1460 ) -> Option<String> {
1461     let expr_str = expr.rewrite(context, shape)?;
1462
1463     let offset = last_line_width(&expr_str) + 1;
1464     let rhs_overhead = shape.rhs_overhead(context.config);
1465     let index_shape = if expr_str.contains('\n') {
1466         Shape::legacy(context.config.max_width(), shape.indent)
1467             .offset_left(offset)
1468             .and_then(|shape| shape.sub_width(1 + rhs_overhead))
1469     } else {
1470         match context.config.indent_style() {
1471             IndentStyle::Block => shape
1472                 .offset_left(offset)
1473                 .and_then(|shape| shape.sub_width(1)),
1474             IndentStyle::Visual => shape.visual_indent(offset).sub_width(offset + 1),
1475         }
1476     };
1477     let orig_index_rw = index_shape.and_then(|s| index.rewrite(context, s));
1478
1479     // Return if index fits in a single line.
1480     match orig_index_rw {
1481         Some(ref index_str) if !index_str.contains('\n') => {
1482             return Some(format!("{}[{}]", expr_str, index_str));
1483         }
1484         _ => (),
1485     }
1486
1487     // Try putting index on the next line and see if it fits in a single line.
1488     let indent = shape.indent.block_indent(context.config);
1489     let index_shape = Shape::indented(indent, context.config).offset_left(1)?;
1490     let index_shape = index_shape.sub_width(1 + rhs_overhead)?;
1491     let new_index_rw = index.rewrite(context, index_shape);
1492     match (orig_index_rw, new_index_rw) {
1493         (_, Some(ref new_index_str)) if !new_index_str.contains('\n') => Some(format!(
1494             "{}{}[{}]",
1495             expr_str,
1496             indent.to_string_with_newline(context.config),
1497             new_index_str,
1498         )),
1499         (None, Some(ref new_index_str)) => Some(format!(
1500             "{}{}[{}]",
1501             expr_str,
1502             indent.to_string_with_newline(context.config),
1503             new_index_str,
1504         )),
1505         (Some(ref index_str), _) => Some(format!("{}[{}]", expr_str, index_str)),
1506         _ => None,
1507     }
1508 }
1509
1510 fn struct_lit_can_be_aligned(fields: &[ast::Field], base: Option<&ast::Expr>) -> bool {
1511     if base.is_some() {
1512         return false;
1513     }
1514
1515     fields.iter().all(|field| !field.is_shorthand)
1516 }
1517
1518 fn rewrite_struct_lit<'a>(
1519     context: &RewriteContext,
1520     path: &ast::Path,
1521     fields: &'a [ast::Field],
1522     base: Option<&'a ast::Expr>,
1523     span: Span,
1524     shape: Shape,
1525 ) -> Option<String> {
1526     debug!("rewrite_struct_lit: shape {:?}", shape);
1527
1528     enum StructLitField<'a> {
1529         Regular(&'a ast::Field),
1530         Base(&'a ast::Expr),
1531     }
1532
1533     // 2 = " {".len()
1534     let path_shape = shape.sub_width(2)?;
1535     let path_str = rewrite_path(context, PathContext::Expr, None, path, path_shape)?;
1536
1537     if fields.is_empty() && base.is_none() {
1538         return Some(format!("{} {{}}", path_str));
1539     }
1540
1541     // Foo { a: Foo } - indent is +3, width is -5.
1542     let (h_shape, v_shape) = struct_lit_shape(shape, context, path_str.len() + 3, 2)?;
1543
1544     let one_line_width = h_shape.map_or(0, |shape| shape.width);
1545     let body_lo = context.snippet_provider.span_after(span, "{");
1546     let fields_str = if struct_lit_can_be_aligned(fields, base)
1547         && context.config.struct_field_align_threshold() > 0
1548     {
1549         rewrite_with_alignment(
1550             fields,
1551             context,
1552             shape,
1553             mk_sp(body_lo, span.hi()),
1554             one_line_width,
1555         )?
1556     } else {
1557         let field_iter = fields
1558             .into_iter()
1559             .map(StructLitField::Regular)
1560             .chain(base.into_iter().map(StructLitField::Base));
1561
1562         let span_lo = |item: &StructLitField| match *item {
1563             StructLitField::Regular(field) => field.span().lo(),
1564             StructLitField::Base(expr) => {
1565                 let last_field_hi = fields.last().map_or(span.lo(), |field| field.span.hi());
1566                 let snippet = context.snippet(mk_sp(last_field_hi, expr.span.lo()));
1567                 let pos = snippet.find_uncommented("..").unwrap();
1568                 last_field_hi + BytePos(pos as u32)
1569             }
1570         };
1571         let span_hi = |item: &StructLitField| match *item {
1572             StructLitField::Regular(field) => field.span().hi(),
1573             StructLitField::Base(expr) => expr.span.hi(),
1574         };
1575         let rewrite = |item: &StructLitField| match *item {
1576             StructLitField::Regular(field) => {
1577                 // The 1 taken from the v_budget is for the comma.
1578                 rewrite_field(context, field, v_shape.sub_width(1)?, 0)
1579             }
1580             StructLitField::Base(expr) => {
1581                 // 2 = ..
1582                 expr.rewrite(context, v_shape.offset_left(2)?)
1583                     .map(|s| format!("..{}", s))
1584             }
1585         };
1586
1587         let items = itemize_list(
1588             context.snippet_provider,
1589             field_iter,
1590             "}",
1591             ",",
1592             span_lo,
1593             span_hi,
1594             rewrite,
1595             body_lo,
1596             span.hi(),
1597             false,
1598         );
1599         let item_vec = items.collect::<Vec<_>>();
1600
1601         let tactic = struct_lit_tactic(h_shape, context, &item_vec);
1602         let nested_shape = shape_for_tactic(tactic, h_shape, v_shape);
1603
1604         let ends_with_comma = span_ends_with_comma(context, span);
1605         let force_no_trailing_comma = context.inside_macro() && !ends_with_comma;
1606
1607         let fmt = struct_lit_formatting(
1608             nested_shape,
1609             tactic,
1610             context,
1611             force_no_trailing_comma || base.is_some() || !context.use_block_indent(),
1612         );
1613
1614         write_list(&item_vec, &fmt)?
1615     };
1616
1617     let fields_str = wrap_struct_field(context, &fields_str, shape, v_shape, one_line_width);
1618     Some(format!("{} {{{}}}", path_str, fields_str))
1619
1620     // FIXME if context.config.indent_style() == Visual, but we run out
1621     // of space, we should fall back to BlockIndent.
1622 }
1623
1624 pub fn wrap_struct_field(
1625     context: &RewriteContext,
1626     fields_str: &str,
1627     shape: Shape,
1628     nested_shape: Shape,
1629     one_line_width: usize,
1630 ) -> String {
1631     if context.config.indent_style() == IndentStyle::Block
1632         && (fields_str.contains('\n')
1633             || !context.config.struct_lit_single_line()
1634             || fields_str.len() > one_line_width)
1635     {
1636         format!(
1637             "{}{}{}",
1638             nested_shape.indent.to_string_with_newline(context.config),
1639             fields_str,
1640             shape.indent.to_string_with_newline(context.config)
1641         )
1642     } else {
1643         // One liner or visual indent.
1644         format!(" {} ", fields_str)
1645     }
1646 }
1647
1648 pub fn struct_lit_field_separator(config: &Config) -> &str {
1649     colon_spaces(config.space_before_colon(), config.space_after_colon())
1650 }
1651
1652 pub fn rewrite_field(
1653     context: &RewriteContext,
1654     field: &ast::Field,
1655     shape: Shape,
1656     prefix_max_width: usize,
1657 ) -> Option<String> {
1658     if contains_skip(&field.attrs) {
1659         return Some(context.snippet(field.span()).to_owned());
1660     }
1661     let mut attrs_str = field.attrs.rewrite(context, shape)?;
1662     if !attrs_str.is_empty() {
1663         attrs_str.push_str(&shape.indent.to_string_with_newline(context.config));
1664     };
1665     let name = context.snippet(field.ident.span);
1666     if field.is_shorthand {
1667         Some(attrs_str + name)
1668     } else {
1669         let mut separator = String::from(struct_lit_field_separator(context.config));
1670         for _ in 0..prefix_max_width.saturating_sub(name.len()) {
1671             separator.push(' ');
1672         }
1673         let overhead = name.len() + separator.len();
1674         let expr_shape = shape.offset_left(overhead)?;
1675         let expr = field.expr.rewrite(context, expr_shape);
1676
1677         match expr {
1678             Some(ref e) if e.as_str() == name && context.config.use_field_init_shorthand() => {
1679                 Some(attrs_str + name)
1680             }
1681             Some(e) => Some(format!("{}{}{}{}", attrs_str, name, separator, e)),
1682             None => {
1683                 let expr_offset = shape.indent.block_indent(context.config);
1684                 let expr = field
1685                     .expr
1686                     .rewrite(context, Shape::indented(expr_offset, context.config));
1687                 expr.map(|s| {
1688                     format!(
1689                         "{}{}:\n{}{}",
1690                         attrs_str,
1691                         name,
1692                         expr_offset.to_string(context.config),
1693                         s
1694                     )
1695                 })
1696             }
1697         }
1698     }
1699 }
1700
1701 fn rewrite_tuple_in_visual_indent_style<'a, T: 'a + IntoOverflowableItem<'a>>(
1702     context: &RewriteContext,
1703     mut items: impl Iterator<Item = &'a T>,
1704     span: Span,
1705     shape: Shape,
1706     is_singleton_tuple: bool,
1707 ) -> Option<String> {
1708     // In case of length 1, need a trailing comma
1709     debug!("rewrite_tuple_in_visual_indent_style {:?}", shape);
1710     if is_singleton_tuple {
1711         // 3 = "(" + ",)"
1712         let nested_shape = shape.sub_width(3)?.visual_indent(1);
1713         return items
1714             .next()
1715             .unwrap()
1716             .rewrite(context, nested_shape)
1717             .map(|s| format!("({},)", s));
1718     }
1719
1720     let list_lo = context.snippet_provider.span_after(span, "(");
1721     let nested_shape = shape.sub_width(2)?.visual_indent(1);
1722     let items = itemize_list(
1723         context.snippet_provider,
1724         items,
1725         ")",
1726         ",",
1727         |item| item.span().lo(),
1728         |item| item.span().hi(),
1729         |item| item.rewrite(context, nested_shape),
1730         list_lo,
1731         span.hi() - BytePos(1),
1732         false,
1733     );
1734     let item_vec: Vec<_> = items.collect();
1735     let tactic = definitive_tactic(
1736         &item_vec,
1737         ListTactic::HorizontalVertical,
1738         Separator::Comma,
1739         nested_shape.width,
1740     );
1741     let fmt = ListFormatting::new(nested_shape, context.config)
1742         .tactic(tactic)
1743         .ends_with_newline(false);
1744     let list_str = write_list(&item_vec, &fmt)?;
1745
1746     Some(format!("({})", list_str))
1747 }
1748
1749 pub fn rewrite_tuple<'a, T: 'a + IntoOverflowableItem<'a>>(
1750     context: &'a RewriteContext,
1751     items: impl Iterator<Item = &'a T>,
1752     span: Span,
1753     shape: Shape,
1754     is_singleton_tuple: bool,
1755 ) -> Option<String> {
1756     debug!("rewrite_tuple {:?}", shape);
1757     if context.use_block_indent() {
1758         // We use the same rule as function calls for rewriting tuples.
1759         let force_tactic = if context.inside_macro() {
1760             if span_ends_with_comma(context, span) {
1761                 Some(SeparatorTactic::Always)
1762             } else {
1763                 Some(SeparatorTactic::Never)
1764             }
1765         } else if is_singleton_tuple {
1766             Some(SeparatorTactic::Always)
1767         } else {
1768             None
1769         };
1770         overflow::rewrite_with_parens(
1771             context,
1772             "",
1773             items,
1774             shape,
1775             span,
1776             context.config.width_heuristics().fn_call_width,
1777             force_tactic,
1778         )
1779     } else {
1780         rewrite_tuple_in_visual_indent_style(context, items, span, shape, is_singleton_tuple)
1781     }
1782 }
1783
1784 pub fn rewrite_unary_prefix<R: Rewrite>(
1785     context: &RewriteContext,
1786     prefix: &str,
1787     rewrite: &R,
1788     shape: Shape,
1789 ) -> Option<String> {
1790     rewrite
1791         .rewrite(context, shape.offset_left(prefix.len())?)
1792         .map(|r| format!("{}{}", prefix, r))
1793 }
1794
1795 // FIXME: this is probably not correct for multi-line Rewrites. we should
1796 // subtract suffix.len() from the last line budget, not the first!
1797 pub fn rewrite_unary_suffix<R: Rewrite>(
1798     context: &RewriteContext,
1799     suffix: &str,
1800     rewrite: &R,
1801     shape: Shape,
1802 ) -> Option<String> {
1803     rewrite
1804         .rewrite(context, shape.sub_width(suffix.len())?)
1805         .map(|mut r| {
1806             r.push_str(suffix);
1807             r
1808         })
1809 }
1810
1811 fn rewrite_unary_op(
1812     context: &RewriteContext,
1813     op: ast::UnOp,
1814     expr: &ast::Expr,
1815     shape: Shape,
1816 ) -> Option<String> {
1817     // For some reason, an UnOp is not spanned like BinOp!
1818     rewrite_unary_prefix(context, ast::UnOp::to_string(op), expr, shape)
1819 }
1820
1821 fn rewrite_assignment(
1822     context: &RewriteContext,
1823     lhs: &ast::Expr,
1824     rhs: &ast::Expr,
1825     op: Option<&ast::BinOp>,
1826     shape: Shape,
1827 ) -> Option<String> {
1828     let operator_str = match op {
1829         Some(op) => context.snippet(op.span),
1830         None => "=",
1831     };
1832
1833     // 1 = space between lhs and operator.
1834     let lhs_shape = shape.sub_width(operator_str.len() + 1)?;
1835     let lhs_str = format!("{} {}", lhs.rewrite(context, lhs_shape)?, operator_str);
1836
1837     rewrite_assign_rhs(context, lhs_str, rhs, shape)
1838 }
1839
1840 /// Controls where to put the rhs.
1841 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
1842 pub enum RhsTactics {
1843     /// Use heuristics.
1844     Default,
1845     /// Put the rhs on the next line if it uses multiple line, without extra indentation.
1846     ForceNextLineWithoutIndent,
1847 }
1848
1849 // The left hand side must contain everything up to, and including, the
1850 // assignment operator.
1851 pub fn rewrite_assign_rhs<S: Into<String>, R: Rewrite>(
1852     context: &RewriteContext,
1853     lhs: S,
1854     ex: &R,
1855     shape: Shape,
1856 ) -> Option<String> {
1857     rewrite_assign_rhs_with(context, lhs, ex, shape, RhsTactics::Default)
1858 }
1859
1860 pub fn rewrite_assign_rhs_with<S: Into<String>, R: Rewrite>(
1861     context: &RewriteContext,
1862     lhs: S,
1863     ex: &R,
1864     shape: Shape,
1865     rhs_tactics: RhsTactics,
1866 ) -> Option<String> {
1867     let lhs = lhs.into();
1868     let last_line_width = last_line_width(&lhs).saturating_sub(if lhs.contains('\n') {
1869         shape.indent.width()
1870     } else {
1871         0
1872     });
1873     // 1 = space between operator and rhs.
1874     let orig_shape = shape.offset_left(last_line_width + 1).unwrap_or(Shape {
1875         width: 0,
1876         offset: shape.offset + last_line_width + 1,
1877         ..shape
1878     });
1879     let rhs = choose_rhs(
1880         context,
1881         ex,
1882         orig_shape,
1883         ex.rewrite(context, orig_shape),
1884         rhs_tactics,
1885     )?;
1886     Some(lhs + &rhs)
1887 }
1888
1889 fn choose_rhs<R: Rewrite>(
1890     context: &RewriteContext,
1891     expr: &R,
1892     shape: Shape,
1893     orig_rhs: Option<String>,
1894     rhs_tactics: RhsTactics,
1895 ) -> Option<String> {
1896     match orig_rhs {
1897         Some(ref new_str) if !new_str.contains('\n') && new_str.len() <= shape.width => {
1898             Some(format!(" {}", new_str))
1899         }
1900         _ => {
1901             // Expression did not fit on the same line as the identifier.
1902             // Try splitting the line and see if that works better.
1903             let new_shape = shape_from_rhs_tactic(context, shape, rhs_tactics)?;
1904             let new_rhs = expr.rewrite(context, new_shape);
1905             let new_indent_str = &shape
1906                 .indent
1907                 .block_indent(context.config)
1908                 .to_string_with_newline(context.config);
1909
1910             match (orig_rhs, new_rhs) {
1911                 (Some(ref orig_rhs), Some(ref new_rhs))
1912                     if wrap_str(new_rhs.clone(), context.config.max_width(), new_shape)
1913                         .is_none() =>
1914                 {
1915                     Some(format!(" {}", orig_rhs))
1916                 }
1917                 (Some(ref orig_rhs), Some(ref new_rhs))
1918                     if prefer_next_line(orig_rhs, new_rhs, rhs_tactics) =>
1919                 {
1920                     Some(format!("{}{}", new_indent_str, new_rhs))
1921                 }
1922                 (None, Some(ref new_rhs)) => Some(format!("{}{}", new_indent_str, new_rhs)),
1923                 (None, None) => None,
1924                 (Some(orig_rhs), _) => Some(format!(" {}", orig_rhs)),
1925             }
1926         }
1927     }
1928 }
1929
1930 fn shape_from_rhs_tactic(
1931     context: &RewriteContext,
1932     shape: Shape,
1933     rhs_tactic: RhsTactics,
1934 ) -> Option<Shape> {
1935     match rhs_tactic {
1936         RhsTactics::ForceNextLineWithoutIndent => shape
1937             .with_max_width(context.config)
1938             .sub_width(shape.indent.width()),
1939         RhsTactics::Default => {
1940             Shape::indented(shape.indent.block_indent(context.config), context.config)
1941                 .sub_width(shape.rhs_overhead(context.config))
1942         }
1943     }
1944 }
1945
1946 pub fn prefer_next_line(orig_rhs: &str, next_line_rhs: &str, rhs_tactics: RhsTactics) -> bool {
1947     rhs_tactics == RhsTactics::ForceNextLineWithoutIndent
1948         || !next_line_rhs.contains('\n')
1949         || count_newlines(orig_rhs) > count_newlines(next_line_rhs) + 1
1950         || first_line_ends_with(orig_rhs, '(') && !first_line_ends_with(next_line_rhs, '(')
1951         || first_line_ends_with(orig_rhs, '{') && !first_line_ends_with(next_line_rhs, '{')
1952         || first_line_ends_with(orig_rhs, '[') && !first_line_ends_with(next_line_rhs, '[')
1953 }
1954
1955 fn rewrite_expr_addrof(
1956     context: &RewriteContext,
1957     mutability: ast::Mutability,
1958     expr: &ast::Expr,
1959     shape: Shape,
1960 ) -> Option<String> {
1961     let operator_str = match mutability {
1962         ast::Mutability::Immutable => "&",
1963         ast::Mutability::Mutable => "&mut ",
1964     };
1965     rewrite_unary_prefix(context, operator_str, expr, shape)
1966 }
1967
1968 pub fn is_method_call(expr: &ast::Expr) -> bool {
1969     match expr.node {
1970         ast::ExprKind::MethodCall(..) => true,
1971         ast::ExprKind::AddrOf(_, ref expr)
1972         | ast::ExprKind::Box(ref expr)
1973         | ast::ExprKind::Cast(ref expr, _)
1974         | ast::ExprKind::Try(ref expr)
1975         | ast::ExprKind::Unary(_, ref expr) => is_method_call(expr),
1976         _ => false,
1977     }
1978 }