1 //! Util methods for [`rustc_middle::ty`]
3 #![allow(clippy::module_name_repetitions)]
5 use rustc_ast::ast::Mutability;
6 use rustc_data_structures::fx::FxHashMap;
8 use rustc_hir::def_id::DefId;
9 use rustc_hir::{TyKind, Unsafety};
10 use rustc_infer::infer::TyCtxtInferExt;
11 use rustc_lint::LateContext;
12 use rustc_middle::ty::subst::{GenericArg, GenericArgKind};
13 use rustc_middle::ty::{self, AdtDef, IntTy, Ty, TypeFoldable, UintTy};
15 use rustc_span::symbol::{Ident, Symbol};
16 use rustc_span::DUMMY_SP;
17 use rustc_trait_selection::infer::InferCtxtExt;
18 use rustc_trait_selection::traits::query::normalize::AtExt;
20 use crate::{match_def_path, must_use_attr};
22 pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
23 ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
26 /// Checks whether a type can be partially moved.
27 pub fn can_partially_move_ty(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
28 if has_drop(cx, ty) || is_copy(cx, ty) {
32 ty::Param(_) => false,
33 ty::Adt(def, subs) => def.all_fields().any(|f| !is_copy(cx, f.ty(cx.tcx, subs))),
38 /// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
39 pub fn contains_ty(ty: Ty<'_>, other_ty: Ty<'_>) -> bool {
40 ty.walk().any(|inner| match inner.unpack() {
41 GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
42 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
46 /// Walks into `ty` and returns `true` if any inner type is an instance of the given adt
48 pub fn contains_adt_constructor(ty: Ty<'_>, adt: &AdtDef) -> bool {
49 ty.walk().any(|inner| match inner.unpack() {
50 GenericArgKind::Type(inner_ty) => inner_ty.ty_adt_def() == Some(adt),
51 GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
55 /// Resolves `<T as Iterator>::Item` for `T`
56 /// Do not invoke without first verifying that the type implements `Iterator`
57 pub fn get_iterator_item_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
59 .get_diagnostic_item(sym::Iterator)
60 .and_then(|iter_did| {
61 cx.tcx.associated_items(iter_did).find_by_name_and_kind(
63 Ident::from_str("Item"),
69 let proj = cx.tcx.mk_projection(assoc.def_id, cx.tcx.mk_substs_trait(ty, &[]));
70 cx.tcx.normalize_erasing_regions(cx.param_env, proj)
74 /// Returns true if ty has `iter` or `iter_mut` methods
75 pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<Symbol> {
76 // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
77 // exists and has the desired signature. Unfortunately FnCtxt is not exported
78 // so we can't use its `lookup_method` method.
79 let into_iter_collections: &[Symbol] = &[
95 let ty_to_check = match probably_ref_ty.kind() {
96 ty::Ref(_, ty_to_check, _) => ty_to_check,
100 let def_id = match ty_to_check.kind() {
101 ty::Array(..) => return Some(sym::array),
102 ty::Slice(..) => return Some(sym::slice),
103 ty::Adt(adt, _) => adt.did,
107 for &name in into_iter_collections {
108 if cx.tcx.is_diagnostic_item(name, def_id) {
109 return Some(cx.tcx.item_name(def_id));
115 /// Checks whether a type implements a trait.
116 /// The function returns false in case the type contains an inference variable.
117 /// See also `get_trait_def_id`.
118 pub fn implements_trait<'tcx>(
119 cx: &LateContext<'tcx>,
122 ty_params: &[GenericArg<'tcx>],
124 // Clippy shouldn't have infer types
125 assert!(!ty.needs_infer());
127 let ty = cx.tcx.erase_regions(ty);
128 if ty.has_escaping_bound_vars() {
131 let ty_params = cx.tcx.mk_substs(ty_params.iter());
132 cx.tcx.infer_ctxt().enter(|infcx| {
134 .type_implements_trait(trait_id, ty, ty_params, cx.param_env)
135 .must_apply_modulo_regions()
139 /// Checks whether this type implements `Drop`.
140 pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
141 match ty.ty_adt_def() {
142 Some(def) => def.has_dtor(cx.tcx),
147 // Returns whether the type has #[must_use] attribute
148 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
150 ty::Adt(adt, _) => must_use_attr(cx.tcx.get_attrs(adt.did)).is_some(),
151 ty::Foreign(ref did) => must_use_attr(cx.tcx.get_attrs(*did)).is_some(),
152 ty::Slice(ty) | ty::Array(ty, _) | ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _) => {
153 // for the Array case we don't need to care for the len == 0 case
154 // because we don't want to lint functions returning empty arrays
155 is_must_use_ty(cx, *ty)
157 ty::Tuple(substs) => substs.types().any(|ty| is_must_use_ty(cx, ty)),
158 ty::Opaque(ref def_id, _) => {
159 for (predicate, _) in cx.tcx.explicit_item_bounds(*def_id) {
160 if let ty::PredicateKind::Trait(trait_predicate, _) = predicate.kind().skip_binder() {
161 if must_use_attr(cx.tcx.get_attrs(trait_predicate.trait_ref.def_id)).is_some() {
168 ty::Dynamic(binder, _) => {
169 for predicate in binder.iter() {
170 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate.skip_binder() {
171 if must_use_attr(cx.tcx.get_attrs(trait_ref.def_id)).is_some() {
182 // FIXME: Per https://doc.rust-lang.org/nightly/nightly-rustc/rustc_trait_selection/infer/at/struct.At.html#method.normalize
183 // this function can be removed once the `normalizie` method does not panic when normalization does
185 /// Checks if `Ty` is normalizable. This function is useful
186 /// to avoid crashes on `layout_of`.
187 pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
188 is_normalizable_helper(cx, param_env, ty, &mut FxHashMap::default())
191 fn is_normalizable_helper<'tcx>(
192 cx: &LateContext<'tcx>,
193 param_env: ty::ParamEnv<'tcx>,
195 cache: &mut FxHashMap<Ty<'tcx>, bool>,
197 if let Some(&cached_result) = cache.get(ty) {
198 return cached_result;
200 // prevent recursive loops, false-negative is better than endless loop leading to stack overflow
201 cache.insert(ty, false);
202 let result = cx.tcx.infer_ctxt().enter(|infcx| {
203 let cause = rustc_middle::traits::ObligationCause::dummy();
204 if infcx.at(&cause, param_env).normalize(ty).is_ok() {
206 ty::Adt(def, substs) => def.variants.iter().all(|variant| {
210 .all(|field| is_normalizable_helper(cx, param_env, field.ty(cx.tcx, substs), cache))
212 _ => ty.walk().all(|generic_arg| match generic_arg.unpack() {
213 GenericArgKind::Type(inner_ty) if inner_ty != ty => {
214 is_normalizable_helper(cx, param_env, inner_ty, cache)
216 _ => true, // if inner_ty == ty, we've already checked it
223 cache.insert(ty, result);
227 /// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
228 /// number type, a str, or an array, slice, or tuple of those types).
229 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
231 ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
232 ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
233 ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
234 ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
239 /// Checks if the type is a reference equals to a diagnostic item
240 pub fn is_type_ref_to_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
242 ty::Ref(_, ref_ty, _) => match ref_ty.kind() {
243 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
250 /// Checks if the type is equal to a diagnostic item
252 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
253 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
255 ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
260 /// Checks if the type is equal to a lang item.
262 /// Returns `false` if the `LangItem` is not defined.
263 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
265 ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).map_or(false, |li| li == adt.did),
270 /// Return `true` if the passed `typ` is `isize` or `usize`.
271 pub fn is_isize_or_usize(typ: Ty<'_>) -> bool {
272 matches!(typ.kind(), ty::Int(IntTy::Isize) | ty::Uint(UintTy::Usize))
275 /// Checks if type is struct, enum or union type with the given def path.
277 /// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
278 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
279 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
281 ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
286 /// Peels off all references on the type. Returns the underlying type and the number of references
288 pub fn peel_mid_ty_refs(ty: Ty<'_>) -> (Ty<'_>, usize) {
289 fn peel(ty: Ty<'_>, count: usize) -> (Ty<'_>, usize) {
290 if let ty::Ref(_, ty, _) = ty.kind() {
299 /// Peels off all references on the type.Returns the underlying type, the number of references
300 /// removed, and whether the pointer is ultimately mutable or not.
301 pub fn peel_mid_ty_refs_is_mutable(ty: Ty<'_>) -> (Ty<'_>, usize, Mutability) {
302 fn f(ty: Ty<'_>, count: usize, mutability: Mutability) -> (Ty<'_>, usize, Mutability) {
304 ty::Ref(_, ty, Mutability::Mut) => f(ty, count + 1, mutability),
305 ty::Ref(_, ty, Mutability::Not) => f(ty, count + 1, Mutability::Not),
306 _ => (ty, count, mutability),
309 f(ty, 0, Mutability::Mut)
312 /// Returns `true` if the given type is an `unsafe` function.
313 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
315 ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
320 /// Returns the base type for HIR references and pointers.
321 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
323 TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(mut_ty.ty),
328 /// Returns the base type for references and raw pointers, and count reference
330 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
331 fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
333 ty::Ref(_, ty, _) => inner(ty, depth + 1),
340 /// Returns `true` if types `a` and `b` are same types having same `Const` generic args,
341 /// otherwise returns `false`
342 pub fn same_type_and_consts(a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
343 match (&a.kind(), &b.kind()) {
344 (&ty::Adt(did_a, substs_a), &ty::Adt(did_b, substs_b)) => {
351 .zip(substs_b.iter())
352 .all(|(arg_a, arg_b)| match (arg_a.unpack(), arg_b.unpack()) {
353 (GenericArgKind::Const(inner_a), GenericArgKind::Const(inner_b)) => inner_a == inner_b,
354 (GenericArgKind::Type(type_a), GenericArgKind::Type(type_b)) => {
355 same_type_and_consts(type_a, type_b)