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