]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/matches.rs
Eat collapsible_match dogfood
[rust.git] / clippy_lints / src / matches.rs
1 use crate::consts::{constant, miri_to_const, Constant};
2 use crate::utils::sugg::Sugg;
3 use crate::utils::usage::is_unused;
4 use crate::utils::{
5     expr_block, get_arg_name, get_parent_expr, in_macro, indent_of, is_allowed, is_expn_of, is_refutable,
6     is_type_diagnostic_item, is_wild, match_qpath, match_type, match_var, meets_msrv, multispan_sugg, remove_blocks,
7     snippet, snippet_block, snippet_with_applicability, span_lint_and_help, span_lint_and_note, span_lint_and_sugg,
8     span_lint_and_then,
9 };
10 use crate::utils::{paths, search_same, SpanlessEq, SpanlessHash};
11 use if_chain::if_chain;
12 use rustc_ast::ast::LitKind;
13 use rustc_data_structures::fx::FxHashMap;
14 use rustc_errors::Applicability;
15 use rustc_hir::def::CtorKind;
16 use rustc_hir::{
17     Arm, BindingAnnotation, Block, BorrowKind, Expr, ExprKind, Guard, Local, MatchSource, Mutability, Node, Pat,
18     PatKind, QPath, RangeEnd,
19 };
20 use rustc_lint::{LateContext, LateLintPass, LintContext};
21 use rustc_middle::lint::in_external_macro;
22 use rustc_middle::ty::{self, Ty, TyS};
23 use rustc_session::{declare_tool_lint, impl_lint_pass};
24 use rustc_span::source_map::{Span, Spanned};
25 use rustc_span::{sym, Symbol};
26 use semver::{Version, VersionReq};
27 use std::cmp::Ordering;
28 use std::collections::hash_map::Entry;
29 use std::collections::Bound;
30
31 declare_clippy_lint! {
32     /// **What it does:** Checks for matches with a single arm where an `if let`
33     /// will usually suffice.
34     ///
35     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
36     ///
37     /// **Known problems:** None.
38     ///
39     /// **Example:**
40     /// ```rust
41     /// # fn bar(stool: &str) {}
42     /// # let x = Some("abc");
43     /// // Bad
44     /// match x {
45     ///     Some(ref foo) => bar(foo),
46     ///     _ => (),
47     /// }
48     ///
49     /// // Good
50     /// if let Some(ref foo) = x {
51     ///     bar(foo);
52     /// }
53     /// ```
54     pub SINGLE_MATCH,
55     style,
56     "a `match` statement with a single nontrivial arm (i.e., where the other arm is `_ => {}`) instead of `if let`"
57 }
58
59 declare_clippy_lint! {
60     /// **What it does:** Checks for matches with two arms where an `if let else` will
61     /// usually suffice.
62     ///
63     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
64     ///
65     /// **Known problems:** Personal style preferences may differ.
66     ///
67     /// **Example:**
68     ///
69     /// Using `match`:
70     ///
71     /// ```rust
72     /// # fn bar(foo: &usize) {}
73     /// # let other_ref: usize = 1;
74     /// # let x: Option<&usize> = Some(&1);
75     /// match x {
76     ///     Some(ref foo) => bar(foo),
77     ///     _ => bar(&other_ref),
78     /// }
79     /// ```
80     ///
81     /// Using `if let` with `else`:
82     ///
83     /// ```rust
84     /// # fn bar(foo: &usize) {}
85     /// # let other_ref: usize = 1;
86     /// # let x: Option<&usize> = Some(&1);
87     /// if let Some(ref foo) = x {
88     ///     bar(foo);
89     /// } else {
90     ///     bar(&other_ref);
91     /// }
92     /// ```
93     pub SINGLE_MATCH_ELSE,
94     pedantic,
95     "a `match` statement with two arms where the second arm's pattern is a placeholder instead of a specific match pattern"
96 }
97
98 declare_clippy_lint! {
99     /// **What it does:** Checks for matches where all arms match a reference,
100     /// suggesting to remove the reference and deref the matched expression
101     /// instead. It also checks for `if let &foo = bar` blocks.
102     ///
103     /// **Why is this bad?** It just makes the code less readable. That reference
104     /// destructuring adds nothing to the code.
105     ///
106     /// **Known problems:** None.
107     ///
108     /// **Example:**
109     /// ```rust,ignore
110     /// // Bad
111     /// match x {
112     ///     &A(ref y) => foo(y),
113     ///     &B => bar(),
114     ///     _ => frob(&x),
115     /// }
116     ///
117     /// // Good
118     /// match *x {
119     ///     A(ref y) => foo(y),
120     ///     B => bar(),
121     ///     _ => frob(x),
122     /// }
123     /// ```
124     pub MATCH_REF_PATS,
125     style,
126     "a `match` or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
127 }
128
129 declare_clippy_lint! {
130     /// **What it does:** Checks for matches where match expression is a `bool`. It
131     /// suggests to replace the expression with an `if...else` block.
132     ///
133     /// **Why is this bad?** It makes the code less readable.
134     ///
135     /// **Known problems:** None.
136     ///
137     /// **Example:**
138     /// ```rust
139     /// # fn foo() {}
140     /// # fn bar() {}
141     /// let condition: bool = true;
142     /// match condition {
143     ///     true => foo(),
144     ///     false => bar(),
145     /// }
146     /// ```
147     /// Use if/else instead:
148     /// ```rust
149     /// # fn foo() {}
150     /// # fn bar() {}
151     /// let condition: bool = true;
152     /// if condition {
153     ///     foo();
154     /// } else {
155     ///     bar();
156     /// }
157     /// ```
158     pub MATCH_BOOL,
159     pedantic,
160     "a `match` on a boolean expression instead of an `if..else` block"
161 }
162
163 declare_clippy_lint! {
164     /// **What it does:** Checks for overlapping match arms.
165     ///
166     /// **Why is this bad?** It is likely to be an error and if not, makes the code
167     /// less obvious.
168     ///
169     /// **Known problems:** None.
170     ///
171     /// **Example:**
172     /// ```rust
173     /// let x = 5;
174     /// match x {
175     ///     1...10 => println!("1 ... 10"),
176     ///     5...15 => println!("5 ... 15"),
177     ///     _ => (),
178     /// }
179     /// ```
180     pub MATCH_OVERLAPPING_ARM,
181     style,
182     "a `match` with overlapping arms"
183 }
184
185 declare_clippy_lint! {
186     /// **What it does:** Checks for arm which matches all errors with `Err(_)`
187     /// and take drastic actions like `panic!`.
188     ///
189     /// **Why is this bad?** It is generally a bad practice, similar to
190     /// catching all exceptions in java with `catch(Exception)`
191     ///
192     /// **Known problems:** None.
193     ///
194     /// **Example:**
195     /// ```rust
196     /// let x: Result<i32, &str> = Ok(3);
197     /// match x {
198     ///     Ok(_) => println!("ok"),
199     ///     Err(_) => panic!("err"),
200     /// }
201     /// ```
202     pub MATCH_WILD_ERR_ARM,
203     pedantic,
204     "a `match` with `Err(_)` arm and take drastic actions"
205 }
206
207 declare_clippy_lint! {
208     /// **What it does:** Checks for match which is used to add a reference to an
209     /// `Option` value.
210     ///
211     /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
212     ///
213     /// **Known problems:** None.
214     ///
215     /// **Example:**
216     /// ```rust
217     /// let x: Option<()> = None;
218     ///
219     /// // Bad
220     /// let r: Option<&()> = match x {
221     ///     None => None,
222     ///     Some(ref v) => Some(v),
223     /// };
224     ///
225     /// // Good
226     /// let r: Option<&()> = x.as_ref();
227     /// ```
228     pub MATCH_AS_REF,
229     complexity,
230     "a `match` on an Option value instead of using `as_ref()` or `as_mut`"
231 }
232
233 declare_clippy_lint! {
234     /// **What it does:** Checks for wildcard enum matches using `_`.
235     ///
236     /// **Why is this bad?** New enum variants added by library updates can be missed.
237     ///
238     /// **Known problems:** Suggested replacements may be incorrect if guards exhaustively cover some
239     /// variants, and also may not use correct path to enum if it's not present in the current scope.
240     ///
241     /// **Example:**
242     /// ```rust
243     /// # enum Foo { A(usize), B(usize) }
244     /// # let x = Foo::B(1);
245     /// // Bad
246     /// match x {
247     ///     Foo::A(_) => {},
248     ///     _ => {},
249     /// }
250     ///
251     /// // Good
252     /// match x {
253     ///     Foo::A(_) => {},
254     ///     Foo::B(_) => {},
255     /// }
256     /// ```
257     pub WILDCARD_ENUM_MATCH_ARM,
258     restriction,
259     "a wildcard enum match arm using `_`"
260 }
261
262 declare_clippy_lint! {
263     /// **What it does:** Checks for wildcard enum matches for a single variant.
264     ///
265     /// **Why is this bad?** New enum variants added by library updates can be missed.
266     ///
267     /// **Known problems:** Suggested replacements may not use correct path to enum
268     /// if it's not present in the current scope.
269     ///
270     /// **Example:**
271     ///
272     /// ```rust
273     /// # enum Foo { A, B, C }
274     /// # let x = Foo::B;
275     /// // Bad
276     /// match x {
277     ///     Foo::A => {},
278     ///     Foo::B => {},
279     ///     _ => {},
280     /// }
281     ///
282     /// // Good
283     /// match x {
284     ///     Foo::A => {},
285     ///     Foo::B => {},
286     ///     Foo::C => {},
287     /// }
288     /// ```
289     pub MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
290     pedantic,
291     "a wildcard enum match for a single variant"
292 }
293
294 declare_clippy_lint! {
295     /// **What it does:** Checks for wildcard pattern used with others patterns in same match arm.
296     ///
297     /// **Why is this bad?** Wildcard pattern already covers any other pattern as it will match anyway.
298     /// It makes the code less readable, especially to spot wildcard pattern use in match arm.
299     ///
300     /// **Known problems:** None.
301     ///
302     /// **Example:**
303     /// ```rust
304     /// // Bad
305     /// match "foo" {
306     ///     "a" => {},
307     ///     "bar" | _ => {},
308     /// }
309     ///
310     /// // Good
311     /// match "foo" {
312     ///     "a" => {},
313     ///     _ => {},
314     /// }
315     /// ```
316     pub WILDCARD_IN_OR_PATTERNS,
317     complexity,
318     "a wildcard pattern used with others patterns in same match arm"
319 }
320
321 declare_clippy_lint! {
322     /// **What it does:** Checks for matches being used to destructure a single-variant enum
323     /// or tuple struct where a `let` will suffice.
324     ///
325     /// **Why is this bad?** Just readability – `let` doesn't nest, whereas a `match` does.
326     ///
327     /// **Known problems:** None.
328     ///
329     /// **Example:**
330     /// ```rust
331     /// enum Wrapper {
332     ///     Data(i32),
333     /// }
334     ///
335     /// let wrapper = Wrapper::Data(42);
336     ///
337     /// let data = match wrapper {
338     ///     Wrapper::Data(i) => i,
339     /// };
340     /// ```
341     ///
342     /// The correct use would be:
343     /// ```rust
344     /// enum Wrapper {
345     ///     Data(i32),
346     /// }
347     ///
348     /// let wrapper = Wrapper::Data(42);
349     /// let Wrapper::Data(data) = wrapper;
350     /// ```
351     pub INFALLIBLE_DESTRUCTURING_MATCH,
352     style,
353     "a `match` statement with a single infallible arm instead of a `let`"
354 }
355
356 declare_clippy_lint! {
357     /// **What it does:** Checks for useless match that binds to only one value.
358     ///
359     /// **Why is this bad?** Readability and needless complexity.
360     ///
361     /// **Known problems:**  Suggested replacements may be incorrect when `match`
362     /// is actually binding temporary value, bringing a 'dropped while borrowed' error.
363     ///
364     /// **Example:**
365     /// ```rust
366     /// # let a = 1;
367     /// # let b = 2;
368     ///
369     /// // Bad
370     /// match (a, b) {
371     ///     (c, d) => {
372     ///         // useless match
373     ///     }
374     /// }
375     ///
376     /// // Good
377     /// let (c, d) = (a, b);
378     /// ```
379     pub MATCH_SINGLE_BINDING,
380     complexity,
381     "a match with a single binding instead of using `let` statement"
382 }
383
384 declare_clippy_lint! {
385     /// **What it does:** Checks for unnecessary '..' pattern binding on struct when all fields are explicitly matched.
386     ///
387     /// **Why is this bad?** Correctness and readability. It's like having a wildcard pattern after
388     /// matching all enum variants explicitly.
389     ///
390     /// **Known problems:** None.
391     ///
392     /// **Example:**
393     /// ```rust
394     /// # struct A { a: i32 }
395     /// let a = A { a: 5 };
396     ///
397     /// // Bad
398     /// match a {
399     ///     A { a: 5, .. } => {},
400     ///     _ => {},
401     /// }
402     ///
403     /// // Good
404     /// match a {
405     ///     A { a: 5 } => {},
406     ///     _ => {},
407     /// }
408     /// ```
409     pub REST_PAT_IN_FULLY_BOUND_STRUCTS,
410     restriction,
411     "a match on a struct that binds all fields but still uses the wildcard pattern"
412 }
413
414 declare_clippy_lint! {
415     /// **What it does:** Lint for redundant pattern matching over `Result`, `Option`,
416     /// `std::task::Poll` or `std::net::IpAddr`
417     ///
418     /// **Why is this bad?** It's more concise and clear to just use the proper
419     /// utility function
420     ///
421     /// **Known problems:** None.
422     ///
423     /// **Example:**
424     ///
425     /// ```rust
426     /// # use std::task::Poll;
427     /// # use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
428     /// if let Ok(_) = Ok::<i32, i32>(42) {}
429     /// if let Err(_) = Err::<i32, i32>(42) {}
430     /// if let None = None::<()> {}
431     /// if let Some(_) = Some(42) {}
432     /// if let Poll::Pending = Poll::Pending::<()> {}
433     /// if let Poll::Ready(_) = Poll::Ready(42) {}
434     /// if let IpAddr::V4(_) = IpAddr::V4(Ipv4Addr::LOCALHOST) {}
435     /// if let IpAddr::V6(_) = IpAddr::V6(Ipv6Addr::LOCALHOST) {}
436     /// match Ok::<i32, i32>(42) {
437     ///     Ok(_) => true,
438     ///     Err(_) => false,
439     /// };
440     /// ```
441     ///
442     /// The more idiomatic use would be:
443     ///
444     /// ```rust
445     /// # use std::task::Poll;
446     /// # use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
447     /// if Ok::<i32, i32>(42).is_ok() {}
448     /// if Err::<i32, i32>(42).is_err() {}
449     /// if None::<()>.is_none() {}
450     /// if Some(42).is_some() {}
451     /// if Poll::Pending::<()>.is_pending() {}
452     /// if Poll::Ready(42).is_ready() {}
453     /// if IpAddr::V4(Ipv4Addr::LOCALHOST).is_ipv4() {}
454     /// if IpAddr::V6(Ipv6Addr::LOCALHOST).is_ipv6() {}
455     /// Ok::<i32, i32>(42).is_ok();
456     /// ```
457     pub REDUNDANT_PATTERN_MATCHING,
458     style,
459     "use the proper utility function avoiding an `if let`"
460 }
461
462 declare_clippy_lint! {
463     /// **What it does:** Checks for `match`  or `if let` expressions producing a
464     /// `bool` that could be written using `matches!`
465     ///
466     /// **Why is this bad?** Readability and needless complexity.
467     ///
468     /// **Known problems:** This lint falsely triggers, if there are arms with
469     /// `cfg` attributes that remove an arm evaluating to `false`.
470     ///
471     /// **Example:**
472     /// ```rust
473     /// let x = Some(5);
474     ///
475     /// // Bad
476     /// let a = match x {
477     ///     Some(0) => true,
478     ///     _ => false,
479     /// };
480     ///
481     /// let a = if let Some(0) = x {
482     ///     true
483     /// } else {
484     ///     false
485     /// };
486     ///
487     /// // Good
488     /// let a = matches!(x, Some(0));
489     /// ```
490     pub MATCH_LIKE_MATCHES_MACRO,
491     style,
492     "a match that could be written with the matches! macro"
493 }
494
495 declare_clippy_lint! {
496     /// **What it does:** Checks for `match` with identical arm bodies.
497     ///
498     /// **Why is this bad?** This is probably a copy & paste error. If arm bodies
499     /// are the same on purpose, you can factor them
500     /// [using `|`](https://doc.rust-lang.org/book/patterns.html#multiple-patterns).
501     ///
502     /// **Known problems:** False positive possible with order dependent `match`
503     /// (see issue
504     /// [#860](https://github.com/rust-lang/rust-clippy/issues/860)).
505     ///
506     /// **Example:**
507     /// ```rust,ignore
508     /// match foo {
509     ///     Bar => bar(),
510     ///     Quz => quz(),
511     ///     Baz => bar(), // <= oops
512     /// }
513     /// ```
514     ///
515     /// This should probably be
516     /// ```rust,ignore
517     /// match foo {
518     ///     Bar => bar(),
519     ///     Quz => quz(),
520     ///     Baz => baz(), // <= fixed
521     /// }
522     /// ```
523     ///
524     /// or if the original code was not a typo:
525     /// ```rust,ignore
526     /// match foo {
527     ///     Bar | Baz => bar(), // <= shows the intent better
528     ///     Quz => quz(),
529     /// }
530     /// ```
531     pub MATCH_SAME_ARMS,
532     pedantic,
533     "`match` with identical arm bodies"
534 }
535
536 #[derive(Default)]
537 pub struct Matches {
538     msrv: Option<VersionReq>,
539     infallible_destructuring_match_linted: bool,
540 }
541
542 impl Matches {
543     #[must_use]
544     pub fn new(msrv: Option<VersionReq>) -> Self {
545         Self {
546             msrv,
547             ..Matches::default()
548         }
549     }
550 }
551
552 impl_lint_pass!(Matches => [
553     SINGLE_MATCH,
554     MATCH_REF_PATS,
555     MATCH_BOOL,
556     SINGLE_MATCH_ELSE,
557     MATCH_OVERLAPPING_ARM,
558     MATCH_WILD_ERR_ARM,
559     MATCH_AS_REF,
560     WILDCARD_ENUM_MATCH_ARM,
561     MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
562     WILDCARD_IN_OR_PATTERNS,
563     MATCH_SINGLE_BINDING,
564     INFALLIBLE_DESTRUCTURING_MATCH,
565     REST_PAT_IN_FULLY_BOUND_STRUCTS,
566     REDUNDANT_PATTERN_MATCHING,
567     MATCH_LIKE_MATCHES_MACRO,
568     MATCH_SAME_ARMS,
569 ]);
570
571 const MATCH_LIKE_MATCHES_MACRO_MSRV: Version = Version {
572     major: 1,
573     minor: 42,
574     patch: 0,
575     pre: Vec::new(),
576     build: Vec::new(),
577 };
578
579 impl<'tcx> LateLintPass<'tcx> for Matches {
580     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
581         if in_external_macro(cx.sess(), expr.span) || in_macro(expr.span) {
582             return;
583         }
584
585         redundant_pattern_match::check(cx, expr);
586
587         if meets_msrv(self.msrv.as_ref(), &MATCH_LIKE_MATCHES_MACRO_MSRV) {
588             if !check_match_like_matches(cx, expr) {
589                 lint_match_arms(cx, expr);
590             }
591         } else {
592             lint_match_arms(cx, expr);
593         }
594
595         if let ExprKind::Match(ref ex, ref arms, MatchSource::Normal) = expr.kind {
596             check_single_match(cx, ex, arms, expr);
597             check_match_bool(cx, ex, arms, expr);
598             check_overlapping_arms(cx, ex, arms);
599             check_wild_err_arm(cx, ex, arms);
600             check_wild_enum_match(cx, ex, arms);
601             check_match_as_ref(cx, ex, arms, expr);
602             check_wild_in_or_pats(cx, arms);
603
604             if self.infallible_destructuring_match_linted {
605                 self.infallible_destructuring_match_linted = false;
606             } else {
607                 check_match_single_binding(cx, ex, arms, expr);
608             }
609         }
610         if let ExprKind::Match(ref ex, ref arms, _) = expr.kind {
611             check_match_ref_pats(cx, ex, arms, expr);
612         }
613     }
614
615     fn check_local(&mut self, cx: &LateContext<'tcx>, local: &'tcx Local<'_>) {
616         if_chain! {
617             if !in_external_macro(cx.sess(), local.span);
618             if !in_macro(local.span);
619             if let Some(ref expr) = local.init;
620             if let ExprKind::Match(ref target, ref arms, MatchSource::Normal) = expr.kind;
621             if arms.len() == 1 && arms[0].guard.is_none();
622             if let PatKind::TupleStruct(
623                 QPath::Resolved(None, ref variant_name), ref args, _) = arms[0].pat.kind;
624             if args.len() == 1;
625             if let Some(arg) = get_arg_name(&args[0]);
626             let body = remove_blocks(&arms[0].body);
627             if match_var(body, arg);
628
629             then {
630                 let mut applicability = Applicability::MachineApplicable;
631                 self.infallible_destructuring_match_linted = true;
632                 span_lint_and_sugg(
633                     cx,
634                     INFALLIBLE_DESTRUCTURING_MATCH,
635                     local.span,
636                     "you seem to be trying to use `match` to destructure a single infallible pattern. \
637                     Consider using `let`",
638                     "try this",
639                     format!(
640                         "let {}({}) = {};",
641                         snippet_with_applicability(cx, variant_name.span, "..", &mut applicability),
642                         snippet_with_applicability(cx, local.pat.span, "..", &mut applicability),
643                         snippet_with_applicability(cx, target.span, "..", &mut applicability),
644                     ),
645                     applicability,
646                 );
647             }
648         }
649     }
650
651     fn check_pat(&mut self, cx: &LateContext<'tcx>, pat: &'tcx Pat<'_>) {
652         if_chain! {
653             if !in_external_macro(cx.sess(), pat.span);
654             if !in_macro(pat.span);
655             if let PatKind::Struct(QPath::Resolved(_, ref path), fields, true) = pat.kind;
656             if let Some(def_id) = path.res.opt_def_id();
657             let ty = cx.tcx.type_of(def_id);
658             if let ty::Adt(def, _) = ty.kind();
659             if def.is_struct() || def.is_union();
660             if fields.len() == def.non_enum_variant().fields.len();
661
662             then {
663                 span_lint_and_help(
664                     cx,
665                     REST_PAT_IN_FULLY_BOUND_STRUCTS,
666                     pat.span,
667                     "unnecessary use of `..` pattern in struct binding. All fields were already bound",
668                     None,
669                     "consider removing `..` from this binding",
670                 );
671             }
672         }
673     }
674
675     extract_msrv_attr!(LateContext);
676 }
677
678 #[rustfmt::skip]
679 fn check_single_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
680     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
681         if in_macro(expr.span) {
682             // Don't lint match expressions present in
683             // macro_rules! block
684             return;
685         }
686         if let PatKind::Or(..) = arms[0].pat.kind {
687             // don't lint for or patterns for now, this makes
688             // the lint noisy in unnecessary situations
689             return;
690         }
691         let els = arms[1].body;
692         let els = if is_unit_expr(remove_blocks(els)) {
693             None
694         } else if let ExprKind::Block(Block { stmts, expr: block_expr, .. }, _) = els.kind {
695             if stmts.len() == 1 && block_expr.is_none() || stmts.is_empty() && block_expr.is_some() {
696                 // single statement/expr "else" block, don't lint
697                 return;
698             } else {
699                 // block with 2+ statements or 1 expr and 1+ statement
700                 Some(els)
701             }
702         } else {
703             // not a block, don't lint
704             return;
705         };
706
707         let ty = cx.typeck_results().expr_ty(ex);
708         if *ty.kind() != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.hir_id) {
709             check_single_match_single_pattern(cx, ex, arms, expr, els);
710             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
711         }
712     }
713 }
714
715 fn check_single_match_single_pattern(
716     cx: &LateContext<'_>,
717     ex: &Expr<'_>,
718     arms: &[Arm<'_>],
719     expr: &Expr<'_>,
720     els: Option<&Expr<'_>>,
721 ) {
722     if is_wild(&arms[1].pat) {
723         report_single_match_single_pattern(cx, ex, arms, expr, els);
724     }
725 }
726
727 fn report_single_match_single_pattern(
728     cx: &LateContext<'_>,
729     ex: &Expr<'_>,
730     arms: &[Arm<'_>],
731     expr: &Expr<'_>,
732     els: Option<&Expr<'_>>,
733 ) {
734     let lint = if els.is_some() { SINGLE_MATCH_ELSE } else { SINGLE_MATCH };
735     let els_str = els.map_or(String::new(), |els| {
736         format!(" else {}", expr_block(cx, els, None, "..", Some(expr.span)))
737     });
738     span_lint_and_sugg(
739         cx,
740         lint,
741         expr.span,
742         "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
743          let`",
744         "try this",
745         format!(
746             "if let {} = {} {}{}",
747             snippet(cx, arms[0].pat.span, ".."),
748             snippet(cx, ex.span, ".."),
749             expr_block(cx, &arms[0].body, None, "..", Some(expr.span)),
750             els_str,
751         ),
752         Applicability::HasPlaceholders,
753     );
754 }
755
756 fn check_single_match_opt_like(
757     cx: &LateContext<'_>,
758     ex: &Expr<'_>,
759     arms: &[Arm<'_>],
760     expr: &Expr<'_>,
761     ty: Ty<'_>,
762     els: Option<&Expr<'_>>,
763 ) {
764     // list of candidate `Enum`s we know will never get any more members
765     let candidates = &[
766         (&paths::COW, "Borrowed"),
767         (&paths::COW, "Cow::Borrowed"),
768         (&paths::COW, "Cow::Owned"),
769         (&paths::COW, "Owned"),
770         (&paths::OPTION, "None"),
771         (&paths::RESULT, "Err"),
772         (&paths::RESULT, "Ok"),
773     ];
774
775     let path = match arms[1].pat.kind {
776         PatKind::TupleStruct(ref path, ref inner, _) => {
777             // Contains any non wildcard patterns (e.g., `Err(err)`)?
778             if !inner.iter().all(is_wild) {
779                 return;
780             }
781             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
782         },
783         PatKind::Binding(BindingAnnotation::Unannotated, .., ident, None) => ident.to_string(),
784         PatKind::Path(ref path) => {
785             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
786         },
787         _ => return,
788     };
789
790     for &(ty_path, pat_path) in candidates {
791         if path == *pat_path && match_type(cx, ty, ty_path) {
792             report_single_match_single_pattern(cx, ex, arms, expr, els);
793         }
794     }
795 }
796
797 fn check_match_bool(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
798     // Type of expression is `bool`.
799     if *cx.typeck_results().expr_ty(ex).kind() == ty::Bool {
800         span_lint_and_then(
801             cx,
802             MATCH_BOOL,
803             expr.span,
804             "you seem to be trying to match on a boolean expression",
805             move |diag| {
806                 if arms.len() == 2 {
807                     // no guards
808                     let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
809                         if let ExprKind::Lit(ref lit) = arm_bool.kind {
810                             match lit.node {
811                                 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
812                                 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
813                                 _ => None,
814                             }
815                         } else {
816                             None
817                         }
818                     } else {
819                         None
820                     };
821
822                     if let Some((true_expr, false_expr)) = exprs {
823                         let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
824                             (false, false) => Some(format!(
825                                 "if {} {} else {}",
826                                 snippet(cx, ex.span, "b"),
827                                 expr_block(cx, true_expr, None, "..", Some(expr.span)),
828                                 expr_block(cx, false_expr, None, "..", Some(expr.span))
829                             )),
830                             (false, true) => Some(format!(
831                                 "if {} {}",
832                                 snippet(cx, ex.span, "b"),
833                                 expr_block(cx, true_expr, None, "..", Some(expr.span))
834                             )),
835                             (true, false) => {
836                                 let test = Sugg::hir(cx, ex, "..");
837                                 Some(format!(
838                                     "if {} {}",
839                                     !test,
840                                     expr_block(cx, false_expr, None, "..", Some(expr.span))
841                                 ))
842                             },
843                             (true, true) => None,
844                         };
845
846                         if let Some(sugg) = sugg {
847                             diag.span_suggestion(
848                                 expr.span,
849                                 "consider using an `if`/`else` expression",
850                                 sugg,
851                                 Applicability::HasPlaceholders,
852                             );
853                         }
854                     }
855                 }
856             },
857         );
858     }
859 }
860
861 fn check_overlapping_arms<'tcx>(cx: &LateContext<'tcx>, ex: &'tcx Expr<'_>, arms: &'tcx [Arm<'_>]) {
862     if arms.len() >= 2 && cx.typeck_results().expr_ty(ex).is_integral() {
863         let ranges = all_ranges(cx, arms, cx.typeck_results().expr_ty(ex));
864         let type_ranges = type_ranges(&ranges);
865         if !type_ranges.is_empty() {
866             if let Some((start, end)) = overlapping(&type_ranges) {
867                 span_lint_and_note(
868                     cx,
869                     MATCH_OVERLAPPING_ARM,
870                     start.span,
871                     "some ranges overlap",
872                     Some(end.span),
873                     "overlaps with this",
874                 );
875             }
876         }
877     }
878 }
879
880 fn check_wild_err_arm(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
881     let ex_ty = cx.typeck_results().expr_ty(ex).peel_refs();
882     if is_type_diagnostic_item(cx, ex_ty, sym::result_type) {
883         for arm in arms {
884             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pat.kind {
885                 let path_str = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false));
886                 if path_str == "Err" {
887                     let mut matching_wild = inner.iter().any(is_wild);
888                     let mut ident_bind_name = String::from("_");
889                     if !matching_wild {
890                         // Looking for unused bindings (i.e.: `_e`)
891                         inner.iter().for_each(|pat| {
892                             if let PatKind::Binding(.., ident, None) = &pat.kind {
893                                 if ident.as_str().starts_with('_') && is_unused(ident, arm.body) {
894                                     ident_bind_name = (&ident.name.as_str()).to_string();
895                                     matching_wild = true;
896                                 }
897                             }
898                         });
899                     }
900                     if_chain! {
901                         if matching_wild;
902                         if let ExprKind::Block(ref block, _) = arm.body.kind;
903                         if is_panic_block(block);
904                         then {
905                             // `Err(_)` or `Err(_e)` arm with `panic!` found
906                             span_lint_and_note(cx,
907                                 MATCH_WILD_ERR_ARM,
908                                 arm.pat.span,
909                                 &format!("`Err({})` matches all errors", &ident_bind_name),
910                                 None,
911                                 "match each error separately or use the error output, or use `.except(msg)` if the error case is unreachable",
912                             );
913                         }
914                     }
915                 }
916             }
917         }
918     }
919 }
920
921 fn check_wild_enum_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
922     let ty = cx.typeck_results().expr_ty(ex);
923     if !ty.is_enum() {
924         // If there isn't a nice closed set of possible values that can be conveniently enumerated,
925         // don't complain about not enumerating the mall.
926         return;
927     }
928
929     // First pass - check for violation, but don't do much book-keeping because this is hopefully
930     // the uncommon case, and the book-keeping is slightly expensive.
931     let mut wildcard_span = None;
932     let mut wildcard_ident = None;
933     for arm in arms {
934         if let PatKind::Wild = arm.pat.kind {
935             wildcard_span = Some(arm.pat.span);
936         } else if let PatKind::Binding(_, _, ident, None) = arm.pat.kind {
937             wildcard_span = Some(arm.pat.span);
938             wildcard_ident = Some(ident);
939         }
940     }
941
942     if let Some(wildcard_span) = wildcard_span {
943         // Accumulate the variants which should be put in place of the wildcard because they're not
944         // already covered.
945
946         let mut missing_variants = vec![];
947         if let ty::Adt(def, _) = ty.kind() {
948             for variant in &def.variants {
949                 missing_variants.push(variant);
950             }
951         }
952
953         for arm in arms {
954             if arm.guard.is_some() {
955                 // Guards mean that this case probably isn't exhaustively covered. Technically
956                 // this is incorrect, as we should really check whether each variant is exhaustively
957                 // covered by the set of guards that cover it, but that's really hard to do.
958                 continue;
959             }
960             if let PatKind::Path(ref path) = arm.pat.kind {
961                 if let QPath::Resolved(_, p) = path {
962                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
963                 }
964             } else if let PatKind::TupleStruct(QPath::Resolved(_, p), ref patterns, ..) = arm.pat.kind {
965                 // Some simple checks for exhaustive patterns.
966                 // There is a room for improvements to detect more cases,
967                 // but it can be more expensive to do so.
968                 let is_pattern_exhaustive =
969                     |pat: &&Pat<'_>| matches!(pat.kind, PatKind::Wild | PatKind::Binding(.., None));
970                 if patterns.iter().all(is_pattern_exhaustive) {
971                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
972                 }
973             }
974         }
975
976         let mut suggestion: Vec<String> = missing_variants
977             .iter()
978             .map(|v| {
979                 let suffix = match v.ctor_kind {
980                     CtorKind::Fn => "(..)",
981                     CtorKind::Const | CtorKind::Fictive => "",
982                 };
983                 let ident_str = if let Some(ident) = wildcard_ident {
984                     format!("{} @ ", ident.name)
985                 } else {
986                     String::new()
987                 };
988                 // This path assumes that the enum type is imported into scope.
989                 format!("{}{}{}", ident_str, cx.tcx.def_path_str(v.def_id), suffix)
990             })
991             .collect();
992
993         if suggestion.is_empty() {
994             return;
995         }
996
997         let mut message = "wildcard match will miss any future added variants";
998
999         if let ty::Adt(def, _) = ty.kind() {
1000             if def.is_variant_list_non_exhaustive() {
1001                 message = "match on non-exhaustive enum doesn't explicitly match all known variants";
1002                 suggestion.push(String::from("_"));
1003             }
1004         }
1005
1006         if suggestion.len() == 1 {
1007             // No need to check for non-exhaustive enum as in that case len would be greater than 1
1008             span_lint_and_sugg(
1009                 cx,
1010                 MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
1011                 wildcard_span,
1012                 message,
1013                 "try this",
1014                 suggestion[0].clone(),
1015                 Applicability::MaybeIncorrect,
1016             )
1017         };
1018
1019         span_lint_and_sugg(
1020             cx,
1021             WILDCARD_ENUM_MATCH_ARM,
1022             wildcard_span,
1023             message,
1024             "try this",
1025             suggestion.join(" | "),
1026             Applicability::MaybeIncorrect,
1027         )
1028     }
1029 }
1030
1031 // If the block contains only a `panic!` macro (as expression or statement)
1032 fn is_panic_block(block: &Block<'_>) -> bool {
1033     match (&block.expr, block.stmts.len(), block.stmts.first()) {
1034         (&Some(ref exp), 0, _) => {
1035             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
1036         },
1037         (&None, 1, Some(stmt)) => {
1038             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
1039         },
1040         _ => false,
1041     }
1042 }
1043
1044 fn check_match_ref_pats(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1045     if has_only_ref_pats(arms) {
1046         let mut suggs = Vec::with_capacity(arms.len() + 1);
1047         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Not, ref inner) = ex.kind {
1048             let span = ex.span.source_callsite();
1049             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
1050             (
1051                 "you don't need to add `&` to both the expression and the patterns",
1052                 "try",
1053             )
1054         } else {
1055             let span = ex.span.source_callsite();
1056             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
1057             (
1058                 "you don't need to add `&` to all patterns",
1059                 "instead of prefixing all patterns with `&`, you can dereference the expression",
1060             )
1061         };
1062
1063         suggs.extend(arms.iter().filter_map(|a| {
1064             if let PatKind::Ref(ref refp, _) = a.pat.kind {
1065                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
1066             } else {
1067                 None
1068             }
1069         }));
1070
1071         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |diag| {
1072             if !expr.span.from_expansion() {
1073                 multispan_sugg(diag, msg, suggs);
1074             }
1075         });
1076     }
1077 }
1078
1079 fn check_match_as_ref(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1080     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
1081         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
1082             is_ref_some_arm(&arms[1])
1083         } else if is_none_arm(&arms[1]) {
1084             is_ref_some_arm(&arms[0])
1085         } else {
1086             None
1087         };
1088         if let Some(rb) = arm_ref {
1089             let suggestion = if rb == BindingAnnotation::Ref {
1090                 "as_ref"
1091             } else {
1092                 "as_mut"
1093             };
1094
1095             let output_ty = cx.typeck_results().expr_ty(expr);
1096             let input_ty = cx.typeck_results().expr_ty(ex);
1097
1098             let cast = if_chain! {
1099                 if let ty::Adt(_, substs) = input_ty.kind();
1100                 let input_ty = substs.type_at(0);
1101                 if let ty::Adt(_, substs) = output_ty.kind();
1102                 let output_ty = substs.type_at(0);
1103                 if let ty::Ref(_, output_ty, _) = *output_ty.kind();
1104                 if input_ty != output_ty;
1105                 then {
1106                     ".map(|x| x as _)"
1107                 } else {
1108                     ""
1109                 }
1110             };
1111
1112             let mut applicability = Applicability::MachineApplicable;
1113             span_lint_and_sugg(
1114                 cx,
1115                 MATCH_AS_REF,
1116                 expr.span,
1117                 &format!("use `{}()` instead", suggestion),
1118                 "try this",
1119                 format!(
1120                     "{}.{}(){}",
1121                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
1122                     suggestion,
1123                     cast,
1124                 ),
1125                 applicability,
1126             )
1127         }
1128     }
1129 }
1130
1131 fn check_wild_in_or_pats(cx: &LateContext<'_>, arms: &[Arm<'_>]) {
1132     for arm in arms {
1133         if let PatKind::Or(ref fields) = arm.pat.kind {
1134             // look for multiple fields in this arm that contains at least one Wild pattern
1135             if fields.len() > 1 && fields.iter().any(is_wild) {
1136                 span_lint_and_help(
1137                     cx,
1138                     WILDCARD_IN_OR_PATTERNS,
1139                     arm.pat.span,
1140                     "wildcard pattern covers any other pattern as it will match anyway.",
1141                     None,
1142                     "Consider handling `_` separately.",
1143                 );
1144             }
1145         }
1146     }
1147 }
1148
1149 /// Lint a `match` or `if let .. { .. } else { .. }` expr that could be replaced by `matches!`
1150 fn check_match_like_matches<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> bool {
1151     if let ExprKind::Match(ex, arms, ref match_source) = &expr.kind {
1152         match match_source {
1153             MatchSource::Normal => find_matches_sugg(cx, ex, arms, expr, false),
1154             MatchSource::IfLetDesugar { .. } => find_matches_sugg(cx, ex, arms, expr, true),
1155             _ => false,
1156         }
1157     } else {
1158         false
1159     }
1160 }
1161
1162 /// Lint a `match` or desugared `if let` for replacement by `matches!`
1163 fn find_matches_sugg(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>, desugared: bool) -> bool {
1164     if_chain! {
1165         if arms.len() >= 2;
1166         if cx.typeck_results().expr_ty(expr).is_bool();
1167         if let Some((b1_arm, b0_arms)) = arms.split_last();
1168         if let Some(b0) = find_bool_lit(&b0_arms[0].body.kind, desugared);
1169         if let Some(b1) = find_bool_lit(&b1_arm.body.kind, desugared);
1170         if is_wild(&b1_arm.pat);
1171         if b0 != b1;
1172         let if_guard = &b0_arms[0].guard;
1173         if if_guard.is_none() || b0_arms.len() == 1;
1174         if b0_arms[0].attrs.is_empty();
1175         if b0_arms[1..].iter()
1176             .all(|arm| {
1177                 find_bool_lit(&arm.body.kind, desugared).map_or(false, |b| b == b0) &&
1178                 arm.guard.is_none() && arm.attrs.is_empty()
1179             });
1180         then {
1181             // The suggestion may be incorrect, because some arms can have `cfg` attributes
1182             // evaluated into `false` and so such arms will be stripped before.
1183             let mut applicability = Applicability::MaybeIncorrect;
1184             let pat = {
1185                 use itertools::Itertools as _;
1186                 b0_arms.iter()
1187                     .map(|arm| snippet_with_applicability(cx, arm.pat.span, "..", &mut applicability))
1188                     .join(" | ")
1189             };
1190             let pat_and_guard = if let Some(Guard::If(g)) = if_guard {
1191                 format!("{} if {}", pat, snippet_with_applicability(cx, g.span, "..", &mut applicability))
1192             } else {
1193                 pat
1194             };
1195             span_lint_and_sugg(
1196                 cx,
1197                 MATCH_LIKE_MATCHES_MACRO,
1198                 expr.span,
1199                 &format!("{} expression looks like `matches!` macro", if desugared { "if let .. else" } else { "match" }),
1200                 "try this",
1201                 format!(
1202                     "{}matches!({}, {})",
1203                     if b0 { "" } else { "!" },
1204                     snippet_with_applicability(cx, ex.span, "..", &mut applicability),
1205                     pat_and_guard,
1206                 ),
1207                 applicability,
1208             );
1209             true
1210         } else {
1211             false
1212         }
1213     }
1214 }
1215
1216 /// Extract a `bool` or `{ bool }`
1217 fn find_bool_lit(ex: &ExprKind<'_>, desugared: bool) -> Option<bool> {
1218     match ex {
1219         ExprKind::Lit(Spanned {
1220             node: LitKind::Bool(b), ..
1221         }) => Some(*b),
1222         ExprKind::Block(
1223             rustc_hir::Block {
1224                 stmts: &[],
1225                 expr: Some(exp),
1226                 ..
1227             },
1228             _,
1229         ) if desugared => {
1230             if let ExprKind::Lit(Spanned {
1231                 node: LitKind::Bool(b), ..
1232             }) = exp.kind
1233             {
1234                 Some(b)
1235             } else {
1236                 None
1237             }
1238         },
1239         _ => None,
1240     }
1241 }
1242
1243 fn check_match_single_binding<'a>(cx: &LateContext<'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1244     if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
1245         return;
1246     }
1247     let matched_vars = ex.span;
1248     let bind_names = arms[0].pat.span;
1249     let match_body = remove_blocks(&arms[0].body);
1250     let mut snippet_body = if match_body.span.from_expansion() {
1251         Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
1252     } else {
1253         snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
1254     };
1255
1256     // Do we need to add ';' to suggestion ?
1257     match match_body.kind {
1258         ExprKind::Block(block, _) => {
1259             // macro + expr_ty(body) == ()
1260             if block.span.from_expansion() && cx.typeck_results().expr_ty(&match_body).is_unit() {
1261                 snippet_body.push(';');
1262             }
1263         },
1264         _ => {
1265             // expr_ty(body) == ()
1266             if cx.typeck_results().expr_ty(&match_body).is_unit() {
1267                 snippet_body.push(';');
1268             }
1269         },
1270     }
1271
1272     let mut applicability = Applicability::MaybeIncorrect;
1273     match arms[0].pat.kind {
1274         PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
1275             // If this match is in a local (`let`) stmt
1276             let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
1277                 (
1278                     parent_let_node.span,
1279                     format!(
1280                         "let {} = {};\n{}let {} = {};",
1281                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1282                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1283                         " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
1284                         snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
1285                         snippet_body
1286                     ),
1287                 )
1288             } else {
1289                 // If we are in closure, we need curly braces around suggestion
1290                 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
1291                 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
1292                 if let Some(parent_expr) = get_parent_expr(cx, expr) {
1293                     if let ExprKind::Closure(..) = parent_expr.kind {
1294                         cbrace_end = format!("\n{}}}", indent);
1295                         // Fix body indent due to the closure
1296                         indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
1297                         cbrace_start = format!("{{\n{}", indent);
1298                     }
1299                 };
1300                 (
1301                     expr.span,
1302                     format!(
1303                         "{}let {} = {};\n{}{}{}",
1304                         cbrace_start,
1305                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1306                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1307                         indent,
1308                         snippet_body,
1309                         cbrace_end
1310                     ),
1311                 )
1312             };
1313             span_lint_and_sugg(
1314                 cx,
1315                 MATCH_SINGLE_BINDING,
1316                 target_span,
1317                 "this match could be written as a `let` statement",
1318                 "consider using `let` statement",
1319                 sugg,
1320                 applicability,
1321             );
1322         },
1323         PatKind::Wild => {
1324             span_lint_and_sugg(
1325                 cx,
1326                 MATCH_SINGLE_BINDING,
1327                 expr.span,
1328                 "this match could be replaced by its body itself",
1329                 "consider using the match body instead",
1330                 snippet_body,
1331                 Applicability::MachineApplicable,
1332             );
1333         },
1334         _ => (),
1335     }
1336 }
1337
1338 /// Returns true if the `ex` match expression is in a local (`let`) statement
1339 fn opt_parent_let<'a>(cx: &LateContext<'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
1340     if_chain! {
1341         let map = &cx.tcx.hir();
1342         if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
1343         if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
1344         then {
1345             return Some(parent_let_expr);
1346         }
1347     }
1348     None
1349 }
1350
1351 /// Gets all arms that are unbounded `PatRange`s.
1352 fn all_ranges<'tcx>(cx: &LateContext<'tcx>, arms: &'tcx [Arm<'_>], ty: Ty<'tcx>) -> Vec<SpannedRange<Constant>> {
1353     arms.iter()
1354         .flat_map(|arm| {
1355             if let Arm {
1356                 ref pat, guard: None, ..
1357             } = *arm
1358             {
1359                 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1360                     let lhs = match lhs {
1361                         Some(lhs) => constant(cx, cx.typeck_results(), lhs)?.0,
1362                         None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1363                     };
1364                     let rhs = match rhs {
1365                         Some(rhs) => constant(cx, cx.typeck_results(), rhs)?.0,
1366                         None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1367                     };
1368                     let rhs = match range_end {
1369                         RangeEnd::Included => Bound::Included(rhs),
1370                         RangeEnd::Excluded => Bound::Excluded(rhs),
1371                     };
1372                     return Some(SpannedRange {
1373                         span: pat.span,
1374                         node: (lhs, rhs),
1375                     });
1376                 }
1377
1378                 if let PatKind::Lit(ref value) = pat.kind {
1379                     let value = constant(cx, cx.typeck_results(), value)?.0;
1380                     return Some(SpannedRange {
1381                         span: pat.span,
1382                         node: (value.clone(), Bound::Included(value)),
1383                     });
1384                 }
1385             }
1386             None
1387         })
1388         .collect()
1389 }
1390
1391 #[derive(Debug, Eq, PartialEq)]
1392 pub struct SpannedRange<T> {
1393     pub span: Span,
1394     pub node: (T, Bound<T>),
1395 }
1396
1397 type TypedRanges = Vec<SpannedRange<u128>>;
1398
1399 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1400 /// and other types than
1401 /// `Uint` and `Int` probably don't make sense.
1402 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1403     ranges
1404         .iter()
1405         .filter_map(|range| match range.node {
1406             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1407                 span: range.span,
1408                 node: (start, Bound::Included(end)),
1409             }),
1410             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1411                 span: range.span,
1412                 node: (start, Bound::Excluded(end)),
1413             }),
1414             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1415                 span: range.span,
1416                 node: (start, Bound::Unbounded),
1417             }),
1418             _ => None,
1419         })
1420         .collect()
1421 }
1422
1423 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1424     match expr.kind {
1425         ExprKind::Tup(ref v) if v.is_empty() => true,
1426         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1427         _ => false,
1428     }
1429 }
1430
1431 // Checks if arm has the form `None => None`
1432 fn is_none_arm(arm: &Arm<'_>) -> bool {
1433     matches!(arm.pat.kind, PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE))
1434 }
1435
1436 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1437 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1438     if_chain! {
1439         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1440         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1441         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1442         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1443         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1444         if let ExprKind::Path(ref some_path) = e.kind;
1445         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1446         if let ExprKind::Path(QPath::Resolved(_, ref path2)) = args[0].kind;
1447         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1448         then {
1449             return Some(rb)
1450         }
1451     }
1452     None
1453 }
1454
1455 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1456     let mapped = arms
1457         .iter()
1458         .map(|a| {
1459             match a.pat.kind {
1460                 PatKind::Ref(..) => Some(true), // &-patterns
1461                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
1462                 _ => None,                      // any other pattern is not fine
1463             }
1464         })
1465         .collect::<Option<Vec<bool>>>();
1466     // look for Some(v) where there's at least one true element
1467     mapped.map_or(false, |v| v.iter().any(|el| *el))
1468 }
1469
1470 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1471 where
1472     T: Copy + Ord,
1473 {
1474     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1475     enum Kind<'a, T> {
1476         Start(T, &'a SpannedRange<T>),
1477         End(Bound<T>, &'a SpannedRange<T>),
1478     }
1479
1480     impl<'a, T: Copy> Kind<'a, T> {
1481         fn range(&self) -> &'a SpannedRange<T> {
1482             match *self {
1483                 Kind::Start(_, r) | Kind::End(_, r) => r,
1484             }
1485         }
1486
1487         fn value(self) -> Bound<T> {
1488             match self {
1489                 Kind::Start(t, _) => Bound::Included(t),
1490                 Kind::End(t, _) => t,
1491             }
1492         }
1493     }
1494
1495     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1496         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1497             Some(self.cmp(other))
1498         }
1499     }
1500
1501     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1502         fn cmp(&self, other: &Self) -> Ordering {
1503             match (self.value(), other.value()) {
1504                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1505                 // Range patterns cannot be unbounded (yet)
1506                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1507                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1508                     Ordering::Equal => Ordering::Greater,
1509                     other => other,
1510                 },
1511                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1512                     Ordering::Equal => Ordering::Less,
1513                     other => other,
1514                 },
1515             }
1516         }
1517     }
1518
1519     let mut values = Vec::with_capacity(2 * ranges.len());
1520
1521     for r in ranges {
1522         values.push(Kind::Start(r.node.0, r));
1523         values.push(Kind::End(r.node.1, r));
1524     }
1525
1526     values.sort();
1527
1528     for (a, b) in values.iter().zip(values.iter().skip(1)) {
1529         match (a, b) {
1530             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1531                 if ra.node != rb.node {
1532                     return Some((ra, rb));
1533                 }
1534             },
1535             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1536             _ => return Some((a.range(), b.range())),
1537         }
1538     }
1539
1540     None
1541 }
1542
1543 mod redundant_pattern_match {
1544     use super::REDUNDANT_PATTERN_MATCHING;
1545     use crate::utils::{match_qpath, match_trait_method, paths, snippet, span_lint_and_then};
1546     use if_chain::if_chain;
1547     use rustc_ast::ast::LitKind;
1548     use rustc_errors::Applicability;
1549     use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind, QPath};
1550     use rustc_lint::LateContext;
1551     use rustc_span::sym;
1552
1553     pub fn check<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1554         if let ExprKind::Match(op, arms, ref match_source) = &expr.kind {
1555             match match_source {
1556                 MatchSource::Normal => find_sugg_for_match(cx, expr, op, arms),
1557                 MatchSource::IfLetDesugar { .. } => find_sugg_for_if_let(cx, expr, op, arms, "if"),
1558                 MatchSource::WhileLetDesugar => find_sugg_for_if_let(cx, expr, op, arms, "while"),
1559                 _ => {},
1560             }
1561         }
1562     }
1563
1564     fn find_sugg_for_if_let<'tcx>(
1565         cx: &LateContext<'tcx>,
1566         expr: &'tcx Expr<'_>,
1567         op: &Expr<'_>,
1568         arms: &[Arm<'_>],
1569         keyword: &'static str,
1570     ) {
1571         let good_method = match arms[0].pat.kind {
1572             PatKind::TupleStruct(ref path, ref patterns, _) if patterns.len() == 1 => {
1573                 if let PatKind::Wild = patterns[0].kind {
1574                     if match_qpath(path, &paths::RESULT_OK) {
1575                         "is_ok()"
1576                     } else if match_qpath(path, &paths::RESULT_ERR) {
1577                         "is_err()"
1578                     } else if match_qpath(path, &paths::OPTION_SOME) {
1579                         "is_some()"
1580                     } else if match_qpath(path, &paths::POLL_READY) {
1581                         "is_ready()"
1582                     } else if match_qpath(path, &paths::IPADDR_V4) {
1583                         "is_ipv4()"
1584                     } else if match_qpath(path, &paths::IPADDR_V6) {
1585                         "is_ipv6()"
1586                     } else {
1587                         return;
1588                     }
1589                 } else {
1590                     return;
1591                 }
1592             },
1593             PatKind::Path(ref path) => {
1594                 if match_qpath(path, &paths::OPTION_NONE) {
1595                     "is_none()"
1596                 } else if match_qpath(path, &paths::POLL_PENDING) {
1597                     "is_pending()"
1598                 } else {
1599                     return;
1600                 }
1601             },
1602             _ => return,
1603         };
1604
1605         // check that `while_let_on_iterator` lint does not trigger
1606         if_chain! {
1607             if keyword == "while";
1608             if let ExprKind::MethodCall(method_path, _, _, _) = op.kind;
1609             if method_path.ident.name == sym::next;
1610             if match_trait_method(cx, op, &paths::ITERATOR);
1611             then {
1612                 return;
1613             }
1614         }
1615
1616         let result_expr = match &op.kind {
1617             ExprKind::AddrOf(_, _, borrowed) => borrowed,
1618             _ => op,
1619         };
1620         span_lint_and_then(
1621             cx,
1622             REDUNDANT_PATTERN_MATCHING,
1623             arms[0].pat.span,
1624             &format!("redundant pattern matching, consider using `{}`", good_method),
1625             |diag| {
1626                 // while let ... = ... { ... }
1627                 // ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1628                 let expr_span = expr.span;
1629
1630                 // while let ... = ... { ... }
1631                 //                 ^^^
1632                 let op_span = result_expr.span.source_callsite();
1633
1634                 // while let ... = ... { ... }
1635                 // ^^^^^^^^^^^^^^^^^^^
1636                 let span = expr_span.until(op_span.shrink_to_hi());
1637                 diag.span_suggestion(
1638                     span,
1639                     "try this",
1640                     format!("{} {}.{}", keyword, snippet(cx, op_span, "_"), good_method),
1641                     Applicability::MachineApplicable, // snippet
1642                 );
1643             },
1644         );
1645     }
1646
1647     fn find_sugg_for_match<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>]) {
1648         if arms.len() == 2 {
1649             let node_pair = (&arms[0].pat.kind, &arms[1].pat.kind);
1650
1651             let found_good_method = match node_pair {
1652                 (
1653                     PatKind::TupleStruct(ref path_left, ref patterns_left, _),
1654                     PatKind::TupleStruct(ref path_right, ref patterns_right, _),
1655                 ) if patterns_left.len() == 1 && patterns_right.len() == 1 => {
1656                     if let (PatKind::Wild, PatKind::Wild) = (&patterns_left[0].kind, &patterns_right[0].kind) {
1657                         find_good_method_for_match(
1658                             arms,
1659                             path_left,
1660                             path_right,
1661                             &paths::RESULT_OK,
1662                             &paths::RESULT_ERR,
1663                             "is_ok()",
1664                             "is_err()",
1665                         )
1666                         .or_else(|| {
1667                             find_good_method_for_match(
1668                                 arms,
1669                                 path_left,
1670                                 path_right,
1671                                 &paths::IPADDR_V4,
1672                                 &paths::IPADDR_V6,
1673                                 "is_ipv4()",
1674                                 "is_ipv6()",
1675                             )
1676                         })
1677                     } else {
1678                         None
1679                     }
1680                 },
1681                 (PatKind::TupleStruct(ref path_left, ref patterns, _), PatKind::Path(ref path_right))
1682                 | (PatKind::Path(ref path_left), PatKind::TupleStruct(ref path_right, ref patterns, _))
1683                     if patterns.len() == 1 =>
1684                 {
1685                     if let PatKind::Wild = patterns[0].kind {
1686                         find_good_method_for_match(
1687                             arms,
1688                             path_left,
1689                             path_right,
1690                             &paths::OPTION_SOME,
1691                             &paths::OPTION_NONE,
1692                             "is_some()",
1693                             "is_none()",
1694                         )
1695                         .or_else(|| {
1696                             find_good_method_for_match(
1697                                 arms,
1698                                 path_left,
1699                                 path_right,
1700                                 &paths::POLL_READY,
1701                                 &paths::POLL_PENDING,
1702                                 "is_ready()",
1703                                 "is_pending()",
1704                             )
1705                         })
1706                     } else {
1707                         None
1708                     }
1709                 },
1710                 _ => None,
1711             };
1712
1713             if let Some(good_method) = found_good_method {
1714                 let span = expr.span.to(op.span);
1715                 let result_expr = match &op.kind {
1716                     ExprKind::AddrOf(_, _, borrowed) => borrowed,
1717                     _ => op,
1718                 };
1719                 span_lint_and_then(
1720                     cx,
1721                     REDUNDANT_PATTERN_MATCHING,
1722                     expr.span,
1723                     &format!("redundant pattern matching, consider using `{}`", good_method),
1724                     |diag| {
1725                         diag.span_suggestion(
1726                             span,
1727                             "try this",
1728                             format!("{}.{}", snippet(cx, result_expr.span, "_"), good_method),
1729                             Applicability::MaybeIncorrect, // snippet
1730                         );
1731                     },
1732                 );
1733             }
1734         }
1735     }
1736
1737     fn find_good_method_for_match<'a>(
1738         arms: &[Arm<'_>],
1739         path_left: &QPath<'_>,
1740         path_right: &QPath<'_>,
1741         expected_left: &[&str],
1742         expected_right: &[&str],
1743         should_be_left: &'a str,
1744         should_be_right: &'a str,
1745     ) -> Option<&'a str> {
1746         let body_node_pair = if match_qpath(path_left, expected_left) && match_qpath(path_right, expected_right) {
1747             (&(*arms[0].body).kind, &(*arms[1].body).kind)
1748         } else if match_qpath(path_right, expected_left) && match_qpath(path_left, expected_right) {
1749             (&(*arms[1].body).kind, &(*arms[0].body).kind)
1750         } else {
1751             return None;
1752         };
1753
1754         match body_node_pair {
1755             (ExprKind::Lit(ref lit_left), ExprKind::Lit(ref lit_right)) => match (&lit_left.node, &lit_right.node) {
1756                 (LitKind::Bool(true), LitKind::Bool(false)) => Some(should_be_left),
1757                 (LitKind::Bool(false), LitKind::Bool(true)) => Some(should_be_right),
1758                 _ => None,
1759             },
1760             _ => None,
1761         }
1762     }
1763 }
1764
1765 #[test]
1766 fn test_overlapping() {
1767     use rustc_span::source_map::DUMMY_SP;
1768
1769     let sp = |s, e| SpannedRange {
1770         span: DUMMY_SP,
1771         node: (s, e),
1772     };
1773
1774     assert_eq!(None, overlapping::<u8>(&[]));
1775     assert_eq!(None, overlapping(&[sp(1, Bound::Included(4))]));
1776     assert_eq!(
1777         None,
1778         overlapping(&[sp(1, Bound::Included(4)), sp(5, Bound::Included(6))])
1779     );
1780     assert_eq!(
1781         None,
1782         overlapping(&[
1783             sp(1, Bound::Included(4)),
1784             sp(5, Bound::Included(6)),
1785             sp(10, Bound::Included(11))
1786         ],)
1787     );
1788     assert_eq!(
1789         Some((&sp(1, Bound::Included(4)), &sp(3, Bound::Included(6)))),
1790         overlapping(&[sp(1, Bound::Included(4)), sp(3, Bound::Included(6))])
1791     );
1792     assert_eq!(
1793         Some((&sp(5, Bound::Included(6)), &sp(6, Bound::Included(11)))),
1794         overlapping(&[
1795             sp(1, Bound::Included(4)),
1796             sp(5, Bound::Included(6)),
1797             sp(6, Bound::Included(11))
1798         ],)
1799     );
1800 }
1801
1802 /// Implementation of `MATCH_SAME_ARMS`.
1803 fn lint_match_arms<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) {
1804     fn same_bindings<'tcx>(lhs: &FxHashMap<Symbol, Ty<'tcx>>, rhs: &FxHashMap<Symbol, Ty<'tcx>>) -> bool {
1805         lhs.len() == rhs.len()
1806             && lhs
1807                 .iter()
1808                 .all(|(name, l_ty)| rhs.get(name).map_or(false, |r_ty| TyS::same_type(l_ty, r_ty)))
1809     }
1810
1811     if let ExprKind::Match(_, ref arms, MatchSource::Normal) = expr.kind {
1812         let hash = |&(_, arm): &(usize, &Arm<'_>)| -> u64 {
1813             let mut h = SpanlessHash::new(cx);
1814             h.hash_expr(&arm.body);
1815             h.finish()
1816         };
1817
1818         let eq = |&(lindex, lhs): &(usize, &Arm<'_>), &(rindex, rhs): &(usize, &Arm<'_>)| -> bool {
1819             let min_index = usize::min(lindex, rindex);
1820             let max_index = usize::max(lindex, rindex);
1821
1822             // Arms with a guard are ignored, those can’t always be merged together
1823             // This is also the case for arms in-between each there is an arm with a guard
1824             (min_index..=max_index).all(|index| arms[index].guard.is_none()) &&
1825                 SpanlessEq::new(cx).eq_expr(&lhs.body, &rhs.body) &&
1826                 // all patterns should have the same bindings
1827                 same_bindings(&bindings(cx, &lhs.pat), &bindings(cx, &rhs.pat))
1828         };
1829
1830         let indexed_arms: Vec<(usize, &Arm<'_>)> = arms.iter().enumerate().collect();
1831         for (&(_, i), &(_, j)) in search_same(&indexed_arms, hash, eq) {
1832             span_lint_and_then(
1833                 cx,
1834                 MATCH_SAME_ARMS,
1835                 j.body.span,
1836                 "this `match` has identical arm bodies",
1837                 |diag| {
1838                     diag.span_note(i.body.span, "same as this");
1839
1840                     // Note: this does not use `span_suggestion` on purpose:
1841                     // there is no clean way
1842                     // to remove the other arm. Building a span and suggest to replace it to ""
1843                     // makes an even more confusing error message. Also in order not to make up a
1844                     // span for the whole pattern, the suggestion is only shown when there is only
1845                     // one pattern. The user should know about `|` if they are already using it…
1846
1847                     let lhs = snippet(cx, i.pat.span, "<pat1>");
1848                     let rhs = snippet(cx, j.pat.span, "<pat2>");
1849
1850                     if let PatKind::Wild = j.pat.kind {
1851                         // if the last arm is _, then i could be integrated into _
1852                         // note that i.pat cannot be _, because that would mean that we're
1853                         // hiding all the subsequent arms, and rust won't compile
1854                         diag.span_note(
1855                             i.body.span,
1856                             &format!(
1857                                 "`{}` has the same arm body as the `_` wildcard, consider removing it",
1858                                 lhs
1859                             ),
1860                         );
1861                     } else {
1862                         diag.span_help(i.pat.span, &format!("consider refactoring into `{} | {}`", lhs, rhs));
1863                     }
1864                 },
1865             );
1866         }
1867     }
1868 }
1869
1870 /// Returns the list of bindings in a pattern.
1871 fn bindings<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>) -> FxHashMap<Symbol, Ty<'tcx>> {
1872     fn bindings_impl<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>, map: &mut FxHashMap<Symbol, Ty<'tcx>>) {
1873         match pat.kind {
1874             PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => bindings_impl(cx, pat, map),
1875             PatKind::TupleStruct(_, pats, _) => {
1876                 for pat in pats {
1877                     bindings_impl(cx, pat, map);
1878                 }
1879             },
1880             PatKind::Binding(.., ident, ref as_pat) => {
1881                 if let Entry::Vacant(v) = map.entry(ident.name) {
1882                     v.insert(cx.typeck_results().pat_ty(pat));
1883                 }
1884                 if let Some(ref as_pat) = *as_pat {
1885                     bindings_impl(cx, as_pat, map);
1886                 }
1887             },
1888             PatKind::Or(fields) | PatKind::Tuple(fields, _) => {
1889                 for pat in fields {
1890                     bindings_impl(cx, pat, map);
1891                 }
1892             },
1893             PatKind::Struct(_, fields, _) => {
1894                 for pat in fields {
1895                     bindings_impl(cx, &pat.pat, map);
1896                 }
1897             },
1898             PatKind::Slice(lhs, ref mid, rhs) => {
1899                 for pat in lhs {
1900                     bindings_impl(cx, pat, map);
1901                 }
1902                 if let Some(ref mid) = *mid {
1903                     bindings_impl(cx, mid, map);
1904                 }
1905                 for pat in rhs {
1906                     bindings_impl(cx, pat, map);
1907                 }
1908             },
1909             PatKind::Lit(..) | PatKind::Range(..) | PatKind::Wild | PatKind::Path(..) => (),
1910         }
1911     }
1912
1913     let mut result = FxHashMap::default();
1914     bindings_impl(cx, pat, &mut result);
1915     result
1916 }