rust-clippy/clippy_lints/src/utils/mod.rs

1754 lines
57 KiB
Rust
Raw Normal View History

2019-05-17 21:53:54 +00:00
#[macro_use]
pub mod sym;
#[allow(clippy::module_name_repetitions)]
pub mod ast_utils;
2019-01-31 01:15:29 +00:00
pub mod attrs;
pub mod author;
pub mod camel_case;
pub mod comparisons;
pub mod conf;
pub mod constants;
mod diagnostics;
pub mod eager_or_lazy;
2019-01-31 01:15:29 +00:00
pub mod higher;
mod hir_utils;
pub mod inspector;
pub mod internal_lints;
2020-03-03 16:58:37 +00:00
pub mod numeric_literal;
2019-01-31 01:15:29 +00:00
pub mod paths;
pub mod ptr;
pub mod qualify_min_const_fn;
2019-01-31 01:15:29 +00:00
pub mod sugg;
pub mod usage;
pub mod visitors;
2019-01-31 01:15:29 +00:00
pub use self::attrs::*;
pub use self::diagnostics::*;
pub use self::hir_utils::{both, eq_expr_value, over, SpanlessEq, SpanlessHash};
2019-01-31 01:15:29 +00:00
use std::borrow::Cow;
use std::collections::hash_map::Entry;
use std::hash::BuildHasherDefault;
2019-01-31 01:15:29 +00:00
use std::mem;
use if_chain::if_chain;
2020-03-01 03:23:33 +00:00
use rustc_ast::ast::{self, Attribute, LitKind};
2020-02-01 21:56:27 +00:00
use rustc_attr as attr;
use rustc_data_structures::fx::FxHashMap;
use rustc_errors::Applicability;
2020-01-06 16:39:50 +00:00
use rustc_hir as hir;
use rustc_hir::def::{DefKind, Res};
use rustc_hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
2020-01-09 07:13:22 +00:00
use rustc_hir::intravisit::{NestedVisitorMap, Visitor};
2020-01-06 16:39:50 +00:00
use rustc_hir::Node;
2020-02-21 08:39:38 +00:00
use rustc_hir::{
def, Arm, Block, Body, Constness, Crate, Expr, ExprKind, FnDecl, HirId, ImplItem, ImplItemKind, Item, ItemKind,
MatchSource, Param, Pat, PatKind, Path, PathSegment, QPath, TraitItem, TraitItemKind, TraitRef, TyKind, Unsafety,
};
2020-02-17 02:07:26 +00:00
use rustc_infer::infer::TyCtxtInferExt;
2020-01-12 06:08:41 +00:00
use rustc_lint::{LateContext, Level, Lint, LintContext};
use rustc_middle::hir::map::Map;
use rustc_middle::ty::subst::{GenericArg, GenericArgKind};
use rustc_middle::ty::{self, layout::IntegerExt, Ty, TyCtxt, TypeFoldable};
use rustc_session::Session;
use rustc_span::hygiene::{ExpnKind, MacroKind};
use rustc_span::source_map::original_sp;
use rustc_span::sym as rustc_sym;
2020-01-24 10:50:03 +00:00
use rustc_span::symbol::{self, kw, Symbol};
2020-01-08 16:31:06 +00:00
use rustc_span::{BytePos, Pos, Span, DUMMY_SP};
2020-04-02 20:29:41 +00:00
use rustc_target::abi::Integer;
2020-03-14 20:26:32 +00:00
use rustc_trait_selection::traits::query::normalize::AtExt;
use semver::{Version, VersionReq};
use smallvec::SmallVec;
use crate::consts::{constant, Constant};
pub fn parse_msrv(msrv: &str, sess: Option<&Session>, span: Option<Span>) -> Option<VersionReq> {
if let Ok(version) = VersionReq::parse(msrv) {
return Some(version);
} else if let Some(sess) = sess {
if let Some(span) = span {
sess.span_err(span, &format!("`{}` is not a valid Rust version", msrv));
}
}
None
}
pub fn meets_msrv(msrv: Option<&VersionReq>, lint_msrv: &Version) -> bool {
msrv.map_or(true, |msrv| !msrv.matches(lint_msrv))
}
macro_rules! extract_msrv_attr {
(LateContext) => {
2020-11-25 10:50:13 +00:00
extract_msrv_attr!(@LateContext, ());
};
(EarlyContext) => {
2020-11-25 10:50:13 +00:00
extract_msrv_attr!(@EarlyContext);
};
(@$context:ident$(, $call:tt)?) => {
fn enter_lint_attrs(&mut self, cx: &rustc_lint::$context<'tcx>, attrs: &'tcx [rustc_ast::ast::Attribute]) {
use $crate::utils::get_unique_inner_attr;
match get_unique_inner_attr(cx.sess$($call)?, attrs, "msrv") {
Some(msrv_attr) => {
if let Some(msrv) = msrv_attr.value_str() {
2020-11-25 10:50:13 +00:00
self.msrv = $crate::utils::parse_msrv(
&msrv.to_string(),
Some(cx.sess$($call)?),
Some(msrv_attr.span),
);
} else {
2020-11-25 10:50:13 +00:00
cx.sess$($call)?.span_err(msrv_attr.span, "bad clippy attribute");
}
},
_ => (),
}
}
};
}
2019-01-31 01:15:29 +00:00
/// Returns `true` if the two spans come from differing expansions (i.e., one is
/// from a macro and one isn't).
#[must_use]
pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
rhs.ctxt() != lhs.ctxt()
}
/// Returns `true` if the given `NodeId` is inside a constant context
///
/// # Example
///
/// ```rust,ignore
2019-10-02 15:38:00 +00:00
/// if in_constant(cx, expr.hir_id) {
/// // Do something
/// }
/// ```
pub fn in_constant(cx: &LateContext<'_>, id: HirId) -> bool {
2019-02-24 18:43:15 +00:00
let parent_id = cx.tcx.hir().get_parent_item(id);
2019-06-22 06:41:16 +00:00
match cx.tcx.hir().get(parent_id) {
2019-01-22 15:27:42 +00:00
Node::Item(&Item {
kind: ItemKind::Const(..) | ItemKind::Static(..),
2019-01-22 15:27:42 +00:00
..
})
| Node::TraitItem(&TraitItem {
2019-09-27 15:16:06 +00:00
kind: TraitItemKind::Const(..),
2019-01-22 15:27:42 +00:00
..
})
| Node::ImplItem(&ImplItem {
2019-09-27 15:16:06 +00:00
kind: ImplItemKind::Const(..),
2019-01-22 15:27:42 +00:00
..
})
| Node::AnonConst(_) => true,
Node::Item(&Item {
2019-11-08 20:12:08 +00:00
kind: ItemKind::Fn(ref sig, ..),
..
2019-11-08 20:41:54 +00:00
})
| Node::ImplItem(&ImplItem {
kind: ImplItemKind::Fn(ref sig, _),
..
}) => sig.header.constness == Constness::Const,
_ => false,
}
}
/// Returns `true` if this `span` was expanded by any macro.
#[must_use]
2019-05-12 03:41:30 +00:00
pub fn in_macro(span: Span) -> bool {
if span.from_expansion() {
!matches!(span.ctxt().outer_expn_data().kind, ExpnKind::Desugaring(..))
2019-05-11 06:19:35 +00:00
} else {
false
}
}
// If the snippet is empty, it's an attribute that was inserted during macro
// expansion and we want to ignore those, because they could come from external
// sources that the user has no control over.
// For some reason these attributes don't have any expansion info on them, so
// we have to check it this way until there is a better way.
2019-06-12 03:07:48 +00:00
pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
if let Some(snippet) = snippet_opt(cx, span) {
if snippet.is_empty() {
return false;
}
}
true
}
2020-01-10 16:14:17 +00:00
/// Checks if given pattern is a wildcard (`_`)
pub fn is_wild<'tcx>(pat: &impl std::ops::Deref<Target = Pat<'tcx>>) -> bool {
matches!(pat.kind, PatKind::Wild)
2020-01-10 16:14:17 +00:00
}
2019-03-10 17:19:47 +00:00
/// Checks if type is struct, enum or union type with the given def path.
///
/// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
/// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
match ty.kind() {
2019-05-13 23:34:08 +00:00
ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
2016-01-04 04:26:12 +00:00
_ => false,
}
}
2019-09-07 10:21:52 +00:00
/// Checks if the type is equal to a diagnostic item
///
/// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
match ty.kind() {
2019-09-07 10:21:52 +00:00
ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
_ => false,
}
}
/// Checks if the type is equal to a lang item
pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
match ty.kind() {
ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).unwrap() == adt.did,
_ => false,
}
}
2019-03-10 17:19:47 +00:00
/// Checks if the method call given in `expr` belongs to the given trait.
pub fn match_trait_method(cx: &LateContext<'_>, expr: &Expr<'_>, path: &[&str]) -> bool {
2020-07-17 08:47:04 +00:00
let def_id = cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
let trt_id = cx.tcx.trait_of_item(def_id);
trt_id.map_or(false, |trt_id| match_def_path(cx, trt_id, path))
}
2019-01-31 01:15:29 +00:00
/// Checks if an expression references a variable of the given name.
pub fn match_var(expr: &Expr<'_>, var: Symbol) -> bool {
2019-09-27 15:16:06 +00:00
if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.kind {
if let [p] = path.segments {
return p.ident.name == var;
}
}
false
}
2019-12-30 04:02:10 +00:00
pub fn last_path_segment<'tcx>(path: &QPath<'tcx>) -> &'tcx PathSegment<'tcx> {
2016-12-02 16:38:31 +00:00
match *path {
QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
2016-12-02 21:33:16 +00:00
QPath::TypeRelative(_, ref seg) => seg,
QPath::LangItem(..) => panic!("last_path_segment: lang item has no path segments"),
2016-12-02 16:38:31 +00:00
}
}
2019-12-30 04:02:10 +00:00
pub fn single_segment_path<'tcx>(path: &QPath<'tcx>) -> Option<&'tcx PathSegment<'tcx>> {
2016-12-02 16:38:31 +00:00
match *path {
QPath::Resolved(_, ref path) => path.segments.get(0),
2016-12-02 21:33:16 +00:00
QPath::TypeRelative(_, ref seg) => Some(seg),
QPath::LangItem(..) => None,
2016-12-02 16:38:31 +00:00
}
}
2019-01-31 01:15:29 +00:00
/// Matches a `QPath` against a slice of segment string literals.
///
2020-01-06 16:39:50 +00:00
/// There is also `match_path` if you are dealing with a `rustc_hir::Path` instead of a
/// `rustc_hir::QPath`.
2016-01-12 22:17:54 +00:00
///
/// # Examples
2016-12-21 09:00:13 +00:00
/// ```rust,ignore
/// match_qpath(path, &["std", "rt", "begin_unwind"])
2016-01-12 22:17:54 +00:00
/// ```
2019-12-30 04:02:10 +00:00
pub fn match_qpath(path: &QPath<'_>, segments: &[&str]) -> bool {
2016-12-02 16:38:31 +00:00
match *path {
QPath::Resolved(_, ref path) => match_path(path, segments),
2019-09-27 15:16:06 +00:00
QPath::TypeRelative(ref ty, ref segment) => match ty.kind {
2018-07-12 08:03:06 +00:00
TyKind::Path(ref inner_path) => {
if let [prefix @ .., end] = segments {
if match_qpath(inner_path, prefix) {
return segment.ident.name.as_str() == *end;
}
}
false
2017-09-05 09:33:04 +00:00
},
_ => false,
2016-12-02 16:38:31 +00:00
},
QPath::LangItem(..) => false,
}
}
2019-01-31 01:15:29 +00:00
/// Matches a `Path` against a slice of segment string literals.
///
2020-01-06 16:39:50 +00:00
/// There is also `match_qpath` if you are dealing with a `rustc_hir::QPath` instead of a
/// `rustc_hir::Path`.
///
/// # Examples
///
/// ```rust,ignore
2019-05-17 21:53:54 +00:00
/// if match_path(&trait_ref.path, &paths::HASH) {
/// // This is the `std::hash::Hash` trait.
/// }
///
/// if match_path(ty_path, &["rustc", "lint", "Lint"]) {
/// // This is a `rustc_middle::lint::Lint`.
/// }
/// ```
2019-12-30 04:02:10 +00:00
pub fn match_path(path: &Path<'_>, segments: &[&str]) -> bool {
2017-09-05 09:33:04 +00:00
path.segments
.iter()
.rev()
.zip(segments.iter().rev())
2019-05-17 21:53:54 +00:00
.all(|(a, b)| a.ident.name.as_str() == *b)
}
2019-01-31 01:15:29 +00:00
/// Matches a `Path` against a slice of segment string literals, e.g.
2016-01-12 22:17:54 +00:00
///
/// # Examples
2016-12-21 09:00:13 +00:00
/// ```rust,ignore
/// match_path_ast(path, &["std", "rt", "begin_unwind"])
2016-01-12 22:17:54 +00:00
/// ```
2019-05-17 21:53:54 +00:00
pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
2017-09-05 09:33:04 +00:00
path.segments
.iter()
.rev()
.zip(segments.iter().rev())
2019-05-17 21:53:54 +00:00
.all(|(a, b)| a.ident.name.as_str() == *b)
}
2019-01-31 01:15:29 +00:00
/// Gets the definition associated to a path.
pub fn path_to_res(cx: &LateContext<'_>, path: &[&str]) -> Option<def::Res> {
let crates = cx.tcx.crates();
2019-05-17 22:58:25 +00:00
let krate = crates
.iter()
.find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
if let Some(krate) = krate {
2016-12-20 17:21:30 +00:00
let krate = DefId {
krate: *krate,
index: CRATE_DEF_INDEX,
};
let mut current_item = None;
let mut items = cx.tcx.item_children(krate);
let mut path_it = path.iter().skip(1).peekable();
loop {
let segment = match path_it.next() {
Some(segment) => segment,
2016-01-30 12:48:39 +00:00
None => return None,
};
// `get_def_path` seems to generate these empty segments for extern blocks.
// We can just ignore them.
if segment.is_empty() {
continue;
}
let result = SmallVec::<[_; 8]>::new();
for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
2019-05-17 21:53:54 +00:00
if item.ident.name.as_str() == *segment {
if path_it.peek().is_none() {
return Some(item.res);
}
current_item = Some(item);
items = cx.tcx.item_children(item.res.def_id());
break;
}
}
// The segment isn't a child_item.
// Try to find it under an inherent impl.
if_chain! {
if path_it.peek().is_none();
if let Some(current_item) = current_item;
let item_def_id = current_item.res.def_id();
if cx.tcx.def_kind(item_def_id) == DefKind::Struct;
then {
// Bad `find_map` suggestion. See #4193.
#[allow(clippy::find_map)]
return cx.tcx.inherent_impls(item_def_id).iter()
.flat_map(|&impl_def_id| cx.tcx.item_children(impl_def_id))
.find(|item| item.ident.name.as_str() == *segment)
.map(|item| item.res);
}
}
}
2016-01-30 12:48:39 +00:00
} else {
None
}
}
pub fn qpath_res(cx: &LateContext<'_>, qpath: &hir::QPath<'_>, id: hir::HirId) -> Res {
2019-09-18 17:29:04 +00:00
match qpath {
hir::QPath::Resolved(_, path) => path.res,
hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
2020-07-17 08:47:04 +00:00
if cx.tcx.has_typeck_results(id.owner.to_def_id()) {
cx.tcx.typeck(id.owner).qpath_res(qpath, id)
2019-09-18 17:29:04 +00:00
} else {
Res::Err
}
},
}
}
/// Convenience function to get the `DefId` of a trait by path.
/// It could be a trait or trait alias.
pub fn get_trait_def_id(cx: &LateContext<'_>, path: &[&str]) -> Option<DefId> {
let res = match path_to_res(cx, path) {
Some(res) => res,
None => return None,
};
match res {
2020-03-16 06:23:03 +00:00
Res::Def(DefKind::Trait | DefKind::TraitAlias, trait_id) => Some(trait_id),
Res::Err => unreachable!("this trait resolution is impossible: {:?}", &path),
_ => None,
}
}
2019-01-31 01:15:29 +00:00
/// Checks whether a type implements a trait.
/// See also `get_trait_def_id`.
pub fn implements_trait<'tcx>(
cx: &LateContext<'tcx>,
ty: Ty<'tcx>,
trait_id: DefId,
ty_params: &[GenericArg<'tcx>],
) -> bool {
2020-05-30 09:48:54 +00:00
// Do not check on infer_types to avoid panic in evaluate_obligation.
if ty.has_infer_types() {
return false;
}
2020-10-24 00:21:27 +00:00
let ty = cx.tcx.erase_regions(ty);
if ty.has_escaping_bound_vars() {
return false;
}
2020-05-14 15:07:46 +00:00
let ty_params = cx.tcx.mk_substs(ty_params.iter());
cx.tcx.type_implements_trait((trait_id, ty, ty_params, cx.param_env))
}
2019-01-31 01:15:29 +00:00
/// Gets the `hir::TraitRef` of the trait the given method is implemented for.
///
/// Use this if you want to find the `TraitRef` of the `Add` trait in this example:
///
/// ```rust
2019-03-08 08:10:41 +00:00
/// struct Point(isize, isize);
///
2019-03-08 08:10:41 +00:00
/// impl std::ops::Add for Point {
/// type Output = Self;
///
/// fn add(self, other: Self) -> Self {
/// Point(0, 0)
/// }
/// }
/// ```
pub fn trait_ref_of_method<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx TraitRef<'tcx>> {
// Get the implemented trait for the current function
let parent_impl = cx.tcx.hir().get_parent_item(hir_id);
if_chain! {
if parent_impl != hir::CRATE_HIR_ID;
2019-06-22 06:41:16 +00:00
if let hir::Node::Item(item) = cx.tcx.hir().get(parent_impl);
2020-01-18 05:14:36 +00:00
if let hir::ItemKind::Impl{ of_trait: trait_ref, .. } = &item.kind;
then { return trait_ref.as_ref(); }
}
None
}
2019-01-31 01:15:29 +00:00
/// Checks whether this type implements `Drop`.
pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
2018-12-09 11:19:21 +00:00
match ty.ty_adt_def() {
2017-09-19 20:38:35 +00:00
Some(def) => def.has_dtor(cx.tcx),
None => false,
2017-09-19 20:38:35 +00:00
}
}
2019-01-31 01:15:29 +00:00
/// Returns the method names and argument list of nested method call expressions that make up
2019-08-29 08:06:56 +00:00
/// `expr`. method/span lists are sorted with the most recent call first.
2019-12-27 07:12:26 +00:00
pub fn method_calls<'tcx>(
expr: &'tcx Expr<'tcx>,
max_depth: usize,
) -> (Vec<Symbol>, Vec<&'tcx [Expr<'tcx>]>, Vec<Span>) {
let mut method_names = Vec::with_capacity(max_depth);
let mut arg_lists = Vec::with_capacity(max_depth);
let mut spans = Vec::with_capacity(max_depth);
let mut current = expr;
for _ in 0..max_depth {
2020-06-09 21:44:04 +00:00
if let ExprKind::MethodCall(path, span, args, _) = &current.kind {
2019-08-19 16:30:32 +00:00
if args.iter().any(|e| e.span.from_expansion()) {
break;
}
method_names.push(path.ident.name);
arg_lists.push(&**args);
spans.push(*span);
current = &args[0];
} else {
break;
}
}
(method_names, arg_lists, spans)
}
2019-01-31 01:15:29 +00:00
/// Matches an `Expr` against a chain of methods, and return the matched `Expr`s.
2016-01-12 22:17:54 +00:00
///
/// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
/// `method_chain_args(expr, &["bar", "baz"])` will return a `Vec`
2017-08-09 07:30:56 +00:00
/// containing the `Expr`s for
2016-01-12 22:17:54 +00:00
/// `.bar()` and `.baz()`
2019-12-27 07:12:26 +00:00
pub fn method_chain_args<'a>(expr: &'a Expr<'_>, methods: &[&str]) -> Option<Vec<&'a [Expr<'a>]>> {
let mut current = expr;
let mut matched = Vec::with_capacity(methods.len());
2016-01-04 04:26:12 +00:00
for method_name in methods.iter().rev() {
// method chains are stored last -> first
2020-06-09 21:44:04 +00:00
if let ExprKind::MethodCall(ref path, _, ref args, _) = current.kind {
2019-05-17 21:53:54 +00:00
if path.ident.name.as_str() == *method_name {
2019-08-19 16:30:32 +00:00
if args.iter().any(|e| e.span.from_expansion()) {
2017-04-06 14:48:48 +00:00
return None;
}
matched.push(&**args); // build up `matched` backwards
current = &args[0] // go to parent expression
2016-01-04 04:26:12 +00:00
} else {
return None;
}
2016-01-04 04:26:12 +00:00
} else {
return None;
}
}
2019-01-31 01:15:29 +00:00
// Reverse `matched` so that it is in the same order as `methods`.
matched.reverse();
Some(matched)
}
2019-01-31 01:15:29 +00:00
/// Returns `true` if the provided `def_id` is an entrypoint to a program.
pub fn is_entrypoint_fn(cx: &LateContext<'_>, def_id: DefId) -> bool {
2019-09-04 14:19:59 +00:00
cx.tcx
.entry_fn(LOCAL_CRATE)
.map_or(false, |(entry_fn_def_id, _)| def_id == entry_fn_def_id.to_def_id())
2019-01-09 19:11:37 +00:00
}
/// Returns `true` if the expression is in the program's `#[panic_handler]`.
pub fn is_in_panic_handler(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
let parent = cx.tcx.hir().get_parent_item(e.hir_id);
let def_id = cx.tcx.hir().local_def_id(parent).to_def_id();
Some(def_id) == cx.tcx.lang_items().panic_impl()
}
2019-01-31 01:15:29 +00:00
/// Gets the name of the item the expression is in, if available.
pub fn get_item_name(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<Symbol> {
2019-02-24 18:43:15 +00:00
let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
2019-06-25 21:34:07 +00:00
match cx.tcx.hir().find(parent_id) {
2020-03-16 06:23:03 +00:00
Some(
Node::Item(Item { ident, .. })
| Node::TraitItem(TraitItem { ident, .. })
| Node::ImplItem(ImplItem { ident, .. }),
) => Some(ident.name),
_ => None,
}
}
2019-03-10 17:19:47 +00:00
/// Gets the name of a `Pat`, if any.
pub fn get_pat_name(pat: &Pat<'_>) -> Option<Symbol> {
2019-09-27 15:16:06 +00:00
match pat.kind {
PatKind::Binding(.., ref spname, _) => Some(spname.name),
2018-06-28 13:46:58 +00:00
PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
_ => None,
}
}
struct ContainsName {
name: Symbol,
result: bool,
}
impl<'tcx> Visitor<'tcx> for ContainsName {
2020-01-09 07:13:22 +00:00
type Map = Map<'tcx>;
fn visit_name(&mut self, _: Span, name: Symbol) {
if self.name == name {
self.result = true;
}
}
fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
NestedVisitorMap::None
}
}
2019-01-31 01:15:29 +00:00
/// Checks if an `Expr` contains a certain name.
pub fn contains_name(name: Symbol, expr: &Expr<'_>) -> bool {
let mut cn = ContainsName { name, result: false };
cn.visit_expr(expr);
cn.result
}
2020-11-28 17:18:05 +00:00
/// Returns `true` if `expr` contains a return expression
pub fn contains_return(expr: &hir::Expr<'_>) -> bool {
struct RetCallFinder {
found: bool,
}
impl<'tcx> hir::intravisit::Visitor<'tcx> for RetCallFinder {
type Map = Map<'tcx>;
fn visit_expr(&mut self, expr: &'tcx hir::Expr<'_>) {
if self.found {
return;
}
if let hir::ExprKind::Ret(..) = &expr.kind {
self.found = true;
} else {
hir::intravisit::walk_expr(self, expr);
}
}
fn nested_visit_map(&mut self) -> hir::intravisit::NestedVisitorMap<Self::Map> {
hir::intravisit::NestedVisitorMap::None
}
}
let mut visitor = RetCallFinder { found: false };
visitor.visit_expr(expr);
visitor.found
}
2019-01-31 01:15:29 +00:00
/// Converts a span to a code snippet if available, otherwise use default.
2016-01-12 22:17:54 +00:00
///
/// This is useful if you want to provide suggestions for your lint or more generally, if you want
/// to convert a given `Span` to a `str`.
///
2016-01-12 22:17:54 +00:00
/// # Example
2016-12-21 09:00:13 +00:00
/// ```rust,ignore
2016-01-12 22:17:54 +00:00
/// snippet(cx, expr.span, "..")
/// ```
2019-06-12 03:07:48 +00:00
pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
}
/// Same as `snippet`, but it adapts the applicability level by following rules:
///
/// - Applicability level `Unspecified` will never be changed.
/// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
/// - If the default value is used and the applicability level is `MachineApplicable`, change it to
/// `HasPlaceholders`
2019-06-12 03:07:48 +00:00
pub fn snippet_with_applicability<'a, T: LintContext>(
cx: &T,
span: Span,
default: &'a str,
applicability: &mut Applicability,
) -> Cow<'a, str> {
2019-08-19 16:30:32 +00:00
if *applicability != Applicability::Unspecified && span.from_expansion() {
*applicability = Applicability::MaybeIncorrect;
}
snippet_opt(cx, span).map_or_else(
|| {
if *applicability == Applicability::MachineApplicable {
*applicability = Applicability::HasPlaceholders;
}
Cow::Borrowed(default)
},
From::from,
)
}
/// Same as `snippet`, but should only be used when it's clear that the input span is
/// not a macro argument.
2019-06-12 03:07:48 +00:00
pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
snippet(cx, span.source_callsite(), default)
}
2019-01-31 01:15:29 +00:00
/// Converts a span to a code snippet. Returns `None` if not available.
2019-06-12 03:07:48 +00:00
pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
cx.sess().source_map().span_to_snippet(span).ok()
2015-12-08 06:03:01 +00:00
}
/// Converts a span (from a block) to a code snippet if available, otherwise use default.
///
/// This trims the code of indentation, except for the first line. Use it for blocks or block-like
2016-01-12 22:17:54 +00:00
/// things which need to be printed as such.
///
/// The `indent_relative_to` arg can be used, to provide a span, where the indentation of the
/// resulting snippet of the given span.
///
2016-01-12 22:17:54 +00:00
/// # Example
///
2016-12-21 09:00:13 +00:00
/// ```rust,ignore
/// snippet_block(cx, block.span, "..", None)
/// // where, `block` is the block of the if expr
/// if x {
/// y;
/// }
/// // will return the snippet
/// {
/// y;
/// }
/// ```
///
/// ```rust,ignore
/// snippet_block(cx, block.span, "..", Some(if_expr.span))
/// // where, `block` is the block of the if expr
/// if x {
/// y;
/// }
/// // will return the snippet
/// {
/// y;
/// } // aligned with `if`
2016-01-12 22:17:54 +00:00
/// ```
/// Note that the first line of the snippet always has 0 indentation.
pub fn snippet_block<'a, T: LintContext>(
cx: &T,
span: Span,
default: &'a str,
indent_relative_to: Option<Span>,
) -> Cow<'a, str> {
let snip = snippet(cx, span, default);
let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
reindent_multiline(snip, true, indent)
}
/// Same as `snippet_block`, but adapts the applicability level by the rules of
/// `snippet_with_applicability`.
2019-06-12 03:07:48 +00:00
pub fn snippet_block_with_applicability<'a, T: LintContext>(
cx: &T,
span: Span,
default: &'a str,
indent_relative_to: Option<Span>,
applicability: &mut Applicability,
) -> Cow<'a, str> {
let snip = snippet_with_applicability(cx, span, default, applicability);
let indent = indent_relative_to.and_then(|s| indent_of(cx, s));
reindent_multiline(snip, true, indent)
}
/// Returns a new Span that extends the original Span to the first non-whitespace char of the first
/// line.
///
/// ```rust,ignore
/// let x = ();
/// // ^^
/// // will be converted to
/// let x = ();
/// // ^^^^^^^^^^
/// ```
pub fn first_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
first_char_in_first_line(cx, span).map_or(span, |first_char_pos| span.with_lo(first_char_pos))
}
fn first_char_in_first_line<T: LintContext>(cx: &T, span: Span) -> Option<BytePos> {
let line_span = line_span(cx, span);
snippet_opt(cx, line_span).and_then(|snip| {
snip.find(|c: char| !c.is_whitespace())
.map(|pos| line_span.lo() + BytePos::from_usize(pos))
})
}
/// Returns the indentation of the line of a span
///
/// ```rust,ignore
/// let x = ();
/// // ^^ -- will return 0
/// let x = ();
/// // ^^ -- will return 4
/// ```
pub fn indent_of<T: LintContext>(cx: &T, span: Span) -> Option<usize> {
snippet_opt(cx, line_span(cx, span)).and_then(|snip| snip.find(|c: char| !c.is_whitespace()))
}
/// Returns the positon just before rarrow
///
/// ```rust,ignore
/// fn into(self) -> () {}
/// ^
/// // in case of unformatted code
/// fn into2(self)-> () {}
/// ^
/// fn into3(self) -> () {}
/// ^
/// ```
#[allow(clippy::needless_pass_by_value)]
pub fn position_before_rarrow(s: String) -> Option<usize> {
s.rfind("->").map(|rpos| {
let mut rpos = rpos;
let chars: Vec<char> = s.chars().collect();
while rpos > 1 {
if let Some(c) = chars.get(rpos - 1) {
if c.is_whitespace() {
rpos -= 1;
continue;
}
}
break;
}
rpos
})
}
/// Extends the span to the beginning of the spans line, incl. whitespaces.
///
/// ```rust,ignore
/// let x = ();
/// // ^^
/// // will be converted to
/// let x = ();
/// // ^^^^^^^^^^^^^^
/// ```
fn line_span<T: LintContext>(cx: &T, span: Span) -> Span {
let span = original_sp(span, DUMMY_SP);
2018-11-22 06:53:59 +00:00
let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
let line_no = source_map_and_line.line;
let line_start = source_map_and_line.sf.lines[line_no];
Span::new(line_start, span.hi(), span.ctxt())
}
2018-07-12 07:30:57 +00:00
/// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
2016-01-12 22:17:54 +00:00
/// Also takes an `Option<String>` which can be put inside the braces.
2019-12-27 07:12:26 +00:00
pub fn expr_block<'a, T: LintContext>(
cx: &T,
expr: &Expr<'_>,
option: Option<String>,
default: &'a str,
indent_relative_to: Option<Span>,
2019-12-27 07:12:26 +00:00
) -> Cow<'a, str> {
let code = snippet_block(cx, expr.span, default, indent_relative_to);
2016-01-12 22:17:54 +00:00
let string = option.unwrap_or_default();
2019-08-19 16:30:32 +00:00
if expr.span.from_expansion() {
Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
2019-09-27 15:16:06 +00:00
} else if let ExprKind::Block(_, _) = expr.kind {
Cow::Owned(format!("{}{}", code, string))
} else if string.is_empty() {
Cow::Owned(format!("{{ {} }}", code))
} else {
Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
}
}
/// Reindent a multiline string with possibility of ignoring the first line.
#[allow(clippy::needless_pass_by_value)]
pub fn reindent_multiline(s: Cow<'_, str>, ignore_first: bool, indent: Option<usize>) -> Cow<'_, str> {
let s_space = reindent_multiline_inner(&s, ignore_first, indent, ' ');
let s_tab = reindent_multiline_inner(&s_space, ignore_first, indent, '\t');
reindent_multiline_inner(&s_tab, ignore_first, indent, ' ').into()
2015-08-13 07:57:30 +00:00
}
fn reindent_multiline_inner(s: &str, ignore_first: bool, indent: Option<usize>, ch: char) -> String {
let x = s
.lines()
2016-12-20 17:21:30 +00:00
.skip(ignore_first as usize)
.filter_map(|l| {
if l.is_empty() {
None
} else {
// ignore empty lines
Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
2016-12-20 17:21:30 +00:00
}
})
.min()
.unwrap_or(0);
let indent = indent.unwrap_or(0);
s.lines()
.enumerate()
.map(|(i, l)| {
if (ignore_first && i == 0) || l.is_empty() {
l.to_owned()
} else if x > indent {
l.split_at(x - indent).1.to_owned()
} else {
" ".repeat(indent - x) + l
}
})
.collect::<Vec<String>>()
.join("\n")
}
2019-03-10 17:19:47 +00:00
/// Gets the parent expression, if any - this is useful to constrain a lint.
pub fn get_parent_expr<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>) -> Option<&'tcx Expr<'tcx>> {
let map = &cx.tcx.hir();
2019-02-24 18:43:15 +00:00
let hir_id = e.hir_id;
let parent_id = map.get_parent_node(hir_id);
2019-02-24 18:43:15 +00:00
if hir_id == parent_id {
2016-01-04 04:26:12 +00:00
return None;
}
2019-06-25 21:34:07 +00:00
map.find(parent_id).and_then(|node| {
2018-08-28 11:13:42 +00:00
if let Node::Expr(parent) = node {
2017-08-09 07:30:56 +00:00
Some(parent)
} else {
None
2017-11-04 19:55:56 +00:00
}
})
}
pub fn get_enclosing_block<'tcx>(cx: &LateContext<'tcx>, hir_id: HirId) -> Option<&'tcx Block<'tcx>> {
let map = &cx.tcx.hir();
let enclosing_node = map
.get_enclosing_scope(hir_id)
2019-06-25 21:34:07 +00:00
.and_then(|enclosing_id| map.find(enclosing_id));
enclosing_node.and_then(|node| match node {
Node::Block(block) => Some(block),
Node::Item(&Item {
kind: ItemKind::Fn(_, _, eid),
..
})
| Node::ImplItem(&ImplItem {
kind: ImplItemKind::Fn(_, eid),
..
}) => match cx.tcx.hir().body(eid).value.kind {
ExprKind::Block(ref block, _) => Some(block),
2016-01-04 04:26:12 +00:00
_ => None,
},
_ => None,
})
}
2019-01-31 01:15:29 +00:00
/// Returns the base type for HIR references and pointers.
2019-12-30 04:02:10 +00:00
pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
2019-09-27 15:16:06 +00:00
match ty.kind {
2018-07-12 08:03:06 +00:00
TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
2017-11-04 19:55:56 +00:00
_ => ty,
2017-09-10 17:32:24 +00:00
}
}
2019-01-31 01:15:29 +00:00
/// Returns the base type for references and raw pointers, and count reference
2017-08-09 07:30:56 +00:00
/// depth.
2018-07-23 11:01:12 +00:00
pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
match ty.kind() {
ty::Ref(_, ty, _) => inner(ty, depth + 1),
2016-01-04 04:26:12 +00:00
_ => (ty, depth),
}
}
inner(ty, 0)
}
/// Checks whether the given expression is a constant integer of the given value.
2019-09-11 06:26:57 +00:00
/// unlike `is_integer_literal`, this version does const folding
pub fn is_integer_const(cx: &LateContext<'_>, e: &Expr<'_>, value: u128) -> bool {
if is_integer_literal(e, value) {
return true;
}
let map = cx.tcx.hir();
let parent_item = map.get_parent_item(e.hir_id);
2019-09-11 06:26:57 +00:00
if let Some((Constant::Int(v), _)) = map
.maybe_body_owned_by(parent_item)
2020-07-17 08:47:04 +00:00
.and_then(|body_id| constant(cx, cx.tcx.typeck_body(body_id), e))
2019-09-11 06:26:57 +00:00
{
value == v
} else {
false
}
}
2019-01-31 01:15:29 +00:00
/// Checks whether the given expression is a constant literal of the given value.
2019-12-27 07:12:26 +00:00
pub fn is_integer_literal(expr: &Expr<'_>, value: u128) -> bool {
// FIXME: use constant folding
2019-09-27 15:16:06 +00:00
if let ExprKind::Lit(ref spanned) = expr.kind {
2016-02-12 17:35:44 +00:00
if let LitKind::Int(v, _) = spanned.node {
return v == value;
}
}
false
}
/// Returns `true` if the given `Expr` has been coerced before.
///
/// Examples of coercions can be found in the Nomicon at
/// <https://doc.rust-lang.org/nomicon/coercions.html>.
///
/// See `rustc_middle::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
/// information on adjustments and coercions.
pub fn is_adjusted(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
2020-07-17 08:47:04 +00:00
cx.typeck_results().adjustments().get(e.hir_id).is_some()
2015-11-04 03:11:40 +00:00
}
2019-01-31 01:15:29 +00:00
/// Returns the pre-expansion span if is this comes from an expansion of the
2017-08-09 07:30:56 +00:00
/// macro `name`.
/// See also `is_direct_expn_of`.
#[must_use]
2019-05-17 21:53:54 +00:00
pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
loop {
if span.from_expansion() {
let data = span.ctxt().outer_expn_data();
let new_span = data.call_site;
2016-01-30 12:48:39 +00:00
if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
if mac_name.as_str() == name {
return Some(new_span);
}
}
span = new_span;
} else {
return None;
2016-02-01 10:28:39 +00:00
}
}
}
2019-03-10 17:19:47 +00:00
/// Returns the pre-expansion span if the span directly comes from an expansion
2017-08-09 07:30:56 +00:00
/// of the macro `name`.
/// The difference with `is_expn_of` is that in
/// ```rust,ignore
/// foo!(bar!(42));
/// ```
2017-08-09 07:30:56 +00:00
/// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
/// `bar!` by
/// `is_direct_expn_of`.
#[must_use]
2019-05-17 21:53:54 +00:00
pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
if span.from_expansion() {
let data = span.ctxt().outer_expn_data();
let new_span = data.call_site;
if let ExpnKind::Macro(MacroKind::Bang, mac_name) = data.kind {
if mac_name.as_str() == name {
return Some(new_span);
}
}
}
None
}
2019-03-10 17:19:47 +00:00
/// Convenience function to get the return type of a function.
pub fn return_ty<'tcx>(cx: &LateContext<'tcx>, fn_item: hir::HirId) -> Ty<'tcx> {
let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
2020-10-24 00:21:27 +00:00
cx.tcx.erase_late_bound_regions(ret_ty)
}
2016-03-03 18:46:10 +00:00
/// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
pub fn contains_ty(ty: Ty<'_>, other_ty: Ty<'_>) -> bool {
ty.walk().any(|inner| match inner.unpack() {
GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
})
}
2019-01-31 01:15:29 +00:00
/// Returns `true` if the given type is an `unsafe` function.
pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
match ty.kind() {
ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
_ => false,
}
}
pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
}
/// Checks if an expression is constructing a tuple-like enum variant or struct
pub fn is_ctor_or_promotable_const_function(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
2019-09-27 15:16:06 +00:00
if let ExprKind::Call(ref fun, _) = expr.kind {
if let ExprKind::Path(ref qp) = fun.kind {
let res = cx.qpath_res(qp, fun.hir_id);
return match res {
2020-03-16 06:23:03 +00:00
def::Res::Def(DefKind::Variant | DefKind::Ctor(..), ..) => true,
def::Res::Def(_, def_id) => cx.tcx.is_promotable_const_fn(def_id),
_ => false,
2019-10-05 10:42:09 +00:00
};
}
}
false
}
2019-01-31 01:15:29 +00:00
/// Returns `true` if a pattern is refutable.
2020-07-21 09:09:27 +00:00
// TODO: should be implemented using rustc/mir_build/thir machinery
pub fn is_refutable(cx: &LateContext<'_>, pat: &Pat<'_>) -> bool {
fn is_enum_variant(cx: &LateContext<'_>, qpath: &QPath<'_>, id: HirId) -> bool {
2017-08-09 07:30:56 +00:00
matches!(
cx.qpath_res(qpath, id),
def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
2017-08-09 07:30:56 +00:00
)
}
fn are_refutable<'a, I: Iterator<Item = &'a Pat<'a>>>(cx: &LateContext<'_>, mut i: I) -> bool {
i.any(|pat| is_refutable(cx, pat))
}
2019-09-27 15:16:06 +00:00
match pat.kind {
PatKind::Wild => false,
PatKind::Binding(_, _, _, pat) => pat.map_or(false, |pat| is_refutable(cx, pat)),
2017-09-05 09:33:04 +00:00
PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
PatKind::Lit(..) | PatKind::Range(..) => true,
2017-08-15 09:10:49 +00:00
PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
PatKind::Or(ref pats) => {
// TODO: should be the honest check, that pats is exhaustive set
are_refutable(cx, pats.iter().map(|pat| &**pat))
},
PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
PatKind::Struct(ref qpath, ref fields, _) => {
is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, fields.iter().map(|field| &*field.pat))
2016-12-20 17:21:30 +00:00
},
PatKind::TupleStruct(ref qpath, ref pats, _) => {
is_enum_variant(cx, qpath, pat.hir_id) || are_refutable(cx, pats.iter().map(|pat| &**pat))
},
PatKind::Slice(ref head, ref middle, ref tail) => {
match &cx.typeck_results().node_type(pat.hir_id).kind() {
ty::Slice(..) => {
// [..] is the only irrefutable slice pattern.
!head.is_empty() || middle.is_none() || !tail.is_empty()
},
ty::Array(..) => are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat)),
_ => {
// unreachable!()
true
},
}
2016-12-20 17:21:30 +00:00
},
}
}
2017-08-09 07:30:56 +00:00
/// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
/// implementations have.
pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
attrs.iter().any(|attr| attr.has_name(rustc_sym::automatically_derived))
}
/// Remove blocks around an expression.
///
2017-08-09 07:30:56 +00:00
/// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
/// themselves.
pub fn remove_blocks<'tcx>(mut expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
while let ExprKind::Block(ref block, ..) = expr.kind {
match (block.stmts.is_empty(), block.expr.as_ref()) {
(true, Some(e)) => expr = e,
_ => break,
}
}
2019-12-22 21:49:59 +00:00
expr
}
2019-12-27 07:12:26 +00:00
pub fn is_self(slf: &Param<'_>) -> bool {
2019-09-27 15:16:06 +00:00
if let PatKind::Binding(.., name, _) = slf.pat.kind {
name.name == kw::SelfLower
} else {
false
}
}
2019-12-30 04:02:10 +00:00
pub fn is_self_ty(slf: &hir::Ty<'_>) -> bool {
if_chain! {
2019-09-27 15:16:06 +00:00
if let TyKind::Path(ref qp) = slf.kind;
if let QPath::Resolved(None, ref path) = *qp;
if let Res::SelfTy(..) = path.res;
then {
return true
}
}
false
}
2019-12-30 04:02:10 +00:00
pub fn iter_input_pats<'tcx>(decl: &FnDecl<'_>, body: &'tcx Body<'_>) -> impl Iterator<Item = &'tcx Param<'tcx>> {
2019-08-28 09:27:06 +00:00
(0..decl.inputs.len()).map(move |i| &body.params[i])
2017-01-04 23:53:16 +00:00
}
2019-03-10 17:19:47 +00:00
/// Checks if a given expression is a match expression expanded from the `?`
/// operator or the `try` macro.
2019-12-27 07:12:26 +00:00
pub fn is_try<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
fn is_ok(arm: &Arm<'_>) -> bool {
if_chain! {
2019-09-27 15:16:06 +00:00
if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pat.kind;
if match_qpath(path, &paths::RESULT_OK[1..]);
2019-09-27 15:16:06 +00:00
if let PatKind::Binding(_, hir_id, _, None) = pat[0].kind;
if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.kind;
if let Res::Local(lid) = path.res;
if lid == hir_id;
then {
return true;
}
}
false
}
2019-12-27 07:12:26 +00:00
fn is_err(arm: &Arm<'_>) -> bool {
2019-09-27 15:16:06 +00:00
if let PatKind::TupleStruct(ref path, _, _) = arm.pat.kind {
match_qpath(path, &paths::RESULT_ERR[1..])
} else {
false
}
}
2019-09-27 15:16:06 +00:00
if let ExprKind::Match(_, ref arms, ref source) = expr.kind {
// desugared from a `?` operator
if let MatchSource::TryDesugar = *source {
return Some(expr);
}
if_chain! {
if arms.len() == 2;
2019-09-25 19:00:17 +00:00
if arms[0].guard.is_none();
if arms[1].guard.is_none();
2019-04-14 20:19:33 +00:00
if (is_ok(&arms[0]) && is_err(&arms[1])) ||
(is_ok(&arms[1]) && is_err(&arms[0]));
then {
return Some(expr);
}
}
}
None
}
2019-01-31 01:15:29 +00:00
/// Returns `true` if the lint is allowed in the current context
2017-08-11 12:11:46 +00:00
///
/// Useful for skipping long running code when it's unnecessary
pub fn is_allowed(cx: &LateContext<'_>, lint: &'static Lint, id: HirId) -> bool {
2019-02-27 09:39:33 +00:00
cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
2017-08-11 12:11:46 +00:00
}
2018-01-14 10:05:01 +00:00
pub fn get_arg_name(pat: &Pat<'_>) -> Option<Symbol> {
2019-09-27 15:16:06 +00:00
match pat.kind {
PatKind::Binding(.., ident, None) => Some(ident.name),
2018-01-14 10:05:01 +00:00
PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
_ => None,
}
}
2018-03-13 10:38:11 +00:00
2019-06-14 16:47:48 +00:00
pub fn int_bits(tcx: TyCtxt<'_>, ity: ast::IntTy) -> u64 {
2020-04-02 20:29:41 +00:00
Integer::from_attr(&tcx, attr::IntType::SignedInt(ity)).size().bits()
2018-03-13 10:38:11 +00:00
}
#[allow(clippy::cast_possible_wrap)]
2018-03-13 10:38:11 +00:00
/// Turn a constant int byte representation into an i128
2019-06-14 16:47:48 +00:00
pub fn sext(tcx: TyCtxt<'_>, u: u128, ity: ast::IntTy) -> i128 {
2018-03-13 10:38:11 +00:00
let amt = 128 - int_bits(tcx, ity);
((u as i128) << amt) >> amt
}
#[allow(clippy::cast_sign_loss)]
2018-03-13 10:38:11 +00:00
/// clip unused bytes
2019-06-14 16:47:48 +00:00
pub fn unsext(tcx: TyCtxt<'_>, u: i128, ity: ast::IntTy) -> u128 {
2018-03-13 10:38:11 +00:00
let amt = 128 - int_bits(tcx, ity);
((u as u128) << amt) >> amt
}
/// clip unused bytes
2019-06-14 16:47:48 +00:00
pub fn clip(tcx: TyCtxt<'_>, u: u128, ity: ast::UintTy) -> u128 {
2020-04-02 20:29:41 +00:00
let bits = Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity)).size().bits();
2018-03-13 10:38:11 +00:00
let amt = 128 - bits;
(u << amt) >> amt
}
2019-01-31 01:15:29 +00:00
/// Removes block comments from the given `Vec` of lines.
///
/// # Examples
///
/// ```rust,ignore
/// without_block_comments(vec!["/*", "foo", "*/"]);
/// // => vec![]
///
/// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
/// // => vec!["bar"]
/// ```
pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
let mut without = vec![];
2018-03-30 10:36:30 +00:00
let mut nest_level = 0;
2018-04-02 05:35:13 +00:00
for line in lines {
if line.contains("/*") {
2018-03-30 10:36:30 +00:00
nest_level += 1;
continue;
} else if line.contains("*/") {
2018-03-30 10:36:30 +00:00
nest_level -= 1;
continue;
}
2018-03-30 10:36:30 +00:00
if nest_level == 0 {
without.push(line);
}
}
without
}
2018-06-17 21:58:08 +00:00
2019-06-14 16:47:48 +00:00
pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_>, node: HirId) -> bool {
let map = &tcx.hir();
2018-06-17 21:58:08 +00:00
let mut prev_enclosing_node = None;
let mut enclosing_node = node;
while Some(enclosing_node) != prev_enclosing_node {
if is_automatically_derived(map.attrs(enclosing_node)) {
2018-06-17 21:58:08 +00:00
return true;
}
prev_enclosing_node = Some(enclosing_node);
2019-02-24 18:43:15 +00:00
enclosing_node = map.get_parent_item(enclosing_node);
2018-06-17 21:58:08 +00:00
}
false
}
/// Returns true if ty has `iter` or `iter_mut` methods
pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<&'static str> {
// FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
// exists and has the desired signature. Unfortunately FnCtxt is not exported
// so we can't use its `lookup_method` method.
2019-05-17 21:53:54 +00:00
let into_iter_collections: [&[&str]; 13] = [
&paths::VEC,
&paths::OPTION,
&paths::RESULT,
&paths::BTREESET,
&paths::BTREEMAP,
&paths::VEC_DEQUE,
&paths::LINKED_LIST,
&paths::BINARY_HEAP,
&paths::HASHSET,
&paths::HASHMAP,
&paths::PATH_BUF,
&paths::PATH,
&paths::RECEIVER,
];
let ty_to_check = match probably_ref_ty.kind() {
ty::Ref(_, ty_to_check, _) => ty_to_check,
_ => probably_ref_ty,
};
let def_id = match ty_to_check.kind() {
2019-05-17 21:53:54 +00:00
ty::Array(..) => return Some("array"),
ty::Slice(..) => return Some("slice"),
ty::Adt(adt, _) => adt.did,
_ => return None,
};
2019-05-14 08:03:16 +00:00
for path in &into_iter_collections {
2019-05-13 23:34:08 +00:00
if match_def_path(cx, def_id, path) {
return Some(*path.last().unwrap());
}
}
None
}
2019-10-10 08:57:12 +00:00
/// Matches a function call with the given path and returns the arguments.
///
/// Usage:
///
/// ```rust,ignore
/// if let Some(args) = match_function_call(cx, cmp_max_call, &paths::CMP_MAX);
2019-10-10 08:57:12 +00:00
/// ```
pub fn match_function_call<'tcx>(
cx: &LateContext<'tcx>,
2019-12-27 07:12:26 +00:00
expr: &'tcx Expr<'_>,
2019-10-10 08:57:12 +00:00
path: &[&str],
2019-12-27 07:12:26 +00:00
) -> Option<&'tcx [Expr<'tcx>]> {
2019-10-10 08:57:12 +00:00
if_chain! {
if let ExprKind::Call(ref fun, ref args) = expr.kind;
if let ExprKind::Path(ref qpath) = fun.kind;
if let Some(fun_def_id) = cx.qpath_res(qpath, fun.hir_id).opt_def_id();
2019-10-10 08:57:12 +00:00
if match_def_path(cx, fun_def_id, path);
then {
return Some(&args)
}
};
None
}
2020-01-02 02:48:06 +00:00
/// Checks if `Ty` is normalizable. This function is useful
/// to avoid crashes on `layout_of`.
pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
2020-01-02 02:48:06 +00:00
cx.tcx.infer_ctxt().enter(|infcx| {
let cause = rustc_middle::traits::ObligationCause::dummy();
2020-10-24 00:21:27 +00:00
infcx.at(&cause, param_env).normalize(ty).is_ok()
2020-01-02 02:48:06 +00:00
})
}
pub fn match_def_path<'tcx>(cx: &LateContext<'tcx>, did: DefId, syms: &[&str]) -> bool {
// We have to convert `syms` to `&[Symbol]` here because rustc's `match_def_path`
// accepts only that. We should probably move to Symbols in Clippy as well.
let syms = syms.iter().map(|p| Symbol::intern(p)).collect::<Vec<Symbol>>();
cx.match_def_path(did, &syms)
2019-05-13 23:34:08 +00:00
}
2019-09-24 21:55:05 +00:00
pub fn match_panic_call<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<&'tcx [Expr<'tcx>]> {
match_function_call(cx, expr, &paths::BEGIN_PANIC)
.or_else(|| match_function_call(cx, expr, &paths::BEGIN_PANIC_FMT))
.or_else(|| match_function_call(cx, expr, &paths::PANIC_ANY))
.or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC))
.or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_FMT))
.or_else(|| match_function_call(cx, expr, &paths::PANICKING_PANIC_STR))
}
pub fn match_panic_def_id(cx: &LateContext<'_>, did: DefId) -> bool {
match_def_path(cx, did, &paths::BEGIN_PANIC)
|| match_def_path(cx, did, &paths::BEGIN_PANIC_FMT)
|| match_def_path(cx, did, &paths::PANIC_ANY)
|| match_def_path(cx, did, &paths::PANICKING_PANIC)
|| match_def_path(cx, did, &paths::PANICKING_PANIC_FMT)
|| match_def_path(cx, did, &paths::PANICKING_PANIC_STR)
}
2019-09-24 21:55:05 +00:00
/// Returns the list of condition expressions and the list of blocks in a
/// sequence of `if/else`.
/// E.g., this returns `([a, b], [c, d, e])` for the expression
/// `if a { c } else if b { d } else { e }`.
2019-12-27 07:12:26 +00:00
pub fn if_sequence<'tcx>(
mut expr: &'tcx Expr<'tcx>,
) -> (SmallVec<[&'tcx Expr<'tcx>; 1]>, SmallVec<[&'tcx Block<'tcx>; 1]>) {
2019-09-24 21:55:05 +00:00
let mut conds = SmallVec::new();
2019-12-27 07:12:26 +00:00
let mut blocks: SmallVec<[&Block<'_>; 1]> = SmallVec::new();
2019-09-24 21:55:05 +00:00
while let Some((ref cond, ref then_expr, ref else_expr)) = higher::if_block(&expr) {
conds.push(&**cond);
2019-09-27 15:16:06 +00:00
if let ExprKind::Block(ref block, _) = then_expr.kind {
2019-09-24 21:55:05 +00:00
blocks.push(block);
} else {
panic!("ExprKind::If node is not an ExprKind::Block");
}
if let Some(ref else_expr) = *else_expr {
expr = else_expr;
} else {
break;
}
}
// final `else {..}`
if !blocks.is_empty() {
2019-09-27 15:16:06 +00:00
if let ExprKind::Block(ref block, _) = expr.kind {
2019-09-24 21:55:05 +00:00
blocks.push(&**block);
}
}
(conds, blocks)
}
pub fn parent_node_is_if_expr(expr: &Expr<'_>, cx: &LateContext<'_>) -> bool {
2019-12-22 21:49:59 +00:00
let map = cx.tcx.hir();
let parent_id = map.get_parent_node(expr.hir_id);
let parent_node = map.get(parent_id);
2019-09-24 21:55:05 +00:00
match parent_node {
2019-12-22 21:49:59 +00:00
Node::Expr(e) => higher::if_block(&e).is_some(),
Node::Arm(e) => higher::if_block(&e.body).is_some(),
2019-09-24 21:55:05 +00:00
_ => false,
}
}
2019-11-13 23:42:00 +00:00
// Finds the attribute with the given name, if any
pub fn attr_by_name<'a>(attrs: &'a [Attribute], name: &'_ str) -> Option<&'a Attribute> {
attrs
.iter()
.find(|attr| attr.ident().map_or(false, |ident| ident.as_str() == name))
}
// Finds the `#[must_use]` attribute, if any
2019-11-13 23:42:00 +00:00
pub fn must_use_attr(attrs: &[Attribute]) -> Option<&Attribute> {
attr_by_name(attrs, "must_use")
2019-11-13 23:42:00 +00:00
}
// Returns whether the type has #[must_use] attribute
pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
match ty.kind() {
2020-02-21 08:40:13 +00:00
ty::Adt(ref adt, _) => must_use_attr(&cx.tcx.get_attrs(adt.did)).is_some(),
ty::Foreign(ref did) => must_use_attr(&cx.tcx.get_attrs(*did)).is_some(),
ty::Slice(ref ty)
| ty::Array(ref ty, _)
| ty::RawPtr(ty::TypeAndMut { ref ty, .. })
| ty::Ref(_, ref ty, _) => {
2019-11-13 23:42:00 +00:00
// for the Array case we don't need to care for the len == 0 case
// because we don't want to lint functions returning empty arrays
is_must_use_ty(cx, *ty)
},
2020-02-21 08:40:13 +00:00
ty::Tuple(ref substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
ty::Opaque(ref def_id, _) => {
2020-06-30 21:41:57 +00:00
for (predicate, _) in cx.tcx.explicit_item_bounds(*def_id) {
2020-07-08 22:35:55 +00:00
if let ty::PredicateAtom::Trait(trait_predicate, _) = predicate.skip_binders() {
if must_use_attr(&cx.tcx.get_attrs(trait_predicate.trait_ref.def_id)).is_some() {
2019-11-13 23:42:00 +00:00
return true;
}
}
}
false
},
2020-02-21 08:40:13 +00:00
ty::Dynamic(binder, _) => {
2019-11-13 23:42:00 +00:00
for predicate in binder.skip_binder().iter() {
if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate {
if must_use_attr(&cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
return true;
}
}
}
false
},
_ => false,
}
}
// check if expr is calling method or function with #[must_use] attribute
pub fn is_must_use_func_call(cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
let did = match expr.kind {
ExprKind::Call(ref path, _) => if_chain! {
if let ExprKind::Path(ref qpath) = path.kind;
if let def::Res::Def(_, did) = cx.qpath_res(qpath, path.hir_id);
then {
Some(did)
} else {
None
}
},
2020-07-17 08:47:04 +00:00
ExprKind::MethodCall(_, _, _, _) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
_ => None,
};
did.map_or(false, |did| must_use_attr(&cx.tcx.get_attrs(did)).is_some())
}
2020-01-24 10:50:03 +00:00
pub fn is_no_std_crate(krate: &Crate<'_>) -> bool {
krate.item.attrs.iter().any(|attr| {
2020-11-05 17:27:48 +00:00
if let ast::AttrKind::Normal(ref attr, _) = attr.kind {
2020-01-24 10:50:03 +00:00
attr.path == symbol::sym::no_std
} else {
false
}
})
}
2020-02-01 23:49:52 +00:00
/// Check if parent of a hir node is a trait implementation block.
/// For example, `f` in
/// ```rust,ignore
/// impl Trait for S {
/// fn f() {}
/// }
/// ```
pub fn is_trait_impl_item(cx: &LateContext<'_>, hir_id: HirId) -> bool {
if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
matches!(item.kind, ItemKind::Impl{ of_trait: Some(_), .. })
} else {
false
}
}
2020-03-10 04:17:15 +00:00
/// Check if it's even possible to satisfy the `where` clause for the item.
///
/// `trivial_bounds` feature allows functions with unsatisfiable bounds, for example:
///
2020-03-10 04:27:33 +00:00
/// ```ignore
/// fn foo() where i32: Iterator {
2020-03-10 04:17:15 +00:00
/// for _ in 2i32 {}
/// }
/// ```
pub fn fn_has_unsatisfiable_preds(cx: &LateContext<'_>, did: DefId) -> bool {
2020-03-14 20:26:32 +00:00
use rustc_trait_selection::traits;
2020-04-27 13:56:20 +00:00
let predicates =
cx.tcx
.predicates_of(did)
.predicates
.iter()
.filter_map(|(p, _)| if p.is_global() { Some(*p) } else { None });
traits::impossible_predicates(
cx.tcx,
traits::elaborate_predicates(cx.tcx, predicates)
.map(|o| o.predicate)
.collect::<Vec<_>>(),
)
2020-03-10 04:17:15 +00:00
}
/// Returns the `DefId` of the callee if the given expression is a function or method call.
pub fn fn_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<DefId> {
match &expr.kind {
2020-07-17 08:47:04 +00:00
ExprKind::MethodCall(..) => cx.typeck_results().type_dependent_def_id(expr.hir_id),
ExprKind::Call(
Expr {
kind: ExprKind::Path(qpath),
..
},
..,
2020-07-17 08:47:04 +00:00
) => cx.typeck_results().qpath_res(qpath, expr.hir_id).opt_def_id(),
_ => None,
}
}
pub fn run_lints(cx: &LateContext<'_>, lints: &[&'static Lint], id: HirId) -> bool {
lints.iter().any(|lint| {
matches!(
cx.tcx.lint_level_at_node(lint, id),
(Level::Forbid | Level::Deny | Level::Warn, _)
)
})
}
/// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
/// number type, a str, or an array, slice, or tuple of those types).
pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
match ty.kind() {
ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
_ => false,
}
}
/// Returns Option<String> where String is a textual representation of the type encapsulated in the
/// slice iff the given expression is a slice of primitives (as defined in the
/// `is_recursively_primitive_type` function) and None otherwise.
pub fn is_slice_of_primitives(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<String> {
let expr_type = cx.typeck_results().expr_ty_adjusted(expr);
let expr_kind = expr_type.kind();
let is_primitive = match expr_kind {
ty::Slice(element_type) => is_recursively_primitive_type(element_type),
ty::Ref(_, inner_ty, _) if matches!(inner_ty.kind(), &ty::Slice(_)) => {
if let ty::Slice(element_type) = inner_ty.kind() {
is_recursively_primitive_type(element_type)
} else {
unreachable!()
}
},
_ => false,
};
if is_primitive {
// if we have wrappers like Array, Slice or Tuple, print these
// and get the type enclosed in the slice ref
match expr_type.peel_refs().walk().nth(1).unwrap().expect_ty().kind() {
ty::Slice(..) => return Some("slice".into()),
ty::Array(..) => return Some("array".into()),
ty::Tuple(..) => return Some("tuple".into()),
_ => {
// is_recursively_primitive_type() should have taken care
// of the rest and we can rely on the type that is found
let refs_peeled = expr_type.peel_refs();
return Some(refs_peeled.walk().last().unwrap().to_string());
},
}
}
None
}
/// returns list of all pairs (a, b) from `exprs` such that `eq(a, b)`
/// `hash` must be comformed with `eq`
pub fn search_same<T, Hash, Eq>(exprs: &[T], hash: Hash, eq: Eq) -> Vec<(&T, &T)>
where
Hash: Fn(&T) -> u64,
Eq: Fn(&T, &T) -> bool,
{
if exprs.len() == 2 && eq(&exprs[0], &exprs[1]) {
return vec![(&exprs[0], &exprs[1])];
}
let mut match_expr_list: Vec<(&T, &T)> = Vec::new();
let mut map: FxHashMap<_, Vec<&_>> =
FxHashMap::with_capacity_and_hasher(exprs.len(), BuildHasherDefault::default());
for expr in exprs {
match map.entry(hash(expr)) {
Entry::Occupied(mut o) => {
for o in o.get() {
if eq(o, expr) {
match_expr_list.push((o, expr));
}
}
o.get_mut().push(expr);
},
Entry::Vacant(v) => {
v.insert(vec![expr]);
},
}
}
match_expr_list
}
#[macro_export]
macro_rules! unwrap_cargo_metadata {
($cx: ident, $lint: ident, $deps: expr) => {{
let mut command = cargo_metadata::MetadataCommand::new();
if !$deps {
command.no_deps();
}
match command.exec() {
Ok(metadata) => metadata,
Err(err) => {
span_lint($cx, $lint, DUMMY_SP, &format!("could not read cargo metadata: {}", err));
return;
},
}
}};
}
#[cfg(test)]
mod test {
use super::{reindent_multiline, without_block_comments};
#[test]
fn test_reindent_multiline_single_line() {
assert_eq!("", reindent_multiline("".into(), false, None));
assert_eq!("...", reindent_multiline("...".into(), false, None));
assert_eq!("...", reindent_multiline(" ...".into(), false, None));
assert_eq!("...", reindent_multiline("\t...".into(), false, None));
assert_eq!("...", reindent_multiline("\t\t...".into(), false, None));
}
#[test]
#[rustfmt::skip]
fn test_reindent_multiline_block() {
assert_eq!("\
if x {
y
} else {
z
}", reindent_multiline(" if x {
y
} else {
z
}".into(), false, None));
assert_eq!("\
if x {
\ty
} else {
\tz
}", reindent_multiline(" if x {
\ty
} else {
\tz
}".into(), false, None));
}
#[test]
#[rustfmt::skip]
fn test_reindent_multiline_empty_line() {
assert_eq!("\
if x {
y
} else {
z
}", reindent_multiline(" if x {
y
} else {
z
}".into(), false, None));
}
#[test]
#[rustfmt::skip]
fn test_reindent_multiline_lines_deeper() {
assert_eq!("\
if x {
y
} else {
z
}", reindent_multiline("\
if x {
y
} else {
z
}".into(), true, Some(8)));
}
#[test]
fn test_without_block_comments_lines_without_block_comments() {
let result = without_block_comments(vec!["/*", "", "*/"]);
println!("result: {:?}", result);
assert!(result.is_empty());
let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
let result = without_block_comments(vec!["/* rust", "", "*/"]);
assert!(result.is_empty());
let result = without_block_comments(vec!["/* one-line comment */"]);
assert!(result.is_empty());
let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
assert!(result.is_empty());
let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
assert!(result.is_empty());
let result = without_block_comments(vec!["foo", "bar", "baz"]);
assert_eq!(result, vec!["foo", "bar", "baz"]);
}
}