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