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 #[allow(unused)]
   4 macro_rules! eprintln {
   5     ($($tt:tt)*) => { stdx::eprintln!($($tt)*) };
   6 }
   7
   8 mod autoderef;
   9 pub mod primitive;
  10 pub mod traits;
  11 pub mod method_resolution;
  12 mod op;
  13 mod lower;
  14 pub(crate) mod infer;
  15 pub(crate) mod utils;
  16 mod chalk_cast;
  17 mod chalk_ext;
  18 mod builder;
  19 mod walk;
  20 mod types;
  21
  22 pub mod display;
  23 pub mod db;
  24 pub mod diagnostics;
  25
  26 #[cfg(test)]
  27 mod tests;
  28 #[cfg(test)]
  29 mod test_db;
  30
  31 use std::sync::Arc;
  32
  33 use base_db::salsa;
  34 use chalk_ir::UintTy;
  35 use hir_def::{
  36     expr::ExprId, type_ref::Rawness, ConstParamId, LifetimeParamId, TraitId, TypeAliasId,
  37     TypeParamId,
  38 };
  39
  40 use crate::{db::HirDatabase, display::HirDisplay, utils::generics};
  41
  42 pub use autoderef::autoderef;
  43 pub use builder::TyBuilder;
  44 pub use chalk_ext::*;
  45 pub use infer::{could_unify, InferenceResult};
  46 pub use lower::{
  47     associated_type_shorthand_candidates, callable_item_sig, CallableDefId, ImplTraitLoweringMode,
  48     TyDefId, TyLoweringContext, ValueTyDefId,
  49 };
  50 pub use traits::{chalk::Interner, TraitEnvironment};
  51 pub use types::*;
  52 pub use walk::TypeWalk;
  53
  54 pub use chalk_ir::{
  55     cast::Cast, AdtId, BoundVar, DebruijnIndex, Mutability, Safety, Scalar, TyVariableKind,
  56 };
  57
  58 pub type ForeignDefId = chalk_ir::ForeignDefId<Interner>;
  59 pub type AssocTypeId = chalk_ir::AssocTypeId<Interner>;
  60 pub type FnDefId = chalk_ir::FnDefId<Interner>;
  61 pub type ClosureId = chalk_ir::ClosureId<Interner>;
  62 pub type OpaqueTyId = chalk_ir::OpaqueTyId<Interner>;
  63 pub type PlaceholderIndex = chalk_ir::PlaceholderIndex;
  64
  65 pub type VariableKind = chalk_ir::VariableKind<Interner>;
  66 pub type VariableKinds = chalk_ir::VariableKinds<Interner>;
  67 pub type CanonicalVarKinds = chalk_ir::CanonicalVarKinds<Interner>;
  68
  69 pub type Lifetime = chalk_ir::Lifetime<Interner>;
  70 pub type LifetimeData = chalk_ir::LifetimeData<Interner>;
  71 pub type LifetimeOutlives = chalk_ir::LifetimeOutlives<Interner>;
  72
  73 pub type Const = chalk_ir::Const<Interner>;
  74 pub type ConstData = chalk_ir::ConstData<Interner>;
  75 pub type ConstValue = chalk_ir::ConstValue<Interner>;
  76 pub type ConcreteConst = chalk_ir::ConcreteConst<Interner>;
  77
  78 pub type ChalkTraitId = chalk_ir::TraitId<Interner>;
  79
  80 pub type FnSig = chalk_ir::FnSig<Interner>;
  81
  82 // FIXME: get rid of this
  83 pub fn subst_prefix(s: &Substitution, n: usize) -> Substitution {
  84     Substitution::intern(s.interned()[..std::cmp::min(s.len(&Interner), n)].into())
  85 }
  86
  87 /// Return an index of a parameter in the generic type parameter list by it's id.
  88 pub fn param_idx(db: &dyn HirDatabase, id: TypeParamId) -> Option<usize> {
  89     generics(db.upcast(), id.parent).param_idx(id)
  90 }
  91
  92 pub fn wrap_empty_binders<T>(value: T) -> Binders<T>
  93 where
  94     T: TypeWalk,
  95 {
  96     Binders::empty(&Interner, value.shifted_in_from(DebruijnIndex::ONE))
  97 }
  98
  99 pub fn make_only_type_binders<T>(num_vars: usize, value: T) -> Binders<T> {
 100     Binders::new(
 101         VariableKinds::from_iter(
 102             &Interner,
 103             std::iter::repeat(chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General))
 104                 .take(num_vars),
 105         ),
 106         value,
 107     )
 108 }
 109
 110 // FIXME: get rid of this
 111 pub fn make_canonical<T>(
 112     value: T,
 113     kinds: impl IntoIterator<Item = TyVariableKind>,
 114 ) -> Canonical<T> {
 115     let kinds = kinds.into_iter().map(|tk| {
 116         chalk_ir::CanonicalVarKind::new(
 117             chalk_ir::VariableKind::Ty(tk),
 118             chalk_ir::UniverseIndex::ROOT,
 119         )
 120     });
 121     Canonical { value, binders: chalk_ir::CanonicalVarKinds::from_iter(&Interner, kinds) }
 122 }
 123
 124 /// A function signature as seen by type inference: Several parameter types and
 125 /// one return type.
 126 #[derive(Clone, PartialEq, Eq, Debug)]
 127 pub struct CallableSig {
 128     params_and_return: Arc<[Ty]>,
 129     is_varargs: bool,
 130 }
 131
 132 /// A polymorphic function signature.
 133 pub type PolyFnSig = Binders<CallableSig>;
 134
 135 impl CallableSig {
 136     pub fn from_params_and_return(mut params: Vec<Ty>, ret: Ty, is_varargs: bool) -> CallableSig {
 137         params.push(ret);
 138         CallableSig { params_and_return: params.into(), is_varargs }
 139     }
 140
 141     pub fn from_fn_ptr(fn_ptr: &FnPointer) -> CallableSig {
 142         CallableSig {
 143             // FIXME: what to do about lifetime params? -> return PolyFnSig
 144             params_and_return: fn_ptr
 145                 .substitution
 146                 .clone()
 147                 .shifted_out_to(DebruijnIndex::ONE)
 148                 .expect("unexpected lifetime vars in fn ptr")
 149                 .0
 150                 .interned()
 151                 .iter()
 152                 .map(|arg| arg.assert_ty_ref(&Interner).clone())
 153                 .collect(),
 154             is_varargs: fn_ptr.sig.variadic,
 155         }
 156     }
 157
 158     pub fn params(&self) -> &[Ty] {
 159         &self.params_and_return[0..self.params_and_return.len() - 1]
 160     }
 161
 162     pub fn ret(&self) -> &Ty {
 163         &self.params_and_return[self.params_and_return.len() - 1]
 164     }
 165 }
 166
 167 impl Ty {}
 168
 169 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
 170 pub enum ImplTraitId {
 171     ReturnTypeImplTrait(hir_def::FunctionId, u16),
 172     AsyncBlockTypeImplTrait(hir_def::DefWithBodyId, ExprId),
 173 }
 174
 175 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
 176 pub struct ReturnTypeImplTraits {
 177     pub(crate) impl_traits: Vec<ReturnTypeImplTrait>,
 178 }
 179
 180 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
 181 pub(crate) struct ReturnTypeImplTrait {
 182     pub(crate) bounds: Binders<Vec<QuantifiedWhereClause>>,
 183 }
 184
 185 pub fn to_foreign_def_id(id: TypeAliasId) -> ForeignDefId {
 186     chalk_ir::ForeignDefId(salsa::InternKey::as_intern_id(&id))
 187 }
 188
 189 pub fn from_foreign_def_id(id: ForeignDefId) -> TypeAliasId {
 190     salsa::InternKey::from_intern_id(id.0)
 191 }
 192
 193 pub fn to_assoc_type_id(id: TypeAliasId) -> AssocTypeId {
 194     chalk_ir::AssocTypeId(salsa::InternKey::as_intern_id(&id))
 195 }
 196
 197 pub fn from_assoc_type_id(id: AssocTypeId) -> TypeAliasId {
 198     salsa::InternKey::from_intern_id(id.0)
 199 }
 200
 201 pub fn from_placeholder_idx(db: &dyn HirDatabase, idx: PlaceholderIndex) -> TypeParamId {
 202     assert_eq!(idx.ui, chalk_ir::UniverseIndex::ROOT);
 203     let interned_id = salsa::InternKey::from_intern_id(salsa::InternId::from(idx.idx));
 204     db.lookup_intern_type_param_id(interned_id)
 205 }
 206
 207 pub fn to_placeholder_idx(db: &dyn HirDatabase, id: TypeParamId) -> PlaceholderIndex {
 208     let interned_id = db.intern_type_param_id(id);
 209     PlaceholderIndex {
 210         ui: chalk_ir::UniverseIndex::ROOT,
 211         idx: salsa::InternKey::as_intern_id(&interned_id).as_usize(),
 212     }
 213 }
 214
 215 pub fn lt_from_placeholder_idx(db: &dyn HirDatabase, idx: PlaceholderIndex) -> LifetimeParamId {
 216     assert_eq!(idx.ui, chalk_ir::UniverseIndex::ROOT);
 217     let interned_id = salsa::InternKey::from_intern_id(salsa::InternId::from(idx.idx));
 218     db.lookup_intern_lifetime_param_id(interned_id)
 219 }
 220
 221 pub fn const_from_placeholder_idx(db: &dyn HirDatabase, idx: PlaceholderIndex) -> ConstParamId {
 222     assert_eq!(idx.ui, chalk_ir::UniverseIndex::ROOT);
 223     let interned_id = salsa::InternKey::from_intern_id(salsa::InternId::from(idx.idx));
 224     db.lookup_intern_const_param_id(interned_id)
 225 }
 226
 227 pub fn to_chalk_trait_id(id: TraitId) -> ChalkTraitId {
 228     chalk_ir::TraitId(salsa::InternKey::as_intern_id(&id))
 229 }
 230
 231 pub fn from_chalk_trait_id(id: ChalkTraitId) -> TraitId {
 232     salsa::InternKey::from_intern_id(id.0)
 233 }
 234
 235 pub fn static_lifetime() -> Lifetime {
 236     LifetimeData::Static.intern(&Interner)
 237 }
 238
 239 pub fn dummy_usize_const() -> Const {
 240     let usize_ty = chalk_ir::TyKind::Scalar(Scalar::Uint(UintTy::Usize)).intern(&Interner);
 241     chalk_ir::ConstData {
 242         ty: usize_ty,
 243         value: chalk_ir::ConstValue::Concrete(chalk_ir::ConcreteConst { interned: () }),
 244     }
 245     .intern(&Interner)
 246 }