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