src/chains.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 //! Formatting of chained expressions, i.e. expressions which are chained by
  12 //! dots: struct and enum field access, method calls, and try shorthand (?).
  13 //!
  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.
  17 //!
  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.
  21 //!
  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
  24 //! alignment).
  25 //! E.g., `let foo = { aaaa; bbb; ccc }.bar.baz();`, we would layout for the
  26 //! following values of `chain_indent`:
  27 //! Block:
  28 //!
  29 //! ```ignore
  30 //! let foo = {
  31 //!     aaaa;
  32 //!     bbb;
  33 //!     ccc
  34 //! }.bar
  35 //!     .baz();
  36 //! ```
  37 //!
  38 //! Visual:
  39 //!
  40 //! ```ignore
  41 //! let foo = {
  42 //!               aaaa;
  43 //!               bbb;
  44 //!               ccc
  45 //!           }
  46 //!           .bar
  47 //!           .baz();
  48 //! ```
  49 //!
  50 //! If the first item in the chain is a block expression, we align the dots with
  51 //! the braces.
  52 //! Block:
  53 //!
  54 //! ```ignore
  55 //! let a = foo.bar
  56 //!     .baz()
  57 //!     .qux
  58 //! ```
  59 //!
  60 //! Visual:
  61 //!
  62 //! ```ignore
  63 //! let a = foo.bar
  64 //!            .baz()
  65 //!            .qux
  66 //! ```
  67
  68 use codemap::SpanUtils;
  69 use comment::rewrite_comment;
  70 use config::IndentStyle;
  71 use expr::rewrite_call;
  72 use macros::convert_try_mac;
  73 use rewrite::{Rewrite, RewriteContext};
  74 use shape::Shape;
  75 use utils::{
  76     first_line_width, last_line_extendable, last_line_width, mk_sp, trimmed_last_line_width,
  77     wrap_str,
  78 };
  79
  80 use std::borrow::Cow;
  81 use std::cmp::min;
  82 use std::iter;
  83
  84 use syntax::codemap::Span;
  85 use syntax::{ast, ptr};
  86
  87 pub fn rewrite_chain(expr: &ast::Expr, context: &RewriteContext, shape: Shape) -> Option<String> {
  88     let chain = Chain::from_ast(expr, context);
  89     debug!("rewrite_chain {:?} {:?}", chain, shape);
  90
  91     // If this is just an expression with some `?`s, then format it trivially and
  92     // return early.
  93     if chain.children.is_empty() {
  94         return chain.parent.rewrite(context, shape);
  95     }
  96
  97     chain.rewrite(context, shape)
  98 }
  99
 100 // An expression plus trailing `?`s to be formatted together.
 101 #[derive(Debug)]
 102 struct ChainItem {
 103     kind: ChainItemKind,
 104     tries: usize,
 105     span: Span,
 106 }
 107
 108 // FIXME: we can't use a reference here because to convert `try!` to `?` we
 109 // synthesise the AST node. However, I think we could use `Cow` and that
 110 // would remove a lot of cloning.
 111 #[derive(Debug)]
 112 enum ChainItemKind {
 113     Parent(ast::Expr),
 114     MethodCall(
 115         ast::PathSegment,
 116         Vec<ast::GenericArg>,
 117         Vec<ptr::P<ast::Expr>>,
 118     ),
 119     StructField(ast::Ident),
 120     TupleField(ast::Ident, bool),
 121     Comment,
 122 }
 123
 124 impl ChainItemKind {
 125     fn is_block_like(&self, context: &RewriteContext, reps: &str) -> bool {
 126         match self {
 127             ChainItemKind::Parent(ref expr) => is_block_expr(context, expr, reps),
 128             ChainItemKind::MethodCall(..) => reps.contains('\n'),
 129             ChainItemKind::StructField(..)
 130             | ChainItemKind::TupleField(..)
 131             | ChainItemKind::Comment => false,
 132         }
 133     }
 134
 135     fn is_tup_field_access(expr: &ast::Expr) -> bool {
 136         match expr.node {
 137             ast::ExprKind::Field(_, ref field) => {
 138                 field.name.to_string().chars().all(|c| c.is_digit(10))
 139             }
 140             _ => false,
 141         }
 142     }
 143
 144     fn from_ast(context: &RewriteContext, expr: &ast::Expr) -> (ChainItemKind, Span) {
 145         let (kind, span) = match expr.node {
 146             ast::ExprKind::MethodCall(ref segment, ref expressions) => {
 147                 let types = if let Some(ref generic_args) = segment.args {
 148                     if let ast::GenericArgs::AngleBracketed(ref data) = **generic_args {
 149                         data.args.clone()
 150                     } else {
 151                         vec![]
 152                     }
 153                 } else {
 154                     vec![]
 155                 };
 156                 let span = mk_sp(expressions[0].span.hi(), expr.span.hi());
 157                 let kind = ChainItemKind::MethodCall(segment.clone(), types, expressions.clone());
 158                 (kind, span)
 159             }
 160             ast::ExprKind::Field(ref nested, field) => {
 161                 let kind = if Self::is_tup_field_access(expr) {
 162                     ChainItemKind::TupleField(field, Self::is_tup_field_access(nested))
 163                 } else {
 164                     ChainItemKind::StructField(field)
 165                 };
 166                 let span = mk_sp(nested.span.hi(), field.span.hi());
 167                 (kind, span)
 168             }
 169             _ => return (ChainItemKind::Parent(expr.clone()), expr.span),
 170         };
 171
 172         // Remove comments from the span.
 173         let lo = context.snippet_provider.span_before(span, ".");
 174         (kind, mk_sp(lo, span.hi()))
 175     }
 176 }
 177
 178 impl Rewrite for ChainItem {
 179     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
 180         let shape = shape.sub_width(self.tries)?;
 181         let rewrite = match self.kind {
 182             ChainItemKind::Parent(ref expr) => expr.rewrite(context, shape)?,
 183             ChainItemKind::MethodCall(ref segment, ref types, ref exprs) => {
 184                 Self::rewrite_method_call(segment.ident, types, exprs, self.span, context, shape)?
 185             }
 186             ChainItemKind::StructField(ident) => format!(".{}", ident.name),
 187             ChainItemKind::TupleField(ident, nested) => {
 188                 format!("{}.{}", if nested { " " } else { "" }, ident.name)
 189             }
 190             ChainItemKind::Comment => {
 191                 rewrite_comment(context.snippet(self.span).trim(), false, shape, context.config)?
 192             }
 193         };
 194         Some(format!("{}{}", rewrite, "?".repeat(self.tries)))
 195     }
 196 }
 197
 198 impl ChainItem {
 199     fn new(context: &RewriteContext, expr: &ast::Expr, tries: usize) -> ChainItem {
 200         let (kind, span) = ChainItemKind::from_ast(context, expr);
 201         ChainItem { kind, tries, span }
 202     }
 203
 204     fn comment(span: Span) -> ChainItem {
 205         ChainItem {
 206             kind: ChainItemKind::Comment,
 207             tries: 0,
 208             span,
 209         }
 210     }
 211
 212     fn is_comment(&self) -> bool {
 213         match self.kind {
 214             ChainItemKind::Comment => true,
 215             _ => false,
 216         }
 217     }
 218
 219     fn rewrite_method_call(
 220         method_name: ast::Ident,
 221         types: &[ast::GenericArg],
 222         args: &[ptr::P<ast::Expr>],
 223         span: Span,
 224         context: &RewriteContext,
 225         shape: Shape,
 226     ) -> Option<String> {
 227         let type_str = if types.is_empty() {
 228             String::new()
 229         } else {
 230             let type_list = types
 231                 .iter()
 232                 .map(|ty| ty.rewrite(context, shape))
 233                 .collect::<Option<Vec<_>>>()?;
 234
 235             format!("::<{}>", type_list.join(", "))
 236         };
 237         let callee_str = format!(".{}{}", method_name, type_str);
 238         rewrite_call(context, &callee_str, &args[1..], span, shape)
 239     }
 240 }
 241
 242 #[derive(Debug)]
 243 struct Chain {
 244     parent: ChainItem,
 245     children: Vec<ChainItem>,
 246 }
 247
 248 impl Chain {
 249     fn from_ast(expr: &ast::Expr, context: &RewriteContext) -> Chain {
 250         let subexpr_list = Self::make_subexpr_list(expr, context);
 251
 252         // Un-parse the expression tree into ChainItems
 253         let mut rev_children = vec![];
 254         let mut sub_tries = 0;
 255         for subexpr in &subexpr_list {
 256             match subexpr.node {
 257                 ast::ExprKind::Try(_) => sub_tries += 1,
 258                 _ => {
 259                     rev_children.push(ChainItem::new(context, subexpr, sub_tries));
 260                     sub_tries = 0;
 261                 }
 262             }
 263         }
 264
 265         fn is_tries(s: &str) -> bool {
 266             s.chars().all(|c| c == '?')
 267         }
 268
 269         let parent = rev_children.pop().unwrap();
 270         let mut children = vec![];
 271         let mut prev_hi = parent.span.hi();
 272         for chain_item in rev_children.into_iter().rev() {
 273             let comment_span = mk_sp(prev_hi, chain_item.span.lo());
 274             let comment_snippet = context.snippet(comment_span);
 275             if !(context.config.use_try_shorthand()
 276                 || comment_snippet.trim().is_empty()
 277                 || is_tries(comment_snippet.trim()))
 278             {
 279                 children.push(ChainItem::comment(comment_span));
 280             }
 281             prev_hi = chain_item.span.hi();
 282             children.push(chain_item);
 283         }
 284
 285         Chain { parent, children }
 286     }
 287
 288     // Returns a Vec of the prefixes of the chain.
 289     // E.g., for input `a.b.c` we return [`a.b.c`, `a.b`, 'a']
 290     fn make_subexpr_list(expr: &ast::Expr, context: &RewriteContext) -> Vec<ast::Expr> {
 291         let mut subexpr_list = vec![expr.clone()];
 292
 293         while let Some(subexpr) = Self::pop_expr_chain(subexpr_list.last().unwrap(), context) {
 294             subexpr_list.push(subexpr.clone());
 295         }
 296
 297         subexpr_list
 298     }
 299
 300     // Returns the expression's subexpression, if it exists. When the subexpr
 301     // is a try! macro, we'll convert it to shorthand when the option is set.
 302     fn pop_expr_chain(expr: &ast::Expr, context: &RewriteContext) -> Option<ast::Expr> {
 303         match expr.node {
 304             ast::ExprKind::MethodCall(_, ref expressions) => {
 305                 Some(Self::convert_try(&expressions[0], context))
 306             }
 307             ast::ExprKind::Field(ref subexpr, _) | ast::ExprKind::Try(ref subexpr) => {
 308                 Some(Self::convert_try(subexpr, context))
 309             }
 310             _ => None,
 311         }
 312     }
 313
 314     fn convert_try(expr: &ast::Expr, context: &RewriteContext) -> ast::Expr {
 315         match expr.node {
 316             ast::ExprKind::Mac(ref mac) if context.config.use_try_shorthand() => {
 317                 if let Some(subexpr) = convert_try_mac(mac, context) {
 318                     subexpr
 319                 } else {
 320                     expr.clone()
 321                 }
 322             }
 323             _ => expr.clone(),
 324         }
 325     }
 326 }
 327
 328 impl Rewrite for Chain {
 329     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
 330         debug!("rewrite chain {:?} {:?}", self, shape);
 331
 332         let mut formatter = match context.config.indent_style() {
 333             IndentStyle::Block => Box::new(ChainFormatterBlock::new(self)) as Box<ChainFormatter>,
 334             IndentStyle::Visual => Box::new(ChainFormatterVisual::new(self)) as Box<ChainFormatter>,
 335         };
 336
 337         formatter.format_root(&self.parent, context, shape)?;
 338         if let Some(result) = formatter.pure_root() {
 339             return wrap_str(result, context.config.max_width(), shape);
 340         }
 341
 342         // Decide how to layout the rest of the chain.
 343         let child_shape = formatter.child_shape(context, shape)?;
 344
 345         formatter.format_children(context, child_shape)?;
 346         formatter.format_last_child(context, shape, child_shape)?;
 347
 348         let result = formatter.join_rewrites(context, child_shape)?;
 349         wrap_str(result, context.config.max_width(), shape)
 350     }
 351 }
 352
 353 // There are a few types for formatting chains. This is because there is a lot
 354 // in common between formatting with block vs visual indent, but they are
 355 // different enough that branching on the indent all over the place gets ugly.
 356 // Anything that can format a chain is a ChainFormatter.
 357 trait ChainFormatter {
 358     // Parent is the first item in the chain, e.g., `foo` in `foo.bar.baz()`.
 359     // Root is the parent plus any other chain items placed on the first line to
 360     // avoid an orphan. E.g.,
 361     // ```
 362     // foo.bar
 363     //     .baz()
 364     // ```
 365     // If `bar` were not part of the root, then foo would be orphaned and 'float'.
 366     fn format_root(
 367         &mut self,
 368         parent: &ChainItem,
 369         context: &RewriteContext,
 370         shape: Shape,
 371     ) -> Option<()>;
 372     fn child_shape(&self, context: &RewriteContext, shape: Shape) -> Option<Shape>;
 373     fn format_children(&mut self, context: &RewriteContext, child_shape: Shape) -> Option<()>;
 374     fn format_last_child(
 375         &mut self,
 376         context: &RewriteContext,
 377         shape: Shape,
 378         child_shape: Shape,
 379     ) -> Option<()>;
 380     fn join_rewrites(&self, context: &RewriteContext, child_shape: Shape) -> Option<String>;
 381     // Returns `Some` if the chain is only a root, None otherwise.
 382     fn pure_root(&mut self) -> Option<String>;
 383 }
 384
 385 // Data and behaviour that is shared by both chain formatters. The concrete
 386 // formatters can delegate much behaviour to `ChainFormatterShared`.
 387 struct ChainFormatterShared<'a> {
 388     // The current working set of child items.
 389     children: &'a [ChainItem],
 390     // The current rewrites of items (includes trailing `?`s, but not any way to
 391     // connect the rewrites together).
 392     rewrites: Vec<String>,
 393     // Whether the chain can fit on one line.
 394     fits_single_line: bool,
 395     // The number of children in the chain. This is not equal to `self.children.len()`
 396     // because `self.children` will change size as we process the chain.
 397     child_count: usize,
 398 }
 399
 400 impl<'a> ChainFormatterShared<'a> {
 401     fn new(chain: &'a Chain) -> ChainFormatterShared<'a> {
 402         ChainFormatterShared {
 403             children: &chain.children,
 404             rewrites: Vec::with_capacity(chain.children.len() + 1),
 405             fits_single_line: false,
 406             child_count: chain.children.len(),
 407         }
 408     }
 409
 410     fn pure_root(&mut self) -> Option<String> {
 411         if self.children.is_empty() {
 412             assert_eq!(self.rewrites.len(), 1);
 413             Some(self.rewrites.pop().unwrap())
 414         } else {
 415             None
 416         }
 417     }
 418
 419     // Rewrite the last child. The last child of a chain requires special treatment. We need to
 420     // know whether 'overflowing' the last child make a better formatting:
 421     //
 422     // A chain with overflowing the last child:
 423     // ```
 424     // parent.child1.child2.last_child(
 425     //     a,
 426     //     b,
 427     //     c,
 428     // )
 429     // ```
 430     //
 431     // A chain without overflowing the last child (in vertical layout):
 432     // ```
 433     // parent
 434     //     .child1
 435     //     .child2
 436     //     .last_child(a, b, c)
 437     // ```
 438     //
 439     // In particular, overflowing is effective when the last child is a method with a multi-lined
 440     // block-like argument (e.g. closure):
 441     // ```
 442     // parent.child1.child2.last_child(|a, b, c| {
 443     //     let x = foo(a, b, c);
 444     //     let y = bar(a, b, c);
 445     //
 446     //     // ...
 447     //
 448     //     result
 449     // })
 450     // ```
 451     fn format_last_child(
 452         &mut self,
 453         may_extend: bool,
 454         context: &RewriteContext,
 455         shape: Shape,
 456         child_shape: Shape,
 457     ) -> Option<()> {
 458         let last = self.children.last()?;
 459         let extendable = may_extend && last_line_extendable(&self.rewrites[0]);
 460         let prev_last_line_width = last_line_width(&self.rewrites[0]);
 461
 462         // Total of all items excluding the last.
 463         let almost_total = if extendable {
 464             prev_last_line_width
 465         } else {
 466             self.rewrites.iter().fold(0, |a, b| a + b.len())
 467         } + last.tries;
 468         let one_line_budget = if self.child_count == 1 {
 469             shape.width
 470         } else {
 471             min(shape.width, context.config.width_heuristics().chain_width)
 472         }.saturating_sub(almost_total);
 473
 474         let all_in_one_line =
 475             !self.children.iter().any(ChainItem::is_comment)
 476             && self.rewrites.iter().all(|s| !s.contains('\n'))
 477             && one_line_budget > 0;
 478         let last_shape = if all_in_one_line {
 479             shape.sub_width(last.tries)?
 480         } else if extendable {
 481             child_shape.sub_width(last.tries)?
 482         } else {
 483             child_shape.sub_width(shape.rhs_overhead(context.config) + last.tries)?
 484         };
 485
 486         let mut last_subexpr_str = None;
 487         if all_in_one_line || extendable {
 488             // First we try to 'overflow' the last child and see if it looks better than using
 489             // vertical layout.
 490             if let Some(one_line_shape) = last_shape.offset_left(almost_total) {
 491                 if let Some(rw) = last.rewrite(context, one_line_shape) {
 492                     // We allow overflowing here only if both of the following conditions match:
 493                     // 1. The entire chain fits in a single line except the last child.
 494                     // 2. `last_child_str.lines().count() >= 5`.
 495                     let line_count = rw.lines().count();
 496                     let could_fit_single_line = first_line_width(&rw) <= one_line_budget;
 497                     if could_fit_single_line && line_count >= 5 {
 498                         last_subexpr_str = Some(rw);
 499                         self.fits_single_line = all_in_one_line;
 500                     } else {
 501                         // We could not know whether overflowing is better than using vertical
 502                         // layout, just by looking at the overflowed rewrite. Now we rewrite the
 503                         // last child on its own line, and compare two rewrites to choose which is
 504                         // better.
 505                         let last_shape = child_shape
 506                             .sub_width(shape.rhs_overhead(context.config) + last.tries)?;
 507                         match last.rewrite(context, last_shape) {
 508                             Some(ref new_rw) if !could_fit_single_line => {
 509                                 last_subexpr_str = Some(new_rw.clone());
 510                             }
 511                             Some(ref new_rw) if new_rw.lines().count() >= line_count => {
 512                                 last_subexpr_str = Some(rw);
 513                                 self.fits_single_line = could_fit_single_line && all_in_one_line;
 514                             }
 515                             new_rw @ Some(..) => {
 516                                 last_subexpr_str = new_rw;
 517                             }
 518                             _ => {
 519                                 last_subexpr_str = Some(rw);
 520                                 self.fits_single_line = could_fit_single_line && all_in_one_line;
 521                             }
 522                         }
 523                     }
 524                 }
 525             }
 526         }
 527
 528         last_subexpr_str = last_subexpr_str.or_else(|| last.rewrite(context, last_shape));
 529         self.rewrites.push(last_subexpr_str?);
 530         Some(())
 531     }
 532
 533     fn join_rewrites(
 534         &self,
 535         context: &RewriteContext,
 536         child_shape: Shape,
 537         block_like_iter: impl Iterator<Item = bool>,
 538     ) -> Option<String> {
 539         let connector = if self.fits_single_line {
 540             // Yay, we can put everything on one line.
 541             Cow::from("")
 542         } else {
 543             // Use new lines.
 544             if *context.force_one_line_chain.borrow() {
 545                 return None;
 546             }
 547             child_shape.to_string_with_newline(context.config)
 548         };
 549
 550         let mut rewrite_iter = self.rewrites.iter();
 551         let mut result = rewrite_iter.next().unwrap().clone();
 552
 553         for (rewrite, prev_is_block_like) in rewrite_iter.zip(block_like_iter) {
 554             if !prev_is_block_like {
 555                 result.push_str(&connector);
 556             } else if rewrite.starts_with('/') {
 557                 // This is comment, add a space before it.
 558                 result.push(' ');
 559             }
 560             result.push_str(&rewrite);
 561         }
 562
 563         Some(result)
 564     }
 565 }
 566
 567 // Formats a chain using block indent.
 568 struct ChainFormatterBlock<'a> {
 569     shared: ChainFormatterShared<'a>,
 570     // For each rewrite, whether the corresponding item is block-like.
 571     is_block_like: Vec<bool>,
 572 }
 573
 574 impl<'a> ChainFormatterBlock<'a> {
 575     fn new(chain: &'a Chain) -> ChainFormatterBlock<'a> {
 576         ChainFormatterBlock {
 577             shared: ChainFormatterShared::new(chain),
 578             is_block_like: Vec::with_capacity(chain.children.len() + 1),
 579         }
 580     }
 581 }
 582
 583 impl<'a> ChainFormatter for ChainFormatterBlock<'a> {
 584     fn format_root(
 585         &mut self,
 586         parent: &ChainItem,
 587         context: &RewriteContext,
 588         shape: Shape,
 589     ) -> Option<()> {
 590         let mut root_rewrite: String = parent.rewrite(context, shape)?;
 591
 592         let mut root_ends_with_block = parent.kind.is_block_like(context, &root_rewrite);
 593         let tab_width = context.config.tab_spaces().saturating_sub(shape.offset);
 594
 595         while root_rewrite.len() <= tab_width && !root_rewrite.contains('\n') {
 596             let item = &self.shared.children[0];
 597             if let ChainItemKind::Comment = item.kind {
 598                 break;
 599             }
 600             let shape = shape.offset_left(root_rewrite.len())?;
 601             match &item.rewrite(context, shape) {
 602                 Some(rewrite) => root_rewrite.push_str(rewrite),
 603                 None => break,
 604             }
 605
 606             root_ends_with_block = item.kind.is_block_like(context, &root_rewrite);
 607
 608             self.shared.children = &self.shared.children[1..];
 609             if self.shared.children.is_empty() {
 610                 break;
 611             }
 612         }
 613         self.is_block_like.push(root_ends_with_block);
 614         self.shared.rewrites.push(root_rewrite);
 615         Some(())
 616     }
 617
 618     fn child_shape(&self, context: &RewriteContext, shape: Shape) -> Option<Shape> {
 619         Some(
 620             if self.is_block_like[0] {
 621                 shape.block_indent(0)
 622             } else {
 623                 shape.block_indent(context.config.tab_spaces())
 624             }.with_max_width(context.config),
 625         )
 626     }
 627
 628     fn format_children(&mut self, context: &RewriteContext, child_shape: Shape) -> Option<()> {
 629         for item in &self.shared.children[..self.shared.children.len() - 1] {
 630             let rewrite = item.rewrite(context, child_shape)?;
 631             self.is_block_like
 632                 .push(item.kind.is_block_like(context, &rewrite));
 633             self.shared.rewrites.push(rewrite);
 634         }
 635         Some(())
 636     }
 637
 638     fn format_last_child(
 639         &mut self,
 640         context: &RewriteContext,
 641         shape: Shape,
 642         child_shape: Shape,
 643     ) -> Option<()> {
 644         self.shared
 645             .format_last_child(true, context, shape, child_shape)
 646     }
 647
 648     fn join_rewrites(&self, context: &RewriteContext, child_shape: Shape) -> Option<String> {
 649         self.shared
 650             .join_rewrites(context, child_shape, self.is_block_like.iter().cloned())
 651     }
 652
 653     fn pure_root(&mut self) -> Option<String> {
 654         self.shared.pure_root()
 655     }
 656 }
 657
 658 // Format a chain using visual indent.
 659 struct ChainFormatterVisual<'a> {
 660     shared: ChainFormatterShared<'a>,
 661     // The extra offset from the chain's shape to the position of the `.`
 662     offset: usize,
 663 }
 664
 665 impl<'a> ChainFormatterVisual<'a> {
 666     fn new(chain: &'a Chain) -> ChainFormatterVisual<'a> {
 667         ChainFormatterVisual {
 668             shared: ChainFormatterShared::new(chain),
 669             offset: 0,
 670         }
 671     }
 672 }
 673
 674 impl<'a> ChainFormatter for ChainFormatterVisual<'a> {
 675     fn format_root(
 676         &mut self,
 677         parent: &ChainItem,
 678         context: &RewriteContext,
 679         shape: Shape,
 680     ) -> Option<()> {
 681         let parent_shape = shape.visual_indent(0);
 682         let mut root_rewrite = parent.rewrite(context, parent_shape)?;
 683         let multiline = root_rewrite.contains('\n');
 684         self.offset = if multiline {
 685             last_line_width(&root_rewrite).saturating_sub(shape.used_width())
 686         } else {
 687             trimmed_last_line_width(&root_rewrite)
 688         };
 689
 690         if !multiline || parent.kind.is_block_like(context, &root_rewrite) {
 691             let item = &self.shared.children[0];
 692             if let ChainItemKind::Comment = item.kind {
 693                 self.shared.rewrites.push(root_rewrite);
 694                 return Some(());
 695             }
 696             let child_shape = parent_shape
 697                 .visual_indent(self.offset)
 698                 .sub_width(self.offset)?;
 699             let rewrite = item.rewrite(context, child_shape)?;
 700             match wrap_str(rewrite, context.config.max_width(), shape) {
 701                 Some(rewrite) => root_rewrite.push_str(&rewrite),
 702                 None => {
 703                     // We couldn't fit in at the visual indent, try the last
 704                     // indent.
 705                     let rewrite = item.rewrite(context, parent_shape)?;
 706                     root_rewrite.push_str(&rewrite);
 707                     self.offset = 0;
 708                 }
 709             }
 710
 711             self.shared.children = &self.shared.children[1..];
 712         }
 713
 714         self.shared.rewrites.push(root_rewrite);
 715         Some(())
 716     }
 717
 718     fn child_shape(&self, context: &RewriteContext, shape: Shape) -> Option<Shape> {
 719         shape
 720             .with_max_width(context.config)
 721             .offset_left(self.offset)
 722             .map(|s| s.visual_indent(0))
 723     }
 724
 725     fn format_children(&mut self, context: &RewriteContext, child_shape: Shape) -> Option<()> {
 726         for item in &self.shared.children[..self.shared.children.len() - 1] {
 727             let rewrite = item.rewrite(context, child_shape)?;
 728             self.shared.rewrites.push(rewrite);
 729         }
 730         Some(())
 731     }
 732
 733     fn format_last_child(
 734         &mut self,
 735         context: &RewriteContext,
 736         shape: Shape,
 737         child_shape: Shape,
 738     ) -> Option<()> {
 739         self.shared
 740             .format_last_child(false, context, shape, child_shape)
 741     }
 742
 743     fn join_rewrites(&self, context: &RewriteContext, child_shape: Shape) -> Option<String> {
 744         self.shared
 745             .join_rewrites(context, child_shape, iter::repeat(false))
 746     }
 747
 748     fn pure_root(&mut self) -> Option<String> {
 749         self.shared.pure_root()
 750     }
 751 }
 752
 753 // States whether an expression's last line exclusively consists of closing
 754 // parens, braces, and brackets in its idiomatic formatting.
 755 fn is_block_expr(context: &RewriteContext, expr: &ast::Expr, repr: &str) -> bool {
 756     match expr.node {
 757         ast::ExprKind::Mac(..)
 758         | ast::ExprKind::Call(..)
 759         | ast::ExprKind::MethodCall(..)
 760         | ast::ExprKind::Struct(..)
 761         | ast::ExprKind::While(..)
 762         | ast::ExprKind::WhileLet(..)
 763         | ast::ExprKind::If(..)
 764         | ast::ExprKind::IfLet(..)
 765         | ast::ExprKind::Block(..)
 766         | ast::ExprKind::Loop(..)
 767         | ast::ExprKind::ForLoop(..)
 768         | ast::ExprKind::Match(..) => repr.contains('\n'),
 769         ast::ExprKind::Paren(ref expr)
 770         | ast::ExprKind::Binary(_, _, ref expr)
 771         | ast::ExprKind::Index(_, ref expr)
 772         | ast::ExprKind::Unary(_, ref expr)
 773         | ast::ExprKind::Closure(_, _, _, _, ref expr, _)
 774         | ast::ExprKind::Try(ref expr)
 775         | ast::ExprKind::Yield(Some(ref expr)) => is_block_expr(context, expr, repr),
 776         // This can only be a string lit
 777         ast::ExprKind::Lit(_) => {
 778             repr.contains('\n') && trimmed_last_line_width(repr) <= context.config.tab_spaces()
 779         }
 780         _ => false,
 781     }
 782 }