-use std::cell::RefCell;
+use std::cell::{Cell, RefCell};
use std::rc::Rc;
-use syntax::parse::ParseSess;
-use syntax::source_map::{self, BytePos, Pos, SourceMap, Span};
-use syntax::{ast, visit};
+use rustc_ast::{ast, attr::HasAttrs, token::DelimToken, visit};
+use rustc_span::{symbol, BytePos, Pos, Span, DUMMY_SP};
use crate::attr::*;
-use crate::comment::{rewrite_comment, CodeCharKind, CommentCodeSlices};
+use crate::comment::{contains_comment, rewrite_comment, CodeCharKind, CommentCodeSlices};
+use crate::config::Version;
use crate::config::{BraceStyle, Config};
use crate::coverage::transform_missing_snippet;
use crate::items::{
format_impl, format_trait, format_trait_alias, is_mod_decl, is_use_item,
- rewrite_associated_impl_type, rewrite_associated_type, rewrite_existential_impl_type,
- rewrite_existential_type, rewrite_extern_crate, rewrite_type_alias, FnBraceStyle, FnSig,
- StaticParts, StructParts,
+ rewrite_associated_impl_type, rewrite_extern_crate, rewrite_opaque_impl_type,
+ rewrite_opaque_type, rewrite_type_alias, FnBraceStyle, FnSig, StaticParts, StructParts,
};
-use crate::macros::{rewrite_macro, rewrite_macro_def, MacroPosition};
+use crate::macros::{macro_style, rewrite_macro, rewrite_macro_def, MacroPosition};
+use crate::modules::Module;
use crate::rewrite::{Rewrite, RewriteContext};
use crate::shape::{Indent, Shape};
use crate::skip::{is_skip_attr, SkipContext};
use crate::source_map::{LineRangeUtils, SpanUtils};
use crate::spanned::Spanned;
use crate::stmt::Stmt;
+use crate::syntux::session::ParseSess;
use crate::utils::{
- self, contains_skip, count_newlines, depr_skip_annotation, inner_attributes, last_line_width,
- mk_sp, ptr_vec_to_ref_vec, rewrite_ident, stmt_expr,
+ self, contains_skip, count_newlines, depr_skip_annotation, format_unsafety, inner_attributes,
+ last_line_width, mk_sp, ptr_vec_to_ref_vec, rewrite_ident, starts_with_newline, stmt_expr,
};
use crate::{ErrorKind, FormatReport, FormattingError};
/// Creates a string slice corresponding to the specified span.
-pub(crate) struct SnippetProvider<'a> {
+pub(crate) struct SnippetProvider {
/// A pointer to the content of the file we are formatting.
- big_snippet: &'a str,
+ big_snippet: Rc<String>,
/// A position of the start of `big_snippet`, used as an offset.
start_pos: usize,
+ /// A end position of the file that this snippet lives.
+ end_pos: usize,
}
-impl<'a> SnippetProvider<'a> {
+impl SnippetProvider {
pub(crate) fn span_to_snippet(&self, span: Span) -> Option<&str> {
let start_index = span.lo().to_usize().checked_sub(self.start_pos)?;
let end_index = span.hi().to_usize().checked_sub(self.start_pos)?;
Some(&self.big_snippet[start_index..end_index])
}
- pub(crate) fn new(start_pos: BytePos, big_snippet: &'a str) -> Self {
+ pub(crate) fn new(start_pos: BytePos, end_pos: BytePos, big_snippet: Rc<String>) -> Self {
let start_pos = start_pos.to_usize();
+ let end_pos = end_pos.to_usize();
SnippetProvider {
big_snippet,
start_pos,
+ end_pos,
}
}
+
+ pub(crate) fn entire_snippet(&self) -> &str {
+ self.big_snippet.as_str()
+ }
+
+ pub(crate) fn start_pos(&self) -> BytePos {
+ BytePos::from_usize(self.start_pos)
+ }
+
+ pub(crate) fn end_pos(&self) -> BytePos {
+ BytePos::from_usize(self.end_pos)
+ }
}
pub(crate) struct FmtVisitor<'a> {
parent_context: Option<&'a RewriteContext<'a>>,
- pub(crate) parse_session: &'a ParseSess,
- pub(crate) source_map: &'a SourceMap,
+ pub(crate) parse_sess: &'a ParseSess,
pub(crate) buffer: String,
pub(crate) last_pos: BytePos,
// FIXME: use an RAII util or closure for indenting
pub(crate) block_indent: Indent,
pub(crate) config: &'a Config,
pub(crate) is_if_else_block: bool,
- pub(crate) snippet_provider: &'a SnippetProvider<'a>,
+ pub(crate) snippet_provider: &'a SnippetProvider,
pub(crate) line_number: usize,
/// List of 1-based line ranges which were annotated with skip
/// Both bounds are inclusifs.
pub(crate) macro_rewrite_failure: bool,
pub(crate) report: FormatReport,
pub(crate) skip_context: SkipContext,
+ pub(crate) is_macro_def: bool,
}
impl<'a> Drop for FmtVisitor<'a> {
mk_sp(self.last_pos, hi)
}
- fn visit_stmt(&mut self, stmt: &Stmt<'_>) {
+ fn visit_stmt(&mut self, stmt: &Stmt<'_>, include_empty_semi: bool) {
debug!(
- "visit_stmt: {:?} {:?}",
- self.source_map.lookup_char_pos(stmt.span().lo()),
- self.source_map.lookup_char_pos(stmt.span().hi())
+ "visit_stmt: {}",
+ self.parse_sess.span_to_debug_info(stmt.span())
);
- match stmt.as_ast_node().node {
+ if stmt.is_empty() {
+ // If the statement is empty, just skip over it. Before that, make sure any comment
+ // snippet preceding the semicolon is picked up.
+ let snippet = self.snippet(mk_sp(self.last_pos, stmt.span().lo()));
+ let original_starts_with_newline = snippet
+ .find(|c| c != ' ')
+ .map_or(false, |i| starts_with_newline(&snippet[i..]));
+ let snippet = snippet.trim();
+ if !snippet.is_empty() {
+ // FIXME(calebcartwright 2021-01-03) - This exists strictly to maintain legacy
+ // formatting where rustfmt would preserve redundant semicolons on Items in a
+ // statement position.
+ // See comment within `walk_stmts` for more info
+ if include_empty_semi {
+ self.format_missing(stmt.span().hi());
+ } else {
+ if original_starts_with_newline {
+ self.push_str("\n");
+ }
+
+ self.push_str(&self.block_indent.to_string(self.config));
+ self.push_str(snippet);
+ }
+ } else if include_empty_semi {
+ self.push_str(";");
+ }
+ self.last_pos = stmt.span().hi();
+ return;
+ }
+
+ match stmt.as_ast_node().kind {
ast::StmtKind::Item(ref item) => {
self.visit_item(item);
- // Handle potential `;` after the item.
- self.format_missing(stmt.span().hi());
+ self.last_pos = stmt.span().hi();
}
ast::StmtKind::Local(..) | ast::StmtKind::Expr(..) | ast::StmtKind::Semi(..) => {
let attrs = get_attrs_from_stmt(stmt.as_ast_node());
self.push_rewrite(stmt.span(), rewrite)
}
}
- ast::StmtKind::Mac(ref mac) => {
- let (ref mac, _macro_style, ref attrs) = **mac;
- if self.visit_attrs(attrs, ast::AttrStyle::Outer) {
+ ast::StmtKind::MacCall(ref mac_stmt) => {
+ if self.visit_attrs(&mac_stmt.attrs, ast::AttrStyle::Outer) {
self.push_skipped_with_span(
- attrs,
+ &mac_stmt.attrs,
stmt.span(),
get_span_without_attrs(stmt.as_ast_node()),
);
} else {
- self.visit_mac(mac, None, MacroPosition::Statement);
+ self.visit_mac(&mac_stmt.mac, None, MacroPosition::Statement);
}
self.format_missing(stmt.span().hi());
}
+ ast::StmtKind::Empty => (),
}
}
has_braces: bool,
) {
debug!(
- "visit_block: {:?} {:?}",
- self.source_map.lookup_char_pos(b.span.lo()),
- self.source_map.lookup_char_pos(b.span.hi())
+ "visit_block: {}",
+ self.parse_sess.span_to_debug_info(b.span),
);
// Check if this block has braces.
trimmed.is_empty() || trimmed.chars().all(|c| c == ';')
};
- for (kind, offset, sub_slice) in CommentCodeSlices::new(self.snippet(span)) {
+ let comment_snippet = self.snippet(span);
+
+ let align_to_right = if unindent_comment && contains_comment(&comment_snippet) {
+ let first_lines = comment_snippet.splitn(2, '/').next().unwrap_or("");
+ last_line_width(first_lines) > last_line_width(&comment_snippet)
+ } else {
+ false
+ };
+
+ for (kind, offset, sub_slice) in CommentCodeSlices::new(comment_snippet) {
let sub_slice = transform_missing_snippet(config, sub_slice);
debug!("close_block: {:?} {:?} {:?}", kind, offset, sub_slice);
match kind {
CodeCharKind::Comment => {
- if !unindented && unindent_comment {
+ if !unindented && unindent_comment && !align_to_right {
unindented = true;
self.block_indent = self.block_indent.block_unindent(config);
}
let mut comment_shape =
Shape::indented(self.block_indent, config).comment(config);
- if comment_on_same_line {
- // 1 = a space before `//`
- let offset_len = 1 + last_line_width(&self.buffer)
- .saturating_sub(self.block_indent.width());
- match comment_shape
- .visual_indent(offset_len)
- .sub_width(offset_len)
- {
- Some(shp) => comment_shape = shp,
- None => comment_on_same_line = false,
- }
- };
-
- if comment_on_same_line {
+ if self.config.version() == Version::Two && comment_on_same_line {
self.push_str(" ");
+ // put the first line of the comment on the same line as the
+ // block's last line
+ match sub_slice.find("\n") {
+ None => {
+ self.push_str(&sub_slice);
+ }
+ Some(offset) if offset + 1 == sub_slice.len() => {
+ self.push_str(&sub_slice[..offset]);
+ }
+ Some(offset) => {
+ let first_line = &sub_slice[..offset];
+ self.push_str(first_line);
+ self.push_str(&self.block_indent.to_string_with_newline(config));
+
+ // put the other lines below it, shaping it as needed
+ let other_lines = &sub_slice[offset + 1..];
+ let comment_str =
+ rewrite_comment(other_lines, false, comment_shape, config);
+ match comment_str {
+ Some(ref s) => self.push_str(s),
+ None => self.push_str(other_lines),
+ }
+ }
+ }
} else {
- if count_newlines(snippet_in_between) >= 2 || extra_newline {
- self.push_str("\n");
+ if comment_on_same_line {
+ // 1 = a space before `//`
+ let offset_len = 1 + last_line_width(&self.buffer)
+ .saturating_sub(self.block_indent.width());
+ match comment_shape
+ .visual_indent(offset_len)
+ .sub_width(offset_len)
+ {
+ Some(shp) => comment_shape = shp,
+ None => comment_on_same_line = false,
+ }
+ };
+
+ if comment_on_same_line {
+ self.push_str(" ");
+ } else {
+ if count_newlines(snippet_in_between) >= 2 || extra_newline {
+ self.push_str("\n");
+ }
+ self.push_str(&self.block_indent.to_string_with_newline(config));
}
- self.push_str(&self.block_indent.to_string_with_newline(config));
- }
- let comment_str = rewrite_comment(&sub_slice, false, comment_shape, config);
- match comment_str {
- Some(ref s) => self.push_str(s),
- None => self.push_str(&sub_slice),
+ let comment_str = rewrite_comment(&sub_slice, false, comment_shape, config);
+ match comment_str {
+ Some(ref s) => self.push_str(s),
+ None => self.push_str(&sub_slice),
+ }
}
}
CodeCharKind::Normal if skip_normal(&sub_slice) => {
// Note that this only gets called for function definitions. Required methods
// on traits do not get handled here.
- fn visit_fn(
+ pub(crate) fn visit_fn(
&mut self,
fk: visit::FnKind<'_>,
generics: &ast::Generics,
let indent = self.block_indent;
let block;
let rewrite = match fk {
- visit::FnKind::ItemFn(ident, _, _, b) | visit::FnKind::Method(ident, _, _, b) => {
+ visit::FnKind::Fn(_, ident, _, _, Some(ref b)) => {
block = b;
self.rewrite_fn_before_block(
indent,
mk_sp(s.lo(), b.span.lo()),
)
}
- visit::FnKind::Closure(_) => unreachable!(),
+ _ => unreachable!(),
};
if let Some((fn_str, fn_brace_style)) = rewrite {
let skip_context_saved = self.skip_context.clone();
self.skip_context.update_with_attrs(&attrs);
- let should_visit_node_again = match item.node {
+ let should_visit_node_again = match item.kind {
// For use/extern crate items, skip rewriting attributes but check for a skip attribute.
ast::ItemKind::Use(..) | ast::ItemKind::ExternCrate(_) => {
if contains_skip(attrs) {
};
if should_visit_node_again {
- match item.node {
+ match item.kind {
ast::ItemKind::Use(ref tree) => self.format_import(item, tree),
- ast::ItemKind::Impl(..) => {
+ ast::ItemKind::Impl { .. } => {
let block_indent = self.block_indent;
let rw = self.with_context(|ctx| format_impl(&ctx, item, block_indent));
self.push_rewrite(item.span, rw);
self.format_missing_with_indent(source!(self, item.span).lo());
self.format_mod(module, &item.vis, item.span, item.ident, attrs, is_inline);
}
- ast::ItemKind::Mac(ref mac) => {
+ ast::ItemKind::MacCall(ref mac) => {
self.visit_mac(mac, Some(item.ident), MacroPosition::Item);
}
ast::ItemKind::ForeignMod(ref foreign_mod) => {
ast::ItemKind::Static(..) | ast::ItemKind::Const(..) => {
self.visit_static(&StaticParts::from_item(item));
}
- ast::ItemKind::Fn(ref decl, ref fn_header, ref generics, ref body) => {
+ ast::ItemKind::Fn(defaultness, ref fn_signature, ref generics, Some(ref body)) => {
let inner_attrs = inner_attributes(&item.attrs);
+ let fn_ctxt = match fn_signature.header.ext {
+ ast::Extern::None => visit::FnCtxt::Free,
+ _ => visit::FnCtxt::Foreign,
+ };
self.visit_fn(
- visit::FnKind::ItemFn(item.ident, fn_header, &item.vis, body),
+ visit::FnKind::Fn(
+ fn_ctxt,
+ item.ident,
+ &fn_signature,
+ &item.vis,
+ Some(body),
+ ),
generics,
- decl,
+ &fn_signature.decl,
item.span,
- ast::Defaultness::Final,
+ defaultness,
Some(&inner_attrs),
)
}
- ast::ItemKind::Ty(ref ty, ref generics) => {
- let rewrite = rewrite_type_alias(
- &self.get_context(),
- self.block_indent,
- item.ident,
- ty,
- generics,
- &item.vis,
- );
- self.push_rewrite(item.span, rewrite);
- }
- ast::ItemKind::Existential(ref generic_bounds, ref generics) => {
- let rewrite = rewrite_existential_type(
- &self.get_context(),
- self.block_indent,
+ ast::ItemKind::Fn(_, ref fn_signature, ref generics, None) => {
+ let indent = self.block_indent;
+ let rewrite = self.rewrite_required_fn(
+ indent,
item.ident,
- generic_bounds,
+ &fn_signature,
generics,
- &item.vis,
+ item.span,
);
+
self.push_rewrite(item.span, rewrite);
}
+ ast::ItemKind::TyAlias(_, ref generics, ref generic_bounds, ref ty) => match ty {
+ Some(ty) => {
+ let rewrite = rewrite_type_alias(
+ item.ident,
+ Some(&*ty),
+ generics,
+ Some(generic_bounds),
+ &self.get_context(),
+ self.block_indent,
+ &item.vis,
+ item.span,
+ );
+ self.push_rewrite(item.span, rewrite);
+ }
+ None => {
+ let rewrite = rewrite_opaque_type(
+ &self.get_context(),
+ self.block_indent,
+ item.ident,
+ generic_bounds,
+ generics,
+ &item.vis,
+ item.span,
+ );
+ self.push_rewrite(item.span, rewrite);
+ }
+ },
ast::ItemKind::GlobalAsm(..) => {
let snippet = Some(self.snippet(item.span).to_owned());
self.push_rewrite(item.span, snippet);
self.skip_context = skip_context_saved;
}
- pub(crate) fn visit_trait_item(&mut self, ti: &ast::TraitItem) {
+ pub(crate) fn visit_trait_item(&mut self, ti: &ast::AssocItem) {
skip_out_of_file_lines_range_visitor!(self, ti.span);
if self.visit_attrs(&ti.attrs, ast::AttrStyle::Outer) {
return;
}
- match ti.node {
- ast::TraitItemKind::Const(..) => self.visit_static(&StaticParts::from_trait_item(ti)),
- ast::TraitItemKind::Method(ref sig, None) => {
+ match ti.kind {
+ ast::AssocItemKind::Const(..) => self.visit_static(&StaticParts::from_trait_item(ti)),
+ ast::AssocItemKind::Fn(_, ref sig, ref generics, None) => {
let indent = self.block_indent;
- let rewrite =
- self.rewrite_required_fn(indent, ti.ident, sig, &ti.generics, ti.span);
+ let rewrite = self.rewrite_required_fn(indent, ti.ident, sig, generics, ti.span);
self.push_rewrite(ti.span, rewrite);
}
- ast::TraitItemKind::Method(ref sig, Some(ref body)) => {
+ ast::AssocItemKind::Fn(defaultness, ref sig, ref generics, Some(ref body)) => {
let inner_attrs = inner_attributes(&ti.attrs);
+ let vis = ast::Visibility {
+ kind: ast::VisibilityKind::Inherited,
+ span: DUMMY_SP,
+ tokens: None,
+ };
+ let fn_ctxt = visit::FnCtxt::Assoc(visit::AssocCtxt::Trait);
self.visit_fn(
- visit::FnKind::Method(ti.ident, sig, None, body),
- &ti.generics,
+ visit::FnKind::Fn(fn_ctxt, ti.ident, sig, &vis, Some(body)),
+ generics,
&sig.decl,
ti.span,
- ast::Defaultness::Final,
+ defaultness,
Some(&inner_attrs),
);
}
- ast::TraitItemKind::Type(ref generic_bounds, ref type_default) => {
- let rewrite = rewrite_associated_type(
+ ast::AssocItemKind::TyAlias(_, ref generics, ref generic_bounds, ref type_default) => {
+ let rewrite = rewrite_type_alias(
ti.ident,
type_default.as_ref(),
- &ti.generics,
+ generics,
Some(generic_bounds),
&self.get_context(),
self.block_indent,
+ &ti.vis,
+ ti.span,
);
self.push_rewrite(ti.span, rewrite);
}
- ast::TraitItemKind::Macro(ref mac) => {
+ ast::AssocItemKind::MacCall(ref mac) => {
self.visit_mac(mac, Some(ti.ident), MacroPosition::Item);
}
}
}
- pub(crate) fn visit_impl_item(&mut self, ii: &ast::ImplItem) {
+ pub(crate) fn visit_impl_item(&mut self, ii: &ast::AssocItem) {
skip_out_of_file_lines_range_visitor!(self, ii.span);
if self.visit_attrs(&ii.attrs, ast::AttrStyle::Outer) {
- self.push_skipped_with_span(ii.attrs.as_slice(), ii.span(), ii.span());
+ self.push_skipped_with_span(ii.attrs.as_slice(), ii.span, ii.span);
return;
}
- match ii.node {
- ast::ImplItemKind::Method(ref sig, ref body) => {
+ match ii.kind {
+ ast::AssocItemKind::Fn(defaultness, ref sig, ref generics, Some(ref body)) => {
let inner_attrs = inner_attributes(&ii.attrs);
+ let fn_ctxt = visit::FnCtxt::Assoc(visit::AssocCtxt::Impl);
self.visit_fn(
- visit::FnKind::Method(ii.ident, sig, Some(&ii.vis), body),
- &ii.generics,
+ visit::FnKind::Fn(fn_ctxt, ii.ident, sig, &ii.vis, Some(body)),
+ generics,
&sig.decl,
ii.span,
- ii.defaultness,
+ defaultness,
Some(&inner_attrs),
);
}
- ast::ImplItemKind::Const(..) => self.visit_static(&StaticParts::from_impl_item(ii)),
- ast::ImplItemKind::Type(ref ty) => {
- let rewrite = rewrite_associated_impl_type(
- ii.ident,
- ii.defaultness,
- Some(ty),
- &ii.generics,
- &self.get_context(),
- self.block_indent,
- );
+ ast::AssocItemKind::Fn(_, ref sig, ref generics, None) => {
+ let indent = self.block_indent;
+ let rewrite = self.rewrite_required_fn(indent, ii.ident, sig, generics, ii.span);
self.push_rewrite(ii.span, rewrite);
}
- ast::ImplItemKind::Existential(ref generic_bounds) => {
- let rewrite = rewrite_existential_impl_type(
- &self.get_context(),
- ii.ident,
- &ii.generics,
- generic_bounds,
- self.block_indent,
- );
+ ast::AssocItemKind::Const(..) => self.visit_static(&StaticParts::from_impl_item(ii)),
+ ast::AssocItemKind::TyAlias(defaultness, ref generics, _, ref ty) => {
+ let rewrite_associated = || {
+ rewrite_associated_impl_type(
+ ii.ident,
+ &ii.vis,
+ defaultness,
+ ty.as_ref(),
+ &generics,
+ &self.get_context(),
+ self.block_indent,
+ ii.span,
+ )
+ };
+ let rewrite = match ty {
+ None => rewrite_associated(),
+ Some(ty) => match ty.kind {
+ ast::TyKind::ImplTrait(_, ref bounds) => rewrite_opaque_impl_type(
+ &self.get_context(),
+ ii.ident,
+ generics,
+ bounds,
+ self.block_indent,
+ ),
+ _ => rewrite_associated(),
+ },
+ };
self.push_rewrite(ii.span, rewrite);
}
- ast::ImplItemKind::Macro(ref mac) => {
+ ast::AssocItemKind::MacCall(ref mac) => {
self.visit_mac(mac, Some(ii.ident), MacroPosition::Item);
}
}
}
- fn visit_mac(&mut self, mac: &ast::Mac, ident: Option<ast::Ident>, pos: MacroPosition) {
- skip_out_of_file_lines_range_visitor!(self, mac.span);
+ fn visit_mac(&mut self, mac: &ast::MacCall, ident: Option<symbol::Ident>, pos: MacroPosition) {
+ skip_out_of_file_lines_range_visitor!(self, mac.span());
// 1 = ;
let shape = self.shape().saturating_sub_width(1);
let rewrite = self.with_context(|ctx| rewrite_macro(mac, ident, ctx, shape, pos));
- self.push_rewrite(mac.span, rewrite);
+ // As of v638 of the rustc-ap-* crates, the associated span no longer includes
+ // the trailing semicolon. This determines the correct span to ensure scenarios
+ // with whitespace between the delimiters and trailing semi (i.e. `foo!(abc) ;`)
+ // are formatted correctly.
+ let (span, rewrite) = match macro_style(mac, &self.get_context()) {
+ DelimToken::Bracket | DelimToken::Paren if MacroPosition::Item == pos => {
+ let search_span = mk_sp(mac.span().hi(), self.snippet_provider.end_pos());
+ let hi = self.snippet_provider.span_before(search_span, ";");
+ let target_span = mk_sp(mac.span().lo(), hi + BytePos(1));
+ let rewrite = rewrite.map(|rw| {
+ if !rw.ends_with(";") {
+ format!("{};", rw)
+ } else {
+ rw
+ }
+ });
+ (target_span, rewrite)
+ }
+ _ => (mac.span(), rewrite),
+ };
+
+ self.push_rewrite(span, rewrite);
}
pub(crate) fn push_str(&mut self, s: &str) {
self.push_str(s);
} else {
let snippet = self.snippet(span);
- self.push_str(snippet);
+ self.push_str(snippet.trim());
}
self.last_pos = source!(self, span).hi();
}
// do not take into account the lines with attributes as part of the skipped range
let attrs_end = attrs
.iter()
- .map(|attr| self.source_map.lookup_char_pos(attr.span.hi()).line)
+ .map(|attr| self.parse_sess.line_of_byte_pos(attr.span.hi()))
.max()
.unwrap_or(1);
- let first_line = self.source_map.lookup_char_pos(main_span.lo()).line;
+ let first_line = self.parse_sess.line_of_byte_pos(main_span.lo());
// Statement can start after some newlines and/or spaces
// or it can be on the same line as the last attribute.
// So here we need to take a minimum between the two.
}
pub(crate) fn from_context(ctx: &'a RewriteContext<'_>) -> FmtVisitor<'a> {
- let mut visitor = FmtVisitor::from_source_map(
- ctx.parse_session,
+ let mut visitor = FmtVisitor::from_parse_sess(
+ ctx.parse_sess,
ctx.config,
ctx.snippet_provider,
ctx.report.clone(),
visitor
}
- pub(crate) fn from_source_map(
+ pub(crate) fn from_parse_sess(
parse_session: &'a ParseSess,
config: &'a Config,
- snippet_provider: &'a SnippetProvider<'_>,
+ snippet_provider: &'a SnippetProvider,
report: FormatReport,
) -> FmtVisitor<'a> {
FmtVisitor {
parent_context: None,
- parse_session,
- source_map: parse_session.source_map(),
+ parse_sess: parse_session,
buffer: String::with_capacity(snippet_provider.big_snippet.len() * 2),
last_pos: BytePos(0),
block_indent: Indent::empty(),
snippet_provider,
line_number: 0,
skipped_range: Rc::new(RefCell::new(vec![])),
+ is_macro_def: false,
macro_rewrite_failure: false,
report,
skip_context: Default::default(),
// Returns true if we should skip the following item.
pub(crate) fn visit_attrs(&mut self, attrs: &[ast::Attribute], style: ast::AttrStyle) -> bool {
for attr in attrs {
- if attr.check_name(depr_skip_annotation()) {
- let file_name = self.source_map.span_to_filename(attr.span).into();
+ if attr.has_name(depr_skip_annotation()) {
+ let file_name = self.parse_sess.span_to_filename(attr.span);
self.report.append(
file_name,
vec![FormattingError::from_span(
attr.span,
- &self.source_map,
+ self.parse_sess,
ErrorKind::DeprecatedAttr,
)],
);
- } else if self.is_unknown_rustfmt_attr(&attr.path.segments) {
- let file_name = self.source_map.span_to_filename(attr.span).into();
- self.report.append(
- file_name,
- vec![FormattingError::from_span(
- attr.span,
- &self.source_map,
- ErrorKind::BadAttr,
- )],
- );
+ } else {
+ match &attr.kind {
+ ast::AttrKind::Normal(ref attribute_item, _)
+ if self.is_unknown_rustfmt_attr(&attribute_item.path.segments) =>
+ {
+ let file_name = self.parse_sess.span_to_filename(attr.span);
+ self.report.append(
+ file_name,
+ vec![FormattingError::from_span(
+ attr.span,
+ self.parse_sess,
+ ErrorKind::BadAttr,
+ )],
+ );
+ }
+ _ => (),
+ }
}
}
if contains_skip(attrs) {
self.visit_items_with_reordering(&ptr_vec_to_ref_vec(&m.items));
}
- fn walk_stmts(&mut self, stmts: &[Stmt<'_>]) {
+ fn walk_stmts(&mut self, stmts: &[Stmt<'_>], include_current_empty_semi: bool) {
if stmts.is_empty() {
return;
}
.collect();
if items.is_empty() {
- self.visit_stmt(&stmts[0]);
- self.walk_stmts(&stmts[1..]);
+ self.visit_stmt(&stmts[0], include_current_empty_semi);
+
+ // FIXME(calebcartwright 2021-01-03) - This exists strictly to maintain legacy
+ // formatting where rustfmt would preserve redundant semicolons on Items in a
+ // statement position.
+ //
+ // Starting in rustc-ap-* v692 (~2020-12-01) the rustc parser now parses this as
+ // two separate statements (Item and Empty kinds), whereas before it was parsed as
+ // a single statement with the statement's span including the redundant semicolon.
+ //
+ // rustfmt typically tosses unnecessary/redundant semicolons, and eventually we
+ // should toss these as well, but doing so at this time would
+ // break the Stability Guarantee
+ // N.B. This could be updated to utilize the version gates.
+ let include_next_empty = if stmts.len() > 1 {
+ match (&stmts[0].as_ast_node().kind, &stmts[1].as_ast_node().kind) {
+ (ast::StmtKind::Item(_), ast::StmtKind::Empty) => true,
+ _ => false,
+ }
+ } else {
+ false
+ };
+
+ self.walk_stmts(&stmts[1..], include_next_empty);
} else {
self.visit_items_with_reordering(&items);
- self.walk_stmts(&stmts[items.len()..]);
+ self.walk_stmts(&stmts[items.len()..], false);
}
}
fn walk_block_stmts(&mut self, b: &ast::Block) {
- self.walk_stmts(&Stmt::from_ast_nodes(b.stmts.iter()))
+ self.walk_stmts(&Stmt::from_ast_nodes(b.stmts.iter()), false)
}
fn format_mod(
m: &ast::Mod,
vis: &ast::Visibility,
s: Span,
- ident: ast::Ident,
+ ident: symbol::Ident,
attrs: &[ast::Attribute],
is_internal: bool,
) {
let vis_str = utils::format_visibility(&self.get_context(), vis);
self.push_str(&*vis_str);
+ self.push_str(format_unsafety(m.unsafety));
self.push_str("mod ");
// Calling `to_owned()` to work around borrow checker.
let ident_str = rewrite_ident(&self.get_context(), ident).to_owned();
}
}
- pub(crate) fn format_separate_mod(
- &mut self,
- m: &ast::Mod,
- source_file: &source_map::SourceFile,
- ) {
+ pub(crate) fn format_separate_mod(&mut self, m: &Module<'_>, end_pos: BytePos) {
self.block_indent = Indent::empty();
- self.walk_mod_items(m);
- self.format_missing_with_indent(source_file.end_pos);
+ if self.visit_attrs(m.attrs(), ast::AttrStyle::Inner) {
+ self.push_skipped_with_span(m.attrs(), m.as_ref().inner, m.as_ref().inner);
+ } else {
+ self.walk_mod_items(m.as_ref());
+ self.format_missing_with_indent(end_pos);
+ }
}
pub(crate) fn skip_empty_lines(&mut self, end_pos: BytePos) {
where
F: Fn(&RewriteContext<'_>) -> Option<String>,
{
- // FIXME borrow checker fighting - can be simplified a lot with NLL.
- let (result, mrf) = {
- let context = self.get_context();
- let result = f(&context);
- let mrf = &context.macro_rewrite_failure.borrow();
- (result, *std::ops::Deref::deref(mrf))
- };
+ let context = self.get_context();
+ let result = f(&context);
- self.macro_rewrite_failure |= mrf;
+ self.macro_rewrite_failure |= context.macro_rewrite_failure.get();
result
}
pub(crate) fn get_context(&self) -> RewriteContext<'_> {
RewriteContext {
- parse_session: self.parse_session,
- source_map: self.source_map,
+ parse_sess: self.parse_sess,
config: self.config,
- inside_macro: Rc::new(RefCell::new(false)),
- use_block: RefCell::new(false),
- is_if_else_block: RefCell::new(false),
- force_one_line_chain: RefCell::new(false),
+ inside_macro: Rc::new(Cell::new(false)),
+ use_block: Cell::new(false),
+ is_if_else_block: Cell::new(false),
+ force_one_line_chain: Cell::new(false),
snippet_provider: self.snippet_provider,
- macro_rewrite_failure: RefCell::new(false),
+ macro_rewrite_failure: Cell::new(false),
+ is_macro_def: self.is_macro_def,
report: self.report.clone(),
skip_context: self.skip_context.clone(),
skipped_range: self.skipped_range.clone(),
projects / rust.git / blobdiff