rustfmt-core/src/items.rs

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