]> git.lizzy.rs Git - rust.git/blob - clippy_utils/src/lib.rs
Fix a FP in `missing_const_for_fn`
[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, Expr, ExprKind, FnDecl, GenericArgs, HirId, Impl, ImplItem,
67     ImplItemKind, Item, ItemKind, LangItem, MatchSource, Node, Param, Pat, PatKind, Path, PathSegment, QPath,
68     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 the method call given in `def_id` belongs to a trait or other container with a given
298 /// diagnostic item
299 pub fn is_diagnostic_assoc_item(cx: &LateContext<'_>, def_id: DefId, diag_item: Symbol) -> bool {
300     cx.tcx
301         .opt_associated_item(def_id)
302         .and_then(|associated_item| match associated_item.container {
303             rustc_ty::TraitContainer(assoc_def_id) => Some(assoc_def_id),
304             rustc_ty::ImplContainer(assoc_def_id) => match cx.tcx.type_of(assoc_def_id).kind() {
305                 rustc_ty::Adt(adt, _) => Some(adt.did),
306                 rustc_ty::Slice(_) => cx.tcx.get_diagnostic_item(sym::slice), // this isn't perfect but it works
307                 _ => None,
308             },
309         })
310         .map_or(false, |assoc_def_id| cx.tcx.is_diagnostic_item(diag_item, assoc_def_id))
311 }
312
313 /// Checks if the method call given in `expr` belongs to the given trait.
314 pub fn is_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, diag_item: Symbol) -> bool {
315     cx.typeck_results()
316         .type_dependent_def_id(expr.hir_id)
317         .map_or(false, |did| is_diagnostic_assoc_item(cx, did, diag_item))
318 }
319
320 /// Checks if an expression references a variable of the given name.
321 pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
322     if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
323         if let [p] = path.segments {
324             return p.ident.name == var;
325         }
326     }
327     false
328 }
329
330 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
331     match *path {
332         QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
333         QPath::TypeRelative(_, ref seg) => seg,
334         QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
335     }
336 }
337
338 pub fn get_qpath_generics(path: &QPath<'tcx>) -> Option<&'tcx GenericArgs<'tcx>> {
339     match path {
340         QPath::Resolved(_, p) => p.segments.last().and_then(|s| s.args),
341         QPath::TypeRelative(_, s) => s.args,
342         QPath::LangItem(..) => None,
343     }
344 }
345
346 pub fn get_qpath_generic_tys(path: &QPath<'tcx>) -> impl Iterator<Item = &'tcx hir::Ty<'tcx>> {
347     get_qpath_generics(path)
348         .map_or([].as_ref(), |a| a.args)
349         .iter()
350         .filter_map(|a| {
351             if let hir::GenericArg::Type(ty) = a {
352                 Some(ty)
353             } else {
354                 None
355             }
356         })
357 }
358
359 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
360     match *path {
361         QPath::Resolved(_, ref path) => path.segments.get(0),
362         QPath::TypeRelative(_, ref seg) => Some(seg),
363         QPath::LangItem(..) => None,
364     }
365 }
366
367 /// THIS METHOD IS DEPRECATED and will eventually be removed since it does not match against the
368 /// entire path or resolved `DefId`. Prefer using `match_def_path`. Consider getting a `DefId` from
369 /// `QPath::Resolved.1.res.opt_def_id()`.
370 ///
371 /// Matches a `QPath` against a slice of segment string literals.
372 ///
373 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
374 /// `rustc_hir::QPath`.
375 ///
376 /// # Examples
377 /// ```rust,ignore
378 /// match_qpath(path, &["std", "rt", "begin_unwind"])
379 /// ```
380 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
381     match *path {
382         QPath::Resolved(_, ref path) => match_path(path, segments),
383         QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
384             TyKind::Path(ref inner_path) => {
385                 if let [prefix @ .., end] = segments {
386                     if match_qpath(inner_path, prefix) {
387                         return segment.ident.name.as_str() == *end;
388                     }
389                 }
390                 false
391             },
392             _ => false,
393         },
394         QPath::LangItem(..) => false,
395     }
396 }
397
398 /// THIS METHOD IS DEPRECATED and will eventually be removed since it does not match against the
399 /// entire path or resolved `DefId`. Prefer using `match_def_path`. Consider getting a `DefId` from
400 /// `QPath::Resolved.1.res.opt_def_id()`.
401 ///
402 /// Matches a `Path` against a slice of segment string literals.
403 ///
404 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
405 /// `rustc_hir::Path`.
406 ///
407 /// # Examples
408 ///
409 /// ```rust,ignore
410 /// if match_path(&trait_ref.path, &paths::HASH) {
411 ///     // This is the `std::hash::Hash` trait.
412 /// }
413 ///
414 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
415 ///     // This is a `rustc_middle::lint::Lint`.
416 /// }
417 /// ```
418 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
419     path.segments
420         .iter()
421         .rev()
422         .zip(segments.iter().rev())
423         .all(|(a, b)| a.ident.name.as_str() == *b)
424 }
425
426 /// Matches a `Path` against a slice of segment string literals, e.g.
427 ///
428 /// # Examples
429 /// ```rust,ignore
430 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
431 /// ```
432 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
433     path.segments
434         .iter()
435         .rev()
436         .zip(segments.iter().rev())
437         .all(|(a, b)| a.ident.name.as_str() == *b)
438 }
439
440 /// If the expression is a path to a local, returns the canonical `HirId` of the local.
441 pub fn path_to_local(expr: &Expr<'_>) -> Option<HirId> {
442     if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
443         if let Res::Local(id) = path.res {
444             return Some(id);
445         }
446     }
447     None
448 }
449
450 /// Returns true if the expression is a path to a local with the specified `HirId`.
451 /// Use this function to see if an expression matches a function argument or a match binding.
452 pub fn path_to_local_id(expr: &Expr<'_>, id: HirId) -> bool {
453     path_to_local(expr) == Some(id)
454 }
455
456 /// Gets the definition associated to a path.
457 #[allow(clippy::shadow_unrelated)] // false positive #6563
458 pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Res {
459     macro_rules! try_res {
460         ($e:expr) => {
461             match $e {
462                 Some(e) => e,
463                 None => return Res::Err,
464             }
465         };
466     }
467     fn item_child_by_name<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId, name: &str) -> Option<&'tcx Export<HirId>> {
468         tcx.item_children(def_id)
469             .iter()
470             .find(|item| item.ident.name.as_str() == name)
471     }
472
473     let (krate, first, path) = match *path {
474         [krate, first, ref path @ ..] => (krate, first, path),
475         _ => return Res::Err,
476     };
477     let tcx = cx.tcx;
478     let crates = tcx.crates();
479     let krate = try_res!(crates.iter().find(|&&num| tcx.crate_name(num).as_str() == krate));
480     let first = try_res!(item_child_by_name(tcx, krate.as_def_id(), first));
481     let last = path
482         .iter()
483         .copied()
484         // `get_def_path` seems to generate these empty segments for extern blocks.
485         // We can just ignore them.
486         .filter(|segment| !segment.is_empty())
487         // for each segment, find the child item
488         .try_fold(first, |item, segment| {
489             let def_id = item.res.def_id();
490             if let Some(item) = item_child_by_name(tcx, def_id, segment) {
491                 Some(item)
492             } else if matches!(item.res, Res::Def(DefKind::Enum | DefKind::Struct, _)) {
493                 // it is not a child item so check inherent impl items
494                 tcx.inherent_impls(def_id)
495                     .iter()
496                     .find_map(|&impl_def_id| item_child_by_name(tcx, impl_def_id, segment))
497             } else {
498                 None
499             }
500         });
501     try_res!(last).res
502 }
503
504 /// Convenience function to get the `DefId` of a trait by path.
505 /// It could be a trait or trait alias.
506 pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
507     match path_to_res(cx, path) {
508         Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
509         _ => None,
510     }
511 }
512
513 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
514 ///
515 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
516 ///
517 /// ```rust
518 /// struct Point(isize, isize);
519 ///
520 /// impl std::ops::Add for Point {
521 ///     type Output = Self;
522 ///
523 ///     fn add(self, other: Self) -> Self {
524 ///         Point(0, 0)
525 ///     }
526 /// }
527 /// ```
528 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
529     // Get the implemented trait for the current function
530     let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
531     if_chain! {
532         if parent_impl != hir::CRATE_HIR_ID;
533         if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
534         if let hir::ItemKind::Impl(impl_) = &item.kind;
535         then { return impl_.of_trait.as_ref(); }
536     }
537     None
538 }
539
540 /// Returns the method names and argument list of nested method call expressions that make up
541 /// `expr`. method/span lists are sorted with the most recent call first.
542 pub fn method_calls<'tcx>(
543     expr: &'tcx Expr<'tcx>,
544     max_depth: usize,
545 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
546     let mut method_names = Vec::with_capacity(max_depth);
547     let mut arg_lists = Vec::with_capacity(max_depth);
548     let mut spans = Vec::with_capacity(max_depth);
549
550     let mut current = expr;
551     for _ in 0..max_depth {
552         if let ExprKind::MethodCall(path, span, args, _) = &current.kind {
553             if args.iter().any(|e| e.span.from_expansion()) {
554                 break;
555             }
556             method_names.push(path.ident.name);
557             arg_lists.push(&**args);
558             spans.push(*span);
559             current = &args[0];
560         } else {
561             break;
562         }
563     }
564
565     (method_names, arg_lists, spans)
566 }
567
568 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
569 ///
570 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
571 /// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
572 /// containing the `Expr`s for
573 /// `.bar()` and `.baz()`
574 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
575     let mut current = expr;
576     let mut matched = Vec::with_capacity(methods.len());
577     for method_name in methods.iter().rev() {
578         // method chains are stored last -> first
579         if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
580             if path.ident.name.as_str() == *method_name {
581                 if args.iter().any(|e| e.span.from_expansion()) {
582                     return None;
583                 }
584                 matched.push(&**args); // build up `matched` backwards
585                 current = &args[0] // go to parent expression
586             } else {
587                 return None;
588             }
589         } else {
590             return None;
591         }
592     }
593     // Reverse `matched` so that it is in the same order as `methods`.
594     matched.reverse();
595     Some(matched)
596 }
597
598 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
599 pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
600     cx.tcx
601         .entry_fn(LOCAL_CRATE)
602         .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
603 }
604
605 /// Returns `true` if the expression is in the program's `#[panic_handler]`.
606 pub fn is_in_panic_handler(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
607     let parent = cx.tcx.hir().get_parent_item(e.hir_id);
608     let def_id = cx.tcx.hir().local_def_id(parent).to_def_id();
609     Some(def_id) == cx.tcx.lang_items().panic_impl()
610 }
611
612 /// Gets the name of the item the expression is in, if available.
613 pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
614     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
615     match cx.tcx.hir().find(parent_id) {
616         Some(
617             Node::Item(Item { ident, .. })
618             | Node::TraitItem(TraitItem { ident, .. })
619             | Node::ImplItem(ImplItem { ident, .. }),
620         ) => Some(ident.name),
621         _ => None,
622     }
623 }
624
625 /// Gets the name of a `Pat`, if any.
626 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
627     match pat.kind {
628         PatKind::Binding(.., ref spname, _) => Some(spname.name),
629         PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
630         PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
631         _ => None,
632     }
633 }
634
635 pub struct ContainsName {
636     pub name: Symbol,
637     pub result: bool,
638 }
639
640 impl<'tcx> Visitor<'tcx> for ContainsName {
641     type Map = Map<'tcx>;
642
643     fn visit_name(&mut self, _: Span, name: Symbol) {
644         if self.name == name {
645             self.result = true;
646         }
647     }
648     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
649         NestedVisitorMap::None
650     }
651 }
652
653 /// Checks if an `Expr` contains a certain name.
654 pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
655     let mut cn = ContainsName { name, result: false };
656     cn.visit_expr(expr);
657     cn.result
658 }
659
660 /// Returns `true` if `expr` contains a return expression
661 pub fn contains_return(expr: &hir::Expr<'_>) -> bool {
662     struct RetCallFinder {
663         found: bool,
664     }
665
666     impl<'tcx> hir::intravisit::Visitor<'tcx> for RetCallFinder {
667         type Map = Map<'tcx>;
668
669         fn visit_expr(&mut self, expr: &'tcx hir::Expr<'_>) {
670             if self.found {
671                 return;
672             }
673             if let hir::ExprKind::Ret(..) = &expr.kind {
674                 self.found = true;
675             } else {
676                 hir::intravisit::walk_expr(self, expr);
677             }
678         }
679
680         fn nested_visit_map(&mut self) -> hir::intravisit::NestedVisitorMap<Self::Map> {
681             hir::intravisit::NestedVisitorMap::None
682         }
683     }
684
685     let mut visitor = RetCallFinder { found: false };
686     visitor.visit_expr(expr);
687     visitor.found
688 }
689
690 struct FindMacroCalls<'a, 'b> {
691     names: &'a [&'b str],
692     result: Vec<Span>,
693 }
694
695 impl<'a, 'b, 'tcx> Visitor<'tcx> for FindMacroCalls<'a, 'b> {
696     type Map = Map<'tcx>;
697
698     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
699         if self.names.iter().any(|fun| is_expn_of(expr.span, fun).is_some()) {
700             self.result.push(expr.span);
701         }
702         // and check sub-expressions
703         intravisit::walk_expr(self, expr);
704     }
705
706     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
707         NestedVisitorMap::None
708     }
709 }
710
711 /// Finds calls of the specified macros in a function body.
712 pub fn find_macro_calls(names: &[&str], body: &Body<'_>) -> Vec<Span> {
713     let mut fmc = FindMacroCalls {
714         names,
715         result: Vec::new(),
716     };
717     fmc.visit_expr(&body.value);
718     fmc.result
719 }
720
721 /// Extends the span to the beginning of the spans line, incl. whitespaces.
722 ///
723 /// ```rust,ignore
724 ///        let x = ();
725 /// //             ^^
726 /// // will be converted to
727 ///        let x = ();
728 /// // ^^^^^^^^^^^^^^
729 /// ```
730 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
731     let span = original_sp(span, DUMMY_SP);
732     let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
733     let line_no = source_map_and_line.line;
734     let line_start = source_map_and_line.sf.lines[line_no];
735     Span::new(line_start, span.hi(), span.ctxt())
736 }
737
738 /// Gets the parent node, if any.
739 pub fn get_parent_node(tcx: TyCtxt<'_>, id: HirId) -> Option<Node<'_>> {
740     tcx.hir().parent_iter(id).next().map(|(_, node)| node)
741 }
742
743 /// Gets the parent expression, if any â€“- this is useful to constrain a lint.
744 pub fn get_parent_expr<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
745     match get_parent_node(cx.tcx, e.hir_id) {
746         Some(Node::Expr(parent)) => Some(parent),
747         _ => None,
748     }
749 }
750
751 pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
752     let map = &cx.tcx.hir();
753     let enclosing_node = map
754         .get_enclosing_scope(hir_id)
755         .and_then(|enclosing_id| map.find(enclosing_id));
756     enclosing_node.and_then(|node| match node {
757         Node::Block(block) => Some(block),
758         Node::Item(&Item {
759             kind: ItemKind::Fn(_, _, eid),
760             ..
761         })
762         | Node::ImplItem(&ImplItem {
763             kind: ImplItemKind::Fn(_, eid),
764             ..
765         }) => match cx.tcx.hir().body(eid).value.kind {
766             ExprKind::Block(ref block, _) => Some(block),
767             _ => None,
768         },
769         _ => None,
770     })
771 }
772
773 /// Gets the parent node if it's an impl block.
774 pub fn get_parent_as_impl(tcx: TyCtxt<'_>, id: HirId) -> Option<&Impl<'_>> {
775     let map = tcx.hir();
776     match map.parent_iter(id).next() {
777         Some((
778             _,
779             Node::Item(Item {
780                 kind: ItemKind::Impl(imp),
781                 ..
782             }),
783         )) => Some(imp),
784         _ => None,
785     }
786 }
787
788 /// Checks if the given expression is the else clause of either an `if` or `if let` expression.
789 pub fn is_else_clause(tcx: TyCtxt<'_>, expr: &Expr<'_>) -> bool {
790     let map = tcx.hir();
791     let mut iter = map.parent_iter(expr.hir_id);
792     match iter.next() {
793         Some((arm_id, Node::Arm(..))) => matches!(
794             iter.next(),
795             Some((
796                 _,
797                 Node::Expr(Expr {
798                     kind: ExprKind::Match(_, [_, else_arm], MatchSource::IfLetDesugar { .. }),
799                     ..
800                 })
801             ))
802             if else_arm.hir_id == arm_id
803         ),
804         Some((
805             _,
806             Node::Expr(Expr {
807                 kind: ExprKind::If(_, _, Some(else_expr)),
808                 ..
809             }),
810         )) => else_expr.hir_id == expr.hir_id,
811         _ => false,
812     }
813 }
814
815 /// Checks whether the given expression is a constant integer of the given value.
816 /// unlike `is_integer_literal`, this version does const folding
817 pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
818     if is_integer_literal(e, value) {
819         return true;
820     }
821     let map = cx.tcx.hir();
822     let parent_item = map.get_parent_item(e.hir_id);
823     if let Some((Constant::Int(v), _)) = map
824         .maybe_body_owned_by(parent_item)
825         .and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
826     {
827         value == v
828     } else {
829         false
830     }
831 }
832
833 /// Checks whether the given expression is a constant literal of the given value.
834 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
835     // FIXME: use constant folding
836     if let ExprKind::Lit(ref spanned) = expr.kind {
837         if let LitKind::Int(v, _) = spanned.node {
838             return v == value;
839         }
840     }
841     false
842 }
843
844 /// Returns `true` if the given `Expr` has been coerced before.
845 ///
846 /// Examples of coercions can be found in the Nomicon at
847 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
848 ///
849 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
850 /// information on adjustments and coercions.
851 pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
852     cx.typeck_results().adjustments().get(e.hir_id).is_some()
853 }
854
855 /// Returns the pre-expansion span if is this comes from an expansion of the
856 /// macro `name`.
857 /// See also `is_direct_expn_of`.
858 #[must_use]
859 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
860     loop {
861         if span.from_expansion() {
862             let data = span.ctxt().outer_expn_data();
863             let new_span = data.call_site;
864
865             if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
866                 if mac_name.as_str() == name {
867                     return Some(new_span);
868                 }
869             }
870
871             span = new_span;
872         } else {
873             return None;
874         }
875     }
876 }
877
878 /// Returns the pre-expansion span if the span directly comes from an expansion
879 /// of the macro `name`.
880 /// The difference with `is_expn_of` is that in
881 /// ```rust,ignore
882 /// foo!(bar!(42));
883 /// ```
884 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
885 /// `bar!` by
886 /// `is_direct_expn_of`.
887 #[must_use]
888 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
889     if span.from_expansion() {
890         let data = span.ctxt().outer_expn_data();
891         let new_span = data.call_site;
892
893         if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
894             if mac_name.as_str() == name {
895                 return Some(new_span);
896             }
897         }
898     }
899
900     None
901 }
902
903 /// Convenience function to get the return type of a function.
904 pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
905     let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
906     let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
907     cx.tcx.erase_late_bound_regions(ret_ty)
908 }
909
910 /// Checks if an expression is constructing a tuple-like enum variant or struct
911 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
912     if let ExprKind::Call(ref fun, _) = expr.kind {
913         if let ExprKind::Path(ref qp) = fun.kind {
914             let res = cx.qpath_res(qp, fun.hir_id);
915             return match res {
916                 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
917                 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
918                 _ => false,
919             };
920         }
921     }
922     false
923 }
924
925 /// Returns `true` if a pattern is refutable.
926 // TODO: should be implemented using rustc/mir_build/thir machinery
927 pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
928     fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
929         matches!(
930             cx.qpath_res(qpath, id),
931             def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
932         )
933     }
934
935     fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
936         i.any(|pat| is_refutable(cx, pat))
937     }
938
939     match pat.kind {
940         PatKind::Wild => false,
941         PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
942         PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
943         PatKind::Lit(..) | PatKind::Range(..) => true,
944         PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
945         PatKind::Or(ref pats) => {
946             // TODO: should be the honest check, that pats is exhaustive set
947             are_refutable(cx, pats.iter().map(|pat| &**pat))
948         },
949         PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
950         PatKind::Struct(ref qpath, ref fields, _) => {
951             is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
952         },
953         PatKind::TupleStruct(ref qpath, ref pats, _) => {
954             is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
955         },
956         PatKind::Slice(ref head, ref middle, ref tail) => {
957             match &cx.typeck_results().node_type(pat.hir_id).kind() {
958                 rustc_ty::Slice(..) => {
959                     // [..] is the only irrefutable slice pattern.
960                     !head.is_empty() || middle.is_none() || !tail.is_empty()
961                 },
962                 rustc_ty::Array(..) => {
963                     are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
964                 },
965                 _ => {
966                     // unreachable!()
967                     true
968                 },
969             }
970         },
971     }
972 }
973
974 /// If the pattern is an `or` pattern, call the function once for each sub pattern. Otherwise, call
975 /// the function once on the given pattern.
976 pub fn recurse_or_patterns<'tcx, F: FnMut(&'tcx Pat<'tcx>)>(pat: &'tcx Pat<'tcx>, mut f: F) {
977     if let PatKind::Or(pats) = pat.kind {
978         pats.iter().cloned().for_each(f)
979     } else {
980         f(pat)
981     }
982 }
983
984 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
985 /// implementations have.
986 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
987     attrs.iter().any(|attr| attr.has_name(sym::automatically_derived))
988 }
989
990 /// Remove blocks around an expression.
991 ///
992 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
993 /// themselves.
994 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
995     while let ExprKind::Block(ref block, ..) = expr.kind {
996         match (block.stmts.is_empty(), block.expr.as_ref()) {
997             (true, Some(e)) => expr = e,
998             _ => break,
999         }
1000     }
1001     expr
1002 }
1003
1004 pub fn is_self(slf: &Param<'_>) -> bool {
1005     if let PatKind::Binding(.., name, _) = slf.pat.kind {
1006         name.name == kw::SelfLower
1007     } else {
1008         false
1009     }
1010 }
1011
1012 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
1013     if_chain! {
1014         if let TyKind::Path(QPath::Resolved(None, ref path)) = slf.kind;
1015         if let Res::SelfTy(..) = path.res;
1016         then {
1017             return true
1018         }
1019     }
1020     false
1021 }
1022
1023 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1024     (0..decl.inputs.len()).map(move |i| &body.params[i])
1025 }
1026
1027 /// Checks if a given expression is a match expression expanded from the `?`
1028 /// operator or the `try` macro.
1029 pub fn is_try<'tcx>(cx: &LateContext<'_>, expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1030     fn is_ok(cx: &LateContext<'_>, arm: &Arm<'_>) -> bool {
1031         if_chain! {
1032             if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1033             if is_lang_ctor(cx, path, ResultOk);
1034             if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1035             if path_to_local_id(arm.body, hir_id);
1036             then {
1037                 return true;
1038             }
1039         }
1040         false
1041     }
1042
1043     fn is_err(cx: &LateContext<'_>, arm: &Arm<'_>) -> bool {
1044         if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1045             is_lang_ctor(cx, path, ResultErr)
1046         } else {
1047             false
1048         }
1049     }
1050
1051     if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1052         // desugared from a `?` operator
1053         if let MatchSource::TryDesugar = *source {
1054             return Some(expr);
1055         }
1056
1057         if_chain! {
1058             if arms.len() == 2;
1059             if arms[0].guard.is_none();
1060             if arms[1].guard.is_none();
1061             if (is_ok(cx, &arms[0]) && is_err(cx, &arms[1])) ||
1062                 (is_ok(cx, &arms[1]) && is_err(cx, &arms[0]));
1063             then {
1064                 return Some(expr);
1065             }
1066         }
1067     }
1068
1069     None
1070 }
1071
1072 /// Returns `true` if the lint is allowed in the current context
1073 ///
1074 /// Useful for skipping long running code when it's unnecessary
1075 pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
1076     cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1077 }
1078
1079 pub fn strip_pat_refs<'hir>(mut pat: &'hir Pat<'hir>) -> &'hir Pat<'hir> {
1080     while let PatKind::Ref(subpat, _) = pat.kind {
1081         pat = subpat;
1082     }
1083     pat
1084 }
1085
1086 pub fn int_bits(tcx: TyCtxt<'_>, ity: rustc_ty::IntTy) -> u64 {
1087     Integer::from_int_ty(&tcx, ity).size().bits()
1088 }
1089
1090 #[allow(clippy::cast_possible_wrap)]
1091 /// Turn a constant int byte representation into an i128
1092 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: rustc_ty::IntTy) -> i128 {
1093     let amt = 128 - int_bits(tcx, ity);
1094     ((u as i128) << amt) >> amt
1095 }
1096
1097 #[allow(clippy::cast_sign_loss)]
1098 /// clip unused bytes
1099 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: rustc_ty::IntTy) -> u128 {
1100     let amt = 128 - int_bits(tcx, ity);
1101     ((u as u128) << amt) >> amt
1102 }
1103
1104 /// clip unused bytes
1105 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: rustc_ty::UintTy) -> u128 {
1106     let bits = Integer::from_uint_ty(&tcx, ity).size().bits();
1107     let amt = 128 - bits;
1108     (u << amt) >> amt
1109 }
1110
1111 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1112     let map = &tcx.hir();
1113     let mut prev_enclosing_node = None;
1114     let mut enclosing_node = node;
1115     while Some(enclosing_node) != prev_enclosing_node {
1116         if is_automatically_derived(map.attrs(enclosing_node)) {
1117             return true;
1118         }
1119         prev_enclosing_node = Some(enclosing_node);
1120         enclosing_node = map.get_parent_item(enclosing_node);
1121     }
1122     false
1123 }
1124
1125 /// Matches a function call with the given path and returns the arguments.
1126 ///
1127 /// Usage:
1128 ///
1129 /// ```rust,ignore
1130 /// if let Some(args) = match_function_call(cx, cmp_max_call, &paths::CMP_MAX);
1131 /// ```
1132 pub fn match_function_call<'tcx>(
1133     cx: &LateContext<'tcx>,
1134     expr: &'tcx Expr<'_>,
1135     path: &[&str],
1136 ) -> Option<&'tcx [Expr<'tcx>]> {
1137     if_chain! {
1138         if let ExprKind::Call(ref fun, ref args) = expr.kind;
1139         if let ExprKind::Path(ref qpath) = fun.kind;
1140         if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
1141         if match_def_path(cx, fun_def_id, path);
1142         then {
1143             return Some(&args)
1144         }
1145     };
1146     None
1147 }
1148
1149 pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
1150     // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1151     // accepts only that. We should probably move to Symbols in Clippy as well.
1152     let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1153     cx.match_def_path(did, &syms)
1154 }
1155
1156 pub fn match_panic_call<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<&'tcx [Expr<'tcx>]> {
1157     match_function_call(cx, expr, &paths::BEGIN_PANIC)
1158         .or_else(|| match_function_call(cx, expr, &paths::BEGIN_PANIC_FMT))
1159         .or_else(|| match_function_call(cx, expr, &paths::PANIC_ANY))
1160         .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC))
1161         .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_FMT))
1162         .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_STR))
1163 }
1164
1165 pub fn match_panic_def_id(cx: &LateContext<'_>, did: DefId) -> bool {
1166     match_def_path(cx, did, &paths::BEGIN_PANIC)
1167         || match_def_path(cx, did, &paths::BEGIN_PANIC_FMT)
1168         || match_def_path(cx, did, &paths::PANIC_ANY)
1169         || match_def_path(cx, did, &paths::PANICKING_PANIC)
1170         || match_def_path(cx, did, &paths::PANICKING_PANIC_FMT)
1171         || match_def_path(cx, did, &paths::PANICKING_PANIC_STR)
1172 }
1173
1174 /// Returns the list of condition expressions and the list of blocks in a
1175 /// sequence of `if/else`.
1176 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1177 /// `if a { c } else if b { d } else { e }`.
1178 pub fn if_sequence<'tcx>(mut expr: &'tcx Expr<'tcx>) -> (Vec<&'tcx Expr<'tcx>>, Vec<&'tcx Block<'tcx>>) {
1179     let mut conds = Vec::new();
1180     let mut blocks: Vec<&Block<'_>> = Vec::new();
1181
1182     while let ExprKind::If(ref cond, ref then_expr, ref else_expr) = expr.kind {
1183         conds.push(&**cond);
1184         if let ExprKind::Block(ref block, _) = then_expr.kind {
1185             blocks.push(block);
1186         } else {
1187             panic!("ExprKind::If node is not an ExprKind::Block");
1188         }
1189
1190         if let Some(ref else_expr) = *else_expr {
1191             expr = else_expr;
1192         } else {
1193             break;
1194         }
1195     }
1196
1197     // final `else {..}`
1198     if !blocks.is_empty() {
1199         if let ExprKind::Block(ref block, _) = expr.kind {
1200             blocks.push(&**block);
1201         }
1202     }
1203
1204     (conds, blocks)
1205 }
1206
1207 /// This function returns true if the given expression is the `else` or `if else` part of an if
1208 /// statement
1209 pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
1210     let map = cx.tcx.hir();
1211     let parent_id = map.get_parent_node(expr.hir_id);
1212     let parent_node = map.get(parent_id);
1213     matches!(
1214         parent_node,
1215         Node::Expr(Expr {
1216             kind: ExprKind::If(_, _, _),
1217             ..
1218         })
1219     )
1220 }
1221
1222 // Finds the `#[must_use]` attribute, if any
1223 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1224     attrs.iter().find(|a| a.has_name(sym::must_use))
1225 }
1226
1227 // check if expr is calling method or function with #[must_use] attribute
1228 pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1229     let did = match expr.kind {
1230         ExprKind::Call(ref path, _) => if_chain! {
1231             if let ExprKind::Path(ref qpath) = path.kind;
1232             if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
1233             then {
1234                 Some(did)
1235             } else {
1236                 None
1237             }
1238         },
1239         ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1240         _ => None,
1241     };
1242
1243     did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
1244 }
1245
1246 pub fn is_no_std_crate(cx: &LateContext<'_>) -> bool {
1247     cx.tcx.hir().attrs(hir::CRATE_HIR_ID).iter().any(|attr| {
1248         if let ast::AttrKind::Normal(ref attr, _) = attr.kind {
1249             attr.path == sym::no_std
1250         } else {
1251             false
1252         }
1253     })
1254 }
1255
1256 /// Check if parent of a hir node is a trait implementation block.
1257 /// For example, `f` in
1258 /// ```rust,ignore
1259 /// impl Trait for S {
1260 ///     fn f() {}
1261 /// }
1262 /// ```
1263 pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
1264     if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1265         matches!(item.kind, ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }))
1266     } else {
1267         false
1268     }
1269 }
1270
1271 /// Check if it's even possible to satisfy the `where` clause for the item.
1272 ///
1273 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1274 ///
1275 /// ```ignore
1276 /// fn foo() where i32: Iterator {
1277 ///     for _ in 2i32 {}
1278 /// }
1279 /// ```
1280 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
1281     use rustc_trait_selection::traits;
1282     let predicates = cx
1283         .tcx
1284         .predicates_of(did)
1285         .predicates
1286         .iter()
1287         .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1288     traits::impossible_predicates(
1289         cx.tcx,
1290         traits::elaborate_predicates(cx.tcx, predicates)
1291             .map(|o| o.predicate)
1292             .collect::<Vec<_>>(),
1293     )
1294 }
1295
1296 /// Returns the `DefId` of the callee if the given expression is a function or method call.
1297 pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
1298     match &expr.kind {
1299         ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1300         ExprKind::Call(
1301             Expr {
1302                 kind: ExprKind::Path(qpath),
1303                 hir_id: path_hir_id,
1304                 ..
1305             },
1306             ..,
1307         ) => cx.typeck_results().qpath_res(qpath, *path_hir_id).opt_def_id(),
1308         _ => None,
1309     }
1310 }
1311
1312 /// This function checks if any of the lints in the slice is enabled for the provided `HirId`.
1313 /// A lint counts as enabled with any of the levels: `Level::Forbid` | `Level::Deny` | `Level::Warn`
1314 ///
1315 /// ```ignore
1316 /// #[deny(clippy::YOUR_AWESOME_LINT)]
1317 /// println!("Hello, World!"); // <- Clippy code: run_lints(cx, &[YOUR_AWESOME_LINT], id) == true
1318 ///
1319 /// #[allow(clippy::YOUR_AWESOME_LINT)]
1320 /// println!("See you soon!"); // <- Clippy code: run_lints(cx, &[YOUR_AWESOME_LINT], id) == false
1321 /// ```
1322 pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
1323     lints.iter().any(|lint| {
1324         matches!(
1325             cx.tcx.lint_level_at_node(lint, id),
1326             (Level::Forbid | Level::Deny | Level::Warn, _)
1327         )
1328     })
1329 }
1330
1331 /// Returns Option<String> where String is a textual representation of the type encapsulated in the
1332 /// slice iff the given expression is a slice of primitives (as defined in the
1333 /// `is_recursively_primitive_type` function) and None otherwise.
1334 pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
1335     let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
1336     let expr_kind = expr_type.kind();
1337     let is_primitive = match expr_kind {
1338         rustc_ty::Slice(element_type) => is_recursively_primitive_type(element_type),
1339         rustc_ty::Ref(_, inner_ty, _) if matches!(inner_ty.kind(), &rustc_ty::Slice(_)) => {
1340             if let rustc_ty::Slice(element_type) = inner_ty.kind() {
1341                 is_recursively_primitive_type(element_type)
1342             } else {
1343                 unreachable!()
1344             }
1345         },
1346         _ => false,
1347     };
1348
1349     if is_primitive {
1350         // if we have wrappers like Array, Slice or Tuple, print these
1351         // and get the type enclosed in the slice ref
1352         match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind() {
1353             rustc_ty::Slice(..) => return Some("slice".into()),
1354             rustc_ty::Array(..) => return Some("array".into()),
1355             rustc_ty::Tuple(..) => return Some("tuple".into()),
1356             _ => {
1357                 // is_recursively_primitive_type() should have taken care
1358                 // of the rest and we can rely on the type that is found
1359                 let refs_peeled = expr_type.peel_refs();
1360                 return Some(refs_peeled.walk().last().unwrap().to_string());
1361             },
1362         }
1363     }
1364     None
1365 }
1366
1367 /// returns list of all pairs (a, b) from `exprs` such that `eq(a, b)`
1368 /// `hash` must be comformed with `eq`
1369 pub fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
1370 where
1371     Hash: Fn(&T) -> u64,
1372     Eq: Fn(&T, &T) -> bool,
1373 {
1374     if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
1375         return vec![(&exprs[0], &exprs[1])];
1376     }
1377
1378     let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
1379
1380     let mut map: FxHashMap<_, Vec<&_>> =
1381         FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
1382
1383     for expr in exprs {
1384         match map.entry(hash(expr)) {
1385             Entry::Occupied(mut o) => {
1386                 for o in o.get() {
1387                     if eq(o, expr) {
1388                         match_expr_list.push((o, expr));
1389                     }
1390                 }
1391                 o.get_mut().push(expr);
1392             },
1393             Entry::Vacant(v) => {
1394                 v.insert(vec![expr]);
1395             },
1396         }
1397     }
1398
1399     match_expr_list
1400 }
1401
1402 /// Peels off all references on the pattern. Returns the underlying pattern and the number of
1403 /// references removed.
1404 pub fn peel_hir_pat_refs(pat: &'a Pat<'a>) -> (&'a Pat<'a>, usize) {
1405     fn peel(pat: &'a Pat<'a>, count: usize) -> (&'a Pat<'a>, usize) {
1406         if let PatKind::Ref(pat, _) = pat.kind {
1407             peel(pat, count + 1)
1408         } else {
1409             (pat, count)
1410         }
1411     }
1412     peel(pat, 0)
1413 }
1414
1415 /// Peels off up to the given number of references on the expression. Returns the underlying
1416 /// expression and the number of references removed.
1417 pub fn peel_n_hir_expr_refs(expr: &'a Expr<'a>, count: usize) -> (&'a Expr<'a>, usize) {
1418     fn f(expr: &'a Expr<'a>, count: usize, target: usize) -> (&'a Expr<'a>, usize) {
1419         match expr.kind {
1420             ExprKind::AddrOf(_, _, expr) if count != target => f(expr, count + 1, target),
1421             _ => (expr, count),
1422         }
1423     }
1424     f(expr, 0, count)
1425 }
1426
1427 /// Peels off all references on the expression. Returns the underlying expression and the number of
1428 /// references removed.
1429 pub fn peel_hir_expr_refs(expr: &'a Expr<'a>) -> (&'a Expr<'a>, usize) {
1430     fn f(expr: &'a Expr<'a>, count: usize) -> (&'a Expr<'a>, usize) {
1431         match expr.kind {
1432             ExprKind::AddrOf(BorrowKind::Ref, _, expr) => f(expr, count + 1),
1433             _ => (expr, count),
1434         }
1435     }
1436     f(expr, 0)
1437 }
1438
1439 #[macro_export]
1440 macro_rules! unwrap_cargo_metadata {
1441     ($cx: ident, $lint: ident, $deps: expr) => {{
1442         let mut command = cargo_metadata::MetadataCommand::new();
1443         if !$deps {
1444             command.no_deps();
1445         }
1446
1447         match command.exec() {
1448             Ok(metadata) => metadata,
1449             Err(err) => {
1450                 span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
1451                 return;
1452             },
1453         }
1454     }};
1455 }
1456
1457 pub fn is_hir_ty_cfg_dependant(cx: &LateContext<'_>, ty: &hir::Ty<'_>) -> bool {
1458     if_chain! {
1459         if let TyKind::Path(QPath::Resolved(_, path)) = ty.kind;
1460         if let Res::Def(_, def_id) = path.res;
1461         then {
1462             cx.tcx.has_attr(def_id, sym::cfg) || cx.tcx.has_attr(def_id, sym::cfg_attr)
1463         } else {
1464             false
1465         }
1466     }
1467 }