]> git.lizzy.rs Git - rust.git/blobdiff - clippy_lints/src/ranges.rs
range_plus_one suggestion should not remove braces fix
[rust.git] / clippy_lints / src / ranges.rs
index 6e9bebca7570459ee0a66cc9b674dd71e5850b29..d86f264addab99df26b4fc4dac7f558fabff08bf 100644 (file)
@@ -1,10 +1,12 @@
-use rustc::lint::*;
+use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
+use rustc::{declare_lint, lint_array};
+use if_chain::if_chain;
 use rustc::hir::*;
 use syntax::ast::RangeLimits;
-use syntax::codemap::Spanned;
-use utils::{is_integer_literal, paths, snippet, span_lint, span_lint_and_then};
-use utils::{get_trait_def_id, higher, implements_trait};
-use utils::sugg::Sugg;
+use syntax::source_map::Spanned;
+use crate::utils::{is_integer_literal, paths, snippet, span_lint, span_lint_and_then, snippet_opt};
+use crate::utils::{get_trait_def_id, higher, implements_trait, SpanlessEq};
+use crate::utils::sugg::Sugg;
 
 /// **What it does:** Checks for calling `.step_by(0)` on iterators,
 /// which never terminates.
@@ -18,9 +20,9 @@
 /// ```rust
 /// for x in (5..5).step_by(0) { .. }
 /// ```
-declare_lint! {
+declare_clippy_lint! {
     pub ITERATOR_STEP_BY_ZERO,
-    Warn,
+    correctness,
     "using `Iterator::step_by(0)`, which produces an infinite iterator"
 }
 
@@ -35,9 +37,9 @@
 /// ```rust
 /// x.iter().zip(0..x.len())
 /// ```
-declare_lint! {
+declare_clippy_lint! {
     pub RANGE_ZIP_WITH_LEN,
-    Warn,
+    complexity,
     "zipping iterator with a range when `enumerate()` would do"
 }
 
 /// **Why is this bad?** The code is more readable with an inclusive range
 /// like `x..=y`.
 ///
-/// **Known problems:** None.
+/// **Known problems:** Will add unnecessary pair of parentheses when the
+/// expression is not wrapped in a pair but starts with a opening parenthesis
+/// and ends with a closing one.
+/// I.e: let _ = (f()+1)..(f()+1) results in let _ = ((f()+1)..(f()+1)).
 ///
 /// **Example:**
 /// ```rust
 /// for x..(y+1) { .. }
 /// ```
-declare_lint! {
+declare_clippy_lint! {
     pub RANGE_PLUS_ONE,
-    Allow,
+    complexity,
     "`x..(y+1)` reads better as `x..=y`"
 }
 
@@ -71,9 +76,9 @@
 /// ```rust
 /// for x..=(y-1) { .. }
 /// ```
-declare_lint! {
+declare_clippy_lint! {
     pub RANGE_MINUS_ONE,
-    Warn,
+    complexity,
     "`x..=(y-1)` reads better as `x..y`"
 }
 
 
 impl LintPass for Pass {
     fn get_lints(&self) -> LintArray {
-        lint_array!(
-            ITERATOR_STEP_BY_ZERO,
-            RANGE_ZIP_WITH_LEN,
-            RANGE_PLUS_ONE,
-            RANGE_MINUS_ONE
-        )
+        lint_array!(ITERATOR_STEP_BY_ZERO, RANGE_ZIP_WITH_LEN, RANGE_PLUS_ONE, RANGE_MINUS_ONE)
     }
 }
 
 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
-        if let ExprMethodCall(ref path, _, ref args) = expr.node {
-            let name = path.name.as_str();
+        if let ExprKind::MethodCall(ref path, _, ref args) = expr.node {
+            let name = path.ident.as_str();
 
             // Range with step_by(0).
             if name == "step_by" && args.len() == 2 && has_step_by(cx, &args[0]) {
-                use consts::{constant, Constant};
-                use rustc_const_math::ConstInt::Usize;
-                if let Some((Constant::Int(Usize(us)), _)) = constant(cx, &args[1]) {
-                    if us.as_u64() == 0 {
-                        span_lint(
-                            cx,
-                            ITERATOR_STEP_BY_ZERO,
-                            expr.span,
-                            "Iterator::step_by(0) will panic at runtime",
-                        );
-                    }
+                use crate::consts::{constant, Constant};
+                if let Some((Constant::Int(0), _)) = constant(cx, cx.tables, &args[1]) {
+                    span_lint(
+                        cx,
+                        ITERATOR_STEP_BY_ZERO,
+                        expr.span,
+                        "Iterator::step_by(0) will panic at runtime",
+                    );
                 }
             } else if name == "zip" && args.len() == 2 {
                 let iter = &args[0].node;
                 let zip_arg = &args[1];
                 if_chain! {
                     // .iter() call
-                    if let ExprMethodCall(ref iter_path, _, ref iter_args ) = *iter;
-                    if iter_path.name == "iter";
+                    if let ExprKind::MethodCall(ref iter_path, _, ref iter_args ) = *iter;
+                    if iter_path.ident.name == "iter";
                     // range expression in .zip() call: 0..x.len()
-                    if let Some(higher::Range { start: Some(start), end: Some(end), .. }) = higher::range(zip_arg);
+                    if let Some(higher::Range { start: Some(start), end: Some(end), .. }) = higher::range(cx, zip_arg);
                     if is_integer_literal(start, 0);
                     // .len() call
-                    if let ExprMethodCall(ref len_path, _, ref len_args) = end.node;
-                    if len_path.name == "len" && len_args.len() == 1;
+                    if let ExprKind::MethodCall(ref len_path, _, ref len_args) = end.node;
+                    if len_path.ident.name == "len" && len_args.len() == 1;
                     // .iter() and .len() called on same Path
-                    if let ExprPath(QPath::Resolved(_, ref iter_path)) = iter_args[0].node;
-                    if let ExprPath(QPath::Resolved(_, ref len_path)) = len_args[0].node;
-                    if iter_path.segments == len_path.segments;
+                    if let ExprKind::Path(QPath::Resolved(_, ref iter_path)) = iter_args[0].node;
+                    if let ExprKind::Path(QPath::Resolved(_, ref len_path)) = len_args[0].node;
+                    if SpanlessEq::new(cx).eq_path_segments(&iter_path.segments, &len_path.segments);
                      then {
                          span_lint(cx,
                                    RANGE_ZIP_WITH_LEN,
@@ -140,7 +137,7 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 
         // exclusive range plus one: x..(y+1)
         if_chain! {
-            if let Some(higher::Range { start, end: Some(end), limits: RangeLimits::HalfOpen }) = higher::range(expr);
+            if let Some(higher::Range { start, end: Some(end), limits: RangeLimits::HalfOpen }) = higher::range(cx, expr);
             if let Some(y) = y_plus_one(end);
             then {
                 span_lint_and_then(
@@ -151,9 +148,17 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
                     |db| {
                         let start = start.map_or("".to_owned(), |x| Sugg::hir(cx, x, "x").to_string());
                         let end = Sugg::hir(cx, y, "y");
-                        db.span_suggestion(expr.span,
+                        if let Some(is_wrapped) = &snippet_opt(cx, expr.span) {
+                            if is_wrapped.starts_with("(") && is_wrapped.ends_with(")") {
+                                db.span_suggestion(expr.span,
+                                           "use",
+                                           format!("({}..={})", start, end));
+                            } else {
+                                db.span_suggestion(expr.span,
                                            "use",
                                            format!("{}..={}", start, end));
+                            }
+                        }
                     },
                 );
             }
@@ -161,7 +166,7 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 
         // inclusive range minus one: x..=(y-1)
         if_chain! {
-            if let Some(higher::Range { start, end: Some(end), limits: RangeLimits::Closed }) = higher::range(expr);
+            if let Some(higher::Range { start, end: Some(end), limits: RangeLimits::Closed }) = higher::range(cx, expr);
             if let Some(y) = y_minus_one(end);
             then {
                 span_lint_and_then(
@@ -182,7 +187,7 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
     }
 }
 
-fn has_step_by(cx: &LateContext, expr: &Expr) -> bool {
+fn has_step_by(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
     // No need for walk_ptrs_ty here because step_by moves self, so it
     // can't be called on a borrowed range.
     let ty = cx.tables.expr_ty_adjusted(expr);
@@ -192,14 +197,12 @@ fn has_step_by(cx: &LateContext, expr: &Expr) -> bool {
 
 fn y_plus_one(expr: &Expr) -> Option<&Expr> {
     match expr.node {
-        ExprBinary(Spanned { node: BiAdd, .. }, ref lhs, ref rhs) => {
-            if is_integer_literal(lhs, 1) {
-                Some(rhs)
-            } else if is_integer_literal(rhs, 1) {
-                Some(lhs)
-            } else {
-                None
-            }
+        ExprKind::Binary(Spanned { node: BinOpKind::Add, .. }, ref lhs, ref rhs) => if is_integer_literal(lhs, 1) {
+            Some(rhs)
+        } else if is_integer_literal(rhs, 1) {
+            Some(lhs)
+        } else {
+            None
         },
         _ => None,
     }
@@ -207,7 +210,7 @@ fn y_plus_one(expr: &Expr) -> Option<&Expr> {
 
 fn y_minus_one(expr: &Expr) -> Option<&Expr> {
     match expr.node {
-        ExprBinary(Spanned { node: BiSub, .. }, ref lhs, ref rhs) if is_integer_literal(rhs, 1) => Some(lhs),
+        ExprKind::Binary(Spanned { node: BinOpKind::Sub, .. }, ref lhs, ref rhs) if is_integer_literal(rhs, 1) => Some(lhs),
         _ => None,
     }
 }