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