src/librustc_typeck/check_unused.rs

   1 use rustc_data_structures::fx::FxHashMap;
   2 use rustc_errors::Applicability;
   3 use rustc_hir as hir;
   4 use rustc_hir::def_id::{DefId, DefIdSet, LOCAL_CRATE};
   5 use rustc_hir::itemlikevisit::ItemLikeVisitor;
   6 use rustc_middle::ty::TyCtxt;
   7 use rustc_session::lint;
   8 use rustc_span::{Span, Symbol};
   9
  10 pub fn check_crate(tcx: TyCtxt<'_>) {
  11     let mut used_trait_imports = DefIdSet::default();
  12     for &body_id in tcx.hir().krate().bodies.keys() {
  13         let item_def_id = tcx.hir().body_owner_def_id(body_id);
  14         let imports = tcx.used_trait_imports(item_def_id);
  15         debug!("GatherVisitor: item_def_id={:?} with imports {:#?}", item_def_id, imports);
  16         used_trait_imports.extend(imports.iter());
  17     }
  18
  19     let mut visitor = CheckVisitor { tcx, used_trait_imports };
  20     tcx.hir().krate().visit_all_item_likes(&mut visitor);
  21
  22     unused_crates_lint(tcx);
  23 }
  24
  25 impl ItemLikeVisitor<'v> for CheckVisitor<'tcx> {
  26     fn visit_item(&mut self, item: &hir::Item<'_>) {
  27         if item.vis.node.is_pub() || item.span.is_dummy() {
  28             return;
  29         }
  30         if let hir::ItemKind::Use(ref path, _) = item.kind {
  31             self.check_import(item.hir_id, path.span);
  32         }
  33     }
  34
  35     fn visit_trait_item(&mut self, _trait_item: &hir::TraitItem<'_>) {}
  36
  37     fn visit_impl_item(&mut self, _impl_item: &hir::ImplItem<'_>) {}
  38 }
  39
  40 struct CheckVisitor<'tcx> {
  41     tcx: TyCtxt<'tcx>,
  42     used_trait_imports: DefIdSet,
  43 }
  44
  45 impl CheckVisitor<'tcx> {
  46     fn check_import(&self, id: hir::HirId, span: Span) {
  47         let def_id = self.tcx.hir().local_def_id(id);
  48         if !self.tcx.maybe_unused_trait_import(def_id) {
  49             return;
  50         }
  51
  52         if self.used_trait_imports.contains(&def_id.to_def_id()) {
  53             return;
  54         }
  55
  56         self.tcx.struct_span_lint_hir(lint::builtin::UNUSED_IMPORTS, id, span, |lint| {
  57             let msg = if let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span) {
  58                 format!("unused import: `{}`", snippet)
  59             } else {
  60                 "unused import".to_owned()
  61             };
  62             lint.build(&msg).emit();
  63         });
  64     }
  65 }
  66
  67 fn unused_crates_lint(tcx: TyCtxt<'_>) {
  68     let lint = lint::builtin::UNUSED_EXTERN_CRATES;
  69
  70     // Collect first the crates that are completely unused.  These we
  71     // can always suggest removing (no matter which edition we are
  72     // in).
  73     let unused_extern_crates: FxHashMap<DefId, Span> = tcx
  74         .maybe_unused_extern_crates(LOCAL_CRATE)
  75         .iter()
  76         .filter(|&&(def_id, _)| {
  77             // The `def_id` here actually was calculated during resolution (at least
  78             // at the time of this writing) and is being shipped to us via a side
  79             // channel of the tcx. There may have been extra expansion phases,
  80             // however, which ended up removing the `def_id` *after* expansion such
  81             // as the `ReplaceBodyWithLoop` pass (which is a bit of a hack, but hey)
  82             //
  83             // As a result we need to verify that `def_id` is indeed still valid for
  84             // our AST and actually present in the HIR map. If it's not there then
  85             // there's safely nothing to warn about, and otherwise we carry on with
  86             // our execution.
  87             //
  88             // Note that if we carry through to the `extern_mod_stmt_cnum` query
  89             // below it'll cause a panic because `def_id` is actually bogus at this
  90             // point in time otherwise.
  91             if tcx.hir().find(tcx.hir().as_local_hir_id(def_id.expect_local())).is_none() {
  92                 return false;
  93             }
  94             true
  95         })
  96         .filter(|&&(def_id, _)| {
  97             tcx.extern_mod_stmt_cnum(def_id).map_or(true, |cnum| {
  98                 !tcx.is_compiler_builtins(cnum)
  99                     && !tcx.is_panic_runtime(cnum)
 100                     && !tcx.has_global_allocator(cnum)
 101                     && !tcx.has_panic_handler(cnum)
 102             })
 103         })
 104         .cloned()
 105         .collect();
 106
 107     // Collect all the extern crates (in a reliable order).
 108     let mut crates_to_lint = vec![];
 109     tcx.hir().krate().visit_all_item_likes(&mut CollectExternCrateVisitor {
 110         tcx,
 111         crates_to_lint: &mut crates_to_lint,
 112     });
 113
 114     for extern_crate in &crates_to_lint {
 115         let id = tcx.hir().as_local_hir_id(extern_crate.def_id.expect_local());
 116         let item = tcx.hir().expect_item(id);
 117
 118         // If the crate is fully unused, we suggest removing it altogether.
 119         // We do this in any edition.
 120         if extern_crate.warn_if_unused {
 121             if let Some(&span) = unused_extern_crates.get(&extern_crate.def_id) {
 122                 tcx.struct_span_lint_hir(lint, id, span, |lint| {
 123                     // Removal suggestion span needs to include attributes (Issue #54400)
 124                     let span_with_attrs = tcx
 125                         .get_attrs(extern_crate.def_id)
 126                         .iter()
 127                         .map(|attr| attr.span)
 128                         .fold(span, |acc, attr_span| acc.to(attr_span));
 129
 130                     lint.build("unused extern crate")
 131                         .span_suggestion_short(
 132                             span_with_attrs,
 133                             "remove it",
 134                             String::new(),
 135                             Applicability::MachineApplicable,
 136                         )
 137                         .emit();
 138                 });
 139                 continue;
 140             }
 141         }
 142
 143         // If we are not in Rust 2018 edition, then we don't make any further
 144         // suggestions.
 145         if !tcx.sess.rust_2018() {
 146             continue;
 147         }
 148
 149         // If the extern crate isn't in the extern prelude,
 150         // there is no way it can be written as an `use`.
 151         let orig_name = extern_crate.orig_name.unwrap_or(item.ident.name);
 152         if !tcx.extern_prelude.get(&orig_name).map_or(false, |from_item| !from_item) {
 153             continue;
 154         }
 155
 156         // If the extern crate is renamed, then we cannot suggest replacing it with a use as this
 157         // would not insert the new name into the prelude, where other imports in the crate may be
 158         // expecting it.
 159         if extern_crate.orig_name.is_some() {
 160             continue;
 161         }
 162
 163         // If the extern crate has any attributes, they may have funky
 164         // semantics we can't faithfully represent using `use` (most
 165         // notably `#[macro_use]`). Ignore it.
 166         if !tcx.get_attrs(extern_crate.def_id).is_empty() {
 167             continue;
 168         }
 169         tcx.struct_span_lint_hir(lint, id, extern_crate.span, |lint| {
 170             // Otherwise, we can convert it into a `use` of some kind.
 171             let base_replacement = match extern_crate.orig_name {
 172                 Some(orig_name) => format!("use {} as {};", orig_name, item.ident.name),
 173                 None => format!("use {};", item.ident.name),
 174             };
 175             let vis = tcx.sess.source_map().span_to_snippet(item.vis.span).unwrap_or_default();
 176             let add_vis = |to| if vis.is_empty() { to } else { format!("{} {}", vis, to) };
 177             lint.build("`extern crate` is not idiomatic in the new edition")
 178                 .span_suggestion_short(
 179                     extern_crate.span,
 180                     &format!("convert it to a `{}`", add_vis("use".to_string())),
 181                     add_vis(base_replacement),
 182                     Applicability::MachineApplicable,
 183                 )
 184                 .emit();
 185         })
 186     }
 187 }
 188
 189 struct CollectExternCrateVisitor<'a, 'tcx> {
 190     tcx: TyCtxt<'tcx>,
 191     crates_to_lint: &'a mut Vec<ExternCrateToLint>,
 192 }
 193
 194 struct ExternCrateToLint {
 195     /// `DefId` of the extern crate
 196     def_id: DefId,
 197
 198     /// span from the item
 199     span: Span,
 200
 201     /// if `Some`, then this is renamed (`extern crate orig_name as
 202     /// crate_name`), and -- perhaps surprisingly -- this stores the
 203     /// *original* name (`item.name` will contain the new name)
 204     orig_name: Option<Symbol>,
 205
 206     /// if `false`, the original name started with `_`, so we shouldn't lint
 207     /// about it going unused (but we should still emit idiom lints).
 208     warn_if_unused: bool,
 209 }
 210
 211 impl<'a, 'tcx, 'v> ItemLikeVisitor<'v> for CollectExternCrateVisitor<'a, 'tcx> {
 212     fn visit_item(&mut self, item: &hir::Item<'_>) {
 213         if let hir::ItemKind::ExternCrate(orig_name) = item.kind {
 214             let extern_crate_def_id = self.tcx.hir().local_def_id(item.hir_id);
 215             self.crates_to_lint.push(ExternCrateToLint {
 216                 def_id: extern_crate_def_id.to_def_id(),
 217                 span: item.span,
 218                 orig_name,
 219                 warn_if_unused: !item.ident.as_str().starts_with('_'),
 220             });
 221         }
 222     }
 223
 224     fn visit_trait_item(&mut self, _trait_item: &hir::TraitItem<'_>) {}
 225
 226     fn visit_impl_item(&mut self, _impl_item: &hir::ImplItem<'_>) {}
 227 }