clippy_lints/src/types.rs

   1 use reexport::*;
   2 use rustc::hir::*;
   3 use rustc::hir::intravisit::{FnKind, Visitor, walk_ty};
   4 use rustc::lint::*;
   5 use rustc::ty;
   6 use std::cmp::Ordering;
   7 use syntax::ast::{IntTy, UintTy, FloatTy};
   8 use syntax::codemap::Span;
   9 use utils::{comparisons, higher, in_external_macro, in_macro, match_def_path, snippet,
  10             span_help_and_lint, span_lint, opt_def_id, last_path_segment};
  11 use utils::paths;
  12
  13 /// Handles all the linting of funky types
  14 #[allow(missing_copy_implementations)]
  15 pub struct TypePass;
  16
  17 /// **What it does:** Checks for use of `Box<Vec<_>>` anywhere in the code.
  18 ///
  19 /// **Why is this bad?** `Vec` already keeps its contents in a separate area on
  20 /// the heap. So if you `Box` it, you just add another level of indirection
  21 /// without any benefit whatsoever.
  22 ///
  23 /// **Known problems:** None.
  24 ///
  25 /// **Example:**
  26 /// ```rust
  27 /// struct X {
  28 ///     values: Box<Vec<Foo>>,
  29 /// }
  30 /// ```
  31 declare_lint! {
  32     pub BOX_VEC,
  33     Warn,
  34     "usage of `Box<Vec<T>>`, vector elements are already on the heap"
  35 }
  36
  37 /// **What it does:** Checks for usage of any `LinkedList`, suggesting to use a
  38 /// `Vec` or a `VecDeque` (formerly called `RingBuf`).
  39 ///
  40 /// **Why is this bad?** Gankro says:
  41 ///
  42 /// > The TL;DR of `LinkedList` is that it's built on a massive amount of pointers and indirection.
  43 /// > It wastes memory, it has terrible cache locality, and is all-around slow. `RingBuf`, while
  44 /// > "only" amortized for push/pop, should be faster in the general case for almost every possible
  45 /// > workload, and isn't even amortized at all if you can predict the capacity you need.
  46 /// >
  47 /// > `LinkedList`s are only really good if you're doing a lot of merging or splitting of lists.
  48 /// > This is because they can just mangle some pointers instead of actually copying the data. Even
  49 /// > if you're doing a lot of insertion in the middle of the list, `RingBuf` can still be better
  50 /// > because of how expensive it is to seek to the middle of a `LinkedList`.
  51 ///
  52 /// **Known problems:** False positives – the instances where using a
  53 /// `LinkedList` makes sense are few and far between, but they can still happen.
  54 ///
  55 /// **Example:**
  56 /// ```rust
  57 /// let x = LinkedList::new();
  58 /// ```
  59 declare_lint! {
  60     pub LINKEDLIST,
  61     Warn,
  62     "usage of LinkedList, usually a vector is faster, or a more specialized data \
  63      structure like a VecDeque"
  64 }
  65
  66 impl LintPass for TypePass {
  67     fn get_lints(&self) -> LintArray {
  68         lint_array!(BOX_VEC, LINKEDLIST)
  69     }
  70 }
  71
  72 impl LateLintPass for TypePass {
  73     fn check_ty(&mut self, cx: &LateContext, ast_ty: &Ty) {
  74         if in_macro(cx, ast_ty.span) {
  75             return;
  76         }
  77         if let TyPath(ref qpath) = ast_ty.node {
  78             let def = cx.tcx.tables().qpath_def(qpath, ast_ty.id);
  79             if let Some(def_id) = opt_def_id(def) {
  80                 if Some(def_id) == cx.tcx.lang_items.owned_box() {
  81                     let last = last_path_segment(qpath);
  82                     if_let_chain! {[
  83                         let PathParameters::AngleBracketedParameters(ref ag) = last.parameters,
  84                         let Some(ref vec) = ag.types.get(0),
  85                         let TyPath(ref qpath) = vec.node,
  86                         let def::Def::Struct(..) = cx.tcx.tables().qpath_def(qpath, vec.id),
  87                         let Some(did) = opt_def_id(cx.tcx.tables().qpath_def(qpath, vec.id)),
  88                         match_def_path(cx, did, &paths::VEC),
  89                     ], {
  90                         span_help_and_lint(cx,
  91                                            BOX_VEC,
  92                                            ast_ty.span,
  93                                            "you seem to be trying to use `Box<Vec<T>>`. Consider using just `Vec<T>`",
  94                                            "`Vec<T>` is already on the heap, `Box<Vec<T>>` makes an extra allocation.");
  95                     }}
  96                 } else if match_def_path(cx, def_id, &paths::LINKED_LIST) {
  97                     span_help_and_lint(cx,
  98                                         LINKEDLIST,
  99                                         ast_ty.span,
 100                                         "I see you're using a LinkedList! Perhaps you meant some other data structure?",
 101                                         "a VecDeque might work");
 102                 }
 103             }
 104         }
 105     }
 106 }
 107
 108 #[allow(missing_copy_implementations)]
 109 pub struct LetPass;
 110
 111 /// **What it does:** Checks for binding a unit value.
 112 ///
 113 /// **Why is this bad?** A unit value cannot usefully be used anywhere. So
 114 /// binding one is kind of pointless.
 115 ///
 116 /// **Known problems:** None.
 117 ///
 118 /// **Example:**
 119 /// ```rust
 120 /// let x = { 1; };
 121 /// ```
 122 declare_lint! {
 123     pub LET_UNIT_VALUE,
 124     Warn,
 125     "creating a let binding to a value of unit type, which usually can't be used afterwards"
 126 }
 127
 128 fn check_let_unit(cx: &LateContext, decl: &Decl) {
 129     if let DeclLocal(ref local) = decl.node {
 130         let bindtype = &cx.tcx.tables().pat_ty(&local.pat).sty;
 131         match *bindtype {
 132             ty::TyTuple(slice) if slice.is_empty() => {
 133                 if in_external_macro(cx, decl.span) || in_macro(cx, local.pat.span) {
 134                     return;
 135                 }
 136                 if higher::is_from_for_desugar(decl) {
 137                     return;
 138                 }
 139                 span_lint(cx,
 140                           LET_UNIT_VALUE,
 141                           decl.span,
 142                           &format!("this let-binding has unit value. Consider omitting `let {} =`",
 143                                    snippet(cx, local.pat.span, "..")));
 144             }
 145             _ => (),
 146         }
 147     }
 148 }
 149
 150 impl LintPass for LetPass {
 151     fn get_lints(&self) -> LintArray {
 152         lint_array!(LET_UNIT_VALUE)
 153     }
 154 }
 155
 156 impl LateLintPass for LetPass {
 157     fn check_decl(&mut self, cx: &LateContext, decl: &Decl) {
 158         check_let_unit(cx, decl)
 159     }
 160 }
 161
 162 /// **What it does:** Checks for comparisons to unit.
 163 ///
 164 /// **Why is this bad?** Unit is always equal to itself, and thus is just a
 165 /// clumsily written constant. Mostly this happens when someone accidentally
 166 /// adds semicolons at the end of the operands.
 167 ///
 168 /// **Known problems:** None.
 169 ///
 170 /// **Example:**
 171 /// ```rust
 172 /// if { foo(); } == { bar(); } { baz(); }
 173 /// ```
 174 /// is equal to
 175 /// ```rust
 176 /// { foo(); bar(); baz(); }
 177 /// ```
 178 declare_lint! {
 179     pub UNIT_CMP,
 180     Warn,
 181     "comparing unit values"
 182 }
 183
 184 #[allow(missing_copy_implementations)]
 185 pub struct UnitCmp;
 186
 187 impl LintPass for UnitCmp {
 188     fn get_lints(&self) -> LintArray {
 189         lint_array!(UNIT_CMP)
 190     }
 191 }
 192
 193 impl LateLintPass for UnitCmp {
 194     fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
 195         if in_macro(cx, expr.span) {
 196             return;
 197         }
 198         if let ExprBinary(ref cmp, ref left, _) = expr.node {
 199             let op = cmp.node;
 200             if op.is_comparison() {
 201                 let sty = &cx.tcx.tables().expr_ty(left).sty;
 202                 match *sty {
 203                     ty::TyTuple(slice) if slice.is_empty() => {
 204                         let result = match op {
 205                             BiEq | BiLe | BiGe => "true",
 206                             _ => "false",
 207                         };
 208                         span_lint(cx,
 209                                   UNIT_CMP,
 210                                   expr.span,
 211                                   &format!("{}-comparison of unit values detected. This will always be {}",
 212                                            op.as_str(),
 213                                            result));
 214                     }
 215                     _ => ()
 216                 }
 217             }
 218         }
 219     }
 220 }
 221
 222 pub struct CastPass;
 223
 224 /// **What it does:** Checks for casts from any numerical to a float type where
 225 /// the receiving type cannot store all values from the original type without
 226 /// rounding errors. This possible rounding is to be expected, so this lint is
 227 /// `Allow` by default.
 228 ///
 229 /// Basically, this warns on casting any integer with 32 or more bits to `f32`
 230 /// or any 64-bit integer to `f64`.
 231 ///
 232 /// **Why is this bad?** It's not bad at all. But in some applications it can be
 233 /// helpful to know where precision loss can take place. This lint can help find
 234 /// those places in the code.
 235 ///
 236 /// **Known problems:** None.
 237 ///
 238 /// **Example:**
 239 /// ```rust
 240 /// let x = u64::MAX; x as f64
 241 /// ```
 242 declare_lint! {
 243     pub CAST_PRECISION_LOSS,
 244     Allow,
 245     "casts that cause loss of precision, e.g `x as f32` where `x: u64`"
 246 }
 247
 248 /// **What it does:** Checks for casts from a signed to an unsigned numerical
 249 /// type. In this case, negative values wrap around to large positive values,
 250 /// which can be quite surprising in practice. However, as the cast works as
 251 /// defined, this lint is `Allow` by default.
 252 ///
 253 /// **Why is this bad?** Possibly surprising results. You can activate this lint
 254 /// as a one-time check to see where numerical wrapping can arise.
 255 ///
 256 /// **Known problems:** None.
 257 ///
 258 /// **Example:**
 259 /// ```rust
 260 /// let y: i8 = -1;
 261 /// y as u64  // will return 18446744073709551615
 262 /// ```
 263 declare_lint! {
 264     pub CAST_SIGN_LOSS,
 265     Allow,
 266     "casts from signed types to unsigned types, e.g `x as u32` where `x: i32`"
 267 }
 268
 269 /// **What it does:** Checks for on casts between numerical types that may
 270 /// truncate large values. This is expected behavior, so the cast is `Allow` by
 271 /// default.
 272 ///
 273 /// **Why is this bad?** In some problem domains, it is good practice to avoid
 274 /// truncation. This lint can be activated to help assess where additional
 275 /// checks could be beneficial.
 276 ///
 277 /// **Known problems:** None.
 278 ///
 279 /// **Example:**
 280 /// ```rust
 281 /// fn as_u8(x: u64) -> u8 { x as u8 }
 282 /// ```
 283 declare_lint! {
 284     pub CAST_POSSIBLE_TRUNCATION,
 285     Allow,
 286     "casts that may cause truncation of the value, e.g `x as u8` where `x: u32`, \
 287      or `x as i32` where `x: f32`"
 288 }
 289
 290 /// **What it does:** Checks for casts from an unsigned type to a signed type of
 291 /// the same size. Performing such a cast is a 'no-op' for the compiler,
 292 /// i.e. nothing is changed at the bit level, and the binary representation of
 293 /// the value is reinterpreted. This can cause wrapping if the value is too big
 294 /// for the target signed type. However, the cast works as defined, so this lint
 295 /// is `Allow` by default.
 296 ///
 297 /// **Why is this bad?** While such a cast is not bad in itself, the results can
 298 /// be surprising when this is not the intended behavior, as demonstrated by the
 299 /// example below.
 300 ///
 301 /// **Known problems:** None.
 302 ///
 303 /// **Example:**
 304 /// ```rust
 305 /// u32::MAX as i32  // will yield a value of `-1`
 306 /// ```
 307 declare_lint! {
 308     pub CAST_POSSIBLE_WRAP,
 309     Allow,
 310     "casts that may cause wrapping around the value, e.g `x as i32` where `x: u32` \
 311      and `x > i32::MAX`"
 312 }
 313
 314 /// Returns the size in bits of an integral type.
 315 /// Will return 0 if the type is not an int or uint variant
 316 fn int_ty_to_nbits(typ: &ty::TyS) -> usize {
 317     let n = match typ.sty {
 318         ty::TyInt(i) => 4 << (i as usize),
 319         ty::TyUint(u) => 4 << (u as usize),
 320         _ => 0,
 321     };
 322     // n == 4 is the usize/isize case
 323     if n == 4 {
 324         ::std::mem::size_of::<usize>() * 8
 325     } else {
 326         n
 327     }
 328 }
 329
 330 fn is_isize_or_usize(typ: &ty::TyS) -> bool {
 331     match typ.sty {
 332         ty::TyInt(IntTy::Is) |
 333         ty::TyUint(UintTy::Us) => true,
 334         _ => false,
 335     }
 336 }
 337
 338 fn span_precision_loss_lint(cx: &LateContext, expr: &Expr, cast_from: &ty::TyS, cast_to_f64: bool) {
 339     let mantissa_nbits = if cast_to_f64 {
 340         52
 341     } else {
 342         23
 343     };
 344     let arch_dependent = is_isize_or_usize(cast_from) && cast_to_f64;
 345     let arch_dependent_str = "on targets with 64-bit wide pointers ";
 346     let from_nbits_str = if arch_dependent {
 347         "64".to_owned()
 348     } else if is_isize_or_usize(cast_from) {
 349         "32 or 64".to_owned()
 350     } else {
 351         int_ty_to_nbits(cast_from).to_string()
 352     };
 353     span_lint(cx,
 354               CAST_PRECISION_LOSS,
 355               expr.span,
 356               &format!("casting {0} to {1} causes a loss of precision {2}({0} is {3} bits wide, but {1}'s mantissa \
 357                         is only {4} bits wide)",
 358                        cast_from,
 359                        if cast_to_f64 {
 360                            "f64"
 361                        } else {
 362                            "f32"
 363                        },
 364                        if arch_dependent {
 365                            arch_dependent_str
 366                        } else {
 367                            ""
 368                        },
 369                        from_nbits_str,
 370                        mantissa_nbits));
 371 }
 372
 373 enum ArchSuffix {
 374     _32,
 375     _64,
 376     None,
 377 }
 378
 379 fn check_truncation_and_wrapping(cx: &LateContext, expr: &Expr, cast_from: &ty::TyS, cast_to: &ty::TyS) {
 380     let arch_64_suffix = " on targets with 64-bit wide pointers";
 381     let arch_32_suffix = " on targets with 32-bit wide pointers";
 382     let cast_unsigned_to_signed = !cast_from.is_signed() && cast_to.is_signed();
 383     let (from_nbits, to_nbits) = (int_ty_to_nbits(cast_from), int_ty_to_nbits(cast_to));
 384     let (span_truncation, suffix_truncation, span_wrap, suffix_wrap) = match (is_isize_or_usize(cast_from),
 385                                                                               is_isize_or_usize(cast_to)) {
 386         (true, true) | (false, false) => {
 387             (to_nbits < from_nbits,
 388              ArchSuffix::None,
 389              to_nbits == from_nbits && cast_unsigned_to_signed,
 390              ArchSuffix::None)
 391         }
 392         (true, false) => {
 393             (to_nbits <= 32,
 394              if to_nbits == 32 {
 395                 ArchSuffix::_64
 396             } else {
 397                 ArchSuffix::None
 398             },
 399              to_nbits <= 32 && cast_unsigned_to_signed,
 400              ArchSuffix::_32)
 401         }
 402         (false, true) => {
 403             (from_nbits == 64,
 404              ArchSuffix::_32,
 405              cast_unsigned_to_signed,
 406              if from_nbits == 64 {
 407                 ArchSuffix::_64
 408             } else {
 409                 ArchSuffix::_32
 410             })
 411         }
 412     };
 413     if span_truncation {
 414         span_lint(cx,
 415                   CAST_POSSIBLE_TRUNCATION,
 416                   expr.span,
 417                   &format!("casting {} to {} may truncate the value{}",
 418                            cast_from,
 419                            cast_to,
 420                            match suffix_truncation {
 421                                ArchSuffix::_32 => arch_32_suffix,
 422                                ArchSuffix::_64 => arch_64_suffix,
 423                                ArchSuffix::None => "",
 424                            }));
 425     }
 426     if span_wrap {
 427         span_lint(cx,
 428                   CAST_POSSIBLE_WRAP,
 429                   expr.span,
 430                   &format!("casting {} to {} may wrap around the value{}",
 431                            cast_from,
 432                            cast_to,
 433                            match suffix_wrap {
 434                                ArchSuffix::_32 => arch_32_suffix,
 435                                ArchSuffix::_64 => arch_64_suffix,
 436                                ArchSuffix::None => "",
 437                            }));
 438     }
 439 }
 440
 441 impl LintPass for CastPass {
 442     fn get_lints(&self) -> LintArray {
 443         lint_array!(CAST_PRECISION_LOSS,
 444                     CAST_SIGN_LOSS,
 445                     CAST_POSSIBLE_TRUNCATION,
 446                     CAST_POSSIBLE_WRAP)
 447     }
 448 }
 449
 450 impl LateLintPass for CastPass {
 451     fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
 452         if let ExprCast(ref ex, _) = expr.node {
 453             let (cast_from, cast_to) = (cx.tcx.tables().expr_ty(ex), cx.tcx.tables().expr_ty(expr));
 454             if cast_from.is_numeric() && cast_to.is_numeric() && !in_external_macro(cx, expr.span) {
 455                 match (cast_from.is_integral(), cast_to.is_integral()) {
 456                     (true, false) => {
 457                         let from_nbits = int_ty_to_nbits(cast_from);
 458                         let to_nbits = if let ty::TyFloat(FloatTy::F32) = cast_to.sty {
 459                             32
 460                         } else {
 461                             64
 462                         };
 463                         if is_isize_or_usize(cast_from) || from_nbits >= to_nbits {
 464                             span_precision_loss_lint(cx, expr, cast_from, to_nbits == 64);
 465                         }
 466                     }
 467                     (false, true) => {
 468                         span_lint(cx,
 469                                   CAST_POSSIBLE_TRUNCATION,
 470                                   expr.span,
 471                                   &format!("casting {} to {} may truncate the value", cast_from, cast_to));
 472                         if !cast_to.is_signed() {
 473                             span_lint(cx,
 474                                       CAST_SIGN_LOSS,
 475                                       expr.span,
 476                                       &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to));
 477                         }
 478                     }
 479                     (true, true) => {
 480                         if cast_from.is_signed() && !cast_to.is_signed() {
 481                             span_lint(cx,
 482                                       CAST_SIGN_LOSS,
 483                                       expr.span,
 484                                       &format!("casting {} to {} may lose the sign of the value", cast_from, cast_to));
 485                         }
 486                         check_truncation_and_wrapping(cx, expr, cast_from, cast_to);
 487                     }
 488                     (false, false) => {
 489                         if let (&ty::TyFloat(FloatTy::F64), &ty::TyFloat(FloatTy::F32)) = (&cast_from.sty,
 490                                                                                            &cast_to.sty) {
 491                             span_lint(cx,
 492                                       CAST_POSSIBLE_TRUNCATION,
 493                                       expr.span,
 494                                       "casting f64 to f32 may truncate the value");
 495                         }
 496                     }
 497                 }
 498             }
 499         }
 500     }
 501 }
 502
 503 /// **What it does:** Checks for types used in structs, parameters and `let`
 504 /// declarations above a certain complexity threshold.
 505 ///
 506 /// **Why is this bad?** Too complex types make the code less readable. Consider
 507 /// using a `type` definition to simplify them.
 508 ///
 509 /// **Known problems:** None.
 510 ///
 511 /// **Example:**
 512 /// ```rust
 513 /// struct Foo { inner: Rc<Vec<Vec<Box<(u32, u32, u32, u32)>>>> }
 514 /// ```
 515 declare_lint! {
 516     pub TYPE_COMPLEXITY,
 517     Warn,
 518     "usage of very complex types that might be better factored into `type` definitions"
 519 }
 520
 521 #[allow(missing_copy_implementations)]
 522 pub struct TypeComplexityPass {
 523     threshold: u64,
 524 }
 525
 526 impl TypeComplexityPass {
 527     pub fn new(threshold: u64) -> Self {
 528         TypeComplexityPass { threshold: threshold }
 529     }
 530 }
 531
 532 impl LintPass for TypeComplexityPass {
 533     fn get_lints(&self) -> LintArray {
 534         lint_array!(TYPE_COMPLEXITY)
 535     }
 536 }
 537
 538 impl LateLintPass for TypeComplexityPass {
 539     fn check_fn(&mut self, cx: &LateContext, _: FnKind, decl: &FnDecl, _: &Expr, _: Span, _: NodeId) {
 540         self.check_fndecl(cx, decl);
 541     }
 542
 543     fn check_struct_field(&mut self, cx: &LateContext, field: &StructField) {
 544         // enum variants are also struct fields now
 545         self.check_type(cx, &field.ty);
 546     }
 547
 548     fn check_item(&mut self, cx: &LateContext, item: &Item) {
 549         match item.node {
 550             ItemStatic(ref ty, _, _) |
 551             ItemConst(ref ty, _) => self.check_type(cx, ty),
 552             // functions, enums, structs, impls and traits are covered
 553             _ => (),
 554         }
 555     }
 556
 557     fn check_trait_item(&mut self, cx: &LateContext, item: &TraitItem) {
 558         match item.node {
 559             ConstTraitItem(ref ty, _) |
 560             TypeTraitItem(_, Some(ref ty)) => self.check_type(cx, ty),
 561             MethodTraitItem(MethodSig { ref decl, .. }, None) => self.check_fndecl(cx, decl),
 562             // methods with default impl are covered by check_fn
 563             _ => (),
 564         }
 565     }
 566
 567     fn check_impl_item(&mut self, cx: &LateContext, item: &ImplItem) {
 568         match item.node {
 569             ImplItemKind::Const(ref ty, _) |
 570             ImplItemKind::Type(ref ty) => self.check_type(cx, ty),
 571             // methods are covered by check_fn
 572             _ => (),
 573         }
 574     }
 575
 576     fn check_local(&mut self, cx: &LateContext, local: &Local) {
 577         if let Some(ref ty) = local.ty {
 578             self.check_type(cx, ty);
 579         }
 580     }
 581 }
 582
 583 impl TypeComplexityPass {
 584     fn check_fndecl(&self, cx: &LateContext, decl: &FnDecl) {
 585         for arg in &decl.inputs {
 586             self.check_type(cx, &arg.ty);
 587         }
 588         if let Return(ref ty) = decl.output {
 589             self.check_type(cx, ty);
 590         }
 591     }
 592
 593     fn check_type(&self, cx: &LateContext, ty: &Ty) {
 594         if in_macro(cx, ty.span) {
 595             return;
 596         }
 597         let score = {
 598             let mut visitor = TypeComplexityVisitor {
 599                 score: 0,
 600                 nest: 1,
 601             };
 602             visitor.visit_ty(ty);
 603             visitor.score
 604         };
 605
 606         if score > self.threshold {
 607             span_lint(cx,
 608                       TYPE_COMPLEXITY,
 609                       ty.span,
 610                       "very complex type used. Consider factoring parts into `type` definitions");
 611         }
 612     }
 613 }
 614
 615 /// Walks a type and assigns a complexity score to it.
 616 struct TypeComplexityVisitor {
 617     /// total complexity score of the type
 618     score: u64,
 619     /// current nesting level
 620     nest: u64,
 621 }
 622
 623 impl<'v> Visitor<'v> for TypeComplexityVisitor {
 624     fn visit_ty(&mut self, ty: &'v Ty) {
 625         let (add_score, sub_nest) = match ty.node {
 626             // _, &x and *x have only small overhead; don't mess with nesting level
 627             TyInfer | TyPtr(..) | TyRptr(..) => (1, 0),
 628
 629             // the "normal" components of a type: named types, arrays/tuples
 630             TyPath(..) |
 631             TySlice(..) |
 632             TyTup(..) |
 633             TyArray(..) => (10 * self.nest, 1),
 634
 635             // "Sum" of trait bounds
 636             TyObjectSum(..) => (20 * self.nest, 0),
 637
 638             // function types and "for<...>" bring a lot of overhead
 639             TyBareFn(..) |
 640             TyPolyTraitRef(..) => (50 * self.nest, 1),
 641
 642             _ => (0, 0),
 643         };
 644         self.score += add_score;
 645         self.nest += sub_nest;
 646         walk_ty(self, ty);
 647         self.nest -= sub_nest;
 648     }
 649 }
 650
 651 /// **What it does:** Checks for expressions where a character literal is cast
 652 /// to `u8` and suggests using a byte literal instead.
 653 ///
 654 /// **Why is this bad?** In general, casting values to smaller types is
 655 /// error-prone and should be avoided where possible. In the particular case of
 656 /// converting a character literal to u8, it is easy to avoid by just using a
 657 /// byte literal instead. As an added bonus, `b'a'` is even slightly shorter
 658 /// than `'a' as u8`.
 659 ///
 660 /// **Known problems:** None.
 661 ///
 662 /// **Example:**
 663 /// ```rust
 664 /// 'x' as u8
 665 /// ```
 666 declare_lint! {
 667     pub CHAR_LIT_AS_U8,
 668     Warn,
 669     "casting a character literal to u8"
 670 }
 671
 672 pub struct CharLitAsU8;
 673
 674 impl LintPass for CharLitAsU8 {
 675     fn get_lints(&self) -> LintArray {
 676         lint_array!(CHAR_LIT_AS_U8)
 677     }
 678 }
 679
 680 impl LateLintPass for CharLitAsU8 {
 681     fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
 682         use syntax::ast::{LitKind, UintTy};
 683
 684         if let ExprCast(ref e, _) = expr.node {
 685             if let ExprLit(ref l) = e.node {
 686                 if let LitKind::Char(_) = l.node {
 687                     if ty::TyUint(UintTy::U8) == cx.tcx.tables().expr_ty(expr).sty && !in_macro(cx, expr.span) {
 688                         let msg = "casting character literal to u8. `char`s \
 689                                    are 4 bytes wide in rust, so casting to u8 \
 690                                    truncates them";
 691                         let help = format!("Consider using a byte literal \
 692                                             instead:\nb{}",
 693                                            snippet(cx, e.span, "'x'"));
 694                         span_help_and_lint(cx, CHAR_LIT_AS_U8, expr.span, msg, &help);
 695                     }
 696                 }
 697             }
 698         }
 699     }
 700 }
 701
 702 /// **What it does:** Checks for comparisons where one side of the relation is
 703 /// either the minimum or maximum value for its type and warns if it involves a
 704 /// case that is always true or always false. Only integer and boolean types are
 705 /// checked.
 706 ///
 707 /// **Why is this bad?** An expression like `min <= x` may misleadingly imply
 708 /// that is is possible for `x` to be less than the minimum. Expressions like
 709 /// `max < x` are probably mistakes.
 710 ///
 711 /// **Known problems:** None.
 712 ///
 713 /// **Example:**
 714 /// ```rust
 715 /// vec.len() <= 0
 716 /// 100 > std::i32::MAX
 717 /// ```
 718 declare_lint! {
 719     pub ABSURD_EXTREME_COMPARISONS,
 720     Warn,
 721     "a comparison with a maximum or minimum value that is always true or false"
 722 }
 723
 724 pub struct AbsurdExtremeComparisons;
 725
 726 impl LintPass for AbsurdExtremeComparisons {
 727     fn get_lints(&self) -> LintArray {
 728         lint_array!(ABSURD_EXTREME_COMPARISONS)
 729     }
 730 }
 731
 732 enum ExtremeType {
 733     Minimum,
 734     Maximum,
 735 }
 736
 737 struct ExtremeExpr<'a> {
 738     which: ExtremeType,
 739     expr: &'a Expr,
 740 }
 741
 742 enum AbsurdComparisonResult {
 743     AlwaysFalse,
 744     AlwaysTrue,
 745     InequalityImpossible,
 746 }
 747
 748
 749
 750 fn detect_absurd_comparison<'a>(cx: &LateContext, op: BinOp_, lhs: &'a Expr, rhs: &'a Expr)
 751                                 -> Option<(ExtremeExpr<'a>, AbsurdComparisonResult)> {
 752     use types::ExtremeType::*;
 753     use types::AbsurdComparisonResult::*;
 754     use utils::comparisons::*;
 755     type Extr<'a> = ExtremeExpr<'a>;
 756
 757     let normalized = normalize_comparison(op, lhs, rhs);
 758     let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
 759         val
 760     } else {
 761         return None;
 762     };
 763
 764     let lx = detect_extreme_expr(cx, normalized_lhs);
 765     let rx = detect_extreme_expr(cx, normalized_rhs);
 766
 767     Some(match rel {
 768         Rel::Lt => {
 769             match (lx, rx) {
 770                 (Some(l @ Extr { which: Maximum, .. }), _) => (l, AlwaysFalse), // max < x
 771                 (_, Some(r @ Extr { which: Minimum, .. })) => (r, AlwaysFalse), // x < min
 772                 _ => return None,
 773             }
 774         }
 775         Rel::Le => {
 776             match (lx, rx) {
 777                 (Some(l @ Extr { which: Minimum, .. }), _) => (l, AlwaysTrue), // min <= x
 778                 (Some(l @ Extr { which: Maximum, .. }), _) => (l, InequalityImpossible), //max <= x
 779                 (_, Some(r @ Extr { which: Minimum, .. })) => (r, InequalityImpossible), // x <= min
 780                 (_, Some(r @ Extr { which: Maximum, .. })) => (r, AlwaysTrue), // x <= max
 781                 _ => return None,
 782             }
 783         }
 784         Rel::Ne | Rel::Eq => return None,
 785     })
 786 }
 787
 788 fn detect_extreme_expr<'a>(cx: &LateContext, expr: &'a Expr) -> Option<ExtremeExpr<'a>> {
 789     use rustc::middle::const_val::ConstVal::*;
 790     use rustc_const_math::*;
 791     use rustc_const_eval::EvalHint::ExprTypeChecked;
 792     use rustc_const_eval::*;
 793     use types::ExtremeType::*;
 794
 795     let ty = &cx.tcx.tables().expr_ty(expr).sty;
 796
 797     match *ty {
 798         ty::TyBool | ty::TyInt(_) | ty::TyUint(_) => (),
 799         _ => return None,
 800     };
 801
 802     let cv = match eval_const_expr_partial(cx.tcx, expr, ExprTypeChecked, None) {
 803         Ok(val) => val,
 804         Err(_) => return None,
 805     };
 806
 807     let which = match (ty, cv) {
 808         (&ty::TyBool, Bool(false)) |
 809         (&ty::TyInt(IntTy::Is), Integral(Isize(Is32(::std::i32::MIN)))) |
 810         (&ty::TyInt(IntTy::Is), Integral(Isize(Is64(::std::i64::MIN)))) |
 811         (&ty::TyInt(IntTy::I8), Integral(I8(::std::i8::MIN))) |
 812         (&ty::TyInt(IntTy::I16), Integral(I16(::std::i16::MIN))) |
 813         (&ty::TyInt(IntTy::I32), Integral(I32(::std::i32::MIN))) |
 814         (&ty::TyInt(IntTy::I64), Integral(I64(::std::i64::MIN))) |
 815         (&ty::TyUint(UintTy::Us), Integral(Usize(Us32(::std::u32::MIN)))) |
 816         (&ty::TyUint(UintTy::Us), Integral(Usize(Us64(::std::u64::MIN)))) |
 817         (&ty::TyUint(UintTy::U8), Integral(U8(::std::u8::MIN))) |
 818         (&ty::TyUint(UintTy::U16), Integral(U16(::std::u16::MIN))) |
 819         (&ty::TyUint(UintTy::U32), Integral(U32(::std::u32::MIN))) |
 820         (&ty::TyUint(UintTy::U64), Integral(U64(::std::u64::MIN))) => Minimum,
 821
 822         (&ty::TyBool, Bool(true)) |
 823         (&ty::TyInt(IntTy::Is), Integral(Isize(Is32(::std::i32::MAX)))) |
 824         (&ty::TyInt(IntTy::Is), Integral(Isize(Is64(::std::i64::MAX)))) |
 825         (&ty::TyInt(IntTy::I8), Integral(I8(::std::i8::MAX))) |
 826         (&ty::TyInt(IntTy::I16), Integral(I16(::std::i16::MAX))) |
 827         (&ty::TyInt(IntTy::I32), Integral(I32(::std::i32::MAX))) |
 828         (&ty::TyInt(IntTy::I64), Integral(I64(::std::i64::MAX))) |
 829         (&ty::TyUint(UintTy::Us), Integral(Usize(Us32(::std::u32::MAX)))) |
 830         (&ty::TyUint(UintTy::Us), Integral(Usize(Us64(::std::u64::MAX)))) |
 831         (&ty::TyUint(UintTy::U8), Integral(U8(::std::u8::MAX))) |
 832         (&ty::TyUint(UintTy::U16), Integral(U16(::std::u16::MAX))) |
 833         (&ty::TyUint(UintTy::U32), Integral(U32(::std::u32::MAX))) |
 834         (&ty::TyUint(UintTy::U64), Integral(U64(::std::u64::MAX))) => Maximum,
 835
 836         _ => return None,
 837     };
 838     Some(ExtremeExpr {
 839         which: which,
 840         expr: expr,
 841     })
 842 }
 843
 844 impl LateLintPass for AbsurdExtremeComparisons {
 845     fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
 846         use types::ExtremeType::*;
 847         use types::AbsurdComparisonResult::*;
 848
 849         if let ExprBinary(ref cmp, ref lhs, ref rhs) = expr.node {
 850             if let Some((culprit, result)) = detect_absurd_comparison(cx, cmp.node, lhs, rhs) {
 851                 if !in_macro(cx, expr.span) {
 852                     let msg = "this comparison involving the minimum or maximum element for this \
 853                                type contains a case that is always true or always false";
 854
 855                     let conclusion = match result {
 856                         AlwaysFalse => "this comparison is always false".to_owned(),
 857                         AlwaysTrue => "this comparison is always true".to_owned(),
 858                         InequalityImpossible => {
 859                             format!("the case where the two sides are not equal never occurs, consider using {} == {} \
 860                                      instead",
 861                                     snippet(cx, lhs.span, "lhs"),
 862                                     snippet(cx, rhs.span, "rhs"))
 863                         }
 864                     };
 865
 866                     let help = format!("because {} is the {} value for this type, {}",
 867                                        snippet(cx, culprit.expr.span, "x"),
 868                                        match culprit.which {
 869                                            Minimum => "minimum",
 870                                            Maximum => "maximum",
 871                                        },
 872                                        conclusion);
 873
 874                     span_help_and_lint(cx, ABSURD_EXTREME_COMPARISONS, expr.span, msg, &help);
 875                 }
 876             }
 877         }
 878     }
 879 }
 880
 881 /// **What it does:** Checks for comparisons where the relation is always either
 882 /// true or false, but where one side has been upcast so that the comparison is
 883 /// necessary. Only integer types are checked.
 884 ///
 885 /// **Why is this bad?** An expression like `let x : u8 = ...; (x as u32) > 300`
 886 /// will mistakenly imply that it is possible for `x` to be outside the range of
 887 /// `u8`.
 888 ///
 889 /// **Known problems:** https://github.com/Manishearth/rust-clippy/issues/886
 890 ///
 891 /// **Example:**
 892 /// ```rust
 893 /// let x : u8 = ...; (x as u32) > 300
 894 /// ```
 895 declare_lint! {
 896     pub INVALID_UPCAST_COMPARISONS,
 897     Allow,
 898     "a comparison involving an upcast which is always true or false"
 899 }
 900
 901 pub struct InvalidUpcastComparisons;
 902
 903 impl LintPass for InvalidUpcastComparisons {
 904     fn get_lints(&self) -> LintArray {
 905         lint_array!(INVALID_UPCAST_COMPARISONS)
 906     }
 907 }
 908
 909 #[derive(Copy, Clone, Debug, Eq)]
 910 enum FullInt {
 911     S(i64),
 912     U(u64),
 913 }
 914
 915 impl FullInt {
 916     #[allow(cast_sign_loss)]
 917     fn cmp_s_u(s: i64, u: u64) -> Ordering {
 918         if s < 0 {
 919             Ordering::Less
 920         } else if u > (i64::max_value() as u64) {
 921             Ordering::Greater
 922         } else {
 923             (s as u64).cmp(&u)
 924         }
 925     }
 926 }
 927
 928 impl PartialEq for FullInt {
 929     fn eq(&self, other: &Self) -> bool {
 930         self.partial_cmp(other).expect("partial_cmp only returns Some(_)") == Ordering::Equal
 931     }
 932 }
 933
 934 impl PartialOrd for FullInt {
 935     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 936         Some(match (self, other) {
 937             (&FullInt::S(s), &FullInt::S(o)) => s.cmp(&o),
 938             (&FullInt::U(s), &FullInt::U(o)) => s.cmp(&o),
 939             (&FullInt::S(s), &FullInt::U(o)) => Self::cmp_s_u(s, o),
 940             (&FullInt::U(s), &FullInt::S(o)) => Self::cmp_s_u(o, s).reverse(),
 941         })
 942     }
 943 }
 944 impl Ord for FullInt {
 945     fn cmp(&self, other: &Self) -> Ordering {
 946         self.partial_cmp(other).expect("partial_cmp for FullInt can never return None")
 947     }
 948 }
 949
 950
 951 fn numeric_cast_precast_bounds<'a>(cx: &LateContext, expr: &'a Expr) -> Option<(FullInt, FullInt)> {
 952     use rustc::ty::TypeVariants::{TyInt, TyUint};
 953     use syntax::ast::{IntTy, UintTy};
 954     use std::*;
 955
 956     if let ExprCast(ref cast_exp, _) = expr.node {
 957         match cx.tcx.tables().expr_ty(cast_exp).sty {
 958             TyInt(int_ty) => {
 959                 Some(match int_ty {
 960                     IntTy::I8 => (FullInt::S(i8::min_value() as i64), FullInt::S(i8::max_value() as i64)),
 961                     IntTy::I16 => (FullInt::S(i16::min_value() as i64), FullInt::S(i16::max_value() as i64)),
 962                     IntTy::I32 => (FullInt::S(i32::min_value() as i64), FullInt::S(i32::max_value() as i64)),
 963                     IntTy::I64 => (FullInt::S(i64::min_value() as i64), FullInt::S(i64::max_value() as i64)),
 964                     IntTy::Is => (FullInt::S(isize::min_value() as i64), FullInt::S(isize::max_value() as i64)),
 965                 })
 966             }
 967             TyUint(uint_ty) => {
 968                 Some(match uint_ty {
 969                     UintTy::U8 => (FullInt::U(u8::min_value() as u64), FullInt::U(u8::max_value() as u64)),
 970                     UintTy::U16 => (FullInt::U(u16::min_value() as u64), FullInt::U(u16::max_value() as u64)),
 971                     UintTy::U32 => (FullInt::U(u32::min_value() as u64), FullInt::U(u32::max_value() as u64)),
 972                     UintTy::U64 => (FullInt::U(u64::min_value() as u64), FullInt::U(u64::max_value() as u64)),
 973                     UintTy::Us => (FullInt::U(usize::min_value() as u64), FullInt::U(usize::max_value() as u64)),
 974                 })
 975             }
 976             _ => None,
 977         }
 978     } else {
 979         None
 980     }
 981 }
 982
 983 fn node_as_const_fullint(cx: &LateContext, expr: &Expr) -> Option<FullInt> {
 984     use rustc::middle::const_val::ConstVal::*;
 985     use rustc_const_eval::EvalHint::ExprTypeChecked;
 986     use rustc_const_eval::eval_const_expr_partial;
 987     use rustc_const_math::ConstInt;
 988
 989     match eval_const_expr_partial(cx.tcx, expr, ExprTypeChecked, None) {
 990         Ok(val) => {
 991             if let Integral(const_int) = val {
 992                 Some(match const_int.erase_type() {
 993                     ConstInt::InferSigned(x) => FullInt::S(x as i64),
 994                     ConstInt::Infer(x) => FullInt::U(x as u64),
 995                     _ => unreachable!(),
 996                 })
 997             } else {
 998                 None
 999             }
1000         }
1001         Err(_) => None,
1002     }
1003 }
1004
1005 fn err_upcast_comparison(cx: &LateContext, span: &Span, expr: &Expr, always: bool) {
1006     if let ExprCast(ref cast_val, _) = expr.node {
1007         span_lint(cx,
1008                   INVALID_UPCAST_COMPARISONS,
1009                   *span,
1010                   &format!(
1011                 "because of the numeric bounds on `{}` prior to casting, this expression is always {}",
1012                 snippet(cx, cast_val.span, "the expression"),
1013                 if always { "true" } else { "false" },
1014             ));
1015     }
1016 }
1017
1018 fn upcast_comparison_bounds_err(cx: &LateContext, span: &Span, rel: comparisons::Rel,
1019                                 lhs_bounds: Option<(FullInt, FullInt)>, lhs: &Expr, rhs: &Expr, invert: bool) {
1020     use utils::comparisons::*;
1021
1022     if let Some((lb, ub)) = lhs_bounds {
1023         if let Some(norm_rhs_val) = node_as_const_fullint(cx, rhs) {
1024             if rel == Rel::Eq || rel == Rel::Ne {
1025                 if norm_rhs_val < lb || norm_rhs_val > ub {
1026                     err_upcast_comparison(cx, span, lhs, rel == Rel::Ne);
1027                 }
1028             } else if match rel {
1029                 Rel::Lt => {
1030                     if invert {
1031                         norm_rhs_val < lb
1032                     } else {
1033                         ub < norm_rhs_val
1034                     }
1035                 }
1036                 Rel::Le => {
1037                     if invert {
1038                         norm_rhs_val <= lb
1039                     } else {
1040                         ub <= norm_rhs_val
1041                     }
1042                 }
1043                 Rel::Eq | Rel::Ne => unreachable!(),
1044             } {
1045                 err_upcast_comparison(cx, span, lhs, true)
1046             } else if match rel {
1047                 Rel::Lt => {
1048                     if invert {
1049                         norm_rhs_val >= ub
1050                     } else {
1051                         lb >= norm_rhs_val
1052                     }
1053                 }
1054                 Rel::Le => {
1055                     if invert {
1056                         norm_rhs_val > ub
1057                     } else {
1058                         lb > norm_rhs_val
1059                     }
1060                 }
1061                 Rel::Eq | Rel::Ne => unreachable!(),
1062             } {
1063                 err_upcast_comparison(cx, span, lhs, false)
1064             }
1065         }
1066     }
1067 }
1068
1069 impl LateLintPass for InvalidUpcastComparisons {
1070     fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
1071         if let ExprBinary(ref cmp, ref lhs, ref rhs) = expr.node {
1072
1073             let normalized = comparisons::normalize_comparison(cmp.node, lhs, rhs);
1074             let (rel, normalized_lhs, normalized_rhs) = if let Some(val) = normalized {
1075                 val
1076             } else {
1077                 return;
1078             };
1079
1080             let lhs_bounds = numeric_cast_precast_bounds(cx, normalized_lhs);
1081             let rhs_bounds = numeric_cast_precast_bounds(cx, normalized_rhs);
1082
1083             upcast_comparison_bounds_err(cx, &expr.span, rel, lhs_bounds, normalized_lhs, normalized_rhs, false);
1084             upcast_comparison_bounds_err(cx, &expr.span, rel, rhs_bounds, normalized_rhs, normalized_lhs, true);
1085         }
1086     }
1087 }