clippy_lints/src/methods.rs

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