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 /// Formatting of chained expressions, i.e. expressions which are chained by
12 /// dots: struct and enum field access, method calls, and try shorthand (?).
14 /// Instead of walking these subexpressions one-by-one, as is our usual strategy
15 /// for expression formatting, we collect maximal sequences of these expressions
16 /// and handle them simultaneously.
18 /// Whenever possible, the entire chain is put on a single line. If that fails,
19 /// we put each subexpression on a separate, much like the (default) function
20 /// argument function argument strategy.
22 /// Depends on config options: `chain_indent` is the indent to use for
23 /// blocks in the parent/root/base of the chain (and the rest of the chain's
25 /// E.g., `let foo = { aaaa; bbb; ccc }.bar.baz();`, we would layout for the
26 /// following values of `chain_indent`:
47 /// If the first item in the chain is a block expression, we align the dots with
63 use config::IndentStyle;
64 use expr::rewrite_call;
65 use macros::convert_try_mac;
66 use rewrite::{Rewrite, RewriteContext};
67 use utils::{first_line_width, last_line_extendable, last_line_width, mk_sp, wrap_str};
71 use syntax::{ast, ptr};
72 use syntax::codemap::Span;
74 pub fn rewrite_chain(expr: &ast::Expr, context: &RewriteContext, shape: Shape) -> Option<String> {
75 debug!("rewrite_chain {:?}", shape);
76 let total_span = expr.span;
77 let (parent, subexpr_list) = make_subexpr_list(expr, context);
79 // Bail out if the chain is just try sugar, i.e., an expression followed by
80 // any number of `?`s.
81 if chain_only_try(&subexpr_list) {
82 return rewrite_try(&parent, subexpr_list.len(), context, shape);
84 let suffix_try_num = subexpr_list.iter().take_while(|e| is_try(e)).count();
85 let prefix_try_num = subexpr_list.iter().rev().take_while(|e| is_try(e)).count();
87 // Parent is the first item in the chain, e.g., `foo` in `foo.bar.baz()`.
88 let parent_shape = if is_block_expr(context, &parent, "\n") {
89 match context.config.chain_indent() {
90 IndentStyle::Visual => shape.visual_indent(0),
91 IndentStyle::Block => shape,
96 let parent_rewrite = parent
97 .rewrite(context, parent_shape)
98 .map(|parent_rw| parent_rw + &repeat_try(prefix_try_num))?;
99 let parent_rewrite_contains_newline = parent_rewrite.contains('\n');
100 let is_small_parent = parent_rewrite.len() <= context.config.tab_spaces();
102 // Decide how to layout the rest of the chain. `extend` is true if we can
103 // put the first non-parent item on the same line as the parent.
104 let (nested_shape, extend) = if !parent_rewrite_contains_newline && is_continuable(&parent) {
106 chain_indent(context, shape.add_offset(parent_rewrite.len())),
107 context.config.chain_indent() == IndentStyle::Visual || is_small_parent,
109 } else if is_block_expr(context, &parent, &parent_rewrite) {
110 match context.config.chain_indent() {
111 // Try to put the first child on the same line with parent's last line
112 IndentStyle::Block => (parent_shape.block_indent(context.config.tab_spaces()), true),
113 // The parent is a block, so align the rest of the chain with the closing
115 IndentStyle::Visual => (parent_shape, false),
119 chain_indent(context, shape.add_offset(parent_rewrite.len())),
124 let other_child_shape = nested_shape.with_max_width(context.config);
126 let first_child_shape = if extend {
127 let overhead = last_line_width(&parent_rewrite);
128 let offset = parent_rewrite.lines().rev().next().unwrap().trim().len();
129 match context.config.chain_indent() {
130 IndentStyle::Visual => parent_shape.offset_left(overhead)?,
131 IndentStyle::Block => parent_shape.block().offset_left(offset)?,
137 "child_shapes {:?} {:?}",
142 let child_shape_iter = Some(first_child_shape)
144 .chain(iter::repeat(other_child_shape));
145 let subexpr_num = subexpr_list.len();
146 let last_subexpr = &subexpr_list[suffix_try_num];
147 let subexpr_list = &subexpr_list[suffix_try_num..subexpr_num - prefix_try_num];
148 let iter = subexpr_list.iter().skip(1).rev().zip(child_shape_iter);
149 let mut rewrites = iter.map(|(e, shape)| {
150 rewrite_chain_subexpr(e, total_span, context, shape)
151 }).collect::<Option<Vec<_>>>()?;
153 // Total of all items excluding the last.
154 let extend_last_subexr = last_line_extendable(&parent_rewrite) && rewrites.is_empty();
155 let almost_total = if extend_last_subexr {
156 last_line_width(&parent_rewrite)
158 rewrites.iter().fold(0, |a, b| a + b.len()) + parent_rewrite.len()
160 let one_line_budget = if rewrites.is_empty() && !context.config.chain_split_single_child() {
163 min(shape.width, context.config.chain_one_line_max())
165 let all_in_one_line = !parent_rewrite_contains_newline
166 && rewrites.iter().all(|s| !s.contains('\n'))
167 && almost_total < one_line_budget;
168 let last_shape = if rewrites.is_empty() {
169 // We only have a single child.
172 match context.config.chain_indent() {
173 IndentStyle::Visual => other_child_shape.sub_width(shape.rhs_overhead(context.config))?,
174 IndentStyle::Block => other_child_shape,
177 let last_shape = last_shape.sub_width(suffix_try_num)?;
178 let rewrite_last = || rewrite_chain_subexpr(last_subexpr, total_span, context, last_shape);
179 let (last_subexpr_str, fits_single_line) = if all_in_one_line || extend_last_subexr {
180 parent_shape.offset_left(almost_total).map(|shape| {
181 if let Some(rw) = rewrite_chain_subexpr(last_subexpr, total_span, context, shape) {
182 let line_count = rw.lines().count();
183 let fits_single_line = almost_total + first_line_width(&rw) <= one_line_budget;
184 if fits_single_line && (line_count >= 5 || extend_last_subexr) {
187 match rewrite_last() {
188 Some(ref new_rw) if !fits_single_line => (Some(new_rw.clone()), false),
189 Some(ref new_rw) if new_rw.lines().count() >= line_count => {
190 (Some(rw), fits_single_line)
192 new_rw @ Some(..) => (new_rw, false),
193 _ => (Some(rw), fits_single_line),
197 (rewrite_last(), false)
201 (rewrite_last(), false)
203 rewrites.push(last_subexpr_str?);
205 let connector = if fits_single_line && !parent_rewrite_contains_newline {
206 // Yay, we can put everything on one line.
210 if context.force_one_line_chain {
213 format!("\n{}", nested_shape.indent.to_string(context.config))
216 let first_connector = if is_small_parent || fits_single_line
217 || last_line_extendable(&parent_rewrite)
218 || context.config.chain_indent() == IndentStyle::Visual
225 let result = if is_small_parent && rewrites.len() > 1 {
226 let second_connector = if fits_single_line || rewrites[1] == "?"
227 || last_line_extendable(&rewrites[0])
228 || context.config.chain_indent() == IndentStyle::Visual
240 join_rewrites(&rewrites[1..], &connector)
247 join_rewrites(&rewrites, &connector)
250 let result = format!("{}{}", result, repeat_try(suffix_try_num));
251 if context.config.chain_indent() == IndentStyle::Visual {
252 wrap_str(result, context.config.max_width(), shape)
258 // True if the chain is only `?`s.
259 fn chain_only_try(exprs: &[ast::Expr]) -> bool {
260 exprs.iter().all(|e| if let ast::ExprKind::Try(_) = e.node {
267 // Try to rewrite and replace the last non-try child. Return `true` if
268 // replacing succeeds.
269 fn repeat_try(try_count: usize) -> String {
270 iter::repeat("?").take(try_count).collect::<String>()
276 context: &RewriteContext,
278 ) -> Option<String> {
279 let sub_expr = expr.rewrite(context, shape.sub_width(try_count)?)?;
280 Some(format!("{}{}", sub_expr, repeat_try(try_count)))
283 fn join_rewrites(rewrites: &[String], connector: &str) -> String {
284 let mut rewrite_iter = rewrites.iter();
285 let mut result = rewrite_iter.next().unwrap().clone();
287 for rewrite in rewrite_iter {
289 result.push_str(connector);
291 result.push_str(&rewrite[..]);
297 // States whether an expression's last line exclusively consists of closing
298 // parens, braces, and brackets in its idiomatic formatting.
299 fn is_block_expr(context: &RewriteContext, expr: &ast::Expr, repr: &str) -> bool {
301 ast::ExprKind::Mac(..) | ast::ExprKind::Call(..) => {
302 context.use_block_indent() && repr.contains('\n')
304 ast::ExprKind::Struct(..) |
305 ast::ExprKind::While(..) |
306 ast::ExprKind::WhileLet(..) |
307 ast::ExprKind::If(..) |
308 ast::ExprKind::IfLet(..) |
309 ast::ExprKind::Block(..) |
310 ast::ExprKind::Loop(..) |
311 ast::ExprKind::ForLoop(..) |
312 ast::ExprKind::Match(..) => repr.contains('\n'),
313 ast::ExprKind::Paren(ref expr) |
314 ast::ExprKind::Binary(_, _, ref expr) |
315 ast::ExprKind::Index(_, ref expr) |
316 ast::ExprKind::Unary(_, ref expr) => is_block_expr(context, expr, repr),
321 // Returns the root of the chain and a Vec of the prefixes of the rest of the chain.
322 // E.g., for input `a.b.c` we return (`a`, [`a.b.c`, `a.b`])
323 fn make_subexpr_list(expr: &ast::Expr, context: &RewriteContext) -> (ast::Expr, Vec<ast::Expr>) {
324 let mut subexpr_list = vec![expr.clone()];
326 while let Some(subexpr) = pop_expr_chain(subexpr_list.last().unwrap(), context) {
327 subexpr_list.push(subexpr.clone());
330 let parent = subexpr_list.pop().unwrap();
331 (parent, subexpr_list)
334 fn chain_indent(context: &RewriteContext, shape: Shape) -> Shape {
335 match context.config.chain_indent() {
336 IndentStyle::Visual => shape.visual_indent(0),
337 IndentStyle::Block => shape
338 .block_indent(context.config.tab_spaces())
339 .with_max_width(context.config),
343 // Returns the expression's subexpression, if it exists. When the subexpr
344 // is a try! macro, we'll convert it to shorthand when the option is set.
345 fn pop_expr_chain(expr: &ast::Expr, context: &RewriteContext) -> Option<ast::Expr> {
347 ast::ExprKind::MethodCall(_, ref expressions) => {
348 Some(convert_try(&expressions[0], context))
350 ast::ExprKind::TupField(ref subexpr, _) |
351 ast::ExprKind::Field(ref subexpr, _) |
352 ast::ExprKind::Try(ref subexpr) => Some(convert_try(subexpr, context)),
357 fn convert_try(expr: &ast::Expr, context: &RewriteContext) -> ast::Expr {
359 ast::ExprKind::Mac(ref mac) if context.config.use_try_shorthand() => {
360 if let Some(subexpr) = convert_try_mac(mac, context) {
370 // Rewrite the last element in the chain `expr`. E.g., given `a.b.c` we rewrite
372 fn rewrite_chain_subexpr(
375 context: &RewriteContext,
377 ) -> Option<String> {
378 let rewrite_element = |expr_str: String| if expr_str.len() <= shape.width {
385 ast::ExprKind::MethodCall(ref segment, ref expressions) => {
386 let types = match segment.parameters {
387 Some(ref params) => match **params {
388 ast::PathParameters::AngleBracketed(ref data) => &data.types[..],
393 rewrite_method_call(segment.identifier, types, expressions, span, context, shape)
395 ast::ExprKind::Field(_, ref field) => rewrite_element(format!(".{}", field.node)),
396 ast::ExprKind::TupField(ref expr, ref field) => {
397 let space = match expr.node {
398 ast::ExprKind::TupField(..) => " ",
401 rewrite_element(format!("{}.{}", space, field.node))
403 ast::ExprKind::Try(_) => rewrite_element(String::from("?")),
408 // Determines if we can continue formatting a given expression on the same line.
409 fn is_continuable(expr: &ast::Expr) -> bool {
411 ast::ExprKind::Path(..) => true,
416 fn is_try(expr: &ast::Expr) -> bool {
418 ast::ExprKind::Try(..) => true,
423 fn rewrite_method_call(
424 method_name: ast::Ident,
425 types: &[ptr::P<ast::Ty>],
426 args: &[ptr::P<ast::Expr>],
428 context: &RewriteContext,
430 ) -> Option<String> {
431 let (lo, type_str) = if types.is_empty() {
432 (args[0].span.hi(), String::new())
434 let type_list = types
436 .map(|ty| ty.rewrite(context, shape))
437 .collect::<Option<Vec<_>>>()?;
439 let type_str = if context.config.spaces_within_angle_brackets() && !type_list.is_empty() {
440 format!("::< {} >", type_list.join(", "))
442 format!("::<{}>", type_list.join(", "))
445 (types.last().unwrap().span.hi(), type_str)
448 let callee_str = format!(".{}{}", method_name, type_str);
449 let span = mk_sp(lo, span.hi());
451 rewrite_call(context, &callee_str, &args[1..], span, shape)