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 impl LintPass for Pass {
 444     fn get_lints(&self) -> LintArray {
 445         lint_array!(EXTEND_FROM_SLICE,
 446                     OPTION_UNWRAP_USED,
 447                     RESULT_UNWRAP_USED,
 448                     SHOULD_IMPLEMENT_TRAIT,
 449                     WRONG_SELF_CONVENTION,
 450                     WRONG_PUB_SELF_CONVENTION,
 451                     OK_EXPECT,
 452                     OPTION_MAP_UNWRAP_OR,
 453                     OPTION_MAP_UNWRAP_OR_ELSE,
 454                     OR_FUN_CALL,
 455                     CHARS_NEXT_CMP,
 456                     CLONE_ON_COPY,
 457                     CLONE_DOUBLE_REF,
 458                     NEW_RET_NO_SELF,
 459                     SINGLE_CHAR_PATTERN,
 460                     SEARCH_IS_SOME,
 461                     TEMPORARY_CSTRING_AS_PTR,
 462                     FILTER_NEXT,
 463                     FILTER_MAP,
 464                     ITER_NTH)
 465     }
 466 }
 467
 468 impl LateLintPass for Pass {
 469     fn check_expr(&mut self, cx: &LateContext, expr: &hir::Expr) {
 470         if in_macro(cx, expr.span) {
 471             return;
 472         }
 473
 474         match expr.node {
 475             hir::ExprMethodCall(name, _, ref args) => {
 476                 // Chain calls
 477                 if let Some(arglists) = method_chain_args(expr, &["unwrap"]) {
 478                     lint_unwrap(cx, expr, arglists[0]);
 479                 } else if let Some(arglists) = method_chain_args(expr, &["ok", "expect"]) {
 480                     lint_ok_expect(cx, expr, arglists[0]);
 481                 } else if let Some(arglists) = method_chain_args(expr, &["map", "unwrap_or"]) {
 482                     lint_map_unwrap_or(cx, expr, arglists[0], arglists[1]);
 483                 } else if let Some(arglists) = method_chain_args(expr, &["map", "unwrap_or_else"]) {
 484                     lint_map_unwrap_or_else(cx, expr, arglists[0], arglists[1]);
 485                 } else if let Some(arglists) = method_chain_args(expr, &["filter", "next"]) {
 486                     lint_filter_next(cx, expr, arglists[0]);
 487                 } else if let Some(arglists) = method_chain_args(expr, &["filter", "map"]) {
 488                     lint_filter_map(cx, expr, arglists[0], arglists[1]);
 489                 } else if let Some(arglists) = method_chain_args(expr, &["filter_map", "map"]) {
 490                     lint_filter_map_map(cx, expr, arglists[0], arglists[1]);
 491                 } else if let Some(arglists) = method_chain_args(expr, &["filter", "flat_map"]) {
 492                     lint_filter_flat_map(cx, expr, arglists[0], arglists[1]);
 493                 } else if let Some(arglists) = method_chain_args(expr, &["filter_map", "flat_map"]) {
 494                     lint_filter_map_flat_map(cx, expr, arglists[0], arglists[1]);
 495                 } else if let Some(arglists) = method_chain_args(expr, &["find", "is_some"]) {
 496                     lint_search_is_some(cx, expr, "find", arglists[0], arglists[1]);
 497                 } else if let Some(arglists) = method_chain_args(expr, &["position", "is_some"]) {
 498                     lint_search_is_some(cx, expr, "position", arglists[0], arglists[1]);
 499                 } else if let Some(arglists) = method_chain_args(expr, &["rposition", "is_some"]) {
 500                     lint_search_is_some(cx, expr, "rposition", arglists[0], arglists[1]);
 501                 } else if let Some(arglists) = method_chain_args(expr, &["extend"]) {
 502                     lint_extend(cx, expr, arglists[0]);
 503                 } else if let Some(arglists) = method_chain_args(expr, &["unwrap", "as_ptr"]) {
 504                     lint_cstring_as_ptr(cx, expr, &arglists[0][0], &arglists[1][0]);
 505                 } else if let Some(arglists) = method_chain_args(expr, &["iter", "nth"]) {
 506                     lint_iter_nth(cx, expr, arglists[0], false);
 507                 } else if let Some(arglists) = method_chain_args(expr, &["iter_mut", "nth"]) {
 508                     lint_iter_nth(cx, expr, arglists[0], true);
 509                 }
 510
 511                 lint_or_fun_call(cx, expr, &name.node.as_str(), args);
 512
 513                 let self_ty = cx.tcx.expr_ty_adjusted(&args[0]);
 514                 if args.len() == 1 && name.node.as_str() == "clone" {
 515                     lint_clone_on_copy(cx, expr, &args[0], self_ty);
 516                 }
 517
 518                 match self_ty.sty {
 519                     ty::TyRef(_, ty) if ty.ty.sty == ty::TyStr => {
 520                         for &(method, pos) in &PATTERN_METHODS {
 521                             if name.node.as_str() == method && args.len() > pos {
 522                                 lint_single_char_pattern(cx, expr, &args[pos]);
 523                             }
 524                         }
 525                     }
 526                     _ => (),
 527                 }
 528             }
 529             hir::ExprBinary(op, ref lhs, ref rhs) if op.node == hir::BiEq || op.node == hir::BiNe => {
 530                 if !lint_chars_next(cx, expr, lhs, rhs, op.node == hir::BiEq) {
 531                     lint_chars_next(cx, expr, rhs, lhs, op.node == hir::BiEq);
 532                 }
 533             }
 534             _ => (),
 535         }
 536     }
 537
 538     fn check_impl_item(&mut self, cx: &LateContext, implitem: &hir::ImplItem) {
 539         if in_external_macro(cx, implitem.span) {
 540             return;
 541         }
 542         let name = implitem.name;
 543         let parent = cx.tcx.map.get_parent(implitem.id);
 544         let item = cx.tcx.map.expect_item(parent);
 545         if_let_chain! {[
 546             let hir::ImplItemKind::Method(ref sig, _) = implitem.node,
 547             let Some(explicit_self) = sig.decl.inputs.get(0).and_then(hir::Arg::to_self),
 548             let hir::ItemImpl(_, _, _, None, _, _) = item.node,
 549         ], {
 550             // check missing trait implementations
 551             for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
 552                 if name.as_str() == method_name &&
 553                    sig.decl.inputs.len() == n_args &&
 554                    out_type.matches(&sig.decl.output) &&
 555                    self_kind.matches(&explicit_self, false) {
 556                     span_lint(cx, SHOULD_IMPLEMENT_TRAIT, implitem.span, &format!(
 557                         "defining a method called `{}` on this type; consider implementing \
 558                          the `{}` trait or choosing a less ambiguous name", name, trait_name));
 559                 }
 560             }
 561
 562             // check conventions w.r.t. conversion method names and predicates
 563             let ty = cx.tcx.lookup_item_type(cx.tcx.map.local_def_id(item.id)).ty;
 564             let is_copy = is_copy(cx, ty, item.id);
 565             for &(ref conv, self_kinds) in &CONVENTIONS {
 566                 if_let_chain! {[
 567                     conv.check(&name.as_str()),
 568                     let Some(explicit_self) = sig.decl.inputs.get(0).and_then(hir::Arg::to_self),
 569                     !self_kinds.iter().any(|k| k.matches(&explicit_self, is_copy)),
 570                 ], {
 571                     let lint = if item.vis == hir::Visibility::Public {
 572                         WRONG_PUB_SELF_CONVENTION
 573                     } else {
 574                         WRONG_SELF_CONVENTION
 575                     };
 576                     span_lint(cx,
 577                               lint,
 578                               explicit_self.span,
 579                               &format!("methods called `{}` usually take {}; consider choosing a less \
 580                                         ambiguous name",
 581                                        conv,
 582                                        &self_kinds.iter()
 583                                                   .map(|k| k.description())
 584                                                   .collect::<Vec<_>>()
 585                                                   .join(" or ")));
 586                 }}
 587             }
 588
 589             let ret_ty = return_ty(cx, implitem.id);
 590             if &name.as_str() == &"new" &&
 591                !ret_ty.walk().any(|t| same_tys(cx, t, ty, implitem.id)) {
 592                 span_lint(cx,
 593                           NEW_RET_NO_SELF,
 594                           explicit_self.span,
 595                           "methods called `new` usually return `Self`");
 596             }
 597         }}
 598     }
 599 }
 600
 601 /// Checks for the `OR_FUN_CALL` lint.
 602 fn lint_or_fun_call(cx: &LateContext, expr: &hir::Expr, name: &str, args: &[P<hir::Expr>]) {
 603     /// Check for `unwrap_or(T::new())` or `unwrap_or(T::default())`.
 604     fn check_unwrap_or_default(cx: &LateContext, name: &str, fun: &hir::Expr, self_expr: &hir::Expr, arg: &hir::Expr,
 605                                or_has_args: bool, span: Span)
 606                                -> bool {
 607         if or_has_args {
 608             return false;
 609         }
 610
 611         if name == "unwrap_or" {
 612             if let hir::ExprPath(_, ref path) = fun.node {
 613                 let path: &str = &path.segments
 614                                       .last()
 615                                       .expect("A path must have at least one segment")
 616                                       .name
 617                                       .as_str();
 618
 619                 if ["default", "new"].contains(&path) {
 620                     let arg_ty = cx.tcx.expr_ty(arg);
 621                     let default_trait_id = if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT) {
 622                         default_trait_id
 623                     } else {
 624                         return false;
 625                     };
 626
 627                     if implements_trait(cx, arg_ty, default_trait_id, Vec::new()) {
 628                         span_lint_and_then(cx,
 629                                   OR_FUN_CALL,
 630                                   span,
 631                                   &format!("use of `{}` followed by a call to `{}`", name, path),
 632                                   |db| {
 633                                       db.span_suggestion(span, "try this",
 634                                                           format!("{}.unwrap_or_default()", snippet(cx, self_expr.span, "_")));
 635                                   });
 636                         return true;
 637                     }
 638                 }
 639             }
 640         }
 641
 642         false
 643     }
 644
 645     /// Check for `*or(foo())`.
 646     fn check_general_case(cx: &LateContext, name: &str, fun: &hir::Expr, self_expr: &hir::Expr, arg: &hir::Expr, or_has_args: bool,
 647                           span: Span) {
 648         // don't lint for constant values
 649         // FIXME: can we `expect` here instead of match?
 650         if let Some(qualif) = cx.tcx.const_qualif_map.borrow().get(&arg.id) {
 651             if !qualif.contains(ConstQualif::NOT_CONST) {
 652                 return;
 653             }
 654         }
 655         // (path, fn_has_argument, methods, suffix)
 656         let know_types: &[(&[_], _, &[_], _)] = &[(&paths::BTREEMAP_ENTRY, false, &["or_insert"], "with"),
 657                                                   (&paths::HASHMAP_ENTRY, false, &["or_insert"], "with"),
 658                                                   (&paths::OPTION,
 659                                                    false,
 660                                                    &["map_or", "ok_or", "or", "unwrap_or"],
 661                                                    "else"),
 662                                                   (&paths::RESULT, true, &["or", "unwrap_or"], "else")];
 663
 664         let self_ty = cx.tcx.expr_ty(self_expr);
 665
 666         let (fn_has_arguments, poss, suffix) = if let Some(&(_, fn_has_arguments, poss, suffix)) =
 667                                                       know_types.iter().find(|&&i| match_type(cx, self_ty, i.0)) {
 668             (fn_has_arguments, poss, suffix)
 669         } else {
 670             return;
 671         };
 672
 673         if !poss.contains(&name) {
 674             return;
 675         }
 676
 677         let sugg: Cow<_> = match (fn_has_arguments, !or_has_args) {
 678             (true, _) => format!("|_| {}", snippet(cx, arg.span, "..")).into(),
 679             (false, false) => format!("|| {}", snippet(cx, arg.span, "..")).into(),
 680             (false, true) => snippet(cx, fun.span, ".."),
 681         };
 682
 683         span_lint_and_then(cx, OR_FUN_CALL, span, &format!("use of `{}` followed by a function call", name), |db| {
 684             db.span_suggestion(span,
 685                                "try this",
 686                                format!("{}.{}_{}({})", snippet(cx, self_expr.span, "_"), name, suffix, sugg));
 687         });
 688     }
 689
 690     if args.len() == 2 {
 691         if let hir::ExprCall(ref fun, ref or_args) = args[1].node {
 692             let or_has_args = !or_args.is_empty();
 693             if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
 694                 check_general_case(cx, name, fun, &args[0], &args[1], or_has_args, expr.span);
 695             }
 696         }
 697     }
 698 }
 699
 700 /// Checks for the `CLONE_ON_COPY` lint.
 701 fn lint_clone_on_copy(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr, arg_ty: ty::Ty) {
 702     let ty = cx.tcx.expr_ty(expr);
 703     let parent = cx.tcx.map.get_parent(expr.id);
 704     let parameter_environment = ty::ParameterEnvironment::for_item(cx.tcx, parent);
 705     if let ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) = arg_ty.sty {
 706         if let ty::TyRef(..) = inner.sty {
 707             span_lint_and_then(cx,
 708                                CLONE_DOUBLE_REF,
 709                                expr.span,
 710                                "using `clone` on a double-reference; \
 711                                 this will copy the reference instead of cloning the inner type",
 712                                |db| if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
 713                                    db.span_suggestion(expr.span, "try dereferencing it", format!("({}).clone()", snip.deref()));
 714                                });
 715             return; // don't report clone_on_copy
 716         }
 717     }
 718
 719     if !ty.moves_by_default(cx.tcx.global_tcx(), &parameter_environment, expr.span) {
 720         span_lint_and_then(cx,
 721                            CLONE_ON_COPY,
 722                            expr.span,
 723                            "using `clone` on a `Copy` type",
 724                            |db| if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
 725                                if let ty::TyRef(..) = cx.tcx.expr_ty(arg).sty {
 726                                    db.span_suggestion(expr.span, "try dereferencing it", format!("{}", snip.deref()));
 727                                } else {
 728                                    db.span_suggestion(expr.span, "try removing the `clone` call", format!("{}", snip));
 729                                }
 730                            });
 731     }
 732 }
 733
 734 fn lint_extend(cx: &LateContext, expr: &hir::Expr, args: &MethodArgs) {
 735     let (obj_ty, _) = walk_ptrs_ty_depth(cx.tcx.expr_ty(&args[0]));
 736     if !match_type(cx, obj_ty, &paths::VEC) {
 737         return;
 738     }
 739     let arg_ty = cx.tcx.expr_ty(&args[1]);
 740     if let Some(slice) = derefs_to_slice(cx, &args[1], arg_ty) {
 741         span_lint_and_then(cx, EXTEND_FROM_SLICE, expr.span, "use of `extend` to extend a Vec by a slice", |db| {
 742             db.span_suggestion(expr.span,
 743                                "try this",
 744                                format!("{}.extend_from_slice({})",
 745                                        snippet(cx, args[0].span, "_"),
 746                                        slice));
 747         });
 748     }
 749 }
 750
 751 fn lint_cstring_as_ptr(cx: &LateContext, expr: &hir::Expr, new: &hir::Expr, unwrap: &hir::Expr) {
 752     if_let_chain!{[
 753         let hir::ExprCall(ref fun, ref args) = new.node,
 754         args.len() == 1,
 755         let hir::ExprPath(None, ref path) = fun.node,
 756         match_path(path, &paths::CSTRING_NEW),
 757     ], {
 758         span_lint_and_then(cx, TEMPORARY_CSTRING_AS_PTR, expr.span,
 759                            "you are getting the inner pointer of a temporary `CString`",
 760                            |db| {
 761                                db.note("that pointer will be invalid outside this expression");
 762                                db.span_help(unwrap.span, "assign the `CString` to a variable to extend its lifetime");
 763                            });
 764     }}
 765 }
 766
 767 #[allow(ptr_arg)]
 768 // Type of MethodArgs is potentially a Vec
 769 fn lint_iter_nth(cx: &LateContext, expr: &hir::Expr, iter_args: &MethodArgs, is_mut: bool){
 770     let mut_str = if is_mut { "_mut" } else {""};
 771     let caller_type = if let Some(_) = derefs_to_slice(cx, &iter_args[0], cx.tcx.expr_ty(&iter_args[0])) {
 772         "slice"
 773     }
 774     else if match_type(cx, cx.tcx.expr_ty(&iter_args[0]), &paths::VEC) {
 775         "Vec"
 776     }
 777     else if match_type(cx, cx.tcx.expr_ty(&iter_args[0]), &paths::VEC_DEQUE) {
 778         "VecDeque"
 779     }
 780     else {
 781         return; // caller is not a type that we want to lint
 782     };
 783
 784     span_lint(
 785         cx,
 786         ITER_NTH,
 787         expr.span,
 788         &format!("called `.iter{0}().nth()` on a {1}. Calling `.get{0}()` is both faster and more readable",
 789                  mut_str, caller_type)
 790     );
 791 }
 792
 793 fn derefs_to_slice(cx: &LateContext, expr: &hir::Expr, ty: ty::Ty) -> Option<sugg::Sugg<'static>> {
 794     fn may_slice(cx: &LateContext, ty: ty::Ty) -> bool {
 795         match ty.sty {
 796             ty::TySlice(_) => true,
 797             ty::TyAdt(..) => match_type(cx, ty, &paths::VEC),
 798             ty::TyArray(_, size) => size < 32,
 799             ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) |
 800             ty::TyBox(inner) => may_slice(cx, inner),
 801             _ => false,
 802         }
 803     }
 804
 805     if let hir::ExprMethodCall(name, _, ref args) = expr.node {
 806         if &name.node.as_str() == &"iter" && may_slice(cx, cx.tcx.expr_ty(&args[0])) {
 807             sugg::Sugg::hir_opt(cx, &*args[0]).map(|sugg| {
 808                 sugg.addr()
 809             })
 810         } else {
 811             None
 812         }
 813     } else {
 814         match ty.sty {
 815             ty::TySlice(_) => sugg::Sugg::hir_opt(cx, expr),
 816             ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) |
 817             ty::TyBox(inner) => {
 818                 if may_slice(cx, inner) {
 819                     sugg::Sugg::hir_opt(cx, expr)
 820                 } else {
 821                     None
 822                 }
 823             }
 824             _ => None,
 825         }
 826     }
 827 }
 828
 829 #[allow(ptr_arg)]
 830 // Type of MethodArgs is potentially a Vec
 831 /// lint use of `unwrap()` for `Option`s and `Result`s
 832 fn lint_unwrap(cx: &LateContext, expr: &hir::Expr, unwrap_args: &MethodArgs) {
 833     let (obj_ty, _) = walk_ptrs_ty_depth(cx.tcx.expr_ty(&unwrap_args[0]));
 834
 835     let mess = if match_type(cx, obj_ty, &paths::OPTION) {
 836         Some((OPTION_UNWRAP_USED, "an Option", "None"))
 837     } else if match_type(cx, obj_ty, &paths::RESULT) {
 838         Some((RESULT_UNWRAP_USED, "a Result", "Err"))
 839     } else {
 840         None
 841     };
 842
 843     if let Some((lint, kind, none_value)) = mess {
 844         span_lint(cx,
 845                   lint,
 846                   expr.span,
 847                   &format!("used unwrap() on {} value. If you don't want to handle the {} case gracefully, consider \
 848                             using expect() to provide a better panic
 849                             message",
 850                            kind,
 851                            none_value));
 852     }
 853 }
 854
 855 #[allow(ptr_arg)]
 856 // Type of MethodArgs is potentially a Vec
 857 /// lint use of `ok().expect()` for `Result`s
 858 fn lint_ok_expect(cx: &LateContext, expr: &hir::Expr, ok_args: &MethodArgs) {
 859     // lint if the caller of `ok()` is a `Result`
 860     if match_type(cx, cx.tcx.expr_ty(&ok_args[0]), &paths::RESULT) {
 861         let result_type = cx.tcx.expr_ty(&ok_args[0]);
 862         if let Some(error_type) = get_error_type(cx, result_type) {
 863             if has_debug_impl(error_type, cx) {
 864                 span_lint(cx,
 865                           OK_EXPECT,
 866                           expr.span,
 867                           "called `ok().expect()` on a Result value. You can call `expect` directly on the `Result`");
 868             }
 869         }
 870     }
 871 }
 872
 873 #[allow(ptr_arg)]
 874 // Type of MethodArgs is potentially a Vec
 875 /// lint use of `map().unwrap_or()` for `Option`s
 876 fn lint_map_unwrap_or(cx: &LateContext, expr: &hir::Expr, map_args: &MethodArgs, unwrap_args: &MethodArgs) {
 877     // lint if the caller of `map()` is an `Option`
 878     if match_type(cx, cx.tcx.expr_ty(&map_args[0]), &paths::OPTION) {
 879         // lint message
 880         let msg = "called `map(f).unwrap_or(a)` on an Option value. This can be done more directly by calling \
 881                    `map_or(a, f)` instead";
 882         // get snippets for args to map() and unwrap_or()
 883         let map_snippet = snippet(cx, map_args[1].span, "..");
 884         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
 885         // lint, with note if neither arg is > 1 line and both map() and
 886         // unwrap_or() have the same span
 887         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
 888         let same_span = map_args[1].span.expn_id == unwrap_args[1].span.expn_id;
 889         if same_span && !multiline {
 890             span_note_and_lint(cx,
 891                                OPTION_MAP_UNWRAP_OR,
 892                                expr.span,
 893                                msg,
 894                                expr.span,
 895                                &format!("replace `map({0}).unwrap_or({1})` with `map_or({1}, {0})`",
 896                                         map_snippet,
 897                                         unwrap_snippet));
 898         } else if same_span && multiline {
 899             span_lint(cx, OPTION_MAP_UNWRAP_OR, expr.span, msg);
 900         };
 901     }
 902 }
 903
 904 #[allow(ptr_arg)]
 905 // Type of MethodArgs is potentially a Vec
 906 /// lint use of `map().unwrap_or_else()` for `Option`s
 907 fn lint_map_unwrap_or_else(cx: &LateContext, expr: &hir::Expr, map_args: &MethodArgs, unwrap_args: &MethodArgs) {
 908     // lint if the caller of `map()` is an `Option`
 909     if match_type(cx, cx.tcx.expr_ty(&map_args[0]), &paths::OPTION) {
 910         // lint message
 911         let msg = "called `map(f).unwrap_or_else(g)` on an Option value. This can be done more directly by calling \
 912                    `map_or_else(g, f)` instead";
 913         // get snippets for args to map() and unwrap_or_else()
 914         let map_snippet = snippet(cx, map_args[1].span, "..");
 915         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
 916         // lint, with note if neither arg is > 1 line and both map() and
 917         // unwrap_or_else() have the same span
 918         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
 919         let same_span = map_args[1].span.expn_id == unwrap_args[1].span.expn_id;
 920         if same_span && !multiline {
 921             span_note_and_lint(cx,
 922                                OPTION_MAP_UNWRAP_OR_ELSE,
 923                                expr.span,
 924                                msg,
 925                                expr.span,
 926                                &format!("replace `map({0}).unwrap_or_else({1})` with `with map_or_else({1}, {0})`",
 927                                         map_snippet,
 928                                         unwrap_snippet));
 929         } else if same_span && multiline {
 930             span_lint(cx, OPTION_MAP_UNWRAP_OR_ELSE, expr.span, msg);
 931         };
 932     }
 933 }
 934
 935 #[allow(ptr_arg)]
 936 // Type of MethodArgs is potentially a Vec
 937 /// lint use of `filter().next()` for `Iterators`
 938 fn lint_filter_next(cx: &LateContext, expr: &hir::Expr, filter_args: &MethodArgs) {
 939     // lint if caller of `.filter().next()` is an Iterator
 940     if match_trait_method(cx, expr, &paths::ITERATOR) {
 941         let msg = "called `filter(p).next()` on an `Iterator`. This is more succinctly expressed by calling `.find(p)` \
 942                    instead.";
 943         let filter_snippet = snippet(cx, filter_args[1].span, "..");
 944         if filter_snippet.lines().count() <= 1 {
 945             // add note if not multi-line
 946             span_note_and_lint(cx,
 947                                FILTER_NEXT,
 948                                expr.span,
 949                                msg,
 950                                expr.span,
 951                                &format!("replace `filter({0}).next()` with `find({0})`", filter_snippet));
 952         } else {
 953             span_lint(cx, FILTER_NEXT, expr.span, msg);
 954         }
 955     }
 956 }
 957
 958 // Type of MethodArgs is potentially a Vec
 959 /// lint use of `filter().map()` for `Iterators`
 960 fn lint_filter_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
 961     // lint if caller of `.filter().map()` is an Iterator
 962     if match_trait_method(cx, expr, &paths::ITERATOR) {
 963         let msg = "called `filter(p).map(q)` on an `Iterator`. \
 964                    This is more succinctly expressed by calling `.filter_map(..)` instead.";
 965         span_lint(cx, FILTER_MAP, expr.span, msg);
 966     }
 967 }
 968
 969 // Type of MethodArgs is potentially a Vec
 970 /// lint use of `filter().map()` for `Iterators`
 971 fn lint_filter_map_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
 972     // lint if caller of `.filter().map()` is an Iterator
 973     if match_trait_method(cx, expr, &paths::ITERATOR) {
 974         let msg = "called `filter_map(p).map(q)` on an `Iterator`. \
 975                    This is more succinctly expressed by only calling `.filter_map(..)` instead.";
 976         span_lint(cx, FILTER_MAP, expr.span, msg);
 977     }
 978 }
 979
 980 // Type of MethodArgs is potentially a Vec
 981 /// lint use of `filter().flat_map()` for `Iterators`
 982 fn lint_filter_flat_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
 983     // lint if caller of `.filter().flat_map()` is an Iterator
 984     if match_trait_method(cx, expr, &paths::ITERATOR) {
 985         let msg = "called `filter(p).flat_map(q)` on an `Iterator`. \
 986                    This is more succinctly expressed by calling `.flat_map(..)` \
 987                    and filtering by returning an empty Iterator.";
 988         span_lint(cx, FILTER_MAP, expr.span, msg);
 989     }
 990 }
 991
 992 // Type of MethodArgs is potentially a Vec
 993 /// lint use of `filter_map().flat_map()` for `Iterators`
 994 fn lint_filter_map_flat_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &MethodArgs, _map_args: &MethodArgs) {
 995     // lint if caller of `.filter_map().flat_map()` is an Iterator
 996     if match_trait_method(cx, expr, &paths::ITERATOR) {
 997         let msg = "called `filter_map(p).flat_map(q)` on an `Iterator`. \
 998                    This is more succinctly expressed by calling `.flat_map(..)` \
 999                    and filtering by returning an empty Iterator.";
1000         span_lint(cx, FILTER_MAP, expr.span, msg);
1001     }
1002 }
1003
1004 #[allow(ptr_arg)]
1005 // Type of MethodArgs is potentially a Vec
1006 /// lint searching an Iterator followed by `is_some()`
1007 fn lint_search_is_some(cx: &LateContext, expr: &hir::Expr, search_method: &str, search_args: &MethodArgs,
1008                        is_some_args: &MethodArgs) {
1009     // lint if caller of search is an Iterator
1010     if match_trait_method(cx, &*is_some_args[0], &paths::ITERATOR) {
1011         let msg = format!("called `is_some()` after searching an `Iterator` with {}. This is more succinctly expressed \
1012                            by calling `any()`.",
1013                           search_method);
1014         let search_snippet = snippet(cx, search_args[1].span, "..");
1015         if search_snippet.lines().count() <= 1 {
1016             // add note if not multi-line
1017             span_note_and_lint(cx,
1018                                SEARCH_IS_SOME,
1019                                expr.span,
1020                                &msg,
1021                                expr.span,
1022                                &format!("replace `{0}({1}).is_some()` with `any({1})`", search_method, search_snippet));
1023         } else {
1024             span_lint(cx, SEARCH_IS_SOME, expr.span, &msg);
1025         }
1026     }
1027 }
1028
1029 /// Checks for the `CHARS_NEXT_CMP` lint.
1030 fn lint_chars_next(cx: &LateContext, expr: &hir::Expr, chain: &hir::Expr, other: &hir::Expr, eq: bool) -> bool {
1031     if_let_chain! {[
1032         let Some(args) = method_chain_args(chain, &["chars", "next"]),
1033         let hir::ExprCall(ref fun, ref arg_char) = other.node,
1034         arg_char.len() == 1,
1035         let hir::ExprPath(None, ref path) = fun.node,
1036         path.segments.len() == 1 && path.segments[0].name.as_str() == "Some"
1037     ], {
1038         let self_ty = walk_ptrs_ty(cx.tcx.expr_ty_adjusted(&args[0][0]));
1039
1040         if self_ty.sty != ty::TyStr {
1041             return false;
1042         }
1043
1044         span_lint_and_then(cx,
1045                            CHARS_NEXT_CMP,
1046                            expr.span,
1047                            "you should use the `starts_with` method",
1048                            |db| {
1049                                let sugg = format!("{}{}.starts_with({})",
1050                                                   if eq { "" } else { "!" },
1051                                                   snippet(cx, args[0][0].span, "_"),
1052                                                   snippet(cx, arg_char[0].span, "_")
1053                                                   );
1054
1055                                db.span_suggestion(expr.span, "like this", sugg);
1056                            });
1057
1058         return true;
1059     }}
1060
1061     false
1062 }
1063
1064 /// lint for length-1 `str`s for methods in `PATTERN_METHODS`
1065 fn lint_single_char_pattern(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr) {
1066     if let Ok(ConstVal::Str(r)) = eval_const_expr_partial(cx.tcx, arg, ExprTypeChecked, None) {
1067         if r.len() == 1 {
1068             let hint = snippet(cx, expr.span, "..").replace(&format!("\"{}\"", r), &format!("'{}'", r));
1069             span_lint_and_then(cx,
1070                                SINGLE_CHAR_PATTERN,
1071                                arg.span,
1072                                "single-character string constant used as pattern",
1073                                |db| {
1074                                    db.span_suggestion(expr.span, "try using a char instead:", hint);
1075                                });
1076         }
1077     }
1078 }
1079
1080 /// Given a `Result<T, E>` type, return its error type (`E`).
1081 fn get_error_type<'a>(cx: &LateContext, ty: ty::Ty<'a>) -> Option<ty::Ty<'a>> {
1082     if let ty::TyAdt(_, substs) = ty.sty {
1083         if match_type(cx, ty, &paths::RESULT) {
1084             substs.types().nth(1)
1085         } else {
1086             None
1087         }
1088     } else {
1089         None
1090     }
1091 }
1092
1093 /// This checks whether a given type is known to implement Debug.
1094 fn has_debug_impl<'a, 'b>(ty: ty::Ty<'a>, cx: &LateContext<'b, 'a>) -> bool {
1095     match cx.tcx.lang_items.debug_trait() {
1096         Some(debug) => implements_trait(cx, ty, debug, Vec::new()),
1097         None => false,
1098     }
1099 }
1100
1101 enum Convention {
1102     Eq(&'static str),
1103     StartsWith(&'static str),
1104 }
1105
1106 #[cfg_attr(rustfmt, rustfmt_skip)]
1107 const CONVENTIONS: [(Convention, &'static [SelfKind]); 6] = [
1108     (Convention::Eq("new"), &[SelfKind::No]),
1109     (Convention::StartsWith("as_"), &[SelfKind::Ref, SelfKind::RefMut]),
1110     (Convention::StartsWith("from_"), &[SelfKind::No]),
1111     (Convention::StartsWith("into_"), &[SelfKind::Value]),
1112     (Convention::StartsWith("is_"), &[SelfKind::Ref, SelfKind::No]),
1113     (Convention::StartsWith("to_"), &[SelfKind::Ref]),
1114 ];
1115
1116 #[cfg_attr(rustfmt, rustfmt_skip)]
1117 const TRAIT_METHODS: [(&'static str, usize, SelfKind, OutType, &'static str); 30] = [
1118     ("add", 2, SelfKind::Value, OutType::Any, "std::ops::Add"),
1119     ("as_mut", 1, SelfKind::RefMut, OutType::Ref, "std::convert::AsMut"),
1120     ("as_ref", 1, SelfKind::Ref, OutType::Ref, "std::convert::AsRef"),
1121     ("bitand", 2, SelfKind::Value, OutType::Any, "std::ops::BitAnd"),
1122     ("bitor", 2, SelfKind::Value, OutType::Any, "std::ops::BitOr"),
1123     ("bitxor", 2, SelfKind::Value, OutType::Any, "std::ops::BitXor"),
1124     ("borrow", 1, SelfKind::Ref, OutType::Ref, "std::borrow::Borrow"),
1125     ("borrow_mut", 1, SelfKind::RefMut, OutType::Ref, "std::borrow::BorrowMut"),
1126     ("clone", 1, SelfKind::Ref, OutType::Any, "std::clone::Clone"),
1127     ("cmp", 2, SelfKind::Ref, OutType::Any, "std::cmp::Ord"),
1128     ("default", 0, SelfKind::No, OutType::Any, "std::default::Default"),
1129     ("deref", 1, SelfKind::Ref, OutType::Ref, "std::ops::Deref"),
1130     ("deref_mut", 1, SelfKind::RefMut, OutType::Ref, "std::ops::DerefMut"),
1131     ("div", 2, SelfKind::Value, OutType::Any, "std::ops::Div"),
1132     ("drop", 1, SelfKind::RefMut, OutType::Unit, "std::ops::Drop"),
1133     ("eq", 2, SelfKind::Ref, OutType::Bool, "std::cmp::PartialEq"),
1134     ("from_iter", 1, SelfKind::No, OutType::Any, "std::iter::FromIterator"),
1135     ("from_str", 1, SelfKind::No, OutType::Any, "std::str::FromStr"),
1136     ("hash", 2, SelfKind::Ref, OutType::Unit, "std::hash::Hash"),
1137     ("index", 2, SelfKind::Ref, OutType::Ref, "std::ops::Index"),
1138     ("index_mut", 2, SelfKind::RefMut, OutType::Ref, "std::ops::IndexMut"),
1139     ("into_iter", 1, SelfKind::Value, OutType::Any, "std::iter::IntoIterator"),
1140     ("mul", 2, SelfKind::Value, OutType::Any, "std::ops::Mul"),
1141     ("neg", 1, SelfKind::Value, OutType::Any, "std::ops::Neg"),
1142     ("next", 1, SelfKind::RefMut, OutType::Any, "std::iter::Iterator"),
1143     ("not", 1, SelfKind::Value, OutType::Any, "std::ops::Not"),
1144     ("rem", 2, SelfKind::Value, OutType::Any, "std::ops::Rem"),
1145     ("shl", 2, SelfKind::Value, OutType::Any, "std::ops::Shl"),
1146     ("shr", 2, SelfKind::Value, OutType::Any, "std::ops::Shr"),
1147     ("sub", 2, SelfKind::Value, OutType::Any, "std::ops::Sub"),
1148 ];
1149
1150 #[cfg_attr(rustfmt, rustfmt_skip)]
1151 const PATTERN_METHODS: [(&'static str, usize); 17] = [
1152     ("contains", 1),
1153     ("starts_with", 1),
1154     ("ends_with", 1),
1155     ("find", 1),
1156     ("rfind", 1),
1157     ("split", 1),
1158     ("rsplit", 1),
1159     ("split_terminator", 1),
1160     ("rsplit_terminator", 1),
1161     ("splitn", 2),
1162     ("rsplitn", 2),
1163     ("matches", 1),
1164     ("rmatches", 1),
1165     ("match_indices", 1),
1166     ("rmatch_indices", 1),
1167     ("trim_left_matches", 1),
1168     ("trim_right_matches", 1),
1169 ];
1170
1171
1172 #[derive(Clone, Copy)]
1173 enum SelfKind {
1174     Value,
1175     Ref,
1176     RefMut,
1177     No,
1178 }
1179
1180 impl SelfKind {
1181     fn matches(self, slf: &hir::ExplicitSelf, allow_value_for_ref: bool) -> bool {
1182         match (self, &slf.node) {
1183             (SelfKind::Value, &hir::SelfKind::Value(_)) |
1184             (SelfKind::Ref, &hir::SelfKind::Region(_, hir::Mutability::MutImmutable)) |
1185             (SelfKind::RefMut, &hir::SelfKind::Region(_, hir::Mutability::MutMutable)) => true,
1186             (SelfKind::Ref, &hir::SelfKind::Value(_)) |
1187             (SelfKind::RefMut, &hir::SelfKind::Value(_)) => allow_value_for_ref,
1188             (_, &hir::SelfKind::Explicit(ref ty, _)) => self.matches_explicit_type(ty, allow_value_for_ref),
1189
1190             _ => false,
1191         }
1192     }
1193
1194     fn matches_explicit_type(self, ty: &hir::Ty, allow_value_for_ref: bool) -> bool {
1195         match (self, &ty.node) {
1196             (SelfKind::Value, &hir::TyPath(..)) |
1197             (SelfKind::Ref, &hir::TyRptr(_, hir::MutTy { mutbl: hir::Mutability::MutImmutable, .. })) |
1198             (SelfKind::RefMut, &hir::TyRptr(_, hir::MutTy { mutbl: hir::Mutability::MutMutable, .. })) => true,
1199             (SelfKind::Ref, &hir::TyPath(..)) |
1200             (SelfKind::RefMut, &hir::TyPath(..)) => allow_value_for_ref,
1201             _ => false,
1202         }
1203     }
1204
1205     fn description(&self) -> &'static str {
1206         match *self {
1207             SelfKind::Value => "self by value",
1208             SelfKind::Ref => "self by reference",
1209             SelfKind::RefMut => "self by mutable reference",
1210             SelfKind::No => "no self",
1211         }
1212     }
1213 }
1214
1215 impl Convention {
1216     fn check(&self, other: &str) -> bool {
1217         match *self {
1218             Convention::Eq(this) => this == other,
1219             Convention::StartsWith(this) => other.starts_with(this),
1220         }
1221     }
1222 }
1223
1224 impl fmt::Display for Convention {
1225     fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1226         match *self {
1227             Convention::Eq(this) => this.fmt(f),
1228             Convention::StartsWith(this) => this.fmt(f).and_then(|_| '*'.fmt(f)),
1229         }
1230     }
1231 }
1232
1233 #[derive(Clone, Copy)]
1234 enum OutType {
1235     Unit,
1236     Bool,
1237     Any,
1238     Ref,
1239 }
1240
1241 impl OutType {
1242     fn matches(&self, ty: &hir::FunctionRetTy) -> bool {
1243         match (self, ty) {
1244             (&OutType::Unit, &hir::DefaultReturn(_)) => true,
1245             (&OutType::Unit, &hir::Return(ref ty)) if ty.node == hir::TyTup(vec![].into()) => true,
1246             (&OutType::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
1247             (&OutType::Any, &hir::Return(ref ty)) if ty.node != hir::TyTup(vec![].into()) => true,
1248             (&OutType::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyRptr(_, _)),
1249             _ => false,
1250         }
1251     }
1252 }
1253
1254 fn is_bool(ty: &hir::Ty) -> bool {
1255     if let hir::TyPath(None, ref p) = ty.node {
1256         match_path(p, &["bool"])
1257     } else {
1258         false
1259     }
1260 }