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, mk_sp};
  82 use expr::rewrite_call;
  83 use config::IndentStyle;
  84 use macros::convert_try_mac;
  85
  86 use std::cmp::min;
  87 use std::iter;
  88 use syntax::{ast, ptr};
  89 use syntax::codemap::Span;
  90
  91 pub fn rewrite_chain(expr: &ast::Expr, context: &RewriteContext, shape: Shape) -> Option<String> {
  92     debug!("rewrite_chain {:?}", shape);
  93     let total_span = expr.span;
  94     let (parent, subexpr_list) = make_subexpr_list(expr, context);
  95
  96     // Bail out if the chain is just try sugar, i.e., an expression followed by
  97     // any number of `?`s.
  98     if chain_only_try(&subexpr_list) {
  99         return rewrite_try(&parent, subexpr_list.len(), context, shape);
 100     }
 101     let trailing_try_num = subexpr_list
 102         .iter()
 103         .take_while(|e| match e.node {
 104             ast::ExprKind::Try(..) => true,
 105             _ => false,
 106         })
 107         .count();
 108
 109     // Parent is the first item in the chain, e.g., `foo` in `foo.bar.baz()`.
 110     let parent_shape = if is_block_expr(context, &parent, "\n") {
 111         match context.config.chain_indent() {
 112             IndentStyle::Visual => shape.visual_indent(0),
 113             IndentStyle::Block => shape.block(),
 114         }
 115     } else {
 116         shape
 117     };
 118     let parent_rewrite = try_opt!(parent.rewrite(context, parent_shape));
 119     let parent_rewrite_contains_newline = parent_rewrite.contains('\n');
 120     let is_small_parent = parent_rewrite.len() <= context.config.tab_spaces();
 121
 122     // Decide how to layout the rest of the chain. `extend` is true if we can
 123     // put the first non-parent item on the same line as the parent.
 124     let first_subexpr_is_try = subexpr_list.last().map_or(false, is_try);
 125     let (nested_shape, extend) = if !parent_rewrite_contains_newline && is_continuable(&parent) {
 126         let nested_shape = if first_subexpr_is_try {
 127             parent_shape
 128                 .block_indent(context.config.tab_spaces())
 129                 .with_max_width(context.config)
 130         } else {
 131             chain_indent(context, shape.add_offset(parent_rewrite.len()))
 132         };
 133         (
 134             nested_shape,
 135             context.config.chain_indent() == IndentStyle::Visual || is_small_parent,
 136         )
 137     } else if is_block_expr(context, &parent, &parent_rewrite) {
 138         match context.config.chain_indent() {
 139             // Try to put the first child on the same line with parent's last line
 140             IndentStyle::Block => (parent_shape.block_indent(context.config.tab_spaces()), true),
 141             // The parent is a block, so align the rest of the chain with the closing
 142             // brace.
 143             IndentStyle::Visual => (parent_shape, false),
 144         }
 145     } else if parent_rewrite_contains_newline {
 146         (chain_indent(context, parent_shape), false)
 147     } else {
 148         (
 149             shape
 150                 .block_indent(context.config.tab_spaces())
 151                 .with_max_width(context.config),
 152             false,
 153         )
 154     };
 155
 156     let other_child_shape = nested_shape.with_max_width(context.config);
 157
 158     let first_child_shape = if extend {
 159         let overhead = last_line_width(&parent_rewrite);
 160         let offset = parent_rewrite.lines().rev().next().unwrap().trim().len();
 161         match context.config.chain_indent() {
 162             IndentStyle::Visual => try_opt!(parent_shape.offset_left(overhead)),
 163             IndentStyle::Block => try_opt!(parent_shape.block().offset_left(offset)),
 164         }
 165     } else {
 166         other_child_shape
 167     };
 168     debug!(
 169         "child_shapes {:?} {:?}",
 170         first_child_shape,
 171         other_child_shape
 172     );
 173
 174     let child_shape_iter = Some(first_child_shape).into_iter().chain(
 175         ::std::iter::repeat(other_child_shape).take(subexpr_list.len() - 1),
 176     );
 177     let iter = subexpr_list.iter().rev().zip(child_shape_iter);
 178     let mut rewrites = try_opt!(
 179         iter.map(|(e, shape)| {
 180             rewrite_chain_subexpr(e, total_span, context, shape)
 181         }).collect::<Option<Vec<_>>>()
 182     );
 183
 184     // Total of all items excluding the last.
 185     let last_non_try_index = rewrites.len() - (1 + trailing_try_num);
 186     let almost_total = rewrites[..last_non_try_index].iter().fold(
 187         0,
 188         |a, b| a + first_line_width(b),
 189     ) + parent_rewrite.len();
 190     let one_line_len = rewrites.iter().fold(0, |a, r| a + first_line_width(r)) +
 191         parent_rewrite.len();
 192
 193     let one_line_budget = min(shape.width, context.config.chain_one_line_max());
 194     let veto_single_line = if one_line_len > one_line_budget {
 195         if rewrites.len() > 1 {
 196             true
 197         } else if rewrites.len() == 1 {
 198             context.config.chain_split_single_child() || one_line_len > shape.width
 199         } else {
 200             false
 201         }
 202     } else if context.config.take_source_hints() && subexpr_list.len() > 1 {
 203         // Look at the source code. Unless all chain elements start on the same
 204         // line, we won't consider putting them on a single line either.
 205         let last_span = context.snippet(mk_sp(subexpr_list[1].span.hi, total_span.hi));
 206         let first_span = context.snippet(subexpr_list[1].span);
 207         let last_iter = last_span.chars().take_while(|c| c.is_whitespace());
 208
 209         first_span.chars().chain(last_iter).any(|c| c == '\n')
 210     } else {
 211         false
 212     };
 213
 214     let mut fits_single_line = !veto_single_line && almost_total <= shape.width;
 215     if fits_single_line {
 216         let len = rewrites.len();
 217         let (init, last) = rewrites.split_at_mut(len - (1 + trailing_try_num));
 218         fits_single_line = init.iter().all(|s| !s.contains('\n'));
 219
 220         if fits_single_line {
 221             fits_single_line = match expr.node {
 222                 ref e @ ast::ExprKind::MethodCall(..) => {
 223                     if rewrite_method_call_with_overflow(
 224                         e,
 225                         &mut last[0],
 226                         almost_total,
 227                         total_span,
 228                         context,
 229                         shape,
 230                     )
 231                     {
 232                         // If the first line of the last method does not fit into a single line
 233                         // after the others, allow new lines.
 234                         almost_total + first_line_width(&last[0]) < context.config.max_width()
 235                     } else {
 236                         false
 237                     }
 238                 }
 239                 _ => !last[0].contains('\n'),
 240             }
 241         }
 242     }
 243
 244     // Try overflowing the last element if we are using block indent and it goes multi line
 245     // or it fits in a single line but goes over the max width.
 246     if !fits_single_line && context.use_block_indent() {
 247         let (init, last) = rewrites.split_at_mut(last_non_try_index);
 248         let almost_single_line = init.iter().all(|s| !s.contains('\n'));
 249         if almost_single_line && last[0].contains('\n') {
 250             let overflow_shape = Shape {
 251                 width: one_line_budget,
 252                 ..parent_shape
 253             };
 254             fits_single_line = rewrite_last_child_with_overflow(
 255                 context,
 256                 &subexpr_list[trailing_try_num],
 257                 overflow_shape,
 258                 total_span,
 259                 almost_total,
 260                 one_line_budget,
 261                 &mut last[0],
 262             );
 263         }
 264     }
 265
 266     let connector = if fits_single_line && !parent_rewrite_contains_newline {
 267         // Yay, we can put everything on one line.
 268         String::new()
 269     } else {
 270         // Use new lines.
 271         if context.force_one_line_chain {
 272             return None;
 273         }
 274         format!("\n{}", nested_shape.indent.to_string(context.config))
 275     };
 276
 277     let first_connector = choose_first_connector(
 278         context,
 279         &parent_rewrite,
 280         &rewrites[0],
 281         &connector,
 282         &subexpr_list,
 283         extend,
 284     );
 285
 286     if is_small_parent && rewrites.len() > 1 {
 287         let second_connector = choose_first_connector(
 288             context,
 289             &rewrites[0],
 290             &rewrites[1],
 291             &connector,
 292             &subexpr_list[0..subexpr_list.len() - 1],
 293             false,
 294         );
 295         wrap_str(
 296             format!(
 297                 "{}{}{}{}{}",
 298                 parent_rewrite,
 299                 first_connector,
 300                 rewrites[0],
 301                 second_connector,
 302                 join_rewrites(
 303                     &rewrites[1..],
 304                     &subexpr_list[0..subexpr_list.len() - 1],
 305                     &connector,
 306                 )
 307             ),
 308             context.config.max_width(),
 309             shape,
 310         )
 311     } else {
 312         wrap_str(
 313             format!(
 314                 "{}{}{}",
 315                 parent_rewrite,
 316                 first_connector,
 317                 join_rewrites(&rewrites, &subexpr_list, &connector)
 318             ),
 319             context.config.max_width(),
 320             shape,
 321         )
 322     }
 323 }
 324
 325 fn is_extendable_parent(context: &RewriteContext, parent_str: &str) -> bool {
 326     context.config.chain_indent() == IndentStyle::Block &&
 327         parent_str.lines().last().map_or(false, |s| {
 328             s.trim()
 329                 .chars()
 330                 .all(|c| c == ')' || c == ']' || c == '}' || c == '?')
 331         })
 332 }
 333
 334 // True if the chain is only `?`s.
 335 fn chain_only_try(exprs: &[ast::Expr]) -> bool {
 336     exprs.iter().all(|e| if let ast::ExprKind::Try(_) = e.node {
 337         true
 338     } else {
 339         false
 340     })
 341 }
 342
 343 // Try to rewrite and replace the last non-try child. Return `true` if
 344 // replacing succeeds.
 345 fn rewrite_last_child_with_overflow(
 346     context: &RewriteContext,
 347     expr: &ast::Expr,
 348     shape: Shape,
 349     span: Span,
 350     almost_total: usize,
 351     one_line_budget: usize,
 352     last_child: &mut String,
 353 ) -> bool {
 354     if let Some(shape) = shape.shrink_left(almost_total) {
 355         if let Some(ref mut rw) = rewrite_chain_subexpr(expr, span, context, shape) {
 356             if almost_total + first_line_width(rw) <= one_line_budget && rw.lines().count() > 3 {
 357                 ::std::mem::swap(last_child, rw);
 358                 return true;
 359             }
 360         }
 361     }
 362     false
 363 }
 364
 365 pub fn rewrite_try(
 366     expr: &ast::Expr,
 367     try_count: usize,
 368     context: &RewriteContext,
 369     shape: Shape,
 370 ) -> Option<String> {
 371     let sub_expr = try_opt!(expr.rewrite(context, try_opt!(shape.sub_width(try_count))));
 372     Some(format!(
 373         "{}{}",
 374         sub_expr,
 375         iter::repeat("?").take(try_count).collect::<String>()
 376     ))
 377 }
 378
 379 fn join_rewrites(rewrites: &[String], subexps: &[ast::Expr], connector: &str) -> String {
 380     let mut rewrite_iter = rewrites.iter();
 381     let mut result = rewrite_iter.next().unwrap().clone();
 382     let mut subexpr_iter = subexps.iter().rev();
 383     subexpr_iter.next();
 384
 385     for (rewrite, expr) in rewrite_iter.zip(subexpr_iter) {
 386         match expr.node {
 387             ast::ExprKind::Try(_) => (),
 388             _ => result.push_str(connector),
 389         };
 390         result.push_str(&rewrite[..]);
 391     }
 392
 393     result
 394 }
 395
 396 // States whether an expression's last line exclusively consists of closing
 397 // parens, braces, and brackets in its idiomatic formatting.
 398 fn is_block_expr(context: &RewriteContext, expr: &ast::Expr, repr: &str) -> bool {
 399     match expr.node {
 400         ast::ExprKind::Mac(..) |
 401         ast::ExprKind::Call(..) => context.use_block_indent() && repr.contains('\n'),
 402         ast::ExprKind::Struct(..) |
 403         ast::ExprKind::While(..) |
 404         ast::ExprKind::WhileLet(..) |
 405         ast::ExprKind::If(..) |
 406         ast::ExprKind::IfLet(..) |
 407         ast::ExprKind::Block(..) |
 408         ast::ExprKind::Loop(..) |
 409         ast::ExprKind::ForLoop(..) |
 410         ast::ExprKind::Match(..) => repr.contains('\n'),
 411         ast::ExprKind::Paren(ref expr) |
 412         ast::ExprKind::Binary(_, _, ref expr) |
 413         ast::ExprKind::Index(_, ref expr) |
 414         ast::ExprKind::Unary(_, ref expr) => is_block_expr(context, expr, repr),
 415         _ => false,
 416     }
 417 }
 418
 419 // Returns the root of the chain and a Vec of the prefixes of the rest of the chain.
 420 // E.g., for input `a.b.c` we return (`a`, [`a.b.c`, `a.b`])
 421 fn make_subexpr_list(expr: &ast::Expr, context: &RewriteContext) -> (ast::Expr, Vec<ast::Expr>) {
 422     let mut subexpr_list = vec![expr.clone()];
 423
 424     while let Some(subexpr) = pop_expr_chain(subexpr_list.last().unwrap(), context) {
 425         subexpr_list.push(subexpr.clone());
 426     }
 427
 428     let parent = subexpr_list.pop().unwrap();
 429     (parent, subexpr_list)
 430 }
 431
 432 fn chain_indent(context: &RewriteContext, shape: Shape) -> Shape {
 433     match context.config.chain_indent() {
 434         IndentStyle::Visual => shape.visual_indent(0),
 435         IndentStyle::Block => shape.block_indent(context.config.tab_spaces()),
 436     }
 437 }
 438
 439 fn rewrite_method_call_with_overflow(
 440     expr_kind: &ast::ExprKind,
 441     last: &mut String,
 442     almost_total: usize,
 443     total_span: Span,
 444     context: &RewriteContext,
 445     shape: Shape,
 446 ) -> bool {
 447     if let &ast::ExprKind::MethodCall(ref method_name, ref types, ref expressions) = expr_kind {
 448         let shape = match shape.shrink_left(almost_total) {
 449             Some(b) => b,
 450             None => return false,
 451         };
 452         let mut last_rewrite = rewrite_method_call(
 453             method_name.node,
 454             types,
 455             expressions,
 456             total_span,
 457             context,
 458             shape,
 459         );
 460
 461         if let Some(ref mut s) = last_rewrite {
 462             ::std::mem::swap(s, last);
 463             true
 464         } else {
 465             false
 466         }
 467     } else {
 468         unreachable!();
 469     }
 470 }
 471
 472 // Returns the expression's subexpression, if it exists. When the subexpr
 473 // is a try! macro, we'll convert it to shorthand when the option is set.
 474 fn pop_expr_chain(expr: &ast::Expr, context: &RewriteContext) -> Option<ast::Expr> {
 475     match expr.node {
 476         ast::ExprKind::MethodCall(_, _, ref expressions) => {
 477             Some(convert_try(&expressions[0], context))
 478         }
 479         ast::ExprKind::TupField(ref subexpr, _) |
 480         ast::ExprKind::Field(ref subexpr, _) |
 481         ast::ExprKind::Try(ref subexpr) => Some(convert_try(subexpr, context)),
 482         _ => None,
 483     }
 484 }
 485
 486 fn convert_try(expr: &ast::Expr, context: &RewriteContext) -> ast::Expr {
 487     match expr.node {
 488         ast::ExprKind::Mac(ref mac) if context.config.use_try_shorthand() => {
 489             if let Some(subexpr) = convert_try_mac(mac, context) {
 490                 subexpr
 491             } else {
 492                 expr.clone()
 493             }
 494         }
 495         _ => expr.clone(),
 496     }
 497 }
 498
 499 // Rewrite the last element in the chain `expr`. E.g., given `a.b.c` we rewrite
 500 // `.c`.
 501 fn rewrite_chain_subexpr(
 502     expr: &ast::Expr,
 503     span: Span,
 504     context: &RewriteContext,
 505     shape: Shape,
 506 ) -> Option<String> {
 507     let rewrite_element = |expr_str: String| if expr_str.len() <= shape.width {
 508         Some(expr_str)
 509     } else {
 510         None
 511     };
 512
 513     match expr.node {
 514         ast::ExprKind::MethodCall(ref method_name, ref types, ref expressions) => {
 515             rewrite_method_call(method_name.node, types, expressions, span, context, shape)
 516         }
 517         ast::ExprKind::Field(_, ref field) => rewrite_element(format!(".{}", field.node)),
 518         ast::ExprKind::TupField(ref expr, ref field) => {
 519             let space = match expr.node {
 520                 ast::ExprKind::TupField(..) => " ",
 521                 _ => "",
 522             };
 523             rewrite_element(format!("{}.{}", space, field.node))
 524         }
 525         ast::ExprKind::Try(_) => rewrite_element(String::from("?")),
 526         _ => unreachable!(),
 527     }
 528 }
 529
 530 // Determines if we can continue formatting a given expression on the same line.
 531 fn is_continuable(expr: &ast::Expr) -> bool {
 532     match expr.node {
 533         ast::ExprKind::Path(..) => true,
 534         _ => false,
 535     }
 536 }
 537
 538 fn is_try(expr: &ast::Expr) -> bool {
 539     match expr.node {
 540         ast::ExprKind::Try(..) => true,
 541         _ => false,
 542     }
 543 }
 544
 545 fn choose_first_connector<'a>(
 546     context: &RewriteContext,
 547     parent_str: &str,
 548     first_child_str: &str,
 549     connector: &'a str,
 550     subexpr_list: &[ast::Expr],
 551     extend: bool,
 552 ) -> &'a str {
 553     if subexpr_list.is_empty() {
 554         ""
 555     } else if extend || subexpr_list.last().map_or(false, is_try) ||
 556                is_extendable_parent(context, parent_str)
 557     {
 558         // 1 = ";", being conservative here.
 559         if last_line_width(parent_str) + first_line_width(first_child_str) + 1 <=
 560             context.config.max_width()
 561         {
 562             ""
 563         } else {
 564             connector
 565         }
 566     } else {
 567         connector
 568     }
 569 }
 570
 571 fn rewrite_method_call(
 572     method_name: ast::Ident,
 573     types: &[ptr::P<ast::Ty>],
 574     args: &[ptr::P<ast::Expr>],
 575     span: Span,
 576     context: &RewriteContext,
 577     shape: Shape,
 578 ) -> Option<String> {
 579     let (lo, type_str) = if types.is_empty() {
 580         (args[0].span.hi, String::new())
 581     } else {
 582         let type_list: Vec<_> =
 583             try_opt!(types.iter().map(|ty| ty.rewrite(context, shape)).collect());
 584
 585         let type_str = if context.config.spaces_within_angle_brackets() && type_list.len() > 0 {
 586             format!("::< {} >", type_list.join(", "))
 587         } else {
 588             format!("::<{}>", type_list.join(", "))
 589         };
 590
 591         (types.last().unwrap().span.hi, type_str)
 592     };
 593
 594     let callee_str = format!(".{}{}", method_name, type_str);
 595     let span = mk_sp(lo, span.hi);
 596
 597     rewrite_call(context, &callee_str, &args[1..], span, shape)
 598 }