rust/src/mut_mut.rs

use syntax::ptr::P;
use syntax::ast::*;
use rustc::lint::{Context, LintPass, LintArray, Lint};
use rustc::middle::ty::{expr_ty, sty, ty_ptr, ty_rptr, mt};
use syntax::codemap::{BytePos, ExpnInfo, MacroFormat, Span};

declare_lint!(pub MUT_MUT, Warn,
              "Warn on usage of double-mut refs, e.g. '&mut &mut ...'");

#[derive(Copy,Clone)]
pub struct MutMut;

impl LintPass for MutMut {
	fn get_lints(&self) -> LintArray {
        lint_array!(MUT_MUT)
	}
	
	fn check_expr(&mut self, cx: &Context, expr: &Expr) {
		cx.sess().codemap().with_expn_info(expr.span.expn_id, 
			|info| check_expr_expd(cx, expr, info))
	}
	
	fn check_ty(&mut self, cx: &Context, ty: &Ty) {
		unwrap_mut(ty).and_then(unwrap_mut).map_or((), |_| cx.span_lint(MUT_MUT, 
			ty.span, "Generally you want to avoid &mut &mut _ if possible."))
	}
}

fn check_expr_expd(cx: &Context, expr: &Expr, info: Option<&ExpnInfo>) {
	if in_macro(cx, info) { return; }

	fn unwrap_addr(expr : &Expr) -> Option<&Expr> {
		match expr.node {
			ExprAddrOf(MutMutable, ref e) => Option::Some(e),
			_ => Option::None
		}
	}
	
	unwrap_addr(expr).map_or((), |e| {
		unwrap_addr(e).map(|_| {
			cx.span_lint(MUT_MUT, expr.span, 
				"Generally you want to avoid &mut &mut _ if possible.")
		}).unwrap_or_else(|| {
			if let ty_rptr(_, mt{ty: _, mutbl: MutMutable}) = 
					expr_ty(cx.tcx, e).sty {
				cx.span_lint(MUT_MUT, expr.span,
					"This expression mutably borrows a mutable reference. \
					Consider reborrowing")
			}
		})
	})
}

pub fn in_macro(cx: &Context, opt_info: Option<&ExpnInfo>) -> bool {
	opt_info.map_or(false, |info| {
		info.callee.span.map_or(true, |span| {
			cx.sess().codemap().span_to_snippet(span).ok().map_or(true, |code| 
				!code.starts_with("macro_rules")
			)
		})
	})
}

fn unwrap_mut(ty : &Ty) -> Option<&Ty> {
	match ty.node {
		TyPtr(MutTy{ ty: ref pty, mutbl: MutMutable }) => Option::Some(pty),
		TyRptr(_, MutTy{ ty: ref pty, mutbl: MutMutable }) => Option::Some(pty),
		_ => Option::None
	}
}