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};
7 use rustc::hir::intravisit::{NestedVisitorMap, Visitor};
10 use rustc::lint::{LateContext, Level, Lint, LintContext};
11 use rustc::session::Session;
15 layout::{self, IntegerExt},
19 use rustc_data_structures::sync::Lrc;
20 use rustc_errors::{Applicability, CodeSuggestion, Substitution, SubstitutionPart};
24 use std::str::FromStr;
25 use syntax::ast::{self, LitKind};
27 use syntax::errors::DiagnosticBuilder;
28 use syntax::source_map::{Span, DUMMY_SP};
30 use syntax::symbol::{keywords, Symbol};
40 pub mod internal_lints;
45 pub use self::hir_utils::{SpanlessEq, SpanlessHash};
49 /// Returns true if the two spans come from differing expansions (i.e. one is
50 /// from a macro and one
52 pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
53 rhs.ctxt() != lhs.ctxt()
56 /// Returns `true` if the given `NodeId` is inside a constant context
61 /// if in_constant(cx, expr.id) {
65 pub fn in_constant(cx: &LateContext<'_, '_>, id: NodeId) -> bool {
66 let parent_id = cx.tcx.hir().get_parent(id);
67 match cx.tcx.hir().get(parent_id) {
69 node: ItemKind::Const(..),
72 | Node::TraitItem(&TraitItem {
73 node: TraitItemKind::Const(..),
76 | Node::ImplItem(&ImplItem {
77 node: ImplItemKind::Const(..),
82 node: ItemKind::Static(..),
86 node: ItemKind::Fn(_, header, ..),
88 }) => header.constness == Constness::Const,
93 /// Returns true if this `expn_info` was expanded by any macro.
94 pub fn in_macro(span: Span) -> bool {
95 span.ctxt().outer().expn_info().is_some()
98 /// Used to store the absolute path to a type.
100 /// See `match_def_path` for usage.
102 pub struct AbsolutePathBuffer {
103 pub names: Vec<symbol::LocalInternedString>,
106 impl ty::item_path::ItemPathBuffer for AbsolutePathBuffer {
107 fn root_mode(&self) -> &ty::item_path::RootMode {
108 const ABSOLUTE: &ty::item_path::RootMode = &ty::item_path::RootMode::Absolute;
112 fn push(&mut self, text: &str) {
113 self.names.push(symbol::Symbol::intern(text).as_str());
117 /// Check if a `DefId`'s path matches the given absolute type path usage.
121 /// match_def_path(cx.tcx, id, &["core", "option", "Option"])
124 /// See also the `paths` module.
125 pub fn match_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId, path: &[&str]) -> bool {
126 let mut apb = AbsolutePathBuffer { names: vec![] };
128 tcx.push_item_path(&mut apb, def_id, false);
130 apb.names.len() == path.len() && apb.names.into_iter().zip(path.iter()).all(|(a, &b)| *a == *b)
133 /// Check if type is struct, enum or union type with given def path.
134 pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
136 ty::Adt(adt, _) => match_def_path(cx.tcx, adt.did, path),
141 /// Check if the method call given in `expr` belongs to given trait.
142 pub fn match_trait_method(cx: &LateContext<'_, '_>, expr: &Expr, path: &[&str]) -> bool {
143 let method_call = cx.tables.type_dependent_defs()[expr.hir_id];
144 let trt_id = cx.tcx.trait_of_item(method_call.def_id());
145 if let Some(trt_id) = trt_id {
146 match_def_path(cx.tcx, trt_id, path)
152 /// Check if an expression references a variable of the given name.
153 pub fn match_var(expr: &Expr, var: Name) -> bool {
154 if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.node {
155 if path.segments.len() == 1 && path.segments[0].ident.name == var {
162 pub fn last_path_segment(path: &QPath) -> &PathSegment {
164 QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
165 QPath::TypeRelative(_, ref seg) => seg,
169 pub fn single_segment_path(path: &QPath) -> Option<&PathSegment> {
171 QPath::Resolved(_, ref path) if path.segments.len() == 1 => Some(&path.segments[0]),
172 QPath::Resolved(..) => None,
173 QPath::TypeRelative(_, ref seg) => Some(seg),
177 /// Match a `Path` against a slice of segment string literals.
181 /// match_qpath(path, &["std", "rt", "begin_unwind"])
183 pub fn match_qpath(path: &QPath, segments: &[&str]) -> bool {
185 QPath::Resolved(_, ref path) => match_path(path, segments),
186 QPath::TypeRelative(ref ty, ref segment) => match ty.node {
187 TyKind::Path(ref inner_path) => {
189 && match_qpath(inner_path, &segments[..(segments.len() - 1)])
190 && segment.ident.name == segments[segments.len() - 1]
197 pub fn match_path(path: &Path, segments: &[&str]) -> bool {
201 .zip(segments.iter().rev())
202 .all(|(a, b)| a.ident.name == *b)
205 /// Match a `Path` against a slice of segment string literals, e.g.
209 /// match_qpath(path, &["std", "rt", "begin_unwind"])
211 pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
215 .zip(segments.iter().rev())
216 .all(|(a, b)| a.ident.name == *b)
219 /// Get the definition associated to a path.
220 pub fn path_to_def(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<def::Def> {
221 let crates = cx.tcx.crates();
222 let krate = crates.iter().find(|&&krate| cx.tcx.crate_name(krate) == path[0]);
223 if let Some(krate) = krate {
226 index: CRATE_DEF_INDEX,
228 let mut items = cx.tcx.item_children(krate);
229 let mut path_it = path.iter().skip(1).peekable();
232 let segment = match path_it.next() {
233 Some(segment) => segment,
237 for item in mem::replace(&mut items, Lrc::new(vec![])).iter() {
238 if item.ident.name == *segment {
239 if path_it.peek().is_none() {
240 return Some(item.def);
243 items = cx.tcx.item_children(item.def.def_id());
253 /// Convenience function to get the `DefId` of a trait by path.
254 pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
255 let def = match path_to_def(cx, path) {
261 def::Def::Trait(trait_id) => Some(trait_id),
266 /// Check whether a type implements a trait.
267 /// See also `get_trait_def_id`.
268 pub fn implements_trait<'a, 'tcx>(
269 cx: &LateContext<'a, 'tcx>,
272 ty_params: &[Kind<'tcx>],
274 let ty = cx.tcx.erase_regions(&ty);
275 let obligation = cx.tcx.predicate_for_trait_def(
277 traits::ObligationCause::dummy(),
285 .enter(|infcx| infcx.predicate_must_hold_modulo_regions(&obligation))
288 /// Check whether this type implements Drop.
289 pub fn has_drop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
290 match ty.ty_adt_def() {
291 Some(def) => def.has_dtor(cx.tcx),
296 /// Resolve the definition of a node from its `HirId`.
297 pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> def::Def {
298 cx.tables.qpath_def(qpath, id)
301 /// Return the method names and argument list of nested method call expressions that make up
303 pub fn method_calls<'a>(expr: &'a Expr, max_depth: usize) -> (Vec<Symbol>, Vec<&'a [Expr]>) {
304 let mut method_names = Vec::with_capacity(max_depth);
305 let mut arg_lists = Vec::with_capacity(max_depth);
307 let mut current = expr;
308 for _ in 0..max_depth {
309 if let ExprKind::MethodCall(path, _, args) = ¤t.node {
310 if args.iter().any(|e| in_macro(e.span)) {
313 method_names.push(path.ident.name);
314 arg_lists.push(&**args);
321 (method_names, arg_lists)
324 /// Match an `Expr` against a chain of methods, and return the matched `Expr`s.
326 /// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
327 /// `matched_method_chain(expr, &["bar", "baz"])` will return a `Vec`
328 /// containing the `Expr`s for
329 /// `.bar()` and `.baz()`
330 pub fn method_chain_args<'a>(expr: &'a Expr, methods: &[&str]) -> Option<Vec<&'a [Expr]>> {
331 let mut current = expr;
332 let mut matched = Vec::with_capacity(methods.len());
333 for method_name in methods.iter().rev() {
334 // method chains are stored last -> first
335 if let ExprKind::MethodCall(ref path, _, ref args) = current.node {
336 if path.ident.name == *method_name {
337 if args.iter().any(|e| in_macro(e.span)) {
340 matched.push(&**args); // build up `matched` backwards
341 current = &args[0] // go to parent expression
349 matched.reverse(); // reverse `matched`, so that it is in the same order as `methods`
353 /// Returns true if the function is an entrypoint to a program
355 /// This is either the usual `main` function or a custom function with the `#[start]` attribute.
356 pub fn is_entrypoint_fn(fn_name: &str, attrs: &[ast::Attribute]) -> bool {
358 let is_custom_entrypoint = attrs.iter().any(|attr| {
359 attr.path.segments.len() == 1
360 && attr.path.segments[0].ident.to_string() == "start"
363 is_custom_entrypoint || fn_name == "main"
366 /// Get the name of the item the expression is in, if available.
367 pub fn get_item_name(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<Name> {
368 let parent_id = cx.tcx.hir().get_parent(expr.id);
369 match cx.tcx.hir().find(parent_id) {
370 Some(Node::Item(&Item { ref ident, .. })) => Some(ident.name),
371 Some(Node::TraitItem(&TraitItem { ident, .. })) | Some(Node::ImplItem(&ImplItem { ident, .. })) => {
378 /// Get the name of a `Pat`, if any
379 pub fn get_pat_name(pat: &Pat) -> Option<Name> {
381 PatKind::Binding(_, _, ref spname, _) => Some(spname.name),
382 PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
383 PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
388 struct ContainsName {
393 impl<'tcx> Visitor<'tcx> for ContainsName {
394 fn visit_name(&mut self, _: Span, name: Name) {
395 if self.name == name {
399 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
400 NestedVisitorMap::None
404 /// check if an `Expr` contains a certain name
405 pub fn contains_name(name: Name, expr: &Expr) -> bool {
406 let mut cn = ContainsName { name, result: false };
411 /// Convert a span to a code snippet if available, otherwise use default.
413 /// This is useful if you want to provide suggestions for your lint or more generally, if you want
414 /// to convert a given `Span` to a `str`.
418 /// snippet(cx, expr.span, "..")
420 pub fn snippet<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
421 snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
424 /// Same as `snippet`, but it adapts the applicability level by following rules:
426 /// - Applicability level `Unspecified` will never be changed.
427 /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
428 /// - If the default value is used and the applicability level is `MachineApplicable`, change it to
429 /// `HasPlaceholders`
430 pub fn snippet_with_applicability<'a, 'b, T: LintContext<'b>>(
434 applicability: &mut Applicability,
436 if *applicability != Applicability::Unspecified && in_macro(span) {
437 *applicability = Applicability::MaybeIncorrect;
439 snippet_opt(cx, span).map_or_else(
441 if *applicability == Applicability::MachineApplicable {
442 *applicability = Applicability::HasPlaceholders;
444 Cow::Borrowed(default)
450 /// Same as `snippet`, but should only be used when it's clear that the input span is
451 /// not a macro argument.
452 pub fn snippet_with_macro_callsite<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
453 snippet(cx, span.source_callsite(), default)
456 /// Convert a span to a code snippet. Returns `None` if not available.
457 pub fn snippet_opt<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
458 cx.sess().source_map().span_to_snippet(span).ok()
461 /// Convert a span (from a block) to a code snippet if available, otherwise use
463 /// This trims the code of indentation, except for the first line. Use it for
464 /// blocks or block-like
465 /// things which need to be printed as such.
469 /// snippet_block(cx, expr.span, "..")
471 pub fn snippet_block<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
472 let snip = snippet(cx, span, default);
473 trim_multiline(snip, true)
476 /// Same as `snippet_block`, but adapts the applicability level by the rules of
477 /// `snippet_with_applicabiliy`.
478 pub fn snippet_block_with_applicability<'a, 'b, T: LintContext<'b>>(
482 applicability: &mut Applicability,
484 let snip = snippet_with_applicability(cx, span, default, applicability);
485 trim_multiline(snip, true)
488 /// Returns a new Span that covers the full last line of the given Span
489 pub fn last_line_of_span<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Span {
490 let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
491 let line_no = source_map_and_line.line;
492 let line_start = &source_map_and_line.sf.lines[line_no];
493 Span::new(*line_start, span.hi(), span.ctxt())
496 /// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
497 /// Also takes an `Option<String>` which can be put inside the braces.
498 pub fn expr_block<'a, 'b, T: LintContext<'b>>(
501 option: Option<String>,
504 let code = snippet_block(cx, expr.span, default);
505 let string = option.unwrap_or_default();
506 if in_macro(expr.span) {
507 Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
508 } else if let ExprKind::Block(_, _) = expr.node {
509 Cow::Owned(format!("{}{}", code, string))
510 } else if string.is_empty() {
511 Cow::Owned(format!("{{ {} }}", code))
513 Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
517 /// Trim indentation from a multiline string with possibility of ignoring the
519 pub fn trim_multiline(s: Cow<'_, str>, ignore_first: bool) -> Cow<'_, str> {
520 let s_space = trim_multiline_inner(s, ignore_first, ' ');
521 let s_tab = trim_multiline_inner(s_space, ignore_first, '\t');
522 trim_multiline_inner(s_tab, ignore_first, ' ')
525 fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, ch: char) -> Cow<'_, str> {
528 .skip(ignore_first as usize)
533 // ignore empty lines
534 Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
544 if (ignore_first && i == 0) || l.is_empty() {
558 /// Get a parent expressions if any – this is useful to constrain a lint.
559 pub fn get_parent_expr<'c>(cx: &'c LateContext<'_, '_>, e: &Expr) -> Option<&'c Expr> {
560 let map = &cx.tcx.hir();
561 let node_id: NodeId = e.id;
562 let parent_id: NodeId = map.get_parent_node(node_id);
563 if node_id == parent_id {
566 map.find(parent_id).and_then(|node| {
567 if let Node::Expr(parent) = node {
575 pub fn get_enclosing_block<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, node: NodeId) -> Option<&'tcx Block> {
576 let map = &cx.tcx.hir();
577 let enclosing_node = map
578 .get_enclosing_scope(node)
579 .and_then(|enclosing_id| map.find(enclosing_id));
580 if let Some(node) = enclosing_node {
582 Node::Block(block) => Some(block),
584 node: ItemKind::Fn(_, _, _, eid),
587 | Node::ImplItem(&ImplItem {
588 node: ImplItemKind::Method(_, eid),
590 }) => match cx.tcx.hir().body(eid).value.node {
591 ExprKind::Block(ref block, _) => Some(block),
601 pub struct DiagnosticWrapper<'a>(pub DiagnosticBuilder<'a>);
603 impl<'a> Drop for DiagnosticWrapper<'a> {
609 impl<'a> DiagnosticWrapper<'a> {
610 fn docs_link(&mut self, lint: &'static Lint) {
611 if env::var("CLIPPY_DISABLE_DOCS_LINKS").is_err() {
612 self.0.help(&format!(
613 "for further information visit https://rust-lang.github.io/rust-clippy/{}/index.html#{}",
614 &option_env!("RUST_RELEASE_NUM").map_or("master".to_string(), |n| {
615 // extract just major + minor version and ignore patch versions
616 format!("rust-{}", n.rsplitn(2, '.').nth(1).unwrap())
618 lint.name_lower().replacen("clippy::", "", 1)
624 pub fn span_lint<'a, T: LintContext<'a>>(cx: &T, lint: &'static Lint, sp: Span, msg: &str) {
625 DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg)).docs_link(lint);
628 pub fn span_help_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
635 let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, span, msg));
640 pub fn span_note_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
648 let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, span, msg));
649 if note_span == span {
652 db.0.span_note(note_span, note);
657 pub fn span_lint_and_then<'a, 'tcx: 'a, T: LintContext<'tcx>, F>(
664 F: for<'b> FnOnce(&mut DiagnosticBuilder<'b>),
666 let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg));
671 pub fn span_lint_node(cx: &LateContext<'_, '_>, lint: &'static Lint, node: NodeId, sp: Span, msg: &str) {
672 DiagnosticWrapper(cx.tcx.struct_span_lint_node(lint, node, sp, msg)).docs_link(lint);
675 pub fn span_lint_node_and_then(
676 cx: &LateContext<'_, '_>,
681 f: impl FnOnce(&mut DiagnosticBuilder<'_>),
683 let mut db = DiagnosticWrapper(cx.tcx.struct_span_lint_node(lint, node, sp, msg));
688 /// Add a span lint with a suggestion on how to fix it.
690 /// These suggestions can be parsed by rustfix to allow it to automatically fix your code.
691 /// In the example below, `help` is `"try"` and `sugg` is the suggested replacement `".any(|x| x >
695 /// error: This `.fold` can be more succinctly expressed as `.any`
696 /// --> $DIR/methods.rs:390:13
698 /// 390 | let _ = (0..3).fold(false, |acc, x| acc || x > 2);
699 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `.any(|x| x > 2)`
701 /// = note: `-D fold-any` implied by `-D warnings`
703 pub fn span_lint_and_sugg<'a, 'tcx: 'a, T: LintContext<'tcx>>(
710 applicability: Applicability,
712 span_lint_and_then(cx, lint, sp, msg, |db| {
713 db.span_suggestion(sp, help, sugg, applicability);
717 /// Create a suggestion made from several `span → replacement`.
719 /// Note: in the JSON format (used by `compiletest_rs`), the help message will
721 /// replacement. In human-readable format though, it only appears once before
722 /// the whole suggestion.
723 pub fn multispan_sugg<I>(db: &mut DiagnosticBuilder<'_>, help_msg: String, sugg: I)
725 I: IntoIterator<Item = (Span, String)>,
727 let sugg = CodeSuggestion {
728 substitutions: vec![Substitution {
731 .map(|(span, snippet)| SubstitutionPart { snippet, span })
735 show_code_when_inline: true,
736 applicability: Applicability::Unspecified,
738 db.suggestions.push(sugg);
741 /// Return the base type for HIR references and pointers.
742 pub fn walk_ptrs_hir_ty(ty: &hir::Ty) -> &hir::Ty {
744 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
749 /// Return the base type for references and raw pointers.
750 pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
752 ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
757 /// Return the base type for references and raw pointers, and count reference
759 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
760 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
762 ty::Ref(_, ty, _) => inner(ty, depth + 1),
769 /// Check whether the given expression is a constant literal of the given value.
770 pub fn is_integer_literal(expr: &Expr, value: u128) -> bool {
771 // FIXME: use constant folding
772 if let ExprKind::Lit(ref spanned) = expr.node {
773 if let LitKind::Int(v, _) = spanned.node {
780 /// Returns `true` if the given `Expr` has been coerced before.
782 /// Examples of coercions can be found in the Nomicon at
783 /// <https://doc.rust-lang.org/nomicon/coercions.html>.
785 /// See `rustc::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
786 /// information on adjustments and coercions.
787 pub fn is_adjusted(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
788 cx.tables.adjustments().get(e.hir_id).is_some()
791 pub struct LimitStack {
795 impl Drop for LimitStack {
797 assert_eq!(self.stack.len(), 1);
802 pub fn new(limit: u64) -> Self {
803 Self { stack: vec![limit] }
805 pub fn limit(&self) -> u64 {
806 *self.stack.last().expect("there should always be a value in the stack")
808 pub fn push_attrs(&mut self, sess: &Session, attrs: &[ast::Attribute], name: &'static str) {
809 let stack = &mut self.stack;
810 parse_attrs(sess, attrs, name, |val| stack.push(val));
812 pub fn pop_attrs(&mut self, sess: &Session, attrs: &[ast::Attribute], name: &'static str) {
813 let stack = &mut self.stack;
814 parse_attrs(sess, attrs, name, |val| assert_eq!(stack.pop(), Some(val)));
818 pub fn get_attr<'a>(attrs: &'a [ast::Attribute], name: &'static str) -> impl Iterator<Item = &'a ast::Attribute> {
819 attrs.iter().filter(move |attr| {
820 attr.path.segments.len() == 2
821 && attr.path.segments[0].ident.to_string() == "clippy"
822 && attr.path.segments[1].ident.to_string() == name
826 fn parse_attrs<F: FnMut(u64)>(sess: &Session, attrs: &[ast::Attribute], name: &'static str, mut f: F) {
827 for attr in get_attr(attrs, name) {
828 if let Some(ref value) = attr.value_str() {
829 if let Ok(value) = FromStr::from_str(&value.as_str()) {
832 sess.span_err(attr.span, "not a number");
835 sess.span_err(attr.span, "bad clippy attribute");
840 /// Return the pre-expansion span if is this comes from an expansion of the
842 /// See also `is_direct_expn_of`.
843 pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
845 let span_name_span = span
849 .map(|ei| (ei.format.name(), ei.call_site));
851 match span_name_span {
852 Some((mac_name, new_span)) if mac_name == name => return Some(new_span),
854 Some((_, new_span)) => span = new_span,
859 /// Return the pre-expansion span if is this directly comes from an expansion
860 /// of the macro `name`.
861 /// The difference with `is_expn_of` is that in
865 /// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
867 /// `is_direct_expn_of`.
868 pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
869 let span_name_span = span
873 .map(|ei| (ei.format.name(), ei.call_site));
875 match span_name_span {
876 Some((mac_name, new_span)) if mac_name == name => Some(new_span),
881 /// Convenience function to get the return type of a function
882 pub fn return_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, fn_item: NodeId) -> Ty<'tcx> {
883 let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
884 let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
885 cx.tcx.erase_late_bound_regions(&ret_ty)
888 /// Check if two types are the same.
890 /// This discards any lifetime annotations, too.
891 // FIXME: this works correctly for lifetimes bounds (`for <'a> Foo<'a>` == `for
893 // not for type parameters.
894 pub fn same_tys<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
895 let a = cx.tcx.erase_late_bound_regions(&Binder::bind(a));
896 let b = cx.tcx.erase_late_bound_regions(&Binder::bind(b));
899 .enter(|infcx| infcx.can_eq(cx.param_env, a, b).is_ok())
902 /// Return whether the given type is an `unsafe` function.
903 pub fn type_is_unsafe_function<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
905 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
910 pub fn is_copy<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
911 ty.is_copy_modulo_regions(cx.tcx.global_tcx(), cx.param_env, DUMMY_SP)
914 /// Return whether a pattern is refutable.
915 pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat) -> bool {
916 fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> bool {
918 cx.tables.qpath_def(qpath, id),
919 def::Def::Variant(..) | def::Def::VariantCtor(..)
923 fn are_refutable<'a, I: Iterator<Item = &'a Pat>>(cx: &LateContext<'_, '_>, mut i: I) -> bool {
924 i.any(|pat| is_refutable(cx, pat))
928 PatKind::Binding(..) | PatKind::Wild => false,
929 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
930 PatKind::Lit(..) | PatKind::Range(..) => true,
931 PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
932 PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
933 PatKind::Struct(ref qpath, ref fields, _) => {
934 if is_enum_variant(cx, qpath, pat.hir_id) {
937 are_refutable(cx, fields.iter().map(|field| &*field.node.pat))
940 PatKind::TupleStruct(ref qpath, ref pats, _) => {
941 if is_enum_variant(cx, qpath, pat.hir_id) {
944 are_refutable(cx, pats.iter().map(|pat| &**pat))
947 PatKind::Slice(ref head, ref middle, ref tail) => {
948 are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
953 /// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
954 /// implementations have.
955 pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
956 attr::contains_name(attrs, "automatically_derived")
959 /// Remove blocks around an expression.
961 /// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
963 pub fn remove_blocks(expr: &Expr) -> &Expr {
964 if let ExprKind::Block(ref block, _) = expr.node {
965 if block.stmts.is_empty() {
966 if let Some(ref expr) = block.expr {
979 pub fn opt_def_id(def: Def) -> Option<DefId> {
985 | Def::VariantCtor(id, ..)
988 | Def::AssociatedTy(id)
992 | Def::StructCtor(id, ..)
995 | Def::TraitAlias(id)
998 | Def::AssociatedConst(id)
1000 | Def::Existential(id)
1001 | Def::AssociatedExistential(id)
1002 | Def::SelfCtor(id) => Some(id),
1010 | Def::NonMacroAttr { .. }
1015 pub fn is_self(slf: &Arg) -> bool {
1016 if let PatKind::Binding(_, _, name, _) = slf.pat.node {
1017 name.name == keywords::SelfLower.name()
1023 pub fn is_self_ty(slf: &hir::Ty) -> bool {
1025 if let TyKind::Path(ref qp) = slf.node;
1026 if let QPath::Resolved(None, ref path) = *qp;
1027 if let Def::SelfTy(..) = path.def;
1035 pub fn iter_input_pats<'tcx>(decl: &FnDecl, body: &'tcx Body) -> impl Iterator<Item = &'tcx Arg> {
1036 (0..decl.inputs.len()).map(move |i| &body.arguments[i])
1039 /// Check if a given expression is a match expression
1040 /// expanded from `?` operator or `try` macro.
1041 pub fn is_try(expr: &Expr) -> Option<&Expr> {
1042 fn is_ok(arm: &Arm) -> bool {
1044 if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pats[0].node;
1045 if match_qpath(path, &paths::RESULT_OK[1..]);
1046 if let PatKind::Binding(_, defid, _, None) = pat[0].node;
1047 if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.node;
1048 if let Def::Local(lid) = path.def;
1057 fn is_err(arm: &Arm) -> bool {
1058 if let PatKind::TupleStruct(ref path, _, _) = arm.pats[0].node {
1059 match_qpath(path, &paths::RESULT_ERR[1..])
1065 if let ExprKind::Match(_, ref arms, ref source) = expr.node {
1066 // desugared from a `?` operator
1067 if let MatchSource::TryDesugar = *source {
1073 if arms[0].pats.len() == 1 && arms[0].guard.is_none();
1074 if arms[1].pats.len() == 1 && arms[1].guard.is_none();
1075 if (is_ok(&arms[0]) && is_err(&arms[1])) ||
1076 (is_ok(&arms[1]) && is_err(&arms[0]));
1086 /// Returns true if the lint is allowed in the current context
1088 /// Useful for skipping long running code when it's unnecessary
1089 pub fn is_allowed(cx: &LateContext<'_, '_>, lint: &'static Lint, id: NodeId) -> bool {
1090 cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
1093 pub fn get_arg_name(pat: &Pat) -> Option<ast::Name> {
1095 PatKind::Binding(_, _, ident, None) => Some(ident.name),
1096 PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
1101 pub fn int_bits(tcx: TyCtxt<'_, '_, '_>, ity: ast::IntTy) -> u64 {
1102 layout::Integer::from_attr(&tcx, attr::IntType::SignedInt(ity))
1107 #[allow(clippy::cast_possible_wrap)]
1108 /// Turn a constant int byte representation into an i128
1109 pub fn sext(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::IntTy) -> i128 {
1110 let amt = 128 - int_bits(tcx, ity);
1111 ((u as i128) << amt) >> amt
1114 #[allow(clippy::cast_sign_loss)]
1115 /// clip unused bytes
1116 pub fn unsext(tcx: TyCtxt<'_, '_, '_>, u: i128, ity: ast::IntTy) -> u128 {
1117 let amt = 128 - int_bits(tcx, ity);
1118 ((u as u128) << amt) >> amt
1121 /// clip unused bytes
1122 pub fn clip(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::UintTy) -> u128 {
1123 let bits = layout::Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity))
1126 let amt = 128 - bits;
1130 /// Remove block comments from the given Vec of lines
1135 /// without_block_comments(vec!["/*", "foo", "*/"]);
1138 /// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
1139 /// // => vec!["bar"]
1141 pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
1142 let mut without = vec![];
1144 let mut nest_level = 0;
1147 if line.contains("/*") {
1150 } else if line.contains("*/") {
1155 if nest_level == 0 {
1163 pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_, '_, '_>, node: NodeId) -> bool {
1164 let map = &tcx.hir();
1165 let mut prev_enclosing_node = None;
1166 let mut enclosing_node = node;
1167 while Some(enclosing_node) != prev_enclosing_node {
1168 if is_automatically_derived(map.attrs(enclosing_node)) {
1171 prev_enclosing_node = Some(enclosing_node);
1172 enclosing_node = map.get_parent(enclosing_node);
1179 use super::{trim_multiline, without_block_comments};
1182 fn test_trim_multiline_single_line() {
1183 assert_eq!("", trim_multiline("".into(), false));
1184 assert_eq!("...", trim_multiline("...".into(), false));
1185 assert_eq!("...", trim_multiline(" ...".into(), false));
1186 assert_eq!("...", trim_multiline("\t...".into(), false));
1187 assert_eq!("...", trim_multiline("\t\t...".into(), false));
1192 fn test_trim_multiline_block() {
1198 }", trim_multiline(" if x {
1208 }", trim_multiline(" if x {
1217 fn test_trim_multiline_empty_line() {
1224 }", trim_multiline(" if x {
1233 fn test_without_block_comments_lines_without_block_comments() {
1234 let result = without_block_comments(vec!["/*", "", "*/"]);
1235 println!("result: {:?}", result);
1236 assert!(result.is_empty());
1238 let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
1239 assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
1241 let result = without_block_comments(vec!["/* rust", "", "*/"]);
1242 assert!(result.is_empty());
1244 let result = without_block_comments(vec!["/* one-line comment */"]);
1245 assert!(result.is_empty());
1247 let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
1248 assert!(result.is_empty());
1250 let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
1251 assert!(result.is_empty());
1253 let result = without_block_comments(vec!["foo", "bar", "baz"]);
1254 assert_eq!(result, vec!["foo", "bar", "baz"]);