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