src/closures.rs

   1 // Copyright 2017 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 use syntax::{ast, ptr};
  12 use syntax::codemap::Span;
  13 use syntax::parse::classify;
  14
  15 use codemap::SpanUtils;
  16 use expr::{block_contains_comment, is_simple_block, is_unsafe_block, rewrite_cond, ToExpr};
  17 use items::{span_hi_for_arg, span_lo_for_arg};
  18 use lists::{definitive_tactic, itemize_list, write_list, DefinitiveListTactic, ListFormatting,
  19             ListTactic, Separator, SeparatorPlace, SeparatorTactic};
  20 use rewrite::{Rewrite, RewriteContext};
  21 use shape::Shape;
  22 use utils::{last_line_width, left_most_sub_expr, stmt_expr};
  23
  24 // This module is pretty messy because of the rules around closures and blocks:
  25 // FIXME - the below is probably no longer true in full.
  26 //   * if there is a return type, then there must be braces,
  27 //   * given a closure with braces, whether that is parsed to give an inner block
  28 //     or not depends on if there is a return type and if there are statements
  29 //     in that block,
  30 //   * if the first expression in the body ends with a block (i.e., is a
  31 //     statement without needing a semi-colon), then adding or removing braces
  32 //     can change whether it is treated as an expression or statement.
  33
  34 pub fn rewrite_closure(
  35     capture: ast::CaptureBy,
  36     fn_decl: &ast::FnDecl,
  37     body: &ast::Expr,
  38     span: Span,
  39     context: &RewriteContext,
  40     shape: Shape,
  41 ) -> Option<String> {
  42     debug!("rewrite_closure {:?}", body);
  43
  44     let (prefix, extra_offset) =
  45         rewrite_closure_fn_decl(capture, fn_decl, body, span, context, shape)?;
  46     // 1 = space between `|...|` and body.
  47     let body_shape = shape.offset_left(extra_offset)?;
  48
  49     if let ast::ExprKind::Block(ref block) = body.node {
  50         // The body of the closure is an empty block.
  51         if block.stmts.is_empty() && !block_contains_comment(block, context.codemap) {
  52             return Some(format!("{} {{}}", prefix));
  53         }
  54
  55         let result = match fn_decl.output {
  56             ast::FunctionRetTy::Default(_) => {
  57                 try_rewrite_without_block(body, &prefix, context, shape, body_shape)
  58             }
  59             _ => None,
  60         };
  61
  62         result.or_else(|| {
  63             // Either we require a block, or tried without and failed.
  64             rewrite_closure_block(block, &prefix, context, body_shape)
  65         })
  66     } else {
  67         rewrite_closure_expr(body, &prefix, context, body_shape).or_else(|| {
  68             // The closure originally had a non-block expression, but we can't fit on
  69             // one line, so we'll insert a block.
  70             rewrite_closure_with_block(body, &prefix, context, body_shape)
  71         })
  72     }
  73 }
  74
  75 fn try_rewrite_without_block(
  76     expr: &ast::Expr,
  77     prefix: &str,
  78     context: &RewriteContext,
  79     shape: Shape,
  80     body_shape: Shape,
  81 ) -> Option<String> {
  82     let expr = get_inner_expr(expr, prefix, context);
  83
  84     if is_block_closure_forced(expr) {
  85         rewrite_closure_with_block(expr, prefix, context, shape)
  86     } else {
  87         rewrite_closure_expr(expr, prefix, context, body_shape)
  88     }
  89 }
  90
  91 fn get_inner_expr<'a>(
  92     expr: &'a ast::Expr,
  93     prefix: &str,
  94     context: &RewriteContext,
  95 ) -> &'a ast::Expr {
  96     if let ast::ExprKind::Block(ref block) = expr.node {
  97         if !needs_block(block, prefix, context) {
  98             // block.stmts.len() == 1
  99             if let Some(expr) = stmt_expr(&block.stmts[0]) {
 100                 return get_inner_expr(expr, prefix, context);
 101             }
 102         }
 103     }
 104
 105     expr
 106 }
 107
 108 // Figure out if a block is necessary.
 109 fn needs_block(block: &ast::Block, prefix: &str, context: &RewriteContext) -> bool {
 110     is_unsafe_block(block) || block.stmts.len() > 1 || context.inside_macro
 111         || block_contains_comment(block, context.codemap) || prefix.contains('\n')
 112 }
 113
 114 // Rewrite closure with a single expression wrapping its body with block.
 115 fn rewrite_closure_with_block(
 116     body: &ast::Expr,
 117     prefix: &str,
 118     context: &RewriteContext,
 119     shape: Shape,
 120 ) -> Option<String> {
 121     let block = ast::Block {
 122         stmts: vec![
 123             ast::Stmt {
 124                 id: ast::NodeId::new(0),
 125                 node: ast::StmtKind::Expr(ptr::P(body.clone())),
 126                 span: body.span,
 127             },
 128         ],
 129         id: ast::NodeId::new(0),
 130         rules: ast::BlockCheckMode::Default,
 131         span: body.span,
 132     };
 133     let block = ::expr::rewrite_block_with_visitor(context, "", &block, shape, false)?;
 134     Some(format!("{} {}", prefix, block))
 135 }
 136
 137 // Rewrite closure with a single expression without wrapping its body with block.
 138 fn rewrite_closure_expr(
 139     expr: &ast::Expr,
 140     prefix: &str,
 141     context: &RewriteContext,
 142     shape: Shape,
 143 ) -> Option<String> {
 144     let mut rewrite = expr.rewrite(context, shape);
 145     if classify::expr_requires_semi_to_be_stmt(left_most_sub_expr(expr)) {
 146         rewrite = and_one_line(rewrite);
 147     }
 148     rewrite = rewrite.and_then(|rw| {
 149         if context.config.force_multiline_blocks() && rw.contains('\n') {
 150             None
 151         } else {
 152             Some(rw)
 153         }
 154     });
 155     rewrite.map(|rw| format!("{} {}", prefix, rw))
 156 }
 157
 158 // Rewrite closure whose body is block.
 159 fn rewrite_closure_block(
 160     block: &ast::Block,
 161     prefix: &str,
 162     context: &RewriteContext,
 163     shape: Shape,
 164 ) -> Option<String> {
 165     let block_shape = shape.block();
 166     let block_str = block.rewrite(context, block_shape)?;
 167     Some(format!("{} {}", prefix, block_str))
 168 }
 169
 170 // Return type is (prefix, extra_offset)
 171 fn rewrite_closure_fn_decl(
 172     capture: ast::CaptureBy,
 173     fn_decl: &ast::FnDecl,
 174     body: &ast::Expr,
 175     span: Span,
 176     context: &RewriteContext,
 177     shape: Shape,
 178 ) -> Option<(String, usize)> {
 179     let mover = if capture == ast::CaptureBy::Value {
 180         "move "
 181     } else {
 182         ""
 183     };
 184     // 4 = "|| {".len(), which is overconservative when the closure consists of
 185     // a single expression.
 186     let nested_shape = shape.shrink_left(mover.len())?.sub_width(4)?;
 187
 188     // 1 = |
 189     let argument_offset = nested_shape.indent + 1;
 190     let arg_shape = nested_shape.offset_left(1)?.visual_indent(0);
 191     let ret_str = fn_decl.output.rewrite(context, arg_shape)?;
 192
 193     let arg_items = itemize_list(
 194         context.codemap,
 195         fn_decl.inputs.iter(),
 196         "|",
 197         ",",
 198         |arg| span_lo_for_arg(arg),
 199         |arg| span_hi_for_arg(context, arg),
 200         |arg| arg.rewrite(context, arg_shape),
 201         context.codemap.span_after(span, "|"),
 202         body.span.lo(),
 203         false,
 204     );
 205     let item_vec = arg_items.collect::<Vec<_>>();
 206     // 1 = space between arguments and return type.
 207     let horizontal_budget = nested_shape
 208         .width
 209         .checked_sub(ret_str.len() + 1)
 210         .unwrap_or(0);
 211     let tactic = definitive_tactic(
 212         &item_vec,
 213         ListTactic::HorizontalVertical,
 214         Separator::Comma,
 215         horizontal_budget,
 216     );
 217     let arg_shape = match tactic {
 218         DefinitiveListTactic::Horizontal => arg_shape.sub_width(ret_str.len() + 1)?,
 219         _ => arg_shape,
 220     };
 221
 222     let fmt = ListFormatting {
 223         tactic: tactic,
 224         separator: ",",
 225         trailing_separator: SeparatorTactic::Never,
 226         separator_place: SeparatorPlace::Back,
 227         shape: arg_shape,
 228         ends_with_newline: false,
 229         preserve_newline: true,
 230         config: context.config,
 231     };
 232     let list_str = write_list(&item_vec, &fmt)?;
 233     let mut prefix = format!("{}|{}|", mover, list_str);
 234
 235     if !ret_str.is_empty() {
 236         if prefix.contains('\n') {
 237             prefix.push('\n');
 238             prefix.push_str(&argument_offset.to_string(context.config));
 239         } else {
 240             prefix.push(' ');
 241         }
 242         prefix.push_str(&ret_str);
 243     }
 244     // 1 = space between `|...|` and body.
 245     let extra_offset = last_line_width(&prefix) + 1;
 246
 247     Some((prefix, extra_offset))
 248 }
 249
 250 // Rewriting closure which is placed at the end of the function call's arg.
 251 // Returns `None` if the reformatted closure 'looks bad'.
 252 pub fn rewrite_last_closure(
 253     context: &RewriteContext,
 254     expr: &ast::Expr,
 255     shape: Shape,
 256 ) -> Option<String> {
 257     if let ast::ExprKind::Closure(capture, ref fn_decl, ref body, _) = expr.node {
 258         let body = match body.node {
 259             ast::ExprKind::Block(ref block)
 260                 if !is_unsafe_block(block) && is_simple_block(block, context.codemap) =>
 261             {
 262                 stmt_expr(&block.stmts[0]).unwrap_or(body)
 263             }
 264             _ => body,
 265         };
 266         let (prefix, extra_offset) =
 267             rewrite_closure_fn_decl(capture, fn_decl, body, expr.span, context, shape)?;
 268         // If the closure goes multi line before its body, do not overflow the closure.
 269         if prefix.contains('\n') {
 270             return None;
 271         }
 272         // If we are inside macro, we do not want to add or remove block from closure body.
 273         if context.inside_macro {
 274             return expr.rewrite(context, shape);
 275         }
 276
 277         let body_shape = shape.offset_left(extra_offset)?;
 278
 279         // We force to use block for the body of the closure for certain kinds of expressions.
 280         if is_block_closure_forced(body) {
 281             return rewrite_closure_with_block(body, &prefix, context, body_shape).and_then(
 282                 |body_str| {
 283                     // If the expression can fit in a single line, we need not force block closure.
 284                     if body_str.lines().count() <= 7 {
 285                         match rewrite_closure_expr(body, &prefix, context, shape) {
 286                             Some(ref single_line_body_str)
 287                                 if !single_line_body_str.contains('\n') =>
 288                             {
 289                                 Some(single_line_body_str.clone())
 290                             }
 291                             _ => Some(body_str),
 292                         }
 293                     } else {
 294                         Some(body_str)
 295                     }
 296                 },
 297             );
 298         }
 299
 300         // When overflowing the closure which consists of a single control flow expression,
 301         // force to use block if its condition uses multi line.
 302         let is_multi_lined_cond = rewrite_cond(context, body, body_shape)
 303             .map(|cond| cond.contains('\n') || cond.len() > body_shape.width)
 304             .unwrap_or(false);
 305         if is_multi_lined_cond {
 306             return rewrite_closure_with_block(body, &prefix, context, body_shape);
 307         }
 308
 309         // Seems fine, just format the closure in usual manner.
 310         return expr.rewrite(context, shape);
 311     }
 312     None
 313 }
 314
 315 /// Returns true if the given vector of arguments has more than one `ast::ExprKind::Closure`.
 316 pub fn args_have_many_closure<T>(args: &[&T]) -> bool
 317 where
 318     T: ToExpr,
 319 {
 320     args.iter()
 321         .filter(|arg| {
 322             arg.to_expr()
 323                 .map(|e| match e.node {
 324                     ast::ExprKind::Closure(..) => true,
 325                     _ => false,
 326                 })
 327                 .unwrap_or(false)
 328         })
 329         .count() > 1
 330 }
 331
 332 fn is_block_closure_forced(expr: &ast::Expr) -> bool {
 333     match expr.node {
 334         ast::ExprKind::If(..)
 335         | ast::ExprKind::IfLet(..)
 336         | ast::ExprKind::Loop(..)
 337         | ast::ExprKind::While(..)
 338         | ast::ExprKind::WhileLet(..)
 339         | ast::ExprKind::ForLoop(..) => true,
 340         ast::ExprKind::AddrOf(_, ref expr)
 341         | ast::ExprKind::Box(ref expr)
 342         | ast::ExprKind::Try(ref expr)
 343         | ast::ExprKind::Unary(_, ref expr)
 344         | ast::ExprKind::Cast(ref expr, _) => is_block_closure_forced(expr),
 345         _ => false,
 346     }
 347 }
 348
 349 fn and_one_line(x: Option<String>) -> Option<String> {
 350     x.and_then(|x| if x.contains('\n') { None } else { Some(x) })
 351 }