clippy_lints/src/methods.rs

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