src/librustc_typeck/check_unused.rs

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