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