]> git.lizzy.rs Git - rust.git/blobdiff - src/reorder.rs
Use `AttrVec` for `Arm`, `FieldDef`, and `Variant`
[rust.git] / src / reorder.rs
index 5595fa5b237ba6373575dc9c577daa55502fc6e2..ac65ff2c1086e853edfd5e10ac355fe93631657c 100644 (file)
@@ -1,61 +1,38 @@
-// 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 constatns comes before methods).
-
-// TODO(#2455): Reorder trait items.
+//! and constants comes before methods).
 
-use config::{Config, lists::*};
-use syntax::ast::UseTreeKind;
-use syntax::{ast, attr, codemap::Span};
+// FIXME(#2455): Reorder trait items.
 
-use attr::filter_inline_attrs;
-use codemap::LineRangeUtils;
-use comment::combine_strs_with_missing_comments;
-use imports::{path_to_imported_ident, rewrite_import};
-use items::{is_mod_decl, rewrite_extern_crate, rewrite_mod};
-use lists::{itemize_list, write_list, ListFormatting};
-use rewrite::{Rewrite, RewriteContext};
-use shape::Shape;
-use spanned::Spanned;
-use utils::mk_sp;
-use visitor::FmtVisitor;
+use std::cmp::{Ord, Ordering};
 
-use std::cmp::{Ord, Ordering, PartialOrd};
+use rustc_ast::ast;
+use rustc_span::{symbol::sym, Span};
 
-fn compare_use_trees(a: &ast::UseTree, b: &ast::UseTree) -> Ordering {
-    let aa = UseTree::from_ast(a).normalize();
-    let bb = UseTree::from_ast(b).normalize();
-    aa.cmp(&bb)
-}
+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())
-        }
-        (&ast::ItemKind::Use(ref a_tree), &ast::ItemKind::Use(ref b_tree)) => {
-            compare_use_trees(a_tree, b_tree)
+            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;
@@ -67,81 +44,160 @@ fn compare_items(a: &ast::Item, b: &ast::Item) -> Ordering {
                 (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!(),
     }
 }
 
-/// Rewrite a list of items with reordering. Every item in `items` must have
-/// the same `ast::ItemKind`.
-fn rewrite_reorderable_items(
-    context: &RewriteContext,
+fn wrap_reorderable_items(
+    context: &RewriteContext<'_>,
+    list_items: &[ListItem],
+    shape: Shape,
+) -> Option<String> {
+    let fmt = ListFormatting::new(shape, context.config)
+        .separator("")
+        .align_comments(false);
+    write_list(list_items, &fmt)
+}
+
+fn rewrite_reorderable_item(
+    context: &RewriteContext<'_>,
+    item: &ast::Item,
+    shape: Shape,
+) -> Option<String> {
+    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 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> {
-    let items = itemize_list(
-        context.snippet_provider,
-        reorderable_items.iter(),
-        "",
-        ";",
-        |item| item.span().lo(),
-        |item| item.span().hi(),
-        |item| {
-            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())
+    match reorderable_items[0].kind {
+        // FIXME: Remove duplicated code.
+        ast::ItemKind::Use(..) => {
+            let mut normalized_items: Vec<_> = reorderable_items
+                .iter()
+                .filter_map(|item| UseTree::from_ast_with_normalization(context, item))
+                .collect();
+            let cloned = normalized_items.clone();
+            // Add comments before merging.
+            let list_items = itemize_list(
+                context.snippet_provider,
+                cloned.iter(),
+                "",
+                ";",
+                |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 item_str = match item.node {
-                ast::ItemKind::Use(ref tree) => {
-                    rewrite_import(context, &item.vis, tree, &item.attrs, shape)?
-                }
-                ast::ItemKind::ExternCrate(..) => rewrite_extern_crate(context, item)?,
-                ast::ItemKind::Mod(..) => rewrite_mod(item),
-                _ => return None,
+            let mut regrouped_items = match context.config.group_imports() {
+                GroupImportsTactic::Preserve => vec![normalized_items],
+                GroupImportsTactic::StdExternalCrate => group_imports(normalized_items),
             };
 
-            combine_strs_with_missing_comments(
-                context,
-                &attrs_str,
-                &item_str,
-                missed_span,
-                shape,
-                false,
-            )
-        },
-        span.lo(),
-        span.hi(),
-        false,
-    );
+            if context.config.reorder_imports() {
+                regrouped_items.iter_mut().for_each(|items| items.sort())
+            }
 
-    let mut item_pair_vec: Vec<_> = items.zip(reorderable_items.iter()).collect();
-    item_pair_vec.sort_by(|a, b| compare_items(a.1, b.1));
-    let item_vec: Vec<_> = item_pair_vec.into_iter().map(|pair| pair.0).collect();
+            // 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(
+                context.snippet_provider,
+                reorderable_items.iter(),
+                "",
+                ";",
+                |item| item.span().lo(),
+                |item| item.span().hi(),
+                |item| rewrite_reorderable_item(context, item, shape),
+                span.lo(),
+                span.hi(),
+                false,
+            );
 
-    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 mut item_pair_vec: Vec<_> = list_items.zip(reorderable_items.iter()).collect();
+            item_pair_vec.sort_by(|a, b| compare_items(a.1, b.1));
+            let item_vec: Vec<_> = item_pair_vec.into_iter().map(|pair| pair.0).collect();
 
-    write_list(&item_vec, &fmt)
+            wrap_reorderable_items(context, &item_vec, shape)
+        }
+    }
 }
 
 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`.
@@ -156,9 +212,11 @@ enum ReorderableItemKind {
 }
 
 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,
@@ -166,49 +224,58 @@ pub fn from(item: &ast::Item) -> Self {
         }
     }
 
-    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 {
-            ReorderableItemKind::ExternCrate => config.reorder_extern_crates(),
+    fn is_reorderable(self, config: &Config) -> bool {
+        match self {
+            ReorderableItemKind::ExternCrate => config.reorder_imports(),
             ReorderableItemKind::Mod => config.reorder_modules(),
             ReorderableItemKind::Use => config.reorder_imports(),
             ReorderableItemKind::Other => false,
         }
     }
 
-    pub fn in_group(&self, config: &Config) -> bool {
-        match *self {
-            ReorderableItemKind::ExternCrate => config.reorder_extern_crates_in_group(),
-            ReorderableItemKind::Mod => config.reorder_modules(),
-            ReorderableItemKind::Use => config.reorder_imports_in_group(),
+    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];
@@ -221,7 +288,12 @@ fn walk_reorderable_items(
             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 {
@@ -232,17 +304,20 @@ fn walk_reorderable_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(self.config));
+            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 {
@@ -255,399 +330,3 @@ pub fn visit_items_with_reordering(&mut self, mut items: &[&ast::Item]) {
         }
     }
 }
-
-// Ordering of imports
-
-// We order imports by translating to our own representation and then sorting.
-// The Rust AST data structures are really bad for this. Rustfmt applies a bunch
-// of normalisations to imports and since we want to sort based on the result
-// of these (and to maintain idempotence) we must apply the same normalisations
-// to the data structures for sorting.
-//
-// We sort `self` and `super` before other imports, then identifier imports,
-// then glob imports, then lists of imports. We do not take aliases into account
-// when ordering unless the imports are identical except for the alias (rare in
-// practice).
-
-// FIXME(#2531) - we should unify the comparison code here with the formatting
-// code elsewhere since we are essentially string-ifying twice. Furthermore, by
-// parsing to our own format on comparison, we repeat a lot of work when
-// sorting.
-
-// FIXME we do a lot of allocation to make our own representation.
-#[derive(Debug, Clone, Eq, PartialEq)]
-enum UseSegment {
-    Ident(String, Option<String>),
-    Slf(Option<String>),
-    Super(Option<String>),
-    Glob,
-    List(Vec<UseTree>),
-}
-
-#[derive(Debug, Clone, Eq, PartialEq)]
-struct UseTree {
-    path: Vec<UseSegment>,
-}
-
-impl UseSegment {
-    // Clone a version of self with any top-level alias removed.
-    fn remove_alias(&self) -> UseSegment {
-        match *self {
-            UseSegment::Ident(ref s, _) => UseSegment::Ident(s.clone(), None),
-            UseSegment::Slf(_) => UseSegment::Slf(None),
-            UseSegment::Super(_) => UseSegment::Super(None),
-            _ => self.clone(),
-        }
-    }
-}
-
-impl UseTree {
-    fn from_ast(a: &ast::UseTree) -> UseTree {
-        let mut result = UseTree { path: vec![] };
-        for p in &a.prefix.segments {
-            result.path.push(UseSegment::Ident(
-                (*p.identifier.name.as_str()).to_owned(),
-                None,
-            ));
-        }
-        match a.kind {
-            UseTreeKind::Glob => {
-                result.path.push(UseSegment::Glob);
-            }
-            UseTreeKind::Nested(ref list) => {
-                result.path.push(UseSegment::List(
-                    list.iter().map(|t| Self::from_ast(&t.0)).collect(),
-                ));
-            }
-            UseTreeKind::Simple(ref rename) => {
-                let mut name = (*path_to_imported_ident(&a.prefix).name.as_str()).to_owned();
-                let alias = if &name == &*rename.name.as_str() {
-                    None
-                } else {
-                    Some((&*rename.name.as_str()).to_owned())
-                };
-
-                let segment = if &name == "self" {
-                    UseSegment::Slf(alias)
-                } else if &name == "super" {
-                    UseSegment::Super(alias)
-                } else {
-                    UseSegment::Ident(name, alias)
-                };
-
-                // `name` is already in result.
-                result.path.pop();
-                result.path.push(segment);
-            }
-        }
-        result
-    }
-
-    // Do the adjustments that rustfmt does elsewhere to use paths.
-    fn normalize(mut self) -> UseTree {
-        let mut last = self.path.pop().expect("Empty use tree?");
-        // Hack around borrow checker.
-        let mut normalize_sole_list = false;
-        let mut aliased_self = false;
-
-        // Normalise foo::self -> foo.
-        if let UseSegment::Slf(None) = last {
-            return self;
-        }
-
-        // Normalise foo::self as bar -> foo as bar.
-        if let UseSegment::Slf(_) = last {
-            match self.path.last() {
-                None => {}
-                Some(UseSegment::Ident(_, None)) => {
-                    aliased_self = true;
-                }
-                _ => unreachable!(),
-            }
-        }
-
-        if aliased_self {
-            match self.path.last() {
-                Some(UseSegment::Ident(_, ref mut old_rename)) => {
-                    assert!(old_rename.is_none());
-                    if let UseSegment::Slf(Some(rename)) = last {
-                        *old_rename = Some(rename);
-                        return self;
-                    }
-                }
-                _ => unreachable!(),
-            }
-        }
-
-        // Normalise foo::{bar} -> foo::bar
-        if let UseSegment::List(ref list) = last {
-            if list.len() == 1 && list[0].path.len() == 1 {
-                normalize_sole_list = true;
-            }
-        }
-
-        if normalize_sole_list {
-            match last {
-                UseSegment::List(list) => {
-                    self.path.push(list[0].path[0].clone());
-                    return self.normalize();
-                }
-                _ => unreachable!(),
-            }
-        }
-
-        // Recursively normalize elements of a list use (including sorting the list).
-        if let UseSegment::List(list) = last {
-            let mut list: Vec<_> = list.into_iter().map(|ut| ut.normalize()).collect();
-            list.sort();
-            last = UseSegment::List(list);
-        }
-
-        self.path.push(last);
-        self
-    }
-}
-
-impl PartialOrd for UseSegment {
-    fn partial_cmp(&self, other: &UseSegment) -> Option<Ordering> {
-        Some(self.cmp(other))
-    }
-}
-impl PartialOrd for UseTree {
-    fn partial_cmp(&self, other: &UseTree) -> Option<Ordering> {
-        Some(self.cmp(other))
-    }
-}
-impl Ord for UseSegment {
-    fn cmp(&self, other: &UseSegment) -> Ordering {
-        use self::UseSegment::*;
-
-        match (self, other) {
-            (&Slf(ref a), &Slf(ref b)) | (&Super(ref a), &Super(ref b)) => a.cmp(b),
-            (&Glob, &Glob) => Ordering::Equal,
-            (&Ident(ref ia, ref aa), &Ident(ref ib, ref ab)) => {
-                let ident_ord = ia.cmp(ib);
-                if ident_ord != Ordering::Equal {
-                    return ident_ord;
-                }
-                if aa.is_none() && ab.is_some() {
-                    return Ordering::Less;
-                }
-                if aa.is_some() && ab.is_none() {
-                    return Ordering::Greater;
-                }
-                aa.cmp(ab)
-            }
-            (&List(ref a), &List(ref b)) => {
-                for (a, b) in a.iter().zip(b.iter()) {
-                    let ord = a.cmp(b);
-                    if ord != Ordering::Equal {
-                        return ord;
-                    }
-                }
-
-                a.len().cmp(&b.len())
-            }
-            (&Slf(_), _) => Ordering::Less,
-            (_, &Slf(_)) => Ordering::Greater,
-            (&Super(_), _) => Ordering::Less,
-            (_, &Super(_)) => Ordering::Greater,
-            (&Ident(..), _) => Ordering::Less,
-            (_, &Ident(..)) => Ordering::Greater,
-            (&Glob, _) => Ordering::Less,
-            (_, &Glob) => Ordering::Greater,
-        }
-    }
-}
-impl Ord for UseTree {
-    fn cmp(&self, other: &UseTree) -> Ordering {
-        for (a, b) in self.path.iter().zip(other.path.iter()) {
-            let ord = a.cmp(b);
-            // The comparison without aliases is a hack to avoid situations like
-            // comparing `a::b` to `a as c` - where the latter should be ordered
-            // first since it is shorter.
-            if ord != Ordering::Equal && a.remove_alias().cmp(&b.remove_alias()) != Ordering::Equal
-            {
-                return ord;
-            }
-        }
-
-        self.path.len().cmp(&other.path.len())
-    }
-}
-
-#[cfg(test)]
-mod test {
-    use super::*;
-
-    // Parse the path part of an import. This parser is not robust and is only
-    // suitable for use in a test harness.
-    fn parse_use_tree(s: &str) -> UseTree {
-        use std::iter::Peekable;
-        use std::mem::swap;
-        use std::str::Chars;
-
-        struct Parser<'a> {
-            input: Peekable<Chars<'a>>,
-        }
-
-        impl<'a> Parser<'a> {
-            fn bump(&mut self) {
-                self.input.next().unwrap();
-            }
-            fn eat(&mut self, c: char) {
-                assert!(self.input.next().unwrap() == c);
-            }
-            fn push_segment(
-                result: &mut Vec<UseSegment>,
-                buf: &mut String,
-                alias_buf: &mut Option<String>,
-            ) {
-                if !buf.is_empty() {
-                    let mut alias = None;
-                    swap(alias_buf, &mut alias);
-                    if buf == "self" {
-                        result.push(UseSegment::Slf(alias));
-                        *buf = String::new();
-                        *alias_buf = None;
-                    } else if buf == "super" {
-                        result.push(UseSegment::Super(alias));
-                        *buf = String::new();
-                        *alias_buf = None;
-                    } else {
-                        let mut name = String::new();
-                        swap(buf, &mut name);
-                        result.push(UseSegment::Ident(name, alias));
-                    }
-                }
-            }
-            fn parse_in_list(&mut self) -> UseTree {
-                let mut result = vec![];
-                let mut buf = String::new();
-                let mut alias_buf = None;
-                while let Some(&c) = self.input.peek() {
-                    match c {
-                        '{' => {
-                            assert!(buf.is_empty());
-                            self.bump();
-                            result.push(UseSegment::List(self.parse_list()));
-                            self.eat('}');
-                        }
-                        '*' => {
-                            assert!(buf.is_empty());
-                            self.bump();
-                            result.push(UseSegment::Glob);
-                        }
-                        ':' => {
-                            self.bump();
-                            self.eat(':');
-                            Self::push_segment(&mut result, &mut buf, &mut alias_buf);
-                        }
-                        '}' | ',' => {
-                            Self::push_segment(&mut result, &mut buf, &mut alias_buf);
-                            return UseTree { path: result };
-                        }
-                        ' ' => {
-                            self.bump();
-                            self.eat('a');
-                            self.eat('s');
-                            self.eat(' ');
-                            alias_buf = Some(String::new());
-                        }
-                        c => {
-                            self.bump();
-                            if let Some(ref mut buf) = alias_buf {
-                                buf.push(c);
-                            } else {
-                                buf.push(c);
-                            }
-                        }
-                    }
-                }
-                Self::push_segment(&mut result, &mut buf, &mut alias_buf);
-                UseTree { path: result }
-            }
-
-            fn parse_list(&mut self) -> Vec<UseTree> {
-                let mut result = vec![];
-                loop {
-                    match self.input.peek().unwrap() {
-                        ',' | ' ' => self.bump(),
-                        '}' => {
-                            return result;
-                        }
-                        _ => result.push(self.parse_in_list()),
-                    }
-                }
-            }
-        }
-
-        let mut parser = Parser {
-            input: s.chars().peekable(),
-        };
-        parser.parse_in_list()
-    }
-
-    #[test]
-    fn test_use_tree_normalize() {
-        assert_eq!(parse_use_tree("a::self").normalize(), parse_use_tree("a"));
-        assert_eq!(
-            parse_use_tree("a::self as foo").normalize(),
-            parse_use_tree("a as foo")
-        );
-        assert_eq!(parse_use_tree("a::{self}").normalize(), parse_use_tree("a"));
-        assert_eq!(parse_use_tree("a::{b}").normalize(), parse_use_tree("a::b"));
-        assert_eq!(
-            parse_use_tree("a::{b, c::self}").normalize(),
-            parse_use_tree("a::{b, c}")
-        );
-        assert_eq!(
-            parse_use_tree("a::{b as bar, c::self}").normalize(),
-            parse_use_tree("a::{b as bar, c}")
-        );
-    }
-
-    #[test]
-    fn test_use_tree_ord() {
-        assert!(parse_use_tree("a").normalize() < parse_use_tree("aa").normalize());
-        assert!(parse_use_tree("a").normalize() < parse_use_tree("a::a").normalize());
-        assert!(parse_use_tree("a").normalize() < parse_use_tree("*").normalize());
-        assert!(parse_use_tree("a").normalize() < parse_use_tree("{a, b}").normalize());
-        assert!(parse_use_tree("*").normalize() < parse_use_tree("{a, b}").normalize());
-
-        assert!(
-            parse_use_tree("aaaaaaaaaaaaaaa::{bb, cc, dddddddd}").normalize()
-                < parse_use_tree("aaaaaaaaaaaaaaa::{bb, cc, ddddddddd}").normalize()
-        );
-        assert!(
-            parse_use_tree("serde::de::{Deserialize}").normalize()
-                < parse_use_tree("serde_json").normalize()
-        );
-        assert!(parse_use_tree("a::b::c").normalize() < parse_use_tree("a::b::*").normalize());
-        assert!(
-            parse_use_tree("foo::{Bar, Baz}").normalize()
-                < parse_use_tree("{Bar, Baz}").normalize()
-        );
-
-        assert!(
-            parse_use_tree("foo::{self as bar}").normalize()
-                < parse_use_tree("foo::{qux as bar}").normalize()
-        );
-        assert!(
-            parse_use_tree("foo::{qux as bar}").normalize()
-                < parse_use_tree("foo::{baz, qux as bar}").normalize()
-        );
-        assert!(
-            parse_use_tree("foo::{self as bar, baz}").normalize()
-                < parse_use_tree("foo::{baz, qux as bar}").normalize()
-        );
-
-        assert!(parse_use_tree("Foo").normalize() < parse_use_tree("foo").normalize());
-        assert!(parse_use_tree("foo").normalize() < parse_use_tree("foo::Bar").normalize());
-
-        assert!(
-            parse_use_tree("std::cmp::{d, c, b, a}").normalize()
-                < parse_use_tree("std::cmp::{b, e, g, f}").normalize()
-        );
-    }
-}