src/items.rs

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