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 syntax::ast;
  23 use syntax::codemap::BytePos;
  24 use syntax::parse::new_parser_from_tts;
  25 use syntax::parse::parser::Parser;
  26 use syntax::parse::token::Token;
  27 use syntax::symbol;
  28 use syntax::tokenstream::TokenStream;
  29 use syntax::util::ThinVec;
  30
  31 use codemap::SpanUtils;
  32 use comment::{contains_comment, FindUncommented};
  33 use expr::{rewrite_array, rewrite_call_inner};
  34 use rewrite::{Rewrite, RewriteContext};
  35 use shape::{Indent, Shape};
  36 use utils::mk_sp;
  37
  38 const FORCED_BRACKET_MACROS: &[&str] = &["vec!"];
  39
  40 // FIXME: use the enum from libsyntax?
  41 #[derive(Clone, Copy, PartialEq, Eq)]
  42 enum MacroStyle {
  43     Parens,
  44     Brackets,
  45     Braces,
  46 }
  47
  48 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
  49 pub enum MacroPosition {
  50     Item,
  51     Statement,
  52     Expression,
  53 }
  54
  55 impl MacroStyle {
  56     fn opener(&self) -> &'static str {
  57         match *self {
  58             MacroStyle::Parens => "(",
  59             MacroStyle::Brackets => "[",
  60             MacroStyle::Braces => "{",
  61         }
  62     }
  63 }
  64
  65 pub enum MacroArg {
  66     Expr(ast::Expr),
  67     Ty(ast::Ty),
  68     Pat(ast::Pat),
  69 }
  70
  71 impl Rewrite for MacroArg {
  72     fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
  73         match *self {
  74             MacroArg::Expr(ref expr) => expr.rewrite(context, shape),
  75             MacroArg::Ty(ref ty) => ty.rewrite(context, shape),
  76             MacroArg::Pat(ref pat) => pat.rewrite(context, shape),
  77         }
  78     }
  79 }
  80
  81 fn parse_macro_arg(parser: &mut Parser) -> Option<MacroArg> {
  82     macro_rules! parse_macro_arg {
  83         ($target:tt, $macro_arg:ident, $parser:ident) => {
  84             let mut cloned_parser = (*parser).clone();
  85             match cloned_parser.$parser() {
  86                 Ok($target) => {
  87                     if parser.sess.span_diagnostic.has_errors() {
  88                         parser.sess.span_diagnostic.reset_err_count();
  89                     } else {
  90                         // Parsing succeeded.
  91                         *parser = cloned_parser;
  92                         return Some(MacroArg::$macro_arg((*$target).clone()));
  93                     }
  94                 }
  95                 Err(mut e) => {
  96                     e.cancel();
  97                     parser.sess.span_diagnostic.reset_err_count();
  98                 }
  99             }
 100         }
 101     }
 102
 103     parse_macro_arg!(expr, Expr, parse_expr);
 104     parse_macro_arg!(ty, Ty, parse_ty);
 105     parse_macro_arg!(pat, Pat, parse_pat);
 106
 107     None
 108 }
 109
 110 pub fn rewrite_macro(
 111     mac: &ast::Mac,
 112     extra_ident: Option<ast::Ident>,
 113     context: &RewriteContext,
 114     shape: Shape,
 115     position: MacroPosition,
 116 ) -> Option<String> {
 117     let context = &mut context.clone();
 118     context.inside_macro = true;
 119     if context.config.use_try_shorthand() {
 120         if let Some(expr) = convert_try_mac(mac, context) {
 121             return expr.rewrite(context, shape);
 122         }
 123     }
 124
 125     let original_style = macro_style(mac, context);
 126
 127     let macro_name = match extra_ident {
 128         None => format!("{}!", mac.node.path),
 129         Some(ident) => {
 130             if ident == symbol::keywords::Invalid.ident() {
 131                 format!("{}!", mac.node.path)
 132             } else {
 133                 format!("{}! {}", mac.node.path, ident)
 134             }
 135         }
 136     };
 137
 138     let style = if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
 139         MacroStyle::Brackets
 140     } else {
 141         original_style
 142     };
 143
 144     let ts: TokenStream = mac.node.stream();
 145     if ts.is_empty() && !contains_comment(&context.snippet(mac.span)) {
 146         return match style {
 147             MacroStyle::Parens if position == MacroPosition::Item => {
 148                 Some(format!("{}();", macro_name))
 149             }
 150             MacroStyle::Parens => Some(format!("{}()", macro_name)),
 151             MacroStyle::Brackets => Some(format!("{}[]", macro_name)),
 152             MacroStyle::Braces => Some(format!("{}{{}}", macro_name)),
 153         };
 154     }
 155
 156     let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 157     let mut arg_vec = Vec::new();
 158     let mut vec_with_semi = false;
 159     let mut trailing_comma = false;
 160
 161     if MacroStyle::Braces != style {
 162         loop {
 163             match parse_macro_arg(&mut parser) {
 164                 Some(arg) => arg_vec.push(arg),
 165                 None => return Some(context.snippet(mac.span)),
 166             }
 167
 168             match parser.token {
 169                 Token::Eof => break,
 170                 Token::Comma => (),
 171                 Token::Semi => {
 172                     // Try to parse `vec![expr; expr]`
 173                     if FORCED_BRACKET_MACROS.contains(&&macro_name[..]) {
 174                         parser.bump();
 175                         if parser.token != Token::Eof {
 176                             match parse_macro_arg(&mut parser) {
 177                                 Some(arg) => {
 178                                     arg_vec.push(arg);
 179                                     parser.bump();
 180                                     if parser.token == Token::Eof && arg_vec.len() == 2 {
 181                                         vec_with_semi = true;
 182                                         break;
 183                                     }
 184                                 }
 185                                 None => return Some(context.snippet(mac.span)),
 186                             }
 187                         }
 188                     }
 189                     return Some(context.snippet(mac.span));
 190                 }
 191                 _ => return Some(context.snippet(mac.span)),
 192             }
 193
 194             parser.bump();
 195
 196             if parser.token == Token::Eof {
 197                 trailing_comma = true;
 198                 break;
 199             }
 200         }
 201     }
 202
 203     match style {
 204         MacroStyle::Parens => {
 205             // Format macro invocation as function call, forcing no trailing
 206             // comma because not all macros support them.
 207             rewrite_call_inner(
 208                 context,
 209                 &macro_name,
 210                 &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>()[..],
 211                 mac.span,
 212                 shape,
 213                 context.config.width_heuristics().fn_call_width,
 214                 trailing_comma,
 215             ).map(|rw| match position {
 216                 MacroPosition::Item => format!("{};", rw),
 217                 _ => rw,
 218             })
 219         }
 220         MacroStyle::Brackets => {
 221             let mac_shape = shape.offset_left(macro_name.len())?;
 222             // Handle special case: `vec![expr; expr]`
 223             if vec_with_semi {
 224                 let (lbr, rbr) = if context.config.spaces_within_parens_and_brackets() {
 225                     ("[ ", " ]")
 226                 } else {
 227                     ("[", "]")
 228                 };
 229                 // 6 = `vec!` + `; `
 230                 let total_overhead = lbr.len() + rbr.len() + 6;
 231                 let nested_shape = mac_shape.block_indent(context.config.tab_spaces());
 232                 let lhs = arg_vec[0].rewrite(context, nested_shape)?;
 233                 let rhs = arg_vec[1].rewrite(context, nested_shape)?;
 234                 if !lhs.contains('\n') && !rhs.contains('\n')
 235                     && lhs.len() + rhs.len() + total_overhead <= shape.width
 236                 {
 237                     Some(format!("{}{}{}; {}{}", macro_name, lbr, lhs, rhs, rbr))
 238                 } else {
 239                     Some(format!(
 240                         "{}{}\n{}{};\n{}{}\n{}{}",
 241                         macro_name,
 242                         lbr,
 243                         nested_shape.indent.to_string(context.config),
 244                         lhs,
 245                         nested_shape.indent.to_string(context.config),
 246                         rhs,
 247                         shape.indent.to_string(context.config),
 248                         rbr
 249                     ))
 250                 }
 251             } else {
 252                 // If we are rewriting `vec!` macro or other special macros,
 253                 // then we can rewrite this as an usual array literal.
 254                 // Otherwise, we must preserve the original existence of trailing comma.
 255                 if FORCED_BRACKET_MACROS.contains(&macro_name.as_str()) {
 256                     context.inside_macro = false;
 257                     trailing_comma = false;
 258                 }
 259                 // Convert `MacroArg` into `ast::Expr`, as `rewrite_array` only accepts the latter.
 260                 let expr_vec: Vec<_> = arg_vec
 261                     .iter()
 262                     .filter_map(|e| match *e {
 263                         MacroArg::Expr(ref e) => Some(e.clone()),
 264                         _ => None,
 265                     })
 266                     .collect();
 267                 if expr_vec.len() != arg_vec.len() {
 268                     return Some(context.snippet(mac.span));
 269                 }
 270                 let sp = mk_sp(
 271                     context
 272                         .codemap
 273                         .span_after(mac.span, original_style.opener()),
 274                     mac.span.hi() - BytePos(1),
 275                 );
 276                 let rewrite =
 277                     rewrite_array(expr_vec.iter(), sp, context, mac_shape, trailing_comma)?;
 278
 279                 Some(format!("{}{}", macro_name, rewrite))
 280             }
 281         }
 282         MacroStyle::Braces => {
 283             // Skip macro invocations with braces, for now.
 284             indent_macro_snippet(context, &context.snippet(mac.span), shape.indent)
 285         }
 286     }
 287 }
 288
 289 /// Tries to convert a macro use into a short hand try expression. Returns None
 290 /// when the macro is not an instance of try! (or parsing the inner expression
 291 /// failed).
 292 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
 293     if &format!("{}", mac.node.path)[..] == "try" {
 294         let ts: TokenStream = mac.node.tts.clone().into();
 295         let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
 296
 297         Some(ast::Expr {
 298             id: ast::NodeId::new(0), // dummy value
 299             node: ast::ExprKind::Try(parser.parse_expr().ok()?),
 300             span: mac.span, // incorrect span, but shouldn't matter too much
 301             attrs: ThinVec::new(),
 302         })
 303     } else {
 304         None
 305     }
 306 }
 307
 308 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
 309     let snippet = context.snippet(mac.span);
 310     let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
 311     let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
 312     let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
 313
 314     if paren_pos < bracket_pos && paren_pos < brace_pos {
 315         MacroStyle::Parens
 316     } else if bracket_pos < brace_pos {
 317         MacroStyle::Brackets
 318     } else {
 319         MacroStyle::Braces
 320     }
 321 }
 322
 323 /// Indent each line according to the specified `indent`.
 324 /// e.g.
 325 /// ```rust
 326 /// foo!{
 327 /// x,
 328 /// y,
 329 /// foo(
 330 ///     a,
 331 ///     b,
 332 ///     c,
 333 /// ),
 334 /// }
 335 /// ```
 336 /// will become
 337 /// ```rust
 338 /// foo!{
 339 ///     x,
 340 ///     y,
 341 ///     foo(
 342 ///         a,
 343 ///         b,
 344 ///         c,
 345 //      ),
 346 /// }
 347 /// ```
 348 fn indent_macro_snippet(
 349     context: &RewriteContext,
 350     macro_str: &str,
 351     indent: Indent,
 352 ) -> Option<String> {
 353     let mut lines = macro_str.lines();
 354     let first_line = lines.next().map(|s| s.trim_right())?;
 355     let mut trimmed_lines = Vec::with_capacity(16);
 356
 357     let min_prefix_space_width = lines
 358         .filter_map(|line| {
 359             let prefix_space_width = if is_empty_line(line) {
 360                 None
 361             } else {
 362                 Some(get_prefix_space_width(context, line))
 363             };
 364             trimmed_lines.push((line.trim(), prefix_space_width));
 365             prefix_space_width
 366         })
 367         .min()?;
 368
 369     Some(
 370         String::from(first_line) + "\n"
 371             + &trimmed_lines
 372                 .iter()
 373                 .map(|&(line, prefix_space_width)| match prefix_space_width {
 374                     Some(original_indent_width) => {
 375                         let new_indent_width = indent.width()
 376                             + original_indent_width
 377                                 .checked_sub(min_prefix_space_width)
 378                                 .unwrap_or(0);
 379                         let new_indent = Indent::from_width(context.config, new_indent_width);
 380                         format!("{}{}", new_indent.to_string(context.config), line.trim())
 381                     }
 382                     None => String::new(),
 383                 })
 384                 .collect::<Vec<_>>()
 385                 .join("\n"),
 386     )
 387 }
 388
 389 fn get_prefix_space_width(context: &RewriteContext, s: &str) -> usize {
 390     let mut width = 0;
 391     for c in s.chars() {
 392         match c {
 393             ' ' => width += 1,
 394             '\t' => width += context.config.tab_spaces(),
 395             _ => return width,
 396         }
 397     }
 398     width
 399 }
 400
 401 fn is_empty_line(s: &str) -> bool {
 402     s.is_empty() || s.chars().all(char::is_whitespace)
 403 }