Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Finishing touches for #[expect] (RFC 2383) #98507

Merged
merged 3 commits into from
Jul 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion compiler/rustc_lint/src/context.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ use rustc_middle::middle::stability;
use rustc_middle::ty::layout::{LayoutError, LayoutOfHelpers, TyAndLayout};
use rustc_middle::ty::print::with_no_trimmed_paths;
use rustc_middle::ty::{self, print::Printer, subst::GenericArg, RegisteredTools, Ty, TyCtxt};
use rustc_session::lint::BuiltinLintDiagnostics;
use rustc_session::lint::{BuiltinLintDiagnostics, LintExpectationId};
use rustc_session::lint::{FutureIncompatibleInfo, Level, Lint, LintBuffer, LintId};
use rustc_session::Session;
use rustc_span::lev_distance::find_best_match_for_name;
Expand Down Expand Up @@ -887,6 +887,29 @@ pub trait LintContext: Sized {
) {
self.lookup(lint, None as Option<Span>, decorate);
}

/// This returns the lint level for the given lint at the current location.
fn get_lint_level(&self, lint: &'static Lint) -> Level;

/// This function can be used to manually fulfill an expectation. This can
/// be used for lints which contain several spans, and should be suppressed,
/// if either location was marked with an expectation.
///
/// Note that this function should only be called for [`LintExpectationId`]s
/// retrieved from the current lint pass. Buffered or manually created ids can
/// cause ICEs.
fn fulfill_expectation(&self, expectation: LintExpectationId) {
// We need to make sure that submitted expectation ids are correctly fulfilled suppressed
// and stored between compilation sessions. To not manually do these steps, we simply create
// a dummy diagnostic and emit is as usual, which will be suppressed and stored like a normal
// expected lint diagnostic.
self.sess()
.struct_expect(
"this is a dummy diagnostic, to submit and store an expectation",
expectation,
)
.emit();
}
}

impl<'a> EarlyContext<'a> {
Expand Down Expand Up @@ -934,6 +957,10 @@ impl LintContext for LateContext<'_> {
None => self.tcx.struct_lint_node(lint, hir_id, decorate),
}
}

fn get_lint_level(&self, lint: &'static Lint) -> Level {
self.tcx.lint_level_at_node(lint, self.last_node_with_lint_attrs).0
}
}

impl LintContext for EarlyContext<'_> {
Expand All @@ -956,6 +983,10 @@ impl LintContext for EarlyContext<'_> {
) {
self.builder.struct_lint(lint, span.map(|s| s.into()), decorate)
}

fn get_lint_level(&self, lint: &'static Lint) -> Level {
self.builder.lint_level(lint).0
}
}

impl<'tcx> LateContext<'tcx> {
Expand Down
5 changes: 5 additions & 0 deletions compiler/rustc_lint_defs/src/builtin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,11 @@ declare_lint! {
/// The `expect` attribute can be removed if this is intended behavior otherwise
/// it should be investigated why the expected lint is no longer issued.
///
/// In rare cases, the expectation might be emitted at a different location than
/// shown in the shown code snippet. In most cases, the `#[expect]` attribute
/// works when added to the outer scope. A few lints can only be expected
/// on a crate level.
///
/// Part of RFC 2383. The progress is being tracked in [#54503]
///
/// [#54503]: https://github.com/rust-lang/rust/issues/54503
Expand Down
7 changes: 7 additions & 0 deletions compiler/rustc_lint_defs/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,13 @@ impl Level {
Level::Deny | Level::Forbid => true,
}
}

pub fn get_expectation_id(&self) -> Option<LintExpectationId> {
match self {
Level::Expect(id) | Level::ForceWarn(Some(id)) => Some(*id),
_ => None,
}
}
}

/// Specification of a single lint.
Expand Down
22 changes: 20 additions & 2 deletions src/tools/clippy/clippy_lints/src/duplicate_mod.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use clippy_utils::diagnostics::span_lint_and_help;
use rustc_ast::ast::{Crate, Inline, Item, ItemKind, ModKind};
use rustc_errors::MultiSpan;
use rustc_lint::{EarlyContext, EarlyLintPass, LintContext};
use rustc_lint::{EarlyContext, EarlyLintPass, LintContext, Level};
use rustc_session::{declare_tool_lint, impl_lint_pass};
use rustc_span::{FileName, Span};
use std::collections::BTreeMap;
Expand Down Expand Up @@ -49,6 +49,7 @@ declare_clippy_lint! {
struct Modules {
local_path: PathBuf,
spans: Vec<Span>,
lint_levels: Vec<Level>,
}

#[derive(Default)]
Expand All @@ -70,13 +71,30 @@ impl EarlyLintPass for DuplicateMod {
let modules = self.modules.entry(absolute_path).or_insert(Modules {
local_path,
spans: Vec::new(),
lint_levels: Vec::new(),
});
modules.spans.push(item.span_with_attributes());
modules.lint_levels.push(cx.get_lint_level(DUPLICATE_MOD));
}
}

fn check_crate_post(&mut self, cx: &EarlyContext<'_>, _: &Crate) {
for Modules { local_path, spans } in self.modules.values() {
for Modules { local_path, spans, lint_levels } in self.modules.values() {
if spans.len() < 2 {
continue;
}

// At this point the lint would be emitted
assert_eq!(spans.len(), lint_levels.len());
let spans: Vec<_> = spans.into_iter().zip(lint_levels).filter_map(|(span, lvl)|{
if let Some(id) = lvl.get_expectation_id() {
cx.fulfill_expectation(id);
}

(!matches!(lvl, Level::Allow | Level::Expect(_))).then_some(*span)
})
.collect();

if spans.len() < 2 {
continue;
}
Expand Down
Empty file.
13 changes: 13 additions & 0 deletions src/tools/clippy/tests/ui-cargo/duplicate_mod/fail/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#[feature(lint_reasons)]

mod a;

mod b;
Expand All @@ -13,4 +15,15 @@ mod c3;
mod from_other_module;
mod other_module;

mod d;
xFrednet marked this conversation as resolved.
Show resolved Hide resolved
#[path = "d.rs"]
mod d2;
#[path = "d.rs"]
#[expect(clippy::duplicate_mod)]
mod d3;
#[path = "d.rs"]
#[allow(clippy::duplicate_mod)]
mod d4;


fn main() {}
19 changes: 15 additions & 4 deletions src/tools/clippy/tests/ui-cargo/duplicate_mod/fail/src/main.stderr
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
error: file is loaded as a module multiple times: `$DIR/b.rs`
--> $DIR/main.rs:3:1
--> $DIR/main.rs:5:1
|
LL | mod b;
| ^^^^^^ first loaded here
Expand All @@ -11,7 +11,7 @@ LL | | mod b2;
= help: replace all but one `mod` item with `use` items

error: file is loaded as a module multiple times: `$DIR/c.rs`
--> $DIR/main.rs:7:1
--> $DIR/main.rs:9:1
|
LL | mod c;
| ^^^^^^ first loaded here
Expand All @@ -25,7 +25,7 @@ LL | | mod c3;
= help: replace all but one `mod` item with `use` items

error: file is loaded as a module multiple times: `$DIR/from_other_module.rs`
--> $DIR/main.rs:13:1
--> $DIR/main.rs:15:1
|
LL | mod from_other_module;
| ^^^^^^^^^^^^^^^^^^^^^^ first loaded here
Expand All @@ -38,5 +38,16 @@ LL | | mod m;
|
= help: replace all but one `mod` item with `use` items

error: aborting due to 3 previous errors
error: file is loaded as a module multiple times: `$DIR/b.rs`
--> $DIR/main.rs:18:1
|
LL | mod d;
| ^^^^^^ first loaded here
LL | / #[path = "d.rs"]
LL | | mod d2;
| |_______^ loaded again here
|
= help: replace all but one `mod` item with `use` items

error: aborting due to 4 previous errors