]> git.lizzy.rs Git - rust.git/blob - src/librustc/middle/check_match.rs
Auto merge of #29858 - fhahn:abort-if-path-has-spaces, r=brson
[rust.git] / src / librustc / middle / check_match.rs
1 // Copyright 2012-2014 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 pub use self::Constructor::*;
12 use self::Usefulness::*;
13 use self::WitnessPreference::*;
14
15 use middle::const_eval::{compare_const_vals, ConstVal};
16 use middle::const_eval::{eval_const_expr, eval_const_expr_partial};
17 use middle::const_eval::{const_expr_to_pat, lookup_const_by_id};
18 use middle::const_eval::EvalHint::ExprTypeChecked;
19 use middle::def::*;
20 use middle::def_id::{DefId};
21 use middle::expr_use_visitor::{ConsumeMode, Delegate, ExprUseVisitor, Init};
22 use middle::expr_use_visitor::{JustWrite, LoanCause, MutateMode};
23 use middle::expr_use_visitor::WriteAndRead;
24 use middle::expr_use_visitor as euv;
25 use middle::infer;
26 use middle::mem_categorization::{cmt};
27 use middle::pat_util::*;
28 use middle::ty::*;
29 use middle::ty;
30 use std::cmp::Ordering;
31 use std::fmt;
32 use std::iter::{FromIterator, IntoIterator, repeat};
33
34 use rustc_front::hir;
35 use rustc_front::hir::Pat;
36 use rustc_front::intravisit::{self, Visitor, FnKind};
37 use rustc_front::util as front_util;
38 use rustc_back::slice;
39
40 use syntax::ast::{self, DUMMY_NODE_ID, NodeId};
41 use syntax::ast_util;
42 use syntax::codemap::{Span, Spanned, DUMMY_SP};
43 use rustc_front::fold::{Folder, noop_fold_pat};
44 use rustc_front::print::pprust::pat_to_string;
45 use syntax::ptr::P;
46 use util::nodemap::FnvHashMap;
47
48 pub const DUMMY_WILD_PAT: &'static Pat = &Pat {
49     id: DUMMY_NODE_ID,
50     node: hir::PatWild,
51     span: DUMMY_SP
52 };
53
54 struct Matrix<'a>(Vec<Vec<&'a Pat>>);
55
56 /// Pretty-printer for matrices of patterns, example:
57 /// ++++++++++++++++++++++++++
58 /// + _     + []             +
59 /// ++++++++++++++++++++++++++
60 /// + true  + [First]        +
61 /// ++++++++++++++++++++++++++
62 /// + true  + [Second(true)] +
63 /// ++++++++++++++++++++++++++
64 /// + false + [_]            +
65 /// ++++++++++++++++++++++++++
66 /// + _     + [_, _, ..tail] +
67 /// ++++++++++++++++++++++++++
68 impl<'a> fmt::Debug for Matrix<'a> {
69     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
70         try!(write!(f, "\n"));
71
72         let &Matrix(ref m) = self;
73         let pretty_printed_matrix: Vec<Vec<String>> = m.iter().map(|row| {
74             row.iter()
75                .map(|&pat| pat_to_string(&*pat))
76                .collect::<Vec<String>>()
77         }).collect();
78
79         let column_count = m.iter().map(|row| row.len()).max().unwrap_or(0);
80         assert!(m.iter().all(|row| row.len() == column_count));
81         let column_widths: Vec<usize> = (0..column_count).map(|col| {
82             pretty_printed_matrix.iter().map(|row| row[col].len()).max().unwrap_or(0)
83         }).collect();
84
85         let total_width = column_widths.iter().cloned().sum::<usize>() + column_count * 3 + 1;
86         let br = repeat('+').take(total_width).collect::<String>();
87         try!(write!(f, "{}\n", br));
88         for row in pretty_printed_matrix {
89             try!(write!(f, "+"));
90             for (column, pat_str) in row.into_iter().enumerate() {
91                 try!(write!(f, " "));
92                 try!(write!(f, "{:1$}", pat_str, column_widths[column]));
93                 try!(write!(f, " +"));
94             }
95             try!(write!(f, "\n"));
96             try!(write!(f, "{}\n", br));
97         }
98         Ok(())
99     }
100 }
101
102 impl<'a> FromIterator<Vec<&'a Pat>> for Matrix<'a> {
103     fn from_iter<T: IntoIterator<Item=Vec<&'a Pat>>>(iter: T) -> Matrix<'a> {
104         Matrix(iter.into_iter().collect())
105     }
106 }
107
108 //NOTE: appears to be the only place other then InferCtxt to contain a ParamEnv
109 pub struct MatchCheckCtxt<'a, 'tcx: 'a> {
110     pub tcx: &'a ty::ctxt<'tcx>,
111     pub param_env: ParameterEnvironment<'a, 'tcx>,
112 }
113
114 #[derive(Clone, PartialEq)]
115 pub enum Constructor {
116     /// The constructor of all patterns that don't vary by constructor,
117     /// e.g. struct patterns and fixed-length arrays.
118     Single,
119     /// Enum variants.
120     Variant(DefId),
121     /// Literal values.
122     ConstantValue(ConstVal),
123     /// Ranges of literal values (2..5).
124     ConstantRange(ConstVal, ConstVal),
125     /// Array patterns of length n.
126     Slice(usize),
127     /// Array patterns with a subslice.
128     SliceWithSubslice(usize, usize)
129 }
130
131 #[derive(Clone, PartialEq)]
132 enum Usefulness {
133     Useful,
134     UsefulWithWitness(Vec<P<Pat>>),
135     NotUseful
136 }
137
138 #[derive(Copy, Clone)]
139 enum WitnessPreference {
140     ConstructWitness,
141     LeaveOutWitness
142 }
143
144 impl<'a, 'tcx, 'v> Visitor<'v> for MatchCheckCtxt<'a, 'tcx> {
145     fn visit_expr(&mut self, ex: &hir::Expr) {
146         check_expr(self, ex);
147     }
148     fn visit_local(&mut self, l: &hir::Local) {
149         check_local(self, l);
150     }
151     fn visit_fn(&mut self, fk: FnKind<'v>, fd: &'v hir::FnDecl,
152                 b: &'v hir::Block, s: Span, n: NodeId) {
153         check_fn(self, fk, fd, b, s, n);
154     }
155 }
156
157 pub fn check_crate(tcx: &ty::ctxt) {
158     tcx.map.krate().visit_all_items(&mut MatchCheckCtxt {
159         tcx: tcx,
160         param_env: tcx.empty_parameter_environment(),
161     });
162     tcx.sess.abort_if_errors();
163 }
164
165 fn check_expr(cx: &mut MatchCheckCtxt, ex: &hir::Expr) {
166     intravisit::walk_expr(cx, ex);
167     match ex.node {
168         hir::ExprMatch(ref scrut, ref arms, source) => {
169             for arm in arms {
170                 // First, check legality of move bindings.
171                 check_legality_of_move_bindings(cx,
172                                                 arm.guard.is_some(),
173                                                 &arm.pats);
174
175                 // Second, if there is a guard on each arm, make sure it isn't
176                 // assigning or borrowing anything mutably.
177                 match arm.guard {
178                     Some(ref guard) => check_for_mutation_in_guard(cx, &**guard),
179                     None => {}
180                 }
181             }
182
183             let mut static_inliner = StaticInliner::new(cx.tcx, None);
184             let inlined_arms = arms.iter().map(|arm| {
185                 (arm.pats.iter().map(|pat| {
186                     static_inliner.fold_pat((*pat).clone())
187                 }).collect(), arm.guard.as_ref().map(|e| &**e))
188             }).collect::<Vec<(Vec<P<Pat>>, Option<&hir::Expr>)>>();
189
190             // Bail out early if inlining failed.
191             if static_inliner.failed {
192                 return;
193             }
194
195             for pat in inlined_arms
196                 .iter()
197                 .flat_map(|&(ref pats, _)| pats) {
198                 // Third, check legality of move bindings.
199                 check_legality_of_bindings_in_at_patterns(cx, &**pat);
200
201                 // Fourth, check if there are any references to NaN that we should warn about.
202                 check_for_static_nan(cx, &**pat);
203
204                 // Fifth, check if for any of the patterns that match an enumerated type
205                 // are bindings with the same name as one of the variants of said type.
206                 check_for_bindings_named_the_same_as_variants(cx, &**pat);
207             }
208
209             // Fourth, check for unreachable arms.
210             check_arms(cx, &inlined_arms[..], source);
211
212             // Finally, check if the whole match expression is exhaustive.
213             // Check for empty enum, because is_useful only works on inhabited types.
214             let pat_ty = cx.tcx.node_id_to_type(scrut.id);
215             if inlined_arms.is_empty() {
216                 if !pat_ty.is_empty(cx.tcx) {
217                     // We know the type is inhabited, so this must be wrong
218                     span_err!(cx.tcx.sess, ex.span, E0002,
219                               "non-exhaustive patterns: type {} is non-empty",
220                               pat_ty);
221                     span_help!(cx.tcx.sess, ex.span,
222                         "Please ensure that all possible cases are being handled; \
223                          possibly adding wildcards or more match arms.");
224                 }
225                 // If the type *is* empty, it's vacuously exhaustive
226                 return;
227             }
228
229             let matrix: Matrix = inlined_arms
230                 .iter()
231                 .filter(|&&(_, guard)| guard.is_none())
232                 .flat_map(|arm| &arm.0)
233                 .map(|pat| vec![&**pat])
234                 .collect();
235             check_exhaustive(cx, ex.span, &matrix, source);
236         },
237         _ => ()
238     }
239 }
240
241 fn check_for_bindings_named_the_same_as_variants(cx: &MatchCheckCtxt, pat: &Pat) {
242     front_util::walk_pat(pat, |p| {
243         match p.node {
244             hir::PatIdent(hir::BindByValue(hir::MutImmutable), ident, None) => {
245                 let pat_ty = cx.tcx.pat_ty(p);
246                 if let ty::TyEnum(edef, _) = pat_ty.sty {
247                     let def = cx.tcx.def_map.borrow().get(&p.id).map(|d| d.full_def());
248                     if let Some(DefLocal(..)) = def {
249                         if edef.variants.iter().any(|variant|
250                             variant.name == ident.node.name
251                                 && variant.kind() == VariantKind::Unit
252                         ) {
253                             span_warn!(cx.tcx.sess, p.span, E0170,
254                                 "pattern binding `{}` is named the same as one \
255                                  of the variants of the type `{}`",
256                                 ident.node, pat_ty);
257                             fileline_help!(cx.tcx.sess, p.span,
258                                 "if you meant to match on a variant, \
259                                  consider making the path in the pattern qualified: `{}::{}`",
260                                 pat_ty, ident.node);
261                         }
262                     }
263                 }
264             }
265             _ => ()
266         }
267         true
268     });
269 }
270
271 // Check that we do not match against a static NaN (#6804)
272 fn check_for_static_nan(cx: &MatchCheckCtxt, pat: &Pat) {
273     front_util::walk_pat(pat, |p| {
274         if let hir::PatLit(ref expr) = p.node {
275             match eval_const_expr_partial(cx.tcx, &**expr, ExprTypeChecked, None) {
276                 Ok(ConstVal::Float(f)) if f.is_nan() => {
277                     span_warn!(cx.tcx.sess, p.span, E0003,
278                                "unmatchable NaN in pattern, \
279                                 use the is_nan method in a guard instead");
280                 }
281                 Ok(_) => {}
282
283                 Err(err) => {
284                     span_err!(cx.tcx.sess, err.span, E0471,
285                               "constant evaluation error: {}",
286                               err.description());
287                     if !p.span.contains(err.span) {
288                         cx.tcx.sess.span_note(p.span,
289                                               "in pattern here")
290                     }
291                 }
292             }
293         }
294         true
295     });
296 }
297
298 // Check for unreachable patterns
299 fn check_arms(cx: &MatchCheckCtxt,
300               arms: &[(Vec<P<Pat>>, Option<&hir::Expr>)],
301               source: hir::MatchSource) {
302     let mut seen = Matrix(vec![]);
303     let mut printed_if_let_err = false;
304     for &(ref pats, guard) in arms {
305         for pat in pats {
306             let v = vec![&**pat];
307
308             match is_useful(cx, &seen, &v[..], LeaveOutWitness) {
309                 NotUseful => {
310                     match source {
311                         hir::MatchSource::IfLetDesugar { .. } => {
312                             if printed_if_let_err {
313                                 // we already printed an irrefutable if-let pattern error.
314                                 // We don't want two, that's just confusing.
315                             } else {
316                                 // find the first arm pattern so we can use its span
317                                 let &(ref first_arm_pats, _) = &arms[0];
318                                 let first_pat = &first_arm_pats[0];
319                                 let span = first_pat.span;
320                                 span_err!(cx.tcx.sess, span, E0162, "irrefutable if-let pattern");
321                                 printed_if_let_err = true;
322                             }
323                         },
324
325                         hir::MatchSource::WhileLetDesugar => {
326                             // find the first arm pattern so we can use its span
327                             let &(ref first_arm_pats, _) = &arms[0];
328                             let first_pat = &first_arm_pats[0];
329                             let span = first_pat.span;
330                             span_err!(cx.tcx.sess, span, E0165, "irrefutable while-let pattern");
331                         },
332
333                         hir::MatchSource::ForLoopDesugar => {
334                             // this is a bug, because on `match iter.next()` we cover
335                             // `Some(<head>)` and `None`. It's impossible to have an unreachable
336                             // pattern
337                             // (see libsyntax/ext/expand.rs for the full expansion of a for loop)
338                             cx.tcx.sess.span_bug(pat.span, "unreachable for-loop pattern")
339                         },
340
341                         hir::MatchSource::Normal => {
342                             span_err!(cx.tcx.sess, pat.span, E0001, "unreachable pattern")
343                         },
344                     }
345                 }
346                 Useful => (),
347                 UsefulWithWitness(_) => unreachable!()
348             }
349             if guard.is_none() {
350                 let Matrix(mut rows) = seen;
351                 rows.push(v);
352                 seen = Matrix(rows);
353             }
354         }
355     }
356 }
357
358 fn raw_pat<'a>(p: &'a Pat) -> &'a Pat {
359     match p.node {
360         hir::PatIdent(_, _, Some(ref s)) => raw_pat(&**s),
361         _ => p
362     }
363 }
364
365 fn check_exhaustive(cx: &MatchCheckCtxt, sp: Span, matrix: &Matrix, source: hir::MatchSource) {
366     match is_useful(cx, matrix, &[DUMMY_WILD_PAT], ConstructWitness) {
367         UsefulWithWitness(pats) => {
368             let witness = match &pats[..] {
369                 [ref witness] => &**witness,
370                 [] => DUMMY_WILD_PAT,
371                 _ => unreachable!()
372             };
373             match source {
374                 hir::MatchSource::ForLoopDesugar => {
375                     // `witness` has the form `Some(<head>)`, peel off the `Some`
376                     let witness = match witness.node {
377                         hir::PatEnum(_, Some(ref pats)) => match &pats[..] {
378                             [ref pat] => &**pat,
379                             _ => unreachable!(),
380                         },
381                         _ => unreachable!(),
382                     };
383
384                     span_err!(cx.tcx.sess, sp, E0297,
385                         "refutable pattern in `for` loop binding: \
386                                 `{}` not covered",
387                                 pat_to_string(witness));
388                 },
389                 _ => {
390                     span_err!(cx.tcx.sess, sp, E0004,
391                         "non-exhaustive patterns: `{}` not covered",
392                         pat_to_string(witness)
393                     );
394                 },
395             }
396         }
397         NotUseful => {
398             // This is good, wildcard pattern isn't reachable
399         },
400         _ => unreachable!()
401     }
402 }
403
404 fn const_val_to_expr(value: &ConstVal) -> P<hir::Expr> {
405     let node = match value {
406         &ConstVal::Bool(b) => ast::LitBool(b),
407         _ => unreachable!()
408     };
409     P(hir::Expr {
410         id: 0,
411         node: hir::ExprLit(P(Spanned { node: node, span: DUMMY_SP })),
412         span: DUMMY_SP
413     })
414 }
415
416 pub struct StaticInliner<'a, 'tcx: 'a> {
417     pub tcx: &'a ty::ctxt<'tcx>,
418     pub failed: bool,
419     pub renaming_map: Option<&'a mut FnvHashMap<(NodeId, Span), NodeId>>,
420 }
421
422 impl<'a, 'tcx> StaticInliner<'a, 'tcx> {
423     pub fn new<'b>(tcx: &'b ty::ctxt<'tcx>,
424                    renaming_map: Option<&'b mut FnvHashMap<(NodeId, Span), NodeId>>)
425                    -> StaticInliner<'b, 'tcx> {
426         StaticInliner {
427             tcx: tcx,
428             failed: false,
429             renaming_map: renaming_map
430         }
431     }
432 }
433
434 struct RenamingRecorder<'map> {
435     substituted_node_id: NodeId,
436     origin_span: Span,
437     renaming_map: &'map mut FnvHashMap<(NodeId, Span), NodeId>
438 }
439
440 impl<'map> ast_util::IdVisitingOperation for RenamingRecorder<'map> {
441     fn visit_id(&mut self, node_id: NodeId) {
442         let key = (node_id, self.origin_span);
443         self.renaming_map.insert(key, self.substituted_node_id);
444     }
445 }
446
447 impl<'a, 'tcx> Folder for StaticInliner<'a, 'tcx> {
448     fn fold_pat(&mut self, pat: P<Pat>) -> P<Pat> {
449         return match pat.node {
450             hir::PatIdent(..) | hir::PatEnum(..) | hir::PatQPath(..) => {
451                 let def = self.tcx.def_map.borrow().get(&pat.id).map(|d| d.full_def());
452                 match def {
453                     Some(DefAssociatedConst(did)) |
454                     Some(DefConst(did)) => match lookup_const_by_id(self.tcx, did, Some(pat.id)) {
455                         Some(const_expr) => {
456                             const_expr_to_pat(self.tcx, const_expr, pat.span).map(|new_pat| {
457
458                                 if let Some(ref mut renaming_map) = self.renaming_map {
459                                     // Record any renamings we do here
460                                     record_renamings(const_expr, &pat, renaming_map);
461                                 }
462
463                                 new_pat
464                             })
465                         }
466                         None => {
467                             self.failed = true;
468                             span_err!(self.tcx.sess, pat.span, E0158,
469                                 "statics cannot be referenced in patterns");
470                             pat
471                         }
472                     },
473                     _ => noop_fold_pat(pat, self)
474                 }
475             }
476             _ => noop_fold_pat(pat, self)
477         };
478
479         fn record_renamings(const_expr: &hir::Expr,
480                             substituted_pat: &hir::Pat,
481                             renaming_map: &mut FnvHashMap<(NodeId, Span), NodeId>) {
482             let mut renaming_recorder = RenamingRecorder {
483                 substituted_node_id: substituted_pat.id,
484                 origin_span: substituted_pat.span,
485                 renaming_map: renaming_map,
486             };
487
488             let mut id_visitor = front_util::IdVisitor::new(&mut renaming_recorder);
489
490             id_visitor.visit_expr(const_expr);
491         }
492     }
493 }
494
495 /// Constructs a partial witness for a pattern given a list of
496 /// patterns expanded by the specialization step.
497 ///
498 /// When a pattern P is discovered to be useful, this function is used bottom-up
499 /// to reconstruct a complete witness, e.g. a pattern P' that covers a subset
500 /// of values, V, where each value in that set is not covered by any previously
501 /// used patterns and is covered by the pattern P'. Examples:
502 ///
503 /// left_ty: tuple of 3 elements
504 /// pats: [10, 20, _]           => (10, 20, _)
505 ///
506 /// left_ty: struct X { a: (bool, &'static str), b: usize}
507 /// pats: [(false, "foo"), 42]  => X { a: (false, "foo"), b: 42 }
508 fn construct_witness<'a,'tcx>(cx: &MatchCheckCtxt<'a,'tcx>, ctor: &Constructor,
509                               pats: Vec<&Pat>, left_ty: Ty<'tcx>) -> P<Pat> {
510     let pats_len = pats.len();
511     let mut pats = pats.into_iter().map(|p| P((*p).clone()));
512     let pat = match left_ty.sty {
513         ty::TyTuple(_) => hir::PatTup(pats.collect()),
514
515         ty::TyEnum(adt, _) | ty::TyStruct(adt, _)  => {
516             let v = adt.variant_of_ctor(ctor);
517             if let VariantKind::Struct = v.kind() {
518                 let field_pats: Vec<_> = v.fields.iter()
519                     .zip(pats)
520                     .filter(|&(_, ref pat)| pat.node != hir::PatWild)
521                     .map(|(field, pat)| Spanned {
522                         span: DUMMY_SP,
523                         node: hir::FieldPat {
524                             name: field.name,
525                             pat: pat,
526                             is_shorthand: false,
527                         }
528                     }).collect();
529                 let has_more_fields = field_pats.len() < pats_len;
530                 hir::PatStruct(def_to_path(cx.tcx, v.did), field_pats, has_more_fields)
531             } else {
532                 hir::PatEnum(def_to_path(cx.tcx, v.did), Some(pats.collect()))
533             }
534         }
535
536         ty::TyRef(_, ty::TypeAndMut { ty, mutbl }) => {
537             match ty.sty {
538                ty::TyArray(_, n) => match ctor {
539                     &Single => {
540                         assert_eq!(pats_len, n);
541                         hir::PatVec(pats.collect(), None, vec!())
542                     },
543                     _ => unreachable!()
544                 },
545                 ty::TySlice(_) => match ctor {
546                     &Slice(n) => {
547                         assert_eq!(pats_len, n);
548                         hir::PatVec(pats.collect(), None, vec!())
549                     },
550                     _ => unreachable!()
551                 },
552                 ty::TyStr => hir::PatWild,
553
554                 _ => {
555                     assert_eq!(pats_len, 1);
556                     hir::PatRegion(pats.nth(0).unwrap(), mutbl)
557                 }
558             }
559         }
560
561         ty::TyArray(_, len) => {
562             assert_eq!(pats_len, len);
563             hir::PatVec(pats.collect(), None, vec![])
564         }
565
566         _ => {
567             match *ctor {
568                 ConstantValue(ref v) => hir::PatLit(const_val_to_expr(v)),
569                 _ => hir::PatWild,
570             }
571         }
572     };
573
574     P(hir::Pat {
575         id: 0,
576         node: pat,
577         span: DUMMY_SP
578     })
579 }
580
581 impl<'tcx, 'container> ty::AdtDefData<'tcx, 'container> {
582     fn variant_of_ctor(&self,
583                        ctor: &Constructor)
584                        -> &VariantDefData<'tcx, 'container> {
585         match ctor {
586             &Variant(vid) => self.variant_with_id(vid),
587             _ => self.struct_variant()
588         }
589     }
590 }
591
592 fn missing_constructor(cx: &MatchCheckCtxt, &Matrix(ref rows): &Matrix,
593                        left_ty: Ty, max_slice_length: usize) -> Option<Constructor> {
594     let used_constructors: Vec<Constructor> = rows.iter()
595         .flat_map(|row| pat_constructors(cx, row[0], left_ty, max_slice_length))
596         .collect();
597     all_constructors(cx, left_ty, max_slice_length)
598         .into_iter()
599         .find(|c| !used_constructors.contains(c))
600 }
601
602 /// This determines the set of all possible constructors of a pattern matching
603 /// values of type `left_ty`. For vectors, this would normally be an infinite set
604 /// but is instead bounded by the maximum fixed length of slice patterns in
605 /// the column of patterns being analyzed.
606 fn all_constructors(_cx: &MatchCheckCtxt, left_ty: Ty,
607                     max_slice_length: usize) -> Vec<Constructor> {
608     match left_ty.sty {
609         ty::TyBool =>
610             [true, false].iter().map(|b| ConstantValue(ConstVal::Bool(*b))).collect(),
611
612         ty::TyRef(_, ty::TypeAndMut { ty, .. }) => match ty.sty {
613             ty::TySlice(_) =>
614                 (0..max_slice_length+1).map(|length| Slice(length)).collect(),
615             _ => vec![Single]
616         },
617
618         ty::TyEnum(def, _) => def.variants.iter().map(|v| Variant(v.did)).collect(),
619         _ => vec![Single]
620     }
621 }
622
623 // Algorithm from http://moscova.inria.fr/~maranget/papers/warn/index.html
624 //
625 // Whether a vector `v` of patterns is 'useful' in relation to a set of such
626 // vectors `m` is defined as there being a set of inputs that will match `v`
627 // but not any of the sets in `m`.
628 //
629 // This is used both for reachability checking (if a pattern isn't useful in
630 // relation to preceding patterns, it is not reachable) and exhaustiveness
631 // checking (if a wildcard pattern is useful in relation to a matrix, the
632 // matrix isn't exhaustive).
633
634 // Note: is_useful doesn't work on empty types, as the paper notes.
635 // So it assumes that v is non-empty.
636 fn is_useful(cx: &MatchCheckCtxt,
637              matrix: &Matrix,
638              v: &[&Pat],
639              witness: WitnessPreference)
640              -> Usefulness {
641     let &Matrix(ref rows) = matrix;
642     debug!("{:?}", matrix);
643     if rows.is_empty() {
644         return match witness {
645             ConstructWitness => UsefulWithWitness(vec!()),
646             LeaveOutWitness => Useful
647         };
648     }
649     if rows[0].is_empty() {
650         return NotUseful;
651     }
652     assert!(rows.iter().all(|r| r.len() == v.len()));
653     let real_pat = match rows.iter().find(|r| (*r)[0].id != DUMMY_NODE_ID) {
654         Some(r) => raw_pat(r[0]),
655         None if v.is_empty() => return NotUseful,
656         None => v[0]
657     };
658     let left_ty = if real_pat.id == DUMMY_NODE_ID {
659         cx.tcx.mk_nil()
660     } else {
661         let left_ty = cx.tcx.pat_ty(&*real_pat);
662
663         match real_pat.node {
664             hir::PatIdent(hir::BindByRef(..), _, _) => {
665                 left_ty.builtin_deref(false, NoPreference).unwrap().ty
666             }
667             _ => left_ty,
668         }
669     };
670
671     let max_slice_length = rows.iter().filter_map(|row| match row[0].node {
672         hir::PatVec(ref before, _, ref after) => Some(before.len() + after.len()),
673         _ => None
674     }).max().map_or(0, |v| v + 1);
675
676     let constructors = pat_constructors(cx, v[0], left_ty, max_slice_length);
677     if constructors.is_empty() {
678         match missing_constructor(cx, matrix, left_ty, max_slice_length) {
679             None => {
680                 all_constructors(cx, left_ty, max_slice_length).into_iter().map(|c| {
681                     match is_useful_specialized(cx, matrix, v, c.clone(), left_ty, witness) {
682                         UsefulWithWitness(pats) => UsefulWithWitness({
683                             let arity = constructor_arity(cx, &c, left_ty);
684                             let mut result = {
685                                 let pat_slice = &pats[..];
686                                 let subpats: Vec<_> = (0..arity).map(|i| {
687                                     pat_slice.get(i).map_or(DUMMY_WILD_PAT, |p| &**p)
688                                 }).collect();
689                                 vec![construct_witness(cx, &c, subpats, left_ty)]
690                             };
691                             result.extend(pats.into_iter().skip(arity));
692                             result
693                         }),
694                         result => result
695                     }
696                 }).find(|result| result != &NotUseful).unwrap_or(NotUseful)
697             },
698
699             Some(constructor) => {
700                 let matrix = rows.iter().filter_map(|r| {
701                     if pat_is_binding_or_wild(&cx.tcx.def_map.borrow(), raw_pat(r[0])) {
702                         Some(r[1..].to_vec())
703                     } else {
704                         None
705                     }
706                 }).collect();
707                 match is_useful(cx, &matrix, &v[1..], witness) {
708                     UsefulWithWitness(pats) => {
709                         let arity = constructor_arity(cx, &constructor, left_ty);
710                         let wild_pats = vec![DUMMY_WILD_PAT; arity];
711                         let enum_pat = construct_witness(cx, &constructor, wild_pats, left_ty);
712                         let mut new_pats = vec![enum_pat];
713                         new_pats.extend(pats);
714                         UsefulWithWitness(new_pats)
715                     },
716                     result => result
717                 }
718             }
719         }
720     } else {
721         constructors.into_iter().map(|c|
722             is_useful_specialized(cx, matrix, v, c.clone(), left_ty, witness)
723         ).find(|result| result != &NotUseful).unwrap_or(NotUseful)
724     }
725 }
726
727 fn is_useful_specialized(cx: &MatchCheckCtxt, &Matrix(ref m): &Matrix,
728                          v: &[&Pat], ctor: Constructor, lty: Ty,
729                          witness: WitnessPreference) -> Usefulness {
730     let arity = constructor_arity(cx, &ctor, lty);
731     let matrix = Matrix(m.iter().filter_map(|r| {
732         specialize(cx, &r[..], &ctor, 0, arity)
733     }).collect());
734     match specialize(cx, v, &ctor, 0, arity) {
735         Some(v) => is_useful(cx, &matrix, &v[..], witness),
736         None => NotUseful
737     }
738 }
739
740 /// Determines the constructors that the given pattern can be specialized to.
741 ///
742 /// In most cases, there's only one constructor that a specific pattern
743 /// represents, such as a specific enum variant or a specific literal value.
744 /// Slice patterns, however, can match slices of different lengths. For instance,
745 /// `[a, b, ..tail]` can match a slice of length 2, 3, 4 and so on.
746 ///
747 /// On the other hand, a wild pattern and an identifier pattern cannot be
748 /// specialized in any way.
749 fn pat_constructors(cx: &MatchCheckCtxt, p: &Pat,
750                     left_ty: Ty, max_slice_length: usize) -> Vec<Constructor> {
751     let pat = raw_pat(p);
752     match pat.node {
753         hir::PatIdent(..) =>
754             match cx.tcx.def_map.borrow().get(&pat.id).map(|d| d.full_def()) {
755                 Some(DefConst(..)) | Some(DefAssociatedConst(..)) =>
756                     cx.tcx.sess.span_bug(pat.span, "const pattern should've \
757                                                     been rewritten"),
758                 Some(DefStruct(_)) => vec!(Single),
759                 Some(DefVariant(_, id, _)) => vec!(Variant(id)),
760                 _ => vec!()
761             },
762         hir::PatEnum(..) =>
763             match cx.tcx.def_map.borrow().get(&pat.id).map(|d| d.full_def()) {
764                 Some(DefConst(..)) | Some(DefAssociatedConst(..)) =>
765                     cx.tcx.sess.span_bug(pat.span, "const pattern should've \
766                                                     been rewritten"),
767                 Some(DefVariant(_, id, _)) => vec!(Variant(id)),
768                 _ => vec!(Single)
769             },
770         hir::PatQPath(..) =>
771             cx.tcx.sess.span_bug(pat.span, "const pattern should've \
772                                             been rewritten"),
773         hir::PatStruct(..) =>
774             match cx.tcx.def_map.borrow().get(&pat.id).map(|d| d.full_def()) {
775                 Some(DefConst(..)) | Some(DefAssociatedConst(..)) =>
776                     cx.tcx.sess.span_bug(pat.span, "const pattern should've \
777                                                     been rewritten"),
778                 Some(DefVariant(_, id, _)) => vec!(Variant(id)),
779                 _ => vec!(Single)
780             },
781         hir::PatLit(ref expr) =>
782             vec!(ConstantValue(eval_const_expr(cx.tcx, &**expr))),
783         hir::PatRange(ref lo, ref hi) =>
784             vec!(ConstantRange(eval_const_expr(cx.tcx, &**lo), eval_const_expr(cx.tcx, &**hi))),
785         hir::PatVec(ref before, ref slice, ref after) =>
786             match left_ty.sty {
787                 ty::TyArray(_, _) => vec!(Single),
788                 _                      => if slice.is_some() {
789                     (before.len() + after.len()..max_slice_length+1)
790                         .map(|length| Slice(length))
791                         .collect()
792                 } else {
793                     vec!(Slice(before.len() + after.len()))
794                 }
795             },
796         hir::PatBox(_) | hir::PatTup(_) | hir::PatRegion(..) =>
797             vec!(Single),
798         hir::PatWild =>
799             vec!(),
800     }
801 }
802
803 /// This computes the arity of a constructor. The arity of a constructor
804 /// is how many subpattern patterns of that constructor should be expanded to.
805 ///
806 /// For instance, a tuple pattern (_, 42, Some([])) has the arity of 3.
807 /// A struct pattern's arity is the number of fields it contains, etc.
808 pub fn constructor_arity(_cx: &MatchCheckCtxt, ctor: &Constructor, ty: Ty) -> usize {
809     match ty.sty {
810         ty::TyTuple(ref fs) => fs.len(),
811         ty::TyBox(_) => 1,
812         ty::TyRef(_, ty::TypeAndMut { ty, .. }) => match ty.sty {
813             ty::TySlice(_) => match *ctor {
814                 Slice(length) => length,
815                 ConstantValue(_) => 0,
816                 _ => unreachable!()
817             },
818             ty::TyStr => 0,
819             _ => 1
820         },
821         ty::TyEnum(adt, _) | ty::TyStruct(adt, _) => {
822             adt.variant_of_ctor(ctor).fields.len()
823         }
824         ty::TyArray(_, n) => n,
825         _ => 0
826     }
827 }
828
829 fn range_covered_by_constructor(ctor: &Constructor,
830                                 from: &ConstVal, to: &ConstVal) -> Option<bool> {
831     let (c_from, c_to) = match *ctor {
832         ConstantValue(ref value)        => (value, value),
833         ConstantRange(ref from, ref to) => (from, to),
834         Single                          => return Some(true),
835         _                               => unreachable!()
836     };
837     let cmp_from = compare_const_vals(c_from, from);
838     let cmp_to = compare_const_vals(c_to, to);
839     match (cmp_from, cmp_to) {
840         (Some(cmp_from), Some(cmp_to)) => {
841             Some(cmp_from != Ordering::Less && cmp_to != Ordering::Greater)
842         }
843         _ => None
844     }
845 }
846
847 /// This is the main specialization step. It expands the first pattern in the given row
848 /// into `arity` patterns based on the constructor. For most patterns, the step is trivial,
849 /// for instance tuple patterns are flattened and box patterns expand into their inner pattern.
850 ///
851 /// OTOH, slice patterns with a subslice pattern (..tail) can be expanded into multiple
852 /// different patterns.
853 /// Structure patterns with a partial wild pattern (Foo { a: 42, .. }) have their missing
854 /// fields filled with wild patterns.
855 pub fn specialize<'a>(cx: &MatchCheckCtxt, r: &[&'a Pat],
856                       constructor: &Constructor, col: usize, arity: usize) -> Option<Vec<&'a Pat>> {
857     let &Pat {
858         id: pat_id, ref node, span: pat_span
859     } = raw_pat(r[col]);
860     let head: Option<Vec<&Pat>> = match *node {
861         hir::PatWild =>
862             Some(vec![DUMMY_WILD_PAT; arity]),
863
864         hir::PatIdent(_, _, _) => {
865             let opt_def = cx.tcx.def_map.borrow().get(&pat_id).map(|d| d.full_def());
866             match opt_def {
867                 Some(DefConst(..)) | Some(DefAssociatedConst(..)) =>
868                     cx.tcx.sess.span_bug(pat_span, "const pattern should've \
869                                                     been rewritten"),
870                 Some(DefVariant(_, id, _)) => if *constructor == Variant(id) {
871                     Some(vec!())
872                 } else {
873                     None
874                 },
875                 _ => Some(vec![DUMMY_WILD_PAT; arity])
876             }
877         }
878
879         hir::PatEnum(_, ref args) => {
880             let def = cx.tcx.def_map.borrow().get(&pat_id).unwrap().full_def();
881             match def {
882                 DefConst(..) | DefAssociatedConst(..) =>
883                     cx.tcx.sess.span_bug(pat_span, "const pattern should've \
884                                                     been rewritten"),
885                 DefVariant(_, id, _) if *constructor != Variant(id) => None,
886                 DefVariant(..) | DefStruct(..) => {
887                     Some(match args {
888                         &Some(ref args) => args.iter().map(|p| &**p).collect(),
889                         &None => vec![DUMMY_WILD_PAT; arity],
890                     })
891                 }
892                 _ => None
893             }
894         }
895
896         hir::PatQPath(_, _) => {
897             cx.tcx.sess.span_bug(pat_span, "const pattern should've \
898                                             been rewritten")
899         }
900
901         hir::PatStruct(_, ref pattern_fields, _) => {
902             let def = cx.tcx.def_map.borrow().get(&pat_id).unwrap().full_def();
903             let adt = cx.tcx.node_id_to_type(pat_id).ty_adt_def().unwrap();
904             let variant = adt.variant_of_ctor(constructor);
905             let def_variant = adt.variant_of_def(def);
906             if variant.did == def_variant.did {
907                 Some(variant.fields.iter().map(|sf| {
908                     match pattern_fields.iter().find(|f| f.node.name == sf.name) {
909                         Some(ref f) => &*f.node.pat,
910                         _ => DUMMY_WILD_PAT
911                     }
912                 }).collect())
913             } else {
914                 None
915             }
916         }
917
918         hir::PatTup(ref args) =>
919             Some(args.iter().map(|p| &**p).collect()),
920
921         hir::PatBox(ref inner) | hir::PatRegion(ref inner, _) =>
922             Some(vec![&**inner]),
923
924         hir::PatLit(ref expr) => {
925             let expr_value = eval_const_expr(cx.tcx, &**expr);
926             match range_covered_by_constructor(constructor, &expr_value, &expr_value) {
927                 Some(true) => Some(vec![]),
928                 Some(false) => None,
929                 None => {
930                     span_err!(cx.tcx.sess, pat_span, E0298, "mismatched types between arms");
931                     None
932                 }
933             }
934         }
935
936         hir::PatRange(ref from, ref to) => {
937             let from_value = eval_const_expr(cx.tcx, &**from);
938             let to_value = eval_const_expr(cx.tcx, &**to);
939             match range_covered_by_constructor(constructor, &from_value, &to_value) {
940                 Some(true) => Some(vec![]),
941                 Some(false) => None,
942                 None => {
943                     span_err!(cx.tcx.sess, pat_span, E0299, "mismatched types between arms");
944                     None
945                 }
946             }
947         }
948
949         hir::PatVec(ref before, ref slice, ref after) => {
950             match *constructor {
951                 // Fixed-length vectors.
952                 Single => {
953                     let mut pats: Vec<&Pat> = before.iter().map(|p| &**p).collect();
954                     pats.extend(repeat(DUMMY_WILD_PAT).take(arity - before.len() - after.len()));
955                     pats.extend(after.iter().map(|p| &**p));
956                     Some(pats)
957                 },
958                 Slice(length) if before.len() + after.len() <= length && slice.is_some() => {
959                     let mut pats: Vec<&Pat> = before.iter().map(|p| &**p).collect();
960                     pats.extend(repeat(DUMMY_WILD_PAT).take(arity - before.len() - after.len()));
961                     pats.extend(after.iter().map(|p| &**p));
962                     Some(pats)
963                 },
964                 Slice(length) if before.len() + after.len() == length => {
965                     let mut pats: Vec<&Pat> = before.iter().map(|p| &**p).collect();
966                     pats.extend(after.iter().map(|p| &**p));
967                     Some(pats)
968                 },
969                 SliceWithSubslice(prefix, suffix)
970                     if before.len() == prefix
971                         && after.len() == suffix
972                         && slice.is_some() => {
973                     let mut pats: Vec<&Pat> = before.iter().map(|p| &**p).collect();
974                     pats.extend(after.iter().map(|p| &**p));
975                     Some(pats)
976                 }
977                 _ => None
978             }
979         }
980     };
981     head.map(|mut head| {
982         head.push_all(&r[..col]);
983         head.push_all(&r[col + 1..]);
984         head
985     })
986 }
987
988 fn check_local(cx: &mut MatchCheckCtxt, loc: &hir::Local) {
989     intravisit::walk_local(cx, loc);
990
991     let pat = StaticInliner::new(cx.tcx, None).fold_pat(loc.pat.clone());
992     check_irrefutable(cx, &pat, false);
993
994     // Check legality of move bindings and `@` patterns.
995     check_legality_of_move_bindings(cx, false, slice::ref_slice(&loc.pat));
996     check_legality_of_bindings_in_at_patterns(cx, &*loc.pat);
997 }
998
999 fn check_fn(cx: &mut MatchCheckCtxt,
1000             kind: FnKind,
1001             decl: &hir::FnDecl,
1002             body: &hir::Block,
1003             sp: Span,
1004             fn_id: NodeId) {
1005     match kind {
1006         FnKind::Closure => {}
1007         _ => cx.param_env = ParameterEnvironment::for_item(cx.tcx, fn_id),
1008     }
1009
1010     intravisit::walk_fn(cx, kind, decl, body, sp);
1011
1012     for input in &decl.inputs {
1013         check_irrefutable(cx, &input.pat, true);
1014         check_legality_of_move_bindings(cx, false, slice::ref_slice(&input.pat));
1015         check_legality_of_bindings_in_at_patterns(cx, &*input.pat);
1016     }
1017 }
1018
1019 fn check_irrefutable(cx: &MatchCheckCtxt, pat: &Pat, is_fn_arg: bool) {
1020     let origin = if is_fn_arg {
1021         "function argument"
1022     } else {
1023         "local binding"
1024     };
1025
1026     is_refutable(cx, pat, |uncovered_pat| {
1027         span_err!(cx.tcx.sess, pat.span, E0005,
1028             "refutable pattern in {}: `{}` not covered",
1029             origin,
1030             pat_to_string(uncovered_pat),
1031         );
1032     });
1033 }
1034
1035 fn is_refutable<A, F>(cx: &MatchCheckCtxt, pat: &Pat, refutable: F) -> Option<A> where
1036     F: FnOnce(&Pat) -> A,
1037 {
1038     let pats = Matrix(vec!(vec!(pat)));
1039     match is_useful(cx, &pats, &[DUMMY_WILD_PAT], ConstructWitness) {
1040         UsefulWithWitness(pats) => {
1041             assert_eq!(pats.len(), 1);
1042             Some(refutable(&*pats[0]))
1043         },
1044         NotUseful => None,
1045         Useful => unreachable!()
1046     }
1047 }
1048
1049 // Legality of move bindings checking
1050 fn check_legality_of_move_bindings(cx: &MatchCheckCtxt,
1051                                    has_guard: bool,
1052                                    pats: &[P<Pat>]) {
1053     let tcx = cx.tcx;
1054     let def_map = &tcx.def_map;
1055     let mut by_ref_span = None;
1056     for pat in pats {
1057         pat_bindings(def_map, &**pat, |bm, _, span, _path| {
1058             match bm {
1059                 hir::BindByRef(_) => {
1060                     by_ref_span = Some(span);
1061                 }
1062                 hir::BindByValue(_) => {
1063                 }
1064             }
1065         })
1066     }
1067
1068     let check_move = |p: &Pat, sub: Option<&Pat>| {
1069         // check legality of moving out of the enum
1070
1071         // x @ Foo(..) is legal, but x @ Foo(y) isn't.
1072         if sub.map_or(false, |p| pat_contains_bindings(&def_map.borrow(), &*p)) {
1073             span_err!(cx.tcx.sess, p.span, E0007, "cannot bind by-move with sub-bindings");
1074         } else if has_guard {
1075             span_err!(cx.tcx.sess, p.span, E0008, "cannot bind by-move into a pattern guard");
1076         } else if by_ref_span.is_some() {
1077             span_err!(cx.tcx.sess, p.span, E0009,
1078                 "cannot bind by-move and by-ref in the same pattern");
1079             span_note!(cx.tcx.sess, by_ref_span.unwrap(), "by-ref binding occurs here");
1080         }
1081     };
1082
1083     for pat in pats {
1084         front_util::walk_pat(&**pat, |p| {
1085             if pat_is_binding(&def_map.borrow(), &*p) {
1086                 match p.node {
1087                     hir::PatIdent(hir::BindByValue(_), _, ref sub) => {
1088                         let pat_ty = tcx.node_id_to_type(p.id);
1089                         //FIXME: (@jroesch) this code should be floated up as well
1090                         let infcx = infer::new_infer_ctxt(cx.tcx,
1091                                                           &cx.tcx.tables,
1092                                                           Some(cx.param_env.clone()),
1093                                                           false);
1094                         if infcx.type_moves_by_default(pat_ty, pat.span) {
1095                             check_move(p, sub.as_ref().map(|p| &**p));
1096                         }
1097                     }
1098                     hir::PatIdent(hir::BindByRef(_), _, _) => {
1099                     }
1100                     _ => {
1101                         cx.tcx.sess.span_bug(
1102                             p.span,
1103                             &format!("binding pattern {} is not an \
1104                                      identifier: {:?}",
1105                                     p.id,
1106                                     p.node));
1107                     }
1108                 }
1109             }
1110             true
1111         });
1112     }
1113 }
1114
1115 /// Ensures that a pattern guard doesn't borrow by mutable reference or
1116 /// assign.
1117 fn check_for_mutation_in_guard<'a, 'tcx>(cx: &'a MatchCheckCtxt<'a, 'tcx>,
1118                                          guard: &hir::Expr) {
1119     let mut checker = MutationChecker {
1120         cx: cx,
1121     };
1122
1123     let infcx = infer::new_infer_ctxt(cx.tcx,
1124                                       &cx.tcx.tables,
1125                                       Some(checker.cx.param_env.clone()),
1126                                       false);
1127
1128     let mut visitor = ExprUseVisitor::new(&mut checker, &infcx);
1129     visitor.walk_expr(guard);
1130 }
1131
1132 struct MutationChecker<'a, 'tcx: 'a> {
1133     cx: &'a MatchCheckCtxt<'a, 'tcx>,
1134 }
1135
1136 impl<'a, 'tcx> Delegate<'tcx> for MutationChecker<'a, 'tcx> {
1137     fn matched_pat(&mut self, _: &Pat, _: cmt, _: euv::MatchMode) {}
1138     fn consume(&mut self, _: NodeId, _: Span, _: cmt, _: ConsumeMode) {}
1139     fn consume_pat(&mut self, _: &Pat, _: cmt, _: ConsumeMode) {}
1140     fn borrow(&mut self,
1141               _: NodeId,
1142               span: Span,
1143               _: cmt,
1144               _: Region,
1145               kind: BorrowKind,
1146               _: LoanCause) {
1147         match kind {
1148             MutBorrow => {
1149                 span_err!(self.cx.tcx.sess, span, E0301,
1150                           "cannot mutably borrow in a pattern guard")
1151             }
1152             ImmBorrow | UniqueImmBorrow => {}
1153         }
1154     }
1155     fn decl_without_init(&mut self, _: NodeId, _: Span) {}
1156     fn mutate(&mut self, _: NodeId, span: Span, _: cmt, mode: MutateMode) {
1157         match mode {
1158             JustWrite | WriteAndRead => {
1159                 span_err!(self.cx.tcx.sess, span, E0302, "cannot assign in a pattern guard")
1160             }
1161             Init => {}
1162         }
1163     }
1164 }
1165
1166 /// Forbids bindings in `@` patterns. This is necessary for memory safety,
1167 /// because of the way rvalues are handled in the borrow check. (See issue
1168 /// #14587.)
1169 fn check_legality_of_bindings_in_at_patterns(cx: &MatchCheckCtxt, pat: &Pat) {
1170     AtBindingPatternVisitor { cx: cx, bindings_allowed: true }.visit_pat(pat);
1171 }
1172
1173 struct AtBindingPatternVisitor<'a, 'b:'a, 'tcx:'b> {
1174     cx: &'a MatchCheckCtxt<'b, 'tcx>,
1175     bindings_allowed: bool
1176 }
1177
1178 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for AtBindingPatternVisitor<'a, 'b, 'tcx> {
1179     fn visit_pat(&mut self, pat: &Pat) {
1180         if !self.bindings_allowed && pat_is_binding(&self.cx.tcx.def_map.borrow(), pat) {
1181             span_err!(self.cx.tcx.sess, pat.span, E0303,
1182                                       "pattern bindings are not allowed \
1183                                        after an `@`");
1184         }
1185
1186         match pat.node {
1187             hir::PatIdent(_, _, Some(_)) => {
1188                 let bindings_were_allowed = self.bindings_allowed;
1189                 self.bindings_allowed = false;
1190                 intravisit::walk_pat(self, pat);
1191                 self.bindings_allowed = bindings_were_allowed;
1192             }
1193             _ => intravisit::walk_pat(self, pat),
1194         }
1195     }
1196 }