4 #[allow(clippy::module_name_repetitions)]
13 pub mod eager_or_lazy;
17 #[cfg(feature = "internal-lints")]
18 pub mod internal_lints;
19 pub mod numeric_literal;
22 pub mod qualify_min_const_fn;
27 pub use self::attrs::*;
28 pub use self::diagnostics::*;
29 pub use self::hir_utils::{both, eq_expr_value, over, SpanlessEq, SpanlessHash};
32 use std::collections::hash_map::Entry;
33 use std::hash::BuildHasherDefault;
35 use if_chain::if_chain;
36 use rustc_ast::ast::{self, Attribute, LitKind};
37 use rustc_data_structures::fx::FxHashMap;
38 use rustc_errors::Applicability;
40 use rustc_hir::def::{DefKind, Res};
41 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
42 use rustc_hir::intravisit::{self, NestedVisitorMap, Visitor};
45 def, Arm, Block, Body, Constness, Crate, Expr, ExprKind, FnDecl, HirId, ImplItem, ImplItemKind, Item, ItemKind,
46 MatchSource, Param, Pat, PatKind, Path, PathSegment, QPath, TraitItem, TraitItemKind, TraitRef, TyKind, Unsafety,
48 use rustc_infer::infer::TyCtxtInferExt;
49 use rustc_lint::{LateContext, Level, Lint, LintContext};
50 use rustc_middle::hir::exports::Export;
51 use rustc_middle::hir::map::Map;
52 use rustc_middle::ty::subst::{GenericArg, GenericArgKind};
53 use rustc_middle::ty::{self, layout::IntegerExt, Ty, TyCtxt, TypeFoldable};
54 use rustc_semver::RustcVersion;
55 use rustc_session::Session;
56 use rustc_span::hygiene::{ExpnKind, MacroKind};
57 use rustc_span::source_map::original_sp;
59 use rustc_span::symbol::{kw, Symbol};
60 use rustc_span::{BytePos, Pos, Span, DUMMY_SP};
61 use rustc_target::abi::Integer;
62 use rustc_trait_selection::traits::query::normalize::AtExt;
63 use smallvec::SmallVec;
65 use crate::consts::{constant, Constant};
67 pub fn parse_msrv(msrv: &str, sess: Option<&Session>, span: Option<Span>) -> Option<RustcVersion> {
68 if let Ok(version) = RustcVersion::parse(msrv) {
70 } else if let Some(sess) = sess {
71 if let Some(span) = span {
72 sess.span_err(span, &format!("`{}` is not a valid Rust version", msrv));
78 pub fn meets_msrv(msrv: Option<&RustcVersion>, lint_msrv: &RustcVersion) -> bool {
79 msrv.map_or(true, |msrv| msrv.meets(*lint_msrv))
82 macro_rules! extract_msrv_attr {
84 extract_msrv_attr!(@LateContext, ());
87 extract_msrv_attr!(@EarlyContext);
89 (@$context:ident$(, $call:tt)?) => {
90 fn enter_lint_attrs(&mut self, cx: &rustc_lint::$context<'tcx>, attrs: &'tcx [rustc_ast::ast::Attribute]) {
91 use $crate::utils::get_unique_inner_attr;
92 match get_unique_inner_attr(cx.sess$($call)?, attrs, "msrv") {
94 if let Some(msrv) = msrv_attr.value_str() {
95 self.msrv = $crate::utils::parse_msrv(
97 Some(cx.sess$($call)?),
101 cx.sess$($call)?.span_err(msrv_attr.span, "bad clippy attribute");
110 /// Returns `true` if the two spans come from differing expansions (i.e., one is
111 /// from a macro and one isn't).
113 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
114 rhs.ctxt() != lhs.ctxt()
117 /// Returns `true` if the given `NodeId` is inside a constant context
122 /// if in_constant(cx, expr.hir_id) {
126 pub fn in_constant(cx: &LateContext<'_>, id: HirId) -> bool {
127 let parent_id = cx.tcx.hir().get_parent_item(id);
128 match cx.tcx.hir().get(parent_id) {
130 kind: ItemKind::Const(..) | ItemKind::Static(..),
133 | Node::TraitItem(&TraitItem {
134 kind: TraitItemKind::Const(..),
137 | Node::ImplItem(&ImplItem {
138 kind: ImplItemKind::Const(..),
141 | Node::AnonConst(_) => true,
143 kind: ItemKind::Fn(ref sig, ..),
146 | Node::ImplItem(&ImplItem {
147 kind: ImplItemKind::Fn(ref sig, _),
149 }) => sig.header.constness == Constness::Const,
154 /// Returns `true` if this `span` was expanded by any macro.
156 pub fn in_macro(span: Span) -> bool {
157 if span.from_expansion() {
158 !matches!(span.ctxt().outer_expn_data().kind, ExpnKind::Desugaring(..))
164 // If the snippet is empty, it's an attribute that was inserted during macro
165 // expansion and we want to ignore those, because they could come from external
166 // sources that the user has no control over.
167 // For some reason these attributes don't have any expansion info on them, so
168 // we have to check it this way until there is a better way.
169 pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
170 if let Some(snippet) = snippet_opt(cx, span) {
171 if snippet.is_empty() {
178 /// Checks if given pattern is a wildcard (`_`)
179 pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
180 matches!(pat.kind, PatKind::Wild)
183 /// Checks if type is struct, enum or union type with the given def path.
185 /// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
186 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
187 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
189 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
194 /// Checks if the type is equal to a diagnostic item
196 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
197 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
199 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
204 /// Checks if the type is equal to a lang item
205 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
207 ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).unwrap() == adt.did,
212 /// Checks if the method call given in `expr` belongs to the given trait.
213 pub fn match_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, path: &[&str]) -> bool {
214 let def_id = cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
215 let trt_id = cx.tcx.trait_of_item(def_id);
216 trt_id.map_or(false, |trt_id| match_def_path(cx, trt_id, path))
219 /// Checks if an expression references a variable of the given name.
220 pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
221 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
222 if let [p] = path.segments {
223 return p.ident.name == var;
229 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
231 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
232 QPath::TypeRelative(_, ref seg) => seg,
233 QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
237 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
239 QPath::Resolved(_, ref path) => path.segments.get(0),
240 QPath::TypeRelative(_, ref seg) => Some(seg),
241 QPath::LangItem(..) => None,
245 /// Matches a `QPath` against a slice of segment string literals.
247 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
248 /// `rustc_hir::QPath`.
252 /// match_qpath(path, &["std", "rt", "begin_unwind"])
254 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
256 QPath::Resolved(_, ref path) => match_path(path, segments),
257 QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
258 TyKind::Path(ref inner_path) => {
259 if let [prefix @ .., end] = segments {
260 if match_qpath(inner_path, prefix) {
261 return segment.ident.name.as_str() == *end;
268 QPath::LangItem(..) => false,
272 /// Matches a `Path` against a slice of segment string literals.
274 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
275 /// `rustc_hir::Path`.
280 /// if match_path(&trait_ref.path, &paths::HASH) {
281 /// // This is the `std::hash::Hash` trait.
284 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
285 /// // This is a `rustc_middle::lint::Lint`.
288 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
292 .zip(segments.iter().rev())
293 .all(|(a, b)| a.ident.name.as_str() == *b)
296 /// Matches a `Path` against a slice of segment string literals, e.g.
300 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
302 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
306 .zip(segments.iter().rev())
307 .all(|(a, b)| a.ident.name.as_str() == *b)
310 /// Gets the definition associated to a path.
311 #[allow(clippy::shadow_unrelated)] // false positive #6563
312 pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Option<Res> {
313 fn item_child_by_name<'tcx>(tcx: TyCtxt<'tcx>, def_id: DefId, name: &str) -> Option<&'tcx Export<HirId>> {
314 tcx.item_children(def_id)
316 .find(|item| item.ident.name.as_str() == name)
319 let (krate, first, path) = match *path {
320 [krate, first, ref path @ ..] => (krate, first, path),
324 let crates = tcx.crates();
325 let krate = crates.iter().find(|&&num| tcx.crate_name(num).as_str() == krate)?;
326 let first = item_child_by_name(tcx, krate.as_def_id(), first)?;
330 // `get_def_path` seems to generate these empty segments for extern blocks.
331 // We can just ignore them.
332 .filter(|segment| !segment.is_empty())
333 // for each segment, find the child item
334 .try_fold(first, |item, segment| {
335 let def_id = item.res.def_id();
336 if let Some(item) = item_child_by_name(tcx, def_id, segment) {
338 } else if matches!(item.res, Res::Def(DefKind::Enum | DefKind::Struct, _)) {
339 // it is not a child item so check inherent impl items
340 tcx.inherent_impls(def_id)
342 .find_map(|&impl_def_id| item_child_by_name(tcx, impl_def_id, segment))
350 /// Convenience function to get the `DefId` of a trait by path.
351 /// It could be a trait or trait alias.
352 pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
353 let res = match path_to_res(cx, path) {
359 Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
360 Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
365 /// Checks whether a type implements a trait.
366 /// See also `get_trait_def_id`.
367 pub fn implements_trait<'tcx>(
368 cx: &LateContext<'tcx>,
371 ty_params: &[GenericArg<'tcx>],
373 // Do not check on infer_types to avoid panic in evaluate_obligation.
374 if ty.has_infer_types() {
377 let ty = cx.tcx.erase_regions(ty);
378 if ty.has_escaping_bound_vars() {
381 let ty_params = cx.tcx.mk_substs(ty_params.iter());
382 cx.tcx.type_implements_trait((trait_id, ty, ty_params, cx.param_env))
385 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
387 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
390 /// struct Point(isize, isize);
392 /// impl std::ops::Add for Point {
393 /// type Output = Self;
395 /// fn add(self, other: Self) -> Self {
400 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
401 // Get the implemented trait for the current function
402 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
404 if parent_impl != hir::CRATE_HIR_ID;
405 if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
406 if let hir::ItemKind::Impl(impl_) = &item.kind;
407 then { return impl_.of_trait.as_ref(); }
412 /// Checks whether this type implements `Drop`.
413 pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
414 match ty.ty_adt_def() {
415 Some(def) => def.has_dtor(cx.tcx),
420 /// Returns the method names and argument list of nested method call expressions that make up
421 /// `expr`. method/span lists are sorted with the most recent call first.
422 pub fn method_calls<'tcx>(
423 expr: &'tcx Expr<'tcx>,
425 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
426 let mut method_names = Vec::with_capacity(max_depth);
427 let mut arg_lists = Vec::with_capacity(max_depth);
428 let mut spans = Vec::with_capacity(max_depth);
430 let mut current = expr;
431 for _ in 0..max_depth {
432 if let ExprKind::MethodCall(path, span, args, _) = ¤t.kind {
433 if args.iter().any(|e| e.span.from_expansion()) {
436 method_names.push(path.ident.name);
437 arg_lists.push(&**args);
445 (method_names, arg_lists, spans)
448 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
450 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
451 /// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
452 /// containing the `Expr`s for
453 /// `.bar()` and `.baz()`
454 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
455 let mut current = expr;
456 let mut matched = Vec::with_capacity(methods.len());
457 for method_name in methods.iter().rev() {
458 // method chains are stored last -> first
459 if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
460 if path.ident.name.as_str() == *method_name {
461 if args.iter().any(|e| e.span.from_expansion()) {
464 matched.push(&**args); // build up `matched` backwards
465 current = &args[0] // go to parent expression
473 // Reverse `matched` so that it is in the same order as `methods`.
478 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
479 pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
481 .entry_fn(LOCAL_CRATE)
482 .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
485 /// Returns `true` if the expression is in the program's `#[panic_handler]`.
486 pub fn is_in_panic_handler(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
487 let parent = cx.tcx.hir().get_parent_item(e.hir_id);
488 let def_id = cx.tcx.hir().local_def_id(parent).to_def_id();
489 Some(def_id) == cx.tcx.lang_items().panic_impl()
492 /// Gets the name of the item the expression is in, if available.
493 pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
494 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
495 match cx.tcx.hir().find(parent_id) {
497 Node::Item(Item { ident, .. })
498 | Node::TraitItem(TraitItem { ident, .. })
499 | Node::ImplItem(ImplItem { ident, .. }),
500 ) => Some(ident.name),
505 /// Gets the name of a `Pat`, if any.
506 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
508 PatKind::Binding(.., ref spname, _) => Some(spname.name),
509 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
510 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
515 struct ContainsName {
520 impl<'tcx> Visitor<'tcx> for ContainsName {
521 type Map = Map<'tcx>;
523 fn visit_name(&mut self, _: Span, name: Symbol) {
524 if self.name == name {
528 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
529 NestedVisitorMap::None
533 /// Checks if an `Expr` contains a certain name.
534 pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
535 let mut cn = ContainsName { name, result: false };
540 /// Returns `true` if `expr` contains a return expression
541 pub fn contains_return(expr: &hir::Expr<'_>) -> bool {
542 struct RetCallFinder {
546 impl<'tcx> hir::intravisit::Visitor<'tcx> for RetCallFinder {
547 type Map = Map<'tcx>;
549 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'_>) {
553 if let hir::ExprKind::Ret(..) = &expr.kind {
556 hir::intravisit::walk_expr(self, expr);
560 fn nested_visit_map(&mut self) -> hir::intravisit::NestedVisitorMap<Self::Map> {
561 hir::intravisit::NestedVisitorMap::None
565 let mut visitor = RetCallFinder { found: false };
566 visitor.visit_expr(expr);
570 struct FindMacroCalls<'a, 'b> {
571 names: &'a [&'b str],
575 impl<'a, 'b, 'tcx> Visitor<'tcx> for FindMacroCalls<'a, 'b> {
576 type Map = Map<'tcx>;
578 fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
579 if self.names.iter().any(|fun| is_expn_of(expr.span, fun).is_some()) {
580 self.result.push(expr.span);
582 // and check sub-expressions
583 intravisit::walk_expr(self, expr);
586 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
587 NestedVisitorMap::None
591 /// Finds calls of the specified macros in a function body.
592 pub fn find_macro_calls(names: &[&str], body: &Body<'_>) -> Vec<Span> {
593 let mut fmc = FindMacroCalls {
597 fmc.visit_expr(&body.value);
601 /// Converts a span to a code snippet if available, otherwise use default.
603 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
604 /// to convert a given `Span` to a `str`.
608 /// snippet(cx, expr.span, "..")
610 pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
611 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
614 /// Same as `snippet`, but it adapts the applicability level by following rules:
616 /// - Applicability level `Unspecified` will never be changed.
617 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
618 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
619 /// `HasPlaceholders`
620 pub fn snippet_with_applicability<'a, T: LintContext>(
624 applicability: &mut Applicability,
626 if *applicability != Applicability::Unspecified && span.from_expansion() {
627 *applicability = Applicability::MaybeIncorrect;
629 snippet_opt(cx, span).map_or_else(
631 if *applicability == Applicability::MachineApplicable {
632 *applicability = Applicability::HasPlaceholders;
634 Cow::Borrowed(default)
640 /// Same as `snippet`, but should only be used when it's clear that the input span is
641 /// not a macro argument.
642 pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
643 snippet(cx, span.source_callsite(), default)
646 /// Converts a span to a code snippet. Returns `None` if not available.
647 pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
648 cx.sess().source_map().span_to_snippet(span).ok()
651 /// Converts a span (from a block) to a code snippet if available, otherwise use default.
653 /// This trims the code of indentation, except for the first line. Use it for blocks or block-like
654 /// things which need to be printed as such.
656 /// The `indent_relative_to` arg can be used, to provide a span, where the indentation of the
657 /// resulting snippet of the given span.
662 /// snippet_block(cx, block.span, "..", None)
663 /// // where, `block` is the block of the if expr
667 /// // will return the snippet
674 /// snippet_block(cx, block.span, "..", Some(if_expr.span))
675 /// // where, `block` is the block of the if expr
679 /// // will return the snippet
682 /// } // aligned with `if`
684 /// Note that the first line of the snippet always has 0 indentation.
685 pub fn snippet_block<'a, T: LintContext>(
689 indent_relative_to: Option<Span>,
691 let snip = snippet(cx, span, default);
692 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
693 reindent_multiline(snip, true, indent)
696 /// Same as `snippet_block`, but adapts the applicability level by the rules of
697 /// `snippet_with_applicability`.
698 pub fn snippet_block_with_applicability<'a, T: LintContext>(
702 indent_relative_to: Option<Span>,
703 applicability: &mut Applicability,
705 let snip = snippet_with_applicability(cx, span, default, applicability);
706 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
707 reindent_multiline(snip, true, indent)
710 /// Returns a new Span that extends the original Span to the first non-whitespace char of the first
716 /// // will be converted to
720 pub fn first_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
721 first_char_in_first_line(cx, span).map_or(span, |first_char_pos| span.with_lo(first_char_pos))
724 fn first_char_in_first_line<T: LintContext>(cx: &T, span: Span) -> Option<BytePos> {
725 let line_span = line_span(cx, span);
726 snippet_opt(cx, line_span).and_then(|snip| {
727 snip.find(|c: char| !c.is_whitespace())
728 .map(|pos| line_span.lo() + BytePos::from_usize(pos))
732 /// Returns the indentation of the line of a span
736 /// // ^^ -- will return 0
738 /// // ^^ -- will return 4
740 pub fn indent_of<T: LintContext>(cx: &T, span: Span) -> Option<usize> {
741 snippet_opt(cx, line_span(cx, span)).and_then(|snip| snip.find(|c: char| !c.is_whitespace()))
744 /// Returns the positon just before rarrow
747 /// fn into(self) -> () {}
749 /// // in case of unformatted code
750 /// fn into2(self)-> () {}
752 /// fn into3(self) -> () {}
755 pub fn position_before_rarrow(s: &str) -> Option<usize> {
756 s.rfind("->").map(|rpos| {
758 let chars: Vec<char> = s.chars().collect();
760 if let Some(c) = chars.get(rpos - 1) {
761 if c.is_whitespace() {
772 /// Extends the span to the beginning of the spans line, incl. whitespaces.
777 /// // will be converted to
779 /// // ^^^^^^^^^^^^^^
781 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
782 let span = original_sp(span, DUMMY_SP);
783 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
784 let line_no = source_map_and_line.line;
785 let line_start = source_map_and_line.sf.lines[line_no];
786 Span::new(line_start, span.hi(), span.ctxt())
789 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
790 /// Also takes an `Option<String>` which can be put inside the braces.
791 pub fn expr_block<'a, T: LintContext>(
794 option: Option<String>,
796 indent_relative_to: Option<Span>,
798 let code = snippet_block(cx, expr.span, default, indent_relative_to);
799 let string = option.unwrap_or_default();
800 if expr.span.from_expansion() {
801 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
802 } else if let ExprKind::Block(_, _) = expr.kind {
803 Cow::Owned(format!("{}{}", code, string))
804 } else if string.is_empty() {
805 Cow::Owned(format!("{{ {} }}", code))
807 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
811 /// Reindent a multiline string with possibility of ignoring the first line.
812 #[allow(clippy::needless_pass_by_value)]
813 pub fn reindent_multiline(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>) -> Cow<'_, str> {
814 let s_space = reindent_multiline_inner(&s, ignore_first, indent, ' ');
815 let s_tab = reindent_multiline_inner(&s_space, ignore_first, indent, '\t');
816 reindent_multiline_inner(&s_tab, ignore_first, indent, ' ').into()
819 fn reindent_multiline_inner(s: &str, ignore_first: bool, indent: Option<usize>, ch: char) -> String {
822 .skip(ignore_first as usize)
827 // ignore empty lines
828 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
833 let indent = indent.unwrap_or(0);
837 if (ignore_first && i == 0) || l.is_empty() {
839 } else if x > indent {
840 l.split_at(x - indent).1.to_owned()
842 " ".repeat(indent - x) + l
845 .collect::<Vec<String>>()
849 /// Gets the parent expression, if any –- this is useful to constrain a lint.
850 pub fn get_parent_expr<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
851 let map = &cx.tcx.hir();
852 let hir_id = e.hir_id;
853 let parent_id = map.get_parent_node(hir_id);
854 if hir_id == parent_id {
857 map.find(parent_id).and_then(|node| {
858 if let Node::Expr(parent) = node {
866 pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
867 let map = &cx.tcx.hir();
868 let enclosing_node = map
869 .get_enclosing_scope(hir_id)
870 .and_then(|enclosing_id| map.find(enclosing_id));
871 enclosing_node.and_then(|node| match node {
872 Node::Block(block) => Some(block),
874 kind: ItemKind::Fn(_, _, eid),
877 | Node::ImplItem(&ImplItem {
878 kind: ImplItemKind::Fn(_, eid),
880 }) => match cx.tcx.hir().body(eid).value.kind {
881 ExprKind::Block(ref block, _) => Some(block),
888 /// Returns the base type for HIR references and pointers.
889 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
891 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
896 /// Returns the base type for references and raw pointers, and count reference
898 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
899 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
901 ty::Ref(_, ty, _) => inner(ty, depth + 1),
908 /// Checks whether the given expression is a constant integer of the given value.
909 /// unlike `is_integer_literal`, this version does const folding
910 pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
911 if is_integer_literal(e, value) {
914 let map = cx.tcx.hir();
915 let parent_item = map.get_parent_item(e.hir_id);
916 if let Some((Constant::Int(v), _)) = map
917 .maybe_body_owned_by(parent_item)
918 .and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
926 /// Checks whether the given expression is a constant literal of the given value.
927 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
928 // FIXME: use constant folding
929 if let ExprKind::Lit(ref spanned) = expr.kind {
930 if let LitKind::Int(v, _) = spanned.node {
937 /// Returns `true` if the given `Expr` has been coerced before.
939 /// Examples of coercions can be found in the Nomicon at
940 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
942 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
943 /// information on adjustments and coercions.
944 pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
945 cx.typeck_results().adjustments().get(e.hir_id).is_some()
948 /// Returns the pre-expansion span if is this comes from an expansion of the
950 /// See also `is_direct_expn_of`.
952 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
954 if span.from_expansion() {
955 let data = span.ctxt().outer_expn_data();
956 let new_span = data.call_site;
958 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
959 if mac_name.as_str() == name {
960 return Some(new_span);
971 /// Returns the pre-expansion span if the span directly comes from an expansion
972 /// of the macro `name`.
973 /// The difference with `is_expn_of` is that in
977 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
979 /// `is_direct_expn_of`.
981 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
982 if span.from_expansion() {
983 let data = span.ctxt().outer_expn_data();
984 let new_span = data.call_site;
986 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
987 if mac_name.as_str() == name {
988 return Some(new_span);
996 /// Convenience function to get the return type of a function.
997 pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
998 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
999 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
1000 cx.tcx.erase_late_bound_regions(ret_ty)
1003 /// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
1004 pub fn contains_ty(ty: Ty<'_>, other_ty: Ty<'_>) -> bool {
1005 ty.walk().any(|inner| match inner.unpack() {
1006 GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
1007 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
1011 /// Returns `true` if the given type is an `unsafe` function.
1012 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
1014 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
1019 pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
1020 ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
1023 /// Checks if an expression is constructing a tuple-like enum variant or struct
1024 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1025 if let ExprKind::Call(ref fun, _) = expr.kind {
1026 if let ExprKind::Path(ref qp) = fun.kind {
1027 let res = cx.qpath_res(qp, fun.hir_id);
1029 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
1030 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
1038 /// Returns `true` if a pattern is refutable.
1039 // TODO: should be implemented using rustc/mir_build/thir machinery
1040 pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
1041 fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
1043 cx.qpath_res(qpath, id),
1044 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
1048 fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
1049 i.any(|pat| is_refutable(cx, pat))
1053 PatKind::Wild => false,
1054 PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
1055 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
1056 PatKind::Lit(..) | PatKind::Range(..) => true,
1057 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
1058 PatKind::Or(ref pats) => {
1059 // TODO: should be the honest check, that pats is exhaustive set
1060 are_refutable(cx, pats.iter().map(|pat| &**pat))
1062 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
1063 PatKind::Struct(ref qpath, ref fields, _) => {
1064 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
1066 PatKind::TupleStruct(ref qpath, ref pats, _) => {
1067 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
1069 PatKind::Slice(ref head, ref middle, ref tail) => {
1070 match &cx.typeck_results().node_type(pat.hir_id).kind() {
1072 // [..] is the only irrefutable slice pattern.
1073 !head.is_empty() || middle.is_none() || !tail.is_empty()
1075 ty::Array(..) => are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat)),
1085 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
1086 /// implementations have.
1087 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
1088 attrs.iter().any(|attr| attr.has_name(sym::automatically_derived))
1091 /// Remove blocks around an expression.
1093 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
1095 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
1096 while let ExprKind::Block(ref block, ..) = expr.kind {
1097 match (block.stmts.is_empty(), block.expr.as_ref()) {
1098 (true, Some(e)) => expr = e,
1105 pub fn is_self(slf: &Param<'_>) -> bool {
1106 if let PatKind::Binding(.., name, _) = slf.pat.kind {
1107 name.name == kw::SelfLower
1113 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
1115 if let TyKind::Path(QPath::Resolved(None, ref path)) = slf.kind;
1116 if let Res::SelfTy(..) = path.res;
1124 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1125 (0..decl.inputs.len()).map(move |i| &body.params[i])
1128 /// Checks if a given expression is a match expression expanded from the `?`
1129 /// operator or the `try` macro.
1130 pub fn is_try<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1131 fn is_ok(arm: &Arm<'_>) -> bool {
1133 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1134 if match_qpath(path, &paths::RESULT_OK[1..]);
1135 if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1136 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.kind;
1137 if let Res::Local(lid) = path.res;
1146 fn is_err(arm: &Arm<'_>) -> bool {
1147 if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1148 match_qpath(path, &paths::RESULT_ERR[1..])
1154 if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1155 // desugared from a `?` operator
1156 if let MatchSource::TryDesugar = *source {
1162 if arms[0].guard.is_none();
1163 if arms[1].guard.is_none();
1164 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
1165 (is_ok(&arms[1]) && is_err(&arms[0]));
1175 /// Returns `true` if the lint is allowed in the current context
1177 /// Useful for skipping long running code when it's unnecessary
1178 pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
1179 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1182 pub fn get_arg_name(pat: &Pat<'_>) -> Option<Symbol> {
1184 PatKind::Binding(.., ident, None) => Some(ident.name),
1185 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
1190 pub fn int_bits(tcx: TyCtxt<'_>, ity: ty::IntTy) -> u64 {
1191 Integer::from_int_ty(&tcx, ity).size().bits()
1194 #[allow(clippy::cast_possible_wrap)]
1195 /// Turn a constant int byte representation into an i128
1196 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ty::IntTy) -> i128 {
1197 let amt = 128 - int_bits(tcx, ity);
1198 ((u as i128) << amt) >> amt
1201 #[allow(clippy::cast_sign_loss)]
1202 /// clip unused bytes
1203 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ty::IntTy) -> u128 {
1204 let amt = 128 - int_bits(tcx, ity);
1205 ((u as u128) << amt) >> amt
1208 /// clip unused bytes
1209 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ty::UintTy) -> u128 {
1210 let bits = Integer::from_uint_ty(&tcx, ity).size().bits();
1211 let amt = 128 - bits;
1215 /// Removes block comments from the given `Vec` of lines.
1220 /// without_block_comments(vec!["/*", "foo", "*/"]);
1223 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
1224 /// // => vec!["bar"]
1226 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
1227 let mut without = vec![];
1229 let mut nest_level = 0;
1232 if line.contains("/*") {
1235 } else if line.contains("*/") {
1240 if nest_level == 0 {
1248 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1249 let map = &tcx.hir();
1250 let mut prev_enclosing_node = None;
1251 let mut enclosing_node = node;
1252 while Some(enclosing_node) != prev_enclosing_node {
1253 if is_automatically_derived(map.attrs(enclosing_node)) {
1256 prev_enclosing_node = Some(enclosing_node);
1257 enclosing_node = map.get_parent_item(enclosing_node);
1262 /// Returns true if ty has `iter` or `iter_mut` methods
1263 pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
1264 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1265 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1266 // so we can't use its `lookup_method` method.
1267 let into_iter_collections: [&[&str]; 13] = [
1274 &paths::LINKED_LIST,
1275 &paths::BINARY_HEAP,
1283 let ty_to_check = match probably_ref_ty.kind() {
1284 ty::Ref(_, ty_to_check, _) => ty_to_check,
1285 _ => probably_ref_ty,
1288 let def_id = match ty_to_check.kind() {
1289 ty::Array(..) => return Some("array"),
1290 ty::Slice(..) => return Some("slice"),
1291 ty::Adt(adt, _) => adt.did,
1295 for path in &into_iter_collections {
1296 if match_def_path(cx, def_id, path) {
1297 return Some(*path.last().unwrap());
1303 /// Matches a function call with the given path and returns the arguments.
1308 /// if let Some(args) = match_function_call(cx, cmp_max_call, &paths::CMP_MAX);
1310 pub fn match_function_call<'tcx>(
1311 cx: &LateContext<'tcx>,
1312 expr: &'tcx Expr<'_>,
1314 ) -> Option<&'tcx [Expr<'tcx>]> {
1316 if let ExprKind::Call(ref fun, ref args) = expr.kind;
1317 if let ExprKind::Path(ref qpath) = fun.kind;
1318 if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
1319 if match_def_path(cx, fun_def_id, path);
1327 /// Checks if `Ty` is normalizable. This function is useful
1328 /// to avoid crashes on `layout_of`.
1329 pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
1330 cx.tcx.infer_ctxt().enter(|infcx| {
1331 let cause = rustc_middle::traits::ObligationCause::dummy();
1332 infcx.at(&cause, param_env).normalize(ty).is_ok()
1336 pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
1337 // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1338 // accepts only that. We should probably move to Symbols in Clippy as well.
1339 let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1340 cx.match_def_path(did, &syms)
1343 pub fn match_panic_call<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<&'tcx [Expr<'tcx>]> {
1344 match_function_call(cx, expr, &paths::BEGIN_PANIC)
1345 .or_else(|| match_function_call(cx, expr, &paths::BEGIN_PANIC_FMT))
1346 .or_else(|| match_function_call(cx, expr, &paths::PANIC_ANY))
1347 .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC))
1348 .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_FMT))
1349 .or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_STR))
1352 pub fn match_panic_def_id(cx: &LateContext<'_>, did: DefId) -> bool {
1353 match_def_path(cx, did, &paths::BEGIN_PANIC)
1354 || match_def_path(cx, did, &paths::BEGIN_PANIC_FMT)
1355 || match_def_path(cx, did, &paths::PANIC_ANY)
1356 || match_def_path(cx, did, &paths::PANICKING_PANIC)
1357 || match_def_path(cx, did, &paths::PANICKING_PANIC_FMT)
1358 || match_def_path(cx, did, &paths::PANICKING_PANIC_STR)
1361 /// Returns the list of condition expressions and the list of blocks in a
1362 /// sequence of `if/else`.
1363 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1364 /// `if a { c } else if b { d } else { e }`.
1365 pub fn if_sequence<'tcx>(
1366 mut expr: &'tcx Expr<'tcx>,
1367 ) -> (SmallVec<[&'tcx Expr<'tcx>; 1]>, SmallVec<[&'tcx Block<'tcx>; 1]>) {
1368 let mut conds = SmallVec::new();
1369 let mut blocks: SmallVec<[&Block<'_>; 1]> = SmallVec::new();
1371 while let ExprKind::If(ref cond, ref then_expr, ref else_expr) = expr.kind {
1372 conds.push(&**cond);
1373 if let ExprKind::Block(ref block, _) = then_expr.kind {
1376 panic!("ExprKind::If node is not an ExprKind::Block");
1379 if let Some(ref else_expr) = *else_expr {
1386 // final `else {..}`
1387 if !blocks.is_empty() {
1388 if let ExprKind::Block(ref block, _) = expr.kind {
1389 blocks.push(&**block);
1396 pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
1397 let map = cx.tcx.hir();
1398 let parent_id = map.get_parent_node(expr.hir_id);
1399 let parent_node = map.get(parent_id);
1403 kind: ExprKind::If(_, _, _),
1409 // Finds the attribute with the given name, if any
1410 pub fn attr_by_name<'a>(attrs: &'a [Attribute], name: &'_ str) -> Option<&'a Attribute> {
1413 .find(|attr| attr.ident().map_or(false, |ident| ident.as_str() == name))
1416 // Finds the `#[must_use]` attribute, if any
1417 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1418 attr_by_name(attrs, "must_use")
1421 // Returns whether the type has #[must_use] attribute
1422 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
1424 ty::Adt(ref adt, _) => must_use_attr(&cx.tcx.get_attrs(adt.did)).is_some(),
1425 ty::Foreign(ref did) => must_use_attr(&cx.tcx.get_attrs(*did)).is_some(),
1427 | ty::Array(ref ty, _)
1428 | ty::RawPtr(ty::TypeAndMut { ref ty, .. })
1429 | ty::Ref(_, ref ty, _) => {
1430 // for the Array case we don't need to care for the len == 0 case
1431 // because we don't want to lint functions returning empty arrays
1432 is_must_use_ty(cx, *ty)
1434 ty::Tuple(ref substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
1435 ty::Opaque(ref def_id, _) => {
1436 for (predicate, _) in cx.tcx.explicit_item_bounds(*def_id) {
1437 if let ty::PredicateKind::Trait(trait_predicate, _) = predicate.kind().skip_binder() {
1438 if must_use_attr(&cx.tcx.get_attrs(trait_predicate.trait_ref.def_id)).is_some() {
1445 ty::Dynamic(binder, _) => {
1446 for predicate in binder.iter() {
1447 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate.skip_binder() {
1448 if must_use_attr(&cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
1459 // check if expr is calling method or function with #[must_use] attribute
1460 pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1461 let did = match expr.kind {
1462 ExprKind::Call(ref path, _) => if_chain! {
1463 if let ExprKind::Path(ref qpath) = path.kind;
1464 if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
1471 ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1475 did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
1478 pub fn is_no_std_crate(krate: &Crate<'_>) -> bool {
1479 krate.item.attrs.iter().any(|attr| {
1480 if let ast::AttrKind::Normal(ref attr, _) = attr.kind {
1481 attr.path == sym::no_std
1488 /// Check if parent of a hir node is a trait implementation block.
1489 /// For example, `f` in
1491 /// impl Trait for S {
1495 pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
1496 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1497 matches!(item.kind, ItemKind::Impl(hir::Impl { of_trait: Some(_), .. }))
1503 /// Check if it's even possible to satisfy the `where` clause for the item.
1505 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1508 /// fn foo() where i32: Iterator {
1509 /// for _ in 2i32 {}
1512 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
1513 use rustc_trait_selection::traits;
1519 .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1520 traits::impossible_predicates(
1522 traits::elaborate_predicates(cx.tcx, predicates)
1523 .map(|o| o.predicate)
1524 .collect::<Vec<_>>(),
1528 /// Returns the `DefId` of the callee if the given expression is a function or method call.
1529 pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
1531 ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1534 kind: ExprKind::Path(qpath),
1538 ) => cx.typeck_results().qpath_res(qpath, expr.hir_id).opt_def_id(),
1543 pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
1544 lints.iter().any(|lint| {
1546 cx.tcx.lint_level_at_node(lint, id),
1547 (Level::Forbid | Level::Deny | Level::Warn, _)
1552 /// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
1553 /// number type, a str, or an array, slice, or tuple of those types).
1554 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
1556 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
1557 ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
1558 ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
1559 ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
1564 /// Returns Option<String> where String is a textual representation of the type encapsulated in the
1565 /// slice iff the given expression is a slice of primitives (as defined in the
1566 /// `is_recursively_primitive_type` function) and None otherwise.
1567 pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
1568 let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
1569 let expr_kind = expr_type.kind();
1570 let is_primitive = match expr_kind {
1571 ty::Slice(element_type) => is_recursively_primitive_type(element_type),
1572 ty::Ref(_, inner_ty, _) if matches!(inner_ty.kind(), &ty::Slice(_)) => {
1573 if let ty::Slice(element_type) = inner_ty.kind() {
1574 is_recursively_primitive_type(element_type)
1583 // if we have wrappers like Array, Slice or Tuple, print these
1584 // and get the type enclosed in the slice ref
1585 match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind() {
1586 ty::Slice(..) => return Some("slice".into()),
1587 ty::Array(..) => return Some("array".into()),
1588 ty::Tuple(..) => return Some("tuple".into()),
1590 // is_recursively_primitive_type() should have taken care
1591 // of the rest and we can rely on the type that is found
1592 let refs_peeled = expr_type.peel_refs();
1593 return Some(refs_peeled.walk().last().unwrap().to_string());
1600 /// returns list of all pairs (a, b) from `exprs` such that `eq(a, b)`
1601 /// `hash` must be comformed with `eq`
1602 pub fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
1604 Hash: Fn(&T) -> u64,
1605 Eq: Fn(&T, &T) -> bool,
1607 if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
1608 return vec![(&exprs[0], &exprs[1])];
1611 let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
1613 let mut map: FxHashMap<_, Vec<&_>> =
1614 FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
1617 match map.entry(hash(expr)) {
1618 Entry::Occupied(mut o) => {
1621 match_expr_list.push((o, expr));
1624 o.get_mut().push(expr);
1626 Entry::Vacant(v) => {
1627 v.insert(vec![expr]);
1635 /// Peels off all references on the pattern. Returns the underlying pattern and the number of
1636 /// references removed.
1637 pub fn peel_hir_pat_refs(pat: &'a Pat<'a>) -> (&'a Pat<'a>, usize) {
1638 fn peel(pat: &'a Pat<'a>, count: usize) -> (&'a Pat<'a>, usize) {
1639 if let PatKind::Ref(pat, _) = pat.kind {
1640 peel(pat, count + 1)
1648 /// Peels off up to the given number of references on the expression. Returns the underlying
1649 /// expression and the number of references removed.
1650 pub fn peel_n_hir_expr_refs(expr: &'a Expr<'a>, count: usize) -> (&'a Expr<'a>, usize) {
1651 fn f(expr: &'a Expr<'a>, count: usize, target: usize) -> (&'a Expr<'a>, usize) {
1653 ExprKind::AddrOf(_, _, expr) if count != target => f(expr, count + 1, target),
1660 /// Peels off all references on the type. Returns the underlying type and the number of references
1662 pub fn peel_mid_ty_refs(ty: Ty<'_>) -> (Ty<'_>, usize) {
1663 fn peel(ty: Ty<'_>, count: usize) -> (Ty<'_>, usize) {
1664 if let ty::Ref(_, ty, _) = ty.kind() {
1674 macro_rules! unwrap_cargo_metadata {
1675 ($cx: ident, $lint: ident, $deps: expr) => {{
1676 let mut command = cargo_metadata::MetadataCommand::new();
1681 match command.exec() {
1682 Ok(metadata) => metadata,
1684 span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
1691 pub fn is_hir_ty_cfg_dependant(cx: &LateContext<'_>, ty: &hir::Ty<'_>) -> bool {
1693 if let TyKind::Path(QPath::Resolved(_, path)) = ty.kind;
1694 if let Res::Def(_, def_id) = path.res;
1696 cx.tcx.has_attr(def_id, sym::cfg) || cx.tcx.has_attr(def_id, sym::cfg_attr)
1705 use super::{reindent_multiline, without_block_comments};
1708 fn test_reindent_multiline_single_line() {
1709 assert_eq!("", reindent_multiline("".into(), false, None));
1710 assert_eq!("...", reindent_multiline("...".into(), false, None));
1711 assert_eq!("...", reindent_multiline(" ...".into(), false, None));
1712 assert_eq!("...", reindent_multiline("\t...".into(), false, None));
1713 assert_eq!("...", reindent_multiline("\t\t...".into(), false, None));
1718 fn test_reindent_multiline_block() {
1724 }", reindent_multiline(" if x {
1728 }".into(), false, None));
1734 }", reindent_multiline(" if x {
1738 }".into(), false, None));
1743 fn test_reindent_multiline_empty_line() {
1750 }", reindent_multiline(" if x {
1755 }".into(), false, None));
1760 fn test_reindent_multiline_lines_deeper() {
1766 }", reindent_multiline("\
1771 }".into(), true, Some(8)));
1775 fn test_without_block_comments_lines_without_block_comments() {
1776 let result = without_block_comments(vec!["/*", "", "*/"]);
1777 println!("result: {:?}", result);
1778 assert!(result.is_empty());
1780 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1781 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1783 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1784 assert!(result.is_empty());
1786 let result = without_block_comments(vec!["/* one-line comment */"]);
1787 assert!(result.is_empty());
1789 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1790 assert!(result.is_empty());
1792 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1793 assert!(result.is_empty());
1795 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1796 assert_eq!(result, vec!["foo", "bar", "baz"]);