compiler/rustc_typeck/src/check/inherited.rs

   1 use super::callee::DeferredCallResolution;
   2 use super::MaybeInProgressTables;
   3
   4 use rustc_data_structures::fx::FxHashSet;
   5 use rustc_hir as hir;
   6 use rustc_hir::def_id::{DefIdMap, LocalDefId};
   7 use rustc_hir::HirIdMap;
   8 use rustc_infer::infer;
   9 use rustc_infer::infer::{InferCtxt, InferOk, TyCtxtInferExt};
  10 use rustc_middle::ty::fold::TypeFoldable;
  11 use rustc_middle::ty::{self, Ty, TyCtxt};
  12 use rustc_span::{self, Span};
  13 use rustc_trait_selection::infer::InferCtxtExt as _;
  14 use rustc_trait_selection::traits::{self, ObligationCause, TraitEngine, TraitEngineExt};
  15
  16 use std::cell::RefCell;
  17 use std::ops::Deref;
  18
  19 /// Closures defined within the function. For example:
  20 ///
  21 ///     fn foo() {
  22 ///         bar(move|| { ... })
  23 ///     }
  24 ///
  25 /// Here, the function `foo()` and the closure passed to
  26 /// `bar()` will each have their own `FnCtxt`, but they will
  27 /// share the inherited fields.
  28 pub struct Inherited<'a, 'tcx> {
  29     pub(super) infcx: InferCtxt<'a, 'tcx>,
  30
  31     pub(super) typeck_results: super::MaybeInProgressTables<'a, 'tcx>,
  32
  33     pub(super) locals: RefCell<HirIdMap<super::LocalTy<'tcx>>>,
  34
  35     pub(super) fulfillment_cx: RefCell<Box<dyn TraitEngine<'tcx>>>,
  36
  37     // Some additional `Sized` obligations badly affect type inference.
  38     // These obligations are added in a later stage of typeck.
  39     pub(super) deferred_sized_obligations:
  40         RefCell<Vec<(Ty<'tcx>, Span, traits::ObligationCauseCode<'tcx>)>>,
  41
  42     // When we process a call like `c()` where `c` is a closure type,
  43     // we may not have decided yet whether `c` is a `Fn`, `FnMut`, or
  44     // `FnOnce` closure. In that case, we defer full resolution of the
  45     // call until upvar inference can kick in and make the
  46     // decision. We keep these deferred resolutions grouped by the
  47     // def-id of the closure, so that once we decide, we can easily go
  48     // back and process them.
  49     pub(super) deferred_call_resolutions: RefCell<DefIdMap<Vec<DeferredCallResolution<'tcx>>>>,
  50
  51     pub(super) deferred_cast_checks: RefCell<Vec<super::cast::CastCheck<'tcx>>>,
  52
  53     pub(super) deferred_generator_interiors:
  54         RefCell<Vec<(hir::BodyId, Ty<'tcx>, hir::GeneratorKind)>>,
  55
  56     pub(super) body_id: Option<hir::BodyId>,
  57
  58     /// Whenever we introduce an adjustment from `!` into a type variable,
  59     /// we record that type variable here. This is later used to inform
  60     /// fallback. See the `fallback` module for details.
  61     pub(super) diverging_type_vars: RefCell<FxHashSet<Ty<'tcx>>>,
  62 }
  63
  64 impl<'a, 'tcx> Deref for Inherited<'a, 'tcx> {
  65     type Target = InferCtxt<'a, 'tcx>;
  66     fn deref(&self) -> &Self::Target {
  67         &self.infcx
  68     }
  69 }
  70
  71 /// Helper type of a temporary returned by `Inherited::build(...)`.
  72 /// Necessary because we can't write the following bound:
  73 /// `F: for<'b, 'tcx> where 'tcx FnOnce(Inherited<'b, 'tcx>)`.
  74 pub struct InheritedBuilder<'tcx> {
  75     infcx: infer::InferCtxtBuilder<'tcx>,
  76     def_id: LocalDefId,
  77 }
  78
  79 impl<'tcx> Inherited<'_, 'tcx> {
  80     pub fn build(tcx: TyCtxt<'tcx>, def_id: LocalDefId) -> InheritedBuilder<'tcx> {
  81         let hir_owner = tcx.hir().local_def_id_to_hir_id(def_id).owner;
  82
  83         InheritedBuilder {
  84             infcx: tcx.infer_ctxt().with_fresh_in_progress_typeck_results(hir_owner),
  85             def_id,
  86         }
  87     }
  88 }
  89
  90 impl<'tcx> InheritedBuilder<'tcx> {
  91     pub fn enter<F, R>(&mut self, f: F) -> R
  92     where
  93         F: for<'a> FnOnce(Inherited<'a, 'tcx>) -> R,
  94     {
  95         let def_id = self.def_id;
  96         self.infcx.enter(|infcx| f(Inherited::new(infcx, def_id)))
  97     }
  98
  99     /// WF-checking doesn't need to recompute opaque types and can instead use
 100     /// the type_of query to get them from typeck.
 101     pub fn reveal_defining_opaque_types(mut self) -> Self {
 102         self.infcx = self.infcx.reveal_defining_opaque_types();
 103         self
 104     }
 105 }
 106
 107 impl<'a, 'tcx> Inherited<'a, 'tcx> {
 108     pub(super) fn new(infcx: InferCtxt<'a, 'tcx>, def_id: LocalDefId) -> Self {
 109         let tcx = infcx.tcx;
 110         let item_id = tcx.hir().local_def_id_to_hir_id(def_id);
 111         let body_id = tcx.hir().maybe_body_owned_by(item_id);
 112
 113         Inherited {
 114             typeck_results: MaybeInProgressTables {
 115                 maybe_typeck_results: infcx.in_progress_typeck_results,
 116             },
 117             infcx,
 118             fulfillment_cx: RefCell::new(<dyn TraitEngine<'_>>::new(tcx)),
 119             locals: RefCell::new(Default::default()),
 120             deferred_sized_obligations: RefCell::new(Vec::new()),
 121             deferred_call_resolutions: RefCell::new(Default::default()),
 122             deferred_cast_checks: RefCell::new(Vec::new()),
 123             deferred_generator_interiors: RefCell::new(Vec::new()),
 124             diverging_type_vars: RefCell::new(Default::default()),
 125             body_id,
 126         }
 127     }
 128
 129     #[instrument(level = "debug", skip(self))]
 130     pub(super) fn register_predicate(&self, obligation: traits::PredicateObligation<'tcx>) {
 131         if obligation.has_escaping_bound_vars() {
 132             span_bug!(obligation.cause.span, "escaping bound vars in predicate {:?}", obligation);
 133         }
 134         self.fulfillment_cx.borrow_mut().register_predicate_obligation(self, obligation);
 135     }
 136
 137     pub(super) fn register_predicates<I>(&self, obligations: I)
 138     where
 139         I: IntoIterator<Item = traits::PredicateObligation<'tcx>>,
 140     {
 141         for obligation in obligations {
 142             self.register_predicate(obligation);
 143         }
 144     }
 145
 146     pub(super) fn register_infer_ok_obligations<T>(&self, infer_ok: InferOk<'tcx, T>) -> T {
 147         self.register_predicates(infer_ok.obligations);
 148         infer_ok.value
 149     }
 150
 151     pub(super) fn normalize_associated_types_in<T>(
 152         &self,
 153         span: Span,
 154         body_id: hir::HirId,
 155         param_env: ty::ParamEnv<'tcx>,
 156         value: T,
 157     ) -> T
 158     where
 159         T: TypeFoldable<'tcx>,
 160     {
 161         self.normalize_associated_types_in_with_cause(
 162             ObligationCause::misc(span, body_id),
 163             param_env,
 164             value,
 165         )
 166     }
 167
 168     pub(super) fn normalize_associated_types_in_with_cause<T>(
 169         &self,
 170         cause: ObligationCause<'tcx>,
 171         param_env: ty::ParamEnv<'tcx>,
 172         value: T,
 173     ) -> T
 174     where
 175         T: TypeFoldable<'tcx>,
 176     {
 177         let ok = self.partially_normalize_associated_types_in(cause, param_env, value);
 178         debug!(?ok);
 179         self.register_infer_ok_obligations(ok)
 180     }
 181 }