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.
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.
11 use _match::{MatchCheckCtxt, Matrix, expand_pattern, is_useful};
12 use _match::Usefulness::*;
13 use _match::WitnessPreference::*;
15 use pattern::{Pattern, PatternContext, PatternError, PatternKind};
17 use eval::report_const_eval_err;
19 use rustc::dep_graph::DepNode;
21 use rustc::middle::expr_use_visitor::{ConsumeMode, Delegate, ExprUseVisitor};
22 use rustc::middle::expr_use_visitor::{LoanCause, MutateMode};
23 use rustc::middle::expr_use_visitor as euv;
24 use rustc::middle::mem_categorization::{cmt};
25 use rustc::session::Session;
26 use rustc::traits::Reveal;
27 use rustc::ty::{self, Ty, TyCtxt};
29 use rustc_errors::{Diagnostic, Level, DiagnosticBuilder};
31 use rustc::hir::def::*;
32 use rustc::hir::intravisit::{self, Visitor, FnKind, NestedVisitorMap};
33 use rustc::hir::{self, Pat, PatKind};
35 use rustc_back::slice;
39 use syntax_pos::{Span, DUMMY_SP};
41 struct OuterVisitor<'a, 'tcx: 'a> { tcx: TyCtxt<'a, 'tcx, 'tcx> }
43 impl<'a, 'tcx> Visitor<'tcx> for OuterVisitor<'a, 'tcx> {
44 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
45 NestedVisitorMap::OnlyBodies(&self.tcx.hir)
48 fn visit_fn(&mut self, fk: FnKind<'tcx>, fd: &'tcx hir::FnDecl,
49 b: hir::BodyId, s: Span, id: ast::NodeId) {
50 intravisit::walk_fn(self, fk, fd, b, s, id);
54 tables: self.tcx.body_tables(b),
55 param_env: &ty::ParameterEnvironment::for_item(self.tcx, id)
56 }.visit_body(self.tcx.hir.body(b));
60 pub fn check_crate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
61 tcx.visit_all_item_likes_in_krate(DepNode::MatchCheck,
62 &mut OuterVisitor { tcx: tcx }.as_deep_visitor());
63 tcx.sess.abort_if_errors();
66 fn create_e0004<'a>(sess: &'a Session, sp: Span, error_message: String) -> DiagnosticBuilder<'a> {
67 struct_span_err!(sess, sp, E0004, "{}", &error_message)
70 struct MatchVisitor<'a, 'tcx: 'a> {
71 tcx: TyCtxt<'a, 'tcx, 'tcx>,
72 tables: &'a ty::TypeckTables<'tcx>,
73 param_env: &'a ty::ParameterEnvironment<'tcx>
76 impl<'a, 'tcx> Visitor<'tcx> for MatchVisitor<'a, 'tcx> {
77 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
78 NestedVisitorMap::None
81 fn visit_expr(&mut self, ex: &'tcx hir::Expr) {
82 intravisit::walk_expr(self, ex);
85 hir::ExprMatch(ref scrut, ref arms, source) => {
86 self.check_match(scrut, arms, source);
92 fn visit_local(&mut self, loc: &'tcx hir::Local) {
93 intravisit::walk_local(self, loc);
95 self.check_irrefutable(&loc.pat, false);
97 // Check legality of move bindings and `@` patterns.
98 self.check_patterns(false, slice::ref_slice(&loc.pat));
101 fn visit_body(&mut self, body: &'tcx hir::Body) {
102 intravisit::walk_body(self, body);
104 for arg in &body.arguments {
105 self.check_irrefutable(&arg.pat, true);
106 self.check_patterns(false, slice::ref_slice(&arg.pat));
111 impl<'a, 'tcx> MatchVisitor<'a, 'tcx> {
112 fn check_patterns(&self, has_guard: bool, pats: &[P<Pat>]) {
113 check_legality_of_move_bindings(self, has_guard, pats);
115 check_legality_of_bindings_in_at_patterns(self, pat);
119 fn report_inlining_errors(&self, patcx: PatternContext, pat_span: Span) {
120 for error in patcx.errors {
122 PatternError::StaticInPattern(span) => {
123 span_err!(self.tcx.sess, span, E0158,
124 "statics cannot be referenced in patterns");
126 PatternError::ConstEval(err) => {
127 report_const_eval_err(self.tcx, &err, pat_span, "pattern").emit();
137 source: hir::MatchSource)
140 // First, check legality of move bindings.
141 self.check_patterns(arm.guard.is_some(), &arm.pats);
143 // Second, if there is a guard on each arm, make sure it isn't
144 // assigning or borrowing anything mutably.
145 if let Some(ref guard) = arm.guard {
146 check_for_mutation_in_guard(self, &guard);
149 // Third, perform some lints.
150 for pat in &arm.pats {
151 check_for_bindings_named_the_same_as_variants(self, pat);
155 let module = self.tcx.hir.local_def_id(self.tcx.hir.get_module_parent(scrut.id));
156 MatchCheckCtxt::create_and_enter(self.tcx, module, |ref mut cx| {
157 let mut have_errors = false;
159 let inlined_arms : Vec<(Vec<_>, _)> = arms.iter().map(|arm| (
160 arm.pats.iter().map(|pat| {
161 let mut patcx = PatternContext::new(self.tcx, self.tables);
162 let pattern = expand_pattern(cx, patcx.lower_pattern(&pat));
163 if !patcx.errors.is_empty() {
164 self.report_inlining_errors(patcx, pat.span);
169 arm.guard.as_ref().map(|e| &**e)
172 // Bail out early if inlining failed.
177 // Fourth, check for unreachable arms.
178 check_arms(cx, &inlined_arms, source);
180 // Then, if the match has no arms, check whether the scrutinee
182 let pat_ty = self.tables.node_id_to_type(scrut.id);
183 let module = self.tcx.hir.local_def_id(self.tcx.hir.get_module_parent(scrut.id));
184 if inlined_arms.is_empty() {
185 let scrutinee_is_uninhabited = if self.tcx.sess.features.borrow().never_type {
186 pat_ty.is_uninhabited_from(module, self.tcx)
188 self.conservative_is_uninhabited(pat_ty)
190 if !scrutinee_is_uninhabited {
191 // We know the type is inhabited, so this must be wrong
192 let mut err = create_e0004(self.tcx.sess, scrut.span,
193 format!("non-exhaustive patterns: type {} \
196 span_help!(&mut err, scrut.span,
197 "Please ensure that all possible cases are being handled; \
198 possibly adding wildcards or more match arms.");
201 // If the type *is* uninhabited, it's vacuously exhaustive
205 let matrix: Matrix = inlined_arms
207 .filter(|&&(_, guard)| guard.is_none())
208 .flat_map(|arm| &arm.0)
209 .map(|pat| vec![pat.0])
211 let scrut_ty = self.tables.node_id_to_type(scrut.id);
212 check_exhaustive(cx, scrut_ty, scrut.span, &matrix, source);
216 fn conservative_is_uninhabited(&self, scrutinee_ty: Ty<'tcx>) -> bool {
217 // "rustc-1.0-style" uncontentious uninhabitableness check
218 match scrutinee_ty.sty {
220 ty::TyAdt(def, _) => def.variants.is_empty(),
225 fn check_irrefutable(&self, pat: &Pat, is_fn_arg: bool) {
226 let origin = if is_fn_arg {
232 let module = self.tcx.hir.local_def_id(self.tcx.hir.get_module_parent(pat.id));
233 MatchCheckCtxt::create_and_enter(self.tcx, module, |ref mut cx| {
234 let mut patcx = PatternContext::new(self.tcx, self.tables);
235 let pattern = patcx.lower_pattern(pat);
236 let pattern_ty = pattern.ty;
237 let pats : Matrix = vec![vec![
238 expand_pattern(cx, pattern)
239 ]].into_iter().collect();
241 let wild_pattern = Pattern {
244 kind: box PatternKind::Wild,
246 let witness = match is_useful(cx, &pats, &[&wild_pattern], ConstructWitness) {
247 UsefulWithWitness(witness) => witness,
252 let pattern_string = witness[0].single_pattern().to_string();
253 let mut diag = struct_span_err!(
254 self.tcx.sess, pat.span, E0005,
255 "refutable pattern in {}: `{}` not covered",
256 origin, pattern_string
258 diag.span_label(pat.span, &format!("pattern `{}` not covered", pattern_string));
264 fn check_for_bindings_named_the_same_as_variants(cx: &MatchVisitor, pat: &Pat) {
266 if let PatKind::Binding(hir::BindByValue(hir::MutImmutable), _, name, None) = p.node {
267 let pat_ty = cx.tables.pat_ty(p);
268 if let ty::TyAdt(edef, _) = pat_ty.sty {
269 if edef.is_enum() && edef.variants.iter().any(|variant| {
270 variant.name == name.node && variant.ctor_kind == CtorKind::Const
272 let ty_path = cx.tcx.item_path_str(edef.did);
273 let mut err = struct_span_warn!(cx.tcx.sess, p.span, E0170,
274 "pattern binding `{}` is named the same as one \
275 of the variants of the type `{}`",
278 "if you meant to match on a variant, \
279 consider making the path in the pattern qualified: `{}::{}`",
289 /// Checks for common cases of "catchall" patterns that may not be intended as such.
290 fn pat_is_catchall(pat: &Pat) -> bool {
292 PatKind::Binding(.., None) => true,
293 PatKind::Binding(.., Some(ref s)) => pat_is_catchall(s),
294 PatKind::Ref(ref s, _) => pat_is_catchall(s),
295 PatKind::Tuple(ref v, _) => v.iter().all(|p| {
302 // Check for unreachable patterns
303 fn check_arms<'a, 'tcx>(cx: &mut MatchCheckCtxt<'a, 'tcx>,
304 arms: &[(Vec<(&'a Pattern<'tcx>, &hir::Pat)>, Option<&hir::Expr>)],
305 source: hir::MatchSource)
307 let mut seen = Matrix::empty();
308 let mut catchall = None;
309 let mut printed_if_let_err = false;
310 for (arm_index, &(ref pats, guard)) in arms.iter().enumerate() {
311 for &(pat, hir_pat) in pats {
314 match is_useful(cx, &seen, &v[..], LeaveOutWitness) {
317 hir::MatchSource::IfLetDesugar { .. } => {
318 if printed_if_let_err {
319 // we already printed an irrefutable if-let pattern error.
320 // We don't want two, that's just confusing.
322 // find the first arm pattern so we can use its span
323 let &(ref first_arm_pats, _) = &arms[0];
324 let first_pat = &first_arm_pats[0];
325 let span = first_pat.0.span;
326 struct_span_err!(cx.tcx.sess, span, E0162,
327 "irrefutable if-let pattern")
328 .span_label(span, &format!("irrefutable pattern"))
330 printed_if_let_err = true;
334 hir::MatchSource::WhileLetDesugar => {
335 // find the first arm pattern so we can use its span
336 let &(ref first_arm_pats, _) = &arms[0];
337 let first_pat = &first_arm_pats[0];
338 let span = first_pat.0.span;
340 // check which arm we're on.
342 // The arm with the user-specified pattern.
344 let mut diagnostic = Diagnostic::new(Level::Warning,
345 "unreachable pattern");
346 diagnostic.set_span(pat.span);
347 cx.tcx.sess.add_lint_diagnostic(
348 lint::builtin::UNREACHABLE_PATTERNS,
349 hir_pat.id, diagnostic);
351 // The arm with the wildcard pattern.
353 struct_span_err!(cx.tcx.sess, span, E0165,
354 "irrefutable while-let pattern")
355 .span_label(span, &format!("irrefutable pattern"))
362 hir::MatchSource::ForLoopDesugar |
363 hir::MatchSource::Normal => {
364 let mut diagnostic = Diagnostic::new(Level::Warning,
365 "unreachable pattern");
366 diagnostic.set_span(pat.span);
367 // if we had a catchall pattern, hint at that
368 if let Some(catchall) = catchall {
369 diagnostic.span_label(pat.span, &"this is an unreachable pattern");
370 diagnostic.span_note(catchall, "this pattern matches any value");
372 cx.tcx.sess.add_lint_diagnostic(lint::builtin::UNREACHABLE_PATTERNS,
373 hir_pat.id, diagnostic);
376 // Unreachable patterns in try expressions occur when one of the arms
377 // are an uninhabited type. Which is OK.
378 hir::MatchSource::TryDesugar => {}
382 UsefulWithWitness(_) => bug!()
386 if catchall.is_none() && pat_is_catchall(hir_pat) {
387 catchall = Some(pat.span);
394 fn check_exhaustive<'a, 'tcx>(cx: &mut MatchCheckCtxt<'a, 'tcx>,
397 matrix: &Matrix<'a, 'tcx>,
398 source: hir::MatchSource) {
399 let wild_pattern = Pattern {
402 kind: box PatternKind::Wild,
404 match is_useful(cx, matrix, &[&wild_pattern], ConstructWitness) {
405 UsefulWithWitness(pats) => {
406 let witnesses = if pats.is_empty() {
409 pats.iter().map(|w| w.single_pattern()).collect()
412 hir::MatchSource::ForLoopDesugar => {
413 // `witnesses[0]` has the form `Some(<head>)`, peel off the `Some`
414 let witness = match *witnesses[0].kind {
415 PatternKind::Variant { ref subpatterns, .. } => match &subpatterns[..] {
416 &[ref pat] => &pat.pattern,
421 let pattern_string = witness.to_string();
422 struct_span_err!(cx.tcx.sess, sp, E0297,
423 "refutable pattern in `for` loop binding: \
426 .span_label(sp, &format!("pattern `{}` not covered", pattern_string))
430 const LIMIT: usize = 3;
431 let joined_patterns = match witnesses.len() {
433 1 => format!("`{}`", witnesses[0]),
435 let (tail, head) = witnesses.split_last().unwrap();
436 let head: Vec<_> = head.iter().map(|w| w.to_string()).collect();
437 format!("`{}` and `{}`", head.join("`, `"), tail)
440 let (head, tail) = witnesses.split_at(LIMIT);
441 let head: Vec<_> = head.iter().map(|w| w.to_string()).collect();
442 format!("`{}` and {} more", head.join("`, `"), tail.len())
446 let label_text = match witnesses.len() {
447 1 => format!("pattern {} not covered", joined_patterns),
448 _ => format!("patterns {} not covered", joined_patterns)
450 create_e0004(cx.tcx.sess, sp,
451 format!("non-exhaustive patterns: {} not covered",
453 .span_label(sp, &label_text)
459 // This is good, wildcard pattern isn't reachable
465 // Legality of move bindings checking
466 fn check_legality_of_move_bindings(cx: &MatchVisitor,
469 let mut by_ref_span = None;
471 pat.each_binding(|bm, _, span, _path| {
472 if let hir::BindByRef(..) = bm {
473 by_ref_span = Some(span);
478 let check_move = |p: &Pat, sub: Option<&Pat>| {
479 // check legality of moving out of the enum
481 // x @ Foo(..) is legal, but x @ Foo(y) isn't.
482 if sub.map_or(false, |p| p.contains_bindings()) {
483 struct_span_err!(cx.tcx.sess, p.span, E0007,
484 "cannot bind by-move with sub-bindings")
485 .span_label(p.span, &format!("binds an already bound by-move value by moving it"))
487 } else if has_guard {
488 struct_span_err!(cx.tcx.sess, p.span, E0008,
489 "cannot bind by-move into a pattern guard")
490 .span_label(p.span, &format!("moves value into pattern guard"))
492 } else if by_ref_span.is_some() {
493 struct_span_err!(cx.tcx.sess, p.span, E0009,
494 "cannot bind by-move and by-ref in the same pattern")
495 .span_label(p.span, &format!("by-move pattern here"))
496 .span_label(by_ref_span.unwrap(), &format!("both by-ref and by-move used"))
503 if let PatKind::Binding(hir::BindByValue(..), _, _, ref sub) = p.node {
504 let pat_ty = cx.tables.node_id_to_type(p.id);
505 if pat_ty.moves_by_default(cx.tcx, cx.param_env, pat.span) {
506 check_move(p, sub.as_ref().map(|p| &**p));
514 /// Ensures that a pattern guard doesn't borrow by mutable reference or
517 /// FIXME: this should be done by borrowck.
518 fn check_for_mutation_in_guard(cx: &MatchVisitor, guard: &hir::Expr) {
519 cx.tcx.infer_ctxt((cx.tables, cx.param_env.clone()), Reveal::NotSpecializable).enter(|infcx| {
520 let mut checker = MutationChecker {
523 ExprUseVisitor::new(&mut checker, &infcx).walk_expr(guard);
527 struct MutationChecker<'a, 'gcx: 'a> {
528 cx: &'a MatchVisitor<'a, 'gcx>,
531 impl<'a, 'gcx, 'tcx> Delegate<'tcx> for MutationChecker<'a, 'gcx> {
532 fn matched_pat(&mut self, _: &Pat, _: cmt, _: euv::MatchMode) {}
533 fn consume(&mut self, _: ast::NodeId, _: Span, _: cmt, _: ConsumeMode) {}
534 fn consume_pat(&mut self, _: &Pat, _: cmt, _: ConsumeMode) {}
540 kind:ty:: BorrowKind,
544 struct_span_err!(self.cx.tcx.sess, span, E0301,
545 "cannot mutably borrow in a pattern guard")
546 .span_label(span, &format!("borrowed mutably in pattern guard"))
549 ty::ImmBorrow | ty::UniqueImmBorrow => {}
552 fn decl_without_init(&mut self, _: ast::NodeId, _: Span) {}
553 fn mutate(&mut self, _: ast::NodeId, span: Span, _: cmt, mode: MutateMode) {
555 MutateMode::JustWrite | MutateMode::WriteAndRead => {
556 struct_span_err!(self.cx.tcx.sess, span, E0302, "cannot assign in a pattern guard")
557 .span_label(span, &format!("assignment in pattern guard"))
560 MutateMode::Init => {}
565 /// Forbids bindings in `@` patterns. This is necessary for memory safety,
566 /// because of the way rvalues are handled in the borrow check. (See issue
568 fn check_legality_of_bindings_in_at_patterns(cx: &MatchVisitor, pat: &Pat) {
569 AtBindingPatternVisitor { cx: cx, bindings_allowed: true }.visit_pat(pat);
572 struct AtBindingPatternVisitor<'a, 'b:'a, 'tcx:'b> {
573 cx: &'a MatchVisitor<'b, 'tcx>,
574 bindings_allowed: bool
577 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for AtBindingPatternVisitor<'a, 'b, 'tcx> {
578 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v> {
579 NestedVisitorMap::None
582 fn visit_pat(&mut self, pat: &Pat) {
584 PatKind::Binding(.., ref subpat) => {
585 if !self.bindings_allowed {
586 struct_span_err!(self.cx.tcx.sess, pat.span, E0303,
587 "pattern bindings are not allowed after an `@`")
588 .span_label(pat.span, &format!("not allowed after `@`"))
592 if subpat.is_some() {
593 let bindings_were_allowed = self.bindings_allowed;
594 self.bindings_allowed = false;
595 intravisit::walk_pat(self, pat);
596 self.bindings_allowed = bindings_were_allowed;
599 _ => intravisit::walk_pat(self, pat),