crates/hir_ty/src/infer/pat.rs

   1 //! Type inference for patterns.
   2
   3 use std::iter::repeat;
   4 use std::sync::Arc;
   5
   6 use chalk_ir::Mutability;
   7 use hir_def::{
   8     expr::{BindingAnnotation, Expr, Literal, Pat, PatId, RecordFieldPat},
   9     path::Path,
  10 };
  11 use hir_expand::name::Name;
  12
  13 use super::{BindingMode, Expectation, InferenceContext, TypeMismatch};
  14 use crate::{
  15     lower::lower_to_chalk_mutability, static_lifetime, Interner, Substitution, Ty, TyBuilder,
  16     TyExt, TyKind,
  17 };
  18
  19 impl<'a> InferenceContext<'a> {
  20     fn infer_tuple_struct_pat(
  21         &mut self,
  22         path: Option<&Path>,
  23         subpats: &[PatId],
  24         expected: &Ty,
  25         default_bm: BindingMode,
  26         id: PatId,
  27         ellipsis: Option<usize>,
  28     ) -> Ty {
  29         let (ty, def) = self.resolve_variant(path);
  30         let var_data = def.map(|it| it.variant_data(self.db.upcast()));
  31         if let Some(variant) = def {
  32             self.write_variant_resolution(id.into(), variant);
  33         }
  34         self.unify(&ty, expected);
  35
  36         let substs =
  37             ty.as_adt().map(|(_, s)| s.clone()).unwrap_or_else(|| Substitution::empty(&Interner));
  38
  39         let field_tys = def.map(|it| self.db.field_types(it)).unwrap_or_default();
  40         let (pre, post) = match ellipsis {
  41             Some(idx) => subpats.split_at(idx),
  42             None => (subpats, &[][..]),
  43         };
  44         let post_idx_offset = field_tys.iter().count() - post.len();
  45
  46         let pre_iter = pre.iter().enumerate();
  47         let post_iter = (post_idx_offset..).zip(post.iter());
  48         for (i, &subpat) in pre_iter.chain(post_iter) {
  49             let expected_ty = var_data
  50                 .as_ref()
  51                 .and_then(|d| d.field(&Name::new_tuple_field(i)))
  52                 .map_or(self.err_ty(), |field| {
  53                     field_tys[field].clone().substitute(&Interner, &substs)
  54                 });
  55             let expected_ty = self.normalize_associated_types_in(expected_ty);
  56             self.infer_pat(subpat, &expected_ty, default_bm);
  57         }
  58
  59         ty
  60     }
  61
  62     fn infer_record_pat(
  63         &mut self,
  64         path: Option<&Path>,
  65         subpats: &[RecordFieldPat],
  66         expected: &Ty,
  67         default_bm: BindingMode,
  68         id: PatId,
  69     ) -> Ty {
  70         let (ty, def) = self.resolve_variant(path);
  71         let var_data = def.map(|it| it.variant_data(self.db.upcast()));
  72         if let Some(variant) = def {
  73             self.write_variant_resolution(id.into(), variant);
  74         }
  75
  76         self.unify(&ty, expected);
  77
  78         let substs =
  79             ty.as_adt().map(|(_, s)| s.clone()).unwrap_or_else(|| Substitution::empty(&Interner));
  80
  81         let field_tys = def.map(|it| self.db.field_types(it)).unwrap_or_default();
  82         for subpat in subpats {
  83             let matching_field = var_data.as_ref().and_then(|it| it.field(&subpat.name));
  84             let expected_ty = matching_field.map_or(self.err_ty(), |field| {
  85                 field_tys[field].clone().substitute(&Interner, &substs)
  86             });
  87             let expected_ty = self.normalize_associated_types_in(expected_ty);
  88             self.infer_pat(subpat.pat, &expected_ty, default_bm);
  89         }
  90
  91         ty
  92     }
  93
  94     pub(super) fn infer_pat(
  95         &mut self,
  96         pat: PatId,
  97         expected: &Ty,
  98         mut default_bm: BindingMode,
  99     ) -> Ty {
 100         let body = Arc::clone(&self.body); // avoid borrow checker problem
 101         let mut expected = self.resolve_ty_shallow(expected);
 102
 103         if is_non_ref_pat(&body, pat) {
 104             let mut pat_adjustments = Vec::new();
 105             while let Some((inner, _lifetime, mutability)) = expected.as_reference() {
 106                 pat_adjustments.push(expected.clone());
 107                 expected = self.resolve_ty_shallow(inner);
 108                 default_bm = match default_bm {
 109                     BindingMode::Move => BindingMode::Ref(mutability),
 110                     BindingMode::Ref(Mutability::Not) => BindingMode::Ref(Mutability::Not),
 111                     BindingMode::Ref(Mutability::Mut) => BindingMode::Ref(mutability),
 112                 }
 113             }
 114
 115             if !pat_adjustments.is_empty() {
 116                 pat_adjustments.shrink_to_fit();
 117                 self.result.pat_adjustments.insert(pat, pat_adjustments);
 118             }
 119         } else if let Pat::Ref { .. } = &body[pat] {
 120             cov_mark::hit!(match_ergonomics_ref);
 121             // When you encounter a `&pat` pattern, reset to Move.
 122             // This is so that `w` is by value: `let (_, &w) = &(1, &2);`
 123             default_bm = BindingMode::Move;
 124         }
 125
 126         // Lose mutability.
 127         let default_bm = default_bm;
 128         let expected = expected;
 129
 130         let ty = match &body[pat] {
 131             &Pat::Tuple { ref args, ellipsis } => {
 132                 let expectations = match expected.as_tuple() {
 133                     Some(parameters) => &*parameters.as_slice(&Interner),
 134                     _ => &[],
 135                 };
 136
 137                 let ((pre, post), n_uncovered_patterns) = match ellipsis {
 138                     Some(idx) => {
 139                         (args.split_at(idx), expectations.len().saturating_sub(args.len()))
 140                     }
 141                     None => ((&args[..], &[][..]), 0),
 142                 };
 143                 let err_ty = self.err_ty();
 144                 let mut expectations_iter =
 145                     expectations.iter().map(|a| a.assert_ty_ref(&Interner)).chain(repeat(&err_ty));
 146                 let mut infer_pat = |(&pat, ty)| self.infer_pat(pat, ty, default_bm);
 147
 148                 let mut inner_tys = Vec::with_capacity(n_uncovered_patterns + args.len());
 149                 inner_tys.extend(pre.iter().zip(expectations_iter.by_ref()).map(&mut infer_pat));
 150                 inner_tys.extend(expectations_iter.by_ref().take(n_uncovered_patterns).cloned());
 151                 inner_tys.extend(post.iter().zip(expectations_iter).map(infer_pat));
 152
 153                 TyKind::Tuple(inner_tys.len(), Substitution::from_iter(&Interner, inner_tys))
 154                     .intern(&Interner)
 155             }
 156             Pat::Or(ref pats) => {
 157                 if let Some((first_pat, rest)) = pats.split_first() {
 158                     let ty = self.infer_pat(*first_pat, &expected, default_bm);
 159                     for pat in rest {
 160                         self.infer_pat(*pat, &expected, default_bm);
 161                     }
 162                     ty
 163                 } else {
 164                     self.err_ty()
 165                 }
 166             }
 167             Pat::Ref { pat, mutability } => {
 168                 let mutability = lower_to_chalk_mutability(*mutability);
 169                 let expectation = match expected.as_reference() {
 170                     Some((inner_ty, _lifetime, exp_mut)) => {
 171                         if mutability != exp_mut {
 172                             // FIXME: emit type error?
 173                         }
 174                         inner_ty.clone()
 175                     }
 176                     _ => self.result.standard_types.unknown.clone(),
 177                 };
 178                 let subty = self.infer_pat(*pat, &expectation, default_bm);
 179                 TyKind::Ref(mutability, static_lifetime(), subty).intern(&Interner)
 180             }
 181             Pat::TupleStruct { path: p, args: subpats, ellipsis } => self.infer_tuple_struct_pat(
 182                 p.as_deref(),
 183                 subpats,
 184                 &expected,
 185                 default_bm,
 186                 pat,
 187                 *ellipsis,
 188             ),
 189             Pat::Record { path: p, args: fields, ellipsis: _ } => {
 190                 self.infer_record_pat(p.as_deref(), fields, &expected, default_bm, pat)
 191             }
 192             Pat::Path(path) => {
 193                 // FIXME use correct resolver for the surrounding expression
 194                 let resolver = self.resolver.clone();
 195                 self.infer_path(&resolver, &path, pat.into()).unwrap_or(self.err_ty())
 196             }
 197             Pat::Bind { mode, name: _, subpat } => {
 198                 let mode = if mode == &BindingAnnotation::Unannotated {
 199                     default_bm
 200                 } else {
 201                     BindingMode::convert(*mode)
 202                 };
 203                 let inner_ty = if let Some(subpat) = subpat {
 204                     self.infer_pat(*subpat, &expected, default_bm)
 205                 } else {
 206                     expected
 207                 };
 208                 let inner_ty = self.insert_type_vars_shallow(inner_ty);
 209
 210                 let bound_ty = match mode {
 211                     BindingMode::Ref(mutability) => {
 212                         TyKind::Ref(mutability, static_lifetime(), inner_ty.clone())
 213                             .intern(&Interner)
 214                     }
 215                     BindingMode::Move => inner_ty.clone(),
 216                 };
 217                 self.write_pat_ty(pat, bound_ty);
 218                 return inner_ty;
 219             }
 220             Pat::Slice { prefix, slice, suffix } => {
 221                 let elem_ty = match expected.kind(&Interner) {
 222                     TyKind::Array(st, _) | TyKind::Slice(st) => st.clone(),
 223                     _ => self.err_ty(),
 224                 };
 225
 226                 for pat_id in prefix.iter().chain(suffix) {
 227                     self.infer_pat(*pat_id, &elem_ty, default_bm);
 228                 }
 229
 230                 let pat_ty = match expected.kind(&Interner) {
 231                     TyKind::Array(_, const_) => TyKind::Array(elem_ty, const_.clone()),
 232                     _ => TyKind::Slice(elem_ty),
 233                 }
 234                 .intern(&Interner);
 235                 if let Some(slice_pat_id) = slice {
 236                     self.infer_pat(*slice_pat_id, &pat_ty, default_bm);
 237                 }
 238
 239                 pat_ty
 240             }
 241             Pat::Wild => expected.clone(),
 242             Pat::Range { start, end } => {
 243                 let start_ty = self.infer_expr(*start, &Expectation::has_type(expected.clone()));
 244                 let end_ty = self.infer_expr(*end, &Expectation::has_type(start_ty));
 245                 end_ty
 246             }
 247             Pat::Lit(expr) => self.infer_expr(*expr, &Expectation::has_type(expected.clone())),
 248             Pat::Box { inner } => match self.resolve_boxed_box() {
 249                 Some(box_adt) => {
 250                     let (inner_ty, alloc_ty) = match expected.as_adt() {
 251                         Some((adt, subst)) if adt == box_adt => (
 252                             subst.at(&Interner, 0).assert_ty_ref(&Interner).clone(),
 253                             subst.as_slice(&Interner).get(1).and_then(|a| a.ty(&Interner).cloned()),
 254                         ),
 255                         _ => (self.result.standard_types.unknown.clone(), None),
 256                     };
 257
 258                     let inner_ty = self.infer_pat(*inner, &inner_ty, default_bm);
 259                     let mut b = TyBuilder::adt(self.db, box_adt).push(inner_ty);
 260
 261                     if let Some(alloc_ty) = alloc_ty {
 262                         b = b.push(alloc_ty);
 263                     }
 264                     b.fill_with_defaults(self.db, || self.table.new_type_var()).build()
 265                 }
 266                 None => self.err_ty(),
 267             },
 268             Pat::ConstBlock(expr) => {
 269                 self.infer_expr(*expr, &Expectation::has_type(expected.clone()))
 270             }
 271             Pat::Missing => self.err_ty(),
 272         };
 273         // use a new type variable if we got error type here
 274         let ty = self.insert_type_vars_shallow(ty);
 275         if !self.unify(&ty, &expected) {
 276             self.result
 277                 .type_mismatches
 278                 .insert(pat.into(), TypeMismatch { expected: expected, actual: ty.clone() });
 279         }
 280         self.write_pat_ty(pat, ty.clone());
 281         ty
 282     }
 283 }
 284
 285 fn is_non_ref_pat(body: &hir_def::body::Body, pat: PatId) -> bool {
 286     match &body[pat] {
 287         Pat::Tuple { .. }
 288         | Pat::TupleStruct { .. }
 289         | Pat::Record { .. }
 290         | Pat::Range { .. }
 291         | Pat::Slice { .. } => true,
 292         Pat::Or(pats) => pats.iter().all(|p| is_non_ref_pat(body, *p)),
 293         // FIXME: ConstBlock/Path/Lit might actually evaluate to ref, but inference is unimplemented.
 294         Pat::Path(..) => true,
 295         Pat::ConstBlock(..) => true,
 296         Pat::Lit(expr) => match body[*expr] {
 297             Expr::Literal(Literal::String(..)) => false,
 298             _ => true,
 299         },
 300         Pat::Bind { mode: BindingAnnotation::Mutable, subpat: Some(subpat), .. }
 301         | Pat::Bind { mode: BindingAnnotation::Unannotated, subpat: Some(subpat), .. } => {
 302             is_non_ref_pat(body, *subpat)
 303         }
 304         Pat::Wild | Pat::Bind { .. } | Pat::Ref { .. } | Pat::Box { .. } | Pat::Missing => false,
 305     }
 306 }