src/items.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 top-level items - functions, structs, enums, traits, impls.
  12
  13 use std::borrow::Cow;
  14 use std::cmp::min;
  15
  16 use syntax::{abi, ast, ptr, symbol};
  17 use syntax::ast::{CrateSugar, ImplItem};
  18 use syntax::codemap::{BytePos, Span};
  19 use syntax::visit;
  20
  21 use spanned::Spanned;
  22 use codemap::{LineRangeUtils, SpanUtils};
  23 use comment::{combine_strs_with_missing_comments, contains_comment, recover_comment_removed,
  24               recover_missing_comment_in_span, rewrite_missing_comment, FindUncommented};
  25 use config::{BraceStyle, Config, Density, IndentStyle, ReturnIndent, Style};
  26 use expr::{format_expr, is_empty_block, is_simple_block_stmt, rewrite_assign_rhs,
  27            rewrite_call_inner, ExprType};
  28 use lists::{definitive_tactic, itemize_list, write_list, DefinitiveListTactic, ListFormatting,
  29             ListItem, ListTactic, Separator, SeparatorPlace, SeparatorTactic};
  30 use rewrite::{Rewrite, RewriteContext};
  31 use shape::{Indent, Shape};
  32 use types::join_bounds;
  33 use utils::{colon_spaces, contains_skip, end_typaram, first_line_width, format_abi,
  34             format_constness, format_defaultness, format_mutability, format_unsafety,
  35             format_visibility, is_attributes_extendable, last_line_contains_single_line_comment,
  36             last_line_used_width, last_line_width, mk_sp, semicolon_for_expr, starts_with_newline,
  37             stmt_expr, trim_newlines, trimmed_last_line_width};
  38 use vertical::rewrite_with_alignment;
  39 use visitor::FmtVisitor;
  40
  41 fn type_annotation_separator(config: &Config) -> &str {
  42     colon_spaces(
  43         config.space_before_type_annotation(),
  44         config.space_after_type_annotation_colon(),
  45     )
  46 }
  47
  48 // Statements of the form
  49 // let pat: ty = init;
  50 impl Rewrite for ast::Local {
  51     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  52         debug!(
  53             "Local::rewrite {:?} {} {:?}",
  54             self,
  55             shape.width,
  56             shape.indent
  57         );
  58
  59         skip_out_of_file_lines_range!(context, self.span);
  60
  61         if contains_skip(&self.attrs) {
  62             return None;
  63         }
  64
  65         let attrs_str = self.attrs.rewrite(context, shape)?;
  66         let mut result = if attrs_str.is_empty() {
  67             "let ".to_owned()
  68         } else {
  69             combine_strs_with_missing_comments(
  70                 context,
  71                 &attrs_str,
  72                 "let ",
  73                 mk_sp(
  74                     self.attrs.last().map(|a| a.span.hi()).unwrap(),
  75                     self.span.lo(),
  76                 ),
  77                 shape,
  78                 false,
  79             )?
  80         };
  81
  82         // 4 = "let ".len()
  83         let pat_shape = shape.offset_left(4)?;
  84         // 1 = ;
  85         let pat_shape = pat_shape.sub_width(1)?;
  86         let pat_str = self.pat.rewrite(context, pat_shape)?;
  87         result.push_str(&pat_str);
  88
  89         // String that is placed within the assignment pattern and expression.
  90         let infix = {
  91             let mut infix = String::with_capacity(32);
  92
  93             if let Some(ref ty) = self.ty {
  94                 let separator = type_annotation_separator(context.config);
  95                 let indent = shape.indent + last_line_width(&result) + separator.len();
  96                 // 1 = ;
  97                 let budget = shape.width.checked_sub(indent.width() + 1)?;
  98                 let rewrite = ty.rewrite(context, Shape::legacy(budget, indent))?;
  99
 100                 infix.push_str(separator);
 101                 infix.push_str(&rewrite);
 102             }
 103
 104             if self.init.is_some() {
 105                 infix.push_str(" =");
 106             }
 107
 108             infix
 109         };
 110
 111         result.push_str(&infix);
 112
 113         if let Some(ref ex) = self.init {
 114             // 1 = trailing semicolon;
 115             let nested_shape = shape.sub_width(1)?;
 116
 117             result = rewrite_assign_rhs(context, result, ex, nested_shape)?;
 118         }
 119
 120         result.push(';');
 121         Some(result)
 122     }
 123 }
 124
 125 // TODO convert to using rewrite style rather than visitor
 126 // TODO format modules in this style
 127 #[allow(dead_code)]
 128 struct Item<'a> {
 129     keyword: &'static str,
 130     abi: Cow<'static, str>,
 131     vis: Option<&'a ast::Visibility>,
 132     body: Vec<BodyElement<'a>>,
 133     span: Span,
 134 }
 135
 136 impl<'a> Item<'a> {
 137     fn from_foreign_mod(fm: &'a ast::ForeignMod, span: Span, config: &Config) -> Item<'a> {
 138         Item {
 139             keyword: "",
 140             abi: format_abi(fm.abi, config.force_explicit_abi(), true),
 141             vis: None,
 142             body: fm.items
 143                 .iter()
 144                 .map(|i| BodyElement::ForeignItem(i))
 145                 .collect(),
 146             span: span,
 147         }
 148     }
 149 }
 150
 151 enum BodyElement<'a> {
 152     // Stmt(&'a ast::Stmt),
 153     // Field(&'a ast::Field),
 154     // Variant(&'a ast::Variant),
 155     // Item(&'a ast::Item),
 156     ForeignItem(&'a ast::ForeignItem),
 157 }
 158
 159 /// Represents a fn's signature.
 160 pub struct FnSig<'a> {
 161     decl: &'a ast::FnDecl,
 162     generics: &'a ast::Generics,
 163     abi: abi::Abi,
 164     constness: ast::Constness,
 165     defaultness: ast::Defaultness,
 166     unsafety: ast::Unsafety,
 167     visibility: ast::Visibility,
 168 }
 169
 170 impl<'a> FnSig<'a> {
 171     pub fn new(
 172         decl: &'a ast::FnDecl,
 173         generics: &'a ast::Generics,
 174         vis: ast::Visibility,
 175     ) -> FnSig<'a> {
 176         FnSig {
 177             decl: decl,
 178             generics: generics,
 179             abi: abi::Abi::Rust,
 180             constness: ast::Constness::NotConst,
 181             defaultness: ast::Defaultness::Final,
 182             unsafety: ast::Unsafety::Normal,
 183             visibility: vis,
 184         }
 185     }
 186
 187     pub fn from_method_sig(
 188         method_sig: &'a ast::MethodSig,
 189         generics: &'a ast::Generics,
 190     ) -> FnSig<'a> {
 191         FnSig {
 192             unsafety: method_sig.unsafety,
 193             constness: method_sig.constness.node,
 194             defaultness: ast::Defaultness::Final,
 195             abi: method_sig.abi,
 196             decl: &*method_sig.decl,
 197             generics: generics,
 198             visibility: ast::Visibility::Inherited,
 199         }
 200     }
 201
 202     pub fn from_fn_kind(
 203         fn_kind: &'a visit::FnKind,
 204         generics: &'a ast::Generics,
 205         decl: &'a ast::FnDecl,
 206         defualtness: ast::Defaultness,
 207     ) -> FnSig<'a> {
 208         match *fn_kind {
 209             visit::FnKind::ItemFn(_, unsafety, constness, abi, visibility, _) => FnSig {
 210                 decl: decl,
 211                 generics: generics,
 212                 abi: abi,
 213                 constness: constness.node,
 214                 defaultness: defualtness,
 215                 unsafety: unsafety,
 216                 visibility: visibility.clone(),
 217             },
 218             visit::FnKind::Method(_, method_sig, vis, _) => {
 219                 let mut fn_sig = FnSig::from_method_sig(method_sig, generics);
 220                 fn_sig.defaultness = defualtness;
 221                 if let Some(vis) = vis {
 222                     fn_sig.visibility = vis.clone();
 223                 }
 224                 fn_sig
 225             }
 226             _ => unreachable!(),
 227         }
 228     }
 229
 230     fn to_str(&self, context: &RewriteContext) -> String {
 231         let mut result = String::with_capacity(128);
 232         // Vis defaultness constness unsafety abi.
 233         result.push_str(&*format_visibility(&self.visibility));
 234         result.push_str(format_defaultness(self.defaultness));
 235         result.push_str(format_constness(self.constness));
 236         result.push_str(format_unsafety(self.unsafety));
 237         result.push_str(&format_abi(
 238             self.abi,
 239             context.config.force_explicit_abi(),
 240             false,
 241         ));
 242         result
 243     }
 244 }
 245
 246 impl<'a> FmtVisitor<'a> {
 247     fn format_item(&mut self, item: Item) {
 248         self.buffer.push_str(&item.abi);
 249
 250         let snippet = self.snippet(item.span);
 251         let brace_pos = snippet.find_uncommented("{").unwrap();
 252
 253         self.buffer.push_str("{");
 254         if !item.body.is_empty() || contains_comment(&snippet[brace_pos..]) {
 255             // FIXME: this skips comments between the extern keyword and the opening
 256             // brace.
 257             self.last_pos = item.span.lo() + BytePos(brace_pos as u32 + 1);
 258             self.block_indent = self.block_indent.block_indent(self.config);
 259
 260             if item.body.is_empty() {
 261                 self.format_missing_no_indent(item.span.hi() - BytePos(1));
 262                 self.block_indent = self.block_indent.block_unindent(self.config);
 263
 264                 self.buffer
 265                     .push_str(&self.block_indent.to_string(self.config));
 266             } else {
 267                 for item in &item.body {
 268                     self.format_body_element(item);
 269                 }
 270
 271                 self.block_indent = self.block_indent.block_unindent(self.config);
 272                 self.format_missing_with_indent(item.span.hi() - BytePos(1));
 273             }
 274         }
 275
 276         self.buffer.push_str("}");
 277         self.last_pos = item.span.hi();
 278     }
 279
 280     fn format_body_element(&mut self, element: &BodyElement) {
 281         match *element {
 282             BodyElement::ForeignItem(item) => self.format_foreign_item(item),
 283         }
 284     }
 285
 286     pub fn format_foreign_mod(&mut self, fm: &ast::ForeignMod, span: Span) {
 287         let item = Item::from_foreign_mod(fm, span, self.config);
 288         self.format_item(item);
 289     }
 290
 291
 292     fn format_foreign_item(&mut self, item: &ast::ForeignItem) {
 293         let rewrite = item.rewrite(&self.get_context(), self.shape());
 294         self.push_rewrite(item.span(), rewrite);
 295         self.last_pos = item.span.hi();
 296     }
 297
 298     pub fn rewrite_fn(
 299         &mut self,
 300         indent: Indent,
 301         ident: ast::Ident,
 302         fn_sig: &FnSig,
 303         span: Span,
 304         block: &ast::Block,
 305     ) -> Option<String> {
 306         let context = self.get_context();
 307
 308         let has_body =
 309             !is_empty_block(block, self.codemap) || !context.config.fn_empty_single_line();
 310         let mut newline_brace =
 311             newline_for_brace(self.config, &fn_sig.generics.where_clause, has_body);
 312
 313         let (mut result, force_newline_brace) =
 314             rewrite_fn_base(&context, indent, ident, fn_sig, span, newline_brace, true)?;
 315
 316         // 2 = ` {`
 317         if self.config.fn_brace_style() == BraceStyle::AlwaysNextLine || force_newline_brace
 318             || last_line_width(&result) + 2 > self.shape().width
 319         {
 320             newline_brace = true;
 321         } else if !result.contains('\n') {
 322             newline_brace = false;
 323         }
 324
 325         // Prepare for the function body by possibly adding a newline and
 326         // indent.
 327         // FIXME we'll miss anything between the end of the signature and the
 328         // start of the body, but we need more spans from the compiler to solve
 329         // this.
 330         if newline_brace {
 331             result.push('\n');
 332             result.push_str(&indent.to_string(self.config));
 333         } else {
 334             result.push(' ');
 335         }
 336
 337         self.single_line_fn(&result, block).or_else(|| Some(result))
 338     }
 339
 340     pub fn rewrite_required_fn(
 341         &mut self,
 342         indent: Indent,
 343         ident: ast::Ident,
 344         sig: &ast::MethodSig,
 345         generics: &ast::Generics,
 346         span: Span,
 347     ) -> Option<String> {
 348         // Drop semicolon or it will be interpreted as comment.
 349         let span = mk_sp(span.lo(), span.hi() - BytePos(1));
 350         let context = self.get_context();
 351
 352         let (mut result, _) = rewrite_fn_base(
 353             &context,
 354             indent,
 355             ident,
 356             &FnSig::from_method_sig(sig, generics),
 357             span,
 358             false,
 359             false,
 360         )?;
 361
 362         // Re-attach semicolon
 363         result.push(';');
 364
 365         Some(result)
 366     }
 367
 368     fn single_line_fn(&self, fn_str: &str, block: &ast::Block) -> Option<String> {
 369         if fn_str.contains('\n') {
 370             return None;
 371         }
 372
 373         let codemap = self.get_context().codemap;
 374
 375         if self.config.fn_empty_single_line() && is_empty_block(block, codemap)
 376             && self.block_indent.width() + fn_str.len() + 2 <= self.config.max_width()
 377         {
 378             return Some(format!("{}{{}}", fn_str));
 379         }
 380
 381         if self.config.fn_single_line() && is_simple_block_stmt(block, codemap) {
 382             let rewrite = {
 383                 if let Some(stmt) = block.stmts.first() {
 384                     match stmt_expr(stmt) {
 385                         Some(e) => {
 386                             let suffix = if semicolon_for_expr(&self.get_context(), e) {
 387                                 ";"
 388                             } else {
 389                                 ""
 390                             };
 391
 392                             format_expr(e, ExprType::Statement, &self.get_context(), self.shape())
 393                                 .map(|s| s + suffix)
 394                                 .or_else(|| Some(self.snippet(e.span)))
 395                         }
 396                         None => stmt.rewrite(&self.get_context(), self.shape()),
 397                     }
 398                 } else {
 399                     None
 400                 }
 401             };
 402
 403             if let Some(res) = rewrite {
 404                 let width = self.block_indent.width() + fn_str.len() + res.len() + 4;
 405                 if !res.contains('\n') && width <= self.config.max_width() {
 406                     return Some(format!("{}{{ {} }}", fn_str, res));
 407                 }
 408             }
 409         }
 410
 411         None
 412     }
 413
 414     pub fn visit_static(&mut self, static_parts: &StaticParts) {
 415         let rewrite = rewrite_static(&self.get_context(), static_parts, self.block_indent);
 416         self.push_rewrite(static_parts.span, rewrite);
 417     }
 418
 419     pub fn visit_struct(&mut self, struct_parts: &StructParts) {
 420         let is_tuple = struct_parts.def.is_tuple();
 421         let rewrite = format_struct(&self.get_context(), struct_parts, self.block_indent, None)
 422             .map(|s| if is_tuple { s + ";" } else { s });
 423         self.push_rewrite(struct_parts.span, rewrite);
 424     }
 425
 426     pub fn visit_enum(
 427         &mut self,
 428         ident: ast::Ident,
 429         vis: &ast::Visibility,
 430         enum_def: &ast::EnumDef,
 431         generics: &ast::Generics,
 432         span: Span,
 433     ) {
 434         let enum_header = format_header("enum ", ident, vis);
 435         self.buffer.push_str(&enum_header);
 436
 437         let enum_snippet = self.snippet(span);
 438         let brace_pos = enum_snippet.find_uncommented("{").unwrap();
 439         let body_start = span.lo() + BytePos(brace_pos as u32 + 1);
 440         let generics_str = format_generics(
 441             &self.get_context(),
 442             generics,
 443             self.config.item_brace_style(),
 444             enum_def.variants.is_empty(),
 445             self.block_indent,
 446             mk_sp(span.lo(), body_start),
 447             last_line_width(&enum_header),
 448         ).unwrap();
 449         self.buffer.push_str(&generics_str);
 450
 451         self.last_pos = body_start;
 452
 453         self.block_indent = self.block_indent.block_indent(self.config);
 454         let variant_list = self.format_variant_list(enum_def, body_start, span.hi() - BytePos(1));
 455         match variant_list {
 456             Some(ref body_str) => self.buffer.push_str(body_str),
 457             None => if contains_comment(&enum_snippet[brace_pos..]) {
 458                 self.format_missing_no_indent(span.hi() - BytePos(1))
 459             },
 460         }
 461         self.block_indent = self.block_indent.block_unindent(self.config);
 462
 463         if variant_list.is_some() || contains_comment(&enum_snippet[brace_pos..]) {
 464             self.buffer
 465                 .push_str(&self.block_indent.to_string(self.config));
 466         }
 467         self.buffer.push_str("}");
 468         self.last_pos = span.hi();
 469     }
 470
 471     // Format the body of an enum definition
 472     fn format_variant_list(
 473         &self,
 474         enum_def: &ast::EnumDef,
 475         body_lo: BytePos,
 476         body_hi: BytePos,
 477     ) -> Option<String> {
 478         if enum_def.variants.is_empty() {
 479             return None;
 480         }
 481         let mut result = String::with_capacity(1024);
 482         result.push('\n');
 483         let indentation = self.block_indent.to_string(self.config);
 484         result.push_str(&indentation);
 485
 486         let items = itemize_list(
 487             self.codemap,
 488             enum_def.variants.iter(),
 489             "}",
 490             |f| if !f.node.attrs.is_empty() {
 491                 f.node.attrs[0].span.lo()
 492             } else {
 493                 f.span.lo()
 494             },
 495             |f| f.span.hi(),
 496             |f| self.format_variant(f),
 497             body_lo,
 498             body_hi,
 499             false,
 500         );
 501
 502         let shape = self.shape().sub_width(2).unwrap();
 503         let fmt = ListFormatting {
 504             tactic: DefinitiveListTactic::Vertical,
 505             separator: ",",
 506             trailing_separator: self.config.trailing_comma(),
 507             separator_place: SeparatorPlace::Back,
 508             shape: shape,
 509             ends_with_newline: true,
 510             preserve_newline: true,
 511             config: self.config,
 512         };
 513
 514         let list = write_list(&items.collect::<Vec<_>>(), &fmt)?;
 515         result.push_str(&list);
 516         result.push('\n');
 517         Some(result)
 518     }
 519
 520     // Variant of an enum.
 521     fn format_variant(&self, field: &ast::Variant) -> Option<String> {
 522         if contains_skip(&field.node.attrs) {
 523             let lo = field.node.attrs[0].span.lo();
 524             let span = mk_sp(lo, field.span.hi());
 525             return Some(self.snippet(span));
 526         }
 527
 528         let context = self.get_context();
 529         let indent = self.block_indent;
 530         let shape = self.shape();
 531         let attrs_str = field.node.attrs.rewrite(&context, shape)?;
 532         let lo = field
 533             .node
 534             .attrs
 535             .last()
 536             .map_or(field.span.lo(), |attr| attr.span.hi());
 537         let span = mk_sp(lo, field.span.lo());
 538
 539         let variant_body = match field.node.data {
 540             ast::VariantData::Tuple(..) | ast::VariantData::Struct(..) => {
 541                 // FIXME: Should limit the width, as we have a trailing comma
 542                 format_struct(
 543                     &context,
 544                     &StructParts::from_variant(field),
 545                     indent,
 546                     Some(self.config.struct_variant_width()),
 547                 )?
 548             }
 549             ast::VariantData::Unit(..) => if let Some(ref expr) = field.node.disr_expr {
 550                 let lhs = format!("{} =", field.node.name);
 551                 // 1 = ','
 552                 rewrite_assign_rhs(&context, lhs, expr, shape.sub_width(1)?)?
 553             } else {
 554                 field.node.name.to_string()
 555             },
 556         };
 557
 558         let attrs_extendable = attrs_str.is_empty()
 559             || (context.config.attributes_on_same_line_as_variant()
 560                 && is_attributes_extendable(&attrs_str));
 561         combine_strs_with_missing_comments(
 562             &context,
 563             &attrs_str,
 564             &variant_body,
 565             span,
 566             shape,
 567             attrs_extendable,
 568         )
 569     }
 570 }
 571
 572 pub fn format_impl(
 573     context: &RewriteContext,
 574     item: &ast::Item,
 575     offset: Indent,
 576     where_span_end: Option<BytePos>,
 577 ) -> Option<String> {
 578     if let ast::ItemKind::Impl(_, _, _, ref generics, _, ref self_ty, ref items) = item.node {
 579         let mut result = String::with_capacity(128);
 580         let ref_and_type = format_impl_ref_and_type(context, item, offset)?;
 581         let indent_str = offset.to_string(context.config);
 582         let sep = format!("\n{}", &indent_str);
 583         result.push_str(&ref_and_type);
 584
 585         let where_budget = if result.contains('\n') {
 586             context.config.max_width()
 587         } else {
 588             context.budget(last_line_width(&result))
 589         };
 590         let option = WhereClauseOption::snuggled(&ref_and_type);
 591         let where_clause_str = rewrite_where_clause(
 592             context,
 593             &generics.where_clause,
 594             context.config.item_brace_style(),
 595             Shape::legacy(where_budget, offset.block_only()),
 596             context.config.where_density(),
 597             "{",
 598             where_span_end,
 599             self_ty.span.hi(),
 600             option,
 601             false,
 602         )?;
 603
 604         // If there is no where clause, we may have missing comments between the trait name and
 605         // the opening brace.
 606         if generics.where_clause.predicates.is_empty() {
 607             if let Some(hi) = where_span_end {
 608                 match recover_missing_comment_in_span(
 609                     mk_sp(self_ty.span.hi(), hi),
 610                     Shape::indented(offset, context.config),
 611                     context,
 612                     last_line_width(&result),
 613                 ) {
 614                     Some(ref missing_comment) if !missing_comment.is_empty() => {
 615                         result.push_str(missing_comment);
 616                     }
 617                     _ => (),
 618                 }
 619             }
 620         }
 621
 622         if is_impl_single_line(context, items, &result, &where_clause_str, item)? {
 623             result.push_str(&where_clause_str);
 624             if where_clause_str.contains('\n') || last_line_contains_single_line_comment(&result) {
 625                 result.push_str(&format!("{}{{{}}}", &sep, &sep));
 626             } else {
 627                 result.push_str(" {}");
 628             }
 629             return Some(result);
 630         }
 631
 632         if !where_clause_str.is_empty() && !where_clause_str.contains('\n') {
 633             result.push('\n');
 634             let width = offset.block_indent + context.config.tab_spaces() - 1;
 635             let where_indent = Indent::new(0, width);
 636             result.push_str(&where_indent.to_string(context.config));
 637         }
 638         result.push_str(&where_clause_str);
 639
 640         match context.config.item_brace_style() {
 641             _ if last_line_contains_single_line_comment(&result) => result.push_str(&sep),
 642             BraceStyle::AlwaysNextLine => result.push_str(&sep),
 643             BraceStyle::PreferSameLine => result.push(' '),
 644             BraceStyle::SameLineWhere => if !where_clause_str.is_empty() {
 645                 result.push_str(&sep);
 646             } else {
 647                 result.push(' ');
 648             },
 649         }
 650
 651         result.push('{');
 652
 653         let snippet = context.snippet(item.span);
 654         let open_pos = snippet.find_uncommented("{")? + 1;
 655
 656         if !items.is_empty() || contains_comment(&snippet[open_pos..]) {
 657             let mut visitor = FmtVisitor::from_codemap(context.parse_session, context.config);
 658             visitor.block_indent = offset.block_only().block_indent(context.config);
 659             visitor.last_pos = item.span.lo() + BytePos(open_pos as u32);
 660
 661             visitor.visit_attrs(&item.attrs, ast::AttrStyle::Inner);
 662             for item in items {
 663                 visitor.visit_impl_item(item);
 664             }
 665
 666             visitor.format_missing(item.span.hi() - BytePos(1));
 667
 668             let inner_indent_str = visitor.block_indent.to_string(context.config);
 669             let outer_indent_str = offset.block_only().to_string(context.config);
 670
 671             result.push('\n');
 672             result.push_str(&inner_indent_str);
 673             result.push_str(trim_newlines(visitor.buffer.to_string().trim()));
 674             result.push('\n');
 675             result.push_str(&outer_indent_str);
 676         }
 677
 678         if result.ends_with('{') {
 679             result.push_str(&sep);
 680         }
 681         result.push('}');
 682
 683         Some(result)
 684     } else {
 685         unreachable!();
 686     }
 687 }
 688
 689 fn is_impl_single_line(
 690     context: &RewriteContext,
 691     items: &[ImplItem],
 692     result: &str,
 693     where_clause_str: &str,
 694     item: &ast::Item,
 695 ) -> Option<bool> {
 696     let snippet = context.snippet(item.span);
 697     let open_pos = snippet.find_uncommented("{")? + 1;
 698
 699     Some(
 700         context.config.impl_empty_single_line() && items.is_empty() && !result.contains('\n')
 701             && result.len() + where_clause_str.len() <= context.config.max_width()
 702             && !contains_comment(&snippet[open_pos..]),
 703     )
 704 }
 705
 706 fn format_impl_ref_and_type(
 707     context: &RewriteContext,
 708     item: &ast::Item,
 709     offset: Indent,
 710 ) -> Option<String> {
 711     if let ast::ItemKind::Impl(
 712         unsafety,
 713         polarity,
 714         defaultness,
 715         ref generics,
 716         ref trait_ref,
 717         ref self_ty,
 718         _,
 719     ) = item.node
 720     {
 721         let mut result = String::with_capacity(128);
 722
 723         result.push_str(&format_visibility(&item.vis));
 724         result.push_str(format_defaultness(defaultness));
 725         result.push_str(format_unsafety(unsafety));
 726         result.push_str("impl");
 727
 728         let lo = context.codemap.span_after(item.span, "impl");
 729         let hi = match *trait_ref {
 730             Some(ref tr) => tr.path.span.lo(),
 731             None => self_ty.span.lo(),
 732         };
 733         let shape = generics_shape_from_config(
 734             context.config,
 735             Shape::indented(offset + last_line_width(&result), context.config),
 736             0,
 737         )?;
 738         let one_line_budget = shape.width.checked_sub(last_line_width(&result) + 2)?;
 739         let generics_str =
 740             rewrite_generics_inner(context, generics, shape, one_line_budget, mk_sp(lo, hi))?;
 741
 742         let polarity_str = if polarity == ast::ImplPolarity::Negative {
 743             "!"
 744         } else {
 745             ""
 746         };
 747
 748         if let Some(ref trait_ref) = *trait_ref {
 749             let result_len = result.len();
 750             if let Some(trait_ref_str) = rewrite_trait_ref(
 751                 context,
 752                 trait_ref,
 753                 offset,
 754                 &generics_str,
 755                 true,
 756                 polarity_str,
 757                 result_len,
 758             ) {
 759                 result.push_str(&trait_ref_str);
 760             } else {
 761                 let generics_str =
 762                     rewrite_generics_inner(context, generics, shape, 0, mk_sp(lo, hi))?;
 763                 result.push_str(&rewrite_trait_ref(
 764                     context,
 765                     trait_ref,
 766                     offset,
 767                     &generics_str,
 768                     false,
 769                     polarity_str,
 770                     result_len,
 771                 )?);
 772             }
 773         } else {
 774             result.push_str(&generics_str);
 775         }
 776
 777         // Try to put the self type in a single line.
 778         // ` for`
 779         let trait_ref_overhead = if trait_ref.is_some() { 4 } else { 0 };
 780         let curly_brace_overhead = if generics.where_clause.predicates.is_empty() {
 781             // If there is no where clause adapt budget for type formatting to take space and curly
 782             // brace into account.
 783             match context.config.item_brace_style() {
 784                 BraceStyle::AlwaysNextLine => 0,
 785                 _ => 2,
 786             }
 787         } else {
 788             0
 789         };
 790         let used_space = last_line_width(&result) + trait_ref_overhead + curly_brace_overhead;
 791         // 1 = space before the type.
 792         let budget = context.budget(used_space + 1);
 793         if let Some(self_ty_str) = self_ty.rewrite(context, Shape::legacy(budget, offset)) {
 794             if !self_ty_str.contains('\n') {
 795                 if trait_ref.is_some() {
 796                     result.push_str(" for ");
 797                 } else {
 798                     result.push(' ');
 799                 }
 800                 result.push_str(&self_ty_str);
 801                 return Some(result);
 802             }
 803         }
 804
 805         // Couldn't fit the self type on a single line, put it on a new line.
 806         result.push('\n');
 807         // Add indentation of one additional tab.
 808         let new_line_offset = offset.block_indent(context.config);
 809         result.push_str(&new_line_offset.to_string(context.config));
 810         if trait_ref.is_some() {
 811             result.push_str("for ");
 812         }
 813         let budget = context.budget(last_line_width(&result));
 814         let type_offset = match context.config.where_style() {
 815             Style::Legacy => new_line_offset + trait_ref_overhead,
 816             Style::Rfc => new_line_offset,
 817         };
 818         result.push_str(&*self_ty
 819             .rewrite(context, Shape::legacy(budget, type_offset))?);
 820         Some(result)
 821     } else {
 822         unreachable!();
 823     }
 824 }
 825
 826 fn rewrite_trait_ref(
 827     context: &RewriteContext,
 828     trait_ref: &ast::TraitRef,
 829     offset: Indent,
 830     generics_str: &str,
 831     retry: bool,
 832     polarity_str: &str,
 833     result_len: usize,
 834 ) -> Option<String> {
 835     // 1 = space between generics and trait_ref
 836     let used_space = 1 + polarity_str.len() + last_line_used_width(generics_str, result_len);
 837     let shape = Shape::indented(offset + used_space, context.config);
 838     if let Some(trait_ref_str) = trait_ref.rewrite(context, shape) {
 839         if !(retry && trait_ref_str.contains('\n')) {
 840             return Some(format!(
 841                 "{} {}{}",
 842                 generics_str,
 843                 polarity_str,
 844                 &trait_ref_str
 845             ));
 846         }
 847     }
 848     // We could not make enough space for trait_ref, so put it on new line.
 849     if !retry {
 850         let offset = offset.block_indent(context.config);
 851         let shape = Shape::indented(offset, context.config);
 852         let trait_ref_str = trait_ref.rewrite(context, shape)?;
 853         Some(format!(
 854             "{}\n{}{}{}",
 855             generics_str,
 856             &offset.to_string(context.config),
 857             polarity_str,
 858             &trait_ref_str
 859         ))
 860     } else {
 861         None
 862     }
 863 }
 864
 865 pub struct StructParts<'a> {
 866     prefix: &'a str,
 867     ident: ast::Ident,
 868     vis: &'a ast::Visibility,
 869     def: &'a ast::VariantData,
 870     generics: Option<&'a ast::Generics>,
 871     span: Span,
 872 }
 873
 874 impl<'a> StructParts<'a> {
 875     fn format_header(&self) -> String {
 876         format_header(self.prefix, self.ident, self.vis)
 877     }
 878
 879     fn from_variant(variant: &'a ast::Variant) -> Self {
 880         StructParts {
 881             prefix: "",
 882             ident: variant.node.name,
 883             vis: &ast::Visibility::Inherited,
 884             def: &variant.node.data,
 885             generics: None,
 886             span: variant.span,
 887         }
 888     }
 889
 890     pub fn from_item(item: &'a ast::Item) -> Self {
 891         let (prefix, def, generics) = match item.node {
 892             ast::ItemKind::Struct(ref def, ref generics) => ("struct ", def, generics),
 893             ast::ItemKind::Union(ref def, ref generics) => ("union ", def, generics),
 894             _ => unreachable!(),
 895         };
 896         StructParts {
 897             prefix: prefix,
 898             ident: item.ident,
 899             vis: &item.vis,
 900             def: def,
 901             generics: Some(generics),
 902             span: item.span,
 903         }
 904     }
 905 }
 906
 907 fn format_struct(
 908     context: &RewriteContext,
 909     struct_parts: &StructParts,
 910     offset: Indent,
 911     one_line_width: Option<usize>,
 912 ) -> Option<String> {
 913     match *struct_parts.def {
 914         ast::VariantData::Unit(..) => Some(format_unit_struct(struct_parts)),
 915         ast::VariantData::Tuple(ref fields, _) => {
 916             format_tuple_struct(context, struct_parts, fields, offset)
 917         }
 918         ast::VariantData::Struct(ref fields, _) => {
 919             format_struct_struct(context, struct_parts, fields, offset, one_line_width)
 920         }
 921     }
 922 }
 923
 924 pub fn format_trait(context: &RewriteContext, item: &ast::Item, offset: Indent) -> Option<String> {
 925     if let ast::ItemKind::Trait(_, unsafety, ref generics, ref type_param_bounds, ref trait_items) =
 926         item.node
 927     {
 928         let mut result = String::with_capacity(128);
 929         let header = format!(
 930             "{}{}trait {}",
 931             format_visibility(&item.vis),
 932             format_unsafety(unsafety),
 933             item.ident
 934         );
 935
 936         result.push_str(&header);
 937
 938         let body_lo = context.codemap.span_after(item.span, "{");
 939
 940         let shape = Shape::indented(offset + last_line_width(&result), context.config);
 941         let generics_str =
 942             rewrite_generics(context, generics, shape, mk_sp(item.span.lo(), body_lo))?;
 943         result.push_str(&generics_str);
 944
 945         let trait_bound_str = rewrite_trait_bounds(
 946             context,
 947             type_param_bounds,
 948             Shape::indented(offset, context.config),
 949         )?;
 950         // If the trait, generics, and trait bound cannot fit on the same line,
 951         // put the trait bounds on an indented new line
 952         if offset.width() + last_line_width(&result) + trait_bound_str.len()
 953             > context.config.comment_width()
 954         {
 955             result.push('\n');
 956             let trait_indent = offset.block_only().block_indent(context.config);
 957             result.push_str(&trait_indent.to_string(context.config));
 958         }
 959         result.push_str(&trait_bound_str);
 960
 961         let has_body = !trait_items.is_empty();
 962
 963         let where_density = if (context.config.where_density() == Density::Compressed
 964             && (!result.contains('\n') || context.config.fn_args_indent() == IndentStyle::Block))
 965             || (context.config.fn_args_indent() == IndentStyle::Block && result.is_empty())
 966             || (context.config.where_density() == Density::CompressedIfEmpty && !has_body
 967                 && !result.contains('\n'))
 968         {
 969             Density::Compressed
 970         } else {
 971             Density::Tall
 972         };
 973
 974         let where_budget = context.budget(last_line_width(&result));
 975         let pos_before_where = if type_param_bounds.is_empty() {
 976             generics.where_clause.span.lo()
 977         } else {
 978             type_param_bounds[type_param_bounds.len() - 1].span().hi()
 979         };
 980         let option = WhereClauseOption::snuggled(&generics_str);
 981         let where_clause_str = rewrite_where_clause(
 982             context,
 983             &generics.where_clause,
 984             context.config.item_brace_style(),
 985             Shape::legacy(where_budget, offset.block_only()),
 986             where_density,
 987             "{",
 988             None,
 989             pos_before_where,
 990             option,
 991             false,
 992         )?;
 993         // If the where clause cannot fit on the same line,
 994         // put the where clause on a new line
 995         if !where_clause_str.contains('\n')
 996             && last_line_width(&result) + where_clause_str.len() + offset.width()
 997                 > context.config.comment_width()
 998         {
 999             result.push('\n');
1000             let width = offset.block_indent + context.config.tab_spaces() - 1;
1001             let where_indent = Indent::new(0, width);
1002             result.push_str(&where_indent.to_string(context.config));
1003         }
1004         result.push_str(&where_clause_str);
1005
1006         if generics.where_clause.predicates.is_empty() {
1007             let item_snippet = context.snippet(item.span);
1008             if let Some(lo) = item_snippet.chars().position(|c| c == '/') {
1009                 // 1 = `{`
1010                 let comment_hi = body_lo - BytePos(1);
1011                 let comment_lo = item.span.lo() + BytePos(lo as u32);
1012                 if comment_lo < comment_hi {
1013                     match recover_missing_comment_in_span(
1014                         mk_sp(comment_lo, comment_hi),
1015                         Shape::indented(offset, context.config),
1016                         context,
1017                         last_line_width(&result),
1018                     ) {
1019                         Some(ref missing_comment) if !missing_comment.is_empty() => {
1020                             result.push_str(missing_comment);
1021                         }
1022                         _ => (),
1023                     }
1024                 }
1025             }
1026         }
1027
1028         match context.config.item_brace_style() {
1029             _ if last_line_contains_single_line_comment(&result) => {
1030                 result.push('\n');
1031                 result.push_str(&offset.to_string(context.config));
1032             }
1033             BraceStyle::AlwaysNextLine => {
1034                 result.push('\n');
1035                 result.push_str(&offset.to_string(context.config));
1036             }
1037             BraceStyle::PreferSameLine => result.push(' '),
1038             BraceStyle::SameLineWhere => if !where_clause_str.is_empty()
1039                 && (!trait_items.is_empty() || result.contains('\n'))
1040             {
1041                 result.push('\n');
1042                 result.push_str(&offset.to_string(context.config));
1043             } else {
1044                 result.push(' ');
1045             },
1046         }
1047         result.push('{');
1048
1049         let snippet = context.snippet(item.span);
1050         let open_pos = snippet.find_uncommented("{")? + 1;
1051
1052         if !trait_items.is_empty() || contains_comment(&snippet[open_pos..]) {
1053             let mut visitor = FmtVisitor::from_codemap(context.parse_session, context.config);
1054             visitor.block_indent = offset.block_only().block_indent(context.config);
1055             visitor.last_pos = item.span.lo() + BytePos(open_pos as u32);
1056
1057             for item in trait_items {
1058                 visitor.visit_trait_item(item);
1059             }
1060
1061             visitor.format_missing(item.span.hi() - BytePos(1));
1062
1063             let inner_indent_str = visitor.block_indent.to_string(context.config);
1064             let outer_indent_str = offset.block_only().to_string(context.config);
1065
1066             result.push('\n');
1067             result.push_str(&inner_indent_str);
1068             result.push_str(trim_newlines(visitor.buffer.to_string().trim()));
1069             result.push('\n');
1070             result.push_str(&outer_indent_str);
1071         } else if result.contains('\n') {
1072             result.push('\n');
1073         }
1074
1075         result.push('}');
1076         Some(result)
1077     } else {
1078         unreachable!();
1079     }
1080 }
1081
1082 fn format_unit_struct(p: &StructParts) -> String {
1083     format!("{};", format_header(p.prefix, p.ident, p.vis))
1084 }
1085
1086 pub fn format_struct_struct(
1087     context: &RewriteContext,
1088     struct_parts: &StructParts,
1089     fields: &[ast::StructField],
1090     offset: Indent,
1091     one_line_width: Option<usize>,
1092 ) -> Option<String> {
1093     let mut result = String::with_capacity(1024);
1094     let span = struct_parts.span;
1095
1096     let header_str = struct_parts.format_header();
1097     result.push_str(&header_str);
1098
1099     let header_hi = span.lo() + BytePos(header_str.len() as u32);
1100     let body_lo = context.codemap.span_after(span, "{");
1101
1102     let generics_str = match struct_parts.generics {
1103         Some(g) => format_generics(
1104             context,
1105             g,
1106             context.config.item_brace_style(),
1107             fields.is_empty(),
1108             offset,
1109             mk_sp(header_hi, body_lo),
1110             last_line_width(&result),
1111         )?,
1112         None => {
1113             // 3 = ` {}`, 2 = ` {`.
1114             let overhead = if fields.is_empty() { 3 } else { 2 };
1115             if (context.config.item_brace_style() == BraceStyle::AlwaysNextLine
1116                 && !fields.is_empty())
1117                 || context.config.max_width() < overhead + result.len()
1118             {
1119                 format!("\n{}{{", offset.block_only().to_string(context.config))
1120             } else {
1121                 " {".to_owned()
1122             }
1123         }
1124     };
1125     // 1 = `}`
1126     let overhead = if fields.is_empty() { 1 } else { 0 };
1127     let total_width = result.len() + generics_str.len() + overhead;
1128     if !generics_str.is_empty() && !generics_str.contains('\n')
1129         && total_width > context.config.max_width()
1130     {
1131         result.push('\n');
1132         result.push_str(&offset.to_string(context.config));
1133         result.push_str(generics_str.trim_left());
1134     } else {
1135         result.push_str(&generics_str);
1136     }
1137
1138     if fields.is_empty() {
1139         let snippet = context.snippet(mk_sp(body_lo, span.hi() - BytePos(1)));
1140         if snippet.trim().is_empty() {
1141             // `struct S {}`
1142         } else if snippet.trim_right_matches(&[' ', '\t'][..]).ends_with('\n') {
1143             // fix indent
1144             result.push_str(snippet.trim_right());
1145             result.push('\n');
1146             result.push_str(&offset.to_string(context.config));
1147         } else {
1148             result.push_str(&snippet);
1149         }
1150         result.push('}');
1151         return Some(result);
1152     }
1153
1154     // 3 = ` ` and ` }`
1155     let one_line_budget = context.budget(result.len() + 3 + offset.width());
1156     let one_line_budget =
1157         one_line_width.map_or(0, |one_line_width| min(one_line_width, one_line_budget));
1158
1159     let items_str = rewrite_with_alignment(
1160         fields,
1161         context,
1162         Shape::indented(offset, context.config),
1163         mk_sp(body_lo, span.hi()),
1164         one_line_budget,
1165     )?;
1166
1167     if !items_str.contains('\n') && !result.contains('\n') && items_str.len() <= one_line_budget {
1168         Some(format!("{} {} }}", result, items_str))
1169     } else {
1170         Some(format!(
1171             "{}\n{}{}\n{}}}",
1172             result,
1173             offset
1174                 .block_indent(context.config)
1175                 .to_string(context.config),
1176             items_str,
1177             offset.to_string(context.config)
1178         ))
1179     }
1180 }
1181
1182 /// Returns a bytepos that is after that of `(` in `pub(..)`. If the given visibility does not
1183 /// contain `pub(..)`, then return the `lo` of the `defualt_span`. Yeah, but for what? Well, we need
1184 /// to bypass the `(` in the visibility when creating a span of tuple's body or fn's args.
1185 fn get_bytepos_after_visibility(
1186     context: &RewriteContext,
1187     vis: &ast::Visibility,
1188     default_span: Span,
1189     terminator: &str,
1190 ) -> BytePos {
1191     match *vis {
1192         ast::Visibility::Crate(s, CrateSugar::PubCrate) => context
1193             .codemap
1194             .span_after(mk_sp(s.hi(), default_span.hi()), terminator),
1195         ast::Visibility::Crate(s, CrateSugar::JustCrate) => s.hi(),
1196         ast::Visibility::Restricted { ref path, .. } => path.span.hi(),
1197         _ => default_span.lo(),
1198     }
1199 }
1200
1201 fn format_tuple_struct(
1202     context: &RewriteContext,
1203     struct_parts: &StructParts,
1204     fields: &[ast::StructField],
1205     offset: Indent,
1206 ) -> Option<String> {
1207     let mut result = String::with_capacity(1024);
1208     let span = struct_parts.span;
1209
1210     let header_str = struct_parts.format_header();
1211     result.push_str(&header_str);
1212
1213     let body_lo = if fields.is_empty() {
1214         let lo = get_bytepos_after_visibility(context, struct_parts.vis, span, ")");
1215         context.codemap.span_after(mk_sp(lo, span.hi()), "(")
1216     } else {
1217         fields[0].span.lo()
1218     };
1219     let body_hi = if fields.is_empty() {
1220         context.codemap.span_after(mk_sp(body_lo, span.hi()), ")")
1221     } else {
1222         // This is a dirty hack to work around a missing `)` from the span of the last field.
1223         let last_arg_span = fields[fields.len() - 1].span;
1224         if context.snippet(last_arg_span).ends_with(')') {
1225             last_arg_span.hi()
1226         } else {
1227             context
1228                 .codemap
1229                 .span_after(mk_sp(last_arg_span.hi(), span.hi()), ")")
1230         }
1231     };
1232
1233     let where_clause_str = match struct_parts.generics {
1234         Some(generics) => {
1235             let budget = context.budget(last_line_width(&header_str));
1236             let shape = Shape::legacy(budget, offset);
1237             let g_span = mk_sp(span.lo(), body_lo);
1238             let generics_str = rewrite_generics(context, generics, shape, g_span)?;
1239             result.push_str(&generics_str);
1240
1241             let where_budget = context.budget(last_line_width(&result));
1242             let option = WhereClauseOption::new(true, false);
1243             rewrite_where_clause(
1244                 context,
1245                 &generics.where_clause,
1246                 context.config.item_brace_style(),
1247                 Shape::legacy(where_budget, offset.block_only()),
1248                 Density::Compressed,
1249                 ";",
1250                 None,
1251                 body_hi,
1252                 option,
1253                 false,
1254             )?
1255         }
1256         None => "".to_owned(),
1257     };
1258
1259     if fields.is_empty() {
1260         // 3 = `();`
1261         let used_width = last_line_used_width(&result, offset.width()) + 3;
1262         if used_width > context.config.max_width() {
1263             result.push('\n');
1264             result.push_str(&offset
1265                 .block_indent(context.config)
1266                 .to_string(context.config))
1267         }
1268         result.push('(');
1269         let snippet = context.snippet(mk_sp(
1270             body_lo,
1271             context.codemap.span_before(mk_sp(body_lo, span.hi()), ")"),
1272         ));
1273         if snippet.is_empty() {
1274             // `struct S ()`
1275         } else if snippet.trim_right_matches(&[' ', '\t'][..]).ends_with('\n') {
1276             result.push_str(snippet.trim_right());
1277             result.push('\n');
1278             result.push_str(&offset.to_string(context.config));
1279         } else {
1280             result.push_str(&snippet);
1281         }
1282         result.push(')');
1283     } else {
1284         let shape = Shape::indented(offset, context.config);
1285         let fields = &fields.iter().map(|field| field).collect::<Vec<_>>()[..];
1286         let one_line_width = context.config.fn_call_width();
1287         result = rewrite_call_inner(context, &result, fields, span, shape, one_line_width, false)?;
1288     }
1289
1290     if !where_clause_str.is_empty() && !where_clause_str.contains('\n')
1291         && (result.contains('\n')
1292             || offset.block_indent + result.len() + where_clause_str.len() + 1
1293                 > context.config.max_width())
1294     {
1295         // We need to put the where clause on a new line, but we didn't
1296         // know that earlier, so the where clause will not be indented properly.
1297         result.push('\n');
1298         result.push_str(&(offset.block_only() + (context.config.tab_spaces() - 1))
1299             .to_string(context.config));
1300     }
1301     result.push_str(&where_clause_str);
1302
1303     Some(result)
1304 }
1305
1306 pub fn rewrite_type_alias(
1307     context: &RewriteContext,
1308     indent: Indent,
1309     ident: ast::Ident,
1310     ty: &ast::Ty,
1311     generics: &ast::Generics,
1312     vis: &ast::Visibility,
1313     span: Span,
1314 ) -> Option<String> {
1315     let mut result = String::with_capacity(128);
1316
1317     result.push_str(&format_visibility(vis));
1318     result.push_str("type ");
1319     result.push_str(&ident.to_string());
1320
1321     // 2 = `= `
1322     let shape = Shape::indented(indent + result.len(), context.config).sub_width(2)?;
1323     let g_span = mk_sp(context.codemap.span_after(span, "type"), ty.span.lo());
1324     let generics_str = rewrite_generics(context, generics, shape, g_span)?;
1325     result.push_str(&generics_str);
1326
1327     let where_budget = context.budget(last_line_width(&result));
1328     let option = WhereClauseOption::snuggled(&result);
1329     let where_clause_str = rewrite_where_clause(
1330         context,
1331         &generics.where_clause,
1332         context.config.item_brace_style(),
1333         Shape::legacy(where_budget, indent),
1334         context.config.where_density(),
1335         "=",
1336         Some(span.hi()),
1337         generics.span.hi(),
1338         option,
1339         false,
1340     )?;
1341     result.push_str(&where_clause_str);
1342     if where_clause_str.is_empty() {
1343         result.push_str(" = ");
1344     } else {
1345         result.push_str(&format!("\n{}= ", indent.to_string(context.config)));
1346     }
1347
1348     let line_width = last_line_width(&result);
1349     // This checked_sub may fail as the extra space after '=' is not taken into account
1350     // In that case the budget is set to 0 which will make ty.rewrite retry on a new line
1351     let budget = context.budget(indent.width() + line_width + ";".len());
1352     let type_indent = indent + line_width;
1353     // Try to fit the type on the same line
1354     let ty_str = ty.rewrite(context, Shape::legacy(budget, type_indent))
1355         .or_else(|| {
1356             // The line was too short, try to put the type on the next line
1357
1358             // Remove the space after '='
1359             result.pop();
1360             let type_indent = indent.block_indent(context.config);
1361             result.push('\n');
1362             result.push_str(&type_indent.to_string(context.config));
1363             let budget = context.budget(type_indent.width() + ";".len());
1364             ty.rewrite(context, Shape::legacy(budget, type_indent))
1365         })?;
1366     result.push_str(&ty_str);
1367     result.push_str(";");
1368     Some(result)
1369 }
1370
1371 fn type_annotation_spacing(config: &Config) -> (&str, &str) {
1372     (
1373         if config.space_before_type_annotation() {
1374             " "
1375         } else {
1376             ""
1377         },
1378         if config.space_after_type_annotation_colon() {
1379             " "
1380         } else {
1381             ""
1382         },
1383     )
1384 }
1385
1386 pub fn rewrite_struct_field_prefix(
1387     context: &RewriteContext,
1388     field: &ast::StructField,
1389 ) -> Option<String> {
1390     let vis = format_visibility(&field.vis);
1391     let type_annotation_spacing = type_annotation_spacing(context.config);
1392     Some(match field.ident {
1393         Some(name) => format!("{}{}{}:", vis, name, type_annotation_spacing.0),
1394         None => format!("{}", vis),
1395     })
1396 }
1397
1398 impl Rewrite for ast::StructField {
1399     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1400         rewrite_struct_field(context, self, shape, 0)
1401     }
1402 }
1403
1404 pub fn rewrite_struct_field(
1405     context: &RewriteContext,
1406     field: &ast::StructField,
1407     shape: Shape,
1408     lhs_max_width: usize,
1409 ) -> Option<String> {
1410     if contains_skip(&field.attrs) {
1411         return Some(context.snippet(mk_sp(field.attrs[0].span.lo(), field.span.hi())));
1412     }
1413
1414     let type_annotation_spacing = type_annotation_spacing(context.config);
1415     let prefix = rewrite_struct_field_prefix(context, field)?;
1416
1417     let attrs_str = field.attrs.rewrite(context, shape)?;
1418     let attrs_extendable = attrs_str.is_empty()
1419         || (context.config.attributes_on_same_line_as_field()
1420             && is_attributes_extendable(&attrs_str));
1421     let missing_span = if field.attrs.is_empty() {
1422         mk_sp(field.span.lo(), field.span.lo())
1423     } else {
1424         mk_sp(field.attrs.last().unwrap().span.hi(), field.span.lo())
1425     };
1426     let mut spacing = String::from(if field.ident.is_some() {
1427         type_annotation_spacing.1
1428     } else {
1429         ""
1430     });
1431     // Try to put everything on a single line.
1432     let attr_prefix = combine_strs_with_missing_comments(
1433         context,
1434         &attrs_str,
1435         &prefix,
1436         missing_span,
1437         shape,
1438         attrs_extendable,
1439     )?;
1440     let overhead = last_line_width(&attr_prefix);
1441     let lhs_offset = lhs_max_width.checked_sub(overhead).unwrap_or(0);
1442     for _ in 0..lhs_offset {
1443         spacing.push(' ');
1444     }
1445     // In this extreme case we will be missing a space betweeen an attribute and a field.
1446     if prefix.is_empty() && !attrs_str.is_empty() && attrs_extendable && spacing.is_empty() {
1447         spacing.push(' ');
1448     }
1449     let ty_shape = shape.offset_left(overhead + spacing.len())?;
1450     if let Some(ref ty) = field.ty.rewrite(context, ty_shape) {
1451         if !ty.contains('\n') {
1452             return Some(attr_prefix + &spacing + ty);
1453         }
1454     }
1455
1456     // We must use multiline.
1457     let new_shape = shape.with_max_width(context.config);
1458     let ty_rewritten = field.ty.rewrite(context, new_shape)?;
1459
1460     let field_str = if prefix.is_empty() {
1461         ty_rewritten
1462     } else if prefix.len() + first_line_width(&ty_rewritten) + 1 <= shape.width {
1463         prefix + " " + &ty_rewritten
1464     } else {
1465         let type_offset = shape.indent.block_indent(context.config);
1466         let nested_shape = Shape::indented(type_offset, context.config);
1467         let nested_ty = field.ty.rewrite(context, nested_shape)?;
1468         prefix + "\n" + &type_offset.to_string(context.config) + &nested_ty
1469     };
1470     combine_strs_with_missing_comments(
1471         context,
1472         &attrs_str,
1473         &field_str,
1474         missing_span,
1475         shape,
1476         attrs_extendable,
1477     )
1478 }
1479
1480 pub struct StaticParts<'a> {
1481     prefix: &'a str,
1482     vis: &'a ast::Visibility,
1483     ident: ast::Ident,
1484     ty: &'a ast::Ty,
1485     mutability: ast::Mutability,
1486     expr_opt: Option<&'a ptr::P<ast::Expr>>,
1487     span: Span,
1488 }
1489
1490 impl<'a> StaticParts<'a> {
1491     pub fn from_item(item: &'a ast::Item) -> Self {
1492         let (prefix, ty, mutability, expr) = match item.node {
1493             ast::ItemKind::Static(ref ty, mutability, ref expr) => ("static", ty, mutability, expr),
1494             ast::ItemKind::Const(ref ty, ref expr) => {
1495                 ("const", ty, ast::Mutability::Immutable, expr)
1496             }
1497             _ => unreachable!(),
1498         };
1499         StaticParts {
1500             prefix: prefix,
1501             vis: &item.vis,
1502             ident: item.ident,
1503             ty: ty,
1504             mutability: mutability,
1505             expr_opt: Some(expr),
1506             span: item.span,
1507         }
1508     }
1509
1510     pub fn from_trait_item(ti: &'a ast::TraitItem) -> Self {
1511         let (ty, expr_opt) = match ti.node {
1512             ast::TraitItemKind::Const(ref ty, ref expr_opt) => (ty, expr_opt),
1513             _ => unreachable!(),
1514         };
1515         StaticParts {
1516             prefix: "const",
1517             vis: &ast::Visibility::Inherited,
1518             ident: ti.ident,
1519             ty: ty,
1520             mutability: ast::Mutability::Immutable,
1521             expr_opt: expr_opt.as_ref(),
1522             span: ti.span,
1523         }
1524     }
1525
1526     pub fn from_impl_item(ii: &'a ast::ImplItem) -> Self {
1527         let (ty, expr) = match ii.node {
1528             ast::ImplItemKind::Const(ref ty, ref expr) => (ty, expr),
1529             _ => unreachable!(),
1530         };
1531         StaticParts {
1532             prefix: "const",
1533             vis: &ii.vis,
1534             ident: ii.ident,
1535             ty: ty,
1536             mutability: ast::Mutability::Immutable,
1537             expr_opt: Some(expr),
1538             span: ii.span,
1539         }
1540     }
1541 }
1542
1543 fn rewrite_static(
1544     context: &RewriteContext,
1545     static_parts: &StaticParts,
1546     offset: Indent,
1547 ) -> Option<String> {
1548     let colon = colon_spaces(
1549         context.config.space_before_type_annotation(),
1550         context.config.space_after_type_annotation_colon(),
1551     );
1552     let prefix = format!(
1553         "{}{} {}{}{}",
1554         format_visibility(static_parts.vis),
1555         static_parts.prefix,
1556         format_mutability(static_parts.mutability),
1557         static_parts.ident,
1558         colon,
1559     );
1560     // 2 = " =".len()
1561     let ty_shape =
1562         Shape::indented(offset.block_only(), context.config).offset_left(prefix.len() + 2)?;
1563     let ty_str = static_parts.ty.rewrite(context, ty_shape)?;
1564
1565     if let Some(expr) = static_parts.expr_opt {
1566         let lhs = format!("{}{} =", prefix, ty_str);
1567         // 1 = ;
1568         let remaining_width = context.budget(offset.block_indent + 1);
1569         rewrite_assign_rhs(
1570             context,
1571             lhs,
1572             expr,
1573             Shape::legacy(remaining_width, offset.block_only()),
1574         ).and_then(|res| {
1575             recover_comment_removed(res, static_parts.span, context)
1576         })
1577             .map(|s| if s.ends_with(';') { s } else { s + ";" })
1578     } else {
1579         Some(format!("{}{};", prefix, ty_str))
1580     }
1581 }
1582
1583 pub fn rewrite_associated_type(
1584     ident: ast::Ident,
1585     ty_opt: Option<&ptr::P<ast::Ty>>,
1586     ty_param_bounds_opt: Option<&ast::TyParamBounds>,
1587     context: &RewriteContext,
1588     indent: Indent,
1589 ) -> Option<String> {
1590     let prefix = format!("type {}", ident);
1591
1592     let type_bounds_str = if let Some(ty_param_bounds) = ty_param_bounds_opt {
1593         // 2 = ": ".len()
1594         let shape = Shape::indented(indent, context.config).offset_left(prefix.len() + 2)?;
1595         let bounds: &[_] = ty_param_bounds;
1596         let bound_str = bounds
1597             .iter()
1598             .map(|ty_bound| ty_bound.rewrite(context, shape))
1599             .collect::<Option<Vec<_>>>()?;
1600         if !bounds.is_empty() {
1601             format!(": {}", join_bounds(context, shape, &bound_str))
1602         } else {
1603             String::new()
1604         }
1605     } else {
1606         String::new()
1607     };
1608
1609     if let Some(ty) = ty_opt {
1610         let ty_str = ty.rewrite(
1611             context,
1612             Shape::legacy(
1613                 context.budget(indent.block_indent + prefix.len() + 2),
1614                 indent.block_only(),
1615             ),
1616         )?;
1617         Some(format!("{}{} = {};", prefix, type_bounds_str, ty_str))
1618     } else {
1619         Some(format!("{}{};", prefix, type_bounds_str))
1620     }
1621 }
1622
1623 pub fn rewrite_associated_impl_type(
1624     ident: ast::Ident,
1625     defaultness: ast::Defaultness,
1626     ty_opt: Option<&ptr::P<ast::Ty>>,
1627     ty_param_bounds_opt: Option<&ast::TyParamBounds>,
1628     context: &RewriteContext,
1629     indent: Indent,
1630 ) -> Option<String> {
1631     let result = rewrite_associated_type(ident, ty_opt, ty_param_bounds_opt, context, indent)?;
1632
1633     match defaultness {
1634         ast::Defaultness::Default => Some(format!("default {}", result)),
1635         _ => Some(result),
1636     }
1637 }
1638
1639 impl Rewrite for ast::FunctionRetTy {
1640     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1641         match *self {
1642             ast::FunctionRetTy::Default(_) => Some(String::new()),
1643             ast::FunctionRetTy::Ty(ref ty) => {
1644                 let inner_width = shape.width.checked_sub(3)?;
1645                 ty.rewrite(context, Shape::legacy(inner_width, shape.indent + 3))
1646                     .map(|r| format!("-> {}", r))
1647             }
1648         }
1649     }
1650 }
1651
1652 fn is_empty_infer(context: &RewriteContext, ty: &ast::Ty) -> bool {
1653     match ty.node {
1654         ast::TyKind::Infer => {
1655             let original = context.snippet(ty.span);
1656             original != "_"
1657         }
1658         _ => false,
1659     }
1660 }
1661
1662 impl Rewrite for ast::Arg {
1663     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1664         if is_named_arg(self) {
1665             let mut result = self.pat
1666                 .rewrite(context, Shape::legacy(shape.width, shape.indent))?;
1667
1668             if !is_empty_infer(context, &*self.ty) {
1669                 if context.config.space_before_type_annotation() {
1670                     result.push_str(" ");
1671                 }
1672                 result.push_str(":");
1673                 if context.config.space_after_type_annotation_colon() {
1674                     result.push_str(" ");
1675                 }
1676                 let overhead = last_line_width(&result);
1677                 let max_width = shape.width.checked_sub(overhead)?;
1678                 let ty_str = self.ty
1679                     .rewrite(context, Shape::legacy(max_width, shape.indent))?;
1680                 result.push_str(&ty_str);
1681             }
1682
1683             Some(result)
1684         } else {
1685             self.ty.rewrite(context, shape)
1686         }
1687     }
1688 }
1689
1690 fn rewrite_explicit_self(
1691     explicit_self: &ast::ExplicitSelf,
1692     args: &[ast::Arg],
1693     context: &RewriteContext,
1694 ) -> Option<String> {
1695     match explicit_self.node {
1696         ast::SelfKind::Region(lt, m) => {
1697             let mut_str = format_mutability(m);
1698             match lt {
1699                 Some(ref l) => {
1700                     let lifetime_str = l.rewrite(
1701                         context,
1702                         Shape::legacy(context.config.max_width(), Indent::empty()),
1703                     )?;
1704                     Some(format!("&{} {}self", lifetime_str, mut_str))
1705                 }
1706                 None => Some(format!("&{}self", mut_str)),
1707             }
1708         }
1709         ast::SelfKind::Explicit(ref ty, _) => {
1710             assert!(!args.is_empty(), "&[ast::Arg] shouldn't be empty.");
1711
1712             let mutability = explicit_self_mutability(&args[0]);
1713             let type_str = ty.rewrite(
1714                 context,
1715                 Shape::legacy(context.config.max_width(), Indent::empty()),
1716             )?;
1717
1718             Some(format!(
1719                 "{}self: {}",
1720                 format_mutability(mutability),
1721                 type_str
1722             ))
1723         }
1724         ast::SelfKind::Value(_) => {
1725             assert!(!args.is_empty(), "&[ast::Arg] shouldn't be empty.");
1726
1727             let mutability = explicit_self_mutability(&args[0]);
1728
1729             Some(format!("{}self", format_mutability(mutability)))
1730         }
1731     }
1732 }
1733
1734 // Hacky solution caused by absence of `Mutability` in `SelfValue` and
1735 // `SelfExplicit` variants of `ast::ExplicitSelf_`.
1736 fn explicit_self_mutability(arg: &ast::Arg) -> ast::Mutability {
1737     if let ast::PatKind::Ident(ast::BindingMode::ByValue(mutability), _, _) = arg.pat.node {
1738         mutability
1739     } else {
1740         unreachable!()
1741     }
1742 }
1743
1744 pub fn span_lo_for_arg(arg: &ast::Arg) -> BytePos {
1745     if is_named_arg(arg) {
1746         arg.pat.span.lo()
1747     } else {
1748         arg.ty.span.lo()
1749     }
1750 }
1751
1752 pub fn span_hi_for_arg(context: &RewriteContext, arg: &ast::Arg) -> BytePos {
1753     match arg.ty.node {
1754         ast::TyKind::Infer if context.snippet(arg.ty.span) == "_" => arg.ty.span.hi(),
1755         ast::TyKind::Infer if is_named_arg(arg) => arg.pat.span.hi(),
1756         _ => arg.ty.span.hi(),
1757     }
1758 }
1759
1760 pub fn is_named_arg(arg: &ast::Arg) -> bool {
1761     if let ast::PatKind::Ident(_, ident, _) = arg.pat.node {
1762         ident.node != symbol::keywords::Invalid.ident()
1763     } else {
1764         true
1765     }
1766 }
1767
1768 // Return type is (result, force_new_line_for_brace)
1769 fn rewrite_fn_base(
1770     context: &RewriteContext,
1771     indent: Indent,
1772     ident: ast::Ident,
1773     fn_sig: &FnSig,
1774     span: Span,
1775     newline_brace: bool,
1776     has_body: bool,
1777 ) -> Option<(String, bool)> {
1778     let mut force_new_line_for_brace = false;
1779
1780     let where_clause = &fn_sig.generics.where_clause;
1781
1782     let mut result = String::with_capacity(1024);
1783     result.push_str(&fn_sig.to_str(context));
1784
1785     // fn foo
1786     result.push_str("fn ");
1787     result.push_str(&ident.to_string());
1788
1789     // Generics.
1790     let overhead = if has_body && !newline_brace {
1791         // 4 = `() {`
1792         4
1793     } else {
1794         // 2 = `()`
1795         2
1796     };
1797     let used_width = last_line_used_width(&result, indent.width());
1798     let one_line_budget = context.budget(used_width + overhead);
1799     let shape = Shape {
1800         width: one_line_budget,
1801         indent: indent,
1802         offset: used_width,
1803     };
1804     let fd = fn_sig.decl;
1805     let g_span = mk_sp(span.lo(), fd.output.span().lo());
1806     let generics_str = rewrite_generics(context, fn_sig.generics, shape, g_span)?;
1807     result.push_str(&generics_str);
1808
1809     let snuggle_angle_bracket = generics_str
1810         .lines()
1811         .last()
1812         .map_or(false, |l| l.trim_left().len() == 1);
1813
1814     // Note that the width and indent don't really matter, we'll re-layout the
1815     // return type later anyway.
1816     let ret_str = fd.output
1817         .rewrite(context, Shape::indented(indent, context.config))?;
1818
1819     let multi_line_ret_str = ret_str.contains('\n');
1820     let ret_str_len = if multi_line_ret_str { 0 } else { ret_str.len() };
1821
1822     // Args.
1823     let (one_line_budget, multi_line_budget, mut arg_indent) = compute_budgets_for_args(
1824         context,
1825         &result,
1826         indent,
1827         ret_str_len,
1828         newline_brace,
1829         has_body,
1830         multi_line_ret_str,
1831     )?;
1832
1833     debug!(
1834         "rewrite_fn_base: one_line_budget: {}, multi_line_budget: {}, arg_indent: {:?}",
1835         one_line_budget,
1836         multi_line_budget,
1837         arg_indent
1838     );
1839
1840     // Check if vertical layout was forced.
1841     if one_line_budget == 0 {
1842         if snuggle_angle_bracket {
1843             result.push('(');
1844         } else if context.config.fn_args_paren_newline() {
1845             result.push('\n');
1846             result.push_str(&arg_indent.to_string(context.config));
1847             if context.config.fn_args_indent() == IndentStyle::Visual {
1848                 arg_indent = arg_indent + 1; // extra space for `(`
1849             }
1850             result.push('(');
1851         } else {
1852             result.push_str("(");
1853             if context.config.fn_args_indent() == IndentStyle::Visual {
1854                 result.push('\n');
1855                 result.push_str(&arg_indent.to_string(context.config));
1856             }
1857         }
1858     } else {
1859         result.push('(');
1860     }
1861     if context.config.spaces_within_parens() && !fd.inputs.is_empty() && result.ends_with('(') {
1862         result.push(' ')
1863     }
1864
1865     // Skip `pub(crate)`.
1866     let lo_after_visibility = get_bytepos_after_visibility(context, &fn_sig.visibility, span, ")");
1867     // A conservative estimation, to goal is to be over all parens in generics
1868     let args_start = fn_sig
1869         .generics
1870         .ty_params
1871         .last()
1872         .map_or(lo_after_visibility, |tp| end_typaram(tp));
1873     let args_end = if fd.inputs.is_empty() {
1874         context
1875             .codemap
1876             .span_after(mk_sp(args_start, span.hi()), ")")
1877     } else {
1878         let last_span = mk_sp(fd.inputs[fd.inputs.len() - 1].span().hi(), span.hi());
1879         context.codemap.span_after(last_span, ")")
1880     };
1881     let args_span = mk_sp(
1882         context
1883             .codemap
1884             .span_after(mk_sp(args_start, span.hi()), "("),
1885         args_end,
1886     );
1887     let arg_str = rewrite_args(
1888         context,
1889         &fd.inputs,
1890         fd.get_self().as_ref(),
1891         one_line_budget,
1892         multi_line_budget,
1893         indent,
1894         arg_indent,
1895         args_span,
1896         fd.variadic,
1897         generics_str.contains('\n'),
1898     )?;
1899
1900     let put_args_in_block = match context.config.fn_args_indent() {
1901         IndentStyle::Block => arg_str.contains('\n') || arg_str.len() > one_line_budget,
1902         _ => false,
1903     } && !fd.inputs.is_empty();
1904
1905     let mut args_last_line_contains_comment = false;
1906     if put_args_in_block {
1907         arg_indent = indent.block_indent(context.config);
1908         result.push('\n');
1909         result.push_str(&arg_indent.to_string(context.config));
1910         result.push_str(&arg_str);
1911         result.push('\n');
1912         result.push_str(&indent.to_string(context.config));
1913         result.push(')');
1914     } else {
1915         result.push_str(&arg_str);
1916         let used_width = last_line_used_width(&result, indent.width()) + first_line_width(&ret_str);
1917         // Put the closing brace on the next line if it overflows the max width.
1918         // 1 = `)`
1919         if fd.inputs.is_empty() && used_width + 1 > context.config.max_width() {
1920             result.push('\n');
1921         }
1922         if context.config.spaces_within_parens() && !fd.inputs.is_empty() {
1923             result.push(' ')
1924         }
1925         // If the last line of args contains comment, we cannot put the closing paren
1926         // on the same line.
1927         if arg_str
1928             .lines()
1929             .last()
1930             .map_or(false, |last_line| last_line.contains("//"))
1931         {
1932             args_last_line_contains_comment = true;
1933             result.push('\n');
1934             result.push_str(&arg_indent.to_string(context.config));
1935         }
1936         result.push(')');
1937     }
1938
1939     // Return type.
1940     if let ast::FunctionRetTy::Ty(..) = fd.output {
1941         let ret_should_indent = match context.config.fn_args_indent() {
1942             // If our args are block layout then we surely must have space.
1943             IndentStyle::Block if put_args_in_block || fd.inputs.is_empty() => false,
1944             _ if args_last_line_contains_comment => false,
1945             _ if result.contains('\n') || multi_line_ret_str => true,
1946             _ => {
1947                 // If the return type would push over the max width, then put the return type on
1948                 // a new line. With the +1 for the signature length an additional space between
1949                 // the closing parenthesis of the argument and the arrow '->' is considered.
1950                 let mut sig_length = result.len() + indent.width() + ret_str_len + 1;
1951
1952                 // If there is no where clause, take into account the space after the return type
1953                 // and the brace.
1954                 if where_clause.predicates.is_empty() {
1955                     sig_length += 2;
1956                 }
1957
1958                 sig_length > context.config.max_width()
1959             }
1960         };
1961         let ret_indent = if ret_should_indent {
1962             let indent = match context.config.fn_return_indent() {
1963                 ReturnIndent::WithWhereClause => indent + 4,
1964                 // Aligning with non-existent args looks silly.
1965                 _ if arg_str.is_empty() => {
1966                     force_new_line_for_brace = true;
1967                     indent + 4
1968                 }
1969                 // FIXME: we might want to check that using the arg indent
1970                 // doesn't blow our budget, and if it does, then fallback to
1971                 // the where clause indent.
1972                 _ => arg_indent,
1973             };
1974
1975             result.push('\n');
1976             result.push_str(&indent.to_string(context.config));
1977             indent
1978         } else {
1979             result.push(' ');
1980             Indent::new(indent.block_indent, last_line_width(&result))
1981         };
1982
1983         if multi_line_ret_str || ret_should_indent {
1984             // Now that we know the proper indent and width, we need to
1985             // re-layout the return type.
1986             let ret_str = fd.output
1987                 .rewrite(context, Shape::indented(ret_indent, context.config))?;
1988             result.push_str(&ret_str);
1989         } else {
1990             result.push_str(&ret_str);
1991         }
1992
1993         // Comment between return type and the end of the decl.
1994         let snippet_lo = fd.output.span().hi();
1995         if where_clause.predicates.is_empty() {
1996             let snippet_hi = span.hi();
1997             let snippet = context.snippet(mk_sp(snippet_lo, snippet_hi));
1998             // Try to preserve the layout of the original snippet.
1999             let original_starts_with_newline = snippet
2000                 .find(|c| c != ' ')
2001                 .map_or(false, |i| starts_with_newline(&snippet[i..]));
2002             let original_ends_with_newline = snippet
2003                 .rfind(|c| c != ' ')
2004                 .map_or(false, |i| snippet[i..].ends_with('\n'));
2005             let snippet = snippet.trim();
2006             if !snippet.is_empty() {
2007                 result.push(if original_starts_with_newline {
2008                     '\n'
2009                 } else {
2010                     ' '
2011                 });
2012                 result.push_str(snippet);
2013                 if original_ends_with_newline {
2014                     force_new_line_for_brace = true;
2015                 }
2016             }
2017         }
2018     }
2019
2020     let should_compress_where = match context.config.where_density() {
2021         Density::Compressed => !result.contains('\n'),
2022         Density::CompressedIfEmpty => !has_body && !result.contains('\n'),
2023         _ => false,
2024     };
2025
2026     let pos_before_where = match fd.output {
2027         ast::FunctionRetTy::Default(..) => args_span.hi(),
2028         ast::FunctionRetTy::Ty(ref ty) => ty.span.hi(),
2029     };
2030
2031     let is_args_multi_lined = arg_str.contains('\n');
2032
2033     if where_clause.predicates.len() == 1 && should_compress_where {
2034         let budget = context.budget(last_line_used_width(&result, indent.width()));
2035         if let Some(where_clause_str) = rewrite_where_clause(
2036             context,
2037             where_clause,
2038             context.config.fn_brace_style(),
2039             Shape::legacy(budget, indent),
2040             Density::Compressed,
2041             "{",
2042             Some(span.hi()),
2043             pos_before_where,
2044             WhereClauseOption::compressed(),
2045             is_args_multi_lined,
2046         ) {
2047             result.push_str(&where_clause_str);
2048             force_new_line_for_brace |= last_line_contains_single_line_comment(&result);
2049             return Some((result, force_new_line_for_brace));
2050         }
2051     }
2052
2053     let option = WhereClauseOption::new(!has_body, put_args_in_block && ret_str.is_empty());
2054     let where_clause_str = rewrite_where_clause(
2055         context,
2056         where_clause,
2057         context.config.fn_brace_style(),
2058         Shape::indented(indent, context.config),
2059         Density::Tall,
2060         "{",
2061         Some(span.hi()),
2062         pos_before_where,
2063         option,
2064         is_args_multi_lined,
2065     )?;
2066     // If there are neither where clause nor return type, we may be missing comments between
2067     // args and `{`.
2068     if where_clause_str.is_empty() {
2069         if let ast::FunctionRetTy::Default(ret_span) = fd.output {
2070             match recover_missing_comment_in_span(
2071                 mk_sp(args_span.hi(), ret_span.hi()),
2072                 shape,
2073                 context,
2074                 last_line_width(&result),
2075             ) {
2076                 Some(ref missing_comment) if !missing_comment.is_empty() => {
2077                     result.push_str(missing_comment);
2078                     force_new_line_for_brace = true;
2079                 }
2080                 _ => (),
2081             }
2082         }
2083     }
2084
2085     result.push_str(&where_clause_str);
2086
2087     force_new_line_for_brace |= last_line_contains_single_line_comment(&result);
2088     force_new_line_for_brace |= is_args_multi_lined && context.config.where_single_line();
2089     Some((result, force_new_line_for_brace))
2090 }
2091
2092 #[derive(Copy, Clone)]
2093 struct WhereClauseOption {
2094     suppress_comma: bool, // Force no trailing comma
2095     snuggle: bool,        // Do not insert newline before `where`
2096     compress_where: bool, // Try single line where clause instead of vertical layout
2097 }
2098
2099 impl WhereClauseOption {
2100     pub fn new(suppress_comma: bool, snuggle: bool) -> WhereClauseOption {
2101         WhereClauseOption {
2102             suppress_comma: suppress_comma,
2103             snuggle: snuggle,
2104             compress_where: false,
2105         }
2106     }
2107
2108     pub fn compressed() -> WhereClauseOption {
2109         WhereClauseOption {
2110             suppress_comma: true,
2111             snuggle: false,
2112             compress_where: true,
2113         }
2114     }
2115
2116     pub fn snuggled(current: &str) -> WhereClauseOption {
2117         WhereClauseOption {
2118             suppress_comma: false,
2119             snuggle: trimmed_last_line_width(current) == 1,
2120             compress_where: false,
2121         }
2122     }
2123 }
2124
2125 fn rewrite_args(
2126     context: &RewriteContext,
2127     args: &[ast::Arg],
2128     explicit_self: Option<&ast::ExplicitSelf>,
2129     one_line_budget: usize,
2130     multi_line_budget: usize,
2131     indent: Indent,
2132     arg_indent: Indent,
2133     span: Span,
2134     variadic: bool,
2135     generics_str_contains_newline: bool,
2136 ) -> Option<String> {
2137     let mut arg_item_strs = args.iter()
2138         .map(|arg| arg.rewrite(context, Shape::legacy(multi_line_budget, arg_indent)))
2139         .collect::<Option<Vec<_>>>()?;
2140
2141     // Account for sugary self.
2142     // FIXME: the comment for the self argument is dropped. This is blocked
2143     // on rust issue #27522.
2144     let min_args = explicit_self
2145         .and_then(|explicit_self| {
2146             rewrite_explicit_self(explicit_self, args, context)
2147         })
2148         .map_or(1, |self_str| {
2149             arg_item_strs[0] = self_str;
2150             2
2151         });
2152
2153     // Comments between args.
2154     let mut arg_items = Vec::new();
2155     if min_args == 2 {
2156         arg_items.push(ListItem::from_str(""));
2157     }
2158
2159     // FIXME(#21): if there are no args, there might still be a comment, but
2160     // without spans for the comment or parens, there is no chance of
2161     // getting it right. You also don't get to put a comment on self, unless
2162     // it is explicit.
2163     if args.len() >= min_args || variadic {
2164         let comment_span_start = if min_args == 2 {
2165             let second_arg_start = if arg_has_pattern(&args[1]) {
2166                 args[1].pat.span.lo()
2167             } else {
2168                 args[1].ty.span.lo()
2169             };
2170             let reduced_span = mk_sp(span.lo(), second_arg_start);
2171
2172             context.codemap.span_after_last(reduced_span, ",")
2173         } else {
2174             span.lo()
2175         };
2176
2177         enum ArgumentKind<'a> {
2178             Regular(&'a ast::Arg),
2179             Variadic(BytePos),
2180         }
2181
2182         let variadic_arg = if variadic {
2183             let variadic_span = mk_sp(args.last().unwrap().ty.span.hi(), span.hi());
2184             let variadic_start = context.codemap.span_after(variadic_span, "...") - BytePos(3);
2185             Some(ArgumentKind::Variadic(variadic_start))
2186         } else {
2187             None
2188         };
2189
2190         let more_items = itemize_list(
2191             context.codemap,
2192             args[min_args - 1..]
2193                 .iter()
2194                 .map(ArgumentKind::Regular)
2195                 .chain(variadic_arg),
2196             ")",
2197             |arg| match *arg {
2198                 ArgumentKind::Regular(arg) => span_lo_for_arg(arg),
2199                 ArgumentKind::Variadic(start) => start,
2200             },
2201             |arg| match *arg {
2202                 ArgumentKind::Regular(arg) => arg.ty.span.hi(),
2203                 ArgumentKind::Variadic(start) => start + BytePos(3),
2204             },
2205             |arg| match *arg {
2206                 ArgumentKind::Regular(..) => None,
2207                 ArgumentKind::Variadic(..) => Some("...".to_owned()),
2208             },
2209             comment_span_start,
2210             span.hi(),
2211             false,
2212         );
2213
2214         arg_items.extend(more_items);
2215     }
2216
2217     let fits_in_one_line = !generics_str_contains_newline
2218         && (arg_items.is_empty()
2219             || arg_items.len() == 1 && arg_item_strs[0].len() <= one_line_budget);
2220
2221     for (item, arg) in arg_items.iter_mut().zip(arg_item_strs) {
2222         item.item = Some(arg);
2223     }
2224
2225     let last_line_ends_with_comment = arg_items
2226         .iter()
2227         .last()
2228         .and_then(|item| item.post_comment.as_ref())
2229         .map_or(false, |s| s.trim().starts_with("//"));
2230
2231     let (indent, trailing_comma) = match context.config.fn_args_indent() {
2232         IndentStyle::Block if fits_in_one_line => {
2233             (indent.block_indent(context.config), SeparatorTactic::Never)
2234         }
2235         IndentStyle::Block => (
2236             indent.block_indent(context.config),
2237             context.config.trailing_comma(),
2238         ),
2239         IndentStyle::Visual if last_line_ends_with_comment => {
2240             (arg_indent, context.config.trailing_comma())
2241         }
2242         IndentStyle::Visual => (arg_indent, SeparatorTactic::Never),
2243     };
2244
2245     let tactic = definitive_tactic(
2246         &arg_items,
2247         context.config.fn_args_density().to_list_tactic(),
2248         Separator::Comma,
2249         one_line_budget,
2250     );
2251     let budget = match tactic {
2252         DefinitiveListTactic::Horizontal => one_line_budget,
2253         _ => multi_line_budget,
2254     };
2255
2256     debug!("rewrite_args: budget: {}, tactic: {:?}", budget, tactic);
2257
2258     let fmt = ListFormatting {
2259         tactic: tactic,
2260         separator: ",",
2261         trailing_separator: if variadic {
2262             SeparatorTactic::Never
2263         } else {
2264             trailing_comma
2265         },
2266         separator_place: SeparatorPlace::Back,
2267         shape: Shape::legacy(budget, indent),
2268         ends_with_newline: tactic.ends_with_newline(context.config.fn_args_indent()),
2269         preserve_newline: true,
2270         config: context.config,
2271     };
2272
2273     write_list(&arg_items, &fmt)
2274 }
2275
2276 fn arg_has_pattern(arg: &ast::Arg) -> bool {
2277     if let ast::PatKind::Ident(_, ident, _) = arg.pat.node {
2278         ident.node != symbol::keywords::Invalid.ident()
2279     } else {
2280         true
2281     }
2282 }
2283
2284 fn compute_budgets_for_args(
2285     context: &RewriteContext,
2286     result: &str,
2287     indent: Indent,
2288     ret_str_len: usize,
2289     newline_brace: bool,
2290     has_braces: bool,
2291     force_vertical_layout: bool,
2292 ) -> Option<((usize, usize, Indent))> {
2293     debug!(
2294         "compute_budgets_for_args {} {:?}, {}, {}",
2295         result.len(),
2296         indent,
2297         ret_str_len,
2298         newline_brace
2299     );
2300     // Try keeping everything on the same line.
2301     if !result.contains('\n') && !force_vertical_layout {
2302         // 2 = `()`, 3 = `() `, space is before ret_string.
2303         let overhead = if ret_str_len == 0 { 2 } else { 3 };
2304         let mut used_space = indent.width() + result.len() + ret_str_len + overhead;
2305         if has_braces {
2306             if !newline_brace {
2307                 // 2 = `{}`
2308                 used_space += 2;
2309             }
2310         } else {
2311             // 1 = `;`
2312             used_space += 1;
2313         }
2314         let one_line_budget = context.budget(used_space);
2315
2316         if one_line_budget > 0 {
2317             // 4 = "() {".len()
2318             let (indent, multi_line_budget) = match context.config.fn_args_indent() {
2319                 IndentStyle::Block => {
2320                     let indent = indent.block_indent(context.config);
2321                     (indent, context.budget(indent.width() + 1))
2322                 }
2323                 IndentStyle::Visual => {
2324                     let indent = indent + result.len() + 1;
2325                     let multi_line_overhead = indent.width() + if newline_brace { 2 } else { 4 };
2326                     (indent, context.budget(multi_line_overhead))
2327                 }
2328             };
2329
2330             return Some((one_line_budget, multi_line_budget, indent));
2331         }
2332     }
2333
2334     // Didn't work. we must force vertical layout and put args on a newline.
2335     let new_indent = indent.block_indent(context.config);
2336     let used_space = match context.config.fn_args_indent() {
2337         // 1 = `,`
2338         IndentStyle::Block => new_indent.width() + 1,
2339         // Account for `)` and possibly ` {`.
2340         IndentStyle::Visual => new_indent.width() + if ret_str_len == 0 { 1 } else { 3 },
2341     };
2342     Some((0, context.budget(used_space), new_indent))
2343 }
2344
2345 fn newline_for_brace(config: &Config, where_clause: &ast::WhereClause, has_body: bool) -> bool {
2346     let predicate_count = where_clause.predicates.len();
2347
2348     if config.where_single_line() && predicate_count == 1 {
2349         return false;
2350     }
2351     match (config.fn_brace_style(), config.where_density()) {
2352         (BraceStyle::AlwaysNextLine, _) => true,
2353         (_, Density::Compressed) if predicate_count == 1 => false,
2354         (_, Density::CompressedIfEmpty) if predicate_count == 1 && !has_body => false,
2355         (BraceStyle::SameLineWhere, _) if predicate_count > 0 => true,
2356         _ => false,
2357     }
2358 }
2359
2360 fn rewrite_generics(
2361     context: &RewriteContext,
2362     generics: &ast::Generics,
2363     shape: Shape,
2364     span: Span,
2365 ) -> Option<String> {
2366     let g_shape = generics_shape_from_config(context.config, shape, 0)?;
2367     let one_line_width = shape.width.checked_sub(2).unwrap_or(0);
2368     rewrite_generics_inner(context, generics, g_shape, one_line_width, span).or_else(|| {
2369         rewrite_generics_inner(context, generics, g_shape, 0, span)
2370     })
2371 }
2372
2373 fn rewrite_generics_inner(
2374     context: &RewriteContext,
2375     generics: &ast::Generics,
2376     shape: Shape,
2377     one_line_width: usize,
2378     span: Span,
2379 ) -> Option<String> {
2380     // FIXME: convert bounds to where clauses where they get too big or if
2381     // there is a where clause at all.
2382
2383     // Wrapper type
2384     enum GenericsArg<'a> {
2385         Lifetime(&'a ast::LifetimeDef),
2386         TyParam(&'a ast::TyParam),
2387     }
2388     impl<'a> Rewrite for GenericsArg<'a> {
2389         fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
2390             match *self {
2391                 GenericsArg::Lifetime(lifetime) => lifetime.rewrite(context, shape),
2392                 GenericsArg::TyParam(ty) => ty.rewrite(context, shape),
2393             }
2394         }
2395     }
2396     impl<'a> Spanned for GenericsArg<'a> {
2397         fn span(&self) -> Span {
2398             match *self {
2399                 GenericsArg::Lifetime(lifetime) => lifetime.span(),
2400                 GenericsArg::TyParam(ty) => ty.span(),
2401             }
2402         }
2403     }
2404
2405     if generics.lifetimes.is_empty() && generics.ty_params.is_empty() {
2406         return Some(String::new());
2407     }
2408
2409     let generics_args = generics
2410         .lifetimes
2411         .iter()
2412         .map(|lt| GenericsArg::Lifetime(lt))
2413         .chain(generics.ty_params.iter().map(|ty| GenericsArg::TyParam(ty)));
2414     let items = itemize_list(
2415         context.codemap,
2416         generics_args,
2417         ">",
2418         |arg| arg.span().lo(),
2419         |arg| arg.span().hi(),
2420         |arg| arg.rewrite(context, shape),
2421         context.codemap.span_after(span, "<"),
2422         span.hi(),
2423         false,
2424     );
2425     format_generics_item_list(context, items, shape, one_line_width)
2426 }
2427
2428 pub fn generics_shape_from_config(config: &Config, shape: Shape, offset: usize) -> Option<Shape> {
2429     match config.generics_indent() {
2430         IndentStyle::Visual => shape.visual_indent(1 + offset).sub_width(offset + 2),
2431         IndentStyle::Block => {
2432             // 1 = ","
2433             shape
2434                 .block()
2435                 .block_indent(config.tab_spaces())
2436                 .with_max_width(config)
2437                 .sub_width(1)
2438         }
2439     }
2440 }
2441
2442 pub fn format_generics_item_list<I>(
2443     context: &RewriteContext,
2444     items: I,
2445     shape: Shape,
2446     one_line_budget: usize,
2447 ) -> Option<String>
2448 where
2449     I: Iterator<Item = ListItem>,
2450 {
2451     let item_vec = items.collect::<Vec<_>>();
2452
2453     let tactic = definitive_tactic(
2454         &item_vec,
2455         ListTactic::HorizontalVertical,
2456         Separator::Comma,
2457         one_line_budget,
2458     );
2459     let fmt = ListFormatting {
2460         tactic: tactic,
2461         separator: ",",
2462         trailing_separator: if context.config.generics_indent() == IndentStyle::Visual {
2463             SeparatorTactic::Never
2464         } else {
2465             context.config.trailing_comma()
2466         },
2467         separator_place: SeparatorPlace::Back,
2468         shape: shape,
2469         ends_with_newline: tactic.ends_with_newline(context.config.generics_indent()),
2470         preserve_newline: true,
2471         config: context.config,
2472     };
2473
2474     let list_str = write_list(&item_vec, &fmt)?;
2475
2476     Some(wrap_generics_with_angle_brackets(
2477         context,
2478         &list_str,
2479         shape.indent,
2480     ))
2481 }
2482
2483 pub fn wrap_generics_with_angle_brackets(
2484     context: &RewriteContext,
2485     list_str: &str,
2486     list_offset: Indent,
2487 ) -> String {
2488     if context.config.generics_indent() == IndentStyle::Block
2489         && (list_str.contains('\n') || list_str.ends_with(','))
2490     {
2491         format!(
2492             "<\n{}{}\n{}>",
2493             list_offset.to_string(context.config),
2494             list_str,
2495             list_offset
2496                 .block_unindent(context.config)
2497                 .to_string(context.config)
2498         )
2499     } else if context.config.spaces_within_angle_brackets() {
2500         format!("< {} >", list_str)
2501     } else {
2502         format!("<{}>", list_str)
2503     }
2504 }
2505
2506 fn rewrite_trait_bounds(
2507     context: &RewriteContext,
2508     type_param_bounds: &ast::TyParamBounds,
2509     shape: Shape,
2510 ) -> Option<String> {
2511     let bounds: &[_] = type_param_bounds;
2512
2513     if bounds.is_empty() {
2514         return Some(String::new());
2515     }
2516     let bound_str = bounds
2517         .iter()
2518         .map(|ty_bound| ty_bound.rewrite(context, shape))
2519         .collect::<Option<Vec<_>>>()?;
2520     Some(format!(": {}", join_bounds(context, shape, &bound_str)))
2521 }
2522
2523 fn rewrite_where_clause_rfc_style(
2524     context: &RewriteContext,
2525     where_clause: &ast::WhereClause,
2526     shape: Shape,
2527     terminator: &str,
2528     span_end: Option<BytePos>,
2529     span_end_before_where: BytePos,
2530     where_clause_option: WhereClauseOption,
2531     is_args_multi_line: bool,
2532 ) -> Option<String> {
2533     let block_shape = shape.block().with_max_width(context.config);
2534
2535     let (span_before, span_after) =
2536         missing_span_before_after_where(span_end_before_where, where_clause);
2537     let (comment_before, comment_after) =
2538         rewrite_comments_before_after_where(context, span_before, span_after, shape)?;
2539
2540     let starting_newline = if where_clause_option.snuggle && comment_before.is_empty() {
2541         " ".to_owned()
2542     } else {
2543         "\n".to_owned() + &block_shape.indent.to_string(context.config)
2544     };
2545
2546     let clause_shape = block_shape.block_left(context.config.tab_spaces())?;
2547     // 1 = `,`
2548     let clause_shape = clause_shape.sub_width(1)?;
2549     // each clause on one line, trailing comma (except if suppress_comma)
2550     let span_start = where_clause.predicates[0].span().lo();
2551     // If we don't have the start of the next span, then use the end of the
2552     // predicates, but that means we miss comments.
2553     let len = where_clause.predicates.len();
2554     let end_of_preds = where_clause.predicates[len - 1].span().hi();
2555     let span_end = span_end.unwrap_or(end_of_preds);
2556     let items = itemize_list(
2557         context.codemap,
2558         where_clause.predicates.iter(),
2559         terminator,
2560         |pred| pred.span().lo(),
2561         |pred| pred.span().hi(),
2562         |pred| pred.rewrite(context, clause_shape),
2563         span_start,
2564         span_end,
2565         false,
2566     );
2567     let where_single_line = context.config.where_single_line() && len == 1 && !is_args_multi_line;
2568     let comma_tactic = if where_clause_option.suppress_comma || where_single_line {
2569         SeparatorTactic::Never
2570     } else {
2571         context.config.trailing_comma()
2572     };
2573
2574     // shape should be vertical only and only if we have `where_single_line` option enabled
2575     // and the number of items of the where clause is equal to 1
2576     let shape_tactic = if where_single_line {
2577         DefinitiveListTactic::Horizontal
2578     } else {
2579         DefinitiveListTactic::Vertical
2580     };
2581
2582     let fmt = ListFormatting {
2583         tactic: shape_tactic,
2584         separator: ",",
2585         trailing_separator: comma_tactic,
2586         separator_place: SeparatorPlace::Back,
2587         shape: clause_shape,
2588         ends_with_newline: true,
2589         preserve_newline: true,
2590         config: context.config,
2591     };
2592     let preds_str = write_list(&items.collect::<Vec<_>>(), &fmt)?;
2593
2594     let comment_separator = |comment: &str, shape: Shape| if comment.is_empty() {
2595         String::new()
2596     } else {
2597         format!("\n{}", shape.indent.to_string(context.config))
2598     };
2599     let newline_before_where = comment_separator(&comment_before, shape);
2600     let newline_after_where = comment_separator(&comment_after, clause_shape);
2601
2602     // 6 = `where `
2603     let clause_sep = if where_clause_option.compress_where && comment_before.is_empty()
2604         && comment_after.is_empty() && !preds_str.contains('\n')
2605         && 6 + preds_str.len() <= shape.width || where_single_line
2606     {
2607         String::from(" ")
2608     } else {
2609         format!("\n{}", clause_shape.indent.to_string(context.config))
2610     };
2611     Some(format!(
2612         "{}{}{}where{}{}{}{}",
2613         starting_newline,
2614         comment_before,
2615         newline_before_where,
2616         newline_after_where,
2617         comment_after,
2618         clause_sep,
2619         preds_str
2620     ))
2621 }
2622
2623 fn rewrite_where_clause(
2624     context: &RewriteContext,
2625     where_clause: &ast::WhereClause,
2626     brace_style: BraceStyle,
2627     shape: Shape,
2628     density: Density,
2629     terminator: &str,
2630     span_end: Option<BytePos>,
2631     span_end_before_where: BytePos,
2632     where_clause_option: WhereClauseOption,
2633     is_args_multi_line: bool,
2634 ) -> Option<String> {
2635     if where_clause.predicates.is_empty() {
2636         return Some(String::new());
2637     }
2638
2639     if context.config.where_style() == Style::Rfc {
2640         return rewrite_where_clause_rfc_style(
2641             context,
2642             where_clause,
2643             shape,
2644             terminator,
2645             span_end,
2646             span_end_before_where,
2647             where_clause_option,
2648             is_args_multi_line,
2649         );
2650     }
2651
2652     let extra_indent = Indent::new(context.config.tab_spaces(), 0);
2653
2654     let offset = match context.config.where_pred_indent() {
2655         IndentStyle::Block => shape.indent + extra_indent.block_indent(context.config),
2656         // 6 = "where ".len()
2657         IndentStyle::Visual => shape.indent + extra_indent + 6,
2658     };
2659     // FIXME: if where_pred_indent != Visual, then the budgets below might
2660     // be out by a char or two.
2661
2662     let budget = context.config.max_width() - offset.width();
2663     let span_start = where_clause.predicates[0].span().lo();
2664     // If we don't have the start of the next span, then use the end of the
2665     // predicates, but that means we miss comments.
2666     let len = where_clause.predicates.len();
2667     let end_of_preds = where_clause.predicates[len - 1].span().hi();
2668     let span_end = span_end.unwrap_or(end_of_preds);
2669     let items = itemize_list(
2670         context.codemap,
2671         where_clause.predicates.iter(),
2672         terminator,
2673         |pred| pred.span().lo(),
2674         |pred| pred.span().hi(),
2675         |pred| pred.rewrite(context, Shape::legacy(budget, offset)),
2676         span_start,
2677         span_end,
2678         false,
2679     );
2680     let item_vec = items.collect::<Vec<_>>();
2681     // FIXME: we don't need to collect here if the where_layout isn't
2682     // HorizontalVertical.
2683     let tactic = definitive_tactic(
2684         &item_vec,
2685         context.config.where_layout(),
2686         Separator::Comma,
2687         budget,
2688     );
2689
2690     let mut comma_tactic = context.config.trailing_comma();
2691     // Kind of a hack because we don't usually have trailing commas in where clauses.
2692     if comma_tactic == SeparatorTactic::Vertical || where_clause_option.suppress_comma {
2693         comma_tactic = SeparatorTactic::Never;
2694     }
2695
2696     let fmt = ListFormatting {
2697         tactic: tactic,
2698         separator: ",",
2699         trailing_separator: comma_tactic,
2700         separator_place: SeparatorPlace::Back,
2701         shape: Shape::legacy(budget, offset),
2702         ends_with_newline: tactic.ends_with_newline(context.config.where_pred_indent()),
2703         preserve_newline: true,
2704         config: context.config,
2705     };
2706     let preds_str = write_list(&item_vec, &fmt)?;
2707
2708     let end_length = if terminator == "{" {
2709         // If the brace is on the next line we don't need to count it otherwise it needs two
2710         // characters " {"
2711         match brace_style {
2712             BraceStyle::AlwaysNextLine | BraceStyle::SameLineWhere => 0,
2713             BraceStyle::PreferSameLine => 2,
2714         }
2715     } else if terminator == "=" {
2716         2
2717     } else {
2718         terminator.len()
2719     };
2720     if density == Density::Tall || preds_str.contains('\n')
2721         || shape.indent.width() + " where ".len() + preds_str.len() + end_length > shape.width
2722     {
2723         Some(format!(
2724             "\n{}where {}",
2725             (shape.indent + extra_indent).to_string(context.config),
2726             preds_str
2727         ))
2728     } else {
2729         Some(format!(" where {}", preds_str))
2730     }
2731 }
2732
2733 fn missing_span_before_after_where(
2734     before_item_span_end: BytePos,
2735     where_clause: &ast::WhereClause,
2736 ) -> (Span, Span) {
2737     let missing_span_before = mk_sp(before_item_span_end, where_clause.span.lo());
2738     // 5 = `where`
2739     let pos_after_where = where_clause.span.lo() + BytePos(5);
2740     let missing_span_after = mk_sp(pos_after_where, where_clause.predicates[0].span().lo());
2741     (missing_span_before, missing_span_after)
2742 }
2743
2744 fn rewrite_comments_before_after_where(
2745     context: &RewriteContext,
2746     span_before_where: Span,
2747     span_after_where: Span,
2748     shape: Shape,
2749 ) -> Option<(String, String)> {
2750     let before_comment = rewrite_missing_comment(span_before_where, shape, context)?;
2751     let after_comment = rewrite_missing_comment(
2752         span_after_where,
2753         shape.block_indent(context.config.tab_spaces()),
2754         context,
2755     )?;
2756     Some((before_comment, after_comment))
2757 }
2758
2759 fn format_header(item_name: &str, ident: ast::Ident, vis: &ast::Visibility) -> String {
2760     format!("{}{}{}", format_visibility(vis), item_name, ident)
2761 }
2762
2763 fn format_generics(
2764     context: &RewriteContext,
2765     generics: &ast::Generics,
2766     brace_style: BraceStyle,
2767     force_same_line_brace: bool,
2768     offset: Indent,
2769     span: Span,
2770     used_width: usize,
2771 ) -> Option<String> {
2772     let shape = Shape::legacy(context.budget(used_width + offset.width()), offset);
2773     let mut result = rewrite_generics(context, generics, shape, span)?;
2774
2775     let same_line_brace = if !generics.where_clause.predicates.is_empty() || result.contains('\n') {
2776         let budget = context.budget(last_line_used_width(&result, offset.width()));
2777         let option = WhereClauseOption::snuggled(&result);
2778         // If the generics are not parameterized then generics.span.hi() == 0,
2779         // so we use span.lo(), which is the position after `struct Foo`.
2780         let span_end_before_where = if generics.is_parameterized() {
2781             generics.span.hi()
2782         } else {
2783             span.lo()
2784         };
2785         let where_clause_str = rewrite_where_clause(
2786             context,
2787             &generics.where_clause,
2788             brace_style,
2789             Shape::legacy(budget, offset.block_only()),
2790             Density::Tall,
2791             "{",
2792             Some(span.hi()),
2793             span_end_before_where,
2794             option,
2795             false,
2796         )?;
2797         result.push_str(&where_clause_str);
2798         force_same_line_brace || brace_style == BraceStyle::PreferSameLine
2799             || (generics.where_clause.predicates.is_empty()
2800                 && trimmed_last_line_width(&result) == 1)
2801     } else {
2802         force_same_line_brace || trimmed_last_line_width(&result) == 1
2803             || brace_style != BraceStyle::AlwaysNextLine
2804     };
2805     let total_used_width = last_line_used_width(&result, used_width);
2806     let remaining_budget = context.budget(total_used_width);
2807     // If the same line brace if forced, it indicates that we are rewriting an item with empty body,
2808     // and hence we take the closer into account as well for one line budget.
2809     // We assume that the closer has the same length as the opener.
2810     let overhead = if force_same_line_brace {
2811         // 3 = ` {}`
2812         3
2813     } else {
2814         // 2 = ` {`
2815         2
2816     };
2817     let forbid_same_line_brace = overhead > remaining_budget;
2818     if !forbid_same_line_brace && same_line_brace {
2819         result.push(' ');
2820     } else {
2821         result.push('\n');
2822         result.push_str(&offset.block_only().to_string(context.config));
2823     }
2824     result.push('{');
2825
2826     Some(result)
2827 }
2828
2829 impl Rewrite for ast::ForeignItem {
2830     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
2831         let attrs_str = self.attrs.rewrite(context, shape)?;
2832         // Drop semicolon or it will be interpreted as comment.
2833         // FIXME: this may be a faulty span from libsyntax.
2834         let span = mk_sp(self.span.lo(), self.span.hi() - BytePos(1));
2835
2836         let item_str = match self.node {
2837             ast::ForeignItemKind::Fn(ref fn_decl, ref generics) => rewrite_fn_base(
2838                 context,
2839                 shape.indent,
2840                 self.ident,
2841                 &FnSig::new(fn_decl, generics, self.vis.clone()),
2842                 span,
2843                 false,
2844                 false,
2845             ).map(|(s, _)| format!("{};", s)),
2846             ast::ForeignItemKind::Static(ref ty, is_mutable) => {
2847                 // FIXME(#21): we're dropping potential comments in between the
2848                 // function keywords here.
2849                 let vis = format_visibility(&self.vis);
2850                 let mut_str = if is_mutable { "mut " } else { "" };
2851                 let prefix = format!("{}static {}{}:", vis, mut_str, self.ident);
2852                 // 1 = ;
2853                 let shape = shape.sub_width(1)?;
2854                 ty.rewrite(context, shape).map(|ty_str| {
2855                     // 1 = space between prefix and type.
2856                     let sep = if prefix.len() + ty_str.len() + 1 <= shape.width {
2857                         String::from(" ")
2858                     } else {
2859                         let nested_indent = shape.indent.block_indent(context.config);
2860                         format!("\n{}", nested_indent.to_string(context.config))
2861                     };
2862                     format!("{}{}{};", prefix, sep, ty_str)
2863                 })
2864             }
2865             ast::ForeignItemKind::Ty => {
2866                 let vis = format_visibility(&self.vis);
2867                 Some(format!("{}type {};", vis, self.ident))
2868             }
2869         }?;
2870
2871         let missing_span = if self.attrs.is_empty() {
2872             mk_sp(self.span.lo(), self.span.lo())
2873         } else {
2874             mk_sp(self.attrs[self.attrs.len() - 1].span.hi(), self.span.lo())
2875         };
2876         combine_strs_with_missing_comments(
2877             context,
2878             &attrs_str,
2879             &item_str,
2880             missing_span,
2881             shape,
2882             false,
2883         )
2884     }
2885 }