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