clippy_lints/src/unnested_or_patterns.rs

   1 #![allow(clippy::wildcard_imports, clippy::enum_glob_use)]
   2
   3 use clippy_utils::ast_utils::{eq_field_pat, eq_id, eq_pat, eq_path};
   4 use clippy_utils::diagnostics::span_lint_and_then;
   5 use clippy_utils::over;
   6 use rustc_ast::mut_visit::*;
   7 use rustc_ast::ptr::P;
   8 use rustc_ast::{self as ast, 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_session::{declare_lint_pass, declare_tool_lint};
  13 use rustc_span::DUMMY_SP;
  14
  15 use std::cell::Cell;
  16 use std::mem;
  17
  18 declare_clippy_lint! {
  19     /// **What it does:**
  20     ///
  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)`.
  23     ///
  24     /// Another way to think of this is that it rewrites patterns in
  25     /// *disjunctive normal form (DNF)* into *conjunctive normal form (CNF)*.
  26     ///
  27     /// **Why is this bad?**
  28     ///
  29     /// In the example above, `Some` is repeated, which unncessarily complicates the pattern.
  30     ///
  31     /// **Known problems:** None.
  32     ///
  33     /// **Example:**
  34     ///
  35     /// ```rust
  36     /// fn main() {
  37     ///     if let Some(0) | Some(2) = Some(0) {}
  38     /// }
  39     /// ```
  40     /// Use instead:
  41     /// ```rust
  42     /// #![feature(or_patterns)]
  43     ///
  44     /// fn main() {
  45     ///     if let Some(0 | 2) = Some(0) {}
  46     /// }
  47     /// ```
  48     pub UNNESTED_OR_PATTERNS,
  49     pedantic,
  50     "unnested or-patterns, e.g., `Foo(Bar) | Foo(Baz) instead of `Foo(Bar | Baz)`"
  51 }
  52
  53 declare_lint_pass!(UnnestedOrPatterns => [UNNESTED_OR_PATTERNS]);
  54
  55 impl EarlyLintPass for UnnestedOrPatterns {
  56     fn check_arm(&mut self, cx: &EarlyContext<'_>, a: &ast::Arm) {
  57         lint_unnested_or_patterns(cx, &a.pat);
  58     }
  59
  60     fn check_expr(&mut self, cx: &EarlyContext<'_>, e: &ast::Expr) {
  61         if let ast::ExprKind::Let(pat, _) = &e.kind {
  62             lint_unnested_or_patterns(cx, pat);
  63         }
  64     }
  65
  66     fn check_param(&mut self, cx: &EarlyContext<'_>, p: &ast::Param) {
  67         lint_unnested_or_patterns(cx, &p.pat);
  68     }
  69
  70     fn check_local(&mut self, cx: &EarlyContext<'_>, l: &ast::Local) {
  71         lint_unnested_or_patterns(cx, &l.pat);
  72     }
  73 }
  74
  75 fn lint_unnested_or_patterns(cx: &EarlyContext<'_>, pat: &Pat) {
  76     if let Ident(.., None) | Lit(_) | Wild | Path(..) | Range(..) | Rest | MacCall(_) = pat.kind {
  77         // This is a leaf pattern, so cloning is unprofitable.
  78         return;
  79     }
  80
  81     let mut pat = P(pat.clone());
  82
  83     // Nix all the paren patterns everywhere so that they aren't in our way.
  84     remove_all_parens(&mut pat);
  85
  86     // Transform all unnested or-patterns into nested ones, and if there were none, quit.
  87     if !unnest_or_patterns(&mut pat) {
  88         return;
  89     }
  90
  91     span_lint_and_then(cx, UNNESTED_OR_PATTERNS, pat.span, "unnested or-patterns", |db| {
  92         insert_necessary_parens(&mut pat);
  93         db.span_suggestion_verbose(
  94             pat.span,
  95             "nest the patterns",
  96             pprust::pat_to_string(&pat),
  97             Applicability::MachineApplicable,
  98         );
  99     });
 100 }
 101
 102 /// Remove all `(p)` patterns in `pat`.
 103 fn remove_all_parens(pat: &mut P<Pat>) {
 104     struct Visitor;
 105     impl MutVisitor for Visitor {
 106         fn visit_pat(&mut self, pat: &mut P<Pat>) {
 107             noop_visit_pat(pat, self);
 108             let inner = match &mut pat.kind {
 109                 Paren(i) => mem::replace(&mut i.kind, Wild),
 110                 _ => return,
 111             };
 112             pat.kind = inner;
 113         }
 114     }
 115     Visitor.visit_pat(pat);
 116 }
 117
 118 /// Insert parens where necessary according to Rust's precedence rules for patterns.
 119 fn insert_necessary_parens(pat: &mut P<Pat>) {
 120     struct Visitor;
 121     impl MutVisitor for Visitor {
 122         fn visit_pat(&mut self, pat: &mut P<Pat>) {
 123             use ast::{BindingMode::*, Mutability::*};
 124             noop_visit_pat(pat, self);
 125             let target = match &mut pat.kind {
 126                 // `i @ a | b`, `box a | b`, and `& mut? a | b`.
 127                 Ident(.., Some(p)) | Box(p) | Ref(p, _) if matches!(&p.kind, Or(ps) if ps.len() > 1) => p,
 128                 Ref(p, Not) if matches!(p.kind, Ident(ByValue(Mut), ..)) => p, // `&(mut x)`
 129                 _ => return,
 130             };
 131             target.kind = Paren(P(take_pat(target)));
 132         }
 133     }
 134     Visitor.visit_pat(pat);
 135 }
 136
 137 /// Unnest or-patterns `p0 | ... | p1` in the pattern `pat`.
 138 /// For example, this would transform `Some(0) | FOO | Some(2)` into `Some(0 | 2) | FOO`.
 139 fn unnest_or_patterns(pat: &mut P<Pat>) -> bool {
 140     struct Visitor {
 141         changed: bool,
 142     }
 143     impl MutVisitor for Visitor {
 144         fn visit_pat(&mut self, p: &mut P<Pat>) {
 145             // This is a bottom up transformation, so recurse first.
 146             noop_visit_pat(p, self);
 147
 148             // Don't have an or-pattern? Just quit early on.
 149             let alternatives = match &mut p.kind {
 150                 Or(ps) => ps,
 151                 _ => return,
 152             };
 153
 154             // Collapse or-patterns directly nested in or-patterns.
 155             let mut idx = 0;
 156             let mut this_level_changed = false;
 157             while idx < alternatives.len() {
 158                 let inner = if let Or(ps) = &mut alternatives[idx].kind {
 159                     mem::take(ps)
 160                 } else {
 161                     idx += 1;
 162                     continue;
 163                 };
 164                 this_level_changed = true;
 165                 alternatives.splice(idx..=idx, inner);
 166             }
 167
 168             // Focus on `p_n` and then try to transform all `p_i` where `i > n`.
 169             let mut focus_idx = 0;
 170             while focus_idx < alternatives.len() {
 171                 this_level_changed |= transform_with_focus_on_idx(alternatives, focus_idx);
 172                 focus_idx += 1;
 173             }
 174             self.changed |= this_level_changed;
 175
 176             // Deal with `Some(Some(0)) | Some(Some(1))`.
 177             if this_level_changed {
 178                 noop_visit_pat(p, self);
 179             }
 180         }
 181     }
 182
 183     let mut visitor = Visitor { changed: false };
 184     visitor.visit_pat(pat);
 185     visitor.changed
 186 }
 187
 188 /// Match `$scrutinee` against `$pat` and extract `$then` from it.
 189 /// Panics if there is no match.
 190 macro_rules! always_pat {
 191     ($scrutinee:expr, $pat:pat => $then:expr) => {
 192         match $scrutinee {
 193             $pat => $then,
 194             _ => unreachable!(),
 195         }
 196     };
 197 }
 198
 199 /// Focus on `focus_idx` in `alternatives`,
 200 /// attempting to extend it with elements of the same constructor `C`
 201 /// in `alternatives[focus_idx + 1..]`.
 202 fn transform_with_focus_on_idx(alternatives: &mut Vec<P<Pat>>, focus_idx: usize) -> bool {
 203     // Extract the kind; we'll need to make some changes in it.
 204     let mut focus_kind = mem::replace(&mut alternatives[focus_idx].kind, PatKind::Wild);
 205     // We'll focus on `alternatives[focus_idx]`,
 206     // so we're draining from `alternatives[focus_idx + 1..]`.
 207     let start = focus_idx + 1;
 208
 209     // We're trying to find whatever kind (~"constructor") we found in `alternatives[start..]`.
 210     let changed = match &mut focus_kind {
 211         // These pattern forms are "leafs" and do not have sub-patterns.
 212         // Therefore they are not some form of constructor `C`,
 213         // with which a pattern `C(p_0)` may be formed,
 214         // which we would want to join with other `C(p_j)`s.
 215         Ident(.., None) | Lit(_) | Wild | Path(..) | Range(..) | Rest | MacCall(_)
 216         // Dealt with elsewhere.
 217         | Or(_) | Paren(_) => false,
 218         // Transform `box x | ... | box y` into `box (x | y)`.
 219         //
 220         // The cases below until `Slice(...)` deal with *singleton* products.
 221         // These patterns have the shape `C(p)`, and not e.g., `C(p0, ..., pn)`.
 222         Box(target) => extend_with_matching(
 223             target, start, alternatives,
 224             |k| matches!(k, Box(_)),
 225             |k| always_pat!(k, Box(p) => p),
 226         ),
 227         // Transform `&m x | ... | &m y` into `&m (x | y)`.
 228         Ref(target, m1) => extend_with_matching(
 229             target, start, alternatives,
 230             |k| matches!(k, Ref(_, m2) if m1 == m2), // Mutabilities must match.
 231             |k| always_pat!(k, Ref(p, _) => p),
 232         ),
 233         // Transform `b @ p0 | ... b @ p1` into `b @ (p0 | p1)`.
 234         Ident(b1, i1, Some(target)) => extend_with_matching(
 235             target, start, alternatives,
 236             // Binding names must match.
 237             |k| matches!(k, Ident(b2, i2, Some(_)) if b1 == b2 && eq_id(*i1, *i2)),
 238             |k| always_pat!(k, Ident(_, _, Some(p)) => p),
 239         ),
 240         // Transform `[pre, x, post] | ... | [pre, y, post]` into `[pre, x | y, post]`.
 241         Slice(ps1) => extend_with_matching_product(
 242             ps1, start, alternatives,
 243             |k, ps1, idx| matches!(k, Slice(ps2) if eq_pre_post(ps1, ps2, idx)),
 244             |k| always_pat!(k, Slice(ps) => ps),
 245         ),
 246         // Transform `(pre, x, post) | ... | (pre, y, post)` into `(pre, x | y, post)`.
 247         Tuple(ps1) => extend_with_matching_product(
 248             ps1, start, alternatives,
 249             |k, ps1, idx| matches!(k, Tuple(ps2) if eq_pre_post(ps1, ps2, idx)),
 250             |k| always_pat!(k, Tuple(ps) => ps),
 251         ),
 252         // Transform `S(pre, x, post) | ... | S(pre, y, post)` into `S(pre, x | y, post)`.
 253         TupleStruct(path1, ps1) => extend_with_matching_product(
 254             ps1, start, alternatives,
 255             |k, ps1, idx| matches!(
 256                 k,
 257                 TupleStruct(path2, ps2) if eq_path(path1, path2) && eq_pre_post(ps1, ps2, idx)
 258             ),
 259             |k| always_pat!(k, TupleStruct(_, ps) => ps),
 260         ),
 261         // Transform a record pattern `S { fp_0, ..., fp_n }`.
 262         Struct(path1, fps1, rest1) => extend_with_struct_pat(path1, fps1, *rest1, start, alternatives),
 263     };
 264
 265     alternatives[focus_idx].kind = focus_kind;
 266     changed
 267 }
 268
 269 /// Here we focusing on a record pattern `S { fp_0, ..., fp_n }`.
 270 /// In particular, for a record pattern, the order in which the field patterns is irrelevant.
 271 /// So when we fixate on some `ident_k: pat_k`, we try to find `ident_k` in the other pattern
 272 /// and check that all `fp_i` where `i ∈ ((0...n) \ k)` between two patterns are equal.
 273 fn extend_with_struct_pat(
 274     path1: &ast::Path,
 275     fps1: &mut Vec<ast::PatField>,
 276     rest1: bool,
 277     start: usize,
 278     alternatives: &mut Vec<P<Pat>>,
 279 ) -> bool {
 280     (0..fps1.len()).any(|idx| {
 281         let pos_in_2 = Cell::new(None); // The element `k`.
 282         let tail_or = drain_matching(
 283             start,
 284             alternatives,
 285             |k| {
 286                 matches!(k, Struct(path2, fps2, rest2)
 287                 if rest1 == *rest2 // If one struct pattern has `..` so must the other.
 288                 && eq_path(path1, path2)
 289                 && fps1.len() == fps2.len()
 290                 && fps1.iter().enumerate().all(|(idx_1, fp1)| {
 291                     if idx_1 == idx {
 292                         // In the case of `k`, we merely require identical field names
 293                         // so that we will transform into `ident_k: p1_k | p2_k`.
 294                         let pos = fps2.iter().position(|fp2| eq_id(fp1.ident, fp2.ident));
 295                         pos_in_2.set(pos);
 296                         pos.is_some()
 297                     } else {
 298                         fps2.iter().any(|fp2| eq_field_pat(fp1, fp2))
 299                     }
 300                 }))
 301             },
 302             // Extract `p2_k`.
 303             |k| always_pat!(k, Struct(_, mut fps, _) => fps.swap_remove(pos_in_2.take().unwrap()).pat),
 304         );
 305         extend_with_tail_or(&mut fps1[idx].pat, tail_or)
 306     })
 307 }
 308
 309 /// Like `extend_with_matching` but for products with > 1 factor, e.g., `C(p_0, ..., p_n)`.
 310 /// Here, the idea is that we fixate on some `p_k` in `C`,
 311 /// allowing it to vary between two `targets` and `ps2` (returned by `extract`),
 312 /// while also requiring `ps1[..n] ~ ps2[..n]` (pre) and `ps1[n + 1..] ~ ps2[n + 1..]` (post),
 313 /// where `~` denotes semantic equality.
 314 fn extend_with_matching_product(
 315     targets: &mut Vec<P<Pat>>,
 316     start: usize,
 317     alternatives: &mut Vec<P<Pat>>,
 318     predicate: impl Fn(&PatKind, &[P<Pat>], usize) -> bool,
 319     extract: impl Fn(PatKind) -> Vec<P<Pat>>,
 320 ) -> bool {
 321     (0..targets.len()).any(|idx| {
 322         let tail_or = drain_matching(
 323             start,
 324             alternatives,
 325             |k| predicate(k, targets, idx),
 326             |k| extract(k).swap_remove(idx),
 327         );
 328         extend_with_tail_or(&mut targets[idx], tail_or)
 329     })
 330 }
 331
 332 /// Extract the pattern from the given one and replace it with `Wild`.
 333 /// This is meant for temporarily swapping out the pattern for manipulation.
 334 fn take_pat(from: &mut Pat) -> Pat {
 335     let dummy = Pat {
 336         id: DUMMY_NODE_ID,
 337         kind: Wild,
 338         span: DUMMY_SP,
 339         tokens: None,
 340     };
 341     mem::replace(from, dummy)
 342 }
 343
 344 /// Extend `target` as an or-pattern with the alternatives
 345 /// in `tail_or` if there are any and return if there were.
 346 fn extend_with_tail_or(target: &mut Pat, tail_or: Vec<P<Pat>>) -> bool {
 347     fn extend(target: &mut Pat, mut tail_or: Vec<P<Pat>>) {
 348         match target {
 349             // On an existing or-pattern in the target, append to it.
 350             Pat { kind: Or(ps), .. } => ps.append(&mut tail_or),
 351             // Otherwise convert the target to an or-pattern.
 352             target => {
 353                 let mut init_or = vec![P(take_pat(target))];
 354                 init_or.append(&mut tail_or);
 355                 target.kind = Or(init_or);
 356             },
 357         }
 358     }
 359
 360     let changed = !tail_or.is_empty();
 361     if changed {
 362         // Extend the target.
 363         extend(target, tail_or);
 364     }
 365     changed
 366 }
 367
 368 // Extract all inner patterns in `alternatives` matching our `predicate`.
 369 // Only elements beginning with `start` are considered for extraction.
 370 fn drain_matching(
 371     start: usize,
 372     alternatives: &mut Vec<P<Pat>>,
 373     predicate: impl Fn(&PatKind) -> bool,
 374     extract: impl Fn(PatKind) -> P<Pat>,
 375 ) -> Vec<P<Pat>> {
 376     let mut tail_or = vec![];
 377     let mut idx = 0;
 378     for pat in alternatives.drain_filter(|p| {
 379         // Check if we should extract, but only if `idx >= start`.
 380         idx += 1;
 381         idx > start && predicate(&p.kind)
 382     }) {
 383         tail_or.push(extract(pat.into_inner().kind));
 384     }
 385     tail_or
 386 }
 387
 388 fn extend_with_matching(
 389     target: &mut Pat,
 390     start: usize,
 391     alternatives: &mut Vec<P<Pat>>,
 392     predicate: impl Fn(&PatKind) -> bool,
 393     extract: impl Fn(PatKind) -> P<Pat>,
 394 ) -> bool {
 395     extend_with_tail_or(target, drain_matching(start, alternatives, predicate, extract))
 396 }
 397
 398 /// Are the patterns in `ps1` and `ps2` equal save for `ps1[idx]` compared to `ps2[idx]`?
 399 fn eq_pre_post(ps1: &[P<Pat>], ps2: &[P<Pat>], idx: usize) -> bool {
 400     ps1.len() == ps2.len()
 401         && ps1[idx].is_rest() == ps2[idx].is_rest() // Avoid `[x, ..] | [x, 0]` => `[x, .. | 0]`.
 402         && over(&ps1[..idx], &ps2[..idx], |l, r| eq_pat(l, r))
 403         && over(&ps1[idx + 1..], &ps2[idx + 1..], |l, r| eq_pat(l, r))
 404 }