rust/clippy_lints/src/mut_reference.rs

87 lines
2.9 KiB
Rust
Raw Normal View History

2015-09-29 06:11:19 -05:00
use rustc::lint::*;
use rustc::ty::{self, Ty};
2017-06-04 16:28:01 -05:00
use rustc::ty::subst::Subst;
use rustc::hir::*;
2016-02-24 10:38:57 -06:00
use utils::span_lint;
2015-09-29 06:11:19 -05:00
/// **What it does:** Detects giving a mutable reference to a function that only
/// requires an immutable reference.
///
/// **Why is this bad?** The immutable reference rules out all other references
/// to the value. Also the code misleads about the intent of the call site.
///
/// **Known problems:** None.
///
/// **Example:**
2016-07-15 17:25:44 -05:00
/// ```rust
/// my_vec.push(&mut value)
/// ```
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
2015-09-29 06:11:19 -05:00
pub UNNECESSARY_MUT_PASSED,
2018-03-28 08:24:26 -05:00
style,
"an argument passed as a mutable reference although the callee only demands an \
2015-09-29 06:11:19 -05:00
immutable reference"
}
2017-08-09 02:30:56 -05:00
#[derive(Copy, Clone)]
2015-09-29 06:11:19 -05:00
pub struct UnnecessaryMutPassed;
impl LintPass for UnnecessaryMutPassed {
fn get_lints(&self) -> LintArray {
lint_array!(UNNECESSARY_MUT_PASSED)
}
}
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnnecessaryMutPassed {
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr) {
match e.node {
2017-09-05 04:33:04 -05:00
ExprCall(ref fn_expr, ref arguments) => if let ExprPath(ref path) = fn_expr.node {
check_arguments(
cx,
arguments,
cx.tables.expr_ty(fn_expr),
&print::to_string(print::NO_ANN, |s| s.print_qpath(path, false)),
);
2016-12-20 11:21:30 -06:00
},
ExprMethodCall(ref path, _, ref arguments) => {
2017-08-15 04:10:49 -05:00
let def_id = cx.tables.type_dependent_defs()[e.hir_id].def_id();
let substs = cx.tables.node_substs(e.hir_id);
2017-06-04 16:28:01 -05:00
let method_type = cx.tcx.type_of(def_id).subst(cx.tcx, substs);
check_arguments(cx, arguments, method_type, &path.name.as_str())
2016-12-20 11:21:30 -06:00
},
2016-04-14 13:14:03 -05:00
_ => (),
2015-09-29 06:11:19 -05:00
}
}
}
fn check_arguments<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arguments: &[Expr], type_definition: Ty<'tcx>, name: &str) {
match type_definition.sty {
2017-06-29 09:07:43 -05:00
ty::TyFnDef(..) | ty::TyFnPtr(_) => {
let parameters = type_definition.fn_sig(cx.tcx).skip_binder().inputs();
for (argument, parameter) in arguments.iter().zip(parameters.iter()) {
match parameter.sty {
2017-09-05 04:33:04 -05:00
ty::TyRef(
_,
2018-05-11 01:37:48 -05:00
_,
MutImmutable,
2017-09-05 04:33:04 -05:00
) |
ty::TyRawPtr(ty::TypeAndMut {
mutbl: MutImmutable,
..
}) => if let ExprAddrOf(MutMutable, _) = argument.node {
span_lint(
cx,
UNNECESSARY_MUT_PASSED,
argument.span,
&format!("The function/method `{}` doesn't need a mutable reference", name),
);
2016-12-20 11:21:30 -06:00
},
2016-04-14 13:14:03 -05:00
_ => (),
}
}
2016-12-20 11:21:30 -06:00
},
_ => (),
}
}