2015-08-30 15:32:35 +00:00
|
|
|
use rustc::lint::*;
|
2015-09-19 02:53:04 +00:00
|
|
|
use syntax::ast::*;
|
2016-02-24 16:38:57 +00:00
|
|
|
use syntax::codemap::Spanned;
|
2017-06-21 18:04:04 +00:00
|
|
|
use utils::{span_lint_and_sugg, snippet};
|
2015-08-30 15:32:35 +00:00
|
|
|
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **What it does:** Checks for operations where precedence may be unclear
|
|
|
|
/// and suggests to add parentheses. Currently it catches the following:
|
2015-12-11 00:22:27 +00:00
|
|
|
/// * mixed usage of arithmetic and bit shifting/combining operators without parentheses
|
2016-07-15 22:25:44 +00:00
|
|
|
/// * a "negative" numeric literal (which is really a unary `-` followed by a numeric literal)
|
|
|
|
/// followed by a method call
|
2015-12-11 00:22:27 +00:00
|
|
|
///
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **Why is this bad?** Not everyone knows the precedence of those operators by
|
|
|
|
/// heart, so expressions like these may trip others trying to reason about the
|
|
|
|
/// code.
|
2015-12-11 00:22:27 +00:00
|
|
|
///
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **Known problems:** None.
|
2015-12-11 00:22:27 +00:00
|
|
|
///
|
2016-08-06 07:55:04 +00:00
|
|
|
/// **Example:**
|
2015-12-11 00:22:27 +00:00
|
|
|
/// * `1 << 2 + 3` equals 32, while `(1 << 2) + 3` equals 7
|
|
|
|
/// * `-1i32.abs()` equals -1, while `(-1i32).abs()` equals 1
|
2016-02-05 23:13:29 +00:00
|
|
|
declare_lint! {
|
2016-08-06 08:18:36 +00:00
|
|
|
pub PRECEDENCE,
|
|
|
|
Warn,
|
|
|
|
"operations where precedence may be unclear"
|
2016-02-05 23:13:29 +00:00
|
|
|
}
|
2015-08-30 15:32:35 +00:00
|
|
|
|
|
|
|
#[derive(Copy,Clone)]
|
|
|
|
pub struct Precedence;
|
|
|
|
|
|
|
|
impl LintPass for Precedence {
|
|
|
|
fn get_lints(&self) -> LintArray {
|
|
|
|
lint_array!(PRECEDENCE)
|
|
|
|
}
|
2015-09-19 02:53:04 +00:00
|
|
|
}
|
2015-08-30 15:32:35 +00:00
|
|
|
|
2015-09-19 02:53:04 +00:00
|
|
|
impl EarlyLintPass for Precedence {
|
|
|
|
fn check_expr(&mut self, cx: &EarlyContext, expr: &Expr) {
|
2016-04-14 18:14:03 +00:00
|
|
|
if let ExprKind::Binary(Spanned { node: op, .. }, ref left, ref right) = expr.node {
|
2017-06-29 14:07:43 +00:00
|
|
|
let span_sugg = |expr: &Expr, sugg| {
|
|
|
|
span_lint_and_sugg(cx,
|
|
|
|
PRECEDENCE,
|
|
|
|
expr.span,
|
|
|
|
"operator precedence can trip the unwary",
|
|
|
|
"consider parenthesizing your expression",
|
|
|
|
sugg);
|
|
|
|
};
|
2017-01-22 13:51:13 +00:00
|
|
|
|
2016-01-04 04:26:12 +00:00
|
|
|
if !is_bit_op(op) {
|
|
|
|
return;
|
|
|
|
}
|
2015-10-13 11:48:48 +00:00
|
|
|
match (is_arith_expr(left), is_arith_expr(right)) {
|
2015-12-31 20:39:03 +00:00
|
|
|
(true, true) => {
|
2017-01-22 13:51:13 +00:00
|
|
|
let sugg = format!("({}) {} ({})",
|
2016-01-04 04:26:12 +00:00
|
|
|
snippet(cx, left.span, ".."),
|
|
|
|
op.to_string(),
|
2017-01-22 13:51:13 +00:00
|
|
|
snippet(cx, right.span, ".."));
|
|
|
|
span_sugg(expr, sugg);
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2015-12-31 20:39:03 +00:00
|
|
|
(true, false) => {
|
2017-01-22 13:51:13 +00:00
|
|
|
let sugg = format!("({}) {} {}",
|
2016-01-04 04:26:12 +00:00
|
|
|
snippet(cx, left.span, ".."),
|
|
|
|
op.to_string(),
|
2017-01-22 13:51:13 +00:00
|
|
|
snippet(cx, right.span, ".."));
|
|
|
|
span_sugg(expr, sugg);
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2015-12-31 20:39:03 +00:00
|
|
|
(false, true) => {
|
2017-01-22 13:51:13 +00:00
|
|
|
let sugg = format!("{} {} ({})",
|
2016-01-04 04:26:12 +00:00
|
|
|
snippet(cx, left.span, ".."),
|
|
|
|
op.to_string(),
|
2017-01-22 13:51:13 +00:00
|
|
|
snippet(cx, right.span, ".."));
|
|
|
|
span_sugg(expr, sugg);
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2017-01-22 13:51:13 +00:00
|
|
|
(false, false) => (),
|
2015-08-30 15:32:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-12 17:35:44 +00:00
|
|
|
if let ExprKind::Unary(UnOp::Neg, ref rhs) = expr.node {
|
2017-07-10 08:17:40 +00:00
|
|
|
if let ExprKind::MethodCall(_, ref args) = rhs.node {
|
2015-08-30 15:32:35 +00:00
|
|
|
if let Some(slf) = args.first() {
|
2016-02-12 17:35:44 +00:00
|
|
|
if let ExprKind::Lit(ref lit) = slf.node {
|
2015-08-30 15:32:35 +00:00
|
|
|
match lit.node {
|
2016-04-14 18:14:03 +00:00
|
|
|
LitKind::Int(..) |
|
|
|
|
LitKind::Float(..) |
|
|
|
|
LitKind::FloatUnsuffixed(..) => {
|
2017-06-21 18:04:04 +00:00
|
|
|
span_lint_and_sugg(cx,
|
2017-01-22 13:51:13 +00:00
|
|
|
PRECEDENCE,
|
|
|
|
expr.span,
|
|
|
|
"unary minus has lower precedence than method call",
|
2017-06-21 18:04:04 +00:00
|
|
|
"consider adding parentheses to clarify your intent",
|
|
|
|
format!("-({})", snippet(cx, rhs.span, "..")));
|
2016-12-20 17:21:30 +00:00
|
|
|
},
|
2016-01-04 04:26:12 +00:00
|
|
|
_ => (),
|
2015-08-30 15:32:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-17 05:22:57 +00:00
|
|
|
fn is_arith_expr(expr: &Expr) -> bool {
|
2015-08-30 15:32:35 +00:00
|
|
|
match expr.node {
|
2016-04-14 18:14:03 +00:00
|
|
|
ExprKind::Binary(Spanned { node: op, .. }, _, _) => is_arith_op(op),
|
2016-01-04 04:26:12 +00:00
|
|
|
_ => false,
|
2015-08-30 15:32:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-12 17:35:44 +00:00
|
|
|
fn is_bit_op(op: BinOpKind) -> bool {
|
|
|
|
use syntax::ast::BinOpKind::*;
|
2015-08-30 15:32:35 +00:00
|
|
|
match op {
|
2016-02-12 17:35:44 +00:00
|
|
|
BitXor | BitAnd | BitOr | Shl | Shr => true,
|
2016-01-04 04:26:12 +00:00
|
|
|
_ => false,
|
2015-08-30 15:32:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-12 17:35:44 +00:00
|
|
|
fn is_arith_op(op: BinOpKind) -> bool {
|
|
|
|
use syntax::ast::BinOpKind::*;
|
2015-08-30 15:32:35 +00:00
|
|
|
match op {
|
2016-02-12 17:35:44 +00:00
|
|
|
Add | Sub | Mul | Div | Rem => true,
|
2016-01-04 04:26:12 +00:00
|
|
|
_ => false,
|
2015-08-30 15:32:35 +00:00
|
|
|
}
|
|
|
|
}
|