clippy_utils/src/ty.rs

   1 //! Util methods for [`rustc_middle::ty`]
   2
   3 #![allow(clippy::module_name_repetitions)]
   4
   5 use rustc_ast::ast::Mutability;
   6 use rustc_data_structures::fx::FxHashMap;
   7 use rustc_hir as hir;
   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, TyCtxt, TypeFoldable, UintTy};
  14 use rustc_span::sym;
  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;
  19
  20 use crate::{match_def_path, must_use_attr};
  21
  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)
  24 }
  25
  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) {
  29         return false;
  30     }
  31     match ty.kind() {
  32         ty::Param(_) => false,
  33         ty::Adt(def, subs) => def.all_fields().any(|f| !is_copy(cx, f.ty(cx.tcx, subs))),
  34         _ => true,
  35     }
  36 }
  37
  38 /// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
  39 pub fn contains_ty<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, other_ty: Ty<'tcx>) -> bool {
  40     ty.walk(tcx).any(|inner| match inner.unpack() {
  41         GenericArgKind::Type(inner_ty) => ty::TyS::same_type(other_ty, inner_ty),
  42         GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
  43     })
  44 }
  45
  46 /// Walks into `ty` and returns `true` if any inner type is an instance of the given adt
  47 /// constructor.
  48 pub fn contains_adt_constructor<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, adt: &'tcx AdtDef) -> bool {
  49     ty.walk(tcx).any(|inner| match inner.unpack() {
  50         GenericArgKind::Type(inner_ty) => inner_ty.ty_adt_def() == Some(adt),
  51         GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
  52     })
  53 }
  54
  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>> {
  58     cx.tcx
  59         .get_diagnostic_item(sym::Iterator)
  60         .and_then(|iter_did| {
  61             cx.tcx.associated_items(iter_did).find_by_name_and_kind(
  62                 cx.tcx,
  63                 Ident::from_str("Item"),
  64                 ty::AssocKind::Type,
  65                 iter_did,
  66             )
  67         })
  68         .map(|assoc| {
  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)
  71         })
  72 }
  73
  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] = &[
  80         sym::vec_type,
  81         sym::option_type,
  82         sym::result_type,
  83         sym::BTreeMap,
  84         sym::BTreeSet,
  85         sym::vecdeque_type,
  86         sym::LinkedList,
  87         sym::BinaryHeap,
  88         sym::hashset_type,
  89         sym::hashmap_type,
  90         sym::PathBuf,
  91         sym::Path,
  92         sym::Receiver,
  93     ];
  94
  95     let ty_to_check = match probably_ref_ty.kind() {
  96         ty::Ref(_, ty_to_check, _) => ty_to_check,
  97         _ => probably_ref_ty,
  98     };
  99
 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,
 104         _ => return None,
 105     };
 106
 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));
 110         }
 111     }
 112     None
 113 }
 114
 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`](super::get_trait_def_id).
 118 pub fn implements_trait<'tcx>(
 119     cx: &LateContext<'tcx>,
 120     ty: Ty<'tcx>,
 121     trait_id: DefId,
 122     ty_params: &[GenericArg<'tcx>],
 123 ) -> bool {
 124     // Clippy shouldn't have infer types
 125     assert!(!ty.needs_infer());
 126
 127     let ty = cx.tcx.erase_regions(ty);
 128     if ty.has_escaping_bound_vars() {
 129         return false;
 130     }
 131     let ty_params = cx.tcx.mk_substs(ty_params.iter());
 132     cx.tcx.infer_ctxt().enter(|infcx| {
 133         infcx
 134             .type_implements_trait(trait_id, ty, ty_params, cx.param_env)
 135             .must_apply_modulo_regions()
 136     })
 137 }
 138
 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),
 143         None => false,
 144     }
 145 }
 146
 147 // Returns whether the type has #[must_use] attribute
 148 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
 149     match ty.kind() {
 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)
 156         },
 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() {
 162                         return true;
 163                     }
 164                 }
 165             }
 166             false
 167         },
 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() {
 172                         return true;
 173                     }
 174                 }
 175             }
 176             false
 177         },
 178         _ => false,
 179     }
 180 }
 181
 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 `normalize` method does not panic when normalization does
 184 // not succeed
 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())
 189 }
 190
 191 fn is_normalizable_helper<'tcx>(
 192     cx: &LateContext<'tcx>,
 193     param_env: ty::ParamEnv<'tcx>,
 194     ty: Ty<'tcx>,
 195     cache: &mut FxHashMap<Ty<'tcx>, bool>,
 196 ) -> bool {
 197     if let Some(&cached_result) = cache.get(ty) {
 198         return cached_result;
 199     }
 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() {
 205             match ty.kind() {
 206                 ty::Adt(def, substs) => def.variants.iter().all(|variant| {
 207                     variant
 208                         .fields
 209                         .iter()
 210                         .all(|field| is_normalizable_helper(cx, param_env, field.ty(cx.tcx, substs), cache))
 211                 }),
 212                 _ => ty.walk(cx.tcx).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)
 215                     },
 216                     _ => true, // if inner_ty == ty, we've already checked it
 217                 }),
 218             }
 219         } else {
 220             false
 221         }
 222     });
 223     cache.insert(ty, result);
 224     result
 225 }
 226
 227 /// Returns true iff the given type is a non aggregate primitive (a bool or char, any integer or
 228 /// floating-point number type). For checking aggregation of primitive types (e.g. tuples and slices
 229 /// of primitive type) see `is_recursively_primitive_type`
 230 pub fn is_non_aggregate_primitive_type(ty: Ty<'_>) -> bool {
 231     matches!(ty.kind(), ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_))
 232 }
 233
 234 /// Returns true iff the given type is a primitive (a bool or char, any integer or floating-point
 235 /// number type, a str, or an array, slice, or tuple of those types).
 236 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
 237     match ty.kind() {
 238         ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
 239         ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
 240         ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
 241         ty::Tuple(inner_types) => inner_types.types().all(is_recursively_primitive_type),
 242         _ => false,
 243     }
 244 }
 245
 246 /// Checks if the type is a reference equals to a diagnostic item
 247 pub fn is_type_ref_to_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
 248     match ty.kind() {
 249         ty::Ref(_, ref_ty, _) => match ref_ty.kind() {
 250             ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
 251             _ => false,
 252         },
 253         _ => false,
 254     }
 255 }
 256
 257 /// Checks if the type is equal to a diagnostic item
 258 ///
 259 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
 260 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
 261     match ty.kind() {
 262         ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did),
 263         _ => false,
 264     }
 265 }
 266
 267 /// Checks if the type is equal to a lang item.
 268 ///
 269 /// Returns `false` if the `LangItem` is not defined.
 270 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
 271     match ty.kind() {
 272         ty::Adt(adt, _) => cx.tcx.lang_items().require(lang_item).map_or(false, |li| li == adt.did),
 273         _ => false,
 274     }
 275 }
 276
 277 /// Return `true` if the passed `typ` is `isize` or `usize`.
 278 pub fn is_isize_or_usize(typ: Ty<'_>) -> bool {
 279     matches!(typ.kind(), ty::Int(IntTy::Isize) | ty::Uint(UintTy::Usize))
 280 }
 281
 282 /// Checks if type is struct, enum or union type with the given def path.
 283 ///
 284 /// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
 285 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
 286 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
 287     match ty.kind() {
 288         ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
 289         _ => false,
 290     }
 291 }
 292
 293 /// Peels off all references on the type. Returns the underlying type and the number of references
 294 /// removed.
 295 pub fn peel_mid_ty_refs(ty: Ty<'_>) -> (Ty<'_>, usize) {
 296     fn peel(ty: Ty<'_>, count: usize) -> (Ty<'_>, usize) {
 297         if let ty::Ref(_, ty, _) = ty.kind() {
 298             peel(ty, count + 1)
 299         } else {
 300             (ty, count)
 301         }
 302     }
 303     peel(ty, 0)
 304 }
 305
 306 /// Peels off all references on the type.Returns the underlying type, the number of references
 307 /// removed, and whether the pointer is ultimately mutable or not.
 308 pub fn peel_mid_ty_refs_is_mutable(ty: Ty<'_>) -> (Ty<'_>, usize, Mutability) {
 309     fn f(ty: Ty<'_>, count: usize, mutability: Mutability) -> (Ty<'_>, usize, Mutability) {
 310         match ty.kind() {
 311             ty::Ref(_, ty, Mutability::Mut) => f(ty, count + 1, mutability),
 312             ty::Ref(_, ty, Mutability::Not) => f(ty, count + 1, Mutability::Not),
 313             _ => (ty, count, mutability),
 314         }
 315     }
 316     f(ty, 0, Mutability::Mut)
 317 }
 318
 319 /// Returns `true` if the given type is an `unsafe` function.
 320 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
 321     match ty.kind() {
 322         ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
 323         _ => false,
 324     }
 325 }
 326
 327 /// Returns the base type for HIR references and pointers.
 328 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
 329     match ty.kind {
 330         TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(mut_ty.ty),
 331         _ => ty,
 332     }
 333 }
 334
 335 /// Returns the base type for references and raw pointers, and count reference
 336 /// depth.
 337 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
 338     fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
 339         match ty.kind() {
 340             ty::Ref(_, ty, _) => inner(ty, depth + 1),
 341             _ => (ty, depth),
 342         }
 343     }
 344     inner(ty, 0)
 345 }
 346
 347 /// Returns `true` if types `a` and `b` are same types having same `Const` generic args,
 348 /// otherwise returns `false`
 349 pub fn same_type_and_consts(a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
 350     match (&a.kind(), &b.kind()) {
 351         (&ty::Adt(did_a, substs_a), &ty::Adt(did_b, substs_b)) => {
 352             if did_a != did_b {
 353                 return false;
 354             }
 355
 356             substs_a
 357                 .iter()
 358                 .zip(substs_b.iter())
 359                 .all(|(arg_a, arg_b)| match (arg_a.unpack(), arg_b.unpack()) {
 360                     (GenericArgKind::Const(inner_a), GenericArgKind::Const(inner_b)) => inner_a == inner_b,
 361                     (GenericArgKind::Type(type_a), GenericArgKind::Type(type_b)) => {
 362                         same_type_and_consts(type_a, type_b)
 363                     },
 364                     _ => true,
 365                 })
 366         },
 367         _ => a == b,
 368     }
 369 }