2 eq_expr_value, get_trait_def_id, implements_trait, in_macro, is_type_diagnostic_item, paths, snippet_opt,
3 span_lint_and_sugg, span_lint_and_then,
5 use if_chain::if_chain;
6 use rustc_ast::ast::LitKind;
7 use rustc_errors::Applicability;
8 use rustc_hir::intravisit::{walk_expr, FnKind, NestedVisitorMap, Visitor};
9 use rustc_hir::{BinOpKind, Body, Expr, ExprKind, FnDecl, HirId, UnOp};
10 use rustc_lint::{LateContext, LateLintPass};
11 use rustc_middle::hir::map::Map;
12 use rustc_session::{declare_lint_pass, declare_tool_lint};
13 use rustc_span::source_map::Span;
15 declare_clippy_lint! {
16 /// **What it does:** Checks for boolean expressions that can be written more
19 /// **Why is this bad?** Readability of boolean expressions suffers from
20 /// unnecessary duplication.
22 /// **Known problems:** Ignores short circuiting behavior of `||` and
23 /// `&&`. Ignores `|`, `&` and `^`.
27 /// if a && true // should be: if a
28 /// if !(a == b) // should be: if a != b
32 "boolean expressions that can be written more concisely"
35 declare_clippy_lint! {
36 /// **What it does:** Checks for boolean expressions that contain terminals that
37 /// can be eliminated.
39 /// **Why is this bad?** This is most likely a logic bug.
41 /// **Known problems:** Ignores short circuiting behavior.
45 /// if a && b || a { ... }
47 /// The `b` is unnecessary, the expression is equivalent to `if a`.
50 "boolean expressions that contain terminals which can be eliminated"
53 // For each pairs, both orders are considered.
54 const METHODS_WITH_NEGATION: [(&str, &str); 2] = [("is_some", "is_none"), ("is_err", "is_ok")];
56 declare_lint_pass!(NonminimalBool => [NONMINIMAL_BOOL, LOGIC_BUG]);
58 impl<'tcx> LateLintPass<'tcx> for NonminimalBool {
61 cx: &LateContext<'tcx>,
68 NonminimalBoolVisitor { cx }.visit_body(body)
72 struct NonminimalBoolVisitor<'a, 'tcx> {
73 cx: &'a LateContext<'tcx>,
76 use quine_mc_cluskey::Bool;
77 struct Hir2Qmm<'a, 'tcx, 'v> {
78 terminals: Vec<&'v Expr<'v>>,
79 cx: &'a LateContext<'tcx>,
82 impl<'a, 'tcx, 'v> Hir2Qmm<'a, 'tcx, 'v> {
83 fn extract(&mut self, op: BinOpKind, a: &[&'v Expr<'_>], mut v: Vec<Bool>) -> Result<Vec<Bool>, String> {
85 if let ExprKind::Binary(binop, lhs, rhs) = &a.kind {
87 v = self.extract(op, &[lhs, rhs], v)?;
96 fn run(&mut self, e: &'v Expr<'_>) -> Result<Bool, String> {
97 fn negate(bin_op_kind: BinOpKind) -> Option<BinOpKind> {
99 BinOpKind::Eq => Some(BinOpKind::Ne),
100 BinOpKind::Ne => Some(BinOpKind::Eq),
101 BinOpKind::Gt => Some(BinOpKind::Le),
102 BinOpKind::Ge => Some(BinOpKind::Lt),
103 BinOpKind::Lt => Some(BinOpKind::Ge),
104 BinOpKind::Le => Some(BinOpKind::Gt),
109 // prevent folding of `cfg!` macros and the like
110 if !e.span.from_expansion() {
112 ExprKind::Unary(UnOp::UnNot, inner) => return Ok(Bool::Not(box self.run(inner)?)),
113 ExprKind::Binary(binop, lhs, rhs) => match &binop.node {
115 return Ok(Bool::Or(self.extract(BinOpKind::Or, &[lhs, rhs], Vec::new())?));
118 return Ok(Bool::And(self.extract(BinOpKind::And, &[lhs, rhs], Vec::new())?));
122 ExprKind::Lit(lit) => match lit.node {
123 LitKind::Bool(true) => return Ok(Bool::True),
124 LitKind::Bool(false) => return Ok(Bool::False),
130 for (n, expr) in self.terminals.iter().enumerate() {
131 if eq_expr_value(self.cx, e, expr) {
132 #[allow(clippy::cast_possible_truncation)]
133 return Ok(Bool::Term(n as u8));
137 if let ExprKind::Binary(e_binop, e_lhs, e_rhs) = &e.kind;
138 if implements_ord(self.cx, e_lhs);
139 if let ExprKind::Binary(expr_binop, expr_lhs, expr_rhs) = &expr.kind;
140 if negate(e_binop.node) == Some(expr_binop.node);
141 if eq_expr_value(self.cx, e_lhs, expr_lhs);
142 if eq_expr_value(self.cx, e_rhs, expr_rhs);
144 #[allow(clippy::cast_possible_truncation)]
145 return Ok(Bool::Not(Box::new(Bool::Term(n as u8))));
149 let n = self.terminals.len();
150 self.terminals.push(e);
152 #[allow(clippy::cast_possible_truncation)]
153 Ok(Bool::Term(n as u8))
155 Err("too many literals".to_owned())
160 struct SuggestContext<'a, 'tcx, 'v> {
161 terminals: &'v [&'v Expr<'v>],
162 cx: &'a LateContext<'tcx>,
166 impl<'a, 'tcx, 'v> SuggestContext<'a, 'tcx, 'v> {
167 fn recurse(&mut self, suggestion: &Bool) -> Option<()> {
168 use quine_mc_cluskey::Bool::{And, False, Not, Or, Term, True};
171 self.output.push_str("true");
174 self.output.push_str("false");
176 Not(inner) => match **inner {
178 self.output.push('!');
179 self.output.push('(');
181 self.output.push(')');
184 let terminal = self.terminals[n as usize];
185 if let Some(str) = simplify_not(self.cx, terminal) {
186 self.output.push_str(&str)
188 self.output.push('!');
189 let snip = snippet_opt(self.cx, terminal.span)?;
190 self.output.push_str(&snip);
193 True | False | Not(_) => {
194 self.output.push('!');
195 self.recurse(inner)?;
199 for (index, inner) in v.iter().enumerate() {
201 self.output.push_str(" && ");
203 if let Or(_) = *inner {
204 self.output.push('(');
206 self.output.push(')');
213 for (index, inner) in v.iter().rev().enumerate() {
215 self.output.push_str(" || ");
221 let snip = snippet_opt(self.cx, self.terminals[n as usize].span)?;
222 self.output.push_str(&snip);
229 fn simplify_not(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
231 ExprKind::Binary(binop, lhs, rhs) => {
232 if !implements_ord(cx, lhs) {
237 BinOpKind::Eq => Some(" != "),
238 BinOpKind::Ne => Some(" == "),
239 BinOpKind::Lt => Some(" >= "),
240 BinOpKind::Gt => Some(" <= "),
241 BinOpKind::Le => Some(" > "),
242 BinOpKind::Ge => Some(" < "),
248 snippet_opt(cx, lhs.span)?,
250 snippet_opt(cx, rhs.span)?
254 ExprKind::MethodCall(path, _, args, _) if args.len() == 1 => {
255 let type_of_receiver = cx.typeck_results().expr_ty(&args[0]);
256 if !is_type_diagnostic_item(cx, type_of_receiver, sym!(option_type))
257 && !is_type_diagnostic_item(cx, type_of_receiver, sym!(result_type))
261 METHODS_WITH_NEGATION
264 .flat_map(|(a, b)| vec![(a, b), (b, a)])
266 let path: &str = &path.ident.name.as_str();
269 .and_then(|(_, neg_method)| Some(format!("{}.{}()", snippet_opt(cx, args[0].span)?, neg_method)))
275 fn suggest(cx: &LateContext<'_>, suggestion: &Bool, terminals: &[&Expr<'_>]) -> String {
276 let mut suggest_context = SuggestContext {
279 output: String::new(),
281 suggest_context.recurse(suggestion);
282 suggest_context.output
285 fn simple_negate(b: Bool) -> Bool {
286 use quine_mc_cluskey::Bool::{And, False, Not, Or, Term, True};
290 t @ Term(_) => Not(Box::new(t)),
293 *el = simple_negate(::std::mem::replace(el, True));
299 *el = simple_negate(::std::mem::replace(el, True));
303 Not(inner) => *inner,
309 terminals: [usize; 32],
314 fn terminal_stats(b: &Bool) -> Stats {
315 fn recurse(b: &Bool, stats: &mut Stats) {
317 True | False => stats.ops += 1,
320 And(_) | Or(_) => stats.ops += 1, // brackets are also operations
321 _ => stats.negations += 1,
323 recurse(inner, stats);
326 stats.ops += v.len() - 1;
328 recurse(inner, stats);
331 &Term(n) => stats.terminals[n as usize] += 1,
334 use quine_mc_cluskey::Bool::{And, False, Not, Or, Term, True};
335 let mut stats = Stats::default();
336 recurse(b, &mut stats);
340 impl<'a, 'tcx> NonminimalBoolVisitor<'a, 'tcx> {
341 fn bool_expr(&self, e: &'tcx Expr<'_>) {
342 let mut h2q = Hir2Qmm {
343 terminals: Vec::new(),
346 if let Ok(expr) = h2q.run(e) {
347 if h2q.terminals.len() > 8 {
348 // QMC has exponentially slow behavior as the number of terminals increases
349 // 8 is reasonable, it takes approximately 0.2 seconds.
354 let stats = terminal_stats(&expr);
355 let mut simplified = expr.simplify();
356 for simple in Bool::Not(Box::new(expr)).simplify() {
358 Bool::Not(_) | Bool::True | Bool::False => {},
359 _ => simplified.push(Bool::Not(Box::new(simple.clone()))),
361 let simple_negated = simple_negate(simple);
362 if simplified.iter().any(|s| *s == simple_negated) {
365 simplified.push(simple_negated);
367 let mut improvements = Vec::with_capacity(simplified.len());
368 'simplified: for suggestion in &simplified {
369 let simplified_stats = terminal_stats(suggestion);
370 let mut improvement = false;
372 // ignore any "simplifications" that end up requiring a terminal more often
373 // than in the original expression
374 if stats.terminals[i] < simplified_stats.terminals[i] {
375 continue 'simplified;
377 if stats.terminals[i] != 0 && simplified_stats.terminals[i] == 0 {
382 "this boolean expression contains a logic bug",
385 h2q.terminals[i].span,
386 "this expression can be optimized out by applying boolean operations to the \
389 diag.span_suggestion(
391 "it would look like the following",
392 suggest(self.cx, suggestion, &h2q.terminals),
393 // nonminimal_bool can produce minimal but
394 // not human readable expressions (#3141)
395 Applicability::Unspecified,
399 // don't also lint `NONMINIMAL_BOOL`
402 // if the number of occurrences of a terminal decreases or any of the stats
403 // decreases while none increases
404 improvement |= (stats.terminals[i] > simplified_stats.terminals[i])
405 || (stats.negations > simplified_stats.negations && stats.ops == simplified_stats.ops)
406 || (stats.ops > simplified_stats.ops && stats.negations == simplified_stats.negations);
409 improvements.push(suggestion);
412 let nonminimal_bool_lint = |suggestions: Vec<_>| {
417 "this boolean expression can be simplified",
419 diag.span_suggestions(
422 suggestions.into_iter(),
423 // nonminimal_bool can produce minimal but
424 // not human readable expressions (#3141)
425 Applicability::Unspecified,
430 if improvements.is_empty() {
431 let mut visitor = NotSimplificationVisitor { cx: self.cx };
432 visitor.visit_expr(e);
434 nonminimal_bool_lint(
437 .map(|suggestion| suggest(self.cx, suggestion, &h2q.terminals))
445 impl<'a, 'tcx> Visitor<'tcx> for NonminimalBoolVisitor<'a, 'tcx> {
446 type Map = Map<'tcx>;
448 fn visit_expr(&mut self, e: &'tcx Expr<'_>) {
449 if in_macro(e.span) {
453 ExprKind::Binary(binop, _, _) if binop.node == BinOpKind::Or || binop.node == BinOpKind::And => {
456 ExprKind::Unary(UnOp::UnNot, inner) => {
457 if self.cx.typeck_results().node_types()[inner.hir_id].is_bool() {
463 _ => walk_expr(self, e),
466 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
467 NestedVisitorMap::None
471 fn implements_ord<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) -> bool {
472 let ty = cx.typeck_results().expr_ty(expr);
473 get_trait_def_id(cx, &paths::ORD).map_or(false, |id| implements_trait(cx, ty, id, &[]))
476 struct NotSimplificationVisitor<'a, 'tcx> {
477 cx: &'a LateContext<'tcx>,
480 impl<'a, 'tcx> Visitor<'tcx> for NotSimplificationVisitor<'a, 'tcx> {
481 type Map = Map<'tcx>;
483 fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
484 if let ExprKind::Unary(UnOp::UnNot, inner) = &expr.kind {
485 if let Some(suggestion) = simplify_not(self.cx, inner) {
490 "this boolean expression can be simplified",
493 Applicability::MachineApplicable,
498 walk_expr(self, expr);
500 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
501 NestedVisitorMap::None