Fix false positives when iterator variable is used after the loop

This commit is contained in:
Florian Hartwig 2015-10-26 23:49:37 +01:00
parent 66419582b5
commit 5ca7ebb6d2
3 changed files with 61 additions and 17 deletions

View file

@ -11,7 +11,8 @@ use std::collections::{HashSet,HashMap};
use syntax::ast::Lit_::*; use syntax::ast::Lit_::*;
use utils::{snippet, span_lint, get_parent_expr, match_trait_method, match_type, use utils::{snippet, span_lint, get_parent_expr, match_trait_method, match_type,
in_external_macro, expr_block, span_help_and_lint, is_integer_literal}; in_external_macro, expr_block, span_help_and_lint, is_integer_literal,
get_enclosing_block};
use utils::{VEC_PATH, LL_PATH}; use utils::{VEC_PATH, LL_PATH};
declare_lint!{ pub NEEDLESS_RANGE_LOOP, Warn, declare_lint!{ pub NEEDLESS_RANGE_LOOP, Warn,
@ -232,17 +233,16 @@ impl LateLintPass for LoopsPass {
} }
} }
if let ExprMatch(ref match_expr, ref arms, MatchSource::WhileLetDesugar) = expr.node { if let ExprMatch(ref match_expr, ref arms, MatchSource::WhileLetDesugar) = expr.node {
let body = &arms[0].body;
let pat = &arms[0].pats[0].node; let pat = &arms[0].pats[0].node;
if let (&PatEnum(ref path, Some(ref pat_args)), if let (&PatEnum(ref path, Some(ref pat_args)),
&ExprMethodCall(method_name, _, ref method_args)) = &ExprMethodCall(method_name, _, ref method_args)) =
(pat, &match_expr.node) { (pat, &match_expr.node) {
let iterator_def_id = var_def_id(cx, &method_args[0]); let iter_expr = &method_args[0];
if let Some(lhs_constructor) = path.segments.last() { if let Some(lhs_constructor) = path.segments.last() {
if method_name.node.as_str() == "next" && if method_name.node.as_str() == "next" &&
match_trait_method(cx, match_expr, &["core", "iter", "Iterator"]) && match_trait_method(cx, match_expr, &["core", "iter", "Iterator"]) &&
lhs_constructor.identifier.name.as_str() == "Some" && lhs_constructor.identifier.name.as_str() == "Some" &&
!var_used(body, iterator_def_id, cx) { !is_iterator_used_after_while_let(cx, iter_expr) {
let iterator = snippet(cx, method_args[0].span, "_"); let iterator = snippet(cx, method_args[0].span, "_");
let loop_var = snippet(cx, pat_args[0].span, "_"); let loop_var = snippet(cx, pat_args[0].span, "_");
span_help_and_lint(cx, WHILE_LET_ON_ITERATOR, expr.span, span_help_and_lint(cx, WHILE_LET_ON_ITERATOR, expr.span,
@ -326,32 +326,46 @@ impl<'v, 't> Visitor<'v> for VarVisitor<'v, 't> {
} }
} }
fn var_used(expr: &Expr, def_id: Option<NodeId>, cx: &LateContext) -> bool { fn is_iterator_used_after_while_let(cx: &LateContext, iter_expr: &Expr) -> bool {
match def_id { let def_id = match var_def_id(cx, iter_expr) {
None => false, Some(id) => id,
Some(def_id) => { None => return false
let mut visitor = VarUsedVisitor{ def_id: def_id, found: false, cx: cx }; };
walk_expr(&mut visitor, expr); let mut visitor = VarUsedAfterLoopVisitor {
visitor.found cx: cx,
} def_id: def_id,
iter_expr_id: iter_expr.id,
past_while_let: false,
var_used_after_while_let: false
};
if let Some(enclosing_block) = get_enclosing_block(cx, def_id) {
walk_block(&mut visitor, enclosing_block);
} }
visitor.var_used_after_while_let
} }
struct VarUsedVisitor<'v, 't: 'v> { struct VarUsedAfterLoopVisitor<'v, 't: 'v> {
cx: &'v LateContext<'v, 't>, cx: &'v LateContext<'v, 't>,
def_id: NodeId, def_id: NodeId,
found: bool iter_expr_id: NodeId,
past_while_let: bool,
var_used_after_while_let: bool
} }
impl<'v, 't> Visitor<'v> for VarUsedVisitor<'v, 't> { impl <'v, 't> Visitor<'v> for VarUsedAfterLoopVisitor<'v, 't> {
fn visit_expr(&mut self, expr: &'v Expr) { fn visit_expr(&mut self, expr: &'v Expr) {
if Some(self.def_id) == var_def_id(self.cx, expr) { if self.past_while_let {
self.found = true; if Some(self.def_id) == var_def_id(self.cx, expr) {
self.var_used_after_while_let = true;
}
} else if self.iter_expr_id == expr.id {
self.past_while_let = true;
} }
walk_expr(self, expr); walk_expr(self, expr);
} }
} }
/// Return true if the type of expr is one that provides IntoIterator impls /// Return true if the type of expr is one that provides IntoIterator impls
/// for &T and &mut T, such as Vec. /// for &T and &mut T, such as Vec.
fn is_ref_iterable_type(cx: &LateContext, e: &Expr) -> bool { fn is_ref_iterable_type(cx: &LateContext, e: &Expr) -> bool {

View file

@ -255,6 +255,19 @@ pub fn get_parent_expr<'c>(cx: &'c LateContext, e: &Expr) -> Option<&'c Expr> {
if let NodeExpr(parent) = node { Some(parent) } else { None } ) if let NodeExpr(parent) = node { Some(parent) } else { None } )
} }
pub fn get_enclosing_block<'c>(cx: &'c LateContext, node: NodeId) -> Option<&'c Block> {
let map = &cx.tcx.map;
let enclosing_node = map.get_enclosing_scope(node)
.and_then(|enclosing_id| map.find(enclosing_id));
if let Some(node) = enclosing_node {
match node {
NodeBlock(ref block) => Some(block),
NodeItem(&Item{ node: ItemFn(_, _, _, _, _, ref block), .. }) => Some(block),
_ => None
}
} else { None }
}
#[cfg(not(feature="structured_logging"))] #[cfg(not(feature="structured_logging"))]
pub fn span_lint<T: LintContext>(cx: &T, lint: &'static Lint, sp: Span, msg: &str) { pub fn span_lint<T: LintContext>(cx: &T, lint: &'static Lint, sp: Span, msg: &str) {
cx.span_lint(lint, sp, msg); cx.span_lint(lint, sp, msg);

View file

@ -80,6 +80,23 @@ fn main() {
while let Some(x) = iter.next() { while let Some(x) = iter.next() {
println!("next: {:?}", iter.next()) println!("next: {:?}", iter.next())
} }
// neither can this
let mut iter = 1u32..20;
while let Some(x) = iter.next() {
println!("next: {:?}", iter.next());
}
// or this
let mut iter = 1u32..20;
while let Some(x) = iter.next() {break;}
println!("Remaining iter {:?}", iter);
// or this
let mut iter = 1u32..20;
while let Some(x) = iter.next() {
iter = 1..20;
}
} }
// regression test (#360) // regression test (#360)