rust/clippy_lints/src/mut_reference.rs

83 lines
3.1 KiB
Rust
Raw Normal View History

2018-05-30 03:15:50 -05:00
use crate::utils::span_lint;
use rustc_hir::{BorrowKind, Expr, ExprKind, Mutability};
2020-01-12 00:08:41 -06:00
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty::subst::Subst;
use rustc_middle::ty::{self, Ty};
2020-01-11 05:37:08 -06:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2015-09-29 06:11:19 -05:00
2018-03-28 08:24:26 -05:00
declare_clippy_lint! {
/// **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:**
2019-03-05 16:23:50 -06:00
/// ```ignore
/// my_vec.push(&mut value)
/// ```
2018-11-27 14:49:09 -06:00
pub UNNECESSARY_MUT_PASSED,
style,
"an argument passed as a mutable reference although the callee only demands an immutable reference"
2015-09-29 06:11:19 -05:00
}
2019-04-08 15:43:55 -05:00
declare_lint_pass!(UnnecessaryMutPassed => [UNNECESSARY_MUT_PASSED]);
2015-09-29 06:11:19 -05:00
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UnnecessaryMutPassed {
2019-12-27 01:12:26 -06:00
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, e: &'tcx Expr<'_>) {
2019-09-27 10:16:06 -05:00
match e.kind {
2018-11-27 14:14:15 -06:00
ExprKind::Call(ref fn_expr, ref arguments) => {
2019-09-27 10:16:06 -05:00
if let ExprKind::Path(ref path) = fn_expr.kind {
2018-11-27 14:14:15 -06:00
check_arguments(
cx,
arguments,
cx.tables.expr_ty(fn_expr),
&rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false)),
2018-11-27 14:14:15 -06:00
);
}
2016-12-20 11:21:30 -06:00
},
2018-07-12 02:30:57 -05:00
ExprKind::MethodCall(ref path, _, ref arguments) => {
let def_id = cx.tables.type_dependent_def_id(e.hir_id).unwrap();
2017-08-15 04:10:49 -05:00
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);
2018-06-28 08:46:58 -05:00
check_arguments(cx, arguments, method_type, &path.ident.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
}
}
}
2019-12-27 01:12:26 -06:00
fn check_arguments<'a, 'tcx>(
cx: &LateContext<'a, 'tcx>,
arguments: &[Expr<'_>],
type_definition: Ty<'tcx>,
name: &str,
) {
match type_definition.kind {
ty::FnDef(..) | ty::FnPtr(_) => {
let parameters = type_definition.fn_sig(cx.tcx).skip_binder().inputs();
for (argument, parameter) in arguments.iter().zip(parameters.iter()) {
match parameter.kind {
ty::Ref(_, _, Mutability::Not)
2018-11-27 14:14:15 -06:00
| ty::RawPtr(ty::TypeAndMut {
mutbl: Mutability::Not, ..
2018-11-27 14:14:15 -06:00
}) => {
if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Mut, _) = argument.kind {
2018-11-27 14:14:15 -06:00
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
},
_ => (),
}
}