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.
11 use std::cmp::Ordering;
12 use std::borrow::Borrow;
15 use {Indent, Spanned};
16 use rewrite::{Rewrite, RewriteContext};
17 use lists::{write_list, itemize_list, ListFormatting, SeparatorTactic, ListTactic,
18 DefinitiveListTactic, definitive_tactic, ListItem, format_fn_args};
19 use string::{StringFormat, rewrite_string};
20 use utils::{span_after, extra_offset, last_line_width, wrap_str, binary_search, first_line_width};
21 use visitor::FmtVisitor;
22 use config::{StructLitStyle, MultilineStyle};
23 use comment::{FindUncommented, rewrite_comment, contains_comment};
24 use types::rewrite_path;
25 use items::{span_lo_for_arg, span_hi_for_arg};
26 use chains::rewrite_chain;
27 use macros::rewrite_macro;
29 use syntax::{ast, ptr};
30 use syntax::codemap::{CodeMap, Span, BytePos, mk_sp};
31 use syntax::visit::Visitor;
33 impl Rewrite for ast::Expr {
34 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
36 ast::Expr_::ExprVec(ref expr_vec) => {
37 rewrite_array(expr_vec.iter().map(|e| &**e),
38 mk_sp(span_after(self.span, "[", context.codemap), self.span.hi),
43 ast::Expr_::ExprLit(ref l) => {
45 ast::Lit_::LitStr(_, ast::StrStyle::CookedStr) => {
46 rewrite_string_lit(context, l.span, width, offset)
49 wrap_str(context.snippet(self.span),
50 context.config.max_width,
56 ast::Expr_::ExprCall(ref callee, ref args) => {
57 let inner_span = mk_sp(callee.span.hi, self.span.hi);
58 rewrite_call(context, &**callee, args, inner_span, width, offset)
60 ast::Expr_::ExprParen(ref subexpr) => {
61 rewrite_paren(context, subexpr, width, offset)
63 ast::Expr_::ExprBinary(ref op, ref lhs, ref rhs) => {
64 rewrite_binary_op(context, op, lhs, rhs, width, offset)
66 ast::Expr_::ExprUnary(ref op, ref subexpr) => {
67 rewrite_unary_op(context, op, subexpr, width, offset)
69 ast::Expr_::ExprStruct(ref path, ref fields, ref base) => {
70 rewrite_struct_lit(context,
73 base.as_ref().map(|e| &**e),
78 ast::Expr_::ExprTup(ref items) => {
79 rewrite_tuple(context, items, self.span, width, offset)
81 ast::Expr_::ExprWhile(ref cond, ref block, label) => {
82 Loop::new_while(None, cond, block, label).rewrite(context, width, offset)
84 ast::Expr_::ExprWhileLet(ref pat, ref cond, ref block, label) => {
85 Loop::new_while(Some(pat), cond, block, label).rewrite(context, width, offset)
87 ast::Expr_::ExprForLoop(ref pat, ref cond, ref block, label) => {
88 Loop::new_for(pat, cond, block, label).rewrite(context, width, offset)
90 ast::Expr_::ExprLoop(ref block, label) => {
91 Loop::new_loop(block, label).rewrite(context, width, offset)
93 ast::Expr_::ExprBlock(ref block) => {
94 block.rewrite(context, width, offset)
96 ast::Expr_::ExprIf(ref cond, ref if_block, ref else_block) => {
97 rewrite_if_else(context,
100 else_block.as_ref().map(|e| &**e),
106 ast::Expr_::ExprIfLet(ref pat, ref cond, ref if_block, ref else_block) => {
107 rewrite_if_else(context,
110 else_block.as_ref().map(|e| &**e),
116 ast::Expr_::ExprMatch(ref cond, ref arms) => {
117 rewrite_match(context, cond, arms, width, offset, self.span)
119 ast::Expr_::ExprPath(ref qself, ref path) => {
120 rewrite_path(context, true, qself.as_ref(), path, width, offset)
122 ast::Expr_::ExprAssign(ref lhs, ref rhs) => {
123 rewrite_assignment(context, lhs, rhs, None, width, offset)
125 ast::Expr_::ExprAssignOp(ref op, ref lhs, ref rhs) => {
126 rewrite_assignment(context, lhs, rhs, Some(op), width, offset)
128 ast::Expr_::ExprAgain(ref opt_ident) => {
129 let id_str = match *opt_ident {
130 Some(ident) => format!(" {}", ident.node),
131 None => String::new(),
133 Some(format!("continue{}", id_str))
135 ast::Expr_::ExprBreak(ref opt_ident) => {
136 let id_str = match *opt_ident {
137 Some(ident) => format!(" {}", ident.node),
138 None => String::new(),
140 Some(format!("break{}", id_str))
142 ast::Expr_::ExprClosure(capture, ref fn_decl, ref body) => {
143 rewrite_closure(capture, fn_decl, body, self.span, context, width, offset)
145 ast::Expr_::ExprField(..) |
146 ast::Expr_::ExprTupField(..) |
147 ast::Expr_::ExprMethodCall(..) => {
148 rewrite_chain(self, context, width, offset)
150 ast::Expr_::ExprMac(ref mac) => {
151 // Failure to rewrite a marco should not imply failure to
152 // rewrite the expression.
153 rewrite_macro(mac, context, width, offset).or_else(|| {
154 wrap_str(context.snippet(self.span),
155 context.config.max_width,
160 ast::Expr_::ExprRet(None) => {
161 wrap_str("return".to_owned(), context.config.max_width, width, offset)
163 ast::Expr_::ExprRet(Some(ref expr)) => {
164 rewrite_unary_prefix(context, "return ", &**expr, width, offset)
166 ast::Expr_::ExprBox(ref expr) => {
167 rewrite_unary_prefix(context, "box ", &**expr, width, offset)
169 ast::Expr_::ExprAddrOf(mutability, ref expr) => {
170 rewrite_expr_addrof(context, mutability, expr, width, offset)
172 ast::Expr_::ExprCast(ref expr, ref ty) => {
173 rewrite_pair(&**expr, &**ty, "", " as ", "", context, width, offset)
175 ast::Expr_::ExprIndex(ref expr, ref index) => {
176 rewrite_pair(&**expr, &**index, "", "[", "]", context, width, offset)
178 ast::Expr_::ExprRepeat(ref expr, ref repeats) => {
179 rewrite_pair(&**expr, &**repeats, "[", "; ", "]", context, width, offset)
181 ast::Expr_::ExprRange(Some(ref lhs), Some(ref rhs)) => {
182 rewrite_pair(&**lhs, &**rhs, "", "..", "", context, width, offset)
184 ast::Expr_::ExprRange(None, Some(ref rhs)) => {
185 rewrite_unary_prefix(context, "..", &**rhs, width, offset)
187 ast::Expr_::ExprRange(Some(ref lhs), None) => {
189 try_opt!(lhs.rewrite(context,
190 try_opt!(width.checked_sub(2)),
193 ast::Expr_::ExprRange(None, None) => {
200 // We do not format these expressions yet, but they should still
201 // satisfy our width restrictions.
202 ast::Expr_::ExprInPlace(..) |
203 ast::Expr_::ExprInlineAsm(..) => {
204 wrap_str(context.snippet(self.span),
205 context.config.max_width,
213 pub fn rewrite_pair<LHS, RHS>(lhs: &LHS,
218 context: &RewriteContext,
225 let max_width = try_opt!(width.checked_sub(prefix.len() + infix.len() + suffix.len()));
227 binary_search(1, max_width, |lhs_budget| {
228 let lhs_offset = offset + prefix.len();
229 let lhs_str = match lhs.rewrite(context, lhs_budget, lhs_offset) {
230 Some(result) => result,
231 None => return Err(Ordering::Greater),
234 let last_line_width = last_line_width(&lhs_str);
235 let rhs_budget = match max_width.checked_sub(last_line_width) {
237 None => return Err(Ordering::Less),
239 let rhs_indent = offset + last_line_width + prefix.len() + infix.len();
241 let rhs_str = match rhs.rewrite(context, rhs_budget, rhs_indent) {
242 Some(result) => result,
243 None => return Err(Ordering::Less),
246 Ok(format!("{}{}{}{}{}", prefix, lhs_str, infix, rhs_str, suffix))
250 pub fn rewrite_array<'a, I>(expr_iter: I,
252 context: &RewriteContext,
256 where I: Iterator<Item = &'a ast::Expr>
259 let offset = offset + 1;
260 let inner_context = &RewriteContext { block_indent: offset, ..*context };
261 let max_item_width = try_opt!(width.checked_sub(2));
262 let items = itemize_list(context.codemap,
268 |item| item.rewrite(&inner_context, max_item_width, offset),
271 .collect::<Vec<_>>();
273 let has_long_item = try_opt!(items.iter()
274 .map(|li| li.item.as_ref().map(|s| s.len() > 10))
276 |acc, x| acc.and_then(|y| x.map(|x| x || y))));
278 let tactic = if has_long_item || items.iter().any(ListItem::is_multiline) {
279 definitive_tactic(&items, ListTactic::HorizontalVertical, max_item_width)
281 DefinitiveListTactic::Mixed
284 let fmt = ListFormatting {
287 trailing_separator: SeparatorTactic::Never,
289 width: max_item_width,
290 ends_with_newline: false,
291 config: context.config,
293 let list_str = try_opt!(write_list(&items, &fmt));
295 Some(format!("[{}]", list_str))
298 // This functions is pretty messy because of the wrapping and unwrapping of
299 // expressions into and from blocks. See rust issue #27872.
300 fn rewrite_closure(capture: ast::CaptureClause,
301 fn_decl: &ast::FnDecl,
304 context: &RewriteContext,
308 let mover = if capture == ast::CaptureClause::CaptureByValue {
313 let offset = offset + mover.len();
315 // 4 = "|| {".len(), which is overconservative when the closure consists of
316 // a single expression.
317 let budget = try_opt!(width.checked_sub(4 + mover.len()));
319 let argument_offset = offset + 1;
320 let ret_str = try_opt!(fn_decl.output.rewrite(context, budget, argument_offset));
321 // 1 = space between arguments and return type.
322 let horizontal_budget = budget.checked_sub(ret_str.len() + 1).unwrap_or(0);
324 let arg_items = itemize_list(context.codemap,
325 fn_decl.inputs.iter(),
327 |arg| span_lo_for_arg(arg),
328 |arg| span_hi_for_arg(arg),
329 |arg| arg.rewrite(context, budget, argument_offset),
330 span_after(span, "|", context.codemap),
332 let item_vec = arg_items.collect::<Vec<_>>();
333 let tactic = definitive_tactic(&item_vec, ListTactic::HorizontalVertical, horizontal_budget);
334 let budget = match tactic {
335 DefinitiveListTactic::Horizontal => horizontal_budget,
339 let fmt = ListFormatting {
342 trailing_separator: SeparatorTactic::Never,
343 indent: argument_offset,
345 ends_with_newline: false,
346 config: context.config,
348 let list_str = try_opt!(write_list(&item_vec, &fmt));
349 let mut prefix = format!("{}|{}|", mover, list_str);
351 if !ret_str.is_empty() {
352 if prefix.contains('\n') {
354 prefix.push_str(&argument_offset.to_string(context.config));
358 prefix.push_str(&ret_str);
361 // Try to format closure body as a single line expression without braces.
362 if is_simple_block(body, context.codemap) && !prefix.contains('\n') {
363 let (spacer, closer) = if ret_str.is_empty() {
368 let expr = body.expr.as_ref().unwrap();
369 // All closure bodies are blocks in the eyes of the AST, but we may not
370 // want to unwrap them when they only contain a single expression.
371 let inner_expr = match expr.node {
372 ast::Expr_::ExprBlock(ref inner) if inner.stmts.is_empty() && inner.expr.is_some() &&
374 ast::BlockCheckMode::DefaultBlock => {
375 inner.expr.as_ref().unwrap()
379 let extra_offset = extra_offset(&prefix, offset) + spacer.len();
380 let budget = try_opt!(width.checked_sub(extra_offset + closer.len()));
381 let rewrite = inner_expr.rewrite(context, budget, offset + extra_offset);
383 // Checks if rewrite succeeded and fits on a single line.
384 let accept_rewrite = rewrite.as_ref().map(|result| !result.contains('\n')).unwrap_or(false);
387 return Some(format!("{}{}{}{}", prefix, spacer, rewrite.unwrap(), closer));
391 // We couldn't format the closure body as a single line expression; fall
392 // back to block formatting.
393 let body_rewrite = body.expr
395 .and_then(|body_expr| {
396 if let ast::Expr_::ExprBlock(ref inner) = body_expr.node {
397 Some(inner.rewrite(&context, 2, Indent::empty()))
402 .unwrap_or_else(|| body.rewrite(&context, 2, Indent::empty()));
404 Some(format!("{} {}", prefix, try_opt!(body_rewrite)))
407 fn nop_block_collapse(block_str: Option<String>, budget: usize) -> Option<String> {
408 block_str.map(|block_str| {
409 if block_str.starts_with("{") && budget >= 2 &&
410 (block_str[1..].find(|c: char| !c.is_whitespace()).unwrap() == block_str.len() - 2) {
418 impl Rewrite for ast::Block {
419 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
420 let user_str = context.snippet(self.span);
421 if user_str == "{}" && width >= 2 {
422 return Some(user_str);
425 let mut visitor = FmtVisitor::from_codemap(context.parse_session, context.config, None);
426 visitor.block_indent = context.block_indent;
428 let prefix = match self.rules {
429 ast::BlockCheckMode::UnsafeBlock(..) => {
430 let snippet = context.snippet(self.span);
431 let open_pos = try_opt!(snippet.find_uncommented("{"));
432 visitor.last_pos = self.span.lo + BytePos(open_pos as u32);
434 // Extract comment between unsafe and block start.
435 let trimmed = &snippet[6..open_pos].trim();
437 let prefix = if !trimmed.is_empty() {
438 // 9 = "unsafe {".len(), 7 = "unsafe ".len()
439 let budget = try_opt!(width.checked_sub(9));
440 format!("unsafe {} ",
441 try_opt!(rewrite_comment(trimmed,
450 if is_simple_block(self, context.codemap) && prefix.len() < width {
454 .rewrite(context, width - prefix.len(), offset);
455 if let Some(ref expr_str) = body {
456 let result = format!("{}{{ {} }}", prefix, expr_str);
457 if result.len() <= width && !result.contains('\n') {
465 ast::BlockCheckMode::DefaultBlock => {
466 visitor.last_pos = self.span.lo;
472 visitor.visit_block(self);
474 Some(format!("{}{}", prefix, visitor.buffer))
478 // Abstraction over for, while and loop expressions
480 cond: Option<&'a ast::Expr>,
481 block: &'a ast::Block,
482 label: Option<ast::Ident>,
483 pat: Option<&'a ast::Pat>,
490 fn new_loop(block: &'a ast::Block, label: Option<ast::Ident>) -> Loop<'a> {
502 fn new_while(pat: Option<&'a ast::Pat>,
504 block: &'a ast::Block,
505 label: Option<ast::Ident>)
521 fn new_for(pat: &'a ast::Pat,
523 block: &'a ast::Block,
524 label: Option<ast::Ident>)
538 impl<'a> Rewrite for Loop<'a> {
539 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
540 let label_string = rewrite_label(self.label);
542 let inner_width = try_opt!(width.checked_sub(self.keyword.len() + 2 + label_string.len()));
543 let inner_offset = offset + self.keyword.len() + label_string.len();
545 let pat_expr_string = match self.cond {
546 Some(cond) => try_opt!(rewrite_pat_expr(context,
553 None => String::new(),
556 // FIXME: this drops any comment between "loop" and the block.
558 .rewrite(context, width, offset)
569 fn rewrite_label(label: Option<ast::Ident>) -> String {
571 Some(ident) => format!("{}: ", ident),
572 None => "".to_owned(),
576 // Rewrites if-else blocks. If let Some(_) = pat, the expression is
577 // treated as an if-let-else expression.
578 fn rewrite_if_else(context: &RewriteContext,
580 if_block: &ast::Block,
581 else_block_opt: Option<&ast::Expr>,
582 pat: Option<&ast::Pat>,
585 allow_single_line: bool)
587 // 3 = "if ", 2 = " {"
588 let pat_expr_string = try_opt!(rewrite_pat_expr(context,
593 try_opt!(width.checked_sub(3 + 2)),
596 // Try to format if-else on single line.
597 if allow_single_line && context.config.single_line_if_else {
598 let trial = single_line_if_else(context, &pat_expr_string, if_block, else_block_opt, width);
605 let if_block_string = try_opt!(if_block.rewrite(context, width, offset));
606 let mut result = format!("if {} {}", pat_expr_string, if_block_string);
608 if let Some(else_block) = else_block_opt {
609 let rewrite = match else_block.node {
610 // If the else expression is another if-else expression, prevent it
611 // from being formatted on a single line.
612 ast::Expr_::ExprIfLet(ref pat, ref cond, ref if_block, ref else_block) => {
613 rewrite_if_else(context,
616 else_block.as_ref().map(|e| &**e),
622 ast::Expr_::ExprIf(ref cond, ref if_block, ref else_block) => {
623 rewrite_if_else(context,
626 else_block.as_ref().map(|e| &**e),
632 _ => else_block.rewrite(context, width, offset),
635 result.push_str(" else ");
636 result.push_str(&&try_opt!(rewrite));
642 fn single_line_if_else(context: &RewriteContext,
644 if_node: &ast::Block,
645 else_block_opt: Option<&ast::Expr>,
648 let else_block = try_opt!(else_block_opt);
649 let fixed_cost = "if { } else { }".len();
651 if let ast::ExprBlock(ref else_node) = else_block.node {
652 if !is_simple_block(if_node, context.codemap) ||
653 !is_simple_block(else_node, context.codemap) || pat_expr_str.contains('\n') {
657 let new_width = try_opt!(width.checked_sub(pat_expr_str.len() + fixed_cost));
658 let if_expr = if_node.expr.as_ref().unwrap();
659 let if_str = try_opt!(if_expr.rewrite(context, new_width, Indent::empty()));
661 let new_width = try_opt!(new_width.checked_sub(if_str.len()));
662 let else_expr = else_node.expr.as_ref().unwrap();
663 let else_str = try_opt!(else_expr.rewrite(context, new_width, Indent::empty()));
665 // FIXME: this check shouldn't be necessary. Rewrites should either fail
666 // or wrap to a newline when the object does not fit the width.
667 let fits_line = fixed_cost + pat_expr_str.len() + if_str.len() + else_str.len() <= width;
669 if fits_line && !if_str.contains('\n') && !else_str.contains('\n') {
670 return Some(format!("if {} {{ {} }} else {{ {} }}",
680 // Checks that a block contains no statements, an expression and no comments.
681 fn is_simple_block(block: &ast::Block, codemap: &CodeMap) -> bool {
682 if !block.stmts.is_empty() || block.expr.is_none() {
686 let snippet = codemap.span_to_snippet(block.span).unwrap();
688 !contains_comment(&snippet)
691 // inter-match-arm-comment-rules:
692 // - all comments following a match arm before the start of the next arm
693 // are about the second arm
694 fn rewrite_match_arm_comment(context: &RewriteContext,
698 arm_indent_str: &str)
700 // The leading "," is not part of the arm-comment
701 let missed_str = match missed_str.find_uncommented(",") {
702 Some(n) => &missed_str[n + 1..],
703 None => &missed_str[..],
706 let mut result = String::new();
707 // any text not preceeded by a newline is pushed unmodified to the block
708 let first_brk = missed_str.find(|c: char| c == '\n').unwrap_or(0);
709 result.push_str(&missed_str[..first_brk]);
710 let missed_str = &missed_str[first_brk..]; // If missed_str had one newline, it starts with it
712 let first = missed_str.find(|c: char| !c.is_whitespace()).unwrap_or(missed_str.len());
713 if missed_str[..first].chars().filter(|c| c == &'\n').count() >= 2 {
714 // Excessive vertical whitespace before comment should be preserved
715 // TODO handle vertical whitespace better
718 let missed_str = missed_str[first..].trim();
719 if !missed_str.is_empty() {
720 let comment = try_opt!(rewrite_comment(&missed_str,
726 result.push_str(arm_indent_str);
727 result.push_str(&comment);
733 fn rewrite_match(context: &RewriteContext,
745 let cond_budget = try_opt!(width.checked_sub(8));
746 let cond_str = try_opt!(cond.rewrite(context, cond_budget, offset + 6));
747 let mut result = format!("match {} {{", cond_str);
749 let nested_context = context.nested_context();
750 let arm_indent = nested_context.block_indent;
751 let arm_indent_str = arm_indent.to_string(context.config);
753 let open_brace_pos = span_after(mk_sp(cond.span.hi, arm_start_pos(&arms[0])),
757 for (i, arm) in arms.iter().enumerate() {
758 // Make sure we get the stuff between arms.
759 let missed_str = if i == 0 {
760 context.snippet(mk_sp(open_brace_pos, arm_start_pos(arm)))
762 context.snippet(mk_sp(arm_end_pos(&arms[i - 1]), arm_start_pos(arm)))
764 let comment = try_opt!(rewrite_match_arm_comment(context,
769 result.push_str(&comment);
771 result.push_str(&arm_indent_str);
773 let arm_str = arm.rewrite(&nested_context,
774 context.config.max_width - arm_indent.width(),
776 if let Some(ref arm_str) = arm_str {
777 result.push_str(arm_str);
779 // We couldn't format the arm, just reproduce the source.
780 let snippet = context.snippet(mk_sp(arm_start_pos(arm), arm_end_pos(arm)));
781 result.push_str(&snippet);
782 result.push_str(arm_comma(&arm.body));
785 // BytePos(1) = closing match brace.
786 let last_span = mk_sp(arm_end_pos(&arms[arms.len() - 1]), span.hi - BytePos(1));
787 let last_comment = context.snippet(last_span);
788 let comment = try_opt!(rewrite_match_arm_comment(context,
793 result.push_str(&comment);
795 result.push_str(&context.block_indent.to_string(context.config));
800 fn arm_start_pos(arm: &ast::Arm) -> BytePos {
801 let &ast::Arm { ref attrs, ref pats, .. } = arm;
802 if !attrs.is_empty() {
803 return attrs[0].span.lo;
809 fn arm_end_pos(arm: &ast::Arm) -> BytePos {
813 fn arm_comma(body: &ast::Expr) -> &'static str {
814 if let ast::ExprBlock(ref block) = body.node {
815 if let ast::DefaultBlock = block.rules {
826 impl Rewrite for ast::Arm {
827 fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
828 let &ast::Arm { ref attrs, ref pats, ref guard, ref body } = self;
829 let indent_str = offset.to_string(context.config);
831 // FIXME this is all a bit grotty, would be nice to abstract out the
832 // treatment of attributes.
833 let attr_str = if !attrs.is_empty() {
834 // We only use this visitor for the attributes, should we use it for
836 let mut attr_visitor = FmtVisitor::from_codemap(context.parse_session,
839 attr_visitor.block_indent = context.block_indent;
840 attr_visitor.last_pos = attrs[0].span.lo;
841 if attr_visitor.visit_attrs(attrs) {
842 // Attributes included a skip instruction.
843 let snippet = context.snippet(mk_sp(attrs[0].span.lo, body.span.hi));
844 return Some(snippet);
846 attr_visitor.format_missing(pats[0].span.lo);
847 attr_visitor.buffer.to_string()
854 let pat_budget = try_opt!(width.checked_sub(5));
855 let pat_strs = try_opt!(pats.iter()
856 .map(|p| p.rewrite(context, pat_budget, offset))
857 .collect::<Option<Vec<_>>>());
859 let mut total_width = pat_strs.iter().fold(0, |a, p| a + p.len());
861 total_width += (pat_strs.len() - 1) * 3;
863 let mut vertical = total_width > pat_budget || pat_strs.iter().any(|p| p.contains('\n'));
864 if !vertical && context.config.take_source_hints {
865 // If the patterns were previously stacked, keep them stacked.
866 let pat_span = mk_sp(pats[0].span.lo, pats[pats.len() - 1].span.hi);
867 let pat_str = context.snippet(pat_span);
868 vertical = pat_str.contains('\n');
871 let pats_width = if vertical {
872 pat_strs[pat_strs.len() - 1].len()
877 let mut pats_str = String::new();
879 if !pats_str.is_empty() {
881 pats_str.push_str(" |\n");
882 pats_str.push_str(&indent_str);
884 pats_str.push_str(" | ");
887 pats_str.push_str(&p);
890 let guard_str = try_opt!(rewrite_guard(context, guard, width, offset, pats_width));
892 let pats_str = format!("{}{}", pats_str, guard_str);
893 // Where the next text can start.
894 let mut line_start = last_line_width(&pats_str);
895 if !pats_str.contains('\n') {
896 line_start += offset.width();
899 let comma = arm_comma(body);
901 // Let's try and get the arm body on the same line as the condition.
903 let same_line_body = if context.config.max_width > line_start + comma.len() + 4 {
904 let budget = context.config.max_width - line_start - comma.len() - 4;
905 let offset = Indent::new(offset.block_indent, line_start + 4 - offset.block_indent);
906 let rewrite = nop_block_collapse(body.rewrite(context, budget, offset), budget);
909 Some(ref body_str) if body_str.len() <= budget || comma.is_empty() =>
910 return Some(format!("{}{} => {}{}",
911 attr_str.trim_left(),
921 if let ast::ExprBlock(_) = body.node {
922 // We're trying to fit a block in, but it still failed, give up.
926 let body_budget = try_opt!(width.checked_sub(context.config.tab_spaces));
927 let indent = context.block_indent.block_indent(context.config);
928 let inner_context = &RewriteContext { block_indent: indent, ..*context };
929 let next_line_body = nop_block_collapse(body.rewrite(inner_context, body_budget, indent),
932 let body_str = try_opt!(match_arm_heuristic(same_line_body.as_ref().map(|x| &x[..]),
933 next_line_body.as_ref().map(|x| &x[..])));
935 let spacer = match same_line_body {
936 Some(ref body) if body == body_str => " ".to_owned(),
938 offset.block_indent(context.config).to_string(context.config)),
941 Some(format!("{}{} =>{}{},",
942 attr_str.trim_left(),
949 // Takes two possible rewrites for the match arm body and chooses the "nicest".
950 fn match_arm_heuristic<'a>(former: Option<&'a str>, latter: Option<&'a str>) -> Option<&'a str> {
951 match (former, latter) {
952 (f @ Some(..), None) => f,
953 (Some(f), Some(l)) if f.chars().filter(|&c| c == '\n').count() <=
954 l.chars().filter(|&c| c == '\n').count() => {
961 // The `if ...` guard on a match arm.
962 fn rewrite_guard(context: &RewriteContext,
963 guard: &Option<ptr::P<ast::Expr>>,
966 // The amount of space used up on this line for the pattern in
967 // the arm (excludes offset).
968 pattern_width: usize)
970 if let &Some(ref guard) = guard {
971 // First try to fit the guard string on the same line as the pattern.
972 // 4 = ` if `, 5 = ` => {`
973 let overhead = pattern_width + 4 + 5;
974 if overhead < width {
975 let cond_str = guard.rewrite(context, width - overhead, offset + pattern_width + 4);
976 if let Some(cond_str) = cond_str {
977 return Some(format!(" if {}", cond_str));
981 // Not enough space to put the guard after the pattern, try a newline.
982 let overhead = context.config.tab_spaces + 4 + 5;
983 if overhead < width {
984 let cond_str = guard.rewrite(context,
986 offset.block_indent(context.config));
987 if let Some(cond_str) = cond_str {
988 return Some(format!("\n{}if {}",
989 offset.block_indent(context.config).to_string(context.config),
1000 fn rewrite_pat_expr(context: &RewriteContext,
1001 pat: Option<&ast::Pat>,
1004 // Connecting piece between pattern and expression,
1005 // *without* trailing space.
1010 let pat_offset = offset + matcher.len();
1011 let mut result = match pat {
1013 let pat_budget = try_opt!(width.checked_sub(connector.len() + matcher.len()));
1014 let pat_string = try_opt!(pat.rewrite(context, pat_budget, pat_offset));
1015 format!("{}{}{}", matcher, pat_string, connector)
1017 None => String::new(),
1020 // Consider only the last line of the pat string.
1021 let extra_offset = extra_offset(&result, offset);
1023 // The expression may (partionally) fit on the current line.
1024 if width > extra_offset + 1 {
1025 let spacer = if pat.is_some() {
1031 let expr_rewrite = expr.rewrite(context,
1032 width - extra_offset - spacer.len(),
1033 offset + extra_offset + spacer.len());
1035 if let Some(expr_string) = expr_rewrite {
1036 result.push_str(spacer);
1037 result.push_str(&expr_string);
1038 return Some(result);
1042 // The expression won't fit on the current line, jump to next.
1044 result.push_str(&pat_offset.to_string(context.config));
1046 let expr_rewrite = expr.rewrite(context,
1047 context.config.max_width - pat_offset.width(),
1049 result.push_str(&&try_opt!(expr_rewrite));
1054 fn rewrite_string_lit(context: &RewriteContext,
1059 if !context.config.format_strings {
1060 return Some(context.snippet(span));
1063 let fmt = StringFormat {
1071 config: context.config,
1074 let string_lit = context.snippet(span);
1075 let str_lit = &string_lit[1..string_lit.len() - 1]; // Remove the quote characters.
1077 rewrite_string(str_lit, &fmt)
1080 pub fn rewrite_call<R>(context: &RewriteContext,
1082 args: &[ptr::P<ast::Expr>],
1089 let closure = |callee_max_width| {
1090 rewrite_call_inner(context, callee, callee_max_width, args, span, width, offset)
1094 let max_width = try_opt!(width.checked_sub(2));
1095 binary_search(1, max_width, closure)
1098 fn rewrite_call_inner<R>(context: &RewriteContext,
1100 max_callee_width: usize,
1101 args: &[ptr::P<ast::Expr>],
1105 -> Result<String, Ordering>
1108 let callee = callee.borrow();
1109 // FIXME using byte lens instead of char lens (and probably all over the
1111 let callee_str = match callee.rewrite(context, max_callee_width, offset) {
1113 if !string.contains('\n') && string.len() > max_callee_width {
1114 panic!("{:?} {}", string, max_callee_width);
1119 None => return Err(Ordering::Greater),
1122 let span_lo = span_after(span, "(", context.codemap);
1123 let span = mk_sp(span_lo, span.hi);
1125 let extra_offset = extra_offset(&callee_str, offset);
1127 let remaining_width = match width.checked_sub(extra_offset + 2) {
1129 None => return Err(Ordering::Greater),
1131 let offset = offset + extra_offset + 1;
1132 let arg_count = args.len();
1133 let block_indent = if arg_count == 1 {
1134 context.block_indent
1138 let inner_context = &RewriteContext { block_indent: block_indent, ..*context };
1140 let items = itemize_list(context.codemap,
1143 |item| item.span.lo,
1144 |item| item.span.hi,
1145 |item| item.rewrite(&inner_context, remaining_width, offset),
1148 let mut item_vec: Vec<_> = items.collect();
1150 // Try letting the last argument overflow to the next line with block
1151 // indentation. If its first line fits on one line with the other arguments,
1152 // we format the function arguments horizontally.
1153 let overflow_last = match args.last().map(|x| &x.node) {
1154 Some(&ast::Expr_::ExprClosure(..)) |
1155 Some(&ast::Expr_::ExprBlock(..)) if arg_count > 1 => true,
1157 } && context.config.chains_overflow_last;
1159 let mut orig_last = None;
1160 let mut placeholder = None;
1162 // Replace the last item with its first line to see if it fits with
1165 let inner_context = &RewriteContext { block_indent: context.block_indent, ..*context };
1166 let rewrite = args.last().unwrap().rewrite(&inner_context, remaining_width, offset);
1168 if let Some(rewrite) = rewrite {
1169 let rewrite_first_line = Some(rewrite[..first_line_width(&rewrite)].to_owned());
1170 placeholder = Some(rewrite);
1172 swap(&mut item_vec[arg_count - 1].item, &mut orig_last);
1173 item_vec[arg_count - 1].item = rewrite_first_line;
1177 let tactic = definitive_tactic(&item_vec,
1178 ListTactic::LimitedHorizontalVertical(context.config
1182 // Replace the stub with the full overflowing last argument if the rewrite
1183 // succeeded and its first line fits with the other arguments.
1184 match (overflow_last, tactic, placeholder) {
1186 DefinitiveListTactic::Horizontal,
1187 placeholder @ Some(..)) => {
1188 item_vec[arg_count - 1].item = placeholder;
1191 item_vec[arg_count - 1].item = orig_last;
1196 let fmt = ListFormatting {
1199 trailing_separator: SeparatorTactic::Never,
1202 ends_with_newline: false,
1203 config: context.config,
1206 let list_str = match write_list(&item_vec, &fmt) {
1208 None => return Err(Ordering::Less),
1211 Ok(format!("{}({})", callee_str, list_str))
1214 fn rewrite_paren(context: &RewriteContext,
1215 subexpr: &ast::Expr,
1219 debug!("rewrite_paren, width: {}, offset: {:?}", width, offset);
1220 // 1 is for opening paren, 2 is for opening+closing, we want to keep the closing
1221 // paren on the same line as the subexpr.
1222 let subexpr_str = subexpr.rewrite(context, try_opt!(width.checked_sub(2)), offset + 1);
1223 debug!("rewrite_paren, subexpr_str: `{:?}`", subexpr_str);
1224 subexpr_str.map(|s| format!("({})", s))
1227 fn rewrite_struct_lit<'a>(context: &RewriteContext,
1229 fields: &'a [ast::Field],
1230 base: Option<&'a ast::Expr>,
1235 debug!("rewrite_struct_lit: width {}, offset {:?}", width, offset);
1236 assert!(!fields.is_empty() || base.is_some());
1238 enum StructLitField<'a> {
1239 Regular(&'a ast::Field),
1240 Base(&'a ast::Expr),
1244 let path_budget = try_opt!(width.checked_sub(2));
1245 let path_str = try_opt!(rewrite_path(context, true, None, path, path_budget, offset));
1247 // Foo { a: Foo } - indent is +3, width is -5.
1248 let h_budget = width.checked_sub(path_str.len() + 5).unwrap_or(0);
1249 let (indent, v_budget) = match context.config.struct_lit_style {
1250 StructLitStyle::Visual => {
1251 (offset + path_str.len() + 3, h_budget)
1253 StructLitStyle::Block => {
1254 // If we are all on one line, then we'll ignore the indent, and we
1255 // have a smaller budget.
1256 let indent = context.block_indent.block_indent(context.config);
1257 let v_budget = context.config.max_width.checked_sub(indent.width()).unwrap_or(0);
1262 let field_iter = fields.into_iter()
1263 .map(StructLitField::Regular)
1264 .chain(base.into_iter().map(StructLitField::Base));
1266 let inner_context = &RewriteContext { block_indent: indent, ..*context };
1268 let items = itemize_list(context.codemap,
1273 StructLitField::Regular(ref field) => field.span.lo,
1274 StructLitField::Base(ref expr) => {
1275 let last_field_hi = fields.last().map_or(span.lo,
1279 let snippet = context.snippet(mk_sp(last_field_hi,
1281 let pos = snippet.find_uncommented("..").unwrap();
1282 last_field_hi + BytePos(pos as u32)
1288 StructLitField::Regular(ref field) => field.span.hi,
1289 StructLitField::Base(ref expr) => expr.span.hi,
1294 StructLitField::Regular(ref field) => {
1295 rewrite_field(inner_context, &field, v_budget, indent)
1297 StructLitField::Base(ref expr) => {
1299 expr.rewrite(inner_context,
1300 try_opt!(v_budget.checked_sub(2)),
1302 .map(|s| format!("..{}", s))
1306 span_after(span, "{", context.codemap),
1308 let item_vec = items.collect::<Vec<_>>();
1311 let mut prelim_tactic = match (context.config.struct_lit_style, fields.len()) {
1312 (StructLitStyle::Visual, 1) => ListTactic::HorizontalVertical,
1313 _ => context.config.struct_lit_multiline_style.to_list_tactic(),
1316 if prelim_tactic == ListTactic::HorizontalVertical && fields.len() > 1 {
1317 prelim_tactic = ListTactic::LimitedHorizontalVertical(context.config.struct_lit_width);
1320 definitive_tactic(&item_vec, prelim_tactic, h_budget)
1323 let budget = match tactic {
1324 DefinitiveListTactic::Horizontal => h_budget,
1328 let fmt = ListFormatting {
1331 trailing_separator: if base.is_some() {
1332 SeparatorTactic::Never
1334 context.config.struct_lit_trailing_comma
1338 ends_with_newline: false,
1339 config: context.config,
1341 let fields_str = try_opt!(write_list(&item_vec, &fmt));
1343 let format_on_newline = || {
1344 let inner_indent = context.block_indent
1345 .block_indent(context.config)
1346 .to_string(context.config);
1347 let outer_indent = context.block_indent.to_string(context.config);
1348 Some(format!("{} {{\n{}{}\n{}}}",
1355 match (context.config.struct_lit_style,
1356 context.config.struct_lit_multiline_style) {
1357 (StructLitStyle::Block, _) if fields_str.contains('\n') || fields_str.len() > h_budget =>
1358 format_on_newline(),
1359 (StructLitStyle::Block, MultilineStyle::ForceMulti) => format_on_newline(),
1360 _ => Some(format!("{} {{ {} }}", path_str, fields_str)),
1363 // FIXME if context.config.struct_lit_style == Visual, but we run out
1364 // of space, we should fall back to BlockIndent.
1367 fn rewrite_field(context: &RewriteContext,
1372 let name = &field.ident.node.to_string();
1373 let overhead = name.len() + 2;
1374 let expr = field.expr.rewrite(context,
1375 try_opt!(width.checked_sub(overhead)),
1377 expr.map(|s| format!("{}: {}", name, s))
1380 pub fn rewrite_tuple<'a, R>(context: &RewriteContext,
1381 items: &'a [ptr::P<R>],
1386 where R: Rewrite + Spanned + 'a
1388 debug!("rewrite_tuple_lit: width: {}, offset: {:?}", width, offset);
1389 let indent = offset + 1;
1390 // In case of length 1, need a trailing comma
1391 if items.len() == 1 {
1393 let budget = try_opt!(width.checked_sub(3));
1394 return items[0].rewrite(context, budget, indent).map(|s| format!("({},)", s));
1397 let items = itemize_list(context.codemap,
1400 |item| item.span().lo,
1401 |item| item.span().hi,
1403 let inner_width = try_opt!(context.config
1405 .checked_sub(indent.width() +
1407 item.rewrite(context, inner_width, indent)
1409 span.lo + BytePos(1), // Remove parens
1410 span.hi - BytePos(1));
1411 let budget = try_opt!(width.checked_sub(2));
1412 let list_str = try_opt!(format_fn_args(items, budget, indent, context.config));
1414 Some(format!("({})", list_str))
1417 fn rewrite_binary_op(context: &RewriteContext,
1424 // FIXME: format comments between operands and operator
1426 let operator_str = context.snippet(op.span);
1428 // Get "full width" rhs and see if it fits on the current line. This
1429 // usually works fairly well since it tends to place operands of
1430 // operations with high precendence close together.
1431 let rhs_result = try_opt!(rhs.rewrite(context, width, offset));
1433 // Second condition is needed in case of line break not caused by a
1434 // shortage of space, but by end-of-line comments, for example.
1435 // Note that this is non-conservative, but its just to see if it's even
1436 // worth trying to put everything on one line.
1437 if rhs_result.len() + 2 + operator_str.len() < width && !rhs_result.contains('\n') {
1438 // 1 = space between lhs expr and operator
1439 if let Some(mut result) = lhs.rewrite(context, width - 1 - operator_str.len(), offset) {
1441 result.push_str(&operator_str);
1444 let remaining_width = width.checked_sub(last_line_width(&result)).unwrap_or(0);
1446 if rhs_result.len() <= remaining_width {
1447 result.push_str(&rhs_result);
1448 return Some(result);
1451 if let Some(rhs_result) = rhs.rewrite(context, remaining_width, offset + result.len()) {
1452 if rhs_result.len() <= remaining_width {
1453 result.push_str(&rhs_result);
1454 return Some(result);
1460 // We have to use multiple lines.
1462 // Re-evaluate the lhs because we have more space now:
1463 let budget = try_opt!(context.config
1465 .checked_sub(offset.width() + 1 + operator_str.len()));
1466 Some(format!("{} {}\n{}{}",
1467 try_opt!(lhs.rewrite(context, budget, offset)),
1469 offset.to_string(context.config),
1473 pub fn rewrite_unary_prefix<R: Rewrite>(context: &RewriteContext,
1479 rewrite.rewrite(context,
1480 try_opt!(width.checked_sub(prefix.len())),
1481 offset + prefix.len())
1482 .map(|r| format!("{}{}", prefix, r))
1485 fn rewrite_unary_op(context: &RewriteContext,
1491 // For some reason, an UnOp is not spanned like BinOp!
1492 let operator_str = match *op {
1493 ast::UnOp::UnDeref => "*",
1494 ast::UnOp::UnNot => "!",
1495 ast::UnOp::UnNeg => "-",
1497 rewrite_unary_prefix(context, operator_str, expr, width, offset)
1500 fn rewrite_assignment(context: &RewriteContext,
1503 op: Option<&ast::BinOp>,
1507 let operator_str = match op {
1508 Some(op) => context.snippet(op.span),
1509 None => "=".to_owned(),
1512 // 1 = space between lhs and operator.
1513 let max_width = try_opt!(width.checked_sub(operator_str.len() + 1));
1514 let lhs_str = format!("{} {}",
1515 try_opt!(lhs.rewrite(context, max_width, offset)),
1518 rewrite_assign_rhs(&context, lhs_str, rhs, width, offset)
1521 // The left hand side must contain everything up to, and including, the
1522 // assignment operator.
1523 pub fn rewrite_assign_rhs<S: Into<String>>(context: &RewriteContext,
1529 let mut result = lhs.into();
1530 let last_line_width = last_line_width(&result) -
1531 if result.contains('\n') {
1536 // 1 = space between operator and rhs.
1537 let max_width = try_opt!(width.checked_sub(last_line_width + 1));
1538 let rhs = ex.rewrite(&context, max_width, offset + last_line_width + 1);
1543 result.push_str(&new_str)
1546 // Expression did not fit on the same line as the identifier. Retry
1547 // on the next line.
1548 let new_offset = offset.block_indent(context.config);
1549 result.push_str(&format!("\n{}", new_offset.to_string(context.config)));
1551 // FIXME: we probably should related max_width to width instead of
1552 // config.max_width where is the 1 coming from anyway?
1553 let max_width = try_opt!(context.config.max_width.checked_sub(new_offset.width() + 1));
1554 let inner_context = context.nested_context();
1555 let rhs = ex.rewrite(&inner_context, max_width, new_offset);
1557 result.push_str(&&try_opt!(rhs));
1564 fn rewrite_expr_addrof(context: &RewriteContext,
1565 mutability: ast::Mutability,
1570 let operator_str = match mutability {
1571 ast::Mutability::MutImmutable => "&",
1572 ast::Mutability::MutMutable => "&mut ",
1574 rewrite_unary_prefix(context, operator_str, expr, width, offset)