src/items.rs

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