use std::collections::HashMap;
use config::lists::*;
-use syntax::codemap::{BytePos, Span};
use syntax::parse::new_parser_from_tts;
use syntax::parse::parser::Parser;
use syntax::parse::token::{BinOpToken, DelimToken, Token};
use syntax::print::pprust;
+use syntax::source_map::{BytePos, Span};
use syntax::symbol;
use syntax::tokenstream::{Cursor, ThinTokenStream, TokenStream, TokenTree};
-use syntax::util::ThinVec;
+use syntax::ThinVec;
use syntax::{ast, ptr};
-use codemap::SpanUtils;
use comment::{
contains_comment, remove_trailing_white_spaces, CharClasses, FindUncommented, FullCodeCharKind,
LineClasses,
use overflow;
use rewrite::{Rewrite, RewriteContext};
use shape::{Indent, Shape};
+use source_map::SpanUtils;
use spanned::Spanned;
-use utils::{format_visibility, mk_sp, wrap_str};
+use utils::{format_visibility, mk_sp, rewrite_ident, wrap_str};
+use visitor::FmtVisitor;
const FORCED_BRACKET_MACROS: &[&str] = &["vec!"];
Item(ptr::P<ast::Item>),
}
+impl MacroArg {
+ fn is_item(&self) -> bool {
+ match self {
+ MacroArg::Item(..) => true,
+ _ => false,
+ }
+ }
+}
+
impl Rewrite for ast::Item {
fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
let mut visitor = ::visitor::FmtVisitor::from_context(context);
visitor.block_indent = shape.indent;
visitor.last_pos = self.span().lo();
visitor.visit_item(self);
- Some(visitor.buffer)
+ Some(visitor.buffer.to_owned())
}
}
}
/// Rewrite macro name without using pretty-printer if possible.
-fn rewrite_macro_name(path: &ast::Path, extra_ident: Option<ast::Ident>) -> String {
+fn rewrite_macro_name(
+ context: &RewriteContext,
+ path: &ast::Path,
+ extra_ident: Option<ast::Ident>,
+) -> String {
let name = if path.segments.len() == 1 {
// Avoid using pretty-printer in the common case.
- format!("{}!", path.segments[0].ident)
+ format!("{}!", rewrite_ident(context, path.segments[0].ident))
} else {
format!("{}!", path)
};
}
}
+// Use this on failing to format the macro call.
+fn return_original_snippet_with_failure_marked(
+ context: &RewriteContext,
+ span: Span,
+) -> Option<String> {
+ context.macro_rewrite_failure.replace(true);
+ Some(context.snippet(span).to_owned())
+}
+
+struct InsideMacroGuard<'a> {
+ context: &'a RewriteContext<'a>,
+ is_nested: bool,
+}
+
+impl<'a> InsideMacroGuard<'a> {
+ fn inside_macro_context(context: &'a RewriteContext) -> InsideMacroGuard<'a> {
+ let is_nested = context.inside_macro.replace(true);
+ InsideMacroGuard { context, is_nested }
+ }
+}
+
+impl<'a> Drop for InsideMacroGuard<'a> {
+ fn drop(&mut self) {
+ self.context.inside_macro.replace(self.is_nested);
+ }
+}
+
pub fn rewrite_macro(
mac: &ast::Mac,
extra_ident: Option<ast::Ident>,
shape: Shape,
position: MacroPosition,
) -> Option<String> {
- context.inside_macro.replace(true);
- let result = rewrite_macro_inner(mac, extra_ident, context, shape, position);
- context.inside_macro.replace(false);
+ let guard = InsideMacroGuard::inside_macro_context(context);
+ let result = rewrite_macro_inner(mac, extra_ident, context, shape, position, guard.is_nested);
+ if result.is_none() {
+ context.macro_rewrite_failure.replace(true);
+ }
result
}
context: &RewriteContext,
shape: Shape,
position: MacroPosition,
+ is_nested_macro: bool,
) -> Option<String> {
if context.config.use_try_shorthand() {
if let Some(expr) = convert_try_mac(mac, context) {
let original_style = macro_style(mac, context);
- let macro_name = rewrite_macro_name(&mac.node.path, extra_ident);
+ let macro_name = rewrite_macro_name(context, &mac.node.path, extra_ident);
- let style = if FORCED_BRACKET_MACROS.contains(&¯o_name[..]) {
+ let style = if FORCED_BRACKET_MACROS.contains(&¯o_name[..]) && !is_nested_macro {
DelimToken::Bracket
} else {
original_style
};
}
// Format well-known macros which cannot be parsed as a valid AST.
- // TODO: Maybe add more macros?
if macro_name == "lazy_static!" && !has_comment {
if let success @ Some(..) = format_lazy_static(context, shape, &ts) {
return success;
loop {
match parse_macro_arg(&mut parser) {
Some(arg) => arg_vec.push(arg),
- None => return Some(context.snippet(mac.span).to_owned()),
+ None => return return_original_snippet_with_failure_marked(context, mac.span),
}
match parser.token {
break;
}
}
- None => return Some(context.snippet(mac.span).to_owned()),
+ None => {
+ return return_original_snippet_with_failure_marked(
+ context, mac.span,
+ )
+ }
}
}
}
- return Some(context.snippet(mac.span).to_owned());
+ return return_original_snippet_with_failure_marked(context, mac.span);
}
- _ => return Some(context.snippet(mac.span).to_owned()),
+ _ if arg_vec.last().map_or(false, MacroArg::is_item) => continue,
+ _ => return return_original_snippet_with_failure_marked(context, mac.span),
}
parser.bump();
}
}
+ if !arg_vec.is_empty() && arg_vec.iter().all(MacroArg::is_item) {
+ return rewrite_macro_with_items(
+ context,
+ &arg_vec,
+ ¯o_name,
+ shape,
+ style,
+ position,
+ mac.span,
+ );
+ }
+
match style {
DelimToken::Paren => {
// Format macro invocation as function call, preserve the trailing
overflow::rewrite_with_parens(
context,
¯o_name,
- &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>(),
+ arg_vec.iter(),
shape,
mac.span,
context.config.width_heuristics().fn_call_width,
} else {
Some(SeparatorTactic::Never)
},
- ).map(|rw| match position {
+ )
+ .map(|rw| match position {
MacroPosition::Item => format!("{};", rw),
_ => rw,
})
// Handle special case: `vec![expr; expr]`
if vec_with_semi {
let mac_shape = shape.offset_left(macro_name.len())?;
- let (lbr, rbr) = if context.config.spaces_within_parens_and_brackets() {
- ("[ ", " ]")
- } else {
- ("[", "]")
- };
- // 6 = `vec!` + `; `
- let total_overhead = lbr.len() + rbr.len() + 6;
+ // 8 = `vec![]` + `; `
+ let total_overhead = 8;
let nested_shape = mac_shape.block_indent(context.config.tab_spaces());
let lhs = arg_vec[0].rewrite(context, nested_shape)?;
let rhs = arg_vec[1].rewrite(context, nested_shape)?;
&& !rhs.contains('\n')
&& lhs.len() + rhs.len() + total_overhead <= shape.width
{
- Some(format!("{}{}{}; {}{}", macro_name, lbr, lhs, rhs, rbr))
+ Some(format!("{}[{}; {}]", macro_name, lhs, rhs))
} else {
Some(format!(
- "{}{}{}{};{}{}{}{}",
+ "{}[{}{};{}{}{}]",
macro_name,
- lbr,
nested_shape.indent.to_string_with_newline(context.config),
lhs,
nested_shape.indent.to_string_with_newline(context.config),
rhs,
shape.indent.to_string_with_newline(context.config),
- rbr
))
}
} else {
} else {
Some(SeparatorTactic::Never)
};
- if FORCED_BRACKET_MACROS.contains(macro_name) {
+ if FORCED_BRACKET_MACROS.contains(macro_name) && !is_nested_macro {
context.inside_macro.replace(false);
if context.use_block_indent() {
force_trailing_comma = Some(SeparatorTactic::Vertical);
};
}
- // Convert `MacroArg` into `ast::Expr`, as `rewrite_array` only accepts the latter.
- let arg_vec = &arg_vec.iter().map(|e| &*e).collect::<Vec<_>>();
let rewrite = rewrite_array(
macro_name,
- arg_vec,
+ arg_vec.iter(),
mac.span,
context,
shape,
let mut result = if def.legacy {
String::from("macro_rules!")
} else {
- format!("{}macro", format_visibility(vis))
+ format!("{}macro", format_visibility(context, vis))
};
result += " ";
- result += &ident.name.as_str();
+ result += rewrite_ident(context, ident);
let multi_branch_style = def.legacy || parsed_def.branches.len() != 1;
";",
|branch| branch.span.lo(),
|branch| branch.span.hi(),
- |branch| branch.rewrite(context, arm_shape, multi_branch_style),
+ |branch| match branch.rewrite(context, arm_shape, multi_branch_style) {
+ Some(v) => Some(v),
+ // if the rewrite returned None because a macro could not be rewritten, then return the
+ // original body
+ None if *context.macro_rewrite_failure.borrow() == true => {
+ Some(context.snippet(branch.body).trim().to_string())
+ }
+ None => None,
+ },
context.snippet_provider.span_after(span, "{"),
span.hi(),
false,
- ).collect::<Vec<_>>();
-
- let fmt = ListFormatting {
- tactic: DefinitiveListTactic::Vertical,
- separator: if def.legacy { ";" } else { "" },
- trailing_separator: SeparatorTactic::Always,
- separator_place: SeparatorPlace::Back,
- shape: arm_shape,
- ends_with_newline: true,
- preserve_newline: true,
- config: context.config,
- };
+ )
+ .collect::<Vec<_>>();
+
+ let fmt = ListFormatting::new(arm_shape, context.config)
+ .separator(if def.legacy { ";" } else { "" })
+ .trailing_separator(SeparatorTactic::Always)
+ .preserve_newline(true);
if multi_branch_style {
result += " {";
result += &arm_shape.indent.to_string_with_newline(context.config);
}
- result += write_list(&branch_items, &fmt)?.as_str();
+ match write_list(&branch_items, &fmt) {
+ Some(ref s) => result += s,
+ None => return snippet,
+ }
if multi_branch_style {
result += &indent.to_string_with_newline(context.config);
fn delim_token_to_str(
context: &RewriteContext,
- delim_token: &DelimToken,
+ delim_token: DelimToken,
shape: Shape,
use_multiple_lines: bool,
+ inner_is_empty: bool,
) -> (String, String) {
- let (lhs, rhs) = match *delim_token {
+ let (lhs, rhs) = match delim_token {
DelimToken::Paren => ("(", ")"),
DelimToken::Bracket => ("[", "]"),
- DelimToken::Brace => ("{ ", " }"),
+ DelimToken::Brace => {
+ if inner_is_empty || use_multiple_lines {
+ ("{", "}")
+ } else {
+ ("{ ", " }")
+ }
+ }
DelimToken::NoDelim => ("", ""),
};
if use_multiple_lines {
use_multiple_lines: bool,
) -> Option<String> {
let rewrite_delimited_inner = |delim_tok, args| -> Option<(String, String, String)> {
- let (lhs, rhs) = delim_token_to_str(context, delim_tok, shape, false);
let inner = wrap_macro_args(context, args, shape)?;
+ let (lhs, rhs) = delim_token_to_str(context, delim_tok, shape, false, inner.is_empty());
if lhs.len() + inner.len() + rhs.len() <= shape.width {
return Some((lhs, inner, rhs));
}
- let (lhs, rhs) = delim_token_to_str(context, delim_tok, shape, true);
+ let (lhs, rhs) = delim_token_to_str(context, delim_tok, shape, true, false);
let nested_shape = shape
.block_indent(context.config.tab_spaces())
.with_max_width(context.config);
MacroArgKind::MetaVariable(ty, ref name) => {
Some(format!("${}:{}", name, ty.name.as_str()))
}
- MacroArgKind::Repeat(ref delim_tok, ref args, ref another, ref tok) => {
+ MacroArgKind::Repeat(delim_tok, ref args, ref another, ref tok) => {
let (lhs, inner, rhs) = rewrite_delimited_inner(delim_tok, args)?;
let another = another
.as_ref()
Some(format!("${}{}{}{}{}", lhs, inner, rhs, another, repeat_tok))
}
- MacroArgKind::Delimited(ref delim_tok, ref args) => {
+ MacroArgKind::Delimited(delim_tok, ref args) => {
rewrite_delimited_inner(delim_tok, args)
.map(|(lhs, inner, rhs)| format!("{}{}{}", lhs, inner, rhs))
}
let mut hi = span.hi();
// Parse '*', '+' or '?.
- for ref tok in iter {
- self.set_last_tok(tok);
+ for tok in iter {
+ self.set_last_tok(&tok);
if first {
first = false;
lo = tok.span().lo();
self.add_meta_variable(&mut iter)?;
}
TokenTree::Token(sp, ref t) => self.update_buffer(sp.lo(), t),
- TokenTree::Delimited(sp, delimited) => {
+ TokenTree::Delimited(delimited_span, delimited) => {
if !self.buf.is_empty() {
if next_space(&self.last_tok) == SpaceState::Always {
self.add_separator();
// Parse the stuff inside delimiters.
let mut parser = MacroArgParser::new();
- parser.lo = sp.lo();
+ parser.lo = delimited_span.open.lo();
let delimited_arg = parser.parse(delimited.tts.clone())?;
+ let span = delimited_span.entire();
if self.is_meta_var {
- self.add_repeat(delimited_arg, delimited.delim, &mut iter, *sp)?;
+ self.add_repeat(delimited_arg, delimited.delim, &mut iter, span)?;
+ self.is_meta_var = false;
} else {
- self.add_delimited(delimited_arg, delimited.delim, *sp);
+ self.add_delimited(delimited_arg, delimited.delim, span);
}
}
}
toks: ThinTokenStream,
shape: Shape,
) -> Option<String> {
+ if !context.config.format_macro_matchers() {
+ let token_stream: TokenStream = toks.into();
+ let span = span_for_token_stream(token_stream);
+ return Some(match span {
+ Some(span) => context.snippet(span).to_owned(),
+ None => String::new(),
+ });
+ }
let parsed_args = MacroArgParser::new().parse(toks)?;
wrap_macro_args(context, &parsed_args, shape)
}
+fn span_for_token_stream(token_stream: TokenStream) -> Option<Span> {
+ token_stream.trees().next().map(|tt| tt.span())
+}
+
// We should insert a space if the next token is a:
#[derive(Copy, Clone, PartialEq)]
enum SpaceState {
fn force_space_before(tok: &Token) -> bool {
debug!("tok: force_space_before {:?}", tok);
- match *tok {
+ match tok {
Token::Eq
| Token::Lt
| Token::Le
}
fn ident_like(tok: &Token) -> bool {
- match *tok {
+ match tok {
Token::Ident(..) | Token::Literal(..) | Token::Lifetime(_) => true,
_ => false,
}
fn next_space(tok: &Token) -> SpaceState {
debug!("next_space: {:?}", tok);
- match *tok {
+ match tok {
Token::Not
| Token::BinOp(BinOpToken::And)
| Token::Tilde
} else {
Some(get_prefix_space_width(context, &line))
};
+
let line = if veto_trim || (kind.is_string() && !line.ends_with('\\')) {
veto_trim = kind.is_string() && !line.ends_with('\\');
trimmed = false;
line.trim().to_owned()
};
trimmed_lines.push((trimmed, line, prefix_space_width));
- prefix_space_width
+
+ // when computing the minimum, do not consider lines within a string
+ match kind {
+ FullCodeCharKind::InString | FullCodeCharKind::EndString => None,
+ _ => prefix_space_width,
+ }
})
.min()?;
Some(
- first_line + "\n"
+ first_line
+ + "\n"
+ &trimmed_lines
.iter()
.map(
_ if !trimmed => line.to_owned(),
Some(original_indent_width) => {
let new_indent_width = indent.width()
- + original_indent_width
- .checked_sub(min_prefix_space_width)
- .unwrap_or(0);
+ + original_indent_width.saturating_sub(min_prefix_space_width);
let new_indent = Indent::from_width(context.config, new_indent_width);
- format!("{}{}", new_indent.to_string(context.config), line.trim())
+ format!("{}{}", new_indent.to_string(context.config), line)
}
None => String::new(),
},
let tok = self.toks.next()?;
let (lo, args_paren_kind) = match tok {
TokenTree::Token(..) => return None,
- TokenTree::Delimited(sp, ref d) => (sp.lo(), d.delim),
+ TokenTree::Delimited(delimited_span, ref d) => (delimited_span.open.lo(), d.delim),
};
let args = tok.joint().into();
match self.toks.next()? {
TokenTree::Token(_, Token::FatArrow) => {}
_ => return None,
}
- let (mut hi, body) = match self.toks.next()? {
+ let (mut hi, body, whole_body) = match self.toks.next()? {
TokenTree::Token(..) => return None,
- TokenTree::Delimited(sp, _) => {
- let data = sp.data();
+ TokenTree::Delimited(delimited_span, _) => {
+ let data = delimited_span.entire().data();
(
data.hi,
Span::new(data.lo + BytePos(1), data.hi - BytePos(1), data.ctxt),
+ delimited_span.entire(),
)
}
};
args_paren_kind,
args,
body,
+ whole_body,
})
}
}
args_paren_kind: DelimToken,
args: ThinTokenStream,
body: Span,
+ whole_body: Span,
}
impl MacroBranch {
result += " =>";
}
+ if !context.config.format_macro_bodies() {
+ result += " ";
+ result += context.snippet(self.whole_body);
+ return Some(result);
+ }
+
// The macro body is the most interesting part. It might end up as various
// AST nodes, but also has special variables (e.g, `$foo`) which can't be
// parsed as regular Rust code (and note that these can be escaped using
let old_body = context.snippet(self.body).trim();
let (body_str, substs) = replace_names(old_body)?;
+ let has_block_body = old_body.starts_with('{');
let mut config = context.config.clone();
config.set().hide_parse_errors(true);
result += " {";
- let has_block_body = old_body.starts_with('{');
-
let body_indent = if has_block_body {
shape.indent
} else {
- // We'll hack the indent below, take this into account when formatting,
- let body_indent = shape.indent.block_indent(&config);
- let new_width = config.max_width() - body_indent.width();
- config.set().max_width(new_width);
- body_indent
+ shape.indent.block_indent(&config)
};
+ let new_width = config.max_width() - body_indent.width();
+ config.set().max_width(new_width);
// First try to format as items, then as statements.
let new_body = match ::format_snippet(&body_str, &config) {
Some(new_body) => new_body,
- None => match ::format_code_block(&body_str, &config) {
- Some(new_body) => new_body,
- None => return None,
- },
+ None => {
+ let new_width = new_width + config.tab_spaces();
+ config.set().max_width(new_width);
+ match ::format_code_block(&body_str, &config) {
+ Some(new_body) => new_body,
+ None => return None,
+ }
+ }
};
let new_body = wrap_str(new_body, config.max_width(), shape)?;
fn format_lazy_static(context: &RewriteContext, shape: Shape, ts: &TokenStream) -> Option<String> {
let mut result = String::with_capacity(1024);
let mut parser = new_parser_from_tts(context.parse_session, ts.trees().collect());
- let nested_shape = shape.block_indent(context.config.tab_spaces());
+ let nested_shape = shape
+ .block_indent(context.config.tab_spaces())
+ .with_max_width(context.config);
result.push_str("lazy_static! {");
result.push_str(&nested_shape.indent.to_string_with_newline(context.config));
while parser.token != Token::Eof {
// Parse a `lazy_static!` item.
- let vis = ::utils::format_visibility(&parse_or!(parse_visibility, false));
+ let vis = ::utils::format_visibility(context, &parse_or!(parse_visibility, false));
parser.eat_keyword(symbol::keywords::Static);
parser.eat_keyword(symbol::keywords::Ref);
let id = parse_or!(parse_ident);
Some(result)
}
+
+fn rewrite_macro_with_items(
+ context: &RewriteContext,
+ items: &[MacroArg],
+ macro_name: &str,
+ shape: Shape,
+ style: DelimToken,
+ position: MacroPosition,
+ span: Span,
+) -> Option<String> {
+ let (opener, closer) = match style {
+ DelimToken::Paren => ("(", ")"),
+ DelimToken::Bracket => ("[", "]"),
+ DelimToken::Brace => (" {", "}"),
+ _ => return None,
+ };
+ let trailing_semicolon = match style {
+ DelimToken::Paren | DelimToken::Bracket if position == MacroPosition::Item => ";",
+ _ => "",
+ };
+
+ let mut visitor = FmtVisitor::from_context(context);
+ visitor.block_indent = shape.indent.block_indent(context.config);
+ visitor.last_pos = context.snippet_provider.span_after(span, opener.trim());
+ for item in items {
+ let item = match item {
+ MacroArg::Item(item) => item,
+ _ => return None,
+ };
+ visitor.visit_item(&item);
+ }
+
+ let mut result = String::with_capacity(256);
+ result.push_str(¯o_name);
+ result.push_str(opener);
+ result.push_str(&visitor.block_indent.to_string_with_newline(context.config));
+ result.push_str(visitor.buffer.trim());
+ result.push_str(&shape.indent.to_string_with_newline(context.config));
+ result.push_str(closer);
+ result.push_str(trailing_semicolon);
+ return Some(result);
+}
projects / rust.git / blobdiff