compiler/rustc_hir_analysis/src/check/fn_ctxt/mod.rs

   1 mod _impl;
   2 mod arg_matrix;
   3 mod checks;
   4 mod suggestions;
   5
   6 pub use _impl::*;
   7 pub use suggestions::*;
   8
   9 use crate::astconv::AstConv;
  10 use crate::check::coercion::DynamicCoerceMany;
  11 use crate::check::{Diverges, EnclosingBreakables, Inherited, UnsafetyState};
  12
  13 use rustc_hir as hir;
  14 use rustc_hir::def_id::DefId;
  15 use rustc_infer::infer;
  16 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
  17 use rustc_middle::infer::unify_key::{ConstVariableOrigin, ConstVariableOriginKind};
  18 use rustc_middle::ty::subst::GenericArgKind;
  19 use rustc_middle::ty::visit::TypeVisitable;
  20 use rustc_middle::ty::{self, Const, Ty, TyCtxt};
  21 use rustc_session::Session;
  22 use rustc_span::symbol::Ident;
  23 use rustc_span::{self, Span};
  24 use rustc_trait_selection::traits::{ObligationCause, ObligationCauseCode};
  25
  26 use std::cell::{Cell, RefCell};
  27 use std::ops::Deref;
  28
  29 /// The `FnCtxt` stores type-checking context needed to type-check bodies of
  30 /// functions, closures, and `const`s, including performing type inference
  31 /// with [`InferCtxt`].
  32 ///
  33 /// This is in contrast to [`ItemCtxt`], which is used to type-check item *signatures*
  34 /// and thus does not perform type inference.
  35 ///
  36 /// See [`ItemCtxt`]'s docs for more.
  37 ///
  38 /// [`ItemCtxt`]: crate::collect::ItemCtxt
  39 /// [`InferCtxt`]: infer::InferCtxt
  40 pub struct FnCtxt<'a, 'tcx> {
  41     pub(super) body_id: hir::HirId,
  42
  43     /// The parameter environment used for proving trait obligations
  44     /// in this function. This can change when we descend into
  45     /// closures (as they bring new things into scope), hence it is
  46     /// not part of `Inherited` (as of the time of this writing,
  47     /// closures do not yet change the environment, but they will
  48     /// eventually).
  49     pub(super) param_env: ty::ParamEnv<'tcx>,
  50
  51     /// Number of errors that had been reported when we started
  52     /// checking this function. On exit, if we find that *more* errors
  53     /// have been reported, we will skip regionck and other work that
  54     /// expects the types within the function to be consistent.
  55     // FIXME(matthewjasper) This should not exist, and it's not correct
  56     // if type checking is run in parallel.
  57     err_count_on_creation: usize,
  58
  59     /// If `Some`, this stores coercion information for returned
  60     /// expressions. If `None`, this is in a context where return is
  61     /// inappropriate, such as a const expression.
  62     ///
  63     /// This is a `RefCell<DynamicCoerceMany>`, which means that we
  64     /// can track all the return expressions and then use them to
  65     /// compute a useful coercion from the set, similar to a match
  66     /// expression or other branching context. You can use methods
  67     /// like `expected_ty` to access the declared return type (if
  68     /// any).
  69     pub(super) ret_coercion: Option<RefCell<DynamicCoerceMany<'tcx>>>,
  70
  71     /// Used exclusively to reduce cost of advanced evaluation used for
  72     /// more helpful diagnostics.
  73     pub(super) in_tail_expr: bool,
  74
  75     /// First span of a return site that we find. Used in error messages.
  76     pub(super) ret_coercion_span: Cell<Option<Span>>,
  77
  78     pub(super) resume_yield_tys: Option<(Ty<'tcx>, Ty<'tcx>)>,
  79
  80     pub(super) ps: Cell<UnsafetyState>,
  81
  82     /// Whether the last checked node generates a divergence (e.g.,
  83     /// `return` will set this to `Always`). In general, when entering
  84     /// an expression or other node in the tree, the initial value
  85     /// indicates whether prior parts of the containing expression may
  86     /// have diverged. It is then typically set to `Maybe` (and the
  87     /// old value remembered) for processing the subparts of the
  88     /// current expression. As each subpart is processed, they may set
  89     /// the flag to `Always`, etc. Finally, at the end, we take the
  90     /// result and "union" it with the original value, so that when we
  91     /// return the flag indicates if any subpart of the parent
  92     /// expression (up to and including this part) has diverged. So,
  93     /// if you read it after evaluating a subexpression `X`, the value
  94     /// you get indicates whether any subexpression that was
  95     /// evaluating up to and including `X` diverged.
  96     ///
  97     /// We currently use this flag only for diagnostic purposes:
  98     ///
  99     /// - To warn about unreachable code: if, after processing a
 100     ///   sub-expression but before we have applied the effects of the
 101     ///   current node, we see that the flag is set to `Always`, we
 102     ///   can issue a warning. This corresponds to something like
 103     ///   `foo(return)`; we warn on the `foo()` expression. (We then
 104     ///   update the flag to `WarnedAlways` to suppress duplicate
 105     ///   reports.) Similarly, if we traverse to a fresh statement (or
 106     ///   tail expression) from an `Always` setting, we will issue a
 107     ///   warning. This corresponds to something like `{return;
 108     ///   foo();}` or `{return; 22}`, where we would warn on the
 109     ///   `foo()` or `22`.
 110     ///
 111     /// An expression represents dead code if, after checking it,
 112     /// the diverges flag is set to something other than `Maybe`.
 113     pub(super) diverges: Cell<Diverges>,
 114
 115     /// Whether any child nodes have any type errors.
 116     pub(super) has_errors: Cell<bool>,
 117
 118     pub(super) enclosing_breakables: RefCell<EnclosingBreakables<'tcx>>,
 119
 120     pub(super) inh: &'a Inherited<'a, 'tcx>,
 121
 122     /// True if the function or closure's return type is known before
 123     /// entering the function/closure, i.e. if the return type is
 124     /// either given explicitly or inferred from, say, an `Fn*` trait
 125     /// bound. Used for diagnostic purposes only.
 126     pub(super) return_type_pre_known: bool,
 127
 128     /// True if the return type has an Opaque type
 129     pub(super) return_type_has_opaque: bool,
 130 }
 131
 132 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
 133     pub fn new(
 134         inh: &'a Inherited<'a, 'tcx>,
 135         param_env: ty::ParamEnv<'tcx>,
 136         body_id: hir::HirId,
 137     ) -> FnCtxt<'a, 'tcx> {
 138         FnCtxt {
 139             body_id,
 140             param_env,
 141             err_count_on_creation: inh.tcx.sess.err_count(),
 142             ret_coercion: None,
 143             in_tail_expr: false,
 144             ret_coercion_span: Cell::new(None),
 145             resume_yield_tys: None,
 146             ps: Cell::new(UnsafetyState::function(hir::Unsafety::Normal, hir::CRATE_HIR_ID)),
 147             diverges: Cell::new(Diverges::Maybe),
 148             has_errors: Cell::new(false),
 149             enclosing_breakables: RefCell::new(EnclosingBreakables {
 150                 stack: Vec::new(),
 151                 by_id: Default::default(),
 152             }),
 153             inh,
 154             return_type_pre_known: true,
 155             return_type_has_opaque: false,
 156         }
 157     }
 158
 159     pub fn cause(&self, span: Span, code: ObligationCauseCode<'tcx>) -> ObligationCause<'tcx> {
 160         ObligationCause::new(span, self.body_id, code)
 161     }
 162
 163     pub fn misc(&self, span: Span) -> ObligationCause<'tcx> {
 164         self.cause(span, ObligationCauseCode::MiscObligation)
 165     }
 166
 167     pub fn sess(&self) -> &Session {
 168         &self.tcx.sess
 169     }
 170
 171     pub fn errors_reported_since_creation(&self) -> bool {
 172         self.tcx.sess.err_count() > self.err_count_on_creation
 173     }
 174 }
 175
 176 impl<'a, 'tcx> Deref for FnCtxt<'a, 'tcx> {
 177     type Target = Inherited<'a, 'tcx>;
 178     fn deref(&self) -> &Self::Target {
 179         &self.inh
 180     }
 181 }
 182
 183 impl<'a, 'tcx> AstConv<'tcx> for FnCtxt<'a, 'tcx> {
 184     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 185         self.tcx
 186     }
 187
 188     fn item_def_id(&self) -> Option<DefId> {
 189         None
 190     }
 191
 192     fn get_type_parameter_bounds(
 193         &self,
 194         _: Span,
 195         def_id: DefId,
 196         _: Ident,
 197     ) -> ty::GenericPredicates<'tcx> {
 198         let tcx = self.tcx;
 199         let item_def_id = tcx.hir().ty_param_owner(def_id.expect_local());
 200         let generics = tcx.generics_of(item_def_id);
 201         let index = generics.param_def_id_to_index[&def_id];
 202         ty::GenericPredicates {
 203             parent: None,
 204             predicates: tcx.arena.alloc_from_iter(
 205                 self.param_env.caller_bounds().iter().filter_map(|predicate| {
 206                     match predicate.kind().skip_binder() {
 207                         ty::PredicateKind::Trait(data) if data.self_ty().is_param(index) => {
 208                             // HACK(eddyb) should get the original `Span`.
 209                             let span = tcx.def_span(def_id);
 210                             Some((predicate, span))
 211                         }
 212                         _ => None,
 213                     }
 214                 }),
 215             ),
 216         }
 217     }
 218
 219     fn re_infer(&self, def: Option<&ty::GenericParamDef>, span: Span) -> Option<ty::Region<'tcx>> {
 220         let v = match def {
 221             Some(def) => infer::EarlyBoundRegion(span, def.name),
 222             None => infer::MiscVariable(span),
 223         };
 224         Some(self.next_region_var(v))
 225     }
 226
 227     fn allow_ty_infer(&self) -> bool {
 228         true
 229     }
 230
 231     fn ty_infer(&self, param: Option<&ty::GenericParamDef>, span: Span) -> Ty<'tcx> {
 232         if let Some(param) = param {
 233             if let GenericArgKind::Type(ty) = self.var_for_def(span, param).unpack() {
 234                 return ty;
 235             }
 236             unreachable!()
 237         } else {
 238             self.next_ty_var(TypeVariableOrigin {
 239                 kind: TypeVariableOriginKind::TypeInference,
 240                 span,
 241             })
 242         }
 243     }
 244
 245     fn ct_infer(
 246         &self,
 247         ty: Ty<'tcx>,
 248         param: Option<&ty::GenericParamDef>,
 249         span: Span,
 250     ) -> Const<'tcx> {
 251         if let Some(param) = param {
 252             if let GenericArgKind::Const(ct) = self.var_for_def(span, param).unpack() {
 253                 return ct;
 254             }
 255             unreachable!()
 256         } else {
 257             self.next_const_var(
 258                 ty,
 259                 ConstVariableOrigin { kind: ConstVariableOriginKind::ConstInference, span },
 260             )
 261         }
 262     }
 263
 264     fn projected_ty_from_poly_trait_ref(
 265         &self,
 266         span: Span,
 267         item_def_id: DefId,
 268         item_segment: &hir::PathSegment<'_>,
 269         poly_trait_ref: ty::PolyTraitRef<'tcx>,
 270     ) -> Ty<'tcx> {
 271         let trait_ref = self.replace_bound_vars_with_fresh_vars(
 272             span,
 273             infer::LateBoundRegionConversionTime::AssocTypeProjection(item_def_id),
 274             poly_trait_ref,
 275         );
 276
 277         let item_substs = <dyn AstConv<'tcx>>::create_substs_for_associated_item(
 278             self,
 279             span,
 280             item_def_id,
 281             item_segment,
 282             trait_ref.substs,
 283         );
 284
 285         self.tcx().mk_projection(item_def_id, item_substs)
 286     }
 287
 288     fn normalize_ty(&self, span: Span, ty: Ty<'tcx>) -> Ty<'tcx> {
 289         if ty.has_escaping_bound_vars() {
 290             ty // FIXME: normalization and escaping regions
 291         } else {
 292             self.normalize_associated_types_in(span, ty)
 293         }
 294     }
 295
 296     fn set_tainted_by_errors(&self) {
 297         self.infcx.set_tainted_by_errors()
 298     }
 299
 300     fn record_ty(&self, hir_id: hir::HirId, ty: Ty<'tcx>, _span: Span) {
 301         self.write_ty(hir_id, ty)
 302     }
 303 }