]> git.lizzy.rs Git - rust.git/blob - clippy_utils/src/lib.rs
Improve `map_entry` lint
[rust.git] / clippy_utils / src / lib.rs
1 #![feature(box_patterns)]
2 #![feature(in_band_lifetimes)]
3 #![feature(iter_zip)]
4 #![feature(rustc_private)]
5 #![recursion_limit = "512"]
6 #![allow(clippy::missing_errors_doc, clippy::missing_panics_doc, clippy::must_use_candidate)]
7
8 // FIXME: switch to something more ergonomic here, once available.
9 // (Currently there is no way to opt into sysroot crates without `extern crate`.)
10 extern crate rustc_ast;
11 extern crate rustc_ast_pretty;
12 extern crate rustc_attr;
13 extern crate rustc_data_structures;
14 extern crate rustc_errors;
15 extern crate rustc_hir;
16 extern crate rustc_hir_pretty;
17 extern crate rustc_infer;
18 extern crate rustc_lexer;
19 extern crate rustc_lint;
20 extern crate rustc_middle;
21 extern crate rustc_mir;
22 extern crate rustc_session;
23 extern crate rustc_span;
24 extern crate rustc_target;
25 extern crate rustc_trait_selection;
26 extern crate rustc_typeck;
27
28 #[macro_use]
29 pub mod sym_helper;
30
31 #[allow(clippy::module_name_repetitions)]
32 pub mod ast_utils;
33 pub mod attrs;
34 pub mod camel_case;
35 pub mod comparisons;
36 pub mod consts;
37 pub mod diagnostics;
38 pub mod eager_or_lazy;
39 pub mod higher;
40 mod hir_utils;
41 pub mod numeric_literal;
42 pub mod paths;
43 pub mod ptr;
44 pub mod qualify_min_const_fn;
45 pub mod source;
46 pub mod sugg;
47 pub mod ty;
48 pub mod usage;
49 pub mod visitors;
50
51 pub use self::attrs::*;
52 pub use self::hir_utils::{both, count_eq, eq_expr_value, over, SpanlessEq, SpanlessHash};
53
54 use std::collections::hash_map::Entry;
55 use std::hash::BuildHasherDefault;
56
57 use if_chain::if_chain;
58 use rustc_ast::ast::{self, Attribute, BorrowKind, LitKind};
59 use rustc_data_structures::fx::FxHashMap;
60 use rustc_hir as hir;
61 use rustc_hir::def::{DefKind, Res};
62 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
63 use rustc_hir::intravisit::{self, NestedVisitorMap, Visitor};
64 use rustc_hir::LangItem::{ResultErr, ResultOk};
65 use rustc_hir::{
66     def, Arm, BindingAnnotation, Block, Body, Constness, Destination, Expr, ExprKind, FnDecl, GenericArgs, HirId, Impl,
67     ImplItem, ImplItemKind, Item, ItemKind, LangItem, MatchSource, Node, Param, Pat, PatKind, Path, PathSegment, QPath,
68     Stmt, StmtKind, TraitItem, TraitItemKind, TraitRef, TyKind,
69 };
70 use rustc_lint::{LateContext, Level, Lint, LintContext};
71 use rustc_middle::hir::exports::Export;
72 use rustc_middle::hir::map::Map;
73 use rustc_middle::ty as rustc_ty;
74 use rustc_middle::ty::{layout::IntegerExt, DefIdTree, Ty, TyCtxt, TypeFoldable};
75 use rustc_semver::RustcVersion;
76 use rustc_session::Session;
77 use rustc_span::hygiene::{ExpnKind, MacroKind};
78 use rustc_span::source_map::original_sp;
79 use rustc_span::sym;
80 use rustc_span::symbol::{kw, Symbol};
81 use rustc_span::{Span, DUMMY_SP};
82 use rustc_target::abi::Integer;
83
84 use crate::consts::{constant, Constant};
85 use crate::ty::is_recursively_primitive_type;
86
87 pub fn parse_msrv(msrv: &str, sess: Option<&Session>, span: Option<Span>) -> Option<RustcVersion> {
88     if let Ok(version) = RustcVersion::parse(msrv) {
89         return Some(version);
90     } else if let Some(sess) = sess {
91         if let Some(span) = span {
92             sess.span_err(span, &format!("`{}` is not a valid Rust version", msrv));
93         }
94     }
95     None
96 }
97
98 pub fn meets_msrv(msrv: Option<&RustcVersion>, lint_msrv: &RustcVersion) -> bool {
99     msrv.map_or(true, |msrv| msrv.meets(*lint_msrv))
100 }
101
102 #[macro_export]
103 macro_rules! extract_msrv_attr {
104     (LateContext) => {
105         extract_msrv_attr!(@LateContext, ());
106     };
107     (EarlyContext) => {
108         extract_msrv_attr!(@EarlyContext);
109     };
110     (@$context:ident$(, $call:tt)?) => {
111         fn enter_lint_attrs(&mut self, cx: &rustc_lint::$context<'tcx>, attrs: &'tcx [rustc_ast::ast::Attribute]) {
112             use $crate::get_unique_inner_attr;
113             match get_unique_inner_attr(cx.sess$($call)?, attrs, "msrv") {
114                 Some(msrv_attr) => {
115                     if let Some(msrv) = msrv_attr.value_str() {
116                         self.msrv = $crate::parse_msrv(
117                             &msrv.to_string(),
118                             Some(cx.sess$($call)?),
119                             Some(msrv_attr.span),
120                         );
121                     } else {
122                         cx.sess$($call)?.span_err(msrv_attr.span, "bad clippy attribute");
123                     }
124                 },
125                 _ => (),
126             }
127         }
128     };
129 }
130
131 /// Returns `true` if the two spans come from differing expansions (i.e., one is
132 /// from a macro and one isn't).
133 #[must_use]
134 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
135     rhs.ctxt() != lhs.ctxt()
136 }
137
138 /// If the given expression is a local binding, find the initializer expression.
139 /// If that initializer expression is another local binding, find its initializer again.
140 /// This process repeats as long as possible (but usually no more than once). Initializer
141 /// expressions with adjustments are ignored. If this is not desired, use [`find_binding_init`]
142 /// instead.
143 ///
144 /// Examples:
145 /// ```ignore
146 /// let abc = 1;
147 /// //        ^ output
148 /// let def = abc;
149 /// dbg!(def)
150 /// //   ^^^ input
151 ///
152 /// // or...
153 /// let abc = 1;
154 /// let def = abc + 2;
155 /// //        ^^^^^^^ output
156 /// dbg!(def)
157 /// //   ^^^ input
158 /// ```
159 pub fn expr_or_init<'a, 'b, 'tcx: 'b>(cx: &LateContext<'tcx>, mut expr: &'a Expr<'b>) -> &'a Expr<'b> {
160     while let Some(init) = path_to_local(expr)
161         .and_then(|id| find_binding_init(cx, id))
162         .filter(|init| cx.typeck_results().expr_adjustments(init).is_empty())
163     {
164         expr = init;
165     }
166     expr
167 }
168
169 /// Finds the initializer expression for a local binding. Returns `None` if the binding is mutable.
170 /// By only considering immutable bindings, we guarantee that the returned expression represents the
171 /// value of the binding wherever it is referenced.
172 ///
173 /// Example: For `let x = 1`, if the `HirId` of `x` is provided, the `Expr` `1` is returned.
174 /// Note: If you have an expression that references a binding `x`, use `path_to_local` to get the
175 /// canonical binding `HirId`.
176 pub fn find_binding_init<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Expr<'tcx>> {
177     let hir = cx.tcx.hir();
178     if_chain! {
179         if let Some(Node::Binding(pat)) = hir.find(hir_id);
180         if matches!(pat.kind, PatKind::Binding(BindingAnnotation::Unannotated, ..));
181         let parent = hir.get_parent_node(hir_id);
182         if let Some(Node::Local(local)) = hir.find(parent);
183         then {
184             return local.init;
185         }
186     }
187     None
188 }
189
190 /// Returns `true` if the given `NodeId` is inside a constant context
191 ///
192 /// # Example
193 ///
194 /// ```rust,ignore
195 /// if in_constant(cx, expr.hir_id) {
196 ///     // Do something
197 /// }
198 /// ```
199 pub fn in_constant(cx: &LateContext<'_>, id: HirId) -> bool {
200     let parent_id = cx.tcx.hir().get_parent_item(id);
201     match cx.tcx.hir().get(parent_id) {
202         Node::Item(&Item {
203             kind: ItemKind::Const(..) | ItemKind::Static(..),
204             ..
205         })
206         | Node::TraitItem(&TraitItem {
207             kind: TraitItemKind::Const(..),
208             ..
209         })
210         | Node::ImplItem(&ImplItem {
211             kind: ImplItemKind::Const(..),
212             ..
213         })
214         | Node::AnonConst(_) => true,
215         Node::Item(&Item {
216             kind: ItemKind::Fn(ref sig, ..),
217             ..
218         })
219         | Node::ImplItem(&ImplItem {
220             kind: ImplItemKind::Fn(ref sig, _),
221             ..
222         }) => sig.header.constness == Constness::Const,
223         _ => false,
224     }
225 }
226
227 /// Checks if a `QPath` resolves to a constructor of a `LangItem`.
228 /// For example, use this to check whether a function call or a pattern is `Some(..)`.
229 pub fn is_lang_ctor(cx: &LateContext<'_>, qpath: &QPath<'_>, lang_item: LangItem) -> bool {
230     if let QPath::Resolved(_, path) = qpath {
231         if let Res::Def(DefKind::Ctor(..), ctor_id) = path.res {
232             if let Ok(item_id) = cx.tcx.lang_items().require(lang_item) {
233                 return cx.tcx.parent(ctor_id) == Some(item_id);
234             }
235         }
236     }
237     false
238 }
239
240 /// Returns `true` if this `span` was expanded by any macro.
241 #[must_use]
242 pub fn in_macro(span: Span) -> bool {
243     if span.from_expansion() {
244         !matches!(span.ctxt().outer_expn_data().kind, ExpnKind::Desugaring(..))
245     } else {
246         false
247     }
248 }
249
250 /// Checks if given pattern is a wildcard (`_`)
251 pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
252     matches!(pat.kind, PatKind::Wild)
253 }
254
255 /// Checks if the first type parameter is a lang item.
256 pub fn is_ty_param_lang_item(cx: &LateContext<'_>, qpath: &QPath<'tcx>, item: LangItem) -> Option<&'tcx hir::Ty<'tcx>> {
257     let ty = get_qpath_generic_tys(qpath).next()?;
258
259     if let TyKind::Path(qpath) = &ty.kind {
260         cx.qpath_res(qpath, ty.hir_id)
261             .opt_def_id()
262             .map_or(false, |id| {
263                 cx.tcx.lang_items().require(item).map_or(false, |lang_id| id == lang_id)
264             })
265             .then(|| ty)
266     } else {
267         None
268     }
269 }
270
271 /// Checks if the first type parameter is a diagnostic item.
272 pub fn is_ty_param_diagnostic_item(
273     cx: &LateContext<'_>,
274     qpath: &QPath<'tcx>,
275     item: Symbol,
276 ) -> Option<&'tcx hir::Ty<'tcx>> {
277     let ty = get_qpath_generic_tys(qpath).next()?;
278
279     if let TyKind::Path(qpath) = &ty.kind {
280         cx.qpath_res(qpath, ty.hir_id)
281             .opt_def_id()
282             .map_or(false, |id| cx.tcx.is_diagnostic_item(item, id))
283             .then(|| ty)
284     } else {
285         None
286     }
287 }
288
289 /// Checks if the method call given in `expr` belongs to the given trait.
290 /// This is a deprecated function, consider using [`is_trait_method`].
291 pub fn match_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, path: &[&str]) -> bool {
292     let def_id = cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
293     let trt_id = cx.tcx.trait_of_item(def_id);
294     trt_id.map_or(false, |trt_id| match_def_path(cx, trt_id, path))
295 }
296
297 /// Checks if a method is defined in an impl of a diagnostic item
298 pub fn is_diag_item_method(cx: &LateContext<'_>, def_id: DefId, diag_item: Symbol) -> bool {
299     if let Some(impl_did) = cx.tcx.impl_of_method(def_id) {
300         if let Some(adt) = cx.tcx.type_of(impl_did).ty_adt_def() {
301             return cx.tcx.is_diagnostic_item(diag_item, adt.did);
302         }
303     }
304     false
305 }
306
307 /// Checks if a method is in a diagnostic item trait
308 pub fn is_diag_trait_item(cx: &LateContext<'_>, def_id: DefId, diag_item: Symbol) -> bool {
309     if let Some(trait_did) = cx.tcx.trait_of_item(def_id) {
310         return cx.tcx.is_diagnostic_item(diag_item, trait_did);
311     }
312     false
313 }
314
315 /// Checks if the method call given in `expr` belongs to the given trait.
316 pub fn is_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, diag_item: Symbol) -> bool {
317     cx.typeck_results()
318         .type_dependent_def_id(expr.hir_id)
319         .map_or(false, |did| is_diag_trait_item(cx, did, diag_item))
320 }
321
322 /// Checks if an expression references a variable of the given name.
323 pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
324     if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
325         if let [p] = path.segments {
326             return p.ident.name == var;
327         }
328     }
329     false
330 }
331
332 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
333     match *path {
334         QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
335         QPath::TypeRelative(_, ref seg) => seg,
336         QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
337     }
338 }
339
340 pub fn get_qpath_generics(path: &QPath<'tcx>) -> Option<&'tcx GenericArgs<'tcx>> {
341     match path {
342         QPath::Resolved(_, p) => p.segments.last().and_then(|s| s.args),
343         QPath::TypeRelative(_, s) => s.args,
344         QPath::LangItem(..) => None,
345     }
346 }
347
348 pub fn get_qpath_generic_tys(path: &QPath<'tcx>) -> impl Iterator<Item = &'tcx hir::Ty<'tcx>> {
349     get_qpath_generics(path)
350         .map_or([].as_ref(), |a| a.args)
351         .iter()
352         .filter_map(|a| {
353             if let hir::GenericArg::Type(ty) = a {
354                 Some(ty)
355             } else {
356                 None
357             }
358         })
359 }
360
361 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
362     match *path {
363         QPath::Resolved(_, ref path) => path.segments.get(0),
364         QPath::TypeRelative(_, ref seg) => Some(seg),
365         QPath::LangItem(..) => None,
366     }
367 }
368
369 /// THIS METHOD IS DEPRECATED and will eventually be removed since it does not match against the
370 /// entire path or resolved `DefId`. Prefer using `match_def_path`. Consider getting a `DefId` from
371 /// `QPath::Resolved.1.res.opt_def_id()`.
372 ///
373 /// Matches a `QPath` against a slice of segment string literals.
374 ///
375 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
376 /// `rustc_hir::QPath`.
377 ///
378 /// # Examples
379 /// ```rust,ignore
380 /// match_qpath(path, &["std", "rt", "begin_unwind"])
381 /// ```
382 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
383     match *path {
384         QPath::Resolved(_, ref path) => match_path(path, segments),
385         QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
386             TyKind::Path(ref inner_path) => {
387                 if let [prefix @ .., end] = segments {
388                     if match_qpath(inner_path, prefix) {
389                         return segment.ident.name.as_str() == *end;
390                     }
391                 }
392                 false
393             },
394             _ => false,
395         },
396         QPath::LangItem(..) => false,
397     }
398 }
399
400 /// THIS METHOD IS DEPRECATED and will eventually be removed since it does not match against the
401 /// entire path or resolved `DefId`. Prefer using `match_def_path`. Consider getting a `DefId` from
402 /// `QPath::Resolved.1.res.opt_def_id()`.
403 ///
404 /// Matches a `Path` against a slice of segment string literals.
405 ///
406 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
407 /// `rustc_hir::Path`.
408 ///
409 /// # Examples
410 ///
411 /// ```rust,ignore
412 /// if match_path(&trait_ref.path, &paths::HASH) {
413 ///     // This is the `std::hash::Hash` trait.
414 /// }
415 ///
416 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
417 ///     // This is a `rustc_middle::lint::Lint`.
418 /// }
419 /// ```
420 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
421     path.segments
422         .iter()
423         .rev()
424         .zip(segments.iter().rev())
425         .all(|(a, b)| a.ident.name.as_str() == *b)
426 }
427
428 /// Matches a `Path` against a slice of segment string literals, e.g.
429 ///
430 /// # Examples
431 /// ```rust,ignore
432 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
433 /// ```
434 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
435     path.segments
436         .iter()
437         .rev()
438         .zip(segments.iter().rev())
439         .all(|(a, b)| a.ident.name.as_str() == *b)
440 }
441
442 /// If the expression is a path to a local, returns the canonical `HirId` of the local.
443 pub fn path_to_local(expr: &Expr<'_>) -> Option<HirId> {
444     if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
445         if let Res::Local(id) = path.res {
446             return Some(id);
447         }
448     }
449     None
450 }
451
452 /// Returns true if the expression is a path to a local with the specified `HirId`.
453 /// Use this function to see if an expression matches a function argument or a match binding.
454 pub fn path_to_local_id(expr: &Expr<'_>, id: HirId) -> bool {
455     path_to_local(expr) == Some(id)
456 }
457
458 /// Gets the definition associated to a path.
459 #[allow(clippy::shadow_unrelated)] // false positive #6563
460 pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Res {
461     macro_rules! try_res {
462         ($e:expr) => {
463             match $e {
464                 Some(e) => e,
465                 None => return Res::Err,
466             }
467         };
468     }
469     fn item_child_by_name<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId, name: &str) -> Option<&'tcx Export<HirId>> {
470         tcx.item_children(def_id)
471             .iter()
472             .find(|item| item.ident.name.as_str() == name)
473     }
474
475     let (krate, first, path) = match *path {
476         [krate, first, ref path @ ..] => (krate, first, path),
477         _ => return Res::Err,
478     };
479     let tcx = cx.tcx;
480     let crates = tcx.crates();
481     let krate = try_res!(crates.iter().find(|&&num| tcx.crate_name(num).as_str() == krate));
482     let first = try_res!(item_child_by_name(tcx, krate.as_def_id(), first));
483     let last = path
484         .iter()
485         .copied()
486         // `get_def_path` seems to generate these empty segments for extern blocks.
487         // We can just ignore them.
488         .filter(|segment| !segment.is_empty())
489         // for each segment, find the child item
490         .try_fold(first, |item, segment| {
491             let def_id = item.res.def_id();
492             if let Some(item) = item_child_by_name(tcx, def_id, segment) {
493                 Some(item)
494             } else if matches!(item.res, Res::Def(DefKind::Enum | DefKind::Struct, _)) {
495                 // it is not a child item so check inherent impl items
496                 tcx.inherent_impls(def_id)
497                     .iter()
498                     .find_map(|&impl_def_id| item_child_by_name(tcx, impl_def_id, segment))
499             } else {
500                 None
501             }
502         });
503     try_res!(last).res
504 }
505
506 /// Convenience function to get the `DefId` of a trait by path.
507 /// It could be a trait or trait alias.
508 pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
509     match path_to_res(cx, path) {
510         Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
511         _ => None,
512     }
513 }
514
515 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
516 ///
517 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
518 ///
519 /// ```rust
520 /// struct Point(isize, isize);
521 ///
522 /// impl std::ops::Add for Point {
523 ///     type Output = Self;
524 ///
525 ///     fn add(self, other: Self) -> Self {
526 ///         Point(0, 0)
527 ///     }
528 /// }
529 /// ```
530 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
531     // Get the implemented trait for the current function
532     let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
533     if_chain! {
534         if parent_impl != hir::CRATE_HIR_ID;
535         if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
536         if let hir::ItemKind::Impl(impl_) = &item.kind;
537         then { return impl_.of_trait.as_ref(); }
538     }
539     None
540 }
541
542 /// Returns the method names and argument list of nested method call expressions that make up
543 /// `expr`. method/span lists are sorted with the most recent call first.
544 pub fn method_calls<'tcx>(
545     expr: &'tcx Expr<'tcx>,
546     max_depth: usize,
547 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
548     let mut method_names = Vec::with_capacity(max_depth);
549     let mut arg_lists = Vec::with_capacity(max_depth);
550     let mut spans = Vec::with_capacity(max_depth);
551
552     let mut current = expr;
553     for _ in 0..max_depth {
554         if let ExprKind::MethodCall(path, span, args, _) = &current.kind {
555             if args.iter().any(|e| e.span.from_expansion()) {
556                 break;
557             }
558             method_names.push(path.ident.name);
559             arg_lists.push(&**args);
560             spans.push(*span);
561             current = &args[0];
562         } else {
563             break;
564         }
565     }
566
567     (method_names, arg_lists, spans)
568 }
569
570 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
571 ///
572 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
573 /// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
574 /// containing the `Expr`s for
575 /// `.bar()` and `.baz()`
576 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
577     let mut current = expr;
578     let mut matched = Vec::with_capacity(methods.len());
579     for method_name in methods.iter().rev() {
580         // method chains are stored last -> first
581         if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
582             if path.ident.name.as_str() == *method_name {
583                 if args.iter().any(|e| e.span.from_expansion()) {
584                     return None;
585                 }
586                 matched.push(&**args); // build up `matched` backwards
587                 current = &args[0] // go to parent expression
588             } else {
589                 return None;
590             }
591         } else {
592             return None;
593         }
594     }
595     // Reverse `matched` so that it is in the same order as `methods`.
596     matched.reverse();
597     Some(matched)
598 }
599
600 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
601 pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
602     cx.tcx
603         .entry_fn(LOCAL_CRATE)
604         .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
605 }
606
607 /// Returns `true` if the expression is in the program's `#[panic_handler]`.
608 pub fn is_in_panic_handler(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
609     let parent = cx.tcx.hir().get_parent_item(e.hir_id);
610     let def_id = cx.tcx.hir().local_def_id(parent).to_def_id();
611     Some(def_id) == cx.tcx.lang_items().panic_impl()
612 }
613
614 /// Gets the name of the item the expression is in, if available.
615 pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
616     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
617     match cx.tcx.hir().find(parent_id) {
618         Some(
619             Node::Item(Item { ident, .. })
620             | Node::TraitItem(TraitItem { ident, .. })
621             | Node::ImplItem(ImplItem { ident, .. }),
622         ) => Some(ident.name),
623         _ => None,
624     }
625 }
626
627 /// Gets the name of a `Pat`, if any.
628 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
629     match pat.kind {
630         PatKind::Binding(.., ref spname, _) => Some(spname.name),
631         PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
632         PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
633         _ => None,
634     }
635 }
636
637 pub struct ContainsName {
638     pub name: Symbol,
639     pub result: bool,
640 }
641
642 impl<'tcx> Visitor<'tcx> for ContainsName {
643     type Map = Map<'tcx>;
644
645     fn visit_name(&mut self, _: Span, name: Symbol) {
646         if self.name == name {
647             self.result = true;
648         }
649     }
650     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
651         NestedVisitorMap::None
652     }
653 }
654
655 /// Checks if an `Expr` contains a certain name.
656 pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
657     let mut cn = ContainsName { name, result: false };
658     cn.visit_expr(expr);
659     cn.result
660 }
661
662 /// Returns `true` if `expr` contains a return expression
663 pub fn contains_return(expr: &hir::Expr<'_>) -> bool {
664     struct RetCallFinder {
665         found: bool,
666     }
667
668     impl<'tcx> hir::intravisit::Visitor<'tcx> for RetCallFinder {
669         type Map = Map<'tcx>;
670
671         fn visit_expr(&mut self, expr: &'tcx hir::Expr<'_>) {
672             if self.found {
673                 return;
674             }
675             if let hir::ExprKind::Ret(..) = &expr.kind {
676                 self.found = true;
677             } else {
678                 hir::intravisit::walk_expr(self, expr);
679             }
680         }
681
682         fn nested_visit_map(&mut self) -> hir::intravisit::NestedVisitorMap<Self::Map> {
683             hir::intravisit::NestedVisitorMap::None
684         }
685     }
686
687     let mut visitor = RetCallFinder { found: false };
688     visitor.visit_expr(expr);
689     visitor.found
690 }
691
692 struct FindMacroCalls<'a, 'b> {
693     names: &'a [&'b str],
694     result: Vec<Span>,
695 }
696
697 impl<'a, 'b, 'tcx> Visitor<'tcx> for FindMacroCalls<'a, 'b> {
698     type Map = Map<'tcx>;
699
700     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
701         if self.names.iter().any(|fun| is_expn_of(expr.span, fun).is_some()) {
702             self.result.push(expr.span);
703         }
704         // and check sub-expressions
705         intravisit::walk_expr(self, expr);
706     }
707
708     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
709         NestedVisitorMap::None
710     }
711 }
712
713 /// Finds calls of the specified macros in a function body.
714 pub fn find_macro_calls(names: &[&str], body: &Body<'_>) -> Vec<Span> {
715     let mut fmc = FindMacroCalls {
716         names,
717         result: Vec::new(),
718     };
719     fmc.visit_expr(&body.value);
720     fmc.result
721 }
722
723 /// Extends the span to the beginning of the spans line, incl. whitespaces.
724 ///
725 /// ```rust,ignore
726 ///        let x = ();
727 /// //             ^^
728 /// // will be converted to
729 ///        let x = ();
730 /// // ^^^^^^^^^^^^^^
731 /// ```
732 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
733     let span = original_sp(span, DUMMY_SP);
734     let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
735     let line_no = source_map_and_line.line;
736     let line_start = source_map_and_line.sf.lines[line_no];
737     Span::new(line_start, span.hi(), span.ctxt())
738 }
739
740 /// Gets the parent node, if any.
741 pub fn get_parent_node(tcx: TyCtxt<'_>, id: HirId) -> Option<Node<'_>> {
742     tcx.hir().parent_iter(id).next().map(|(_, node)| node)
743 }
744
745 /// Gets the parent expression, if any â€“- this is useful to constrain a lint.
746 pub fn get_parent_expr<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
747     match get_parent_node(cx.tcx, e.hir_id) {
748         Some(Node::Expr(parent)) => Some(parent),
749         _ => None,
750     }
751 }
752
753 pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
754     let map = &cx.tcx.hir();
755     let enclosing_node = map
756         .get_enclosing_scope(hir_id)
757         .and_then(|enclosing_id| map.find(enclosing_id));
758     enclosing_node.and_then(|node| match node {
759         Node::Block(block) => Some(block),
760         Node::Item(&Item {
761             kind: ItemKind::Fn(_, _, eid),
762             ..
763         })
764         | Node::ImplItem(&ImplItem {
765             kind: ImplItemKind::Fn(_, eid),
766             ..
767         }) => match cx.tcx.hir().body(eid).value.kind {
768             ExprKind::Block(ref block, _) => Some(block),
769             _ => None,
770         },
771         _ => None,
772     })
773 }
774
775 /// Gets the parent node if it's an impl block.
776 pub fn get_parent_as_impl(tcx: TyCtxt<'_>, id: HirId) -> Option<&Impl<'_>> {
777     let map = tcx.hir();
778     match map.parent_iter(id).next() {
779         Some((
780             _,
781             Node::Item(Item {
782                 kind: ItemKind::Impl(imp),
783                 ..
784             }),
785         )) => Some(imp),
786         _ => None,
787     }
788 }
789
790 /// Checks if the given expression is the else clause of either an `if` or `if let` expression.
791 pub fn is_else_clause(tcx: TyCtxt<'_>, expr: &Expr<'_>) -> bool {
792     let map = tcx.hir();
793     let mut iter = map.parent_iter(expr.hir_id);
794     match iter.next() {
795         Some((arm_id, Node::Arm(..))) => matches!(
796             iter.next(),
797             Some((
798                 _,
799                 Node::Expr(Expr {
800                     kind: ExprKind::Match(_, [_, else_arm], MatchSource::IfLetDesugar { .. }),
801                     ..
802                 })
803             ))
804             if else_arm.hir_id == arm_id
805         ),
806         Some((
807             _,
808             Node::Expr(Expr {
809                 kind: ExprKind::If(_, _, Some(else_expr)),
810                 ..
811             }),
812         )) => else_expr.hir_id == expr.hir_id,
813         _ => false,
814     }
815 }
816
817 /// Checks whether the given expression is a constant integer of the given value.
818 /// unlike `is_integer_literal`, this version does const folding
819 pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
820     if is_integer_literal(e, value) {
821         return true;
822     }
823     let map = cx.tcx.hir();
824     let parent_item = map.get_parent_item(e.hir_id);
825     if let Some((Constant::Int(v), _)) = map
826         .maybe_body_owned_by(parent_item)
827         .and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
828     {
829         value == v
830     } else {
831         false
832     }
833 }
834
835 /// Checks whether the given expression is a constant literal of the given value.
836 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
837     // FIXME: use constant folding
838     if let ExprKind::Lit(ref spanned) = expr.kind {
839         if let LitKind::Int(v, _) = spanned.node {
840             return v == value;
841         }
842     }
843     false
844 }
845
846 /// Returns `true` if the given `Expr` has been coerced before.
847 ///
848 /// Examples of coercions can be found in the Nomicon at
849 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
850 ///
851 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
852 /// information on adjustments and coercions.
853 pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
854     cx.typeck_results().adjustments().get(e.hir_id).is_some()
855 }
856
857 /// Returns the pre-expansion span if is this comes from an expansion of the
858 /// macro `name`.
859 /// See also `is_direct_expn_of`.
860 #[must_use]
861 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
862     loop {
863         if span.from_expansion() {
864             let data = span.ctxt().outer_expn_data();
865             let new_span = data.call_site;
866
867             if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
868                 if mac_name.as_str() == name {
869                     return Some(new_span);
870                 }
871             }
872
873             span = new_span;
874         } else {
875             return None;
876         }
877     }
878 }
879
880 /// Returns the pre-expansion span if the span directly comes from an expansion
881 /// of the macro `name`.
882 /// The difference with `is_expn_of` is that in
883 /// ```rust,ignore
884 /// foo!(bar!(42));
885 /// ```
886 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
887 /// `bar!` by
888 /// `is_direct_expn_of`.
889 #[must_use]
890 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
891     if span.from_expansion() {
892         let data = span.ctxt().outer_expn_data();
893         let new_span = data.call_site;
894
895         if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
896             if mac_name.as_str() == name {
897                 return Some(new_span);
898             }
899         }
900     }
901
902     None
903 }
904
905 /// Convenience function to get the return type of a function.
906 pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
907     let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
908     let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
909     cx.tcx.erase_late_bound_regions(ret_ty)
910 }
911
912 /// Checks if an expression is constructing a tuple-like enum variant or struct
913 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
914     if let ExprKind::Call(ref fun, _) = expr.kind {
915         if let ExprKind::Path(ref qp) = fun.kind {
916             let res = cx.qpath_res(qp, fun.hir_id);
917             return match res {
918                 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
919                 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
920                 _ => false,
921             };
922         }
923     }
924     false
925 }
926
927 /// Returns `true` if a pattern is refutable.
928 // TODO: should be implemented using rustc/mir_build/thir machinery
929 pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
930     fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
931         matches!(
932             cx.qpath_res(qpath, id),
933             def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
934         )
935     }
936
937     fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
938         i.any(|pat| is_refutable(cx, pat))
939     }
940
941     match pat.kind {
942         PatKind::Wild => false,
943         PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
944         PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
945         PatKind::Lit(..) | PatKind::Range(..) => true,
946         PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
947         PatKind::Or(ref pats) => {
948             // TODO: should be the honest check, that pats is exhaustive set
949             are_refutable(cx, pats.iter().map(|pat| &**pat))
950         },
951         PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
952         PatKind::Struct(ref qpath, ref fields, _) => {
953             is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
954         },
955         PatKind::TupleStruct(ref qpath, ref pats, _) => {
956             is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
957         },
958         PatKind::Slice(ref head, ref middle, ref tail) => {
959             match &cx.typeck_results().node_type(pat.hir_id).kind() {
960                 rustc_ty::Slice(..) => {
961                     // [..] is the only irrefutable slice pattern.
962                     !head.is_empty() || middle.is_none() || !tail.is_empty()
963                 },
964                 rustc_ty::Array(..) => {
965                     are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
966                 },
967                 _ => {
968                     // unreachable!()
969                     true
970                 },
971             }
972         },
973     }
974 }
975
976 /// If the pattern is an `or` pattern, call the function once for each sub pattern. Otherwise, call
977 /// the function once on the given pattern.
978 pub fn recurse_or_patterns<'tcx, F: FnMut(&'tcx Pat<'tcx>)>(pat: &'tcx Pat<'tcx>, mut f: F) {
979     if let PatKind::Or(pats) = pat.kind {
980         pats.iter().cloned().for_each(f)
981     } else {
982         f(pat)
983     }
984 }
985
986 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
987 /// implementations have.
988 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
989     attrs.iter().any(|attr| attr.has_name(sym::automatically_derived))
990 }
991
992 /// Remove blocks around an expression.
993 ///
994 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
995 /// themselves.
996 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
997     while let ExprKind::Block(ref block, ..) = expr.kind {
998         match (block.stmts.is_empty(), block.expr.as_ref()) {
999             (true, Some(e)) => expr = e,
1000             _ => break,
1001         }
1002     }
1003     expr
1004 }
1005
1006 pub fn is_self(slf: &Param<'_>) -> bool {
1007     if let PatKind::Binding(.., name, _) = slf.pat.kind {
1008         name.name == kw::SelfLower
1009     } else {
1010         false
1011     }
1012 }
1013
1014 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
1015     if_chain! {
1016         if let TyKind::Path(QPath::Resolved(None, ref path)) = slf.kind;
1017         if let Res::SelfTy(..) = path.res;
1018         then {
1019             return true
1020         }
1021     }
1022     false
1023 }
1024
1025 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1026     (0..decl.inputs.len()).map(move |i| &body.params[i])
1027 }
1028
1029 /// Checks if a given expression is a match expression expanded from the `?`
1030 /// operator or the `try` macro.
1031 pub fn is_try<'tcx>(cx: &LateContext<'_>, expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1032     fn is_ok(cx: &LateContext<'_>, arm: &Arm<'_>) -> bool {
1033         if_chain! {
1034             if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1035             if is_lang_ctor(cx, path, ResultOk);
1036             if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1037             if path_to_local_id(arm.body, hir_id);
1038             then {
1039                 return true;
1040             }
1041         }
1042         false
1043     }
1044
1045     fn is_err(cx: &LateContext<'_>, arm: &Arm<'_>) -> bool {
1046         if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1047             is_lang_ctor(cx, path, ResultErr)
1048         } else {
1049             false
1050         }
1051     }
1052
1053     if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1054         // desugared from a `?` operator
1055         if let MatchSource::TryDesugar = *source {
1056             return Some(expr);
1057         }
1058
1059         if_chain! {
1060             if arms.len() == 2;
1061             if arms[0].guard.is_none();
1062             if arms[1].guard.is_none();
1063             if (is_ok(cx, &arms[0]) && is_err(cx, &arms[1])) ||
1064                 (is_ok(cx, &arms[1]) && is_err(cx, &arms[0]));
1065             then {
1066                 return Some(expr);
1067             }
1068         }
1069     }
1070
1071     None
1072 }
1073
1074 /// Returns `true` if the lint is allowed in the current context
1075 ///
1076 /// Useful for skipping long running code when it's unnecessary
1077 pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
1078     cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1079 }
1080
1081 pub fn strip_pat_refs<'hir>(mut pat: &'hir Pat<'hir>) -> &'hir Pat<'hir> {
1082     while let PatKind::Ref(subpat, _) = pat.kind {
1083         pat = subpat;
1084     }
1085     pat
1086 }
1087
1088 pub fn int_bits(tcx: TyCtxt<'_>, ity: rustc_ty::IntTy) -> u64 {
1089     Integer::from_int_ty(&tcx, ity).size().bits()
1090 }
1091
1092 #[allow(clippy::cast_possible_wrap)]
1093 /// Turn a constant int byte representation into an i128
1094 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: rustc_ty::IntTy) -> i128 {
1095     let amt = 128 - int_bits(tcx, ity);
1096     ((u as i128) << amt) >> amt
1097 }
1098
1099 #[allow(clippy::cast_sign_loss)]
1100 /// clip unused bytes
1101 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: rustc_ty::IntTy) -> u128 {
1102     let amt = 128 - int_bits(tcx, ity);
1103     ((u as u128) << amt) >> amt
1104 }
1105
1106 /// clip unused bytes
1107 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: rustc_ty::UintTy) -> u128 {
1108     let bits = Integer::from_uint_ty(&tcx, ity).size().bits();
1109     let amt = 128 - bits;
1110     (u << amt) >> amt
1111 }
1112
1113 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1114     let map = &tcx.hir();
1115     let mut prev_enclosing_node = None;
1116     let mut enclosing_node = node;
1117     while Some(enclosing_node) != prev_enclosing_node {
1118         if is_automatically_derived(map.attrs(enclosing_node)) {
1119             return true;
1120         }
1121         prev_enclosing_node = Some(enclosing_node);
1122         enclosing_node = map.get_parent_item(enclosing_node);
1123     }
1124     false
1125 }
1126
1127 /// Matches a function call with the given path and returns the arguments.
1128 ///
1129 /// Usage:
1130 ///
1131 /// ```rust,ignore
1132 /// if let Some(args) = match_function_call(cx, cmp_max_call, &paths::CMP_MAX);
1133 /// ```
1134 pub fn match_function_call<'tcx>(
1135     cx: &LateContext<'tcx>,
1136     expr: &'tcx Expr<'_>,
1137     path: &[&str],
1138 ) -> Option<&'tcx [Expr<'tcx>]> {
1139     if_chain! {
1140         if let ExprKind::Call(ref fun, ref args) = expr.kind;
1141         if let ExprKind::Path(ref qpath) = fun.kind;
1142         if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
1143         if match_def_path(cx, fun_def_id, path);
1144         then {
1145             return Some(&args)
1146         }
1147     };
1148     None
1149 }
1150
1151 pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
1152     // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1153     // accepts only that. We should probably move to Symbols in Clippy as well.
1154     let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1155     cx.match_def_path(did, &syms)
1156 }
1157
1158 pub fn match_panic_call<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<&'tcx [Expr<'tcx>]> {
1159     match_function_call(cx, expr, &paths::BEGIN_PANIC)
1160         .or_else(|| match_function_call(cx, expr, &paths::BEGIN_PANIC_FMT))
1161         .or_else(|| match_function_call(cx, expr, &paths::PANIC_ANY))
1162         .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC))
1163         .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_FMT))
1164         .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_STR))
1165 }
1166
1167 pub fn match_panic_def_id(cx: &LateContext<'_>, did: DefId) -> bool {
1168     match_def_path(cx, did, &paths::BEGIN_PANIC)
1169         || match_def_path(cx, did, &paths::BEGIN_PANIC_FMT)
1170         || match_def_path(cx, did, &paths::PANIC_ANY)
1171         || match_def_path(cx, did, &paths::PANICKING_PANIC)
1172         || match_def_path(cx, did, &paths::PANICKING_PANIC_FMT)
1173         || match_def_path(cx, did, &paths::PANICKING_PANIC_STR)
1174 }
1175
1176 /// Returns the list of condition expressions and the list of blocks in a
1177 /// sequence of `if/else`.
1178 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1179 /// `if a { c } else if b { d } else { e }`.
1180 pub fn if_sequence<'tcx>(mut expr: &'tcx Expr<'tcx>) -> (Vec<&'tcx Expr<'tcx>>, Vec<&'tcx Block<'tcx>>) {
1181     let mut conds = Vec::new();
1182     let mut blocks: Vec<&Block<'_>> = Vec::new();
1183
1184     while let ExprKind::If(ref cond, ref then_expr, ref else_expr) = expr.kind {
1185         conds.push(&**cond);
1186         if let ExprKind::Block(ref block, _) = then_expr.kind {
1187             blocks.push(block);
1188         } else {
1189             panic!("ExprKind::If node is not an ExprKind::Block");
1190         }
1191
1192         if let Some(ref else_expr) = *else_expr {
1193             expr = else_expr;
1194         } else {
1195             break;
1196         }
1197     }
1198
1199     // final `else {..}`
1200     if !blocks.is_empty() {
1201         if let ExprKind::Block(ref block, _) = expr.kind {
1202             blocks.push(&**block);
1203         }
1204     }
1205
1206     (conds, blocks)
1207 }
1208
1209 /// This function returns true if the given expression is the `else` or `if else` part of an if
1210 /// statement
1211 pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
1212     let map = cx.tcx.hir();
1213     let parent_id = map.get_parent_node(expr.hir_id);
1214     let parent_node = map.get(parent_id);
1215     matches!(
1216         parent_node,
1217         Node::Expr(Expr {
1218             kind: ExprKind::If(_, _, _),
1219             ..
1220         })
1221     )
1222 }
1223
1224 // Finds the `#[must_use]` attribute, if any
1225 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1226     attrs.iter().find(|a| a.has_name(sym::must_use))
1227 }
1228
1229 // check if expr is calling method or function with #[must_use] attribute
1230 pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1231     let did = match expr.kind {
1232         ExprKind::Call(ref path, _) => if_chain! {
1233             if let ExprKind::Path(ref qpath) = path.kind;
1234             if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
1235             then {
1236                 Some(did)
1237             } else {
1238                 None
1239             }
1240         },
1241         ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1242         _ => None,
1243     };
1244
1245     did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
1246 }
1247
1248 pub fn get_expr_use_node(tcx: TyCtxt<'tcx>, expr: &Expr<'_>) -> Option<Node<'tcx>> {
1249     let map = tcx.hir();
1250     let mut child_id = expr.hir_id;
1251     let mut iter = map.parent_iter(child_id);
1252     loop {
1253         match iter.next() {
1254             None => break None,
1255             Some((id, Node::Block(_))) => child_id = id,
1256             Some((id, Node::Arm(arm))) if arm.body.hir_id == child_id => child_id = id,
1257             Some((_, Node::Expr(expr))) => match expr.kind {
1258                 ExprKind::Break(
1259                     Destination {
1260                         target_id: Ok(dest), ..
1261                     },
1262                     _,
1263                 ) => {
1264                     iter = map.parent_iter(dest);
1265                     child_id = dest;
1266                 },
1267                 ExprKind::DropTemps(_) | ExprKind::Block(..) => child_id = expr.hir_id,
1268                 ExprKind::If(control_expr, ..) | ExprKind::Match(control_expr, ..)
1269                     if control_expr.hir_id != child_id =>
1270                 {
1271                     child_id = expr.hir_id
1272                 },
1273                 _ => break Some(Node::Expr(expr)),
1274             },
1275             Some((_, node)) => break Some(node),
1276         }
1277     }
1278 }
1279
1280 pub fn is_expr_used(tcx: TyCtxt<'_>, expr: &Expr<'_>) -> bool {
1281     !matches!(
1282         get_expr_use_node(tcx, expr),
1283         Some(Node::Stmt(Stmt {
1284             kind: StmtKind::Expr(_) | StmtKind::Semi(_),
1285             ..
1286         }))
1287     )
1288 }
1289
1290 pub fn get_expr_use_or_unification_node(tcx: TyCtxt<'tcx>, expr: &Expr<'_>) -> Option<Node<'tcx>> {
1291     let map = tcx.hir();
1292     let mut child_id = expr.hir_id;
1293     let mut iter = map.parent_iter(child_id);
1294     loop {
1295         match iter.next() {
1296             None => break None,
1297             Some((id, Node::Block(_))) => child_id = id,
1298             Some((id, Node::Arm(arm))) if arm.body.hir_id == child_id => child_id = id,
1299             Some((_, Node::Expr(expr))) => match expr.kind {
1300                 ExprKind::Match(_, [arm], _) if arm.hir_id == child_id => child_id = expr.hir_id,
1301                 ExprKind::Block(..) | ExprKind::DropTemps(_) => child_id = expr.hir_id,
1302                 ExprKind::If(_, then_expr, None) if then_expr.hir_id == child_id => break None,
1303                 _ => break Some(Node::Expr(expr)),
1304             },
1305             Some((_, node)) => break Some(node),
1306         }
1307     }
1308 }
1309
1310 pub fn is_expr_used_or_unified(tcx: TyCtxt<'_>, expr: &Expr<'_>) -> bool {
1311     !matches!(
1312         get_expr_use_or_unification_node(tcx, expr),
1313         None | Some(Node::Stmt(Stmt {
1314             kind: StmtKind::Expr(_) | StmtKind::Semi(_),
1315             ..
1316         }))
1317     )
1318 }
1319
1320 pub fn is_expr_final_block_expr(tcx: TyCtxt<'_>, expr: &Expr<'_>) -> bool {
1321     matches!(get_parent_node(tcx, expr.hir_id), Some(Node::Block(..)))
1322 }
1323
1324 pub fn is_no_std_crate(cx: &LateContext<'_>) -> bool {
1325     cx.tcx.hir().attrs(hir::CRATE_HIR_ID).iter().any(|attr| {
1326         if let ast::AttrKind::Normal(ref attr, _) = attr.kind {
1327             attr.path == sym::no_std
1328         } else {
1329             false
1330         }
1331     })
1332 }
1333
1334 /// Check if parent of a hir node is a trait implementation block.
1335 /// For example, `f` in
1336 /// ```rust,ignore
1337 /// impl Trait for S {
1338 ///     fn f() {}
1339 /// }
1340 /// ```
1341 pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
1342     if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1343         matches!(item.kind, ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }))
1344     } else {
1345         false
1346     }
1347 }
1348
1349 /// Check if it's even possible to satisfy the `where` clause for the item.
1350 ///
1351 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1352 ///
1353 /// ```ignore
1354 /// fn foo() where i32: Iterator {
1355 ///     for _ in 2i32 {}
1356 /// }
1357 /// ```
1358 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
1359     use rustc_trait_selection::traits;
1360     let predicates = cx
1361         .tcx
1362         .predicates_of(did)
1363         .predicates
1364         .iter()
1365         .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1366     traits::impossible_predicates(
1367         cx.tcx,
1368         traits::elaborate_predicates(cx.tcx, predicates)
1369             .map(|o| o.predicate)
1370             .collect::<Vec<_>>(),
1371     )
1372 }
1373
1374 /// Returns the `DefId` of the callee if the given expression is a function or method call.
1375 pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
1376     match &expr.kind {
1377         ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1378         ExprKind::Call(
1379             Expr {
1380                 kind: ExprKind::Path(qpath),
1381                 hir_id: path_hir_id,
1382                 ..
1383             },
1384             ..,
1385         ) => cx.typeck_results().qpath_res(qpath, *path_hir_id).opt_def_id(),
1386         _ => None,
1387     }
1388 }
1389
1390 /// This function checks if any of the lints in the slice is enabled for the provided `HirId`.
1391 /// A lint counts as enabled with any of the levels: `Level::Forbid` | `Level::Deny` | `Level::Warn`
1392 ///
1393 /// ```ignore
1394 /// #[deny(clippy::YOUR_AWESOME_LINT)]
1395 /// println!("Hello, World!"); // <- Clippy code: run_lints(cx, &[YOUR_AWESOME_LINT], id) == true
1396 ///
1397 /// #[allow(clippy::YOUR_AWESOME_LINT)]
1398 /// println!("See you soon!"); // <- Clippy code: run_lints(cx, &[YOUR_AWESOME_LINT], id) == false
1399 /// ```
1400 pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
1401     lints.iter().any(|lint| {
1402         matches!(
1403             cx.tcx.lint_level_at_node(lint, id),
1404             (Level::Forbid | Level::Deny | Level::Warn, _)
1405         )
1406     })
1407 }
1408
1409 /// Returns Option<String> where String is a textual representation of the type encapsulated in the
1410 /// slice iff the given expression is a slice of primitives (as defined in the
1411 /// `is_recursively_primitive_type` function) and None otherwise.
1412 pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
1413     let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
1414     let expr_kind = expr_type.kind();
1415     let is_primitive = match expr_kind {
1416         rustc_ty::Slice(element_type) => is_recursively_primitive_type(element_type),
1417         rustc_ty::Ref(_, inner_ty, _) if matches!(inner_ty.kind(), &rustc_ty::Slice(_)) => {
1418             if let rustc_ty::Slice(element_type) = inner_ty.kind() {
1419                 is_recursively_primitive_type(element_type)
1420             } else {
1421                 unreachable!()
1422             }
1423         },
1424         _ => false,
1425     };
1426
1427     if is_primitive {
1428         // if we have wrappers like Array, Slice or Tuple, print these
1429         // and get the type enclosed in the slice ref
1430         match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind() {
1431             rustc_ty::Slice(..) => return Some("slice".into()),
1432             rustc_ty::Array(..) => return Some("array".into()),
1433             rustc_ty::Tuple(..) => return Some("tuple".into()),
1434             _ => {
1435                 // is_recursively_primitive_type() should have taken care
1436                 // of the rest and we can rely on the type that is found
1437                 let refs_peeled = expr_type.peel_refs();
1438                 return Some(refs_peeled.walk().last().unwrap().to_string());
1439             },
1440         }
1441     }
1442     None
1443 }
1444
1445 /// returns list of all pairs (a, b) from `exprs` such that `eq(a, b)`
1446 /// `hash` must be comformed with `eq`
1447 pub fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
1448 where
1449     Hash: Fn(&T) -> u64,
1450     Eq: Fn(&T, &T) -> bool,
1451 {
1452     if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
1453         return vec![(&exprs[0], &exprs[1])];
1454     }
1455
1456     let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
1457
1458     let mut map: FxHashMap<_, Vec<&_>> =
1459         FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
1460
1461     for expr in exprs {
1462         match map.entry(hash(expr)) {
1463             Entry::Occupied(mut o) => {
1464                 for o in o.get() {
1465                     if eq(o, expr) {
1466                         match_expr_list.push((o, expr));
1467                     }
1468                 }
1469                 o.get_mut().push(expr);
1470             },
1471             Entry::Vacant(v) => {
1472                 v.insert(vec![expr]);
1473             },
1474         }
1475     }
1476
1477     match_expr_list
1478 }
1479
1480 /// Peels off all references on the pattern. Returns the underlying pattern and the number of
1481 /// references removed.
1482 pub fn peel_hir_pat_refs(pat: &'a Pat<'a>) -> (&'a Pat<'a>, usize) {
1483     fn peel(pat: &'a Pat<'a>, count: usize) -> (&'a Pat<'a>, usize) {
1484         if let PatKind::Ref(pat, _) = pat.kind {
1485             peel(pat, count + 1)
1486         } else {
1487             (pat, count)
1488         }
1489     }
1490     peel(pat, 0)
1491 }
1492
1493 /// Peels of expressions while the given closure returns `Some`.
1494 pub fn peel_hir_expr_while<'tcx>(
1495     mut expr: &'tcx Expr<'tcx>,
1496     mut f: impl FnMut(&'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>>,
1497 ) -> &'tcx Expr<'tcx> {
1498     while let Some(e) = f(expr) {
1499         expr = e;
1500     }
1501     expr
1502 }
1503
1504 /// Peels off up to the given number of references on the expression. Returns the underlying
1505 /// expression and the number of references removed.
1506 pub fn peel_n_hir_expr_refs(expr: &'a Expr<'a>, count: usize) -> (&'a Expr<'a>, usize) {
1507     let mut remaining = count;
1508     let e = peel_hir_expr_while(expr, |e| match e.kind {
1509         ExprKind::AddrOf(BorrowKind::Ref, _, e) if remaining != 0 => {
1510             remaining -= 1;
1511             Some(e)
1512         },
1513         _ => None,
1514     });
1515     (e, count - remaining)
1516 }
1517
1518 /// Peels off all references on the expression. Returns the underlying expression and the number of
1519 /// references removed.
1520 pub fn peel_hir_expr_refs(expr: &'a Expr<'a>) -> (&'a Expr<'a>, usize) {
1521     let mut count = 0;
1522     let e = peel_hir_expr_while(expr, |e| match e.kind {
1523         ExprKind::AddrOf(BorrowKind::Ref, _, e) => {
1524             count += 1;
1525             Some(e)
1526         },
1527         _ => None,
1528     });
1529     (e, count)
1530 }
1531
1532 #[macro_export]
1533 macro_rules! unwrap_cargo_metadata {
1534     ($cx: ident, $lint: ident, $deps: expr) => {{
1535         let mut command = cargo_metadata::MetadataCommand::new();
1536         if !$deps {
1537             command.no_deps();
1538         }
1539
1540         match command.exec() {
1541             Ok(metadata) => metadata,
1542             Err(err) => {
1543                 span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
1544                 return;
1545             },
1546         }
1547     }};
1548 }
1549
1550 pub fn is_hir_ty_cfg_dependant(cx: &LateContext<'_>, ty: &hir::Ty<'_>) -> bool {
1551     if_chain! {
1552         if let TyKind::Path(QPath::Resolved(_, path)) = ty.kind;
1553         if let Res::Def(_, def_id) = path.res;
1554         then {
1555             cx.tcx.has_attr(def_id, sym::cfg) || cx.tcx.has_attr(def_id, sym::cfg_attr)
1556         } else {
1557             false
1558         }
1559     }
1560 }