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 /// Visual:
  28 /// ```
  29 /// let foo = {
  30 ///               aaaa;
  31 ///               bbb;
  32 ///               ccc
  33 ///           }
  34 ///           .bar
  35 ///           .baz();
  36 /// ```
  37 /// Inherit:
  38 /// ```
  39 /// let foo = {
  40 ///     aaaa;
  41 ///     bbb;
  42 ///     ccc
  43 /// }
  44 /// .bar
  45 /// .baz();
  46 /// ```
  47 /// Tabbed:
  48 /// ```
  49 /// let foo = {
  50 ///         aaaa;
  51 ///         bbb;
  52 ///         ccc
  53 ///     }
  54 ///     .bar
  55 ///     .baz();
  56 /// ```
  57 ///
  58 /// If the first item in the chain is a block expression, we align the dots with
  59 /// the braces.
  60 /// Visual:
  61 /// ```
  62 /// let a = foo.bar
  63 ///            .baz()
  64 ///            .qux
  65 /// ```
  66 /// Inherit:
  67 /// ```
  68 /// let a = foo.bar
  69 /// .baz()
  70 /// .qux
  71 /// ```
  72 /// Tabbed:
  73 /// ```
  74 /// let a = foo.bar
  75 ///     .baz()
  76 ///     .qux
  77 /// ```
  78
  79 use Shape;
  80 use rewrite::{Rewrite, RewriteContext};
  81 use utils::{wrap_str, first_line_width, last_line_width};
  82 use expr::rewrite_call;
  83 use config::BlockIndentStyle;
  84 use macros::convert_try_mac;
  85
  86 use std::iter;
  87 use syntax::{ast, ptr};
  88 use syntax::codemap::{mk_sp, Span};
  89
  90 pub fn rewrite_chain(expr: &ast::Expr, context: &RewriteContext, shape: Shape) -> Option<String> {
  91     debug!("rewrite_chain {:?}", shape);
  92     let total_span = expr.span;
  93     let (parent, subexpr_list) = make_subexpr_list(expr, context);
  94
  95     // Bail out if the chain is just try sugar, i.e., an expression followed by
  96     // any number of `?`s.
  97     if chain_only_try(&subexpr_list) {
  98         return rewrite_try(&parent, subexpr_list.len(), context, shape);
  99     }
 100
 101     // Parent is the first item in the chain, e.g., `foo` in `foo.bar.baz()`.
 102     let mut parent_shape = shape;
 103     if is_block_expr(&parent, "\n") {
 104         parent_shape = chain_indent(context, shape);
 105     }
 106     let parent_rewrite = try_opt!(parent.rewrite(context, parent_shape));
 107
 108     // Decide how to layout the rest of the chain. `extend` is true if we can
 109     // put the first non-parent item on the same line as the parent.
 110     let (nested_shape, extend) = if !parent_rewrite.contains('\n') && is_continuable(&parent) {
 111         let nested_shape = if let ast::ExprKind::Try(..) = subexpr_list.last().unwrap().node {
 112             parent_shape.block_indent(context.config.tab_spaces)
 113         } else {
 114             chain_indent(context, shape.add_offset(parent_rewrite.len()))
 115         };
 116         (nested_shape, true)
 117     } else if is_block_expr(&parent, &parent_rewrite) {
 118         // The parent is a block, so align the rest of the chain with the closing
 119         // brace.
 120         (parent_shape, false)
 121     } else if parent_rewrite.contains('\n') {
 122         (chain_indent(context,
 123                       parent_shape.block_indent(context.config.tab_spaces)),
 124          false)
 125     } else {
 126         (chain_indent_newline(context, shape.add_offset(parent_rewrite.len())), false)
 127     };
 128
 129     let max_width = try_opt!((shape.width + shape.indent.width() + shape.offset)
 130                                  .checked_sub(nested_shape.indent.width() +
 131                                               nested_shape.offset));
 132
 133     let other_child_shape = Shape { width: max_width, ..nested_shape };
 134     let first_child_shape = if extend {
 135         let mut shape = try_opt!(parent_shape.shrink_left(last_line_width(&parent_rewrite)));
 136         shape.offset = shape.offset.checked_sub(context.config.tab_spaces).unwrap_or(0);
 137         shape.indent.block_indent += context.config.tab_spaces;
 138         shape
 139     } else {
 140         other_child_shape
 141     };
 142     debug!("child_shapes {:?} {:?}",
 143            first_child_shape,
 144            other_child_shape);
 145
 146     let child_shape_iter =
 147         Some(first_child_shape).into_iter().chain(::std::iter::repeat(other_child_shape)
 148                                                       .take(subexpr_list.len() - 1));
 149     let iter = subexpr_list.iter().rev().zip(child_shape_iter);
 150     let mut rewrites =
 151         try_opt!(iter.map(|(e, shape)| rewrite_chain_subexpr(e, total_span, context, shape))
 152                      .collect::<Option<Vec<_>>>());
 153
 154     // Total of all items excluding the last.
 155     let almost_total = rewrites[..rewrites.len() - 1]
 156         .iter()
 157         .fold(0, |a, b| a + first_line_width(b)) + parent_rewrite.len();
 158
 159     let veto_single_line = if context.config.take_source_hints && subexpr_list.len() > 1 {
 160         // Look at the source code. Unless all chain elements start on the same
 161         // line, we won't consider putting them on a single line either.
 162         let last_span = context.snippet(mk_sp(subexpr_list[1].span.hi, total_span.hi));
 163         let first_span = context.snippet(subexpr_list[1].span);
 164         let last_iter = last_span.chars().take_while(|c| c.is_whitespace());
 165
 166         first_span.chars().chain(last_iter).any(|c| c == '\n')
 167     } else {
 168         false
 169     };
 170
 171     let mut fits_single_line = !veto_single_line && almost_total <= shape.width;
 172     if fits_single_line {
 173         let len = rewrites.len();
 174         let (init, last) = rewrites.split_at_mut(len - 1);
 175         fits_single_line = init.iter().all(|s| !s.contains('\n'));
 176
 177         if fits_single_line {
 178             fits_single_line = match expr.node {
 179                 ref e @ ast::ExprKind::MethodCall(..) => {
 180                     rewrite_method_call_with_overflow(e,
 181                                                       &mut last[0],
 182                                                       almost_total,
 183                                                       total_span,
 184                                                       context,
 185                                                       shape)
 186                 }
 187                 _ => !last[0].contains('\n'),
 188             }
 189         }
 190     }
 191
 192     let connector = if fits_single_line && !parent_rewrite.contains('\n') {
 193         // Yay, we can put everything on one line.
 194         String::new()
 195     } else {
 196         // Use new lines.
 197         format!("\n{}", nested_shape.indent.to_string(context.config))
 198     };
 199
 200     let first_connector = if extend || subexpr_list.is_empty() {
 201         ""
 202     } else if let ast::ExprKind::Try(_) = subexpr_list[0].node {
 203         ""
 204     } else {
 205         &*connector
 206     };
 207
 208     wrap_str(format!("{}{}{}",
 209                      parent_rewrite,
 210                      first_connector,
 211                      join_rewrites(&rewrites, &subexpr_list, &connector)),
 212              context.config.max_width,
 213              shape)
 214 }
 215
 216 // True if the chain is only `?`s.
 217 fn chain_only_try(exprs: &[ast::Expr]) -> bool {
 218     exprs.iter().all(|e| if let ast::ExprKind::Try(_) = e.node {
 219                          true
 220                      } else {
 221                          false
 222                      })
 223 }
 224
 225 pub fn rewrite_try(expr: &ast::Expr,
 226                    try_count: usize,
 227                    context: &RewriteContext,
 228                    shape: Shape)
 229                    -> Option<String> {
 230     let sub_expr = try_opt!(expr.rewrite(context, try_opt!(shape.sub_width(try_count))));
 231     Some(format!("{}{}",
 232                  sub_expr,
 233                  iter::repeat("?").take(try_count).collect::<String>()))
 234 }
 235
 236 fn join_rewrites(rewrites: &[String], subexps: &[ast::Expr], connector: &str) -> String {
 237     let mut rewrite_iter = rewrites.iter();
 238     let mut result = rewrite_iter.next().unwrap().clone();
 239     let mut subexpr_iter = subexps.iter().rev();
 240     subexpr_iter.next();
 241
 242     for (rewrite, expr) in rewrite_iter.zip(subexpr_iter) {
 243         match expr.node {
 244             ast::ExprKind::Try(_) => (),
 245             _ => result.push_str(connector),
 246         };
 247         result.push_str(&rewrite[..]);
 248     }
 249
 250     result
 251 }
 252
 253 // States whether an expression's last line exclusively consists of closing
 254 // parens, braces, and brackets in its idiomatic formatting.
 255 fn is_block_expr(expr: &ast::Expr, repr: &str) -> bool {
 256     match expr.node {
 257         ast::ExprKind::Struct(..) |
 258         ast::ExprKind::While(..) |
 259         ast::ExprKind::WhileLet(..) |
 260         ast::ExprKind::If(..) |
 261         ast::ExprKind::IfLet(..) |
 262         ast::ExprKind::Block(..) |
 263         ast::ExprKind::Loop(..) |
 264         ast::ExprKind::ForLoop(..) |
 265         ast::ExprKind::Match(..) => repr.contains('\n'),
 266         ast::ExprKind::Paren(ref expr) |
 267         ast::ExprKind::Binary(_, _, ref expr) |
 268         ast::ExprKind::Index(_, ref expr) |
 269         ast::ExprKind::Unary(_, ref expr) => is_block_expr(expr, repr),
 270         _ => false,
 271     }
 272 }
 273
 274 // Returns the root of the chain and a Vec of the prefixes of the rest of the chain.
 275 // E.g., for input `a.b.c` we return (`a`, [`a.b.c`, `a.b`])
 276 fn make_subexpr_list(expr: &ast::Expr, context: &RewriteContext) -> (ast::Expr, Vec<ast::Expr>) {
 277     let mut subexpr_list = vec![expr.clone()];
 278
 279     while let Some(subexpr) = pop_expr_chain(subexpr_list.last().unwrap(), context) {
 280         subexpr_list.push(subexpr.clone());
 281     }
 282
 283     let parent = subexpr_list.pop().unwrap();
 284     (parent, subexpr_list)
 285 }
 286
 287 fn chain_indent(context: &RewriteContext, shape: Shape) -> Shape {
 288     match context.config.chain_indent {
 289         BlockIndentStyle::Visual => shape,
 290         BlockIndentStyle::Inherit => shape.block_indent(0),
 291         BlockIndentStyle::Tabbed => shape.block_indent(context.config.tab_spaces),
 292     }
 293 }
 294
 295 // Ignores visual indenting because this function should be called where it is
 296 // not possible to use visual indentation because we are starting on a newline.
 297 fn chain_indent_newline(context: &RewriteContext, shape: Shape) -> Shape {
 298     match context.config.chain_indent {
 299         BlockIndentStyle::Inherit => shape.block_indent(0),
 300         BlockIndentStyle::Visual | BlockIndentStyle::Tabbed => {
 301             shape.block_indent(context.config.tab_spaces)
 302         }
 303     }
 304 }
 305
 306 fn rewrite_method_call_with_overflow(expr_kind: &ast::ExprKind,
 307                                      last: &mut String,
 308                                      almost_total: usize,
 309                                      total_span: Span,
 310                                      context: &RewriteContext,
 311                                      shape: Shape)
 312                                      -> bool {
 313     if let &ast::ExprKind::MethodCall(ref method_name, ref types, ref expressions) = expr_kind {
 314         let shape = match shape.shrink_left(almost_total) {
 315             Some(b) => b,
 316             None => return false,
 317         };
 318         let mut last_rewrite = rewrite_method_call(method_name.node,
 319                                                    types,
 320                                                    expressions,
 321                                                    total_span,
 322                                                    context,
 323                                                    shape);
 324
 325         if let Some(ref mut s) = last_rewrite {
 326             ::std::mem::swap(s, last);
 327             true
 328         } else {
 329             false
 330         }
 331     } else {
 332         unreachable!();
 333     }
 334 }
 335
 336 // Returns the expression's subexpression, if it exists. When the subexpr
 337 // is a try! macro, we'll convert it to shorthand when the option is set.
 338 fn pop_expr_chain(expr: &ast::Expr, context: &RewriteContext) -> Option<ast::Expr> {
 339     match expr.node {
 340         ast::ExprKind::MethodCall(_, _, ref expressions) => {
 341             Some(convert_try(&expressions[0], context))
 342         }
 343         ast::ExprKind::TupField(ref subexpr, _) |
 344         ast::ExprKind::Field(ref subexpr, _) |
 345         ast::ExprKind::Try(ref subexpr) => Some(convert_try(subexpr, context)),
 346         _ => None,
 347     }
 348 }
 349
 350 fn convert_try(expr: &ast::Expr, context: &RewriteContext) -> ast::Expr {
 351     match expr.node {
 352         ast::ExprKind::Mac(ref mac) if context.config.use_try_shorthand => {
 353             if let Some(subexpr) = convert_try_mac(mac, context) {
 354                 subexpr
 355             } else {
 356                 expr.clone()
 357             }
 358         }
 359         _ => expr.clone(),
 360     }
 361 }
 362
 363 // Rewrite the last element in the chain `expr`. E.g., given `a.b.c` we rewrite
 364 // `.c`.
 365 fn rewrite_chain_subexpr(expr: &ast::Expr,
 366                          span: Span,
 367                          context: &RewriteContext,
 368                          shape: Shape)
 369                          -> Option<String> {
 370     match expr.node {
 371         ast::ExprKind::MethodCall(ref method_name, ref types, ref expressions) => {
 372             rewrite_method_call(method_name.node, types, expressions, span, context, shape)
 373         }
 374         ast::ExprKind::Field(_, ref field) => {
 375             let s = format!(".{}", field.node);
 376             if s.len() <= shape.width {
 377                 Some(s)
 378             } else {
 379                 None
 380             }
 381         }
 382         ast::ExprKind::TupField(_, ref field) => {
 383             let s = format!(".{}", field.node);
 384             if s.len() <= shape.width {
 385                 Some(s)
 386             } else {
 387                 None
 388             }
 389         }
 390         ast::ExprKind::Try(_) => {
 391             if shape.width >= 1 {
 392                 Some("?".into())
 393             } else {
 394                 None
 395             }
 396         }
 397         _ => unreachable!(),
 398     }
 399 }
 400
 401 // Determines if we can continue formatting a given expression on the same line.
 402 fn is_continuable(expr: &ast::Expr) -> bool {
 403     match expr.node {
 404         ast::ExprKind::Path(..) => true,
 405         _ => false,
 406     }
 407 }
 408
 409 fn rewrite_method_call(method_name: ast::Ident,
 410                        types: &[ptr::P<ast::Ty>],
 411                        args: &[ptr::P<ast::Expr>],
 412                        span: Span,
 413                        context: &RewriteContext,
 414                        shape: Shape)
 415                        -> Option<String> {
 416     let (lo, type_str) = if types.is_empty() {
 417         (args[0].span.hi, String::new())
 418     } else {
 419         let type_list: Vec<_> = try_opt!(types.iter()
 420                                              .map(|ty| ty.rewrite(context, shape))
 421                                              .collect());
 422
 423         let type_str = if context.config.spaces_within_angle_brackets && type_list.len() > 0 {
 424             format!("::< {} >", type_list.join(", "))
 425         } else {
 426             format!("::<{}>", type_list.join(", "))
 427         };
 428
 429         (types.last().unwrap().span.hi, type_str)
 430     };
 431
 432     let callee_str = format!(".{}{}", method_name, type_str);
 433     let span = mk_sp(lo, span.hi);
 434
 435     rewrite_call(context, &callee_str, &args[1..], span, shape)
 436 }