2 use rustc_data_structures
::fx
::FxHashMap
;
3 use rustc_errors
::Applicability
;
5 use rustc_hir
::def_id
::{DefId, DefIdSet, LOCAL_CRATE}
;
6 use rustc_hir
::itemlikevisit
::ItemLikeVisitor
;
7 use rustc_middle
::ty
::TyCtxt
;
8 use rustc_session
::lint
;
11 pub fn check_crate(tcx
: TyCtxt
<'_
>) {
12 let mut used_trait_imports
= DefIdSet
::default();
13 for &body_id
in tcx
.hir().krate().bodies
.keys() {
14 let item_def_id
= tcx
.hir().body_owner_def_id(body_id
);
15 let imports
= tcx
.used_trait_imports(item_def_id
.to_def_id());
16 debug
!("GatherVisitor: item_def_id={:?} with imports {:#?}", item_def_id
, imports
);
17 used_trait_imports
.extend(imports
.iter());
20 let mut visitor
= CheckVisitor { tcx, used_trait_imports }
;
21 tcx
.hir().krate().visit_all_item_likes(&mut visitor
);
23 unused_crates_lint(tcx
);
26 impl ItemLikeVisitor
<'v
> for CheckVisitor
<'tcx
> {
27 fn visit_item(&mut self, item
: &hir
::Item
<'_
>) {
28 if item
.vis
.node
.is_pub() || item
.span
.is_dummy() {
31 if let hir
::ItemKind
::Use(ref path
, _
) = item
.kind
{
32 self.check_import(item
.hir_id
, path
.span
);
36 fn visit_trait_item(&mut self, _trait_item
: &hir
::TraitItem
<'_
>) {}
38 fn visit_impl_item(&mut self, _impl_item
: &hir
::ImplItem
<'_
>) {}
41 struct CheckVisitor
<'tcx
> {
43 used_trait_imports
: DefIdSet
,
46 impl CheckVisitor
<'tcx
> {
47 fn check_import(&self, id
: hir
::HirId
, span
: Span
) {
48 let def_id
= self.tcx
.hir().local_def_id(id
);
49 if !self.tcx
.maybe_unused_trait_import(def_id
) {
53 if self.used_trait_imports
.contains(&def_id
) {
57 self.tcx
.struct_span_lint_hir(lint
::builtin
::UNUSED_IMPORTS
, id
, span
, |lint
| {
58 let msg
= if let Ok(snippet
) = self.tcx
.sess
.source_map().span_to_snippet(span
) {
59 format
!("unused import: `{}`", snippet
)
61 "unused import".to_owned()
63 lint
.build(&msg
).emit();
68 fn unused_crates_lint(tcx
: TyCtxt
<'_
>) {
69 let lint
= lint
::builtin
::UNUSED_EXTERN_CRATES
;
71 // Collect first the crates that are completely unused. These we
72 // can always suggest removing (no matter which edition we are
74 let unused_extern_crates
: FxHashMap
<DefId
, Span
> = tcx
75 .maybe_unused_extern_crates(LOCAL_CRATE
)
77 .filter(|&&(def_id
, _
)| {
78 // The `def_id` here actually was calculated during resolution (at least
79 // at the time of this writing) and is being shipped to us via a side
80 // channel of the tcx. There may have been extra expansion phases,
81 // however, which ended up removing the `def_id` *after* expansion such
82 // as the `ReplaceBodyWithLoop` pass (which is a bit of a hack, but hey)
84 // As a result we need to verify that `def_id` is indeed still valid for
85 // our AST and actually present in the HIR map. If it's not there then
86 // there's safely nothing to warn about, and otherwise we carry on with
89 // Note that if we carry through to the `extern_mod_stmt_cnum` query
90 // below it'll cause a panic because `def_id` is actually bogus at this
91 // point in time otherwise.
92 if let Some(id
) = tcx
.hir().as_local_hir_id(def_id
) {
93 if tcx
.hir().find(id
).is_none() {
99 .filter(|&&(def_id
, _
)| {
100 tcx
.extern_mod_stmt_cnum(def_id
).map_or(true, |cnum
| {
101 !tcx
.is_compiler_builtins(cnum
)
102 && !tcx
.is_panic_runtime(cnum
)
103 && !tcx
.has_global_allocator(cnum
)
104 && !tcx
.has_panic_handler(cnum
)
110 // Collect all the extern crates (in a reliable order).
111 let mut crates_to_lint
= vec
![];
112 tcx
.hir().krate().visit_all_item_likes(&mut CollectExternCrateVisitor
{
114 crates_to_lint
: &mut crates_to_lint
,
117 for extern_crate
in &crates_to_lint
{
118 let id
= tcx
.hir().as_local_hir_id(extern_crate
.def_id
).unwrap();
119 let item
= tcx
.hir().expect_item(id
);
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(&extern_crate
.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
)
130 .map(|attr
| attr
.span
)
131 .fold(span
, |acc
, attr_span
| acc
.to(attr_span
));
133 lint
.build("unused extern crate")
134 .span_suggestion_short(
138 Applicability
::MachineApplicable
,
146 // If we are not in Rust 2018 edition, then we don't make any further
148 if !tcx
.sess
.rust_2018() {
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
) {
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
162 if extern_crate
.orig_name
.is_some() {
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() {
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
),
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(
183 &format!("convert it to a `{}`
", add_vis("use".to_string())),
184 add_vis(base_replacement),
185 Applicability::MachineApplicable,
192 struct CollectExternCrateVisitor<'a, 'tcx> {
194 crates_to_lint: &'a mut Vec<ExternCrateToLint>,
197 struct ExternCrateToLint {
198 /// `DefId` of the extern crate
201 /// span from the item
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<ast::Name>,
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,
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,
222 warn_if_unused: !item.ident.as_str().starts_with('_'),
227 fn visit_trait_item(&mut self, _trait_item: &hir::TraitItem<'_>) {}
229 fn visit_impl_item(&mut self, _impl_item: &hir::ImplItem<'_>) {}