1 use crate::reexport::*;
2 use if_chain::if_chain;
5 use rustc::hir::def::Def;
6 use rustc::hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
7 use rustc::hir::intravisit::{NestedVisitorMap, Visitor};
10 use rustc::lint::{LateContext, Level, Lint, LintContext};
14 layout::{self, IntegerExt},
18 use rustc_data_structures::sync::Lrc;
19 use rustc_errors::Applicability;
22 use syntax::ast::{self, LitKind};
24 use syntax::source_map::{Span, DUMMY_SP};
26 use syntax::symbol::{keywords, Symbol};
38 pub mod internal_lints;
43 pub use self::attrs::*;
44 pub use self::diagnostics::*;
45 pub use self::hir_utils::{SpanlessEq, SpanlessHash};
47 /// Returns true if the two spans come from differing expansions (i.e. one is
48 /// from a macro and one
50 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
51 rhs.ctxt() != lhs.ctxt()
54 /// Returns `true` if the given `NodeId` is inside a constant context
59 /// if in_constant(cx, expr.id) {
63 pub fn in_constant(cx: &LateContext<'_, '_>, id: HirId) -> bool {
64 let parent_id = cx.tcx.hir().get_parent_item(id);
65 match cx.tcx.hir().get_by_hir_id(parent_id) {
67 node: ItemKind::Const(..),
70 | Node::TraitItem(&TraitItem {
71 node: TraitItemKind::Const(..),
74 | Node::ImplItem(&ImplItem {
75 node: ImplItemKind::Const(..),
80 node: ItemKind::Static(..),
84 node: ItemKind::Fn(_, header, ..),
86 }) => header.constness == Constness::Const,
91 /// Returns true if this `expn_info` was expanded by any macro.
92 pub fn in_macro(span: Span) -> bool {
93 span.ctxt().outer().expn_info().is_some()
96 /// Used to store the absolute path to a type.
98 /// See `match_def_path` for usage.
100 pub struct AbsolutePathBuffer {
101 pub names: Vec<symbol::LocalInternedString>,
104 impl ty::item_path::ItemPathBuffer for AbsolutePathBuffer {
105 fn root_mode(&self) -> &ty::item_path::RootMode {
106 const ABSOLUTE: &ty::item_path::RootMode = &ty::item_path::RootMode::Absolute;
110 fn push(&mut self, text: &str) {
111 self.names.push(symbol::Symbol::intern(text).as_str());
115 /// Check if a `DefId`'s path matches the given absolute type path usage.
119 /// match_def_path(cx.tcx, id, &["core", "option", "Option"])
122 /// See also the `paths` module.
123 pub fn match_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId, path: &[&str]) -> bool {
124 let mut apb = AbsolutePathBuffer { names: vec![] };
126 tcx.push_item_path(&mut apb, def_id, false);
128 apb.names.len() == path.len() && apb.names.into_iter().zip(path.iter()).all(|(a, &b)| *a == *b)
131 /// Get the absolute path of `def_id` as a vector of `&str`.
135 /// let def_path = get_def_path(tcx, def_id);
136 /// if let &["core", "option", "Option"] = &def_path[..] {
137 /// // The given `def_id` is that of an `Option` type
140 pub fn get_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId) -> Vec<&'static str> {
141 let mut apb = AbsolutePathBuffer { names: vec![] };
142 tcx.push_item_path(&mut apb, def_id, false);
145 .map(syntax_pos::symbol::LocalInternedString::get)
149 /// Check if type is struct, enum or union type with given def path.
150 pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
152 ty::Adt(adt, _) => match_def_path(cx.tcx, adt.did, path),
157 /// Check if the method call given in `expr` belongs to given trait.
158 pub fn match_trait_method(cx: &LateContext<'_, '_>, expr: &Expr, path: &[&str]) -> bool {
159 let method_call = cx.tables.type_dependent_defs()[expr.hir_id];
160 let trt_id = cx.tcx.trait_of_item(method_call.def_id());
161 if let Some(trt_id) = trt_id {
162 match_def_path(cx.tcx, trt_id, path)
168 /// Check if an expression references a variable of the given name.
169 pub fn match_var(expr: &Expr, var: Name) -> bool {
170 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.node {
171 if path.segments.len() == 1 && path.segments[0].ident.name == var {
178 pub fn last_path_segment(path: &QPath) -> &PathSegment {
180 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
181 QPath::TypeRelative(_, ref seg) => seg,
185 pub fn single_segment_path(path: &QPath) -> Option<&PathSegment> {
187 QPath::Resolved(_, ref path) if path.segments.len() == 1 => Some(&path.segments[0]),
188 QPath::Resolved(..) => None,
189 QPath::TypeRelative(_, ref seg) => Some(seg),
193 /// Match a `QPath` against a slice of segment string literals.
195 /// There is also `match_path` if you are dealing with a `rustc::hir::Path` instead of a
196 /// `rustc::hir::QPath`.
200 /// match_qpath(path, &["std", "rt", "begin_unwind"])
202 pub fn match_qpath(path: &QPath, segments: &[&str]) -> bool {
204 QPath::Resolved(_, ref path) => match_path(path, segments),
205 QPath::TypeRelative(ref ty, ref segment) => match ty.node {
206 TyKind::Path(ref inner_path) => {
208 && match_qpath(inner_path, &segments[..(segments.len() - 1)])
209 && segment.ident.name == segments[segments.len() - 1]
216 /// Match a `Path` against a slice of segment string literals.
218 /// There is also `match_qpath` if you are dealing with a `rustc::hir::QPath` instead of a
219 /// `rustc::hir::Path`.
224 /// if match_path(&trait_ref.path, &paths::HASH) {
225 /// // This is the `std::hash::Hash` trait.
228 /// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
229 /// // This is a `rustc::lint::Lint`.
232 pub fn match_path(path: &Path, segments: &[&str]) -> bool {
236 .zip(segments.iter().rev())
237 .all(|(a, b)| a.ident.name == *b)
240 /// Match a `Path` against a slice of segment string literals, e.g.
244 /// match_qpath(path, &["std", "rt", "begin_unwind"])
246 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
250 .zip(segments.iter().rev())
251 .all(|(a, b)| a.ident.name == *b)
254 /// Get the definition associated to a path.
255 pub fn path_to_def(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<def::Def> {
256 let crates = cx.tcx.crates();
257 let krate = crates.iter().find(|&&krate| cx.tcx.crate_name(krate) == 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 for item in mem::replace(&mut items, Lrc::new(vec![])).iter() {
273 if item.ident.name == *segment {
274 if path_it.peek().is_none() {
275 return Some(item.def);
278 items = cx.tcx.item_children(item.def.def_id());
288 /// Convenience function to get the `DefId` of a trait by path.
289 pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
290 let def = match path_to_def(cx, path) {
296 def::Def::Trait(trait_id) => Some(trait_id),
301 /// Check whether a type implements a trait.
302 /// See also `get_trait_def_id`.
303 pub fn implements_trait<'a, 'tcx>(
304 cx: &LateContext<'a, 'tcx>,
307 ty_params: &[Kind<'tcx>],
309 let ty = cx.tcx.erase_regions(&ty);
310 let obligation = cx.tcx.predicate_for_trait_def(
312 traits::ObligationCause::dummy(),
320 .enter(|infcx| infcx.predicate_must_hold_modulo_regions(&obligation))
323 /// Get the `hir::TraitRef` of the trait the given method is implemented for
325 /// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
328 /// struct Point(isize, isize);
330 /// impl std::ops::Add for Point {
331 /// type Output = Self;
333 /// fn add(self, other: Self) -> Self {
338 pub fn trait_ref_of_method(cx: &LateContext<'_, '_>, hir_id: HirId) -> Option<TraitRef> {
339 // Get the implemented trait for the current function
340 let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
342 if parent_impl != hir::CRATE_HIR_ID;
343 if let hir::Node::Item(item) = cx.tcx.hir().get_by_hir_id(parent_impl);
344 if let hir::ItemKind::Impl(_, _, _, _, trait_ref, _, _) = &item.node;
345 then { return trait_ref.clone(); }
350 /// Check whether this type implements Drop.
351 pub fn has_drop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
352 match ty.ty_adt_def() {
353 Some(def) => def.has_dtor(cx.tcx),
358 /// Resolve the definition of a node from its `HirId`.
359 pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> def::Def {
360 cx.tables.qpath_def(qpath, id)
363 /// Return the method names and argument list of nested method call expressions that make up
365 pub fn method_calls<'a>(expr: &'a Expr, max_depth: usize) -> (Vec<Symbol>, Vec<&'a [Expr]>) {
366 let mut method_names = Vec::with_capacity(max_depth);
367 let mut arg_lists = Vec::with_capacity(max_depth);
369 let mut current = expr;
370 for _ in 0..max_depth {
371 if let ExprKind::MethodCall(path, _, args) = ¤t.node {
372 if args.iter().any(|e| in_macro(e.span)) {
375 method_names.push(path.ident.name);
376 arg_lists.push(&**args);
383 (method_names, arg_lists)
386 /// Match an `Expr` against a chain of methods, and return the matched `Expr`s.
388 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
389 /// `matched_method_chain(expr, &["bar", "baz"])` will return a `Vec`
390 /// containing the `Expr`s for
391 /// `.bar()` and `.baz()`
392 pub fn method_chain_args<'a>(expr: &'a Expr, methods: &[&str]) -> Option<Vec<&'a [Expr]>> {
393 let mut current = expr;
394 let mut matched = Vec::with_capacity(methods.len());
395 for method_name in methods.iter().rev() {
396 // method chains are stored last -> first
397 if let ExprKind::MethodCall(ref path, _, ref args) = current.node {
398 if path.ident.name == *method_name {
399 if args.iter().any(|e| in_macro(e.span)) {
402 matched.push(&**args); // build up `matched` backwards
403 current = &args[0] // go to parent expression
411 matched.reverse(); // reverse `matched`, so that it is in the same order as `methods`
415 /// Returns true if the provided `def_id` is an entrypoint to a program
416 pub fn is_entrypoint_fn(cx: &LateContext<'_, '_>, def_id: DefId) -> bool {
417 if let Some((entry_fn_def_id, _)) = cx.tcx.entry_fn(LOCAL_CRATE) {
418 return def_id == entry_fn_def_id;
423 /// Get the name of the item the expression is in, if available.
424 pub fn get_item_name(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<Name> {
425 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
426 match cx.tcx.hir().find_by_hir_id(parent_id) {
427 Some(Node::Item(&Item { ref ident, .. })) => Some(ident.name),
428 Some(Node::TraitItem(&TraitItem { ident, .. })) | Some(Node::ImplItem(&ImplItem { ident, .. })) => {
435 /// Get the name of a `Pat`, if any
436 pub fn get_pat_name(pat: &Pat) -> Option<Name> {
438 PatKind::Binding(.., ref spname, _) => Some(spname.name),
439 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
440 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
445 struct ContainsName {
450 impl<'tcx> Visitor<'tcx> for ContainsName {
451 fn visit_name(&mut self, _: Span, name: Name) {
452 if self.name == name {
456 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
457 NestedVisitorMap::None
461 /// check if an `Expr` contains a certain name
462 pub fn contains_name(name: Name, expr: &Expr) -> bool {
463 let mut cn = ContainsName { name, result: false };
468 /// Convert a span to a code snippet if available, otherwise use default.
470 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
471 /// to convert a given `Span` to a `str`.
475 /// snippet(cx, expr.span, "..")
477 pub fn snippet<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
478 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
481 /// Same as `snippet`, but it adapts the applicability level by following rules:
483 /// - Applicability level `Unspecified` will never be changed.
484 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
485 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
486 /// `HasPlaceholders`
487 pub fn snippet_with_applicability<'a, 'b, T: LintContext<'b>>(
491 applicability: &mut Applicability,
493 if *applicability != Applicability::Unspecified && in_macro(span) {
494 *applicability = Applicability::MaybeIncorrect;
496 snippet_opt(cx, span).map_or_else(
498 if *applicability == Applicability::MachineApplicable {
499 *applicability = Applicability::HasPlaceholders;
501 Cow::Borrowed(default)
507 /// Same as `snippet`, but should only be used when it's clear that the input span is
508 /// not a macro argument.
509 pub fn snippet_with_macro_callsite<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
510 snippet(cx, span.source_callsite(), default)
513 /// Convert a span to a code snippet. Returns `None` if not available.
514 pub fn snippet_opt<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
515 cx.sess().source_map().span_to_snippet(span).ok()
518 /// Convert a span (from a block) to a code snippet if available, otherwise use
520 /// This trims the code of indentation, except for the first line. Use it for
521 /// blocks or block-like
522 /// things which need to be printed as such.
526 /// snippet_block(cx, expr.span, "..")
528 pub fn snippet_block<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
529 let snip = snippet(cx, span, default);
530 trim_multiline(snip, true)
533 /// Same as `snippet_block`, but adapts the applicability level by the rules of
534 /// `snippet_with_applicabiliy`.
535 pub fn snippet_block_with_applicability<'a, 'b, T: LintContext<'b>>(
539 applicability: &mut Applicability,
541 let snip = snippet_with_applicability(cx, span, default, applicability);
542 trim_multiline(snip, true)
545 /// Returns a new Span that covers the full last line of the given Span
546 pub fn last_line_of_span<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Span {
547 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
548 let line_no = source_map_and_line.line;
549 let line_start = &source_map_and_line.sf.lines[line_no];
550 Span::new(*line_start, span.hi(), span.ctxt())
553 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
554 /// Also takes an `Option<String>` which can be put inside the braces.
555 pub fn expr_block<'a, 'b, T: LintContext<'b>>(
558 option: Option<String>,
561 let code = snippet_block(cx, expr.span, default);
562 let string = option.unwrap_or_default();
563 if in_macro(expr.span) {
564 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
565 } else if let ExprKind::Block(_, _) = expr.node {
566 Cow::Owned(format!("{}{}", code, string))
567 } else if string.is_empty() {
568 Cow::Owned(format!("{{ {} }}", code))
570 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
574 /// Trim indentation from a multiline string with possibility of ignoring the
576 pub fn trim_multiline(s: Cow<'_, str>, ignore_first: bool) -> Cow<'_, str> {
577 let s_space = trim_multiline_inner(s, ignore_first, ' ');
578 let s_tab = trim_multiline_inner(s_space, ignore_first, '\t');
579 trim_multiline_inner(s_tab, ignore_first, ' ')
582 fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, ch: char) -> Cow<'_, str> {
585 .skip(ignore_first as usize)
590 // ignore empty lines
591 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
601 if (ignore_first && i == 0) || l.is_empty() {
615 /// Get a parent expressions if any – this is useful to constrain a lint.
616 pub fn get_parent_expr<'c>(cx: &'c LateContext<'_, '_>, e: &Expr) -> Option<&'c Expr> {
617 let map = &cx.tcx.hir();
618 let hir_id = e.hir_id;
619 let parent_id = map.get_parent_node_by_hir_id(hir_id);
620 if hir_id == parent_id {
623 map.find_by_hir_id(parent_id).and_then(|node| {
624 if let Node::Expr(parent) = node {
632 pub fn get_enclosing_block<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, node: HirId) -> Option<&'tcx Block> {
633 let map = &cx.tcx.hir();
634 let node_id = map.hir_to_node_id(node);
635 let enclosing_node = map
636 .get_enclosing_scope(node_id)
637 .and_then(|enclosing_id| map.find(enclosing_id));
638 if let Some(node) = enclosing_node {
640 Node::Block(block) => Some(block),
642 node: ItemKind::Fn(_, _, _, eid),
645 | Node::ImplItem(&ImplItem {
646 node: ImplItemKind::Method(_, eid),
648 }) => match cx.tcx.hir().body(eid).value.node {
649 ExprKind::Block(ref block, _) => Some(block),
659 /// Return the base type for HIR references and pointers.
660 pub fn walk_ptrs_hir_ty(ty: &hir::Ty) -> &hir::Ty {
662 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
667 /// Return the base type for references and raw pointers.
668 pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
670 ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
675 /// Return the base type for references and raw pointers, and count reference
677 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
678 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
680 ty::Ref(_, ty, _) => inner(ty, depth + 1),
687 /// Check whether the given expression is a constant literal of the given value.
688 pub fn is_integer_literal(expr: &Expr, value: u128) -> bool {
689 // FIXME: use constant folding
690 if let ExprKind::Lit(ref spanned) = expr.node {
691 if let LitKind::Int(v, _) = spanned.node {
698 /// Returns `true` if the given `Expr` has been coerced before.
700 /// Examples of coercions can be found in the Nomicon at
701 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
703 /// See `rustc::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
704 /// information on adjustments and coercions.
705 pub fn is_adjusted(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
706 cx.tables.adjustments().get(e.hir_id).is_some()
709 /// Return the pre-expansion span if is this comes from an expansion of the
711 /// See also `is_direct_expn_of`.
712 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
714 let span_name_span = span
718 .map(|ei| (ei.format.name(), ei.call_site));
720 match span_name_span {
721 Some((mac_name, new_span)) if mac_name == name => return Some(new_span),
723 Some((_, new_span)) => span = new_span,
728 /// Return the pre-expansion span if is this directly comes from an expansion
729 /// of the macro `name`.
730 /// The difference with `is_expn_of` is that in
734 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
736 /// `is_direct_expn_of`.
737 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
738 let span_name_span = span
742 .map(|ei| (ei.format.name(), ei.call_site));
744 match span_name_span {
745 Some((mac_name, new_span)) if mac_name == name => Some(new_span),
750 /// Convenience function to get the return type of a function
751 pub fn return_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
752 let fn_def_id = cx.tcx.hir().local_def_id_from_hir_id(fn_item);
753 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
754 cx.tcx.erase_late_bound_regions(&ret_ty)
757 /// Check if two types are the same.
759 /// This discards any lifetime annotations, too.
760 // FIXME: this works correctly for lifetimes bounds (`for <'a> Foo<'a>` == `for
762 // not for type parameters.
763 pub fn same_tys<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
764 let a = cx.tcx.erase_late_bound_regions(&Binder::bind(a));
765 let b = cx.tcx.erase_late_bound_regions(&Binder::bind(b));
768 .enter(|infcx| infcx.can_eq(cx.param_env, a, b).is_ok())
771 /// Return whether the given type is an `unsafe` function.
772 pub fn type_is_unsafe_function<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
774 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
779 pub fn is_copy<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
780 ty.is_copy_modulo_regions(cx.tcx.global_tcx(), cx.param_env, DUMMY_SP)
783 /// Return whether a pattern is refutable.
784 pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat) -> bool {
785 fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> bool {
787 cx.tables.qpath_def(qpath, id),
788 def::Def::Variant(..) | def::Def::VariantCtor(..)
792 fn are_refutable<'a, I: Iterator<Item = &'a Pat>>(cx: &LateContext<'_, '_>, mut i: I) -> bool {
793 i.any(|pat| is_refutable(cx, pat))
797 PatKind::Binding(..) | PatKind::Wild => false,
798 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
799 PatKind::Lit(..) | PatKind::Range(..) => true,
800 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
801 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
802 PatKind::Struct(ref qpath, ref fields, _) => {
803 if is_enum_variant(cx, qpath, pat.hir_id) {
806 are_refutable(cx, fields.iter().map(|field| &*field.node.pat))
809 PatKind::TupleStruct(ref qpath, ref pats, _) => {
810 if is_enum_variant(cx, qpath, pat.hir_id) {
813 are_refutable(cx, pats.iter().map(|pat| &**pat))
816 PatKind::Slice(ref head, ref middle, ref tail) => {
817 are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
822 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
823 /// implementations have.
824 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
825 attr::contains_name(attrs, "automatically_derived")
828 /// Remove blocks around an expression.
830 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
832 pub fn remove_blocks(expr: &Expr) -> &Expr {
833 if let ExprKind::Block(ref block, _) = expr.node {
834 if block.stmts.is_empty() {
835 if let Some(ref expr) = block.expr {
848 pub fn opt_def_id(def: Def) -> Option<DefId> {
852 pub fn is_self(slf: &Arg) -> bool {
853 if let PatKind::Binding(.., name, _) = slf.pat.node {
854 name.name == keywords::SelfLower.name()
860 pub fn is_self_ty(slf: &hir::Ty) -> bool {
862 if let TyKind::Path(ref qp) = slf.node;
863 if let QPath::Resolved(None, ref path) = *qp;
864 if let Def::SelfTy(..) = path.def;
872 pub fn iter_input_pats<'tcx>(decl: &FnDecl, body: &'tcx Body) -> impl Iterator<Item = &'tcx Arg> {
873 (0..decl.inputs.len()).map(move |i| &body.arguments[i])
876 /// Check if a given expression is a match expression
877 /// expanded from `?` operator or `try` macro.
878 pub fn is_try<'a>(cx: &'_ LateContext<'_, '_>, expr: &'a Expr) -> Option<&'a Expr> {
879 fn is_ok(cx: &'_ LateContext<'_, '_>, arm: &Arm) -> bool {
881 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pats[0].node;
882 if match_qpath(path, &paths::RESULT_OK[1..]);
883 if let PatKind::Binding(_, hir_id, _, None) = pat[0].node;
884 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.node;
885 if let Def::Local(lid) = path.def;
886 if cx.tcx.hir().node_to_hir_id(lid) == hir_id;
894 fn is_err(arm: &Arm) -> bool {
895 if let PatKind::TupleStruct(ref path, _, _) = arm.pats[0].node {
896 match_qpath(path, &paths::RESULT_ERR[1..])
902 if let ExprKind::Match(_, ref arms, ref source) = expr.node {
903 // desugared from a `?` operator
904 if let MatchSource::TryDesugar = *source {
910 if arms[0].pats.len() == 1 && arms[0].guard.is_none();
911 if arms[1].pats.len() == 1 && arms[1].guard.is_none();
912 if (is_ok(cx, &arms[0]) && is_err(&arms[1])) ||
913 (is_ok(cx, &arms[1]) && is_err(&arms[0]));
923 /// Returns true if the lint is allowed in the current context
925 /// Useful for skipping long running code when it's unnecessary
926 pub fn is_allowed(cx: &LateContext<'_, '_>, lint: &'static Lint, id: HirId) -> bool {
927 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
930 pub fn get_arg_name(pat: &Pat) -> Option<ast::Name> {
932 PatKind::Binding(.., ident, None) => Some(ident.name),
933 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
938 pub fn int_bits(tcx: TyCtxt<'_, '_, '_>, ity: ast::IntTy) -> u64 {
939 layout::Integer::from_attr(&tcx, attr::IntType::SignedInt(ity))
944 #[allow(clippy::cast_possible_wrap)]
945 /// Turn a constant int byte representation into an i128
946 pub fn sext(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::IntTy) -> i128 {
947 let amt = 128 - int_bits(tcx, ity);
948 ((u as i128) << amt) >> amt
951 #[allow(clippy::cast_sign_loss)]
952 /// clip unused bytes
953 pub fn unsext(tcx: TyCtxt<'_, '_, '_>, u: i128, ity: ast::IntTy) -> u128 {
954 let amt = 128 - int_bits(tcx, ity);
955 ((u as u128) << amt) >> amt
958 /// clip unused bytes
959 pub fn clip(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::UintTy) -> u128 {
960 let bits = layout::Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity))
963 let amt = 128 - bits;
967 /// Remove block comments from the given Vec of lines
972 /// without_block_comments(vec!["/*", "foo", "*/"]);
975 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
976 /// // => vec!["bar"]
978 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
979 let mut without = vec![];
981 let mut nest_level = 0;
984 if line.contains("/*") {
987 } else if line.contains("*/") {
1000 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_, '_, '_>, node: HirId) -> bool {
1001 let map = &tcx.hir();
1002 let mut prev_enclosing_node = None;
1003 let mut enclosing_node = node;
1004 while Some(enclosing_node) != prev_enclosing_node {
1005 if is_automatically_derived(map.attrs_by_hir_id(enclosing_node)) {
1008 prev_enclosing_node = Some(enclosing_node);
1009 enclosing_node = map.get_parent_item(enclosing_node);
1014 /// Returns true if ty has `iter` or `iter_mut` methods
1015 pub fn has_iter_method(cx: &LateContext<'_, '_>, probably_ref_ty: ty::Ty<'_>) -> Option<&'static str> {
1016 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
1017 // exists and has the desired signature. Unfortunately FnCtxt is not exported
1018 // so we can't use its `lookup_method` method.
1019 static INTO_ITER_COLLECTIONS: [&[&str]; 13] = [
1026 &paths::LINKED_LIST,
1027 &paths::BINARY_HEAP,
1035 let ty_to_check = match probably_ref_ty.sty {
1036 ty::Ref(_, ty_to_check, _) => ty_to_check,
1037 _ => probably_ref_ty,
1040 let def_id = match ty_to_check.sty {
1041 ty::Array(..) => return Some("array"),
1042 ty::Slice(..) => return Some("slice"),
1043 ty::Adt(adt, _) => adt.did,
1047 for path in &INTO_ITER_COLLECTIONS {
1048 if match_def_path(cx.tcx, def_id, path) {
1049 return Some(path.last().unwrap());
1057 use super::{trim_multiline, without_block_comments};
1060 fn test_trim_multiline_single_line() {
1061 assert_eq!("", trim_multiline("".into(), false));
1062 assert_eq!("...", trim_multiline("...".into(), false));
1063 assert_eq!("...", trim_multiline(" ...".into(), false));
1064 assert_eq!("...", trim_multiline("\t...".into(), false));
1065 assert_eq!("...", trim_multiline("\t\t...".into(), false));
1070 fn test_trim_multiline_block() {
1076 }", trim_multiline(" if x {
1086 }", trim_multiline(" if x {
1095 fn test_trim_multiline_empty_line() {
1102 }", trim_multiline(" if x {
1111 fn test_without_block_comments_lines_without_block_comments() {
1112 let result = without_block_comments(vec!["/*", "", "*/"]);
1113 println!("result: {:?}", result);
1114 assert!(result.is_empty());
1116 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1117 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1119 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1120 assert!(result.is_empty());
1122 let result = without_block_comments(vec!["/* one-line comment */"]);
1123 assert!(result.is_empty());
1125 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1126 assert!(result.is_empty());
1128 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1129 assert!(result.is_empty());
1131 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1132 assert_eq!(result, vec!["foo", "bar", "baz"]);