4 #[allow(clippy::module_name_repetitions)]
16 pub mod internal_lints;
17 pub mod numeric_literal;
22 pub use self::attrs::*;
23 pub use self::diagnostics::*;
24 pub use self::hir_utils::{both, eq_expr_value, over, SpanlessEq, SpanlessHash};
29 use if_chain::if_chain;
30 use rustc_ast::ast::{self, Attribute, LitKind};
31 use rustc_attr as attr;
32 use rustc_errors::Applicability;
34 use rustc_hir::def::{DefKind, Res};
35 use rustc_hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
36 use rustc_hir::intravisit::{NestedVisitorMap, Visitor};
39 def, Arm, Block, Body, Constness, Crate, Expr, ExprKind, FnDecl, HirId, ImplItem, ImplItemKind, Item, ItemKind,
40 MatchSource, Param, Pat, PatKind, Path, PathSegment, QPath, TraitItem, TraitItemKind, TraitRef, TyKind, Unsafety,
42 use rustc_infer::infer::TyCtxtInferExt;
43 use rustc_lint::{LateContext, Level, Lint, LintContext};
44 use rustc_middle::hir::map::Map;
45 use rustc_middle::ty::subst::{GenericArg, GenericArgKind};
46 use rustc_middle::ty::{self, layout::IntegerExt, Ty, TyCtxt, TypeFoldable};
47 use rustc_mir::const_eval;
48 use rustc_span::hygiene::{ExpnKind, MacroKind};
49 use rustc_span::source_map::original_sp;
50 use rustc_span::symbol::{self, kw, Symbol};
51 use rustc_span::{BytePos, Pos, Span, DUMMY_SP};
52 use rustc_target::abi::Integer;
53 use rustc_trait_selection::traits::query::normalize::AtExt;
54 use smallvec::SmallVec;
56 use crate::consts::{constant, Constant};
58 /// Returns `true` if the two spans come from differing expansions (i.e., one is
59 /// from a macro and one isn't).
61 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
62 rhs.ctxt() != lhs.ctxt()
65 /// Returns `true` if the given `NodeId` is inside a constant context
70 /// if in_constant(cx, expr.hir_id) {
74 pub fn in_constant(cx: &LateContext<'_>, id: HirId) -> bool {
75 let parent_id = cx.tcx.hir().get_parent_item(id);
76 match cx.tcx.hir().get(parent_id) {
78 kind: ItemKind::Const(..) | ItemKind::Static(..),
81 | Node::TraitItem(&TraitItem {
82 kind: TraitItemKind::Const(..),
85 | Node::ImplItem(&ImplItem {
86 kind: ImplItemKind::Const(..),
89 | Node::AnonConst(_) => true,
91 kind: ItemKind::Fn(ref sig, ..),
94 | Node::ImplItem(&ImplItem {
95 kind: ImplItemKind::Fn(ref sig, _),
97 }) => sig.header.constness == Constness::Const,
102 /// Returns `true` if this `span` was expanded by any macro.
104 pub fn in_macro(span: Span) -> bool {
105 if span.from_expansion() {
106 !matches!(span.ctxt().outer_expn_data().kind, ExpnKind::Desugaring(..))
111 // If the snippet is empty, it's an attribute that was inserted during macro
112 // expansion and we want to ignore those, because they could come from external
113 // sources that the user has no control over.
114 // For some reason these attributes don't have any expansion info on them, so
115 // we have to check it this way until there is a better way.
116 pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
117 if let Some(snippet) = snippet_opt(cx, span) {
118 if snippet.is_empty() {
125 /// Checks if given pattern is a wildcard (`_`)
126 pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
127 matches!(pat.kind, PatKind::Wild)
130 /// Checks if type is struct, enum or union type with the given def path.
131 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
133 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
138 /// Checks if the type is equal to a diagnostic item
139 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
141 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
146 /// Checks if the type is equal to a lang item
147 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
149 ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).unwrap() == adt.did,
154 /// Checks if the method call given in `expr` belongs to the given trait.
155 pub fn match_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, path: &[&str]) -> bool {
156 let def_id = cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
157 let trt_id = cx.tcx.trait_of_item(def_id);
158 trt_id.map_or(false, |trt_id| match_def_path(cx, trt_id, path))
161 /// Checks if an expression references a variable of the given name.
162 pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
163 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
164 if let [p] = path.segments {
165 return p.ident.name == var;
171 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
173 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
174 QPath::TypeRelative(_, ref seg) => seg,
175 QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
179 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
181 QPath::Resolved(_, ref path) => path.segments.get(0),
182 QPath::TypeRelative(_, ref seg) => Some(seg),
183 QPath::LangItem(..) => None,
187 /// Matches a `QPath` against a slice of segment string literals.
189 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
190 /// `rustc_hir::QPath`.
194 /// match_qpath(path, &["std", "rt", "begin_unwind"])
196 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
198 QPath::Resolved(_, ref path) => match_path(path, segments),
199 QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
200 TyKind::Path(ref inner_path) => {
201 if let [prefix @ .., end] = segments {
202 if match_qpath(inner_path, prefix) {
203 return segment.ident.name.as_str() == *end;
210 QPath::LangItem(..) => false,
214 /// Matches a `Path` against a slice of segment string literals.
216 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
217 /// `rustc_hir::Path`.
222 /// if match_path(&trait_ref.path, &paths::HASH) {
223 /// // This is the `std::hash::Hash` trait.
226 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
227 /// // This is a `rustc_middle::lint::Lint`.
230 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
234 .zip(segments.iter().rev())
235 .all(|(a, b)| a.ident.name.as_str() == *b)
238 /// Matches a `Path` against a slice of segment string literals, e.g.
242 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
244 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
248 .zip(segments.iter().rev())
249 .all(|(a, b)| a.ident.name.as_str() == *b)
252 /// Gets the definition associated to a path.
253 pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Option<def::Res> {
254 let crates = cx.tcx.crates();
257 .find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
258 if let Some(krate) = krate {
261 index: CRATE_DEF_INDEX,
263 let mut items = cx.tcx.item_children(krate);
264 let mut path_it = path.iter().skip(1).peekable();
267 let segment = match path_it.next() {
268 Some(segment) => segment,
272 let result = SmallVec::<[_; 8]>::new();
273 for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
274 if item.ident.name.as_str() == *segment {
275 if path_it.peek().is_none() {
276 return Some(item.res);
279 items = cx.tcx.item_children(item.res.def_id());
289 pub fn qpath_res(cx: &LateContext<'_>, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
291 hir::QPath::Resolved(_, path) => path.res,
292 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
293 if cx.tcx.has_typeck_results(id.owner.to_def_id()) {
294 cx.tcx.typeck(id.owner.to_def_id().expect_local()).qpath_res(qpath, id)
302 /// Convenience function to get the `DefId` of a trait by path.
303 /// It could be a trait or trait alias.
304 pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
305 let res = match path_to_res(cx, path) {
311 Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
312 Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
317 /// Checks whether a type implements a trait.
318 /// See also `get_trait_def_id`.
319 pub fn implements_trait<'tcx>(
320 cx: &LateContext<'tcx>,
323 ty_params: &[GenericArg<'tcx>],
325 // Do not check on infer_types to avoid panic in evaluate_obligation.
326 if ty.has_infer_types() {
329 let ty = cx.tcx.erase_regions(&ty);
330 let ty_params = cx.tcx.mk_substs(ty_params.iter());
331 cx.tcx.type_implements_trait((trait_id, ty, ty_params, cx.param_env))
334 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
336 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
339 /// struct Point(isize, isize);
341 /// impl std::ops::Add for Point {
342 /// type Output = Self;
344 /// fn add(self, other: Self) -> Self {
349 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
350 // Get the implemented trait for the current function
351 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
353 if parent_impl != hir::CRATE_HIR_ID;
354 if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
355 if let hir::ItemKind::Impl{ of_trait: trait_ref, .. } = &item.kind;
356 then { return trait_ref.as_ref(); }
361 /// Checks whether this type implements `Drop`.
362 pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
363 match ty.ty_adt_def() {
364 Some(def) => def.has_dtor(cx.tcx),
369 /// Returns the method names and argument list of nested method call expressions that make up
370 /// `expr`. method/span lists are sorted with the most recent call first.
371 pub fn method_calls<'tcx>(
372 expr: &'tcx Expr<'tcx>,
374 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
375 let mut method_names = Vec::with_capacity(max_depth);
376 let mut arg_lists = Vec::with_capacity(max_depth);
377 let mut spans = Vec::with_capacity(max_depth);
379 let mut current = expr;
380 for _ in 0..max_depth {
381 if let ExprKind::MethodCall(path, span, args, _) = ¤t.kind {
382 if args.iter().any(|e| e.span.from_expansion()) {
385 method_names.push(path.ident.name);
386 arg_lists.push(&**args);
394 (method_names, arg_lists, spans)
397 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
399 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
400 /// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
401 /// containing the `Expr`s for
402 /// `.bar()` and `.baz()`
403 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
404 let mut current = expr;
405 let mut matched = Vec::with_capacity(methods.len());
406 for method_name in methods.iter().rev() {
407 // method chains are stored last -> first
408 if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
409 if path.ident.name.as_str() == *method_name {
410 if args.iter().any(|e| e.span.from_expansion()) {
413 matched.push(&**args); // build up `matched` backwards
414 current = &args[0] // go to parent expression
422 // Reverse `matched` so that it is in the same order as `methods`.
427 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
428 pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
430 .entry_fn(LOCAL_CRATE)
431 .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
434 /// Gets the name of the item the expression is in, if available.
435 pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
436 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
437 match cx.tcx.hir().find(parent_id) {
439 Node::Item(Item { ident, .. })
440 | Node::TraitItem(TraitItem { ident, .. })
441 | Node::ImplItem(ImplItem { ident, .. }),
442 ) => Some(ident.name),
447 /// Gets the name of a `Pat`, if any.
448 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
450 PatKind::Binding(.., ref spname, _) => Some(spname.name),
451 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
452 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
457 struct ContainsName {
462 impl<'tcx> Visitor<'tcx> for ContainsName {
463 type Map = Map<'tcx>;
465 fn visit_name(&mut self, _: Span, name: Symbol) {
466 if self.name == name {
470 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
471 NestedVisitorMap::None
475 /// Checks if an `Expr` contains a certain name.
476 pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
477 let mut cn = ContainsName { name, result: false };
482 /// Converts a span to a code snippet if available, otherwise use default.
484 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
485 /// to convert a given `Span` to a `str`.
489 /// snippet(cx, expr.span, "..")
491 pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
492 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
495 /// Same as `snippet`, but it adapts the applicability level by following rules:
497 /// - Applicability level `Unspecified` will never be changed.
498 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
499 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
500 /// `HasPlaceholders`
501 pub fn snippet_with_applicability<'a, T: LintContext>(
505 applicability: &mut Applicability,
507 if *applicability != Applicability::Unspecified && span.from_expansion() {
508 *applicability = Applicability::MaybeIncorrect;
510 snippet_opt(cx, span).map_or_else(
512 if *applicability == Applicability::MachineApplicable {
513 *applicability = Applicability::HasPlaceholders;
515 Cow::Borrowed(default)
521 /// Same as `snippet`, but should only be used when it's clear that the input span is
522 /// not a macro argument.
523 pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
524 snippet(cx, span.source_callsite(), default)
527 /// Converts a span to a code snippet. Returns `None` if not available.
528 pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
529 cx.sess().source_map().span_to_snippet(span).ok()
532 /// Converts a span (from a block) to a code snippet if available, otherwise use default.
534 /// This trims the code of indentation, except for the first line. Use it for blocks or block-like
535 /// things which need to be printed as such.
537 /// The `indent_relative_to` arg can be used, to provide a span, where the indentation of the
538 /// resulting snippet of the given span.
543 /// snippet_block(cx, block.span, "..", None)
544 /// // where, `block` is the block of the if expr
548 /// // will return the snippet
555 /// snippet_block(cx, block.span, "..", Some(if_expr.span))
556 /// // where, `block` is the block of the if expr
560 /// // will return the snippet
563 /// } // aligned with `if`
565 /// Note that the first line of the snippet always has 0 indentation.
566 pub fn snippet_block<'a, T: LintContext>(
570 indent_relative_to: Option<Span>,
572 let snip = snippet(cx, span, default);
573 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
574 trim_multiline(snip, true, indent)
577 /// Same as `snippet_block`, but adapts the applicability level by the rules of
578 /// `snippet_with_applicability`.
579 pub fn snippet_block_with_applicability<'a, T: LintContext>(
583 indent_relative_to: Option<Span>,
584 applicability: &mut Applicability,
586 let snip = snippet_with_applicability(cx, span, default, applicability);
587 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
588 trim_multiline(snip, true, indent)
591 /// Returns a new Span that extends the original Span to the first non-whitespace char of the first
597 /// // will be converted to
601 pub fn first_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
602 first_char_in_first_line(cx, span).map_or(span, |first_char_pos| span.with_lo(first_char_pos))
605 fn first_char_in_first_line<T: LintContext>(cx: &T, span: Span) -> Option<BytePos> {
606 let line_span = line_span(cx, span);
607 snippet_opt(cx, line_span).and_then(|snip| {
608 snip.find(|c: char| !c.is_whitespace())
609 .map(|pos| line_span.lo() + BytePos::from_usize(pos))
613 /// Returns the indentation of the line of a span
617 /// // ^^ -- will return 0
619 /// // ^^ -- will return 4
621 pub fn indent_of<T: LintContext>(cx: &T, span: Span) -> Option<usize> {
622 snippet_opt(cx, line_span(cx, span)).and_then(|snip| snip.find(|c: char| !c.is_whitespace()))
625 /// Extends the span to the beginning of the spans line, incl. whitespaces.
630 /// // will be converted to
632 /// // ^^^^^^^^^^^^^^
634 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
635 let span = original_sp(span, DUMMY_SP);
636 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
637 let line_no = source_map_and_line.line;
638 let line_start = source_map_and_line.sf.lines[line_no];
639 Span::new(line_start, span.hi(), span.ctxt())
642 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
643 /// Also takes an `Option<String>` which can be put inside the braces.
644 pub fn expr_block<'a, T: LintContext>(
647 option: Option<String>,
649 indent_relative_to: Option<Span>,
651 let code = snippet_block(cx, expr.span, default, indent_relative_to);
652 let string = option.unwrap_or_default();
653 if expr.span.from_expansion() {
654 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
655 } else if let ExprKind::Block(_, _) = expr.kind {
656 Cow::Owned(format!("{}{}", code, string))
657 } else if string.is_empty() {
658 Cow::Owned(format!("{{ {} }}", code))
660 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
664 /// Trim indentation from a multiline string with possibility of ignoring the
666 fn trim_multiline(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>) -> Cow<'_, str> {
667 let s_space = trim_multiline_inner(s, ignore_first, indent, ' ');
668 let s_tab = trim_multiline_inner(s_space, ignore_first, indent, '\t');
669 trim_multiline_inner(s_tab, ignore_first, indent, ' ')
672 fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>, ch: char) -> Cow<'_, str> {
675 .skip(ignore_first as usize)
680 // ignore empty lines
681 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
686 if let Some(indent) = indent {
687 x = x.saturating_sub(indent);
694 if (ignore_first && i == 0) || l.is_empty() {
708 /// Gets the parent expression, if any –- this is useful to constrain a lint.
709 pub fn get_parent_expr<'c>(cx: &'c LateContext<'_>, e: &Expr<'_>) -> Option<&'c Expr<'c>> {
710 let map = &cx.tcx.hir();
711 let hir_id = e.hir_id;
712 let parent_id = map.get_parent_node(hir_id);
713 if hir_id == parent_id {
716 map.find(parent_id).and_then(|node| {
717 if let Node::Expr(parent) = node {
725 pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
726 let map = &cx.tcx.hir();
727 let enclosing_node = map
728 .get_enclosing_scope(hir_id)
729 .and_then(|enclosing_id| map.find(enclosing_id));
730 enclosing_node.and_then(|node| match node {
731 Node::Block(block) => Some(block),
733 kind: ItemKind::Fn(_, _, eid),
736 | Node::ImplItem(&ImplItem {
737 kind: ImplItemKind::Fn(_, eid),
739 }) => match cx.tcx.hir().body(eid).value.kind {
740 ExprKind::Block(ref block, _) => Some(block),
747 /// Returns the base type for HIR references and pointers.
748 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
750 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
755 /// Returns the base type for references and raw pointers.
756 pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
758 ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
763 /// Returns the base type for references and raw pointers, and count reference
765 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
766 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
768 ty::Ref(_, ty, _) => inner(ty, depth + 1),
775 /// Checks whether the given expression is a constant integer of the given value.
776 /// unlike `is_integer_literal`, this version does const folding
777 pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
778 if is_integer_literal(e, value) {
781 let map = cx.tcx.hir();
782 let parent_item = map.get_parent_item(e.hir_id);
783 if let Some((Constant::Int(v), _)) = map
784 .maybe_body_owned_by(parent_item)
785 .and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
793 /// Checks whether the given expression is a constant literal of the given value.
794 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
795 // FIXME: use constant folding
796 if let ExprKind::Lit(ref spanned) = expr.kind {
797 if let LitKind::Int(v, _) = spanned.node {
804 /// Returns `true` if the given `Expr` has been coerced before.
806 /// Examples of coercions can be found in the Nomicon at
807 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
809 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
810 /// information on adjustments and coercions.
811 pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
812 cx.typeck_results().adjustments().get(e.hir_id).is_some()
815 /// Returns the pre-expansion span if is this comes from an expansion of the
817 /// See also `is_direct_expn_of`.
819 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
821 if span.from_expansion() {
822 let data = span.ctxt().outer_expn_data();
823 let new_span = data.call_site;
825 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
826 if mac_name.as_str() == name {
827 return Some(new_span);
838 /// Returns the pre-expansion span if the span directly comes from an expansion
839 /// of the macro `name`.
840 /// The difference with `is_expn_of` is that in
844 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
846 /// `is_direct_expn_of`.
848 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
849 if span.from_expansion() {
850 let data = span.ctxt().outer_expn_data();
851 let new_span = data.call_site;
853 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
854 if mac_name.as_str() == name {
855 return Some(new_span);
863 /// Convenience function to get the return type of a function.
864 pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
865 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
866 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
867 cx.tcx.erase_late_bound_regions(&ret_ty)
870 /// Walk into `ty` and returns `true` if any inner type is the same as `other_ty`
871 pub fn contains_ty<'tcx>(ty: Ty<'tcx>, other_ty: Ty<'tcx>) -> bool {
872 ty.walk().any(|inner| match inner.unpack() {
873 GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
874 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
878 /// Returns `true` if the given type is an `unsafe` function.
879 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
881 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
886 pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
887 ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
890 /// Checks if an expression is constructing a tuple-like enum variant or struct
891 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
892 fn has_no_arguments(cx: &LateContext<'_>, def_id: DefId) -> bool {
893 cx.tcx.fn_sig(def_id).skip_binder().inputs().is_empty()
896 if let ExprKind::Call(ref fun, _) = expr.kind {
897 if let ExprKind::Path(ref qp) = fun.kind {
898 let res = cx.qpath_res(qp, fun.hir_id);
900 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
901 // FIXME: check the constness of the arguments, see https://github.com/rust-lang/rust-clippy/pull/5682#issuecomment-638681210
902 def::Res::Def(DefKind::Fn, def_id) if has_no_arguments(cx, def_id) => {
903 const_eval::is_const_fn(cx.tcx, def_id)
905 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
913 /// Returns `true` if a pattern is refutable.
914 // TODO: should be implemented using rustc/mir_build/thir machinery
915 pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
916 fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
918 cx.qpath_res(qpath, id),
919 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
923 fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
924 i.any(|pat| is_refutable(cx, pat))
928 PatKind::Wild => false,
929 PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
930 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
931 PatKind::Lit(..) | PatKind::Range(..) => true,
932 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
933 PatKind::Or(ref pats) => {
934 // TODO: should be the honest check, that pats is exhaustive set
935 are_refutable(cx, pats.iter().map(|pat| &**pat))
937 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
938 PatKind::Struct(ref qpath, ref fields, _) => {
939 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
941 PatKind::TupleStruct(ref qpath, ref pats, _) => {
942 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
944 PatKind::Slice(ref head, ref middle, ref tail) => {
945 match &cx.typeck_results().node_type(pat.hir_id).kind {
947 // [..] is the only irrefutable slice pattern.
948 !head.is_empty() || middle.is_none() || !tail.is_empty()
950 ty::Array(..) => are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat)),
960 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
961 /// implementations have.
962 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
963 attrs.iter().any(|attr| attr.has_name(sym!(automatically_derived)))
966 /// Remove blocks around an expression.
968 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
970 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
971 while let ExprKind::Block(ref block, ..) = expr.kind {
972 match (block.stmts.is_empty(), block.expr.as_ref()) {
973 (true, Some(e)) => expr = e,
980 pub fn is_self(slf: &Param<'_>) -> bool {
981 if let PatKind::Binding(.., name, _) = slf.pat.kind {
982 name.name == kw::SelfLower
988 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
990 if let TyKind::Path(ref qp) = slf.kind;
991 if let QPath::Resolved(None, ref path) = *qp;
992 if let Res::SelfTy(..) = path.res;
1000 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1001 (0..decl.inputs.len()).map(move |i| &body.params[i])
1004 /// Checks if a given expression is a match expression expanded from the `?`
1005 /// operator or the `try` macro.
1006 pub fn is_try<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1007 fn is_ok(arm: &Arm<'_>) -> bool {
1009 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1010 if match_qpath(path, &paths::RESULT_OK[1..]);
1011 if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1012 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.kind;
1013 if let Res::Local(lid) = path.res;
1022 fn is_err(arm: &Arm<'_>) -> bool {
1023 if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1024 match_qpath(path, &paths::RESULT_ERR[1..])
1030 if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1031 // desugared from a `?` operator
1032 if let MatchSource::TryDesugar = *source {
1038 if arms[0].guard.is_none();
1039 if arms[1].guard.is_none();
1040 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
1041 (is_ok(&arms[1]) && is_err(&arms[0]));
1051 /// Returns `true` if the lint is allowed in the current context
1053 /// Useful for skipping long running code when it's unnecessary
1054 pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
1055 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1058 pub fn get_arg_name(pat: &Pat<'_>) -> Option<Symbol> {
1060 PatKind::Binding(.., ident, None) => Some(ident.name),
1061 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
1066 pub fn int_bits(tcx: TyCtxt<'_>, ity: ast::IntTy) -> u64 {
1067 Integer::from_attr(&tcx, attr::IntType::SignedInt(ity)).size().bits()
1070 #[allow(clippy::cast_possible_wrap)]
1071 /// Turn a constant int byte representation into an i128
1072 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ast::IntTy) -> i128 {
1073 let amt = 128 - int_bits(tcx, ity);
1074 ((u as i128) << amt) >> amt
1077 #[allow(clippy::cast_sign_loss)]
1078 /// clip unused bytes
1079 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ast::IntTy) -> u128 {
1080 let amt = 128 - int_bits(tcx, ity);
1081 ((u as u128) << amt) >> amt
1084 /// clip unused bytes
1085 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ast::UintTy) -> u128 {
1086 let bits = Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity)).size().bits();
1087 let amt = 128 - bits;
1091 /// Removes block comments from the given `Vec` of lines.
1096 /// without_block_comments(vec!["/*", "foo", "*/"]);
1099 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
1100 /// // => vec!["bar"]
1102 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
1103 let mut without = vec![];
1105 let mut nest_level = 0;
1108 if line.contains("/*") {
1111 } else if line.contains("*/") {
1116 if nest_level == 0 {
1124 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1125 let map = &tcx.hir();
1126 let mut prev_enclosing_node = None;
1127 let mut enclosing_node = node;
1128 while Some(enclosing_node) != prev_enclosing_node {
1129 if is_automatically_derived(map.attrs(enclosing_node)) {
1132 prev_enclosing_node = Some(enclosing_node);
1133 enclosing_node = map.get_parent_item(enclosing_node);
1138 /// Returns true if ty has `iter` or `iter_mut` methods
1139 pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
1140 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1141 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1142 // so we can't use its `lookup_method` method.
1143 let into_iter_collections: [&[&str]; 13] = [
1150 &paths::LINKED_LIST,
1151 &paths::BINARY_HEAP,
1159 let ty_to_check = match probably_ref_ty.kind {
1160 ty::Ref(_, ty_to_check, _) => ty_to_check,
1161 _ => probably_ref_ty,
1164 let def_id = match ty_to_check.kind {
1165 ty::Array(..) => return Some("array"),
1166 ty::Slice(..) => return Some("slice"),
1167 ty::Adt(adt, _) => adt.did,
1171 for path in &into_iter_collections {
1172 if match_def_path(cx, def_id, path) {
1173 return Some(*path.last().unwrap());
1179 /// Matches a function call with the given path and returns the arguments.
1184 /// if let Some(args) = match_function_call(cx, begin_panic_call, &paths::BEGIN_PANIC);
1186 pub fn match_function_call<'tcx>(
1187 cx: &LateContext<'tcx>,
1188 expr: &'tcx Expr<'_>,
1190 ) -> Option<&'tcx [Expr<'tcx>]> {
1192 if let ExprKind::Call(ref fun, ref args) = expr.kind;
1193 if let ExprKind::Path(ref qpath) = fun.kind;
1194 if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
1195 if match_def_path(cx, fun_def_id, path);
1203 /// Checks if `Ty` is normalizable. This function is useful
1204 /// to avoid crashes on `layout_of`.
1205 pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
1206 cx.tcx.infer_ctxt().enter(|infcx| {
1207 let cause = rustc_middle::traits::ObligationCause::dummy();
1208 infcx.at(&cause, param_env).normalize(&ty).is_ok()
1212 pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
1213 // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1214 // accepts only that. We should probably move to Symbols in Clippy as well.
1215 let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1216 cx.match_def_path(did, &syms)
1219 /// Returns the list of condition expressions and the list of blocks in a
1220 /// sequence of `if/else`.
1221 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1222 /// `if a { c } else if b { d } else { e }`.
1223 pub fn if_sequence<'tcx>(
1224 mut expr: &'tcx Expr<'tcx>,
1225 ) -> (SmallVec<[&'tcx Expr<'tcx>; 1]>, SmallVec<[&'tcx Block<'tcx>; 1]>) {
1226 let mut conds = SmallVec::new();
1227 let mut blocks: SmallVec<[&Block<'_>; 1]> = SmallVec::new();
1229 while let Some((ref cond, ref then_expr, ref else_expr)) = higher::if_block(&expr) {
1230 conds.push(&**cond);
1231 if let ExprKind::Block(ref block, _) = then_expr.kind {
1234 panic!("ExprKind::If node is not an ExprKind::Block");
1237 if let Some(ref else_expr) = *else_expr {
1244 // final `else {..}`
1245 if !blocks.is_empty() {
1246 if let ExprKind::Block(ref block, _) = expr.kind {
1247 blocks.push(&**block);
1254 pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
1255 let map = cx.tcx.hir();
1256 let parent_id = map.get_parent_node(expr.hir_id);
1257 let parent_node = map.get(parent_id);
1260 Node::Expr(e) => higher::if_block(&e).is_some(),
1261 Node::Arm(e) => higher::if_block(&e.body).is_some(),
1266 // Finds the attribute with the given name, if any
1267 pub fn attr_by_name<'a>(attrs: &'a [Attribute], name: &'_ str) -> Option<&'a Attribute> {
1270 .find(|attr| attr.ident().map_or(false, |ident| ident.as_str() == name))
1273 // Finds the `#[must_use]` attribute, if any
1274 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1275 attr_by_name(attrs, "must_use")
1278 // Returns whether the type has #[must_use] attribute
1279 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
1281 ty::Adt(ref adt, _) => must_use_attr(&cx.tcx.get_attrs(adt.did)).is_some(),
1282 ty::Foreign(ref did) => must_use_attr(&cx.tcx.get_attrs(*did)).is_some(),
1284 | ty::Array(ref ty, _)
1285 | ty::RawPtr(ty::TypeAndMut { ref ty, .. })
1286 | ty::Ref(_, ref ty, _) => {
1287 // for the Array case we don't need to care for the len == 0 case
1288 // because we don't want to lint functions returning empty arrays
1289 is_must_use_ty(cx, *ty)
1291 ty::Tuple(ref substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
1292 ty::Opaque(ref def_id, _) => {
1293 for (predicate, _) in cx.tcx.predicates_of(*def_id).predicates {
1294 if let ty::PredicateAtom::Trait(trait_predicate, _) = predicate.skip_binders() {
1295 if must_use_attr(&cx.tcx.get_attrs(trait_predicate.trait_ref.def_id)).is_some() {
1302 ty::Dynamic(binder, _) => {
1303 for predicate in binder.skip_binder().iter() {
1304 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate {
1305 if must_use_attr(&cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
1316 // check if expr is calling method or function with #[must_use] attribute
1317 pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
1318 let did = match expr.kind {
1319 ExprKind::Call(ref path, _) => if_chain! {
1320 if let ExprKind::Path(ref qpath) = path.kind;
1321 if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
1328 ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1332 did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
1335 pub fn is_no_std_crate(krate: &Crate<'_>) -> bool {
1336 krate.item.attrs.iter().any(|attr| {
1337 if let ast::AttrKind::Normal(ref attr) = attr.kind {
1338 attr.path == symbol::sym::no_std
1345 /// Check if parent of a hir node is a trait implementation block.
1346 /// For example, `f` in
1348 /// impl Trait for S {
1352 pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
1353 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1354 matches!(item.kind, ItemKind::Impl{ of_trait: Some(_), .. })
1360 /// Check if it's even possible to satisfy the `where` clause for the item.
1362 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1365 /// fn foo() where i32: Iterator {
1366 /// for _ in 2i32 {}
1369 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
1370 use rustc_trait_selection::traits;
1376 .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1377 traits::impossible_predicates(
1379 traits::elaborate_predicates(cx.tcx, predicates)
1380 .map(|o| o.predicate)
1381 .collect::<Vec<_>>(),
1385 /// Returns the `DefId` of the callee if the given expression is a function or method call.
1386 pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
1388 ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
1391 kind: ExprKind::Path(qpath),
1395 ) => cx.typeck_results().qpath_res(qpath, expr.hir_id).opt_def_id(),
1400 pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
1401 lints.iter().any(|lint| {
1403 cx.tcx.lint_level_at_node(lint, id),
1404 (Level::Forbid | Level::Deny | Level::Warn, _)
1409 /// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
1410 /// number type, a str, or an array, slice, or tuple of those types).
1411 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
1413 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
1414 ty::Ref(_, inner, _) if inner.kind == ty::Str => true,
1415 ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
1416 ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
1421 /// Returns Option<String> where String is a textual representation of the type encapsulated in the
1422 /// slice iff the given expression is a slice of primitives (as defined in the
1423 /// `is_recursively_primitive_type` function) and None otherwise.
1424 pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
1425 let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
1426 let expr_kind = &expr_type.kind;
1427 let is_primitive = match expr_kind {
1428 ty::Slice(ref element_type)
1432 kind: ty::Slice(ref element_type),
1436 ) => is_recursively_primitive_type(element_type),
1441 // if we have wrappers like Array, Slice or Tuple, print these
1442 // and get the type enclosed in the slice ref
1443 match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind {
1444 ty::Slice(..) => return Some("slice".into()),
1445 ty::Array(..) => return Some("array".into()),
1446 ty::Tuple(..) => return Some("tuple".into()),
1448 // is_recursively_primitive_type() should have taken care
1449 // of the rest and we can rely on the type that is found
1450 let refs_peeled = expr_type.peel_refs();
1451 return Some(refs_peeled.walk().last().unwrap().to_string());
1459 macro_rules! unwrap_cargo_metadata {
1460 ($cx: ident, $lint: ident, $deps: expr) => {{
1461 let mut command = cargo_metadata::MetadataCommand::new();
1466 match command.exec() {
1467 Ok(metadata) => metadata,
1469 span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
1478 use super::{trim_multiline, without_block_comments};
1481 fn test_trim_multiline_single_line() {
1482 assert_eq!("", trim_multiline("".into(), false, None));
1483 assert_eq!("...", trim_multiline("...".into(), false, None));
1484 assert_eq!("...", trim_multiline(" ...".into(), false, None));
1485 assert_eq!("...", trim_multiline("\t...".into(), false, None));
1486 assert_eq!("...", trim_multiline("\t\t...".into(), false, None));
1491 fn test_trim_multiline_block() {
1497 }", trim_multiline(" if x {
1501 }".into(), false, None));
1507 }", trim_multiline(" if x {
1511 }".into(), false, None));
1516 fn test_trim_multiline_empty_line() {
1523 }", trim_multiline(" if x {
1528 }".into(), false, None));
1532 fn test_without_block_comments_lines_without_block_comments() {
1533 let result = without_block_comments(vec!["/*", "", "*/"]);
1534 println!("result: {:?}", result);
1535 assert!(result.is_empty());
1537 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1538 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1540 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1541 assert!(result.is_empty());
1543 let result = without_block_comments(vec!["/* one-line comment */"]);
1544 assert!(result.is_empty());
1546 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1547 assert!(result.is_empty());
1549 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1550 assert!(result.is_empty());
1552 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1553 assert_eq!(result, vec!["foo", "bar", "baz"]);