src/mut_mut.rs

   1 use rustc::lint::*;
   2 use rustc::ty::{TypeAndMut, TyRef};
   3 use rustc::hir::*;
   4 use utils::{in_external_macro, span_lint};
   5
   6 /// **What it does:** This lint checks for instances of `mut mut` references.
   7 ///
   8 /// **Why is this bad?** Multiple `mut`s don't add anything meaningful to the source.
   9 ///
  10 /// **Known problems:** None
  11 ///
  12 /// **Example:** `let x = &mut &mut y;`
  13 declare_lint! {
  14     pub MUT_MUT,
  15     Allow,
  16     "usage of double-mut refs, e.g. `&mut &mut ...` (either copy'n'paste error, \
  17      or shows a fundamental misunderstanding of references)"
  18 }
  19
  20 #[derive(Copy,Clone)]
  21 pub struct MutMut;
  22
  23 impl LintPass for MutMut {
  24     fn get_lints(&self) -> LintArray {
  25         lint_array!(MUT_MUT)
  26     }
  27 }
  28
  29 impl LateLintPass for MutMut {
  30     fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
  31         check_expr_mut(cx, expr)
  32     }
  33
  34     fn check_ty(&mut self, cx: &LateContext, ty: &Ty) {
  35         unwrap_mut(ty).and_then(unwrap_mut).map_or((), |_| {
  36             span_lint(cx, MUT_MUT, ty.span, "generally you want to avoid `&mut &mut _` if possible");
  37         });
  38     }
  39 }
  40
  41 fn check_expr_mut(cx: &LateContext, expr: &Expr) {
  42     fn unwrap_addr(expr: &Expr) -> Option<&Expr> {
  43         match expr.node {
  44             ExprAddrOf(MutMutable, ref e) => Some(e),
  45             _ => None,
  46         }
  47     }
  48
  49     if in_external_macro(cx, expr.span) {
  50         return;
  51     }
  52
  53     unwrap_addr(expr).map_or((), |e| {
  54         unwrap_addr(e).map_or_else(|| {
  55                                        if let TyRef(_, TypeAndMut { mutbl: MutMutable, .. }) = cx.tcx.expr_ty(e).sty {
  56                                            span_lint(cx,
  57                                                      MUT_MUT,
  58                                                      expr.span,
  59                                                      "this expression mutably borrows a mutable reference. Consider \
  60                                                       reborrowing");
  61                                        }
  62                                    },
  63                                    |_| {
  64                                        span_lint(cx,
  65                                                  MUT_MUT,
  66                                                  expr.span,
  67                                                  "generally you want to avoid `&mut &mut _` if possible");
  68                                    })
  69     })
  70 }
  71
  72 fn unwrap_mut(ty: &Ty) -> Option<&Ty> {
  73     match ty.node {
  74         TyRptr(_, MutTy { ty: ref pty, mutbl: MutMutable }) => Some(pty),
  75         _ => None,
  76     }
  77 }