src/librustc_resolve/check_unused.rs

   1 //
   2 // Unused import checking
   3 //
   4 // Although this is mostly a lint pass, it lives in here because it depends on
   5 // resolve data structures and because it finalises the privacy information for
   6 // `use` directives.
   7 //
   8 // Unused trait imports can't be checked until the method resolution. We save
   9 // candidates here, and do the actual check in librustc_typeck/check_unused.rs.
  10 //
  11 // Checking for unused imports is split into three steps:
  12 //
  13 //  - `UnusedImportCheckVisitor` walks the AST to find all the unused imports
  14 //    inside of `UseTree`s, recording their `NodeId`s and grouping them by
  15 //    the parent `use` item
  16 //
  17 //  - `calc_unused_spans` then walks over all the `use` items marked in the
  18 //    previous step to collect the spans associated with the `NodeId`s and to
  19 //    calculate the spans that can be removed by rustfix; This is done in a
  20 //    separate step to be able to collapse the adjacent spans that rustfix
  21 //    will remove
  22 //
  23 //  - `check_crate` finally emits the diagnostics based on the data generated
  24 //    in the last step
  25
  26 use crate::Resolver;
  27 use crate::resolve_imports::ImportDirectiveSubclass;
  28
  29 use errors::pluralise;
  30
  31 use rustc::util::nodemap::NodeMap;
  32 use rustc::{lint, ty};
  33 use rustc_data_structures::fx::FxHashSet;
  34 use syntax::ast;
  35 use syntax::visit::{self, Visitor};
  36 use syntax_pos::{Span, MultiSpan, DUMMY_SP};
  37
  38 struct UnusedImport<'a> {
  39     use_tree: &'a ast::UseTree,
  40     use_tree_id: ast::NodeId,
  41     item_span: Span,
  42     unused: FxHashSet<ast::NodeId>,
  43 }
  44
  45 impl<'a> UnusedImport<'a> {
  46     fn add(&mut self, id: ast::NodeId) {
  47         self.unused.insert(id);
  48     }
  49 }
  50
  51 struct UnusedImportCheckVisitor<'a, 'b> {
  52     r: &'a mut Resolver<'b>,
  53     /// All the (so far) unused imports, grouped path list
  54     unused_imports: NodeMap<UnusedImport<'a>>,
  55     base_use_tree: Option<&'a ast::UseTree>,
  56     base_id: ast::NodeId,
  57     item_span: Span,
  58 }
  59
  60 impl<'a, 'b> UnusedImportCheckVisitor<'a, 'b> {
  61     // We have information about whether `use` (import) directives are actually
  62     // used now. If an import is not used at all, we signal a lint error.
  63     fn check_import(&mut self, id: ast::NodeId) {
  64         let mut used = false;
  65         self.r.per_ns(|this, ns| used |= this.used_imports.contains(&(id, ns)));
  66         if !used {
  67             if self.r.maybe_unused_trait_imports.contains(&id) {
  68                 // Check later.
  69                 return;
  70             }
  71             self.unused_import(self.base_id).add(id);
  72         } else {
  73             // This trait import is definitely used, in a way other than
  74             // method resolution.
  75             self.r.maybe_unused_trait_imports.remove(&id);
  76             if let Some(i) = self.unused_imports.get_mut(&self.base_id) {
  77                 i.unused.remove(&id);
  78             }
  79         }
  80     }
  81
  82     fn unused_import(&mut self, id: ast::NodeId) -> &mut UnusedImport<'a> {
  83         let use_tree_id = self.base_id;
  84         let use_tree = self.base_use_tree.unwrap();
  85         let item_span = self.item_span;
  86
  87         self.unused_imports
  88             .entry(id)
  89             .or_insert_with(|| UnusedImport {
  90                 use_tree,
  91                 use_tree_id,
  92                 item_span,
  93                 unused: FxHashSet::default(),
  94             })
  95     }
  96 }
  97
  98 impl<'a, 'b> Visitor<'a> for UnusedImportCheckVisitor<'a, 'b> {
  99     fn visit_item(&mut self, item: &'a ast::Item) {
 100         self.item_span = item.span;
 101
 102         // Ignore is_public import statements because there's no way to be sure
 103         // whether they're used or not. Also ignore imports with a dummy span
 104         // because this means that they were generated in some fashion by the
 105         // compiler and we don't need to consider them.
 106         if let ast::ItemKind::Use(..) = item.kind {
 107             if item.vis.node.is_pub() || item.span.is_dummy() {
 108                 return;
 109             }
 110         }
 111
 112         visit::walk_item(self, item);
 113     }
 114
 115     fn visit_use_tree(&mut self, use_tree: &'a ast::UseTree, id: ast::NodeId, nested: bool) {
 116         // Use the base UseTree's NodeId as the item id
 117         // This allows the grouping of all the lints in the same item
 118         if !nested {
 119             self.base_id = id;
 120             self.base_use_tree = Some(use_tree);
 121         }
 122
 123         if let ast::UseTreeKind::Nested(ref items) = use_tree.kind {
 124             if items.is_empty() {
 125                 self.unused_import(self.base_id).add(id);
 126             }
 127         } else {
 128             self.check_import(id);
 129         }
 130
 131         visit::walk_use_tree(self, use_tree, id);
 132     }
 133 }
 134
 135 enum UnusedSpanResult {
 136     Used,
 137     FlatUnused(Span, Span),
 138     NestedFullUnused(Vec<Span>, Span),
 139     NestedPartialUnused(Vec<Span>, Vec<Span>),
 140 }
 141
 142 fn calc_unused_spans(
 143     unused_import: &UnusedImport<'_>,
 144     use_tree: &ast::UseTree,
 145     use_tree_id: ast::NodeId,
 146 ) -> UnusedSpanResult {
 147     // The full span is the whole item's span if this current tree is not nested inside another
 148     // This tells rustfix to remove the whole item if all the imports are unused
 149     let full_span = if unused_import.use_tree.span == use_tree.span {
 150         unused_import.item_span
 151     } else {
 152         use_tree.span
 153     };
 154     match use_tree.kind {
 155         ast::UseTreeKind::Simple(..) | ast::UseTreeKind::Glob => {
 156             if unused_import.unused.contains(&use_tree_id) {
 157                 UnusedSpanResult::FlatUnused(use_tree.span, full_span)
 158             } else {
 159                 UnusedSpanResult::Used
 160             }
 161         }
 162         ast::UseTreeKind::Nested(ref nested) => {
 163             if nested.len() == 0 {
 164                 return UnusedSpanResult::FlatUnused(use_tree.span, full_span);
 165             }
 166
 167             let mut unused_spans = Vec::new();
 168             let mut to_remove = Vec::new();
 169             let mut all_nested_unused = true;
 170             let mut previous_unused = false;
 171             for (pos, (use_tree, use_tree_id)) in nested.iter().enumerate() {
 172                 let remove = match calc_unused_spans(unused_import, use_tree, *use_tree_id) {
 173                     UnusedSpanResult::Used => {
 174                         all_nested_unused = false;
 175                         None
 176                     }
 177                     UnusedSpanResult::FlatUnused(span, remove) => {
 178                         unused_spans.push(span);
 179                         Some(remove)
 180                     }
 181                     UnusedSpanResult::NestedFullUnused(mut spans, remove) => {
 182                         unused_spans.append(&mut spans);
 183                         Some(remove)
 184                     }
 185                     UnusedSpanResult::NestedPartialUnused(mut spans, mut to_remove_extra) => {
 186                         all_nested_unused = false;
 187                         unused_spans.append(&mut spans);
 188                         to_remove.append(&mut to_remove_extra);
 189                         None
 190                     }
 191                 };
 192                 if let Some(remove) = remove {
 193                     let remove_span = if nested.len() == 1 {
 194                         remove
 195                     } else if pos == nested.len() - 1 || !all_nested_unused {
 196                         // Delete everything from the end of the last import, to delete the
 197                         // previous comma
 198                         nested[pos - 1].0.span.shrink_to_hi().to(use_tree.span)
 199                     } else {
 200                         // Delete everything until the next import, to delete the trailing commas
 201                         use_tree.span.to(nested[pos + 1].0.span.shrink_to_lo())
 202                     };
 203
 204                     // Try to collapse adjacent spans into a single one. This prevents all cases of
 205                     // overlapping removals, which are not supported by rustfix
 206                     if previous_unused && !to_remove.is_empty() {
 207                         let previous = to_remove.pop().unwrap();
 208                         to_remove.push(previous.to(remove_span));
 209                     } else {
 210                         to_remove.push(remove_span);
 211                     }
 212                 }
 213                 previous_unused = remove.is_some();
 214             }
 215             if unused_spans.is_empty() {
 216                 UnusedSpanResult::Used
 217             } else if all_nested_unused {
 218                 UnusedSpanResult::NestedFullUnused(unused_spans, full_span)
 219             } else {
 220                 UnusedSpanResult::NestedPartialUnused(unused_spans, to_remove)
 221             }
 222         }
 223     }
 224 }
 225
 226 impl Resolver<'_> {
 227     crate fn check_unused(&mut self, krate: &ast::Crate) {
 228         for directive in self.potentially_unused_imports.iter() {
 229             match directive.subclass {
 230                 _ if directive.used.get() ||
 231                     directive.vis.get() == ty::Visibility::Public ||
 232                     directive.span.is_dummy() => {
 233                     if let ImportDirectiveSubclass::MacroUse = directive.subclass {
 234                         if !directive.span.is_dummy() {
 235                             self.session.buffer_lint(
 236                                 lint::builtin::MACRO_USE_EXTERN_CRATE,
 237                                 directive.id,
 238                                 directive.span,
 239                                 "deprecated `#[macro_use]` directive used to \
 240                                 import macros should be replaced at use sites \
 241                                 with a `use` statement to import the macro \
 242                                 instead",
 243                             );
 244                         }
 245                     }
 246                 }
 247                 ImportDirectiveSubclass::ExternCrate { .. } => {
 248                     self.maybe_unused_extern_crates.push((directive.id, directive.span));
 249                 }
 250                 ImportDirectiveSubclass::MacroUse => {
 251                     let lint = lint::builtin::UNUSED_IMPORTS;
 252                     let msg = "unused `#[macro_use]` import";
 253                     self.session.buffer_lint(lint, directive.id, directive.span, msg);
 254                 }
 255                 _ => {}
 256             }
 257         }
 258
 259         let mut visitor = UnusedImportCheckVisitor {
 260             r: self,
 261             unused_imports: Default::default(),
 262             base_use_tree: None,
 263             base_id: ast::DUMMY_NODE_ID,
 264             item_span: DUMMY_SP,
 265         };
 266         visit::walk_crate(&mut visitor, krate);
 267
 268         for unused in visitor.unused_imports.values() {
 269             let mut fixes = Vec::new();
 270             let mut spans = match calc_unused_spans(unused, unused.use_tree, unused.use_tree_id) {
 271                 UnusedSpanResult::Used => continue,
 272                 UnusedSpanResult::FlatUnused(span, remove) => {
 273                     fixes.push((remove, String::new()));
 274                     vec![span]
 275                 }
 276                 UnusedSpanResult::NestedFullUnused(spans, remove) => {
 277                     fixes.push((remove, String::new()));
 278                     spans
 279                 }
 280                 UnusedSpanResult::NestedPartialUnused(spans, remove) => {
 281                     for fix in &remove {
 282                         fixes.push((*fix, String::new()));
 283                     }
 284                     spans
 285                 }
 286             };
 287
 288             let len = spans.len();
 289             spans.sort();
 290             let ms = MultiSpan::from_spans(spans.clone());
 291             let mut span_snippets = spans.iter()
 292                 .filter_map(|s| {
 293                     match visitor.r.session.source_map().span_to_snippet(*s) {
 294                         Ok(s) => Some(format!("`{}`", s)),
 295                         _ => None,
 296                     }
 297                 }).collect::<Vec<String>>();
 298             span_snippets.sort();
 299             let msg = format!("unused import{}{}",
 300                             pluralise!(len),
 301                             if !span_snippets.is_empty() {
 302                                 format!(": {}", span_snippets.join(", "))
 303                             } else {
 304                                 String::new()
 305                             });
 306
 307             let fix_msg = if fixes.len() == 1 && fixes[0].0 == unused.item_span {
 308                 "remove the whole `use` item"
 309             } else if spans.len() > 1 {
 310                 "remove the unused imports"
 311             } else {
 312                 "remove the unused import"
 313             };
 314
 315             visitor.r.session.buffer_lint_with_diagnostic(
 316                 lint::builtin::UNUSED_IMPORTS,
 317                 unused.use_tree_id,
 318                 ms,
 319                 &msg,
 320                 lint::builtin::BuiltinLintDiagnostics::UnusedImports(fix_msg.into(), fixes),
 321             );
 322         }
 323     }
 324 }