crates/hir_ty/src/lib.rs

   1 //! The type system. We currently use this to infer types for completion, hover
   2 //! information and various assists.
   3
   4 #[allow(unused)]
   5 macro_rules! eprintln {
   6     ($($tt:tt)*) => { stdx::eprintln!($($tt)*) };
   7 }
   8
   9 mod autoderef;
  10 mod builder;
  11 mod chalk_db;
  12 mod chalk_ext;
  13 mod infer;
  14 mod interner;
  15 mod lower;
  16 mod mapping;
  17 mod op;
  18 mod tls;
  19 mod utils;
  20 mod walk;
  21 pub mod db;
  22 pub mod diagnostics;
  23 pub mod display;
  24 pub mod method_resolution;
  25 pub mod primitive;
  26 pub mod traits;
  27
  28 #[cfg(test)]
  29 mod tests;
  30 #[cfg(test)]
  31 mod test_db;
  32
  33 use std::sync::Arc;
  34
  35 use chalk_ir::{
  36     fold::{Fold, Shift},
  37     interner::HasInterner,
  38     UintTy,
  39 };
  40 use hir_def::{expr::ExprId, type_ref::Rawness, TypeParamId};
  41
  42 use crate::{db::HirDatabase, display::HirDisplay, utils::generics};
  43
  44 pub use autoderef::autoderef;
  45 pub use builder::TyBuilder;
  46 pub use chalk_ext::*;
  47 pub use infer::{could_unify, InferenceResult};
  48 pub use interner::Interner;
  49 pub use lower::{
  50     associated_type_shorthand_candidates, callable_item_sig, CallableDefId, ImplTraitLoweringMode,
  51     TyDefId, TyLoweringContext, ValueTyDefId,
  52 };
  53 pub use mapping::{
  54     const_from_placeholder_idx, from_assoc_type_id, from_chalk_trait_id, from_foreign_def_id,
  55     from_placeholder_idx, lt_from_placeholder_idx, to_assoc_type_id, to_chalk_trait_id,
  56     to_foreign_def_id, to_placeholder_idx,
  57 };
  58 pub use traits::TraitEnvironment;
  59 pub use utils::all_super_traits;
  60 pub use walk::TypeWalk;
  61
  62 pub use chalk_ir::{
  63     cast::Cast, AdtId, BoundVar, DebruijnIndex, Mutability, Safety, Scalar, TyVariableKind,
  64 };
  65
  66 pub type ForeignDefId = chalk_ir::ForeignDefId<Interner>;
  67 pub type AssocTypeId = chalk_ir::AssocTypeId<Interner>;
  68 pub type FnDefId = chalk_ir::FnDefId<Interner>;
  69 pub type ClosureId = chalk_ir::ClosureId<Interner>;
  70 pub type OpaqueTyId = chalk_ir::OpaqueTyId<Interner>;
  71 pub type PlaceholderIndex = chalk_ir::PlaceholderIndex;
  72
  73 pub type VariableKind = chalk_ir::VariableKind<Interner>;
  74 pub type VariableKinds = chalk_ir::VariableKinds<Interner>;
  75 pub type CanonicalVarKinds = chalk_ir::CanonicalVarKinds<Interner>;
  76 pub type Binders<T> = chalk_ir::Binders<T>;
  77 pub type Substitution = chalk_ir::Substitution<Interner>;
  78 pub type GenericArg = chalk_ir::GenericArg<Interner>;
  79 pub type GenericArgData = chalk_ir::GenericArgData<Interner>;
  80
  81 pub type Ty = chalk_ir::Ty<Interner>;
  82 pub type TyKind = chalk_ir::TyKind<Interner>;
  83 pub type DynTy = chalk_ir::DynTy<Interner>;
  84 pub type FnPointer = chalk_ir::FnPointer<Interner>;
  85 // pub type FnSubst = chalk_ir::FnSubst<Interner>;
  86 pub use chalk_ir::FnSubst;
  87 pub type ProjectionTy = chalk_ir::ProjectionTy<Interner>;
  88 pub type AliasTy = chalk_ir::AliasTy<Interner>;
  89 pub type OpaqueTy = chalk_ir::OpaqueTy<Interner>;
  90 pub type InferenceVar = chalk_ir::InferenceVar;
  91
  92 pub type Lifetime = chalk_ir::Lifetime<Interner>;
  93 pub type LifetimeData = chalk_ir::LifetimeData<Interner>;
  94 pub type LifetimeOutlives = chalk_ir::LifetimeOutlives<Interner>;
  95
  96 pub type Const = chalk_ir::Const<Interner>;
  97 pub type ConstData = chalk_ir::ConstData<Interner>;
  98 pub type ConstValue = chalk_ir::ConstValue<Interner>;
  99 pub type ConcreteConst = chalk_ir::ConcreteConst<Interner>;
 100
 101 pub type ChalkTraitId = chalk_ir::TraitId<Interner>;
 102 pub type TraitRef = chalk_ir::TraitRef<Interner>;
 103 pub type QuantifiedWhereClause = Binders<WhereClause>;
 104 pub type QuantifiedWhereClauses = chalk_ir::QuantifiedWhereClauses<Interner>;
 105 pub type Canonical<T> = chalk_ir::Canonical<T>;
 106
 107 pub type FnSig = chalk_ir::FnSig<Interner>;
 108
 109 pub type InEnvironment<T> = chalk_ir::InEnvironment<T>;
 110 pub type DomainGoal = chalk_ir::DomainGoal<Interner>;
 111 pub type AliasEq = chalk_ir::AliasEq<Interner>;
 112 pub type Solution = chalk_solve::Solution<Interner>;
 113 pub type ConstrainedSubst = chalk_ir::ConstrainedSubst<Interner>;
 114 pub type Guidance = chalk_solve::Guidance<Interner>;
 115 pub type WhereClause = chalk_ir::WhereClause<Interner>;
 116
 117 // FIXME: get rid of this
 118 pub fn subst_prefix(s: &Substitution, n: usize) -> Substitution {
 119     Substitution::from_iter(
 120         &Interner,
 121         s.as_slice(&Interner)[..std::cmp::min(s.len(&Interner), n)].iter().cloned(),
 122     )
 123 }
 124
 125 /// Return an index of a parameter in the generic type parameter list by it's id.
 126 pub fn param_idx(db: &dyn HirDatabase, id: TypeParamId) -> Option<usize> {
 127     generics(db.upcast(), id.parent).param_idx(id)
 128 }
 129
 130 pub(crate) fn wrap_empty_binders<T>(value: T) -> Binders<T>
 131 where
 132     T: Fold<Interner, Result = T> + HasInterner<Interner = Interner>,
 133 {
 134     Binders::empty(&Interner, value.shifted_in_from(&Interner, DebruijnIndex::ONE))
 135 }
 136
 137 pub(crate) fn make_only_type_binders<T: HasInterner<Interner = Interner>>(
 138     num_vars: usize,
 139     value: T,
 140 ) -> Binders<T> {
 141     Binders::new(
 142         VariableKinds::from_iter(
 143             &Interner,
 144             std::iter::repeat(chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General))
 145                 .take(num_vars),
 146         ),
 147         value,
 148     )
 149 }
 150
 151 // FIXME: get rid of this
 152 pub fn make_canonical<T: HasInterner<Interner = Interner>>(
 153     value: T,
 154     kinds: impl IntoIterator<Item = TyVariableKind>,
 155 ) -> Canonical<T> {
 156     let kinds = kinds.into_iter().map(|tk| {
 157         chalk_ir::CanonicalVarKind::new(
 158             chalk_ir::VariableKind::Ty(tk),
 159             chalk_ir::UniverseIndex::ROOT,
 160         )
 161     });
 162     Canonical { value, binders: chalk_ir::CanonicalVarKinds::from_iter(&Interner, kinds) }
 163 }
 164
 165 /// A function signature as seen by type inference: Several parameter types and
 166 /// one return type.
 167 #[derive(Clone, PartialEq, Eq, Debug)]
 168 pub struct CallableSig {
 169     params_and_return: Arc<[Ty]>,
 170     is_varargs: bool,
 171 }
 172
 173 has_interner!(CallableSig);
 174
 175 /// A polymorphic function signature.
 176 pub type PolyFnSig = Binders<CallableSig>;
 177
 178 impl CallableSig {
 179     pub fn from_params_and_return(mut params: Vec<Ty>, ret: Ty, is_varargs: bool) -> CallableSig {
 180         params.push(ret);
 181         CallableSig { params_and_return: params.into(), is_varargs }
 182     }
 183
 184     pub fn from_fn_ptr(fn_ptr: &FnPointer) -> CallableSig {
 185         CallableSig {
 186             // FIXME: what to do about lifetime params? -> return PolyFnSig
 187             params_and_return: fn_ptr
 188                 .substitution
 189                 .clone()
 190                 .shifted_out_to(&Interner, DebruijnIndex::ONE)
 191                 .expect("unexpected lifetime vars in fn ptr")
 192                 .0
 193                 .as_slice(&Interner)
 194                 .iter()
 195                 .map(|arg| arg.assert_ty_ref(&Interner).clone())
 196                 .collect(),
 197             is_varargs: fn_ptr.sig.variadic,
 198         }
 199     }
 200
 201     pub fn params(&self) -> &[Ty] {
 202         &self.params_and_return[0..self.params_and_return.len() - 1]
 203     }
 204
 205     pub fn ret(&self) -> &Ty {
 206         &self.params_and_return[self.params_and_return.len() - 1]
 207     }
 208 }
 209
 210 impl Fold<Interner> for CallableSig {
 211     type Result = CallableSig;
 212
 213     fn fold_with<'i>(
 214         self,
 215         folder: &mut dyn chalk_ir::fold::Folder<'i, Interner>,
 216         outer_binder: DebruijnIndex,
 217     ) -> chalk_ir::Fallible<Self::Result>
 218     where
 219         Interner: 'i,
 220     {
 221         let vec = self.params_and_return.to_vec();
 222         let folded = vec.fold_with(folder, outer_binder)?;
 223         Ok(CallableSig { params_and_return: folded.into(), is_varargs: self.is_varargs })
 224     }
 225 }
 226
 227 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
 228 pub enum ImplTraitId {
 229     ReturnTypeImplTrait(hir_def::FunctionId, u16),
 230     AsyncBlockTypeImplTrait(hir_def::DefWithBodyId, ExprId),
 231 }
 232
 233 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
 234 pub struct ReturnTypeImplTraits {
 235     pub(crate) impl_traits: Vec<ReturnTypeImplTrait>,
 236 }
 237
 238 has_interner!(ReturnTypeImplTraits);
 239
 240 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
 241 pub(crate) struct ReturnTypeImplTrait {
 242     pub(crate) bounds: Binders<Vec<QuantifiedWhereClause>>,
 243 }
 244
 245 pub fn static_lifetime() -> Lifetime {
 246     LifetimeData::Static.intern(&Interner)
 247 }
 248
 249 pub fn dummy_usize_const() -> Const {
 250     let usize_ty = chalk_ir::TyKind::Scalar(Scalar::Uint(UintTy::Usize)).intern(&Interner);
 251     chalk_ir::ConstData {
 252         ty: usize_ty,
 253         value: chalk_ir::ConstValue::Concrete(chalk_ir::ConcreteConst { interned: () }),
 254     }
 255     .intern(&Interner)
 256 }
 257
 258 pub(crate) fn fold_free_vars<T: HasInterner<Interner = Interner> + Fold<Interner>>(
 259     t: T,
 260     f: impl FnMut(BoundVar, DebruijnIndex) -> Ty,
 261 ) -> T::Result {
 262     use chalk_ir::{fold::Folder, Fallible};
 263     struct FreeVarFolder<F>(F);
 264     impl<'i, F: FnMut(BoundVar, DebruijnIndex) -> Ty + 'i> Folder<'i, Interner> for FreeVarFolder<F> {
 265         fn as_dyn(&mut self) -> &mut dyn Folder<'i, Interner> {
 266             self
 267         }
 268
 269         fn interner(&self) -> &'i Interner {
 270             &Interner
 271         }
 272
 273         fn fold_free_var_ty(
 274             &mut self,
 275             bound_var: BoundVar,
 276             outer_binder: DebruijnIndex,
 277         ) -> Fallible<Ty> {
 278             Ok(self.0(bound_var, outer_binder))
 279         }
 280     }
 281     t.fold_with(&mut FreeVarFolder(f), DebruijnIndex::INNERMOST).expect("fold failed unexpectedly")
 282 }
 283
 284 pub(crate) fn fold_tys<T: HasInterner<Interner = Interner> + Fold<Interner>>(
 285     t: T,
 286     f: impl FnMut(Ty, DebruijnIndex) -> Ty,
 287     binders: DebruijnIndex,
 288 ) -> T::Result {
 289     use chalk_ir::{
 290         fold::{Folder, SuperFold},
 291         Fallible,
 292     };
 293     struct TyFolder<F>(F);
 294     impl<'i, F: FnMut(Ty, DebruijnIndex) -> Ty + 'i> Folder<'i, Interner> for TyFolder<F> {
 295         fn as_dyn(&mut self) -> &mut dyn Folder<'i, Interner> {
 296             self
 297         }
 298
 299         fn interner(&self) -> &'i Interner {
 300             &Interner
 301         }
 302
 303         fn fold_ty(&mut self, ty: Ty, outer_binder: DebruijnIndex) -> Fallible<Ty> {
 304             let ty = ty.super_fold_with(self.as_dyn(), outer_binder)?;
 305             Ok(self.0(ty, outer_binder))
 306         }
 307     }
 308     t.fold_with(&mut TyFolder(f), binders).expect("fold failed unexpectedly")
 309 }