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) = replace_names(old_body);
 322
 323     // We'll hack the indent below, take this into account when formatting,
 324     let mut config = context.config.clone();
 325     let new_width = config.max_width() - indent.block_indent(&config).width();
 326     config.set().max_width(new_width);
 327     config.set().hide_parse_errors(true);
 328
 329     // First try to format as items, then as statements.
 330     let new_body = match ::format_snippet(&body_str, &config) {
 331         Some(new_body) => new_body,
 332         None => match ::format_code_block(&body_str, &config) {
 333             Some(new_body) => new_body,
 334             None => return snippet,
 335         },
 336     };
 337
 338     // Indent the body since it is in a block.
 339     let indent_str = indent.block_indent(&config).to_string(&config);
 340     let mut new_body = new_body
 341         .lines()
 342         .map(|l| {
 343             if l.is_empty() {
 344                 l.to_owned()
 345             } else {
 346                 format!("{}{}", indent_str, l)
 347             }
 348         })
 349         .collect::<Vec<_>>()
 350         .join("\n");
 351
 352     // Undo our replacement of macro variables.
 353     // FIXME: this could be *much* more efficient.
 354     for (old, new) in &substs {
 355         if old_body.find(new).is_some() {
 356             debug!(
 357                 "rewrite_macro_def: bailing matching variable: `{}` in `{}`",
 358                 new, ident
 359             );
 360             return snippet;
 361         }
 362         new_body = new_body.replace(new, old);
 363     }
 364
 365     let result = format!(
 366         "{}macro {}({}) {{\n{}\n{}}}",
 367         format_visibility(vis),
 368         ident,
 369         args_str,
 370         new_body,
 371         indent.to_string(context.config),
 372     );
 373
 374     Some(result)
 375 }
 376
 377 // Replaces `$foo` with `zfoo`. We must check for name overlap to ensure we
 378 // aren't causing problems.
 379 // This should also work for escaped `$` variables, where we leave earlier `$`s.
 380 fn replace_names(input: &str) -> (String, HashMap<String, String>) {
 381     // Each substitution will require five or six extra bytes.
 382     let mut result = String::with_capacity(input.len() + 64);
 383     let mut substs = HashMap::new();
 384     let mut dollar_count = 0;
 385     let mut cur_name = String::new();
 386
 387     for c in input.chars() {
 388         if c == '$' {
 389             dollar_count += 1;
 390         } else if dollar_count == 0 {
 391             result.push(c);
 392         } else if !c.is_alphanumeric() && !cur_name.is_empty() {
 393             // Terminates a name following one or more dollars.
 394             let mut new_name = String::new();
 395             let mut old_name = String::new();
 396             old_name.push('$');
 397             for _ in 0..(dollar_count - 1) {
 398                 new_name.push('$');
 399                 old_name.push('$');
 400             }
 401             new_name.push('z');
 402             new_name.push_str(&cur_name);
 403             old_name.push_str(&cur_name);
 404
 405             result.push_str(&new_name);
 406             substs.insert(old_name, new_name);
 407
 408             result.push(c);
 409
 410             dollar_count = 0;
 411             cur_name = String::new();
 412         } else if c.is_alphanumeric() {
 413             cur_name.push(c);
 414         }
 415     }
 416
 417     // FIXME: duplicate code
 418     if !cur_name.is_empty() {
 419         let mut new_name = String::new();
 420         let mut old_name = String::new();
 421         old_name.push('$');
 422         for _ in 0..(dollar_count - 1) {
 423             new_name.push('$');
 424             old_name.push('$');
 425         }
 426         new_name.push('z');
 427         new_name.push_str(&cur_name);
 428         old_name.push_str(&cur_name);
 429
 430         result.push_str(&new_name);
 431         substs.insert(old_name, new_name);
 432     }
 433
 434     debug!("replace_names `{}` {:?}", result, substs);
 435
 436     (result, substs)
 437 }
 438
 439 // This is a bit sketchy. The token rules probably need tweaking, but it works
 440 // for some common cases. I hope the basic logic is sufficient. Note that the
 441 // meaning of some tokens is a bit different here from usual Rust, e.g., `*`
 442 // and `(`/`)` have special meaning.
 443 //
 444 // We always try and format on one line.
 445 fn format_macro_args(toks: ThinTokenStream) -> Option<String> {
 446     let mut result = String::with_capacity(128);
 447     let mut insert_space = SpaceState::Never;
 448
 449     for tok in (toks.into(): TokenStream).trees() {
 450         match tok {
 451             TokenTree::Token(_, t) => {
 452                 if !result.is_empty() && force_space_before(&t) {
 453                     insert_space = SpaceState::Always;
 454                 }
 455                 if force_no_space_before(&t) {
 456                     insert_space = SpaceState::Never;
 457                 }
 458                 match (insert_space, ident_like(&t)) {
 459                     (SpaceState::Always, _)
 460                     | (SpaceState::Punctuation, false)
 461                     | (SpaceState::Ident, true) => {
 462                         result.push(' ');
 463                     }
 464                     _ => {}
 465                 }
 466                 result.push_str(&pprust::token_to_string(&t));
 467                 insert_space = next_space(&t);
 468             }
 469             TokenTree::Delimited(_, d) => {
 470                 if let SpaceState::Always = insert_space {
 471                     result.push(' ');
 472                 }
 473                 let formatted = format_macro_args(d.tts)?;
 474                 match d.delim {
 475                     DelimToken::Paren => {
 476                         result.push_str(&format!("({})", formatted));
 477                         insert_space = SpaceState::Always;
 478                     }
 479                     DelimToken::Bracket => {
 480                         result.push_str(&format!("[{}]", formatted));
 481                         insert_space = SpaceState::Always;
 482                     }
 483                     DelimToken::Brace => {
 484                         result.push_str(&format!(" {{ {} }}", formatted));
 485                         insert_space = SpaceState::Always;
 486                     }
 487                     DelimToken::NoDelim => {
 488                         result.push_str(&format!("{}", formatted));
 489                         insert_space = SpaceState::Always;
 490                     }
 491                 }
 492             }
 493         }
 494     }
 495
 496     Some(result)
 497 }
 498
 499 // We should insert a space if the next token is a:
 500 #[derive(Copy, Clone)]
 501 enum SpaceState {
 502     Never,
 503     Punctuation,
 504     Ident, // Or ident/literal-like thing.
 505     Always,
 506 }
 507
 508 fn force_space_before(tok: &Token) -> bool {
 509     match *tok {
 510         Token::Eq
 511         | Token::Lt
 512         | Token::Le
 513         | Token::EqEq
 514         | Token::Ne
 515         | Token::Ge
 516         | Token::Gt
 517         | Token::AndAnd
 518         | Token::OrOr
 519         | Token::Not
 520         | Token::Tilde
 521         | Token::BinOpEq(_)
 522         | Token::At
 523         | Token::RArrow
 524         | Token::LArrow
 525         | Token::FatArrow
 526         | Token::Pound
 527         | Token::Dollar => true,
 528         Token::BinOp(bot) => bot != BinOpToken::Star,
 529         _ => false,
 530     }
 531 }
 532
 533 fn force_no_space_before(tok: &Token) -> bool {
 534     match *tok {
 535         Token::Semi | Token::Comma | Token::Dot => true,
 536         Token::BinOp(bot) => bot == BinOpToken::Star,
 537         _ => false,
 538     }
 539 }
 540 fn ident_like(tok: &Token) -> bool {
 541     match *tok {
 542         Token::Ident(_) | Token::Literal(..) | Token::Lifetime(_) => true,
 543         _ => false,
 544     }
 545 }
 546
 547 fn next_space(tok: &Token) -> SpaceState {
 548     match *tok {
 549         Token::Not
 550         | Token::Tilde
 551         | Token::At
 552         | Token::Comma
 553         | Token::Dot
 554         | Token::DotDot
 555         | Token::DotDotDot
 556         | Token::DotDotEq
 557         | Token::DotEq
 558         | Token::Question
 559         | Token::Underscore
 560         | Token::BinOp(_) => SpaceState::Punctuation,
 561
 562         Token::ModSep
 563         | Token::Pound
 564         | Token::Dollar
 565         | Token::OpenDelim(_)
 566         | Token::CloseDelim(_)
 567         | Token::Whitespace => SpaceState::Never,
 568
 569         Token::Literal(..) | Token::Ident(_) | Token::Lifetime(_) => SpaceState::Ident,
 570
 571         _ => SpaceState::Always,
 572     }
 573 }
 574
 575 /// Tries to convert a macro use into a short hand try expression. Returns None
 576 /// when the macro is not an instance of try! (or parsing the inner expression
 577 /// failed).
 578 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
 579     if &format!("{}", mac.node.path)[..] == "try" {
 580         let ts: TokenStream = mac.node.tts.clone().into();
 581         let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 582
 583         Some(ast::Expr {
 584             id: ast::NodeId::new(0), // dummy value
 585             node: ast::ExprKind::Try(parser.parse_expr().ok()?),
 586             span: mac.span, // incorrect span, but shouldn't matter too much
 587             attrs: ThinVec::new(),
 588         })
 589     } else {
 590         None
 591     }
 592 }
 593
 594 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
 595     let snippet = context.snippet(mac.span);
 596     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
 597     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
 598     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
 599
 600     if paren_pos < bracket_pos && paren_pos < brace_pos {
 601         MacroStyle::Parens
 602     } else if bracket_pos < brace_pos {
 603         MacroStyle::Brackets
 604     } else {
 605         MacroStyle::Braces
 606     }
 607 }
 608
 609 /// Indent each line according to the specified `indent`.
 610 /// e.g.
 611 /// ```rust
 612 /// foo!{
 613 /// x,
 614 /// y,
 615 /// foo(
 616 ///     a,
 617 ///     b,
 618 ///     c,
 619 /// ),
 620 /// }
 621 /// ```
 622 /// will become
 623 /// ```rust
 624 /// foo!{
 625 ///     x,
 626 ///     y,
 627 ///     foo(
 628 ///         a,
 629 ///         b,
 630 ///         c,
 631 //      ),
 632 /// }
 633 /// ```
 634 fn indent_macro_snippet(
 635     context: &RewriteContext,
 636     macro_str: &str,
 637     indent: Indent,
 638 ) -> Option<String> {
 639     let mut lines = macro_str.lines();
 640     let first_line = lines.next().map(|s| s.trim_right())?;
 641     let mut trimmed_lines = Vec::with_capacity(16);
 642
 643     let min_prefix_space_width = lines
 644         .filter_map(|line| {
 645             let prefix_space_width = if is_empty_line(line) {
 646                 None
 647             } else {
 648                 Some(get_prefix_space_width(context, line))
 649             };
 650             trimmed_lines.push((line.trim(), prefix_space_width));
 651             prefix_space_width
 652         })
 653         .min()?;
 654
 655     Some(
 656         String::from(first_line) + "\n"
 657             + &trimmed_lines
 658                 .iter()
 659                 .map(|&(line, prefix_space_width)| match prefix_space_width {
 660                     Some(original_indent_width) => {
 661                         let new_indent_width = indent.width()
 662                             + original_indent_width
 663                                 .checked_sub(min_prefix_space_width)
 664                                 .unwrap_or(0);
 665                         let new_indent = Indent::from_width(context.config, new_indent_width);
 666                         format!("{}{}", new_indent.to_string(context.config), line.trim())
 667                     }
 668                     None => String::new(),
 669                 })
 670                 .collect::<Vec<_>>()
 671                 .join("\n"),
 672     )
 673 }
 674
 675 fn get_prefix_space_width(context: &RewriteContext, s: &str) -> usize {
 676     let mut width = 0;
 677     for c in s.chars() {
 678         match c {
 679             ' ' => width += 1,
 680             '\t' => width += context.config.tab_spaces(),
 681             _ => return width,
 682         }
 683     }
 684     width
 685 }
 686
 687 fn is_empty_line(s: &str) -> bool {
 688     s.is_empty() || s.chars().all(char::is_whitespace)
 689 }
 690
 691 // A very simple parser that just parses a macros 2.0 definition into its branches.
 692 // Currently we do not attempt to parse any further than that.
 693 #[derive(new)]
 694 struct MacroParser {
 695     toks: Cursor,
 696 }
 697
 698 impl MacroParser {
 699     // (`(` ... `)` `=>` `{` ... `}`)*
 700     fn parse(&mut self) -> Option<Macro> {
 701         let mut branches = vec![];
 702         while self.toks.look_ahead(1).is_some() {
 703             branches.push(self.parse_branch()?);
 704         }
 705
 706         Some(Macro { branches })
 707     }
 708
 709     // `(` ... `)` `=>` `{` ... `}`
 710     fn parse_branch(&mut self) -> Option<MacroBranch> {
 711         let (args_paren_kind, args) = match self.toks.next()? {
 712             TokenTree::Token(..) => return None,
 713             TokenTree::Delimited(_, ref d) => (d.delim, d.tts.clone()),
 714         };
 715         match self.toks.next()? {
 716             TokenTree::Token(_, Token::FatArrow) => {}
 717             _ => return None,
 718         }
 719         let body = match self.toks.next()? {
 720             TokenTree::Token(..) => return None,
 721             TokenTree::Delimited(sp, _) => {
 722                 let data = sp.data();
 723                 Span::new(data.lo + BytePos(1), data.hi - BytePos(1), data.ctxt)
 724             }
 725         };
 726         Some(MacroBranch {
 727             args,
 728             args_paren_kind,
 729             body,
 730         })
 731     }
 732 }
 733
 734 // A parsed macros 2.0 macro definition.
 735 struct Macro {
 736     branches: Vec<MacroBranch>,
 737 }
 738
 739 // FIXME: it would be more efficient to use references to the token streams
 740 // rather than clone them, if we can make the borrowing work out.
 741 struct MacroBranch {
 742     args: ThinTokenStream,
 743     args_paren_kind: DelimToken,
 744     body: Span,
 745 }
 746
 747 #[cfg(test)]
 748 mod test {
 749     use super::*;
 750     use syntax::parse::{parse_stream_from_source_str, ParseSess};
 751     use syntax::codemap::{FileName, FilePathMapping};
 752
 753     fn format_macro_args_str(s: &str) -> String {
 754         let input = parse_stream_from_source_str(
 755             FileName::Custom("stdin".to_owned()),
 756             s.to_owned(),
 757             &ParseSess::new(FilePathMapping::empty()),
 758             None,
 759         );
 760         format_macro_args(input.into()).unwrap()
 761     }
 762
 763     #[test]
 764     fn test_format_macro_args() {
 765         assert_eq!(format_macro_args_str(""), "".to_owned());
 766         assert_eq!(format_macro_args_str("$ x : ident"), "$x: ident".to_owned());
 767         assert_eq!(
 768             format_macro_args_str("$ m1 : ident , $ m2 : ident , $ x : ident"),
 769             "$m1: ident, $m2: ident, $x: ident".to_owned()
 770         );
 771         assert_eq!(
 772             format_macro_args_str("$($beginning:ident),*;$middle:ident;$($end:ident),*"),
 773             "$($beginning: ident),*; $middle: ident; $($end: ident),*".to_owned()
 774         );
 775         assert_eq!(
 776             format_macro_args_str(
 777                 "$ name : ident ( $ ( $ dol : tt $ var : ident ) * ) $ ( $ body : tt ) *"
 778             ),
 779             "$name: ident($($dol: tt $var: ident)*) $($body: tt)*".to_owned()
 780         );
 781     }
 782 }