compiler/rustc_middle/src/ty/subst.rs

   1 // Type substitutions.
   2
   3 use crate::mir;
   4 use crate::ty::codec::{TyDecoder, TyEncoder};
   5 use crate::ty::fold::{TypeFoldable, TypeFolder, TypeVisitor};
   6 use crate::ty::sty::{ClosureSubsts, GeneratorSubsts, InlineConstSubsts};
   7 use crate::ty::{self, Lift, List, ParamConst, Ty, TyCtxt};
   8
   9 use rustc_hir::def_id::DefId;
  10 use rustc_macros::HashStable;
  11 use rustc_serialize::{self, Decodable, Encodable};
  12 use rustc_span::{Span, DUMMY_SP};
  13 use smallvec::SmallVec;
  14
  15 use core::intrinsics;
  16 use std::cmp::Ordering;
  17 use std::fmt;
  18 use std::marker::PhantomData;
  19 use std::mem;
  20 use std::num::NonZeroUsize;
  21 use std::ops::ControlFlow;
  22
  23 /// An entity in the Rust type system, which can be one of
  24 /// several kinds (types, lifetimes, and consts).
  25 /// To reduce memory usage, a `GenericArg` is an interned pointer,
  26 /// with the lowest 2 bits being reserved for a tag to
  27 /// indicate the type (`Ty`, `Region`, or `Const`) it points to.
  28 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
  29 pub struct GenericArg<'tcx> {
  30     ptr: NonZeroUsize,
  31     marker: PhantomData<(Ty<'tcx>, ty::Region<'tcx>, &'tcx ty::Const<'tcx>)>,
  32 }
  33
  34 const TAG_MASK: usize = 0b11;
  35 const TYPE_TAG: usize = 0b00;
  36 const REGION_TAG: usize = 0b01;
  37 const CONST_TAG: usize = 0b10;
  38
  39 #[derive(Debug, TyEncodable, TyDecodable, PartialEq, Eq, PartialOrd, Ord, HashStable)]
  40 pub enum GenericArgKind<'tcx> {
  41     Lifetime(ty::Region<'tcx>),
  42     Type(Ty<'tcx>),
  43     Const(&'tcx ty::Const<'tcx>),
  44 }
  45
  46 impl<'tcx> GenericArgKind<'tcx> {
  47     fn pack(self) -> GenericArg<'tcx> {
  48         let (tag, ptr) = match self {
  49             GenericArgKind::Lifetime(lt) => {
  50                 // Ensure we can use the tag bits.
  51                 assert_eq!(mem::align_of_val(lt) & TAG_MASK, 0);
  52                 (REGION_TAG, lt as *const _ as usize)
  53             }
  54             GenericArgKind::Type(ty) => {
  55                 // Ensure we can use the tag bits.
  56                 assert_eq!(mem::align_of_val(ty) & TAG_MASK, 0);
  57                 (TYPE_TAG, ty as *const _ as usize)
  58             }
  59             GenericArgKind::Const(ct) => {
  60                 // Ensure we can use the tag bits.
  61                 assert_eq!(mem::align_of_val(ct) & TAG_MASK, 0);
  62                 (CONST_TAG, ct as *const _ as usize)
  63             }
  64         };
  65
  66         GenericArg { ptr: unsafe { NonZeroUsize::new_unchecked(ptr | tag) }, marker: PhantomData }
  67     }
  68 }
  69
  70 impl fmt::Debug for GenericArg<'tcx> {
  71     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  72         match self.unpack() {
  73             GenericArgKind::Lifetime(lt) => lt.fmt(f),
  74             GenericArgKind::Type(ty) => ty.fmt(f),
  75             GenericArgKind::Const(ct) => ct.fmt(f),
  76         }
  77     }
  78 }
  79
  80 impl<'tcx> Ord for GenericArg<'tcx> {
  81     fn cmp(&self, other: &GenericArg<'_>) -> Ordering {
  82         self.unpack().cmp(&other.unpack())
  83     }
  84 }
  85
  86 impl<'tcx> PartialOrd for GenericArg<'tcx> {
  87     fn partial_cmp(&self, other: &GenericArg<'_>) -> Option<Ordering> {
  88         Some(self.cmp(&other))
  89     }
  90 }
  91
  92 impl<'tcx> From<ty::Region<'tcx>> for GenericArg<'tcx> {
  93     fn from(r: ty::Region<'tcx>) -> GenericArg<'tcx> {
  94         GenericArgKind::Lifetime(r).pack()
  95     }
  96 }
  97
  98 impl<'tcx> From<Ty<'tcx>> for GenericArg<'tcx> {
  99     fn from(ty: Ty<'tcx>) -> GenericArg<'tcx> {
 100         GenericArgKind::Type(ty).pack()
 101     }
 102 }
 103
 104 impl<'tcx> From<&'tcx ty::Const<'tcx>> for GenericArg<'tcx> {
 105     fn from(c: &'tcx ty::Const<'tcx>) -> GenericArg<'tcx> {
 106         GenericArgKind::Const(c).pack()
 107     }
 108 }
 109
 110 impl<'tcx> GenericArg<'tcx> {
 111     #[inline]
 112     pub fn unpack(self) -> GenericArgKind<'tcx> {
 113         let ptr = self.ptr.get();
 114         unsafe {
 115             match ptr & TAG_MASK {
 116                 REGION_TAG => GenericArgKind::Lifetime(&*((ptr & !TAG_MASK) as *const _)),
 117                 TYPE_TAG => GenericArgKind::Type(&*((ptr & !TAG_MASK) as *const _)),
 118                 CONST_TAG => GenericArgKind::Const(&*((ptr & !TAG_MASK) as *const _)),
 119                 _ => intrinsics::unreachable(),
 120             }
 121         }
 122     }
 123
 124     /// Unpack the `GenericArg` as a type when it is known certainly to be a type.
 125     /// This is true in cases where `Substs` is used in places where the kinds are known
 126     /// to be limited (e.g. in tuples, where the only parameters are type parameters).
 127     pub fn expect_ty(self) -> Ty<'tcx> {
 128         match self.unpack() {
 129             GenericArgKind::Type(ty) => ty,
 130             _ => bug!("expected a type, but found another kind"),
 131         }
 132     }
 133
 134     /// Unpack the `GenericArg` as a const when it is known certainly to be a const.
 135     pub fn expect_const(self) -> &'tcx ty::Const<'tcx> {
 136         match self.unpack() {
 137             GenericArgKind::Const(c) => c,
 138             _ => bug!("expected a const, but found another kind"),
 139         }
 140     }
 141 }
 142
 143 impl<'a, 'tcx> Lift<'tcx> for GenericArg<'a> {
 144     type Lifted = GenericArg<'tcx>;
 145
 146     fn lift_to_tcx(self, tcx: TyCtxt<'tcx>) -> Option<Self::Lifted> {
 147         match self.unpack() {
 148             GenericArgKind::Lifetime(lt) => tcx.lift(lt).map(|lt| lt.into()),
 149             GenericArgKind::Type(ty) => tcx.lift(ty).map(|ty| ty.into()),
 150             GenericArgKind::Const(ct) => tcx.lift(ct).map(|ct| ct.into()),
 151         }
 152     }
 153 }
 154
 155 impl<'tcx> TypeFoldable<'tcx> for GenericArg<'tcx> {
 156     fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Result<Self, F::Error> {
 157         match self.unpack() {
 158             GenericArgKind::Lifetime(lt) => lt.fold_with(folder).map(Into::into),
 159             GenericArgKind::Type(ty) => ty.fold_with(folder).map(Into::into),
 160             GenericArgKind::Const(ct) => ct.fold_with(folder).map(Into::into),
 161         }
 162     }
 163
 164     fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> ControlFlow<V::BreakTy> {
 165         match self.unpack() {
 166             GenericArgKind::Lifetime(lt) => lt.visit_with(visitor),
 167             GenericArgKind::Type(ty) => ty.visit_with(visitor),
 168             GenericArgKind::Const(ct) => ct.visit_with(visitor),
 169         }
 170     }
 171 }
 172
 173 impl<'tcx, E: TyEncoder<'tcx>> Encodable<E> for GenericArg<'tcx> {
 174     fn encode(&self, e: &mut E) -> Result<(), E::Error> {
 175         self.unpack().encode(e)
 176     }
 177 }
 178
 179 impl<'tcx, D: TyDecoder<'tcx>> Decodable<D> for GenericArg<'tcx> {
 180     fn decode(d: &mut D) -> Result<GenericArg<'tcx>, D::Error> {
 181         Ok(GenericArgKind::decode(d)?.pack())
 182     }
 183 }
 184
 185 /// A substitution mapping generic parameters to new values.
 186 pub type InternalSubsts<'tcx> = List<GenericArg<'tcx>>;
 187
 188 pub type SubstsRef<'tcx> = &'tcx InternalSubsts<'tcx>;
 189
 190 impl<'a, 'tcx> InternalSubsts<'tcx> {
 191     /// Interpret these substitutions as the substitutions of a closure type.
 192     /// Closure substitutions have a particular structure controlled by the
 193     /// compiler that encodes information like the signature and closure kind;
 194     /// see `ty::ClosureSubsts` struct for more comments.
 195     pub fn as_closure(&'a self) -> ClosureSubsts<'a> {
 196         ClosureSubsts { substs: self }
 197     }
 198
 199     /// Interpret these substitutions as the substitutions of a generator type.
 200     /// Generator substitutions have a particular structure controlled by the
 201     /// compiler that encodes information like the signature and generator kind;
 202     /// see `ty::GeneratorSubsts` struct for more comments.
 203     pub fn as_generator(&'tcx self) -> GeneratorSubsts<'tcx> {
 204         GeneratorSubsts { substs: self }
 205     }
 206
 207     /// Interpret these substitutions as the substitutions of an inline const.
 208     /// Inline const substitutions have a particular structure controlled by the
 209     /// compiler that encodes information like the inferred type;
 210     /// see `ty::InlineConstSubsts` struct for more comments.
 211     pub fn as_inline_const(&'tcx self) -> InlineConstSubsts<'tcx> {
 212         InlineConstSubsts { substs: self }
 213     }
 214
 215     /// Creates an `InternalSubsts` that maps each generic parameter to itself.
 216     pub fn identity_for_item(tcx: TyCtxt<'tcx>, def_id: DefId) -> SubstsRef<'tcx> {
 217         Self::for_item(tcx, def_id, |param, _| tcx.mk_param_from_def(param))
 218     }
 219
 220     /// Creates an `InternalSubsts` for generic parameter definitions,
 221     /// by calling closures to obtain each kind.
 222     /// The closures get to observe the `InternalSubsts` as they're
 223     /// being built, which can be used to correctly
 224     /// substitute defaults of generic parameters.
 225     pub fn for_item<F>(tcx: TyCtxt<'tcx>, def_id: DefId, mut mk_kind: F) -> SubstsRef<'tcx>
 226     where
 227         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 228     {
 229         let defs = tcx.generics_of(def_id);
 230         let count = defs.count();
 231         let mut substs = SmallVec::with_capacity(count);
 232         Self::fill_item(&mut substs, tcx, defs, &mut mk_kind);
 233         tcx.intern_substs(&substs)
 234     }
 235
 236     pub fn extend_to<F>(&self, tcx: TyCtxt<'tcx>, def_id: DefId, mut mk_kind: F) -> SubstsRef<'tcx>
 237     where
 238         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 239     {
 240         Self::for_item(tcx, def_id, |param, substs| {
 241             self.get(param.index as usize).cloned().unwrap_or_else(|| mk_kind(param, substs))
 242         })
 243     }
 244
 245     pub fn fill_item<F>(
 246         substs: &mut SmallVec<[GenericArg<'tcx>; 8]>,
 247         tcx: TyCtxt<'tcx>,
 248         defs: &ty::Generics,
 249         mk_kind: &mut F,
 250     ) where
 251         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 252     {
 253         if let Some(def_id) = defs.parent {
 254             let parent_defs = tcx.generics_of(def_id);
 255             Self::fill_item(substs, tcx, parent_defs, mk_kind);
 256         }
 257         Self::fill_single(substs, defs, mk_kind)
 258     }
 259
 260     pub fn fill_single<F>(
 261         substs: &mut SmallVec<[GenericArg<'tcx>; 8]>,
 262         defs: &ty::Generics,
 263         mk_kind: &mut F,
 264     ) where
 265         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 266     {
 267         substs.reserve(defs.params.len());
 268         for param in &defs.params {
 269             let kind = mk_kind(param, substs);
 270             assert_eq!(param.index as usize, substs.len());
 271             substs.push(kind);
 272         }
 273     }
 274
 275     pub fn is_noop(&self) -> bool {
 276         self.is_empty()
 277     }
 278
 279     #[inline]
 280     pub fn types(&'a self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> + 'a {
 281         self.iter()
 282             .filter_map(|k| if let GenericArgKind::Type(ty) = k.unpack() { Some(ty) } else { None })
 283     }
 284
 285     #[inline]
 286     pub fn regions(&'a self) -> impl DoubleEndedIterator<Item = ty::Region<'tcx>> + 'a {
 287         self.iter().filter_map(|k| {
 288             if let GenericArgKind::Lifetime(lt) = k.unpack() { Some(lt) } else { None }
 289         })
 290     }
 291
 292     #[inline]
 293     pub fn consts(&'a self) -> impl DoubleEndedIterator<Item = &'tcx ty::Const<'tcx>> + 'a {
 294         self.iter().filter_map(|k| {
 295             if let GenericArgKind::Const(ct) = k.unpack() { Some(ct) } else { None }
 296         })
 297     }
 298
 299     #[inline]
 300     pub fn non_erasable_generics(
 301         &'a self,
 302     ) -> impl DoubleEndedIterator<Item = GenericArgKind<'tcx>> + 'a {
 303         self.iter().filter_map(|k| match k.unpack() {
 304             GenericArgKind::Lifetime(_) => None,
 305             generic => Some(generic),
 306         })
 307     }
 308
 309     #[inline]
 310     pub fn type_at(&self, i: usize) -> Ty<'tcx> {
 311         if let GenericArgKind::Type(ty) = self[i].unpack() {
 312             ty
 313         } else {
 314             bug!("expected type for param #{} in {:?}", i, self);
 315         }
 316     }
 317
 318     #[inline]
 319     pub fn region_at(&self, i: usize) -> ty::Region<'tcx> {
 320         if let GenericArgKind::Lifetime(lt) = self[i].unpack() {
 321             lt
 322         } else {
 323             bug!("expected region for param #{} in {:?}", i, self);
 324         }
 325     }
 326
 327     #[inline]
 328     pub fn const_at(&self, i: usize) -> &'tcx ty::Const<'tcx> {
 329         if let GenericArgKind::Const(ct) = self[i].unpack() {
 330             ct
 331         } else {
 332             bug!("expected const for param #{} in {:?}", i, self);
 333         }
 334     }
 335
 336     #[inline]
 337     pub fn type_for_def(&self, def: &ty::GenericParamDef) -> GenericArg<'tcx> {
 338         self.type_at(def.index as usize).into()
 339     }
 340
 341     /// Transform from substitutions for a child of `source_ancestor`
 342     /// (e.g., a trait or impl) to substitutions for the same child
 343     /// in a different item, with `target_substs` as the base for
 344     /// the target impl/trait, with the source child-specific
 345     /// parameters (e.g., method parameters) on top of that base.
 346     ///
 347     /// For example given:
 348     ///
 349     /// ```no_run
 350     /// trait X<S> { fn f<T>(); }
 351     /// impl<U> X<U> for U { fn f<V>() {} }
 352     /// ```
 353     ///
 354     /// * If `self` is `[Self, S, T]`: the identity substs of `f` in the trait.
 355     /// * If `source_ancestor` is the def_id of the trait.
 356     /// * If `target_substs` is `[U]`, the substs for the impl.
 357     /// * Then we will return `[U, T]`, the subst for `f` in the impl that
 358     ///   are needed for it to match the trait.
 359     pub fn rebase_onto(
 360         &self,
 361         tcx: TyCtxt<'tcx>,
 362         source_ancestor: DefId,
 363         target_substs: SubstsRef<'tcx>,
 364     ) -> SubstsRef<'tcx> {
 365         let defs = tcx.generics_of(source_ancestor);
 366         tcx.mk_substs(target_substs.iter().chain(self.iter().skip(defs.params.len())))
 367     }
 368
 369     pub fn truncate_to(&self, tcx: TyCtxt<'tcx>, generics: &ty::Generics) -> SubstsRef<'tcx> {
 370         tcx.mk_substs(self.iter().take(generics.count()))
 371     }
 372 }
 373
 374 impl<'tcx> TypeFoldable<'tcx> for SubstsRef<'tcx> {
 375     fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Result<Self, F::Error> {
 376         // This code is hot enough that it's worth specializing for the most
 377         // common length lists, to avoid the overhead of `SmallVec` creation.
 378         // The match arms are in order of frequency. The 1, 2, and 0 cases are
 379         // typically hit in 90--99.99% of cases. When folding doesn't change
 380         // the substs, it's faster to reuse the existing substs rather than
 381         // calling `intern_substs`.
 382         match self.len() {
 383             1 => {
 384                 let param0 = self[0].fold_with(folder)?;
 385                 if param0 == self[0] { Ok(self) } else { Ok(folder.tcx().intern_substs(&[param0])) }
 386             }
 387             2 => {
 388                 let param0 = self[0].fold_with(folder)?;
 389                 let param1 = self[1].fold_with(folder)?;
 390                 if param0 == self[0] && param1 == self[1] {
 391                     Ok(self)
 392                 } else {
 393                     Ok(folder.tcx().intern_substs(&[param0, param1]))
 394                 }
 395             }
 396             0 => Ok(self),
 397             _ => {
 398                 let params: SmallVec<[_; 8]> =
 399                     self.iter().map(|k| k.fold_with(folder)).collect::<Result<_, _>>()?;
 400                 if params[..] == self[..] {
 401                     Ok(self)
 402                 } else {
 403                     Ok(folder.tcx().intern_substs(&params))
 404                 }
 405             }
 406         }
 407     }
 408
 409     fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> ControlFlow<V::BreakTy> {
 410         self.iter().try_for_each(|t| t.visit_with(visitor))
 411     }
 412 }
 413
 414 ///////////////////////////////////////////////////////////////////////////
 415 // Public trait `Subst`
 416 //
 417 // Just call `foo.subst(tcx, substs)` to perform a substitution across
 418 // `foo`. Or use `foo.subst_spanned(tcx, substs, Some(span))` when
 419 // there is more information available (for better errors).
 420
 421 pub trait Subst<'tcx>: Sized {
 422     fn subst(self, tcx: TyCtxt<'tcx>, substs: &[GenericArg<'tcx>]) -> Self {
 423         self.subst_spanned(tcx, substs, None)
 424     }
 425
 426     fn subst_spanned(
 427         self,
 428         tcx: TyCtxt<'tcx>,
 429         substs: &[GenericArg<'tcx>],
 430         span: Option<Span>,
 431     ) -> Self;
 432 }
 433
 434 impl<'tcx, T: TypeFoldable<'tcx>> Subst<'tcx> for T {
 435     fn subst_spanned(
 436         self,
 437         tcx: TyCtxt<'tcx>,
 438         substs: &[GenericArg<'tcx>],
 439         span: Option<Span>,
 440     ) -> T {
 441         let mut folder = SubstFolder { tcx, substs, span, binders_passed: 0 };
 442         self.fold_with(&mut folder).into_ok()
 443     }
 444 }
 445
 446 ///////////////////////////////////////////////////////////////////////////
 447 // The actual substitution engine itself is a type folder.
 448
 449 struct SubstFolder<'a, 'tcx> {
 450     tcx: TyCtxt<'tcx>,
 451     substs: &'a [GenericArg<'tcx>],
 452
 453     /// The location for which the substitution is performed, if available.
 454     span: Option<Span>,
 455
 456     /// Number of region binders we have passed through while doing the substitution
 457     binders_passed: u32,
 458 }
 459
 460 impl<'a, 'tcx> TypeFolder<'tcx> for SubstFolder<'a, 'tcx> {
 461     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 462         self.tcx
 463     }
 464
 465     fn fold_binder<T: TypeFoldable<'tcx>>(
 466         &mut self,
 467         t: ty::Binder<'tcx, T>,
 468     ) -> Result<ty::Binder<'tcx, T>, Self::Error> {
 469         self.binders_passed += 1;
 470         let t = t.super_fold_with(self)?;
 471         self.binders_passed -= 1;
 472         Ok(t)
 473     }
 474
 475     fn fold_region(&mut self, r: ty::Region<'tcx>) -> Result<ty::Region<'tcx>, Self::Error> {
 476         // Note: This routine only handles regions that are bound on
 477         // type declarations and other outer declarations, not those
 478         // bound in *fn types*. Region substitution of the bound
 479         // regions that appear in a function signature is done using
 480         // the specialized routine `ty::replace_late_regions()`.
 481         match *r {
 482             ty::ReEarlyBound(data) => {
 483                 let rk = self.substs.get(data.index as usize).map(|k| k.unpack());
 484                 match rk {
 485                     Some(GenericArgKind::Lifetime(lt)) => Ok(self.shift_region_through_binders(lt)),
 486                     _ => {
 487                         let span = self.span.unwrap_or(DUMMY_SP);
 488                         let msg = format!(
 489                             "Region parameter out of range \
 490                              when substituting in region {} (index={})",
 491                             data.name, data.index
 492                         );
 493                         span_bug!(span, "{}", msg);
 494                     }
 495                 }
 496             }
 497             _ => Ok(r),
 498         }
 499     }
 500
 501     fn fold_ty(&mut self, t: Ty<'tcx>) -> Result<Ty<'tcx>, Self::Error> {
 502         if !t.potentially_needs_subst() {
 503             return Ok(t);
 504         }
 505
 506         match *t.kind() {
 507             ty::Param(p) => Ok(self.ty_for_param(p, t)),
 508             _ => t.super_fold_with(self),
 509         }
 510     }
 511
 512     fn fold_const(
 513         &mut self,
 514         c: &'tcx ty::Const<'tcx>,
 515     ) -> Result<&'tcx ty::Const<'tcx>, Self::Error> {
 516         if let ty::ConstKind::Param(p) = c.val {
 517             Ok(self.const_for_param(p, c))
 518         } else {
 519             c.super_fold_with(self)
 520         }
 521     }
 522
 523     #[inline]
 524     fn fold_mir_const(
 525         &mut self,
 526         c: mir::ConstantKind<'tcx>,
 527     ) -> Result<mir::ConstantKind<'tcx>, Self::Error> {
 528         c.super_fold_with(self)
 529     }
 530 }
 531
 532 impl<'a, 'tcx> SubstFolder<'a, 'tcx> {
 533     fn ty_for_param(&self, p: ty::ParamTy, source_ty: Ty<'tcx>) -> Ty<'tcx> {
 534         // Look up the type in the substitutions. It really should be in there.
 535         let opt_ty = self.substs.get(p.index as usize).map(|k| k.unpack());
 536         let ty = match opt_ty {
 537             Some(GenericArgKind::Type(ty)) => ty,
 538             Some(kind) => {
 539                 let span = self.span.unwrap_or(DUMMY_SP);
 540                 span_bug!(
 541                     span,
 542                     "expected type for `{:?}` ({:?}/{}) but found {:?} \
 543                      when substituting, substs={:?}",
 544                     p,
 545                     source_ty,
 546                     p.index,
 547                     kind,
 548                     self.substs,
 549                 );
 550             }
 551             None => {
 552                 let span = self.span.unwrap_or(DUMMY_SP);
 553                 span_bug!(
 554                     span,
 555                     "type parameter `{:?}` ({:?}/{}) out of range \
 556                      when substituting, substs={:?}",
 557                     p,
 558                     source_ty,
 559                     p.index,
 560                     self.substs,
 561                 );
 562             }
 563         };
 564
 565         self.shift_vars_through_binders(ty)
 566     }
 567
 568     fn const_for_param(
 569         &self,
 570         p: ParamConst,
 571         source_ct: &'tcx ty::Const<'tcx>,
 572     ) -> &'tcx ty::Const<'tcx> {
 573         // Look up the const in the substitutions. It really should be in there.
 574         let opt_ct = self.substs.get(p.index as usize).map(|k| k.unpack());
 575         let ct = match opt_ct {
 576             Some(GenericArgKind::Const(ct)) => ct,
 577             Some(kind) => {
 578                 let span = self.span.unwrap_or(DUMMY_SP);
 579                 span_bug!(
 580                     span,
 581                     "expected const for `{:?}` ({:?}/{}) but found {:?} \
 582                      when substituting substs={:?}",
 583                     p,
 584                     source_ct,
 585                     p.index,
 586                     kind,
 587                     self.substs,
 588                 );
 589             }
 590             None => {
 591                 let span = self.span.unwrap_or(DUMMY_SP);
 592                 span_bug!(
 593                     span,
 594                     "const parameter `{:?}` ({:?}/{}) out of range \
 595                      when substituting substs={:?}",
 596                     p,
 597                     source_ct,
 598                     p.index,
 599                     self.substs,
 600                 );
 601             }
 602         };
 603
 604         self.shift_vars_through_binders(ct)
 605     }
 606
 607     /// It is sometimes necessary to adjust the De Bruijn indices during substitution. This occurs
 608     /// when we are substituting a type with escaping bound vars into a context where we have
 609     /// passed through binders. That's quite a mouthful. Let's see an example:
 610     ///
 611     /// ```
 612     /// type Func<A> = fn(A);
 613     /// type MetaFunc = for<'a> fn(Func<&'a i32>)
 614     /// ```
 615     ///
 616     /// The type `MetaFunc`, when fully expanded, will be
 617     ///
 618     ///     for<'a> fn(fn(&'a i32))
 619     ///             ^~ ^~ ^~~
 620     ///             |  |  |
 621     ///             |  |  DebruijnIndex of 2
 622     ///             Binders
 623     ///
 624     /// Here the `'a` lifetime is bound in the outer function, but appears as an argument of the
 625     /// inner one. Therefore, that appearance will have a DebruijnIndex of 2, because we must skip
 626     /// over the inner binder (remember that we count De Bruijn indices from 1). However, in the
 627     /// definition of `MetaFunc`, the binder is not visible, so the type `&'a i32` will have a
 628     /// De Bruijn index of 1. It's only during the substitution that we can see we must increase the
 629     /// depth by 1 to account for the binder that we passed through.
 630     ///
 631     /// As a second example, consider this twist:
 632     ///
 633     /// ```
 634     /// type FuncTuple<A> = (A,fn(A));
 635     /// type MetaFuncTuple = for<'a> fn(FuncTuple<&'a i32>)
 636     /// ```
 637     ///
 638     /// Here the final type will be:
 639     ///
 640     ///     for<'a> fn((&'a i32, fn(&'a i32)))
 641     ///                 ^~~         ^~~
 642     ///                 |           |
 643     ///          DebruijnIndex of 1 |
 644     ///                      DebruijnIndex of 2
 645     ///
 646     /// As indicated in the diagram, here the same type `&'a i32` is substituted once, but in the
 647     /// first case we do not increase the De Bruijn index and in the second case we do. The reason
 648     /// is that only in the second case have we passed through a fn binder.
 649     fn shift_vars_through_binders<T: TypeFoldable<'tcx>>(&self, val: T) -> T {
 650         debug!(
 651             "shift_vars(val={:?}, binders_passed={:?}, has_escaping_bound_vars={:?})",
 652             val,
 653             self.binders_passed,
 654             val.has_escaping_bound_vars()
 655         );
 656
 657         if self.binders_passed == 0 || !val.has_escaping_bound_vars() {
 658             return val;
 659         }
 660
 661         let result = ty::fold::shift_vars(self.tcx(), val, self.binders_passed);
 662         debug!("shift_vars: shifted result = {:?}", result);
 663
 664         result
 665     }
 666
 667     fn shift_region_through_binders(&self, region: ty::Region<'tcx>) -> ty::Region<'tcx> {
 668         if self.binders_passed == 0 || !region.has_escaping_bound_vars() {
 669             return region;
 670         }
 671         ty::fold::shift_region(self.tcx, region, self.binders_passed)
 672     }
 673 }
 674
 675 /// Stores the user-given substs to reach some fully qualified path
 676 /// (e.g., `<T>::Item` or `<T as Trait>::Item`).
 677 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 678 #[derive(HashStable, TypeFoldable, Lift)]
 679 pub struct UserSubsts<'tcx> {
 680     /// The substitutions for the item as given by the user.
 681     pub substs: SubstsRef<'tcx>,
 682
 683     /// The self type, in the case of a `<T>::Item` path (when applied
 684     /// to an inherent impl). See `UserSelfTy` below.
 685     pub user_self_ty: Option<UserSelfTy<'tcx>>,
 686 }
 687
 688 /// Specifies the user-given self type. In the case of a path that
 689 /// refers to a member in an inherent impl, this self type is
 690 /// sometimes needed to constrain the type parameters on the impl. For
 691 /// example, in this code:
 692 ///
 693 /// ```
 694 /// struct Foo<T> { }
 695 /// impl<A> Foo<A> { fn method() { } }
 696 /// ```
 697 ///
 698 /// when you then have a path like `<Foo<&'static u32>>::method`,
 699 /// this struct would carry the `DefId` of the impl along with the
 700 /// self type `Foo<u32>`. Then we can instantiate the parameters of
 701 /// the impl (with the substs from `UserSubsts`) and apply those to
 702 /// the self type, giving `Foo<?A>`. Finally, we unify that with
 703 /// the self type here, which contains `?A` to be `&'static u32`
 704 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 705 #[derive(HashStable, TypeFoldable, Lift)]
 706 pub struct UserSelfTy<'tcx> {
 707     pub impl_def_id: DefId,
 708     pub self_ty: Ty<'tcx>,
 709 }