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