-// Copyright 2018 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.
-
//! Reorder items.
//!
-//! `mod`, `extern crate` and `use` declarations are reorderd in alphabetical
+//! `mod`, `extern crate` and `use` declarations are reordered in alphabetical
//! order. Trait items are reordered in pre-determined order (associated types
//! and constants comes before methods).
-// TODO(#2455): Reorder trait items.
+// FIXME(#2455): Reorder trait items.
-use config::{lists::*, Config};
-use syntax::{ast, attr, codemap::Span};
+use std::cmp::{Ord, Ordering};
-use attr::filter_inline_attrs;
-use codemap::LineRangeUtils;
-use comment::combine_strs_with_missing_comments;
-use imports::UseTree;
-use items::{is_mod_decl, rewrite_extern_crate, rewrite_mod};
-use lists::{itemize_list, write_list, ListFormatting, ListItem};
-use rewrite::{Rewrite, RewriteContext};
-use shape::Shape;
-use spanned::Spanned;
-use utils::mk_sp;
-use visitor::FmtVisitor;
+use rustc_ast::ast;
+use rustc_span::{symbol::sym, Span};
-use std::cmp::{Ord, Ordering};
+use crate::config::{Config, GroupImportsTactic, ImportGranularity};
+use crate::imports::{flatten_use_trees, merge_use_trees, SharedPrefix, UseSegment, UseTree};
+use crate::items::{is_mod_decl, rewrite_extern_crate, rewrite_mod};
+use crate::lists::{itemize_list, write_list, ListFormatting, ListItem};
+use crate::rewrite::RewriteContext;
+use crate::shape::Shape;
+use crate::source_map::LineRangeUtils;
+use crate::spanned::Spanned;
+use crate::utils::{contains_skip, mk_sp};
+use crate::visitor::FmtVisitor;
/// Choose the ordering between the given two items.
fn compare_items(a: &ast::Item, b: &ast::Item) -> Ordering {
- match (&a.node, &b.node) {
+ match (&a.kind, &b.kind) {
(&ast::ItemKind::Mod(..), &ast::ItemKind::Mod(..)) => {
- a.ident.name.as_str().cmp(&b.ident.name.as_str())
+ a.ident.as_str().cmp(&b.ident.as_str())
}
(&ast::ItemKind::ExternCrate(ref a_name), &ast::ItemKind::ExternCrate(ref b_name)) => {
// `extern crate foo as bar;`
// ^^^ Comparing this.
- let a_orig_name =
- a_name.map_or_else(|| a.ident.name.as_str(), |symbol| symbol.as_str());
- let b_orig_name =
- b_name.map_or_else(|| b.ident.name.as_str(), |symbol| symbol.as_str());
+ let a_orig_name = a_name.map_or_else(|| a.ident.as_str(), rustc_span::Symbol::as_str);
+ let b_orig_name = b_name.map_or_else(|| b.ident.as_str(), rustc_span::Symbol::as_str);
let result = a_orig_name.cmp(&b_orig_name);
if result != Ordering::Equal {
return result;
(Some(..), None) => Ordering::Greater,
(None, Some(..)) => Ordering::Less,
(None, None) => Ordering::Equal,
- (Some(..), Some(..)) => a.ident.name.as_str().cmp(&b.ident.name.as_str()),
+ (Some(..), Some(..)) => a.ident.as_str().cmp(&b.ident.as_str()),
}
}
_ => unreachable!(),
}
fn wrap_reorderable_items(
- context: &RewriteContext,
+ context: &RewriteContext<'_>,
list_items: &[ListItem],
shape: Shape,
) -> Option<String> {
- let fmt = ListFormatting {
- tactic: DefinitiveListTactic::Vertical,
- separator: "",
- trailing_separator: SeparatorTactic::Never,
- separator_place: SeparatorPlace::Back,
- shape,
- ends_with_newline: true,
- preserve_newline: false,
- config: context.config,
- };
-
+ let fmt = ListFormatting::new(shape, context.config)
+ .separator("")
+ .align_comments(false);
write_list(list_items, &fmt)
}
fn rewrite_reorderable_item(
- context: &RewriteContext,
+ context: &RewriteContext<'_>,
item: &ast::Item,
shape: Shape,
) -> Option<String> {
- let attrs = filter_inline_attrs(&item.attrs, item.span());
- let attrs_str = attrs.rewrite(context, shape)?;
-
- let missed_span = if attrs.is_empty() {
- mk_sp(item.span.lo(), item.span.lo())
- } else {
- mk_sp(attrs.last().unwrap().span.hi(), item.span.lo())
- };
-
- let item_str = match item.node {
- ast::ItemKind::ExternCrate(..) => rewrite_extern_crate(context, item)?,
- ast::ItemKind::Mod(..) => rewrite_mod(item),
- _ => return None,
- };
-
- combine_strs_with_missing_comments(context, &attrs_str, &item_str, missed_span, shape, false)
+ match item.kind {
+ ast::ItemKind::ExternCrate(..) => rewrite_extern_crate(context, item, shape),
+ ast::ItemKind::Mod(..) => rewrite_mod(context, item, shape),
+ _ => None,
+ }
}
-/// Rewrite a list of items with reordering. Every item in `items` must have
-/// the same `ast::ItemKind`.
-fn rewrite_reorderable_items(
- context: &RewriteContext,
+/// Rewrite a list of items with reordering and/or regrouping. Every item
+/// in `items` must have the same `ast::ItemKind`. Whether reordering, regrouping,
+/// or both are done is determined from the `context`.
+fn rewrite_reorderable_or_regroupable_items(
+ context: &RewriteContext<'_>,
reorderable_items: &[&ast::Item],
shape: Shape,
span: Span,
) -> Option<String> {
- match reorderable_items[0].node {
+ match reorderable_items[0].kind {
// FIXME: Remove duplicated code.
ast::ItemKind::Use(..) => {
- let normalized_items: Vec<_> = reorderable_items
+ let mut normalized_items: Vec<_> = reorderable_items
.iter()
.filter_map(|item| UseTree::from_ast_with_normalization(context, item))
.collect();
-
- // 4 = "use ", 1 = ";"
- let nested_shape = shape.offset_left(4)?.sub_width(1)?;
+ let cloned = normalized_items.clone();
+ // Add comments before merging.
let list_items = itemize_list(
context.snippet_provider,
- normalized_items.iter(),
+ cloned.iter(),
"",
";",
- |item| item.span.lo(),
- |item| item.span.hi(),
- |item| item.rewrite_top_level(context, nested_shape),
+ |item| item.span().lo(),
+ |item| item.span().hi(),
+ |_item| Some("".to_owned()),
span.lo(),
span.hi(),
false,
);
+ for (item, list_item) in normalized_items.iter_mut().zip(list_items) {
+ item.list_item = Some(list_item.clone());
+ }
+ normalized_items = match context.config.imports_granularity() {
+ ImportGranularity::Crate => merge_use_trees(normalized_items, SharedPrefix::Crate),
+ ImportGranularity::Module => {
+ merge_use_trees(normalized_items, SharedPrefix::Module)
+ }
+ ImportGranularity::Item => flatten_use_trees(normalized_items),
+ ImportGranularity::Preserve => normalized_items,
+ };
- let mut item_pair_vec: Vec<_> = list_items.zip(&normalized_items).collect();
- item_pair_vec.sort_by(|a, b| a.1.cmp(b.1));
- let item_vec: Vec<_> = item_pair_vec.into_iter().map(|pair| pair.0).collect();
+ let mut regrouped_items = match context.config.group_imports() {
+ GroupImportsTactic::Preserve => vec![normalized_items],
+ GroupImportsTactic::StdExternalCrate => group_imports(normalized_items),
+ };
+
+ if context.config.reorder_imports() {
+ regrouped_items.iter_mut().for_each(|items| items.sort())
+ }
- wrap_reorderable_items(context, &item_vec, nested_shape)
+ // 4 = "use ", 1 = ";"
+ let nested_shape = shape.offset_left(4)?.sub_width(1)?;
+ let item_vec: Vec<_> = regrouped_items
+ .into_iter()
+ .filter(|use_group| !use_group.is_empty())
+ .map(|use_group| {
+ let item_vec: Vec<_> = use_group
+ .into_iter()
+ .map(|use_tree| ListItem {
+ item: use_tree.rewrite_top_level(context, nested_shape),
+ ..use_tree.list_item.unwrap_or_else(ListItem::empty)
+ })
+ .collect();
+ wrap_reorderable_items(context, &item_vec, nested_shape)
+ })
+ .collect::<Option<Vec<_>>>()?;
+
+ let join_string = format!("\n\n{}", shape.indent.to_string(context.config));
+ Some(item_vec.join(&join_string))
}
_ => {
let list_items = itemize_list(
}
fn contains_macro_use_attr(item: &ast::Item) -> bool {
- attr::contains_name(&filter_inline_attrs(&item.attrs, item.span()), "macro_use")
+ crate::attr::contains_name(&item.attrs, sym::macro_use)
+}
+
+/// Divides imports into three groups, corresponding to standard, external
+/// and local imports. Sorts each subgroup.
+fn group_imports(uts: Vec<UseTree>) -> Vec<Vec<UseTree>> {
+ let mut std_imports = Vec::new();
+ let mut external_imports = Vec::new();
+ let mut local_imports = Vec::new();
+
+ for ut in uts.into_iter() {
+ if ut.path.is_empty() {
+ external_imports.push(ut);
+ continue;
+ }
+ match &ut.path[0] {
+ UseSegment::Ident(id, _) => match id.as_ref() {
+ "std" | "alloc" | "core" => std_imports.push(ut),
+ _ => external_imports.push(ut),
+ },
+ UseSegment::Slf(_) | UseSegment::Super(_) | UseSegment::Crate(_) => {
+ local_imports.push(ut)
+ }
+ // These are probably illegal here
+ UseSegment::Glob | UseSegment::List(_) => external_imports.push(ut),
+ }
+ }
+
+ vec![std_imports, external_imports, local_imports]
}
/// A simplified version of `ast::ItemKind`.
}
impl ReorderableItemKind {
- pub fn from(item: &ast::Item) -> Self {
- match item.node {
- _ if contains_macro_use_attr(item) => ReorderableItemKind::Other,
+ fn from(item: &ast::Item) -> Self {
+ match item.kind {
+ _ if contains_macro_use_attr(item) | contains_skip(&item.attrs) => {
+ ReorderableItemKind::Other
+ }
ast::ItemKind::ExternCrate(..) => ReorderableItemKind::ExternCrate,
ast::ItemKind::Mod(..) if is_mod_decl(item) => ReorderableItemKind::Mod,
ast::ItemKind::Use(..) => ReorderableItemKind::Use,
}
}
- pub fn is_same_item_kind(&self, item: &ast::Item) -> bool {
- ReorderableItemKind::from(item) == *self
+ fn is_same_item_kind(self, item: &ast::Item) -> bool {
+ ReorderableItemKind::from(item) == self
}
- pub fn is_reorderable(&self, config: &Config) -> bool {
- match *self {
+ fn is_reorderable(self, config: &Config) -> bool {
+ match self {
ReorderableItemKind::ExternCrate => config.reorder_imports(),
ReorderableItemKind::Mod => config.reorder_modules(),
ReorderableItemKind::Use => config.reorder_imports(),
}
}
- pub fn in_group(&self) -> bool {
- match *self {
- ReorderableItemKind::ExternCrate => false,
- ReorderableItemKind::Mod => true,
- ReorderableItemKind::Use => true,
+ fn is_regroupable(self, config: &Config) -> bool {
+ match self {
+ ReorderableItemKind::ExternCrate
+ | ReorderableItemKind::Mod
+ | ReorderableItemKind::Other => false,
+ ReorderableItemKind::Use => config.group_imports() != GroupImportsTactic::Preserve,
+ }
+ }
+
+ fn in_group(self, config: &Config) -> bool {
+ match self {
+ ReorderableItemKind::ExternCrate | ReorderableItemKind::Mod => true,
+ ReorderableItemKind::Use => config.group_imports() == GroupImportsTactic::Preserve,
ReorderableItemKind::Other => false,
}
}
}
impl<'b, 'a: 'b> FmtVisitor<'a> {
- /// Format items with the same item kind and reorder them. If `in_group` is
- /// `true`, then the items separated by an empty line will not be reordered
- /// together.
- fn walk_reorderable_items(
+ /// Format items with the same item kind and reorder them, regroup them, or
+ /// both. If `in_group` is `true`, then the items separated by an empty line
+ /// will not be reordered together.
+ fn walk_reorderable_or_regroupable_items(
&mut self,
items: &[&ast::Item],
item_kind: ReorderableItemKind,
in_group: bool,
) -> usize {
- let mut last = self.codemap.lookup_line_range(items[0].span());
+ let mut last = self.parse_sess.lookup_line_range(items[0].span());
let item_length = items
.iter()
.take_while(|ppi| {
- item_kind.is_same_item_kind(&***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
- })
+ item_kind.is_same_item_kind(&***ppi)
+ && (!in_group || {
+ let current = self.parse_sess.lookup_line_range(ppi.span());
+ let in_same_group = current.lo < last.hi + 2;
+ last = current;
+ in_same_group
+ })
})
.count();
let items = &items[..item_length];
let lo = items.first().unwrap().span().lo();
let hi = items.last().unwrap().span().hi();
let span = mk_sp(lo, hi);
- let rw = rewrite_reorderable_items(&self.get_context(), items, self.shape(), span);
+ let rw = rewrite_reorderable_or_regroupable_items(
+ &self.get_context(),
+ items,
+ self.shape(),
+ span,
+ );
self.push_rewrite(span, rw);
} else {
for item in items {
item_length
}
- /// Visit and format the given items. Items are reordered If they are
+ /// Visits and format the given items. Items are reordered If they are
/// consecutive and reorderable.
- pub fn visit_items_with_reordering(&mut self, mut items: &[&ast::Item]) {
+ pub(crate) fn visit_items_with_reordering(&mut self, mut items: &[&ast::Item]) {
while !items.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
// `walk_reorderable_items`. Otherwise, just format the next item for output.
let item_kind = ReorderableItemKind::from(items[0]);
- if item_kind.is_reorderable(self.config) {
- let visited_items_num =
- self.walk_reorderable_items(items, item_kind, item_kind.in_group());
+ if item_kind.is_reorderable(self.config) || item_kind.is_regroupable(self.config) {
+ let visited_items_num = self.walk_reorderable_or_regroupable_items(
+ items,
+ item_kind,
+ item_kind.in_group(self.config),
+ );
let (_, rest) = items.split_at(visited_items_num);
items = rest;
} else {
projects / rust.git / blobdiff