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