14 pub mod internal_lints;
19 pub use self::attrs::*;
20 pub use self::diagnostics::*;
21 pub use self::hir_utils::{SpanlessEq, SpanlessHash};
26 use if_chain::if_chain;
29 use rustc::hir::def::{DefKind, Res};
30 use rustc::hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
31 use rustc::hir::intravisit::{NestedVisitorMap, Visitor};
34 use rustc::lint::{LateContext, Level, Lint, LintContext};
38 layout::{self, IntegerExt},
42 use rustc_errors::Applicability;
43 use smallvec::SmallVec;
44 use syntax::ast::{self, LitKind};
46 use syntax::ext::hygiene::ExpnKind;
47 use syntax::source_map::{Span, DUMMY_SP};
48 use syntax::symbol::{kw, Symbol};
50 use crate::reexport::*;
52 /// Returns `true` if the two spans come from differing expansions (i.e., one is
53 /// from a macro and one isn't).
54 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
55 rhs.ctxt() != lhs.ctxt()
58 /// Returns `true` if the given `NodeId` is inside a constant context
63 /// if in_constant(cx, expr.id) {
67 pub fn in_constant(cx: &LateContext<'_, '_>, id: HirId) -> bool {
68 let parent_id = cx.tcx.hir().get_parent_item(id);
69 match cx.tcx.hir().get(parent_id) {
71 node: ItemKind::Const(..),
74 | Node::TraitItem(&TraitItem {
75 node: TraitItemKind::Const(..),
78 | Node::ImplItem(&ImplItem {
79 node: ImplItemKind::Const(..),
84 node: ItemKind::Static(..),
88 node: ItemKind::Fn(_, header, ..),
90 }) => header.constness == Constness::Const,
91 Node::ImplItem(&ImplItem {
92 node: ImplItemKind::Method(ref sig, _),
94 }) => sig.header.constness == Constness::Const,
99 /// Returns `true` if this `span` was expanded by any macro.
100 pub fn in_macro(span: Span) -> bool {
101 if span.from_expansion() {
102 if let ExpnKind::Desugaring(..) = span.ctxt().outer_expn_data().kind {
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 type is struct, enum or union type with the given def path.
126 pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
128 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
133 /// Checks if the method call given in `expr` belongs to the given trait.
134 pub fn match_trait_method(cx: &LateContext<'_, '_>, expr: &Expr, path: &[&str]) -> bool {
135 let def_id = cx.tables.type_dependent_def_id(expr.hir_id).unwrap();
136 let trt_id = cx.tcx.trait_of_item(def_id);
137 if let Some(trt_id) = trt_id {
138 match_def_path(cx, trt_id, path)
144 /// Checks if an expression references a variable of the given name.
145 pub fn match_var(expr: &Expr, var: Name) -> bool {
146 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.node {
147 if path.segments.len() == 1 && path.segments[0].ident.name == var {
154 pub fn last_path_segment(path: &QPath) -> &PathSegment {
156 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
157 QPath::TypeRelative(_, ref seg) => seg,
161 pub fn single_segment_path(path: &QPath) -> Option<&PathSegment> {
163 QPath::Resolved(_, ref path) if path.segments.len() == 1 => Some(&path.segments[0]),
164 QPath::Resolved(..) => None,
165 QPath::TypeRelative(_, ref seg) => Some(seg),
169 /// Matches a `QPath` against a slice of segment string literals.
171 /// There is also `match_path` if you are dealing with a `rustc::hir::Path` instead of a
172 /// `rustc::hir::QPath`.
176 /// match_qpath(path, &["std", "rt", "begin_unwind"])
178 pub fn match_qpath(path: &QPath, segments: &[&str]) -> bool {
180 QPath::Resolved(_, ref path) => match_path(path, segments),
181 QPath::TypeRelative(ref ty, ref segment) => match ty.node {
182 TyKind::Path(ref inner_path) => {
184 && match_qpath(inner_path, &segments[..(segments.len() - 1)])
185 && segment.ident.name.as_str() == segments[segments.len() - 1]
192 /// Matches a `Path` against a slice of segment string literals.
194 /// There is also `match_qpath` if you are dealing with a `rustc::hir::QPath` instead of a
195 /// `rustc::hir::Path`.
200 /// if match_path(&trait_ref.path, &paths::HASH) {
201 /// // This is the `std::hash::Hash` trait.
204 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
205 /// // This is a `rustc::lint::Lint`.
208 pub fn match_path(path: &Path, segments: &[&str]) -> bool {
212 .zip(segments.iter().rev())
213 .all(|(a, b)| a.ident.name.as_str() == *b)
216 /// Matches a `Path` against a slice of segment string literals, e.g.
220 /// match_qpath(path, &["std", "rt", "begin_unwind"])
222 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
226 .zip(segments.iter().rev())
227 .all(|(a, b)| a.ident.name.as_str() == *b)
230 /// Gets the definition associated to a path.
231 pub fn path_to_res(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<(def::Res)> {
232 let crates = cx.tcx.crates();
235 .find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
236 if let Some(krate) = krate {
239 index: CRATE_DEF_INDEX,
241 let mut items = cx.tcx.item_children(krate);
242 let mut path_it = path.iter().skip(1).peekable();
245 let segment = match path_it.next() {
246 Some(segment) => segment,
250 let result = SmallVec::<[_; 8]>::new();
251 for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
252 if item.ident.name.as_str() == *segment {
253 if path_it.peek().is_none() {
254 return Some(item.res);
257 items = cx.tcx.item_children(item.res.def_id());
267 /// Convenience function to get the `DefId` of a trait by path.
268 /// It could be a trait or trait alias.
269 pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
270 let res = match path_to_res(cx, path) {
276 Res::Def(DefKind::Trait, trait_id) | Res::Def(DefKind::TraitAlias, trait_id) => Some(trait_id),
277 Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
282 /// Checks whether a type implements a trait.
283 /// See also `get_trait_def_id`.
284 pub fn implements_trait<'a, 'tcx>(
285 cx: &LateContext<'a, 'tcx>,
288 ty_params: &[Kind<'tcx>],
290 let ty = cx.tcx.erase_regions(&ty);
291 let obligation = cx.tcx.predicate_for_trait_def(
293 traits::ObligationCause::dummy(),
301 .enter(|infcx| infcx.predicate_must_hold_modulo_regions(&obligation))
304 /// Gets the `hir::TraitRef` of the trait the given method is implemented for.
306 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
309 /// struct Point(isize, isize);
311 /// impl std::ops::Add for Point {
312 /// type Output = Self;
314 /// fn add(self, other: Self) -> Self {
319 pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'_, 'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef> {
320 // Get the implemented trait for the current function
321 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
323 if parent_impl != hir::CRATE_HIR_ID;
324 if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
325 if let hir::ItemKind::Impl(_, _, _, _, trait_ref, _, _) = &item.node;
326 then { return trait_ref.as_ref(); }
331 /// Checks whether this type implements `Drop`.
332 pub fn has_drop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
333 match ty.ty_adt_def() {
334 Some(def) => def.has_dtor(cx.tcx),
339 /// Resolves the definition of a node from its `HirId`.
340 pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> Res {
341 cx.tables.qpath_res(qpath, id)
344 /// Returns the method names and argument list of nested method call expressions that make up
345 /// `expr`. method/span lists are sorted with the most recent call first.
346 pub fn method_calls(expr: &Expr, max_depth: usize) -> (Vec<Symbol>, Vec<&[Expr]>, Vec<Span>) {
347 let mut method_names = Vec::with_capacity(max_depth);
348 let mut arg_lists = Vec::with_capacity(max_depth);
349 let mut spans = Vec::with_capacity(max_depth);
351 let mut current = expr;
352 for _ in 0..max_depth {
353 if let ExprKind::MethodCall(path, span, args) = ¤t.node {
354 if args.iter().any(|e| e.span.from_expansion()) {
357 method_names.push(path.ident.name);
358 arg_lists.push(&**args);
366 (method_names, arg_lists, spans)
369 /// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
371 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
372 /// `matched_method_chain(expr, &["bar", "baz"])` will return a `Vec`
373 /// containing the `Expr`s for
374 /// `.bar()` and `.baz()`
375 pub fn method_chain_args<'a>(expr: &'a Expr, methods: &[&str]) -> Option<Vec<&'a [Expr]>> {
376 let mut current = expr;
377 let mut matched = Vec::with_capacity(methods.len());
378 for method_name in methods.iter().rev() {
379 // method chains are stored last -> first
380 if let ExprKind::MethodCall(ref path, _, ref args) = current.node {
381 if path.ident.name.as_str() == *method_name {
382 if args.iter().any(|e| e.span.from_expansion()) {
385 matched.push(&**args); // build up `matched` backwards
386 current = &args[0] // go to parent expression
394 // Reverse `matched` so that it is in the same order as `methods`.
399 /// Returns `true` if the provided `def_id` is an entrypoint to a program.
400 pub fn is_entrypoint_fn(cx: &LateContext<'_, '_>, def_id: DefId) -> bool {
401 if let Some((entry_fn_def_id, _)) = cx.tcx.entry_fn(LOCAL_CRATE) {
402 return def_id == entry_fn_def_id;
407 /// Gets the name of the item the expression is in, if available.
408 pub fn get_item_name(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<Name> {
409 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
410 match cx.tcx.hir().find(parent_id) {
411 Some(Node::Item(&Item { ref ident, .. })) => Some(ident.name),
412 Some(Node::TraitItem(&TraitItem { ident, .. })) | Some(Node::ImplItem(&ImplItem { ident, .. })) => {
419 /// Gets the name of a `Pat`, if any.
420 pub fn get_pat_name(pat: &Pat) -> Option<Name> {
422 PatKind::Binding(.., ref spname, _) => Some(spname.name),
423 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
424 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
429 struct ContainsName {
434 impl<'tcx> Visitor<'tcx> for ContainsName {
435 fn visit_name(&mut self, _: Span, name: Name) {
436 if self.name == name {
440 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
441 NestedVisitorMap::None
445 /// Checks if an `Expr` contains a certain name.
446 pub fn contains_name(name: Name, expr: &Expr) -> bool {
447 let mut cn = ContainsName { name, result: false };
452 /// Converts a span to a code snippet if available, otherwise use default.
454 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
455 /// to convert a given `Span` to a `str`.
459 /// snippet(cx, expr.span, "..")
461 pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
462 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
465 /// Same as `snippet`, but it adapts the applicability level by following rules:
467 /// - Applicability level `Unspecified` will never be changed.
468 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
469 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
470 /// `HasPlaceholders`
471 pub fn snippet_with_applicability<'a, T: LintContext>(
475 applicability: &mut Applicability,
477 if *applicability != Applicability::Unspecified && span.from_expansion() {
478 *applicability = Applicability::MaybeIncorrect;
480 snippet_opt(cx, span).map_or_else(
482 if *applicability == Applicability::MachineApplicable {
483 *applicability = Applicability::HasPlaceholders;
485 Cow::Borrowed(default)
491 /// Same as `snippet`, but should only be used when it's clear that the input span is
492 /// not a macro argument.
493 pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
494 snippet(cx, span.source_callsite(), default)
497 /// Converts a span to a code snippet. Returns `None` if not available.
498 pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
499 cx.sess().source_map().span_to_snippet(span).ok()
502 /// Converts a span (from a block) to a code snippet if available, otherwise use
504 /// This trims the code of indentation, except for the first line. Use it for
505 /// blocks or block-like
506 /// things which need to be printed as such.
510 /// snippet_block(cx, expr.span, "..")
512 pub fn snippet_block<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
513 let snip = snippet(cx, span, default);
514 trim_multiline(snip, true)
517 /// Same as `snippet_block`, but adapts the applicability level by the rules of
518 /// `snippet_with_applicabiliy`.
519 pub fn snippet_block_with_applicability<'a, T: LintContext>(
523 applicability: &mut Applicability,
525 let snip = snippet_with_applicability(cx, span, default, applicability);
526 trim_multiline(snip, true)
529 /// Returns a new Span that covers the full last line of the given Span
530 pub fn last_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
531 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
532 let line_no = source_map_and_line.line;
533 let line_start = &source_map_and_line.sf.lines[line_no];
534 Span::new(*line_start, span.hi(), span.ctxt())
537 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
538 /// Also takes an `Option<String>` which can be put inside the braces.
539 pub fn expr_block<'a, T: LintContext>(cx: &T, expr: &Expr, option: Option<String>, default: &'a str) -> Cow<'a, str> {
540 let code = snippet_block(cx, expr.span, default);
541 let string = option.unwrap_or_default();
542 if expr.span.from_expansion() {
543 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
544 } else if let ExprKind::Block(_, _) = expr.node {
545 Cow::Owned(format!("{}{}", code, string))
546 } else if string.is_empty() {
547 Cow::Owned(format!("{{ {} }}", code))
549 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
553 /// Trim indentation from a multiline string with possibility of ignoring the
555 pub fn trim_multiline(s: Cow<'_, str>, ignore_first: bool) -> Cow<'_, str> {
556 let s_space = trim_multiline_inner(s, ignore_first, ' ');
557 let s_tab = trim_multiline_inner(s_space, ignore_first, '\t');
558 trim_multiline_inner(s_tab, ignore_first, ' ')
561 fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, ch: char) -> Cow<'_, str> {
564 .skip(ignore_first as usize)
569 // ignore empty lines
570 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
580 if (ignore_first && i == 0) || l.is_empty() {
594 /// Gets the parent expression, if any –- this is useful to constrain a lint.
595 pub fn get_parent_expr<'c>(cx: &'c LateContext<'_, '_>, e: &Expr) -> Option<&'c Expr> {
596 let map = &cx.tcx.hir();
597 let hir_id = e.hir_id;
598 let parent_id = map.get_parent_node(hir_id);
599 if hir_id == parent_id {
602 map.find(parent_id).and_then(|node| {
603 if let Node::Expr(parent) = node {
611 pub fn get_enclosing_block<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, hir_id: HirId) -> Option<&'tcx Block> {
612 let map = &cx.tcx.hir();
613 let enclosing_node = map
614 .get_enclosing_scope(hir_id)
615 .and_then(|enclosing_id| map.find(enclosing_id));
616 if let Some(node) = enclosing_node {
618 Node::Block(block) => Some(block),
620 node: ItemKind::Fn(_, _, _, eid),
623 | Node::ImplItem(&ImplItem {
624 node: ImplItemKind::Method(_, eid),
626 }) => match cx.tcx.hir().body(eid).value.node {
627 ExprKind::Block(ref block, _) => Some(block),
637 /// Returns the base type for HIR references and pointers.
638 pub fn walk_ptrs_hir_ty(ty: &hir::Ty) -> &hir::Ty {
640 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
645 /// Returns the base type for references and raw pointers.
646 pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
648 ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
653 /// Returns the base type for references and raw pointers, and count reference
655 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
656 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
658 ty::Ref(_, ty, _) => inner(ty, depth + 1),
665 /// Checks whether the given expression is a constant literal of the given value.
666 pub fn is_integer_literal(expr: &Expr, value: u128) -> bool {
667 // FIXME: use constant folding
668 if let ExprKind::Lit(ref spanned) = expr.node {
669 if let LitKind::Int(v, _) = spanned.node {
676 /// Returns `true` if the given `Expr` has been coerced before.
678 /// Examples of coercions can be found in the Nomicon at
679 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
681 /// See `rustc::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
682 /// information on adjustments and coercions.
683 pub fn is_adjusted(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
684 cx.tables.adjustments().get(e.hir_id).is_some()
687 /// Returns the pre-expansion span if is this comes from an expansion of the
689 /// See also `is_direct_expn_of`.
690 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
692 if span.from_expansion() {
693 let data = span.ctxt().outer_expn_data();
694 let mac_name = data.kind.descr();
695 let new_span = data.call_site;
697 if mac_name.as_str() == name {
698 return Some(new_span);
708 /// Returns the pre-expansion span if the span directly comes from an expansion
709 /// of the macro `name`.
710 /// The difference with `is_expn_of` is that in
714 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
716 /// `is_direct_expn_of`.
717 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
718 if span.from_expansion() {
719 let data = span.ctxt().outer_expn_data();
720 let mac_name = data.kind.descr();
721 let new_span = data.call_site;
723 if mac_name.as_str() == name {
733 /// Convenience function to get the return type of a function.
734 pub fn return_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
735 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
736 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
737 cx.tcx.erase_late_bound_regions(&ret_ty)
740 /// Checks if two types are the same.
742 /// This discards any lifetime annotations, too.
744 // FIXME: this works correctly for lifetimes bounds (`for <'a> Foo<'a>` ==
745 // `for <'b> Foo<'b>`, but not for type parameters).
746 pub fn same_tys<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
747 let a = cx.tcx.erase_late_bound_regions(&Binder::bind(a));
748 let b = cx.tcx.erase_late_bound_regions(&Binder::bind(b));
751 .enter(|infcx| infcx.can_eq(cx.param_env, a, b).is_ok())
754 /// Returns `true` if the given type is an `unsafe` function.
755 pub fn type_is_unsafe_function<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
757 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
762 pub fn is_copy<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
763 ty.is_copy_modulo_regions(cx.tcx.global_tcx(), cx.param_env, DUMMY_SP)
766 /// Checks if an expression is constructing a tuple-like enum variant or struct
767 pub fn is_ctor_function(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
768 if let ExprKind::Call(ref fun, _) = expr.node {
769 if let ExprKind::Path(ref qp) = fun.node {
771 cx.tables.qpath_res(qp, fun.hir_id),
772 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(..), _)
779 /// Returns `true` if a pattern is refutable.
780 pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat) -> bool {
781 fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> bool {
783 cx.tables.qpath_res(qpath, id),
784 def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
788 fn are_refutable<'a, I: Iterator<Item = &'a Pat>>(cx: &LateContext<'_, '_>, mut i: I) -> bool {
789 i.any(|pat| is_refutable(cx, pat))
793 PatKind::Binding(..) | PatKind::Wild => false,
794 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
795 PatKind::Lit(..) | PatKind::Range(..) => true,
796 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
797 PatKind::Or(ref pats) | PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
798 PatKind::Struct(ref qpath, ref fields, _) => {
799 if is_enum_variant(cx, qpath, pat.hir_id) {
802 are_refutable(cx, fields.iter().map(|field| &*field.pat))
805 PatKind::TupleStruct(ref qpath, ref pats, _) => {
806 if is_enum_variant(cx, qpath, pat.hir_id) {
809 are_refutable(cx, pats.iter().map(|pat| &**pat))
812 PatKind::Slice(ref head, ref middle, ref tail) => {
813 are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
818 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
819 /// implementations have.
820 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
821 attr::contains_name(attrs, sym!(automatically_derived))
824 /// Remove blocks around an expression.
826 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
828 pub fn remove_blocks(expr: &Expr) -> &Expr {
829 if let ExprKind::Block(ref block, _) = expr.node {
830 if block.stmts.is_empty() {
831 if let Some(ref expr) = block.expr {
844 pub fn is_self(slf: &Param) -> bool {
845 if let PatKind::Binding(.., name, _) = slf.pat.node {
846 name.name == kw::SelfLower
852 pub fn is_self_ty(slf: &hir::Ty) -> bool {
854 if let TyKind::Path(ref qp) = slf.node;
855 if let QPath::Resolved(None, ref path) = *qp;
856 if let Res::SelfTy(..) = path.res;
864 pub fn iter_input_pats<'tcx>(decl: &FnDecl, body: &'tcx Body) -> impl Iterator<Item = &'tcx Param> {
865 (0..decl.inputs.len()).map(move |i| &body.params[i])
868 /// Checks if a given expression is a match expression expanded from the `?`
869 /// operator or the `try` macro.
870 pub fn is_try(expr: &Expr) -> Option<&Expr> {
871 fn is_ok(arm: &Arm) -> bool {
873 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pats[0].node;
874 if match_qpath(path, &paths::RESULT_OK[1..]);
875 if let PatKind::Binding(_, hir_id, _, None) = pat[0].node;
876 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.node;
877 if let Res::Local(lid) = path.res;
886 fn is_err(arm: &Arm) -> bool {
887 if let PatKind::TupleStruct(ref path, _, _) = arm.pats[0].node {
888 match_qpath(path, &paths::RESULT_ERR[1..])
894 if let ExprKind::Match(_, ref arms, ref source) = expr.node {
895 // desugared from a `?` operator
896 if let MatchSource::TryDesugar = *source {
902 if arms[0].pats.len() == 1 && arms[0].guard.is_none();
903 if arms[1].pats.len() == 1 && arms[1].guard.is_none();
904 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
905 (is_ok(&arms[1]) && is_err(&arms[0]));
915 /// Returns `true` if the lint is allowed in the current context
917 /// Useful for skipping long running code when it's unnecessary
918 pub fn is_allowed(cx: &LateContext<'_, '_>, lint: &'static Lint, id: HirId) -> bool {
919 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
922 pub fn get_arg_name(pat: &Pat) -> Option<ast::Name> {
924 PatKind::Binding(.., ident, None) => Some(ident.name),
925 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
930 pub fn int_bits(tcx: TyCtxt<'_>, ity: ast::IntTy) -> u64 {
931 layout::Integer::from_attr(&tcx, attr::IntType::SignedInt(ity))
936 #[allow(clippy::cast_possible_wrap)]
937 /// Turn a constant int byte representation into an i128
938 pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ast::IntTy) -> i128 {
939 let amt = 128 - int_bits(tcx, ity);
940 ((u as i128) << amt) >> amt
943 #[allow(clippy::cast_sign_loss)]
944 /// clip unused bytes
945 pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ast::IntTy) -> u128 {
946 let amt = 128 - int_bits(tcx, ity);
947 ((u as u128) << amt) >> amt
950 /// clip unused bytes
951 pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ast::UintTy) -> u128 {
952 let bits = layout::Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity))
955 let amt = 128 - bits;
959 /// Removes block comments from the given `Vec` of lines.
964 /// without_block_comments(vec!["/*", "foo", "*/"]);
967 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
968 /// // => vec!["bar"]
970 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
971 let mut without = vec![];
973 let mut nest_level = 0;
976 if line.contains("/*") {
979 } else if line.contains("*/") {
992 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
993 let map = &tcx.hir();
994 let mut prev_enclosing_node = None;
995 let mut enclosing_node = node;
996 while Some(enclosing_node) != prev_enclosing_node {
997 if is_automatically_derived(map.attrs(enclosing_node)) {
1000 prev_enclosing_node = Some(enclosing_node);
1001 enclosing_node = map.get_parent_item(enclosing_node);
1006 /// Returns true if ty has `iter` or `iter_mut` methods
1007 pub fn has_iter_method(cx: &LateContext<'_, '_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
1008 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1009 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1010 // so we can't use its `lookup_method` method.
1011 let into_iter_collections: [&[&str]; 13] = [
1018 &paths::LINKED_LIST,
1019 &paths::BINARY_HEAP,
1027 let ty_to_check = match probably_ref_ty.sty {
1028 ty::Ref(_, ty_to_check, _) => ty_to_check,
1029 _ => probably_ref_ty,
1032 let def_id = match ty_to_check.sty {
1033 ty::Array(..) => return Some("array"),
1034 ty::Slice(..) => return Some("slice"),
1035 ty::Adt(adt, _) => adt.did,
1039 for path in &into_iter_collections {
1040 if match_def_path(cx, def_id, path) {
1041 return Some(*path.last().unwrap());
1049 use super::{trim_multiline, without_block_comments};
1052 fn test_trim_multiline_single_line() {
1053 assert_eq!("", trim_multiline("".into(), false));
1054 assert_eq!("...", trim_multiline("...".into(), false));
1055 assert_eq!("...", trim_multiline(" ...".into(), false));
1056 assert_eq!("...", trim_multiline("\t...".into(), false));
1057 assert_eq!("...", trim_multiline("\t\t...".into(), false));
1062 fn test_trim_multiline_block() {
1068 }", trim_multiline(" if x {
1078 }", trim_multiline(" if x {
1087 fn test_trim_multiline_empty_line() {
1094 }", trim_multiline(" if x {
1103 fn test_without_block_comments_lines_without_block_comments() {
1104 let result = without_block_comments(vec!["/*", "", "*/"]);
1105 println!("result: {:?}", result);
1106 assert!(result.is_empty());
1108 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1109 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1111 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1112 assert!(result.is_empty());
1114 let result = without_block_comments(vec!["/* one-line comment */"]);
1115 assert!(result.is_empty());
1117 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1118 assert!(result.is_empty());
1120 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1121 assert!(result.is_empty());
1123 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1124 assert_eq!(result, vec!["foo", "bar", "baz"]);
1128 pub fn match_def_path<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, did: DefId, syms: &[&str]) -> bool {
1129 let path = cx.get_def_path(did);
1130 path.len() == syms.len() && path.into_iter().zip(syms.iter()).all(|(a, &b)| a.as_str() == b)