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::{choose_rhs, format_expr, is_empty_block, is_simple_block_stmt, rewrite_assign_rhs,
  27            rewrite_call_inner, ExprType};
  28 use lists::{definitive_tactic, itemize_list, write_list, DefinitiveListTactic, ListFormatting,
  29             ListItem, ListTactic, Separator, SeparatorPlace, SeparatorTactic};
  30 use rewrite::{Rewrite, RewriteContext};
  31 use shape::{Indent, Shape};
  32 use types::join_bounds;
  33 use utils::{colon_spaces, contains_skip, end_typaram, first_line_width, format_abi,
  34             format_constness, format_defaultness, format_mutability, format_unsafety,
  35             format_visibility, is_attributes_extendable, last_line_contains_single_line_comment,
  36             last_line_used_width, last_line_width, mk_sp, semicolon_for_expr, starts_with_newline,
  37             stmt_expr, trim_newlines, trimmed_last_line_width};
  38 use vertical::rewrite_with_alignment;
  39 use visitor::FmtVisitor;
  40
  41 fn type_annotation_separator(config: &Config) -> &str {
  42     colon_spaces(config.space_before_colon(), config.space_after_colon())
  43 }
  44
  45 // Statements of the form
  46 // let pat: ty = init;
  47 impl Rewrite for ast::Local {
  48     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  49         debug!(
  50             "Local::rewrite {:?} {} {:?}",
  51             self,
  52             shape.width,
  53             shape.indent
  54         );
  55
  56         skip_out_of_file_lines_range!(context, self.span);
  57
  58         if contains_skip(&self.attrs) {
  59             return None;
  60         }
  61
  62         let attrs_str = self.attrs.rewrite(context, shape)?;
  63         let mut result = if attrs_str.is_empty() {
  64             "let ".to_owned()
  65         } else {
  66             combine_strs_with_missing_comments(
  67                 context,
  68                 &attrs_str,
  69                 "let ",
  70                 mk_sp(
  71                     self.attrs.last().map(|a| a.span.hi()).unwrap(),
  72                     self.span.lo(),
  73                 ),
  74                 shape,
  75                 false,
  76             )?
  77         };
  78
  79         // 4 = "let ".len()
  80         let pat_shape = shape.offset_left(4)?;
  81         // 1 = ;
  82         let pat_shape = pat_shape.sub_width(1)?;
  83         let pat_str = self.pat.rewrite(context, pat_shape)?;
  84         result.push_str(&pat_str);
  85
  86         // String that is placed within the assignment pattern and expression.
  87         let infix = {
  88             let mut infix = String::with_capacity(32);
  89
  90             if let Some(ref ty) = self.ty {
  91                 let separator = type_annotation_separator(context.config);
  92                 let indent = shape.indent + last_line_width(&result) + separator.len();
  93                 // 1 = ;
  94                 let budget = shape.width.checked_sub(indent.width() + 1)?;
  95                 let rewrite = ty.rewrite(context, Shape::legacy(budget, indent))?;
  96
  97                 infix.push_str(separator);
  98                 infix.push_str(&rewrite);
  99             }
 100
 101             if self.init.is_some() {
 102                 infix.push_str(" =");
 103             }
 104
 105             infix
 106         };
 107
 108         result.push_str(&infix);
 109
 110         if let Some(ref ex) = self.init {
 111             // 1 = trailing semicolon;
 112             let nested_shape = shape.sub_width(1)?;
 113
 114             result = rewrite_assign_rhs(context, result, &**ex, nested_shape)?;
 115         }
 116
 117         result.push(';');
 118         Some(result)
 119     }
 120 }
 121
 122 // TODO convert to using rewrite style rather than visitor
 123 // TODO format modules in this style
 124 #[allow(dead_code)]
 125 struct Item<'a> {
 126     keyword: &'static str,
 127     abi: Cow<'static, str>,
 128     vis: Option<&'a ast::Visibility>,
 129     body: Vec<BodyElement<'a>>,
 130     span: Span,
 131 }
 132
 133 impl<'a> Item<'a> {
 134     fn from_foreign_mod(fm: &'a ast::ForeignMod, span: Span, config: &Config) -> Item<'a> {
 135         Item {
 136             keyword: "",
 137             abi: format_abi(fm.abi, config.force_explicit_abi(), true),
 138             vis: None,
 139             body: fm.items
 140                 .iter()
 141                 .map(|i| BodyElement::ForeignItem(i))
 142                 .collect(),
 143             span: span,
 144         }
 145     }
 146 }
 147
 148 enum BodyElement<'a> {
 149     // Stmt(&'a ast::Stmt),
 150     // Field(&'a ast::Field),
 151     // Variant(&'a ast::Variant),
 152     // Item(&'a ast::Item),
 153     ForeignItem(&'a ast::ForeignItem),
 154 }
 155
 156 /// Represents a fn's signature.
 157 pub struct FnSig<'a> {
 158     decl: &'a ast::FnDecl,
 159     generics: &'a ast::Generics,
 160     abi: abi::Abi,
 161     constness: ast::Constness,
 162     defaultness: ast::Defaultness,
 163     unsafety: ast::Unsafety,
 164     visibility: ast::Visibility,
 165 }
 166
 167 impl<'a> FnSig<'a> {
 168     pub fn new(
 169         decl: &'a ast::FnDecl,
 170         generics: &'a ast::Generics,
 171         vis: ast::Visibility,
 172     ) -> FnSig<'a> {
 173         FnSig {
 174             decl: decl,
 175             generics: generics,
 176             abi: abi::Abi::Rust,
 177             constness: ast::Constness::NotConst,
 178             defaultness: ast::Defaultness::Final,
 179             unsafety: ast::Unsafety::Normal,
 180             visibility: vis,
 181         }
 182     }
 183
 184     pub fn from_method_sig(
 185         method_sig: &'a ast::MethodSig,
 186         generics: &'a ast::Generics,
 187     ) -> FnSig<'a> {
 188         FnSig {
 189             unsafety: method_sig.unsafety,
 190             constness: method_sig.constness.node,
 191             defaultness: ast::Defaultness::Final,
 192             abi: method_sig.abi,
 193             decl: &*method_sig.decl,
 194             generics: generics,
 195             visibility: ast::Visibility::Inherited,
 196         }
 197     }
 198
 199     pub fn from_fn_kind(
 200         fn_kind: &'a visit::FnKind,
 201         generics: &'a ast::Generics,
 202         decl: &'a ast::FnDecl,
 203         defualtness: ast::Defaultness,
 204     ) -> FnSig<'a> {
 205         match *fn_kind {
 206             visit::FnKind::ItemFn(_, unsafety, constness, abi, visibility, _) => FnSig {
 207                 decl: decl,
 208                 generics: generics,
 209                 abi: abi,
 210                 constness: constness.node,
 211                 defaultness: defualtness,
 212                 unsafety: unsafety,
 213                 visibility: visibility.clone(),
 214             },
 215             visit::FnKind::Method(_, method_sig, vis, _) => {
 216                 let mut fn_sig = FnSig::from_method_sig(method_sig, generics);
 217                 fn_sig.defaultness = defualtness;
 218                 if let Some(vis) = vis {
 219                     fn_sig.visibility = vis.clone();
 220                 }
 221                 fn_sig
 222             }
 223             _ => unreachable!(),
 224         }
 225     }
 226
 227     fn to_str(&self, context: &RewriteContext) -> String {
 228         let mut result = String::with_capacity(128);
 229         // Vis defaultness constness unsafety abi.
 230         result.push_str(&*format_visibility(&self.visibility));
 231         result.push_str(format_defaultness(self.defaultness));
 232         result.push_str(format_constness(self.constness));
 233         result.push_str(format_unsafety(self.unsafety));
 234         result.push_str(&format_abi(
 235             self.abi,
 236             context.config.force_explicit_abi(),
 237             false,
 238         ));
 239         result
 240     }
 241 }
 242
 243 impl<'a> FmtVisitor<'a> {
 244     fn format_item(&mut self, item: Item) {
 245         self.buffer.push_str(&item.abi);
 246
 247         let snippet = self.snippet(item.span);
 248         let brace_pos = snippet.find_uncommented("{").unwrap();
 249
 250         self.buffer.push_str("{");
 251         if !item.body.is_empty() || contains_comment(&snippet[brace_pos..]) {
 252             // FIXME: this skips comments between the extern keyword and the opening
 253             // brace.
 254             self.last_pos = item.span.lo() + BytePos(brace_pos as u32 + 1);
 255             self.block_indent = self.block_indent.block_indent(self.config);
 256
 257             if item.body.is_empty() {
 258                 self.format_missing_no_indent(item.span.hi() - BytePos(1));
 259                 self.block_indent = self.block_indent.block_unindent(self.config);
 260
 261                 self.buffer
 262                     .push_str(&self.block_indent.to_string(self.config));
 263             } else {
 264                 for item in &item.body {
 265                     self.format_body_element(item);
 266                 }
 267
 268                 self.block_indent = self.block_indent.block_unindent(self.config);
 269                 self.format_missing_with_indent(item.span.hi() - BytePos(1));
 270             }
 271         }
 272
 273         self.buffer.push_str("}");
 274         self.last_pos = item.span.hi();
 275     }
 276
 277     fn format_body_element(&mut self, element: &BodyElement) {
 278         match *element {
 279             BodyElement::ForeignItem(item) => self.format_foreign_item(item),
 280         }
 281     }
 282
 283     pub fn format_foreign_mod(&mut self, fm: &ast::ForeignMod, span: Span) {
 284         let item = Item::from_foreign_mod(fm, span, self.config);
 285         self.format_item(item);
 286     }
 287
 288
 289     fn format_foreign_item(&mut self, item: &ast::ForeignItem) {
 290         let rewrite = item.rewrite(&self.get_context(), self.shape());
 291         self.push_rewrite(item.span(), rewrite);
 292         self.last_pos = item.span.hi();
 293     }
 294
 295     pub fn rewrite_fn(
 296         &mut self,
 297         indent: Indent,
 298         ident: ast::Ident,
 299         fn_sig: &FnSig,
 300         span: Span,
 301         block: &ast::Block,
 302     ) -> Option<String> {
 303         let context = self.get_context();
 304
 305         let 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).sub_width(1)?,
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     let mut orig_ty = field.ty.rewrite(context, ty_shape);
1484     if let Some(ref ty) = orig_ty {
1485         if !ty.contains('\n') {
1486             return Some(attr_prefix + &spacing + ty);
1487         }
1488     }
1489
1490     // We must use multiline. We are going to put attributes and a field on different lines.
1491     // 1 = " "
1492     let rhs_shape = shape.offset_left(last_line_width(&prefix) + 1)?;
1493     orig_ty = field.ty.rewrite(context, rhs_shape);
1494     let field_str = if prefix.is_empty() {
1495         orig_ty?
1496     } else {
1497         prefix + &choose_rhs(context, &*field.ty, rhs_shape, orig_ty)?
1498     };
1499     combine_strs_with_missing_comments(context, &attrs_str, &field_str, missing_span, shape, false)
1500 }
1501
1502 pub struct StaticParts<'a> {
1503     prefix: &'a str,
1504     vis: &'a ast::Visibility,
1505     ident: ast::Ident,
1506     ty: &'a ast::Ty,
1507     mutability: ast::Mutability,
1508     expr_opt: Option<&'a ptr::P<ast::Expr>>,
1509     span: Span,
1510 }
1511
1512 impl<'a> StaticParts<'a> {
1513     pub fn from_item(item: &'a ast::Item) -> Self {
1514         let (prefix, ty, mutability, expr) = match item.node {
1515             ast::ItemKind::Static(ref ty, mutability, ref expr) => ("static", ty, mutability, expr),
1516             ast::ItemKind::Const(ref ty, ref expr) => {
1517                 ("const", ty, ast::Mutability::Immutable, expr)
1518             }
1519             _ => unreachable!(),
1520         };
1521         StaticParts {
1522             prefix: prefix,
1523             vis: &item.vis,
1524             ident: item.ident,
1525             ty: ty,
1526             mutability: mutability,
1527             expr_opt: Some(expr),
1528             span: item.span,
1529         }
1530     }
1531
1532     pub fn from_trait_item(ti: &'a ast::TraitItem) -> Self {
1533         let (ty, expr_opt) = match ti.node {
1534             ast::TraitItemKind::Const(ref ty, ref expr_opt) => (ty, expr_opt),
1535             _ => unreachable!(),
1536         };
1537         StaticParts {
1538             prefix: "const",
1539             vis: &ast::Visibility::Inherited,
1540             ident: ti.ident,
1541             ty: ty,
1542             mutability: ast::Mutability::Immutable,
1543             expr_opt: expr_opt.as_ref(),
1544             span: ti.span,
1545         }
1546     }
1547
1548     pub fn from_impl_item(ii: &'a ast::ImplItem) -> Self {
1549         let (ty, expr) = match ii.node {
1550             ast::ImplItemKind::Const(ref ty, ref expr) => (ty, expr),
1551             _ => unreachable!(),
1552         };
1553         StaticParts {
1554             prefix: "const",
1555             vis: &ii.vis,
1556             ident: ii.ident,
1557             ty: ty,
1558             mutability: ast::Mutability::Immutable,
1559             expr_opt: Some(expr),
1560             span: ii.span,
1561         }
1562     }
1563 }
1564
1565 fn rewrite_static(
1566     context: &RewriteContext,
1567     static_parts: &StaticParts,
1568     offset: Indent,
1569 ) -> Option<String> {
1570     let colon = colon_spaces(
1571         context.config.space_before_colon(),
1572         context.config.space_after_colon(),
1573     );
1574     let prefix = format!(
1575         "{}{} {}{}{}",
1576         format_visibility(static_parts.vis),
1577         static_parts.prefix,
1578         format_mutability(static_parts.mutability),
1579         static_parts.ident,
1580         colon,
1581     );
1582     // 2 = " =".len()
1583     let ty_shape =
1584         Shape::indented(offset.block_only(), context.config).offset_left(prefix.len() + 2)?;
1585     let ty_str = static_parts.ty.rewrite(context, ty_shape)?;
1586
1587     if let Some(expr) = static_parts.expr_opt {
1588         let lhs = format!("{}{} =", prefix, ty_str);
1589         // 1 = ;
1590         let remaining_width = context.budget(offset.block_indent + 1);
1591         rewrite_assign_rhs(
1592             context,
1593             lhs,
1594             &**expr,
1595             Shape::legacy(remaining_width, offset.block_only()),
1596         ).and_then(|res| {
1597             recover_comment_removed(res, static_parts.span, context)
1598         })
1599             .map(|s| if s.ends_with(';') { s } else { s + ";" })
1600     } else {
1601         Some(format!("{}{};", prefix, ty_str))
1602     }
1603 }
1604
1605 pub fn rewrite_associated_type(
1606     ident: ast::Ident,
1607     ty_opt: Option<&ptr::P<ast::Ty>>,
1608     ty_param_bounds_opt: Option<&ast::TyParamBounds>,
1609     context: &RewriteContext,
1610     indent: Indent,
1611 ) -> Option<String> {
1612     let prefix = format!("type {}", ident);
1613
1614     let type_bounds_str = if let Some(ref bounds) = ty_param_bounds_opt {
1615         // 2 = ": ".len()
1616         let shape = Shape::indented(indent, context.config).offset_left(prefix.len() + 2)?;
1617         let bound_str = bounds
1618             .iter()
1619             .map(|ty_bound| ty_bound.rewrite(context, shape))
1620             .collect::<Option<Vec<_>>>()?;
1621         if !bounds.is_empty() {
1622             format!(": {}", join_bounds(context, shape, &bound_str))
1623         } else {
1624             String::new()
1625         }
1626     } else {
1627         String::new()
1628     };
1629
1630     if let Some(ty) = ty_opt {
1631         // 1 = `;`
1632         let shape = Shape::indented(indent, context.config).sub_width(1)?;
1633         let lhs = format!("{}{} =", prefix, type_bounds_str);
1634         rewrite_assign_rhs(context, lhs, &**ty, shape).map(|s| s + ";")
1635     } else {
1636         Some(format!("{}{};", prefix, type_bounds_str))
1637     }
1638 }
1639
1640 pub fn rewrite_associated_impl_type(
1641     ident: ast::Ident,
1642     defaultness: ast::Defaultness,
1643     ty_opt: Option<&ptr::P<ast::Ty>>,
1644     ty_param_bounds_opt: Option<&ast::TyParamBounds>,
1645     context: &RewriteContext,
1646     indent: Indent,
1647 ) -> Option<String> {
1648     let result = rewrite_associated_type(ident, ty_opt, ty_param_bounds_opt, context, indent)?;
1649
1650     match defaultness {
1651         ast::Defaultness::Default => Some(format!("default {}", result)),
1652         _ => Some(result),
1653     }
1654 }
1655
1656 impl Rewrite for ast::FunctionRetTy {
1657     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1658         match *self {
1659             ast::FunctionRetTy::Default(_) => Some(String::new()),
1660             ast::FunctionRetTy::Ty(ref ty) => {
1661                 let inner_width = shape.width.checked_sub(3)?;
1662                 ty.rewrite(context, Shape::legacy(inner_width, shape.indent + 3))
1663                     .map(|r| format!("-> {}", r))
1664             }
1665         }
1666     }
1667 }
1668
1669 fn is_empty_infer(context: &RewriteContext, ty: &ast::Ty) -> bool {
1670     match ty.node {
1671         ast::TyKind::Infer => {
1672             let original = context.snippet(ty.span);
1673             original != "_"
1674         }
1675         _ => false,
1676     }
1677 }
1678
1679 impl Rewrite for ast::Arg {
1680     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1681         if is_named_arg(self) {
1682             let mut result = self.pat
1683                 .rewrite(context, Shape::legacy(shape.width, shape.indent))?;
1684
1685             if !is_empty_infer(context, &*self.ty) {
1686                 if context.config.space_before_colon() {
1687                     result.push_str(" ");
1688                 }
1689                 result.push_str(":");
1690                 if context.config.space_after_colon() {
1691                     result.push_str(" ");
1692                 }
1693                 let overhead = last_line_width(&result);
1694                 let max_width = shape.width.checked_sub(overhead)?;
1695                 let ty_str = self.ty
1696                     .rewrite(context, Shape::legacy(max_width, shape.indent))?;
1697                 result.push_str(&ty_str);
1698             }
1699
1700             Some(result)
1701         } else {
1702             self.ty.rewrite(context, shape)
1703         }
1704     }
1705 }
1706
1707 fn rewrite_explicit_self(
1708     explicit_self: &ast::ExplicitSelf,
1709     args: &[ast::Arg],
1710     context: &RewriteContext,
1711 ) -> Option<String> {
1712     match explicit_self.node {
1713         ast::SelfKind::Region(lt, m) => {
1714             let mut_str = format_mutability(m);
1715             match lt {
1716                 Some(ref l) => {
1717                     let lifetime_str = l.rewrite(
1718                         context,
1719                         Shape::legacy(context.config.max_width(), Indent::empty()),
1720                     )?;
1721                     Some(format!("&{} {}self", lifetime_str, mut_str))
1722                 }
1723                 None => Some(format!("&{}self", mut_str)),
1724             }
1725         }
1726         ast::SelfKind::Explicit(ref ty, _) => {
1727             assert!(!args.is_empty(), "&[ast::Arg] shouldn't be empty.");
1728
1729             let mutability = explicit_self_mutability(&args[0]);
1730             let type_str = ty.rewrite(
1731                 context,
1732                 Shape::legacy(context.config.max_width(), Indent::empty()),
1733             )?;
1734
1735             Some(format!(
1736                 "{}self: {}",
1737                 format_mutability(mutability),
1738                 type_str
1739             ))
1740         }
1741         ast::SelfKind::Value(_) => {
1742             assert!(!args.is_empty(), "&[ast::Arg] shouldn't be empty.");
1743
1744             let mutability = explicit_self_mutability(&args[0]);
1745
1746             Some(format!("{}self", format_mutability(mutability)))
1747         }
1748     }
1749 }
1750
1751 // Hacky solution caused by absence of `Mutability` in `SelfValue` and
1752 // `SelfExplicit` variants of `ast::ExplicitSelf_`.
1753 fn explicit_self_mutability(arg: &ast::Arg) -> ast::Mutability {
1754     if let ast::PatKind::Ident(ast::BindingMode::ByValue(mutability), _, _) = arg.pat.node {
1755         mutability
1756     } else {
1757         unreachable!()
1758     }
1759 }
1760
1761 pub fn span_lo_for_arg(arg: &ast::Arg) -> BytePos {
1762     if is_named_arg(arg) {
1763         arg.pat.span.lo()
1764     } else {
1765         arg.ty.span.lo()
1766     }
1767 }
1768
1769 pub fn span_hi_for_arg(context: &RewriteContext, arg: &ast::Arg) -> BytePos {
1770     match arg.ty.node {
1771         ast::TyKind::Infer if context.snippet(arg.ty.span) == "_" => arg.ty.span.hi(),
1772         ast::TyKind::Infer if is_named_arg(arg) => arg.pat.span.hi(),
1773         _ => arg.ty.span.hi(),
1774     }
1775 }
1776
1777 pub fn is_named_arg(arg: &ast::Arg) -> bool {
1778     if let ast::PatKind::Ident(_, ident, _) = arg.pat.node {
1779         ident.node != symbol::keywords::Invalid.ident()
1780     } else {
1781         true
1782     }
1783 }
1784
1785 // Return type is (result, force_new_line_for_brace)
1786 fn rewrite_fn_base(
1787     context: &RewriteContext,
1788     indent: Indent,
1789     ident: ast::Ident,
1790     fn_sig: &FnSig,
1791     span: Span,
1792     newline_brace: bool,
1793     has_body: bool,
1794 ) -> Option<(String, bool)> {
1795     let mut force_new_line_for_brace = false;
1796
1797     let where_clause = &fn_sig.generics.where_clause;
1798
1799     let mut result = String::with_capacity(1024);
1800     result.push_str(&fn_sig.to_str(context));
1801
1802     // fn foo
1803     result.push_str("fn ");
1804     result.push_str(&ident.to_string());
1805
1806     // Generics.
1807     let overhead = if has_body && !newline_brace {
1808         // 4 = `() {`
1809         4
1810     } else {
1811         // 2 = `()`
1812         2
1813     };
1814     let used_width = last_line_used_width(&result, indent.width());
1815     let one_line_budget = context.budget(used_width + overhead);
1816     let shape = Shape {
1817         width: one_line_budget,
1818         indent: indent,
1819         offset: used_width,
1820     };
1821     let fd = fn_sig.decl;
1822     let g_span = mk_sp(span.lo(), fd.output.span().lo());
1823     let generics_str = rewrite_generics(context, fn_sig.generics, shape, g_span)?;
1824     result.push_str(&generics_str);
1825
1826     let snuggle_angle_bracket = generics_str
1827         .lines()
1828         .last()
1829         .map_or(false, |l| l.trim_left().len() == 1);
1830
1831     // Note that the width and indent don't really matter, we'll re-layout the
1832     // return type later anyway.
1833     let ret_str = fd.output
1834         .rewrite(context, Shape::indented(indent, context.config))?;
1835
1836     let multi_line_ret_str = ret_str.contains('\n');
1837     let ret_str_len = if multi_line_ret_str { 0 } else { ret_str.len() };
1838
1839     // Args.
1840     let (one_line_budget, multi_line_budget, mut arg_indent) = compute_budgets_for_args(
1841         context,
1842         &result,
1843         indent,
1844         ret_str_len,
1845         newline_brace,
1846         has_body,
1847         multi_line_ret_str,
1848     )?;
1849
1850     debug!(
1851         "rewrite_fn_base: one_line_budget: {}, multi_line_budget: {}, arg_indent: {:?}",
1852         one_line_budget,
1853         multi_line_budget,
1854         arg_indent
1855     );
1856
1857     // Check if vertical layout was forced.
1858     if one_line_budget == 0 {
1859         if snuggle_angle_bracket {
1860             result.push('(');
1861         } else if context.config.fn_args_paren_newline() {
1862             result.push('\n');
1863             result.push_str(&arg_indent.to_string(context.config));
1864             if context.config.indent_style() == IndentStyle::Visual {
1865                 arg_indent = arg_indent + 1; // extra space for `(`
1866             }
1867             result.push('(');
1868         } else {
1869             result.push_str("(");
1870             if context.config.indent_style() == IndentStyle::Visual {
1871                 result.push('\n');
1872                 result.push_str(&arg_indent.to_string(context.config));
1873             }
1874         }
1875     } else {
1876         result.push('(');
1877     }
1878     if context.config.spaces_within_parens_and_brackets() && !fd.inputs.is_empty()
1879         && result.ends_with('(')
1880     {
1881         result.push(' ')
1882     }
1883
1884     // Skip `pub(crate)`.
1885     let lo_after_visibility = get_bytepos_after_visibility(context, &fn_sig.visibility, span, ")");
1886     // A conservative estimation, to goal is to be over all parens in generics
1887     let args_start = fn_sig
1888         .generics
1889         .ty_params
1890         .last()
1891         .map_or(lo_after_visibility, |tp| end_typaram(tp));
1892     let args_end = if fd.inputs.is_empty() {
1893         context
1894             .codemap
1895             .span_after(mk_sp(args_start, span.hi()), ")")
1896     } else {
1897         let last_span = mk_sp(fd.inputs[fd.inputs.len() - 1].span().hi(), span.hi());
1898         context.codemap.span_after(last_span, ")")
1899     };
1900     let args_span = mk_sp(
1901         context
1902             .codemap
1903             .span_after(mk_sp(args_start, span.hi()), "("),
1904         args_end,
1905     );
1906     let arg_str = rewrite_args(
1907         context,
1908         &fd.inputs,
1909         fd.get_self().as_ref(),
1910         one_line_budget,
1911         multi_line_budget,
1912         indent,
1913         arg_indent,
1914         args_span,
1915         fd.variadic,
1916         generics_str.contains('\n'),
1917     )?;
1918
1919     let put_args_in_block = match context.config.indent_style() {
1920         IndentStyle::Block => arg_str.contains('\n') || arg_str.len() > one_line_budget,
1921         _ => false,
1922     } && !fd.inputs.is_empty();
1923
1924     let mut args_last_line_contains_comment = false;
1925     if put_args_in_block {
1926         arg_indent = indent.block_indent(context.config);
1927         result.push('\n');
1928         result.push_str(&arg_indent.to_string(context.config));
1929         result.push_str(&arg_str);
1930         result.push('\n');
1931         result.push_str(&indent.to_string(context.config));
1932         result.push(')');
1933     } else {
1934         result.push_str(&arg_str);
1935         let used_width = last_line_used_width(&result, indent.width()) + first_line_width(&ret_str);
1936         // Put the closing brace on the next line if it overflows the max width.
1937         // 1 = `)`
1938         if fd.inputs.is_empty() && used_width + 1 > context.config.max_width() {
1939             result.push('\n');
1940         }
1941         if context.config.spaces_within_parens_and_brackets() && !fd.inputs.is_empty() {
1942             result.push(' ')
1943         }
1944         // If the last line of args contains comment, we cannot put the closing paren
1945         // on the same line.
1946         if arg_str
1947             .lines()
1948             .last()
1949             .map_or(false, |last_line| last_line.contains("//"))
1950         {
1951             args_last_line_contains_comment = true;
1952             result.push('\n');
1953             result.push_str(&arg_indent.to_string(context.config));
1954         }
1955         result.push(')');
1956     }
1957
1958     // Return type.
1959     if let ast::FunctionRetTy::Ty(..) = fd.output {
1960         let ret_should_indent = match context.config.indent_style() {
1961             // If our args are block layout then we surely must have space.
1962             IndentStyle::Block if put_args_in_block || fd.inputs.is_empty() => false,
1963             _ if args_last_line_contains_comment => false,
1964             _ if result.contains('\n') || multi_line_ret_str => true,
1965             _ => {
1966                 // If the return type would push over the max width, then put the return type on
1967                 // a new line. With the +1 for the signature length an additional space between
1968                 // the closing parenthesis of the argument and the arrow '->' is considered.
1969                 let mut sig_length = result.len() + indent.width() + ret_str_len + 1;
1970
1971                 // If there is no where clause, take into account the space after the return type
1972                 // and the brace.
1973                 if where_clause.predicates.is_empty() {
1974                     sig_length += 2;
1975                 }
1976
1977                 sig_length > context.config.max_width()
1978             }
1979         };
1980         let ret_indent = if ret_should_indent {
1981             let indent = match context.config.fn_return_indent() {
1982                 ReturnIndent::WithWhereClause => indent + 4,
1983                 // Aligning with non-existent args looks silly.
1984                 _ if arg_str.is_empty() => {
1985                     force_new_line_for_brace = true;
1986                     indent + 4
1987                 }
1988                 // FIXME: we might want to check that using the arg indent
1989                 // doesn't blow our budget, and if it does, then fallback to
1990                 // the where clause indent.
1991                 _ => arg_indent,
1992             };
1993
1994             result.push('\n');
1995             result.push_str(&indent.to_string(context.config));
1996             indent
1997         } else {
1998             result.push(' ');
1999             Indent::new(indent.block_indent, last_line_width(&result))
2000         };
2001
2002         if multi_line_ret_str || ret_should_indent {
2003             // Now that we know the proper indent and width, we need to
2004             // re-layout the return type.
2005             let ret_str = fd.output
2006                 .rewrite(context, Shape::indented(ret_indent, context.config))?;
2007             result.push_str(&ret_str);
2008         } else {
2009             result.push_str(&ret_str);
2010         }
2011
2012         // Comment between return type and the end of the decl.
2013         let snippet_lo = fd.output.span().hi();
2014         if where_clause.predicates.is_empty() {
2015             let snippet_hi = span.hi();
2016             let snippet = context.snippet(mk_sp(snippet_lo, snippet_hi));
2017             // Try to preserve the layout of the original snippet.
2018             let original_starts_with_newline = snippet
2019                 .find(|c| c != ' ')
2020                 .map_or(false, |i| starts_with_newline(&snippet[i..]));
2021             let original_ends_with_newline = snippet
2022                 .rfind(|c| c != ' ')
2023                 .map_or(false, |i| snippet[i..].ends_with('\n'));
2024             let snippet = snippet.trim();
2025             if !snippet.is_empty() {
2026                 result.push(if original_starts_with_newline {
2027                     '\n'
2028                 } else {
2029                     ' '
2030                 });
2031                 result.push_str(snippet);
2032                 if original_ends_with_newline {
2033                     force_new_line_for_brace = true;
2034                 }
2035             }
2036         }
2037     }
2038
2039     let should_compress_where = match context.config.where_density() {
2040         Density::Compressed => !result.contains('\n'),
2041         Density::CompressedIfEmpty => !has_body && !result.contains('\n'),
2042         _ => false,
2043     };
2044
2045     let pos_before_where = match fd.output {
2046         ast::FunctionRetTy::Default(..) => args_span.hi(),
2047         ast::FunctionRetTy::Ty(ref ty) => ty.span.hi(),
2048     };
2049
2050     let is_args_multi_lined = arg_str.contains('\n');
2051
2052     if where_clause.predicates.len() == 1 && should_compress_where {
2053         let budget = context.budget(last_line_used_width(&result, indent.width()));
2054         if let Some(where_clause_str) = rewrite_where_clause(
2055             context,
2056             where_clause,
2057             context.config.brace_style(),
2058             Shape::legacy(budget, indent),
2059             Density::Compressed,
2060             "{",
2061             Some(span.hi()),
2062             pos_before_where,
2063             WhereClauseOption::compressed(),
2064             is_args_multi_lined,
2065         ) {
2066             result.push_str(&where_clause_str);
2067             force_new_line_for_brace |= last_line_contains_single_line_comment(&result);
2068             return Some((result, force_new_line_for_brace));
2069         }
2070     }
2071
2072     let option = WhereClauseOption::new(!has_body, put_args_in_block && ret_str.is_empty());
2073     let where_clause_str = rewrite_where_clause(
2074         context,
2075         where_clause,
2076         context.config.brace_style(),
2077         Shape::indented(indent, context.config),
2078         Density::Tall,
2079         "{",
2080         Some(span.hi()),
2081         pos_before_where,
2082         option,
2083         is_args_multi_lined,
2084     )?;
2085     // If there are neither where clause nor return type, we may be missing comments between
2086     // args and `{`.
2087     if where_clause_str.is_empty() {
2088         if let ast::FunctionRetTy::Default(ret_span) = fd.output {
2089             match recover_missing_comment_in_span(
2090                 mk_sp(args_span.hi(), ret_span.hi()),
2091                 shape,
2092                 context,
2093                 last_line_width(&result),
2094             ) {
2095                 Some(ref missing_comment) if !missing_comment.is_empty() => {
2096                     result.push_str(missing_comment);
2097                     force_new_line_for_brace = true;
2098                 }
2099                 _ => (),
2100             }
2101         }
2102     }
2103
2104     result.push_str(&where_clause_str);
2105
2106     force_new_line_for_brace |= last_line_contains_single_line_comment(&result);
2107     force_new_line_for_brace |= is_args_multi_lined && context.config.where_single_line();
2108     Some((result, force_new_line_for_brace))
2109 }
2110
2111 #[derive(Copy, Clone)]
2112 struct WhereClauseOption {
2113     suppress_comma: bool, // Force no trailing comma
2114     snuggle: bool,        // Do not insert newline before `where`
2115     compress_where: bool, // Try single line where clause instead of vertical layout
2116 }
2117
2118 impl WhereClauseOption {
2119     pub fn new(suppress_comma: bool, snuggle: bool) -> WhereClauseOption {
2120         WhereClauseOption {
2121             suppress_comma: suppress_comma,
2122             snuggle: snuggle,
2123             compress_where: false,
2124         }
2125     }
2126
2127     pub fn compressed() -> WhereClauseOption {
2128         WhereClauseOption {
2129             suppress_comma: true,
2130             snuggle: false,
2131             compress_where: true,
2132         }
2133     }
2134
2135     pub fn snuggled(current: &str) -> WhereClauseOption {
2136         WhereClauseOption {
2137             suppress_comma: false,
2138             snuggle: trimmed_last_line_width(current) == 1,
2139             compress_where: false,
2140         }
2141     }
2142 }
2143
2144 fn rewrite_args(
2145     context: &RewriteContext,
2146     args: &[ast::Arg],
2147     explicit_self: Option<&ast::ExplicitSelf>,
2148     one_line_budget: usize,
2149     multi_line_budget: usize,
2150     indent: Indent,
2151     arg_indent: Indent,
2152     span: Span,
2153     variadic: bool,
2154     generics_str_contains_newline: bool,
2155 ) -> Option<String> {
2156     let mut arg_item_strs = args.iter()
2157         .map(|arg| {
2158             arg.rewrite(context, Shape::legacy(multi_line_budget, arg_indent))
2159         })
2160         .collect::<Option<Vec<_>>>()?;
2161
2162     // Account for sugary self.
2163     // FIXME: the comment for the self argument is dropped. This is blocked
2164     // on rust issue #27522.
2165     let min_args = explicit_self
2166         .and_then(|explicit_self| {
2167             rewrite_explicit_self(explicit_self, args, context)
2168         })
2169         .map_or(1, |self_str| {
2170             arg_item_strs[0] = self_str;
2171             2
2172         });
2173
2174     // Comments between args.
2175     let mut arg_items = Vec::new();
2176     if min_args == 2 {
2177         arg_items.push(ListItem::from_str(""));
2178     }
2179
2180     // FIXME(#21): if there are no args, there might still be a comment, but
2181     // without spans for the comment or parens, there is no chance of
2182     // getting it right. You also don't get to put a comment on self, unless
2183     // it is explicit.
2184     if args.len() >= min_args || variadic {
2185         let comment_span_start = if min_args == 2 {
2186             let second_arg_start = if arg_has_pattern(&args[1]) {
2187                 args[1].pat.span.lo()
2188             } else {
2189                 args[1].ty.span.lo()
2190             };
2191             let reduced_span = mk_sp(span.lo(), second_arg_start);
2192
2193             context.codemap.span_after_last(reduced_span, ",")
2194         } else {
2195             span.lo()
2196         };
2197
2198         enum ArgumentKind<'a> {
2199             Regular(&'a ast::Arg),
2200             Variadic(BytePos),
2201         }
2202
2203         let variadic_arg = if variadic {
2204             let variadic_span = mk_sp(args.last().unwrap().ty.span.hi(), span.hi());
2205             let variadic_start = context.codemap.span_after(variadic_span, "...") - BytePos(3);
2206             Some(ArgumentKind::Variadic(variadic_start))
2207         } else {
2208             None
2209         };
2210
2211         let more_items = itemize_list(
2212             context.codemap,
2213             args[min_args - 1..]
2214                 .iter()
2215                 .map(ArgumentKind::Regular)
2216                 .chain(variadic_arg),
2217             ")",
2218             |arg| match *arg {
2219                 ArgumentKind::Regular(arg) => span_lo_for_arg(arg),
2220                 ArgumentKind::Variadic(start) => start,
2221             },
2222             |arg| match *arg {
2223                 ArgumentKind::Regular(arg) => arg.ty.span.hi(),
2224                 ArgumentKind::Variadic(start) => start + BytePos(3),
2225             },
2226             |arg| match *arg {
2227                 ArgumentKind::Regular(..) => None,
2228                 ArgumentKind::Variadic(..) => Some("...".to_owned()),
2229             },
2230             comment_span_start,
2231             span.hi(),
2232             false,
2233         );
2234
2235         arg_items.extend(more_items);
2236     }
2237
2238     let fits_in_one_line = !generics_str_contains_newline
2239         && (arg_items.is_empty()
2240             || arg_items.len() == 1 && arg_item_strs[0].len() <= one_line_budget);
2241
2242     for (item, arg) in arg_items.iter_mut().zip(arg_item_strs) {
2243         item.item = Some(arg);
2244     }
2245
2246     let last_line_ends_with_comment = arg_items
2247         .iter()
2248         .last()
2249         .and_then(|item| item.post_comment.as_ref())
2250         .map_or(false, |s| s.trim().starts_with("//"));
2251
2252     let (indent, trailing_comma) = match context.config.indent_style() {
2253         IndentStyle::Block if fits_in_one_line => {
2254             (indent.block_indent(context.config), SeparatorTactic::Never)
2255         }
2256         IndentStyle::Block => (
2257             indent.block_indent(context.config),
2258             context.config.trailing_comma(),
2259         ),
2260         IndentStyle::Visual if last_line_ends_with_comment => {
2261             (arg_indent, context.config.trailing_comma())
2262         }
2263         IndentStyle::Visual => (arg_indent, SeparatorTactic::Never),
2264     };
2265
2266     let tactic = definitive_tactic(
2267         &arg_items,
2268         context.config.fn_args_density().to_list_tactic(),
2269         Separator::Comma,
2270         one_line_budget,
2271     );
2272     let budget = match tactic {
2273         DefinitiveListTactic::Horizontal => one_line_budget,
2274         _ => multi_line_budget,
2275     };
2276
2277     debug!("rewrite_args: budget: {}, tactic: {:?}", budget, tactic);
2278
2279     let fmt = ListFormatting {
2280         tactic: tactic,
2281         separator: ",",
2282         trailing_separator: if variadic {
2283             SeparatorTactic::Never
2284         } else {
2285             trailing_comma
2286         },
2287         separator_place: SeparatorPlace::Back,
2288         shape: Shape::legacy(budget, indent),
2289         ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
2290         preserve_newline: true,
2291         config: context.config,
2292     };
2293
2294     write_list(&arg_items, &fmt)
2295 }
2296
2297 fn arg_has_pattern(arg: &ast::Arg) -> bool {
2298     if let ast::PatKind::Ident(_, ident, _) = arg.pat.node {
2299         ident.node != symbol::keywords::Invalid.ident()
2300     } else {
2301         true
2302     }
2303 }
2304
2305 fn compute_budgets_for_args(
2306     context: &RewriteContext,
2307     result: &str,
2308     indent: Indent,
2309     ret_str_len: usize,
2310     newline_brace: bool,
2311     has_braces: bool,
2312     force_vertical_layout: bool,
2313 ) -> Option<((usize, usize, Indent))> {
2314     debug!(
2315         "compute_budgets_for_args {} {:?}, {}, {}",
2316         result.len(),
2317         indent,
2318         ret_str_len,
2319         newline_brace
2320     );
2321     // Try keeping everything on the same line.
2322     if !result.contains('\n') && !force_vertical_layout {
2323         // 2 = `()`, 3 = `() `, space is before ret_string.
2324         let overhead = if ret_str_len == 0 { 2 } else { 3 };
2325         let mut used_space = indent.width() + result.len() + ret_str_len + overhead;
2326         if has_braces {
2327             if !newline_brace {
2328                 // 2 = `{}`
2329                 used_space += 2;
2330             }
2331         } else {
2332             // 1 = `;`
2333             used_space += 1;
2334         }
2335         let one_line_budget = context.budget(used_space);
2336
2337         if one_line_budget > 0 {
2338             // 4 = "() {".len()
2339             let (indent, multi_line_budget) = match context.config.indent_style() {
2340                 IndentStyle::Block => {
2341                     let indent = indent.block_indent(context.config);
2342                     (indent, context.budget(indent.width() + 1))
2343                 }
2344                 IndentStyle::Visual => {
2345                     let indent = indent + result.len() + 1;
2346                     let multi_line_overhead = indent.width() + if newline_brace { 2 } else { 4 };
2347                     (indent, context.budget(multi_line_overhead))
2348                 }
2349             };
2350
2351             return Some((one_line_budget, multi_line_budget, indent));
2352         }
2353     }
2354
2355     // Didn't work. we must force vertical layout and put args on a newline.
2356     let new_indent = indent.block_indent(context.config);
2357     let used_space = match context.config.indent_style() {
2358         // 1 = `,`
2359         IndentStyle::Block => new_indent.width() + 1,
2360         // Account for `)` and possibly ` {`.
2361         IndentStyle::Visual => new_indent.width() + if ret_str_len == 0 { 1 } else { 3 },
2362     };
2363     Some((0, context.budget(used_space), new_indent))
2364 }
2365
2366 fn newline_for_brace(config: &Config, where_clause: &ast::WhereClause, has_body: bool) -> bool {
2367     let predicate_count = where_clause.predicates.len();
2368
2369     if config.where_single_line() && predicate_count == 1 {
2370         return false;
2371     }
2372     match (config.brace_style(), config.where_density()) {
2373         (BraceStyle::AlwaysNextLine, _) => true,
2374         (_, Density::Compressed) if predicate_count == 1 => false,
2375         (_, Density::CompressedIfEmpty) if predicate_count == 1 && !has_body => false,
2376         (BraceStyle::SameLineWhere, _) if predicate_count > 0 => true,
2377         _ => false,
2378     }
2379 }
2380
2381 fn rewrite_generics(
2382     context: &RewriteContext,
2383     generics: &ast::Generics,
2384     shape: Shape,
2385     span: Span,
2386 ) -> Option<String> {
2387     let g_shape = generics_shape_from_config(context.config, shape, 0)?;
2388     let one_line_width = shape.width.checked_sub(2).unwrap_or(0);
2389     rewrite_generics_inner(context, generics, g_shape, one_line_width, span).or_else(|| {
2390         rewrite_generics_inner(context, generics, g_shape, 0, span)
2391     })
2392 }
2393
2394 fn rewrite_generics_inner(
2395     context: &RewriteContext,
2396     generics: &ast::Generics,
2397     shape: Shape,
2398     one_line_width: usize,
2399     span: Span,
2400 ) -> Option<String> {
2401     // FIXME: convert bounds to where clauses where they get too big or if
2402     // there is a where clause at all.
2403
2404     // Wrapper type
2405     enum GenericsArg<'a> {
2406         Lifetime(&'a ast::LifetimeDef),
2407         TyParam(&'a ast::TyParam),
2408     }
2409     impl<'a> Rewrite for GenericsArg<'a> {
2410         fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
2411             match *self {
2412                 GenericsArg::Lifetime(lifetime) => lifetime.rewrite(context, shape),
2413                 GenericsArg::TyParam(ty) => ty.rewrite(context, shape),
2414             }
2415         }
2416     }
2417     impl<'a> Spanned for GenericsArg<'a> {
2418         fn span(&self) -> Span {
2419             match *self {
2420                 GenericsArg::Lifetime(lifetime) => lifetime.span(),
2421                 GenericsArg::TyParam(ty) => ty.span(),
2422             }
2423         }
2424     }
2425
2426     if generics.lifetimes.is_empty() && generics.ty_params.is_empty() {
2427         return Some(String::new());
2428     }
2429
2430     let generics_args = generics
2431         .lifetimes
2432         .iter()
2433         .map(|lt| GenericsArg::Lifetime(lt))
2434         .chain(generics.ty_params.iter().map(|ty| GenericsArg::TyParam(ty)));
2435     let items = itemize_list(
2436         context.codemap,
2437         generics_args,
2438         ">",
2439         |arg| arg.span().lo(),
2440         |arg| arg.span().hi(),
2441         |arg| arg.rewrite(context, shape),
2442         context.codemap.span_after(span, "<"),
2443         span.hi(),
2444         false,
2445     );
2446     format_generics_item_list(context, items, shape, one_line_width)
2447 }
2448
2449 pub fn generics_shape_from_config(config: &Config, shape: Shape, offset: usize) -> Option<Shape> {
2450     match config.indent_style() {
2451         IndentStyle::Visual => shape.visual_indent(1 + offset).sub_width(offset + 2),
2452         IndentStyle::Block => {
2453             // 1 = ","
2454             shape
2455                 .block()
2456                 .block_indent(config.tab_spaces())
2457                 .with_max_width(config)
2458                 .sub_width(1)
2459         }
2460     }
2461 }
2462
2463 pub fn format_generics_item_list<I>(
2464     context: &RewriteContext,
2465     items: I,
2466     shape: Shape,
2467     one_line_budget: usize,
2468 ) -> Option<String>
2469 where
2470     I: Iterator<Item = ListItem>,
2471 {
2472     let item_vec = items.collect::<Vec<_>>();
2473
2474     let tactic = definitive_tactic(
2475         &item_vec,
2476         ListTactic::HorizontalVertical,
2477         Separator::Comma,
2478         one_line_budget,
2479     );
2480     let fmt = ListFormatting {
2481         tactic: tactic,
2482         separator: ",",
2483         trailing_separator: if context.config.indent_style() == IndentStyle::Visual {
2484             SeparatorTactic::Never
2485         } else {
2486             context.config.trailing_comma()
2487         },
2488         separator_place: SeparatorPlace::Back,
2489         shape: shape,
2490         ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
2491         preserve_newline: true,
2492         config: context.config,
2493     };
2494
2495     let list_str = write_list(&item_vec, &fmt)?;
2496
2497     Some(wrap_generics_with_angle_brackets(
2498         context,
2499         &list_str,
2500         shape.indent,
2501     ))
2502 }
2503
2504 pub fn wrap_generics_with_angle_brackets(
2505     context: &RewriteContext,
2506     list_str: &str,
2507     list_offset: Indent,
2508 ) -> String {
2509     if context.config.indent_style() == IndentStyle::Block
2510         && (list_str.contains('\n') || list_str.ends_with(','))
2511     {
2512         format!(
2513             "<\n{}{}\n{}>",
2514             list_offset.to_string(context.config),
2515             list_str,
2516             list_offset
2517                 .block_unindent(context.config)
2518                 .to_string(context.config)
2519         )
2520     } else if context.config.spaces_within_parens_and_brackets() {
2521         format!("< {} >", list_str)
2522     } else {
2523         format!("<{}>", list_str)
2524     }
2525 }
2526
2527 fn rewrite_trait_bounds(
2528     context: &RewriteContext,
2529     type_param_bounds: &ast::TyParamBounds,
2530     shape: Shape,
2531 ) -> Option<String> {
2532     let bounds: &[_] = type_param_bounds;
2533
2534     if bounds.is_empty() {
2535         return Some(String::new());
2536     }
2537     let bound_str = bounds
2538         .iter()
2539         .map(|ty_bound| ty_bound.rewrite(context, shape))
2540         .collect::<Option<Vec<_>>>()?;
2541     Some(format!(": {}", join_bounds(context, shape, &bound_str)))
2542 }
2543
2544 fn rewrite_where_clause_rfc_style(
2545     context: &RewriteContext,
2546     where_clause: &ast::WhereClause,
2547     shape: Shape,
2548     terminator: &str,
2549     span_end: Option<BytePos>,
2550     span_end_before_where: BytePos,
2551     where_clause_option: WhereClauseOption,
2552     is_args_multi_line: bool,
2553 ) -> Option<String> {
2554     let block_shape = shape.block().with_max_width(context.config);
2555
2556     let (span_before, span_after) =
2557         missing_span_before_after_where(span_end_before_where, where_clause);
2558     let (comment_before, comment_after) =
2559         rewrite_comments_before_after_where(context, span_before, span_after, shape)?;
2560
2561     let starting_newline = if where_clause_option.snuggle && comment_before.is_empty() {
2562         " ".to_owned()
2563     } else {
2564         "\n".to_owned() + &block_shape.indent.to_string(context.config)
2565     };
2566
2567     let clause_shape = block_shape.block_left(context.config.tab_spaces())?;
2568     // 1 = `,`
2569     let clause_shape = clause_shape.sub_width(1)?;
2570     // each clause on one line, trailing comma (except if suppress_comma)
2571     let span_start = where_clause.predicates[0].span().lo();
2572     // If we don't have the start of the next span, then use the end of the
2573     // predicates, but that means we miss comments.
2574     let len = where_clause.predicates.len();
2575     let end_of_preds = where_clause.predicates[len - 1].span().hi();
2576     let span_end = span_end.unwrap_or(end_of_preds);
2577     let items = itemize_list(
2578         context.codemap,
2579         where_clause.predicates.iter(),
2580         terminator,
2581         |pred| pred.span().lo(),
2582         |pred| pred.span().hi(),
2583         |pred| pred.rewrite(context, clause_shape),
2584         span_start,
2585         span_end,
2586         false,
2587     );
2588     let where_single_line = context.config.where_single_line() && len == 1 && !is_args_multi_line;
2589     let comma_tactic = if where_clause_option.suppress_comma || where_single_line {
2590         SeparatorTactic::Never
2591     } else {
2592         context.config.trailing_comma()
2593     };
2594
2595     // shape should be vertical only and only if we have `where_single_line` option enabled
2596     // and the number of items of the where clause is equal to 1
2597     let shape_tactic = if where_single_line {
2598         DefinitiveListTactic::Horizontal
2599     } else {
2600         DefinitiveListTactic::Vertical
2601     };
2602
2603     let fmt = ListFormatting {
2604         tactic: shape_tactic,
2605         separator: ",",
2606         trailing_separator: comma_tactic,
2607         separator_place: SeparatorPlace::Back,
2608         shape: clause_shape,
2609         ends_with_newline: true,
2610         preserve_newline: true,
2611         config: context.config,
2612     };
2613     let preds_str = write_list(&items.collect::<Vec<_>>(), &fmt)?;
2614
2615     let comment_separator = |comment: &str, shape: Shape| if comment.is_empty() {
2616         String::new()
2617     } else {
2618         format!("\n{}", shape.indent.to_string(context.config))
2619     };
2620     let newline_before_where = comment_separator(&comment_before, shape);
2621     let newline_after_where = comment_separator(&comment_after, clause_shape);
2622
2623     // 6 = `where `
2624     let clause_sep = if where_clause_option.compress_where && comment_before.is_empty()
2625         && comment_after.is_empty() && !preds_str.contains('\n')
2626         && 6 + preds_str.len() <= shape.width || where_single_line
2627     {
2628         String::from(" ")
2629     } else {
2630         format!("\n{}", clause_shape.indent.to_string(context.config))
2631     };
2632     Some(format!(
2633         "{}{}{}where{}{}{}{}",
2634         starting_newline,
2635         comment_before,
2636         newline_before_where,
2637         newline_after_where,
2638         comment_after,
2639         clause_sep,
2640         preds_str
2641     ))
2642 }
2643
2644 fn rewrite_where_clause(
2645     context: &RewriteContext,
2646     where_clause: &ast::WhereClause,
2647     brace_style: BraceStyle,
2648     shape: Shape,
2649     density: Density,
2650     terminator: &str,
2651     span_end: Option<BytePos>,
2652     span_end_before_where: BytePos,
2653     where_clause_option: WhereClauseOption,
2654     is_args_multi_line: bool,
2655 ) -> Option<String> {
2656     if where_clause.predicates.is_empty() {
2657         return Some(String::new());
2658     }
2659
2660     if context.config.indent_style() == IndentStyle::Block {
2661         return rewrite_where_clause_rfc_style(
2662             context,
2663             where_clause,
2664             shape,
2665             terminator,
2666             span_end,
2667             span_end_before_where,
2668             where_clause_option,
2669             is_args_multi_line,
2670         );
2671     }
2672
2673     let extra_indent = Indent::new(context.config.tab_spaces(), 0);
2674
2675     let offset = match context.config.indent_style() {
2676         IndentStyle::Block => shape.indent + extra_indent.block_indent(context.config),
2677         // 6 = "where ".len()
2678         IndentStyle::Visual => shape.indent + extra_indent + 6,
2679     };
2680     // FIXME: if indent_style != Visual, then the budgets below might
2681     // be out by a char or two.
2682
2683     let budget = context.config.max_width() - offset.width();
2684     let span_start = where_clause.predicates[0].span().lo();
2685     // If we don't have the start of the next span, then use the end of the
2686     // predicates, but that means we miss comments.
2687     let len = where_clause.predicates.len();
2688     let end_of_preds = where_clause.predicates[len - 1].span().hi();
2689     let span_end = span_end.unwrap_or(end_of_preds);
2690     let items = itemize_list(
2691         context.codemap,
2692         where_clause.predicates.iter(),
2693         terminator,
2694         |pred| pred.span().lo(),
2695         |pred| pred.span().hi(),
2696         |pred| pred.rewrite(context, Shape::legacy(budget, offset)),
2697         span_start,
2698         span_end,
2699         false,
2700     );
2701     let item_vec = items.collect::<Vec<_>>();
2702     // FIXME: we don't need to collect here if the where_layout isn't
2703     // HorizontalVertical.
2704     let tactic = definitive_tactic(
2705         &item_vec,
2706         context.config.where_layout(),
2707         Separator::Comma,
2708         budget,
2709     );
2710
2711     let mut comma_tactic = context.config.trailing_comma();
2712     // Kind of a hack because we don't usually have trailing commas in where clauses.
2713     if comma_tactic == SeparatorTactic::Vertical || where_clause_option.suppress_comma {
2714         comma_tactic = SeparatorTactic::Never;
2715     }
2716
2717     let fmt = ListFormatting {
2718         tactic: tactic,
2719         separator: ",",
2720         trailing_separator: comma_tactic,
2721         separator_place: SeparatorPlace::Back,
2722         shape: Shape::legacy(budget, offset),
2723         ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
2724         preserve_newline: true,
2725         config: context.config,
2726     };
2727     let preds_str = write_list(&item_vec, &fmt)?;
2728
2729     let end_length = if terminator == "{" {
2730         // If the brace is on the next line we don't need to count it otherwise it needs two
2731         // characters " {"
2732         match brace_style {
2733             BraceStyle::AlwaysNextLine | BraceStyle::SameLineWhere => 0,
2734             BraceStyle::PreferSameLine => 2,
2735         }
2736     } else if terminator == "=" {
2737         2
2738     } else {
2739         terminator.len()
2740     };
2741     if density == Density::Tall || preds_str.contains('\n')
2742         || shape.indent.width() + " where ".len() + preds_str.len() + end_length > shape.width
2743     {
2744         Some(format!(
2745             "\n{}where {}",
2746             (shape.indent + extra_indent).to_string(context.config),
2747             preds_str
2748         ))
2749     } else {
2750         Some(format!(" where {}", preds_str))
2751     }
2752 }
2753
2754 fn missing_span_before_after_where(
2755     before_item_span_end: BytePos,
2756     where_clause: &ast::WhereClause,
2757 ) -> (Span, Span) {
2758     let missing_span_before = mk_sp(before_item_span_end, where_clause.span.lo());
2759     // 5 = `where`
2760     let pos_after_where = where_clause.span.lo() + BytePos(5);
2761     let missing_span_after = mk_sp(pos_after_where, where_clause.predicates[0].span().lo());
2762     (missing_span_before, missing_span_after)
2763 }
2764
2765 fn rewrite_comments_before_after_where(
2766     context: &RewriteContext,
2767     span_before_where: Span,
2768     span_after_where: Span,
2769     shape: Shape,
2770 ) -> Option<(String, String)> {
2771     let before_comment = rewrite_missing_comment(span_before_where, shape, context)?;
2772     let after_comment = rewrite_missing_comment(
2773         span_after_where,
2774         shape.block_indent(context.config.tab_spaces()),
2775         context,
2776     )?;
2777     Some((before_comment, after_comment))
2778 }
2779
2780 fn format_header(item_name: &str, ident: ast::Ident, vis: &ast::Visibility) -> String {
2781     format!("{}{}{}", format_visibility(vis), item_name, ident)
2782 }
2783
2784 #[derive(PartialEq, Eq)]
2785 enum BracePos {
2786     None,
2787     Auto,
2788     ForceSameLine,
2789 }
2790
2791 fn format_generics(
2792     context: &RewriteContext,
2793     generics: &ast::Generics,
2794     brace_style: BraceStyle,
2795     brace_pos: BracePos,
2796     offset: Indent,
2797     span: Span,
2798     used_width: usize,
2799 ) -> Option<String> {
2800     let shape = Shape::legacy(context.budget(used_width + offset.width()), offset);
2801     let mut result = rewrite_generics(context, generics, shape, span)?;
2802
2803     let same_line_brace = if !generics.where_clause.predicates.is_empty() || result.contains('\n') {
2804         let budget = context.budget(last_line_used_width(&result, offset.width()));
2805         let mut option = WhereClauseOption::snuggled(&result);
2806         if brace_pos == BracePos::None {
2807             option.suppress_comma = true;
2808         }
2809         // If the generics are not parameterized then generics.span.hi() == 0,
2810         // so we use span.lo(), which is the position after `struct Foo`.
2811         let span_end_before_where = if generics.is_parameterized() {
2812             generics.span.hi()
2813         } else {
2814             span.lo()
2815         };
2816         let where_clause_str = rewrite_where_clause(
2817             context,
2818             &generics.where_clause,
2819             brace_style,
2820             Shape::legacy(budget, offset.block_only()),
2821             Density::Tall,
2822             "{",
2823             Some(span.hi()),
2824             span_end_before_where,
2825             option,
2826             false,
2827         )?;
2828         result.push_str(&where_clause_str);
2829         brace_pos == BracePos::ForceSameLine || brace_style == BraceStyle::PreferSameLine
2830             || (generics.where_clause.predicates.is_empty()
2831                 && trimmed_last_line_width(&result) == 1)
2832     } else {
2833         brace_pos == BracePos::ForceSameLine || trimmed_last_line_width(&result) == 1
2834             || brace_style != BraceStyle::AlwaysNextLine
2835     };
2836     if brace_pos == BracePos::None {
2837         return Some(result);
2838     }
2839     let total_used_width = last_line_used_width(&result, used_width);
2840     let remaining_budget = context.budget(total_used_width);
2841     // If the same line brace if forced, it indicates that we are rewriting an item with empty body,
2842     // and hence we take the closer into account as well for one line budget.
2843     // We assume that the closer has the same length as the opener.
2844     let overhead = if brace_pos == BracePos::ForceSameLine {
2845         // 3 = ` {}`
2846         3
2847     } else {
2848         // 2 = ` {`
2849         2
2850     };
2851     let forbid_same_line_brace = overhead > remaining_budget;
2852     if !forbid_same_line_brace && same_line_brace {
2853         result.push(' ');
2854     } else {
2855         result.push('\n');
2856         result.push_str(&offset.block_only().to_string(context.config));
2857     }
2858     result.push('{');
2859
2860     Some(result)
2861 }
2862
2863 impl Rewrite for ast::ForeignItem {
2864     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
2865         let attrs_str = self.attrs.rewrite(context, shape)?;
2866         // Drop semicolon or it will be interpreted as comment.
2867         // FIXME: this may be a faulty span from libsyntax.
2868         let span = mk_sp(self.span.lo(), self.span.hi() - BytePos(1));
2869
2870         let item_str = match self.node {
2871             ast::ForeignItemKind::Fn(ref fn_decl, ref generics) => {
2872                 rewrite_fn_base(
2873                     context,
2874                     shape.indent,
2875                     self.ident,
2876                     &FnSig::new(fn_decl, generics, self.vis.clone()),
2877                     span,
2878                     false,
2879                     false,
2880                 ).map(|(s, _)| format!("{};", s))
2881             }
2882             ast::ForeignItemKind::Static(ref ty, is_mutable) => {
2883                 // FIXME(#21): we're dropping potential comments in between the
2884                 // function keywords here.
2885                 let vis = format_visibility(&self.vis);
2886                 let mut_str = if is_mutable { "mut " } else { "" };
2887                 let prefix = format!("{}static {}{}:", vis, mut_str, self.ident);
2888                 // 1 = ;
2889                 let shape = shape.sub_width(1)?;
2890                 ty.rewrite(context, shape).map(|ty_str| {
2891                     // 1 = space between prefix and type.
2892                     let sep = if prefix.len() + ty_str.len() + 1 <= shape.width {
2893                         String::from(" ")
2894                     } else {
2895                         let nested_indent = shape.indent.block_indent(context.config);
2896                         format!("\n{}", nested_indent.to_string(context.config))
2897                     };
2898                     format!("{}{}{};", prefix, sep, ty_str)
2899                 })
2900             }
2901             ast::ForeignItemKind::Ty => {
2902                 let vis = format_visibility(&self.vis);
2903                 Some(format!("{}type {};", vis, self.ident))
2904             }
2905         }?;
2906
2907         let missing_span = if self.attrs.is_empty() {
2908             mk_sp(self.span.lo(), self.span.lo())
2909         } else {
2910             mk_sp(self.attrs[self.attrs.len() - 1].span.hi(), self.span.lo())
2911         };
2912         combine_strs_with_missing_comments(
2913             context,
2914             &attrs_str,
2915             &item_str,
2916             missing_span,
2917             shape,
2918             false,
2919         )
2920     }
2921 }