2018-10-06 16:18:06 +00:00
|
|
|
// Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
2018-07-24 06:55:38 +00:00
|
|
|
use crate::utils::{higher, span_lint};
|
2018-12-29 15:04:45 +00:00
|
|
|
use rustc::hir;
|
|
|
|
use rustc::hir::intravisit;
|
|
|
|
use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
|
|
|
|
use rustc::ty;
|
|
|
|
use rustc::{declare_tool_lint, lint_array};
|
2015-05-18 07:02:24 +00:00
|
|
|
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **What it does:** Checks for instances of `mut mut` references.
|
2015-12-11 00:22:27 +00:00
|
|
|
///
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **Why is this bad?** Multiple `mut`s don't add anything meaningful to the
|
|
|
|
/// source. This is either a copy'n'paste error, or it shows a fundamental
|
|
|
|
/// misunderstanding of references.
|
2015-12-11 00:22:27 +00:00
|
|
|
///
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **Known problems:** None.
|
2015-12-11 00:22:27 +00:00
|
|
|
///
|
2016-07-15 22:25:44 +00:00
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// let x = &mut &mut y;
|
|
|
|
/// ```
|
2018-03-28 13:24:26 +00:00
|
|
|
declare_clippy_lint! {
|
2016-02-05 23:13:29 +00:00
|
|
|
pub MUT_MUT,
|
2018-03-28 13:24:26 +00:00
|
|
|
pedantic,
|
2016-07-15 22:25:44 +00:00
|
|
|
"usage of double-mut refs, e.g. `&mut &mut ...`"
|
2016-02-05 23:13:29 +00:00
|
|
|
}
|
2015-05-18 07:02:24 +00:00
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
#[derive(Copy, Clone)]
|
2015-05-18 07:02:24 +00:00
|
|
|
pub struct MutMut;
|
|
|
|
|
|
|
|
impl LintPass for MutMut {
|
2015-08-11 18:22:20 +00:00
|
|
|
fn get_lints(&self) -> LintArray {
|
2015-05-18 07:02:24 +00:00
|
|
|
lint_array!(MUT_MUT)
|
2015-08-11 18:22:20 +00:00
|
|
|
}
|
2015-09-19 02:53:04 +00:00
|
|
|
}
|
2015-08-11 18:22:20 +00:00
|
|
|
|
2016-12-07 12:13:40 +00:00
|
|
|
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MutMut {
|
|
|
|
fn check_block(&mut self, cx: &LateContext<'a, 'tcx>, block: &'tcx hir::Block) {
|
2018-03-15 15:07:15 +00:00
|
|
|
intravisit::walk_block(&mut MutVisitor { cx }, block);
|
2016-06-21 20:54:22 +00:00
|
|
|
}
|
|
|
|
|
2016-12-07 12:13:40 +00:00
|
|
|
fn check_ty(&mut self, cx: &LateContext<'a, 'tcx>, ty: &'tcx hir::Ty) {
|
2018-12-29 15:04:45 +00:00
|
|
|
use rustc::hir::intravisit::Visitor;
|
2016-06-21 20:54:22 +00:00
|
|
|
|
2018-03-15 15:07:15 +00:00
|
|
|
MutVisitor { cx }.visit_ty(ty);
|
2016-06-21 20:54:22 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
pub struct MutVisitor<'a, 'tcx: 'a> {
|
|
|
|
cx: &'a LateContext<'a, 'tcx>,
|
|
|
|
}
|
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
impl<'a, 'tcx> intravisit::Visitor<'tcx> for MutVisitor<'a, 'tcx> {
|
|
|
|
fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
|
2018-07-24 06:55:38 +00:00
|
|
|
if in_external_macro(self.cx.sess(), expr.span) {
|
2016-05-17 14:34:15 +00:00
|
|
|
return;
|
2015-08-11 18:22:20 +00:00
|
|
|
}
|
|
|
|
|
2016-06-29 22:08:43 +00:00
|
|
|
if let Some((_, arg, body)) = higher::for_loop(expr) {
|
2016-06-21 20:54:22 +00:00
|
|
|
// A `for` loop lowers to:
|
|
|
|
// ```rust
|
|
|
|
// match ::std::iter::Iterator::next(&mut iter) {
|
|
|
|
// // ^^^^
|
|
|
|
// ```
|
|
|
|
// Let's ignore the generated code.
|
|
|
|
intravisit::walk_expr(self, arg);
|
|
|
|
intravisit::walk_expr(self, body);
|
2018-07-12 07:30:57 +00:00
|
|
|
} else if let hir::ExprKind::AddrOf(hir::MutMutable, ref e) = expr.node {
|
|
|
|
if let hir::ExprKind::AddrOf(hir::MutMutable, _) = e.node {
|
2017-08-09 07:30:56 +00:00
|
|
|
span_lint(
|
|
|
|
self.cx,
|
|
|
|
MUT_MUT,
|
|
|
|
expr.span,
|
|
|
|
"generally you want to avoid `&mut &mut _` if possible",
|
|
|
|
);
|
2018-11-27 20:14:15 +00:00
|
|
|
} else if let ty::Ref(_, _, hir::MutMutable) = self.cx.tables.expr_ty(e).sty {
|
2017-08-09 07:30:56 +00:00
|
|
|
span_lint(
|
|
|
|
self.cx,
|
|
|
|
MUT_MUT,
|
|
|
|
expr.span,
|
|
|
|
"this expression mutably borrows a mutable reference. Consider reborrowing",
|
|
|
|
);
|
2016-05-17 14:34:15 +00:00
|
|
|
}
|
|
|
|
}
|
2016-01-24 09:16:56 +00:00
|
|
|
}
|
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
fn visit_ty(&mut self, ty: &'tcx hir::Ty) {
|
2018-07-12 08:03:06 +00:00
|
|
|
if let hir::TyKind::Rptr(
|
2017-09-05 09:33:04 +00:00
|
|
|
_,
|
|
|
|
hir::MutTy {
|
|
|
|
ty: ref pty,
|
|
|
|
mutbl: hir::MutMutable,
|
|
|
|
},
|
|
|
|
) = ty.node
|
2017-08-09 07:30:56 +00:00
|
|
|
{
|
2018-07-12 08:03:06 +00:00
|
|
|
if let hir::TyKind::Rptr(
|
2017-09-05 09:33:04 +00:00
|
|
|
_,
|
|
|
|
hir::MutTy {
|
2018-11-27 20:14:15 +00:00
|
|
|
mutbl: hir::MutMutable, ..
|
2017-09-05 09:33:04 +00:00
|
|
|
},
|
|
|
|
) = pty.node
|
|
|
|
{
|
2017-08-09 07:30:56 +00:00
|
|
|
span_lint(
|
|
|
|
self.cx,
|
|
|
|
MUT_MUT,
|
|
|
|
ty.span,
|
|
|
|
"generally you want to avoid `&mut &mut _` if possible",
|
|
|
|
);
|
2016-05-17 14:34:15 +00:00
|
|
|
}
|
|
|
|
}
|
2016-06-21 20:54:22 +00:00
|
|
|
|
|
|
|
intravisit::walk_ty(self, ty);
|
2015-08-11 18:22:20 +00:00
|
|
|
}
|
2016-12-06 10:32:21 +00:00
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
|
2017-05-12 10:02:42 +00:00
|
|
|
intravisit::NestedVisitorMap::None
|
2016-12-06 10:32:21 +00:00
|
|
|
}
|
2015-05-18 08:41:15 +00:00
|
|
|
}
|