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::BytePos;
24 use syntax::parse::new_parser_from_tts;
25 use syntax::parse::parser::Parser;
26 use syntax::parse::token::Token;
28 use syntax::tokenstream::TokenStream;
29 use syntax::util::ThinVec;
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};
38 const FORCED_BRACKET_MACROS: &[&str] = &["vec!"];
40 // FIXME: use the enum from libsyntax?
41 #[derive(Clone, Copy, PartialEq, Eq)]
48 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
49 pub enum MacroPosition {
57 fn opener(&self) -> &'static str {
59 MacroStyle::Parens => "(",
60 MacroStyle::Brackets => "[",
61 MacroStyle::Braces => "{",
72 impl Rewrite for MacroArg {
73 fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
75 MacroArg::Expr(ref expr) => expr.rewrite(context, shape),
76 MacroArg::Ty(ref ty) => ty.rewrite(context, shape),
77 MacroArg::Pat(ref pat) => pat.rewrite(context, shape),
82 fn parse_macro_arg(parser: &mut Parser) -> Option<MacroArg> {
83 macro_rules! parse_macro_arg {
84 ($target:tt, $macro_arg:ident, $parser:ident) => {
85 let mut cloned_parser = (*parser).clone();
86 match cloned_parser.$parser() {
88 if parser.sess.span_diagnostic.has_errors() {
89 parser.sess.span_diagnostic.reset_err_count();
92 *parser = cloned_parser;
93 return Some(MacroArg::$macro_arg((*$target).clone()));
98 parser.sess.span_diagnostic.reset_err_count();
104 parse_macro_arg!(expr, Expr, parse_expr);
105 parse_macro_arg!(ty, Ty, parse_ty);
106 parse_macro_arg!(pat, Pat, parse_pat);
111 pub fn rewrite_macro(
113 extra_ident: Option<ast::Ident>,
114 context: &RewriteContext,
116 position: MacroPosition,
117 ) -> Option<String> {
118 let context = &mut context.clone();
119 context.inside_macro = true;
120 if context.config.use_try_shorthand() {
121 if let Some(expr) = convert_try_mac(mac, context) {
122 context.inside_macro = false;
123 return expr.rewrite(context, shape);
127 let original_style = macro_style(mac, context);
129 let macro_name = match extra_ident {
130 None => format!("{}!", mac.node.path),
132 if ident == symbol::keywords::Invalid.ident() {
133 format!("{}!", mac.node.path)
135 format!("{}! {}", mac.node.path, ident)
140 let style = if FORCED_BRACKET_MACROS.contains(&¯o_name[..]) {
146 let ts: TokenStream = mac.node.stream();
147 if ts.is_empty() && !contains_comment(&context.snippet(mac.span)) {
149 MacroStyle::Parens if position == MacroPosition::Item => {
150 Some(format!("{}();", macro_name))
152 MacroStyle::Parens => Some(format!("{}()", macro_name)),
153 MacroStyle::Brackets => Some(format!("{}[]", macro_name)),
154 MacroStyle::Braces => Some(format!("{}{{}}", macro_name)),
158 let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
159 let mut arg_vec = Vec::new();
160 let mut vec_with_semi = false;
161 let mut trailing_comma = false;
163 if MacroStyle::Braces != style {
165 match parse_macro_arg(&mut parser) {
166 Some(arg) => arg_vec.push(arg),
167 None => return Some(context.snippet(mac.span).to_owned()),
174 // Try to parse `vec![expr; expr]`
175 if FORCED_BRACKET_MACROS.contains(&¯o_name[..]) {
177 if parser.token != Token::Eof {
178 match parse_macro_arg(&mut parser) {
182 if parser.token == Token::Eof && arg_vec.len() == 2 {
183 vec_with_semi = true;
187 None => return Some(context.snippet(mac.span).to_owned()),
191 return Some(context.snippet(mac.span).to_owned());
193 _ => return Some(context.snippet(mac.span).to_owned()),
198 if parser.token == Token::Eof {
199 trailing_comma = true;
206 MacroStyle::Parens => {
207 // Format macro invocation as function call, forcing no trailing
208 // comma because not all macros support them.
212 &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>()[..],
215 context.config.width_heuristics().fn_call_width,
217 ).map(|rw| match position {
218 MacroPosition::Item => format!("{};", rw),
222 MacroStyle::Brackets => {
223 let mac_shape = shape.offset_left(macro_name.len())?;
224 // Handle special case: `vec![expr; expr]`
226 let (lbr, rbr) = if context.config.spaces_within_parens_and_brackets() {
232 let total_overhead = lbr.len() + rbr.len() + 6;
233 let nested_shape = mac_shape.block_indent(context.config.tab_spaces());
234 let lhs = arg_vec[0].rewrite(context, nested_shape)?;
235 let rhs = arg_vec[1].rewrite(context, nested_shape)?;
236 if !lhs.contains('\n') && !rhs.contains('\n')
237 && lhs.len() + rhs.len() + total_overhead <= shape.width
239 Some(format!("{}{}{}; {}{}", macro_name, lbr, lhs, rhs, rbr))
242 "{}{}\n{}{};\n{}{}\n{}{}",
245 nested_shape.indent.to_string(context.config),
247 nested_shape.indent.to_string(context.config),
249 shape.indent.to_string(context.config),
254 // If we are rewriting `vec!` macro or other special macros,
255 // then we can rewrite this as an usual array literal.
256 // Otherwise, we must preserve the original existence of trailing comma.
257 if FORCED_BRACKET_MACROS.contains(¯o_name.as_str()) {
258 context.inside_macro = false;
259 trailing_comma = false;
261 // Convert `MacroArg` into `ast::Expr`, as `rewrite_array` only accepts the latter.
265 .span_after(mac.span, original_style.opener()),
266 mac.span.hi() - BytePos(1),
268 let arg_vec = &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>()[..];
269 let rewrite = rewrite_array(arg_vec, sp, context, mac_shape, trailing_comma)?;
271 Some(format!("{}{}", macro_name, rewrite))
274 MacroStyle::Braces => {
275 // Skip macro invocations with braces, for now.
276 indent_macro_snippet(context, context.snippet(mac.span), shape.indent)
281 /// Tries to convert a macro use into a short hand try expression. Returns None
282 /// when the macro is not an instance of try! (or parsing the inner expression
284 pub fn convert_try_mac(mac: &ast::Mac, context: &RewriteContext) -> Option<ast::Expr> {
285 if &format!("{}", mac.node.path)[..] == "try" {
286 let ts: TokenStream = mac.node.tts.clone().into();
287 let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
290 id: ast::NodeId::new(0), // dummy value
291 node: ast::ExprKind::Try(parser.parse_expr().ok()?),
292 span: mac.span, // incorrect span, but shouldn't matter too much
293 attrs: ThinVec::new(),
300 fn macro_style(mac: &ast::Mac, context: &RewriteContext) -> MacroStyle {
301 let snippet = context.snippet(mac.span);
302 let paren_pos = snippet.find_uncommented("(").unwrap_or(usize::max_value());
303 let bracket_pos = snippet.find_uncommented("[").unwrap_or(usize::max_value());
304 let brace_pos = snippet.find_uncommented("{").unwrap_or(usize::max_value());
306 if paren_pos < bracket_pos && paren_pos < brace_pos {
308 } else if bracket_pos < brace_pos {
315 /// Indent each line according to the specified `indent`.
340 fn indent_macro_snippet(
341 context: &RewriteContext,
344 ) -> Option<String> {
345 let mut lines = macro_str.lines();
346 let first_line = lines.next().map(|s| s.trim_right())?;
347 let mut trimmed_lines = Vec::with_capacity(16);
349 let min_prefix_space_width = lines
351 let prefix_space_width = if is_empty_line(line) {
354 Some(get_prefix_space_width(context, line))
356 trimmed_lines.push((line.trim(), prefix_space_width));
362 String::from(first_line) + "\n"
365 .map(|&(line, prefix_space_width)| match prefix_space_width {
366 Some(original_indent_width) => {
367 let new_indent_width = indent.width()
368 + original_indent_width
369 .checked_sub(min_prefix_space_width)
371 let new_indent = Indent::from_width(context.config, new_indent_width);
372 format!("{}{}", new_indent.to_string(context.config), line.trim())
374 None => String::new(),
381 fn get_prefix_space_width(context: &RewriteContext, s: &str) -> usize {
386 '\t' => width += context.config.tab_spaces(),
393 fn is_empty_line(s: &str) -> bool {
394 s.is_empty() || s.chars().all(char::is_whitespace)