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