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.
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.
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
19 // List-like invocations with parentheses will be formatted as function calls,
20 // and those with brackets will be formatted as array literals.
23 use syntax::codemap::{mk_sp, BytePos};
24 use syntax::parse::token::Token;
25 use syntax::parse::tts_to_parser;
27 use syntax::util::ThinVec;
30 use codemap::SpanUtils;
31 use rewrite::{Rewrite, RewriteContext};
32 use expr::{rewrite_call, rewrite_array, rewrite_pair};
33 use comment::{FindUncommented, contains_comment};
35 const FORCED_BRACKET_MACROS: &'static [&'static str] = &["vec!"];
37 // FIXME: use the enum from libsyntax?
38 #[derive(Clone, Copy, PartialEq, Eq)]
45 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
46 pub enum MacroPosition {
53 fn opener(&self) -> &'static str {
55 MacroStyle::Parens => "(",
56 MacroStyle::Brackets => "[",
57 MacroStyle::Braces => "{",
62 pub fn rewrite_macro(mac: &ast::Mac,
63 extra_ident: Option<ast::Ident>,
64 context: &RewriteContext,
66 position: MacroPosition)
68 let mut context = &mut context.clone();
69 context.inside_macro = true;
70 if context.config.use_try_shorthand() {
71 if let Some(expr) = convert_try_mac(mac, context) {
72 return expr.rewrite(context, shape);
76 let original_style = macro_style(mac, context);
78 let macro_name = match extra_ident {
79 None => format!("{}!", mac.node.path),
81 if ident == symbol::keywords::Invalid.ident() {
82 format!("{}!", mac.node.path)
84 format!("{}! {}", mac.node.path, ident)
89 let style = if FORCED_BRACKET_MACROS.contains(&¯o_name[..]) {
95 if mac.node.tts.is_empty() && !contains_comment(&context.snippet(mac.span)) {
97 MacroStyle::Parens if position == MacroPosition::Item => {
98 Some(format!("{}();", macro_name))
100 MacroStyle::Parens => Some(format!("{}()", macro_name)),
101 MacroStyle::Brackets => Some(format!("{}[]", macro_name)),
102 MacroStyle::Braces => Some(format!("{}{{}}", macro_name)),
106 let mut parser = tts_to_parser(context.parse_session, mac.node.tts.clone());
107 let mut expr_vec = Vec::new();
108 let mut vec_with_semi = false;
110 if MacroStyle::Braces != style {
112 let expr = match parser.parse_expr() {
115 if context.parse_session.span_diagnostic.has_errors() {
116 return Some(context.snippet(mac.span));
123 return Some(context.snippet(mac.span));
133 // Try to parse `vec![expr; expr]`
134 if FORCED_BRACKET_MACROS.contains(&¯o_name[..]) {
136 if parser.token != Token::Eof {
137 match parser.parse_expr() {
139 if context.parse_session.span_diagnostic.has_errors() {
144 if parser.token == Token::Eof && expr_vec.len() == 2 {
145 vec_with_semi = true;
149 Err(mut e) => e.cancel(),
160 if parser.token == Token::Eof {
161 // vec! is a special case of bracket macro which should be formated as an array.
162 if macro_name == "vec!" {
172 MacroStyle::Parens => {
173 // Format macro invocation as function call, forcing no trailing
174 // comma because not all macros support them.
175 rewrite_call(context, ¯o_name, &expr_vec, mac.span, shape).map(
176 |rw| match position {
177 MacroPosition::Item => format!("{};", rw),
182 MacroStyle::Brackets => {
183 let mac_shape = try_opt!(shape.shrink_left(macro_name.len()));
184 // Handle special case: `vec![expr; expr]`
186 let (lbr, rbr) = if context.config.spaces_within_square_brackets() {
191 rewrite_pair(&*expr_vec[0],
198 .map(|s| format!("{}{}", macro_name, s))
200 // Format macro invocation as array literal.
202 try_opt!(rewrite_array(expr_vec.iter().map(|x| &**x),
205 .span_after(mac.span, original_style.opener()),
206 mac.span.hi - BytePos(1)),
210 Some(format!("{}{}", macro_name, rewrite))
213 MacroStyle::Braces => {
214 // Skip macro invocations with braces, for now.
220 /// Tries to convert a macro use into a short hand try expression. Returns None
221 /// when the macro is not an instance of try! (or parsing the inner expression
223 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
224 if &format!("{}", mac.node.path)[..] == "try" {
225 let mut parser = tts_to_parser(context.parse_session, mac.node.tts.clone());
228 id: ast::NodeId::new(0), // dummy value
229 node: ast::ExprKind::Try(try_opt!(parser.parse_expr().ok())),
230 span: mac.span, // incorrect span, but shouldn't matter too much
231 attrs: ThinVec::new(),
238 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
239 let snippet = context.snippet(mac.span);
240 let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
241 let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
242 let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
244 if paren_pos < bracket_pos && paren_pos < brace_pos {
246 } else if bracket_pos < brace_pos {