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