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