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 // reformated.
  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::thread;
  23
  24 use syntax::ast;
  25 use syntax::parse::token::{Eof, Comma, Token};
  26 use syntax::parse::{ParseSess, tts_to_parser};
  27
  28 use Indent;
  29 use rewrite::RewriteContext;
  30 use expr::{rewrite_call, rewrite_array};
  31 use comment::FindUncommented;
  32 use utils::wrap_str;
  33
  34 // We need to pass `TokenTree`s to our expression parsing thread, but they are
  35 // not `Send`. We wrap them in a `Send` container to force our will.
  36 // FIXME: this is a pretty terrible hack. Any other solution would be preferred.
  37 struct ForceSend<T>(pub T);
  38 unsafe impl<T> Send for ForceSend<T> {}
  39
  40 // FIXME: use the enum from libsyntax?
  41 enum MacroStyle {
  42     Parens,
  43     Brackets,
  44     Braces,
  45 }
  46
  47 pub fn rewrite_macro(mac: &ast::Mac,
  48                      context: &RewriteContext,
  49                      width: usize,
  50                      offset: Indent)
  51                      -> Option<String> {
  52     let style = macro_style(mac, context);
  53     let macro_name = format!("{}!", mac.node.path);
  54
  55     if let MacroStyle::Braces = style {
  56         return None;
  57     } else if mac.node.tts.is_empty() {
  58         return if let MacroStyle::Parens = style {
  59             Some(format!("{}()", macro_name))
  60         } else {
  61             Some(format!("{}[]", macro_name))
  62         };
  63     }
  64
  65     let wrapped_tt_vec = ForceSend(mac.node.tts.clone());
  66     // Wrap expression parsing logic in a thread since the libsyntax parser
  67     // panics on failure, which we do not want to propagate.
  68     // The expression vector is wrapped in an Option inside a Result.
  69     let expr_vec_result = thread::catch_panic(move || {
  70         let parse_session = ParseSess::new();
  71         let mut parser = tts_to_parser(&parse_session, wrapped_tt_vec.0, vec![]);
  72         let mut expr_vec = vec![];
  73
  74         loop {
  75             expr_vec.push(parser.parse_expr());
  76
  77             match parser.token {
  78                 Token::Eof => break,
  79                 Token::Comma => (),
  80                 _ => panic!("Macro not list-like, skiping..."),
  81             }
  82
  83             let _ = parser.bump();
  84
  85             if parser.token == Token::Eof {
  86                 return None;
  87             }
  88         }
  89
  90         Some(expr_vec)
  91     });
  92     let expr_vec = try_opt!(try_opt!(expr_vec_result.ok()));
  93
  94     match style {
  95         MacroStyle::Parens => {
  96             // Format macro invocation as function call.
  97             rewrite_call(context, &macro_name, &expr_vec, mac.span, width, offset)
  98         }
  99         MacroStyle::Brackets => {
 100             // Format macro invocation as array literal.
 101             let extra_offset = macro_name.len();
 102             let rewrite = try_opt!(rewrite_array(expr_vec.iter().map(|x| &**x),
 103                                                  mac.span,
 104                                                  context,
 105                                                  try_opt!(width.checked_sub(extra_offset)),
 106                                                  offset + extra_offset));
 107             Some(format!("{}{}", macro_name, rewrite))
 108         }
 109         MacroStyle::Braces => {
 110             // Skip macro invocations with braces, for now.
 111             wrap_str(context.snippet(mac.span),
 112                      context.config.max_width,
 113                      width,
 114                      offset)
 115         }
 116     }
 117 }
 118
 119 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
 120     let snippet = context.snippet(mac.span);
 121     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
 122     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
 123     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
 124
 125     if paren_pos < bracket_pos && paren_pos < brace_pos {
 126         MacroStyle::Parens
 127     } else if bracket_pos < brace_pos {
 128         MacroStyle::Brackets
 129     } else {
 130         MacroStyle::Braces
 131     }
 132 }