clippy_lints/src/methods/mod.rs

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