src/tools/clippy/clippy_lints/src/misc.rs

   1 use if_chain::if_chain;
   2 use rustc_ast::ast::LitKind;
   3 use rustc_errors::Applicability;
   4 use rustc_hir::intravisit::FnKind;
   5 use rustc_hir::{
   6     def, BinOpKind, BindingAnnotation, Body, Expr, ExprKind, FnDecl, HirId, Mutability, PatKind, Stmt, StmtKind, Ty,
   7     TyKind, UnOp,
   8 };
   9 use rustc_lint::{LateContext, LateLintPass};
  10 use rustc_middle::ty;
  11 use rustc_session::{declare_lint_pass, declare_tool_lint};
  12 use rustc_span::hygiene::DesugaringKind;
  13 use rustc_span::source_map::{ExpnKind, Span};
  14
  15 use crate::consts::{constant, Constant};
  16 use crate::utils::sugg::Sugg;
  17 use crate::utils::{
  18     get_item_name, get_parent_expr, higher, implements_trait, in_constant, is_integer_const, iter_input_pats,
  19     last_path_segment, match_qpath, match_trait_method, paths, snippet, snippet_opt, span_lint, span_lint_and_sugg,
  20     span_lint_and_then, span_lint_hir_and_then, walk_ptrs_ty, SpanlessEq,
  21 };
  22
  23 declare_clippy_lint! {
  24     /// **What it does:** Checks for function arguments and let bindings denoted as
  25     /// `ref`.
  26     ///
  27     /// **Why is this bad?** The `ref` declaration makes the function take an owned
  28     /// value, but turns the argument into a reference (which means that the value
  29     /// is destroyed when exiting the function). This adds not much value: either
  30     /// take a reference type, or take an owned value and create references in the
  31     /// body.
  32     ///
  33     /// For let bindings, `let x = &foo;` is preferred over `let ref x = foo`. The
  34     /// type of `x` is more obvious with the former.
  35     ///
  36     /// **Known problems:** If the argument is dereferenced within the function,
  37     /// removing the `ref` will lead to errors. This can be fixed by removing the
  38     /// dereferences, e.g., changing `*x` to `x` within the function.
  39     ///
  40     /// **Example:**
  41     /// ```rust,ignore
  42     /// // Bad
  43     /// fn foo(ref x: u8) -> bool {
  44     ///     true
  45     /// }
  46     ///
  47     /// // Good
  48     /// fn foo(x: &u8) -> bool {
  49     ///     true
  50     /// }
  51     /// ```
  52     pub TOPLEVEL_REF_ARG,
  53     style,
  54     "an entire binding declared as `ref`, in a function argument or a `let` statement"
  55 }
  56
  57 declare_clippy_lint! {
  58     /// **What it does:** Checks for comparisons to NaN.
  59     ///
  60     /// **Why is this bad?** NaN does not compare meaningfully to anything – not
  61     /// even itself – so those comparisons are simply wrong.
  62     ///
  63     /// **Known problems:** None.
  64     ///
  65     /// **Example:**
  66     /// ```rust
  67     /// # let x = 1.0;
  68     ///
  69     /// // Bad
  70     /// if x == f32::NAN { }
  71     ///
  72     /// // Good
  73     /// if x.is_nan() { }
  74     /// ```
  75     pub CMP_NAN,
  76     correctness,
  77     "comparisons to `NAN`, which will always return false, probably not intended"
  78 }
  79
  80 declare_clippy_lint! {
  81     /// **What it does:** Checks for (in-)equality comparisons on floating-point
  82     /// values (apart from zero), except in functions called `*eq*` (which probably
  83     /// implement equality for a type involving floats).
  84     ///
  85     /// **Why is this bad?** Floating point calculations are usually imprecise, so
  86     /// asking if two values are *exactly* equal is asking for trouble. For a good
  87     /// guide on what to do, see [the floating point
  88     /// guide](http://www.floating-point-gui.de/errors/comparison).
  89     ///
  90     /// **Known problems:** None.
  91     ///
  92     /// **Example:**
  93     /// ```rust
  94     /// let x = 1.2331f64;
  95     /// let y = 1.2332f64;
  96     ///
  97     /// // Bad
  98     /// if y == 1.23f64 { }
  99     /// if y != x {} // where both are floats
 100     ///
 101     /// // Good
 102     /// let error = 0.01f64; // Use an epsilon for comparison
 103     /// if (y - 1.23f64).abs() < error { }
 104     /// if (y - x).abs() > error { }
 105     /// ```
 106     pub FLOAT_CMP,
 107     correctness,
 108     "using `==` or `!=` on float values instead of comparing difference with an epsilon"
 109 }
 110
 111 declare_clippy_lint! {
 112     /// **What it does:** Checks for conversions to owned values just for the sake
 113     /// of a comparison.
 114     ///
 115     /// **Why is this bad?** The comparison can operate on a reference, so creating
 116     /// an owned value effectively throws it away directly afterwards, which is
 117     /// needlessly consuming code and heap space.
 118     ///
 119     /// **Known problems:** None.
 120     ///
 121     /// **Example:**
 122     /// ```rust
 123     /// # let x = "foo";
 124     /// # let y = String::from("foo");
 125     /// if x.to_owned() == y {}
 126     /// ```
 127     /// Could be written as
 128     /// ```rust
 129     /// # let x = "foo";
 130     /// # let y = String::from("foo");
 131     /// if x == y {}
 132     /// ```
 133     pub CMP_OWNED,
 134     perf,
 135     "creating owned instances for comparing with others, e.g., `x == \"foo\".to_string()`"
 136 }
 137
 138 declare_clippy_lint! {
 139     /// **What it does:** Checks for getting the remainder of a division by one.
 140     ///
 141     /// **Why is this bad?** The result can only ever be zero. No one will write
 142     /// such code deliberately, unless trying to win an Underhanded Rust
 143     /// Contest. Even for that contest, it's probably a bad idea. Use something more
 144     /// underhanded.
 145     ///
 146     /// **Known problems:** None.
 147     ///
 148     /// **Example:**
 149     /// ```rust
 150     /// # let x = 1;
 151     /// let a = x % 1;
 152     /// ```
 153     pub MODULO_ONE,
 154     correctness,
 155     "taking a number modulo 1, which always returns 0"
 156 }
 157
 158 declare_clippy_lint! {
 159     /// **What it does:** Checks for the use of bindings with a single leading
 160     /// underscore.
 161     ///
 162     /// **Why is this bad?** A single leading underscore is usually used to indicate
 163     /// that a binding will not be used. Using such a binding breaks this
 164     /// expectation.
 165     ///
 166     /// **Known problems:** The lint does not work properly with desugaring and
 167     /// macro, it has been allowed in the mean time.
 168     ///
 169     /// **Example:**
 170     /// ```rust
 171     /// let _x = 0;
 172     /// let y = _x + 1; // Here we are using `_x`, even though it has a leading
 173     ///                 // underscore. We should rename `_x` to `x`
 174     /// ```
 175     pub USED_UNDERSCORE_BINDING,
 176     pedantic,
 177     "using a binding which is prefixed with an underscore"
 178 }
 179
 180 declare_clippy_lint! {
 181     /// **What it does:** Checks for the use of short circuit boolean conditions as
 182     /// a
 183     /// statement.
 184     ///
 185     /// **Why is this bad?** Using a short circuit boolean condition as a statement
 186     /// may hide the fact that the second part is executed or not depending on the
 187     /// outcome of the first part.
 188     ///
 189     /// **Known problems:** None.
 190     ///
 191     /// **Example:**
 192     /// ```rust,ignore
 193     /// f() && g(); // We should write `if f() { g(); }`.
 194     /// ```
 195     pub SHORT_CIRCUIT_STATEMENT,
 196     complexity,
 197     "using a short circuit boolean condition as a statement"
 198 }
 199
 200 declare_clippy_lint! {
 201     /// **What it does:** Catch casts from `0` to some pointer type
 202     ///
 203     /// **Why is this bad?** This generally means `null` and is better expressed as
 204     /// {`std`, `core`}`::ptr::`{`null`, `null_mut`}.
 205     ///
 206     /// **Known problems:** None.
 207     ///
 208     /// **Example:**
 209     ///
 210     /// ```rust
 211     /// // Bad
 212     /// let a = 0 as *const u32;
 213     ///
 214     /// // Good
 215     /// let a = std::ptr::null::<u32>();
 216     /// ```
 217     pub ZERO_PTR,
 218     style,
 219     "using `0 as *{const, mut} T`"
 220 }
 221
 222 declare_clippy_lint! {
 223     /// **What it does:** Checks for (in-)equality comparisons on floating-point
 224     /// value and constant, except in functions called `*eq*` (which probably
 225     /// implement equality for a type involving floats).
 226     ///
 227     /// **Why is this bad?** Floating point calculations are usually imprecise, so
 228     /// asking if two values are *exactly* equal is asking for trouble. For a good
 229     /// guide on what to do, see [the floating point
 230     /// guide](http://www.floating-point-gui.de/errors/comparison).
 231     ///
 232     /// **Known problems:** None.
 233     ///
 234     /// **Example:**
 235     /// ```rust
 236     /// let x: f64 = 1.0;
 237     /// const ONE: f64 = 1.00;
 238     ///
 239     /// // Bad
 240     /// if x == ONE { }  // where both are floats
 241     ///
 242     /// // Good
 243     /// let error = 0.1f64; // Use an epsilon for comparison
 244     /// if (x - ONE).abs() < error { }
 245     /// ```
 246     pub FLOAT_CMP_CONST,
 247     restriction,
 248     "using `==` or `!=` on float constants instead of comparing difference with an epsilon"
 249 }
 250
 251 declare_lint_pass!(MiscLints => [
 252     TOPLEVEL_REF_ARG,
 253     CMP_NAN,
 254     FLOAT_CMP,
 255     CMP_OWNED,
 256     MODULO_ONE,
 257     USED_UNDERSCORE_BINDING,
 258     SHORT_CIRCUIT_STATEMENT,
 259     ZERO_PTR,
 260     FLOAT_CMP_CONST
 261 ]);
 262
 263 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MiscLints {
 264     fn check_fn(
 265         &mut self,
 266         cx: &LateContext<'a, 'tcx>,
 267         k: FnKind<'tcx>,
 268         decl: &'tcx FnDecl<'_>,
 269         body: &'tcx Body<'_>,
 270         _: Span,
 271         _: HirId,
 272     ) {
 273         if let FnKind::Closure(_) = k {
 274             // Does not apply to closures
 275             return;
 276         }
 277         for arg in iter_input_pats(decl, body) {
 278             if let PatKind::Binding(BindingAnnotation::Ref | BindingAnnotation::RefMut, ..) = arg.pat.kind {
 279                 span_lint(
 280                     cx,
 281                     TOPLEVEL_REF_ARG,
 282                     arg.pat.span,
 283                     "`ref` directly on a function argument is ignored. \
 284                     Consider using a reference type instead.",
 285                 );
 286             }
 287         }
 288     }
 289
 290     fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, stmt: &'tcx Stmt<'_>) {
 291         if_chain! {
 292             if let StmtKind::Local(ref local) = stmt.kind;
 293             if let PatKind::Binding(an, .., name, None) = local.pat.kind;
 294             if let Some(ref init) = local.init;
 295             if !higher::is_from_for_desugar(local);
 296             then {
 297                 if an == BindingAnnotation::Ref || an == BindingAnnotation::RefMut {
 298                     let sugg_init = if init.span.from_expansion() {
 299                         Sugg::hir_with_macro_callsite(cx, init, "..")
 300                     } else {
 301                         Sugg::hir(cx, init, "..")
 302                     };
 303                     let (mutopt, initref) = if an == BindingAnnotation::RefMut {
 304                         ("mut ", sugg_init.mut_addr())
 305                     } else {
 306                         ("", sugg_init.addr())
 307                     };
 308                     let tyopt = if let Some(ref ty) = local.ty {
 309                         format!(": &{mutopt}{ty}", mutopt=mutopt, ty=snippet(cx, ty.span, "_"))
 310                     } else {
 311                         String::new()
 312                     };
 313                     span_lint_hir_and_then(
 314                         cx,
 315                         TOPLEVEL_REF_ARG,
 316                         init.hir_id,
 317                         local.pat.span,
 318                         "`ref` on an entire `let` pattern is discouraged, take a reference with `&` instead",
 319                         |diag| {
 320                             diag.span_suggestion(
 321                                 stmt.span,
 322                                 "try",
 323                                 format!(
 324                                     "let {name}{tyopt} = {initref};",
 325                                     name=snippet(cx, name.span, "_"),
 326                                     tyopt=tyopt,
 327                                     initref=initref,
 328                                 ),
 329                                 Applicability::MachineApplicable,
 330                             );
 331                         }
 332                     );
 333                 }
 334             }
 335         };
 336         if_chain! {
 337             if let StmtKind::Semi(ref expr) = stmt.kind;
 338             if let ExprKind::Binary(ref binop, ref a, ref b) = expr.kind;
 339             if binop.node == BinOpKind::And || binop.node == BinOpKind::Or;
 340             if let Some(sugg) = Sugg::hir_opt(cx, a);
 341             then {
 342                 span_lint_and_then(cx,
 343                     SHORT_CIRCUIT_STATEMENT,
 344                     stmt.span,
 345                     "boolean short circuit operator in statement may be clearer using an explicit test",
 346                     |diag| {
 347                         let sugg = if binop.node == BinOpKind::Or { !sugg } else { sugg };
 348                         diag.span_suggestion(
 349                             stmt.span,
 350                             "replace it with",
 351                             format!(
 352                                 "if {} {{ {}; }}",
 353                                 sugg,
 354                                 &snippet(cx, b.span, ".."),
 355                             ),
 356                             Applicability::MachineApplicable, // snippet
 357                         );
 358                     });
 359             }
 360         };
 361     }
 362
 363     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
 364         match expr.kind {
 365             ExprKind::Cast(ref e, ref ty) => {
 366                 check_cast(cx, expr.span, e, ty);
 367                 return;
 368             },
 369             ExprKind::Binary(ref cmp, ref left, ref right) => {
 370                 let op = cmp.node;
 371                 if op.is_comparison() {
 372                     check_nan(cx, left, expr);
 373                     check_nan(cx, right, expr);
 374                     check_to_owned(cx, left, right);
 375                     check_to_owned(cx, right, left);
 376                 }
 377                 if (op == BinOpKind::Eq || op == BinOpKind::Ne) && (is_float(cx, left) || is_float(cx, right)) {
 378                     if is_allowed(cx, left) || is_allowed(cx, right) {
 379                         return;
 380                     }
 381
 382                     // Allow comparing the results of signum()
 383                     if is_signum(cx, left) && is_signum(cx, right) {
 384                         return;
 385                     }
 386
 387                     if let Some(name) = get_item_name(cx, expr) {
 388                         let name = name.as_str();
 389                         if name == "eq"
 390                             || name == "ne"
 391                             || name == "is_nan"
 392                             || name.starts_with("eq_")
 393                             || name.ends_with("_eq")
 394                         {
 395                             return;
 396                         }
 397                     }
 398                     let is_comparing_arrays = is_array(cx, left) || is_array(cx, right);
 399                     let (lint, msg) = get_lint_and_message(
 400                         is_named_constant(cx, left) || is_named_constant(cx, right),
 401                         is_comparing_arrays,
 402                     );
 403                     span_lint_and_then(cx, lint, expr.span, msg, |diag| {
 404                         let lhs = Sugg::hir(cx, left, "..");
 405                         let rhs = Sugg::hir(cx, right, "..");
 406
 407                         if !is_comparing_arrays {
 408                             diag.span_suggestion(
 409                                 expr.span,
 410                                 "consider comparing them within some error",
 411                                 format!(
 412                                     "({}).abs() {} error",
 413                                     lhs - rhs,
 414                                     if op == BinOpKind::Eq { '<' } else { '>' }
 415                                 ),
 416                                 Applicability::HasPlaceholders, // snippet
 417                             );
 418                         }
 419                         diag.note("`f32::EPSILON` and `f64::EPSILON` are available for the `error`");
 420                     });
 421                 } else if op == BinOpKind::Rem && is_integer_const(cx, right, 1) {
 422                     span_lint(cx, MODULO_ONE, expr.span, "any number modulo 1 will be 0");
 423                 }
 424             },
 425             _ => {},
 426         }
 427         if in_attributes_expansion(expr) || expr.span.is_desugaring(DesugaringKind::Await) {
 428             // Don't lint things expanded by #[derive(...)], etc or `await` desugaring
 429             return;
 430         }
 431         let binding = match expr.kind {
 432             ExprKind::Path(ref qpath) => {
 433                 let binding = last_path_segment(qpath).ident.as_str();
 434                 if binding.starts_with('_') &&
 435                     !binding.starts_with("__") &&
 436                     binding != "_result" && // FIXME: #944
 437                     is_used(cx, expr) &&
 438                     // don't lint if the declaration is in a macro
 439                     non_macro_local(cx, cx.tables.qpath_res(qpath, expr.hir_id))
 440                 {
 441                     Some(binding)
 442                 } else {
 443                     None
 444                 }
 445             },
 446             ExprKind::Field(_, ident) => {
 447                 let name = ident.as_str();
 448                 if name.starts_with('_') && !name.starts_with("__") {
 449                     Some(name)
 450                 } else {
 451                     None
 452                 }
 453             },
 454             _ => None,
 455         };
 456         if let Some(binding) = binding {
 457             span_lint(
 458                 cx,
 459                 USED_UNDERSCORE_BINDING,
 460                 expr.span,
 461                 &format!(
 462                     "used binding `{}` which is prefixed with an underscore. A leading \
 463                      underscore signals that a binding will not be used.",
 464                     binding
 465                 ),
 466             );
 467         }
 468     }
 469 }
 470
 471 fn get_lint_and_message(
 472     is_comparing_constants: bool,
 473     is_comparing_arrays: bool,
 474 ) -> (&'static rustc_lint::Lint, &'static str) {
 475     if is_comparing_constants {
 476         (
 477             FLOAT_CMP_CONST,
 478             if is_comparing_arrays {
 479                 "strict comparison of `f32` or `f64` constant arrays"
 480             } else {
 481                 "strict comparison of `f32` or `f64` constant"
 482             },
 483         )
 484     } else {
 485         (
 486             FLOAT_CMP,
 487             if is_comparing_arrays {
 488                 "strict comparison of `f32` or `f64` arrays"
 489             } else {
 490                 "strict comparison of `f32` or `f64`"
 491             },
 492         )
 493     }
 494 }
 495
 496 fn check_nan(cx: &LateContext<'_, '_>, expr: &Expr<'_>, cmp_expr: &Expr<'_>) {
 497     if_chain! {
 498         if !in_constant(cx, cmp_expr.hir_id);
 499         if let Some((value, _)) = constant(cx, cx.tables, expr);
 500         then {
 501             let needs_lint = match value {
 502                 Constant::F32(num) => num.is_nan(),
 503                 Constant::F64(num) => num.is_nan(),
 504                 _ => false,
 505             };
 506
 507             if needs_lint {
 508                 span_lint(
 509                     cx,
 510                     CMP_NAN,
 511                     cmp_expr.span,
 512                     "doomed comparison with `NAN`, use `{f32,f64}::is_nan()` instead",
 513                 );
 514             }
 515         }
 516     }
 517 }
 518
 519 fn is_named_constant<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) -> bool {
 520     if let Some((_, res)) = constant(cx, cx.tables, expr) {
 521         res
 522     } else {
 523         false
 524     }
 525 }
 526
 527 fn is_allowed<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) -> bool {
 528     match constant(cx, cx.tables, expr) {
 529         Some((Constant::F32(f), _)) => f == 0.0 || f.is_infinite(),
 530         Some((Constant::F64(f), _)) => f == 0.0 || f.is_infinite(),
 531         Some((Constant::Vec(vec), _)) => vec.iter().all(|f| match f {
 532             Constant::F32(f) => *f == 0.0 || (*f).is_infinite(),
 533             Constant::F64(f) => *f == 0.0 || (*f).is_infinite(),
 534             _ => false,
 535         }),
 536         _ => false,
 537     }
 538 }
 539
 540 // Return true if `expr` is the result of `signum()` invoked on a float value.
 541 fn is_signum(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
 542     // The negation of a signum is still a signum
 543     if let ExprKind::Unary(UnOp::UnNeg, ref child_expr) = expr.kind {
 544         return is_signum(cx, &child_expr);
 545     }
 546
 547     if_chain! {
 548         if let ExprKind::MethodCall(ref method_name, _, ref expressions, _) = expr.kind;
 549         if sym!(signum) == method_name.ident.name;
 550         // Check that the receiver of the signum() is a float (expressions[0] is the receiver of
 551         // the method call)
 552         then {
 553             return is_float(cx, &expressions[0]);
 554         }
 555     }
 556     false
 557 }
 558
 559 fn is_float(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
 560     let value = &walk_ptrs_ty(cx.tables.expr_ty(expr)).kind;
 561
 562     if let ty::Array(arr_ty, _) = value {
 563         return matches!(arr_ty.kind, ty::Float(_));
 564     };
 565
 566     matches!(value, ty::Float(_))
 567 }
 568
 569 fn is_array(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
 570     matches!(&walk_ptrs_ty(cx.tables.expr_ty(expr)).kind, ty::Array(_, _))
 571 }
 572
 573 fn check_to_owned(cx: &LateContext<'_, '_>, expr: &Expr<'_>, other: &Expr<'_>) {
 574     let (arg_ty, snip) = match expr.kind {
 575         ExprKind::MethodCall(.., ref args, _) if args.len() == 1 => {
 576             if match_trait_method(cx, expr, &paths::TO_STRING) || match_trait_method(cx, expr, &paths::TO_OWNED) {
 577                 (cx.tables.expr_ty_adjusted(&args[0]), snippet(cx, args[0].span, ".."))
 578             } else {
 579                 return;
 580             }
 581         },
 582         ExprKind::Call(ref path, ref v) if v.len() == 1 => {
 583             if let ExprKind::Path(ref path) = path.kind {
 584                 if match_qpath(path, &["String", "from_str"]) || match_qpath(path, &["String", "from"]) {
 585                     (cx.tables.expr_ty_adjusted(&v[0]), snippet(cx, v[0].span, ".."))
 586                 } else {
 587                     return;
 588                 }
 589             } else {
 590                 return;
 591             }
 592         },
 593         _ => return,
 594     };
 595
 596     let other_ty = cx.tables.expr_ty_adjusted(other);
 597     let partial_eq_trait_id = match cx.tcx.lang_items().eq_trait() {
 598         Some(id) => id,
 599         None => return,
 600     };
 601
 602     let deref_arg_impl_partial_eq_other = arg_ty.builtin_deref(true).map_or(false, |tam| {
 603         implements_trait(cx, tam.ty, partial_eq_trait_id, &[other_ty.into()])
 604     });
 605     let arg_impl_partial_eq_deref_other = other_ty.builtin_deref(true).map_or(false, |tam| {
 606         implements_trait(cx, arg_ty, partial_eq_trait_id, &[tam.ty.into()])
 607     });
 608     let arg_impl_partial_eq_other = implements_trait(cx, arg_ty, partial_eq_trait_id, &[other_ty.into()]);
 609
 610     if !deref_arg_impl_partial_eq_other && !arg_impl_partial_eq_deref_other && !arg_impl_partial_eq_other {
 611         return;
 612     }
 613
 614     let other_gets_derefed = match other.kind {
 615         ExprKind::Unary(UnOp::UnDeref, _) => true,
 616         _ => false,
 617     };
 618
 619     let lint_span = if other_gets_derefed {
 620         expr.span.to(other.span)
 621     } else {
 622         expr.span
 623     };
 624
 625     span_lint_and_then(
 626         cx,
 627         CMP_OWNED,
 628         lint_span,
 629         "this creates an owned instance just for comparison",
 630         |diag| {
 631             // This also catches `PartialEq` implementations that call `to_owned`.
 632             if other_gets_derefed {
 633                 diag.span_label(lint_span, "try implementing the comparison without allocating");
 634                 return;
 635             }
 636
 637             let try_hint = if deref_arg_impl_partial_eq_other {
 638                 // suggest deref on the left
 639                 format!("*{}", snip)
 640             } else {
 641                 // suggest dropping the to_owned on the left
 642                 snip.to_string()
 643             };
 644
 645             diag.span_suggestion(
 646                 lint_span,
 647                 "try",
 648                 try_hint,
 649                 Applicability::MachineApplicable, // snippet
 650             );
 651         },
 652     );
 653 }
 654
 655 /// Heuristic to see if an expression is used. Should be compatible with
 656 /// `unused_variables`'s idea
 657 /// of what it means for an expression to be "used".
 658 fn is_used(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
 659     if let Some(parent) = get_parent_expr(cx, expr) {
 660         match parent.kind {
 661             ExprKind::Assign(_, ref rhs, _) | ExprKind::AssignOp(_, _, ref rhs) => {
 662                 SpanlessEq::new(cx).eq_expr(rhs, expr)
 663             },
 664             _ => is_used(cx, parent),
 665         }
 666     } else {
 667         true
 668     }
 669 }
 670
 671 /// Tests whether an expression is in a macro expansion (e.g., something
 672 /// generated by `#[derive(...)]` or the like).
 673 fn in_attributes_expansion(expr: &Expr<'_>) -> bool {
 674     use rustc_span::hygiene::MacroKind;
 675     if expr.span.from_expansion() {
 676         let data = expr.span.ctxt().outer_expn_data();
 677
 678         if let ExpnKind::Macro(MacroKind::Attr, _) = data.kind {
 679             true
 680         } else {
 681             false
 682         }
 683     } else {
 684         false
 685     }
 686 }
 687
 688 /// Tests whether `res` is a variable defined outside a macro.
 689 fn non_macro_local(cx: &LateContext<'_, '_>, res: def::Res) -> bool {
 690     if let def::Res::Local(id) = res {
 691         !cx.tcx.hir().span(id).from_expansion()
 692     } else {
 693         false
 694     }
 695 }
 696
 697 fn check_cast(cx: &LateContext<'_, '_>, span: Span, e: &Expr<'_>, ty: &Ty<'_>) {
 698     if_chain! {
 699         if let TyKind::Ptr(ref mut_ty) = ty.kind;
 700         if let ExprKind::Lit(ref lit) = e.kind;
 701         if let LitKind::Int(0, _) = lit.node;
 702         if !in_constant(cx, e.hir_id);
 703         then {
 704             let (msg, sugg_fn) = match mut_ty.mutbl {
 705                 Mutability::Mut => ("`0 as *mut _` detected", "std::ptr::null_mut"),
 706                 Mutability::Not => ("`0 as *const _` detected", "std::ptr::null"),
 707             };
 708
 709             let (sugg, appl) = if let TyKind::Infer = mut_ty.ty.kind {
 710                 (format!("{}()", sugg_fn), Applicability::MachineApplicable)
 711             } else if let Some(mut_ty_snip) = snippet_opt(cx, mut_ty.ty.span) {
 712                 (format!("{}::<{}>()", sugg_fn, mut_ty_snip), Applicability::MachineApplicable)
 713             } else {
 714                 // `MaybeIncorrect` as type inference may not work with the suggested code
 715                 (format!("{}()", sugg_fn), Applicability::MaybeIncorrect)
 716             };
 717             span_lint_and_sugg(cx, ZERO_PTR, span, msg, "try", sugg, appl);
 718         }
 719     }
 720 }