Skip to content

Commit b92cccb

Browse files
Port #[must_use] to new attribute parsing infrastructure
Signed-off-by: Jonathan Brouwer <jonathantbrouwer@gmail.com>
1 parent 953bf2b commit b92cccb

File tree

4 files changed

+40
-20
lines changed

4 files changed

+40
-20
lines changed

clippy_lints/src/functions/must_use.rs

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,17 @@ use clippy_utils::ty::is_must_use_ty;
1515
use clippy_utils::visitors::for_each_expr_without_closures;
1616
use clippy_utils::{return_ty, trait_ref_of_method};
1717
use rustc_trait_selection::error_reporting::InferCtxtErrorExt;
18+
use rustc_attr_data_structures::AttributeKind;
19+
use rustc_span::Symbol;
20+
use rustc_attr_data_structures::find_attr;
1821

1922
use core::ops::ControlFlow;
2023

2124
use super::{DOUBLE_MUST_USE, MUST_USE_CANDIDATE, MUST_USE_UNIT};
2225

2326
pub(super) fn check_item<'tcx>(cx: &LateContext<'tcx>, item: &'tcx hir::Item<'_>) {
2427
let attrs = cx.tcx.hir_attrs(item.hir_id());
25-
let attr = cx.tcx.get_attr(item.owner_id, sym::must_use);
28+
let attr = find_attr!(cx.tcx.hir_attrs(item.hir_id()), AttributeKind::MustUse { span, reason } => (span, reason));
2629
if let hir::ItemKind::Fn {
2730
ref sig,
2831
body: ref body_id,
@@ -31,8 +34,8 @@ pub(super) fn check_item<'tcx>(cx: &LateContext<'tcx>, item: &'tcx hir::Item<'_>
3134
{
3235
let is_public = cx.effective_visibilities.is_exported(item.owner_id.def_id);
3336
let fn_header_span = item.span.with_hi(sig.decl.output.span().hi());
34-
if let Some(attr) = attr {
35-
check_needless_must_use(cx, sig.decl, item.owner_id, item.span, fn_header_span, attr, attrs, sig);
37+
if let Some((attr_span, reason)) = attr {
38+
check_needless_must_use(cx, sig.decl, item.owner_id, item.span, fn_header_span, *attr_span, *reason, attrs, sig);
3639
} else if is_public && !is_proc_macro(attrs) && !attrs.iter().any(|a| a.has_name(sym::no_mangle)) {
3740
check_must_use_candidate(
3841
cx,
@@ -52,9 +55,9 @@ pub(super) fn check_impl_item<'tcx>(cx: &LateContext<'tcx>, item: &'tcx hir::Imp
5255
let is_public = cx.effective_visibilities.is_exported(item.owner_id.def_id);
5356
let fn_header_span = item.span.with_hi(sig.decl.output.span().hi());
5457
let attrs = cx.tcx.hir_attrs(item.hir_id());
55-
let attr = cx.tcx.get_attr(item.owner_id, sym::must_use);
56-
if let Some(attr) = attr {
57-
check_needless_must_use(cx, sig.decl, item.owner_id, item.span, fn_header_span, attr, attrs, sig);
58+
let attr = find_attr!(cx.tcx.hir_attrs(item.hir_id()), AttributeKind::MustUse { span, reason } => (span, reason));
59+
if let Some((attr_span, reason)) = attr {
60+
check_needless_must_use(cx, sig.decl, item.owner_id, item.span, fn_header_span, *attr_span, *reason, attrs, sig);
5861
} else if is_public && !is_proc_macro(attrs) && trait_ref_of_method(cx, item.owner_id).is_none() {
5962
check_must_use_candidate(
6063
cx,
@@ -75,9 +78,9 @@ pub(super) fn check_trait_item<'tcx>(cx: &LateContext<'tcx>, item: &'tcx hir::Tr
7578
let fn_header_span = item.span.with_hi(sig.decl.output.span().hi());
7679

7780
let attrs = cx.tcx.hir_attrs(item.hir_id());
78-
let attr = cx.tcx.get_attr(item.owner_id, sym::must_use);
79-
if let Some(attr) = attr {
80-
check_needless_must_use(cx, sig.decl, item.owner_id, item.span, fn_header_span, attr, attrs, sig);
81+
let attr = find_attr!(cx.tcx.hir_attrs(item.hir_id()), AttributeKind::MustUse { span, reason } => (span, reason));
82+
if let Some((attr_span, reason)) = attr {
83+
check_needless_must_use(cx, sig.decl, item.owner_id, item.span, fn_header_span, *attr_span, *reason, attrs, sig);
8184
} else if let hir::TraitFn::Provided(eid) = *eid {
8285
let body = cx.tcx.hir_body(eid);
8386
if attr.is_none() && is_public && !is_proc_macro(attrs) {
@@ -103,7 +106,8 @@ fn check_needless_must_use(
103106
item_id: hir::OwnerId,
104107
item_span: Span,
105108
fn_header_span: Span,
106-
attr: &Attribute,
109+
attr_span: Span,
110+
reason: Option<Symbol>,
107111
attrs: &[Attribute],
108112
sig: &FnSig<'_>,
109113
) {
@@ -119,7 +123,7 @@ fn check_needless_must_use(
119123
"this unit-returning function has a `#[must_use]` attribute",
120124
|diag| {
121125
diag.span_suggestion(
122-
attr.span(),
126+
attr_span,
123127
"remove the attribute",
124128
"",
125129
Applicability::MachineApplicable,
@@ -137,11 +141,11 @@ fn check_needless_must_use(
137141
MUST_USE_UNIT,
138142
fn_header_span,
139143
"this unit-returning function has a `#[must_use]` attribute",
140-
Some(attr.span()),
144+
Some(attr_span),
141145
"remove `must_use`",
142146
);
143147
}
144-
} else if attr.value_str().is_none() && is_must_use_ty(cx, return_ty(cx, item_id)) {
148+
} else if reason.is_none() && is_must_use_ty(cx, return_ty(cx, item_id)) {
145149
// Ignore async functions unless Future::Output type is a must_use type
146150
if sig.header.is_async() {
147151
let infcx = cx.tcx.infer_ctxt().build(cx.typing_mode());

clippy_lints/src/return_self_not_must_use.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ use rustc_hir::intravisit::FnKind;
66
use rustc_hir::{Body, FnDecl, OwnerId, TraitItem, TraitItemKind};
77
use rustc_lint::{LateContext, LateLintPass, LintContext};
88
use rustc_session::declare_lint_pass;
9-
use rustc_span::{Span, sym};
9+
use rustc_span::{Span};
10+
use rustc_attr_data_structures::AttributeKind;
11+
use rustc_attr_data_structures::find_attr;
1012

1113
declare_clippy_lint! {
1214
/// ### What it does
@@ -74,7 +76,10 @@ fn check_method(cx: &LateContext<'_>, decl: &FnDecl<'_>, fn_def: LocalDefId, spa
7476
// We only show this warning for public exported methods.
7577
&& cx.effective_visibilities.is_exported(fn_def)
7678
// We don't want to emit this lint if the `#[must_use]` attribute is already there.
77-
&& !cx.tcx.hir_attrs(owner_id.into()).iter().any(|attr| attr.has_name(sym::must_use))
79+
&& !find_attr!(
80+
cx.tcx.hir_attrs(owner_id.into()),
81+
AttributeKind::MustUse { .. }
82+
)
7883
&& cx.tcx.visibility(fn_def.to_def_id()).is_public()
7984
&& let ret_ty = return_ty(cx, owner_id)
8085
&& let self_arg = nth_arg(cx, owner_id, 0)

clippy_utils/src/lib.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1886,7 +1886,10 @@ pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
18861886
_ => None,
18871887
};
18881888

1889-
did.is_some_and(|did| cx.tcx.has_attr(did, sym::must_use))
1889+
did.is_some_and(|did| find_attr!(
1890+
cx.tcx.get_all_attrs(did),
1891+
AttributeKind::MustUse { ..}
1892+
))
18901893
}
18911894

18921895
/// Checks if a function's body represents the identity function. Looks for bodies of the form:

clippy_utils/src/ty/mod.rs

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ use rustc_trait_selection::traits::{Obligation, ObligationCause};
3131
use std::assert_matches::debug_assert_matches;
3232
use std::collections::hash_map::Entry;
3333
use std::iter;
34+
use rustc_attr_data_structures::find_attr;
35+
use rustc_attr_data_structures::AttributeKind;
3436

3537
use crate::path_res;
3638
use crate::paths::{PathNS, lookup_path_str};
@@ -326,8 +328,14 @@ pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
326328
// Returns whether the type has #[must_use] attribute
327329
pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
328330
match ty.kind() {
329-
ty::Adt(adt, _) => cx.tcx.has_attr(adt.did(), sym::must_use),
330-
ty::Foreign(did) => cx.tcx.has_attr(*did, sym::must_use),
331+
ty::Adt(adt, _) => find_attr!(
332+
cx.tcx.get_all_attrs(adt.did()),
333+
AttributeKind::MustUse { ..}
334+
),
335+
ty::Foreign(did) => find_attr!(
336+
cx.tcx.get_all_attrs(*did),
337+
AttributeKind::MustUse { ..}
338+
),
331339
ty::Slice(ty) | ty::Array(ty, _) | ty::RawPtr(ty, _) | ty::Ref(_, ty, _) => {
332340
// for the Array case we don't need to care for the len == 0 case
333341
// because we don't want to lint functions returning empty arrays
@@ -337,7 +345,7 @@ pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
337345
ty::Alias(ty::Opaque, AliasTy { def_id, .. }) => {
338346
for (predicate, _) in cx.tcx.explicit_item_self_bounds(def_id).skip_binder() {
339347
if let ty::ClauseKind::Trait(trait_predicate) = predicate.kind().skip_binder()
340-
&& cx.tcx.has_attr(trait_predicate.trait_ref.def_id, sym::must_use)
348+
&& find_attr!(cx.tcx.get_all_attrs(trait_predicate.trait_ref.def_id), AttributeKind::MustUse { ..})
341349
{
342350
return true;
343351
}
@@ -347,7 +355,7 @@ pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
347355
ty::Dynamic(binder, _, _) => {
348356
for predicate in *binder {
349357
if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate.skip_binder()
350-
&& cx.tcx.has_attr(trait_ref.def_id, sym::must_use)
358+
&& find_attr!(cx.tcx.get_all_attrs(trait_ref.def_id), AttributeKind::MustUse { ..})
351359
{
352360
return true;
353361
}

0 commit comments

Comments
 (0)