2017-06-26 12:42:24 +00:00
|
|
|
//! Checks for useless borrowed references.
|
2017-06-24 10:04:56 +00:00
|
|
|
//!
|
|
|
|
//! This lint is **warn** by default
|
|
|
|
|
|
|
|
use rustc::lint::*;
|
2018-07-19 07:53:23 +00:00
|
|
|
use rustc::{declare_lint, lint_array};
|
2017-09-05 09:33:04 +00:00
|
|
|
use rustc::hir::{BindingAnnotation, MutImmutable, Pat, PatKind};
|
2018-05-30 08:15:50 +00:00
|
|
|
use crate::utils::{in_macro, snippet, span_lint_and_then};
|
2017-06-24 10:04:56 +00:00
|
|
|
|
2017-06-26 12:42:24 +00:00
|
|
|
/// **What it does:** Checks for useless borrowed references.
|
2017-06-24 10:04:56 +00:00
|
|
|
///
|
2017-09-03 21:15:15 +00:00
|
|
|
/// **Why is this bad?** It is mostly useless and make the code look more
|
|
|
|
/// complex than it
|
2017-06-29 14:07:43 +00:00
|
|
|
/// actually is.
|
2017-06-24 10:04:56 +00:00
|
|
|
///
|
2017-07-01 16:51:20 +00:00
|
|
|
/// **Known problems:** It seems that the `&ref` pattern is sometimes useful.
|
|
|
|
/// For instance in the following snippet:
|
|
|
|
/// ```rust
|
|
|
|
/// enum Animal {
|
|
|
|
/// Cat(u64),
|
|
|
|
/// Dog(u64),
|
|
|
|
/// }
|
|
|
|
///
|
|
|
|
/// fn foo(a: &Animal, b: &Animal) {
|
|
|
|
/// match (a, b) {
|
2017-09-03 21:15:15 +00:00
|
|
|
/// (&Animal::Cat(v), k) | (k, &Animal::Cat(v)) => (), // lifetime
|
|
|
|
/// mismatch error
|
2017-07-01 16:51:20 +00:00
|
|
|
/// (&Animal::Dog(ref c), &Animal::Dog(_)) => ()
|
|
|
|
/// }
|
|
|
|
/// }
|
|
|
|
/// ```
|
2017-09-03 21:15:15 +00:00
|
|
|
/// There is a lifetime mismatch error for `k` (indeed a and b have distinct
|
|
|
|
/// lifetime).
|
2017-07-01 16:51:20 +00:00
|
|
|
/// This can be fixed by using the `&ref` pattern.
|
|
|
|
/// However, the code can also be fixed by much cleaner ways
|
2017-06-24 10:04:56 +00:00
|
|
|
///
|
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// let mut v = Vec::<String>::new();
|
|
|
|
/// let _ = v.iter_mut().filter(|&ref a| a.is_empty());
|
|
|
|
/// ```
|
2018-01-01 21:55:40 +00:00
|
|
|
/// This closure takes a reference on something that has been matched as a
|
2017-08-09 07:30:56 +00:00
|
|
|
/// reference and
|
2017-06-29 14:07:43 +00:00
|
|
|
/// de-referenced.
|
2017-06-26 12:42:24 +00:00
|
|
|
/// As such, it could just be |a| a.is_empty()
|
2018-03-28 13:24:26 +00:00
|
|
|
declare_clippy_lint! {
|
2017-06-24 10:04:56 +00:00
|
|
|
pub NEEDLESS_BORROWED_REFERENCE,
|
2018-03-28 13:24:26 +00:00
|
|
|
complexity,
|
2017-06-24 10:04:56 +00:00
|
|
|
"taking a needless borrowed reference"
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Copy, Clone)]
|
|
|
|
pub struct NeedlessBorrowedRef;
|
|
|
|
|
|
|
|
impl LintPass for NeedlessBorrowedRef {
|
|
|
|
fn get_lints(&self) -> LintArray {
|
|
|
|
lint_array!(NEEDLESS_BORROWED_REFERENCE)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NeedlessBorrowedRef {
|
|
|
|
fn check_pat(&mut self, cx: &LateContext<'a, 'tcx>, pat: &'tcx Pat) {
|
|
|
|
if in_macro(pat.span) {
|
|
|
|
// OK, simple enough, lints doesn't check in macro.
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
if_chain! {
|
2017-06-29 11:45:54 +00:00
|
|
|
// Only lint immutable refs, because `&mut ref T` may be useful.
|
2017-10-23 19:18:02 +00:00
|
|
|
if let PatKind::Ref(ref sub_pat, MutImmutable) = pat.node;
|
2017-07-01 10:01:39 +00:00
|
|
|
|
2017-07-01 14:56:19 +00:00
|
|
|
// Check sub_pat got a `ref` keyword (excluding `ref mut`).
|
2017-10-23 19:18:02 +00:00
|
|
|
if let PatKind::Binding(BindingAnnotation::Ref, _, spanned_name, ..) = sub_pat.node;
|
|
|
|
then {
|
|
|
|
span_lint_and_then(cx, NEEDLESS_BORROWED_REFERENCE, pat.span,
|
|
|
|
"this pattern takes a reference on something that is being de-referenced",
|
|
|
|
|db| {
|
|
|
|
let hint = snippet(cx, spanned_name.span, "..").into_owned();
|
|
|
|
db.span_suggestion(pat.span, "try removing the `&ref` part and just keep", hint);
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
2017-06-24 10:04:56 +00:00
|
|
|
}
|
|
|
|
}
|