clippy_lints/src/ranges.rs

   1 use clippy_utils::consts::{constant, Constant};
   2 use clippy_utils::diagnostics::{span_lint, span_lint_and_sugg, span_lint_and_then};
   3 use clippy_utils::source::{snippet, snippet_opt, snippet_with_applicability};
   4 use clippy_utils::sugg::Sugg;
   5 use clippy_utils::{get_parent_expr, in_constant, is_integer_const, meets_msrv, msrvs, path_to_local};
   6 use clippy_utils::{higher, SpanlessEq};
   7 use if_chain::if_chain;
   8 use rustc_ast::ast::RangeLimits;
   9 use rustc_errors::Applicability;
  10 use rustc_hir::{BinOpKind, Expr, ExprKind, HirId, PathSegment, QPath};
  11 use rustc_lint::{LateContext, LateLintPass};
  12 use rustc_middle::ty;
  13 use rustc_semver::RustcVersion;
  14 use rustc_session::{declare_tool_lint, impl_lint_pass};
  15 use rustc_span::source_map::{Span, Spanned};
  16 use rustc_span::sym;
  17 use std::cmp::Ordering;
  18
  19 declare_clippy_lint! {
  20     /// ### What it does
  21     /// Checks for zipping a collection with the range of
  22     /// `0.._.len()`.
  23     ///
  24     /// ### Why is this bad?
  25     /// The code is better expressed with `.enumerate()`.
  26     ///
  27     /// ### Example
  28     /// ```rust
  29     /// # let x = vec![1];
  30     /// x.iter().zip(0..x.len());
  31     /// ```
  32     /// Could be written as
  33     /// ```rust
  34     /// # let x = vec![1];
  35     /// x.iter().enumerate();
  36     /// ```
  37     #[clippy::version = "pre 1.29.0"]
  38     pub RANGE_ZIP_WITH_LEN,
  39     complexity,
  40     "zipping iterator with a range when `enumerate()` would do"
  41 }
  42
  43 declare_clippy_lint! {
  44     /// ### What it does
  45     /// Checks for exclusive ranges where 1 is added to the
  46     /// upper bound, e.g., `x..(y+1)`.
  47     ///
  48     /// ### Why is this bad?
  49     /// The code is more readable with an inclusive range
  50     /// like `x..=y`.
  51     ///
  52     /// ### Known problems
  53     /// Will add unnecessary pair of parentheses when the
  54     /// expression is not wrapped in a pair but starts with an opening parenthesis
  55     /// and ends with a closing one.
  56     /// I.e., `let _ = (f()+1)..(f()+1)` results in `let _ = ((f()+1)..=f())`.
  57     ///
  58     /// Also in many cases, inclusive ranges are still slower to run than
  59     /// exclusive ranges, because they essentially add an extra branch that
  60     /// LLVM may fail to hoist out of the loop.
  61     ///
  62     /// This will cause a warning that cannot be fixed if the consumer of the
  63     /// range only accepts a specific range type, instead of the generic
  64     /// `RangeBounds` trait
  65     /// ([#3307](https://github.com/rust-lang/rust-clippy/issues/3307)).
  66     ///
  67     /// ### Example
  68     /// ```rust,ignore
  69     /// for x..(y+1) { .. }
  70     /// ```
  71     /// Could be written as
  72     /// ```rust,ignore
  73     /// for x..=y { .. }
  74     /// ```
  75     #[clippy::version = "pre 1.29.0"]
  76     pub RANGE_PLUS_ONE,
  77     pedantic,
  78     "`x..(y+1)` reads better as `x..=y`"
  79 }
  80
  81 declare_clippy_lint! {
  82     /// ### What it does
  83     /// Checks for inclusive ranges where 1 is subtracted from
  84     /// the upper bound, e.g., `x..=(y-1)`.
  85     ///
  86     /// ### Why is this bad?
  87     /// The code is more readable with an exclusive range
  88     /// like `x..y`.
  89     ///
  90     /// ### Known problems
  91     /// This will cause a warning that cannot be fixed if
  92     /// the consumer of the range only accepts a specific range type, instead of
  93     /// the generic `RangeBounds` trait
  94     /// ([#3307](https://github.com/rust-lang/rust-clippy/issues/3307)).
  95     ///
  96     /// ### Example
  97     /// ```rust,ignore
  98     /// for x..=(y-1) { .. }
  99     /// ```
 100     /// Could be written as
 101     /// ```rust,ignore
 102     /// for x..y { .. }
 103     /// ```
 104     #[clippy::version = "pre 1.29.0"]
 105     pub RANGE_MINUS_ONE,
 106     pedantic,
 107     "`x..=(y-1)` reads better as `x..y`"
 108 }
 109
 110 declare_clippy_lint! {
 111     /// ### What it does
 112     /// Checks for range expressions `x..y` where both `x` and `y`
 113     /// are constant and `x` is greater or equal to `y`.
 114     ///
 115     /// ### Why is this bad?
 116     /// Empty ranges yield no values so iterating them is a no-op.
 117     /// Moreover, trying to use a reversed range to index a slice will panic at run-time.
 118     ///
 119     /// ### Example
 120     /// ```rust,no_run
 121     /// fn main() {
 122     ///     (10..=0).for_each(|x| println!("{}", x));
 123     ///
 124     ///     let arr = [1, 2, 3, 4, 5];
 125     ///     let sub = &arr[3..1];
 126     /// }
 127     /// ```
 128     /// Use instead:
 129     /// ```rust
 130     /// fn main() {
 131     ///     (0..=10).rev().for_each(|x| println!("{}", x));
 132     ///
 133     ///     let arr = [1, 2, 3, 4, 5];
 134     ///     let sub = &arr[1..3];
 135     /// }
 136     /// ```
 137     #[clippy::version = "1.45.0"]
 138     pub REVERSED_EMPTY_RANGES,
 139     correctness,
 140     "reversing the limits of range expressions, resulting in empty ranges"
 141 }
 142
 143 declare_clippy_lint! {
 144     /// ### What it does
 145     /// Checks for expressions like `x >= 3 && x < 8` that could
 146     /// be more readably expressed as `(3..8).contains(x)`.
 147     ///
 148     /// ### Why is this bad?
 149     /// `contains` expresses the intent better and has less
 150     /// failure modes (such as fencepost errors or using `||` instead of `&&`).
 151     ///
 152     /// ### Example
 153     /// ```rust
 154     /// // given
 155     /// let x = 6;
 156     ///
 157     /// assert!(x >= 3 && x < 8);
 158     /// ```
 159     /// Use instead:
 160     /// ```rust
 161     ///# let x = 6;
 162     /// assert!((3..8).contains(&x));
 163     /// ```
 164     #[clippy::version = "1.49.0"]
 165     pub MANUAL_RANGE_CONTAINS,
 166     style,
 167     "manually reimplementing {`Range`, `RangeInclusive`}`::contains`"
 168 }
 169
 170 pub struct Ranges {
 171     msrv: Option<RustcVersion>,
 172 }
 173
 174 impl Ranges {
 175     #[must_use]
 176     pub fn new(msrv: Option<RustcVersion>) -> Self {
 177         Self { msrv }
 178     }
 179 }
 180
 181 impl_lint_pass!(Ranges => [
 182     RANGE_ZIP_WITH_LEN,
 183     RANGE_PLUS_ONE,
 184     RANGE_MINUS_ONE,
 185     REVERSED_EMPTY_RANGES,
 186     MANUAL_RANGE_CONTAINS,
 187 ]);
 188
 189 impl<'tcx> LateLintPass<'tcx> for Ranges {
 190     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 191         match expr.kind {
 192             ExprKind::MethodCall(path, args, _) => {
 193                 check_range_zip_with_len(cx, path, args, expr.span);
 194             },
 195             ExprKind::Binary(ref op, l, r) => {
 196                 if meets_msrv(self.msrv.as_ref(), &msrvs::RANGE_CONTAINS) {
 197                     check_possible_range_contains(cx, op.node, l, r, expr);
 198                 }
 199             },
 200             _ => {},
 201         }
 202
 203         check_exclusive_range_plus_one(cx, expr);
 204         check_inclusive_range_minus_one(cx, expr);
 205         check_reversed_empty_range(cx, expr);
 206     }
 207     extract_msrv_attr!(LateContext);
 208 }
 209
 210 fn check_possible_range_contains(cx: &LateContext<'_>, op: BinOpKind, l: &Expr<'_>, r: &Expr<'_>, expr: &Expr<'_>) {
 211     if in_constant(cx, expr.hir_id) {
 212         return;
 213     }
 214
 215     let span = expr.span;
 216     let combine_and = match op {
 217         BinOpKind::And | BinOpKind::BitAnd => true,
 218         BinOpKind::Or | BinOpKind::BitOr => false,
 219         _ => return,
 220     };
 221     // value, name, order (higher/lower), inclusiveness
 222     if let (
 223         Some((lval, lexpr, lid, name_span, lval_span, lord, linc)),
 224         Some((rval, _, rid, _, rval_span, rord, rinc)),
 225     ) = (check_range_bounds(cx, l), check_range_bounds(cx, r))
 226     {
 227         // we only lint comparisons on the same name and with different
 228         // direction
 229         if lid != rid || lord == rord {
 230             return;
 231         }
 232         let ord = Constant::partial_cmp(cx.tcx, cx.typeck_results().expr_ty(lexpr), &lval, &rval);
 233         if combine_and && ord == Some(rord) {
 234             // order lower bound and upper bound
 235             let (l_span, u_span, l_inc, u_inc) = if rord == Ordering::Less {
 236                 (lval_span, rval_span, linc, rinc)
 237             } else {
 238                 (rval_span, lval_span, rinc, linc)
 239             };
 240             // we only lint inclusive lower bounds
 241             if !l_inc {
 242                 return;
 243             }
 244             let (range_type, range_op) = if u_inc {
 245                 ("RangeInclusive", "..=")
 246             } else {
 247                 ("Range", "..")
 248             };
 249             let mut applicability = Applicability::MachineApplicable;
 250             let name = snippet_with_applicability(cx, name_span, "_", &mut applicability);
 251             let lo = snippet_with_applicability(cx, l_span, "_", &mut applicability);
 252             let hi = snippet_with_applicability(cx, u_span, "_", &mut applicability);
 253             let space = if lo.ends_with('.') { " " } else { "" };
 254             span_lint_and_sugg(
 255                 cx,
 256                 MANUAL_RANGE_CONTAINS,
 257                 span,
 258                 &format!("manual `{}::contains` implementation", range_type),
 259                 "use",
 260                 format!("({}{}{}{}).contains(&{})", lo, space, range_op, hi, name),
 261                 applicability,
 262             );
 263         } else if !combine_and && ord == Some(lord) {
 264             // `!_.contains(_)`
 265             // order lower bound and upper bound
 266             let (l_span, u_span, l_inc, u_inc) = if lord == Ordering::Less {
 267                 (lval_span, rval_span, linc, rinc)
 268             } else {
 269                 (rval_span, lval_span, rinc, linc)
 270             };
 271             if l_inc {
 272                 return;
 273             }
 274             let (range_type, range_op) = if u_inc {
 275                 ("Range", "..")
 276             } else {
 277                 ("RangeInclusive", "..=")
 278             };
 279             let mut applicability = Applicability::MachineApplicable;
 280             let name = snippet_with_applicability(cx, name_span, "_", &mut applicability);
 281             let lo = snippet_with_applicability(cx, l_span, "_", &mut applicability);
 282             let hi = snippet_with_applicability(cx, u_span, "_", &mut applicability);
 283             let space = if lo.ends_with('.') { " " } else { "" };
 284             span_lint_and_sugg(
 285                 cx,
 286                 MANUAL_RANGE_CONTAINS,
 287                 span,
 288                 &format!("manual `!{}::contains` implementation", range_type),
 289                 "use",
 290                 format!("!({}{}{}{}).contains(&{})", lo, space, range_op, hi, name),
 291                 applicability,
 292             );
 293         }
 294     }
 295 }
 296
 297 fn check_range_bounds<'a>(
 298     cx: &'a LateContext<'_>,
 299     ex: &'a Expr<'_>,
 300 ) -> Option<(Constant, &'a Expr<'a>, HirId, Span, Span, Ordering, bool)> {
 301     if let ExprKind::Binary(ref op, l, r) = ex.kind {
 302         let (inclusive, ordering) = match op.node {
 303             BinOpKind::Gt => (false, Ordering::Greater),
 304             BinOpKind::Ge => (true, Ordering::Greater),
 305             BinOpKind::Lt => (false, Ordering::Less),
 306             BinOpKind::Le => (true, Ordering::Less),
 307             _ => return None,
 308         };
 309         if let Some(id) = path_to_local(l) {
 310             if let Some((c, _)) = constant(cx, cx.typeck_results(), r) {
 311                 return Some((c, r, id, l.span, r.span, ordering, inclusive));
 312             }
 313         } else if let Some(id) = path_to_local(r) {
 314             if let Some((c, _)) = constant(cx, cx.typeck_results(), l) {
 315                 return Some((c, l, id, r.span, l.span, ordering.reverse(), inclusive));
 316             }
 317         }
 318     }
 319     None
 320 }
 321
 322 fn check_range_zip_with_len(cx: &LateContext<'_>, path: &PathSegment<'_>, args: &[Expr<'_>], span: Span) {
 323     if_chain! {
 324         if path.ident.as_str() == "zip";
 325         if let [iter, zip_arg] = args;
 326         // `.iter()` call
 327         if let ExprKind::MethodCall(iter_path, iter_args, _) = iter.kind;
 328         if iter_path.ident.name == sym::iter;
 329         // range expression in `.zip()` call: `0..x.len()`
 330         if let Some(higher::Range { start: Some(start), end: Some(end), .. }) = higher::Range::hir(zip_arg);
 331         if is_integer_const(cx, start, 0);
 332         // `.len()` call
 333         if let ExprKind::MethodCall(len_path, len_args, _) = end.kind;
 334         if len_path.ident.name == sym::len && len_args.len() == 1;
 335         // `.iter()` and `.len()` called on same `Path`
 336         if let ExprKind::Path(QPath::Resolved(_, iter_path)) = iter_args[0].kind;
 337         if let ExprKind::Path(QPath::Resolved(_, len_path)) = len_args[0].kind;
 338         if SpanlessEq::new(cx).eq_path_segments(iter_path.segments, len_path.segments);
 339         then {
 340             span_lint(cx,
 341                 RANGE_ZIP_WITH_LEN,
 342                 span,
 343                 &format!("it is more idiomatic to use `{}.iter().enumerate()`",
 344                     snippet(cx, iter_args[0].span, "_"))
 345             );
 346         }
 347     }
 348 }
 349
 350 // exclusive range plus one: `x..(y+1)`
 351 fn check_exclusive_range_plus_one(cx: &LateContext<'_>, expr: &Expr<'_>) {
 352     if_chain! {
 353         if let Some(higher::Range {
 354             start,
 355             end: Some(end),
 356             limits: RangeLimits::HalfOpen
 357         }) = higher::Range::hir(expr);
 358         if let Some(y) = y_plus_one(cx, end);
 359         then {
 360             let span = if expr.span.from_expansion() {
 361                 expr.span
 362                     .ctxt()
 363                     .outer_expn_data()
 364                     .call_site
 365             } else {
 366                 expr.span
 367             };
 368             span_lint_and_then(
 369                 cx,
 370                 RANGE_PLUS_ONE,
 371                 span,
 372                 "an inclusive range would be more readable",
 373                 |diag| {
 374                     let start = start.map_or(String::new(), |x| Sugg::hir(cx, x, "x").maybe_par().to_string());
 375                     let end = Sugg::hir(cx, y, "y").maybe_par();
 376                     if let Some(is_wrapped) = &snippet_opt(cx, span) {
 377                         if is_wrapped.starts_with('(') && is_wrapped.ends_with(')') {
 378                             diag.span_suggestion(
 379                                 span,
 380                                 "use",
 381                                 format!("({}..={})", start, end),
 382                                 Applicability::MaybeIncorrect,
 383                             );
 384                         } else {
 385                             diag.span_suggestion(
 386                                 span,
 387                                 "use",
 388                                 format!("{}..={}", start, end),
 389                                 Applicability::MachineApplicable, // snippet
 390                             );
 391                         }
 392                     }
 393                 },
 394             );
 395         }
 396     }
 397 }
 398
 399 // inclusive range minus one: `x..=(y-1)`
 400 fn check_inclusive_range_minus_one(cx: &LateContext<'_>, expr: &Expr<'_>) {
 401     if_chain! {
 402         if let Some(higher::Range { start, end: Some(end), limits: RangeLimits::Closed }) = higher::Range::hir(expr);
 403         if let Some(y) = y_minus_one(cx, end);
 404         then {
 405             span_lint_and_then(
 406                 cx,
 407                 RANGE_MINUS_ONE,
 408                 expr.span,
 409                 "an exclusive range would be more readable",
 410                 |diag| {
 411                     let start = start.map_or(String::new(), |x| Sugg::hir(cx, x, "x").maybe_par().to_string());
 412                     let end = Sugg::hir(cx, y, "y").maybe_par();
 413                     diag.span_suggestion(
 414                         expr.span,
 415                         "use",
 416                         format!("{}..{}", start, end),
 417                         Applicability::MachineApplicable, // snippet
 418                     );
 419                 },
 420             );
 421         }
 422     }
 423 }
 424
 425 fn check_reversed_empty_range(cx: &LateContext<'_>, expr: &Expr<'_>) {
 426     fn inside_indexing_expr(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
 427         matches!(
 428             get_parent_expr(cx, expr),
 429             Some(Expr {
 430                 kind: ExprKind::Index(..),
 431                 ..
 432             })
 433         )
 434     }
 435
 436     fn is_for_loop_arg(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
 437         let mut cur_expr = expr;
 438         while let Some(parent_expr) = get_parent_expr(cx, cur_expr) {
 439             match higher::ForLoop::hir(parent_expr) {
 440                 Some(higher::ForLoop { arg, .. }) if arg.hir_id == expr.hir_id => return true,
 441                 _ => cur_expr = parent_expr,
 442             }
 443         }
 444
 445         false
 446     }
 447
 448     fn is_empty_range(limits: RangeLimits, ordering: Ordering) -> bool {
 449         match limits {
 450             RangeLimits::HalfOpen => ordering != Ordering::Less,
 451             RangeLimits::Closed => ordering == Ordering::Greater,
 452         }
 453     }
 454
 455     if_chain! {
 456         if let Some(higher::Range { start: Some(start), end: Some(end), limits }) = higher::Range::hir(expr);
 457         let ty = cx.typeck_results().expr_ty(start);
 458         if let ty::Int(_) | ty::Uint(_) = ty.kind();
 459         if let Some((start_idx, _)) = constant(cx, cx.typeck_results(), start);
 460         if let Some((end_idx, _)) = constant(cx, cx.typeck_results(), end);
 461         if let Some(ordering) = Constant::partial_cmp(cx.tcx, ty, &start_idx, &end_idx);
 462         if is_empty_range(limits, ordering);
 463         then {
 464             if inside_indexing_expr(cx, expr) {
 465                 // Avoid linting `N..N` as it has proven to be useful, see #5689 and #5628 ...
 466                 if ordering != Ordering::Equal {
 467                     span_lint(
 468                         cx,
 469                         REVERSED_EMPTY_RANGES,
 470                         expr.span,
 471                         "this range is reversed and using it to index a slice will panic at run-time",
 472                     );
 473                 }
 474             // ... except in for loop arguments for backwards compatibility with `reverse_range_loop`
 475             } else if ordering != Ordering::Equal || is_for_loop_arg(cx, expr) {
 476                 span_lint_and_then(
 477                     cx,
 478                     REVERSED_EMPTY_RANGES,
 479                     expr.span,
 480                     "this range is empty so it will yield no values",
 481                     |diag| {
 482                         if ordering != Ordering::Equal {
 483                             let start_snippet = snippet(cx, start.span, "_");
 484                             let end_snippet = snippet(cx, end.span, "_");
 485                             let dots = match limits {
 486                                 RangeLimits::HalfOpen => "..",
 487                                 RangeLimits::Closed => "..="
 488                             };
 489
 490                             diag.span_suggestion(
 491                                 expr.span,
 492                                 "consider using the following if you are attempting to iterate over this \
 493                                  range in reverse",
 494                                 format!("({}{}{}).rev()", end_snippet, dots, start_snippet),
 495                                 Applicability::MaybeIncorrect,
 496                             );
 497                         }
 498                     },
 499                 );
 500             }
 501         }
 502     }
 503 }
 504
 505 fn y_plus_one<'t>(cx: &LateContext<'_>, expr: &'t Expr<'_>) -> Option<&'t Expr<'t>> {
 506     match expr.kind {
 507         ExprKind::Binary(
 508             Spanned {
 509                 node: BinOpKind::Add, ..
 510             },
 511             lhs,
 512             rhs,
 513         ) => {
 514             if is_integer_const(cx, lhs, 1) {
 515                 Some(rhs)
 516             } else if is_integer_const(cx, rhs, 1) {
 517                 Some(lhs)
 518             } else {
 519                 None
 520             }
 521         },
 522         _ => None,
 523     }
 524 }
 525
 526 fn y_minus_one<'t>(cx: &LateContext<'_>, expr: &'t Expr<'_>) -> Option<&'t Expr<'t>> {
 527     match expr.kind {
 528         ExprKind::Binary(
 529             Spanned {
 530                 node: BinOpKind::Sub, ..
 531             },
 532             lhs,
 533             rhs,
 534         ) if is_integer_const(cx, rhs, 1) => Some(lhs),
 535         _ => None,
 536     }
 537 }