compiler/rustc_typeck/src/check_unused.rs

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