1096 lines
40 KiB
Rust
1096 lines
40 KiB
Rust
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
use std::cmp;
|
|
|
|
use syntax::{ast, visit};
|
|
use syntax::attr::HasAttrs;
|
|
use syntax::codemap::{self, BytePos, CodeMap, Pos, Span};
|
|
use syntax::parse::ParseSess;
|
|
|
|
use codemap::{LineRangeUtils, SpanUtils};
|
|
use comment::{combine_strs_with_missing_comments, contains_comment, CodeCharKind,
|
|
CommentCodeSlices, FindUncommented};
|
|
use comment::rewrite_comment;
|
|
use config::{BraceStyle, Config};
|
|
use expr::rewrite_literal;
|
|
use items::{format_impl, format_trait, format_trait_alias, rewrite_associated_impl_type,
|
|
rewrite_associated_type, rewrite_type_alias, FnSig, StaticParts, StructParts};
|
|
use lists::{itemize_list, write_list, DefinitiveListTactic, ListFormatting, SeparatorPlace,
|
|
SeparatorTactic};
|
|
use macros::{rewrite_macro, rewrite_macro_def, MacroPosition};
|
|
use regex::Regex;
|
|
use rewrite::{Rewrite, RewriteContext};
|
|
use shape::{Indent, Shape};
|
|
use spanned::Spanned;
|
|
use utils::{self, contains_skip, count_newlines, inner_attributes, mk_sp, ptr_vec_to_ref_vec};
|
|
|
|
/// Returns attributes that are within `outer_span`.
|
|
pub fn filter_inline_attrs(attrs: &[ast::Attribute], outer_span: Span) -> Vec<ast::Attribute> {
|
|
attrs
|
|
.iter()
|
|
.filter(|a| outer_span.lo() <= a.span.lo() && a.span.hi() <= outer_span.hi())
|
|
.cloned()
|
|
.collect()
|
|
}
|
|
|
|
/// Returns true for `mod foo;`, false for `mod foo { .. }`.
|
|
fn is_mod_decl(item: &ast::Item) -> bool {
|
|
match item.node {
|
|
ast::ItemKind::Mod(ref m) => m.inner.hi() != item.span.hi(),
|
|
_ => false,
|
|
}
|
|
}
|
|
|
|
/// Returns true for `mod foo;` without any inline attributes.
|
|
/// We cannot reorder modules with attributes because doing so can break the code.
|
|
/// e.g. `#[macro_use]`.
|
|
fn is_mod_decl_without_attr(item: &ast::Item) -> bool {
|
|
is_mod_decl(item) && filter_inline_attrs(&item.attrs, item.span()).is_empty()
|
|
}
|
|
|
|
fn is_use_item(item: &ast::Item) -> bool {
|
|
match item.node {
|
|
ast::ItemKind::Use(_) => true,
|
|
_ => false,
|
|
}
|
|
}
|
|
|
|
fn is_extern_crate(item: &ast::Item) -> bool {
|
|
match item.node {
|
|
ast::ItemKind::ExternCrate(..) => true,
|
|
_ => false,
|
|
}
|
|
}
|
|
|
|
/// Creates a string slice corresponding to the specified span.
|
|
pub struct SnippetProvider<'a> {
|
|
/// A pointer to the content of the file we are formatting.
|
|
big_snippet: &'a str,
|
|
/// A position of the start of `big_snippet`, used as an offset.
|
|
start_pos: usize,
|
|
}
|
|
|
|
impl<'a> SnippetProvider<'a> {
|
|
pub 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 fn new(start_pos: BytePos, big_snippet: &'a str) -> Self {
|
|
let start_pos = start_pos.to_usize();
|
|
SnippetProvider {
|
|
big_snippet,
|
|
start_pos,
|
|
}
|
|
}
|
|
}
|
|
|
|
pub struct FmtVisitor<'a> {
|
|
pub parse_session: &'a ParseSess,
|
|
pub codemap: &'a CodeMap,
|
|
pub buffer: String,
|
|
pub last_pos: BytePos,
|
|
// FIXME: use an RAII util or closure for indenting
|
|
pub block_indent: Indent,
|
|
pub config: &'a Config,
|
|
pub is_if_else_block: bool,
|
|
pub snippet_provider: &'a SnippetProvider<'a>,
|
|
pub line_number: usize,
|
|
pub skipped_range: Vec<(usize, usize)>,
|
|
}
|
|
|
|
impl<'b, 'a: 'b> FmtVisitor<'a> {
|
|
pub fn shape(&self) -> Shape {
|
|
Shape::indented(self.block_indent, self.config)
|
|
}
|
|
|
|
fn visit_stmt(&mut self, stmt: &ast::Stmt) {
|
|
debug!(
|
|
"visit_stmt: {:?} {:?}",
|
|
self.codemap.lookup_char_pos(stmt.span.lo()),
|
|
self.codemap.lookup_char_pos(stmt.span.hi())
|
|
);
|
|
|
|
match stmt.node {
|
|
ast::StmtKind::Item(ref item) => {
|
|
self.visit_item(item);
|
|
}
|
|
ast::StmtKind::Local(..) | ast::StmtKind::Expr(..) | ast::StmtKind::Semi(..) => {
|
|
if contains_skip(get_attrs_from_stmt(stmt)) {
|
|
self.push_skipped_with_span(stmt.span());
|
|
} else {
|
|
let rewrite = stmt.rewrite(&self.get_context(), self.shape());
|
|
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) {
|
|
self.push_skipped_with_span(stmt.span());
|
|
} else {
|
|
self.visit_mac(mac, None, MacroPosition::Statement);
|
|
}
|
|
self.format_missing(stmt.span.hi());
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn visit_block(
|
|
&mut self,
|
|
b: &ast::Block,
|
|
inner_attrs: Option<&[ast::Attribute]>,
|
|
has_braces: bool,
|
|
) {
|
|
debug!(
|
|
"visit_block: {:?} {:?}",
|
|
self.codemap.lookup_char_pos(b.span.lo()),
|
|
self.codemap.lookup_char_pos(b.span.hi())
|
|
);
|
|
|
|
// Check if this block has braces.
|
|
let brace_compensation = BytePos(if has_braces { 1 } else { 0 });
|
|
|
|
self.last_pos = self.last_pos + brace_compensation;
|
|
self.block_indent = self.block_indent.block_indent(self.config);
|
|
self.push_str("{");
|
|
|
|
if self.config.remove_blank_lines_at_start_or_end_of_block() {
|
|
if let Some(first_stmt) = b.stmts.first() {
|
|
let attr_lo = inner_attrs
|
|
.and_then(|attrs| inner_attributes(attrs).first().map(|attr| attr.span.lo()))
|
|
.or_else(|| {
|
|
// Attributes for an item in a statement position
|
|
// do not belong to the statement. (rust-lang/rust#34459)
|
|
if let ast::StmtKind::Item(ref item) = first_stmt.node {
|
|
item.attrs.first()
|
|
} else {
|
|
first_stmt.attrs().first()
|
|
}.and_then(|attr| {
|
|
// Some stmts can have embedded attributes.
|
|
// e.g. `match { #![attr] ... }`
|
|
let attr_lo = attr.span.lo();
|
|
if attr_lo < first_stmt.span.lo() {
|
|
Some(attr_lo)
|
|
} else {
|
|
None
|
|
}
|
|
})
|
|
});
|
|
|
|
let snippet = self.snippet(mk_sp(
|
|
self.last_pos,
|
|
attr_lo.unwrap_or(first_stmt.span.lo()),
|
|
));
|
|
let len = CommentCodeSlices::new(snippet)
|
|
.nth(0)
|
|
.and_then(|(kind, _, s)| {
|
|
if kind == CodeCharKind::Normal {
|
|
s.rfind('\n')
|
|
} else {
|
|
None
|
|
}
|
|
});
|
|
if let Some(len) = len {
|
|
self.last_pos = self.last_pos + BytePos::from_usize(len);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Format inner attributes if available.
|
|
let skip_rewrite = if let Some(attrs) = inner_attrs {
|
|
self.visit_attrs(attrs, ast::AttrStyle::Inner)
|
|
} else {
|
|
false
|
|
};
|
|
|
|
if skip_rewrite {
|
|
self.push_rewrite(b.span, None);
|
|
self.close_block(false);
|
|
self.last_pos = source!(self, b.span).hi();
|
|
return;
|
|
}
|
|
|
|
self.walk_block_stmts(b);
|
|
|
|
if !b.stmts.is_empty() {
|
|
if let Some(expr) = utils::stmt_expr(&b.stmts[b.stmts.len() - 1]) {
|
|
if utils::semicolon_for_expr(&self.get_context(), expr) {
|
|
self.push_str(";");
|
|
}
|
|
}
|
|
}
|
|
|
|
let mut remove_len = BytePos(0);
|
|
if self.config.remove_blank_lines_at_start_or_end_of_block() {
|
|
if let Some(stmt) = b.stmts.last() {
|
|
let snippet = self.snippet(mk_sp(
|
|
stmt.span.hi(),
|
|
source!(self, b.span).hi() - brace_compensation,
|
|
));
|
|
let len = CommentCodeSlices::new(snippet)
|
|
.last()
|
|
.and_then(|(kind, _, s)| {
|
|
if kind == CodeCharKind::Normal && s.trim().is_empty() {
|
|
Some(s.len())
|
|
} else {
|
|
None
|
|
}
|
|
});
|
|
if let Some(len) = len {
|
|
remove_len = BytePos::from_usize(len);
|
|
}
|
|
}
|
|
}
|
|
|
|
let unindent_comment = (self.is_if_else_block && !b.stmts.is_empty()) && {
|
|
let end_pos = source!(self, b.span).hi() - brace_compensation - remove_len;
|
|
let snippet = self.snippet(mk_sp(self.last_pos, end_pos));
|
|
snippet.contains("//") || snippet.contains("/*")
|
|
};
|
|
// FIXME: we should compress any newlines here to just one
|
|
if unindent_comment {
|
|
self.block_indent = self.block_indent.block_unindent(self.config);
|
|
}
|
|
self.format_missing_with_indent(
|
|
source!(self, b.span).hi() - brace_compensation - remove_len,
|
|
);
|
|
if unindent_comment {
|
|
self.block_indent = self.block_indent.block_indent(self.config);
|
|
}
|
|
self.close_block(unindent_comment);
|
|
self.last_pos = source!(self, b.span).hi();
|
|
}
|
|
|
|
// FIXME: this is a terrible hack to indent the comments between the last
|
|
// item in the block and the closing brace to the block's level.
|
|
// The closing brace itself, however, should be indented at a shallower
|
|
// level.
|
|
fn close_block(&mut self, unindent_comment: bool) {
|
|
let total_len = self.buffer.len();
|
|
let chars_too_many = if unindent_comment {
|
|
0
|
|
} else if self.config.hard_tabs() {
|
|
1
|
|
} else {
|
|
self.config.tab_spaces()
|
|
};
|
|
self.buffer.truncate(total_len - chars_too_many);
|
|
self.push_str("}");
|
|
self.block_indent = self.block_indent.block_unindent(self.config);
|
|
}
|
|
|
|
// Note that this only gets called for function definitions. Required methods
|
|
// on traits do not get handled here.
|
|
fn visit_fn(
|
|
&mut self,
|
|
fk: visit::FnKind,
|
|
generics: &ast::Generics,
|
|
fd: &ast::FnDecl,
|
|
s: Span,
|
|
defaultness: ast::Defaultness,
|
|
inner_attrs: Option<&[ast::Attribute]>,
|
|
) {
|
|
let indent = self.block_indent;
|
|
let block;
|
|
let rewrite = match fk {
|
|
visit::FnKind::ItemFn(ident, _, _, _, _, b) | visit::FnKind::Method(ident, _, _, b) => {
|
|
block = b;
|
|
self.rewrite_fn(
|
|
indent,
|
|
ident,
|
|
&FnSig::from_fn_kind(&fk, generics, fd, defaultness),
|
|
mk_sp(s.lo(), b.span.lo()),
|
|
b,
|
|
)
|
|
}
|
|
visit::FnKind::Closure(_) => unreachable!(),
|
|
};
|
|
|
|
if let Some(fn_str) = rewrite {
|
|
self.format_missing_with_indent(source!(self, s).lo());
|
|
self.push_str(&fn_str);
|
|
if let Some(c) = fn_str.chars().last() {
|
|
if c == '}' {
|
|
self.last_pos = source!(self, block.span).hi();
|
|
return;
|
|
}
|
|
}
|
|
} else {
|
|
self.format_missing(source!(self, block.span).lo());
|
|
}
|
|
|
|
self.last_pos = source!(self, block.span).lo();
|
|
self.visit_block(block, inner_attrs, true)
|
|
}
|
|
|
|
pub fn visit_item(&mut self, item: &ast::Item) {
|
|
skip_out_of_file_lines_range_visitor!(self, item.span);
|
|
|
|
// This is where we bail out if there is a skip attribute. This is only
|
|
// complex in the module case. It is complex because the module could be
|
|
// in a separate file and there might be attributes in both files, but
|
|
// the AST lumps them all together.
|
|
let filtered_attrs;
|
|
let mut attrs = &item.attrs;
|
|
match item.node {
|
|
// Module is inline, in this case we treat it like any other item.
|
|
_ if !is_mod_decl(item) => {
|
|
if self.visit_attrs(&item.attrs, ast::AttrStyle::Outer) {
|
|
self.push_skipped_with_span(item.span());
|
|
return;
|
|
}
|
|
}
|
|
// Module is not inline, but should be skipped.
|
|
ast::ItemKind::Mod(..) if contains_skip(&item.attrs) => {
|
|
return;
|
|
}
|
|
// Module is not inline and should not be skipped. We want
|
|
// to process only the attributes in the current file.
|
|
ast::ItemKind::Mod(..) => {
|
|
filtered_attrs = filter_inline_attrs(&item.attrs, item.span());
|
|
// Assert because if we should skip it should be caught by
|
|
// the above case.
|
|
assert!(!self.visit_attrs(&filtered_attrs, ast::AttrStyle::Outer));
|
|
attrs = &filtered_attrs;
|
|
}
|
|
_ => {
|
|
if self.visit_attrs(&item.attrs, ast::AttrStyle::Outer) {
|
|
self.push_skipped_with_span(item.span());
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
match item.node {
|
|
ast::ItemKind::Use(ref tree) => self.format_import(item, tree),
|
|
ast::ItemKind::Impl(..) => {
|
|
let snippet = self.snippet(item.span);
|
|
let where_span_end = snippet
|
|
.find_uncommented("{")
|
|
.map(|x| (BytePos(x as u32)) + source!(self, item.span).lo());
|
|
let rw = format_impl(&self.get_context(), item, self.block_indent, where_span_end);
|
|
self.push_rewrite(item.span, rw);
|
|
}
|
|
ast::ItemKind::Trait(..) => {
|
|
let rw = format_trait(&self.get_context(), item, self.block_indent);
|
|
self.push_rewrite(item.span, rw);
|
|
}
|
|
ast::ItemKind::TraitAlias(ref generics, ref ty_param_bounds) => {
|
|
let shape = Shape::indented(self.block_indent, self.config);
|
|
let rw = format_trait_alias(
|
|
&self.get_context(),
|
|
item.ident,
|
|
generics,
|
|
ty_param_bounds,
|
|
shape,
|
|
);
|
|
self.push_rewrite(item.span, rw);
|
|
}
|
|
ast::ItemKind::ExternCrate(_) => {
|
|
let rw = rewrite_extern_crate(&self.get_context(), item);
|
|
self.push_rewrite(item.span, rw);
|
|
}
|
|
ast::ItemKind::Struct(..) | ast::ItemKind::Union(..) => {
|
|
self.visit_struct(&StructParts::from_item(item));
|
|
}
|
|
ast::ItemKind::Enum(ref def, ref generics) => {
|
|
self.format_missing_with_indent(source!(self, item.span).lo());
|
|
self.visit_enum(item.ident, &item.vis, def, generics, item.span);
|
|
self.last_pos = source!(self, item.span).hi();
|
|
}
|
|
ast::ItemKind::Mod(ref module) => {
|
|
let is_inline = !is_mod_decl(item);
|
|
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) => {
|
|
self.visit_mac(mac, Some(item.ident), MacroPosition::Item);
|
|
}
|
|
ast::ItemKind::ForeignMod(ref foreign_mod) => {
|
|
self.format_missing_with_indent(source!(self, item.span).lo());
|
|
self.format_foreign_mod(foreign_mod, item.span);
|
|
}
|
|
ast::ItemKind::Static(..) | ast::ItemKind::Const(..) => {
|
|
self.visit_static(&StaticParts::from_item(item));
|
|
}
|
|
ast::ItemKind::Fn(ref decl, unsafety, constness, abi, ref generics, ref body) => {
|
|
self.visit_fn(
|
|
visit::FnKind::ItemFn(item.ident, unsafety, constness, abi, &item.vis, body),
|
|
generics,
|
|
decl,
|
|
item.span,
|
|
ast::Defaultness::Final,
|
|
Some(&item.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,
|
|
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);
|
|
}
|
|
ast::ItemKind::MacroDef(ref def) => {
|
|
let rewrite = rewrite_macro_def(
|
|
&self.get_context(),
|
|
self.block_indent,
|
|
def,
|
|
item.ident,
|
|
&item.vis,
|
|
item.span,
|
|
);
|
|
self.push_rewrite(item.span, rewrite);
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn visit_trait_item(&mut self, ti: &ast::TraitItem) {
|
|
skip_out_of_file_lines_range_visitor!(self, ti.span);
|
|
|
|
if self.visit_attrs(&ti.attrs, ast::AttrStyle::Outer) {
|
|
self.push_skipped_with_span(ti.span());
|
|
return;
|
|
}
|
|
|
|
match ti.node {
|
|
ast::TraitItemKind::Const(..) => self.visit_static(&StaticParts::from_trait_item(ti)),
|
|
ast::TraitItemKind::Method(ref sig, None) => {
|
|
let indent = self.block_indent;
|
|
let rewrite =
|
|
self.rewrite_required_fn(indent, ti.ident, sig, &ti.generics, ti.span);
|
|
self.push_rewrite(ti.span, rewrite);
|
|
}
|
|
ast::TraitItemKind::Method(ref sig, Some(ref body)) => {
|
|
self.visit_fn(
|
|
visit::FnKind::Method(ti.ident, sig, None, body),
|
|
&ti.generics,
|
|
&sig.decl,
|
|
ti.span,
|
|
ast::Defaultness::Final,
|
|
Some(&ti.attrs),
|
|
);
|
|
}
|
|
ast::TraitItemKind::Type(ref type_param_bounds, ref type_default) => {
|
|
let rewrite = rewrite_associated_type(
|
|
ti.ident,
|
|
type_default.as_ref(),
|
|
Some(type_param_bounds),
|
|
&self.get_context(),
|
|
self.block_indent,
|
|
);
|
|
self.push_rewrite(ti.span, rewrite);
|
|
}
|
|
ast::TraitItemKind::Macro(ref mac) => {
|
|
self.visit_mac(mac, Some(ti.ident), MacroPosition::Item);
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn visit_impl_item(&mut self, ii: &ast::ImplItem) {
|
|
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.span());
|
|
return;
|
|
}
|
|
|
|
match ii.node {
|
|
ast::ImplItemKind::Method(ref sig, ref body) => {
|
|
self.visit_fn(
|
|
visit::FnKind::Method(ii.ident, sig, Some(&ii.vis), body),
|
|
&ii.generics,
|
|
&sig.decl,
|
|
ii.span,
|
|
ii.defaultness,
|
|
Some(&ii.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),
|
|
None,
|
|
&self.get_context(),
|
|
self.block_indent,
|
|
);
|
|
self.push_rewrite(ii.span, rewrite);
|
|
}
|
|
ast::ImplItemKind::Macro(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);
|
|
|
|
// 1 = ;
|
|
let shape = self.shape().sub_width(1).unwrap();
|
|
let rewrite = rewrite_macro(mac, ident, &self.get_context(), shape, pos);
|
|
self.push_rewrite(mac.span, rewrite);
|
|
}
|
|
|
|
pub fn push_str(&mut self, s: &str) {
|
|
self.line_number += count_newlines(s);
|
|
self.buffer.push_str(s);
|
|
}
|
|
|
|
fn push_rewrite_inner(&mut self, span: Span, rewrite: Option<String>) {
|
|
if let Some(ref s) = rewrite {
|
|
self.push_str(s);
|
|
} else {
|
|
let snippet = self.snippet(span);
|
|
self.push_str(snippet);
|
|
}
|
|
self.last_pos = source!(self, span).hi();
|
|
}
|
|
|
|
pub fn push_rewrite(&mut self, span: Span, rewrite: Option<String>) {
|
|
self.format_missing_with_indent(source!(self, span).lo());
|
|
self.push_rewrite_inner(span, rewrite);
|
|
}
|
|
|
|
pub fn push_skipped_with_span(&mut self, span: Span) {
|
|
self.format_missing_with_indent(source!(self, span).lo());
|
|
let lo = self.line_number + 1;
|
|
self.push_rewrite_inner(span, None);
|
|
let hi = self.line_number + 1;
|
|
self.skipped_range.push((lo, hi));
|
|
}
|
|
|
|
pub fn from_context(ctx: &'a RewriteContext) -> FmtVisitor<'a> {
|
|
FmtVisitor::from_codemap(ctx.parse_session, ctx.config, ctx.snippet_provider)
|
|
}
|
|
|
|
pub fn from_codemap(
|
|
parse_session: &'a ParseSess,
|
|
config: &'a Config,
|
|
snippet_provider: &'a SnippetProvider,
|
|
) -> FmtVisitor<'a> {
|
|
FmtVisitor {
|
|
parse_session,
|
|
codemap: parse_session.codemap(),
|
|
buffer: String::with_capacity(snippet_provider.big_snippet.len() * 2),
|
|
last_pos: BytePos(0),
|
|
block_indent: Indent::empty(),
|
|
config,
|
|
is_if_else_block: false,
|
|
snippet_provider,
|
|
line_number: 0,
|
|
skipped_range: vec![],
|
|
}
|
|
}
|
|
|
|
pub fn opt_snippet(&'b self, span: Span) -> Option<&'a str> {
|
|
self.snippet_provider.span_to_snippet(span)
|
|
}
|
|
|
|
pub fn snippet(&'b self, span: Span) -> &'a str {
|
|
self.opt_snippet(span).unwrap()
|
|
}
|
|
|
|
// Returns true if we should skip the following item.
|
|
pub fn visit_attrs(&mut self, attrs: &[ast::Attribute], style: ast::AttrStyle) -> bool {
|
|
if contains_skip(attrs) {
|
|
return true;
|
|
}
|
|
|
|
let attrs: Vec<_> = attrs.iter().filter(|a| a.style == style).cloned().collect();
|
|
if attrs.is_empty() {
|
|
return false;
|
|
}
|
|
|
|
let rewrite = attrs.rewrite(&self.get_context(), self.shape());
|
|
let span = mk_sp(attrs[0].span.lo(), attrs[attrs.len() - 1].span.hi());
|
|
self.push_rewrite(span, rewrite);
|
|
|
|
false
|
|
}
|
|
|
|
fn reorder_items<F>(&mut self, items_left: &[&ast::Item], is_item: &F, in_group: bool) -> usize
|
|
where
|
|
F: Fn(&ast::Item) -> bool,
|
|
{
|
|
let mut last = self.codemap.lookup_line_range(items_left[0].span());
|
|
let item_length = items_left
|
|
.iter()
|
|
.take_while(|ppi| {
|
|
is_item(&***ppi) && (!in_group || {
|
|
let current = self.codemap.lookup_line_range(ppi.span());
|
|
let in_same_group = current.lo < last.hi + 2;
|
|
last = current;
|
|
in_same_group
|
|
})
|
|
})
|
|
.count();
|
|
let items = &items_left[..item_length];
|
|
|
|
let at_least_one_in_file_lines = items
|
|
.iter()
|
|
.any(|item| !out_of_file_lines_range!(self, item.span));
|
|
|
|
if at_least_one_in_file_lines {
|
|
self.format_imports(items);
|
|
} else {
|
|
for item in items {
|
|
self.push_rewrite(item.span, None);
|
|
}
|
|
}
|
|
|
|
item_length
|
|
}
|
|
|
|
fn walk_items(&mut self, mut items_left: &[&ast::Item]) {
|
|
macro try_reorder_items_with($reorder: ident, $in_group: ident, $pred: ident) {
|
|
if self.config.$reorder() && $pred(&*items_left[0]) {
|
|
let used_items_len =
|
|
self.reorder_items(items_left, &$pred, self.config.$in_group());
|
|
let (_, rest) = items_left.split_at(used_items_len);
|
|
items_left = rest;
|
|
continue;
|
|
}
|
|
}
|
|
|
|
while !items_left.is_empty() {
|
|
// If the next item is a `use`, `extern crate` or `mod`, then extract it and any
|
|
// subsequent items that have the same item kind to be reordered within
|
|
// `format_imports`. Otherwise, just format the next item for output.
|
|
{
|
|
try_reorder_items_with!(reorder_imports, reorder_imports_in_group, is_use_item);
|
|
try_reorder_items_with!(
|
|
reorder_extern_crates,
|
|
reorder_extern_crates_in_group,
|
|
is_extern_crate
|
|
);
|
|
try_reorder_items_with!(reorder_modules, reorder_modules, is_mod_decl_without_attr);
|
|
}
|
|
// Reaching here means items were not reordered. There must be at least
|
|
// one item left in `items_left`, so calling `unwrap()` here is safe.
|
|
let (item, rest) = items_left.split_first().unwrap();
|
|
self.visit_item(item);
|
|
items_left = rest;
|
|
}
|
|
}
|
|
|
|
fn walk_mod_items(&mut self, m: &ast::Mod) {
|
|
self.walk_items(&ptr_vec_to_ref_vec(&m.items));
|
|
}
|
|
|
|
fn walk_stmts(&mut self, stmts: &[ast::Stmt]) {
|
|
fn to_stmt_item(stmt: &ast::Stmt) -> Option<&ast::Item> {
|
|
match stmt.node {
|
|
ast::StmtKind::Item(ref item) => Some(&**item),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
if stmts.is_empty() {
|
|
return;
|
|
}
|
|
|
|
// Extract leading `use ...;`.
|
|
let items: Vec<_> = stmts
|
|
.iter()
|
|
.take_while(|stmt| to_stmt_item(stmt).map_or(false, is_use_item))
|
|
.filter_map(|stmt| to_stmt_item(stmt))
|
|
.collect();
|
|
|
|
if items.is_empty() {
|
|
self.visit_stmt(&stmts[0]);
|
|
self.walk_stmts(&stmts[1..]);
|
|
} else {
|
|
self.walk_items(&items);
|
|
self.walk_stmts(&stmts[items.len()..]);
|
|
}
|
|
}
|
|
|
|
fn walk_block_stmts(&mut self, b: &ast::Block) {
|
|
self.walk_stmts(&b.stmts)
|
|
}
|
|
|
|
fn format_mod(
|
|
&mut self,
|
|
m: &ast::Mod,
|
|
vis: &ast::Visibility,
|
|
s: Span,
|
|
ident: ast::Ident,
|
|
attrs: &[ast::Attribute],
|
|
is_internal: bool,
|
|
) {
|
|
self.push_str(&*utils::format_visibility(vis));
|
|
self.push_str("mod ");
|
|
self.push_str(&ident.to_string());
|
|
|
|
if is_internal {
|
|
match self.config.brace_style() {
|
|
BraceStyle::AlwaysNextLine => {
|
|
let sep_str = format!("\n{}{{", self.block_indent.to_string(self.config));
|
|
self.push_str(&sep_str);
|
|
}
|
|
_ => self.push_str(" {"),
|
|
}
|
|
// Hackery to account for the closing }.
|
|
let mod_lo = self.codemap.span_after(source!(self, s), "{");
|
|
let body_snippet =
|
|
self.snippet(mk_sp(mod_lo, source!(self, m.inner).hi() - BytePos(1)));
|
|
let body_snippet = body_snippet.trim();
|
|
if body_snippet.is_empty() {
|
|
self.push_str("}");
|
|
} else {
|
|
self.last_pos = mod_lo;
|
|
self.block_indent = self.block_indent.block_indent(self.config);
|
|
self.visit_attrs(attrs, ast::AttrStyle::Inner);
|
|
self.walk_mod_items(m);
|
|
self.format_missing_with_indent(source!(self, m.inner).hi() - BytePos(1));
|
|
self.close_block(false);
|
|
}
|
|
self.last_pos = source!(self, m.inner).hi();
|
|
} else {
|
|
self.push_str(";");
|
|
self.last_pos = source!(self, s).hi();
|
|
}
|
|
}
|
|
|
|
pub fn format_separate_mod(&mut self, m: &ast::Mod, filemap: &codemap::FileMap) {
|
|
self.block_indent = Indent::empty();
|
|
self.walk_mod_items(m);
|
|
self.format_missing_with_indent(filemap.end_pos);
|
|
}
|
|
|
|
pub fn skip_empty_lines(&mut self, end_pos: BytePos) {
|
|
while let Some(pos) = self.codemap
|
|
.opt_span_after(mk_sp(self.last_pos, end_pos), "\n")
|
|
{
|
|
if let Some(snippet) = self.opt_snippet(mk_sp(self.last_pos, pos)) {
|
|
if snippet.trim().is_empty() {
|
|
self.last_pos = pos;
|
|
} else {
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn get_context(&self) -> RewriteContext {
|
|
RewriteContext {
|
|
parse_session: self.parse_session,
|
|
codemap: self.codemap,
|
|
config: self.config,
|
|
inside_macro: false,
|
|
use_block: false,
|
|
is_if_else_block: false,
|
|
force_one_line_chain: false,
|
|
snippet_provider: self.snippet_provider,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Rewrite for ast::NestedMetaItem {
|
|
fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
|
|
match self.node {
|
|
ast::NestedMetaItemKind::MetaItem(ref meta_item) => meta_item.rewrite(context, shape),
|
|
ast::NestedMetaItemKind::Literal(ref l) => rewrite_literal(context, l, shape),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Rewrite for ast::MetaItem {
|
|
fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
|
|
Some(match self.node {
|
|
ast::MetaItemKind::Word => String::from(&*self.name.as_str()),
|
|
ast::MetaItemKind::List(ref list) => {
|
|
let name = self.name.as_str();
|
|
// 1 = `(`, 2 = `]` and `)`
|
|
let item_shape = shape
|
|
.visual_indent(0)
|
|
.shrink_left(name.len() + 1)
|
|
.and_then(|s| s.sub_width(2))?;
|
|
let items = itemize_list(
|
|
context.codemap,
|
|
list.iter(),
|
|
")",
|
|
",",
|
|
|nested_meta_item| nested_meta_item.span.lo(),
|
|
|nested_meta_item| nested_meta_item.span.hi(),
|
|
|nested_meta_item| nested_meta_item.rewrite(context, item_shape),
|
|
self.span.lo(),
|
|
self.span.hi(),
|
|
false,
|
|
);
|
|
let item_vec = items.collect::<Vec<_>>();
|
|
let fmt = ListFormatting {
|
|
tactic: DefinitiveListTactic::Mixed,
|
|
separator: ",",
|
|
trailing_separator: SeparatorTactic::Never,
|
|
separator_place: SeparatorPlace::Back,
|
|
shape: item_shape,
|
|
ends_with_newline: false,
|
|
preserve_newline: false,
|
|
config: context.config,
|
|
};
|
|
format!("{}({})", name, write_list(&item_vec, &fmt)?)
|
|
}
|
|
ast::MetaItemKind::NameValue(ref literal) => {
|
|
let name = self.name.as_str();
|
|
// 3 = ` = `
|
|
let lit_shape = shape.shrink_left(name.len() + 3)?;
|
|
let value = rewrite_literal(context, literal, lit_shape)?;
|
|
format!("{} = {}", name, value)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
impl Rewrite for ast::Attribute {
|
|
fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
|
|
let prefix = match self.style {
|
|
ast::AttrStyle::Inner => "#!",
|
|
ast::AttrStyle::Outer => "#",
|
|
};
|
|
let snippet = context.snippet(self.span);
|
|
if self.is_sugared_doc {
|
|
let doc_shape = Shape {
|
|
width: cmp::min(shape.width, context.config.comment_width())
|
|
.checked_sub(shape.indent.width())
|
|
.unwrap_or(0),
|
|
..shape
|
|
};
|
|
rewrite_comment(snippet, false, doc_shape, context.config)
|
|
} else {
|
|
if contains_comment(snippet) {
|
|
return Some(snippet.to_owned());
|
|
}
|
|
// 1 = `[`
|
|
let shape = shape.offset_left(prefix.len() + 1)?;
|
|
self.meta()?
|
|
.rewrite(context, shape)
|
|
.map(|rw| format!("{}[{}]", prefix, rw))
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Returns the first group of attributes that fills the given predicate.
|
|
/// We consider two doc comments are in different group if they are separated by normal comments.
|
|
fn take_while_with_pred<'a, P>(
|
|
context: &RewriteContext,
|
|
attrs: &'a [ast::Attribute],
|
|
pred: P,
|
|
) -> &'a [ast::Attribute]
|
|
where
|
|
P: Fn(&ast::Attribute) -> bool,
|
|
{
|
|
let mut last_index = 0;
|
|
let mut iter = attrs.iter().enumerate().peekable();
|
|
while let Some((i, attr)) = iter.next() {
|
|
if !pred(attr) {
|
|
break;
|
|
}
|
|
if let Some(&(_, next_attr)) = iter.peek() {
|
|
// Extract comments between two attributes.
|
|
let span_between_attr = mk_sp(attr.span.hi(), next_attr.span.lo());
|
|
let snippet = context.snippet(span_between_attr);
|
|
if count_newlines(snippet) >= 2 || snippet.contains('/') {
|
|
break;
|
|
}
|
|
}
|
|
last_index = i;
|
|
}
|
|
if last_index == 0 {
|
|
&[]
|
|
} else {
|
|
&attrs[..last_index + 1]
|
|
}
|
|
}
|
|
|
|
fn rewrite_first_group_attrs(
|
|
context: &RewriteContext,
|
|
attrs: &[ast::Attribute],
|
|
shape: Shape,
|
|
) -> Option<(usize, String)> {
|
|
if attrs.is_empty() {
|
|
return Some((0, String::new()));
|
|
}
|
|
// Rewrite doc comments
|
|
let sugared_docs = take_while_with_pred(context, attrs, |a| a.is_sugared_doc);
|
|
if !sugared_docs.is_empty() {
|
|
let snippet = sugared_docs
|
|
.iter()
|
|
.map(|a| context.snippet(a.span))
|
|
.collect::<Vec<_>>()
|
|
.join("\n");
|
|
return Some((
|
|
sugared_docs.len(),
|
|
rewrite_comment(&snippet, false, shape, context.config)?,
|
|
));
|
|
}
|
|
// Rewrite `#[derive(..)]`s.
|
|
if context.config.merge_derives() {
|
|
let derives = take_while_with_pred(context, attrs, is_derive);
|
|
if !derives.is_empty() {
|
|
let mut derive_args = vec![];
|
|
for derive in derives {
|
|
derive_args.append(&mut get_derive_args(context, derive)?);
|
|
}
|
|
return Some((derives.len(), format_derive(context, &derive_args, shape)?));
|
|
}
|
|
}
|
|
// Rewrite the first attribute.
|
|
Some((1, attrs[0].rewrite(context, shape)?))
|
|
}
|
|
|
|
fn has_newlines_before_after_comment(comment: &str) -> (&str, &str) {
|
|
// Look at before and after comment and see if there are any empty lines.
|
|
let comment_begin = comment.chars().position(|c| c == '/');
|
|
let len = comment_begin.unwrap_or_else(|| comment.len());
|
|
let mlb = count_newlines(&comment[..len]) > 1;
|
|
let mla = if comment_begin.is_none() {
|
|
mlb
|
|
} else {
|
|
let comment_end = comment.chars().rev().position(|c| !c.is_whitespace());
|
|
let len = comment_end.unwrap();
|
|
comment
|
|
.chars()
|
|
.rev()
|
|
.take(len)
|
|
.filter(|c| *c == '\n')
|
|
.count() > 1
|
|
};
|
|
(if mlb { "\n" } else { "" }, if mla { "\n" } else { "" })
|
|
}
|
|
|
|
impl<'a> Rewrite for [ast::Attribute] {
|
|
fn rewrite(&self, context: &RewriteContext, shape: Shape) -> Option<String> {
|
|
if self.is_empty() {
|
|
return Some(String::new());
|
|
}
|
|
let (first_group_len, first_group_str) = rewrite_first_group_attrs(context, self, shape)?;
|
|
if self.len() == 1 || first_group_len == self.len() {
|
|
Some(first_group_str)
|
|
} else {
|
|
let rest_str = self[first_group_len..].rewrite(context, shape)?;
|
|
let missing_span = mk_sp(
|
|
self[first_group_len - 1].span.hi(),
|
|
self[first_group_len].span.lo(),
|
|
);
|
|
// Preserve an empty line before/after doc comments.
|
|
if self[0].is_sugared_doc || self[first_group_len].is_sugared_doc {
|
|
let snippet = context.snippet(missing_span);
|
|
let (mla, mlb) = has_newlines_before_after_comment(snippet);
|
|
let comment = ::comment::recover_missing_comment_in_span(
|
|
missing_span,
|
|
shape.with_max_width(context.config),
|
|
context,
|
|
0,
|
|
)?;
|
|
let comment = if comment.is_empty() {
|
|
format!("\n{}", mlb)
|
|
} else {
|
|
format!("{}{}\n{}", mla, comment, mlb)
|
|
};
|
|
Some(format!(
|
|
"{}{}{}{}",
|
|
first_group_str,
|
|
comment,
|
|
shape.indent.to_string(context.config),
|
|
rest_str
|
|
))
|
|
} else {
|
|
combine_strs_with_missing_comments(
|
|
context,
|
|
&first_group_str,
|
|
&rest_str,
|
|
missing_span,
|
|
shape,
|
|
false,
|
|
)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Format `#[derive(..)]`, using visual indent & mixed style when we need to go multiline.
|
|
fn format_derive(context: &RewriteContext, derive_args: &[&str], shape: Shape) -> Option<String> {
|
|
let mut result = String::with_capacity(128);
|
|
result.push_str("#[derive(");
|
|
// 11 = `#[derive()]`
|
|
let initial_budget = shape.width.checked_sub(11)?;
|
|
let mut budget = initial_budget;
|
|
let num = derive_args.len();
|
|
for (i, a) in derive_args.iter().enumerate() {
|
|
// 2 = `, ` or `)]`
|
|
let width = a.len() + 2;
|
|
if width > budget {
|
|
if i > 0 {
|
|
// Remove trailing whitespace.
|
|
result.pop();
|
|
}
|
|
result.push('\n');
|
|
// 9 = `#[derive(`
|
|
result.push_str(&(shape.indent + 9).to_string(context.config));
|
|
budget = initial_budget;
|
|
} else {
|
|
budget = budget.checked_sub(width).unwrap_or(0);
|
|
}
|
|
result.push_str(a);
|
|
if i != num - 1 {
|
|
result.push_str(", ")
|
|
}
|
|
}
|
|
result.push_str(")]");
|
|
Some(result)
|
|
}
|
|
|
|
fn is_derive(attr: &ast::Attribute) -> bool {
|
|
attr.check_name("derive")
|
|
}
|
|
|
|
/// Returns the arguments of `#[derive(...)]`.
|
|
fn get_derive_args<'a>(context: &'a RewriteContext, attr: &ast::Attribute) -> Option<Vec<&'a str>> {
|
|
attr.meta_item_list().map(|meta_item_list| {
|
|
meta_item_list
|
|
.iter()
|
|
.map(|nested_meta_item| context.snippet(nested_meta_item.span))
|
|
.collect()
|
|
})
|
|
}
|
|
|
|
// Rewrite `extern crate foo;` WITHOUT attributes.
|
|
pub fn rewrite_extern_crate(context: &RewriteContext, item: &ast::Item) -> Option<String> {
|
|
assert!(is_extern_crate(item));
|
|
let new_str = context.snippet(item.span);
|
|
Some(if contains_comment(new_str) {
|
|
new_str.to_owned()
|
|
} else {
|
|
let no_whitespace = &new_str.split_whitespace().collect::<Vec<&str>>().join(" ");
|
|
String::from(&*Regex::new(r"\s;").unwrap().replace(no_whitespace, ";"))
|
|
})
|
|
}
|
|
|
|
fn get_attrs_from_stmt(stmt: &ast::Stmt) -> &[ast::Attribute] {
|
|
match stmt.node {
|
|
ast::StmtKind::Local(ref local) => &local.attrs,
|
|
ast::StmtKind::Item(ref item) => &item.attrs,
|
|
ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => &expr.attrs,
|
|
ast::StmtKind::Mac(ref mac) => &mac.2,
|
|
}
|
|
}
|