Skip to content

Commit

Permalink
Auto merge of #127854 - fmease:glob-import-type_ir_inherent-lint, r=<…
Browse files Browse the repository at this point in the history
…try>

Add internal lint for detecting non-glob imports of `rustc_type_ir::inherent`

#127627 (comment)

r? compiler-errors
  • Loading branch information
bors committed Jul 18, 2024
2 parents e35364a + bd6a408 commit 647fdf7
Show file tree
Hide file tree
Showing 9 changed files with 168 additions and 2 deletions.
3 changes: 3 additions & 0 deletions compiler/rustc_lint/messages.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,9 @@ lint_non_fmt_panic_unused =
}
.add_fmt_suggestion = or add a "{"{"}{"}"}" format string to use the message literally
lint_non_glob_import_type_ir_inherent = non-glob import of `rustc_type_ir::inherent`
.suggestion = try using a glob import instead
lint_non_local_definitions_cargo_update = the {$macro_kind} `{$macro_name}` may come from an old version of the `{$crate_name}` crate, try updating your dependency with `cargo update -p {$crate_name}`
lint_non_local_definitions_deprecation = this lint may become deny-by-default in the edition 2024 and higher, see the tracking issue <https://github.com/rust-lang/rust/issues/120363>
Expand Down
46 changes: 45 additions & 1 deletion compiler/rustc_lint/src/internal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@

use crate::lints::{
BadOptAccessDiag, DefaultHashTypesDiag, DiagOutOfImpl, LintPassByHand, NonExistentDocKeyword,
QueryInstability, SpanUseEqCtxtDiag, TyQualified, TykindDiag, TykindKind, UntranslatableDiag,
NonGlobImportTypeIrInherent, QueryInstability, SpanUseEqCtxtDiag, TyQualified, TykindDiag,
TykindKind, UntranslatableDiag,
};
use crate::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
use rustc_ast as ast;
Expand Down Expand Up @@ -263,6 +264,49 @@ fn gen_args(segment: &PathSegment<'_>) -> String {
String::new()
}

declare_tool_lint! {
/// The `non_glob_import_of_type_ir_inherent_item` lint detects
/// non-glob imports of module `rustc_type_ir::inherent`.
pub rustc::NON_GLOB_IMPORT_OF_TYPE_IR_INHERENT,
Allow,
"non-glob import of `rustc_type_ir::inherent`",
report_in_external_macro: true
}

declare_lint_pass!(TypeIr => [NON_GLOB_IMPORT_OF_TYPE_IR_INHERENT]);

impl<'tcx> LateLintPass<'tcx> for TypeIr {
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'tcx>) {
let rustc_hir::ItemKind::Use(path, kind) = item.kind else { return };

let is_mod_inherent = |def_id| cx.tcx.is_diagnostic_item(sym::type_ir_inherent, def_id);
let (lo, hi, snippet) = match path.segments {
[.., penultimate, segment]
if penultimate.res.opt_def_id().is_some_and(is_mod_inherent) =>
{
(segment.ident.span, item.ident.span, "*")
}
[.., segment]
if path.res.iter().flat_map(Res::opt_def_id).any(is_mod_inherent)
&& let rustc_hir::UseKind::Single = kind =>
{
let (lo, snippet) =
match cx.tcx.sess.source_map().span_to_snippet(path.span).as_deref() {
Ok("self") => (path.span, "*"),
_ => (segment.ident.span.shrink_to_hi(), "::*"),
};
(lo, if segment.ident == item.ident { lo } else { item.ident.span }, snippet)
}
_ => return,
};
cx.emit_span_lint(
NON_GLOB_IMPORT_OF_TYPE_IR_INHERENT,
path.span,
NonGlobImportTypeIrInherent { suggestion: lo.eq_ctxt(hi).then(|| lo.to(hi)), snippet },
);
}
}

declare_tool_lint! {
/// The `lint_pass_impl_without_macro` detects manual implementations of a lint
/// pass, without using [`declare_lint_pass`] or [`impl_lint_pass`].
Expand Down
3 changes: 3 additions & 0 deletions compiler/rustc_lint/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -572,6 +572,8 @@ fn register_internals(store: &mut LintStore) {
store.register_late_mod_pass(|_| Box::new(ExistingDocKeyword));
store.register_lints(&TyTyKind::get_lints());
store.register_late_mod_pass(|_| Box::new(TyTyKind));
store.register_lints(&TypeIr::get_lints());
store.register_late_mod_pass(|_| Box::new(TypeIr));
store.register_lints(&Diagnostics::get_lints());
store.register_late_mod_pass(|_| Box::new(Diagnostics));
store.register_lints(&BadOptAccess::get_lints());
Expand All @@ -595,6 +597,7 @@ fn register_internals(store: &mut LintStore) {
LintId::of(PASS_BY_VALUE),
LintId::of(LINT_PASS_IMPL_WITHOUT_MACRO),
LintId::of(USAGE_OF_QUALIFIED_TY),
LintId::of(NON_GLOB_IMPORT_OF_TYPE_IR_INHERENT),
LintId::of(EXISTING_DOC_KEYWORD),
LintId::of(BAD_OPT_ACCESS),
LintId::of(SPAN_USE_EQ_CTXT),
Expand Down
8 changes: 8 additions & 0 deletions compiler/rustc_lint/src/lints.rs
Original file line number Diff line number Diff line change
Expand Up @@ -926,6 +926,14 @@ pub struct TyQualified {
pub suggestion: Span,
}

#[derive(LintDiagnostic)]
#[diag(lint_non_glob_import_type_ir_inherent)]
pub struct NonGlobImportTypeIrInherent {
#[suggestion(code = "{snippet}", applicability = "maybe-incorrect")]
pub suggestion: Option<Span>,
pub snippet: &'static str,
}

#[derive(LintDiagnostic)]
#[diag(lint_lintpass_by_hand)]
#[help]
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_span/src/symbol.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1926,6 +1926,7 @@ symbols! {
type_ascription,
type_changing_struct_update,
type_id,
type_ir_inherent,
type_length_limit,
type_macros,
type_name,
Expand Down
2 changes: 1 addition & 1 deletion compiler/rustc_type_ir/src/effects.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::inherent::{AdtDef, IntoKind, Ty};
use crate::inherent::*;
use crate::lang_items::TraitSolverLangItem::{EffectsMaybe, EffectsNoRuntime, EffectsRuntime};
use crate::Interner;

Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_type_ir/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ pub mod elaborate;
pub mod error;
pub mod fast_reject;
pub mod fold;
#[cfg_attr(feature = "nightly", rustc_diagnostic_item = "type_ir_inherent")]
pub mod inherent;
pub mod ir_print;
pub mod lang_items;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
//@ compile-flags: -Z unstable-options
//@ ignore-stage1 (can be removed after beta bump, cfg(not(bootstrap)))
#![feature(rustc_private)]
#![deny(rustc::non_glob_import_of_type_ir_inherent)]

extern crate rustc_type_ir;

mod ok {
use rustc_type_ir::inherent::*; // OK
use rustc_type_ir::inherent::{}; // OK
use rustc_type_ir::inherent::{*}; // OK

fn usage<T: rustc_type_ir::inherent::SliceLike>() {} // OK
}

mod direct {
use rustc_type_ir::inherent::Predicate; //~ ERROR non-glob import of `rustc_type_ir::inherent`
use rustc_type_ir::inherent::{AdtDef, Ty};
//~^ ERROR non-glob import of `rustc_type_ir::inherent`
//~| ERROR non-glob import of `rustc_type_ir::inherent`
use rustc_type_ir::inherent::ParamEnv as _; //~ ERROR non-glob import of `rustc_type_ir::inherent`
}

mod indirect0 {
use rustc_type_ir::inherent; //~ ERROR non-glob import of `rustc_type_ir::inherent`
use rustc_type_ir::inherent as inh; //~ ERROR non-glob import of `rustc_type_ir::inherent`
use rustc_type_ir::{inherent as _}; //~ ERROR non-glob import of `rustc_type_ir::inherent`

fn usage0<T: inherent::SliceLike>() {}
fn usage1<T: inh::SliceLike>() {}
}

mod indirect1 {
use rustc_type_ir::inherent::{self}; //~ ERROR non-glob import of `rustc_type_ir::inherent`
use rustc_type_ir::inherent::{self as innate}; //~ ERROR non-glob import of `rustc_type_ir::inherent`
}

fn main() {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:17:9
|
LL | use rustc_type_ir::inherent::Predicate;
| ^^^^^^^^^^^^^^^^^^^^^^^^^---------
| |
| help: try using a glob import instead: `*`
|
note: the lint level is defined here
--> $DIR/non_glob_import_of_type_ir_inherent.rs:4:9
|
LL | #![deny(rustc::non_glob_import_of_type_ir_inherent)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:18:35
|
LL | use rustc_type_ir::inherent::{AdtDef, Ty};
| ^^^^^^ help: try using a glob import instead: `*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:18:43
|
LL | use rustc_type_ir::inherent::{AdtDef, Ty};
| ^^ help: try using a glob import instead: `*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:21:9
|
LL | use rustc_type_ir::inherent::ParamEnv as _;
| ^^^^^^^^^^^^^^^^^^^^^^^^^-------------
| |
| help: try using a glob import instead: `*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:25:9
|
LL | use rustc_type_ir::inherent;
| ^^^^^^^^^^^^^^^^^^^^^^^- help: try using a glob import instead: `::*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:26:9
|
LL | use rustc_type_ir::inherent as inh;
| ^^^^^^^^^^^^^^^^^^^^^^^------- help: try using a glob import instead: `::*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:27:25
|
LL | use rustc_type_ir::{inherent as _};
| ^^^^^^^^----- help: try using a glob import instead: `::*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:34:35
|
LL | use rustc_type_ir::inherent::{self};
| ^^^^ help: try using a glob import instead: `*`

error: non-glob import of `rustc_type_ir::inherent`
--> $DIR/non_glob_import_of_type_ir_inherent.rs:35:35
|
LL | use rustc_type_ir::inherent::{self as innate};
| ^^^^----------
| |
| help: try using a glob import instead: `*`

error: aborting due to 9 previous errors

0 comments on commit 647fdf7

Please sign in to comment.