src/librustc/ty/fold.rs

   1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Generalized type folding mechanism. The setup is a bit convoluted
  12 //! but allows for convenient usage. Let T be an instance of some
  13 //! "foldable type" (one which implements `TypeFoldable`) and F be an
  14 //! instance of a "folder" (a type which implements `TypeFolder`). Then
  15 //! the setup is intended to be:
  16 //!
  17 //!   T.fold_with(F) --calls--> F.fold_T(T) --calls--> T.super_fold_with(F)
  18 //!
  19 //! This way, when you define a new folder F, you can override
  20 //! `fold_T()` to customize the behavior, and invoke `T.super_fold_with()`
  21 //! to get the original behavior. Meanwhile, to actually fold
  22 //! something, you can just write `T.fold_with(F)`, which is
  23 //! convenient. (Note that `fold_with` will also transparently handle
  24 //! things like a `Vec<T>` where T is foldable and so on.)
  25 //!
  26 //! In this ideal setup, the only function that actually *does*
  27 //! anything is `T.super_fold_with()`, which traverses the type `T`.
  28 //! Moreover, `T.super_fold_with()` should only ever call `T.fold_with()`.
  29 //!
  30 //! In some cases, we follow a degenerate pattern where we do not have
  31 //! a `fold_T` method. Instead, `T.fold_with` traverses the structure directly.
  32 //! This is suboptimal because the behavior cannot be overridden, but it's
  33 //! much less work to implement. If you ever *do* need an override that
  34 //! doesn't exist, it's not hard to convert the degenerate pattern into the
  35 //! proper thing.
  36 //!
  37 //! A `TypeFoldable` T can also be visited by a `TypeVisitor` V using similar setup:
  38 //!   T.visit_with(V) --calls--> V.visit_T(T) --calls--> T.super_visit_with(V).
  39 //! These methods return true to indicate that the visitor has found what it is looking for
  40 //! and does not need to visit anything else.
  41
  42 use middle::const_val::ConstVal;
  43 use hir::def_id::DefId;
  44 use ty::{self, Binder, Ty, TyCtxt, TypeFlags};
  45
  46 use std::collections::BTreeMap;
  47 use std::fmt;
  48 use util::nodemap::FxHashSet;
  49
  50 /// The TypeFoldable trait is implemented for every type that can be folded.
  51 /// Basically, every type that has a corresponding method in TypeFolder.
  52 ///
  53 /// To implement this conveniently, use the
  54 /// `BraceStructTypeFoldableImpl` etc macros found in `macros.rs`.
  55 pub trait TypeFoldable<'tcx>: fmt::Debug + Clone {
  56     fn super_fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self;
  57     fn fold_with<'gcx: 'tcx, F: TypeFolder<'gcx, 'tcx>>(&self, folder: &mut F) -> Self {
  58         self.super_fold_with(folder)
  59     }
  60
  61     fn super_visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool;
  62     fn visit_with<V: TypeVisitor<'tcx>>(&self, visitor: &mut V) -> bool {
  63         self.super_visit_with(visitor)
  64     }
  65
  66     /// True if `self` has any late-bound regions that are either
  67     /// bound by `binder` or bound by some binder outside of `binder`.
  68     /// If `binder` is `ty::INNERMOST`, this indicates whether
  69     /// there are any late-bound regions that appear free.
  70     fn has_regions_bound_at_or_above(&self, binder: ty::DebruijnIndex) -> bool {
  71         self.visit_with(&mut HasEscapingRegionsVisitor { outer_index: binder })
  72     }
  73
  74     /// True if this `self` has any regions that escape `binder` (and
  75     /// hence are not bound by it).
  76     fn has_regions_bound_above(&self, binder: ty::DebruijnIndex) -> bool {
  77         self.has_regions_bound_at_or_above(binder.shifted_in(1))
  78     }
  79
  80     fn has_escaping_regions(&self) -> bool {
  81         self.has_regions_bound_at_or_above(ty::INNERMOST)
  82     }
  83
  84     fn has_type_flags(&self, flags: TypeFlags) -> bool {
  85         self.visit_with(&mut HasTypeFlagsVisitor { flags: flags })
  86     }
  87     fn has_projections(&self) -> bool {
  88         self.has_type_flags(TypeFlags::HAS_PROJECTION)
  89     }
  90     fn references_error(&self) -> bool {
  91         self.has_type_flags(TypeFlags::HAS_TY_ERR)
  92     }
  93     fn has_param_types(&self) -> bool {
  94         self.has_type_flags(TypeFlags::HAS_PARAMS)
  95     }
  96     fn has_self_ty(&self) -> bool {
  97         self.has_type_flags(TypeFlags::HAS_SELF)
  98     }
  99     fn has_infer_types(&self) -> bool {
 100         self.has_type_flags(TypeFlags::HAS_TY_INFER)
 101     }
 102     fn needs_infer(&self) -> bool {
 103         self.has_type_flags(TypeFlags::HAS_TY_INFER | TypeFlags::HAS_RE_INFER)
 104     }
 105     fn has_skol(&self) -> bool {
 106         self.has_type_flags(TypeFlags::HAS_RE_SKOL)
 107     }
 108     fn needs_subst(&self) -> bool {
 109         self.has_type_flags(TypeFlags::NEEDS_SUBST)
 110     }
 111     fn has_re_skol(&self) -> bool {
 112         self.has_type_flags(TypeFlags::HAS_RE_SKOL)
 113     }
 114     fn has_closure_types(&self) -> bool {
 115         self.has_type_flags(TypeFlags::HAS_TY_CLOSURE)
 116     }
 117     /// "Free" regions in this context means that it has any region
 118     /// that is not (a) erased or (b) late-bound.
 119     fn has_free_regions(&self) -> bool {
 120         self.has_type_flags(TypeFlags::HAS_FREE_REGIONS)
 121     }
 122
 123     /// True if there any any un-erased free regions.
 124     fn has_erasable_regions(&self) -> bool {
 125         self.has_type_flags(TypeFlags::HAS_FREE_REGIONS)
 126     }
 127
 128     /// Indicates whether this value references only 'global'
 129     /// types/lifetimes that are the same regardless of what fn we are
 130     /// in. This is used for caching.
 131     fn is_global(&self) -> bool {
 132         !self.has_type_flags(TypeFlags::HAS_FREE_LOCAL_NAMES)
 133     }
 134
 135     /// True if there are any late-bound regions
 136     fn has_late_bound_regions(&self) -> bool {
 137         self.has_type_flags(TypeFlags::HAS_RE_LATE_BOUND)
 138     }
 139 }
 140
 141 /// The TypeFolder trait defines the actual *folding*. There is a
 142 /// method defined for every foldable type. Each of these has a
 143 /// default implementation that does an "identity" fold. Within each
 144 /// identity fold, it should invoke `foo.fold_with(self)` to fold each
 145 /// sub-item.
 146 pub trait TypeFolder<'gcx: 'tcx, 'tcx> : Sized {
 147     fn tcx<'a>(&'a self) -> TyCtxt<'a, 'gcx, 'tcx>;
 148
 149     fn fold_binder<T>(&mut self, t: &Binder<T>) -> Binder<T>
 150         where T : TypeFoldable<'tcx>
 151     {
 152         t.super_fold_with(self)
 153     }
 154
 155     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 156         t.super_fold_with(self)
 157     }
 158
 159     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 160         r.super_fold_with(self)
 161     }
 162
 163     fn fold_const(&mut self, c: &'tcx ty::Const<'tcx>) -> &'tcx ty::Const<'tcx> {
 164         c.super_fold_with(self)
 165     }
 166 }
 167
 168 pub trait TypeVisitor<'tcx> : Sized {
 169     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 170         t.super_visit_with(self)
 171     }
 172
 173     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
 174         t.super_visit_with(self)
 175     }
 176
 177     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 178         r.super_visit_with(self)
 179     }
 180
 181     fn visit_const(&mut self, c: &'tcx ty::Const<'tcx>) -> bool {
 182         c.super_visit_with(self)
 183     }
 184 }
 185
 186 ///////////////////////////////////////////////////////////////////////////
 187 // Some sample folders
 188
 189 pub struct BottomUpFolder<'a, 'gcx: 'a+'tcx, 'tcx: 'a, F>
 190     where F: FnMut(Ty<'tcx>) -> Ty<'tcx>
 191 {
 192     pub tcx: TyCtxt<'a, 'gcx, 'tcx>,
 193     pub fldop: F,
 194 }
 195
 196 impl<'a, 'gcx, 'tcx, F> TypeFolder<'gcx, 'tcx> for BottomUpFolder<'a, 'gcx, 'tcx, F>
 197     where F: FnMut(Ty<'tcx>) -> Ty<'tcx>,
 198 {
 199     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> { self.tcx }
 200
 201     fn fold_ty(&mut self, ty: Ty<'tcx>) -> Ty<'tcx> {
 202         let t1 = ty.super_fold_with(self);
 203         (self.fldop)(t1)
 204     }
 205 }
 206
 207 ///////////////////////////////////////////////////////////////////////////
 208 // Region folder
 209
 210 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 211     /// Collects the free and escaping regions in `value` into `region_set`. Returns
 212     /// whether any late-bound regions were skipped
 213     pub fn collect_regions<T>(self,
 214         value: &T,
 215         region_set: &mut FxHashSet<ty::Region<'tcx>>)
 216         -> bool
 217         where T : TypeFoldable<'tcx>
 218     {
 219         let mut have_bound_regions = false;
 220         self.fold_regions(value, &mut have_bound_regions, |r, d| {
 221             region_set.insert(self.mk_region(r.shifted_out_to_binder(d)));
 222             r
 223         });
 224         have_bound_regions
 225     }
 226
 227     /// Folds the escaping and free regions in `value` using `f`, and
 228     /// sets `skipped_regions` to true if any late-bound region was found
 229     /// and skipped.
 230     pub fn fold_regions<T>(
 231         self,
 232         value: &T,
 233         skipped_regions: &mut bool,
 234         mut f: impl FnMut(ty::Region<'tcx>, ty::DebruijnIndex) -> ty::Region<'tcx>,
 235     ) -> T
 236     where
 237         T : TypeFoldable<'tcx>,
 238     {
 239         value.fold_with(&mut RegionFolder::new(self, skipped_regions, &mut f))
 240     }
 241
 242     pub fn for_each_free_region<T,F>(self,
 243                                      value: &T,
 244                                      callback: F)
 245         where F: FnMut(ty::Region<'tcx>),
 246               T: TypeFoldable<'tcx>,
 247     {
 248         value.visit_with(&mut RegionVisitor {
 249             outer_index: ty::INNERMOST,
 250             callback
 251         });
 252
 253         struct RegionVisitor<F> {
 254             /// The index of a binder *just outside* the things we have
 255             /// traversed. If we encounter a bound region bound by this
 256             /// binder or one outer to it, it appears free. Example:
 257             ///
 258             /// ```
 259             ///    for<'a> fn(for<'b> fn(), T)
 260             /// ^          ^          ^     ^
 261             /// |          |          |     | here, would be shifted in 1
 262             /// |          |          | here, would be shifted in 2
 263             /// |          | here, would be INNERMOST shifted in by 1
 264             /// | here, initially, binder would be INNERMOST
 265             /// ```
 266             ///
 267             /// You see that, initially, *any* bound value is free,
 268             /// because we've not traversed any binders. As we pass
 269             /// through a binder, we shift the `outer_index` by 1 to
 270             /// account for the new binder that encloses us.
 271             outer_index: ty::DebruijnIndex,
 272             callback: F,
 273         }
 274
 275         impl<'tcx, F> TypeVisitor<'tcx> for RegionVisitor<F>
 276             where F : FnMut(ty::Region<'tcx>)
 277         {
 278             fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 279                 self.outer_index.shift_in(1);
 280                 t.skip_binder().visit_with(self);
 281                 self.outer_index.shift_out(1);
 282
 283                 false // keep visiting
 284             }
 285
 286             fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 287                 match *r {
 288                     ty::ReLateBound(debruijn, _) if debruijn < self.outer_index => {
 289                         /* ignore bound regions */
 290                     }
 291                     _ => (self.callback)(r),
 292                 }
 293
 294                 false // keep visiting
 295             }
 296         }
 297     }
 298 }
 299
 300 /// Folds over the substructure of a type, visiting its component
 301 /// types and all regions that occur *free* within it.
 302 ///
 303 /// That is, `Ty` can contain function or method types that bind
 304 /// regions at the call site (`ReLateBound`), and occurrences of
 305 /// regions (aka "lifetimes") that are bound within a type are not
 306 /// visited by this folder; only regions that occur free will be
 307 /// visited by `fld_r`.
 308
 309 pub struct RegionFolder<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 310     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 311     skipped_regions: &'a mut bool,
 312
 313     /// Stores the index of a binder *just outside* the stuff we have
 314     /// visited.  So this begins as INNERMOST; when we pass through a
 315     /// binder, it is incremented (via `shift_in`).
 316     current_index: ty::DebruijnIndex,
 317
 318     /// Callback invokes for each free region. The `DebruijnIndex`
 319     /// points to the binder *just outside* the ones we have passed
 320     /// through.
 321     fold_region_fn: &'a mut (dyn FnMut(
 322         ty::Region<'tcx>,
 323         ty::DebruijnIndex,
 324     ) -> ty::Region<'tcx> + 'a),
 325 }
 326
 327 impl<'a, 'gcx, 'tcx> RegionFolder<'a, 'gcx, 'tcx> {
 328     pub fn new(
 329         tcx: TyCtxt<'a, 'gcx, 'tcx>,
 330         skipped_regions: &'a mut bool,
 331         fold_region_fn: &'a mut dyn FnMut(ty::Region<'tcx>, ty::DebruijnIndex) -> ty::Region<'tcx>,
 332     ) -> RegionFolder<'a, 'gcx, 'tcx> {
 333         RegionFolder {
 334             tcx,
 335             skipped_regions,
 336             current_index: ty::INNERMOST,
 337             fold_region_fn,
 338         }
 339     }
 340 }
 341
 342 impl<'a, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for RegionFolder<'a, 'gcx, 'tcx> {
 343     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> { self.tcx }
 344
 345     fn fold_binder<T: TypeFoldable<'tcx>>(&mut self, t: &ty::Binder<T>) -> ty::Binder<T> {
 346         self.current_index.shift_in(1);
 347         let t = t.super_fold_with(self);
 348         self.current_index.shift_out(1);
 349         t
 350     }
 351
 352     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 353         match *r {
 354             ty::ReLateBound(debruijn, _) if debruijn < self.current_index => {
 355                 debug!("RegionFolder.fold_region({:?}) skipped bound region (current index={:?})",
 356                        r, self.current_index);
 357                 *self.skipped_regions = true;
 358                 r
 359             }
 360             _ => {
 361                 debug!("RegionFolder.fold_region({:?}) folding free region (current_index={:?})",
 362                        r, self.current_index);
 363                 (self.fold_region_fn)(r, self.current_index)
 364             }
 365         }
 366     }
 367 }
 368
 369 ///////////////////////////////////////////////////////////////////////////
 370 // Late-bound region replacer
 371
 372 // Replaces the escaping regions in a type.
 373
 374 struct RegionReplacer<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 375     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 376
 377     /// As with `RegionFolder`, represents the index of a binder *just outside*
 378     /// the ones we have visited.
 379     current_index: ty::DebruijnIndex,
 380
 381     fld_r: &'a mut (dyn FnMut(ty::BoundRegion) -> ty::Region<'tcx> + 'a),
 382     map: BTreeMap<ty::BoundRegion, ty::Region<'tcx>>
 383 }
 384
 385 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 386     /// Replace all regions bound by the given `Binder` with the
 387     /// results returned by the closure; the closure is expected to
 388     /// return a free region (relative to this binder), and hence the
 389     /// binder is removed in the return type. The closure is invoked
 390     /// once for each unique `BoundRegion`; multiple references to the
 391     /// same `BoundRegion` will reuse the previous result.  A map is
 392     /// returned at the end with each bound region and the free region
 393     /// that replaced it.
 394     pub fn replace_late_bound_regions<T,F>(self,
 395         value: &Binder<T>,
 396         mut f: F)
 397         -> (T, BTreeMap<ty::BoundRegion, ty::Region<'tcx>>)
 398         where F : FnMut(ty::BoundRegion) -> ty::Region<'tcx>,
 399               T : TypeFoldable<'tcx>,
 400     {
 401         let mut replacer = RegionReplacer::new(self, &mut f);
 402         let result = value.skip_binder().fold_with(&mut replacer);
 403         (result, replacer.map)
 404     }
 405
 406     /// Replace any late-bound regions bound in `value` with
 407     /// free variants attached to `all_outlive_scope`.
 408     pub fn liberate_late_bound_regions<T>(
 409         &self,
 410         all_outlive_scope: DefId,
 411         value: &ty::Binder<T>
 412     ) -> T
 413     where T: TypeFoldable<'tcx> {
 414         self.replace_late_bound_regions(value, |br| {
 415             self.mk_region(ty::ReFree(ty::FreeRegion {
 416                 scope: all_outlive_scope,
 417                 bound_region: br
 418             }))
 419         }).0
 420     }
 421
 422     /// Flattens multiple binding levels into one. So `for<'a> for<'b> Foo`
 423     /// becomes `for<'a,'b> Foo`.
 424     pub fn flatten_late_bound_regions<T>(self, bound2_value: &Binder<Binder<T>>)
 425                                          -> Binder<T>
 426         where T: TypeFoldable<'tcx>
 427     {
 428         let bound0_value = bound2_value.skip_binder().skip_binder();
 429         let value = self.fold_regions(bound0_value, &mut false, |region, current_depth| {
 430             match *region {
 431                 ty::ReLateBound(debruijn, br) => {
 432                     // We assume no regions bound *outside* of the
 433                     // binders in `bound2_value` (nmatsakis added in
 434                     // the course of this PR; seems like a reasonable
 435                     // sanity check though).
 436                     assert!(debruijn == current_depth);
 437                     self.mk_region(ty::ReLateBound(current_depth, br))
 438                 }
 439                 _ => {
 440                     region
 441                 }
 442             }
 443         });
 444         Binder::bind(value)
 445     }
 446
 447     /// Returns a set of all late-bound regions that are constrained
 448     /// by `value`, meaning that if we instantiate those LBR with
 449     /// variables and equate `value` with something else, those
 450     /// variables will also be equated.
 451     pub fn collect_constrained_late_bound_regions<T>(&self, value: &Binder<T>)
 452                                                      -> FxHashSet<ty::BoundRegion>
 453         where T : TypeFoldable<'tcx>
 454     {
 455         self.collect_late_bound_regions(value, true)
 456     }
 457
 458     /// Returns a set of all late-bound regions that appear in `value` anywhere.
 459     pub fn collect_referenced_late_bound_regions<T>(&self, value: &Binder<T>)
 460                                                     -> FxHashSet<ty::BoundRegion>
 461         where T : TypeFoldable<'tcx>
 462     {
 463         self.collect_late_bound_regions(value, false)
 464     }
 465
 466     fn collect_late_bound_regions<T>(&self, value: &Binder<T>, just_constraint: bool)
 467                                      -> FxHashSet<ty::BoundRegion>
 468         where T : TypeFoldable<'tcx>
 469     {
 470         let mut collector = LateBoundRegionsCollector::new(just_constraint);
 471         let result = value.skip_binder().visit_with(&mut collector);
 472         assert!(!result); // should never have stopped early
 473         collector.regions
 474     }
 475
 476     /// Replace any late-bound regions bound in `value` with `'erased`. Useful in codegen but also
 477     /// method lookup and a few other places where precise region relationships are not required.
 478     pub fn erase_late_bound_regions<T>(self, value: &Binder<T>) -> T
 479         where T : TypeFoldable<'tcx>
 480     {
 481         self.replace_late_bound_regions(value, |_| self.types.re_erased).0
 482     }
 483
 484     /// Rewrite any late-bound regions so that they are anonymous.  Region numbers are
 485     /// assigned starting at 1 and increasing monotonically in the order traversed
 486     /// by the fold operation.
 487     ///
 488     /// The chief purpose of this function is to canonicalize regions so that two
 489     /// `FnSig`s or `TraitRef`s which are equivalent up to region naming will become
 490     /// structurally identical.  For example, `for<'a, 'b> fn(&'a isize, &'b isize)` and
 491     /// `for<'a, 'b> fn(&'b isize, &'a isize)` will become identical after anonymization.
 492     pub fn anonymize_late_bound_regions<T>(self, sig: &Binder<T>) -> Binder<T>
 493         where T : TypeFoldable<'tcx>,
 494     {
 495         let mut counter = 0;
 496         Binder::bind(self.replace_late_bound_regions(sig, |_| {
 497             counter += 1;
 498             self.mk_region(ty::ReLateBound(ty::INNERMOST, ty::BrAnon(counter)))
 499         }).0)
 500     }
 501 }
 502
 503 impl<'a, 'gcx, 'tcx> RegionReplacer<'a, 'gcx, 'tcx> {
 504     fn new<F>(tcx: TyCtxt<'a, 'gcx, 'tcx>, fld_r: &'a mut F)
 505               -> RegionReplacer<'a, 'gcx, 'tcx>
 506         where F : FnMut(ty::BoundRegion) -> ty::Region<'tcx>
 507     {
 508         RegionReplacer {
 509             tcx,
 510             current_index: ty::INNERMOST,
 511             fld_r,
 512             map: BTreeMap::default()
 513         }
 514     }
 515 }
 516
 517 impl<'a, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for RegionReplacer<'a, 'gcx, 'tcx> {
 518     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> { self.tcx }
 519
 520     fn fold_binder<T: TypeFoldable<'tcx>>(&mut self, t: &ty::Binder<T>) -> ty::Binder<T> {
 521         self.current_index.shift_in(1);
 522         let t = t.super_fold_with(self);
 523         self.current_index.shift_out(1);
 524         t
 525     }
 526
 527     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 528         if !t.has_regions_bound_at_or_above(self.current_index) {
 529             return t;
 530         }
 531
 532         t.super_fold_with(self)
 533     }
 534
 535     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 536         match *r {
 537             ty::ReLateBound(debruijn, br) if debruijn == self.current_index => {
 538                 let fld_r = &mut self.fld_r;
 539                 let region = *self.map.entry(br).or_insert_with(|| fld_r(br));
 540                 if let ty::ReLateBound(debruijn1, br) = *region {
 541                     // If the callback returns a late-bound region,
 542                     // that region should always use the INNERMOST
 543                     // debruijn index. Then we adjust it to the
 544                     // correct depth.
 545                     assert_eq!(debruijn1, ty::INNERMOST);
 546                     self.tcx.mk_region(ty::ReLateBound(debruijn, br))
 547                 } else {
 548                     region
 549                 }
 550             }
 551             _ => r
 552         }
 553     }
 554 }
 555
 556 ///////////////////////////////////////////////////////////////////////////
 557 // Region shifter
 558 //
 559 // Shifts the De Bruijn indices on all escaping bound regions by a
 560 // fixed amount. Useful in substitution or when otherwise introducing
 561 // a binding level that is not intended to capture the existing bound
 562 // regions. See comment on `shift_regions_through_binders` method in
 563 // `subst.rs` for more details.
 564
 565 pub fn shift_region(region: ty::RegionKind, amount: u32) -> ty::RegionKind {
 566     match region {
 567         ty::ReLateBound(debruijn, br) => {
 568             ty::ReLateBound(debruijn.shifted_in(amount), br)
 569         }
 570         _ => {
 571             region
 572         }
 573     }
 574 }
 575
 576 pub fn shift_region_ref<'a, 'gcx, 'tcx>(
 577     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 578     region: ty::Region<'tcx>,
 579     amount: u32)
 580     -> ty::Region<'tcx>
 581 {
 582     match region {
 583         &ty::ReLateBound(debruijn, br) if amount > 0 => {
 584             tcx.mk_region(ty::ReLateBound(debruijn.shifted_in(amount), br))
 585         }
 586         _ => {
 587             region
 588         }
 589     }
 590 }
 591
 592 pub fn shift_regions<'a, 'gcx, 'tcx, T>(tcx: TyCtxt<'a, 'gcx, 'tcx>,
 593                                         amount: u32,
 594                                         value: &T) -> T
 595     where T: TypeFoldable<'tcx>
 596 {
 597     debug!("shift_regions(value={:?}, amount={})",
 598            value, amount);
 599
 600     value.fold_with(&mut RegionFolder::new(tcx, &mut false, &mut |region, _current_depth| {
 601         shift_region_ref(tcx, region, amount)
 602     }))
 603 }
 604
 605 /// An "escaping region" is a bound region whose binder is not part of `t`.
 606 ///
 607 /// So, for example, consider a type like the following, which has two binders:
 608 ///
 609 ///    for<'a> fn(x: for<'b> fn(&'a isize, &'b isize))
 610 ///    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ outer scope
 611 ///                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~  inner scope
 612 ///
 613 /// This type has *bound regions* (`'a`, `'b`), but it does not have escaping regions, because the
 614 /// binders of both `'a` and `'b` are part of the type itself. However, if we consider the *inner
 615 /// fn type*, that type has an escaping region: `'a`.
 616 ///
 617 /// Note that what I'm calling an "escaping region" is often just called a "free region". However,
 618 /// we already use the term "free region". It refers to the regions that we use to represent bound
 619 /// regions on a fn definition while we are typechecking its body.
 620 ///
 621 /// To clarify, conceptually there is no particular difference between an "escaping" region and a
 622 /// "free" region. However, there is a big difference in practice. Basically, when "entering" a
 623 /// binding level, one is generally required to do some sort of processing to a bound region, such
 624 /// as replacing it with a fresh/skolemized region, or making an entry in the environment to
 625 /// represent the scope to which it is attached, etc. An escaping region represents a bound region
 626 /// for which this processing has not yet been done.
 627 struct HasEscapingRegionsVisitor {
 628     /// Anything bound by `outer_index` or "above" is escaping
 629     outer_index: ty::DebruijnIndex,
 630 }
 631
 632 impl<'tcx> TypeVisitor<'tcx> for HasEscapingRegionsVisitor {
 633     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 634         self.outer_index.shift_in(1);
 635         let result = t.super_visit_with(self);
 636         self.outer_index.shift_out(1);
 637         result
 638     }
 639
 640     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
 641         // If the outer-exclusive-binder is *strictly greater* than
 642         // `outer_index`, that means that `t` contains some content
 643         // bound at `outer_index` or above (because
 644         // `outer_exclusive_binder` is always 1 higher than the
 645         // content in `t`). Therefore, `t` has some escaping regions.
 646         t.outer_exclusive_binder > self.outer_index
 647     }
 648
 649     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 650         // If the region is bound by `outer_index` or anything outside
 651         // of outer index, then it escapes the binders we have
 652         // visited.
 653         r.bound_at_or_above_binder(self.outer_index)
 654     }
 655 }
 656
 657 struct HasTypeFlagsVisitor {
 658     flags: ty::TypeFlags,
 659 }
 660
 661 impl<'tcx> TypeVisitor<'tcx> for HasTypeFlagsVisitor {
 662     fn visit_ty(&mut self, t: Ty) -> bool {
 663         debug!("HasTypeFlagsVisitor: t={:?} t.flags={:?} self.flags={:?}", t, t.flags, self.flags);
 664         t.flags.intersects(self.flags)
 665     }
 666
 667     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 668         let flags = r.type_flags();
 669         debug!("HasTypeFlagsVisitor: r={:?} r.flags={:?} self.flags={:?}", r, flags, self.flags);
 670         flags.intersects(self.flags)
 671     }
 672
 673     fn visit_const(&mut self, c: &'tcx ty::Const<'tcx>) -> bool {
 674         if let ConstVal::Unevaluated(..) = c.val {
 675             let projection_flags = TypeFlags::HAS_NORMALIZABLE_PROJECTION |
 676                 TypeFlags::HAS_PROJECTION;
 677             if projection_flags.intersects(self.flags) {
 678                 return true;
 679             }
 680         }
 681         c.super_visit_with(self)
 682     }
 683 }
 684
 685 /// Collects all the late-bound regions at the innermost binding level
 686 /// into a hash set.
 687 struct LateBoundRegionsCollector {
 688     current_index: ty::DebruijnIndex,
 689     regions: FxHashSet<ty::BoundRegion>,
 690
 691     /// If true, we only want regions that are known to be
 692     /// "constrained" when you equate this type with another type. In
 693     /// partcular, if you have e.g. `&'a u32` and `&'b u32`, equating
 694     /// them constraints `'a == 'b`.  But if you have `<&'a u32 as
 695     /// Trait>::Foo` and `<&'b u32 as Trait>::Foo`, normalizing those
 696     /// types may mean that `'a` and `'b` don't appear in the results,
 697     /// so they are not considered *constrained*.
 698     just_constrained: bool,
 699 }
 700
 701 impl LateBoundRegionsCollector {
 702     fn new(just_constrained: bool) -> Self {
 703         LateBoundRegionsCollector {
 704             current_index: ty::INNERMOST,
 705             regions: FxHashSet(),
 706             just_constrained,
 707         }
 708     }
 709 }
 710
 711 impl<'tcx> TypeVisitor<'tcx> for LateBoundRegionsCollector {
 712     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 713         self.current_index.shift_in(1);
 714         let result = t.super_visit_with(self);
 715         self.current_index.shift_out(1);
 716         result
 717     }
 718
 719     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
 720         // if we are only looking for "constrained" region, we have to
 721         // ignore the inputs to a projection, as they may not appear
 722         // in the normalized form
 723         if self.just_constrained {
 724             match t.sty {
 725                 ty::TyProjection(..) | ty::TyAnon(..) => { return false; }
 726                 _ => { }
 727             }
 728         }
 729
 730         t.super_visit_with(self)
 731     }
 732
 733     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 734         match *r {
 735             ty::ReLateBound(debruijn, br) if debruijn == self.current_index => {
 736                 self.regions.insert(br);
 737             }
 738             _ => { }
 739         }
 740         false
 741     }
 742 }