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         match context.config.chain_indent {
 137             BlockIndentStyle::Visual => other_child_shape,
 138             BlockIndentStyle::Inherit => shape,
 139             BlockIndentStyle::Tabbed => {
 140                 shape.offset = shape.offset.checked_sub(context.config.tab_spaces).unwrap_or(0);
 141                 shape.indent.block_indent += context.config.tab_spaces;
 142                 shape
 143             }
 144         }
 145     } else {
 146         other_child_shape
 147     };
 148     debug!("child_shapes {:?} {:?}",
 149            first_child_shape,
 150            other_child_shape);
 151
 152     let child_shape_iter =
 153         Some(first_child_shape).into_iter().chain(::std::iter::repeat(other_child_shape)
 154                                                       .take(subexpr_list.len() - 1));
 155     let iter = subexpr_list.iter().rev().zip(child_shape_iter);
 156     let mut rewrites =
 157         try_opt!(iter.map(|(e, shape)| rewrite_chain_subexpr(e, total_span, context, shape))
 158                      .collect::<Option<Vec<_>>>());
 159
 160     // Total of all items excluding the last.
 161     let almost_total = rewrites[..rewrites.len() - 1]
 162         .iter()
 163         .fold(0, |a, b| a + first_line_width(b)) + parent_rewrite.len();
 164
 165     let veto_single_line = if subexpr_list.len() > context.config.chain_one_line_max - 1 {
 166         // -1 above because subexpr_list does not include the parent.
 167         true
 168     } else if context.config.take_source_hints && subexpr_list.len() > 1 {
 169         // Look at the source code. Unless all chain elements start on the same
 170         // line, we won't consider putting them on a single line either.
 171         let last_span = context.snippet(mk_sp(subexpr_list[1].span.hi, total_span.hi));
 172         let first_span = context.snippet(subexpr_list[1].span);
 173         let last_iter = last_span.chars().take_while(|c| c.is_whitespace());
 174
 175         first_span.chars().chain(last_iter).any(|c| c == '\n')
 176     } else {
 177         false
 178     };
 179
 180     let mut fits_single_line = !veto_single_line && almost_total <= shape.width;
 181     if fits_single_line {
 182         let len = rewrites.len();
 183         let (init, last) = rewrites.split_at_mut(len - 1);
 184         fits_single_line = init.iter().all(|s| !s.contains('\n'));
 185
 186         if fits_single_line {
 187             fits_single_line = match expr.node {
 188                 ref e @ ast::ExprKind::MethodCall(..) => {
 189                     rewrite_method_call_with_overflow(e,
 190                                                       &mut last[0],
 191                                                       almost_total,
 192                                                       total_span,
 193                                                       context,
 194                                                       shape)
 195                 }
 196                 _ => !last[0].contains('\n'),
 197             }
 198         }
 199     }
 200
 201     let connector = if fits_single_line && !parent_rewrite.contains('\n') {
 202         // Yay, we can put everything on one line.
 203         String::new()
 204     } else {
 205         // Use new lines.
 206         format!("\n{}", nested_shape.indent.to_string(context.config))
 207     };
 208
 209     let first_connector = if extend || subexpr_list.is_empty() {
 210         ""
 211     } else if let ast::ExprKind::Try(_) = subexpr_list[0].node {
 212         ""
 213     } else {
 214         &*connector
 215     };
 216
 217     wrap_str(format!("{}{}{}",
 218                      parent_rewrite,
 219                      first_connector,
 220                      join_rewrites(&rewrites, &subexpr_list, &connector)),
 221              context.config.max_width,
 222              shape)
 223 }
 224
 225 // True if the chain is only `?`s.
 226 fn chain_only_try(exprs: &[ast::Expr]) -> bool {
 227     exprs.iter().all(|e| if let ast::ExprKind::Try(_) = e.node {
 228                          true
 229                      } else {
 230                          false
 231                      })
 232 }
 233
 234 pub fn rewrite_try(expr: &ast::Expr,
 235                    try_count: usize,
 236                    context: &RewriteContext,
 237                    shape: Shape)
 238                    -> Option<String> {
 239     let sub_expr = try_opt!(expr.rewrite(context, try_opt!(shape.sub_width(try_count))));
 240     Some(format!("{}{}",
 241                  sub_expr,
 242                  iter::repeat("?").take(try_count).collect::<String>()))
 243 }
 244
 245 fn join_rewrites(rewrites: &[String], subexps: &[ast::Expr], connector: &str) -> String {
 246     let mut rewrite_iter = rewrites.iter();
 247     let mut result = rewrite_iter.next().unwrap().clone();
 248     let mut subexpr_iter = subexps.iter().rev();
 249     subexpr_iter.next();
 250
 251     for (rewrite, expr) in rewrite_iter.zip(subexpr_iter) {
 252         match expr.node {
 253             ast::ExprKind::Try(_) => (),
 254             _ => result.push_str(connector),
 255         };
 256         result.push_str(&rewrite[..]);
 257     }
 258
 259     result
 260 }
 261
 262 // States whether an expression's last line exclusively consists of closing
 263 // parens, braces, and brackets in its idiomatic formatting.
 264 fn is_block_expr(expr: &ast::Expr, repr: &str) -> bool {
 265     match expr.node {
 266         ast::ExprKind::Struct(..) |
 267         ast::ExprKind::While(..) |
 268         ast::ExprKind::WhileLet(..) |
 269         ast::ExprKind::If(..) |
 270         ast::ExprKind::IfLet(..) |
 271         ast::ExprKind::Block(..) |
 272         ast::ExprKind::Loop(..) |
 273         ast::ExprKind::ForLoop(..) |
 274         ast::ExprKind::Match(..) => repr.contains('\n'),
 275         ast::ExprKind::Paren(ref expr) |
 276         ast::ExprKind::Binary(_, _, ref expr) |
 277         ast::ExprKind::Index(_, ref expr) |
 278         ast::ExprKind::Unary(_, ref expr) => is_block_expr(expr, repr),
 279         _ => false,
 280     }
 281 }
 282
 283 // Returns the root of the chain and a Vec of the prefixes of the rest of the chain.
 284 // E.g., for input `a.b.c` we return (`a`, [`a.b.c`, `a.b`])
 285 fn make_subexpr_list(expr: &ast::Expr, context: &RewriteContext) -> (ast::Expr, Vec<ast::Expr>) {
 286     let mut subexpr_list = vec![expr.clone()];
 287
 288     while let Some(subexpr) = pop_expr_chain(subexpr_list.last().unwrap(), context) {
 289         subexpr_list.push(subexpr.clone());
 290     }
 291
 292     let parent = subexpr_list.pop().unwrap();
 293     (parent, subexpr_list)
 294 }
 295
 296 fn chain_indent(context: &RewriteContext, shape: Shape) -> Shape {
 297     match context.config.chain_indent {
 298         BlockIndentStyle::Visual => shape.visual_indent(0),
 299         BlockIndentStyle::Inherit => shape.block_indent(0),
 300         BlockIndentStyle::Tabbed => shape.block_indent(context.config.tab_spaces),
 301     }
 302 }
 303
 304 // Ignores visual indenting because this function should be called where it is
 305 // not possible to use visual indentation because we are starting on a newline.
 306 fn chain_indent_newline(context: &RewriteContext, shape: Shape) -> Shape {
 307     match context.config.chain_indent {
 308         BlockIndentStyle::Inherit => shape.block_indent(0),
 309         BlockIndentStyle::Visual | BlockIndentStyle::Tabbed => {
 310             shape.block_indent(context.config.tab_spaces)
 311         }
 312     }
 313 }
 314
 315 fn rewrite_method_call_with_overflow(expr_kind: &ast::ExprKind,
 316                                      last: &mut String,
 317                                      almost_total: usize,
 318                                      total_span: Span,
 319                                      context: &RewriteContext,
 320                                      shape: Shape)
 321                                      -> bool {
 322     if let &ast::ExprKind::MethodCall(ref method_name, ref types, ref expressions) = expr_kind {
 323         let shape = match shape.shrink_left(almost_total) {
 324             Some(b) => b,
 325             None => return false,
 326         };
 327         let mut last_rewrite = rewrite_method_call(method_name.node,
 328                                                    types,
 329                                                    expressions,
 330                                                    total_span,
 331                                                    context,
 332                                                    shape);
 333
 334         if let Some(ref mut s) = last_rewrite {
 335             ::std::mem::swap(s, last);
 336             true
 337         } else {
 338             false
 339         }
 340     } else {
 341         unreachable!();
 342     }
 343 }
 344
 345 // Returns the expression's subexpression, if it exists. When the subexpr
 346 // is a try! macro, we'll convert it to shorthand when the option is set.
 347 fn pop_expr_chain(expr: &ast::Expr, context: &RewriteContext) -> Option<ast::Expr> {
 348     match expr.node {
 349         ast::ExprKind::MethodCall(_, _, ref expressions) => {
 350             Some(convert_try(&expressions[0], context))
 351         }
 352         ast::ExprKind::TupField(ref subexpr, _) |
 353         ast::ExprKind::Field(ref subexpr, _) |
 354         ast::ExprKind::Try(ref subexpr) => Some(convert_try(subexpr, context)),
 355         _ => None,
 356     }
 357 }
 358
 359 fn convert_try(expr: &ast::Expr, context: &RewriteContext) -> ast::Expr {
 360     match expr.node {
 361         ast::ExprKind::Mac(ref mac) if context.config.use_try_shorthand => {
 362             if let Some(subexpr) = convert_try_mac(mac, context) {
 363                 subexpr
 364             } else {
 365                 expr.clone()
 366             }
 367         }
 368         _ => expr.clone(),
 369     }
 370 }
 371
 372 // Rewrite the last element in the chain `expr`. E.g., given `a.b.c` we rewrite
 373 // `.c`.
 374 fn rewrite_chain_subexpr(expr: &ast::Expr,
 375                          span: Span,
 376                          context: &RewriteContext,
 377                          shape: Shape)
 378                          -> Option<String> {
 379     match expr.node {
 380         ast::ExprKind::MethodCall(ref method_name, ref types, ref expressions) => {
 381             rewrite_method_call(method_name.node, types, expressions, span, context, shape)
 382         }
 383         ast::ExprKind::Field(_, ref field) => {
 384             let s = format!(".{}", field.node);
 385             if s.len() <= shape.width {
 386                 Some(s)
 387             } else {
 388                 None
 389             }
 390         }
 391         ast::ExprKind::TupField(_, ref field) => {
 392             let s = format!(".{}", field.node);
 393             if s.len() <= shape.width {
 394                 Some(s)
 395             } else {
 396                 None
 397             }
 398         }
 399         ast::ExprKind::Try(_) => {
 400             if shape.width >= 1 {
 401                 Some("?".into())
 402             } else {
 403                 None
 404             }
 405         }
 406         _ => unreachable!(),
 407     }
 408 }
 409
 410 // Determines if we can continue formatting a given expression on the same line.
 411 fn is_continuable(expr: &ast::Expr) -> bool {
 412     match expr.node {
 413         ast::ExprKind::Path(..) => true,
 414         _ => false,
 415     }
 416 }
 417
 418 fn rewrite_method_call(method_name: ast::Ident,
 419                        types: &[ptr::P<ast::Ty>],
 420                        args: &[ptr::P<ast::Expr>],
 421                        span: Span,
 422                        context: &RewriteContext,
 423                        shape: Shape)
 424                        -> Option<String> {
 425     let (lo, type_str) = if types.is_empty() {
 426         (args[0].span.hi, String::new())
 427     } else {
 428         let type_list: Vec<_> = try_opt!(types.iter()
 429                                              .map(|ty| ty.rewrite(context, shape))
 430                                              .collect());
 431
 432         let type_str = if context.config.spaces_within_angle_brackets && type_list.len() > 0 {
 433             format!("::< {} >", type_list.join(", "))
 434         } else {
 435             format!("::<{}>", type_list.join(", "))
 436         };
 437
 438         (types.last().unwrap().span.hi, type_str)
 439     };
 440
 441     let callee_str = format!(".{}{}", method_name, type_str);
 442     let span = mk_sp(lo, span.hi);
 443
 444     rewrite_call(context, &callee_str, &args[1..], span, shape)
 445 }