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 syntax::ast;
  23 use syntax::parse::token::Token;
  24 use syntax::parse::tts_to_parser;
  25 use syntax::codemap::{mk_sp, BytePos};
  26
  27 use Indent;
  28 use rewrite::RewriteContext;
  29 use expr::{rewrite_call, rewrite_array};
  30 use comment::FindUncommented;
  31 use utils::{wrap_str, span_after};
  32
  33 static FORCED_BRACKET_MACROS: &'static [&'static str] = &["vec!"];
  34
  35 // FIXME: use the enum from libsyntax?
  36 #[derive(Clone, Copy)]
  37 enum MacroStyle {
  38     Parens,
  39     Brackets,
  40     Braces,
  41 }
  42
  43 impl MacroStyle {
  44     fn opener(&self) -> &'static str {
  45         match *self {
  46             MacroStyle::Parens => "(",
  47             MacroStyle::Brackets => "[",
  48             MacroStyle::Braces => "{",
  49         }
  50     }
  51 }
  52
  53 pub fn rewrite_macro(mac: &ast::Mac,
  54                      context: &RewriteContext,
  55                      width: usize,
  56                      offset: Indent)
  57                      -> Option<String> {
  58     let original_style = macro_style(mac, context);
  59     let macro_name = format!("{}!", mac.node.path);
  60     let style = if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
  61         MacroStyle::Brackets
  62     } else {
  63         original_style
  64     };
  65
  66     if let MacroStyle::Braces = style {
  67         return None;
  68     } else if mac.node.tts.is_empty() {
  69         return if let MacroStyle::Parens = style {
  70             Some(format!("{}()", macro_name))
  71         } else {
  72             Some(format!("{}[]", macro_name))
  73         };
  74     }
  75
  76     let mut parser = tts_to_parser(context.parse_session, mac.node.tts.clone(), Vec::new());
  77     let mut expr_vec = Vec::new();
  78
  79     loop {
  80         expr_vec.push(match parser.parse_expr() {
  81             Ok(expr) => expr,
  82             Err(..) => return None,
  83         });
  84
  85         match parser.token {
  86             Token::Eof => break,
  87             Token::Comma => (),
  88             _ => return None,
  89         }
  90
  91         let _ = parser.bump();
  92
  93         if parser.token == Token::Eof {
  94             return None;
  95         }
  96     }
  97
  98     match style {
  99         MacroStyle::Parens => {
 100             // Format macro invocation as function call.
 101             rewrite_call(context, &macro_name, &expr_vec, mac.span, width, offset)
 102         }
 103         MacroStyle::Brackets => {
 104             // Format macro invocation as array literal.
 105             let extra_offset = macro_name.len();
 106             let rewrite = try_opt!(rewrite_array(expr_vec.iter().map(|x| &**x),
 107                                                  mk_sp(span_after(mac.span,
 108                                                                   original_style.opener(),
 109                                                                   context.codemap),
 110                                                        mac.span.hi - BytePos(1)),
 111                                                  context,
 112                                                  try_opt!(width.checked_sub(extra_offset)),
 113                                                  offset + extra_offset));
 114
 115             Some(format!("{}{}", macro_name, rewrite))
 116         }
 117         MacroStyle::Braces => {
 118             // Skip macro invocations with braces, for now.
 119             wrap_str(context.snippet(mac.span),
 120                      context.config.max_width,
 121                      width,
 122                      offset)
 123         }
 124     }
 125 }
 126
 127 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
 128     let snippet = context.snippet(mac.span);
 129     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
 130     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
 131     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
 132
 133     if paren_pos < bracket_pos && paren_pos < brace_pos {
 134         MacroStyle::Parens
 135     } else if bracket_pos < brace_pos {
 136         MacroStyle::Brackets
 137     } else {
 138         MacroStyle::Braces
 139     }
 140 }