clippy_lints/src/methods/mod.rs

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