src/items.rs

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