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 mir::interpret::ConstValue;
  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     /// A visitor that does not recurse into types, works like `fn walk_shallow` in `Ty`.
 141     fn visit_tys_shallow(&self, visit: impl FnMut(Ty<'tcx>) -> bool) -> bool {
 142
 143         pub struct Visitor<F>(F);
 144
 145         impl<'tcx, F: FnMut(Ty<'tcx>) -> bool> TypeVisitor<'tcx> for Visitor<F> {
 146             fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
 147                 self.0(ty)
 148             }
 149         }
 150
 151         self.visit_with(&mut Visitor(visit))
 152     }
 153 }
 154
 155 /// The TypeFolder trait defines the actual *folding*. There is a
 156 /// method defined for every foldable type. Each of these has a
 157 /// default implementation that does an "identity" fold. Within each
 158 /// identity fold, it should invoke `foo.fold_with(self)` to fold each
 159 /// sub-item.
 160 pub trait TypeFolder<'gcx: 'tcx, 'tcx> : Sized {
 161     fn tcx<'a>(&'a self) -> TyCtxt<'a, 'gcx, 'tcx>;
 162
 163     fn fold_binder<T>(&mut self, t: &Binder<T>) -> Binder<T>
 164         where T : TypeFoldable<'tcx>
 165     {
 166         t.super_fold_with(self)
 167     }
 168
 169     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 170         t.super_fold_with(self)
 171     }
 172
 173     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 174         r.super_fold_with(self)
 175     }
 176
 177     fn fold_const(&mut self, c: &'tcx ty::Const<'tcx>) -> &'tcx ty::Const<'tcx> {
 178         c.super_fold_with(self)
 179     }
 180 }
 181
 182 pub trait TypeVisitor<'tcx> : Sized {
 183     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 184         t.super_visit_with(self)
 185     }
 186
 187     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
 188         t.super_visit_with(self)
 189     }
 190
 191     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 192         r.super_visit_with(self)
 193     }
 194
 195     fn visit_const(&mut self, c: &'tcx ty::Const<'tcx>) -> bool {
 196         c.super_visit_with(self)
 197     }
 198 }
 199
 200 ///////////////////////////////////////////////////////////////////////////
 201 // Some sample folders
 202
 203 pub struct BottomUpFolder<'a, 'gcx: 'a+'tcx, 'tcx: 'a, F, G>
 204     where F: FnMut(Ty<'tcx>) -> Ty<'tcx>,
 205           G: FnMut(ty::Region<'tcx>) -> ty::Region<'tcx>,
 206 {
 207     pub tcx: TyCtxt<'a, 'gcx, 'tcx>,
 208     pub fldop: F,
 209     pub reg_op: G,
 210 }
 211
 212 impl<'a, 'gcx, 'tcx, F, G> TypeFolder<'gcx, 'tcx> for BottomUpFolder<'a, 'gcx, 'tcx, F, G>
 213     where F: FnMut(Ty<'tcx>) -> Ty<'tcx>,
 214           G: FnMut(ty::Region<'tcx>) -> ty::Region<'tcx>,
 215 {
 216     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> { self.tcx }
 217
 218     fn fold_ty(&mut self, ty: Ty<'tcx>) -> Ty<'tcx> {
 219         let t1 = ty.super_fold_with(self);
 220         (self.fldop)(t1)
 221     }
 222
 223     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 224         let r = r.super_fold_with(self);
 225         (self.reg_op)(r)
 226     }
 227 }
 228
 229 ///////////////////////////////////////////////////////////////////////////
 230 // Region folder
 231
 232 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 233     /// Collects the free and escaping regions in `value` into `region_set`. Returns
 234     /// whether any late-bound regions were skipped
 235     pub fn collect_regions<T>(self,
 236         value: &T,
 237         region_set: &mut FxHashSet<ty::Region<'tcx>>)
 238         -> bool
 239         where T : TypeFoldable<'tcx>
 240     {
 241         let mut have_bound_regions = false;
 242         self.fold_regions(value, &mut have_bound_regions, |r, d| {
 243             region_set.insert(self.mk_region(r.shifted_out_to_binder(d)));
 244             r
 245         });
 246         have_bound_regions
 247     }
 248
 249     /// Folds the escaping and free regions in `value` using `f`, and
 250     /// sets `skipped_regions` to true if any late-bound region was found
 251     /// and skipped.
 252     pub fn fold_regions<T>(
 253         self,
 254         value: &T,
 255         skipped_regions: &mut bool,
 256         mut f: impl FnMut(ty::Region<'tcx>, ty::DebruijnIndex) -> ty::Region<'tcx>,
 257     ) -> T
 258     where
 259         T : TypeFoldable<'tcx>,
 260     {
 261         value.fold_with(&mut RegionFolder::new(self, skipped_regions, &mut f))
 262     }
 263
 264     /// Invoke `callback` on every region appearing free in `value`.
 265     pub fn for_each_free_region(
 266         self,
 267         value: &impl TypeFoldable<'tcx>,
 268         mut callback: impl FnMut(ty::Region<'tcx>),
 269     ) {
 270         self.any_free_region_meets(value, |r| {
 271             callback(r);
 272             false
 273         });
 274     }
 275
 276     /// True if `callback` returns true for every region appearing free in `value`.
 277     pub fn all_free_regions_meet(
 278         self,
 279         value: &impl TypeFoldable<'tcx>,
 280         mut callback: impl FnMut(ty::Region<'tcx>) -> bool,
 281     ) -> bool {
 282         !self.any_free_region_meets(value, |r| !callback(r))
 283     }
 284
 285     /// True if `callback` returns true for some region appearing free in `value`.
 286     pub fn any_free_region_meets(
 287         self,
 288         value: &impl TypeFoldable<'tcx>,
 289         callback: impl FnMut(ty::Region<'tcx>) -> bool,
 290     ) -> bool {
 291         return value.visit_with(&mut RegionVisitor {
 292             outer_index: ty::INNERMOST,
 293             callback
 294         });
 295
 296         struct RegionVisitor<F> {
 297             /// The index of a binder *just outside* the things we have
 298             /// traversed. If we encounter a bound region bound by this
 299             /// binder or one outer to it, it appears free. Example:
 300             ///
 301             /// ```
 302             ///    for<'a> fn(for<'b> fn(), T)
 303             /// ^          ^          ^     ^
 304             /// |          |          |     | here, would be shifted in 1
 305             /// |          |          | here, would be shifted in 2
 306             /// |          | here, would be INNERMOST shifted in by 1
 307             /// | here, initially, binder would be INNERMOST
 308             /// ```
 309             ///
 310             /// You see that, initially, *any* bound value is free,
 311             /// because we've not traversed any binders. As we pass
 312             /// through a binder, we shift the `outer_index` by 1 to
 313             /// account for the new binder that encloses us.
 314             outer_index: ty::DebruijnIndex,
 315             callback: F,
 316         }
 317
 318         impl<'tcx, F> TypeVisitor<'tcx> for RegionVisitor<F>
 319             where F: FnMut(ty::Region<'tcx>) -> bool
 320         {
 321             fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 322                 self.outer_index.shift_in(1);
 323                 let result = t.skip_binder().visit_with(self);
 324                 self.outer_index.shift_out(1);
 325                 result
 326             }
 327
 328             fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 329                 match *r {
 330                     ty::ReLateBound(debruijn, _) if debruijn < self.outer_index => {
 331                         false // ignore bound regions, keep visiting
 332                     }
 333                     _ => (self.callback)(r),
 334                 }
 335             }
 336
 337             fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
 338                 // We're only interested in types involving regions
 339                 if ty.flags.intersects(TypeFlags::HAS_FREE_REGIONS) {
 340                     ty.super_visit_with(self)
 341                 } else {
 342                     false // keep visiting
 343                 }
 344             }
 345         }
 346     }
 347 }
 348
 349 /// Folds over the substructure of a type, visiting its component
 350 /// types and all regions that occur *free* within it.
 351 ///
 352 /// That is, `Ty` can contain function or method types that bind
 353 /// regions at the call site (`ReLateBound`), and occurrences of
 354 /// regions (aka "lifetimes") that are bound within a type are not
 355 /// visited by this folder; only regions that occur free will be
 356 /// visited by `fld_r`.
 357
 358 pub struct RegionFolder<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 359     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 360     skipped_regions: &'a mut bool,
 361
 362     /// Stores the index of a binder *just outside* the stuff we have
 363     /// visited.  So this begins as INNERMOST; when we pass through a
 364     /// binder, it is incremented (via `shift_in`).
 365     current_index: ty::DebruijnIndex,
 366
 367     /// Callback invokes for each free region. The `DebruijnIndex`
 368     /// points to the binder *just outside* the ones we have passed
 369     /// through.
 370     fold_region_fn: &'a mut (dyn FnMut(
 371         ty::Region<'tcx>,
 372         ty::DebruijnIndex,
 373     ) -> ty::Region<'tcx> + 'a),
 374 }
 375
 376 impl<'a, 'gcx, 'tcx> RegionFolder<'a, 'gcx, 'tcx> {
 377     pub fn new(
 378         tcx: TyCtxt<'a, 'gcx, 'tcx>,
 379         skipped_regions: &'a mut bool,
 380         fold_region_fn: &'a mut dyn FnMut(ty::Region<'tcx>, ty::DebruijnIndex) -> ty::Region<'tcx>,
 381     ) -> RegionFolder<'a, 'gcx, 'tcx> {
 382         RegionFolder {
 383             tcx,
 384             skipped_regions,
 385             current_index: ty::INNERMOST,
 386             fold_region_fn,
 387         }
 388     }
 389 }
 390
 391 impl<'a, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for RegionFolder<'a, 'gcx, 'tcx> {
 392     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> { self.tcx }
 393
 394     fn fold_binder<T: TypeFoldable<'tcx>>(&mut self, t: &ty::Binder<T>) -> ty::Binder<T> {
 395         self.current_index.shift_in(1);
 396         let t = t.super_fold_with(self);
 397         self.current_index.shift_out(1);
 398         t
 399     }
 400
 401     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 402         match *r {
 403             ty::ReLateBound(debruijn, _) if debruijn < self.current_index => {
 404                 debug!("RegionFolder.fold_region({:?}) skipped bound region (current index={:?})",
 405                        r, self.current_index);
 406                 *self.skipped_regions = true;
 407                 r
 408             }
 409             _ => {
 410                 debug!("RegionFolder.fold_region({:?}) folding free region (current_index={:?})",
 411                        r, self.current_index);
 412                 (self.fold_region_fn)(r, self.current_index)
 413             }
 414         }
 415     }
 416 }
 417
 418 ///////////////////////////////////////////////////////////////////////////
 419 // Late-bound region replacer
 420
 421 // Replaces the escaping regions in a type.
 422
 423 struct RegionReplacer<'a, 'gcx: 'a+'tcx, 'tcx: 'a> {
 424     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 425
 426     /// As with `RegionFolder`, represents the index of a binder *just outside*
 427     /// the ones we have visited.
 428     current_index: ty::DebruijnIndex,
 429
 430     fld_r: &'a mut (dyn FnMut(ty::BoundRegion) -> ty::Region<'tcx> + 'a),
 431     map: BTreeMap<ty::BoundRegion, ty::Region<'tcx>>
 432 }
 433
 434 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 435     /// Replace all regions bound by the given `Binder` with the
 436     /// results returned by the closure; the closure is expected to
 437     /// return a free region (relative to this binder), and hence the
 438     /// binder is removed in the return type. The closure is invoked
 439     /// once for each unique `BoundRegion`; multiple references to the
 440     /// same `BoundRegion` will reuse the previous result.  A map is
 441     /// returned at the end with each bound region and the free region
 442     /// that replaced it.
 443     pub fn replace_late_bound_regions<T,F>(self,
 444         value: &Binder<T>,
 445         mut f: F)
 446         -> (T, BTreeMap<ty::BoundRegion, ty::Region<'tcx>>)
 447         where F : FnMut(ty::BoundRegion) -> ty::Region<'tcx>,
 448               T : TypeFoldable<'tcx>,
 449     {
 450         let mut replacer = RegionReplacer::new(self, &mut f);
 451         let result = value.skip_binder().fold_with(&mut replacer);
 452         (result, replacer.map)
 453     }
 454
 455     /// Replace any late-bound regions bound in `value` with
 456     /// free variants attached to `all_outlive_scope`.
 457     pub fn liberate_late_bound_regions<T>(
 458         &self,
 459         all_outlive_scope: DefId,
 460         value: &ty::Binder<T>
 461     ) -> T
 462     where T: TypeFoldable<'tcx> {
 463         self.replace_late_bound_regions(value, |br| {
 464             self.mk_region(ty::ReFree(ty::FreeRegion {
 465                 scope: all_outlive_scope,
 466                 bound_region: br
 467             }))
 468         }).0
 469     }
 470
 471     /// Flattens multiple binding levels into one. So `for<'a> for<'b> Foo`
 472     /// becomes `for<'a,'b> Foo`.
 473     pub fn flatten_late_bound_regions<T>(self, bound2_value: &Binder<Binder<T>>)
 474                                          -> Binder<T>
 475         where T: TypeFoldable<'tcx>
 476     {
 477         let bound0_value = bound2_value.skip_binder().skip_binder();
 478         let value = self.fold_regions(bound0_value, &mut false, |region, current_depth| {
 479             match *region {
 480                 ty::ReLateBound(debruijn, br) => {
 481                     // We assume no regions bound *outside* of the
 482                     // binders in `bound2_value` (nmatsakis added in
 483                     // the course of this PR; seems like a reasonable
 484                     // sanity check though).
 485                     assert!(debruijn == current_depth);
 486                     self.mk_region(ty::ReLateBound(current_depth, br))
 487                 }
 488                 _ => {
 489                     region
 490                 }
 491             }
 492         });
 493         Binder::bind(value)
 494     }
 495
 496     /// Returns a set of all late-bound regions that are constrained
 497     /// by `value`, meaning that if we instantiate those LBR with
 498     /// variables and equate `value` with something else, those
 499     /// variables will also be equated.
 500     pub fn collect_constrained_late_bound_regions<T>(&self, value: &Binder<T>)
 501                                                      -> FxHashSet<ty::BoundRegion>
 502         where T : TypeFoldable<'tcx>
 503     {
 504         self.collect_late_bound_regions(value, true)
 505     }
 506
 507     /// Returns a set of all late-bound regions that appear in `value` anywhere.
 508     pub fn collect_referenced_late_bound_regions<T>(&self, value: &Binder<T>)
 509                                                     -> FxHashSet<ty::BoundRegion>
 510         where T : TypeFoldable<'tcx>
 511     {
 512         self.collect_late_bound_regions(value, false)
 513     }
 514
 515     fn collect_late_bound_regions<T>(&self, value: &Binder<T>, just_constraint: bool)
 516                                      -> FxHashSet<ty::BoundRegion>
 517         where T : TypeFoldable<'tcx>
 518     {
 519         let mut collector = LateBoundRegionsCollector::new(just_constraint);
 520         let result = value.skip_binder().visit_with(&mut collector);
 521         assert!(!result); // should never have stopped early
 522         collector.regions
 523     }
 524
 525     /// Replace any late-bound regions bound in `value` with `'erased`. Useful in codegen but also
 526     /// method lookup and a few other places where precise region relationships are not required.
 527     pub fn erase_late_bound_regions<T>(self, value: &Binder<T>) -> T
 528         where T : TypeFoldable<'tcx>
 529     {
 530         self.replace_late_bound_regions(value, |_| self.types.re_erased).0
 531     }
 532
 533     /// Rewrite any late-bound regions so that they are anonymous.  Region numbers are
 534     /// assigned starting at 1 and increasing monotonically in the order traversed
 535     /// by the fold operation.
 536     ///
 537     /// The chief purpose of this function is to canonicalize regions so that two
 538     /// `FnSig`s or `TraitRef`s which are equivalent up to region naming will become
 539     /// structurally identical.  For example, `for<'a, 'b> fn(&'a isize, &'b isize)` and
 540     /// `for<'a, 'b> fn(&'b isize, &'a isize)` will become identical after anonymization.
 541     pub fn anonymize_late_bound_regions<T>(self, sig: &Binder<T>) -> Binder<T>
 542         where T : TypeFoldable<'tcx>,
 543     {
 544         let mut counter = 0;
 545         Binder::bind(self.replace_late_bound_regions(sig, |_| {
 546             counter += 1;
 547             self.mk_region(ty::ReLateBound(ty::INNERMOST, ty::BrAnon(counter)))
 548         }).0)
 549     }
 550 }
 551
 552 impl<'a, 'gcx, 'tcx> RegionReplacer<'a, 'gcx, 'tcx> {
 553     fn new<F>(tcx: TyCtxt<'a, 'gcx, 'tcx>, fld_r: &'a mut F)
 554               -> RegionReplacer<'a, 'gcx, 'tcx>
 555         where F : FnMut(ty::BoundRegion) -> ty::Region<'tcx>
 556     {
 557         RegionReplacer {
 558             tcx,
 559             current_index: ty::INNERMOST,
 560             fld_r,
 561             map: BTreeMap::default()
 562         }
 563     }
 564 }
 565
 566 impl<'a, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for RegionReplacer<'a, 'gcx, 'tcx> {
 567     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> { self.tcx }
 568
 569     fn fold_binder<T: TypeFoldable<'tcx>>(&mut self, t: &ty::Binder<T>) -> ty::Binder<T> {
 570         self.current_index.shift_in(1);
 571         let t = t.super_fold_with(self);
 572         self.current_index.shift_out(1);
 573         t
 574     }
 575
 576     fn fold_ty(&mut self, t: Ty<'tcx>) -> Ty<'tcx> {
 577         if !t.has_regions_bound_at_or_above(self.current_index) {
 578             return t;
 579         }
 580
 581         t.super_fold_with(self)
 582     }
 583
 584     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 585         match *r {
 586             ty::ReLateBound(debruijn, br) if debruijn == self.current_index => {
 587                 let fld_r = &mut self.fld_r;
 588                 let region = *self.map.entry(br).or_insert_with(|| fld_r(br));
 589                 if let ty::ReLateBound(debruijn1, br) = *region {
 590                     // If the callback returns a late-bound region,
 591                     // that region should always use the INNERMOST
 592                     // debruijn index. Then we adjust it to the
 593                     // correct depth.
 594                     assert_eq!(debruijn1, ty::INNERMOST);
 595                     self.tcx.mk_region(ty::ReLateBound(debruijn, br))
 596                 } else {
 597                     region
 598                 }
 599             }
 600             _ => r
 601         }
 602     }
 603 }
 604
 605 ///////////////////////////////////////////////////////////////////////////
 606 // Region shifter
 607 //
 608 // Shifts the De Bruijn indices on all escaping bound regions by a
 609 // fixed amount. Useful in substitution or when otherwise introducing
 610 // a binding level that is not intended to capture the existing bound
 611 // regions. See comment on `shift_regions_through_binders` method in
 612 // `subst.rs` for more details.
 613
 614 pub fn shift_region(region: ty::RegionKind, amount: u32) -> ty::RegionKind {
 615     match region {
 616         ty::ReLateBound(debruijn, br) => {
 617             ty::ReLateBound(debruijn.shifted_in(amount), br)
 618         }
 619         _ => {
 620             region
 621         }
 622     }
 623 }
 624
 625 pub fn shift_region_ref<'a, 'gcx, 'tcx>(
 626     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 627     region: ty::Region<'tcx>,
 628     amount: u32)
 629     -> ty::Region<'tcx>
 630 {
 631     match region {
 632         &ty::ReLateBound(debruijn, br) if amount > 0 => {
 633             tcx.mk_region(ty::ReLateBound(debruijn.shifted_in(amount), br))
 634         }
 635         _ => {
 636             region
 637         }
 638     }
 639 }
 640
 641 pub fn shift_regions<'a, 'gcx, 'tcx, T>(tcx: TyCtxt<'a, 'gcx, 'tcx>,
 642                                         amount: u32,
 643                                         value: &T) -> T
 644     where T: TypeFoldable<'tcx>
 645 {
 646     debug!("shift_regions(value={:?}, amount={})",
 647            value, amount);
 648
 649     value.fold_with(&mut RegionFolder::new(tcx, &mut false, &mut |region, _current_depth| {
 650         shift_region_ref(tcx, region, amount)
 651     }))
 652 }
 653
 654 /// An "escaping region" is a bound region whose binder is not part of `t`.
 655 ///
 656 /// So, for example, consider a type like the following, which has two binders:
 657 ///
 658 ///    for<'a> fn(x: for<'b> fn(&'a isize, &'b isize))
 659 ///    ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ outer scope
 660 ///                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~  inner scope
 661 ///
 662 /// This type has *bound regions* (`'a`, `'b`), but it does not have escaping regions, because the
 663 /// binders of both `'a` and `'b` are part of the type itself. However, if we consider the *inner
 664 /// fn type*, that type has an escaping region: `'a`.
 665 ///
 666 /// Note that what I'm calling an "escaping region" is often just called a "free region". However,
 667 /// we already use the term "free region". It refers to the regions that we use to represent bound
 668 /// regions on a fn definition while we are typechecking its body.
 669 ///
 670 /// To clarify, conceptually there is no particular difference between
 671 /// an "escaping" region and a "free" region. However, there is a big
 672 /// difference in practice. Basically, when "entering" a binding
 673 /// level, one is generally required to do some sort of processing to
 674 /// a bound region, such as replacing it with a fresh/placeholder
 675 /// region, or making an entry in the environment to represent the
 676 /// scope to which it is attached, etc. An escaping region represents
 677 /// a bound region for which this processing has not yet been done.
 678 struct HasEscapingRegionsVisitor {
 679     /// Anything bound by `outer_index` or "above" is escaping
 680     outer_index: ty::DebruijnIndex,
 681 }
 682
 683 impl<'tcx> TypeVisitor<'tcx> for HasEscapingRegionsVisitor {
 684     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 685         self.outer_index.shift_in(1);
 686         let result = t.super_visit_with(self);
 687         self.outer_index.shift_out(1);
 688         result
 689     }
 690
 691     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
 692         // If the outer-exclusive-binder is *strictly greater* than
 693         // `outer_index`, that means that `t` contains some content
 694         // bound at `outer_index` or above (because
 695         // `outer_exclusive_binder` is always 1 higher than the
 696         // content in `t`). Therefore, `t` has some escaping regions.
 697         t.outer_exclusive_binder > self.outer_index
 698     }
 699
 700     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 701         // If the region is bound by `outer_index` or anything outside
 702         // of outer index, then it escapes the binders we have
 703         // visited.
 704         r.bound_at_or_above_binder(self.outer_index)
 705     }
 706 }
 707
 708 struct HasTypeFlagsVisitor {
 709     flags: ty::TypeFlags,
 710 }
 711
 712 impl<'tcx> TypeVisitor<'tcx> for HasTypeFlagsVisitor {
 713     fn visit_ty(&mut self, t: Ty<'_>) -> bool {
 714         debug!("HasTypeFlagsVisitor: t={:?} t.flags={:?} self.flags={:?}", t, t.flags, self.flags);
 715         t.flags.intersects(self.flags)
 716     }
 717
 718     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 719         let flags = r.type_flags();
 720         debug!("HasTypeFlagsVisitor: r={:?} r.flags={:?} self.flags={:?}", r, flags, self.flags);
 721         flags.intersects(self.flags)
 722     }
 723
 724     fn visit_const(&mut self, c: &'tcx ty::Const<'tcx>) -> bool {
 725         if let ConstValue::Unevaluated(..) = c.val {
 726             let projection_flags = TypeFlags::HAS_NORMALIZABLE_PROJECTION |
 727                 TypeFlags::HAS_PROJECTION;
 728             if projection_flags.intersects(self.flags) {
 729                 return true;
 730             }
 731         }
 732         c.super_visit_with(self)
 733     }
 734 }
 735
 736 /// Collects all the late-bound regions at the innermost binding level
 737 /// into a hash set.
 738 struct LateBoundRegionsCollector {
 739     current_index: ty::DebruijnIndex,
 740     regions: FxHashSet<ty::BoundRegion>,
 741
 742     /// If true, we only want regions that are known to be
 743     /// "constrained" when you equate this type with another type. In
 744     /// partcular, if you have e.g. `&'a u32` and `&'b u32`, equating
 745     /// them constraints `'a == 'b`.  But if you have `<&'a u32 as
 746     /// Trait>::Foo` and `<&'b u32 as Trait>::Foo`, normalizing those
 747     /// types may mean that `'a` and `'b` don't appear in the results,
 748     /// so they are not considered *constrained*.
 749     just_constrained: bool,
 750 }
 751
 752 impl LateBoundRegionsCollector {
 753     fn new(just_constrained: bool) -> Self {
 754         LateBoundRegionsCollector {
 755             current_index: ty::INNERMOST,
 756             regions: FxHashSet(),
 757             just_constrained,
 758         }
 759     }
 760 }
 761
 762 impl<'tcx> TypeVisitor<'tcx> for LateBoundRegionsCollector {
 763     fn visit_binder<T: TypeFoldable<'tcx>>(&mut self, t: &Binder<T>) -> bool {
 764         self.current_index.shift_in(1);
 765         let result = t.super_visit_with(self);
 766         self.current_index.shift_out(1);
 767         result
 768     }
 769
 770     fn visit_ty(&mut self, t: Ty<'tcx>) -> bool {
 771         // if we are only looking for "constrained" region, we have to
 772         // ignore the inputs to a projection, as they may not appear
 773         // in the normalized form
 774         if self.just_constrained {
 775             match t.sty {
 776                 ty::Projection(..) | ty::Opaque(..) => { return false; }
 777                 _ => { }
 778             }
 779         }
 780
 781         t.super_visit_with(self)
 782     }
 783
 784     fn visit_region(&mut self, r: ty::Region<'tcx>) -> bool {
 785         if let ty::ReLateBound(debruijn, br) = *r {
 786              if debruijn == self.current_index {
 787                 self.regions.insert(br);
 788             }
 789         }
 790         false
 791     }
 792 }