1 #![allow(clippy::wildcard_imports, clippy::enum_glob_use)]
3 use clippy_utils::ast_utils::{eq_field_pat, eq_id, eq_maybe_qself, eq_pat, eq_path};
4 use clippy_utils::diagnostics::span_lint_and_then;
5 use clippy_utils::{meets_msrv, msrvs, over};
6 use rustc_ast::mut_visit::*;
8 use rustc_ast::{self as ast, Mutability, Pat, PatKind, PatKind::*, DUMMY_NODE_ID};
9 use rustc_ast_pretty::pprust;
10 use rustc_errors::Applicability;
11 use rustc_lint::{EarlyContext, EarlyLintPass};
12 use rustc_semver::RustcVersion;
13 use rustc_session::{declare_tool_lint, impl_lint_pass};
14 use rustc_span::DUMMY_SP;
19 declare_clippy_lint! {
21 /// Checks for unnested or-patterns, e.g., `Some(0) | Some(2)` and
22 /// suggests replacing the pattern with a nested one, `Some(0 | 2)`.
24 /// Another way to think of this is that it rewrites patterns in
25 /// *disjunctive normal form (DNF)* into *conjunctive normal form (CNF)*.
27 /// ### Why is this bad?
28 /// In the example above, `Some` is repeated, which unnecessarily complicates the pattern.
33 /// if let Some(0) | Some(2) = Some(0) {}
39 /// if let Some(0 | 2) = Some(0) {}
42 #[clippy::version = "1.46.0"]
43 pub UNNESTED_OR_PATTERNS,
45 "unnested or-patterns, e.g., `Foo(Bar) | Foo(Baz) instead of `Foo(Bar | Baz)`"
48 #[derive(Clone, Copy)]
49 pub struct UnnestedOrPatterns {
50 msrv: Option<RustcVersion>,
53 impl UnnestedOrPatterns {
55 pub fn new(msrv: Option<RustcVersion>) -> Self {
60 impl_lint_pass!(UnnestedOrPatterns => [UNNESTED_OR_PATTERNS]);
62 impl EarlyLintPass for UnnestedOrPatterns {
63 fn check_arm(&mut self, cx: &EarlyContext<'_>, a: &ast::Arm) {
64 if meets_msrv(self.msrv, msrvs::OR_PATTERNS) {
65 lint_unnested_or_patterns(cx, &a.pat);
69 fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
70 if meets_msrv(self.msrv, msrvs::OR_PATTERNS) {
71 if let ast::ExprKind::Let(pat, _, _) = &e.kind {
72 lint_unnested_or_patterns(cx, pat);
77 fn check_param(&mut self, cx: &EarlyContext<'_>, p: &ast::Param) {
78 if meets_msrv(self.msrv, msrvs::OR_PATTERNS) {
79 lint_unnested_or_patterns(cx, &p.pat);
83 fn check_local(&mut self, cx: &EarlyContext<'_>, l: &ast::Local) {
84 if meets_msrv(self.msrv, msrvs::OR_PATTERNS) {
85 lint_unnested_or_patterns(cx, &l.pat);
89 extract_msrv_attr!(EarlyContext);
92 fn lint_unnested_or_patterns(cx: &EarlyContext<'_>, pat: &Pat) {
93 if let Ident(.., None) | Lit(_) | Wild | Path(..) | Range(..) | Rest | MacCall(_) = pat.kind {
94 // This is a leaf pattern, so cloning is unprofitable.
98 let mut pat = P(pat.clone());
100 // Nix all the paren patterns everywhere so that they aren't in our way.
101 remove_all_parens(&mut pat);
103 // Transform all unnested or-patterns into nested ones, and if there were none, quit.
104 if !unnest_or_patterns(&mut pat) {
108 span_lint_and_then(cx, UNNESTED_OR_PATTERNS, pat.span, "unnested or-patterns", |db| {
109 insert_necessary_parens(&mut pat);
110 db.span_suggestion_verbose(
113 pprust::pat_to_string(&pat),
114 Applicability::MachineApplicable,
119 /// Remove all `(p)` patterns in `pat`.
120 fn remove_all_parens(pat: &mut P<Pat>) {
122 impl MutVisitor for Visitor {
123 fn visit_pat(&mut self, pat: &mut P<Pat>) {
124 noop_visit_pat(pat, self);
125 let inner = match &mut pat.kind {
126 Paren(i) => mem::replace(&mut i.kind, Wild),
132 Visitor.visit_pat(pat);
135 /// Insert parens where necessary according to Rust's precedence rules for patterns.
136 fn insert_necessary_parens(pat: &mut P<Pat>) {
138 impl MutVisitor for Visitor {
139 fn visit_pat(&mut self, pat: &mut P<Pat>) {
140 use ast::{BindingMode::*, Mutability::*};
141 noop_visit_pat(pat, self);
142 let target = match &mut pat.kind {
143 // `i @ a | b`, `box a | b`, and `& mut? a | b`.
144 Ident(.., Some(p)) | Box(p) | Ref(p, _) if matches!(&p.kind, Or(ps) if ps.len() > 1) => p,
145 Ref(p, Not) if matches!(p.kind, Ident(ByValue(Mut), ..)) => p, // `&(mut x)`
148 target.kind = Paren(P(take_pat(target)));
151 Visitor.visit_pat(pat);
154 /// Unnest or-patterns `p0 | ... | p1` in the pattern `pat`.
155 /// For example, this would transform `Some(0) | FOO | Some(2)` into `Some(0 | 2) | FOO`.
156 fn unnest_or_patterns(pat: &mut P<Pat>) -> bool {
160 impl MutVisitor for Visitor {
161 fn visit_pat(&mut self, p: &mut P<Pat>) {
162 // This is a bottom up transformation, so recurse first.
163 noop_visit_pat(p, self);
165 // Don't have an or-pattern? Just quit early on.
166 let alternatives = match &mut p.kind {
171 // Collapse or-patterns directly nested in or-patterns.
173 let mut this_level_changed = false;
174 while idx < alternatives.len() {
175 let inner = if let Or(ps) = &mut alternatives[idx].kind {
181 this_level_changed = true;
182 alternatives.splice(idx..=idx, inner);
185 // Focus on `p_n` and then try to transform all `p_i` where `i > n`.
186 let mut focus_idx = 0;
187 while focus_idx < alternatives.len() {
188 this_level_changed |= transform_with_focus_on_idx(alternatives, focus_idx);
191 self.changed |= this_level_changed;
193 // Deal with `Some(Some(0)) | Some(Some(1))`.
194 if this_level_changed {
195 noop_visit_pat(p, self);
200 let mut visitor = Visitor { changed: false };
201 visitor.visit_pat(pat);
205 /// Match `$scrutinee` against `$pat` and extract `$then` from it.
206 /// Panics if there is no match.
207 macro_rules! always_pat {
208 ($scrutinee:expr, $pat:pat => $then:expr) => {
216 /// Focus on `focus_idx` in `alternatives`,
217 /// attempting to extend it with elements of the same constructor `C`
218 /// in `alternatives[focus_idx + 1..]`.
219 fn transform_with_focus_on_idx(alternatives: &mut Vec<P<Pat>>, focus_idx: usize) -> bool {
220 // Extract the kind; we'll need to make some changes in it.
221 let mut focus_kind = mem::replace(&mut alternatives[focus_idx].kind, PatKind::Wild);
222 // We'll focus on `alternatives[focus_idx]`,
223 // so we're draining from `alternatives[focus_idx + 1..]`.
224 let start = focus_idx + 1;
226 // We're trying to find whatever kind (~"constructor") we found in `alternatives[start..]`.
227 let changed = match &mut focus_kind {
228 // These pattern forms are "leafs" and do not have sub-patterns.
229 // Therefore they are not some form of constructor `C`,
230 // with which a pattern `C(p_0)` may be formed,
231 // which we would want to join with other `C(p_j)`s.
232 Ident(.., None) | Lit(_) | Wild | Path(..) | Range(..) | Rest | MacCall(_)
233 // Skip immutable refs, as grouping them saves few characters,
234 // and almost always requires adding parens (increasing noisiness).
235 // In the case of only two patterns, replacement adds net characters.
236 | Ref(_, Mutability::Not)
237 // Dealt with elsewhere.
238 | Or(_) | Paren(_) => false,
239 // Transform `box x | ... | box y` into `box (x | y)`.
241 // The cases below until `Slice(...)` deal with *singleton* products.
242 // These patterns have the shape `C(p)`, and not e.g., `C(p0, ..., pn)`.
243 Box(target) => extend_with_matching(
244 target, start, alternatives,
245 |k| matches!(k, Box(_)),
246 |k| always_pat!(k, Box(p) => p),
248 // Transform `&mut x | ... | &mut y` into `&mut (x | y)`.
249 Ref(target, Mutability::Mut) => extend_with_matching(
250 target, start, alternatives,
251 |k| matches!(k, Ref(_, Mutability::Mut)),
252 |k| always_pat!(k, Ref(p, _) => p),
254 // Transform `b @ p0 | ... b @ p1` into `b @ (p0 | p1)`.
255 Ident(b1, i1, Some(target)) => extend_with_matching(
256 target, start, alternatives,
257 // Binding names must match.
258 |k| matches!(k, Ident(b2, i2, Some(_)) if b1 == b2 && eq_id(*i1, *i2)),
259 |k| always_pat!(k, Ident(_, _, Some(p)) => p),
261 // Transform `[pre, x, post] | ... | [pre, y, post]` into `[pre, x | y, post]`.
262 Slice(ps1) => extend_with_matching_product(
263 ps1, start, alternatives,
264 |k, ps1, idx| matches!(k, Slice(ps2) if eq_pre_post(ps1, ps2, idx)),
265 |k| always_pat!(k, Slice(ps) => ps),
267 // Transform `(pre, x, post) | ... | (pre, y, post)` into `(pre, x | y, post)`.
268 Tuple(ps1) => extend_with_matching_product(
269 ps1, start, alternatives,
270 |k, ps1, idx| matches!(k, Tuple(ps2) if eq_pre_post(ps1, ps2, idx)),
271 |k| always_pat!(k, Tuple(ps) => ps),
273 // Transform `S(pre, x, post) | ... | S(pre, y, post)` into `S(pre, x | y, post)`.
274 TupleStruct(qself1, path1, ps1) => extend_with_matching_product(
275 ps1, start, alternatives,
276 |k, ps1, idx| matches!(
278 TupleStruct(qself2, path2, ps2)
279 if eq_maybe_qself(qself1, qself2) && eq_path(path1, path2) && eq_pre_post(ps1, ps2, idx)
281 |k| always_pat!(k, TupleStruct(_, _, ps) => ps),
283 // Transform a record pattern `S { fp_0, ..., fp_n }`.
284 Struct(qself1, path1, fps1, rest1) => extend_with_struct_pat(qself1, path1, fps1, *rest1, start, alternatives),
287 alternatives[focus_idx].kind = focus_kind;
291 /// Here we focusing on a record pattern `S { fp_0, ..., fp_n }`.
292 /// In particular, for a record pattern, the order in which the field patterns is irrelevant.
293 /// So when we fixate on some `ident_k: pat_k`, we try to find `ident_k` in the other pattern
294 /// and check that all `fp_i` where `i ∈ ((0...n) \ k)` between two patterns are equal.
295 fn extend_with_struct_pat(
296 qself1: &Option<ast::QSelf>,
298 fps1: &mut [ast::PatField],
301 alternatives: &mut Vec<P<Pat>>,
303 (0..fps1.len()).any(|idx| {
304 let pos_in_2 = Cell::new(None); // The element `k`.
305 let tail_or = drain_matching(
309 matches!(k, Struct(qself2, path2, fps2, rest2)
310 if rest1 == *rest2 // If one struct pattern has `..` so must the other.
311 && eq_maybe_qself(qself1, qself2)
312 && eq_path(path1, path2)
313 && fps1.len() == fps2.len()
314 && fps1.iter().enumerate().all(|(idx_1, fp1)| {
316 // In the case of `k`, we merely require identical field names
317 // so that we will transform into `ident_k: p1_k | p2_k`.
318 let pos = fps2.iter().position(|fp2| eq_id(fp1.ident, fp2.ident));
322 fps2.iter().any(|fp2| eq_field_pat(fp1, fp2))
327 |k| always_pat!(k, Struct(_, _, mut fps, _) => fps.swap_remove(pos_in_2.take().unwrap()).pat),
329 extend_with_tail_or(&mut fps1[idx].pat, tail_or)
333 /// Like `extend_with_matching` but for products with > 1 factor, e.g., `C(p_0, ..., p_n)`.
334 /// Here, the idea is that we fixate on some `p_k` in `C`,
335 /// allowing it to vary between two `targets` and `ps2` (returned by `extract`),
336 /// while also requiring `ps1[..n] ~ ps2[..n]` (pre) and `ps1[n + 1..] ~ ps2[n + 1..]` (post),
337 /// where `~` denotes semantic equality.
338 fn extend_with_matching_product(
339 targets: &mut [P<Pat>],
341 alternatives: &mut Vec<P<Pat>>,
342 predicate: impl Fn(&PatKind, &[P<Pat>], usize) -> bool,
343 extract: impl Fn(PatKind) -> Vec<P<Pat>>,
345 (0..targets.len()).any(|idx| {
346 let tail_or = drain_matching(
349 |k| predicate(k, targets, idx),
350 |k| extract(k).swap_remove(idx),
352 extend_with_tail_or(&mut targets[idx], tail_or)
356 /// Extract the pattern from the given one and replace it with `Wild`.
357 /// This is meant for temporarily swapping out the pattern for manipulation.
358 fn take_pat(from: &mut Pat) -> Pat {
365 mem::replace(from, dummy)
368 /// Extend `target` as an or-pattern with the alternatives
369 /// in `tail_or` if there are any and return if there were.
370 fn extend_with_tail_or(target: &mut Pat, tail_or: Vec<P<Pat>>) -> bool {
371 fn extend(target: &mut Pat, mut tail_or: Vec<P<Pat>>) {
373 // On an existing or-pattern in the target, append to it.
374 Pat { kind: Or(ps), .. } => ps.append(&mut tail_or),
375 // Otherwise convert the target to an or-pattern.
377 let mut init_or = vec![P(take_pat(target))];
378 init_or.append(&mut tail_or);
379 target.kind = Or(init_or);
384 let changed = !tail_or.is_empty();
386 // Extend the target.
387 extend(target, tail_or);
392 // Extract all inner patterns in `alternatives` matching our `predicate`.
393 // Only elements beginning with `start` are considered for extraction.
396 alternatives: &mut Vec<P<Pat>>,
397 predicate: impl Fn(&PatKind) -> bool,
398 extract: impl Fn(PatKind) -> P<Pat>,
400 let mut tail_or = vec![];
402 for pat in alternatives.drain_filter(|p| {
403 // Check if we should extract, but only if `idx >= start`.
405 idx > start && predicate(&p.kind)
407 tail_or.push(extract(pat.into_inner().kind));
412 fn extend_with_matching(
415 alternatives: &mut Vec<P<Pat>>,
416 predicate: impl Fn(&PatKind) -> bool,
417 extract: impl Fn(PatKind) -> P<Pat>,
419 extend_with_tail_or(target, drain_matching(start, alternatives, predicate, extract))
422 /// Are the patterns in `ps1` and `ps2` equal save for `ps1[idx]` compared to `ps2[idx]`?
423 fn eq_pre_post(ps1: &[P<Pat>], ps2: &[P<Pat>], idx: usize) -> bool {
424 ps1.len() == ps2.len()
425 && ps1[idx].is_rest() == ps2[idx].is_rest() // Avoid `[x, ..] | [x, 0]` => `[x, .. | 0]`.
426 && over(&ps1[..idx], &ps2[..idx], |l, r| eq_pat(l, r))
427 && over(&ps1[idx + 1..], &ps2[idx + 1..], |l, r| eq_pat(l, r))