1 use clippy_utils::diagnostics::span_lint_and_then;
2 use clippy_utils::meets_msrv;
3 use clippy_utils::source::snippet_opt;
4 use if_chain::if_chain;
5 use rustc_ast::ast::{Attribute, Item, ItemKind, StructField, Variant, VariantData, VisibilityKind};
6 use rustc_attr as attr;
7 use rustc_errors::Applicability;
8 use rustc_lint::{EarlyContext, EarlyLintPass};
9 use rustc_semver::RustcVersion;
10 use rustc_session::{declare_tool_lint, impl_lint_pass};
11 use rustc_span::{sym, Span};
13 const MANUAL_NON_EXHAUSTIVE_MSRV: RustcVersion = RustcVersion::new(1, 40, 0);
15 declare_clippy_lint! {
16 /// **What it does:** Checks for manual implementations of the non-exhaustive pattern.
18 /// **Why is this bad?** Using the #[non_exhaustive] attribute expresses better the intent
19 /// and allows possible optimizations when applied to enums.
21 /// **Known problems:** None.
39 /// struct T(pub i32, pub i32, ());
56 /// struct T(pub i32, pub i32);
58 pub MANUAL_NON_EXHAUSTIVE,
60 "manual implementations of the non-exhaustive pattern can be simplified using #[non_exhaustive]"
64 pub struct ManualNonExhaustive {
65 msrv: Option<RustcVersion>,
68 impl ManualNonExhaustive {
70 pub fn new(msrv: Option<RustcVersion>) -> Self {
75 impl_lint_pass!(ManualNonExhaustive => [MANUAL_NON_EXHAUSTIVE]);
77 impl EarlyLintPass for ManualNonExhaustive {
78 fn check_item(&mut self, cx: &EarlyContext<'_>, item: &Item) {
79 if !meets_msrv(self.msrv.as_ref(), &MANUAL_NON_EXHAUSTIVE_MSRV) {
84 ItemKind::Enum(def, _) => {
85 check_manual_non_exhaustive_enum(cx, item, &def.variants);
87 ItemKind::Struct(variant_data, _) => {
88 if let VariantData::Unit(..) = variant_data {
92 check_manual_non_exhaustive_struct(cx, item, variant_data);
98 extract_msrv_attr!(EarlyContext);
101 fn check_manual_non_exhaustive_enum(cx: &EarlyContext<'_>, item: &Item, variants: &[Variant]) {
102 fn is_non_exhaustive_marker(variant: &Variant) -> bool {
103 matches!(variant.data, VariantData::Unit(_))
104 && variant.ident.as_str().starts_with('_')
105 && variant.attrs.iter().any(|a| is_doc_hidden(a))
108 fn is_doc_hidden(attr: &Attribute) -> bool {
109 attr.has_name(sym::doc)
110 && match attr.meta_item_list() {
111 Some(l) => attr::list_contains_name(&l, sym::hidden),
117 let mut markers = variants.iter().filter(|v| is_non_exhaustive_marker(v));
118 if let Some(marker) = markers.next();
119 if markers.count() == 0 && variants.len() > 1;
123 MANUAL_NON_EXHAUSTIVE,
125 "this seems like a manual implementation of the non-exhaustive pattern",
128 if !item.attrs.iter().any(|attr| attr.has_name(sym::non_exhaustive));
129 let header_span = cx.sess.source_map().span_until_char(item.span, '{');
130 if let Some(snippet) = snippet_opt(cx, header_span);
132 diag.span_suggestion(
135 format!("#[non_exhaustive] {}", snippet),
136 Applicability::Unspecified,
140 diag.span_help(marker.span, "remove this variant");
146 fn check_manual_non_exhaustive_struct(cx: &EarlyContext<'_>, item: &Item, data: &VariantData) {
147 fn is_private(field: &StructField) -> bool {
148 matches!(field.vis.kind, VisibilityKind::Inherited)
151 fn is_non_exhaustive_marker(field: &StructField) -> bool {
152 is_private(field) && field.ty.kind.is_unit() && field.ident.map_or(true, |n| n.as_str().starts_with('_'))
155 fn find_header_span(cx: &EarlyContext<'_>, item: &Item, data: &VariantData) -> Span {
156 let delimiter = match data {
157 VariantData::Struct(..) => '{',
158 VariantData::Tuple(..) => '(',
159 VariantData::Unit(_) => unreachable!("`VariantData::Unit` is already handled above"),
162 cx.sess.source_map().span_until_char(item.span, delimiter)
165 let fields = data.fields();
166 let private_fields = fields.iter().filter(|f| is_private(f)).count();
167 let public_fields = fields.iter().filter(|f| f.vis.kind.is_pub()).count();
170 if private_fields == 1 && public_fields >= 1 && public_fields == fields.len() - 1;
171 if let Some(marker) = fields.iter().find(|f| is_non_exhaustive_marker(f));
175 MANUAL_NON_EXHAUSTIVE,
177 "this seems like a manual implementation of the non-exhaustive pattern",
180 if !item.attrs.iter().any(|attr| attr.has_name(sym::non_exhaustive));
181 let header_span = find_header_span(cx, item, data);
182 if let Some(snippet) = snippet_opt(cx, header_span);
184 diag.span_suggestion(
187 format!("#[non_exhaustive] {}", snippet),
188 Applicability::Unspecified,
192 diag.span_help(marker.span, "remove this field");