src/macros.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 // Format list-like macro invocations. These are invocations whose token trees
  12 // can be interpreted as expressions and separated by commas.
  13 // Note that these token trees do not actually have to be interpreted as
  14 // expressions by the compiler. An example of an invocation we would reformat is
  15 // foo!( x, y, z ). The token x may represent an identifier in the code, but we
  16 // interpreted as an expression.
  17 // Macro uses which are not-list like, such as bar!(key => val), will not be
  18 // reformatted.
  19 // List-like invocations with parentheses will be formatted as function calls,
  20 // and those with brackets will be formatted as array literals.
  21
  22 use std::collections::HashMap;
  23
  24 use config::lists::*;
  25 use syntax::parse::new_parser_from_tts;
  26 use syntax::parse::parser::Parser;
  27 use syntax::parse::token::{BinOpToken, DelimToken, Token};
  28 use syntax::print::pprust;
  29 use syntax::source_map::{BytePos, Span};
  30 use syntax::symbol;
  31 use syntax::tokenstream::{Cursor, ThinTokenStream, TokenStream, TokenTree};
  32 use syntax::ThinVec;
  33 use syntax::{ast, ptr};
  34
  35 use comment::{
  36     contains_comment, remove_trailing_white_spaces, CharClasses, FindUncommented, FullCodeCharKind,
  37     LineClasses,
  38 };
  39 use expr::rewrite_array;
  40 use lists::{itemize_list, write_list, ListFormatting};
  41 use overflow;
  42 use rewrite::{Rewrite, RewriteContext};
  43 use shape::{Indent, Shape};
  44 use source_map::SpanUtils;
  45 use spanned::Spanned;
  46 use utils::{format_visibility, mk_sp, rewrite_ident, wrap_str};
  47
  48 const FORCED_BRACKET_MACROS: &[&str] = &["vec!"];
  49
  50 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
  51 pub enum MacroPosition {
  52     Item,
  53     Statement,
  54     Expression,
  55     Pat,
  56 }
  57
  58 #[derive(Debug)]
  59 pub enum MacroArg {
  60     Expr(ptr::P<ast::Expr>),
  61     Ty(ptr::P<ast::Ty>),
  62     Pat(ptr::P<ast::Pat>),
  63     Item(ptr::P<ast::Item>),
  64 }
  65
  66 impl Rewrite for ast::Item {
  67     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  68         let mut visitor = ::visitor::FmtVisitor::from_context(context);
  69         visitor.block_indent = shape.indent;
  70         visitor.last_pos = self.span().lo();
  71         visitor.visit_item(self);
  72         Some(visitor.buffer.to_owned())
  73     }
  74 }
  75
  76 impl Rewrite for MacroArg {
  77     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  78         match *self {
  79             MacroArg::Expr(ref expr) => expr.rewrite(context, shape),
  80             MacroArg::Ty(ref ty) => ty.rewrite(context, shape),
  81             MacroArg::Pat(ref pat) => pat.rewrite(context, shape),
  82             MacroArg::Item(ref item) => item.rewrite(context, shape),
  83         }
  84     }
  85 }
  86
  87 fn parse_macro_arg(parser: &mut Parser) -> Option<MacroArg> {
  88     macro_rules! parse_macro_arg {
  89         ($macro_arg:ident, $parser:ident, $f:expr) => {
  90             let mut cloned_parser = (*parser).clone();
  91             match cloned_parser.$parser() {
  92                 Ok(x) => {
  93                     if parser.sess.span_diagnostic.has_errors() {
  94                         parser.sess.span_diagnostic.reset_err_count();
  95                     } else {
  96                         // Parsing succeeded.
  97                         *parser = cloned_parser;
  98                         return Some(MacroArg::$macro_arg($f(x)?));
  99                     }
 100                 }
 101                 Err(mut e) => {
 102                     e.cancel();
 103                     parser.sess.span_diagnostic.reset_err_count();
 104                 }
 105             }
 106         };
 107     }
 108
 109     parse_macro_arg!(Expr, parse_expr, |x: ptr::P<ast::Expr>| Some(x));
 110     parse_macro_arg!(Ty, parse_ty, |x: ptr::P<ast::Ty>| Some(x));
 111     parse_macro_arg!(Pat, parse_pat, |x: ptr::P<ast::Pat>| Some(x));
 112     // `parse_item` returns `Option<ptr::P<ast::Item>>`.
 113     parse_macro_arg!(Item, parse_item, |x: Option<ptr::P<ast::Item>>| x);
 114
 115     None
 116 }
 117
 118 /// Rewrite macro name without using pretty-printer if possible.
 119 fn rewrite_macro_name(
 120     context: &RewriteContext,
 121     path: &ast::Path,
 122     extra_ident: Option<ast::Ident>,
 123 ) -> String {
 124     let name = if path.segments.len() == 1 {
 125         // Avoid using pretty-printer in the common case.
 126         format!("{}!", rewrite_ident(context, path.segments[0].ident))
 127     } else {
 128         format!("{}!", path)
 129     };
 130     match extra_ident {
 131         Some(ident) if ident != symbol::keywords::Invalid.ident() => format!("{} {}", name, ident),
 132         _ => name,
 133     }
 134 }
 135
 136 // Use this on failing to format the macro call.
 137 fn return_original_snippet_with_failure_marked(
 138     context: &RewriteContext,
 139     span: Span,
 140 ) -> Option<String> {
 141     context.macro_rewrite_failure.replace(true);
 142     Some(context.snippet(span).to_owned())
 143 }
 144
 145 struct InsideMacroGuard<'a> {
 146     context: &'a RewriteContext<'a>,
 147     is_nested: bool,
 148 }
 149
 150 impl<'a> InsideMacroGuard<'a> {
 151     fn inside_macro_context(context: &'a RewriteContext) -> InsideMacroGuard<'a> {
 152         let is_nested = context.inside_macro.replace(true);
 153         InsideMacroGuard { context, is_nested }
 154     }
 155 }
 156
 157 impl<'a> Drop for InsideMacroGuard<'a> {
 158     fn drop(&mut self) {
 159         self.context.inside_macro.replace(self.is_nested);
 160     }
 161 }
 162
 163 pub fn rewrite_macro(
 164     mac: &ast::Mac,
 165     extra_ident: Option<ast::Ident>,
 166     context: &RewriteContext,
 167     shape: Shape,
 168     position: MacroPosition,
 169 ) -> Option<String> {
 170     let guard = InsideMacroGuard::inside_macro_context(context);
 171     let result = rewrite_macro_inner(mac, extra_ident, context, shape, position, guard.is_nested);
 172     if result.is_none() {
 173         context.macro_rewrite_failure.replace(true);
 174     }
 175     result
 176 }
 177
 178 pub fn rewrite_macro_inner(
 179     mac: &ast::Mac,
 180     extra_ident: Option<ast::Ident>,
 181     context: &RewriteContext,
 182     shape: Shape,
 183     position: MacroPosition,
 184     is_nested_macro: bool,
 185 ) -> Option<String> {
 186     if context.config.use_try_shorthand() {
 187         if let Some(expr) = convert_try_mac(mac, context) {
 188             context.inside_macro.replace(false);
 189             return expr.rewrite(context, shape);
 190         }
 191     }
 192
 193     let original_style = macro_style(mac, context);
 194
 195     let macro_name = rewrite_macro_name(context, &mac.node.path, extra_ident);
 196
 197     let style = if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) && !is_nested_macro {
 198         DelimToken::Bracket
 199     } else {
 200         original_style
 201     };
 202
 203     let ts: TokenStream = mac.node.stream();
 204     let has_comment = contains_comment(context.snippet(mac.span));
 205     if ts.is_empty() && !has_comment {
 206         return match style {
 207             DelimToken::Paren if position == MacroPosition::Item => {
 208                 Some(format!("{}();", macro_name))
 209             }
 210             DelimToken::Paren => Some(format!("{}()", macro_name)),
 211             DelimToken::Bracket => Some(format!("{}[]", macro_name)),
 212             DelimToken::Brace => Some(format!("{}{{}}", macro_name)),
 213             _ => unreachable!(),
 214         };
 215     }
 216     // Format well-known macros which cannot be parsed as a valid AST.
 217     if macro_name == "lazy_static!" && !has_comment {
 218         if let success @ Some(..) = format_lazy_static(context, shape, &ts) {
 219             return success;
 220         }
 221     }
 222
 223     let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 224     let mut arg_vec = Vec::new();
 225     let mut vec_with_semi = false;
 226     let mut trailing_comma = false;
 227
 228     if DelimToken::Brace != style {
 229         loop {
 230             match parse_macro_arg(&mut parser) {
 231                 Some(arg) => arg_vec.push(arg),
 232                 None => return return_original_snippet_with_failure_marked(context, mac.span),
 233             }
 234
 235             match parser.token {
 236                 Token::Eof => break,
 237                 Token::Comma => (),
 238                 Token::Semi => {
 239                     // Try to parse `vec![expr; expr]`
 240                     if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
 241                         parser.bump();
 242                         if parser.token != Token::Eof {
 243                             match parse_macro_arg(&mut parser) {
 244                                 Some(arg) => {
 245                                     arg_vec.push(arg);
 246                                     parser.bump();
 247                                     if parser.token == Token::Eof && arg_vec.len() == 2 {
 248                                         vec_with_semi = true;
 249                                         break;
 250                                     }
 251                                 }
 252                                 None => {
 253                                     return return_original_snippet_with_failure_marked(
 254                                         context, mac.span,
 255                                     )
 256                                 }
 257                             }
 258                         }
 259                     }
 260                     return return_original_snippet_with_failure_marked(context, mac.span);
 261                 }
 262                 _ => return return_original_snippet_with_failure_marked(context, mac.span),
 263             }
 264
 265             parser.bump();
 266
 267             if parser.token == Token::Eof {
 268                 trailing_comma = true;
 269                 break;
 270             }
 271         }
 272     }
 273
 274     match style {
 275         DelimToken::Paren => {
 276             // Format macro invocation as function call, preserve the trailing
 277             // comma because not all macros support them.
 278             overflow::rewrite_with_parens(
 279                 context,
 280                 &macro_name,
 281                 &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>(),
 282                 shape,
 283                 mac.span,
 284                 context.config.width_heuristics().fn_call_width,
 285                 if trailing_comma {
 286                     Some(SeparatorTactic::Always)
 287                 } else {
 288                     Some(SeparatorTactic::Never)
 289                 },
 290             ).map(|rw| match position {
 291                 MacroPosition::Item => format!("{};", rw),
 292                 _ => rw,
 293             })
 294         }
 295         DelimToken::Bracket => {
 296             // Handle special case: `vec![expr; expr]`
 297             if vec_with_semi {
 298                 let mac_shape = shape.offset_left(macro_name.len())?;
 299                 // 8 = `vec![]` + `; `
 300                 let total_overhead = 8;
 301                 let nested_shape = mac_shape.block_indent(context.config.tab_spaces());
 302                 let lhs = arg_vec[0].rewrite(context, nested_shape)?;
 303                 let rhs = arg_vec[1].rewrite(context, nested_shape)?;
 304                 if !lhs.contains('\n')
 305                     && !rhs.contains('\n')
 306                     && lhs.len() + rhs.len() + total_overhead <= shape.width
 307                 {
 308                     Some(format!("{}[{}; {}]", macro_name, lhs, rhs))
 309                 } else {
 310                     Some(format!(
 311                         "{}[{}{};{}{}{}]",
 312                         macro_name,
 313                         nested_shape.indent.to_string_with_newline(context.config),
 314                         lhs,
 315                         nested_shape.indent.to_string_with_newline(context.config),
 316                         rhs,
 317                         shape.indent.to_string_with_newline(context.config),
 318                     ))
 319                 }
 320             } else {
 321                 // If we are rewriting `vec!` macro or other special macros,
 322                 // then we can rewrite this as an usual array literal.
 323                 // Otherwise, we must preserve the original existence of trailing comma.
 324                 let macro_name = &macro_name.as_str();
 325                 let mut force_trailing_comma = if trailing_comma {
 326                     Some(SeparatorTactic::Always)
 327                 } else {
 328                     Some(SeparatorTactic::Never)
 329                 };
 330                 if FORCED_BRACKET_MACROS.contains(macro_name) && !is_nested_macro {
 331                     context.inside_macro.replace(false);
 332                     if context.use_block_indent() {
 333                         force_trailing_comma = Some(SeparatorTactic::Vertical);
 334                     };
 335                 }
 336                 // Convert `MacroArg` into `ast::Expr`, as `rewrite_array` only accepts the latter.
 337                 let arg_vec = &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>();
 338                 let rewrite = rewrite_array(
 339                     macro_name,
 340                     arg_vec,
 341                     mac.span,
 342                     context,
 343                     shape,
 344                     force_trailing_comma,
 345                     Some(original_style),
 346                 )?;
 347                 let comma = match position {
 348                     MacroPosition::Item => ";",
 349                     _ => "",
 350                 };
 351
 352                 Some(format!("{}{}", rewrite, comma))
 353             }
 354         }
 355         DelimToken::Brace => {
 356             // Skip macro invocations with braces, for now.
 357             indent_macro_snippet(context, context.snippet(mac.span), shape.indent)
 358         }
 359         _ => unreachable!(),
 360     }
 361 }
 362
 363 pub fn rewrite_macro_def(
 364     context: &RewriteContext,
 365     shape: Shape,
 366     indent: Indent,
 367     def: &ast::MacroDef,
 368     ident: ast::Ident,
 369     vis: &ast::Visibility,
 370     span: Span,
 371 ) -> Option<String> {
 372     let snippet = Some(remove_trailing_white_spaces(context.snippet(span)));
 373     if snippet.as_ref().map_or(true, |s| s.ends_with(';')) {
 374         return snippet;
 375     }
 376
 377     let mut parser = MacroParser::new(def.stream().into_trees());
 378     let parsed_def = match parser.parse() {
 379         Some(def) => def,
 380         None => return snippet,
 381     };
 382
 383     let mut result = if def.legacy {
 384         String::from("macro_rules!")
 385     } else {
 386         format!("{}macro", format_visibility(context, vis))
 387     };
 388
 389     result += " ";
 390     result += rewrite_ident(context, ident);
 391
 392     let multi_branch_style = def.legacy || parsed_def.branches.len() != 1;
 393
 394     let arm_shape = if multi_branch_style {
 395         shape
 396             .block_indent(context.config.tab_spaces())
 397             .with_max_width(context.config)
 398     } else {
 399         shape
 400     };
 401
 402     let branch_items = itemize_list(
 403         context.snippet_provider,
 404         parsed_def.branches.iter(),
 405         "}",
 406         ";",
 407         |branch| branch.span.lo(),
 408         |branch| branch.span.hi(),
 409         |branch| match branch.rewrite(context, arm_shape, multi_branch_style) {
 410             Some(v) => Some(v),
 411             // if the rewrite returned None because a macro could not be rewritten, then return the
 412             // original body
 413             None if *context.macro_rewrite_failure.borrow() == true => {
 414                 Some(context.snippet(branch.body).trim().to_string())
 415             }
 416             None => None,
 417         },
 418         context.snippet_provider.span_after(span, "{"),
 419         span.hi(),
 420         false,
 421     ).collect::<Vec<_>>();
 422
 423     let fmt = ListFormatting::new(arm_shape, context.config)
 424         .separator(if def.legacy { ";" } else { "" })
 425         .trailing_separator(SeparatorTactic::Always)
 426         .preserve_newline(true);
 427
 428     if multi_branch_style {
 429         result += " {";
 430         result += &arm_shape.indent.to_string_with_newline(context.config);
 431     }
 432
 433     match write_list(&branch_items, &fmt) {
 434         Some(ref s) => result += s,
 435         None => return snippet,
 436     }
 437
 438     if multi_branch_style {
 439         result += &indent.to_string_with_newline(context.config);
 440         result += "}";
 441     }
 442
 443     Some(result)
 444 }
 445
 446 fn register_metavariable(
 447     map: &mut HashMap<String, String>,
 448     result: &mut String,
 449     name: &str,
 450     dollar_count: usize,
 451 ) {
 452     let mut new_name = String::new();
 453     let mut old_name = String::new();
 454
 455     old_name.push('$');
 456     for _ in 0..(dollar_count - 1) {
 457         new_name.push('$');
 458         old_name.push('$');
 459     }
 460     new_name.push('z');
 461     new_name.push_str(&name);
 462     old_name.push_str(&name);
 463
 464     result.push_str(&new_name);
 465     map.insert(old_name, new_name);
 466 }
 467
 468 // Replaces `$foo` with `zfoo`. We must check for name overlap to ensure we
 469 // aren't causing problems.
 470 // This should also work for escaped `$` variables, where we leave earlier `$`s.
 471 fn replace_names(input: &str) -> Option<(String, HashMap<String, String>)> {
 472     // Each substitution will require five or six extra bytes.
 473     let mut result = String::with_capacity(input.len() + 64);
 474     let mut substs = HashMap::new();
 475     let mut dollar_count = 0;
 476     let mut cur_name = String::new();
 477
 478     for (kind, c) in CharClasses::new(input.chars()) {
 479         if kind != FullCodeCharKind::Normal {
 480             result.push(c);
 481         } else if c == '$' {
 482             dollar_count += 1;
 483         } else if dollar_count == 0 {
 484             result.push(c);
 485         } else if !c.is_alphanumeric() && !cur_name.is_empty() {
 486             // Terminates a name following one or more dollars.
 487             register_metavariable(&mut substs, &mut result, &cur_name, dollar_count);
 488
 489             result.push(c);
 490             dollar_count = 0;
 491             cur_name.clear();
 492         } else if c == '(' && cur_name.is_empty() {
 493             // FIXME: Support macro def with repeat.
 494             return None;
 495         } else if c.is_alphanumeric() || c == '_' {
 496             cur_name.push(c);
 497         }
 498     }
 499
 500     if !cur_name.is_empty() {
 501         register_metavariable(&mut substs, &mut result, &cur_name, dollar_count);
 502     }
 503
 504     debug!("replace_names `{}` {:?}", result, substs);
 505
 506     Some((result, substs))
 507 }
 508
 509 #[derive(Debug, Clone)]
 510 enum MacroArgKind {
 511     /// e.g. `$x: expr`.
 512     MetaVariable(ast::Ident, String),
 513     /// e.g. `$($foo: expr),*`
 514     Repeat(
 515         /// `()`, `[]` or `{}`.
 516         DelimToken,
 517         /// Inner arguments inside delimiters.
 518         Vec<ParsedMacroArg>,
 519         /// Something after the closing delimiter and the repeat token, if available.
 520         Option<Box<ParsedMacroArg>>,
 521         /// The repeat token. This could be one of `*`, `+` or `?`.
 522         Token,
 523     ),
 524     /// e.g. `[derive(Debug)]`
 525     Delimited(DelimToken, Vec<ParsedMacroArg>),
 526     /// A possible separator. e.g. `,` or `;`.
 527     Separator(String, String),
 528     /// Other random stuff that does not fit to other kinds.
 529     /// e.g. `== foo` in `($x: expr == foo)`.
 530     Other(String, String),
 531 }
 532
 533 fn delim_token_to_str(
 534     context: &RewriteContext,
 535     delim_token: DelimToken,
 536     shape: Shape,
 537     use_multiple_lines: bool,
 538     inner_is_empty: bool,
 539 ) -> (String, String) {
 540     let (lhs, rhs) = match delim_token {
 541         DelimToken::Paren => ("(", ")"),
 542         DelimToken::Bracket => ("[", "]"),
 543         DelimToken::Brace => {
 544             if inner_is_empty || use_multiple_lines {
 545                 ("{", "}")
 546             } else {
 547                 ("{ ", " }")
 548             }
 549         }
 550         DelimToken::NoDelim => ("", ""),
 551     };
 552     if use_multiple_lines {
 553         let indent_str = shape.indent.to_string_with_newline(context.config);
 554         let nested_indent_str = shape
 555             .indent
 556             .block_indent(context.config)
 557             .to_string_with_newline(context.config);
 558         (
 559             format!("{}{}", lhs, nested_indent_str),
 560             format!("{}{}", indent_str, rhs),
 561         )
 562     } else {
 563         (lhs.to_owned(), rhs.to_owned())
 564     }
 565 }
 566
 567 impl MacroArgKind {
 568     fn starts_with_brace(&self) -> bool {
 569         match *self {
 570             MacroArgKind::Repeat(DelimToken::Brace, _, _, _)
 571             | MacroArgKind::Delimited(DelimToken::Brace, _) => true,
 572             _ => false,
 573         }
 574     }
 575
 576     fn starts_with_dollar(&self) -> bool {
 577         match *self {
 578             MacroArgKind::Repeat(..) | MacroArgKind::MetaVariable(..) => true,
 579             _ => false,
 580         }
 581     }
 582
 583     fn ends_with_space(&self) -> bool {
 584         match *self {
 585             MacroArgKind::Separator(..) => true,
 586             _ => false,
 587         }
 588     }
 589
 590     fn has_meta_var(&self) -> bool {
 591         match *self {
 592             MacroArgKind::MetaVariable(..) => true,
 593             MacroArgKind::Repeat(_, ref args, _, _) => args.iter().any(|a| a.kind.has_meta_var()),
 594             _ => false,
 595         }
 596     }
 597
 598     fn rewrite(
 599         &self,
 600         context: &RewriteContext,
 601         shape: Shape,
 602         use_multiple_lines: bool,
 603     ) -> Option<String> {
 604         let rewrite_delimited_inner = |delim_tok, args| -> Option<(String, String, String)> {
 605             let inner = wrap_macro_args(context, args, shape)?;
 606             let (lhs, rhs) = delim_token_to_str(context, delim_tok, shape, false, inner.is_empty());
 607             if lhs.len() + inner.len() + rhs.len() <= shape.width {
 608                 return Some((lhs, inner, rhs));
 609             }
 610
 611             let (lhs, rhs) = delim_token_to_str(context, delim_tok, shape, true, false);
 612             let nested_shape = shape
 613                 .block_indent(context.config.tab_spaces())
 614                 .with_max_width(context.config);
 615             let inner = wrap_macro_args(context, args, nested_shape)?;
 616             Some((lhs, inner, rhs))
 617         };
 618
 619         match *self {
 620             MacroArgKind::MetaVariable(ty, ref name) => {
 621                 Some(format!("${}:{}", name, ty.name.as_str()))
 622             }
 623             MacroArgKind::Repeat(delim_tok, ref args, ref another, ref tok) => {
 624                 let (lhs, inner, rhs) = rewrite_delimited_inner(delim_tok, args)?;
 625                 let another = another
 626                     .as_ref()
 627                     .and_then(|a| a.rewrite(context, shape, use_multiple_lines))
 628                     .unwrap_or_else(|| "".to_owned());
 629                 let repeat_tok = pprust::token_to_string(tok);
 630
 631                 Some(format!("${}{}{}{}{}", lhs, inner, rhs, another, repeat_tok))
 632             }
 633             MacroArgKind::Delimited(delim_tok, ref args) => {
 634                 rewrite_delimited_inner(delim_tok, args)
 635                     .map(|(lhs, inner, rhs)| format!("{}{}{}", lhs, inner, rhs))
 636             }
 637             MacroArgKind::Separator(ref sep, ref prefix) => Some(format!("{}{} ", prefix, sep)),
 638             MacroArgKind::Other(ref inner, ref prefix) => Some(format!("{}{}", prefix, inner)),
 639         }
 640     }
 641 }
 642
 643 #[derive(Debug, Clone)]
 644 struct ParsedMacroArg {
 645     kind: MacroArgKind,
 646     span: Span,
 647 }
 648
 649 impl ParsedMacroArg {
 650     pub fn rewrite(
 651         &self,
 652         context: &RewriteContext,
 653         shape: Shape,
 654         use_multiple_lines: bool,
 655     ) -> Option<String> {
 656         self.kind.rewrite(context, shape, use_multiple_lines)
 657     }
 658 }
 659
 660 /// Parses macro arguments on macro def.
 661 struct MacroArgParser {
 662     /// Holds either a name of the next metavariable, a separator or a junk.
 663     buf: String,
 664     /// The start position on the current buffer.
 665     lo: BytePos,
 666     /// The first token of the current buffer.
 667     start_tok: Token,
 668     /// Set to true if we are parsing a metavariable or a repeat.
 669     is_meta_var: bool,
 670     /// The position of the last token.
 671     hi: BytePos,
 672     /// The last token parsed.
 673     last_tok: Token,
 674     /// Holds the parsed arguments.
 675     result: Vec<ParsedMacroArg>,
 676 }
 677
 678 fn last_tok(tt: &TokenTree) -> Token {
 679     match *tt {
 680         TokenTree::Token(_, ref t) => t.clone(),
 681         TokenTree::Delimited(_, ref d) => d.close_token(),
 682     }
 683 }
 684
 685 impl MacroArgParser {
 686     pub fn new() -> MacroArgParser {
 687         MacroArgParser {
 688             lo: BytePos(0),
 689             hi: BytePos(0),
 690             buf: String::new(),
 691             is_meta_var: false,
 692             last_tok: Token::Eof,
 693             start_tok: Token::Eof,
 694             result: vec![],
 695         }
 696     }
 697
 698     fn set_last_tok(&mut self, tok: &TokenTree) {
 699         self.hi = tok.span().hi();
 700         self.last_tok = last_tok(tok);
 701     }
 702
 703     fn add_separator(&mut self) {
 704         let prefix = if self.need_space_prefix() {
 705             " ".to_owned()
 706         } else {
 707             "".to_owned()
 708         };
 709         self.result.push(ParsedMacroArg {
 710             kind: MacroArgKind::Separator(self.buf.clone(), prefix),
 711             span: mk_sp(self.lo, self.hi),
 712         });
 713         self.buf.clear();
 714     }
 715
 716     fn add_other(&mut self) {
 717         let prefix = if self.need_space_prefix() {
 718             " ".to_owned()
 719         } else {
 720             "".to_owned()
 721         };
 722         self.result.push(ParsedMacroArg {
 723             kind: MacroArgKind::Other(self.buf.clone(), prefix),
 724             span: mk_sp(self.lo, self.hi),
 725         });
 726         self.buf.clear();
 727     }
 728
 729     fn add_meta_variable(&mut self, iter: &mut Cursor) -> Option<()> {
 730         match iter.next() {
 731             Some(TokenTree::Token(sp, Token::Ident(ref ident, _))) => {
 732                 self.result.push(ParsedMacroArg {
 733                     kind: MacroArgKind::MetaVariable(*ident, self.buf.clone()),
 734                     span: mk_sp(self.lo, sp.hi()),
 735                 });
 736
 737                 self.buf.clear();
 738                 self.is_meta_var = false;
 739                 Some(())
 740             }
 741             _ => None,
 742         }
 743     }
 744
 745     fn add_delimited(&mut self, inner: Vec<ParsedMacroArg>, delim: DelimToken, span: Span) {
 746         self.result.push(ParsedMacroArg {
 747             kind: MacroArgKind::Delimited(delim, inner),
 748             span,
 749         });
 750     }
 751
 752     // $($foo: expr),?
 753     fn add_repeat(
 754         &mut self,
 755         inner: Vec<ParsedMacroArg>,
 756         delim: DelimToken,
 757         iter: &mut Cursor,
 758         span: Span,
 759     ) -> Option<()> {
 760         let mut buffer = String::new();
 761         let mut first = false;
 762         let mut lo = span.lo();
 763         let mut hi = span.hi();
 764
 765         // Parse '*', '+' or '?.
 766         for tok in iter {
 767             self.set_last_tok(&tok);
 768             if first {
 769                 first = false;
 770                 lo = tok.span().lo();
 771             }
 772
 773             match tok {
 774                 TokenTree::Token(_, Token::BinOp(BinOpToken::Plus))
 775                 | TokenTree::Token(_, Token::Question)
 776                 | TokenTree::Token(_, Token::BinOp(BinOpToken::Star)) => {
 777                     break;
 778                 }
 779                 TokenTree::Token(sp, ref t) => {
 780                     buffer.push_str(&pprust::token_to_string(t));
 781                     hi = sp.hi();
 782                 }
 783                 _ => return None,
 784             }
 785         }
 786
 787         // There could be some random stuff between ')' and '*', '+' or '?'.
 788         let another = if buffer.trim().is_empty() {
 789             None
 790         } else {
 791             Some(Box::new(ParsedMacroArg {
 792                 kind: MacroArgKind::Other(buffer, "".to_owned()),
 793                 span: mk_sp(lo, hi),
 794             }))
 795         };
 796
 797         self.result.push(ParsedMacroArg {
 798             kind: MacroArgKind::Repeat(delim, inner, another, self.last_tok.clone()),
 799             span: mk_sp(self.lo, self.hi),
 800         });
 801         Some(())
 802     }
 803
 804     fn update_buffer(&mut self, lo: BytePos, t: &Token) {
 805         if self.buf.is_empty() {
 806             self.lo = lo;
 807             self.start_tok = t.clone();
 808         } else {
 809             let needs_space = match next_space(&self.last_tok) {
 810                 SpaceState::Ident => ident_like(t),
 811                 SpaceState::Punctuation => !ident_like(t),
 812                 SpaceState::Always => true,
 813                 SpaceState::Never => false,
 814             };
 815             if force_space_before(t) || needs_space {
 816                 self.buf.push(' ');
 817             }
 818         }
 819
 820         self.buf.push_str(&pprust::token_to_string(t));
 821     }
 822
 823     fn need_space_prefix(&self) -> bool {
 824         if self.result.is_empty() {
 825             return false;
 826         }
 827
 828         let last_arg = self.result.last().unwrap();
 829         if let MacroArgKind::MetaVariable(..) = last_arg.kind {
 830             if ident_like(&self.start_tok) {
 831                 return true;
 832             }
 833             if self.start_tok == Token::Colon {
 834                 return true;
 835             }
 836         }
 837
 838         if force_space_before(&self.start_tok) {
 839             return true;
 840         }
 841
 842         false
 843     }
 844
 845     /// Returns a collection of parsed macro def's arguments.
 846     pub fn parse(mut self, tokens: ThinTokenStream) -> Option<Vec<ParsedMacroArg>> {
 847         let mut iter = (tokens.into(): TokenStream).trees();
 848
 849         while let Some(ref tok) = iter.next() {
 850             match tok {
 851                 TokenTree::Token(sp, Token::Dollar) => {
 852                     // We always want to add a separator before meta variables.
 853                     if !self.buf.is_empty() {
 854                         self.add_separator();
 855                     }
 856
 857                     // Start keeping the name of this metavariable in the buffer.
 858                     self.is_meta_var = true;
 859                     self.lo = sp.lo();
 860                     self.start_tok = Token::Dollar;
 861                 }
 862                 TokenTree::Token(_, Token::Colon) if self.is_meta_var => {
 863                     self.add_meta_variable(&mut iter)?;
 864                 }
 865                 TokenTree::Token(sp, ref t) => self.update_buffer(sp.lo(), t),
 866                 TokenTree::Delimited(delimited_span, delimited) => {
 867                     if !self.buf.is_empty() {
 868                         if next_space(&self.last_tok) == SpaceState::Always {
 869                             self.add_separator();
 870                         } else {
 871                             self.add_other();
 872                         }
 873                     }
 874
 875                     // Parse the stuff inside delimiters.
 876                     let mut parser = MacroArgParser::new();
 877                     parser.lo = delimited_span.open.lo();
 878                     let delimited_arg = parser.parse(delimited.tts.clone())?;
 879
 880                     let span = delimited_span.entire();
 881                     if self.is_meta_var {
 882                         self.add_repeat(delimited_arg, delimited.delim, &mut iter, span)?;
 883                         self.is_meta_var = false;
 884                     } else {
 885                         self.add_delimited(delimited_arg, delimited.delim, span);
 886                     }
 887                 }
 888             }
 889
 890             self.set_last_tok(tok);
 891         }
 892
 893         // We are left with some stuff in the buffer. Since there is nothing
 894         // left to separate, add this as `Other`.
 895         if !self.buf.is_empty() {
 896             self.add_other();
 897         }
 898
 899         Some(self.result)
 900     }
 901 }
 902
 903 fn wrap_macro_args(
 904     context: &RewriteContext,
 905     args: &[ParsedMacroArg],
 906     shape: Shape,
 907 ) -> Option<String> {
 908     wrap_macro_args_inner(context, args, shape, false)
 909         .or_else(|| wrap_macro_args_inner(context, args, shape, true))
 910 }
 911
 912 fn wrap_macro_args_inner(
 913     context: &RewriteContext,
 914     args: &[ParsedMacroArg],
 915     shape: Shape,
 916     use_multiple_lines: bool,
 917 ) -> Option<String> {
 918     let mut result = String::with_capacity(128);
 919     let mut iter = args.iter().peekable();
 920     let indent_str = shape.indent.to_string_with_newline(context.config);
 921
 922     while let Some(ref arg) = iter.next() {
 923         result.push_str(&arg.rewrite(context, shape, use_multiple_lines)?);
 924
 925         if use_multiple_lines
 926             && (arg.kind.ends_with_space() || iter.peek().map_or(false, |a| a.kind.has_meta_var()))
 927         {
 928             if arg.kind.ends_with_space() {
 929                 result.pop();
 930             }
 931             result.push_str(&indent_str);
 932         } else if let Some(ref next_arg) = iter.peek() {
 933             let space_before_dollar =
 934                 !arg.kind.ends_with_space() && next_arg.kind.starts_with_dollar();
 935             let space_before_brace = next_arg.kind.starts_with_brace();
 936             if space_before_dollar || space_before_brace {
 937                 result.push(' ');
 938             }
 939         }
 940     }
 941
 942     if !use_multiple_lines && result.len() >= shape.width {
 943         None
 944     } else {
 945         Some(result)
 946     }
 947 }
 948
 949 // This is a bit sketchy. The token rules probably need tweaking, but it works
 950 // for some common cases. I hope the basic logic is sufficient. Note that the
 951 // meaning of some tokens is a bit different here from usual Rust, e.g., `*`
 952 // and `(`/`)` have special meaning.
 953 //
 954 // We always try and format on one line.
 955 // FIXME: Use multi-line when every thing does not fit on one line.
 956 fn format_macro_args(
 957     context: &RewriteContext,
 958     toks: ThinTokenStream,
 959     shape: Shape,
 960 ) -> Option<String> {
 961     if !context.config.format_macro_matchers() {
 962         let token_stream: TokenStream = toks.into();
 963         let span = span_for_token_stream(token_stream);
 964         return Some(match span {
 965             Some(span) => context.snippet(span).to_owned(),
 966             None => String::new(),
 967         });
 968     }
 969     let parsed_args = MacroArgParser::new().parse(toks)?;
 970     wrap_macro_args(context, &parsed_args, shape)
 971 }
 972
 973 fn span_for_token_stream(token_stream: TokenStream) -> Option<Span> {
 974     token_stream.trees().next().map(|tt| tt.span())
 975 }
 976
 977 // We should insert a space if the next token is a:
 978 #[derive(Copy, Clone, PartialEq)]
 979 enum SpaceState {
 980     Never,
 981     Punctuation,
 982     Ident, // Or ident/literal-like thing.
 983     Always,
 984 }
 985
 986 fn force_space_before(tok: &Token) -> bool {
 987     debug!("tok: force_space_before {:?}", tok);
 988
 989     match tok {
 990         Token::Eq
 991         | Token::Lt
 992         | Token::Le
 993         | Token::EqEq
 994         | Token::Ne
 995         | Token::Ge
 996         | Token::Gt
 997         | Token::AndAnd
 998         | Token::OrOr
 999         | Token::Not
1000         | Token::Tilde
1001         | Token::BinOpEq(_)
1002         | Token::At
1003         | Token::RArrow
1004         | Token::LArrow
1005         | Token::FatArrow
1006         | Token::BinOp(_)
1007         | Token::Pound
1008         | Token::Dollar => true,
1009         _ => false,
1010     }
1011 }
1012
1013 fn ident_like(tok: &Token) -> bool {
1014     match tok {
1015         Token::Ident(..) | Token::Literal(..) | Token::Lifetime(_) => true,
1016         _ => false,
1017     }
1018 }
1019
1020 fn next_space(tok: &Token) -> SpaceState {
1021     debug!("next_space: {:?}", tok);
1022
1023     match tok {
1024         Token::Not
1025         | Token::BinOp(BinOpToken::And)
1026         | Token::Tilde
1027         | Token::At
1028         | Token::Comma
1029         | Token::Dot
1030         | Token::DotDot
1031         | Token::DotDotDot
1032         | Token::DotDotEq
1033         | Token::DotEq
1034         | Token::Question => SpaceState::Punctuation,
1035
1036         Token::ModSep
1037         | Token::Pound
1038         | Token::Dollar
1039         | Token::OpenDelim(_)
1040         | Token::CloseDelim(_)
1041         | Token::Whitespace => SpaceState::Never,
1042
1043         Token::Literal(..) | Token::Ident(..) | Token::Lifetime(_) => SpaceState::Ident,
1044
1045         _ => SpaceState::Always,
1046     }
1047 }
1048
1049 /// Tries to convert a macro use into a short hand try expression. Returns None
1050 /// when the macro is not an instance of try! (or parsing the inner expression
1051 /// failed).
1052 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
1053     if &format!("{}", mac.node.path) == "try" {
1054         let ts: TokenStream = mac.node.tts.clone().into();
1055         let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
1056
1057         Some(ast::Expr {
1058             id: ast::NodeId::new(0), // dummy value
1059             node: ast::ExprKind::Try(parser.parse_expr().ok()?),
1060             span: mac.span, // incorrect span, but shouldn't matter too much
1061             attrs: ThinVec::new(),
1062         })
1063     } else {
1064         None
1065     }
1066 }
1067
1068 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> DelimToken {
1069     let snippet = context.snippet(mac.span);
1070     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
1071     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
1072     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
1073
1074     if paren_pos < bracket_pos && paren_pos < brace_pos {
1075         DelimToken::Paren
1076     } else if bracket_pos < brace_pos {
1077         DelimToken::Bracket
1078     } else {
1079         DelimToken::Brace
1080     }
1081 }
1082
1083 /// Indent each line according to the specified `indent`.
1084 /// e.g.
1085 ///
1086 /// ```rust,ignore
1087 /// foo!{
1088 /// x,
1089 /// y,
1090 /// foo(
1091 ///     a,
1092 ///     b,
1093 ///     c,
1094 /// ),
1095 /// }
1096 /// ```
1097 ///
1098 /// will become
1099 ///
1100 /// ```rust,ignore
1101 /// foo!{
1102 ///     x,
1103 ///     y,
1104 ///     foo(
1105 ///         a,
1106 ///         b,
1107 ///         c,
1108 ///     ),
1109 /// }
1110 /// ```
1111 fn indent_macro_snippet(
1112     context: &RewriteContext,
1113     macro_str: &str,
1114     indent: Indent,
1115 ) -> Option<String> {
1116     let mut lines = LineClasses::new(macro_str);
1117     let first_line = lines.next().map(|(_, s)| s.trim_right().to_owned())?;
1118     let mut trimmed_lines = Vec::with_capacity(16);
1119
1120     let mut veto_trim = false;
1121     let min_prefix_space_width = lines
1122         .filter_map(|(kind, line)| {
1123             let mut trimmed = true;
1124             let prefix_space_width = if is_empty_line(&line) {
1125                 None
1126             } else {
1127                 Some(get_prefix_space_width(context, &line))
1128             };
1129
1130             let line = if veto_trim || (kind.is_string() && !line.ends_with('\\')) {
1131                 veto_trim = kind.is_string() && !line.ends_with('\\');
1132                 trimmed = false;
1133                 line
1134             } else {
1135                 line.trim().to_owned()
1136             };
1137             trimmed_lines.push((trimmed, line, prefix_space_width));
1138
1139             // when computing the minimum, do not consider lines within a string
1140             match kind {
1141                 FullCodeCharKind::InString | FullCodeCharKind::EndString => None,
1142                 _ => prefix_space_width,
1143             }
1144         }).min()?;
1145
1146     Some(
1147         first_line + "\n" + &trimmed_lines
1148             .iter()
1149             .map(
1150                 |&(trimmed, ref line, prefix_space_width)| match prefix_space_width {
1151                     _ if !trimmed => line.to_owned(),
1152                     Some(original_indent_width) => {
1153                         let new_indent_width = indent.width() + original_indent_width
1154                             .saturating_sub(min_prefix_space_width);
1155                         let new_indent = Indent::from_width(context.config, new_indent_width);
1156                         format!("{}{}", new_indent.to_string(context.config), line)
1157                     }
1158                     None => String::new(),
1159                 },
1160             ).collect::<Vec<_>>()
1161             .join("\n"),
1162     )
1163 }
1164
1165 fn get_prefix_space_width(context: &RewriteContext, s: &str) -> usize {
1166     let mut width = 0;
1167     for c in s.chars() {
1168         match c {
1169             ' ' => width += 1,
1170             '\t' => width += context.config.tab_spaces(),
1171             _ => return width,
1172         }
1173     }
1174     width
1175 }
1176
1177 fn is_empty_line(s: &str) -> bool {
1178     s.is_empty() || s.chars().all(char::is_whitespace)
1179 }
1180
1181 // A very simple parser that just parses a macros 2.0 definition into its branches.
1182 // Currently we do not attempt to parse any further than that.
1183 #[derive(new)]
1184 struct MacroParser {
1185     toks: Cursor,
1186 }
1187
1188 impl MacroParser {
1189     // (`(` ... `)` `=>` `{` ... `}`)*
1190     fn parse(&mut self) -> Option<Macro> {
1191         let mut branches = vec![];
1192         while self.toks.look_ahead(1).is_some() {
1193             branches.push(self.parse_branch()?);
1194         }
1195
1196         Some(Macro { branches })
1197     }
1198
1199     // `(` ... `)` `=>` `{` ... `}`
1200     fn parse_branch(&mut self) -> Option<MacroBranch> {
1201         let tok = self.toks.next()?;
1202         let (lo, args_paren_kind) = match tok {
1203             TokenTree::Token(..) => return None,
1204             TokenTree::Delimited(delimited_span, ref d) => (delimited_span.open.lo(), d.delim),
1205         };
1206         let args = tok.joint().into();
1207         match self.toks.next()? {
1208             TokenTree::Token(_, Token::FatArrow) => {}
1209             _ => return None,
1210         }
1211         let (mut hi, body, whole_body) = match self.toks.next()? {
1212             TokenTree::Token(..) => return None,
1213             TokenTree::Delimited(delimited_span, _) => {
1214                 let data = delimited_span.entire().data();
1215                 (
1216                     data.hi,
1217                     Span::new(data.lo + BytePos(1), data.hi - BytePos(1), data.ctxt),
1218                     delimited_span.entire(),
1219                 )
1220             }
1221         };
1222         if let Some(TokenTree::Token(sp, Token::Semi)) = self.toks.look_ahead(0) {
1223             self.toks.next();
1224             hi = sp.hi();
1225         }
1226         Some(MacroBranch {
1227             span: mk_sp(lo, hi),
1228             args_paren_kind,
1229             args,
1230             body,
1231             whole_body,
1232         })
1233     }
1234 }
1235
1236 // A parsed macros 2.0 macro definition.
1237 struct Macro {
1238     branches: Vec<MacroBranch>,
1239 }
1240
1241 // FIXME: it would be more efficient to use references to the token streams
1242 // rather than clone them, if we can make the borrowing work out.
1243 struct MacroBranch {
1244     span: Span,
1245     args_paren_kind: DelimToken,
1246     args: ThinTokenStream,
1247     body: Span,
1248     whole_body: Span,
1249 }
1250
1251 impl MacroBranch {
1252     fn rewrite(
1253         &self,
1254         context: &RewriteContext,
1255         shape: Shape,
1256         multi_branch_style: bool,
1257     ) -> Option<String> {
1258         // Only attempt to format function-like macros.
1259         if self.args_paren_kind != DelimToken::Paren {
1260             // FIXME(#1539): implement for non-sugared macros.
1261             return None;
1262         }
1263
1264         // 5 = " => {"
1265         let mut result = format_macro_args(context, self.args.clone(), shape.sub_width(5)?)?;
1266
1267         if multi_branch_style {
1268             result += " =>";
1269         }
1270
1271         if !context.config.format_macro_bodies() {
1272             result += " ";
1273             result += context.snippet(self.whole_body);
1274             return Some(result);
1275         }
1276
1277         // The macro body is the most interesting part. It might end up as various
1278         // AST nodes, but also has special variables (e.g, `$foo`) which can't be
1279         // parsed as regular Rust code (and note that these can be escaped using
1280         // `$$`). We'll try and format like an AST node, but we'll substitute
1281         // variables for new names with the same length first.
1282
1283         let old_body = context.snippet(self.body).trim();
1284         let (body_str, substs) = replace_names(old_body)?;
1285         let has_block_body = old_body.starts_with('{');
1286
1287         let mut config = context.config.clone();
1288         config.set().hide_parse_errors(true);
1289
1290         result += " {";
1291
1292         let body_indent = if has_block_body {
1293             shape.indent
1294         } else {
1295             shape.indent.block_indent(&config)
1296         };
1297         let new_width = config.max_width() - body_indent.width();
1298         config.set().max_width(new_width);
1299
1300         // First try to format as items, then as statements.
1301         let new_body = match ::format_snippet(&body_str, &config) {
1302             Some(new_body) => new_body,
1303             None => {
1304                 let new_width = new_width + config.tab_spaces();
1305                 config.set().max_width(new_width);
1306                 match ::format_code_block(&body_str, &config) {
1307                     Some(new_body) => new_body,
1308                     None => return None,
1309                 }
1310             }
1311         };
1312         let new_body = wrap_str(new_body, config.max_width(), shape)?;
1313
1314         // Indent the body since it is in a block.
1315         let indent_str = body_indent.to_string(&config);
1316         let mut new_body = LineClasses::new(new_body.trim_right())
1317             .fold(
1318                 (String::new(), true),
1319                 |(mut s, need_indent), (kind, ref l)| {
1320                     if !l.is_empty() && need_indent {
1321                         s += &indent_str;
1322                     }
1323                     (s + l + "\n", !kind.is_string() || l.ends_with('\\'))
1324                 },
1325             ).0;
1326
1327         // Undo our replacement of macro variables.
1328         // FIXME: this could be *much* more efficient.
1329         for (old, new) in &substs {
1330             if old_body.find(new).is_some() {
1331                 debug!("rewrite_macro_def: bailing matching variable: `{}`", new);
1332                 return None;
1333             }
1334             new_body = new_body.replace(new, old);
1335         }
1336
1337         if has_block_body {
1338             result += new_body.trim();
1339         } else if !new_body.is_empty() {
1340             result += "\n";
1341             result += &new_body;
1342             result += &shape.indent.to_string(&config);
1343         }
1344
1345         result += "}";
1346
1347         Some(result)
1348     }
1349 }
1350
1351 /// Format `lazy_static!` from https://crates.io/crates/lazy_static.
1352 ///
1353 /// # Expected syntax
1354 ///
1355 /// ```ignore
1356 /// lazy_static! {
1357 ///     [pub] static ref NAME_1: TYPE_1 = EXPR_1;
1358 ///     [pub] static ref NAME_2: TYPE_2 = EXPR_2;
1359 ///     ...
1360 ///     [pub] static ref NAME_N: TYPE_N = EXPR_N;
1361 /// }
1362 /// ```
1363 fn format_lazy_static(context: &RewriteContext, shape: Shape, ts: &TokenStream) -> Option<String> {
1364     let mut result = String::with_capacity(1024);
1365     let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
1366     let nested_shape = shape
1367         .block_indent(context.config.tab_spaces())
1368         .with_max_width(context.config);
1369
1370     result.push_str("lazy_static! {");
1371     result.push_str(&nested_shape.indent.to_string_with_newline(context.config));
1372
1373     macro parse_or($method:ident $(,)* $($arg:expr),* $(,)*) {
1374         match parser.$method($($arg,)*) {
1375             Ok(val) => {
1376                 if parser.sess.span_diagnostic.has_errors() {
1377                     parser.sess.span_diagnostic.reset_err_count();
1378                     return None;
1379                 } else {
1380                     val
1381                 }
1382             }
1383             Err(mut err) => {
1384                 err.cancel();
1385                 parser.sess.span_diagnostic.reset_err_count();
1386                 return None;
1387             }
1388         }
1389     }
1390
1391     while parser.token != Token::Eof {
1392         // Parse a `lazy_static!` item.
1393         let vis = ::utils::format_visibility(context, &parse_or!(parse_visibility, false));
1394         parser.eat_keyword(symbol::keywords::Static);
1395         parser.eat_keyword(symbol::keywords::Ref);
1396         let id = parse_or!(parse_ident);
1397         parser.eat(&Token::Colon);
1398         let ty = parse_or!(parse_ty);
1399         parser.eat(&Token::Eq);
1400         let expr = parse_or!(parse_expr);
1401         parser.eat(&Token::Semi);
1402
1403         // Rewrite as a static item.
1404         let mut stmt = String::with_capacity(128);
1405         stmt.push_str(&format!(
1406             "{}static ref {}: {} =",
1407             vis,
1408             id,
1409             ty.rewrite(context, nested_shape)?
1410         ));
1411         result.push_str(&::expr::rewrite_assign_rhs(
1412             context,
1413             stmt,
1414             &*expr,
1415             nested_shape.sub_width(1)?,
1416         )?);
1417         result.push(';');
1418         if parser.token != Token::Eof {
1419             result.push_str(&nested_shape.indent.to_string_with_newline(context.config));
1420         }
1421     }
1422
1423     result.push_str(&shape.indent.to_string_with_newline(context.config));
1424     result.push('}');
1425
1426     Some(result)
1427 }