src/tools/clippy/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, FxHashSet};
   7 use rustc_hir as hir;
   8 use rustc_hir::def::{CtorKind, DefKind, Res};
   9 use rustc_hir::def_id::DefId;
  10 use rustc_hir::{Expr, LangItem, TyKind, Unsafety};
  11 use rustc_infer::infer::TyCtxtInferExt;
  12 use rustc_lint::LateContext;
  13 use rustc_middle::mir::interpret::{ConstValue, Scalar};
  14 use rustc_middle::ty::subst::{GenericArg, GenericArgKind, Subst};
  15 use rustc_middle::ty::{
  16     self, AdtDef, Binder, FnSig, IntTy, ParamEnv, Predicate, PredicateKind, Ty, TyCtxt, TypeFoldable, UintTy,
  17     VariantDiscr,
  18 };
  19 use rustc_span::symbol::Ident;
  20 use rustc_span::{sym, Span, Symbol, DUMMY_SP};
  21 use rustc_target::abi::{Size, VariantIdx};
  22 use rustc_trait_selection::infer::InferCtxtExt;
  23 use rustc_trait_selection::traits::query::normalize::AtExt;
  24 use std::iter;
  25
  26 use crate::{match_def_path, path_res, paths};
  27
  28 // Checks if the given type implements copy.
  29 pub fn is_copy<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
  30     ty.is_copy_modulo_regions(cx.tcx.at(DUMMY_SP), cx.param_env)
  31 }
  32
  33 /// Checks whether a type can be partially moved.
  34 pub fn can_partially_move_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
  35     if has_drop(cx, ty) || is_copy(cx, ty) {
  36         return false;
  37     }
  38     match ty.kind() {
  39         ty::Param(_) => false,
  40         ty::Adt(def, subs) => def.all_fields().any(|f| !is_copy(cx, f.ty(cx.tcx, subs))),
  41         _ => true,
  42     }
  43 }
  44
  45 /// Walks into `ty` and returns `true` if any inner type is the same as `other_ty`
  46 pub fn contains_ty<'tcx>(ty: Ty<'tcx>, other_ty: Ty<'tcx>) -> bool {
  47     ty.walk().any(|inner| match inner.unpack() {
  48         GenericArgKind::Type(inner_ty) => other_ty == inner_ty,
  49         GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
  50     })
  51 }
  52
  53 /// Walks into `ty` and returns `true` if any inner type is an instance of the given adt
  54 /// constructor.
  55 pub fn contains_adt_constructor<'tcx>(ty: Ty<'tcx>, adt: AdtDef<'tcx>) -> bool {
  56     ty.walk().any(|inner| match inner.unpack() {
  57         GenericArgKind::Type(inner_ty) => inner_ty.ty_adt_def() == Some(adt),
  58         GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => false,
  59     })
  60 }
  61
  62 /// Resolves `<T as Iterator>::Item` for `T`
  63 /// Do not invoke without first verifying that the type implements `Iterator`
  64 pub fn get_iterator_item_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Option<Ty<'tcx>> {
  65     cx.tcx
  66         .get_diagnostic_item(sym::Iterator)
  67         .and_then(|iter_did| get_associated_type(cx, ty, iter_did, "Item"))
  68 }
  69
  70 /// Returns the associated type `name` for `ty` as an implementation of `trait_id`.
  71 /// Do not invoke without first verifying that the type implements the trait.
  72 pub fn get_associated_type<'tcx>(
  73     cx: &LateContext<'tcx>,
  74     ty: Ty<'tcx>,
  75     trait_id: DefId,
  76     name: &str,
  77 ) -> Option<Ty<'tcx>> {
  78     cx.tcx
  79         .associated_items(trait_id)
  80         .find_by_name_and_kind(cx.tcx, Ident::from_str(name), ty::AssocKind::Type, trait_id)
  81         .map(|assoc| {
  82             let proj = cx.tcx.mk_projection(assoc.def_id, cx.tcx.mk_substs_trait(ty, &[]));
  83             cx.tcx.normalize_erasing_regions(cx.param_env, proj)
  84         })
  85 }
  86
  87 /// Get the diagnostic name of a type, e.g. `sym::HashMap`. To check if a type
  88 /// implements a trait marked with a diagnostic item use [`implements_trait`].
  89 ///
  90 /// For a further exploitation what diagnostic items are see [diagnostic items] in
  91 /// rustc-dev-guide.
  92 ///
  93 /// [Diagnostic Items]: https://rustc-dev-guide.rust-lang.org/diagnostics/diagnostic-items.html
  94 pub fn get_type_diagnostic_name(cx: &LateContext<'_>, ty: Ty<'_>) -> Option<Symbol> {
  95     match ty.kind() {
  96         ty::Adt(adt, _) => cx.tcx.get_diagnostic_name(adt.did()),
  97         _ => None,
  98     }
  99 }
 100
 101 /// Returns true if ty has `iter` or `iter_mut` methods
 102 pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option<Symbol> {
 103     // FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
 104     // exists and has the desired signature. Unfortunately FnCtxt is not exported
 105     // so we can't use its `lookup_method` method.
 106     let into_iter_collections: &[Symbol] = &[
 107         sym::Vec,
 108         sym::Option,
 109         sym::Result,
 110         sym::BTreeMap,
 111         sym::BTreeSet,
 112         sym::VecDeque,
 113         sym::LinkedList,
 114         sym::BinaryHeap,
 115         sym::HashSet,
 116         sym::HashMap,
 117         sym::PathBuf,
 118         sym::Path,
 119         sym::Receiver,
 120     ];
 121
 122     let ty_to_check = match probably_ref_ty.kind() {
 123         ty::Ref(_, ty_to_check, _) => *ty_to_check,
 124         _ => probably_ref_ty,
 125     };
 126
 127     let def_id = match ty_to_check.kind() {
 128         ty::Array(..) => return Some(sym::array),
 129         ty::Slice(..) => return Some(sym::slice),
 130         ty::Adt(adt, _) => adt.did(),
 131         _ => return None,
 132     };
 133
 134     for &name in into_iter_collections {
 135         if cx.tcx.is_diagnostic_item(name, def_id) {
 136             return Some(cx.tcx.item_name(def_id));
 137         }
 138     }
 139     None
 140 }
 141
 142 /// Checks whether a type implements a trait.
 143 /// The function returns false in case the type contains an inference variable.
 144 ///
 145 /// See:
 146 /// * [`get_trait_def_id`](super::get_trait_def_id) to get a trait [`DefId`].
 147 /// * [Common tools for writing lints] for an example how to use this function and other options.
 148 ///
 149 /// [Common tools for writing lints]: https://github.com/rust-lang/rust-clippy/blob/master/doc/common_tools_writing_lints.md#checking-if-a-type-implements-a-specific-trait
 150 pub fn implements_trait<'tcx>(
 151     cx: &LateContext<'tcx>,
 152     ty: Ty<'tcx>,
 153     trait_id: DefId,
 154     ty_params: &[GenericArg<'tcx>],
 155 ) -> bool {
 156     implements_trait_with_env(cx.tcx, cx.param_env, ty, trait_id, ty_params)
 157 }
 158
 159 /// Same as `implements_trait` but allows using a `ParamEnv` different from the lint context.
 160 pub fn implements_trait_with_env<'tcx>(
 161     tcx: TyCtxt<'tcx>,
 162     param_env: ParamEnv<'tcx>,
 163     ty: Ty<'tcx>,
 164     trait_id: DefId,
 165     ty_params: &[GenericArg<'tcx>],
 166 ) -> bool {
 167     // Clippy shouldn't have infer types
 168     assert!(!ty.needs_infer());
 169
 170     let ty = tcx.erase_regions(ty);
 171     if ty.has_escaping_bound_vars() {
 172         return false;
 173     }
 174     let ty_params = tcx.mk_substs(ty_params.iter());
 175     tcx.infer_ctxt().enter(|infcx| {
 176         infcx
 177             .type_implements_trait(trait_id, ty, ty_params, param_env)
 178             .must_apply_modulo_regions()
 179     })
 180 }
 181
 182 /// Checks whether this type implements `Drop`.
 183 pub fn has_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
 184     match ty.ty_adt_def() {
 185         Some(def) => def.has_dtor(cx.tcx),
 186         None => false,
 187     }
 188 }
 189
 190 // Returns whether the type has #[must_use] attribute
 191 pub fn is_must_use_ty<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
 192     match ty.kind() {
 193         ty::Adt(adt, _) => cx.tcx.has_attr(adt.did(), sym::must_use),
 194         ty::Foreign(did) => cx.tcx.has_attr(*did, sym::must_use),
 195         ty::Slice(ty) | ty::Array(ty, _) | ty::RawPtr(ty::TypeAndMut { ty, .. }) | ty::Ref(_, ty, _) => {
 196             // for the Array case we don't need to care for the len == 0 case
 197             // because we don't want to lint functions returning empty arrays
 198             is_must_use_ty(cx, *ty)
 199         },
 200         ty::Tuple(substs) => substs.iter().any(|ty| is_must_use_ty(cx, ty)),
 201         ty::Opaque(def_id, _) => {
 202             for (predicate, _) in cx.tcx.explicit_item_bounds(*def_id) {
 203                 if let ty::PredicateKind::Trait(trait_predicate) = predicate.kind().skip_binder() {
 204                     if cx.tcx.has_attr(trait_predicate.trait_ref.def_id, sym::must_use) {
 205                         return true;
 206                     }
 207                 }
 208             }
 209             false
 210         },
 211         ty::Dynamic(binder, _) => {
 212             for predicate in binder.iter() {
 213                 if let ty::ExistentialPredicate::Trait(ref trait_ref) = predicate.skip_binder() {
 214                     if cx.tcx.has_attr(trait_ref.def_id, sym::must_use) {
 215                         return true;
 216                     }
 217                 }
 218             }
 219             false
 220         },
 221         _ => false,
 222     }
 223 }
 224
 225 // FIXME: Per https://doc.rust-lang.org/nightly/nightly-rustc/rustc_trait_selection/infer/at/struct.At.html#method.normalize
 226 // this function can be removed once the `normalize` method does not panic when normalization does
 227 // not succeed
 228 /// Checks if `Ty` is normalizable. This function is useful
 229 /// to avoid crashes on `layout_of`.
 230 pub fn is_normalizable<'tcx>(cx: &LateContext<'tcx>, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tcx>) -> bool {
 231     is_normalizable_helper(cx, param_env, ty, &mut FxHashMap::default())
 232 }
 233
 234 fn is_normalizable_helper<'tcx>(
 235     cx: &LateContext<'tcx>,
 236     param_env: ty::ParamEnv<'tcx>,
 237     ty: Ty<'tcx>,
 238     cache: &mut FxHashMap<Ty<'tcx>, bool>,
 239 ) -> bool {
 240     if let Some(&cached_result) = cache.get(&ty) {
 241         return cached_result;
 242     }
 243     // prevent recursive loops, false-negative is better than endless loop leading to stack overflow
 244     cache.insert(ty, false);
 245     let result = cx.tcx.infer_ctxt().enter(|infcx| {
 246         let cause = rustc_middle::traits::ObligationCause::dummy();
 247         if infcx.at(&cause, param_env).normalize(ty).is_ok() {
 248             match ty.kind() {
 249                 ty::Adt(def, substs) => def.variants().iter().all(|variant| {
 250                     variant
 251                         .fields
 252                         .iter()
 253                         .all(|field| is_normalizable_helper(cx, param_env, field.ty(cx.tcx, substs), cache))
 254                 }),
 255                 _ => ty.walk().all(|generic_arg| match generic_arg.unpack() {
 256                     GenericArgKind::Type(inner_ty) if inner_ty != ty => {
 257                         is_normalizable_helper(cx, param_env, inner_ty, cache)
 258                     },
 259                     _ => true, // if inner_ty == ty, we've already checked it
 260                 }),
 261             }
 262         } else {
 263             false
 264         }
 265     });
 266     cache.insert(ty, result);
 267     result
 268 }
 269
 270 /// Returns `true` if the given type is a non aggregate primitive (a `bool` or `char`, any
 271 /// integer or floating-point number type). For checking aggregation of primitive types (e.g.
 272 /// tuples and slices of primitive type) see `is_recursively_primitive_type`
 273 pub fn is_non_aggregate_primitive_type(ty: Ty<'_>) -> bool {
 274     matches!(ty.kind(), ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_))
 275 }
 276
 277 /// Returns `true` if the given type is a primitive (a `bool` or `char`, any integer or
 278 /// floating-point number type, a `str`, or an array, slice, or tuple of those types).
 279 pub fn is_recursively_primitive_type(ty: Ty<'_>) -> bool {
 280     match *ty.kind() {
 281         ty::Bool | ty::Char | ty::Int(_) | ty::Uint(_) | ty::Float(_) | ty::Str => true,
 282         ty::Ref(_, inner, _) if *inner.kind() == ty::Str => true,
 283         ty::Array(inner_type, _) | ty::Slice(inner_type) => is_recursively_primitive_type(inner_type),
 284         ty::Tuple(inner_types) => inner_types.iter().all(is_recursively_primitive_type),
 285         _ => false,
 286     }
 287 }
 288
 289 /// Checks if the type is a reference equals to a diagnostic item
 290 pub fn is_type_ref_to_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
 291     match ty.kind() {
 292         ty::Ref(_, ref_ty, _) => match ref_ty.kind() {
 293             ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did()),
 294             _ => false,
 295         },
 296         _ => false,
 297     }
 298 }
 299
 300 /// Checks if the type is equal to a diagnostic item. To check if a type implements a
 301 /// trait marked with a diagnostic item use [`implements_trait`].
 302 ///
 303 /// For a further exploitation what diagnostic items are see [diagnostic items] in
 304 /// rustc-dev-guide.
 305 ///
 306 /// ---
 307 ///
 308 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
 309 ///
 310 /// [Diagnostic Items]: https://rustc-dev-guide.rust-lang.org/diagnostics/diagnostic-items.html
 311 pub fn is_type_diagnostic_item(cx: &LateContext<'_>, ty: Ty<'_>, diag_item: Symbol) -> bool {
 312     match ty.kind() {
 313         ty::Adt(adt, _) => cx.tcx.is_diagnostic_item(diag_item, adt.did()),
 314         _ => false,
 315     }
 316 }
 317
 318 /// Checks if the type is equal to a lang item.
 319 ///
 320 /// Returns `false` if the `LangItem` is not defined.
 321 pub fn is_type_lang_item(cx: &LateContext<'_>, ty: Ty<'_>, lang_item: hir::LangItem) -> bool {
 322     match ty.kind() {
 323         ty::Adt(adt, _) => cx
 324             .tcx
 325             .lang_items()
 326             .require(lang_item)
 327             .map_or(false, |li| li == adt.did()),
 328         _ => false,
 329     }
 330 }
 331
 332 /// Return `true` if the passed `typ` is `isize` or `usize`.
 333 pub fn is_isize_or_usize(typ: Ty<'_>) -> bool {
 334     matches!(typ.kind(), ty::Int(IntTy::Isize) | ty::Uint(UintTy::Usize))
 335 }
 336
 337 /// Checks if type is struct, enum or union type with the given def path.
 338 ///
 339 /// If the type is a diagnostic item, use `is_type_diagnostic_item` instead.
 340 /// If you change the signature, remember to update the internal lint `MatchTypeOnDiagItem`
 341 pub fn match_type(cx: &LateContext<'_>, ty: Ty<'_>, path: &[&str]) -> bool {
 342     match ty.kind() {
 343         ty::Adt(adt, _) => match_def_path(cx, adt.did(), path),
 344         _ => false,
 345     }
 346 }
 347
 348 /// Checks if the drop order for a type matters. Some std types implement drop solely to
 349 /// deallocate memory. For these types, and composites containing them, changing the drop order
 350 /// won't result in any observable side effects.
 351 pub fn needs_ordered_drop<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
 352     fn needs_ordered_drop_inner<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, seen: &mut FxHashSet<Ty<'tcx>>) -> bool {
 353         if !seen.insert(ty) {
 354             return false;
 355         }
 356         if !ty.has_significant_drop(cx.tcx, cx.param_env) {
 357             false
 358         }
 359         // Check for std types which implement drop, but only for memory allocation.
 360         else if is_type_lang_item(cx, ty, LangItem::OwnedBox)
 361             || matches!(
 362                 get_type_diagnostic_name(cx, ty),
 363                 Some(sym::HashSet | sym::Rc | sym::Arc | sym::cstring_type)
 364             )
 365             || match_type(cx, ty, &paths::WEAK_RC)
 366             || match_type(cx, ty, &paths::WEAK_ARC)
 367         {
 368             // Check all of the generic arguments.
 369             if let ty::Adt(_, subs) = ty.kind() {
 370                 subs.types().any(|ty| needs_ordered_drop_inner(cx, ty, seen))
 371             } else {
 372                 true
 373             }
 374         } else if !cx
 375             .tcx
 376             .lang_items()
 377             .drop_trait()
 378             .map_or(false, |id| implements_trait(cx, ty, id, &[]))
 379         {
 380             // This type doesn't implement drop, so no side effects here.
 381             // Check if any component type has any.
 382             match ty.kind() {
 383                 ty::Tuple(fields) => fields.iter().any(|ty| needs_ordered_drop_inner(cx, ty, seen)),
 384                 ty::Array(ty, _) => needs_ordered_drop_inner(cx, *ty, seen),
 385                 ty::Adt(adt, subs) => adt
 386                     .all_fields()
 387                     .map(|f| f.ty(cx.tcx, subs))
 388                     .any(|ty| needs_ordered_drop_inner(cx, ty, seen)),
 389                 _ => true,
 390             }
 391         } else {
 392             true
 393         }
 394     }
 395
 396     needs_ordered_drop_inner(cx, ty, &mut FxHashSet::default())
 397 }
 398
 399 /// Peels off all references on the type. Returns the underlying type and the number of references
 400 /// removed.
 401 pub fn peel_mid_ty_refs(ty: Ty<'_>) -> (Ty<'_>, usize) {
 402     fn peel(ty: Ty<'_>, count: usize) -> (Ty<'_>, usize) {
 403         if let ty::Ref(_, ty, _) = ty.kind() {
 404             peel(*ty, count + 1)
 405         } else {
 406             (ty, count)
 407         }
 408     }
 409     peel(ty, 0)
 410 }
 411
 412 /// Peels off all references on the type.Returns the underlying type, the number of references
 413 /// removed, and whether the pointer is ultimately mutable or not.
 414 pub fn peel_mid_ty_refs_is_mutable(ty: Ty<'_>) -> (Ty<'_>, usize, Mutability) {
 415     fn f(ty: Ty<'_>, count: usize, mutability: Mutability) -> (Ty<'_>, usize, Mutability) {
 416         match ty.kind() {
 417             ty::Ref(_, ty, Mutability::Mut) => f(*ty, count + 1, mutability),
 418             ty::Ref(_, ty, Mutability::Not) => f(*ty, count + 1, Mutability::Not),
 419             _ => (ty, count, mutability),
 420         }
 421     }
 422     f(ty, 0, Mutability::Mut)
 423 }
 424
 425 /// Returns `true` if the given type is an `unsafe` function.
 426 pub fn type_is_unsafe_function<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
 427     match ty.kind() {
 428         ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
 429         _ => false,
 430     }
 431 }
 432
 433 /// Returns the base type for HIR references and pointers.
 434 pub fn walk_ptrs_hir_ty<'tcx>(ty: &'tcx hir::Ty<'tcx>) -> &'tcx hir::Ty<'tcx> {
 435     match ty.kind {
 436         TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(mut_ty.ty),
 437         _ => ty,
 438     }
 439 }
 440
 441 /// Returns the base type for references and raw pointers, and count reference
 442 /// depth.
 443 pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
 444     fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
 445         match ty.kind() {
 446             ty::Ref(_, ty, _) => inner(*ty, depth + 1),
 447             _ => (ty, depth),
 448         }
 449     }
 450     inner(ty, 0)
 451 }
 452
 453 /// Returns `true` if types `a` and `b` are same types having same `Const` generic args,
 454 /// otherwise returns `false`
 455 pub fn same_type_and_consts<'tcx>(a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
 456     match (&a.kind(), &b.kind()) {
 457         (&ty::Adt(did_a, substs_a), &ty::Adt(did_b, substs_b)) => {
 458             if did_a != did_b {
 459                 return false;
 460             }
 461
 462             substs_a
 463                 .iter()
 464                 .zip(substs_b.iter())
 465                 .all(|(arg_a, arg_b)| match (arg_a.unpack(), arg_b.unpack()) {
 466                     (GenericArgKind::Const(inner_a), GenericArgKind::Const(inner_b)) => inner_a == inner_b,
 467                     (GenericArgKind::Type(type_a), GenericArgKind::Type(type_b)) => {
 468                         same_type_and_consts(type_a, type_b)
 469                     },
 470                     _ => true,
 471                 })
 472         },
 473         _ => a == b,
 474     }
 475 }
 476
 477 /// Checks if a given type looks safe to be uninitialized.
 478 pub fn is_uninit_value_valid_for_ty(cx: &LateContext<'_>, ty: Ty<'_>) -> bool {
 479     match *ty.kind() {
 480         ty::Array(component, _) => is_uninit_value_valid_for_ty(cx, component),
 481         ty::Tuple(types) => types.iter().all(|ty| is_uninit_value_valid_for_ty(cx, ty)),
 482         ty::Adt(adt, _) => cx.tcx.lang_items().maybe_uninit() == Some(adt.did()),
 483         _ => false,
 484     }
 485 }
 486
 487 /// Gets an iterator over all predicates which apply to the given item.
 488 pub fn all_predicates_of(tcx: TyCtxt<'_>, id: DefId) -> impl Iterator<Item = &(Predicate<'_>, Span)> {
 489     let mut next_id = Some(id);
 490     iter::from_fn(move || {
 491         next_id.take().map(|id| {
 492             let preds = tcx.predicates_of(id);
 493             next_id = preds.parent;
 494             preds.predicates.iter()
 495         })
 496     })
 497     .flatten()
 498 }
 499
 500 /// A signature for a function like type.
 501 #[derive(Clone, Copy)]
 502 pub enum ExprFnSig<'tcx> {
 503     Sig(Binder<'tcx, FnSig<'tcx>>),
 504     Closure(Binder<'tcx, FnSig<'tcx>>),
 505     Trait(Binder<'tcx, Ty<'tcx>>, Option<Binder<'tcx, Ty<'tcx>>>),
 506 }
 507 impl<'tcx> ExprFnSig<'tcx> {
 508     /// Gets the argument type at the given offset.
 509     pub fn input(self, i: usize) -> Binder<'tcx, Ty<'tcx>> {
 510         match self {
 511             Self::Sig(sig) => sig.input(i),
 512             Self::Closure(sig) => sig.input(0).map_bound(|ty| ty.tuple_fields()[i]),
 513             Self::Trait(inputs, _) => inputs.map_bound(|ty| ty.tuple_fields()[i]),
 514         }
 515     }
 516
 517     /// Gets the result type, if one could be found. Note that the result type of a trait may not be
 518     /// specified.
 519     pub fn output(self) -> Option<Binder<'tcx, Ty<'tcx>>> {
 520         match self {
 521             Self::Sig(sig) | Self::Closure(sig) => Some(sig.output()),
 522             Self::Trait(_, output) => output,
 523         }
 524     }
 525 }
 526
 527 /// If the expression is function like, get the signature for it.
 528 pub fn expr_sig<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) -> Option<ExprFnSig<'tcx>> {
 529     if let Res::Def(DefKind::Fn | DefKind::Ctor(_, CtorKind::Fn) | DefKind::AssocFn, id) = path_res(cx, expr) {
 530         Some(ExprFnSig::Sig(cx.tcx.fn_sig(id)))
 531     } else {
 532         let ty = cx.typeck_results().expr_ty_adjusted(expr).peel_refs();
 533         match *ty.kind() {
 534             ty::Closure(_, subs) => Some(ExprFnSig::Closure(subs.as_closure().sig())),
 535             ty::FnDef(id, subs) => Some(ExprFnSig::Sig(cx.tcx.bound_fn_sig(id).subst(cx.tcx, subs))),
 536             ty::FnPtr(sig) => Some(ExprFnSig::Sig(sig)),
 537             ty::Dynamic(bounds, _) => {
 538                 let lang_items = cx.tcx.lang_items();
 539                 match bounds.principal() {
 540                     Some(bound)
 541                         if Some(bound.def_id()) == lang_items.fn_trait()
 542                             || Some(bound.def_id()) == lang_items.fn_once_trait()
 543                             || Some(bound.def_id()) == lang_items.fn_mut_trait() =>
 544                     {
 545                         let output = bounds
 546                             .projection_bounds()
 547                             .find(|p| lang_items.fn_once_output().map_or(false, |id| id == p.item_def_id()))
 548                             .map(|p| p.map_bound(|p| p.term.ty().expect("return type was a const")));
 549                         Some(ExprFnSig::Trait(bound.map_bound(|b| b.substs.type_at(0)), output))
 550                     },
 551                     _ => None,
 552                 }
 553             },
 554             ty::Param(_) | ty::Projection(..) => {
 555                 let mut inputs = None;
 556                 let mut output = None;
 557                 let lang_items = cx.tcx.lang_items();
 558
 559                 for (pred, _) in all_predicates_of(cx.tcx, cx.typeck_results().hir_owner.to_def_id()) {
 560                     let mut is_input = false;
 561                     if let Some(ty) = pred
 562                         .kind()
 563                         .map_bound(|pred| match pred {
 564                             PredicateKind::Trait(p)
 565                                 if (lang_items.fn_trait() == Some(p.def_id())
 566                                     || lang_items.fn_mut_trait() == Some(p.def_id())
 567                                     || lang_items.fn_once_trait() == Some(p.def_id()))
 568                                     && p.self_ty() == ty =>
 569                             {
 570                                 is_input = true;
 571                                 Some(p.trait_ref.substs.type_at(1))
 572                             },
 573                             PredicateKind::Projection(p)
 574                                 if Some(p.projection_ty.item_def_id) == lang_items.fn_once_output()
 575                                     && p.projection_ty.self_ty() == ty =>
 576                             {
 577                                 is_input = false;
 578                                 p.term.ty()
 579                             },
 580                             _ => None,
 581                         })
 582                         .transpose()
 583                     {
 584                         if is_input && inputs.is_none() {
 585                             inputs = Some(ty);
 586                         } else if !is_input && output.is_none() {
 587                             output = Some(ty);
 588                         } else {
 589                             // Multiple different fn trait impls. Is this even allowed?
 590                             return None;
 591                         }
 592                     }
 593                 }
 594
 595                 inputs.map(|ty| ExprFnSig::Trait(ty, output))
 596             },
 597             _ => None,
 598         }
 599     }
 600 }
 601
 602 #[derive(Clone, Copy)]
 603 pub enum EnumValue {
 604     Unsigned(u128),
 605     Signed(i128),
 606 }
 607 impl core::ops::Add<u32> for EnumValue {
 608     type Output = Self;
 609     fn add(self, n: u32) -> Self::Output {
 610         match self {
 611             Self::Unsigned(x) => Self::Unsigned(x + u128::from(n)),
 612             Self::Signed(x) => Self::Signed(x + i128::from(n)),
 613         }
 614     }
 615 }
 616
 617 /// Attempts to read the given constant as though it were an an enum value.
 618 #[expect(clippy::cast_possible_truncation, clippy::cast_possible_wrap)]
 619 pub fn read_explicit_enum_value(tcx: TyCtxt<'_>, id: DefId) -> Option<EnumValue> {
 620     if let Ok(ConstValue::Scalar(Scalar::Int(value))) = tcx.const_eval_poly(id) {
 621         match tcx.type_of(id).kind() {
 622             ty::Int(_) => Some(EnumValue::Signed(match value.size().bytes() {
 623                 1 => i128::from(value.assert_bits(Size::from_bytes(1)) as u8 as i8),
 624                 2 => i128::from(value.assert_bits(Size::from_bytes(2)) as u16 as i16),
 625                 4 => i128::from(value.assert_bits(Size::from_bytes(4)) as u32 as i32),
 626                 8 => i128::from(value.assert_bits(Size::from_bytes(8)) as u64 as i64),
 627                 16 => value.assert_bits(Size::from_bytes(16)) as i128,
 628                 _ => return None,
 629             })),
 630             ty::Uint(_) => Some(EnumValue::Unsigned(match value.size().bytes() {
 631                 1 => value.assert_bits(Size::from_bytes(1)),
 632                 2 => value.assert_bits(Size::from_bytes(2)),
 633                 4 => value.assert_bits(Size::from_bytes(4)),
 634                 8 => value.assert_bits(Size::from_bytes(8)),
 635                 16 => value.assert_bits(Size::from_bytes(16)),
 636                 _ => return None,
 637             })),
 638             _ => None,
 639         }
 640     } else {
 641         None
 642     }
 643 }
 644
 645 /// Gets the value of the given variant.
 646 pub fn get_discriminant_value(tcx: TyCtxt<'_>, adt: AdtDef<'_>, i: VariantIdx) -> EnumValue {
 647     let variant = &adt.variant(i);
 648     match variant.discr {
 649         VariantDiscr::Explicit(id) => read_explicit_enum_value(tcx, id).unwrap(),
 650         VariantDiscr::Relative(x) => match adt.variant((i.as_usize() - x as usize).into()).discr {
 651             VariantDiscr::Explicit(id) => read_explicit_enum_value(tcx, id).unwrap() + x,
 652             VariantDiscr::Relative(_) => EnumValue::Unsigned(x.into()),
 653         },
 654     }
 655 }
 656
 657 /// Check if the given type is either `core::ffi::c_void`, `std::os::raw::c_void`, or one of the
 658 /// platform specific `libc::<platform>::c_void` types in libc.
 659 pub fn is_c_void(cx: &LateContext<'_>, ty: Ty<'_>) -> bool {
 660     if let ty::Adt(adt, _) = ty.kind()
 661         && let &[krate, .., name] = &*cx.get_def_path(adt.did())
 662         && let sym::libc | sym::core | sym::std = krate
 663         && name.as_str() == "c_void"
 664     {
 665         true
 666     } else {
 667         false
 668     }
 669 }