clippy_lints/src/methods/mod.rs

   1 mod option_map_unwrap_or;
   2 mod unnecessary_filter_map;
   3
   4 use std::borrow::Cow;
   5 use std::fmt;
   6 use std::iter;
   7
   8 use if_chain::if_chain;
   9 use matches::matches;
  10 use rustc::hir;
  11 use rustc::hir::def::{DefKind, Res};
  12 use rustc::hir::intravisit::{self, Visitor};
  13 use rustc::lint::{in_external_macro, LateContext, LateLintPass, Lint, LintArray, LintContext, LintPass};
  14 use rustc::ty::{self, Predicate, Ty};
  15 use rustc::{declare_lint_pass, declare_tool_lint};
  16 use rustc_errors::Applicability;
  17 use syntax::ast;
  18 use syntax::source_map::{BytePos, Span};
  19 use syntax::symbol::LocalInternedString;
  20
  21 use crate::utils::paths;
  22 use crate::utils::sugg;
  23 use crate::utils::usage::mutated_variables;
  24 use crate::utils::{
  25     get_arg_name, get_parent_expr, get_trait_def_id, has_iter_method, implements_trait, in_macro, is_copy,
  26     is_ctor_function, is_expn_of, is_self, is_self_ty, iter_input_pats, last_path_segment, match_def_path, match_path,
  27     match_qpath, match_trait_method, match_type, match_var, method_calls, method_chain_args, remove_blocks, return_ty,
  28     same_tys, single_segment_path, snippet, snippet_with_applicability, snippet_with_macro_callsite, span_lint,
  29     span_lint_and_sugg, span_lint_and_then, span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth, SpanlessEq,
  30 };
  31
  32 declare_clippy_lint! {
  33     /// **What it does:** Checks for `.unwrap()` calls on `Option`s.
  34     ///
  35     /// **Why is this bad?** Usually it is better to handle the `None` case, or to
  36     /// at least call `.expect(_)` with a more helpful message. Still, for a lot of
  37     /// quick-and-dirty code, `unwrap` is a good choice, which is why this lint is
  38     /// `Allow` by default.
  39     ///
  40     /// **Known problems:** None.
  41     ///
  42     /// **Example:**
  43     ///
  44     /// Using unwrap on an `Option`:
  45     ///
  46     /// ```rust
  47     /// let opt = Some(1);
  48     /// opt.unwrap();
  49     /// ```
  50     ///
  51     /// Better:
  52     ///
  53     /// ```rust
  54     /// let opt = Some(1);
  55     /// opt.expect("more helpful message");
  56     /// ```
  57     pub OPTION_UNWRAP_USED,
  58     restriction,
  59     "using `Option.unwrap()`, which should at least get a better message using `expect()`"
  60 }
  61
  62 declare_clippy_lint! {
  63     /// **What it does:** Checks for `.unwrap()` calls on `Result`s.
  64     ///
  65     /// **Why is this bad?** `result.unwrap()` will let the thread panic on `Err`
  66     /// values. Normally, you want to implement more sophisticated error handling,
  67     /// and propagate errors upwards with `try!`.
  68     ///
  69     /// Even if you want to panic on errors, not all `Error`s implement good
  70     /// messages on display. Therefore, it may be beneficial to look at the places
  71     /// where they may get displayed. Activate this lint to do just that.
  72     ///
  73     /// **Known problems:** None.
  74     ///
  75     /// **Example:**
  76     /// Using unwrap on an `Option`:
  77     ///
  78     /// ```rust
  79     /// let res: Result<usize, ()> = Ok(1);
  80     /// res.unwrap();
  81     /// ```
  82     ///
  83     /// Better:
  84     ///
  85     /// ```rust
  86     /// let res: Result<usize, ()> = Ok(1);
  87     /// res.expect("more helpful message");
  88     /// ```
  89     pub RESULT_UNWRAP_USED,
  90     restriction,
  91     "using `Result.unwrap()`, which might be better handled"
  92 }
  93
  94 declare_clippy_lint! {
  95     /// **What it does:** Checks for methods that should live in a trait
  96     /// implementation of a `std` trait (see [llogiq's blog
  97     /// post](http://llogiq.github.io/2015/07/30/traits.html) for further
  98     /// information) instead of an inherent implementation.
  99     ///
 100     /// **Why is this bad?** Implementing the traits improve ergonomics for users of
 101     /// the code, often with very little cost. Also people seeing a `mul(...)`
 102     /// method
 103     /// may expect `*` to work equally, so you should have good reason to disappoint
 104     /// them.
 105     ///
 106     /// **Known problems:** None.
 107     ///
 108     /// **Example:**
 109     /// ```ignore
 110     /// struct X;
 111     /// impl X {
 112     ///     fn add(&self, other: &X) -> X {
 113     ///         ..
 114     ///     }
 115     /// }
 116     /// ```
 117     pub SHOULD_IMPLEMENT_TRAIT,
 118     style,
 119     "defining a method that should be implementing a std trait"
 120 }
 121
 122 declare_clippy_lint! {
 123     /// **What it does:** Checks for methods with certain name prefixes and which
 124     /// doesn't match how self is taken. The actual rules are:
 125     ///
 126     /// |Prefix |`self` taken          |
 127     /// |-------|----------------------|
 128     /// |`as_`  |`&self` or `&mut self`|
 129     /// |`from_`| none                 |
 130     /// |`into_`|`self`                |
 131     /// |`is_`  |`&self` or none       |
 132     /// |`to_`  |`&self`               |
 133     ///
 134     /// **Why is this bad?** Consistency breeds readability. If you follow the
 135     /// conventions, your users won't be surprised that they, e.g., need to supply a
 136     /// mutable reference to a `as_..` function.
 137     ///
 138     /// **Known problems:** None.
 139     ///
 140     /// **Example:**
 141     /// ```ignore
 142     /// impl X {
 143     ///     fn as_str(self) -> &str {
 144     ///         ..
 145     ///     }
 146     /// }
 147     /// ```
 148     pub WRONG_SELF_CONVENTION,
 149     style,
 150     "defining a method named with an established prefix (like \"into_\") that takes `self` with the wrong convention"
 151 }
 152
 153 declare_clippy_lint! {
 154     /// **What it does:** This is the same as
 155     /// [`wrong_self_convention`](#wrong_self_convention), but for public items.
 156     ///
 157     /// **Why is this bad?** See [`wrong_self_convention`](#wrong_self_convention).
 158     ///
 159     /// **Known problems:** Actually *renaming* the function may break clients if
 160     /// the function is part of the public interface. In that case, be mindful of
 161     /// the stability guarantees you've given your users.
 162     ///
 163     /// **Example:**
 164     /// ```rust
 165     /// # struct X;
 166     /// impl<'a> X {
 167     ///     pub fn as_str(self) -> &'a str {
 168     ///         "foo"
 169     ///     }
 170     /// }
 171     /// ```
 172     pub WRONG_PUB_SELF_CONVENTION,
 173     restriction,
 174     "defining a public method named with an established prefix (like \"into_\") that takes `self` with the wrong convention"
 175 }
 176
 177 declare_clippy_lint! {
 178     /// **What it does:** Checks for usage of `ok().expect(..)`.
 179     ///
 180     /// **Why is this bad?** Because you usually call `expect()` on the `Result`
 181     /// directly to get a better error message.
 182     ///
 183     /// **Known problems:** The error type needs to implement `Debug`
 184     ///
 185     /// **Example:**
 186     /// ```ignore
 187     /// x.ok().expect("why did I do this again?")
 188     /// ```
 189     pub OK_EXPECT,
 190     style,
 191     "using `ok().expect()`, which gives worse error messages than calling `expect` directly on the Result"
 192 }
 193
 194 declare_clippy_lint! {
 195     /// **What it does:** Checks for usage of `_.map(_).unwrap_or(_)`.
 196     ///
 197     /// **Why is this bad?** Readability, this can be written more concisely as
 198     /// `_.map_or(_, _)`.
 199     ///
 200     /// **Known problems:** The order of the arguments is not in execution order
 201     ///
 202     /// **Example:**
 203     /// ```rust
 204     /// # let x = Some(1);
 205     /// x.map(|a| a + 1).unwrap_or(0);
 206     /// ```
 207     pub OPTION_MAP_UNWRAP_OR,
 208     pedantic,
 209     "using `Option.map(f).unwrap_or(a)`, which is more succinctly expressed as `map_or(a, f)`"
 210 }
 211
 212 declare_clippy_lint! {
 213     /// **What it does:** Checks for usage of `_.map(_).unwrap_or_else(_)`.
 214     ///
 215     /// **Why is this bad?** Readability, this can be written more concisely as
 216     /// `_.map_or_else(_, _)`.
 217     ///
 218     /// **Known problems:** The order of the arguments is not in execution order.
 219     ///
 220     /// **Example:**
 221     /// ```rust
 222     /// # let x = Some(1);
 223     /// # fn some_function() -> usize { 1 }
 224     /// x.map(|a| a + 1).unwrap_or_else(some_function);
 225     /// ```
 226     pub OPTION_MAP_UNWRAP_OR_ELSE,
 227     pedantic,
 228     "using `Option.map(f).unwrap_or_else(g)`, which is more succinctly expressed as `map_or_else(g, f)`"
 229 }
 230
 231 declare_clippy_lint! {
 232     /// **What it does:** Checks for usage of `result.map(_).unwrap_or_else(_)`.
 233     ///
 234     /// **Why is this bad?** Readability, this can be written more concisely as
 235     /// `result.ok().map_or_else(_, _)`.
 236     ///
 237     /// **Known problems:** None.
 238     ///
 239     /// **Example:**
 240     /// ```rust
 241     /// # let x: Result<usize, ()> = Ok(1);
 242     /// # fn some_function(foo: ()) -> usize { 1 }
 243     /// x.map(|a| a + 1).unwrap_or_else(some_function);
 244     /// ```
 245     pub RESULT_MAP_UNWRAP_OR_ELSE,
 246     pedantic,
 247     "using `Result.map(f).unwrap_or_else(g)`, which is more succinctly expressed as `.ok().map_or_else(g, f)`"
 248 }
 249
 250 declare_clippy_lint! {
 251     /// **What it does:** Checks for usage of `_.map_or(None, _)`.
 252     ///
 253     /// **Why is this bad?** Readability, this can be written more concisely as
 254     /// `_.and_then(_)`.
 255     ///
 256     /// **Known problems:** The order of the arguments is not in execution order.
 257     ///
 258     /// **Example:**
 259     /// ```ignore
 260     /// opt.map_or(None, |a| a + 1)
 261     /// ```
 262     pub OPTION_MAP_OR_NONE,
 263     style,
 264     "using `Option.map_or(None, f)`, which is more succinctly expressed as `and_then(f)`"
 265 }
 266
 267 declare_clippy_lint! {
 268     /// **What it does:** Checks for usage of `_.filter(_).next()`.
 269     ///
 270     /// **Why is this bad?** Readability, this can be written more concisely as
 271     /// `_.find(_)`.
 272     ///
 273     /// **Known problems:** None.
 274     ///
 275     /// **Example:**
 276     /// ```rust
 277     /// # let vec = vec![1];
 278     /// vec.iter().filter(|x| **x == 0).next();
 279     /// ```
 280     pub FILTER_NEXT,
 281     complexity,
 282     "using `filter(p).next()`, which is more succinctly expressed as `.find(p)`"
 283 }
 284
 285 declare_clippy_lint! {
 286     /// **What it does:** Checks for usage of `_.map(_).flatten(_)`,
 287     ///
 288     /// **Why is this bad?** Readability, this can be written more concisely as a
 289     /// single method call.
 290     ///
 291     /// **Known problems:**
 292     ///
 293     /// **Example:**
 294     /// ```rust
 295     /// let vec = vec![vec![1]];
 296     /// vec.iter().map(|x| x.iter()).flatten();
 297     /// ```
 298     pub MAP_FLATTEN,
 299     pedantic,
 300     "using combinations of `flatten` and `map` which can usually be written as a single method call"
 301 }
 302
 303 declare_clippy_lint! {
 304     /// **What it does:** Checks for usage of `_.filter(_).map(_)`,
 305     /// `_.filter(_).flat_map(_)`, `_.filter_map(_).flat_map(_)` and similar.
 306     ///
 307     /// **Why is this bad?** Readability, this can be written more concisely as a
 308     /// single method call.
 309     ///
 310     /// **Known problems:** Often requires a condition + Option/Iterator creation
 311     /// inside the closure.
 312     ///
 313     /// **Example:**
 314     /// ```rust
 315     /// let vec = vec![1];
 316     /// vec.iter().filter(|x| **x == 0).map(|x| *x * 2);
 317     /// ```
 318     pub FILTER_MAP,
 319     pedantic,
 320     "using combinations of `filter`, `map`, `filter_map` and `flat_map` which can usually be written as a single method call"
 321 }
 322
 323 declare_clippy_lint! {
 324     /// **What it does:** Checks for usage of `_.filter_map(_).next()`.
 325     ///
 326     /// **Why is this bad?** Readability, this can be written more concisely as a
 327     /// single method call.
 328     ///
 329     /// **Known problems:** None
 330     ///
 331     /// **Example:**
 332     /// ```rust
 333     ///  (0..3).filter_map(|x| if x == 2 { Some(x) } else { None }).next();
 334     /// ```
 335     /// Can be written as
 336     ///
 337     /// ```rust
 338     ///  (0..3).find_map(|x| if x == 2 { Some(x) } else { None });
 339     /// ```
 340     pub FILTER_MAP_NEXT,
 341     pedantic,
 342     "using combination of `filter_map` and `next` which can usually be written as a single method call"
 343 }
 344
 345 declare_clippy_lint! {
 346     /// **What it does:** Checks for usage of `_.find(_).map(_)`.
 347     ///
 348     /// **Why is this bad?** Readability, this can be written more concisely as a
 349     /// single method call.
 350     ///
 351     /// **Known problems:** Often requires a condition + Option/Iterator creation
 352     /// inside the closure.
 353     ///
 354     /// **Example:**
 355     /// ```rust
 356     ///  (0..3).find(|x| *x == 2).map(|x| x * 2);
 357     /// ```
 358     /// Can be written as
 359     /// ```rust
 360     ///  (0..3).find_map(|x| if x == 2 { Some(x * 2) } else { None });
 361     /// ```
 362     pub FIND_MAP,
 363     pedantic,
 364     "using a combination of `find` and `map` can usually be written as a single method call"
 365 }
 366
 367 declare_clippy_lint! {
 368     /// **What it does:** Checks for an iterator search (such as `find()`,
 369     /// `position()`, or `rposition()`) followed by a call to `is_some()`.
 370     ///
 371     /// **Why is this bad?** Readability, this can be written more concisely as
 372     /// `_.any(_)`.
 373     ///
 374     /// **Known problems:** None.
 375     ///
 376     /// **Example:**
 377     /// ```rust
 378     /// # let vec = vec![1];
 379     /// vec.iter().find(|x| **x == 0).is_some();
 380     /// ```
 381     pub SEARCH_IS_SOME,
 382     complexity,
 383     "using an iterator search followed by `is_some()`, which is more succinctly expressed as a call to `any()`"
 384 }
 385
 386 declare_clippy_lint! {
 387     /// **What it does:** Checks for usage of `.chars().next()` on a `str` to check
 388     /// if it starts with a given char.
 389     ///
 390     /// **Why is this bad?** Readability, this can be written more concisely as
 391     /// `_.starts_with(_)`.
 392     ///
 393     /// **Known problems:** None.
 394     ///
 395     /// **Example:**
 396     /// ```rust
 397     /// let name = "foo";
 398     /// name.chars().next() == Some('_');
 399     /// ```
 400     pub CHARS_NEXT_CMP,
 401     complexity,
 402     "using `.chars().next()` to check if a string starts with a char"
 403 }
 404
 405 declare_clippy_lint! {
 406     /// **What it does:** Checks for calls to `.or(foo(..))`, `.unwrap_or(foo(..))`,
 407     /// etc., and suggests to use `or_else`, `unwrap_or_else`, etc., or
 408     /// `unwrap_or_default` instead.
 409     ///
 410     /// **Why is this bad?** The function will always be called and potentially
 411     /// allocate an object acting as the default.
 412     ///
 413     /// **Known problems:** If the function has side-effects, not calling it will
 414     /// change the semantic of the program, but you shouldn't rely on that anyway.
 415     ///
 416     /// **Example:**
 417     /// ```rust
 418     /// # let foo = Some(String::new());
 419     /// foo.unwrap_or(String::new());
 420     /// ```
 421     /// this can instead be written:
 422     /// ```rust
 423     /// # let foo = Some(String::new());
 424     /// foo.unwrap_or_else(String::new);
 425     /// ```
 426     /// or
 427     /// ```rust
 428     /// # let foo = Some(String::new());
 429     /// foo.unwrap_or_default();
 430     /// ```
 431     pub OR_FUN_CALL,
 432     perf,
 433     "using any `*or` method with a function call, which suggests `*or_else`"
 434 }
 435
 436 declare_clippy_lint! {
 437     /// **What it does:** Checks for calls to `.expect(&format!(...))`, `.expect(foo(..))`,
 438     /// etc., and suggests to use `unwrap_or_else` instead
 439     ///
 440     /// **Why is this bad?** The function will always be called.
 441     ///
 442     /// **Known problems:** If the function has side-effects, not calling it will
 443     /// change the semantics of the program, but you shouldn't rely on that anyway.
 444     ///
 445     /// **Example:**
 446     /// ```rust
 447     /// # let foo = Some(String::new());
 448     /// # let err_code = "418";
 449     /// # let err_msg = "I'm a teapot";
 450     /// foo.expect(&format!("Err {}: {}", err_code, err_msg));
 451     /// ```
 452     /// or
 453     /// ```rust
 454     /// # let foo = Some(String::new());
 455     /// # let err_code = "418";
 456     /// # let err_msg = "I'm a teapot";
 457     /// foo.expect(format!("Err {}: {}", err_code, err_msg).as_str());
 458     /// ```
 459     /// this can instead be written:
 460     /// ```rust
 461     /// # let foo = Some(String::new());
 462     /// # let err_code = "418";
 463     /// # let err_msg = "I'm a teapot";
 464     /// foo.unwrap_or_else(|| panic!("Err {}: {}", err_code, err_msg));
 465     /// ```
 466     pub EXPECT_FUN_CALL,
 467     perf,
 468     "using any `expect` method with a function call"
 469 }
 470
 471 declare_clippy_lint! {
 472     /// **What it does:** Checks for usage of `.clone()` on a `Copy` type.
 473     ///
 474     /// **Why is this bad?** The only reason `Copy` types implement `Clone` is for
 475     /// generics, not for using the `clone` method on a concrete type.
 476     ///
 477     /// **Known problems:** None.
 478     ///
 479     /// **Example:**
 480     /// ```rust
 481     /// 42u64.clone();
 482     /// ```
 483     pub CLONE_ON_COPY,
 484     complexity,
 485     "using `clone` on a `Copy` type"
 486 }
 487
 488 declare_clippy_lint! {
 489     /// **What it does:** Checks for usage of `.clone()` on a ref-counted pointer,
 490     /// (`Rc`, `Arc`, `rc::Weak`, or `sync::Weak`), and suggests calling Clone via unified
 491     /// function syntax instead (e.g., `Rc::clone(foo)`).
 492     ///
 493     /// **Why is this bad?** Calling '.clone()' on an Rc, Arc, or Weak
 494     /// can obscure the fact that only the pointer is being cloned, not the underlying
 495     /// data.
 496     ///
 497     /// **Example:**
 498     /// ```rust
 499     /// # use std::rc::Rc;
 500     /// let x = Rc::new(1);
 501     /// x.clone();
 502     /// ```
 503     pub CLONE_ON_REF_PTR,
 504     restriction,
 505     "using 'clone' on a ref-counted pointer"
 506 }
 507
 508 declare_clippy_lint! {
 509     /// **What it does:** Checks for usage of `.clone()` on an `&&T`.
 510     ///
 511     /// **Why is this bad?** Cloning an `&&T` copies the inner `&T`, instead of
 512     /// cloning the underlying `T`.
 513     ///
 514     /// **Known problems:** None.
 515     ///
 516     /// **Example:**
 517     /// ```rust
 518     /// fn main() {
 519     ///     let x = vec![1];
 520     ///     let y = &&x;
 521     ///     let z = y.clone();
 522     ///     println!("{:p} {:p}", *y, z); // prints out the same pointer
 523     /// }
 524     /// ```
 525     pub CLONE_DOUBLE_REF,
 526     correctness,
 527     "using `clone` on `&&T`"
 528 }
 529
 530 declare_clippy_lint! {
 531     /// **What it does:** Checks for `new` not returning `Self`.
 532     ///
 533     /// **Why is this bad?** As a convention, `new` methods are used to make a new
 534     /// instance of a type.
 535     ///
 536     /// **Known problems:** None.
 537     ///
 538     /// **Example:**
 539     /// ```ignore
 540     /// impl Foo {
 541     ///     fn new(..) -> NotAFoo {
 542     ///     }
 543     /// }
 544     /// ```
 545     pub NEW_RET_NO_SELF,
 546     style,
 547     "not returning `Self` in a `new` method"
 548 }
 549
 550 declare_clippy_lint! {
 551     /// **What it does:** Checks for string methods that receive a single-character
 552     /// `str` as an argument, e.g., `_.split("x")`.
 553     ///
 554     /// **Why is this bad?** Performing these methods using a `char` is faster than
 555     /// using a `str`.
 556     ///
 557     /// **Known problems:** Does not catch multi-byte unicode characters.
 558     ///
 559     /// **Example:**
 560     /// `_.split("x")` could be `_.split('x')`
 561     pub SINGLE_CHAR_PATTERN,
 562     perf,
 563     "using a single-character str where a char could be used, e.g., `_.split(\"x\")`"
 564 }
 565
 566 declare_clippy_lint! {
 567     /// **What it does:** Checks for getting the inner pointer of a temporary
 568     /// `CString`.
 569     ///
 570     /// **Why is this bad?** The inner pointer of a `CString` is only valid as long
 571     /// as the `CString` is alive.
 572     ///
 573     /// **Known problems:** None.
 574     ///
 575     /// **Example:**
 576     /// ```rust,ignore
 577     /// let c_str = CString::new("foo").unwrap().as_ptr();
 578     /// unsafe {
 579     ///     call_some_ffi_func(c_str);
 580     /// }
 581     /// ```
 582     /// Here `c_str` point to a freed address. The correct use would be:
 583     /// ```rust,ignore
 584     /// let c_str = CString::new("foo").unwrap();
 585     /// unsafe {
 586     ///     call_some_ffi_func(c_str.as_ptr());
 587     /// }
 588     /// ```
 589     pub TEMPORARY_CSTRING_AS_PTR,
 590     correctness,
 591     "getting the inner pointer of a temporary `CString`"
 592 }
 593
 594 declare_clippy_lint! {
 595     /// **What it does:** Checks for use of `.iter().nth()` (and the related
 596     /// `.iter_mut().nth()`) on standard library types with O(1) element access.
 597     ///
 598     /// **Why is this bad?** `.get()` and `.get_mut()` are more efficient and more
 599     /// readable.
 600     ///
 601     /// **Known problems:** None.
 602     ///
 603     /// **Example:**
 604     /// ```rust
 605     /// let some_vec = vec![0, 1, 2, 3];
 606     /// let bad_vec = some_vec.iter().nth(3);
 607     /// let bad_slice = &some_vec[..].iter().nth(3);
 608     /// ```
 609     /// The correct use would be:
 610     /// ```rust
 611     /// let some_vec = vec![0, 1, 2, 3];
 612     /// let bad_vec = some_vec.get(3);
 613     /// let bad_slice = &some_vec[..].get(3);
 614     /// ```
 615     pub ITER_NTH,
 616     perf,
 617     "using `.iter().nth()` on a standard library type with O(1) element access"
 618 }
 619
 620 declare_clippy_lint! {
 621     /// **What it does:** Checks for use of `.skip(x).next()` on iterators.
 622     ///
 623     /// **Why is this bad?** `.nth(x)` is cleaner
 624     ///
 625     /// **Known problems:** None.
 626     ///
 627     /// **Example:**
 628     /// ```rust
 629     /// let some_vec = vec![0, 1, 2, 3];
 630     /// let bad_vec = some_vec.iter().skip(3).next();
 631     /// let bad_slice = &some_vec[..].iter().skip(3).next();
 632     /// ```
 633     /// The correct use would be:
 634     /// ```rust
 635     /// let some_vec = vec![0, 1, 2, 3];
 636     /// let bad_vec = some_vec.iter().nth(3);
 637     /// let bad_slice = &some_vec[..].iter().nth(3);
 638     /// ```
 639     pub ITER_SKIP_NEXT,
 640     style,
 641     "using `.skip(x).next()` on an iterator"
 642 }
 643
 644 declare_clippy_lint! {
 645     /// **What it does:** Checks for use of `.get().unwrap()` (or
 646     /// `.get_mut().unwrap`) on a standard library type which implements `Index`
 647     ///
 648     /// **Why is this bad?** Using the Index trait (`[]`) is more clear and more
 649     /// concise.
 650     ///
 651     /// **Known problems:** Not a replacement for error handling: Using either
 652     /// `.unwrap()` or the Index trait (`[]`) carries the risk of causing a `panic`
 653     /// if the value being accessed is `None`. If the use of `.get().unwrap()` is a
 654     /// temporary placeholder for dealing with the `Option` type, then this does
 655     /// not mitigate the need for error handling. If there is a chance that `.get()`
 656     /// will be `None` in your program, then it is advisable that the `None` case
 657     /// is handled in a future refactor instead of using `.unwrap()` or the Index
 658     /// trait.
 659     ///
 660     /// **Example:**
 661     /// ```rust
 662     /// let mut some_vec = vec![0, 1, 2, 3];
 663     /// let last = some_vec.get(3).unwrap();
 664     /// *some_vec.get_mut(0).unwrap() = 1;
 665     /// ```
 666     /// The correct use would be:
 667     /// ```rust
 668     /// let mut some_vec = vec![0, 1, 2, 3];
 669     /// let last = some_vec[3];
 670     /// some_vec[0] = 1;
 671     /// ```
 672     pub GET_UNWRAP,
 673     restriction,
 674     "using `.get().unwrap()` or `.get_mut().unwrap()` when using `[]` would work instead"
 675 }
 676
 677 declare_clippy_lint! {
 678     /// **What it does:** Checks for the use of `.extend(s.chars())` where s is a
 679     /// `&str` or `String`.
 680     ///
 681     /// **Why is this bad?** `.push_str(s)` is clearer
 682     ///
 683     /// **Known problems:** None.
 684     ///
 685     /// **Example:**
 686     /// ```rust
 687     /// let abc = "abc";
 688     /// let def = String::from("def");
 689     /// let mut s = String::new();
 690     /// s.extend(abc.chars());
 691     /// s.extend(def.chars());
 692     /// ```
 693     /// The correct use would be:
 694     /// ```rust
 695     /// let abc = "abc";
 696     /// let def = String::from("def");
 697     /// let mut s = String::new();
 698     /// s.push_str(abc);
 699     /// s.push_str(&def);
 700     /// ```
 701     pub STRING_EXTEND_CHARS,
 702     style,
 703     "using `x.extend(s.chars())` where s is a `&str` or `String`"
 704 }
 705
 706 declare_clippy_lint! {
 707     /// **What it does:** Checks for the use of `.cloned().collect()` on slice to
 708     /// create a `Vec`.
 709     ///
 710     /// **Why is this bad?** `.to_vec()` is clearer
 711     ///
 712     /// **Known problems:** None.
 713     ///
 714     /// **Example:**
 715     /// ```rust
 716     /// let s = [1, 2, 3, 4, 5];
 717     /// let s2: Vec<isize> = s[..].iter().cloned().collect();
 718     /// ```
 719     /// The better use would be:
 720     /// ```rust
 721     /// let s = [1, 2, 3, 4, 5];
 722     /// let s2: Vec<isize> = s.to_vec();
 723     /// ```
 724     pub ITER_CLONED_COLLECT,
 725     style,
 726     "using `.cloned().collect()` on slice to create a `Vec`"
 727 }
 728
 729 declare_clippy_lint! {
 730     /// **What it does:** Checks for usage of `.chars().last()` or
 731     /// `.chars().next_back()` on a `str` to check if it ends with a given char.
 732     ///
 733     /// **Why is this bad?** Readability, this can be written more concisely as
 734     /// `_.ends_with(_)`.
 735     ///
 736     /// **Known problems:** None.
 737     ///
 738     /// **Example:**
 739     /// ```ignore
 740     /// name.chars().last() == Some('_') || name.chars().next_back() == Some('-')
 741     /// ```
 742     pub CHARS_LAST_CMP,
 743     style,
 744     "using `.chars().last()` or `.chars().next_back()` to check if a string ends with a char"
 745 }
 746
 747 declare_clippy_lint! {
 748     /// **What it does:** Checks for usage of `.as_ref()` or `.as_mut()` where the
 749     /// types before and after the call are the same.
 750     ///
 751     /// **Why is this bad?** The call is unnecessary.
 752     ///
 753     /// **Known problems:** None.
 754     ///
 755     /// **Example:**
 756     /// ```rust
 757     /// # fn do_stuff(x: &[i32]) {}
 758     /// let x: &[i32] = &[1, 2, 3, 4, 5];
 759     /// do_stuff(x.as_ref());
 760     /// ```
 761     /// The correct use would be:
 762     /// ```rust
 763     /// # fn do_stuff(x: &[i32]) {}
 764     /// let x: &[i32] = &[1, 2, 3, 4, 5];
 765     /// do_stuff(x);
 766     /// ```
 767     pub USELESS_ASREF,
 768     complexity,
 769     "using `as_ref` where the types before and after the call are the same"
 770 }
 771
 772 declare_clippy_lint! {
 773     /// **What it does:** Checks for using `fold` when a more succinct alternative exists.
 774     /// Specifically, this checks for `fold`s which could be replaced by `any`, `all`,
 775     /// `sum` or `product`.
 776     ///
 777     /// **Why is this bad?** Readability.
 778     ///
 779     /// **Known problems:** False positive in pattern guards. Will be resolved once
 780     /// non-lexical lifetimes are stable.
 781     ///
 782     /// **Example:**
 783     /// ```rust
 784     /// let _ = (0..3).fold(false, |acc, x| acc || x > 2);
 785     /// ```
 786     /// This could be written as:
 787     /// ```rust
 788     /// let _ = (0..3).any(|x| x > 2);
 789     /// ```
 790     pub UNNECESSARY_FOLD,
 791     style,
 792     "using `fold` when a more succinct alternative exists"
 793 }
 794
 795 declare_clippy_lint! {
 796     /// **What it does:** Checks for `filter_map` calls which could be replaced by `filter` or `map`.
 797     /// More specifically it checks if the closure provided is only performing one of the
 798     /// filter or map operations and suggests the appropriate option.
 799     ///
 800     /// **Why is this bad?** Complexity. The intent is also clearer if only a single
 801     /// operation is being performed.
 802     ///
 803     /// **Known problems:** None
 804     ///
 805     /// **Example:**
 806     /// ```rust
 807     /// let _ = (0..3).filter_map(|x| if x > 2 { Some(x) } else { None });
 808     /// ```
 809     /// As there is no transformation of the argument this could be written as:
 810     /// ```rust
 811     /// let _ = (0..3).filter(|&x| x > 2);
 812     /// ```
 813     ///
 814     /// ```rust
 815     /// let _ = (0..4).filter_map(i32::checked_abs);
 816     /// ```
 817     /// As there is no conditional check on the argument this could be written as:
 818     /// ```rust
 819     /// let _ = (0..4).map(i32::checked_abs);
 820     /// ```
 821     pub UNNECESSARY_FILTER_MAP,
 822     complexity,
 823     "using `filter_map` when a more succinct alternative exists"
 824 }
 825
 826 declare_clippy_lint! {
 827     /// **What it does:** Checks for `into_iter` calls on types which should be replaced by `iter` or
 828     /// `iter_mut`.
 829     ///
 830     /// **Why is this bad?** Arrays and `PathBuf` do not yet have an `into_iter` method which move out
 831     /// their content into an iterator. Auto-referencing resolves the `into_iter` call to its reference
 832     /// instead, like `<&[T; N] as IntoIterator>::into_iter`, which just iterates over item references
 833     /// like calling `iter` would. Furthermore, when the standard library actually
 834     /// [implements the `into_iter` method](https://github.com/rust-lang/rust/issues/25725) which moves
 835     /// the content out of the array, the original use of `into_iter` got inferred with the wrong type
 836     /// and the code will be broken.
 837     ///
 838     /// **Known problems:** None
 839     ///
 840     /// **Example:**
 841     ///
 842     /// ```rust
 843     /// let _ = [1, 2, 3].into_iter().map(|x| *x).collect::<Vec<u32>>();
 844     /// ```
 845     pub INTO_ITER_ON_ARRAY,
 846     correctness,
 847     "using `.into_iter()` on an array"
 848 }
 849
 850 declare_clippy_lint! {
 851     /// **What it does:** Checks for `into_iter` calls on references which should be replaced by `iter`
 852     /// or `iter_mut`.
 853     ///
 854     /// **Why is this bad?** Readability. Calling `into_iter` on a reference will not move out its
 855     /// content into the resulting iterator, which is confusing. It is better just call `iter` or
 856     /// `iter_mut` directly.
 857     ///
 858     /// **Known problems:** None
 859     ///
 860     /// **Example:**
 861     ///
 862     /// ```rust
 863     /// let _ = (&vec![3, 4, 5]).into_iter();
 864     /// ```
 865     pub INTO_ITER_ON_REF,
 866     style,
 867     "using `.into_iter()` on a reference"
 868 }
 869
 870 declare_lint_pass!(Methods => [
 871     OPTION_UNWRAP_USED,
 872     RESULT_UNWRAP_USED,
 873     SHOULD_IMPLEMENT_TRAIT,
 874     WRONG_SELF_CONVENTION,
 875     WRONG_PUB_SELF_CONVENTION,
 876     OK_EXPECT,
 877     OPTION_MAP_UNWRAP_OR,
 878     OPTION_MAP_UNWRAP_OR_ELSE,
 879     RESULT_MAP_UNWRAP_OR_ELSE,
 880     OPTION_MAP_OR_NONE,
 881     OR_FUN_CALL,
 882     EXPECT_FUN_CALL,
 883     CHARS_NEXT_CMP,
 884     CHARS_LAST_CMP,
 885     CLONE_ON_COPY,
 886     CLONE_ON_REF_PTR,
 887     CLONE_DOUBLE_REF,
 888     NEW_RET_NO_SELF,
 889     SINGLE_CHAR_PATTERN,
 890     SEARCH_IS_SOME,
 891     TEMPORARY_CSTRING_AS_PTR,
 892     FILTER_NEXT,
 893     FILTER_MAP,
 894     FILTER_MAP_NEXT,
 895     FIND_MAP,
 896     MAP_FLATTEN,
 897     ITER_NTH,
 898     ITER_SKIP_NEXT,
 899     GET_UNWRAP,
 900     STRING_EXTEND_CHARS,
 901     ITER_CLONED_COLLECT,
 902     USELESS_ASREF,
 903     UNNECESSARY_FOLD,
 904     UNNECESSARY_FILTER_MAP,
 905     INTO_ITER_ON_ARRAY,
 906     INTO_ITER_ON_REF,
 907 ]);
 908
 909 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Methods {
 910     #[allow(clippy::cognitive_complexity)]
 911     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr) {
 912         if in_macro(expr.span) {
 913             return;
 914         }
 915
 916         let (method_names, arg_lists) = method_calls(expr, 2);
 917         let method_names: Vec<LocalInternedString> = method_names.iter().map(|s| s.as_str()).collect();
 918         let method_names: Vec<&str> = method_names.iter().map(std::convert::AsRef::as_ref).collect();
 919
 920         match method_names.as_slice() {
 921             ["unwrap", "get"] => lint_get_unwrap(cx, expr, arg_lists[1], false),
 922             ["unwrap", "get_mut"] => lint_get_unwrap(cx, expr, arg_lists[1], true),
 923             ["unwrap", ..] => lint_unwrap(cx, expr, arg_lists[0]),
 924             ["expect", "ok"] => lint_ok_expect(cx, expr, arg_lists[1]),
 925             ["unwrap_or", "map"] => option_map_unwrap_or::lint(cx, expr, arg_lists[1], arg_lists[0]),
 926             ["unwrap_or_else", "map"] => lint_map_unwrap_or_else(cx, expr, arg_lists[1], arg_lists[0]),
 927             ["map_or", ..] => lint_map_or_none(cx, expr, arg_lists[0]),
 928             ["next", "filter"] => lint_filter_next(cx, expr, arg_lists[1]),
 929             ["map", "filter"] => lint_filter_map(cx, expr, arg_lists[1], arg_lists[0]),
 930             ["map", "filter_map"] => lint_filter_map_map(cx, expr, arg_lists[1], arg_lists[0]),
 931             ["next", "filter_map"] => lint_filter_map_next(cx, expr, arg_lists[1]),
 932             ["map", "find"] => lint_find_map(cx, expr, arg_lists[1], arg_lists[0]),
 933             ["flat_map", "filter"] => lint_filter_flat_map(cx, expr, arg_lists[1], arg_lists[0]),
 934             ["flat_map", "filter_map"] => lint_filter_map_flat_map(cx, expr, arg_lists[1], arg_lists[0]),
 935             ["flatten", "map"] => lint_map_flatten(cx, expr, arg_lists[1]),
 936             ["is_some", "find"] => lint_search_is_some(cx, expr, "find", arg_lists[1], arg_lists[0]),
 937             ["is_some", "position"] => lint_search_is_some(cx, expr, "position", arg_lists[1], arg_lists[0]),
 938             ["is_some", "rposition"] => lint_search_is_some(cx, expr, "rposition", arg_lists[1], arg_lists[0]),
 939             ["extend", ..] => lint_extend(cx, expr, arg_lists[0]),
 940             ["as_ptr", "unwrap"] | ["as_ptr", "expect"] => {
 941                 lint_cstring_as_ptr(cx, expr, &arg_lists[1][0], &arg_lists[0][0])
 942             },
 943             ["nth", "iter"] => lint_iter_nth(cx, expr, arg_lists[1], false),
 944             ["nth", "iter_mut"] => lint_iter_nth(cx, expr, arg_lists[1], true),
 945             ["next", "skip"] => lint_iter_skip_next(cx, expr),
 946             ["collect", "cloned"] => lint_iter_cloned_collect(cx, expr, arg_lists[1]),
 947             ["as_ref"] => lint_asref(cx, expr, "as_ref", arg_lists[0]),
 948             ["as_mut"] => lint_asref(cx, expr, "as_mut", arg_lists[0]),
 949             ["fold", ..] => lint_unnecessary_fold(cx, expr, arg_lists[0]),
 950             ["filter_map", ..] => unnecessary_filter_map::lint(cx, expr, arg_lists[0]),
 951             _ => {},
 952         }
 953
 954         match expr.node {
 955             hir::ExprKind::MethodCall(ref method_call, ref method_span, ref args) => {
 956                 lint_or_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
 957                 lint_expect_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
 958
 959                 let self_ty = cx.tables.expr_ty_adjusted(&args[0]);
 960                 if args.len() == 1 && method_call.ident.name == sym!(clone) {
 961                     lint_clone_on_copy(cx, expr, &args[0], self_ty);
 962                     lint_clone_on_ref_ptr(cx, expr, &args[0]);
 963                 }
 964
 965                 match self_ty.sty {
 966                     ty::Ref(_, ty, _) if ty.sty == ty::Str => {
 967                         for &(method, pos) in &PATTERN_METHODS {
 968                             if method_call.ident.name.as_str() == method && args.len() > pos {
 969                                 lint_single_char_pattern(cx, expr, &args[pos]);
 970                             }
 971                         }
 972                     },
 973                     ty::Ref(..) if method_call.ident.name == sym!(into_iter) => {
 974                         lint_into_iter(cx, expr, self_ty, *method_span);
 975                     },
 976                     _ => (),
 977                 }
 978             },
 979             hir::ExprKind::Binary(op, ref lhs, ref rhs)
 980                 if op.node == hir::BinOpKind::Eq || op.node == hir::BinOpKind::Ne =>
 981             {
 982                 let mut info = BinaryExprInfo {
 983                     expr,
 984                     chain: lhs,
 985                     other: rhs,
 986                     eq: op.node == hir::BinOpKind::Eq,
 987                 };
 988                 lint_binary_expr_with_method_call(cx, &mut info);
 989             }
 990             _ => (),
 991         }
 992     }
 993
 994     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, implitem: &'tcx hir::ImplItem) {
 995         if in_external_macro(cx.sess(), implitem.span) {
 996             return;
 997         }
 998         let name = implitem.ident.name.as_str();
 999         let parent = cx.tcx.hir().get_parent_item(implitem.hir_id);
1000         let item = cx.tcx.hir().expect_item(parent);
1001         let def_id = cx.tcx.hir().local_def_id(item.hir_id);
1002         let ty = cx.tcx.type_of(def_id);
1003         if_chain! {
1004             if let hir::ImplItemKind::Method(ref sig, id) = implitem.node;
1005             if let Some(first_arg_ty) = sig.decl.inputs.get(0);
1006             if let Some(first_arg) = iter_input_pats(&sig.decl, cx.tcx.hir().body(id)).next();
1007             if let hir::ItemKind::Impl(_, _, _, _, None, ref self_ty, _) = item.node;
1008             then {
1009                 if cx.access_levels.is_exported(implitem.hir_id) {
1010                 // check missing trait implementations
1011                     for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
1012                         if name == method_name &&
1013                         sig.decl.inputs.len() == n_args &&
1014                         out_type.matches(cx, &sig.decl.output) &&
1015                         self_kind.matches(cx, first_arg_ty, first_arg, self_ty, false, &implitem.generics) {
1016                             span_lint(cx, SHOULD_IMPLEMENT_TRAIT, implitem.span, &format!(
1017                                 "defining a method called `{}` on this type; consider implementing \
1018                                 the `{}` trait or choosing a less ambiguous name", name, trait_name));
1019                         }
1020                     }
1021                 }
1022
1023                 // check conventions w.r.t. conversion method names and predicates
1024                 let is_copy = is_copy(cx, ty);
1025                 for &(ref conv, self_kinds) in &CONVENTIONS {
1026                     if conv.check(&name) {
1027                         if !self_kinds
1028                                 .iter()
1029                                 .any(|k| k.matches(cx, first_arg_ty, first_arg, self_ty, is_copy, &implitem.generics)) {
1030                             let lint = if item.vis.node.is_pub() {
1031                                 WRONG_PUB_SELF_CONVENTION
1032                             } else {
1033                                 WRONG_SELF_CONVENTION
1034                             };
1035                             span_lint(cx,
1036                                       lint,
1037                                       first_arg.pat.span,
1038                                       &format!("methods called `{}` usually take {}; consider choosing a less \
1039                                                 ambiguous name",
1040                                                conv,
1041                                                &self_kinds.iter()
1042                                                           .map(|k| k.description())
1043                                                           .collect::<Vec<_>>()
1044                                                           .join(" or ")));
1045                         }
1046
1047                         // Only check the first convention to match (CONVENTIONS should be listed from most to least
1048                         // specific)
1049                         break;
1050                     }
1051                 }
1052             }
1053         }
1054
1055         if let hir::ImplItemKind::Method(_, _) = implitem.node {
1056             let ret_ty = return_ty(cx, implitem.hir_id);
1057
1058             // walk the return type and check for Self (this does not check associated types)
1059             for inner_type in ret_ty.walk() {
1060                 if same_tys(cx, ty, inner_type) {
1061                     return;
1062                 }
1063             }
1064
1065             // if return type is impl trait, check the associated types
1066             if let ty::Opaque(def_id, _) = ret_ty.sty {
1067                 // one of the associated types must be Self
1068                 for predicate in &cx.tcx.predicates_of(def_id).predicates {
1069                     match predicate {
1070                         (Predicate::Projection(poly_projection_predicate), _) => {
1071                             let binder = poly_projection_predicate.ty();
1072                             let associated_type = binder.skip_binder();
1073
1074                             // walk the associated type and check for Self
1075                             for inner_type in associated_type.walk() {
1076                                 if same_tys(cx, ty, inner_type) {
1077                                     return;
1078                                 }
1079                             }
1080                         },
1081                         (_, _) => {},
1082                     }
1083                 }
1084             }
1085
1086             if name == "new" && !same_tys(cx, ret_ty, ty) {
1087                 span_lint(
1088                     cx,
1089                     NEW_RET_NO_SELF,
1090                     implitem.span,
1091                     "methods called `new` usually return `Self`",
1092                 );
1093             }
1094         }
1095     }
1096 }
1097
1098 /// Checks for the `OR_FUN_CALL` lint.
1099 #[allow(clippy::too_many_lines)]
1100 fn lint_or_fun_call<'a, 'tcx>(
1101     cx: &LateContext<'a, 'tcx>,
1102     expr: &hir::Expr,
1103     method_span: Span,
1104     name: &str,
1105     args: &'tcx [hir::Expr],
1106 ) {
1107     // Searches an expression for method calls or function calls that aren't ctors
1108     struct FunCallFinder<'a, 'tcx> {
1109         cx: &'a LateContext<'a, 'tcx>,
1110         found: bool,
1111     }
1112
1113     impl<'a, 'tcx> intravisit::Visitor<'tcx> for FunCallFinder<'a, 'tcx> {
1114         fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
1115             let call_found = match &expr.node {
1116                 // ignore enum and struct constructors
1117                 hir::ExprKind::Call(..) => !is_ctor_function(self.cx, expr),
1118                 hir::ExprKind::MethodCall(..) => true,
1119                 _ => false,
1120             };
1121
1122             if call_found {
1123                 // don't lint for constant values
1124                 let owner_def = self.cx.tcx.hir().get_parent_did(expr.hir_id);
1125                 let promotable = self
1126                     .cx
1127                     .tcx
1128                     .rvalue_promotable_map(owner_def)
1129                     .contains(&expr.hir_id.local_id);
1130                 if !promotable {
1131                     self.found |= true;
1132                 }
1133             }
1134
1135             if !self.found {
1136                 intravisit::walk_expr(self, expr);
1137             }
1138         }
1139
1140         fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
1141             intravisit::NestedVisitorMap::None
1142         }
1143     }
1144
1145     /// Checks for `unwrap_or(T::new())` or `unwrap_or(T::default())`.
1146     fn check_unwrap_or_default(
1147         cx: &LateContext<'_, '_>,
1148         name: &str,
1149         fun: &hir::Expr,
1150         self_expr: &hir::Expr,
1151         arg: &hir::Expr,
1152         or_has_args: bool,
1153         span: Span,
1154     ) -> bool {
1155         if or_has_args {
1156             return false;
1157         }
1158
1159         if name == "unwrap_or" {
1160             if let hir::ExprKind::Path(ref qpath) = fun.node {
1161                 let path = &*last_path_segment(qpath).ident.as_str();
1162
1163                 if ["default", "new"].contains(&path) {
1164                     let arg_ty = cx.tables.expr_ty(arg);
1165                     let default_trait_id = if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT) {
1166                         default_trait_id
1167                     } else {
1168                         return false;
1169                     };
1170
1171                     if implements_trait(cx, arg_ty, default_trait_id, &[]) {
1172                         let mut applicability = Applicability::MachineApplicable;
1173                         span_lint_and_sugg(
1174                             cx,
1175                             OR_FUN_CALL,
1176                             span,
1177                             &format!("use of `{}` followed by a call to `{}`", name, path),
1178                             "try this",
1179                             format!(
1180                                 "{}.unwrap_or_default()",
1181                                 snippet_with_applicability(cx, self_expr.span, "_", &mut applicability)
1182                             ),
1183                             applicability,
1184                         );
1185                         return true;
1186                     }
1187                 }
1188             }
1189         }
1190
1191         false
1192     }
1193
1194     /// Checks for `*or(foo())`.
1195     #[allow(clippy::too_many_arguments)]
1196     fn check_general_case<'a, 'tcx>(
1197         cx: &LateContext<'a, 'tcx>,
1198         name: &str,
1199         method_span: Span,
1200         fun_span: Span,
1201         self_expr: &hir::Expr,
1202         arg: &'tcx hir::Expr,
1203         or_has_args: bool,
1204         span: Span,
1205     ) {
1206         // (path, fn_has_argument, methods, suffix)
1207         let know_types: &[(&[_], _, &[_], _)] = &[
1208             (&paths::BTREEMAP_ENTRY, false, &["or_insert"], "with"),
1209             (&paths::HASHMAP_ENTRY, false, &["or_insert"], "with"),
1210             (&paths::OPTION, false, &["map_or", "ok_or", "or", "unwrap_or"], "else"),
1211             (&paths::RESULT, true, &["or", "unwrap_or"], "else"),
1212         ];
1213
1214         // early check if the name is one we care about
1215         if know_types.iter().all(|k| !k.2.contains(&name)) {
1216             return;
1217         }
1218
1219         let mut finder = FunCallFinder { cx: &cx, found: false };
1220         finder.visit_expr(&arg);
1221         if !finder.found {
1222             return;
1223         }
1224
1225         let self_ty = cx.tables.expr_ty(self_expr);
1226
1227         let (fn_has_arguments, poss, suffix) = if let Some(&(_, fn_has_arguments, poss, suffix)) =
1228             know_types.iter().find(|&&i| match_type(cx, self_ty, i.0))
1229         {
1230             (fn_has_arguments, poss, suffix)
1231         } else {
1232             return;
1233         };
1234
1235         if !poss.contains(&name) {
1236             return;
1237         }
1238
1239         let sugg: Cow<'_, _> = match (fn_has_arguments, !or_has_args) {
1240             (true, _) => format!("|_| {}", snippet_with_macro_callsite(cx, arg.span, "..")).into(),
1241             (false, false) => format!("|| {}", snippet_with_macro_callsite(cx, arg.span, "..")).into(),
1242             (false, true) => snippet_with_macro_callsite(cx, fun_span, ".."),
1243         };
1244         let span_replace_word = method_span.with_hi(span.hi());
1245         span_lint_and_sugg(
1246             cx,
1247             OR_FUN_CALL,
1248             span_replace_word,
1249             &format!("use of `{}` followed by a function call", name),
1250             "try this",
1251             format!("{}_{}({})", name, suffix, sugg),
1252             Applicability::HasPlaceholders,
1253         );
1254     }
1255
1256     if args.len() == 2 {
1257         match args[1].node {
1258             hir::ExprKind::Call(ref fun, ref or_args) => {
1259                 let or_has_args = !or_args.is_empty();
1260                 if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
1261                     check_general_case(
1262                         cx,
1263                         name,
1264                         method_span,
1265                         fun.span,
1266                         &args[0],
1267                         &args[1],
1268                         or_has_args,
1269                         expr.span,
1270                     );
1271                 }
1272             },
1273             hir::ExprKind::MethodCall(_, span, ref or_args) => check_general_case(
1274                 cx,
1275                 name,
1276                 method_span,
1277                 span,
1278                 &args[0],
1279                 &args[1],
1280                 !or_args.is_empty(),
1281                 expr.span,
1282             ),
1283             _ => {},
1284         }
1285     }
1286 }
1287
1288 /// Checks for the `EXPECT_FUN_CALL` lint.
1289 #[allow(clippy::too_many_lines)]
1290 fn lint_expect_fun_call(cx: &LateContext<'_, '_>, expr: &hir::Expr, method_span: Span, name: &str, args: &[hir::Expr]) {
1291     // Strip `&`, `as_ref()` and `as_str()` off `arg` until we're left with either a `String` or
1292     // `&str`
1293     fn get_arg_root<'a>(cx: &LateContext<'_, '_>, arg: &'a hir::Expr) -> &'a hir::Expr {
1294         let mut arg_root = arg;
1295         loop {
1296             arg_root = match &arg_root.node {
1297                 hir::ExprKind::AddrOf(_, expr) => expr,
1298                 hir::ExprKind::MethodCall(method_name, _, call_args) => {
1299                     if call_args.len() == 1
1300                         && (method_name.ident.name == sym!(as_str) || method_name.ident.name == sym!(as_ref))
1301                         && {
1302                             let arg_type = cx.tables.expr_ty(&call_args[0]);
1303                             let base_type = walk_ptrs_ty(arg_type);
1304                             base_type.sty == ty::Str || match_type(cx, base_type, &paths::STRING)
1305                         }
1306                     {
1307                         &call_args[0]
1308                     } else {
1309                         break;
1310                     }
1311                 },
1312                 _ => break,
1313             };
1314         }
1315         arg_root
1316     }
1317
1318     // Only `&'static str` or `String` can be used directly in the `panic!`. Other types should be
1319     // converted to string.
1320     fn requires_to_string(cx: &LateContext<'_, '_>, arg: &hir::Expr) -> bool {
1321         let arg_ty = cx.tables.expr_ty(arg);
1322         if match_type(cx, arg_ty, &paths::STRING) {
1323             return false;
1324         }
1325         if let ty::Ref(ty::ReStatic, ty, ..) = arg_ty.sty {
1326             if ty.sty == ty::Str {
1327                 return false;
1328             }
1329         };
1330         true
1331     }
1332
1333     fn generate_format_arg_snippet(
1334         cx: &LateContext<'_, '_>,
1335         a: &hir::Expr,
1336         applicability: &mut Applicability,
1337     ) -> Vec<String> {
1338         if let hir::ExprKind::AddrOf(_, ref format_arg) = a.node {
1339             if let hir::ExprKind::Match(ref format_arg_expr, _, _) = format_arg.node {
1340                 if let hir::ExprKind::Tup(ref format_arg_expr_tup) = format_arg_expr.node {
1341                     return format_arg_expr_tup
1342                         .iter()
1343                         .map(|a| snippet_with_applicability(cx, a.span, "..", applicability).into_owned())
1344                         .collect();
1345                 }
1346             }
1347         };
1348
1349         unreachable!()
1350     }
1351
1352     fn is_call(node: &hir::ExprKind) -> bool {
1353         match node {
1354             hir::ExprKind::AddrOf(_, expr) => {
1355                 is_call(&expr.node)
1356             },
1357             hir::ExprKind::Call(..)
1358             | hir::ExprKind::MethodCall(..)
1359             // These variants are debatable or require further examination
1360             | hir::ExprKind::Match(..)
1361             | hir::ExprKind::Block{ .. } => true,
1362             _ => false,
1363         }
1364     }
1365
1366     if args.len() != 2 || name != "expect" || !is_call(&args[1].node) {
1367         return;
1368     }
1369
1370     let receiver_type = cx.tables.expr_ty(&args[0]);
1371     let closure_args = if match_type(cx, receiver_type, &paths::OPTION) {
1372         "||"
1373     } else if match_type(cx, receiver_type, &paths::RESULT) {
1374         "|_|"
1375     } else {
1376         return;
1377     };
1378
1379     let arg_root = get_arg_root(cx, &args[1]);
1380
1381     let span_replace_word = method_span.with_hi(expr.span.hi());
1382
1383     let mut applicability = Applicability::MachineApplicable;
1384
1385     //Special handling for `format!` as arg_root
1386     if let hir::ExprKind::Call(ref inner_fun, ref inner_args) = arg_root.node {
1387         if is_expn_of(inner_fun.span, "format").is_some() && inner_args.len() == 1 {
1388             if let hir::ExprKind::Call(_, format_args) = &inner_args[0].node {
1389                 let fmt_spec = &format_args[0];
1390                 let fmt_args = &format_args[1];
1391
1392                 let mut args = vec![snippet(cx, fmt_spec.span, "..").into_owned()];
1393
1394                 args.extend(generate_format_arg_snippet(cx, fmt_args, &mut applicability));
1395
1396                 let sugg = args.join(", ");
1397
1398                 span_lint_and_sugg(
1399                     cx,
1400                     EXPECT_FUN_CALL,
1401                     span_replace_word,
1402                     &format!("use of `{}` followed by a function call", name),
1403                     "try this",
1404                     format!("unwrap_or_else({} panic!({}))", closure_args, sugg),
1405                     applicability,
1406                 );
1407
1408                 return;
1409             }
1410         }
1411     }
1412
1413     let mut arg_root_snippet: Cow<'_, _> = snippet_with_applicability(cx, arg_root.span, "..", &mut applicability);
1414     if requires_to_string(cx, arg_root) {
1415         arg_root_snippet.to_mut().push_str(".to_string()");
1416     }
1417
1418     span_lint_and_sugg(
1419         cx,
1420         EXPECT_FUN_CALL,
1421         span_replace_word,
1422         &format!("use of `{}` followed by a function call", name),
1423         "try this",
1424         format!("unwrap_or_else({} {{ panic!({}) }})", closure_args, arg_root_snippet),
1425         applicability,
1426     );
1427 }
1428
1429 /// Checks for the `CLONE_ON_COPY` lint.
1430 fn lint_clone_on_copy(cx: &LateContext<'_, '_>, expr: &hir::Expr, arg: &hir::Expr, arg_ty: Ty<'_>) {
1431     let ty = cx.tables.expr_ty(expr);
1432     if let ty::Ref(_, inner, _) = arg_ty.sty {
1433         if let ty::Ref(_, innermost, _) = inner.sty {
1434             span_lint_and_then(
1435                 cx,
1436                 CLONE_DOUBLE_REF,
1437                 expr.span,
1438                 "using `clone` on a double-reference; \
1439                  this will copy the reference instead of cloning the inner type",
1440                 |db| {
1441                     if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
1442                         let mut ty = innermost;
1443                         let mut n = 0;
1444                         while let ty::Ref(_, inner, _) = ty.sty {
1445                             ty = inner;
1446                             n += 1;
1447                         }
1448                         let refs: String = iter::repeat('&').take(n + 1).collect();
1449                         let derefs: String = iter::repeat('*').take(n).collect();
1450                         let explicit = format!("{}{}::clone({})", refs, ty, snip);
1451                         db.span_suggestion(
1452                             expr.span,
1453                             "try dereferencing it",
1454                             format!("{}({}{}).clone()", refs, derefs, snip.deref()),
1455                             Applicability::MaybeIncorrect,
1456                         );
1457                         db.span_suggestion(
1458                             expr.span,
1459                             "or try being explicit about what type to clone",
1460                             explicit,
1461                             Applicability::MaybeIncorrect,
1462                         );
1463                     }
1464                 },
1465             );
1466             return; // don't report clone_on_copy
1467         }
1468     }
1469
1470     if is_copy(cx, ty) {
1471         let snip;
1472         if let Some(snippet) = sugg::Sugg::hir_opt(cx, arg) {
1473             // x.clone() might have dereferenced x, possibly through Deref impls
1474             if cx.tables.expr_ty(arg) == ty {
1475                 snip = Some(("try removing the `clone` call", format!("{}", snippet)));
1476             } else {
1477                 let parent = cx.tcx.hir().get_parent_node(expr.hir_id);
1478                 match cx.tcx.hir().get(parent) {
1479                     hir::Node::Expr(parent) => match parent.node {
1480                         // &*x is a nop, &x.clone() is not
1481                         hir::ExprKind::AddrOf(..) |
1482                         // (*x).func() is useless, x.clone().func() can work in case func borrows mutably
1483                         hir::ExprKind::MethodCall(..) => return,
1484                         _ => {},
1485                     },
1486                     hir::Node::Stmt(stmt) => {
1487                         if let hir::StmtKind::Local(ref loc) = stmt.node {
1488                             if let hir::PatKind::Ref(..) = loc.pat.node {
1489                                 // let ref y = *x borrows x, let ref y = x.clone() does not
1490                                 return;
1491                             }
1492                         }
1493                     },
1494                     _ => {},
1495                 }
1496
1497                 let deref_count = cx
1498                     .tables
1499                     .expr_adjustments(arg)
1500                     .iter()
1501                     .filter(|adj| {
1502                         if let ty::adjustment::Adjust::Deref(_) = adj.kind {
1503                             true
1504                         } else {
1505                             false
1506                         }
1507                     })
1508                     .count();
1509                 let derefs: String = iter::repeat('*').take(deref_count).collect();
1510                 snip = Some(("try dereferencing it", format!("{}{}", derefs, snippet)));
1511             }
1512         } else {
1513             snip = None;
1514         }
1515         span_lint_and_then(cx, CLONE_ON_COPY, expr.span, "using `clone` on a `Copy` type", |db| {
1516             if let Some((text, snip)) = snip {
1517                 db.span_suggestion(expr.span, text, snip, Applicability::Unspecified);
1518             }
1519         });
1520     }
1521 }
1522
1523 fn lint_clone_on_ref_ptr(cx: &LateContext<'_, '_>, expr: &hir::Expr, arg: &hir::Expr) {
1524     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(arg));
1525
1526     if let ty::Adt(_, subst) = obj_ty.sty {
1527         let caller_type = if match_type(cx, obj_ty, &paths::RC) {
1528             "Rc"
1529         } else if match_type(cx, obj_ty, &paths::ARC) {
1530             "Arc"
1531         } else if match_type(cx, obj_ty, &paths::WEAK_RC) || match_type(cx, obj_ty, &paths::WEAK_ARC) {
1532             "Weak"
1533         } else {
1534             return;
1535         };
1536
1537         span_lint_and_sugg(
1538             cx,
1539             CLONE_ON_REF_PTR,
1540             expr.span,
1541             "using '.clone()' on a ref-counted pointer",
1542             "try this",
1543             format!(
1544                 "{}::<{}>::clone(&{})",
1545                 caller_type,
1546                 subst.type_at(0),
1547                 snippet(cx, arg.span, "_")
1548             ),
1549             Applicability::Unspecified, // Sometimes unnecessary ::<_> after Rc/Arc/Weak
1550         );
1551     }
1552 }
1553
1554 fn lint_string_extend(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
1555     let arg = &args[1];
1556     if let Some(arglists) = method_chain_args(arg, &["chars"]) {
1557         let target = &arglists[0][0];
1558         let self_ty = walk_ptrs_ty(cx.tables.expr_ty(target));
1559         let ref_str = if self_ty.sty == ty::Str {
1560             ""
1561         } else if match_type(cx, self_ty, &paths::STRING) {
1562             "&"
1563         } else {
1564             return;
1565         };
1566
1567         let mut applicability = Applicability::MachineApplicable;
1568         span_lint_and_sugg(
1569             cx,
1570             STRING_EXTEND_CHARS,
1571             expr.span,
1572             "calling `.extend(_.chars())`",
1573             "try this",
1574             format!(
1575                 "{}.push_str({}{})",
1576                 snippet_with_applicability(cx, args[0].span, "_", &mut applicability),
1577                 ref_str,
1578                 snippet_with_applicability(cx, target.span, "_", &mut applicability)
1579             ),
1580             applicability,
1581         );
1582     }
1583 }
1584
1585 fn lint_extend(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
1586     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(&args[0]));
1587     if match_type(cx, obj_ty, &paths::STRING) {
1588         lint_string_extend(cx, expr, args);
1589     }
1590 }
1591
1592 fn lint_cstring_as_ptr(cx: &LateContext<'_, '_>, expr: &hir::Expr, new: &hir::Expr, unwrap: &hir::Expr) {
1593     if_chain! {
1594         if let hir::ExprKind::Call(ref fun, ref args) = new.node;
1595         if args.len() == 1;
1596         if let hir::ExprKind::Path(ref path) = fun.node;
1597         if let Res::Def(DefKind::Method, did) = cx.tables.qpath_res(path, fun.hir_id);
1598         if match_def_path(cx, did, &paths::CSTRING_NEW);
1599         then {
1600             span_lint_and_then(
1601                 cx,
1602                 TEMPORARY_CSTRING_AS_PTR,
1603                 expr.span,
1604                 "you are getting the inner pointer of a temporary `CString`",
1605                 |db| {
1606                     db.note("that pointer will be invalid outside this expression");
1607                     db.span_help(unwrap.span, "assign the `CString` to a variable to extend its lifetime");
1608                 });
1609         }
1610     }
1611 }
1612
1613 fn lint_iter_cloned_collect<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, iter_args: &'tcx [hir::Expr]) {
1614     if match_type(cx, cx.tables.expr_ty(expr), &paths::VEC) {
1615         if let Some(slice) = derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0])) {
1616             if let Some(to_replace) = expr.span.trim_start(slice.span.source_callsite()) {
1617                 span_lint_and_sugg(
1618                     cx,
1619                     ITER_CLONED_COLLECT,
1620                     to_replace,
1621                     "called `iter().cloned().collect()` on a slice to create a `Vec`. Calling `to_vec()` is both faster and \
1622                      more readable",
1623                     "try",
1624                     ".to_vec()".to_string(),
1625                     Applicability::MachineApplicable,
1626                 );
1627             }
1628         }
1629     }
1630 }
1631
1632 fn lint_unnecessary_fold(cx: &LateContext<'_, '_>, expr: &hir::Expr, fold_args: &[hir::Expr]) {
1633     fn check_fold_with_op(
1634         cx: &LateContext<'_, '_>,
1635         fold_args: &[hir::Expr],
1636         op: hir::BinOpKind,
1637         replacement_method_name: &str,
1638         replacement_has_args: bool,
1639     ) {
1640         if_chain! {
1641             // Extract the body of the closure passed to fold
1642             if let hir::ExprKind::Closure(_, _, body_id, _, _) = fold_args[2].node;
1643             let closure_body = cx.tcx.hir().body(body_id);
1644             let closure_expr = remove_blocks(&closure_body.value);
1645
1646             // Check if the closure body is of the form `acc <op> some_expr(x)`
1647             if let hir::ExprKind::Binary(ref bin_op, ref left_expr, ref right_expr) = closure_expr.node;
1648             if bin_op.node == op;
1649
1650             // Extract the names of the two arguments to the closure
1651             if let Some(first_arg_ident) = get_arg_name(&closure_body.arguments[0].pat);
1652             if let Some(second_arg_ident) = get_arg_name(&closure_body.arguments[1].pat);
1653
1654             if match_var(&*left_expr, first_arg_ident);
1655             if replacement_has_args || match_var(&*right_expr, second_arg_ident);
1656
1657             then {
1658                 // Span containing `.fold(...)`
1659                 let next_point = cx.sess().source_map().next_point(fold_args[0].span);
1660                 let fold_span = next_point.with_hi(fold_args[2].span.hi() + BytePos(1));
1661
1662                 let mut applicability = Applicability::MachineApplicable;
1663                 let sugg = if replacement_has_args {
1664                     format!(
1665                         ".{replacement}(|{s}| {r})",
1666                         replacement = replacement_method_name,
1667                         s = second_arg_ident,
1668                         r = snippet_with_applicability(cx, right_expr.span, "EXPR", &mut applicability),
1669                     )
1670                 } else {
1671                     format!(
1672                         ".{replacement}()",
1673                         replacement = replacement_method_name,
1674                     )
1675                 };
1676
1677                 span_lint_and_sugg(
1678                     cx,
1679                     UNNECESSARY_FOLD,
1680                     fold_span,
1681                     // TODO #2371 don't suggest e.g., .any(|x| f(x)) if we can suggest .any(f)
1682                     "this `.fold` can be written more succinctly using another method",
1683                     "try",
1684                     sugg,
1685                     applicability,
1686                 );
1687             }
1688         }
1689     }
1690
1691     // Check that this is a call to Iterator::fold rather than just some function called fold
1692     if !match_trait_method(cx, expr, &paths::ITERATOR) {
1693         return;
1694     }
1695
1696     assert!(
1697         fold_args.len() == 3,
1698         "Expected fold_args to have three entries - the receiver, the initial value and the closure"
1699     );
1700
1701     // Check if the first argument to .fold is a suitable literal
1702     if let hir::ExprKind::Lit(ref lit) = fold_args[1].node {
1703         match lit.node {
1704             ast::LitKind::Bool(false) => check_fold_with_op(cx, fold_args, hir::BinOpKind::Or, "any", true),
1705             ast::LitKind::Bool(true) => check_fold_with_op(cx, fold_args, hir::BinOpKind::And, "all", true),
1706             ast::LitKind::Int(0, _) => check_fold_with_op(cx, fold_args, hir::BinOpKind::Add, "sum", false),
1707             ast::LitKind::Int(1, _) => check_fold_with_op(cx, fold_args, hir::BinOpKind::Mul, "product", false),
1708             _ => (),
1709         }
1710     }
1711 }
1712
1713 fn lint_iter_nth<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, iter_args: &'tcx [hir::Expr], is_mut: bool) {
1714     let mut_str = if is_mut { "_mut" } else { "" };
1715     let caller_type = if derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0])).is_some() {
1716         "slice"
1717     } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC) {
1718         "Vec"
1719     } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC_DEQUE) {
1720         "VecDeque"
1721     } else {
1722         return; // caller is not a type that we want to lint
1723     };
1724
1725     span_lint(
1726         cx,
1727         ITER_NTH,
1728         expr.span,
1729         &format!(
1730             "called `.iter{0}().nth()` on a {1}. Calling `.get{0}()` is both faster and more readable",
1731             mut_str, caller_type
1732         ),
1733     );
1734 }
1735
1736 fn lint_get_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, get_args: &'tcx [hir::Expr], is_mut: bool) {
1737     // Note: we don't want to lint `get_mut().unwrap` for HashMap or BTreeMap,
1738     // because they do not implement `IndexMut`
1739     let mut applicability = Applicability::MachineApplicable;
1740     let expr_ty = cx.tables.expr_ty(&get_args[0]);
1741     let get_args_str = if get_args.len() > 1 {
1742         snippet_with_applicability(cx, get_args[1].span, "_", &mut applicability)
1743     } else {
1744         return; // not linting on a .get().unwrap() chain or variant
1745     };
1746     let mut needs_ref;
1747     let caller_type = if derefs_to_slice(cx, &get_args[0], expr_ty).is_some() {
1748         needs_ref = get_args_str.parse::<usize>().is_ok();
1749         "slice"
1750     } else if match_type(cx, expr_ty, &paths::VEC) {
1751         needs_ref = get_args_str.parse::<usize>().is_ok();
1752         "Vec"
1753     } else if match_type(cx, expr_ty, &paths::VEC_DEQUE) {
1754         needs_ref = get_args_str.parse::<usize>().is_ok();
1755         "VecDeque"
1756     } else if !is_mut && match_type(cx, expr_ty, &paths::HASHMAP) {
1757         needs_ref = true;
1758         "HashMap"
1759     } else if !is_mut && match_type(cx, expr_ty, &paths::BTREEMAP) {
1760         needs_ref = true;
1761         "BTreeMap"
1762     } else {
1763         return; // caller is not a type that we want to lint
1764     };
1765
1766     let mut span = expr.span;
1767
1768     // Handle the case where the result is immediately dereferenced
1769     // by not requiring ref and pulling the dereference into the
1770     // suggestion.
1771     if_chain! {
1772         if needs_ref;
1773         if let Some(parent) = get_parent_expr(cx, expr);
1774         if let hir::ExprKind::Unary(hir::UnOp::UnDeref, _) = parent.node;
1775         then {
1776             needs_ref = false;
1777             span = parent.span;
1778         }
1779     }
1780
1781     let mut_str = if is_mut { "_mut" } else { "" };
1782     let borrow_str = if !needs_ref {
1783         ""
1784     } else if is_mut {
1785         "&mut "
1786     } else {
1787         "&"
1788     };
1789
1790     span_lint_and_sugg(
1791         cx,
1792         GET_UNWRAP,
1793         span,
1794         &format!(
1795             "called `.get{0}().unwrap()` on a {1}. Using `[]` is more clear and more concise",
1796             mut_str, caller_type
1797         ),
1798         "try this",
1799         format!(
1800             "{}{}[{}]",
1801             borrow_str,
1802             snippet_with_applicability(cx, get_args[0].span, "_", &mut applicability),
1803             get_args_str
1804         ),
1805         applicability,
1806     );
1807 }
1808
1809 fn lint_iter_skip_next(cx: &LateContext<'_, '_>, expr: &hir::Expr) {
1810     // lint if caller of skip is an Iterator
1811     if match_trait_method(cx, expr, &paths::ITERATOR) {
1812         span_lint(
1813             cx,
1814             ITER_SKIP_NEXT,
1815             expr.span,
1816             "called `skip(x).next()` on an iterator. This is more succinctly expressed by calling `nth(x)`",
1817         );
1818     }
1819 }
1820
1821 fn derefs_to_slice<'a, 'tcx>(
1822     cx: &LateContext<'a, 'tcx>,
1823     expr: &'tcx hir::Expr,
1824     ty: Ty<'tcx>,
1825 ) -> Option<&'tcx hir::Expr> {
1826     fn may_slice<'a>(cx: &LateContext<'_, 'a>, ty: Ty<'a>) -> bool {
1827         match ty.sty {
1828             ty::Slice(_) => true,
1829             ty::Adt(def, _) if def.is_box() => may_slice(cx, ty.boxed_ty()),
1830             ty::Adt(..) => match_type(cx, ty, &paths::VEC),
1831             ty::Array(_, size) => size.eval_usize(cx.tcx, cx.param_env) < 32,
1832             ty::Ref(_, inner, _) => may_slice(cx, inner),
1833             _ => false,
1834         }
1835     }
1836
1837     if let hir::ExprKind::MethodCall(ref path, _, ref args) = expr.node {
1838         if path.ident.name == sym!(iter) && may_slice(cx, cx.tables.expr_ty(&args[0])) {
1839             Some(&args[0])
1840         } else {
1841             None
1842         }
1843     } else {
1844         match ty.sty {
1845             ty::Slice(_) => Some(expr),
1846             ty::Adt(def, _) if def.is_box() && may_slice(cx, ty.boxed_ty()) => Some(expr),
1847             ty::Ref(_, inner, _) => {
1848                 if may_slice(cx, inner) {
1849                     Some(expr)
1850                 } else {
1851                     None
1852                 }
1853             },
1854             _ => None,
1855         }
1856     }
1857 }
1858
1859 /// lint use of `unwrap()` for `Option`s and `Result`s
1860 fn lint_unwrap(cx: &LateContext<'_, '_>, expr: &hir::Expr, unwrap_args: &[hir::Expr]) {
1861     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(&unwrap_args[0]));
1862
1863     let mess = if match_type(cx, obj_ty, &paths::OPTION) {
1864         Some((OPTION_UNWRAP_USED, "an Option", "None"))
1865     } else if match_type(cx, obj_ty, &paths::RESULT) {
1866         Some((RESULT_UNWRAP_USED, "a Result", "Err"))
1867     } else {
1868         None
1869     };
1870
1871     if let Some((lint, kind, none_value)) = mess {
1872         span_lint(
1873             cx,
1874             lint,
1875             expr.span,
1876             &format!(
1877                 "used unwrap() on {} value. If you don't want to handle the {} case gracefully, consider \
1878                  using expect() to provide a better panic \
1879                  message",
1880                 kind, none_value
1881             ),
1882         );
1883     }
1884 }
1885
1886 /// lint use of `ok().expect()` for `Result`s
1887 fn lint_ok_expect(cx: &LateContext<'_, '_>, expr: &hir::Expr, ok_args: &[hir::Expr]) {
1888     // lint if the caller of `ok()` is a `Result`
1889     if match_type(cx, cx.tables.expr_ty(&ok_args[0]), &paths::RESULT) {
1890         let result_type = cx.tables.expr_ty(&ok_args[0]);
1891         if let Some(error_type) = get_error_type(cx, result_type) {
1892             if has_debug_impl(error_type, cx) {
1893                 span_lint(
1894                     cx,
1895                     OK_EXPECT,
1896                     expr.span,
1897                     "called `ok().expect()` on a Result value. You can call `expect` directly on the `Result`",
1898                 );
1899             }
1900         }
1901     }
1902 }
1903
1904 /// lint use of `map().flatten()` for `Iterators`
1905 fn lint_map_flatten<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_args: &'tcx [hir::Expr]) {
1906     // lint if caller of `.map().flatten()` is an Iterator
1907     if match_trait_method(cx, expr, &paths::ITERATOR) {
1908         let msg = "called `map(..).flatten()` on an `Iterator`. \
1909                    This is more succinctly expressed by calling `.flat_map(..)`";
1910         let self_snippet = snippet(cx, map_args[0].span, "..");
1911         let func_snippet = snippet(cx, map_args[1].span, "..");
1912         let hint = format!("{0}.flat_map({1})", self_snippet, func_snippet);
1913         span_lint_and_then(cx, MAP_FLATTEN, expr.span, msg, |db| {
1914             db.span_suggestion(
1915                 expr.span,
1916                 "try using flat_map instead",
1917                 hint,
1918                 Applicability::MachineApplicable,
1919             );
1920         });
1921     }
1922 }
1923
1924 /// lint use of `map().unwrap_or_else()` for `Option`s and `Result`s
1925 fn lint_map_unwrap_or_else<'a, 'tcx>(
1926     cx: &LateContext<'a, 'tcx>,
1927     expr: &'tcx hir::Expr,
1928     map_args: &'tcx [hir::Expr],
1929     unwrap_args: &'tcx [hir::Expr],
1930 ) {
1931     // lint if the caller of `map()` is an `Option`
1932     let is_option = match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::OPTION);
1933     let is_result = match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::RESULT);
1934
1935     if is_option || is_result {
1936         // Don't make a suggestion that may fail to compile due to mutably borrowing
1937         // the same variable twice.
1938         let map_mutated_vars = mutated_variables(&map_args[0], cx);
1939         let unwrap_mutated_vars = mutated_variables(&unwrap_args[1], cx);
1940         if let (Some(map_mutated_vars), Some(unwrap_mutated_vars)) = (map_mutated_vars, unwrap_mutated_vars) {
1941             if map_mutated_vars.intersection(&unwrap_mutated_vars).next().is_some() {
1942                 return;
1943             }
1944         } else {
1945             return;
1946         }
1947
1948         // lint message
1949         let msg = if is_option {
1950             "called `map(f).unwrap_or_else(g)` on an Option value. This can be done more directly by calling \
1951              `map_or_else(g, f)` instead"
1952         } else {
1953             "called `map(f).unwrap_or_else(g)` on a Result value. This can be done more directly by calling \
1954              `ok().map_or_else(g, f)` instead"
1955         };
1956         // get snippets for args to map() and unwrap_or_else()
1957         let map_snippet = snippet(cx, map_args[1].span, "..");
1958         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
1959         // lint, with note if neither arg is > 1 line and both map() and
1960         // unwrap_or_else() have the same span
1961         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
1962         let same_span = map_args[1].span.ctxt() == unwrap_args[1].span.ctxt();
1963         if same_span && !multiline {
1964             span_note_and_lint(
1965                 cx,
1966                 if is_option {
1967                     OPTION_MAP_UNWRAP_OR_ELSE
1968                 } else {
1969                     RESULT_MAP_UNWRAP_OR_ELSE
1970                 },
1971                 expr.span,
1972                 msg,
1973                 expr.span,
1974                 &format!(
1975                     "replace `map({0}).unwrap_or_else({1})` with `{2}map_or_else({1}, {0})`",
1976                     map_snippet,
1977                     unwrap_snippet,
1978                     if is_result { "ok()." } else { "" }
1979                 ),
1980             );
1981         } else if same_span && multiline {
1982             span_lint(
1983                 cx,
1984                 if is_option {
1985                     OPTION_MAP_UNWRAP_OR_ELSE
1986                 } else {
1987                     RESULT_MAP_UNWRAP_OR_ELSE
1988                 },
1989                 expr.span,
1990                 msg,
1991             );
1992         };
1993     }
1994 }
1995
1996 /// lint use of `_.map_or(None, _)` for `Option`s
1997 fn lint_map_or_none<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_or_args: &'tcx [hir::Expr]) {
1998     if match_type(cx, cx.tables.expr_ty(&map_or_args[0]), &paths::OPTION) {
1999         // check if the first non-self argument to map_or() is None
2000         let map_or_arg_is_none = if let hir::ExprKind::Path(ref qpath) = map_or_args[1].node {
2001             match_qpath(qpath, &paths::OPTION_NONE)
2002         } else {
2003             false
2004         };
2005
2006         if map_or_arg_is_none {
2007             // lint message
2008             let msg = "called `map_or(None, f)` on an Option value. This can be done more directly by calling \
2009                        `and_then(f)` instead";
2010             let map_or_self_snippet = snippet(cx, map_or_args[0].span, "..");
2011             let map_or_func_snippet = snippet(cx, map_or_args[2].span, "..");
2012             let hint = format!("{0}.and_then({1})", map_or_self_snippet, map_or_func_snippet);
2013             span_lint_and_then(cx, OPTION_MAP_OR_NONE, expr.span, msg, |db| {
2014                 db.span_suggestion(
2015                     expr.span,
2016                     "try using and_then instead",
2017                     hint,
2018                     Applicability::MachineApplicable, // snippet
2019                 );
2020             });
2021         }
2022     }
2023 }
2024
2025 /// lint use of `filter().next()` for `Iterators`
2026 fn lint_filter_next<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, filter_args: &'tcx [hir::Expr]) {
2027     // lint if caller of `.filter().next()` is an Iterator
2028     if match_trait_method(cx, expr, &paths::ITERATOR) {
2029         let msg = "called `filter(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
2030                    `.find(p)` instead.";
2031         let filter_snippet = snippet(cx, filter_args[1].span, "..");
2032         if filter_snippet.lines().count() <= 1 {
2033             // add note if not multi-line
2034             span_note_and_lint(
2035                 cx,
2036                 FILTER_NEXT,
2037                 expr.span,
2038                 msg,
2039                 expr.span,
2040                 &format!("replace `filter({0}).next()` with `find({0})`", filter_snippet),
2041             );
2042         } else {
2043             span_lint(cx, FILTER_NEXT, expr.span, msg);
2044         }
2045     }
2046 }
2047
2048 /// lint use of `filter().map()` for `Iterators`
2049 fn lint_filter_map<'a, 'tcx>(
2050     cx: &LateContext<'a, 'tcx>,
2051     expr: &'tcx hir::Expr,
2052     _filter_args: &'tcx [hir::Expr],
2053     _map_args: &'tcx [hir::Expr],
2054 ) {
2055     // lint if caller of `.filter().map()` is an Iterator
2056     if match_trait_method(cx, expr, &paths::ITERATOR) {
2057         let msg = "called `filter(p).map(q)` on an `Iterator`. \
2058                    This is more succinctly expressed by calling `.filter_map(..)` instead.";
2059         span_lint(cx, FILTER_MAP, expr.span, msg);
2060     }
2061 }
2062
2063 /// lint use of `filter_map().next()` for `Iterators`
2064 fn lint_filter_map_next<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, filter_args: &'tcx [hir::Expr]) {
2065     if match_trait_method(cx, expr, &paths::ITERATOR) {
2066         let msg = "called `filter_map(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
2067                    `.find_map(p)` instead.";
2068         let filter_snippet = snippet(cx, filter_args[1].span, "..");
2069         if filter_snippet.lines().count() <= 1 {
2070             span_note_and_lint(
2071                 cx,
2072                 FILTER_MAP_NEXT,
2073                 expr.span,
2074                 msg,
2075                 expr.span,
2076                 &format!("replace `filter_map({0}).next()` with `find_map({0})`", filter_snippet),
2077             );
2078         } else {
2079             span_lint(cx, FILTER_MAP_NEXT, expr.span, msg);
2080         }
2081     }
2082 }
2083
2084 /// lint use of `find().map()` for `Iterators`
2085 fn lint_find_map<'a, 'tcx>(
2086     cx: &LateContext<'a, 'tcx>,
2087     expr: &'tcx hir::Expr,
2088     _find_args: &'tcx [hir::Expr],
2089     map_args: &'tcx [hir::Expr],
2090 ) {
2091     // lint if caller of `.filter().map()` is an Iterator
2092     if match_trait_method(cx, &map_args[0], &paths::ITERATOR) {
2093         let msg = "called `find(p).map(q)` on an `Iterator`. \
2094                    This is more succinctly expressed by calling `.find_map(..)` instead.";
2095         span_lint(cx, FIND_MAP, expr.span, msg);
2096     }
2097 }
2098
2099 /// lint use of `filter().map()` for `Iterators`
2100 fn lint_filter_map_map<'a, 'tcx>(
2101     cx: &LateContext<'a, 'tcx>,
2102     expr: &'tcx hir::Expr,
2103     _filter_args: &'tcx [hir::Expr],
2104     _map_args: &'tcx [hir::Expr],
2105 ) {
2106     // lint if caller of `.filter().map()` is an Iterator
2107     if match_trait_method(cx, expr, &paths::ITERATOR) {
2108         let msg = "called `filter_map(p).map(q)` on an `Iterator`. \
2109                    This is more succinctly expressed by only calling `.filter_map(..)` instead.";
2110         span_lint(cx, FILTER_MAP, expr.span, msg);
2111     }
2112 }
2113
2114 /// lint use of `filter().flat_map()` for `Iterators`
2115 fn lint_filter_flat_map<'a, 'tcx>(
2116     cx: &LateContext<'a, 'tcx>,
2117     expr: &'tcx hir::Expr,
2118     _filter_args: &'tcx [hir::Expr],
2119     _map_args: &'tcx [hir::Expr],
2120 ) {
2121     // lint if caller of `.filter().flat_map()` is an Iterator
2122     if match_trait_method(cx, expr, &paths::ITERATOR) {
2123         let msg = "called `filter(p).flat_map(q)` on an `Iterator`. \
2124                    This is more succinctly expressed by calling `.flat_map(..)` \
2125                    and filtering by returning an empty Iterator.";
2126         span_lint(cx, FILTER_MAP, expr.span, msg);
2127     }
2128 }
2129
2130 /// lint use of `filter_map().flat_map()` for `Iterators`
2131 fn lint_filter_map_flat_map<'a, 'tcx>(
2132     cx: &LateContext<'a, 'tcx>,
2133     expr: &'tcx hir::Expr,
2134     _filter_args: &'tcx [hir::Expr],
2135     _map_args: &'tcx [hir::Expr],
2136 ) {
2137     // lint if caller of `.filter_map().flat_map()` is an Iterator
2138     if match_trait_method(cx, expr, &paths::ITERATOR) {
2139         let msg = "called `filter_map(p).flat_map(q)` on an `Iterator`. \
2140                    This is more succinctly expressed by calling `.flat_map(..)` \
2141                    and filtering by returning an empty Iterator.";
2142         span_lint(cx, FILTER_MAP, expr.span, msg);
2143     }
2144 }
2145
2146 /// lint searching an Iterator followed by `is_some()`
2147 fn lint_search_is_some<'a, 'tcx>(
2148     cx: &LateContext<'a, 'tcx>,
2149     expr: &'tcx hir::Expr,
2150     search_method: &str,
2151     search_args: &'tcx [hir::Expr],
2152     is_some_args: &'tcx [hir::Expr],
2153 ) {
2154     // lint if caller of search is an Iterator
2155     if match_trait_method(cx, &is_some_args[0], &paths::ITERATOR) {
2156         let msg = format!(
2157             "called `is_some()` after searching an `Iterator` with {}. This is more succinctly \
2158              expressed by calling `any()`.",
2159             search_method
2160         );
2161         let search_snippet = snippet(cx, search_args[1].span, "..");
2162         if search_snippet.lines().count() <= 1 {
2163             // suggest `any(|x| ..)` instead of `any(|&x| ..)` for `find(|&x| ..).is_some()`
2164             let any_search_snippet = if_chain! {
2165                 if search_method == "find";
2166                 if let hir::ExprKind::Closure(_, _, body_id, ..) = search_args[1].node;
2167                 let closure_body = cx.tcx.hir().body(body_id);
2168                 if let Some(closure_arg) = closure_body.arguments.get(0);
2169                 if let hir::PatKind::Ref(..) = closure_arg.pat.node;
2170                 then {
2171                     Some(search_snippet.replacen('&', "", 1))
2172                 } else {
2173                     None
2174                 }
2175             };
2176             // add note if not multi-line
2177             span_note_and_lint(
2178                 cx,
2179                 SEARCH_IS_SOME,
2180                 expr.span,
2181                 &msg,
2182                 expr.span,
2183                 &format!(
2184                     "replace `{0}({1}).is_some()` with `any({2})`",
2185                     search_method,
2186                     search_snippet,
2187                     any_search_snippet.as_ref().map_or(&*search_snippet, String::as_str)
2188                 ),
2189             );
2190         } else {
2191             span_lint(cx, SEARCH_IS_SOME, expr.span, &msg);
2192         }
2193     }
2194 }
2195
2196 /// Used for `lint_binary_expr_with_method_call`.
2197 #[derive(Copy, Clone)]
2198 struct BinaryExprInfo<'a> {
2199     expr: &'a hir::Expr,
2200     chain: &'a hir::Expr,
2201     other: &'a hir::Expr,
2202     eq: bool,
2203 }
2204
2205 /// Checks for the `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints.
2206 fn lint_binary_expr_with_method_call(cx: &LateContext<'_, '_>, info: &mut BinaryExprInfo<'_>) {
2207     macro_rules! lint_with_both_lhs_and_rhs {
2208         ($func:ident, $cx:expr, $info:ident) => {
2209             if !$func($cx, $info) {
2210                 ::std::mem::swap(&mut $info.chain, &mut $info.other);
2211                 if $func($cx, $info) {
2212                     return;
2213                 }
2214             }
2215         };
2216     }
2217
2218     lint_with_both_lhs_and_rhs!(lint_chars_next_cmp, cx, info);
2219     lint_with_both_lhs_and_rhs!(lint_chars_last_cmp, cx, info);
2220     lint_with_both_lhs_and_rhs!(lint_chars_next_cmp_with_unwrap, cx, info);
2221     lint_with_both_lhs_and_rhs!(lint_chars_last_cmp_with_unwrap, cx, info);
2222 }
2223
2224 /// Wrapper fn for `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints.
2225 fn lint_chars_cmp(
2226     cx: &LateContext<'_, '_>,
2227     info: &BinaryExprInfo<'_>,
2228     chain_methods: &[&str],
2229     lint: &'static Lint,
2230     suggest: &str,
2231 ) -> bool {
2232     if_chain! {
2233         if let Some(args) = method_chain_args(info.chain, chain_methods);
2234         if let hir::ExprKind::Call(ref fun, ref arg_char) = info.other.node;
2235         if arg_char.len() == 1;
2236         if let hir::ExprKind::Path(ref qpath) = fun.node;
2237         if let Some(segment) = single_segment_path(qpath);
2238         if segment.ident.name == sym!(Some);
2239         then {
2240             let mut applicability = Applicability::MachineApplicable;
2241             let self_ty = walk_ptrs_ty(cx.tables.expr_ty_adjusted(&args[0][0]));
2242
2243             if self_ty.sty != ty::Str {
2244                 return false;
2245             }
2246
2247             span_lint_and_sugg(
2248                 cx,
2249                 lint,
2250                 info.expr.span,
2251                 &format!("you should use the `{}` method", suggest),
2252                 "like this",
2253                 format!("{}{}.{}({})",
2254                         if info.eq { "" } else { "!" },
2255                         snippet_with_applicability(cx, args[0][0].span, "_", &mut applicability),
2256                         suggest,
2257                         snippet_with_applicability(cx, arg_char[0].span, "_", &mut applicability)),
2258                 applicability,
2259             );
2260
2261             return true;
2262         }
2263     }
2264
2265     false
2266 }
2267
2268 /// Checks for the `CHARS_NEXT_CMP` lint.
2269 fn lint_chars_next_cmp<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2270     lint_chars_cmp(cx, info, &["chars", "next"], CHARS_NEXT_CMP, "starts_with")
2271 }
2272
2273 /// Checks for the `CHARS_LAST_CMP` lint.
2274 fn lint_chars_last_cmp<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2275     if lint_chars_cmp(cx, info, &["chars", "last"], CHARS_LAST_CMP, "ends_with") {
2276         true
2277     } else {
2278         lint_chars_cmp(cx, info, &["chars", "next_back"], CHARS_LAST_CMP, "ends_with")
2279     }
2280 }
2281
2282 /// Wrapper fn for `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints with `unwrap()`.
2283 fn lint_chars_cmp_with_unwrap<'a, 'tcx>(
2284     cx: &LateContext<'a, 'tcx>,
2285     info: &BinaryExprInfo<'_>,
2286     chain_methods: &[&str],
2287     lint: &'static Lint,
2288     suggest: &str,
2289 ) -> bool {
2290     if_chain! {
2291         if let Some(args) = method_chain_args(info.chain, chain_methods);
2292         if let hir::ExprKind::Lit(ref lit) = info.other.node;
2293         if let ast::LitKind::Char(c) = lit.node;
2294         then {
2295             let mut applicability = Applicability::MachineApplicable;
2296             span_lint_and_sugg(
2297                 cx,
2298                 lint,
2299                 info.expr.span,
2300                 &format!("you should use the `{}` method", suggest),
2301                 "like this",
2302                 format!("{}{}.{}('{}')",
2303                         if info.eq { "" } else { "!" },
2304                         snippet_with_applicability(cx, args[0][0].span, "_", &mut applicability),
2305                         suggest,
2306                         c),
2307                 applicability,
2308             );
2309
2310             return true;
2311         }
2312     }
2313
2314     false
2315 }
2316
2317 /// Checks for the `CHARS_NEXT_CMP` lint with `unwrap()`.
2318 fn lint_chars_next_cmp_with_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2319     lint_chars_cmp_with_unwrap(cx, info, &["chars", "next", "unwrap"], CHARS_NEXT_CMP, "starts_with")
2320 }
2321
2322 /// Checks for the `CHARS_LAST_CMP` lint with `unwrap()`.
2323 fn lint_chars_last_cmp_with_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2324     if lint_chars_cmp_with_unwrap(cx, info, &["chars", "last", "unwrap"], CHARS_LAST_CMP, "ends_with") {
2325         true
2326     } else {
2327         lint_chars_cmp_with_unwrap(cx, info, &["chars", "next_back", "unwrap"], CHARS_LAST_CMP, "ends_with")
2328     }
2329 }
2330
2331 /// lint for length-1 `str`s for methods in `PATTERN_METHODS`
2332 fn lint_single_char_pattern<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, _expr: &'tcx hir::Expr, arg: &'tcx hir::Expr) {
2333     if_chain! {
2334         if let hir::ExprKind::Lit(lit) = &arg.node;
2335         if let ast::LitKind::Str(r, style) = lit.node;
2336         if r.as_str().len() == 1;
2337         then {
2338             let mut applicability = Applicability::MachineApplicable;
2339             let snip = snippet_with_applicability(cx, arg.span, "..", &mut applicability);
2340             let ch = if let ast::StrStyle::Raw(nhash) = style {
2341                 let nhash = nhash as usize;
2342                 // for raw string: r##"a"##
2343                 &snip[(nhash + 2)..(snip.len() - 1 - nhash)]
2344             } else {
2345                 // for regular string: "a"
2346                 &snip[1..(snip.len() - 1)]
2347             };
2348             let hint = format!("'{}'", if ch == "'" { "\\'" } else { ch });
2349             span_lint_and_sugg(
2350                 cx,
2351                 SINGLE_CHAR_PATTERN,
2352                 arg.span,
2353                 "single-character string constant used as pattern",
2354                 "try using a char instead",
2355                 hint,
2356                 applicability,
2357             );
2358         }
2359     }
2360 }
2361
2362 /// Checks for the `USELESS_ASREF` lint.
2363 fn lint_asref(cx: &LateContext<'_, '_>, expr: &hir::Expr, call_name: &str, as_ref_args: &[hir::Expr]) {
2364     // when we get here, we've already checked that the call name is "as_ref" or "as_mut"
2365     // check if the call is to the actual `AsRef` or `AsMut` trait
2366     if match_trait_method(cx, expr, &paths::ASREF_TRAIT) || match_trait_method(cx, expr, &paths::ASMUT_TRAIT) {
2367         // check if the type after `as_ref` or `as_mut` is the same as before
2368         let recvr = &as_ref_args[0];
2369         let rcv_ty = cx.tables.expr_ty(recvr);
2370         let res_ty = cx.tables.expr_ty(expr);
2371         let (base_res_ty, res_depth) = walk_ptrs_ty_depth(res_ty);
2372         let (base_rcv_ty, rcv_depth) = walk_ptrs_ty_depth(rcv_ty);
2373         if base_rcv_ty == base_res_ty && rcv_depth >= res_depth {
2374             // allow the `as_ref` or `as_mut` if it is followed by another method call
2375             if_chain! {
2376                 if let Some(parent) = get_parent_expr(cx, expr);
2377                 if let hir::ExprKind::MethodCall(_, ref span, _) = parent.node;
2378                 if span != &expr.span;
2379                 then {
2380                     return;
2381                 }
2382             }
2383
2384             let mut applicability = Applicability::MachineApplicable;
2385             span_lint_and_sugg(
2386                 cx,
2387                 USELESS_ASREF,
2388                 expr.span,
2389                 &format!("this call to `{}` does nothing", call_name),
2390                 "try this",
2391                 snippet_with_applicability(cx, recvr.span, "_", &mut applicability).to_string(),
2392                 applicability,
2393             );
2394         }
2395     }
2396 }
2397
2398 fn ty_has_iter_method(
2399     cx: &LateContext<'_, '_>,
2400     self_ref_ty: Ty<'_>,
2401 ) -> Option<(&'static Lint, &'static str, &'static str)> {
2402     if let Some(ty_name) = has_iter_method(cx, self_ref_ty) {
2403         let lint = if ty_name == "array" || ty_name == "PathBuf" {
2404             INTO_ITER_ON_ARRAY
2405         } else {
2406             INTO_ITER_ON_REF
2407         };
2408         let mutbl = match self_ref_ty.sty {
2409             ty::Ref(_, _, mutbl) => mutbl,
2410             _ => unreachable!(),
2411         };
2412         let method_name = match mutbl {
2413             hir::MutImmutable => "iter",
2414             hir::MutMutable => "iter_mut",
2415         };
2416         Some((lint, ty_name, method_name))
2417     } else {
2418         None
2419     }
2420 }
2421
2422 fn lint_into_iter(cx: &LateContext<'_, '_>, expr: &hir::Expr, self_ref_ty: Ty<'_>, method_span: Span) {
2423     if !match_trait_method(cx, expr, &paths::INTO_ITERATOR) {
2424         return;
2425     }
2426     if let Some((lint, kind, method_name)) = ty_has_iter_method(cx, self_ref_ty) {
2427         span_lint_and_sugg(
2428             cx,
2429             lint,
2430             method_span,
2431             &format!(
2432                 "this .into_iter() call is equivalent to .{}() and will not move the {}",
2433                 method_name, kind,
2434             ),
2435             "call directly",
2436             method_name.to_string(),
2437             Applicability::MachineApplicable,
2438         );
2439     }
2440 }
2441
2442 /// Given a `Result<T, E>` type, return its error type (`E`).
2443 fn get_error_type<'a>(cx: &LateContext<'_, '_>, ty: Ty<'a>) -> Option<Ty<'a>> {
2444     if let ty::Adt(_, substs) = ty.sty {
2445         if match_type(cx, ty, &paths::RESULT) {
2446             substs.types().nth(1)
2447         } else {
2448             None
2449         }
2450     } else {
2451         None
2452     }
2453 }
2454
2455 /// This checks whether a given type is known to implement Debug.
2456 fn has_debug_impl<'a, 'b>(ty: Ty<'a>, cx: &LateContext<'b, 'a>) -> bool {
2457     match cx.tcx.lang_items().debug_trait() {
2458         Some(debug) => implements_trait(cx, ty, debug, &[]),
2459         None => false,
2460     }
2461 }
2462
2463 enum Convention {
2464     Eq(&'static str),
2465     StartsWith(&'static str),
2466 }
2467
2468 #[rustfmt::skip]
2469 const CONVENTIONS: [(Convention, &[SelfKind]); 7] = [
2470     (Convention::Eq("new"), &[SelfKind::No]),
2471     (Convention::StartsWith("as_"), &[SelfKind::Ref, SelfKind::RefMut]),
2472     (Convention::StartsWith("from_"), &[SelfKind::No]),
2473     (Convention::StartsWith("into_"), &[SelfKind::Value]),
2474     (Convention::StartsWith("is_"), &[SelfKind::Ref, SelfKind::No]),
2475     (Convention::Eq("to_mut"), &[SelfKind::RefMut]),
2476     (Convention::StartsWith("to_"), &[SelfKind::Ref]),
2477 ];
2478
2479 #[rustfmt::skip]
2480 const TRAIT_METHODS: [(&str, usize, SelfKind, OutType, &str); 30] = [
2481     ("add", 2, SelfKind::Value, OutType::Any, "std::ops::Add"),
2482     ("as_mut", 1, SelfKind::RefMut, OutType::Ref, "std::convert::AsMut"),
2483     ("as_ref", 1, SelfKind::Ref, OutType::Ref, "std::convert::AsRef"),
2484     ("bitand", 2, SelfKind::Value, OutType::Any, "std::ops::BitAnd"),
2485     ("bitor", 2, SelfKind::Value, OutType::Any, "std::ops::BitOr"),
2486     ("bitxor", 2, SelfKind::Value, OutType::Any, "std::ops::BitXor"),
2487     ("borrow", 1, SelfKind::Ref, OutType::Ref, "std::borrow::Borrow"),
2488     ("borrow_mut", 1, SelfKind::RefMut, OutType::Ref, "std::borrow::BorrowMut"),
2489     ("clone", 1, SelfKind::Ref, OutType::Any, "std::clone::Clone"),
2490     ("cmp", 2, SelfKind::Ref, OutType::Any, "std::cmp::Ord"),
2491     ("default", 0, SelfKind::No, OutType::Any, "std::default::Default"),
2492     ("deref", 1, SelfKind::Ref, OutType::Ref, "std::ops::Deref"),
2493     ("deref_mut", 1, SelfKind::RefMut, OutType::Ref, "std::ops::DerefMut"),
2494     ("div", 2, SelfKind::Value, OutType::Any, "std::ops::Div"),
2495     ("drop", 1, SelfKind::RefMut, OutType::Unit, "std::ops::Drop"),
2496     ("eq", 2, SelfKind::Ref, OutType::Bool, "std::cmp::PartialEq"),
2497     ("from_iter", 1, SelfKind::No, OutType::Any, "std::iter::FromIterator"),
2498     ("from_str", 1, SelfKind::No, OutType::Any, "std::str::FromStr"),
2499     ("hash", 2, SelfKind::Ref, OutType::Unit, "std::hash::Hash"),
2500     ("index", 2, SelfKind::Ref, OutType::Ref, "std::ops::Index"),
2501     ("index_mut", 2, SelfKind::RefMut, OutType::Ref, "std::ops::IndexMut"),
2502     ("into_iter", 1, SelfKind::Value, OutType::Any, "std::iter::IntoIterator"),
2503     ("mul", 2, SelfKind::Value, OutType::Any, "std::ops::Mul"),
2504     ("neg", 1, SelfKind::Value, OutType::Any, "std::ops::Neg"),
2505     ("next", 1, SelfKind::RefMut, OutType::Any, "std::iter::Iterator"),
2506     ("not", 1, SelfKind::Value, OutType::Any, "std::ops::Not"),
2507     ("rem", 2, SelfKind::Value, OutType::Any, "std::ops::Rem"),
2508     ("shl", 2, SelfKind::Value, OutType::Any, "std::ops::Shl"),
2509     ("shr", 2, SelfKind::Value, OutType::Any, "std::ops::Shr"),
2510     ("sub", 2, SelfKind::Value, OutType::Any, "std::ops::Sub"),
2511 ];
2512
2513 #[rustfmt::skip]
2514 const PATTERN_METHODS: [(&str, usize); 17] = [
2515     ("contains", 1),
2516     ("starts_with", 1),
2517     ("ends_with", 1),
2518     ("find", 1),
2519     ("rfind", 1),
2520     ("split", 1),
2521     ("rsplit", 1),
2522     ("split_terminator", 1),
2523     ("rsplit_terminator", 1),
2524     ("splitn", 2),
2525     ("rsplitn", 2),
2526     ("matches", 1),
2527     ("rmatches", 1),
2528     ("match_indices", 1),
2529     ("rmatch_indices", 1),
2530     ("trim_start_matches", 1),
2531     ("trim_end_matches", 1),
2532 ];
2533
2534 #[derive(Clone, Copy, PartialEq, Debug)]
2535 enum SelfKind {
2536     Value,
2537     Ref,
2538     RefMut,
2539     No,
2540 }
2541
2542 impl SelfKind {
2543     fn matches(
2544         self,
2545         cx: &LateContext<'_, '_>,
2546         ty: &hir::Ty,
2547         arg: &hir::Arg,
2548         self_ty: &hir::Ty,
2549         allow_value_for_ref: bool,
2550         generics: &hir::Generics,
2551     ) -> bool {
2552         // Self types in the HIR are desugared to explicit self types. So it will
2553         // always be `self:
2554         // SomeType`,
2555         // where SomeType can be `Self` or an explicit impl self type (e.g., `Foo` if
2556         // the impl is on `Foo`)
2557         // Thus, we only need to test equality against the impl self type or if it is
2558         // an explicit
2559         // `Self`. Furthermore, the only possible types for `self: ` are `&Self`,
2560         // `Self`, `&mut Self`,
2561         // and `Box<Self>`, including the equivalent types with `Foo`.
2562
2563         let is_actually_self = |ty| is_self_ty(ty) || SpanlessEq::new(cx).eq_ty(ty, self_ty);
2564         if is_self(arg) {
2565             match self {
2566                 Self::Value => is_actually_self(ty),
2567                 Self::Ref | Self::RefMut => {
2568                     if allow_value_for_ref && is_actually_self(ty) {
2569                         return true;
2570                     }
2571                     match ty.node {
2572                         hir::TyKind::Rptr(_, ref mt_ty) => {
2573                             let mutability_match = if self == Self::Ref {
2574                                 mt_ty.mutbl == hir::MutImmutable
2575                             } else {
2576                                 mt_ty.mutbl == hir::MutMutable
2577                             };
2578                             is_actually_self(&mt_ty.ty) && mutability_match
2579                         },
2580                         _ => false,
2581                     }
2582                 },
2583                 _ => false,
2584             }
2585         } else {
2586             match self {
2587                 Self::Value => false,
2588                 Self::Ref => is_as_ref_or_mut_trait(ty, self_ty, generics, &paths::ASREF_TRAIT),
2589                 Self::RefMut => is_as_ref_or_mut_trait(ty, self_ty, generics, &paths::ASMUT_TRAIT),
2590                 Self::No => true,
2591             }
2592         }
2593     }
2594
2595     fn description(self) -> &'static str {
2596         match self {
2597             Self::Value => "self by value",
2598             Self::Ref => "self by reference",
2599             Self::RefMut => "self by mutable reference",
2600             Self::No => "no self",
2601         }
2602     }
2603 }
2604
2605 fn is_as_ref_or_mut_trait(ty: &hir::Ty, self_ty: &hir::Ty, generics: &hir::Generics, name: &[&str]) -> bool {
2606     single_segment_ty(ty).map_or(false, |seg| {
2607         generics.params.iter().any(|param| match param.kind {
2608             hir::GenericParamKind::Type { .. } => {
2609                 param.name.ident().name == seg.ident.name
2610                     && param.bounds.iter().any(|bound| {
2611                         if let hir::GenericBound::Trait(ref ptr, ..) = *bound {
2612                             let path = &ptr.trait_ref.path;
2613                             match_path(path, name)
2614                                 && path.segments.last().map_or(false, |s| {
2615                                     if let Some(ref params) = s.args {
2616                                         if params.parenthesized {
2617                                             false
2618                                         } else {
2619                                             // FIXME(flip1995): messy, improve if there is a better option
2620                                             // in the compiler
2621                                             let types: Vec<_> = params
2622                                                 .args
2623                                                 .iter()
2624                                                 .filter_map(|arg| match arg {
2625                                                     hir::GenericArg::Type(ty) => Some(ty),
2626                                                     _ => None,
2627                                                 })
2628                                                 .collect();
2629                                             types.len() == 1 && (is_self_ty(&types[0]) || is_ty(&*types[0], self_ty))
2630                                         }
2631                                     } else {
2632                                         false
2633                                     }
2634                                 })
2635                         } else {
2636                             false
2637                         }
2638                     })
2639             },
2640             _ => false,
2641         })
2642     })
2643 }
2644
2645 fn is_ty(ty: &hir::Ty, self_ty: &hir::Ty) -> bool {
2646     match (&ty.node, &self_ty.node) {
2647         (
2648             &hir::TyKind::Path(hir::QPath::Resolved(_, ref ty_path)),
2649             &hir::TyKind::Path(hir::QPath::Resolved(_, ref self_ty_path)),
2650         ) => ty_path
2651             .segments
2652             .iter()
2653             .map(|seg| seg.ident.name)
2654             .eq(self_ty_path.segments.iter().map(|seg| seg.ident.name)),
2655         _ => false,
2656     }
2657 }
2658
2659 fn single_segment_ty(ty: &hir::Ty) -> Option<&hir::PathSegment> {
2660     if let hir::TyKind::Path(ref path) = ty.node {
2661         single_segment_path(path)
2662     } else {
2663         None
2664     }
2665 }
2666
2667 impl Convention {
2668     fn check(&self, other: &str) -> bool {
2669         match *self {
2670             Self::Eq(this) => this == other,
2671             Self::StartsWith(this) => other.starts_with(this) && this != other,
2672         }
2673     }
2674 }
2675
2676 impl fmt::Display for Convention {
2677     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
2678         match *self {
2679             Self::Eq(this) => this.fmt(f),
2680             Self::StartsWith(this) => this.fmt(f).and_then(|_| '*'.fmt(f)),
2681         }
2682     }
2683 }
2684
2685 #[derive(Clone, Copy)]
2686 enum OutType {
2687     Unit,
2688     Bool,
2689     Any,
2690     Ref,
2691 }
2692
2693 impl OutType {
2694     fn matches(self, cx: &LateContext<'_, '_>, ty: &hir::FunctionRetTy) -> bool {
2695         let is_unit = |ty: &hir::Ty| SpanlessEq::new(cx).eq_ty_kind(&ty.node, &hir::TyKind::Tup(vec![].into()));
2696         match (self, ty) {
2697             (Self::Unit, &hir::DefaultReturn(_)) => true,
2698             (Self::Unit, &hir::Return(ref ty)) if is_unit(ty) => true,
2699             (Self::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
2700             (Self::Any, &hir::Return(ref ty)) if !is_unit(ty) => true,
2701             (Self::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyKind::Rptr(_, _)),
2702             _ => false,
2703         }
2704     }
2705 }
2706
2707 fn is_bool(ty: &hir::Ty) -> bool {
2708     if let hir::TyKind::Path(ref p) = ty.node {
2709         match_qpath(p, &["bool"])
2710     } else {
2711         false
2712     }
2713 }