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