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 #![warn(rust_2018_idioms, unused_lifetimes, semicolon_in_expressions_from_macros)]
   5
   6 #[allow(unused)]
   7 macro_rules! eprintln {
   8     ($($tt:tt)*) => { stdx::eprintln!($($tt)*) };
   9 }
  10
  11 mod autoderef;
  12 mod builder;
  13 mod chalk_db;
  14 mod chalk_ext;
  15 pub mod consteval;
  16 mod infer;
  17 mod inhabitedness;
  18 mod interner;
  19 mod lower;
  20 mod mapping;
  21 mod tls;
  22 mod utils;
  23 mod walk;
  24 pub mod db;
  25 pub mod diagnostics;
  26 pub mod display;
  27 pub mod method_resolution;
  28 pub mod primitive;
  29 pub mod traits;
  30
  31 #[cfg(test)]
  32 mod tests;
  33 #[cfg(test)]
  34 mod test_db;
  35
  36 use std::sync::Arc;
  37
  38 use chalk_ir::{
  39     fold::{Shift, TypeFoldable},
  40     interner::HasInterner,
  41     NoSolution,
  42 };
  43 use hir_def::{expr::ExprId, type_ref::Rawness, TypeOrConstParamId};
  44 use itertools::Either;
  45 use utils::Generics;
  46
  47 use crate::{consteval::unknown_const, db::HirDatabase, utils::generics};
  48
  49 pub use autoderef::autoderef;
  50 pub use builder::{ParamKind, TyBuilder};
  51 pub use chalk_ext::*;
  52 pub use infer::{
  53     could_coerce, could_unify, Adjust, Adjustment, AutoBorrow, BindingMode, InferenceDiagnostic,
  54     InferenceResult,
  55 };
  56 pub use interner::Interner;
  57 pub use lower::{
  58     associated_type_shorthand_candidates, CallableDefId, ImplTraitLoweringMode, TyDefId,
  59     TyLoweringContext, ValueTyDefId,
  60 };
  61 pub use mapping::{
  62     from_assoc_type_id, from_chalk_trait_id, from_foreign_def_id, from_placeholder_idx,
  63     lt_from_placeholder_idx, to_assoc_type_id, to_chalk_trait_id, to_foreign_def_id,
  64     to_placeholder_idx,
  65 };
  66 pub use traits::TraitEnvironment;
  67 pub use utils::{all_super_traits, is_fn_unsafe_to_call};
  68 pub use walk::TypeWalk;
  69
  70 pub use chalk_ir::{
  71     cast::Cast, AdtId, BoundVar, DebruijnIndex, Mutability, Safety, Scalar, TyVariableKind,
  72 };
  73
  74 pub type ForeignDefId = chalk_ir::ForeignDefId<Interner>;
  75 pub type AssocTypeId = chalk_ir::AssocTypeId<Interner>;
  76 pub type FnDefId = chalk_ir::FnDefId<Interner>;
  77 pub type ClosureId = chalk_ir::ClosureId<Interner>;
  78 pub type OpaqueTyId = chalk_ir::OpaqueTyId<Interner>;
  79 pub type PlaceholderIndex = chalk_ir::PlaceholderIndex;
  80
  81 pub type VariableKind = chalk_ir::VariableKind<Interner>;
  82 pub type VariableKinds = chalk_ir::VariableKinds<Interner>;
  83 pub type CanonicalVarKinds = chalk_ir::CanonicalVarKinds<Interner>;
  84 pub type Binders<T> = chalk_ir::Binders<T>;
  85 pub type Substitution = chalk_ir::Substitution<Interner>;
  86 pub type GenericArg = chalk_ir::GenericArg<Interner>;
  87 pub type GenericArgData = chalk_ir::GenericArgData<Interner>;
  88
  89 pub type Ty = chalk_ir::Ty<Interner>;
  90 pub type TyKind = chalk_ir::TyKind<Interner>;
  91 pub type DynTy = chalk_ir::DynTy<Interner>;
  92 pub type FnPointer = chalk_ir::FnPointer<Interner>;
  93 // pub type FnSubst = chalk_ir::FnSubst<Interner>;
  94 pub use chalk_ir::FnSubst;
  95 pub type ProjectionTy = chalk_ir::ProjectionTy<Interner>;
  96 pub type AliasTy = chalk_ir::AliasTy<Interner>;
  97 pub type OpaqueTy = chalk_ir::OpaqueTy<Interner>;
  98 pub type InferenceVar = chalk_ir::InferenceVar;
  99
 100 pub type Lifetime = chalk_ir::Lifetime<Interner>;
 101 pub type LifetimeData = chalk_ir::LifetimeData<Interner>;
 102 pub type LifetimeOutlives = chalk_ir::LifetimeOutlives<Interner>;
 103
 104 pub type Const = chalk_ir::Const<Interner>;
 105 pub type ConstData = chalk_ir::ConstData<Interner>;
 106 pub type ConstValue = chalk_ir::ConstValue<Interner>;
 107 pub type ConcreteConst = chalk_ir::ConcreteConst<Interner>;
 108
 109 pub type ChalkTraitId = chalk_ir::TraitId<Interner>;
 110 pub type TraitRef = chalk_ir::TraitRef<Interner>;
 111 pub type QuantifiedWhereClause = Binders<WhereClause>;
 112 pub type QuantifiedWhereClauses = chalk_ir::QuantifiedWhereClauses<Interner>;
 113 pub type Canonical<T> = chalk_ir::Canonical<T>;
 114
 115 pub type FnSig = chalk_ir::FnSig<Interner>;
 116
 117 pub type InEnvironment<T> = chalk_ir::InEnvironment<T>;
 118 pub type Environment = chalk_ir::Environment<Interner>;
 119 pub type DomainGoal = chalk_ir::DomainGoal<Interner>;
 120 pub type Goal = chalk_ir::Goal<Interner>;
 121 pub type AliasEq = chalk_ir::AliasEq<Interner>;
 122 pub type Solution = chalk_solve::Solution<Interner>;
 123 pub type ConstrainedSubst = chalk_ir::ConstrainedSubst<Interner>;
 124 pub type Guidance = chalk_solve::Guidance<Interner>;
 125 pub type WhereClause = chalk_ir::WhereClause<Interner>;
 126
 127 // FIXME: get rid of this
 128 pub fn subst_prefix(s: &Substitution, n: usize) -> Substitution {
 129     Substitution::from_iter(
 130         Interner,
 131         s.as_slice(Interner)[..std::cmp::min(s.len(Interner), n)].iter().cloned(),
 132     )
 133 }
 134
 135 /// Return an index of a parameter in the generic type parameter list by it's id.
 136 pub fn param_idx(db: &dyn HirDatabase, id: TypeOrConstParamId) -> Option<usize> {
 137     generics(db.upcast(), id.parent).param_idx(id)
 138 }
 139
 140 pub(crate) fn wrap_empty_binders<T>(value: T) -> Binders<T>
 141 where
 142     T: TypeFoldable<Interner> + HasInterner<Interner = Interner>,
 143 {
 144     Binders::empty(Interner, value.shifted_in_from(Interner, DebruijnIndex::ONE))
 145 }
 146
 147 pub(crate) fn make_type_and_const_binders<T: HasInterner<Interner = Interner>>(
 148     which_is_const: impl Iterator<Item = Option<Ty>>,
 149     value: T,
 150 ) -> Binders<T> {
 151     Binders::new(
 152         VariableKinds::from_iter(
 153             Interner,
 154             which_is_const.map(|x| {
 155                 if let Some(ty) = x {
 156                     chalk_ir::VariableKind::Const(ty)
 157                 } else {
 158                     chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General)
 159                 }
 160             }),
 161         ),
 162         value,
 163     )
 164 }
 165
 166 pub(crate) fn make_single_type_binders<T: HasInterner<Interner = Interner>>(
 167     value: T,
 168 ) -> Binders<T> {
 169     Binders::new(
 170         VariableKinds::from_iter(
 171             Interner,
 172             std::iter::once(chalk_ir::VariableKind::Ty(chalk_ir::TyVariableKind::General)),
 173         ),
 174         value,
 175     )
 176 }
 177
 178 pub(crate) fn make_binders_with_count<T: HasInterner<Interner = Interner>>(
 179     db: &dyn HirDatabase,
 180     count: usize,
 181     generics: &Generics,
 182     value: T,
 183 ) -> Binders<T> {
 184     let it = generics.iter_id().take(count).map(|id| match id {
 185         Either::Left(_) => None,
 186         Either::Right(id) => Some(db.const_param_ty(id)),
 187     });
 188     crate::make_type_and_const_binders(it, value)
 189 }
 190
 191 pub(crate) fn make_binders<T: HasInterner<Interner = Interner>>(
 192     db: &dyn HirDatabase,
 193     generics: &Generics,
 194     value: T,
 195 ) -> Binders<T> {
 196     make_binders_with_count(db, usize::MAX, generics, value)
 197 }
 198
 199 // FIXME: get rid of this, just replace it by FnPointer
 200 /// A function signature as seen by type inference: Several parameter types and
 201 /// one return type.
 202 #[derive(Clone, PartialEq, Eq, Debug)]
 203 pub struct CallableSig {
 204     params_and_return: Arc<[Ty]>,
 205     is_varargs: bool,
 206 }
 207
 208 has_interner!(CallableSig);
 209
 210 /// A polymorphic function signature.
 211 pub type PolyFnSig = Binders<CallableSig>;
 212
 213 impl CallableSig {
 214     pub fn from_params_and_return(mut params: Vec<Ty>, ret: Ty, is_varargs: bool) -> CallableSig {
 215         params.push(ret);
 216         CallableSig { params_and_return: params.into(), is_varargs }
 217     }
 218
 219     pub fn from_fn_ptr(fn_ptr: &FnPointer) -> CallableSig {
 220         CallableSig {
 221             // FIXME: what to do about lifetime params? -> return PolyFnSig
 222             params_and_return: fn_ptr
 223                 .substitution
 224                 .clone()
 225                 .shifted_out_to(Interner, DebruijnIndex::ONE)
 226                 .expect("unexpected lifetime vars in fn ptr")
 227                 .0
 228                 .as_slice(Interner)
 229                 .iter()
 230                 .map(|arg| arg.assert_ty_ref(Interner).clone())
 231                 .collect(),
 232             is_varargs: fn_ptr.sig.variadic,
 233         }
 234     }
 235
 236     pub fn to_fn_ptr(&self) -> FnPointer {
 237         FnPointer {
 238             num_binders: 0,
 239             sig: FnSig { abi: (), safety: Safety::Safe, variadic: self.is_varargs },
 240             substitution: FnSubst(Substitution::from_iter(
 241                 Interner,
 242                 self.params_and_return.iter().cloned(),
 243             )),
 244         }
 245     }
 246
 247     pub fn params(&self) -> &[Ty] {
 248         &self.params_and_return[0..self.params_and_return.len() - 1]
 249     }
 250
 251     pub fn ret(&self) -> &Ty {
 252         &self.params_and_return[self.params_and_return.len() - 1]
 253     }
 254 }
 255
 256 impl TypeFoldable<Interner> for CallableSig {
 257     fn fold_with<E>(
 258         self,
 259         folder: &mut dyn chalk_ir::fold::TypeFolder<Interner, Error = E>,
 260         outer_binder: DebruijnIndex,
 261     ) -> Result<Self, E> {
 262         let vec = self.params_and_return.to_vec();
 263         let folded = vec.fold_with(folder, outer_binder)?;
 264         Ok(CallableSig { params_and_return: folded.into(), is_varargs: self.is_varargs })
 265     }
 266 }
 267
 268 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
 269 pub enum ImplTraitId {
 270     ReturnTypeImplTrait(hir_def::FunctionId, u16),
 271     AsyncBlockTypeImplTrait(hir_def::DefWithBodyId, ExprId),
 272 }
 273
 274 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
 275 pub struct ReturnTypeImplTraits {
 276     pub(crate) impl_traits: Vec<ReturnTypeImplTrait>,
 277 }
 278
 279 has_interner!(ReturnTypeImplTraits);
 280
 281 #[derive(Clone, PartialEq, Eq, Debug, Hash)]
 282 pub(crate) struct ReturnTypeImplTrait {
 283     pub(crate) bounds: Binders<Vec<QuantifiedWhereClause>>,
 284 }
 285
 286 pub fn static_lifetime() -> Lifetime {
 287     LifetimeData::Static.intern(Interner)
 288 }
 289
 290 pub(crate) fn fold_free_vars<T: HasInterner<Interner = Interner> + TypeFoldable<Interner>>(
 291     t: T,
 292     for_ty: impl FnMut(BoundVar, DebruijnIndex) -> Ty,
 293     for_const: impl FnMut(Ty, BoundVar, DebruijnIndex) -> Const,
 294 ) -> T {
 295     use chalk_ir::{fold::TypeFolder, Fallible};
 296     struct FreeVarFolder<F1, F2>(F1, F2);
 297     impl<
 298             'i,
 299             F1: FnMut(BoundVar, DebruijnIndex) -> Ty + 'i,
 300             F2: FnMut(Ty, BoundVar, DebruijnIndex) -> Const + 'i,
 301         > TypeFolder<Interner> for FreeVarFolder<F1, F2>
 302     {
 303         type Error = NoSolution;
 304
 305         fn as_dyn(&mut self) -> &mut dyn TypeFolder<Interner, Error = Self::Error> {
 306             self
 307         }
 308
 309         fn interner(&self) -> Interner {
 310             Interner
 311         }
 312
 313         fn fold_free_var_ty(
 314             &mut self,
 315             bound_var: BoundVar,
 316             outer_binder: DebruijnIndex,
 317         ) -> Fallible<Ty> {
 318             Ok(self.0(bound_var, outer_binder))
 319         }
 320
 321         fn fold_free_var_const(
 322             &mut self,
 323             ty: Ty,
 324             bound_var: BoundVar,
 325             outer_binder: DebruijnIndex,
 326         ) -> Fallible<Const> {
 327             Ok(self.1(ty, bound_var, outer_binder))
 328         }
 329     }
 330     t.fold_with(&mut FreeVarFolder(for_ty, for_const), DebruijnIndex::INNERMOST)
 331         .expect("fold failed unexpectedly")
 332 }
 333
 334 pub(crate) fn fold_tys<T: HasInterner<Interner = Interner> + TypeFoldable<Interner>>(
 335     t: T,
 336     mut for_ty: impl FnMut(Ty, DebruijnIndex) -> Ty,
 337     binders: DebruijnIndex,
 338 ) -> T {
 339     fold_tys_and_consts(
 340         t,
 341         |x, d| match x {
 342             Either::Left(x) => Either::Left(for_ty(x, d)),
 343             Either::Right(x) => Either::Right(x),
 344         },
 345         binders,
 346     )
 347 }
 348
 349 pub(crate) fn fold_tys_and_consts<T: HasInterner<Interner = Interner> + TypeFoldable<Interner>>(
 350     t: T,
 351     f: impl FnMut(Either<Ty, Const>, DebruijnIndex) -> Either<Ty, Const>,
 352     binders: DebruijnIndex,
 353 ) -> T {
 354     use chalk_ir::{
 355         fold::{TypeFolder, TypeSuperFoldable},
 356         Fallible,
 357     };
 358     struct TyFolder<F>(F);
 359     impl<'i, F: FnMut(Either<Ty, Const>, DebruijnIndex) -> Either<Ty, Const> + 'i>
 360         TypeFolder<Interner> for TyFolder<F>
 361     {
 362         type Error = NoSolution;
 363
 364         fn as_dyn(&mut self) -> &mut dyn TypeFolder<Interner, Error = Self::Error> {
 365             self
 366         }
 367
 368         fn interner(&self) -> Interner {
 369             Interner
 370         }
 371
 372         fn fold_ty(&mut self, ty: Ty, outer_binder: DebruijnIndex) -> Fallible<Ty> {
 373             let ty = ty.super_fold_with(self.as_dyn(), outer_binder)?;
 374             Ok(self.0(Either::Left(ty), outer_binder).left().unwrap())
 375         }
 376
 377         fn fold_const(&mut self, c: Const, outer_binder: DebruijnIndex) -> Fallible<Const> {
 378             Ok(self.0(Either::Right(c), outer_binder).right().unwrap())
 379         }
 380     }
 381     t.fold_with(&mut TyFolder(f), binders).expect("fold failed unexpectedly")
 382 }
 383
 384 /// 'Canonicalizes' the `t` by replacing any errors with new variables. Also
 385 /// ensures there are no unbound variables or inference variables anywhere in
 386 /// the `t`.
 387 pub fn replace_errors_with_variables<T>(t: &T) -> Canonical<T>
 388 where
 389     T: HasInterner<Interner = Interner> + TypeFoldable<Interner> + Clone,
 390     T: HasInterner<Interner = Interner>,
 391 {
 392     use chalk_ir::{
 393         fold::{TypeFolder, TypeSuperFoldable},
 394         Fallible,
 395     };
 396     struct ErrorReplacer {
 397         vars: usize,
 398     }
 399     impl TypeFolder<Interner> for ErrorReplacer {
 400         type Error = NoSolution;
 401
 402         fn as_dyn(&mut self) -> &mut dyn TypeFolder<Interner, Error = Self::Error> {
 403             self
 404         }
 405
 406         fn interner(&self) -> Interner {
 407             Interner
 408         }
 409
 410         fn fold_ty(&mut self, ty: Ty, outer_binder: DebruijnIndex) -> Fallible<Ty> {
 411             if let TyKind::Error = ty.kind(Interner) {
 412                 let index = self.vars;
 413                 self.vars += 1;
 414                 Ok(TyKind::BoundVar(BoundVar::new(outer_binder, index)).intern(Interner))
 415             } else {
 416                 let ty = ty.super_fold_with(self.as_dyn(), outer_binder)?;
 417                 Ok(ty)
 418             }
 419         }
 420
 421         fn fold_inference_ty(
 422             &mut self,
 423             _var: InferenceVar,
 424             _kind: TyVariableKind,
 425             _outer_binder: DebruijnIndex,
 426         ) -> Fallible<Ty> {
 427             if cfg!(debug_assertions) {
 428                 // we don't want to just panic here, because then the error message
 429                 // won't contain the whole thing, which would not be very helpful
 430                 Err(NoSolution)
 431             } else {
 432                 Ok(TyKind::Error.intern(Interner))
 433             }
 434         }
 435
 436         fn fold_free_var_ty(
 437             &mut self,
 438             _bound_var: BoundVar,
 439             _outer_binder: DebruijnIndex,
 440         ) -> Fallible<Ty> {
 441             if cfg!(debug_assertions) {
 442                 // we don't want to just panic here, because then the error message
 443                 // won't contain the whole thing, which would not be very helpful
 444                 Err(NoSolution)
 445             } else {
 446                 Ok(TyKind::Error.intern(Interner))
 447             }
 448         }
 449
 450         fn fold_inference_const(
 451             &mut self,
 452             ty: Ty,
 453             _var: InferenceVar,
 454             _outer_binder: DebruijnIndex,
 455         ) -> Fallible<Const> {
 456             if cfg!(debug_assertions) {
 457                 Err(NoSolution)
 458             } else {
 459                 Ok(unknown_const(ty))
 460             }
 461         }
 462
 463         fn fold_free_var_const(
 464             &mut self,
 465             ty: Ty,
 466             _bound_var: BoundVar,
 467             _outer_binder: DebruijnIndex,
 468         ) -> Fallible<Const> {
 469             if cfg!(debug_assertions) {
 470                 Err(NoSolution)
 471             } else {
 472                 Ok(unknown_const(ty))
 473             }
 474         }
 475
 476         fn fold_inference_lifetime(
 477             &mut self,
 478             _var: InferenceVar,
 479             _outer_binder: DebruijnIndex,
 480         ) -> Fallible<Lifetime> {
 481             if cfg!(debug_assertions) {
 482                 Err(NoSolution)
 483             } else {
 484                 Ok(static_lifetime())
 485             }
 486         }
 487
 488         fn fold_free_var_lifetime(
 489             &mut self,
 490             _bound_var: BoundVar,
 491             _outer_binder: DebruijnIndex,
 492         ) -> Fallible<Lifetime> {
 493             if cfg!(debug_assertions) {
 494                 Err(NoSolution)
 495             } else {
 496                 Ok(static_lifetime())
 497             }
 498         }
 499     }
 500     let mut error_replacer = ErrorReplacer { vars: 0 };
 501     let value = match t.clone().fold_with(&mut error_replacer, DebruijnIndex::INNERMOST) {
 502         Ok(t) => t,
 503         Err(_) => panic!("Encountered unbound or inference vars in {:?}", t),
 504     };
 505     let kinds = (0..error_replacer.vars).map(|_| {
 506         chalk_ir::CanonicalVarKind::new(
 507             chalk_ir::VariableKind::Ty(TyVariableKind::General),
 508             chalk_ir::UniverseIndex::ROOT,
 509         )
 510     });
 511     Canonical { value, binders: chalk_ir::CanonicalVarKinds::from_iter(Interner, kinds) }
 512 }