rust-clippy/clippy_lints/src/identity_op.rs

103 lines
3.4 KiB
Rust
Raw Normal View History

use clippy_utils::source::snippet;
use if_chain::if_chain;
use rustc_hir::{BinOp, BinOpKind, Expr, ExprKind};
2020-01-12 06:08:41 +00:00
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty;
2020-01-11 11:37:08 +00:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::source_map::Span;
2019-01-31 01:15:29 +00:00
use crate::consts::{constant_simple, Constant};
use clippy_utils::diagnostics::span_lint;
use clippy_utils::{clip, unsext};
2019-01-31 01:15:29 +00:00
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
2019-01-31 01:15:29 +00:00
/// **What it does:** Checks for identity operations, e.g., `x + 0`.
///
/// **Why is this bad?** This code can be removed without changing the
/// meaning. So it just obscures what's going on. Delete it mercilessly.
///
/// **Known problems:** None.
///
/// **Example:**
/// ```rust
/// # let x = 1;
/// x / 1 + 0 * 1 - 0 | 0;
/// ```
pub IDENTITY_OP,
2018-03-28 13:24:26 +00:00
complexity,
2019-01-31 01:15:29 +00:00
"using identity operations, e.g., `x + 0` or `y / 1`"
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(IdentityOp => [IDENTITY_OP]);
impl<'tcx> LateLintPass<'tcx> for IdentityOp {
fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx Expr<'_>) {
2019-08-19 16:30:32 +00:00
if e.span.from_expansion() {
2016-01-04 04:26:12 +00:00
return;
}
if let ExprKind::Binary(cmp, left, right) = e.kind {
if is_allowed(cx, cmp, left, right) {
return;
}
match cmp.node {
2018-07-12 07:50:09 +00:00
BinOpKind::Add | BinOpKind::BitOr | BinOpKind::BitXor => {
check(cx, left, 0, e.span, right.span);
check(cx, right, 0, e.span, left.span);
2016-12-20 17:21:30 +00:00
},
2018-07-12 07:50:09 +00:00
BinOpKind::Shl | BinOpKind::Shr | BinOpKind::Sub => check(cx, right, 0, e.span, left.span),
BinOpKind::Mul => {
check(cx, left, 1, e.span, right.span);
check(cx, right, 1, e.span, left.span);
2016-12-20 17:21:30 +00:00
},
2018-07-12 07:50:09 +00:00
BinOpKind::Div => check(cx, right, 1, e.span, left.span),
BinOpKind::BitAnd => {
check(cx, left, -1, e.span, right.span);
check(cx, right, -1, e.span, left.span);
2016-12-20 17:21:30 +00:00
},
2016-01-04 04:26:12 +00:00
_ => (),
}
}
}
}
fn is_allowed(cx: &LateContext<'_>, cmp: BinOp, left: &Expr<'_>, right: &Expr<'_>) -> bool {
// `1 << 0` is a common pattern in bit manipulation code
if_chain! {
if let BinOpKind::Shl = cmp.node;
2020-07-17 08:47:04 +00:00
if let Some(Constant::Int(0)) = constant_simple(cx, cx.typeck_results(), right);
if let Some(Constant::Int(1)) = constant_simple(cx, cx.typeck_results(), left);
then {
return true;
}
}
false
}
2018-08-01 20:48:41 +00:00
#[allow(clippy::cast_possible_wrap)]
fn check(cx: &LateContext<'_>, e: &Expr<'_>, m: i8, span: Span, arg: Span) {
2020-07-17 08:47:04 +00:00
if let Some(Constant::Int(v)) = constant_simple(cx, cx.typeck_results(), e) {
let check = match *cx.typeck_results().expr_ty(e).kind() {
ty::Int(ity) => unsext(cx.tcx, -1_i128, ity),
ty::Uint(uty) => clip(cx.tcx, !0, uty),
2018-03-13 10:38:11 +00:00
_ => return,
};
2015-09-06 08:53:55 +00:00
if match m {
2018-03-13 10:38:11 +00:00
0 => v == 0,
-1 => v == check,
1 => v == 1,
2015-09-06 08:53:55 +00:00
_ => unreachable!(),
2017-09-05 09:33:04 +00:00
} {
2017-08-09 07:30:56 +00:00
span_lint(
cx,
IDENTITY_OP,
span,
&format!(
"the operation is ineffective. Consider reducing it to `{}`",
snippet(cx, arg, "..")
),
);
}
}
}