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 use syntax::ast;
  24 use syntax::codemap::{BytePos, Span};
  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::symbol;
  30 use syntax::tokenstream::{Cursor, ThinTokenStream, TokenStream, TokenTree};
  31 use syntax::util::ThinVec;
  32
  33 use codemap::SpanUtils;
  34 use comment::{contains_comment, remove_trailing_white_spaces, FindUncommented};
  35 use expr::{rewrite_array, rewrite_call_inner};
  36 use rewrite::{Rewrite, RewriteContext};
  37 use shape::{Indent, Shape};
  38 use utils::{format_visibility, mk_sp};
  39
  40 const FORCED_BRACKET_MACROS: &[&str] = &["vec!"];
  41
  42 // FIXME: use the enum from libsyntax?
  43 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
  44 enum MacroStyle {
  45     Parens,
  46     Brackets,
  47     Braces,
  48 }
  49
  50 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
  51 pub enum MacroPosition {
  52     Item,
  53     Statement,
  54     Expression,
  55     Pat,
  56 }
  57
  58 impl MacroStyle {
  59     fn opener(&self) -> &'static str {
  60         match *self {
  61             MacroStyle::Parens => "(",
  62             MacroStyle::Brackets => "[",
  63             MacroStyle::Braces => "{",
  64         }
  65     }
  66 }
  67
  68 #[derive(Debug)]
  69 pub enum MacroArg {
  70     Expr(ast::Expr),
  71     Ty(ast::Ty),
  72     Pat(ast::Pat),
  73 }
  74
  75 impl Rewrite for MacroArg {
  76     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  77         match *self {
  78             MacroArg::Expr(ref expr) => expr.rewrite(context, shape),
  79             MacroArg::Ty(ref ty) => ty.rewrite(context, shape),
  80             MacroArg::Pat(ref pat) => pat.rewrite(context, shape),
  81         }
  82     }
  83 }
  84
  85 fn parse_macro_arg(parser: &mut Parser) -> Option<MacroArg> {
  86     macro_rules! parse_macro_arg {
  87         ($macro_arg: ident, $parser: ident) => {
  88             let mut cloned_parser = (*parser).clone();
  89             match cloned_parser.$parser() {
  90                 Ok(x) => {
  91                     if parser.sess.span_diagnostic.has_errors() {
  92                         parser.sess.span_diagnostic.reset_err_count();
  93                     } else {
  94                         // Parsing succeeded.
  95                         *parser = cloned_parser;
  96                         return Some(MacroArg::$macro_arg((*x).clone()));
  97                     }
  98                 }
  99                 Err(mut e) => {
 100                     e.cancel();
 101                     parser.sess.span_diagnostic.reset_err_count();
 102                 }
 103             }
 104         }
 105     }
 106
 107     parse_macro_arg!(Expr, parse_expr);
 108     parse_macro_arg!(Ty, parse_ty);
 109     parse_macro_arg!(Pat, parse_pat);
 110
 111     None
 112 }
 113
 114 pub fn rewrite_macro(
 115     mac: &ast::Mac,
 116     extra_ident: Option<ast::Ident>,
 117     context: &RewriteContext,
 118     shape: Shape,
 119     position: MacroPosition,
 120 ) -> Option<String> {
 121     let context = &mut context.clone();
 122     context.inside_macro = true;
 123     if context.config.use_try_shorthand() {
 124         if let Some(expr) = convert_try_mac(mac, context) {
 125             context.inside_macro = false;
 126             return expr.rewrite(context, shape);
 127         }
 128     }
 129
 130     let original_style = macro_style(mac, context);
 131
 132     let macro_name = match extra_ident {
 133         None => format!("{}!", mac.node.path),
 134         Some(ident) => {
 135             if ident == symbol::keywords::Invalid.ident() {
 136                 format!("{}!", mac.node.path)
 137             } else {
 138                 format!("{}! {}", mac.node.path, ident)
 139             }
 140         }
 141     };
 142
 143     let style = if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
 144         MacroStyle::Brackets
 145     } else {
 146         original_style
 147     };
 148
 149     let ts: TokenStream = mac.node.stream();
 150     if ts.is_empty() && !contains_comment(context.snippet(mac.span)) {
 151         return match style {
 152             MacroStyle::Parens if position == MacroPosition::Item => {
 153                 Some(format!("{}();", macro_name))
 154             }
 155             MacroStyle::Parens => Some(format!("{}()", macro_name)),
 156             MacroStyle::Brackets => Some(format!("{}[]", macro_name)),
 157             MacroStyle::Braces => Some(format!("{}{{}}", macro_name)),
 158         };
 159     }
 160
 161     let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 162     let mut arg_vec = Vec::new();
 163     let mut vec_with_semi = false;
 164     let mut trailing_comma = false;
 165
 166     if MacroStyle::Braces != style {
 167         loop {
 168             match parse_macro_arg(&mut parser) {
 169                 Some(arg) => arg_vec.push(arg),
 170                 None => return Some(context.snippet(mac.span).to_owned()),
 171             }
 172
 173             match parser.token {
 174                 Token::Eof => break,
 175                 Token::Comma => (),
 176                 Token::Semi => {
 177                     // Try to parse `vec![expr; expr]`
 178                     if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
 179                         parser.bump();
 180                         if parser.token != Token::Eof {
 181                             match parse_macro_arg(&mut parser) {
 182                                 Some(arg) => {
 183                                     arg_vec.push(arg);
 184                                     parser.bump();
 185                                     if parser.token == Token::Eof && arg_vec.len() == 2 {
 186                                         vec_with_semi = true;
 187                                         break;
 188                                     }
 189                                 }
 190                                 None => return Some(context.snippet(mac.span).to_owned()),
 191                             }
 192                         }
 193                     }
 194                     return Some(context.snippet(mac.span).to_owned());
 195                 }
 196                 _ => return Some(context.snippet(mac.span).to_owned()),
 197             }
 198
 199             parser.bump();
 200
 201             if parser.token == Token::Eof {
 202                 trailing_comma = true;
 203                 break;
 204             }
 205         }
 206     }
 207
 208     match style {
 209         MacroStyle::Parens => {
 210             // Format macro invocation as function call, forcing no trailing
 211             // comma because not all macros support them.
 212             rewrite_call_inner(
 213                 context,
 214                 &macro_name,
 215                 &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>()[..],
 216                 mac.span,
 217                 shape,
 218                 context.config.width_heuristics().fn_call_width,
 219                 trailing_comma,
 220             ).map(|rw| match position {
 221                 MacroPosition::Item => format!("{};", rw),
 222                 _ => rw,
 223             })
 224         }
 225         MacroStyle::Brackets => {
 226             let mac_shape = shape.offset_left(macro_name.len())?;
 227             // Handle special case: `vec![expr; expr]`
 228             if vec_with_semi {
 229                 let (lbr, rbr) = if context.config.spaces_within_parens_and_brackets() {
 230                     ("[ ", " ]")
 231                 } else {
 232                     ("[", "]")
 233                 };
 234                 // 6 = `vec!` + `; `
 235                 let total_overhead = lbr.len() + rbr.len() + 6;
 236                 let nested_shape = mac_shape.block_indent(context.config.tab_spaces());
 237                 let lhs = arg_vec[0].rewrite(context, nested_shape)?;
 238                 let rhs = arg_vec[1].rewrite(context, nested_shape)?;
 239                 if !lhs.contains('\n') && !rhs.contains('\n')
 240                     && lhs.len() + rhs.len() + total_overhead <= shape.width
 241                 {
 242                     Some(format!("{}{}{}; {}{}", macro_name, lbr, lhs, rhs, rbr))
 243                 } else {
 244                     Some(format!(
 245                         "{}{}\n{}{};\n{}{}\n{}{}",
 246                         macro_name,
 247                         lbr,
 248                         nested_shape.indent.to_string(context.config),
 249                         lhs,
 250                         nested_shape.indent.to_string(context.config),
 251                         rhs,
 252                         shape.indent.to_string(context.config),
 253                         rbr
 254                     ))
 255                 }
 256             } else {
 257                 // If we are rewriting `vec!` macro or other special macros,
 258                 // then we can rewrite this as an usual array literal.
 259                 // Otherwise, we must preserve the original existence of trailing comma.
 260                 if FORCED_BRACKET_MACROS.contains(&macro_name.as_str()) {
 261                     context.inside_macro = false;
 262                     trailing_comma = false;
 263                 }
 264                 // Convert `MacroArg` into `ast::Expr`, as `rewrite_array` only accepts the latter.
 265                 let sp = mk_sp(
 266                     context
 267                         .codemap
 268                         .span_after(mac.span, original_style.opener()),
 269                     mac.span.hi() - BytePos(1),
 270                 );
 271                 let arg_vec = &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>()[..];
 272                 let rewrite = rewrite_array(arg_vec, sp, context, mac_shape, trailing_comma)?;
 273
 274                 Some(format!("{}{}", macro_name, rewrite))
 275             }
 276         }
 277         MacroStyle::Braces => {
 278             // Skip macro invocations with braces, for now.
 279             indent_macro_snippet(context, context.snippet(mac.span), shape.indent)
 280         }
 281     }
 282 }
 283
 284 pub fn rewrite_macro_def(
 285     context: &RewriteContext,
 286     indent: Indent,
 287     def: &ast::MacroDef,
 288     ident: ast::Ident,
 289     vis: &ast::Visibility,
 290     span: Span,
 291 ) -> Option<String> {
 292     let snippet = Some(remove_trailing_white_spaces(context.snippet(span)));
 293
 294     if def.legacy {
 295         return snippet;
 296     }
 297
 298     let mut parser = MacroParser::new(def.stream().into_trees());
 299     let mut parsed_def = match parser.parse() {
 300         Some(def) => def,
 301         None => return snippet,
 302     };
 303
 304     // Only attempt to format function-like macros.
 305     if parsed_def.branches.len() != 1 || parsed_def.branches[0].args_paren_kind != DelimToken::Paren
 306     {
 307         // FIXME(#1539): implement for non-sugared macros.
 308         return snippet;
 309     }
 310
 311     let branch = parsed_def.branches.remove(0);
 312     let args_str = format_macro_args(branch.args)?;
 313
 314     // The macro body is the most interesting part. It might end up as various
 315     // AST nodes, but also has special variables (e.g, `$foo`) which can't be
 316     // parsed as regular Rust code (and note that these can be escaped using
 317     // `$$`). We'll try and format like an AST node, but we'll substitute
 318     // variables for new names with the same length first.
 319
 320     let old_body = context.snippet(branch.body).trim();
 321     let (body_str, substs) = match replace_names(old_body) {
 322         Some(result) => result,
 323         None => return snippet,
 324     };
 325
 326     // We'll hack the indent below, take this into account when formatting,
 327     let mut config = context.config.clone();
 328     let new_width = config.max_width() - indent.block_indent(&config).width();
 329     config.set().max_width(new_width);
 330     config.set().hide_parse_errors(true);
 331
 332     // First try to format as items, then as statements.
 333     let new_body = match ::format_snippet(&body_str, &config) {
 334         Some(new_body) => new_body,
 335         None => match ::format_code_block(&body_str, &config) {
 336             Some(new_body) => new_body,
 337             None => return snippet,
 338         },
 339     };
 340
 341     // Indent the body since it is in a block.
 342     let indent_str = indent.block_indent(&config).to_string(&config);
 343     let mut new_body = new_body
 344         .lines()
 345         .map(|l| {
 346             if l.is_empty() {
 347                 l.to_owned()
 348             } else {
 349                 format!("{}{}", indent_str, l)
 350             }
 351         })
 352         .collect::<Vec<_>>()
 353         .join("\n");
 354
 355     // Undo our replacement of macro variables.
 356     // FIXME: this could be *much* more efficient.
 357     for (old, new) in &substs {
 358         if old_body.find(new).is_some() {
 359             debug!(
 360                 "rewrite_macro_def: bailing matching variable: `{}` in `{}`",
 361                 new, ident
 362             );
 363             return snippet;
 364         }
 365         new_body = new_body.replace(new, old);
 366     }
 367
 368     let result = format!(
 369         "{}macro {}({}) {{\n{}\n{}}}",
 370         format_visibility(vis),
 371         ident,
 372         args_str,
 373         new_body,
 374         indent.to_string(context.config),
 375     );
 376
 377     Some(result)
 378 }
 379
 380 // Replaces `$foo` with `zfoo`. We must check for name overlap to ensure we
 381 // aren't causing problems.
 382 // This should also work for escaped `$` variables, where we leave earlier `$`s.
 383 fn replace_names(input: &str) -> Option<(String, HashMap<String, String>)> {
 384     // Each substitution will require five or six extra bytes.
 385     let mut result = String::with_capacity(input.len() + 64);
 386     let mut substs = HashMap::new();
 387     let mut dollar_count = 0;
 388     let mut cur_name = String::new();
 389
 390     for c in input.chars() {
 391         if c == '$' {
 392             dollar_count += 1;
 393         } else if dollar_count == 0 {
 394             result.push(c);
 395         } else if !c.is_alphanumeric() && !cur_name.is_empty() {
 396             // Terminates a name following one or more dollars.
 397             let mut new_name = String::new();
 398             let mut old_name = String::new();
 399             old_name.push('$');
 400             for _ in 0..(dollar_count - 1) {
 401                 new_name.push('$');
 402                 old_name.push('$');
 403             }
 404             new_name.push('z');
 405             new_name.push_str(&cur_name);
 406             old_name.push_str(&cur_name);
 407
 408             result.push_str(&new_name);
 409             substs.insert(old_name, new_name);
 410
 411             result.push(c);
 412
 413             dollar_count = 0;
 414             cur_name = String::new();
 415         } else if c == '(' && cur_name.is_empty() {
 416             // FIXME: Support macro def with repeat.
 417             return None;
 418         } else if c.is_alphanumeric() {
 419             cur_name.push(c);
 420         }
 421     }
 422
 423     // FIXME: duplicate code
 424     if !cur_name.is_empty() {
 425         let mut new_name = String::new();
 426         let mut old_name = String::new();
 427         old_name.push('$');
 428         for _ in 0..(dollar_count - 1) {
 429             new_name.push('$');
 430             old_name.push('$');
 431         }
 432         new_name.push('z');
 433         new_name.push_str(&cur_name);
 434         old_name.push_str(&cur_name);
 435
 436         result.push_str(&new_name);
 437         substs.insert(old_name, new_name);
 438     }
 439
 440     debug!("replace_names `{}` {:?}", result, substs);
 441
 442     Some((result, substs))
 443 }
 444
 445 // This is a bit sketchy. The token rules probably need tweaking, but it works
 446 // for some common cases. I hope the basic logic is sufficient. Note that the
 447 // meaning of some tokens is a bit different here from usual Rust, e.g., `*`
 448 // and `(`/`)` have special meaning.
 449 //
 450 // We always try and format on one line.
 451 fn format_macro_args(toks: ThinTokenStream) -> Option<String> {
 452     let mut result = String::with_capacity(128);
 453     let mut insert_space = SpaceState::Never;
 454
 455     for tok in (toks.into(): TokenStream).trees() {
 456         match tok {
 457             TokenTree::Token(_, t) => {
 458                 if !result.is_empty() && force_space_before(&t) {
 459                     insert_space = SpaceState::Always;
 460                 }
 461                 if force_no_space_before(&t) {
 462                     insert_space = SpaceState::Never;
 463                 }
 464                 match (insert_space, ident_like(&t)) {
 465                     (SpaceState::Always, _)
 466                     | (SpaceState::Punctuation, false)
 467                     | (SpaceState::Ident, true) => {
 468                         result.push(' ');
 469                     }
 470                     _ => {}
 471                 }
 472                 result.push_str(&pprust::token_to_string(&t));
 473                 insert_space = next_space(&t);
 474             }
 475             TokenTree::Delimited(_, d) => {
 476                 if let SpaceState::Always = insert_space {
 477                     result.push(' ');
 478                 }
 479                 let formatted = format_macro_args(d.tts)?;
 480                 match d.delim {
 481                     DelimToken::Paren => {
 482                         result.push_str(&format!("({})", formatted));
 483                         insert_space = SpaceState::Always;
 484                     }
 485                     DelimToken::Bracket => {
 486                         result.push_str(&format!("[{}]", formatted));
 487                         insert_space = SpaceState::Always;
 488                     }
 489                     DelimToken::Brace => {
 490                         result.push_str(&format!(" {{ {} }}", formatted));
 491                         insert_space = SpaceState::Always;
 492                     }
 493                     DelimToken::NoDelim => {
 494                         result.push_str(&format!("{}", formatted));
 495                         insert_space = SpaceState::Always;
 496                     }
 497                 }
 498             }
 499         }
 500     }
 501
 502     Some(result)
 503 }
 504
 505 // We should insert a space if the next token is a:
 506 #[derive(Copy, Clone)]
 507 enum SpaceState {
 508     Never,
 509     Punctuation,
 510     Ident, // Or ident/literal-like thing.
 511     Always,
 512 }
 513
 514 fn force_space_before(tok: &Token) -> bool {
 515     match *tok {
 516         Token::Eq
 517         | Token::Lt
 518         | Token::Le
 519         | Token::EqEq
 520         | Token::Ne
 521         | Token::Ge
 522         | Token::Gt
 523         | Token::AndAnd
 524         | Token::OrOr
 525         | Token::Not
 526         | Token::Tilde
 527         | Token::BinOpEq(_)
 528         | Token::At
 529         | Token::RArrow
 530         | Token::LArrow
 531         | Token::FatArrow
 532         | Token::Pound
 533         | Token::Dollar => true,
 534         Token::BinOp(bot) => bot != BinOpToken::Star,
 535         _ => false,
 536     }
 537 }
 538
 539 fn force_no_space_before(tok: &Token) -> bool {
 540     match *tok {
 541         Token::Semi | Token::Comma | Token::Dot => true,
 542         Token::BinOp(bot) => bot == BinOpToken::Star,
 543         _ => false,
 544     }
 545 }
 546 fn ident_like(tok: &Token) -> bool {
 547     match *tok {
 548         Token::Ident(_) | Token::Literal(..) | Token::Lifetime(_) => true,
 549         _ => false,
 550     }
 551 }
 552
 553 fn next_space(tok: &Token) -> SpaceState {
 554     match *tok {
 555         Token::Not
 556         | Token::Tilde
 557         | Token::At
 558         | Token::Comma
 559         | Token::Dot
 560         | Token::DotDot
 561         | Token::DotDotDot
 562         | Token::DotDotEq
 563         | Token::DotEq
 564         | Token::Question
 565         | Token::Underscore
 566         | Token::BinOp(_) => SpaceState::Punctuation,
 567
 568         Token::ModSep
 569         | Token::Pound
 570         | Token::Dollar
 571         | Token::OpenDelim(_)
 572         | Token::CloseDelim(_)
 573         | Token::Whitespace => SpaceState::Never,
 574
 575         Token::Literal(..) | Token::Ident(_) | Token::Lifetime(_) => SpaceState::Ident,
 576
 577         _ => SpaceState::Always,
 578     }
 579 }
 580
 581 /// Tries to convert a macro use into a short hand try expression. Returns None
 582 /// when the macro is not an instance of try! (or parsing the inner expression
 583 /// failed).
 584 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
 585     if &format!("{}", mac.node.path)[..] == "try" {
 586         let ts: TokenStream = mac.node.tts.clone().into();
 587         let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 588
 589         Some(ast::Expr {
 590             id: ast::NodeId::new(0), // dummy value
 591             node: ast::ExprKind::Try(parser.parse_expr().ok()?),
 592             span: mac.span, // incorrect span, but shouldn't matter too much
 593             attrs: ThinVec::new(),
 594         })
 595     } else {
 596         None
 597     }
 598 }
 599
 600 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
 601     let snippet = context.snippet(mac.span);
 602     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
 603     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
 604     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
 605
 606     if paren_pos < bracket_pos && paren_pos < brace_pos {
 607         MacroStyle::Parens
 608     } else if bracket_pos < brace_pos {
 609         MacroStyle::Brackets
 610     } else {
 611         MacroStyle::Braces
 612     }
 613 }
 614
 615 /// Indent each line according to the specified `indent`.
 616 /// e.g.
 617 /// ```rust
 618 /// foo!{
 619 /// x,
 620 /// y,
 621 /// foo(
 622 ///     a,
 623 ///     b,
 624 ///     c,
 625 /// ),
 626 /// }
 627 /// ```
 628 /// will become
 629 /// ```rust
 630 /// foo!{
 631 ///     x,
 632 ///     y,
 633 ///     foo(
 634 ///         a,
 635 ///         b,
 636 ///         c,
 637 //      ),
 638 /// }
 639 /// ```
 640 fn indent_macro_snippet(
 641     context: &RewriteContext,
 642     macro_str: &str,
 643     indent: Indent,
 644 ) -> Option<String> {
 645     let mut lines = macro_str.lines();
 646     let first_line = lines.next().map(|s| s.trim_right())?;
 647     let mut trimmed_lines = Vec::with_capacity(16);
 648
 649     let min_prefix_space_width = lines
 650         .filter_map(|line| {
 651             let prefix_space_width = if is_empty_line(line) {
 652                 None
 653             } else {
 654                 Some(get_prefix_space_width(context, line))
 655             };
 656             trimmed_lines.push((line.trim(), prefix_space_width));
 657             prefix_space_width
 658         })
 659         .min()?;
 660
 661     Some(
 662         String::from(first_line) + "\n"
 663             + &trimmed_lines
 664                 .iter()
 665                 .map(|&(line, prefix_space_width)| match prefix_space_width {
 666                     Some(original_indent_width) => {
 667                         let new_indent_width = indent.width()
 668                             + original_indent_width
 669                                 .checked_sub(min_prefix_space_width)
 670                                 .unwrap_or(0);
 671                         let new_indent = Indent::from_width(context.config, new_indent_width);
 672                         format!("{}{}", new_indent.to_string(context.config), line.trim())
 673                     }
 674                     None => String::new(),
 675                 })
 676                 .collect::<Vec<_>>()
 677                 .join("\n"),
 678     )
 679 }
 680
 681 fn get_prefix_space_width(context: &RewriteContext, s: &str) -> usize {
 682     let mut width = 0;
 683     for c in s.chars() {
 684         match c {
 685             ' ' => width += 1,
 686             '\t' => width += context.config.tab_spaces(),
 687             _ => return width,
 688         }
 689     }
 690     width
 691 }
 692
 693 fn is_empty_line(s: &str) -> bool {
 694     s.is_empty() || s.chars().all(char::is_whitespace)
 695 }
 696
 697 // A very simple parser that just parses a macros 2.0 definition into its branches.
 698 // Currently we do not attempt to parse any further than that.
 699 #[derive(new)]
 700 struct MacroParser {
 701     toks: Cursor,
 702 }
 703
 704 impl MacroParser {
 705     // (`(` ... `)` `=>` `{` ... `}`)*
 706     fn parse(&mut self) -> Option<Macro> {
 707         let mut branches = vec![];
 708         while self.toks.look_ahead(1).is_some() {
 709             branches.push(self.parse_branch()?);
 710         }
 711
 712         Some(Macro { branches })
 713     }
 714
 715     // `(` ... `)` `=>` `{` ... `}`
 716     fn parse_branch(&mut self) -> Option<MacroBranch> {
 717         let (args_paren_kind, args) = match self.toks.next()? {
 718             TokenTree::Token(..) => return None,
 719             TokenTree::Delimited(_, ref d) => (d.delim, d.tts.clone()),
 720         };
 721         match self.toks.next()? {
 722             TokenTree::Token(_, Token::FatArrow) => {}
 723             _ => return None,
 724         }
 725         let body = match self.toks.next()? {
 726             TokenTree::Token(..) => return None,
 727             TokenTree::Delimited(sp, _) => {
 728                 let data = sp.data();
 729                 Span::new(data.lo + BytePos(1), data.hi - BytePos(1), data.ctxt)
 730             }
 731         };
 732         Some(MacroBranch {
 733             args,
 734             args_paren_kind,
 735             body,
 736         })
 737     }
 738 }
 739
 740 // A parsed macros 2.0 macro definition.
 741 struct Macro {
 742     branches: Vec<MacroBranch>,
 743 }
 744
 745 // FIXME: it would be more efficient to use references to the token streams
 746 // rather than clone them, if we can make the borrowing work out.
 747 struct MacroBranch {
 748     args: ThinTokenStream,
 749     args_paren_kind: DelimToken,
 750     body: Span,
 751 }
 752
 753 #[cfg(test)]
 754 mod test {
 755     use super::*;
 756     use syntax::parse::{parse_stream_from_source_str, ParseSess};
 757     use syntax::codemap::{FileName, FilePathMapping};
 758
 759     fn format_macro_args_str(s: &str) -> String {
 760         let input = parse_stream_from_source_str(
 761             FileName::Custom("stdin".to_owned()),
 762             s.to_owned(),
 763             &ParseSess::new(FilePathMapping::empty()),
 764             None,
 765         );
 766         format_macro_args(input.into()).unwrap()
 767     }
 768
 769     #[test]
 770     fn test_format_macro_args() {
 771         assert_eq!(format_macro_args_str(""), "".to_owned());
 772         assert_eq!(format_macro_args_str("$ x : ident"), "$x: ident".to_owned());
 773         assert_eq!(
 774             format_macro_args_str("$ m1 : ident , $ m2 : ident , $ x : ident"),
 775             "$m1: ident, $m2: ident, $x: ident".to_owned()
 776         );
 777         assert_eq!(
 778             format_macro_args_str("$($beginning:ident),*;$middle:ident;$($end:ident),*"),
 779             "$($beginning: ident),*; $middle: ident; $($end: ident),*".to_owned()
 780         );
 781         assert_eq!(
 782             format_macro_args_str(
 783                 "$ name : ident ( $ ( $ dol : tt $ var : ident ) * ) $ ( $ body : tt ) *"
 784             ),
 785             "$name: ident($($dol: tt $var: ident)*) $($body: tt)*".to_owned()
 786         );
 787     }
 788 }