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};
   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) -> Self {
 157         match self.unpack() {
 158             GenericArgKind::Lifetime(lt) => lt.fold_with(folder).into(),
 159             GenericArgKind::Type(ty) => ty.fold_with(folder).into(),
 160             GenericArgKind::Const(ct) => ct.fold_with(folder).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     /// Creates an `InternalSubsts` that maps each generic parameter to itself.
 208     pub fn identity_for_item(tcx: TyCtxt<'tcx>, def_id: DefId) -> SubstsRef<'tcx> {
 209         Self::for_item(tcx, def_id, |param, _| tcx.mk_param_from_def(param))
 210     }
 211
 212     /// Creates an `InternalSubsts` for generic parameter definitions,
 213     /// by calling closures to obtain each kind.
 214     /// The closures get to observe the `InternalSubsts` as they're
 215     /// being built, which can be used to correctly
 216     /// substitute defaults of generic parameters.
 217     pub fn for_item<F>(tcx: TyCtxt<'tcx>, def_id: DefId, mut mk_kind: F) -> SubstsRef<'tcx>
 218     where
 219         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 220     {
 221         let defs = tcx.generics_of(def_id);
 222         let count = defs.count();
 223         let mut substs = SmallVec::with_capacity(count);
 224         Self::fill_item(&mut substs, tcx, defs, &mut mk_kind);
 225         tcx.intern_substs(&substs)
 226     }
 227
 228     pub fn extend_to<F>(&self, tcx: TyCtxt<'tcx>, def_id: DefId, mut mk_kind: F) -> SubstsRef<'tcx>
 229     where
 230         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 231     {
 232         Self::for_item(tcx, def_id, |param, substs| {
 233             self.get(param.index as usize).cloned().unwrap_or_else(|| mk_kind(param, substs))
 234         })
 235     }
 236
 237     pub fn fill_item<F>(
 238         substs: &mut SmallVec<[GenericArg<'tcx>; 8]>,
 239         tcx: TyCtxt<'tcx>,
 240         defs: &ty::Generics,
 241         mk_kind: &mut F,
 242     ) where
 243         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 244     {
 245         if let Some(def_id) = defs.parent {
 246             let parent_defs = tcx.generics_of(def_id);
 247             Self::fill_item(substs, tcx, parent_defs, mk_kind);
 248         }
 249         Self::fill_single(substs, defs, mk_kind)
 250     }
 251
 252     pub fn fill_single<F>(
 253         substs: &mut SmallVec<[GenericArg<'tcx>; 8]>,
 254         defs: &ty::Generics,
 255         mk_kind: &mut F,
 256     ) where
 257         F: FnMut(&ty::GenericParamDef, &[GenericArg<'tcx>]) -> GenericArg<'tcx>,
 258     {
 259         substs.reserve(defs.params.len());
 260         for param in &defs.params {
 261             let kind = mk_kind(param, substs);
 262             assert_eq!(param.index as usize, substs.len());
 263             substs.push(kind);
 264         }
 265     }
 266
 267     pub fn is_noop(&self) -> bool {
 268         self.is_empty()
 269     }
 270
 271     #[inline]
 272     pub fn types(&'a self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> + 'a {
 273         self.iter()
 274             .filter_map(|k| if let GenericArgKind::Type(ty) = k.unpack() { Some(ty) } else { None })
 275     }
 276
 277     #[inline]
 278     pub fn regions(&'a self) -> impl DoubleEndedIterator<Item = ty::Region<'tcx>> + 'a {
 279         self.iter().filter_map(|k| {
 280             if let GenericArgKind::Lifetime(lt) = k.unpack() { Some(lt) } else { None }
 281         })
 282     }
 283
 284     #[inline]
 285     pub fn consts(&'a self) -> impl DoubleEndedIterator<Item = &'tcx ty::Const<'tcx>> + 'a {
 286         self.iter().filter_map(|k| {
 287             if let GenericArgKind::Const(ct) = k.unpack() { Some(ct) } else { None }
 288         })
 289     }
 290
 291     #[inline]
 292     pub fn non_erasable_generics(
 293         &'a self,
 294     ) -> impl DoubleEndedIterator<Item = GenericArgKind<'tcx>> + 'a {
 295         self.iter().filter_map(|k| match k.unpack() {
 296             GenericArgKind::Lifetime(_) => None,
 297             generic => Some(generic),
 298         })
 299     }
 300
 301     #[inline]
 302     pub fn type_at(&self, i: usize) -> Ty<'tcx> {
 303         if let GenericArgKind::Type(ty) = self[i].unpack() {
 304             ty
 305         } else {
 306             bug!("expected type for param #{} in {:?}", i, self);
 307         }
 308     }
 309
 310     #[inline]
 311     pub fn region_at(&self, i: usize) -> ty::Region<'tcx> {
 312         if let GenericArgKind::Lifetime(lt) = self[i].unpack() {
 313             lt
 314         } else {
 315             bug!("expected region for param #{} in {:?}", i, self);
 316         }
 317     }
 318
 319     #[inline]
 320     pub fn const_at(&self, i: usize) -> &'tcx ty::Const<'tcx> {
 321         if let GenericArgKind::Const(ct) = self[i].unpack() {
 322             ct
 323         } else {
 324             bug!("expected const for param #{} in {:?}", i, self);
 325         }
 326     }
 327
 328     #[inline]
 329     pub fn type_for_def(&self, def: &ty::GenericParamDef) -> GenericArg<'tcx> {
 330         self.type_at(def.index as usize).into()
 331     }
 332
 333     /// Transform from substitutions for a child of `source_ancestor`
 334     /// (e.g., a trait or impl) to substitutions for the same child
 335     /// in a different item, with `target_substs` as the base for
 336     /// the target impl/trait, with the source child-specific
 337     /// parameters (e.g., method parameters) on top of that base.
 338     ///
 339     /// For example given:
 340     ///
 341     /// ```no_run
 342     /// trait X<S> { fn f<T>(); }
 343     /// impl<U> X<U> for U { fn f<V>() {} }
 344     /// ```
 345     ///
 346     /// * If `self` is `[Self, S, T]`: the identity substs of `f` in the trait.
 347     /// * If `source_ancestor` is the def_id of the trait.
 348     /// * If `target_substs` is `[U]`, the substs for the impl.
 349     /// * Then we will return `[U, T]`, the subst for `f` in the impl that
 350     ///   are needed for it to match the trait.
 351     pub fn rebase_onto(
 352         &self,
 353         tcx: TyCtxt<'tcx>,
 354         source_ancestor: DefId,
 355         target_substs: SubstsRef<'tcx>,
 356     ) -> SubstsRef<'tcx> {
 357         let defs = tcx.generics_of(source_ancestor);
 358         tcx.mk_substs(target_substs.iter().chain(self.iter().skip(defs.params.len())))
 359     }
 360
 361     pub fn truncate_to(&self, tcx: TyCtxt<'tcx>, generics: &ty::Generics) -> SubstsRef<'tcx> {
 362         tcx.mk_substs(self.iter().take(generics.count()))
 363     }
 364 }
 365
 366 impl<'tcx> TypeFoldable<'tcx> for SubstsRef<'tcx> {
 367     fn super_fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self {
 368         // This code is hot enough that it's worth specializing for the most
 369         // common length lists, to avoid the overhead of `SmallVec` creation.
 370         // The match arms are in order of frequency. The 1, 2, and 0 cases are
 371         // typically hit in 90--99.99% of cases. When folding doesn't change
 372         // the substs, it's faster to reuse the existing substs rather than
 373         // calling `intern_substs`.
 374         match self.len() {
 375             1 => {
 376                 let param0 = self[0].fold_with(folder);
 377                 if param0 == self[0] { self } else { folder.tcx().intern_substs(&[param0]) }
 378             }
 379             2 => {
 380                 let param0 = self[0].fold_with(folder);
 381                 let param1 = self[1].fold_with(folder);
 382                 if param0 == self[0] && param1 == self[1] {
 383                     self
 384                 } else {
 385                     folder.tcx().intern_substs(&[param0, param1])
 386                 }
 387             }
 388             0 => self,
 389             _ => {
 390                 let params: SmallVec<[_; 8]> = self.iter().map(|k| k.fold_with(folder)).collect();
 391                 if params[..] == self[..] { self } else { folder.tcx().intern_substs(&params) }
 392             }
 393         }
 394     }
 395
 396     fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> ControlFlow<V::BreakTy> {
 397         self.iter().try_for_each(|t| t.visit_with(visitor))
 398     }
 399 }
 400
 401 ///////////////////////////////////////////////////////////////////////////
 402 // Public trait `Subst`
 403 //
 404 // Just call `foo.subst(tcx, substs)` to perform a substitution across
 405 // `foo`. Or use `foo.subst_spanned(tcx, substs, Some(span))` when
 406 // there is more information available (for better errors).
 407
 408 pub trait Subst<'tcx>: Sized {
 409     fn subst(self, tcx: TyCtxt<'tcx>, substs: &[GenericArg<'tcx>]) -> Self {
 410         self.subst_spanned(tcx, substs, None)
 411     }
 412
 413     fn subst_spanned(
 414         self,
 415         tcx: TyCtxt<'tcx>,
 416         substs: &[GenericArg<'tcx>],
 417         span: Option<Span>,
 418     ) -> Self;
 419 }
 420
 421 impl<'tcx, T: TypeFoldable<'tcx>> Subst<'tcx> for T {
 422     fn subst_spanned(
 423         self,
 424         tcx: TyCtxt<'tcx>,
 425         substs: &[GenericArg<'tcx>],
 426         span: Option<Span>,
 427     ) -> T {
 428         let mut folder = SubstFolder { tcx, substs, span, binders_passed: 0 };
 429         self.fold_with(&mut folder)
 430     }
 431 }
 432
 433 ///////////////////////////////////////////////////////////////////////////
 434 // The actual substitution engine itself is a type folder.
 435
 436 struct SubstFolder<'a, 'tcx> {
 437     tcx: TyCtxt<'tcx>,
 438     substs: &'a [GenericArg<'tcx>],
 439
 440     /// The location for which the substitution is performed, if available.
 441     span: Option<Span>,
 442
 443     /// Number of region binders we have passed through while doing the substitution
 444     binders_passed: u32,
 445 }
 446
 447 impl<'a, 'tcx> TypeFolder<'tcx> for SubstFolder<'a, 'tcx> {
 448     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 449         self.tcx
 450     }
 451
 452     fn fold_binder<T: TypeFoldable<'tcx>>(
 453         &mut self,
 454         t: ty::Binder<'tcx, T>,
 455     ) -> ty::Binder<'tcx, T> {
 456         self.binders_passed += 1;
 457         let t = t.super_fold_with(self);
 458         self.binders_passed -= 1;
 459         t
 460     }
 461
 462     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 463         // Note: This routine only handles regions that are bound on
 464         // type declarations and other outer declarations, not those
 465         // bound in *fn types*. Region substitution of the bound
 466         // regions that appear in a function signature is done using
 467         // the specialized routine `ty::replace_late_regions()`.
 468         match *r {
 469             ty::ReEarlyBound(data) => {
 470                 let rk = self.substs.get(data.index as usize).map(|k| k.unpack());
 471                 match rk {
 472                     Some(GenericArgKind::Lifetime(lt)) => self.shift_region_through_binders(lt),
 473                     _ => {
 474                         let span = self.span.unwrap_or(DUMMY_SP);
 475                         let msg = format!(
 476                             "Region parameter out of range \
 477                              when substituting in region {} (index={})",
 478                             data.name, data.index
 479                         );
 480                         span_bug!(span, "{}", msg);
 481                     }
 482                 }
 483             }
 484             _ => r,
 485         }
 486     }
 487
 488     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 489         if !t.potentially_needs_subst() {
 490             return t;
 491         }
 492
 493         match *t.kind() {
 494             ty::Param(p) => self.ty_for_param(p, t),
 495             _ => t.super_fold_with(self),
 496         }
 497     }
 498
 499     fn fold_const(&mut self, c: &'tcx ty::Const<'tcx>) -> &'tcx ty::Const<'tcx> {
 500         if let ty::ConstKind::Param(p) = c.val {
 501             self.const_for_param(p, c)
 502         } else {
 503             c.super_fold_with(self)
 504         }
 505     }
 506
 507     #[inline]
 508     fn fold_mir_const(&mut self, c: mir::ConstantKind<'tcx>) -> mir::ConstantKind<'tcx> {
 509         c.super_fold_with(self)
 510     }
 511 }
 512
 513 impl<'a, 'tcx> SubstFolder<'a, 'tcx> {
 514     fn ty_for_param(&self, p: ty::ParamTy, source_ty: Ty<'tcx>) -> Ty<'tcx> {
 515         // Look up the type in the substitutions. It really should be in there.
 516         let opt_ty = self.substs.get(p.index as usize).map(|k| k.unpack());
 517         let ty = match opt_ty {
 518             Some(GenericArgKind::Type(ty)) => ty,
 519             Some(kind) => {
 520                 let span = self.span.unwrap_or(DUMMY_SP);
 521                 span_bug!(
 522                     span,
 523                     "expected type for `{:?}` ({:?}/{}) but found {:?} \
 524                      when substituting, substs={:?}",
 525                     p,
 526                     source_ty,
 527                     p.index,
 528                     kind,
 529                     self.substs,
 530                 );
 531             }
 532             None => {
 533                 let span = self.span.unwrap_or(DUMMY_SP);
 534                 span_bug!(
 535                     span,
 536                     "type parameter `{:?}` ({:?}/{}) out of range \
 537                      when substituting, substs={:?}",
 538                     p,
 539                     source_ty,
 540                     p.index,
 541                     self.substs,
 542                 );
 543             }
 544         };
 545
 546         self.shift_vars_through_binders(ty)
 547     }
 548
 549     fn const_for_param(
 550         &self,
 551         p: ParamConst,
 552         source_ct: &'tcx ty::Const<'tcx>,
 553     ) -> &'tcx ty::Const<'tcx> {
 554         // Look up the const in the substitutions. It really should be in there.
 555         let opt_ct = self.substs.get(p.index as usize).map(|k| k.unpack());
 556         let ct = match opt_ct {
 557             Some(GenericArgKind::Const(ct)) => ct,
 558             Some(kind) => {
 559                 let span = self.span.unwrap_or(DUMMY_SP);
 560                 span_bug!(
 561                     span,
 562                     "expected const for `{:?}` ({:?}/{}) but found {:?} \
 563                      when substituting substs={:?}",
 564                     p,
 565                     source_ct,
 566                     p.index,
 567                     kind,
 568                     self.substs,
 569                 );
 570             }
 571             None => {
 572                 let span = self.span.unwrap_or(DUMMY_SP);
 573                 span_bug!(
 574                     span,
 575                     "const parameter `{:?}` ({:?}/{}) out of range \
 576                      when substituting substs={:?}",
 577                     p,
 578                     source_ct,
 579                     p.index,
 580                     self.substs,
 581                 );
 582             }
 583         };
 584
 585         self.shift_vars_through_binders(ct)
 586     }
 587
 588     /// It is sometimes necessary to adjust the De Bruijn indices during substitution. This occurs
 589     /// when we are substituting a type with escaping bound vars into a context where we have
 590     /// passed through binders. That's quite a mouthful. Let's see an example:
 591     ///
 592     /// ```
 593     /// type Func<A> = fn(A);
 594     /// type MetaFunc = for<'a> fn(Func<&'a i32>)
 595     /// ```
 596     ///
 597     /// The type `MetaFunc`, when fully expanded, will be
 598     ///
 599     ///     for<'a> fn(fn(&'a i32))
 600     ///             ^~ ^~ ^~~
 601     ///             |  |  |
 602     ///             |  |  DebruijnIndex of 2
 603     ///             Binders
 604     ///
 605     /// Here the `'a` lifetime is bound in the outer function, but appears as an argument of the
 606     /// inner one. Therefore, that appearance will have a DebruijnIndex of 2, because we must skip
 607     /// over the inner binder (remember that we count De Bruijn indices from 1). However, in the
 608     /// definition of `MetaFunc`, the binder is not visible, so the type `&'a i32` will have a
 609     /// De Bruijn index of 1. It's only during the substitution that we can see we must increase the
 610     /// depth by 1 to account for the binder that we passed through.
 611     ///
 612     /// As a second example, consider this twist:
 613     ///
 614     /// ```
 615     /// type FuncTuple<A> = (A,fn(A));
 616     /// type MetaFuncTuple = for<'a> fn(FuncTuple<&'a i32>)
 617     /// ```
 618     ///
 619     /// Here the final type will be:
 620     ///
 621     ///     for<'a> fn((&'a i32, fn(&'a i32)))
 622     ///                 ^~~         ^~~
 623     ///                 |           |
 624     ///          DebruijnIndex of 1 |
 625     ///                      DebruijnIndex of 2
 626     ///
 627     /// As indicated in the diagram, here the same type `&'a i32` is substituted once, but in the
 628     /// first case we do not increase the De Bruijn index and in the second case we do. The reason
 629     /// is that only in the second case have we passed through a fn binder.
 630     fn shift_vars_through_binders<T: TypeFoldable<'tcx>>(&self, val: T) -> T {
 631         debug!(
 632             "shift_vars(val={:?}, binders_passed={:?}, has_escaping_bound_vars={:?})",
 633             val,
 634             self.binders_passed,
 635             val.has_escaping_bound_vars()
 636         );
 637
 638         if self.binders_passed == 0 || !val.has_escaping_bound_vars() {
 639             return val;
 640         }
 641
 642         let result = ty::fold::shift_vars(self.tcx(), val, self.binders_passed);
 643         debug!("shift_vars: shifted result = {:?}", result);
 644
 645         result
 646     }
 647
 648     fn shift_region_through_binders(&self, region: ty::Region<'tcx>) -> ty::Region<'tcx> {
 649         if self.binders_passed == 0 || !region.has_escaping_bound_vars() {
 650             return region;
 651         }
 652         ty::fold::shift_region(self.tcx, region, self.binders_passed)
 653     }
 654 }
 655
 656 /// Stores the user-given substs to reach some fully qualified path
 657 /// (e.g., `<T>::Item` or `<T as Trait>::Item`).
 658 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 659 #[derive(HashStable, TypeFoldable, Lift)]
 660 pub struct UserSubsts<'tcx> {
 661     /// The substitutions for the item as given by the user.
 662     pub substs: SubstsRef<'tcx>,
 663
 664     /// The self type, in the case of a `<T>::Item` path (when applied
 665     /// to an inherent impl). See `UserSelfTy` below.
 666     pub user_self_ty: Option<UserSelfTy<'tcx>>,
 667 }
 668
 669 /// Specifies the user-given self type. In the case of a path that
 670 /// refers to a member in an inherent impl, this self type is
 671 /// sometimes needed to constrain the type parameters on the impl. For
 672 /// example, in this code:
 673 ///
 674 /// ```
 675 /// struct Foo<T> { }
 676 /// impl<A> Foo<A> { fn method() { } }
 677 /// ```
 678 ///
 679 /// when you then have a path like `<Foo<&'static u32>>::method`,
 680 /// this struct would carry the `DefId` of the impl along with the
 681 /// self type `Foo<u32>`. Then we can instantiate the parameters of
 682 /// the impl (with the substs from `UserSubsts`) and apply those to
 683 /// the self type, giving `Foo<?A>`. Finally, we unify that with
 684 /// the self type here, which contains `?A` to be `&'static u32`
 685 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
 686 #[derive(HashStable, TypeFoldable, Lift)]
 687 pub struct UserSelfTy<'tcx> {
 688     pub impl_def_id: DefId,
 689     pub self_ty: Ty<'tcx>,
 690 }