14 pub mod internal_lints;
15 pub mod numeric_literal;
20 pub use self::attrs::*;
21 pub use self::diagnostics::*;
22 pub use self::hir_utils::{SpanlessEq, SpanlessHash};
27 use if_chain::if_chain;
28 use rustc_ast::ast::{self, Attribute, LitKind};
29 use rustc_attr as attr;
30 use rustc_errors::Applicability;
32 use rustc_hir::def::{DefKind, Res};
33 use rustc_hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
34 use rustc_hir::intravisit::{NestedVisitorMap, Visitor};
37 def, Arm, Block, Body, Constness, Crate, Expr, ExprKind, FnDecl, HirId, ImplItem, ImplItemKind, Item, ItemKind,
38 MatchSource, Param, Pat, PatKind, Path, PathSegment, QPath, TraitItem, TraitItemKind, TraitRef, TyKind, Unsafety,
40 use rustc_infer::infer::TyCtxtInferExt;
41 use rustc_lint::{LateContext, Level, Lint, LintContext};
42 use rustc_middle::hir::map::Map;
43 use rustc_middle::ty::{self, layout::IntegerExt, subst::GenericArg, Binder, Ty, TyCtxt, TypeFoldable};
44 use rustc_span::hygiene::{ExpnKind, MacroKind};
45 use rustc_span::source_map::original_sp;
46 use rustc_span::symbol::{self, kw, Symbol};
47 use rustc_span::{BytePos, Pos, Span, DUMMY_SP};
48 use rustc_target::abi::Integer;
49 use rustc_trait_selection::traits::query::normalize::AtExt;
50 use smallvec::SmallVec;
52 use crate::consts::{constant, Constant};
53 use crate::reexport::Name;
55 /// Returns `true` if the two spans come from differing expansions (i.e., one is
56 /// from a macro and one isn't).
58 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
59 rhs.ctxt() != lhs.ctxt()
62 /// Returns `true` if the given `NodeId` is inside a constant context
67 /// if in_constant(cx, expr.hir_id) {
71 pub fn in_constant(cx: &LateContext<'_, '_>, id: HirId) -> bool {
72 let parent_id = cx.tcx.hir().get_parent_item(id);
73 match cx.tcx.hir().get(parent_id) {
75 kind: ItemKind::Const(..),
78 | Node::TraitItem(&TraitItem {
79 kind: TraitItemKind::Const(..),
82 | Node::ImplItem(&ImplItem {
83 kind: ImplItemKind::Const(..),
88 kind: ItemKind::Static(..),
92 kind: ItemKind::Fn(ref sig, ..),
95 | Node::ImplItem(&ImplItem {
96 kind: ImplItemKind::Fn(ref sig, _),
98 }) => sig.header.constness == Constness::Const,
103 /// Returns `true` if this `span` was expanded by any macro.
105 pub fn in_macro(span: Span) -> bool {
106 if span.from_expansion() {
107 if let ExpnKind::Desugaring(..) = span.ctxt().outer_expn_data().kind {
116 // If the snippet is empty, it's an attribute that was inserted during macro
117 // expansion and we want to ignore those, because they could come from external
118 // sources that the user has no control over.
119 // For some reason these attributes don't have any expansion info on them, so
120 // we have to check it this way until there is a better way.
121 pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
122 if let Some(snippet) = snippet_opt(cx, span) {
123 if snippet.is_empty() {
130 /// Checks if given pattern is a wildcard (`_`)
131 pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
133 PatKind::Wild => true,
138 /// Checks if type is struct, enum or union type with the given def path.
139 pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
141 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
146 /// Checks if the type is equal to a diagnostic item
147 pub fn is_type_diagnostic_item(cx: &LateContext<'_, '_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
149 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, 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.tables.type_dependent_def_id(expr.hir_id).unwrap();
157 let trt_id = cx.tcx.trait_of_item(def_id);
158 if let Some(trt_id) = trt_id {
159 match_def_path(cx, trt_id, path)
165 /// Checks if an expression references a variable of the given name.
166 pub fn match_var(expr: &Expr<'_>, var: Name) -> bool {
167 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
168 if path.segments.len() == 1 && path.segments[0].ident.name == var {
175 pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
177 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
178 QPath::TypeRelative(_, ref seg) => seg,
182 pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
184 QPath::Resolved(_, ref path) if path.segments.len() == 1 => Some(&path.segments[0]),
185 QPath::Resolved(..) => None,
186 QPath::TypeRelative(_, ref seg) => Some(seg),
190 /// Matches a `QPath` against a slice of segment string literals.
192 /// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
193 /// `rustc_hir::QPath`.
197 /// match_qpath(path, &["std", "rt", "begin_unwind"])
199 pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
201 QPath::Resolved(_, ref path) => match_path(path, segments),
202 QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
203 TyKind::Path(ref inner_path) => {
205 && match_qpath(inner_path, &segments[..(segments.len() - 1)])
206 && segment.ident.name.as_str() == segments[segments.len() - 1]
213 /// Matches a `Path` against a slice of segment string literals.
215 /// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
216 /// `rustc_hir::Path`.
221 /// if match_path(&trait_ref.path, &paths::HASH) {
222 /// // This is the `std::hash::Hash` trait.
225 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
226 /// // This is a `rustc_middle::lint::Lint`.
229 pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
233 .zip(segments.iter().rev())
234 .all(|(a, b)| a.ident.name.as_str() == *b)
237 /// Matches a `Path` against a slice of segment string literals, e.g.
241 /// match_path_ast(path, &["std", "rt", "begin_unwind"])
243 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
247 .zip(segments.iter().rev())
248 .all(|(a, b)| a.ident.name.as_str() == *b)
251 /// Gets the definition associated to a path.
252 pub fn path_to_res(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<def::Res> {
253 let crates = cx.tcx.crates();
256 .find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
257 if let Some(krate) = krate {
260 index: CRATE_DEF_INDEX,
262 let mut items = cx.tcx.item_children(krate);
263 let mut path_it = path.iter().skip(1).peekable();
266 let segment = match path_it.next() {
267 Some(segment) => segment,
271 let result = SmallVec::<[_; 8]>::new();
272 for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
273 if item.ident.name.as_str() == *segment {
274 if path_it.peek().is_none() {
275 return Some(item.res);
278 items = cx.tcx.item_children(item.res.def_id());
288 pub fn qpath_res(cx: &LateContext<'_, '_>, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
290 hir::QPath::Resolved(_, path) => path.res,
291 hir::QPath::TypeRelative(..) => {
292 if cx.tcx.has_typeck_tables(id.owner.to_def_id()) {
294 .typeck_tables_of(id.owner.to_def_id().expect_local())
295 .qpath_res(qpath, id)
303 /// Convenience function to get the `DefId` of a trait by path.
304 /// It could be a trait or trait alias.
305 pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
306 let res = match path_to_res(cx, path) {
312 Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
313 Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
318 /// Checks whether a type implements a trait.
319 /// See also `get_trait_def_id`.
320 pub fn implements_trait<'a, 'tcx>(
321 cx: &LateContext<'a, 'tcx>,
324 ty_params: &[GenericArg<'tcx>],
326 let ty_params = cx.tcx.mk_substs(ty_params.iter());
327 cx.tcx.type_implements_trait((trait_id, ty, ty_params, cx.param_env))
330 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
332 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
335 /// struct Point(isize, isize);
337 /// impl std::ops::Add for Point {
338 /// type Output = Self;
340 /// fn add(self, other: Self) -> Self {
345 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'_, 'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
346 // Get the implemented trait for the current function
347 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
349 if parent_impl != hir::CRATE_HIR_ID;
350 if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
351 if let hir::ItemKind::Impl{ of_trait: trait_ref, .. } = &item.kind;
352 then { return trait_ref.as_ref(); }
357 /// Checks whether this type implements `Drop`.
358 pub fn has_drop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
359 match ty.ty_adt_def() {
360 Some(def) => def.has_dtor(cx.tcx),
365 /// Returns the method names and argument list of nested method call expressions that make up
366 /// `expr`. method/span lists are sorted with the most recent call first.
367 pub fn method_calls<'tcx>(
368 expr: &'tcx Expr<'tcx>,
370 ) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
371 let mut method_names = Vec::with_capacity(max_depth);
372 let mut arg_lists = Vec::with_capacity(max_depth);
373 let mut spans = Vec::with_capacity(max_depth);
375 let mut current = expr;
376 for _ in 0..max_depth {
377 if let ExprKind::MethodCall(path, span, args) = ¤t.kind {
378 if args.iter().any(|e| e.span.from_expansion()) {
381 method_names.push(path.ident.name);
382 arg_lists.push(&**args);
390 (method_names, arg_lists, spans)
393 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
395 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
396 /// `matched_method_chain(expr, &["bar", "baz"])` will return a `Vec`
397 /// containing the `Expr`s for
398 /// `.bar()` and `.baz()`
399 pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
400 let mut current = expr;
401 let mut matched = Vec::with_capacity(methods.len());
402 for method_name in methods.iter().rev() {
403 // method chains are stored last -> first
404 if let ExprKind::MethodCall(ref path, _, ref args) = current.kind {
405 if path.ident.name.as_str() == *method_name {
406 if args.iter().any(|e| e.span.from_expansion()) {
409 matched.push(&**args); // build up `matched` backwards
410 current = &args[0] // go to parent expression
418 // Reverse `matched` so that it is in the same order as `methods`.
423 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
424 pub fn is_entrypoint_fn(cx: &LateContext<'_, '_>, def_id: DefId) -> bool {
426 .entry_fn(LOCAL_CRATE)
427 .map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
430 /// Gets the name of the item the expression is in, if available.
431 pub fn get_item_name(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> Option<Name> {
432 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
433 match cx.tcx.hir().find(parent_id) {
435 Node::Item(Item { ident, .. })
436 | Node::TraitItem(TraitItem { ident, .. })
437 | Node::ImplItem(ImplItem { ident, .. }),
438 ) => Some(ident.name),
443 /// Gets the name of a `Pat`, if any.
444 pub fn get_pat_name(pat: &Pat<'_>) -> Option<Name> {
446 PatKind::Binding(.., ref spname, _) => Some(spname.name),
447 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
448 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
453 struct ContainsName {
458 impl<'tcx> Visitor<'tcx> for ContainsName {
459 type Map = Map<'tcx>;
461 fn visit_name(&mut self, _: Span, name: Name) {
462 if self.name == name {
466 fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
467 NestedVisitorMap::None
471 /// Checks if an `Expr` contains a certain name.
472 pub fn contains_name(name: Name, expr: &Expr<'_>) -> bool {
473 let mut cn = ContainsName { name, result: false };
478 /// Converts a span to a code snippet if available, otherwise use default.
480 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
481 /// to convert a given `Span` to a `str`.
485 /// snippet(cx, expr.span, "..")
487 pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
488 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
491 /// Same as `snippet`, but it adapts the applicability level by following rules:
493 /// - Applicability level `Unspecified` will never be changed.
494 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
495 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
496 /// `HasPlaceholders`
497 pub fn snippet_with_applicability<'a, T: LintContext>(
501 applicability: &mut Applicability,
503 if *applicability != Applicability::Unspecified && span.from_expansion() {
504 *applicability = Applicability::MaybeIncorrect;
506 snippet_opt(cx, span).map_or_else(
508 if *applicability == Applicability::MachineApplicable {
509 *applicability = Applicability::HasPlaceholders;
511 Cow::Borrowed(default)
517 /// Same as `snippet`, but should only be used when it's clear that the input span is
518 /// not a macro argument.
519 pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
520 snippet(cx, span.source_callsite(), default)
523 /// Converts a span to a code snippet. Returns `None` if not available.
524 pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
525 cx.sess().source_map().span_to_snippet(span).ok()
528 /// Converts a span (from a block) to a code snippet if available, otherwise use default.
530 /// This trims the code of indentation, except for the first line. Use it for blocks or block-like
531 /// things which need to be printed as such.
533 /// The `indent_relative_to` arg can be used, to provide a span, where the indentation of the
534 /// resulting snippet of the given span.
539 /// snippet_block(cx, block.span, "..", None)
540 /// // where, `block` is the block of the if expr
544 /// // will return the snippet
551 /// snippet_block(cx, block.span, "..", Some(if_expr.span))
552 /// // where, `block` is the block of the if expr
556 /// // will return the snippet
559 /// } // aligned with `if`
561 /// Note that the first line of the snippet always has 0 indentation.
562 pub fn snippet_block<'a, T: LintContext>(
566 indent_relative_to: Option<Span>,
568 let snip = snippet(cx, span, default);
569 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
570 trim_multiline(snip, true, indent)
573 /// Same as `snippet_block`, but adapts the applicability level by the rules of
574 /// `snippet_with_applicabiliy`.
575 pub fn snippet_block_with_applicability<'a, T: LintContext>(
579 indent_relative_to: Option<Span>,
580 applicability: &mut Applicability,
582 let snip = snippet_with_applicability(cx, span, default, applicability);
583 let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
584 trim_multiline(snip, true, indent)
587 /// Returns a new Span that extends the original Span to the first non-whitespace char of the first
593 /// // will be converted to
597 pub fn first_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
598 if let Some(first_char_pos) = first_char_in_first_line(cx, span) {
599 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 if let Some(snip) = snippet_opt(cx, line_span) {
608 snip.find(|c: char| !c.is_whitespace())
609 .map(|pos| line_span.lo() + BytePos::from_usize(pos))
615 /// Returns the indentation of the line of a span
619 /// // ^^ -- will return 0
621 /// // ^^ -- will return 4
623 pub fn indent_of<T: LintContext>(cx: &T, span: Span) -> Option<usize> {
624 if let Some(snip) = snippet_opt(cx, line_span(cx, span)) {
625 snip.find(|c: char| !c.is_whitespace())
631 /// Extends the span to the beginning of the spans line, incl. whitespaces.
636 /// // will be converted to
638 /// // ^^^^^^^^^^^^^^
640 fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
641 let span = original_sp(span, DUMMY_SP);
642 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
643 let line_no = source_map_and_line.line;
644 let line_start = source_map_and_line.sf.lines[line_no];
645 Span::new(line_start, span.hi(), span.ctxt())
648 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
649 /// Also takes an `Option<String>` which can be put inside the braces.
650 pub fn expr_block<'a, T: LintContext>(
653 option: Option<String>,
655 indent_relative_to: Option<Span>,
657 let code = snippet_block(cx, expr.span, default, indent_relative_to);
658 let string = option.unwrap_or_default();
659 if expr.span.from_expansion() {
660 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
661 } else if let ExprKind::Block(_, _) = expr.kind {
662 Cow::Owned(format!("{}{}", code, string))
663 } else if string.is_empty() {
664 Cow::Owned(format!("{{ {} }}", code))
666 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
670 /// Trim indentation from a multiline string with possibility of ignoring the
672 fn trim_multiline(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>) -> Cow<'_, str> {
673 let s_space = trim_multiline_inner(s, ignore_first, indent, ' ');
674 let s_tab = trim_multiline_inner(s_space, ignore_first, indent, '\t');
675 trim_multiline_inner(s_tab, ignore_first, indent, ' ')
678 fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>, ch: char) -> Cow<'_, str> {
681 .skip(ignore_first as usize)
686 // ignore empty lines
687 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
692 if let Some(indent) = indent {
693 x = x.saturating_sub(indent);
700 if (ignore_first && i == 0) || l.is_empty() {
714 /// Gets the parent expression, if any –- this is useful to constrain a lint.
715 pub fn get_parent_expr<'c>(cx: &'c LateContext<'_, '_>, e: &Expr<'_>) -> Option<&'c Expr<'c>> {
716 let map = &cx.tcx.hir();
717 let hir_id = e.hir_id;
718 let parent_id = map.get_parent_node(hir_id);
719 if hir_id == parent_id {
722 map.find(parent_id).and_then(|node| {
723 if let Node::Expr(parent) = node {
731 pub fn get_enclosing_block<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
732 let map = &cx.tcx.hir();
733 let enclosing_node = map
734 .get_enclosing_scope(hir_id)
735 .and_then(|enclosing_id| map.find(enclosing_id));
736 if let Some(node) = enclosing_node {
738 Node::Block(block) => Some(block),
740 kind: ItemKind::Fn(_, _, eid),
743 | Node::ImplItem(&ImplItem {
744 kind: ImplItemKind::Fn(_, eid),
746 }) => match cx.tcx.hir().body(eid).value.kind {
747 ExprKind::Block(ref block, _) => Some(block),
757 /// Returns the base type for HIR references and pointers.
758 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
760 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
765 /// Returns the base type for references and raw pointers.
766 pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
768 ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
773 /// Returns the base type for references and raw pointers, and count reference
775 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
776 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
778 ty::Ref(_, ty, _) => inner(ty, depth + 1),
785 /// Checks whether the given expression is a constant integer of the given value.
786 /// unlike `is_integer_literal`, this version does const folding
787 pub fn is_integer_const(cx: &LateContext<'_, '_>, e: &Expr<'_>, value: u128) -> bool {
788 if is_integer_literal(e, value) {
791 let map = cx.tcx.hir();
792 let parent_item = map.get_parent_item(e.hir_id);
793 if let Some((Constant::Int(v), _)) = map
794 .maybe_body_owned_by(parent_item)
795 .and_then(|body_id| constant(cx, cx.tcx.body_tables(body_id), e))
803 /// Checks whether the given expression is a constant literal of the given value.
804 pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
805 // FIXME: use constant folding
806 if let ExprKind::Lit(ref spanned) = expr.kind {
807 if let LitKind::Int(v, _) = spanned.node {
814 /// Returns `true` if the given `Expr` has been coerced before.
816 /// Examples of coercions can be found in the Nomicon at
817 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
819 /// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
820 /// information on adjustments and coercions.
821 pub fn is_adjusted(cx: &LateContext<'_, '_>, e: &Expr<'_>) -> bool {
822 cx.tables.adjustments().get(e.hir_id).is_some()
825 /// Returns the pre-expansion span if is this comes from an expansion of the
827 /// See also `is_direct_expn_of`.
829 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
831 if span.from_expansion() {
832 let data = span.ctxt().outer_expn_data();
833 let new_span = data.call_site;
835 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
836 if mac_name.as_str() == name {
837 return Some(new_span);
848 /// Returns the pre-expansion span if the span directly comes from an expansion
849 /// of the macro `name`.
850 /// The difference with `is_expn_of` is that in
854 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
856 /// `is_direct_expn_of`.
858 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
859 if span.from_expansion() {
860 let data = span.ctxt().outer_expn_data();
861 let new_span = data.call_site;
863 if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
864 if mac_name.as_str() == name {
865 return Some(new_span);
873 /// Convenience function to get the return type of a function.
874 pub fn return_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
875 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
876 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
877 cx.tcx.erase_late_bound_regions(&ret_ty)
880 /// Checks if two types are the same.
882 /// This discards any lifetime annotations, too.
884 // FIXME: this works correctly for lifetimes bounds (`for <'a> Foo<'a>` ==
885 // `for <'b> Foo<'b>`, but not for type parameters).
886 pub fn same_tys<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
887 let a = cx.tcx.erase_late_bound_regions(&Binder::bind(a));
888 let b = cx.tcx.erase_late_bound_regions(&Binder::bind(b));
891 .enter(|infcx| infcx.can_eq(cx.param_env, a, b).is_ok())
894 /// Returns `true` if the given type is an `unsafe` function.
895 pub fn type_is_unsafe_function<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
897 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
902 pub fn is_copy<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
903 ty.is_copy_modulo_regions(cx.tcx, cx.param_env, DUMMY_SP)
906 /// Checks if an expression is constructing a tuple-like enum variant or struct
907 pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
908 if let ExprKind::Call(ref fun, _) = expr.kind {
909 if let ExprKind::Path(ref qp) = fun.kind {
910 let res = cx.tables.qpath_res(qp, fun.hir_id);
912 def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
913 def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
921 /// Returns `true` if a pattern is refutable.
922 // TODO: should be implemented using rustc/mir_build/hair machinery
923 pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat<'_>) -> bool {
924 fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath<'_>, id: HirId) -> bool {
926 cx.tables.qpath_res(qpath, id),
927 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
931 fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_, '_>, mut i: I) -> bool {
932 i.any(|pat| is_refutable(cx, pat))
936 PatKind::Wild => false,
937 PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
938 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
939 PatKind::Lit(..) | PatKind::Range(..) => true,
940 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
941 PatKind::Or(ref pats) => {
942 // TODO: should be the honest check, that pats is exhaustive set
943 are_refutable(cx, pats.iter().map(|pat| &**pat))
945 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
946 PatKind::Struct(ref qpath, ref fields, _) => {
947 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
949 PatKind::TupleStruct(ref qpath, ref pats, _) => {
950 is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
952 PatKind::Slice(ref head, ref middle, ref tail) => {
953 match &cx.tables.node_type(pat.hir_id).kind {
955 // [..] is the only irrefutable slice pattern.
956 !head.is_empty() || middle.is_none() || !tail.is_empty()
958 ty::Array(..) => are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat)),
968 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
969 /// implementations have.
970 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
971 attr::contains_name(attrs, sym!(automatically_derived))
974 /// Remove blocks around an expression.
976 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
978 pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
979 while let ExprKind::Block(ref block, ..) = expr.kind {
980 match (block.stmts.is_empty(), block.expr.as_ref()) {
981 (true, Some(e)) => expr = e,
988 pub fn is_self(slf: &Param<'_>) -> bool {
989 if let PatKind::Binding(.., name, _) = slf.pat.kind {
990 name.name == kw::SelfLower
996 pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
998 if let TyKind::Path(ref qp) = slf.kind;
999 if let QPath::Resolved(None, ref path) = *qp;
1000 if let Res::SelfTy(..) = path.res;
1008 pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
1009 (0..decl.inputs.len()).map(move |i| &body.params[i])
1012 /// Checks if a given expression is a match expression expanded from the `?`
1013 /// operator or the `try` macro.
1014 pub fn is_try<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1015 fn is_ok(arm: &Arm<'_>) -> bool {
1017 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
1018 if match_qpath(path, &paths::RESULT_OK[1..]);
1019 if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
1020 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.kind;
1021 if let Res::Local(lid) = path.res;
1030 fn is_err(arm: &Arm<'_>) -> bool {
1031 if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
1032 match_qpath(path, &paths::RESULT_ERR[1..])
1038 if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
1039 // desugared from a `?` operator
1040 if let MatchSource::TryDesugar = *source {
1046 if arms[0].guard.is_none();
1047 if arms[1].guard.is_none();
1048 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
1049 (is_ok(&arms[1]) && is_err(&arms[0]));
1059 /// Returns `true` if the lint is allowed in the current context
1061 /// Useful for skipping long running code when it's unnecessary
1062 pub fn is_allowed(cx: &LateContext<'_, '_>, lint: &'static Lint, id: HirId) -> bool {
1063 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1066 pub fn get_arg_name(pat: &Pat<'_>) -> Option<Name> {
1068 PatKind::Binding(.., ident, None) => Some(ident.name),
1069 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
1074 pub fn int_bits(tcx: TyCtxt<'_>, ity: ast::IntTy) -> u64 {
1075 Integer::from_attr(&tcx, attr::IntType::SignedInt(ity)).size().bits()
1078 #[allow(clippy::cast_possible_wrap)]
1079 /// Turn a constant int byte representation into an i128
1080 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ast::IntTy) -> i128 {
1081 let amt = 128 - int_bits(tcx, ity);
1082 ((u as i128) << amt) >> amt
1085 #[allow(clippy::cast_sign_loss)]
1086 /// clip unused bytes
1087 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ast::IntTy) -> u128 {
1088 let amt = 128 - int_bits(tcx, ity);
1089 ((u as u128) << amt) >> amt
1092 /// clip unused bytes
1093 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ast::UintTy) -> u128 {
1094 let bits = Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity)).size().bits();
1095 let amt = 128 - bits;
1099 /// Removes block comments from the given `Vec` of lines.
1104 /// without_block_comments(vec!["/*", "foo", "*/"]);
1107 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
1108 /// // => vec!["bar"]
1110 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
1111 let mut without = vec![];
1113 let mut nest_level = 0;
1116 if line.contains("/*") {
1119 } else if line.contains("*/") {
1124 if nest_level == 0 {
1132 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
1133 let map = &tcx.hir();
1134 let mut prev_enclosing_node = None;
1135 let mut enclosing_node = node;
1136 while Some(enclosing_node) != prev_enclosing_node {
1137 if is_automatically_derived(map.attrs(enclosing_node)) {
1140 prev_enclosing_node = Some(enclosing_node);
1141 enclosing_node = map.get_parent_item(enclosing_node);
1146 /// Returns true if ty has `iter` or `iter_mut` methods
1147 pub fn has_iter_method(cx: &LateContext<'_, '_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
1148 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1149 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1150 // so we can't use its `lookup_method` method.
1151 let into_iter_collections: [&[&str]; 13] = [
1158 &paths::LINKED_LIST,
1159 &paths::BINARY_HEAP,
1167 let ty_to_check = match probably_ref_ty.kind {
1168 ty::Ref(_, ty_to_check, _) => ty_to_check,
1169 _ => probably_ref_ty,
1172 let def_id = match ty_to_check.kind {
1173 ty::Array(..) => return Some("array"),
1174 ty::Slice(..) => return Some("slice"),
1175 ty::Adt(adt, _) => adt.did,
1179 for path in &into_iter_collections {
1180 if match_def_path(cx, def_id, path) {
1181 return Some(*path.last().unwrap());
1187 /// Matches a function call with the given path and returns the arguments.
1192 /// if let Some(args) = match_function_call(cx, begin_panic_call, &paths::BEGIN_PANIC);
1194 pub fn match_function_call<'a, 'tcx>(
1195 cx: &LateContext<'a, 'tcx>,
1196 expr: &'tcx Expr<'_>,
1198 ) -> Option<&'tcx [Expr<'tcx>]> {
1200 if let ExprKind::Call(ref fun, ref args) = expr.kind;
1201 if let ExprKind::Path(ref qpath) = fun.kind;
1202 if let Some(fun_def_id) = cx.tables.qpath_res(qpath, fun.hir_id).opt_def_id();
1203 if match_def_path(cx, fun_def_id, path);
1211 /// Checks if `Ty` is normalizable. This function is useful
1212 /// to avoid crashes on `layout_of`.
1213 pub fn is_normalizable<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
1214 cx.tcx.infer_ctxt().enter(|infcx| {
1215 let cause = rustc_middle::traits::ObligationCause::dummy();
1216 infcx.at(&cause, param_env).normalize(&ty).is_ok()
1220 pub fn match_def_path<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, did: DefId, syms: &[&str]) -> bool {
1221 // We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
1222 // accepts only that. We should probably move to Symbols in Clippy as well.
1223 let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
1224 cx.match_def_path(did, &syms)
1227 /// Returns the list of condition expressions and the list of blocks in a
1228 /// sequence of `if/else`.
1229 /// E.g., this returns `([a, b], [c, d, e])` for the expression
1230 /// `if a { c } else if b { d } else { e }`.
1231 pub fn if_sequence<'tcx>(
1232 mut expr: &'tcx Expr<'tcx>,
1233 ) -> (SmallVec<[&'tcx Expr<'tcx>; 1]>, SmallVec<[&'tcx Block<'tcx>; 1]>) {
1234 let mut conds = SmallVec::new();
1235 let mut blocks: SmallVec<[&Block<'_>; 1]> = SmallVec::new();
1237 while let Some((ref cond, ref then_expr, ref else_expr)) = higher::if_block(&expr) {
1238 conds.push(&**cond);
1239 if let ExprKind::Block(ref block, _) = then_expr.kind {
1242 panic!("ExprKind::If node is not an ExprKind::Block");
1245 if let Some(ref else_expr) = *else_expr {
1252 // final `else {..}`
1253 if !blocks.is_empty() {
1254 if let ExprKind::Block(ref block, _) = expr.kind {
1255 blocks.push(&**block);
1262 pub fn parent_node_is_if_expr<'a, 'b>(expr: &Expr<'_>, cx: &LateContext<'a, 'b>) -> bool {
1263 let map = cx.tcx.hir();
1264 let parent_id = map.get_parent_node(expr.hir_id);
1265 let parent_node = map.get(parent_id);
1268 Node::Expr(e) => higher::if_block(&e).is_some(),
1269 Node::Arm(e) => higher::if_block(&e.body).is_some(),
1274 // Finds the attribute with the given name, if any
1275 pub fn attr_by_name<'a>(attrs: &'a [Attribute], name: &'_ str) -> Option<&'a Attribute> {
1278 .find(|attr| attr.ident().map_or(false, |ident| ident.as_str() == name))
1281 // Finds the `#[must_use]` attribute, if any
1282 pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
1283 attr_by_name(attrs, "must_use")
1286 // Returns whether the type has #[must_use] attribute
1287 pub fn is_must_use_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
1289 ty::Adt(ref adt, _) => must_use_attr(&cx.tcx.get_attrs(adt.did)).is_some(),
1290 ty::Foreign(ref did) => must_use_attr(&cx.tcx.get_attrs(*did)).is_some(),
1292 | ty::Array(ref ty, _)
1293 | ty::RawPtr(ty::TypeAndMut { ref ty, .. })
1294 | ty::Ref(_, ref ty, _) => {
1295 // for the Array case we don't need to care for the len == 0 case
1296 // because we don't want to lint functions returning empty arrays
1297 is_must_use_ty(cx, *ty)
1299 ty::Tuple(ref substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
1300 ty::Opaque(ref def_id, _) => {
1301 for (predicate, _) in cx.tcx.predicates_of(*def_id).predicates {
1302 if let ty::PredicateKind::Trait(ref poly_trait_predicate, _) = predicate.kind() {
1303 if must_use_attr(&cx.tcx.get_attrs(poly_trait_predicate.skip_binder().trait_ref.def_id)).is_some() {
1310 ty::Dynamic(binder, _) => {
1311 for predicate in binder.skip_binder().iter() {
1312 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate {
1313 if must_use_attr(&cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
1324 // check if expr is calling method or function with #[must_use] attribyte
1325 pub fn is_must_use_func_call(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> bool {
1326 let did = match expr.kind {
1327 ExprKind::Call(ref path, _) => if_chain! {
1328 if let ExprKind::Path(ref qpath) = path.kind;
1329 if let def::Res::Def(_, did) = cx.tables.qpath_res(qpath, path.hir_id);
1336 ExprKind::MethodCall(_, _, _) => cx.tables.type_dependent_def_id(expr.hir_id),
1340 if let Some(did) = did {
1341 must_use_attr(&cx.tcx.get_attrs(did)).is_some()
1347 pub fn is_no_std_crate(krate: &Crate<'_>) -> bool {
1348 krate.item.attrs.iter().any(|attr| {
1349 if let ast::AttrKind::Normal(ref attr) = attr.kind {
1350 attr.path == symbol::sym::no_std
1357 /// Check if parent of a hir node is a trait implementation block.
1358 /// For example, `f` in
1360 /// impl Trait for S {
1364 pub fn is_trait_impl_item(cx: &LateContext<'_, '_>, hir_id: HirId) -> bool {
1365 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
1366 matches!(item.kind, ItemKind::Impl{ of_trait: Some(_), .. })
1372 /// Check if it's even possible to satisfy the `where` clause for the item.
1374 /// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
1377 /// fn foo() where i32: Iterator {
1378 /// for _ in 2i32 {}
1381 pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_, '_>, did: DefId) -> bool {
1382 use rustc_trait_selection::traits;
1388 .filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
1389 !traits::normalize_and_test_predicates(
1391 traits::elaborate_predicates(cx.tcx, predicates)
1392 .map(|o| o.predicate)
1393 .collect::<Vec<_>>(),
1397 pub fn run_lints(cx: &LateContext<'_, '_>, lints: &[&'static Lint], id: HirId) -> bool {
1398 lints.iter().any(|lint| {
1400 cx.tcx.lint_level_at_node(lint, id),
1401 (Level::Forbid | Level::Deny | Level::Warn, _)
1408 use super::{trim_multiline, without_block_comments};
1411 fn test_trim_multiline_single_line() {
1412 assert_eq!("", trim_multiline("".into(), false, None));
1413 assert_eq!("...", trim_multiline("...".into(), false, None));
1414 assert_eq!("...", trim_multiline(" ...".into(), false, None));
1415 assert_eq!("...", trim_multiline("\t...".into(), false, None));
1416 assert_eq!("...", trim_multiline("\t\t...".into(), false, None));
1421 fn test_trim_multiline_block() {
1427 }", trim_multiline(" if x {
1431 }".into(), false, None));
1437 }", trim_multiline(" if x {
1441 }".into(), false, None));
1446 fn test_trim_multiline_empty_line() {
1453 }", trim_multiline(" if x {
1458 }".into(), false, None));
1462 fn test_without_block_comments_lines_without_block_comments() {
1463 let result = without_block_comments(vec!["/*", "", "*/"]);
1464 println!("result: {:?}", result);
1465 assert!(result.is_empty());
1467 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1468 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1470 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1471 assert!(result.is_empty());
1473 let result = without_block_comments(vec!["/* one-line comment */"]);
1474 assert!(result.is_empty());
1476 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1477 assert!(result.is_empty());
1479 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1480 assert!(result.is_empty());
1482 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1483 assert_eq!(result, vec!["foo", "bar", "baz"]);