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