clippy_lints/src/methods.rs

   1 use rustc::hir;
   2 use rustc::lint::*;
   3 use rustc::middle::const_val::ConstVal;
   4 use rustc::middle::const_qualif::ConstQualif;
   5 use rustc::ty;
   6 use rustc_const_eval::EvalHint::ExprTypeChecked;
   7 use rustc_const_eval::eval_const_expr_partial;
   8 use std::borrow::Cow;
   9 use std::fmt;
  10 use syntax::codemap::Span;
  11 use syntax::ptr::P;
  12 use utils::{get_trait_def_id, implements_trait, in_external_macro, in_macro, is_copy, match_path,
  13             match_trait_method, match_type, method_chain_args, return_ty, same_tys, snippet,
  14             span_lint, span_lint_and_then, span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth};
  15 use utils::MethodArgs;
  16 use utils::paths;
  17 use utils::sugg;
  18
  19 #[derive(Clone)]
  20 pub struct Pass;
  21
  22 /// **What it does:** Checks for `.unwrap()` calls on `Option`s.
  23 ///
  24 /// **Why is this bad?** Usually it is better to handle the `None` case, or to
  25 /// at least call `.expect(_)` with a more helpful message. Still, for a lot of
  26 /// quick-and-dirty code, `unwrap` is a good choice, which is why this lint is
  27 /// `Allow` by default.
  28 ///
  29 /// **Known problems:** None.
  30 ///
  31 /// **Example:**
  32 /// ```rust
  33 /// x.unwrap()
  34 /// ```
  35 declare_lint! {
  36     pub OPTION_UNWRAP_USED,
  37     Allow,
  38     "using `Option.unwrap()`, which should at least get a better message using `expect()`"
  39 }
  40
  41 /// **What it does:** Checks for `.unwrap()` calls on `Result`s.
  42 ///
  43 /// **Why is this bad?** `result.unwrap()` will let the thread panic on `Err`
  44 /// values. Normally, you want to implement more sophisticated error handling,
  45 /// and propagate errors upwards with `try!`.
  46 ///
  47 /// Even if you want to panic on errors, not all `Error`s implement good
  48 /// messages on display.  Therefore it may be beneficial to look at the places
  49 /// where they may get displayed. Activate this lint to do just that.
  50 ///
  51 /// **Known problems:** None.
  52 ///
  53 /// **Example:**
  54 /// ```rust
  55 /// x.unwrap()
  56 /// ```
  57 declare_lint! {
  58     pub RESULT_UNWRAP_USED,
  59     Allow,
  60     "using `Result.unwrap()`, which might be better handled"
  61 }
  62
  63 /// **What it does:** Checks for methods that should live in a trait
  64 /// implementation of a `std` trait (see [llogiq's blog
  65 /// post](http://llogiq.github.io/2015/07/30/traits.html) for further
  66 /// information) instead of an inherent implementation.
  67 ///
  68 /// **Why is this bad?** Implementing the traits improve ergonomics for users of
  69 /// the code, often with very little cost. Also people seeing a `mul(...)` 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_lint! {
  83     pub SHOULD_IMPLEMENT_TRAIT,
  84     Warn,
  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_lint! {
 112     pub WRONG_SELF_CONVENTION,
 113     Warn,
 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_lint! {
 134     pub WRONG_PUB_SELF_CONVENTION,
 135     Allow,
 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:** None.
 146 ///
 147 /// **Example:**
 148 /// ```rust
 149 /// x.ok().expect("why did I do this again?")
 150 /// ```
 151 declare_lint! {
 152     pub OK_EXPECT,
 153     Warn,
 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:** None.
 164 ///
 165 /// **Example:**
 166 /// ```rust
 167 /// x.map(|a| a + 1).unwrap_or(0)
 168 /// ```
 169 declare_lint! {
 170     pub OPTION_MAP_UNWRAP_OR,
 171     Allow,
 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:** None.
 182 ///
 183 /// **Example:**
 184 /// ```rust
 185 /// x.map(|a| a + 1).unwrap_or_else(some_function)
 186 /// ```
 187 declare_lint! {
 188     pub OPTION_MAP_UNWRAP_OR_ELSE,
 189     Allow,
 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 `_.filter(_).next()`.
 195 ///
 196 /// **Why is this bad?** Readability, this can be written more concisely as
 197 /// `_.find(_)`.
 198 ///
 199 /// **Known problems:** None.
 200 ///
 201 /// **Example:**
 202 /// ```rust
 203 /// iter.filter(|x| x == 0).next()
 204 /// ```
 205 declare_lint! {
 206     pub FILTER_NEXT,
 207     Warn,
 208     "using `filter(p).next()`, which is more succinctly expressed as `.find(p)`"
 209 }
 210
 211 /// **What it does:** Checks for usage of `_.filter(_).map(_)`,
 212 /// `_.filter(_).flat_map(_)`, `_.filter_map(_).flat_map(_)` and similar.
 213 ///
 214 /// **Why is this bad?** Readability, this can be written more concisely as a
 215 /// single method call.
 216 ///
 217 /// **Known problems:** Often requires a condition + Option/Iterator creation
 218 /// inside the closure.
 219 ///
 220 /// **Example:**
 221 /// ```rust
 222 /// iter.filter(|x| x == 0).map(|x| x * 2)
 223 /// ```
 224 declare_lint! {
 225     pub FILTER_MAP,
 226     Allow,
 227     "using combinations of `filter`, `map`, `filter_map` and `flat_map` which can \
 228      usually be written as a single method call"
 229 }
 230
 231 /// **What it does:** Checks for an iterator search (such as `find()`,
 232 /// `position()`, or `rposition()`) followed by a call to `is_some()`.
 233 ///
 234 /// **Why is this bad?** Readability, this can be written more concisely as
 235 /// `_.any(_)`.
 236 ///
 237 /// **Known problems:** None.
 238 ///
 239 /// **Example:**
 240 /// ```rust
 241 /// iter.find(|x| x == 0).is_some()
 242 /// ```
 243 declare_lint! {
 244     pub SEARCH_IS_SOME,
 245     Warn,
 246     "using an iterator search followed by `is_some()`, which is more succinctly \
 247      expressed as a call to `any()`"
 248 }
 249
 250 /// **What it does:** Checks for usage of `.chars().next()` on a `str` to check
 251 /// if it starts with a given char.
 252 ///
 253 /// **Why is this bad?** Readability, this can be written more concisely as
 254 /// `_.starts_with(_)`.
 255 ///
 256 /// **Known problems:** None.
 257 ///
 258 /// **Example:**
 259 /// ```rust
 260 /// name.chars().next() == Some('_')
 261 /// ```
 262 declare_lint! {
 263     pub CHARS_NEXT_CMP,
 264     Warn,
 265     "using `.chars().next()` to check if a string starts with a char"
 266 }
 267
 268 /// **What it does:** Checks for calls to `.or(foo(..))`, `.unwrap_or(foo(..))`,
 269 /// etc., and suggests to use `or_else`, `unwrap_or_else`, etc., or
 270 /// `unwrap_or_default` instead.
 271 ///
 272 /// **Why is this bad?** The function will always be called and potentially
 273 /// allocate an object acting as the default.
 274 ///
 275 /// **Known problems:** If the function has side-effects, not calling it will
 276 /// change the semantic of the program, but you shouldn't rely on that anyway.
 277 ///
 278 /// **Example:**
 279 /// ```rust
 280 /// foo.unwrap_or(String::new())
 281 /// ```
 282 /// this can instead be written:
 283 /// ```rust
 284 /// foo.unwrap_or_else(String::new)
 285 /// ```
 286 /// or
 287 /// ```rust
 288 /// foo.unwrap_or_default()
 289 /// ```
 290 declare_lint! {
 291     pub OR_FUN_CALL,
 292     Warn,
 293     "using any `*or` method with a function call, which suggests `*or_else`"
 294 }
 295
 296 /// **What it does:** Checks for usage of `.extend(s)` on a `Vec` to extend the
 297 /// vector by a slice.
 298 ///
 299 /// **Why is this bad?** Since Rust 1.6, the `extend_from_slice(_)` method is
 300 /// stable and at least for now faster.
 301 ///
 302 /// **Known problems:** None.
 303 ///
 304 /// **Example:**
 305 /// ```rust
 306 /// my_vec.extend(&xs)
 307 /// ```
 308 declare_lint! {
 309     pub EXTEND_FROM_SLICE,
 310     Warn,
 311     "`.extend_from_slice(_)` is a faster way to extend a Vec by a slice"
 312 }
 313
 314 /// **What it does:** Checks for usage of `.clone()` on a `Copy` type.
 315 ///
 316 /// **Why is this bad?** The only reason `Copy` types implement `Clone` is for
 317 /// generics, not for using the `clone` method on a concrete type.
 318 ///
 319 /// **Known problems:** None.
 320 ///
 321 /// **Example:**
 322 /// ```rust
 323 /// 42u64.clone()
 324 /// ```
 325 declare_lint! {
 326     pub CLONE_ON_COPY,
 327     Warn,
 328     "using `clone` on a `Copy` type"
 329 }
 330
 331 /// **What it does:** Checks for usage of `.clone()` on an `&&T`.
 332 ///
 333 /// **Why is this bad?** Cloning an `&&T` copies the inner `&T`, instead of
 334 /// cloning the underlying `T`.
 335 ///
 336 /// **Known problems:** None.
 337 ///
 338 /// **Example:**
 339 /// ```rust
 340 /// fn main() {
 341 ///    let x = vec![1];
 342 ///    let y = &&x;
 343 ///    let z = y.clone();
 344 ///    println!("{:p} {:p}",*y, z); // prints out the same pointer
 345 /// }
 346 /// ```
 347 declare_lint! {
 348     pub CLONE_DOUBLE_REF,
 349     Warn,
 350     "using `clone` on `&&T`"
 351 }
 352
 353 /// **What it does:** Checks for `new` not returning `Self`.
 354 ///
 355 /// **Why is this bad?** As a convention, `new` methods are used to make a new
 356 /// instance of a type.
 357 ///
 358 /// **Known problems:** None.
 359 ///
 360 /// **Example:**
 361 /// ```rust
 362 /// impl Foo {
 363 ///     fn new(..) -> NotAFoo {
 364 ///     }
 365 /// }
 366 /// ```
 367 declare_lint! {
 368     pub NEW_RET_NO_SELF,
 369     Warn,
 370     "not returning `Self` in a `new` method"
 371 }
 372
 373 /// **What it does:** Checks for string methods that receive a single-character
 374 /// `str` as an argument, e.g. `_.split("x")`.
 375 ///
 376 /// **Why is this bad?** Performing these methods using a `char` is faster than
 377 /// using a `str`.
 378 ///
 379 /// **Known problems:** Does not catch multi-byte unicode characters.
 380 ///
 381 /// **Example:**
 382 /// `_.split("x")` could be `_.split('x')
 383 declare_lint! {
 384     pub SINGLE_CHAR_PATTERN,
 385     Warn,
 386     "using a single-character str where a char could be used, e.g. \
 387      `_.split(\"x\")`"
 388 }
 389
 390 /// **What it does:** Checks for getting the inner pointer of a temporary `CString`.
 391 ///
 392 /// **Why is this bad?** The inner pointer of a `CString` is only valid as long
 393 /// as the `CString` is alive.
 394 ///
 395 /// **Known problems:** None.
 396 ///
 397 /// **Example:**
 398 /// ```rust,ignore
 399 /// let c_str = CString::new("foo").unwrap().as_ptr();
 400 /// unsafe {
 401 /// call_some_ffi_func(c_str);
 402 /// }
 403 /// ```
 404 /// Here `c_str` point to a freed address. The correct use would be:
 405 /// ```rust,ignore
 406 /// let c_str = CString::new("foo").unwrap();
 407 /// unsafe {
 408 ///     call_some_ffi_func(c_str.as_ptr());
 409 /// }
 410 /// ```
 411 declare_lint! {
 412     pub TEMPORARY_CSTRING_AS_PTR,
 413     Warn,
 414     "getting the inner pointer of a temporary `CString`"
 415 }
 416
 417 /// **What it does:** Checks for use of `.iter().nth()` (and the related
 418 /// `.iter_mut().nth()`) on standard library types with O(1) element access.
 419 ///
 420 /// **Why is this bad?** `.get()` and `.get_mut()` are more efficient and more
 421 /// readable.
 422 ///
 423 /// **Known problems:** None.
 424 ///
 425 /// **Example:**
 426 /// ```rust
 427 /// let some_vec = vec![0, 1, 2, 3];
 428 /// let bad_vec = some_vec.iter().nth(3);
 429 /// let bad_slice = &some_vec[..].iter().nth(3);
 430 /// ```
 431 /// The correct use would be:
 432 /// ```rust
 433 /// let some_vec = vec![0, 1, 2, 3];
 434 /// let bad_vec = some_vec.get(3);
 435 /// let bad_slice = &some_vec[..].get(3);
 436 /// ```
 437 declare_lint! {
 438     pub ITER_NTH,
 439     Warn,
 440     "using `.iter().nth()` on a standard library type with O(1) element access"
 441 }
 442
 443 /// **What it does:** Checks for use of `.skip(x).next()` on iterators.
 444 ///
 445 /// **Why is this bad?** `.nth(x)` is cleaner
 446 ///
 447 /// **Known problems:** None.
 448 ///
 449 /// **Example:**
 450 /// ```rust
 451 /// let some_vec = vec![0, 1, 2, 3];
 452 /// let bad_vec = some_vec.iter().skip(3).next();
 453 /// let bad_slice = &some_vec[..].iter().skip(3).next();
 454 /// ```
 455 /// The correct use would be:
 456 /// ```rust
 457 /// let some_vec = vec![0, 1, 2, 3];
 458 /// let bad_vec = some_vec.iter().nth(3);
 459 /// let bad_slice = &some_vec[..].iter().nth(3);
 460 /// ```
 461 declare_lint! {
 462     pub ITER_SKIP_NEXT,
 463     Warn,
 464     "using `.skip(x).next()` on an iterator"
 465 }
 466
 467
 468 impl LintPass for Pass {
 469     fn get_lints(&self) -> LintArray {
 470         lint_array!(EXTEND_FROM_SLICE,
 471                     OPTION_UNWRAP_USED,
 472                     RESULT_UNWRAP_USED,
 473                     SHOULD_IMPLEMENT_TRAIT,
 474                     WRONG_SELF_CONVENTION,
 475                     WRONG_PUB_SELF_CONVENTION,
 476                     OK_EXPECT,
 477                     OPTION_MAP_UNWRAP_OR,
 478                     OPTION_MAP_UNWRAP_OR_ELSE,
 479                     OR_FUN_CALL,
 480                     CHARS_NEXT_CMP,
 481                     CLONE_ON_COPY,
 482                     CLONE_DOUBLE_REF,
 483                     NEW_RET_NO_SELF,
 484                     SINGLE_CHAR_PATTERN,
 485                     SEARCH_IS_SOME,
 486                     TEMPORARY_CSTRING_AS_PTR,
 487                     FILTER_NEXT,
 488                     FILTER_MAP,
 489                     ITER_NTH,
 490                     ITER_SKIP_NEXT)
 491     }
 492 }
 493
 494 impl LateLintPass for Pass {
 495     fn check_expr(&mut self, cx: &LateContext, expr: &hir::Expr) {
 496         if in_macro(cx, expr.span) {
 497             return;
 498         }
 499
 500         match expr.node {
 501             hir::ExprMethodCall(name, _, ref args) => {
 502                 // Chain calls
 503                 if let Some(arglists) = method_chain_args(expr, &["unwrap"]) {
 504                     lint_unwrap(cx, expr, arglists[0]);
 505                 } else if let Some(arglists) = method_chain_args(expr, &["ok", "expect"]) {
 506                     lint_ok_expect(cx, expr, arglists[0]);
 507                 } else if let Some(arglists) = method_chain_args(expr, &["map", "unwrap_or"]) {
 508                     lint_map_unwrap_or(cx, expr, arglists[0], arglists[1]);
 509                 } else if let Some(arglists) = method_chain_args(expr, &["map", "unwrap_or_else"]) {
 510                     lint_map_unwrap_or_else(cx, expr, arglists[0], arglists[1]);
 511                 } else if let Some(arglists) = method_chain_args(expr, &["filter", "next"]) {
 512                     lint_filter_next(cx, expr, arglists[0]);
 513                 } else if let Some(arglists) = method_chain_args(expr, &["filter", "map"]) {
 514                     lint_filter_map(cx, expr, arglists[0], arglists[1]);
 515                 } else if let Some(arglists) = method_chain_args(expr, &["filter_map", "map"]) {
 516                     lint_filter_map_map(cx, expr, arglists[0], arglists[1]);
 517                 } else if let Some(arglists) = method_chain_args(expr, &["filter", "flat_map"]) {
 518                     lint_filter_flat_map(cx, expr, arglists[0], arglists[1]);
 519                 } else if let Some(arglists) = method_chain_args(expr, &["filter_map", "flat_map"]) {
 520                     lint_filter_map_flat_map(cx, expr, arglists[0], arglists[1]);
 521                 } else if let Some(arglists) = method_chain_args(expr, &["find", "is_some"]) {
 522                     lint_search_is_some(cx, expr, "find", arglists[0], arglists[1]);
 523                 } else if let Some(arglists) = method_chain_args(expr, &["position", "is_some"]) {
 524                     lint_search_is_some(cx, expr, "position", arglists[0], arglists[1]);
 525                 } else if let Some(arglists) = method_chain_args(expr, &["rposition", "is_some"]) {
 526                     lint_search_is_some(cx, expr, "rposition", arglists[0], arglists[1]);
 527                 } else if let Some(arglists) = method_chain_args(expr, &["extend"]) {
 528                     lint_extend(cx, expr, arglists[0]);
 529                 } else if let Some(arglists) = method_chain_args(expr, &["unwrap", "as_ptr"]) {
 530                     lint_cstring_as_ptr(cx, expr, &arglists[0][0], &arglists[1][0]);
 531                 } else if let Some(arglists) = method_chain_args(expr, &["iter", "nth"]) {
 532                     lint_iter_nth(cx, expr, arglists[0], false);
 533                 } else if let Some(arglists) = method_chain_args(expr, &["iter_mut", "nth"]) {
 534                     lint_iter_nth(cx, expr, arglists[0], true);
 535                 } else if method_chain_args(expr, &["skip", "next"]).is_some() {
 536                     lint_iter_skip_next(cx, expr);
 537                 }
 538
 539                 lint_or_fun_call(cx, expr, &name.node.as_str(), args);
 540
 541                 let self_ty = cx.tcx.expr_ty_adjusted(&args[0]);
 542                 if args.len() == 1 && name.node.as_str() == "clone" {
 543                     lint_clone_on_copy(cx, expr, &args[0], self_ty);
 544                 }
 545
 546                 match self_ty.sty {
 547                     ty::TyRef(_, ty) if ty.ty.sty == ty::TyStr => {
 548                         for &(method, pos) in &PATTERN_METHODS {
 549                             if name.node.as_str() == method && args.len() > pos {
 550                                 lint_single_char_pattern(cx, expr, &args[pos]);
 551                             }
 552                         }
 553                     }
 554                     _ => (),
 555                 }
 556             }
 557             hir::ExprBinary(op, ref lhs, ref rhs) if op.node == hir::BiEq || op.node == hir::BiNe => {
 558                 if !lint_chars_next(cx, expr, lhs, rhs, op.node == hir::BiEq) {
 559                     lint_chars_next(cx, expr, rhs, lhs, op.node == hir::BiEq);
 560                 }
 561             }
 562             _ => (),
 563         }
 564     }
 565
 566     fn check_impl_item(&mut self, cx: &LateContext, implitem: &hir::ImplItem) {
 567         if in_external_macro(cx, implitem.span) {
 568             return;
 569         }
 570         let name = implitem.name;
 571         let parent = cx.tcx.map.get_parent(implitem.id);
 572         let item = cx.tcx.map.expect_item(parent);
 573         if_let_chain! {[
 574             let hir::ImplItemKind::Method(ref sig, _) = implitem.node,
 575             let Some(explicit_self) = sig.decl.inputs.get(0).and_then(hir::Arg::to_self),
 576             let hir::ItemImpl(_, _, _, None, _, _) = item.node,
 577         ], {
 578             // check missing trait implementations
 579             for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
 580                 if name.as_str() == method_name &&
 581                    sig.decl.inputs.len() == n_args &&
 582                    out_type.matches(&sig.decl.output) &&
 583                    self_kind.matches(&explicit_self, false) {
 584                     span_lint(cx, SHOULD_IMPLEMENT_TRAIT, implitem.span, &format!(
 585                         "defining a method called `{}` on this type; consider implementing \
 586                          the `{}` trait or choosing a less ambiguous name", name, trait_name));
 587                 }
 588             }
 589
 590             // check conventions w.r.t. conversion method names and predicates
 591             let ty = cx.tcx.lookup_item_type(cx.tcx.map.local_def_id(item.id)).ty;
 592             let is_copy = is_copy(cx, ty, item.id);
 593             for &(ref conv, self_kinds) in &CONVENTIONS {
 594                 if_let_chain! {[
 595                     conv.check(&name.as_str()),
 596                     let Some(explicit_self) = sig.decl.inputs.get(0).and_then(hir::Arg::to_self),
 597                     !self_kinds.iter().any(|k| k.matches(&explicit_self, is_copy)),
 598                 ], {
 599                     let lint = if item.vis == hir::Visibility::Public {
 600                         WRONG_PUB_SELF_CONVENTION
 601                     } else {
 602                         WRONG_SELF_CONVENTION
 603                     };
 604                     span_lint(cx,
 605                               lint,
 606                               explicit_self.span,
 607                               &format!("methods called `{}` usually take {}; consider choosing a less \
 608                                         ambiguous name",
 609                                        conv,
 610                                        &self_kinds.iter()
 611                                                   .map(|k| k.description())
 612                                                   .collect::<Vec<_>>()
 613                                                   .join(" or ")));
 614                 }}
 615             }
 616
 617             let ret_ty = return_ty(cx, implitem.id);
 618             if &name.as_str() == &"new" &&
 619                !ret_ty.walk().any(|t| same_tys(cx, t, ty, implitem.id)) {
 620                 span_lint(cx,
 621                           NEW_RET_NO_SELF,
 622                           explicit_self.span,
 623                           "methods called `new` usually return `Self`");
 624             }
 625         }}
 626     }
 627 }
 628
 629 /// Checks for the `OR_FUN_CALL` lint.
 630 fn lint_or_fun_call(cx: &LateContext, expr: &hir::Expr, name: &str, args: &[P<hir::Expr>]) {
 631     /// Check for `unwrap_or(T::new())` or `unwrap_or(T::default())`.
 632     fn check_unwrap_or_default(cx: &LateContext, name: &str, fun: &hir::Expr, self_expr: &hir::Expr, arg: &hir::Expr,
 633                                or_has_args: bool, span: Span)
 634                                -> bool {
 635         if or_has_args {
 636             return false;
 637         }
 638
 639         if name == "unwrap_or" {
 640             if let hir::ExprPath(_, ref path) = fun.node {
 641                 let path: &str = &path.segments
 642                                       .last()
 643                                       .expect("A path must have at least one segment")
 644                                       .name
 645                                       .as_str();
 646
 647                 if ["default", "new"].contains(&path) {
 648                     let arg_ty = cx.tcx.expr_ty(arg);
 649                     let default_trait_id = if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT) {
 650                         default_trait_id
 651                     } else {
 652                         return false;
 653                     };
 654
 655                     if implements_trait(cx, arg_ty, default_trait_id, Vec::new()) {
 656                         span_lint_and_then(cx,
 657                                   OR_FUN_CALL,
 658                                   span,
 659                                   &format!("use of `{}` followed by a call to `{}`", name, path),
 660                                   |db| {
 661                                       db.span_suggestion(span, "try this",
 662                                                           format!("{}.unwrap_or_default()", snippet(cx, self_expr.span, "_")));
 663                                   });
 664                         return true;
 665                     }
 666                 }
 667             }
 668         }
 669
 670         false
 671     }
 672
 673     /// Check for `*or(foo())`.
 674     fn check_general_case(cx: &LateContext, name: &str, fun: &hir::Expr, self_expr: &hir::Expr, arg: &hir::Expr, or_has_args: bool,
 675                           span: Span) {
 676         // don't lint for constant values
 677         // FIXME: can we `expect` here instead of match?
 678         if let Some(qualif) = cx.tcx.const_qualif_map.borrow().get(&arg.id) {
 679             if !qualif.contains(ConstQualif::NOT_CONST) {
 680                 return;
 681             }
 682         }
 683         // (path, fn_has_argument, methods, suffix)
 684         let know_types: &[(&[_], _, &[_], _)] = &[(&paths::BTREEMAP_ENTRY, false, &["or_insert"], "with"),
 685                                                   (&paths::HASHMAP_ENTRY, false, &["or_insert"], "with"),
 686                                                   (&paths::OPTION,
 687                                                    false,
 688                                                    &["map_or", "ok_or", "or", "unwrap_or"],
 689                                                    "else"),
 690                                                   (&paths::RESULT, true, &["or", "unwrap_or"], "else")];
 691
 692         let self_ty = cx.tcx.expr_ty(self_expr);
 693
 694         let (fn_has_arguments, poss, suffix) = if let Some(&(_, fn_has_arguments, poss, suffix)) =
 695                                                       know_types.iter().find(|&&i| match_type(cx, self_ty, i.0)) {
 696             (fn_has_arguments, poss, suffix)
 697         } else {
 698             return;
 699         };
 700
 701         if !poss.contains(&name) {
 702             return;
 703         }
 704
 705         let sugg: Cow<_> = match (fn_has_arguments, !or_has_args) {
 706             (true, _) => format!("|_| {}", snippet(cx, arg.span, "..")).into(),
 707             (false, false) => format!("|| {}", snippet(cx, arg.span, "..")).into(),
 708             (false, true) => snippet(cx, fun.span, ".."),
 709         };
 710
 711         span_lint_and_then(cx, OR_FUN_CALL, span, &format!("use of `{}` followed by a function call", name), |db| {
 712             db.span_suggestion(span,
 713                                "try this",
 714                                format!("{}.{}_{}({})", snippet(cx, self_expr.span, "_"), name, suffix, sugg));
 715         });
 716     }
 717
 718     if args.len() == 2 {
 719         if let hir::ExprCall(ref fun, ref or_args) = args[1].node {
 720             let or_has_args = !or_args.is_empty();
 721             if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
 722                 check_general_case(cx, name, fun, &args[0], &args[1], or_has_args, expr.span);
 723             }
 724         }
 725     }
 726 }
 727
 728 /// Checks for the `CLONE_ON_COPY` lint.
 729 fn lint_clone_on_copy(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr, arg_ty: ty::Ty) {
 730     let ty = cx.tcx.expr_ty(expr);
 731     let parent = cx.tcx.map.get_parent(expr.id);
 732     let parameter_environment = ty::ParameterEnvironment::for_item(cx.tcx, parent);
 733     if let ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) = arg_ty.sty {
 734         if let ty::TyRef(..) = inner.sty {
 735             span_lint_and_then(cx,
 736                                CLONE_DOUBLE_REF,
 737                                expr.span,
 738                                "using `clone` on a double-reference; \
 739                                 this will copy the reference instead of cloning the inner type",
 740                                |db| if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
 741                                    db.span_suggestion(expr.span, "try dereferencing it", format!("({}).clone()", snip.deref()));
 742                                });
 743             return; // don't report clone_on_copy
 744         }
 745     }
 746
 747     if !ty.moves_by_default(cx.tcx.global_tcx(), &parameter_environment, expr.span) {
 748         span_lint_and_then(cx,
 749                            CLONE_ON_COPY,
 750                            expr.span,
 751                            "using `clone` on a `Copy` type",
 752                            |db| if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
 753                                if let ty::TyRef(..) = cx.tcx.expr_ty(arg).sty {
 754                                    db.span_suggestion(expr.span, "try dereferencing it", format!("{}", snip.deref()));
 755                                } else {
 756                                    db.span_suggestion(expr.span, "try removing the `clone` call", format!("{}", snip));
 757                                }
 758                            });
 759     }
 760 }
 761
 762 fn lint_extend(cx: &LateContext, expr: &hir::Expr, args: &MethodArgs) {
 763     let (obj_ty, _) = walk_ptrs_ty_depth(cx.tcx.expr_ty(&args[0]));
 764     if !match_type(cx, obj_ty, &paths::VEC) {
 765         return;
 766     }
 767     let arg_ty = cx.tcx.expr_ty(&args[1]);
 768     if let Some(slice) = derefs_to_slice(cx, &args[1], arg_ty) {
 769         span_lint_and_then(cx, EXTEND_FROM_SLICE, expr.span, "use of `extend` to extend a Vec by a slice", |db| {
 770             db.span_suggestion(expr.span,
 771                                "try this",
 772                                format!("{}.extend_from_slice({})",
 773                                        snippet(cx, args[0].span, "_"),
 774                                        slice));
 775         });
 776     }
 777 }
 778
 779 fn lint_cstring_as_ptr(cx: &LateContext, expr: &hir::Expr, new: &hir::Expr, unwrap: &hir::Expr) {
 780     if_let_chain!{[
 781         let hir::ExprCall(ref fun, ref args) = new.node,
 782         args.len() == 1,
 783         let hir::ExprPath(None, ref path) = fun.node,
 784         match_path(path, &paths::CSTRING_NEW),
 785     ], {
 786         span_lint_and_then(cx, TEMPORARY_CSTRING_AS_PTR, expr.span,
 787                            "you are getting the inner pointer of a temporary `CString`",
 788                            |db| {
 789                                db.note("that pointer will be invalid outside this expression");
 790                                db.span_help(unwrap.span, "assign the `CString` to a variable to extend its lifetime");
 791                            });
 792     }}
 793 }
 794
 795 #[allow(ptr_arg)]
 796 // Type of MethodArgs is potentially a Vec
 797 fn lint_iter_nth(cx: &LateContext, expr: &hir::Expr, iter_args: &MethodArgs, is_mut: bool){
 798     let mut_str = if is_mut { "_mut" } else {""};
 799     let caller_type = if derefs_to_slice(cx, &iter_args[0], cx.tcx.expr_ty(&iter_args[0])).is_some() {
 800         "slice"
 801     }
 802     else if match_type(cx, cx.tcx.expr_ty(&iter_args[0]), &paths::VEC) {
 803         "Vec"
 804     }
 805     else if match_type(cx, cx.tcx.expr_ty(&iter_args[0]), &paths::VEC_DEQUE) {
 806         "VecDeque"
 807     }
 808     else {
 809         return; // caller is not a type that we want to lint
 810     };
 811
 812     span_lint(
 813         cx,
 814         ITER_NTH,
 815         expr.span,
 816         &format!("called `.iter{0}().nth()` on a {1}. Calling `.get{0}()` is both faster and more readable",
 817                  mut_str, caller_type)
 818     );
 819 }
 820
 821 fn lint_iter_skip_next(cx: &LateContext, expr: &hir::Expr){
 822     // lint if caller of skip is an Iterator
 823     if match_trait_method(cx, expr, &paths::ITERATOR) {
 824          span_lint(
 825             cx,
 826             ITER_SKIP_NEXT,
 827             expr.span,
 828             "called `skip(x).next()` on an iterator. This is more succinctly expressed by calling `nth(x)`"
 829         );
 830     }
 831 }
 832
 833 fn derefs_to_slice(cx: &LateContext, expr: &hir::Expr, ty: ty::Ty) -> Option<sugg::Sugg<'static>> {
 834     fn may_slice(cx: &LateContext, ty: ty::Ty) -> bool {
 835         match ty.sty {
 836             ty::TySlice(_) => true,
 837             ty::TyAdt(..) => match_type(cx, ty, &paths::VEC),
 838             ty::TyArray(_, size) => size < 32,
 839             ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) |
 840             ty::TyBox(inner) => may_slice(cx, inner),
 841             _ => false,
 842         }
 843     }
 844
 845     if let hir::ExprMethodCall(name, _, ref args) = expr.node {
 846         if &name.node.as_str() == &"iter" && may_slice(cx, cx.tcx.expr_ty(&args[0])) {
 847             sugg::Sugg::hir_opt(cx, &*args[0]).map(|sugg| {
 848                 sugg.addr()
 849             })
 850         } else {
 851             None
 852         }
 853     } else {
 854         match ty.sty {
 855             ty::TySlice(_) => sugg::Sugg::hir_opt(cx, expr),
 856             ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) |
 857             ty::TyBox(inner) => {
 858                 if may_slice(cx, inner) {
 859                     sugg::Sugg::hir_opt(cx, expr)
 860                 } else {
 861                     None
 862                 }
 863             }
 864             _ => None,
 865         }
 866     }
 867 }
 868
 869 #[allow(ptr_arg)]
 870 // Type of MethodArgs is potentially a Vec
 871 /// lint use of `unwrap()` for `Option`s and `Result`s
 872 fn lint_unwrap(cx: &LateContext, expr: &hir::Expr, unwrap_args: &MethodArgs) {
 873     let (obj_ty, _) = walk_ptrs_ty_depth(cx.tcx.expr_ty(&unwrap_args[0]));
 874
 875     let mess = if match_type(cx, obj_ty, &paths::OPTION) {
 876         Some((OPTION_UNWRAP_USED, "an Option", "None"))
 877     } else if match_type(cx, obj_ty, &paths::RESULT) {
 878         Some((RESULT_UNWRAP_USED, "a Result", "Err"))
 879     } else {
 880         None
 881     };
 882
 883     if let Some((lint, kind, none_value)) = mess {
 884         span_lint(cx,
 885                   lint,
 886                   expr.span,
 887                   &format!("used unwrap() on {} value. If you don't want to handle the {} case gracefully, consider \
 888                             using expect() to provide a better panic
 889                             message",
 890                            kind,
 891                            none_value));
 892     }
 893 }
 894
 895 #[allow(ptr_arg)]
 896 // Type of MethodArgs is potentially a Vec
 897 /// lint use of `ok().expect()` for `Result`s
 898 fn lint_ok_expect(cx: &LateContext, expr: &hir::Expr, ok_args: &MethodArgs) {
 899     // lint if the caller of `ok()` is a `Result`
 900     if match_type(cx, cx.tcx.expr_ty(&ok_args[0]), &paths::RESULT) {
 901         let result_type = cx.tcx.expr_ty(&ok_args[0]);
 902         if let Some(error_type) = get_error_type(cx, result_type) {
 903             if has_debug_impl(error_type, cx) {
 904                 span_lint(cx,
 905                           OK_EXPECT,
 906                           expr.span,
 907                           "called `ok().expect()` on a Result value. You can call `expect` directly on the `Result`");
 908             }
 909         }
 910     }
 911 }
 912
 913 #[allow(ptr_arg)]
 914 // Type of MethodArgs is potentially a Vec
 915 /// lint use of `map().unwrap_or()` for `Option`s
 916 fn lint_map_unwrap_or(cx: &LateContext, expr: &hir::Expr, map_args: &MethodArgs, unwrap_args: &MethodArgs) {
 917     // lint if the caller of `map()` is an `Option`
 918     if match_type(cx, cx.tcx.expr_ty(&map_args[0]), &paths::OPTION) {
 919         // lint message
 920         let msg = "called `map(f).unwrap_or(a)` on an Option value. This can be done more directly by calling \
 921                    `map_or(a, f)` instead";
 922         // get snippets for args to map() and unwrap_or()
 923         let map_snippet = snippet(cx, map_args[1].span, "..");
 924         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
 925         // lint, with note if neither arg is > 1 line and both map() and
 926         // unwrap_or() have the same span
 927         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
 928         let same_span = map_args[1].span.expn_id == unwrap_args[1].span.expn_id;
 929         if same_span && !multiline {
 930             span_note_and_lint(cx,
 931                                OPTION_MAP_UNWRAP_OR,
 932                                expr.span,
 933                                msg,
 934                                expr.span,
 935                                &format!("replace `map({0}).unwrap_or({1})` with `map_or({1}, {0})`",
 936                                         map_snippet,
 937                                         unwrap_snippet));
 938         } else if same_span && multiline {
 939             span_lint(cx, OPTION_MAP_UNWRAP_OR, expr.span, msg);
 940         };
 941     }
 942 }
 943
 944 #[allow(ptr_arg)]
 945 // Type of MethodArgs is potentially a Vec
 946 /// lint use of `map().unwrap_or_else()` for `Option`s
 947 fn lint_map_unwrap_or_else(cx: &LateContext, expr: &hir::Expr, map_args: &MethodArgs, unwrap_args: &MethodArgs) {
 948     // lint if the caller of `map()` is an `Option`
 949     if match_type(cx, cx.tcx.expr_ty(&map_args[0]), &paths::OPTION) {
 950         // lint message
 951         let msg = "called `map(f).unwrap_or_else(g)` on an Option value. This can be done more directly by calling \
 952                    `map_or_else(g, f)` instead";
 953         // get snippets for args to map() and unwrap_or_else()
 954         let map_snippet = snippet(cx, map_args[1].span, "..");
 955         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
 956         // lint, with note if neither arg is > 1 line and both map() and
 957         // unwrap_or_else() have the same span
 958         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
 959         let same_span = map_args[1].span.expn_id == unwrap_args[1].span.expn_id;
 960         if same_span && !multiline {
 961             span_note_and_lint(cx,
 962                                OPTION_MAP_UNWRAP_OR_ELSE,
 963                                expr.span,
 964                                msg,
 965                                expr.span,
 966                                &format!("replace `map({0}).unwrap_or_else({1})` with `with map_or_else({1}, {0})`",
 967                                         map_snippet,
 968                                         unwrap_snippet));
 969         } else if same_span && multiline {
 970             span_lint(cx, OPTION_MAP_UNWRAP_OR_ELSE, expr.span, msg);
 971         };
 972     }
 973 }
 974
 975 #[allow(ptr_arg)]
 976 // Type of MethodArgs is potentially a Vec
 977 /// lint use of `filter().next()` for `Iterators`
 978 fn lint_filter_next(cx: &LateContext, expr: &hir::Expr, filter_args: &MethodArgs) {
 979     // lint if caller of `.filter().next()` is an Iterator
 980     if match_trait_method(cx, expr, &paths::ITERATOR) {
 981         let msg = "called `filter(p).next()` on an `Iterator`. This is more succinctly expressed by calling `.find(p)` \
 982                    instead.";
 983         let filter_snippet = snippet(cx, filter_args[1].span, "..");
 984         if filter_snippet.lines().count() <= 1 {
 985             // add note if not multi-line
 986             span_note_and_lint(cx,
 987                                FILTER_NEXT,
 988                                expr.span,
 989                                msg,
 990                                expr.span,
 991                                &format!("replace `filter({0}).next()` with `find({0})`", filter_snippet));
 992         } else {
 993             span_lint(cx, FILTER_NEXT, expr.span, msg);
 994         }
 995     }
 996 }
 997
 998 // Type of MethodArgs is potentially a Vec
 999 /// lint use of `filter().map()` for `Iterators`
1000 fn lint_filter_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
1001     // lint if caller of `.filter().map()` is an Iterator
1002     if match_trait_method(cx, expr, &paths::ITERATOR) {
1003         let msg = "called `filter(p).map(q)` on an `Iterator`. \
1004                    This is more succinctly expressed by calling `.filter_map(..)` instead.";
1005         span_lint(cx, FILTER_MAP, expr.span, msg);
1006     }
1007 }
1008
1009 // Type of MethodArgs is potentially a Vec
1010 /// lint use of `filter().map()` for `Iterators`
1011 fn lint_filter_map_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
1012     // lint if caller of `.filter().map()` is an Iterator
1013     if match_trait_method(cx, expr, &paths::ITERATOR) {
1014         let msg = "called `filter_map(p).map(q)` on an `Iterator`. \
1015                    This is more succinctly expressed by only calling `.filter_map(..)` instead.";
1016         span_lint(cx, FILTER_MAP, expr.span, msg);
1017     }
1018 }
1019
1020 // Type of MethodArgs is potentially a Vec
1021 /// lint use of `filter().flat_map()` for `Iterators`
1022 fn lint_filter_flat_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
1023     // lint if caller of `.filter().flat_map()` is an Iterator
1024     if match_trait_method(cx, expr, &paths::ITERATOR) {
1025         let msg = "called `filter(p).flat_map(q)` on an `Iterator`. \
1026                    This is more succinctly expressed by calling `.flat_map(..)` \
1027                    and filtering by returning an empty Iterator.";
1028         span_lint(cx, FILTER_MAP, expr.span, msg);
1029     }
1030 }
1031
1032 // Type of MethodArgs is potentially a Vec
1033 /// lint use of `filter_map().flat_map()` for `Iterators`
1034 fn lint_filter_map_flat_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
1035     // lint if caller of `.filter_map().flat_map()` is an Iterator
1036     if match_trait_method(cx, expr, &paths::ITERATOR) {
1037         let msg = "called `filter_map(p).flat_map(q)` on an `Iterator`. \
1038                    This is more succinctly expressed by calling `.flat_map(..)` \
1039                    and filtering by returning an empty Iterator.";
1040         span_lint(cx, FILTER_MAP, expr.span, msg);
1041     }
1042 }
1043
1044 #[allow(ptr_arg)]
1045 // Type of MethodArgs is potentially a Vec
1046 /// lint searching an Iterator followed by `is_some()`
1047 fn lint_search_is_some(cx: &LateContext, expr: &hir::Expr, search_method: &str, search_args: &MethodArgs,
1048                        is_some_args: &MethodArgs) {
1049     // lint if caller of search is an Iterator
1050     if match_trait_method(cx, &*is_some_args[0], &paths::ITERATOR) {
1051         let msg = format!("called `is_some()` after searching an `Iterator` with {}. This is more succinctly expressed \
1052                            by calling `any()`.",
1053                           search_method);
1054         let search_snippet = snippet(cx, search_args[1].span, "..");
1055         if search_snippet.lines().count() <= 1 {
1056             // add note if not multi-line
1057             span_note_and_lint(cx,
1058                                SEARCH_IS_SOME,
1059                                expr.span,
1060                                &msg,
1061                                expr.span,
1062                                &format!("replace `{0}({1}).is_some()` with `any({1})`", search_method, search_snippet));
1063         } else {
1064             span_lint(cx, SEARCH_IS_SOME, expr.span, &msg);
1065         }
1066     }
1067 }
1068
1069 /// Checks for the `CHARS_NEXT_CMP` lint.
1070 fn lint_chars_next(cx: &LateContext, expr: &hir::Expr, chain: &hir::Expr, other: &hir::Expr, eq: bool) -> bool {
1071     if_let_chain! {[
1072         let Some(args) = method_chain_args(chain, &["chars", "next"]),
1073         let hir::ExprCall(ref fun, ref arg_char) = other.node,
1074         arg_char.len() == 1,
1075         let hir::ExprPath(None, ref path) = fun.node,
1076         path.segments.len() == 1 && path.segments[0].name.as_str() == "Some"
1077     ], {
1078         let self_ty = walk_ptrs_ty(cx.tcx.expr_ty_adjusted(&args[0][0]));
1079
1080         if self_ty.sty != ty::TyStr {
1081             return false;
1082         }
1083
1084         span_lint_and_then(cx,
1085                            CHARS_NEXT_CMP,
1086                            expr.span,
1087                            "you should use the `starts_with` method",
1088                            |db| {
1089                                let sugg = format!("{}{}.starts_with({})",
1090                                                   if eq { "" } else { "!" },
1091                                                   snippet(cx, args[0][0].span, "_"),
1092                                                   snippet(cx, arg_char[0].span, "_")
1093                                                   );
1094
1095                                db.span_suggestion(expr.span, "like this", sugg);
1096                            });
1097
1098         return true;
1099     }}
1100
1101     false
1102 }
1103
1104 /// lint for length-1 `str`s for methods in `PATTERN_METHODS`
1105 fn lint_single_char_pattern(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr) {
1106     if let Ok(ConstVal::Str(r)) = eval_const_expr_partial(cx.tcx, arg, ExprTypeChecked, None) {
1107         if r.len() == 1 {
1108             let hint = snippet(cx, expr.span, "..").replace(&format!("\"{}\"", r), &format!("'{}'", r));
1109             span_lint_and_then(cx,
1110                                SINGLE_CHAR_PATTERN,
1111                                arg.span,
1112                                "single-character string constant used as pattern",
1113                                |db| {
1114                                    db.span_suggestion(expr.span, "try using a char instead:", hint);
1115                                });
1116         }
1117     }
1118 }
1119
1120 /// Given a `Result<T, E>` type, return its error type (`E`).
1121 fn get_error_type<'a>(cx: &LateContext, ty: ty::Ty<'a>) -> Option<ty::Ty<'a>> {
1122     if let ty::TyAdt(_, substs) = ty.sty {
1123         if match_type(cx, ty, &paths::RESULT) {
1124             substs.types().nth(1)
1125         } else {
1126             None
1127         }
1128     } else {
1129         None
1130     }
1131 }
1132
1133 /// This checks whether a given type is known to implement Debug.
1134 fn has_debug_impl<'a, 'b>(ty: ty::Ty<'a>, cx: &LateContext<'b, 'a>) -> bool {
1135     match cx.tcx.lang_items.debug_trait() {
1136         Some(debug) => implements_trait(cx, ty, debug, Vec::new()),
1137         None => false,
1138     }
1139 }
1140
1141 enum Convention {
1142     Eq(&'static str),
1143     StartsWith(&'static str),
1144 }
1145
1146 #[cfg_attr(rustfmt, rustfmt_skip)]
1147 const CONVENTIONS: [(Convention, &'static [SelfKind]); 6] = [
1148     (Convention::Eq("new"), &[SelfKind::No]),
1149     (Convention::StartsWith("as_"), &[SelfKind::Ref, SelfKind::RefMut]),
1150     (Convention::StartsWith("from_"), &[SelfKind::No]),
1151     (Convention::StartsWith("into_"), &[SelfKind::Value]),
1152     (Convention::StartsWith("is_"), &[SelfKind::Ref, SelfKind::No]),
1153     (Convention::StartsWith("to_"), &[SelfKind::Ref]),
1154 ];
1155
1156 #[cfg_attr(rustfmt, rustfmt_skip)]
1157 const TRAIT_METHODS: [(&'static str, usize, SelfKind, OutType, &'static str); 30] = [
1158     ("add", 2, SelfKind::Value, OutType::Any, "std::ops::Add"),
1159     ("as_mut", 1, SelfKind::RefMut, OutType::Ref, "std::convert::AsMut"),
1160     ("as_ref", 1, SelfKind::Ref, OutType::Ref, "std::convert::AsRef"),
1161     ("bitand", 2, SelfKind::Value, OutType::Any, "std::ops::BitAnd"),
1162     ("bitor", 2, SelfKind::Value, OutType::Any, "std::ops::BitOr"),
1163     ("bitxor", 2, SelfKind::Value, OutType::Any, "std::ops::BitXor"),
1164     ("borrow", 1, SelfKind::Ref, OutType::Ref, "std::borrow::Borrow"),
1165     ("borrow_mut", 1, SelfKind::RefMut, OutType::Ref, "std::borrow::BorrowMut"),
1166     ("clone", 1, SelfKind::Ref, OutType::Any, "std::clone::Clone"),
1167     ("cmp", 2, SelfKind::Ref, OutType::Any, "std::cmp::Ord"),
1168     ("default", 0, SelfKind::No, OutType::Any, "std::default::Default"),
1169     ("deref", 1, SelfKind::Ref, OutType::Ref, "std::ops::Deref"),
1170     ("deref_mut", 1, SelfKind::RefMut, OutType::Ref, "std::ops::DerefMut"),
1171     ("div", 2, SelfKind::Value, OutType::Any, "std::ops::Div"),
1172     ("drop", 1, SelfKind::RefMut, OutType::Unit, "std::ops::Drop"),
1173     ("eq", 2, SelfKind::Ref, OutType::Bool, "std::cmp::PartialEq"),
1174     ("from_iter", 1, SelfKind::No, OutType::Any, "std::iter::FromIterator"),
1175     ("from_str", 1, SelfKind::No, OutType::Any, "std::str::FromStr"),
1176     ("hash", 2, SelfKind::Ref, OutType::Unit, "std::hash::Hash"),
1177     ("index", 2, SelfKind::Ref, OutType::Ref, "std::ops::Index"),
1178     ("index_mut", 2, SelfKind::RefMut, OutType::Ref, "std::ops::IndexMut"),
1179     ("into_iter", 1, SelfKind::Value, OutType::Any, "std::iter::IntoIterator"),
1180     ("mul", 2, SelfKind::Value, OutType::Any, "std::ops::Mul"),
1181     ("neg", 1, SelfKind::Value, OutType::Any, "std::ops::Neg"),
1182     ("next", 1, SelfKind::RefMut, OutType::Any, "std::iter::Iterator"),
1183     ("not", 1, SelfKind::Value, OutType::Any, "std::ops::Not"),
1184     ("rem", 2, SelfKind::Value, OutType::Any, "std::ops::Rem"),
1185     ("shl", 2, SelfKind::Value, OutType::Any, "std::ops::Shl"),
1186     ("shr", 2, SelfKind::Value, OutType::Any, "std::ops::Shr"),
1187     ("sub", 2, SelfKind::Value, OutType::Any, "std::ops::Sub"),
1188 ];
1189
1190 #[cfg_attr(rustfmt, rustfmt_skip)]
1191 const PATTERN_METHODS: [(&'static str, usize); 17] = [
1192     ("contains", 1),
1193     ("starts_with", 1),
1194     ("ends_with", 1),
1195     ("find", 1),
1196     ("rfind", 1),
1197     ("split", 1),
1198     ("rsplit", 1),
1199     ("split_terminator", 1),
1200     ("rsplit_terminator", 1),
1201     ("splitn", 2),
1202     ("rsplitn", 2),
1203     ("matches", 1),
1204     ("rmatches", 1),
1205     ("match_indices", 1),
1206     ("rmatch_indices", 1),
1207     ("trim_left_matches", 1),
1208     ("trim_right_matches", 1),
1209 ];
1210
1211
1212 #[derive(Clone, Copy)]
1213 enum SelfKind {
1214     Value,
1215     Ref,
1216     RefMut,
1217     No,
1218 }
1219
1220 impl SelfKind {
1221     fn matches(self, slf: &hir::ExplicitSelf, allow_value_for_ref: bool) -> bool {
1222         match (self, &slf.node) {
1223             (SelfKind::Value, &hir::SelfKind::Value(_)) |
1224             (SelfKind::Ref, &hir::SelfKind::Region(_, hir::Mutability::MutImmutable)) |
1225             (SelfKind::RefMut, &hir::SelfKind::Region(_, hir::Mutability::MutMutable)) => true,
1226             (SelfKind::Ref, &hir::SelfKind::Value(_)) |
1227             (SelfKind::RefMut, &hir::SelfKind::Value(_)) => allow_value_for_ref,
1228             (_, &hir::SelfKind::Explicit(ref ty, _)) => self.matches_explicit_type(ty, allow_value_for_ref),
1229
1230             _ => false,
1231         }
1232     }
1233
1234     fn matches_explicit_type(self, ty: &hir::Ty, allow_value_for_ref: bool) -> bool {
1235         match (self, &ty.node) {
1236             (SelfKind::Value, &hir::TyPath(..)) |
1237             (SelfKind::Ref, &hir::TyRptr(_, hir::MutTy { mutbl: hir::Mutability::MutImmutable, .. })) |
1238             (SelfKind::RefMut, &hir::TyRptr(_, hir::MutTy { mutbl: hir::Mutability::MutMutable, .. })) => true,
1239             (SelfKind::Ref, &hir::TyPath(..)) |
1240             (SelfKind::RefMut, &hir::TyPath(..)) => allow_value_for_ref,
1241             _ => false,
1242         }
1243     }
1244
1245     fn description(&self) -> &'static str {
1246         match *self {
1247             SelfKind::Value => "self by value",
1248             SelfKind::Ref => "self by reference",
1249             SelfKind::RefMut => "self by mutable reference",
1250             SelfKind::No => "no self",
1251         }
1252     }
1253 }
1254
1255 impl Convention {
1256     fn check(&self, other: &str) -> bool {
1257         match *self {
1258             Convention::Eq(this) => this == other,
1259             Convention::StartsWith(this) => other.starts_with(this) && this != other,
1260         }
1261     }
1262 }
1263
1264 impl fmt::Display for Convention {
1265     fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1266         match *self {
1267             Convention::Eq(this) => this.fmt(f),
1268             Convention::StartsWith(this) => this.fmt(f).and_then(|_| '*'.fmt(f)),
1269         }
1270     }
1271 }
1272
1273 #[derive(Clone, Copy)]
1274 enum OutType {
1275     Unit,
1276     Bool,
1277     Any,
1278     Ref,
1279 }
1280
1281 impl OutType {
1282     fn matches(&self, ty: &hir::FunctionRetTy) -> bool {
1283         match (self, ty) {
1284             (&OutType::Unit, &hir::DefaultReturn(_)) => true,
1285             (&OutType::Unit, &hir::Return(ref ty)) if ty.node == hir::TyTup(vec![].into()) => true,
1286             (&OutType::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
1287             (&OutType::Any, &hir::Return(ref ty)) if ty.node != hir::TyTup(vec![].into()) => true,
1288             (&OutType::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyRptr(_, _)),
1289             _ => false,
1290         }
1291     }
1292 }
1293
1294 fn is_bool(ty: &hir::Ty) -> bool {
1295     if let hir::TyPath(None, ref p) = ty.node {
1296         match_path(p, &["bool"])
1297     } else {
1298         false
1299     }
1300 }