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 codemap::{LineRangeUtils, SpanUtils};
  22 use comment::{combine_strs_with_missing_comments, contains_comment, recover_comment_removed,
  23               recover_missing_comment_in_span, rewrite_missing_comment, FindUncommented};
  24 use config::{BraceStyle, Config, Density, IndentStyle};
  25 use expr::{format_expr, is_empty_block, is_simple_block_stmt, rewrite_assign_rhs,
  26            rewrite_call_inner, ExprType};
  27 use lists::{definitive_tactic, itemize_list, write_list, DefinitiveListTactic, ListFormatting,
  28             ListItem, ListTactic, Separator, SeparatorPlace, SeparatorTactic};
  29 use rewrite::{Rewrite, RewriteContext};
  30 use shape::{Indent, Shape};
  31 use spanned::Spanned;
  32 use types::join_bounds;
  33 use utils::{colon_spaces, contains_skip, first_line_width, format_abi, format_constness,
  34             format_defaultness, format_mutability, format_unsafety, format_visibility,
  35             is_attributes_extendable, last_line_contains_single_line_comment,
  36             last_line_extendable, last_line_used_width, last_line_width, mk_sp,
  37             semicolon_for_expr, starts_with_newline, stmt_expr, 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)?;
 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         combine_strs_with_missing_comments(&context, &attrs_str, &variant_body, span, shape, false)
 562     }
 563 }
 564
 565 pub fn format_impl(
 566     context: &RewriteContext,
 567     item: &ast::Item,
 568     offset: Indent,
 569     where_span_end: Option<BytePos>,
 570 ) -> Option<String> {
 571     if let ast::ItemKind::Impl(_, _, _, ref generics, _, ref self_ty, ref items) = item.node {
 572         let mut result = String::with_capacity(128);
 573         let ref_and_type = format_impl_ref_and_type(context, item, offset)?;
 574         let indent_str = offset.to_string(context.config);
 575         let sep = format!("\n{}", &indent_str);
 576         result.push_str(&ref_and_type);
 577
 578         let where_budget = if result.contains('\n') {
 579             context.config.max_width()
 580         } else {
 581             context.budget(last_line_width(&result))
 582         };
 583         let option = WhereClauseOption::snuggled(&ref_and_type);
 584         let where_clause_str = rewrite_where_clause(
 585             context,
 586             &generics.where_clause,
 587             context.config.brace_style(),
 588             Shape::legacy(where_budget, offset.block_only()),
 589             Density::Vertical,
 590             "{",
 591             where_span_end,
 592             self_ty.span.hi(),
 593             option,
 594             false,
 595         )?;
 596
 597         // If there is no where clause, we may have missing comments between the trait name and
 598         // the opening brace.
 599         if generics.where_clause.predicates.is_empty() {
 600             if let Some(hi) = where_span_end {
 601                 match recover_missing_comment_in_span(
 602                     mk_sp(self_ty.span.hi(), hi),
 603                     Shape::indented(offset, context.config),
 604                     context,
 605                     last_line_width(&result),
 606                 ) {
 607                     Some(ref missing_comment) if !missing_comment.is_empty() => {
 608                         result.push_str(missing_comment);
 609                     }
 610                     _ => (),
 611                 }
 612             }
 613         }
 614
 615         if is_impl_single_line(context, items, &result, &where_clause_str, item)? {
 616             result.push_str(&where_clause_str);
 617             if where_clause_str.contains('\n') || last_line_contains_single_line_comment(&result) {
 618                 result.push_str(&format!("{}{{{}}}", &sep, &sep));
 619             } else {
 620                 result.push_str(" {}");
 621             }
 622             return Some(result);
 623         }
 624
 625         if !where_clause_str.is_empty() && !where_clause_str.contains('\n') {
 626             result.push('\n');
 627             let width = offset.block_indent + context.config.tab_spaces() - 1;
 628             let where_indent = Indent::new(0, width);
 629             result.push_str(&where_indent.to_string(context.config));
 630         }
 631         result.push_str(&where_clause_str);
 632
 633         let need_newline = !last_line_extendable(&result)
 634             && (last_line_contains_single_line_comment(&result) || result.contains('\n'));
 635         match context.config.brace_style() {
 636             _ if need_newline => result.push_str(&sep),
 637             BraceStyle::AlwaysNextLine => result.push_str(&sep),
 638             BraceStyle::PreferSameLine => result.push(' '),
 639             BraceStyle::SameLineWhere => {
 640                 if !where_clause_str.is_empty() {
 641                     result.push_str(&sep);
 642                 } else {
 643                     result.push(' ');
 644                 }
 645             }
 646         }
 647
 648         result.push('{');
 649
 650         let snippet = context.snippet(item.span);
 651         let open_pos = snippet.find_uncommented("{")? + 1;
 652
 653         if !items.is_empty() || contains_comment(&snippet[open_pos..]) {
 654             let mut visitor = FmtVisitor::from_context(context);
 655             visitor.block_indent = offset.block_only().block_indent(context.config);
 656             visitor.last_pos = item.span.lo() + BytePos(open_pos as u32);
 657
 658             visitor.visit_attrs(&item.attrs, ast::AttrStyle::Inner);
 659             for item in items {
 660                 visitor.visit_impl_item(item);
 661             }
 662
 663             visitor.format_missing(item.span.hi() - BytePos(1));
 664
 665             let inner_indent_str = visitor.block_indent.to_string(context.config);
 666             let outer_indent_str = offset.block_only().to_string(context.config);
 667
 668             result.push('\n');
 669             result.push_str(&inner_indent_str);
 670             result.push_str(visitor.buffer.to_string().trim());
 671             result.push('\n');
 672             result.push_str(&outer_indent_str);
 673         }
 674
 675         if result.ends_with('{') {
 676             result.push_str(&sep);
 677         }
 678         result.push('}');
 679
 680         Some(result)
 681     } else {
 682         unreachable!();
 683     }
 684 }
 685
 686 fn is_impl_single_line(
 687     context: &RewriteContext,
 688     items: &[ImplItem],
 689     result: &str,
 690     where_clause_str: &str,
 691     item: &ast::Item,
 692 ) -> Option<bool> {
 693     let snippet = context.snippet(item.span);
 694     let open_pos = snippet.find_uncommented("{")? + 1;
 695
 696     Some(
 697         context.config.empty_item_single_line() && items.is_empty() && !result.contains('\n')
 698             && result.len() + where_clause_str.len() <= context.config.max_width()
 699             && !contains_comment(&snippet[open_pos..]),
 700     )
 701 }
 702
 703 fn format_impl_ref_and_type(
 704     context: &RewriteContext,
 705     item: &ast::Item,
 706     offset: Indent,
 707 ) -> Option<String> {
 708     if let ast::ItemKind::Impl(
 709         unsafety,
 710         polarity,
 711         defaultness,
 712         ref generics,
 713         ref trait_ref,
 714         ref self_ty,
 715         _,
 716     ) = item.node
 717     {
 718         let mut result = String::with_capacity(128);
 719
 720         result.push_str(&format_visibility(&item.vis));
 721         result.push_str(format_defaultness(defaultness));
 722         result.push_str(format_unsafety(unsafety));
 723         result.push_str("impl");
 724
 725         let lo = context.codemap.span_after(item.span, "impl");
 726         let hi = match *trait_ref {
 727             Some(ref tr) => tr.path.span.lo(),
 728             None => self_ty.span.lo(),
 729         };
 730         let shape = generics_shape_from_config(
 731             context.config,
 732             Shape::indented(offset + last_line_width(&result), context.config),
 733             0,
 734         )?;
 735         let one_line_budget = shape.width.checked_sub(last_line_width(&result) + 2)?;
 736         let generics_str =
 737             rewrite_generics_inner(context, generics, shape, one_line_budget, mk_sp(lo, hi))?;
 738
 739         let polarity_str = if polarity == ast::ImplPolarity::Negative {
 740             "!"
 741         } else {
 742             ""
 743         };
 744
 745         if let Some(ref trait_ref) = *trait_ref {
 746             let result_len = result.len();
 747             if let Some(trait_ref_str) = rewrite_trait_ref(
 748                 context,
 749                 trait_ref,
 750                 offset,
 751                 &generics_str,
 752                 true,
 753                 polarity_str,
 754                 result_len,
 755             ) {
 756                 result.push_str(&trait_ref_str);
 757             } else {
 758                 let generics_str =
 759                     rewrite_generics_inner(context, generics, shape, 0, mk_sp(lo, hi))?;
 760                 result.push_str(&rewrite_trait_ref(
 761                     context,
 762                     trait_ref,
 763                     offset,
 764                     &generics_str,
 765                     false,
 766                     polarity_str,
 767                     result_len,
 768                 )?);
 769             }
 770         } else {
 771             result.push_str(&generics_str);
 772         }
 773
 774         // Try to put the self type in a single line.
 775         // ` for`
 776         let trait_ref_overhead = if trait_ref.is_some() { 4 } else { 0 };
 777         let curly_brace_overhead = if generics.where_clause.predicates.is_empty() {
 778             // If there is no where clause adapt budget for type formatting to take space and curly
 779             // brace into account.
 780             match context.config.brace_style() {
 781                 BraceStyle::AlwaysNextLine => 0,
 782                 _ => 2,
 783             }
 784         } else {
 785             0
 786         };
 787         let used_space = last_line_width(&result) + trait_ref_overhead + curly_brace_overhead;
 788         // 1 = space before the type.
 789         let budget = context.budget(used_space + 1);
 790         if let Some(self_ty_str) = self_ty.rewrite(context, Shape::legacy(budget, offset)) {
 791             if !self_ty_str.contains('\n') {
 792                 if trait_ref.is_some() {
 793                     result.push_str(" for ");
 794                 } else {
 795                     result.push(' ');
 796                 }
 797                 result.push_str(&self_ty_str);
 798                 return Some(result);
 799             }
 800         }
 801
 802         // Couldn't fit the self type on a single line, put it on a new line.
 803         result.push('\n');
 804         // Add indentation of one additional tab.
 805         let new_line_offset = offset.block_indent(context.config);
 806         result.push_str(&new_line_offset.to_string(context.config));
 807         if trait_ref.is_some() {
 808             result.push_str("for ");
 809         }
 810         let budget = context.budget(last_line_width(&result));
 811         let type_offset = match context.config.indent_style() {
 812             IndentStyle::Visual => new_line_offset + trait_ref_overhead,
 813             IndentStyle::Block => new_line_offset,
 814         };
 815         result.push_str(&*self_ty.rewrite(context, Shape::legacy(budget, type_offset))?);
 816         Some(result)
 817     } else {
 818         unreachable!();
 819     }
 820 }
 821
 822 fn rewrite_trait_ref(
 823     context: &RewriteContext,
 824     trait_ref: &ast::TraitRef,
 825     offset: Indent,
 826     generics_str: &str,
 827     retry: bool,
 828     polarity_str: &str,
 829     result_len: usize,
 830 ) -> Option<String> {
 831     // 1 = space between generics and trait_ref
 832     let used_space = 1 + polarity_str.len() + last_line_used_width(generics_str, result_len);
 833     let shape = Shape::indented(offset + used_space, context.config);
 834     if let Some(trait_ref_str) = trait_ref.rewrite(context, shape) {
 835         if !(retry && trait_ref_str.contains('\n')) {
 836             return Some(format!(
 837                 "{} {}{}",
 838                 generics_str, polarity_str, &trait_ref_str
 839             ));
 840         }
 841     }
 842     // We could not make enough space for trait_ref, so put it on new line.
 843     if !retry {
 844         let offset = offset.block_indent(context.config);
 845         let shape = Shape::indented(offset, context.config);
 846         let trait_ref_str = trait_ref.rewrite(context, shape)?;
 847         Some(format!(
 848             "{}\n{}{}{}",
 849             generics_str,
 850             &offset.to_string(context.config),
 851             polarity_str,
 852             &trait_ref_str
 853         ))
 854     } else {
 855         None
 856     }
 857 }
 858
 859 pub struct StructParts<'a> {
 860     prefix: &'a str,
 861     ident: ast::Ident,
 862     vis: &'a ast::Visibility,
 863     def: &'a ast::VariantData,
 864     generics: Option<&'a ast::Generics>,
 865     span: Span,
 866 }
 867
 868 impl<'a> StructParts<'a> {
 869     fn format_header(&self) -> String {
 870         format_header(self.prefix, self.ident, self.vis)
 871     }
 872
 873     fn from_variant(variant: &'a ast::Variant) -> Self {
 874         StructParts {
 875             prefix: "",
 876             ident: variant.node.name,
 877             vis: &ast::Visibility::Inherited,
 878             def: &variant.node.data,
 879             generics: None,
 880             span: variant.span,
 881         }
 882     }
 883
 884     pub fn from_item(item: &'a ast::Item) -> Self {
 885         let (prefix, def, generics) = match item.node {
 886             ast::ItemKind::Struct(ref def, ref generics) => ("struct ", def, generics),
 887             ast::ItemKind::Union(ref def, ref generics) => ("union ", def, generics),
 888             _ => unreachable!(),
 889         };
 890         StructParts {
 891             prefix: prefix,
 892             ident: item.ident,
 893             vis: &item.vis,
 894             def: def,
 895             generics: Some(generics),
 896             span: item.span,
 897         }
 898     }
 899 }
 900
 901 fn format_struct(
 902     context: &RewriteContext,
 903     struct_parts: &StructParts,
 904     offset: Indent,
 905     one_line_width: Option<usize>,
 906 ) -> Option<String> {
 907     match *struct_parts.def {
 908         ast::VariantData::Unit(..) => format_unit_struct(context, struct_parts, offset),
 909         ast::VariantData::Tuple(ref fields, _) => {
 910             format_tuple_struct(context, struct_parts, fields, offset)
 911         }
 912         ast::VariantData::Struct(ref fields, _) => {
 913             format_struct_struct(context, struct_parts, fields, offset, one_line_width)
 914         }
 915     }
 916 }
 917
 918 pub fn format_trait(context: &RewriteContext, item: &ast::Item, offset: Indent) -> Option<String> {
 919     if let ast::ItemKind::Trait(_, unsafety, ref generics, ref type_param_bounds, ref trait_items) =
 920         item.node
 921     {
 922         let mut result = String::with_capacity(128);
 923         let header = format!(
 924             "{}{}trait {}",
 925             format_visibility(&item.vis),
 926             format_unsafety(unsafety),
 927             item.ident
 928         );
 929
 930         result.push_str(&header);
 931
 932         let body_lo = context.codemap.span_after(item.span, "{");
 933
 934         let shape = Shape::indented(offset, context.config).offset_left(result.len())?;
 935         let generics_str =
 936             rewrite_generics(context, generics, shape, mk_sp(item.span.lo(), body_lo))?;
 937         result.push_str(&generics_str);
 938
 939         // FIXME(#2055): rustfmt fails to format when there are comments between trait bounds.
 940         if !type_param_bounds.is_empty() {
 941             let ident_hi = context
 942                 .codemap
 943                 .span_after(item.span, &format!("{}", item.ident));
 944             let bound_hi = type_param_bounds.last().unwrap().span().hi();
 945             let snippet = context.snippet(mk_sp(ident_hi, bound_hi));
 946             if contains_comment(snippet) {
 947                 return None;
 948             }
 949         }
 950         let trait_bound_str = rewrite_trait_bounds(
 951             context,
 952             type_param_bounds,
 953             Shape::indented(offset, context.config),
 954         )?;
 955         // If the trait, generics, and trait bound cannot fit on the same line,
 956         // put the trait bounds on an indented new line
 957         if offset.width() + last_line_width(&result) + trait_bound_str.len()
 958             > context.config.comment_width()
 959         {
 960             result.push('\n');
 961             let trait_indent = offset.block_only().block_indent(context.config);
 962             result.push_str(&trait_indent.to_string(context.config));
 963         }
 964         result.push_str(&trait_bound_str);
 965
 966         let where_density =
 967             if context.config.indent_style() == IndentStyle::Block && result.is_empty() {
 968                 Density::Compressed
 969             } else {
 970                 Density::Tall
 971             };
 972
 973         let where_budget = context.budget(last_line_width(&result));
 974         let pos_before_where = if type_param_bounds.is_empty() {
 975             generics.where_clause.span.lo()
 976         } else {
 977             type_param_bounds[type_param_bounds.len() - 1].span().hi()
 978         };
 979         let option = WhereClauseOption::snuggled(&generics_str);
 980         let where_clause_str = rewrite_where_clause(
 981             context,
 982             &generics.where_clause,
 983             context.config.brace_style(),
 984             Shape::legacy(where_budget, offset.block_only()),
 985             where_density,
 986             "{",
 987             None,
 988             pos_before_where,
 989             option,
 990             false,
 991         )?;
 992         // If the where clause cannot fit on the same line,
 993         // put the where clause on a new line
 994         if !where_clause_str.contains('\n')
 995             && last_line_width(&result) + where_clause_str.len() + offset.width()
 996                 > context.config.comment_width()
 997         {
 998             result.push('\n');
 999             let width = offset.block_indent + context.config.tab_spaces() - 1;
1000             let where_indent = Indent::new(0, width);
1001             result.push_str(&where_indent.to_string(context.config));
1002         }
1003         result.push_str(&where_clause_str);
1004
1005         if generics.where_clause.predicates.is_empty() {
1006             let item_snippet = context.snippet(item.span);
1007             if let Some(lo) = item_snippet.chars().position(|c| c == '/') {
1008                 // 1 = `{`
1009                 let comment_hi = body_lo - BytePos(1);
1010                 let comment_lo = item.span.lo() + BytePos(lo as u32);
1011                 if comment_lo < comment_hi {
1012                     match recover_missing_comment_in_span(
1013                         mk_sp(comment_lo, comment_hi),
1014                         Shape::indented(offset, context.config),
1015                         context,
1016                         last_line_width(&result),
1017                     ) {
1018                         Some(ref missing_comment) if !missing_comment.is_empty() => {
1019                             result.push_str(missing_comment);
1020                         }
1021                         _ => (),
1022                     }
1023                 }
1024             }
1025         }
1026
1027         match context.config.brace_style() {
1028             _ if last_line_contains_single_line_comment(&result) => {
1029                 result.push('\n');
1030                 result.push_str(&offset.to_string(context.config));
1031             }
1032             BraceStyle::AlwaysNextLine => {
1033                 result.push('\n');
1034                 result.push_str(&offset.to_string(context.config));
1035             }
1036             BraceStyle::PreferSameLine => result.push(' '),
1037             BraceStyle::SameLineWhere => {
1038                 if !where_clause_str.is_empty()
1039                     && (!trait_items.is_empty() || result.contains('\n'))
1040                 {
1041                     result.push('\n');
1042                     result.push_str(&offset.to_string(context.config));
1043                 } else {
1044                     result.push(' ');
1045                 }
1046             }
1047         }
1048         result.push('{');
1049
1050         let snippet = context.snippet(item.span);
1051         let open_pos = snippet.find_uncommented("{")? + 1;
1052
1053         if !trait_items.is_empty() || contains_comment(&snippet[open_pos..]) {
1054             let mut visitor = FmtVisitor::from_context(context);
1055             visitor.block_indent = offset.block_only().block_indent(context.config);
1056             visitor.last_pos = item.span.lo() + BytePos(open_pos as u32);
1057
1058             for item in trait_items {
1059                 visitor.visit_trait_item(item);
1060             }
1061
1062             visitor.format_missing(item.span.hi() - BytePos(1));
1063
1064             let inner_indent_str = visitor.block_indent.to_string(context.config);
1065             let outer_indent_str = offset.block_only().to_string(context.config);
1066
1067             result.push('\n');
1068             result.push_str(&inner_indent_str);
1069             result.push_str(visitor.buffer.to_string().trim());
1070             result.push('\n');
1071             result.push_str(&outer_indent_str);
1072         } else if result.contains('\n') {
1073             result.push('\n');
1074         }
1075
1076         result.push('}');
1077         Some(result)
1078     } else {
1079         unreachable!();
1080     }
1081 }
1082
1083 pub fn format_trait_alias(
1084     context: &RewriteContext,
1085     ident: ast::Ident,
1086     generics: &ast::Generics,
1087     ty_param_bounds: &ast::TyParamBounds,
1088     shape: Shape,
1089 ) -> Option<String> {
1090     let alias = ident.name.as_str();
1091     // 6 = "trait ", 2 = " ="
1092     let g_shape = shape.offset_left(6 + alias.len())?.sub_width(2)?;
1093     let generics_str = rewrite_generics(context, generics, g_shape, generics.span)?;
1094     let lhs = format!("trait {}{} =", alias, generics_str);
1095     // 1 = ";"
1096     rewrite_assign_rhs(context, lhs, ty_param_bounds, shape.sub_width(1)?).map(|s| s + ";")
1097 }
1098
1099 fn format_unit_struct(context: &RewriteContext, p: &StructParts, offset: Indent) -> Option<String> {
1100     let header_str = format_header(p.prefix, p.ident, p.vis);
1101     let generics_str = if let Some(generics) = p.generics {
1102         let hi = if generics.where_clause.predicates.is_empty() {
1103             generics.span.hi()
1104         } else {
1105             generics.where_clause.span.hi()
1106         };
1107         format_generics(
1108             context,
1109             generics,
1110             context.config.brace_style(),
1111             BracePos::None,
1112             offset,
1113             mk_sp(generics.span.lo(), hi),
1114             last_line_width(&header_str),
1115         )?
1116     } else {
1117         String::new()
1118     };
1119     Some(format!("{}{};", header_str, generics_str))
1120 }
1121
1122 pub fn format_struct_struct(
1123     context: &RewriteContext,
1124     struct_parts: &StructParts,
1125     fields: &[ast::StructField],
1126     offset: Indent,
1127     one_line_width: Option<usize>,
1128 ) -> Option<String> {
1129     let mut result = String::with_capacity(1024);
1130     let span = struct_parts.span;
1131
1132     let header_str = struct_parts.format_header();
1133     result.push_str(&header_str);
1134
1135     let header_hi = span.lo() + BytePos(header_str.len() as u32);
1136     let body_lo = context.codemap.span_after(span, "{");
1137
1138     let generics_str = match struct_parts.generics {
1139         Some(g) => format_generics(
1140             context,
1141             g,
1142             context.config.brace_style(),
1143             if fields.is_empty() {
1144                 BracePos::ForceSameLine
1145             } else {
1146                 BracePos::Auto
1147             },
1148             offset,
1149             mk_sp(header_hi, body_lo),
1150             last_line_width(&result),
1151         )?,
1152         None => {
1153             // 3 = ` {}`, 2 = ` {`.
1154             let overhead = if fields.is_empty() { 3 } else { 2 };
1155             if (context.config.brace_style() == BraceStyle::AlwaysNextLine && !fields.is_empty())
1156                 || context.config.max_width() < overhead + result.len()
1157             {
1158                 format!("\n{}{{", offset.block_only().to_string(context.config))
1159             } else {
1160                 " {".to_owned()
1161             }
1162         }
1163     };
1164     // 1 = `}`
1165     let overhead = if fields.is_empty() { 1 } else { 0 };
1166     let total_width = result.len() + generics_str.len() + overhead;
1167     if !generics_str.is_empty() && !generics_str.contains('\n')
1168         && total_width > context.config.max_width()
1169     {
1170         result.push('\n');
1171         result.push_str(&offset.to_string(context.config));
1172         result.push_str(generics_str.trim_left());
1173     } else {
1174         result.push_str(&generics_str);
1175     }
1176
1177     if fields.is_empty() {
1178         let snippet = context.snippet(mk_sp(body_lo, span.hi() - BytePos(1)));
1179         if snippet.trim().is_empty() {
1180             // `struct S {}`
1181         } else if snippet.trim_right_matches(&[' ', '\t'][..]).ends_with('\n') {
1182             // fix indent
1183             result.push_str(snippet.trim_right());
1184             result.push('\n');
1185             result.push_str(&offset.to_string(context.config));
1186         } else {
1187             result.push_str(snippet);
1188         }
1189         result.push('}');
1190         return Some(result);
1191     }
1192
1193     // 3 = ` ` and ` }`
1194     let one_line_budget = context.budget(result.len() + 3 + offset.width());
1195     let one_line_budget =
1196         one_line_width.map_or(0, |one_line_width| min(one_line_width, one_line_budget));
1197
1198     let items_str = rewrite_with_alignment(
1199         fields,
1200         context,
1201         Shape::indented(offset, context.config).sub_width(1)?,
1202         mk_sp(body_lo, span.hi()),
1203         one_line_budget,
1204     )?;
1205
1206     if !items_str.contains('\n') && !result.contains('\n') && items_str.len() <= one_line_budget {
1207         Some(format!("{} {} }}", result, items_str))
1208     } else {
1209         Some(format!(
1210             "{}\n{}{}\n{}}}",
1211             result,
1212             offset
1213                 .block_indent(context.config)
1214                 .to_string(context.config),
1215             items_str,
1216             offset.to_string(context.config)
1217         ))
1218     }
1219 }
1220
1221 /// Returns a bytepos that is after that of `(` in `pub(..)`. If the given visibility does not
1222 /// contain `pub(..)`, then return the `lo` of the `defualt_span`. Yeah, but for what? Well, we need
1223 /// to bypass the `(` in the visibility when creating a span of tuple's body or fn's args.
1224 fn get_bytepos_after_visibility(
1225     context: &RewriteContext,
1226     vis: &ast::Visibility,
1227     default_span: Span,
1228     terminator: &str,
1229 ) -> BytePos {
1230     match *vis {
1231         ast::Visibility::Crate(s, CrateSugar::PubCrate) => context
1232             .codemap
1233             .span_after(mk_sp(s.hi(), default_span.hi()), terminator),
1234         ast::Visibility::Crate(s, CrateSugar::JustCrate) => s.hi(),
1235         ast::Visibility::Restricted { ref path, .. } => path.span.hi(),
1236         _ => default_span.lo(),
1237     }
1238 }
1239
1240 fn format_tuple_struct(
1241     context: &RewriteContext,
1242     struct_parts: &StructParts,
1243     fields: &[ast::StructField],
1244     offset: Indent,
1245 ) -> Option<String> {
1246     let mut result = String::with_capacity(1024);
1247     let span = struct_parts.span;
1248
1249     let header_str = struct_parts.format_header();
1250     result.push_str(&header_str);
1251
1252     let body_lo = if fields.is_empty() {
1253         let lo = get_bytepos_after_visibility(context, struct_parts.vis, span, ")");
1254         context.codemap.span_after(mk_sp(lo, span.hi()), "(")
1255     } else {
1256         fields[0].span.lo()
1257     };
1258     let body_hi = if fields.is_empty() {
1259         context.codemap.span_after(mk_sp(body_lo, span.hi()), ")")
1260     } else {
1261         // This is a dirty hack to work around a missing `)` from the span of the last field.
1262         let last_arg_span = fields[fields.len() - 1].span;
1263         if context.snippet(last_arg_span).ends_with(')') {
1264             last_arg_span.hi()
1265         } else {
1266             context
1267                 .codemap
1268                 .span_after(mk_sp(last_arg_span.hi(), span.hi()), ")")
1269         }
1270     };
1271
1272     let where_clause_str = match struct_parts.generics {
1273         Some(generics) => {
1274             let budget = context.budget(last_line_width(&header_str));
1275             let shape = Shape::legacy(budget, offset);
1276             let g_span = mk_sp(span.lo(), body_lo);
1277             let generics_str = rewrite_generics(context, generics, shape, g_span)?;
1278             result.push_str(&generics_str);
1279
1280             let where_budget = context.budget(last_line_width(&result));
1281             let option = WhereClauseOption::new(true, false);
1282             rewrite_where_clause(
1283                 context,
1284                 &generics.where_clause,
1285                 context.config.brace_style(),
1286                 Shape::legacy(where_budget, offset.block_only()),
1287                 Density::Compressed,
1288                 ";",
1289                 None,
1290                 body_hi,
1291                 option,
1292                 false,
1293             )?
1294         }
1295         None => "".to_owned(),
1296     };
1297
1298     if fields.is_empty() {
1299         // 3 = `();`
1300         let used_width = last_line_used_width(&result, offset.width()) + 3;
1301         if used_width > context.config.max_width() {
1302             result.push('\n');
1303             result.push_str(&offset
1304                 .block_indent(context.config)
1305                 .to_string(context.config))
1306         }
1307         result.push('(');
1308         let snippet = context.snippet(mk_sp(
1309             body_lo,
1310             context.codemap.span_before(mk_sp(body_lo, span.hi()), ")"),
1311         ));
1312         if snippet.is_empty() {
1313             // `struct S ()`
1314         } else if snippet.trim_right_matches(&[' ', '\t'][..]).ends_with('\n') {
1315             result.push_str(snippet.trim_right());
1316             result.push('\n');
1317             result.push_str(&offset.to_string(context.config));
1318         } else {
1319             result.push_str(snippet);
1320         }
1321         result.push(')');
1322     } else {
1323         let shape = Shape::indented(offset, context.config).sub_width(1)?;
1324         let fields = &fields.iter().collect::<Vec<_>>()[..];
1325         let one_line_width = context.config.width_heuristics().fn_call_width;
1326         result = rewrite_call_inner(context, &result, fields, span, shape, one_line_width, false)?;
1327     }
1328
1329     if !where_clause_str.is_empty() && !where_clause_str.contains('\n')
1330         && (result.contains('\n')
1331             || offset.block_indent + result.len() + where_clause_str.len() + 1
1332                 > context.config.max_width())
1333     {
1334         // We need to put the where clause on a new line, but we didn't
1335         // know that earlier, so the where clause will not be indented properly.
1336         result.push('\n');
1337         result
1338             .push_str(&(offset.block_only() + (context.config.tab_spaces() - 1))
1339                 .to_string(context.config));
1340     }
1341     result.push_str(&where_clause_str);
1342
1343     Some(result)
1344 }
1345
1346 pub fn rewrite_type_alias(
1347     context: &RewriteContext,
1348     indent: Indent,
1349     ident: ast::Ident,
1350     ty: &ast::Ty,
1351     generics: &ast::Generics,
1352     vis: &ast::Visibility,
1353     span: Span,
1354 ) -> Option<String> {
1355     let mut result = String::with_capacity(128);
1356
1357     result.push_str(&format_visibility(vis));
1358     result.push_str("type ");
1359     result.push_str(&ident.to_string());
1360
1361     // 2 = `= `
1362     let g_shape = Shape::indented(indent, context.config)
1363         .offset_left(result.len())?
1364         .sub_width(2)?;
1365     let g_span = mk_sp(context.codemap.span_after(span, "type"), ty.span.lo());
1366     let generics_str = rewrite_generics(context, generics, g_shape, g_span)?;
1367     result.push_str(&generics_str);
1368
1369     let where_budget = context.budget(last_line_width(&result));
1370     let option = WhereClauseOption::snuggled(&result);
1371     let where_clause_str = rewrite_where_clause(
1372         context,
1373         &generics.where_clause,
1374         context.config.brace_style(),
1375         Shape::legacy(where_budget, indent),
1376         Density::Vertical,
1377         "=",
1378         Some(span.hi()),
1379         generics.span.hi(),
1380         option,
1381         false,
1382     )?;
1383     result.push_str(&where_clause_str);
1384     if where_clause_str.is_empty() {
1385         result.push_str(" =");
1386     } else {
1387         result.push_str(&format!("\n{}=", indent.to_string(context.config)));
1388     }
1389
1390     // 1 = ";"
1391     let ty_shape = Shape::indented(indent, context.config).sub_width(1)?;
1392     rewrite_assign_rhs(context, result, ty, ty_shape).map(|s| s + ";")
1393 }
1394
1395 fn type_annotation_spacing(config: &Config) -> (&str, &str) {
1396     (
1397         if config.space_before_colon() { " " } else { "" },
1398         if config.space_after_colon() { " " } else { "" },
1399     )
1400 }
1401
1402 pub fn rewrite_struct_field_prefix(
1403     context: &RewriteContext,
1404     field: &ast::StructField,
1405 ) -> Option<String> {
1406     let vis = format_visibility(&field.vis);
1407     let type_annotation_spacing = type_annotation_spacing(context.config);
1408     Some(match field.ident {
1409         Some(name) => format!("{}{}{}:", vis, name, type_annotation_spacing.0),
1410         None => format!("{}", vis),
1411     })
1412 }
1413
1414 impl Rewrite for ast::StructField {
1415     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1416         rewrite_struct_field(context, self, shape, 0)
1417     }
1418 }
1419
1420 pub fn rewrite_struct_field(
1421     context: &RewriteContext,
1422     field: &ast::StructField,
1423     shape: Shape,
1424     lhs_max_width: usize,
1425 ) -> Option<String> {
1426     if contains_skip(&field.attrs) {
1427         return Some(context.snippet(field.span()).to_owned());
1428     }
1429
1430     let type_annotation_spacing = type_annotation_spacing(context.config);
1431     let prefix = rewrite_struct_field_prefix(context, field)?;
1432
1433     let attrs_str = field.attrs.rewrite(context, shape)?;
1434     let attrs_extendable = field.ident.is_none() && is_attributes_extendable(&attrs_str);
1435     let missing_span = if field.attrs.is_empty() {
1436         mk_sp(field.span.lo(), field.span.lo())
1437     } else {
1438         mk_sp(field.attrs.last().unwrap().span.hi(), field.span.lo())
1439     };
1440     let mut spacing = String::from(if field.ident.is_some() {
1441         type_annotation_spacing.1
1442     } else {
1443         ""
1444     });
1445     // Try to put everything on a single line.
1446     let attr_prefix = combine_strs_with_missing_comments(
1447         context,
1448         &attrs_str,
1449         &prefix,
1450         missing_span,
1451         shape,
1452         attrs_extendable,
1453     )?;
1454     let overhead = last_line_width(&attr_prefix);
1455     let lhs_offset = lhs_max_width.checked_sub(overhead).unwrap_or(0);
1456     for _ in 0..lhs_offset {
1457         spacing.push(' ');
1458     }
1459     // In this extreme case we will be missing a space betweeen an attribute and a field.
1460     if prefix.is_empty() && !attrs_str.is_empty() && attrs_extendable && spacing.is_empty() {
1461         spacing.push(' ');
1462     }
1463     let orig_ty = shape
1464         .offset_left(overhead + spacing.len())
1465         .and_then(|ty_shape| field.ty.rewrite(context, ty_shape));
1466     if let Some(ref ty) = orig_ty {
1467         if !ty.contains('\n') {
1468             return Some(attr_prefix + &spacing + ty);
1469         }
1470     }
1471
1472     let is_prefix_empty = prefix.is_empty();
1473     // We must use multiline. We are going to put attributes and a field on different lines.
1474     let field_str = rewrite_assign_rhs(context, prefix, &*field.ty, shape)?;
1475     // Remove a leading white-space from `rewrite_assign_rhs()` when rewriting a tuple struct.
1476     let field_str = if is_prefix_empty {
1477         field_str.trim_left()
1478     } else {
1479         &field_str
1480     };
1481     combine_strs_with_missing_comments(context, &attrs_str, field_str, missing_span, shape, false)
1482 }
1483
1484 pub struct StaticParts<'a> {
1485     prefix: &'a str,
1486     vis: &'a ast::Visibility,
1487     ident: ast::Ident,
1488     ty: &'a ast::Ty,
1489     mutability: ast::Mutability,
1490     expr_opt: Option<&'a ptr::P<ast::Expr>>,
1491     defaultness: Option<ast::Defaultness>,
1492     span: Span,
1493 }
1494
1495 impl<'a> StaticParts<'a> {
1496     pub fn from_item(item: &'a ast::Item) -> Self {
1497         let (prefix, ty, mutability, expr) = match item.node {
1498             ast::ItemKind::Static(ref ty, mutability, ref expr) => ("static", ty, mutability, expr),
1499             ast::ItemKind::Const(ref ty, ref expr) => {
1500                 ("const", ty, ast::Mutability::Immutable, expr)
1501             }
1502             _ => unreachable!(),
1503         };
1504         StaticParts {
1505             prefix: prefix,
1506             vis: &item.vis,
1507             ident: item.ident,
1508             ty: ty,
1509             mutability: mutability,
1510             expr_opt: Some(expr),
1511             defaultness: None,
1512             span: item.span,
1513         }
1514     }
1515
1516     pub fn from_trait_item(ti: &'a ast::TraitItem) -> Self {
1517         let (ty, expr_opt) = match ti.node {
1518             ast::TraitItemKind::Const(ref ty, ref expr_opt) => (ty, expr_opt),
1519             _ => unreachable!(),
1520         };
1521         StaticParts {
1522             prefix: "const",
1523             vis: &ast::Visibility::Inherited,
1524             ident: ti.ident,
1525             ty: ty,
1526             mutability: ast::Mutability::Immutable,
1527             expr_opt: expr_opt.as_ref(),
1528             defaultness: None,
1529             span: ti.span,
1530         }
1531     }
1532
1533     pub fn from_impl_item(ii: &'a ast::ImplItem) -> Self {
1534         let (ty, expr) = match ii.node {
1535             ast::ImplItemKind::Const(ref ty, ref expr) => (ty, expr),
1536             _ => unreachable!(),
1537         };
1538         StaticParts {
1539             prefix: "const",
1540             vis: &ii.vis,
1541             ident: ii.ident,
1542             ty: ty,
1543             mutability: ast::Mutability::Immutable,
1544             expr_opt: Some(expr),
1545             defaultness: Some(ii.defaultness),
1546             span: ii.span,
1547         }
1548     }
1549 }
1550
1551 fn rewrite_static(
1552     context: &RewriteContext,
1553     static_parts: &StaticParts,
1554     offset: Indent,
1555 ) -> Option<String> {
1556     let colon = colon_spaces(
1557         context.config.space_before_colon(),
1558         context.config.space_after_colon(),
1559     );
1560     let mut prefix = format!(
1561         "{}{}{} {}{}{}",
1562         format_visibility(static_parts.vis),
1563         static_parts.defaultness.map_or("", format_defaultness),
1564         static_parts.prefix,
1565         format_mutability(static_parts.mutability),
1566         static_parts.ident,
1567         colon,
1568     );
1569     // 2 = " =".len()
1570     let ty_shape =
1571         Shape::indented(offset.block_only(), context.config).offset_left(prefix.len() + 2)?;
1572     let ty_str = match static_parts.ty.rewrite(context, ty_shape) {
1573         Some(ty_str) => ty_str,
1574         None => {
1575             if prefix.ends_with(' ') {
1576                 prefix.pop();
1577             }
1578             let nested_indent = offset.block_indent(context.config);
1579             let nested_shape = Shape::indented(nested_indent, context.config);
1580             let ty_str = static_parts.ty.rewrite(context, nested_shape)?;
1581             format!("\n{}{}", nested_indent.to_string(context.config), ty_str)
1582         }
1583     };
1584
1585     if let Some(expr) = static_parts.expr_opt {
1586         let lhs = format!("{}{} =", prefix, ty_str);
1587         // 1 = ;
1588         let remaining_width = context.budget(offset.block_indent + 1);
1589         rewrite_assign_rhs(
1590             context,
1591             lhs,
1592             &**expr,
1593             Shape::legacy(remaining_width, offset.block_only()),
1594         ).and_then(|res| recover_comment_removed(res, static_parts.span, context))
1595             .map(|s| if s.ends_with(';') { s } else { s + ";" })
1596     } else {
1597         Some(format!("{}{};", prefix, ty_str))
1598     }
1599 }
1600
1601 pub fn rewrite_associated_type(
1602     ident: ast::Ident,
1603     ty_opt: Option<&ptr::P<ast::Ty>>,
1604     ty_param_bounds_opt: Option<&ast::TyParamBounds>,
1605     context: &RewriteContext,
1606     indent: Indent,
1607 ) -> Option<String> {
1608     let prefix = format!("type {}", ident);
1609
1610     let type_bounds_str = if let Some(bounds) = ty_param_bounds_opt {
1611         // 2 = ": ".len()
1612         let shape = Shape::indented(indent, context.config).offset_left(prefix.len() + 2)?;
1613         let bound_str = bounds
1614             .iter()
1615             .map(|ty_bound| ty_bound.rewrite(context, shape))
1616             .collect::<Option<Vec<_>>>()?;
1617         if !bounds.is_empty() {
1618             format!(": {}", join_bounds(context, shape, &bound_str))
1619         } else {
1620             String::new()
1621         }
1622     } else {
1623         String::new()
1624     };
1625
1626     if let Some(ty) = ty_opt {
1627         // 1 = `;`
1628         let shape = Shape::indented(indent, context.config).sub_width(1)?;
1629         let lhs = format!("{}{} =", prefix, type_bounds_str);
1630         rewrite_assign_rhs(context, lhs, &**ty, shape).map(|s| s + ";")
1631     } else {
1632         Some(format!("{}{};", prefix, type_bounds_str))
1633     }
1634 }
1635
1636 pub fn rewrite_associated_impl_type(
1637     ident: ast::Ident,
1638     defaultness: ast::Defaultness,
1639     ty_opt: Option<&ptr::P<ast::Ty>>,
1640     ty_param_bounds_opt: Option<&ast::TyParamBounds>,
1641     context: &RewriteContext,
1642     indent: Indent,
1643 ) -> Option<String> {
1644     let result = rewrite_associated_type(ident, ty_opt, ty_param_bounds_opt, context, indent)?;
1645
1646     match defaultness {
1647         ast::Defaultness::Default => Some(format!("default {}", result)),
1648         _ => Some(result),
1649     }
1650 }
1651
1652 impl Rewrite for ast::FunctionRetTy {
1653     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1654         match *self {
1655             ast::FunctionRetTy::Default(_) => Some(String::new()),
1656             ast::FunctionRetTy::Ty(ref ty) => {
1657                 let inner_width = shape.width.checked_sub(3)?;
1658                 ty.rewrite(context, Shape::legacy(inner_width, shape.indent + 3))
1659                     .map(|r| format!("-> {}", r))
1660             }
1661         }
1662     }
1663 }
1664
1665 fn is_empty_infer(context: &RewriteContext, ty: &ast::Ty) -> bool {
1666     match ty.node {
1667         ast::TyKind::Infer => {
1668             let original = context.snippet(ty.span);
1669             original != "_"
1670         }
1671         _ => false,
1672     }
1673 }
1674
1675 impl Rewrite for ast::Arg {
1676     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
1677         if is_named_arg(self) {
1678             let mut result = self.pat
1679                 .rewrite(context, Shape::legacy(shape.width, shape.indent))?;
1680
1681             if !is_empty_infer(context, &*self.ty) {
1682                 if context.config.space_before_colon() {
1683                     result.push_str(" ");
1684                 }
1685                 result.push_str(":");
1686                 if context.config.space_after_colon() {
1687                     result.push_str(" ");
1688                 }
1689                 let overhead = last_line_width(&result);
1690                 let max_width = shape.width.checked_sub(overhead)?;
1691                 let ty_str = self.ty
1692                     .rewrite(context, Shape::legacy(max_width, shape.indent))?;
1693                 result.push_str(&ty_str);
1694             }
1695
1696             Some(result)
1697         } else {
1698             self.ty.rewrite(context, shape)
1699         }
1700     }
1701 }
1702
1703 fn rewrite_explicit_self(
1704     explicit_self: &ast::ExplicitSelf,
1705     args: &[ast::Arg],
1706     context: &RewriteContext,
1707 ) -> Option<String> {
1708     match explicit_self.node {
1709         ast::SelfKind::Region(lt, m) => {
1710             let mut_str = format_mutability(m);
1711             match lt {
1712                 Some(ref l) => {
1713                     let lifetime_str = l.rewrite(
1714                         context,
1715                         Shape::legacy(context.config.max_width(), Indent::empty()),
1716                     )?;
1717                     Some(format!("&{} {}self", lifetime_str, mut_str))
1718                 }
1719                 None => Some(format!("&{}self", mut_str)),
1720             }
1721         }
1722         ast::SelfKind::Explicit(ref ty, _) => {
1723             assert!(!args.is_empty(), "&[ast::Arg] shouldn't be empty.");
1724
1725             let mutability = explicit_self_mutability(&args[0]);
1726             let type_str = ty.rewrite(
1727                 context,
1728                 Shape::legacy(context.config.max_width(), Indent::empty()),
1729             )?;
1730
1731             Some(format!(
1732                 "{}self: {}",
1733                 format_mutability(mutability),
1734                 type_str
1735             ))
1736         }
1737         ast::SelfKind::Value(_) => {
1738             assert!(!args.is_empty(), "&[ast::Arg] shouldn't be empty.");
1739
1740             let mutability = explicit_self_mutability(&args[0]);
1741
1742             Some(format!("{}self", format_mutability(mutability)))
1743         }
1744     }
1745 }
1746
1747 // Hacky solution caused by absence of `Mutability` in `SelfValue` and
1748 // `SelfExplicit` variants of `ast::ExplicitSelf_`.
1749 fn explicit_self_mutability(arg: &ast::Arg) -> ast::Mutability {
1750     if let ast::PatKind::Ident(ast::BindingMode::ByValue(mutability), _, _) = arg.pat.node {
1751         mutability
1752     } else {
1753         unreachable!()
1754     }
1755 }
1756
1757 pub fn span_lo_for_arg(arg: &ast::Arg) -> BytePos {
1758     if is_named_arg(arg) {
1759         arg.pat.span.lo()
1760     } else {
1761         arg.ty.span.lo()
1762     }
1763 }
1764
1765 pub fn span_hi_for_arg(context: &RewriteContext, arg: &ast::Arg) -> BytePos {
1766     match arg.ty.node {
1767         ast::TyKind::Infer if context.snippet(arg.ty.span) == "_" => arg.ty.span.hi(),
1768         ast::TyKind::Infer if is_named_arg(arg) => arg.pat.span.hi(),
1769         _ => arg.ty.span.hi(),
1770     }
1771 }
1772
1773 pub fn is_named_arg(arg: &ast::Arg) -> bool {
1774     if let ast::PatKind::Ident(_, ident, _) = arg.pat.node {
1775         ident.node != symbol::keywords::Invalid.ident()
1776     } else {
1777         true
1778     }
1779 }
1780
1781 // Return type is (result, force_new_line_for_brace)
1782 fn rewrite_fn_base(
1783     context: &RewriteContext,
1784     indent: Indent,
1785     ident: ast::Ident,
1786     fn_sig: &FnSig,
1787     span: Span,
1788     newline_brace: bool,
1789     has_body: bool,
1790 ) -> Option<(String, bool)> {
1791     let mut force_new_line_for_brace = false;
1792
1793     let where_clause = &fn_sig.generics.where_clause;
1794
1795     let mut result = String::with_capacity(1024);
1796     result.push_str(&fn_sig.to_str(context));
1797
1798     // fn foo
1799     result.push_str("fn ");
1800     result.push_str(&ident.to_string());
1801
1802     // Generics.
1803     let overhead = if has_body && !newline_brace {
1804         // 4 = `() {`
1805         4
1806     } else {
1807         // 2 = `()`
1808         2
1809     };
1810     let used_width = last_line_used_width(&result, indent.width());
1811     let one_line_budget = context.budget(used_width + overhead);
1812     let shape = Shape {
1813         width: one_line_budget,
1814         indent: indent,
1815         offset: used_width,
1816     };
1817     let fd = fn_sig.decl;
1818     let g_span = mk_sp(span.lo(), fd.output.span().lo());
1819     let generics_str = rewrite_generics(context, fn_sig.generics, shape, g_span)?;
1820     result.push_str(&generics_str);
1821
1822     let snuggle_angle_bracket = generics_str
1823         .lines()
1824         .last()
1825         .map_or(false, |l| l.trim_left().len() == 1);
1826
1827     // Note that the width and indent don't really matter, we'll re-layout the
1828     // return type later anyway.
1829     let ret_str = fd.output
1830         .rewrite(context, Shape::indented(indent, context.config))?;
1831
1832     let multi_line_ret_str = ret_str.contains('\n');
1833     let ret_str_len = if multi_line_ret_str { 0 } else { ret_str.len() };
1834
1835     // Args.
1836     let (one_line_budget, multi_line_budget, mut arg_indent) = compute_budgets_for_args(
1837         context,
1838         &result,
1839         indent,
1840         ret_str_len,
1841         newline_brace,
1842         has_body,
1843         multi_line_ret_str,
1844     )?;
1845
1846     debug!(
1847         "rewrite_fn_base: one_line_budget: {}, multi_line_budget: {}, arg_indent: {:?}",
1848         one_line_budget, multi_line_budget, arg_indent
1849     );
1850
1851     // Check if vertical layout was forced.
1852     if one_line_budget == 0 {
1853         if snuggle_angle_bracket {
1854             result.push('(');
1855         } else {
1856             result.push_str("(");
1857             if context.config.indent_style() == IndentStyle::Visual {
1858                 result.push('\n');
1859                 result.push_str(&arg_indent.to_string(context.config));
1860             }
1861         }
1862     } else {
1863         result.push('(');
1864     }
1865     if context.config.spaces_within_parens_and_brackets() && !fd.inputs.is_empty()
1866         && result.ends_with('(')
1867     {
1868         result.push(' ')
1869     }
1870
1871     // Skip `pub(crate)`.
1872     let lo_after_visibility = get_bytepos_after_visibility(context, &fn_sig.visibility, span, ")");
1873     // A conservative estimation, to goal is to be over all parens in generics
1874     let args_start = fn_sig
1875         .generics
1876         .params
1877         .iter()
1878         .last()
1879         .map_or(lo_after_visibility, |param| param.span().hi());
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     if generics.params.is_empty() {
2350         return Some(String::new());
2351     }
2352
2353     let items = itemize_list(
2354         context.codemap,
2355         generics.params.iter(),
2356         ">",
2357         ",",
2358         |arg| arg.span().lo(),
2359         |arg| arg.span().hi(),
2360         |arg| arg.rewrite(context, shape),
2361         context.codemap.span_after(span, "<"),
2362         span.hi(),
2363         false,
2364     );
2365     format_generics_item_list(context, items, shape, one_line_width)
2366 }
2367
2368 pub fn generics_shape_from_config(config: &Config, shape: Shape, offset: usize) -> Option<Shape> {
2369     match config.indent_style() {
2370         IndentStyle::Visual => shape.visual_indent(1 + offset).sub_width(offset + 2),
2371         IndentStyle::Block => {
2372             // 1 = ","
2373             shape
2374                 .block()
2375                 .block_indent(config.tab_spaces())
2376                 .with_max_width(config)
2377                 .sub_width(1)
2378         }
2379     }
2380 }
2381
2382 pub fn format_generics_item_list<I>(
2383     context: &RewriteContext,
2384     items: I,
2385     shape: Shape,
2386     one_line_budget: usize,
2387 ) -> Option<String>
2388 where
2389     I: Iterator<Item = ListItem>,
2390 {
2391     let item_vec = items.collect::<Vec<_>>();
2392
2393     let tactic = definitive_tactic(
2394         &item_vec,
2395         ListTactic::HorizontalVertical,
2396         Separator::Comma,
2397         one_line_budget,
2398     );
2399     let fmt = ListFormatting {
2400         tactic: tactic,
2401         separator: ",",
2402         trailing_separator: if context.config.indent_style() == IndentStyle::Visual {
2403             SeparatorTactic::Never
2404         } else {
2405             context.config.trailing_comma()
2406         },
2407         separator_place: SeparatorPlace::Back,
2408         shape: shape,
2409         ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
2410         preserve_newline: true,
2411         config: context.config,
2412     };
2413
2414     let list_str = write_list(&item_vec, &fmt)?;
2415
2416     Some(wrap_generics_with_angle_brackets(
2417         context,
2418         &list_str,
2419         shape.indent,
2420     ))
2421 }
2422
2423 pub fn wrap_generics_with_angle_brackets(
2424     context: &RewriteContext,
2425     list_str: &str,
2426     list_offset: Indent,
2427 ) -> String {
2428     if context.config.indent_style() == IndentStyle::Block
2429         && (list_str.contains('\n') || list_str.ends_with(','))
2430     {
2431         format!(
2432             "<\n{}{}\n{}>",
2433             list_offset.to_string(context.config),
2434             list_str,
2435             list_offset
2436                 .block_unindent(context.config)
2437                 .to_string(context.config)
2438         )
2439     } else if context.config.spaces_within_parens_and_brackets() {
2440         format!("< {} >", list_str)
2441     } else {
2442         format!("<{}>", list_str)
2443     }
2444 }
2445
2446 fn rewrite_trait_bounds(
2447     context: &RewriteContext,
2448     bounds: &[ast::TyParamBound],
2449     shape: Shape,
2450 ) -> Option<String> {
2451     if bounds.is_empty() {
2452         return Some(String::new());
2453     }
2454     let bound_str = bounds
2455         .iter()
2456         .map(|ty_bound| ty_bound.rewrite(context, shape))
2457         .collect::<Option<Vec<_>>>()?;
2458     Some(format!(": {}", join_bounds(context, shape, &bound_str)))
2459 }
2460
2461 fn rewrite_where_clause_rfc_style(
2462     context: &RewriteContext,
2463     where_clause: &ast::WhereClause,
2464     shape: Shape,
2465     terminator: &str,
2466     span_end: Option<BytePos>,
2467     span_end_before_where: BytePos,
2468     where_clause_option: WhereClauseOption,
2469     is_args_multi_line: bool,
2470 ) -> Option<String> {
2471     let block_shape = shape.block().with_max_width(context.config);
2472
2473     let (span_before, span_after) =
2474         missing_span_before_after_where(span_end_before_where, where_clause);
2475     let (comment_before, comment_after) =
2476         rewrite_comments_before_after_where(context, span_before, span_after, shape)?;
2477
2478     let starting_newline = if where_clause_option.snuggle && comment_before.is_empty() {
2479         " ".to_owned()
2480     } else {
2481         "\n".to_owned() + &block_shape.indent.to_string(context.config)
2482     };
2483
2484     let clause_shape = block_shape.block_left(context.config.tab_spaces())?;
2485     // 1 = `,`
2486     let clause_shape = clause_shape.sub_width(1)?;
2487     // each clause on one line, trailing comma (except if suppress_comma)
2488     let span_start = where_clause.predicates[0].span().lo();
2489     // If we don't have the start of the next span, then use the end of the
2490     // predicates, but that means we miss comments.
2491     let len = where_clause.predicates.len();
2492     let end_of_preds = where_clause.predicates[len - 1].span().hi();
2493     let span_end = span_end.unwrap_or(end_of_preds);
2494     let items = itemize_list(
2495         context.codemap,
2496         where_clause.predicates.iter(),
2497         terminator,
2498         ",",
2499         |pred| pred.span().lo(),
2500         |pred| pred.span().hi(),
2501         |pred| pred.rewrite(context, clause_shape),
2502         span_start,
2503         span_end,
2504         false,
2505     );
2506     let where_single_line = context.config.where_single_line() && len == 1 && !is_args_multi_line;
2507     let comma_tactic = if where_clause_option.suppress_comma || where_single_line {
2508         SeparatorTactic::Never
2509     } else {
2510         context.config.trailing_comma()
2511     };
2512
2513     // shape should be vertical only and only if we have `where_single_line` option enabled
2514     // and the number of items of the where clause is equal to 1
2515     let shape_tactic = if where_single_line {
2516         DefinitiveListTactic::Horizontal
2517     } else {
2518         DefinitiveListTactic::Vertical
2519     };
2520
2521     let fmt = ListFormatting {
2522         tactic: shape_tactic,
2523         separator: ",",
2524         trailing_separator: comma_tactic,
2525         separator_place: SeparatorPlace::Back,
2526         shape: clause_shape,
2527         ends_with_newline: true,
2528         preserve_newline: true,
2529         config: context.config,
2530     };
2531     let preds_str = write_list(&items.collect::<Vec<_>>(), &fmt)?;
2532
2533     let comment_separator = |comment: &str, shape: Shape| {
2534         if comment.is_empty() {
2535             String::new()
2536         } else {
2537             format!("\n{}", shape.indent.to_string(context.config))
2538         }
2539     };
2540     let newline_before_where = comment_separator(&comment_before, shape);
2541     let newline_after_where = comment_separator(&comment_after, clause_shape);
2542
2543     // 6 = `where `
2544     let clause_sep = if where_clause_option.compress_where && comment_before.is_empty()
2545         && comment_after.is_empty() && !preds_str.contains('\n')
2546         && 6 + preds_str.len() <= shape.width || where_single_line
2547     {
2548         String::from(" ")
2549     } else {
2550         format!("\n{}", clause_shape.indent.to_string(context.config))
2551     };
2552     Some(format!(
2553         "{}{}{}where{}{}{}{}",
2554         starting_newline,
2555         comment_before,
2556         newline_before_where,
2557         newline_after_where,
2558         comment_after,
2559         clause_sep,
2560         preds_str
2561     ))
2562 }
2563
2564 fn rewrite_where_clause(
2565     context: &RewriteContext,
2566     where_clause: &ast::WhereClause,
2567     brace_style: BraceStyle,
2568     shape: Shape,
2569     density: Density,
2570     terminator: &str,
2571     span_end: Option<BytePos>,
2572     span_end_before_where: BytePos,
2573     where_clause_option: WhereClauseOption,
2574     is_args_multi_line: bool,
2575 ) -> Option<String> {
2576     if where_clause.predicates.is_empty() {
2577         return Some(String::new());
2578     }
2579
2580     if context.config.indent_style() == IndentStyle::Block {
2581         return rewrite_where_clause_rfc_style(
2582             context,
2583             where_clause,
2584             shape,
2585             terminator,
2586             span_end,
2587             span_end_before_where,
2588             where_clause_option,
2589             is_args_multi_line,
2590         );
2591     }
2592
2593     let extra_indent = Indent::new(context.config.tab_spaces(), 0);
2594
2595     let offset = match context.config.indent_style() {
2596         IndentStyle::Block => shape.indent + extra_indent.block_indent(context.config),
2597         // 6 = "where ".len()
2598         IndentStyle::Visual => shape.indent + extra_indent + 6,
2599     };
2600     // FIXME: if indent_style != Visual, then the budgets below might
2601     // be out by a char or two.
2602
2603     let budget = context.config.max_width() - offset.width();
2604     let span_start = where_clause.predicates[0].span().lo();
2605     // If we don't have the start of the next span, then use the end of the
2606     // predicates, but that means we miss comments.
2607     let len = where_clause.predicates.len();
2608     let end_of_preds = where_clause.predicates[len - 1].span().hi();
2609     let span_end = span_end.unwrap_or(end_of_preds);
2610     let items = itemize_list(
2611         context.codemap,
2612         where_clause.predicates.iter(),
2613         terminator,
2614         ",",
2615         |pred| pred.span().lo(),
2616         |pred| pred.span().hi(),
2617         |pred| pred.rewrite(context, Shape::legacy(budget, offset)),
2618         span_start,
2619         span_end,
2620         false,
2621     );
2622     let item_vec = items.collect::<Vec<_>>();
2623     // FIXME: we don't need to collect here
2624     let tactic = definitive_tactic(&item_vec, ListTactic::Vertical, Separator::Comma, budget);
2625
2626     let mut comma_tactic = context.config.trailing_comma();
2627     // Kind of a hack because we don't usually have trailing commas in where clauses.
2628     if comma_tactic == SeparatorTactic::Vertical || where_clause_option.suppress_comma {
2629         comma_tactic = SeparatorTactic::Never;
2630     }
2631
2632     let fmt = ListFormatting {
2633         tactic: tactic,
2634         separator: ",",
2635         trailing_separator: comma_tactic,
2636         separator_place: SeparatorPlace::Back,
2637         shape: Shape::legacy(budget, offset),
2638         ends_with_newline: tactic.ends_with_newline(context.config.indent_style()),
2639         preserve_newline: true,
2640         config: context.config,
2641     };
2642     let preds_str = write_list(&item_vec, &fmt)?;
2643
2644     let end_length = if terminator == "{" {
2645         // If the brace is on the next line we don't need to count it otherwise it needs two
2646         // characters " {"
2647         match brace_style {
2648             BraceStyle::AlwaysNextLine | BraceStyle::SameLineWhere => 0,
2649             BraceStyle::PreferSameLine => 2,
2650         }
2651     } else if terminator == "=" {
2652         2
2653     } else {
2654         terminator.len()
2655     };
2656     if density == Density::Tall || preds_str.contains('\n')
2657         || shape.indent.width() + " where ".len() + preds_str.len() + end_length > shape.width
2658     {
2659         Some(format!(
2660             "\n{}where {}",
2661             (shape.indent + extra_indent).to_string(context.config),
2662             preds_str
2663         ))
2664     } else {
2665         Some(format!(" where {}", preds_str))
2666     }
2667 }
2668
2669 fn missing_span_before_after_where(
2670     before_item_span_end: BytePos,
2671     where_clause: &ast::WhereClause,
2672 ) -> (Span, Span) {
2673     let missing_span_before = mk_sp(before_item_span_end, where_clause.span.lo());
2674     // 5 = `where`
2675     let pos_after_where = where_clause.span.lo() + BytePos(5);
2676     let missing_span_after = mk_sp(pos_after_where, where_clause.predicates[0].span().lo());
2677     (missing_span_before, missing_span_after)
2678 }
2679
2680 fn rewrite_comments_before_after_where(
2681     context: &RewriteContext,
2682     span_before_where: Span,
2683     span_after_where: Span,
2684     shape: Shape,
2685 ) -> Option<(String, String)> {
2686     let before_comment = rewrite_missing_comment(span_before_where, shape, context)?;
2687     let after_comment = rewrite_missing_comment(
2688         span_after_where,
2689         shape.block_indent(context.config.tab_spaces()),
2690         context,
2691     )?;
2692     Some((before_comment, after_comment))
2693 }
2694
2695 fn format_header(item_name: &str, ident: ast::Ident, vis: &ast::Visibility) -> String {
2696     format!("{}{}{}", format_visibility(vis), item_name, ident)
2697 }
2698
2699 #[derive(PartialEq, Eq, Clone, Copy)]
2700 enum BracePos {
2701     None,
2702     Auto,
2703     ForceSameLine,
2704 }
2705
2706 fn format_generics(
2707     context: &RewriteContext,
2708     generics: &ast::Generics,
2709     brace_style: BraceStyle,
2710     brace_pos: BracePos,
2711     offset: Indent,
2712     span: Span,
2713     used_width: usize,
2714 ) -> Option<String> {
2715     let shape = Shape::legacy(context.budget(used_width + offset.width()), offset);
2716     let mut result = rewrite_generics(context, generics, shape, span)?;
2717
2718     let same_line_brace = if !generics.where_clause.predicates.is_empty() || result.contains('\n') {
2719         let budget = context.budget(last_line_used_width(&result, offset.width()));
2720         let mut option = WhereClauseOption::snuggled(&result);
2721         if brace_pos == BracePos::None {
2722             option.suppress_comma = true;
2723         }
2724         // If the generics are not parameterized then generics.span.hi() == 0,
2725         // so we use span.lo(), which is the position after `struct Foo`.
2726         let span_end_before_where = if generics.is_parameterized() {
2727             generics.span.hi()
2728         } else {
2729             span.lo()
2730         };
2731         let where_clause_str = rewrite_where_clause(
2732             context,
2733             &generics.where_clause,
2734             brace_style,
2735             Shape::legacy(budget, offset.block_only()),
2736             Density::Tall,
2737             "{",
2738             Some(span.hi()),
2739             span_end_before_where,
2740             option,
2741             false,
2742         )?;
2743         result.push_str(&where_clause_str);
2744         brace_pos == BracePos::ForceSameLine || brace_style == BraceStyle::PreferSameLine
2745             || (generics.where_clause.predicates.is_empty()
2746                 && trimmed_last_line_width(&result) == 1)
2747     } else {
2748         brace_pos == BracePos::ForceSameLine || trimmed_last_line_width(&result) == 1
2749             || brace_style != BraceStyle::AlwaysNextLine
2750     };
2751     if brace_pos == BracePos::None {
2752         return Some(result);
2753     }
2754     let total_used_width = last_line_used_width(&result, used_width);
2755     let remaining_budget = context.budget(total_used_width);
2756     // If the same line brace if forced, it indicates that we are rewriting an item with empty body,
2757     // and hence we take the closer into account as well for one line budget.
2758     // We assume that the closer has the same length as the opener.
2759     let overhead = if brace_pos == BracePos::ForceSameLine {
2760         // 3 = ` {}`
2761         3
2762     } else {
2763         // 2 = ` {`
2764         2
2765     };
2766     let forbid_same_line_brace = overhead > remaining_budget;
2767     if !forbid_same_line_brace && same_line_brace {
2768         result.push(' ');
2769     } else {
2770         result.push('\n');
2771         result.push_str(&offset.block_only().to_string(context.config));
2772     }
2773     result.push('{');
2774
2775     Some(result)
2776 }
2777
2778 impl Rewrite for ast::ForeignItem {
2779     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
2780         let attrs_str = self.attrs.rewrite(context, shape)?;
2781         // Drop semicolon or it will be interpreted as comment.
2782         // FIXME: this may be a faulty span from libsyntax.
2783         let span = mk_sp(self.span.lo(), self.span.hi() - BytePos(1));
2784
2785         let item_str = match self.node {
2786             ast::ForeignItemKind::Fn(ref fn_decl, ref generics) => {
2787                 rewrite_fn_base(
2788                     context,
2789                     shape.indent,
2790                     self.ident,
2791                     &FnSig::new(fn_decl, generics, self.vis.clone()),
2792                     span,
2793                     false,
2794                     false,
2795                 ).map(|(s, _)| format!("{};", s))
2796             }
2797             ast::ForeignItemKind::Static(ref ty, is_mutable) => {
2798                 // FIXME(#21): we're dropping potential comments in between the
2799                 // function keywords here.
2800                 let vis = format_visibility(&self.vis);
2801                 let mut_str = if is_mutable { "mut " } else { "" };
2802                 let prefix = format!("{}static {}{}:", vis, mut_str, self.ident);
2803                 // 1 = ;
2804                 let shape = shape.sub_width(1)?;
2805                 ty.rewrite(context, shape).map(|ty_str| {
2806                     // 1 = space between prefix and type.
2807                     let sep = if prefix.len() + ty_str.len() + 1 <= shape.width {
2808                         String::from(" ")
2809                     } else {
2810                         let nested_indent = shape.indent.block_indent(context.config);
2811                         format!("\n{}", nested_indent.to_string(context.config))
2812                     };
2813                     format!("{}{}{};", prefix, sep, ty_str)
2814                 })
2815             }
2816             ast::ForeignItemKind::Ty => {
2817                 let vis = format_visibility(&self.vis);
2818                 Some(format!("{}type {};", vis, self.ident))
2819             }
2820         }?;
2821
2822         let missing_span = if self.attrs.is_empty() {
2823             mk_sp(self.span.lo(), self.span.lo())
2824         } else {
2825             mk_sp(self.attrs[self.attrs.len() - 1].span.hi(), self.span.lo())
2826         };
2827         combine_strs_with_missing_comments(
2828             context,
2829             &attrs_str,
2830             &item_str,
2831             missing_span,
2832             shape,
2833             false,
2834         )
2835     }
2836 }
2837
2838 impl Rewrite for ast::GenericParam {
2839     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
2840         match *self {
2841             ast::GenericParam::Lifetime(ref lifetime_def) => lifetime_def.rewrite(context, shape),
2842             ast::GenericParam::Type(ref ty) => ty.rewrite(context, shape),
2843         }
2844     }
2845 }