]> git.lizzy.rs Git - rust.git/blob - clippy_lints/src/booleans.rs
Merge pull request #2230 from LaurentMazare/master
[rust.git] / clippy_lints / src / booleans.rs
1 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
2 use rustc::hir::*;
3 use rustc::hir::intravisit::*;
4 use syntax::ast::{LitKind, NodeId, DUMMY_NODE_ID};
5 use syntax::codemap::{dummy_spanned, Span, DUMMY_SP};
6 use syntax::util::ThinVec;
7 use utils::{in_macro, snippet_opt, span_lint_and_then, SpanlessEq};
8
9 /// **What it does:** Checks for boolean expressions that can be written more
10 /// concisely.
11 ///
12 /// **Why is this bad?** Readability of boolean expressions suffers from
13 /// unnecessary duplication.
14 ///
15 /// **Known problems:** Ignores short circuiting behavior of `||` and
16 /// `&&`. Ignores `|`, `&` and `^`.
17 ///
18 /// **Example:**
19 /// ```rust
20 /// if a && true  // should be: if a
21 /// if !(a == b)  // should be: if a != b
22 /// ```
23 declare_lint! {
24     pub NONMINIMAL_BOOL,
25     Allow,
26     "boolean expressions that can be written more concisely"
27 }
28
29 /// **What it does:** Checks for boolean expressions that contain terminals that
30 /// can be eliminated.
31 ///
32 /// **Why is this bad?** This is most likely a logic bug.
33 ///
34 /// **Known problems:** Ignores short circuiting behavior.
35 ///
36 /// **Example:**
37 /// ```rust
38 /// if a && b || a { ... }
39 /// ```
40 /// The `b` is unnecessary, the expression is equivalent to `if a`.
41 declare_lint! {
42     pub LOGIC_BUG,
43     Warn,
44     "boolean expressions that contain terminals which can be eliminated"
45 }
46
47 // For each pairs, both orders are considered.
48 const METHODS_WITH_NEGATION: [(&str, &str); 2] = [
49     ("is_some", "is_none"),
50     ("is_err", "is_ok"),
51 ];
52
53 #[derive(Copy, Clone)]
54 pub struct NonminimalBool;
55
56 impl LintPass for NonminimalBool {
57     fn get_lints(&self) -> LintArray {
58         lint_array!(NONMINIMAL_BOOL, LOGIC_BUG)
59     }
60 }
61
62 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NonminimalBool {
63     fn check_fn(
64         &mut self,
65         cx: &LateContext<'a, 'tcx>,
66         _: intravisit::FnKind<'tcx>,
67         _: &'tcx FnDecl,
68         body: &'tcx Body,
69         _: Span,
70         _: NodeId,
71     ) {
72         NonminimalBoolVisitor { cx: cx }.visit_body(body)
73     }
74 }
75
76 struct NonminimalBoolVisitor<'a, 'tcx: 'a> {
77     cx: &'a LateContext<'a, 'tcx>,
78 }
79
80 use quine_mc_cluskey::Bool;
81 struct Hir2Qmm<'a, 'tcx: 'a, 'v> {
82     terminals: Vec<&'v Expr>,
83     cx: &'a LateContext<'a, 'tcx>,
84 }
85
86 impl<'a, 'tcx, 'v> Hir2Qmm<'a, 'tcx, 'v> {
87     fn extract(&mut self, op: BinOp_, a: &[&'v Expr], mut v: Vec<Bool>) -> Result<Vec<Bool>, String> {
88         for a in a {
89             if let ExprBinary(binop, ref lhs, ref rhs) = a.node {
90                 if binop.node == op {
91                     v = self.extract(op, &[lhs, rhs], v)?;
92                     continue;
93                 }
94             }
95             v.push(self.run(a)?);
96         }
97         Ok(v)
98     }
99
100     fn run(&mut self, e: &'v Expr) -> Result<Bool, String> {
101         // prevent folding of `cfg!` macros and the like
102         if !in_macro(e.span) {
103             match e.node {
104                 ExprUnary(UnNot, ref inner) => return Ok(Bool::Not(box self.run(inner)?)),
105                 ExprBinary(binop, ref lhs, ref rhs) => match binop.node {
106                     BiOr => return Ok(Bool::Or(self.extract(BiOr, &[lhs, rhs], Vec::new())?)),
107                     BiAnd => return Ok(Bool::And(self.extract(BiAnd, &[lhs, rhs], Vec::new())?)),
108                     _ => (),
109                 },
110                 ExprLit(ref lit) => match lit.node {
111                     LitKind::Bool(true) => return Ok(Bool::True),
112                     LitKind::Bool(false) => return Ok(Bool::False),
113                     _ => (),
114                 },
115                 _ => (),
116             }
117         }
118         for (n, expr) in self.terminals.iter().enumerate() {
119             if SpanlessEq::new(self.cx).ignore_fn().eq_expr(e, expr) {
120                 #[allow(cast_possible_truncation)]
121                 return Ok(Bool::Term(n as u8));
122             }
123             let negated = match e.node {
124                 ExprBinary(binop, ref lhs, ref rhs) => {
125                     let mk_expr = |op| {
126                         Expr {
127                             id: DUMMY_NODE_ID,
128                             hir_id: DUMMY_HIR_ID,
129                             span: DUMMY_SP,
130                             attrs: ThinVec::new(),
131                             node: ExprBinary(dummy_spanned(op), lhs.clone(), rhs.clone()),
132                         }
133                     };
134                     match binop.node {
135                         BiEq => mk_expr(BiNe),
136                         BiNe => mk_expr(BiEq),
137                         BiGt => mk_expr(BiLe),
138                         BiGe => mk_expr(BiLt),
139                         BiLt => mk_expr(BiGe),
140                         BiLe => mk_expr(BiGt),
141                         _ => continue,
142                     }
143                 },
144                 _ => continue,
145             };
146             if SpanlessEq::new(self.cx).ignore_fn().eq_expr(&negated, expr) {
147                 #[allow(cast_possible_truncation)]
148                 return Ok(Bool::Not(Box::new(Bool::Term(n as u8))));
149             }
150         }
151         let n = self.terminals.len();
152         self.terminals.push(e);
153         if n < 32 {
154             #[allow(cast_possible_truncation)]
155             Ok(Bool::Term(n as u8))
156         } else {
157             Err("too many literals".to_owned())
158         }
159     }
160 }
161
162 struct SuggestContext<'a, 'tcx: 'a, 'v> {
163     terminals: &'v [&'v Expr],
164     cx: &'a LateContext<'a, 'tcx>,
165     output: String,
166     simplified: bool,
167 }
168
169 impl<'a, 'tcx, 'v> SuggestContext<'a, 'tcx, 'v> {
170     fn snip(&self, e: &Expr) -> String {
171         snippet_opt(self.cx, e.span).expect("don't try to improve booleans created by macros")
172     }
173
174     fn simplify_not(&self, expr: &Expr) -> Option<String> {
175         match expr.node {
176             ExprBinary(binop, ref lhs, ref rhs) => {
177                 match binop.node {
178                     BiEq => Some(" != "),
179                     BiNe => Some(" == "),
180                     BiLt => Some(" >= "),
181                     BiGt => Some(" <= "),
182                     BiLe => Some(" > "),
183                     BiGe => Some(" < "),
184                     _ => None,
185                 }.map(|op| format!("{}{}{}", self.snip(lhs), op, self.snip(rhs)))
186             },
187             ExprMethodCall(ref path, _, ref args) if args.len() == 1 => {
188                 METHODS_WITH_NEGATION
189                     .iter().cloned()
190                     .flat_map(|(a, b)| vec![(a, b), (b, a)])
191                     .find(|&(a, _)| a == path.name.as_str())
192                     .map(|(_, neg_method)| format!("{}.{}()", self.snip(&args[0]), neg_method))
193             },
194             _ => None,
195         }
196     }
197
198     fn recurse(&mut self, suggestion: &Bool) {
199         use quine_mc_cluskey::Bool::*;
200         match *suggestion {
201             True => {
202                 self.output.push_str("true");
203             },
204             False => {
205                 self.output.push_str("false");
206             },
207             Not(ref inner) => match **inner {
208                 And(_) | Or(_) => {
209                     self.output.push('!');
210                     self.output.push('(');
211                     self.recurse(inner);
212                     self.output.push(')');
213                 },
214                 Term(n) => {
215                     let terminal = self.terminals[n as usize];
216                     if let Some(str) = self.simplify_not(terminal) {
217                         self.simplified = true;
218                         self.output.push_str(&str)
219                     } else {
220                         self.output.push('!');
221                         let snip = self.snip(terminal);
222                         self.output.push_str(&snip);
223                     }
224                 },
225                 True | False | Not(_) => {
226                     self.output.push('!');
227                     self.recurse(inner)
228                 },
229             },
230             And(ref v) => {
231                 for (index, inner) in v.iter().enumerate() {
232                     if index > 0 {
233                         self.output.push_str(" && ");
234                     }
235                     if let Or(_) = *inner {
236                         self.output.push('(');
237                         self.recurse(inner);
238                         self.output.push(')');
239                     } else {
240                         self.recurse(inner);
241                     }
242                 }
243             },
244             Or(ref v) => {
245                 for (index, inner) in v.iter().enumerate() {
246                     if index > 0 {
247                         self.output.push_str(" || ");
248                     }
249                     self.recurse(inner);
250                 }
251             },
252             Term(n) => {
253                 let snip = self.snip(self.terminals[n as usize]);
254                 self.output.push_str(&snip);
255             },
256         }
257     }
258 }
259
260 // The boolean part of the return indicates whether some simplifications have been applied.
261 fn suggest(cx: &LateContext, suggestion: &Bool, terminals: &[&Expr]) -> (String, bool) {
262     let mut suggest_context = SuggestContext {
263         terminals: terminals,
264         cx: cx,
265         output: String::new(),
266         simplified: false,
267     };
268     suggest_context.recurse(suggestion);
269     (suggest_context.output, suggest_context.simplified)
270 }
271
272 fn simple_negate(b: Bool) -> Bool {
273     use quine_mc_cluskey::Bool::*;
274     match b {
275         True => False,
276         False => True,
277         t @ Term(_) => Not(Box::new(t)),
278         And(mut v) => {
279             for el in &mut v {
280                 *el = simple_negate(::std::mem::replace(el, True));
281             }
282             Or(v)
283         },
284         Or(mut v) => {
285             for el in &mut v {
286                 *el = simple_negate(::std::mem::replace(el, True));
287             }
288             And(v)
289         },
290         Not(inner) => *inner,
291     }
292 }
293
294 #[derive(Default)]
295 struct Stats {
296     terminals: [usize; 32],
297     negations: usize,
298     ops: usize,
299 }
300
301 fn terminal_stats(b: &Bool) -> Stats {
302     fn recurse(b: &Bool, stats: &mut Stats) {
303         match *b {
304             True | False => stats.ops += 1,
305             Not(ref inner) => {
306                 match **inner {
307                     And(_) | Or(_) => stats.ops += 1, // brackets are also operations
308                     _ => stats.negations += 1,
309                 }
310                 recurse(inner, stats);
311             },
312             And(ref v) | Or(ref v) => {
313                 stats.ops += v.len() - 1;
314                 for inner in v {
315                     recurse(inner, stats);
316                 }
317             },
318             Term(n) => stats.terminals[n as usize] += 1,
319         }
320     }
321     use quine_mc_cluskey::Bool::*;
322     let mut stats = Stats::default();
323     recurse(b, &mut stats);
324     stats
325 }
326
327 impl<'a, 'tcx> NonminimalBoolVisitor<'a, 'tcx> {
328     fn bool_expr(&self, e: &Expr) {
329         let mut h2q = Hir2Qmm {
330             terminals: Vec::new(),
331             cx: self.cx,
332         };
333         if let Ok(expr) = h2q.run(e) {
334             if h2q.terminals.len() > 8 {
335                 // QMC has exponentially slow behavior as the number of terminals increases
336                 // 8 is reasonable, it takes approximately 0.2 seconds.
337                 // See #825
338                 return;
339             }
340
341             let stats = terminal_stats(&expr);
342             let mut simplified = expr.simplify();
343             for simple in Bool::Not(Box::new(expr.clone())).simplify() {
344                 match simple {
345                     Bool::Not(_) | Bool::True | Bool::False => {},
346                     _ => simplified.push(Bool::Not(Box::new(simple.clone()))),
347                 }
348                 let simple_negated = simple_negate(simple);
349                 if simplified.iter().any(|s| *s == simple_negated) {
350                     continue;
351                 }
352                 simplified.push(simple_negated);
353             }
354             let mut improvements = Vec::new();
355             'simplified: for suggestion in &simplified {
356                 let simplified_stats = terminal_stats(suggestion);
357                 let mut improvement = false;
358                 for i in 0..32 {
359                     // ignore any "simplifications" that end up requiring a terminal more often
360                     // than in the original expression
361                     if stats.terminals[i] < simplified_stats.terminals[i] {
362                         continue 'simplified;
363                     }
364                     if stats.terminals[i] != 0 && simplified_stats.terminals[i] == 0 {
365                         span_lint_and_then(
366                             self.cx,
367                             LOGIC_BUG,
368                             e.span,
369                             "this boolean expression contains a logic bug",
370                             |db| {
371                                 db.span_help(
372                                     h2q.terminals[i].span,
373                                     "this expression can be optimized out by applying boolean operations to the \
374                                      outer expression",
375                                 );
376                                 db.span_suggestion(
377                                     e.span,
378                                     "it would look like the following",
379                                     suggest(self.cx, suggestion, &h2q.terminals).0,
380                                 );
381                             },
382                         );
383                         // don't also lint `NONMINIMAL_BOOL`
384                         return;
385                     }
386                     // if the number of occurrences of a terminal decreases or any of the stats
387                     // decreases while none increases
388                     improvement |= (stats.terminals[i] > simplified_stats.terminals[i])
389                         || (stats.negations > simplified_stats.negations && stats.ops == simplified_stats.ops)
390                         || (stats.ops > simplified_stats.ops && stats.negations == simplified_stats.negations);
391                 }
392                 if improvement {
393                     improvements.push(suggestion);
394                 }
395             }
396             let nonminimal_bool_lint = |suggestions| {
397                 span_lint_and_then(
398                     self.cx,
399                     NONMINIMAL_BOOL,
400                     e.span,
401                     "this boolean expression can be simplified",
402                     |db| { db.span_suggestions(e.span, "try", suggestions); },
403                 );
404             };
405             if improvements.is_empty() {
406                 let suggest = suggest(self.cx, &expr, &h2q.terminals);
407                 if suggest.1 {
408                     nonminimal_bool_lint(vec![suggest.0])
409                 }
410             } else {
411                 nonminimal_bool_lint(
412                     improvements
413                         .into_iter()
414                         .map(|suggestion| suggest(self.cx, suggestion, &h2q.terminals).0)
415                         .collect()
416                 );
417             }
418         }
419     }
420 }
421
422 impl<'a, 'tcx> Visitor<'tcx> for NonminimalBoolVisitor<'a, 'tcx> {
423     fn visit_expr(&mut self, e: &'tcx Expr) {
424         if in_macro(e.span) {
425             return;
426         }
427         match e.node {
428             ExprBinary(binop, _, _) if binop.node == BiOr || binop.node == BiAnd => self.bool_expr(e),
429             ExprUnary(UnNot, ref inner) => if self.cx.tables.node_types()[inner.hir_id].is_bool() {
430                 self.bool_expr(e);
431             } else {
432                 walk_expr(self, e);
433             },
434             _ => walk_expr(self, e),
435         }
436     }
437     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
438         NestedVisitorMap::None
439     }
440 }