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::codemap::BytePos;
  24 use syntax::parse::token::Token;
  25 use syntax::parse::new_parser_from_tts;
  26 use syntax::tokenstream::TokenStream;
  27 use syntax::symbol;
  28 use syntax::util::ThinVec;
  29
  30 use Shape;
  31 use codemap::SpanUtils;
  32 use rewrite::{Rewrite, RewriteContext};
  33 use expr::{rewrite_call, rewrite_array, rewrite_pair};
  34 use comment::{FindUncommented, contains_comment};
  35 use utils::mk_sp;
  36
  37 const FORCED_BRACKET_MACROS: &'static [&'static str] = &["vec!"];
  38
  39 // FIXME: use the enum from libsyntax?
  40 #[derive(Clone, Copy, PartialEq, Eq)]
  41 enum MacroStyle {
  42     Parens,
  43     Brackets,
  44     Braces,
  45 }
  46
  47 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
  48 pub enum MacroPosition {
  49     Item,
  50     Statement,
  51     Expression,
  52 }
  53
  54 impl MacroStyle {
  55     fn opener(&self) -> &'static str {
  56         match *self {
  57             MacroStyle::Parens => "(",
  58             MacroStyle::Brackets => "[",
  59             MacroStyle::Braces => "{",
  60         }
  61     }
  62 }
  63
  64 pub fn rewrite_macro(mac: &ast::Mac,
  65                      extra_ident: Option<ast::Ident>,
  66                      context: &RewriteContext,
  67                      shape: Shape,
  68                      position: MacroPosition)
  69                      -> Option<String> {
  70     let mut context = &mut context.clone();
  71     context.inside_macro = true;
  72     if context.config.use_try_shorthand() {
  73         if let Some(expr) = convert_try_mac(mac, context) {
  74             return expr.rewrite(context, shape);
  75         }
  76     }
  77
  78     let original_style = macro_style(mac, context);
  79
  80     let macro_name = match extra_ident {
  81         None => format!("{}!", mac.node.path),
  82         Some(ident) => {
  83             if ident == symbol::keywords::Invalid.ident() {
  84                 format!("{}!", mac.node.path)
  85             } else {
  86                 format!("{}! {}", mac.node.path, ident)
  87             }
  88         }
  89     };
  90
  91     let style = if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
  92         MacroStyle::Brackets
  93     } else {
  94         original_style
  95     };
  96
  97     let ts: TokenStream = mac.node.tts.clone().into();
  98     if ts.is_empty() && !contains_comment(&context.snippet(mac.span)) {
  99         return match style {
 100             MacroStyle::Parens if position == MacroPosition::Item => {
 101                 Some(format!("{}();", macro_name))
 102             }
 103             MacroStyle::Parens => Some(format!("{}()", macro_name)),
 104             MacroStyle::Brackets => Some(format!("{}[]", macro_name)),
 105             MacroStyle::Braces => Some(format!("{}{{}}", macro_name)),
 106         };
 107     }
 108
 109     let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 110     let mut expr_vec = Vec::new();
 111     let mut vec_with_semi = false;
 112
 113     if MacroStyle::Braces != style {
 114         loop {
 115             let expr = match parser.parse_expr() {
 116                 Ok(expr) => {
 117                     // Recovered errors.
 118                     if context.parse_session.span_diagnostic.has_errors() {
 119                         return Some(context.snippet(mac.span));
 120                     }
 121
 122                     expr
 123                 }
 124                 Err(mut e) => {
 125                     e.cancel();
 126                     return Some(context.snippet(mac.span));
 127                 }
 128             };
 129
 130             expr_vec.push(expr);
 131
 132             match parser.token {
 133                 Token::Eof => break,
 134                 Token::Comma => (),
 135                 Token::Semi => {
 136                     // Try to parse `vec![expr; expr]`
 137                     if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
 138                         parser.bump();
 139                         if parser.token != Token::Eof {
 140                             match parser.parse_expr() {
 141                                 Ok(expr) => {
 142                                     if context.parse_session.span_diagnostic.has_errors() {
 143                                         return None;
 144                                     }
 145                                     expr_vec.push(expr);
 146                                     parser.bump();
 147                                     if parser.token == Token::Eof && expr_vec.len() == 2 {
 148                                         vec_with_semi = true;
 149                                         break;
 150                                     }
 151                                 }
 152                                 Err(mut e) => e.cancel(),
 153                             }
 154                         }
 155                     }
 156                     return None;
 157                 }
 158                 _ => return None,
 159             }
 160
 161             parser.bump();
 162
 163             if parser.token == Token::Eof {
 164                 // vec! is a special case of bracket macro which should be formated as an array.
 165                 if macro_name == "vec!" {
 166                     break;
 167                 } else {
 168                     return None;
 169                 }
 170             }
 171         }
 172     }
 173
 174     match style {
 175         MacroStyle::Parens => {
 176             // Format macro invocation as function call, forcing no trailing
 177             // comma because not all macros support them.
 178             rewrite_call(context, &macro_name, &expr_vec, mac.span, shape).map(
 179                 |rw| match position {
 180                     MacroPosition::Item => format!("{};", rw),
 181                     _ => rw,
 182                 },
 183             )
 184         }
 185         MacroStyle::Brackets => {
 186             let mac_shape = try_opt!(shape.shrink_left(macro_name.len()));
 187             // Handle special case: `vec![expr; expr]`
 188             if vec_with_semi {
 189                 let (lbr, rbr) = if context.config.spaces_within_square_brackets() {
 190                     ("[ ", " ]")
 191                 } else {
 192                     ("[", "]")
 193                 };
 194                 rewrite_pair(&*expr_vec[0],
 195                              &*expr_vec[1],
 196                              lbr,
 197                              "; ",
 198                              rbr,
 199                              context,
 200                              mac_shape)
 201                     .map(|s| format!("{}{}", macro_name, s))
 202             } else {
 203                 // Format macro invocation as array literal.
 204                 let rewrite =
 205                     try_opt!(rewrite_array(expr_vec.iter().map(|x| &**x),
 206                                            mk_sp(context
 207                                                      .codemap
 208                                                      .span_after(mac.span, original_style.opener()),
 209                                                mac.span.hi - BytePos(1)),
 210                                            context,
 211                                            mac_shape));
 212
 213                 Some(format!("{}{}", macro_name, rewrite))
 214             }
 215         }
 216         MacroStyle::Braces => {
 217             // Skip macro invocations with braces, for now.
 218             None
 219         }
 220     }
 221 }
 222
 223 /// Tries to convert a macro use into a short hand try expression. Returns None
 224 /// when the macro is not an instance of try! (or parsing the inner expression
 225 /// failed).
 226 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
 227     if &format!("{}", mac.node.path)[..] == "try" {
 228         let ts: TokenStream = mac.node.tts.clone().into();
 229         let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 230
 231         Some(ast::Expr {
 232                  id: ast::NodeId::new(0), // dummy value
 233                  node: ast::ExprKind::Try(try_opt!(parser.parse_expr().ok())),
 234                  span: mac.span, // incorrect span, but shouldn't matter too much
 235                  attrs: ThinVec::new(),
 236              })
 237     } else {
 238         None
 239     }
 240 }
 241
 242 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
 243     let snippet = context.snippet(mac.span);
 244     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
 245     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
 246     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
 247
 248     if paren_pos < bracket_pos && paren_pos < brace_pos {
 249         MacroStyle::Parens
 250     } else if bracket_pos < brace_pos {
 251         MacroStyle::Brackets
 252     } else {
 253         MacroStyle::Braces
 254     }
 255 }