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