rust-clippy/clippy_lints/src/mut_reference.rs

91 lines
3.2 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint;
use rustc_hir::{BorrowKind, Expr, ExprKind, Mutability};
2020-01-12 06:08:41 +00:00
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty::subst::Subst;
use rustc_middle::ty::{self, Ty};
2020-01-11 11:37:08 +00:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2021-03-08 23:57:44 +00:00
use std::iter;
2015-09-29 11:11:19 +00:00
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// ### What it does
/// Detects passing a mutable reference to a function that only
/// requires an immutable reference.
///
/// ### Why is this bad?
/// The mutable reference rules out all other references to
/// the value. Also the code misleads about the intent of the call site.
///
/// ### Example
2019-03-05 22:23:50 +00:00
/// ```ignore
/// // Bad
/// my_vec.push(&mut value)
///
/// // Good
/// my_vec.push(&value)
/// ```
#[clippy::version = "pre 1.29.0"]
2018-11-27 20:49:09 +00:00
pub UNNECESSARY_MUT_PASSED,
style,
"an argument passed as a mutable reference although the callee only demands an immutable reference"
2015-09-29 11:11:19 +00:00
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(UnnecessaryMutPassed => [UNNECESSARY_MUT_PASSED]);
2015-09-29 11:11:19 +00:00
impl<'tcx> LateLintPass<'tcx> for UnnecessaryMutPassed {
fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx Expr<'_>) {
2019-09-27 15:16:06 +00:00
match e.kind {
ExprKind::Call(fn_expr, arguments) => {
2019-09-27 15:16:06 +00:00
if let ExprKind::Path(ref path) = fn_expr.kind {
2018-11-27 20:14:15 +00:00
check_arguments(
cx,
arguments,
2020-07-17 08:47:04 +00:00
cx.typeck_results().expr_ty(fn_expr),
&rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false)),
"function",
2018-11-27 20:14:15 +00:00
);
}
2016-12-20 17:21:30 +00:00
},
ExprKind::MethodCall(path, arguments, _) => {
2020-07-17 08:47:04 +00:00
let def_id = cx.typeck_results().type_dependent_def_id(e.hir_id).unwrap();
let substs = cx.typeck_results().node_substs(e.hir_id);
2017-06-04 21:28:01 +00:00
let method_type = cx.tcx.type_of(def_id).subst(cx.tcx, substs);
check_arguments(cx, arguments, method_type, path.ident.as_str(), "method");
2016-12-20 17:21:30 +00:00
},
2016-04-14 18:14:03 +00:00
_ => (),
2015-09-29 11:11:19 +00:00
}
}
}
fn check_arguments<'tcx>(
cx: &LateContext<'tcx>,
arguments: &[Expr<'_>],
type_definition: Ty<'tcx>,
name: &str,
fn_kind: &str,
) {
match type_definition.kind() {
ty::FnDef(..) | ty::FnPtr(_) => {
let parameters = type_definition.fn_sig(cx.tcx).skip_binder().inputs();
2021-03-08 23:57:44 +00:00
for (argument, parameter) in iter::zip(arguments, parameters) {
match parameter.kind() {
ty::Ref(_, _, Mutability::Not)
2018-11-27 20:14:15 +00:00
| ty::RawPtr(ty::TypeAndMut {
mutbl: Mutability::Not, ..
2018-11-27 20:14:15 +00:00
}) => {
if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Mut, _) = argument.kind {
2018-11-27 20:14:15 +00:00
span_lint(
cx,
UNNECESSARY_MUT_PASSED,
argument.span,
&format!("the {} `{}` doesn't need a mutable reference", fn_kind, name),
2018-11-27 20:14:15 +00:00
);
}
2016-12-20 17:21:30 +00:00
},
2016-04-14 18:14:03 +00:00
_ => (),
}
}
2016-12-20 17:21:30 +00:00
},
_ => (),
}
}