src/librustc_mir/build/matches/test.rs

   1 // Copyright 2015 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 // Testing candidates
  12 //
  13 // After candidates have been simplified, the only match pairs that
  14 // remain are those that require some sort of test. The functions here
  15 // identify what tests are needed, perform the tests, and then filter
  16 // the candidates based on the result.
  17
  18 use build::Builder;
  19 use build::matches::{Candidate, MatchPair, Test, TestKind};
  20 use hair::*;
  21 use rustc_data_structures::fx::FxHashMap;
  22 use rustc_data_structures::bitvec::BitVector;
  23 use rustc::middle::const_val::{ConstVal, ConstInt};
  24 use rustc::ty::{self, Ty};
  25 use rustc::ty::util::IntTypeExt;
  26 use rustc::mir::*;
  27 use rustc::hir::RangeEnd;
  28 use syntax_pos::Span;
  29 use std::cmp::Ordering;
  30
  31 impl<'a, 'gcx, 'tcx> Builder<'a, 'gcx, 'tcx> {
  32     /// Identifies what test is needed to decide if `match_pair` is applicable.
  33     ///
  34     /// It is a bug to call this with a simplifyable pattern.
  35     pub fn test<'pat>(&mut self, match_pair: &MatchPair<'pat, 'tcx>) -> Test<'tcx> {
  36         match *match_pair.pattern.kind {
  37             PatternKind::Variant { ref adt_def, substs: _, variant_index: _, subpatterns: _ } => {
  38                 Test {
  39                     span: match_pair.pattern.span,
  40                     kind: TestKind::Switch {
  41                         adt_def: adt_def.clone(),
  42                         variants: BitVector::new(self.hir.num_variants(adt_def)),
  43                     },
  44                 }
  45             }
  46
  47             PatternKind::Constant { .. }
  48             if is_switch_ty(match_pair.pattern.ty) => {
  49                 // for integers, we use a SwitchInt match, which allows
  50                 // us to handle more cases
  51                 Test {
  52                     span: match_pair.pattern.span,
  53                     kind: TestKind::SwitchInt {
  54                         switch_ty: match_pair.pattern.ty,
  55
  56                         // these maps are empty to start; cases are
  57                         // added below in add_cases_to_switch
  58                         options: vec![],
  59                         indices: FxHashMap(),
  60                     }
  61                 }
  62             }
  63
  64             PatternKind::Constant { ref value } => {
  65                 Test {
  66                     span: match_pair.pattern.span,
  67                     kind: TestKind::Eq {
  68                         value: value.clone(),
  69                         ty: match_pair.pattern.ty.clone()
  70                     }
  71                 }
  72             }
  73
  74             PatternKind::Range { ref lo, ref hi, ref end } => {
  75                 Test {
  76                     span: match_pair.pattern.span,
  77                     kind: TestKind::Range {
  78                         lo: Literal::Value { value: lo.clone() },
  79                         hi: Literal::Value { value: hi.clone() },
  80                         ty: match_pair.pattern.ty.clone(),
  81                         end: end.clone(),
  82                     },
  83                 }
  84             }
  85
  86             PatternKind::Slice { ref prefix, ref slice, ref suffix }
  87                     if !match_pair.slice_len_checked => {
  88                 let len = prefix.len() + suffix.len();
  89                 let op = if slice.is_some() {
  90                     BinOp::Ge
  91                 } else {
  92                     BinOp::Eq
  93                 };
  94                 Test {
  95                     span: match_pair.pattern.span,
  96                     kind: TestKind::Len { len: len as u64, op: op },
  97                 }
  98             }
  99
 100             PatternKind::Array { .. } |
 101             PatternKind::Slice { .. } |
 102             PatternKind::Wild |
 103             PatternKind::Binding { .. } |
 104             PatternKind::Leaf { .. } |
 105             PatternKind::Deref { .. } => {
 106                 self.error_simplifyable(match_pair)
 107             }
 108         }
 109     }
 110
 111     pub fn add_cases_to_switch<'pat>(&mut self,
 112                                      test_lvalue: &Lvalue<'tcx>,
 113                                      candidate: &Candidate<'pat, 'tcx>,
 114                                      switch_ty: Ty<'tcx>,
 115                                      options: &mut Vec<ConstVal>,
 116                                      indices: &mut FxHashMap<ConstVal, usize>)
 117                                      -> bool
 118     {
 119         let match_pair = match candidate.match_pairs.iter().find(|mp| mp.lvalue == *test_lvalue) {
 120             Some(match_pair) => match_pair,
 121             _ => { return false; }
 122         };
 123
 124         match *match_pair.pattern.kind {
 125             PatternKind::Constant { ref value } => {
 126                 // if the lvalues match, the type should match
 127                 assert_eq!(match_pair.pattern.ty, switch_ty);
 128
 129                 indices.entry(value.clone())
 130                        .or_insert_with(|| {
 131                            options.push(value.clone());
 132                            options.len() - 1
 133                        });
 134                 true
 135             }
 136             PatternKind::Variant { .. } => {
 137                 panic!("you should have called add_variants_to_switch instead!");
 138             }
 139             PatternKind::Range { .. } |
 140             PatternKind::Slice { .. } |
 141             PatternKind::Array { .. } |
 142             PatternKind::Wild |
 143             PatternKind::Binding { .. } |
 144             PatternKind::Leaf { .. } |
 145             PatternKind::Deref { .. } => {
 146                 // don't know how to add these patterns to a switch
 147                 false
 148             }
 149         }
 150     }
 151
 152     pub fn add_variants_to_switch<'pat>(&mut self,
 153                                         test_lvalue: &Lvalue<'tcx>,
 154                                         candidate: &Candidate<'pat, 'tcx>,
 155                                         variants: &mut BitVector)
 156                                         -> bool
 157     {
 158         let match_pair = match candidate.match_pairs.iter().find(|mp| mp.lvalue == *test_lvalue) {
 159             Some(match_pair) => match_pair,
 160             _ => { return false; }
 161         };
 162
 163         match *match_pair.pattern.kind {
 164             PatternKind::Variant { adt_def: _ , variant_index,  .. } => {
 165                 // We have a pattern testing for variant `variant_index`
 166                 // set the corresponding index to true
 167                 variants.insert(variant_index);
 168                 true
 169             }
 170             _ => {
 171                 // don't know how to add these patterns to a switch
 172                 false
 173             }
 174         }
 175     }
 176
 177     /// Generates the code to perform a test.
 178     pub fn perform_test(&mut self,
 179                         block: BasicBlock,
 180                         lvalue: &Lvalue<'tcx>,
 181                         test: &Test<'tcx>)
 182                         -> Vec<BasicBlock> {
 183         let source_info = self.source_info(test.span);
 184         match test.kind {
 185             TestKind::Switch { adt_def, ref variants } => {
 186                 // Variants is a BitVec of indexes into adt_def.variants.
 187                 let num_enum_variants = self.hir.num_variants(adt_def);
 188                 let used_variants = variants.count();
 189                 let mut otherwise_block = None;
 190                 let mut target_blocks = Vec::with_capacity(num_enum_variants);
 191                 let mut targets = Vec::with_capacity(used_variants + 1);
 192                 let mut values = Vec::with_capacity(used_variants);
 193                 let tcx = self.hir.tcx();
 194                 for (idx, variant) in adt_def.variants.iter().enumerate() {
 195                     target_blocks.place_back() <- if variants.contains(idx) {
 196                         let discr = ConstInt::new_inttype(variant.disr_val, adt_def.discr_ty,
 197                                                           tcx.sess.target.uint_type,
 198                                                           tcx.sess.target.int_type).unwrap();
 199                         values.push(discr);
 200                         *(targets.place_back() <- self.cfg.start_new_block())
 201                     } else {
 202                         if otherwise_block.is_none() {
 203                             otherwise_block = Some(self.cfg.start_new_block());
 204                         }
 205                         otherwise_block.unwrap()
 206                     };
 207                 }
 208                 if let Some(otherwise_block) = otherwise_block {
 209                     targets.push(otherwise_block);
 210                 } else {
 211                     values.pop();
 212                 }
 213                 debug!("num_enum_variants: {}, tested variants: {:?}, variants: {:?}",
 214                        num_enum_variants, values, variants);
 215                 let discr_ty = adt_def.discr_ty.to_ty(tcx);
 216                 let discr = self.temp(discr_ty);
 217                 self.cfg.push_assign(block, source_info, &discr,
 218                                      Rvalue::Discriminant(lvalue.clone()));
 219                 assert_eq!(values.len() + 1, targets.len());
 220                 self.cfg.terminate(block, source_info, TerminatorKind::SwitchInt {
 221                     discr: Operand::Consume(discr),
 222                     switch_ty: discr_ty,
 223                     values: From::from(values),
 224                     targets: targets
 225                 });
 226                 target_blocks
 227             }
 228
 229             TestKind::SwitchInt { switch_ty, ref options, indices: _ } => {
 230                 let (ret, terminator) = if switch_ty.sty == ty::TyBool {
 231                     assert!(options.len() > 0 && options.len() <= 2);
 232                     let (true_bb, false_bb) = (self.cfg.start_new_block(),
 233                                                self.cfg.start_new_block());
 234                     let ret = match &options[0] {
 235                         &ConstVal::Bool(true) => vec![true_bb, false_bb],
 236                         &ConstVal::Bool(false) => vec![false_bb, true_bb],
 237                         v => span_bug!(test.span, "expected boolean value but got {:?}", v)
 238                     };
 239                     (ret, TerminatorKind::if_(self.hir.tcx(), Operand::Consume(lvalue.clone()),
 240                                               true_bb, false_bb))
 241                 } else {
 242                     // The switch may be inexhaustive so we
 243                     // add a catch all block
 244                     let otherwise = self.cfg.start_new_block();
 245                     let targets: Vec<_> =
 246                         options.iter()
 247                                .map(|_| self.cfg.start_new_block())
 248                                .chain(Some(otherwise))
 249                                .collect();
 250                     let values: Vec<_> = options.iter().map(|v|
 251                         v.to_const_int().expect("switching on integral")
 252                     ).collect();
 253                     (targets.clone(), TerminatorKind::SwitchInt {
 254                         discr: Operand::Consume(lvalue.clone()),
 255                         switch_ty: switch_ty,
 256                         values: From::from(values),
 257                         targets: targets,
 258                     })
 259                 };
 260                 self.cfg.terminate(block, source_info, terminator);
 261                 ret
 262             }
 263
 264             TestKind::Eq { ref value, mut ty } => {
 265                 let mut val = Operand::Consume(lvalue.clone());
 266
 267                 // If we're using b"..." as a pattern, we need to insert an
 268                 // unsizing coercion, as the byte string has the type &[u8; N].
 269                 let expect = if let ConstVal::ByteStr(ref bytes) = *value {
 270                     let tcx = self.hir.tcx();
 271
 272                     // Unsize the lvalue to &[u8], too, if necessary.
 273                     if let ty::TyRef(region, mt) = ty.sty {
 274                         if let ty::TyArray(_, _) = mt.ty.sty {
 275                             ty = tcx.mk_imm_ref(region, tcx.mk_slice(tcx.types.u8));
 276                             let val_slice = self.temp(ty);
 277                             self.cfg.push_assign(block, source_info, &val_slice,
 278                                                  Rvalue::Cast(CastKind::Unsize, val, ty));
 279                             val = Operand::Consume(val_slice);
 280                         }
 281                     }
 282
 283                     assert!(ty.is_slice());
 284
 285                     let array_ty = tcx.mk_array(tcx.types.u8, bytes.len());
 286                     let array_ref = tcx.mk_imm_ref(tcx.mk_region(ty::ReStatic), array_ty);
 287                     let array = self.literal_operand(test.span, array_ref, Literal::Value {
 288                         value: value.clone()
 289                     });
 290
 291                     let slice = self.temp(ty);
 292                     self.cfg.push_assign(block, source_info, &slice,
 293                                          Rvalue::Cast(CastKind::Unsize, array, ty));
 294                     Operand::Consume(slice)
 295                 } else {
 296                     self.literal_operand(test.span, ty, Literal::Value {
 297                         value: value.clone()
 298                     })
 299                 };
 300
 301                 // Use PartialEq::eq for &str and &[u8] slices, instead of BinOp::Eq.
 302                 let fail = self.cfg.start_new_block();
 303                 if let ty::TyRef(_, mt) = ty.sty {
 304                     assert!(ty.is_slice());
 305                     let eq_def_id = self.hir.tcx().lang_items.eq_trait().unwrap();
 306                     let ty = mt.ty;
 307                     let (mty, method) = self.hir.trait_method(eq_def_id, "eq", ty, &[ty]);
 308
 309                     let bool_ty = self.hir.bool_ty();
 310                     let eq_result = self.temp(bool_ty);
 311                     let eq_block = self.cfg.start_new_block();
 312                     let cleanup = self.diverge_cleanup();
 313                     self.cfg.terminate(block, source_info, TerminatorKind::Call {
 314                         func: Operand::Constant(Constant {
 315                             span: test.span,
 316                             ty: mty,
 317                             literal: method
 318                         }),
 319                         args: vec![val, expect],
 320                         destination: Some((eq_result.clone(), eq_block)),
 321                         cleanup: cleanup,
 322                     });
 323
 324                     // check the result
 325                     let block = self.cfg.start_new_block();
 326                     self.cfg.terminate(eq_block, source_info,
 327                                        TerminatorKind::if_(self.hir.tcx(),
 328                                                            Operand::Consume(eq_result),
 329                                                            block, fail));
 330                     vec![block, fail]
 331                 } else {
 332                     let block = self.compare(block, fail, test.span, BinOp::Eq, expect, val);
 333                     vec![block, fail]
 334                 }
 335             }
 336
 337             TestKind::Range { ref lo, ref hi, ty, ref end } => {
 338                 // Test `val` by computing `lo <= val && val <= hi`, using primitive comparisons.
 339                 let lo = self.literal_operand(test.span, ty.clone(), lo.clone());
 340                 let hi = self.literal_operand(test.span, ty.clone(), hi.clone());
 341                 let val = Operand::Consume(lvalue.clone());
 342
 343                 let fail = self.cfg.start_new_block();
 344                 let block = self.compare(block, fail, test.span, BinOp::Le, lo, val.clone());
 345                 let block = match *end {
 346                     RangeEnd::Included => self.compare(block, fail, test.span, BinOp::Le, val, hi),
 347                     RangeEnd::Excluded => self.compare(block, fail, test.span, BinOp::Lt, val, hi),
 348                 };
 349
 350                 vec![block, fail]
 351             }
 352
 353             TestKind::Len { len, op } => {
 354                 let (usize_ty, bool_ty) = (self.hir.usize_ty(), self.hir.bool_ty());
 355                 let (actual, result) = (self.temp(usize_ty), self.temp(bool_ty));
 356
 357                 // actual = len(lvalue)
 358                 self.cfg.push_assign(block, source_info,
 359                                      &actual, Rvalue::Len(lvalue.clone()));
 360
 361                 // expected = <N>
 362                 let expected = self.push_usize(block, source_info, len);
 363
 364                 // result = actual == expected OR result = actual < expected
 365                 self.cfg.push_assign(block, source_info, &result,
 366                                      Rvalue::BinaryOp(op,
 367                                                       Operand::Consume(actual),
 368                                                       Operand::Consume(expected)));
 369
 370                 // branch based on result
 371                 let (false_bb, true_bb) = (self.cfg.start_new_block(),
 372                                            self.cfg.start_new_block());
 373                 self.cfg.terminate(block, source_info,
 374                                    TerminatorKind::if_(self.hir.tcx(), Operand::Consume(result),
 375                                                        true_bb, false_bb));
 376                 vec![true_bb, false_bb]
 377             }
 378         }
 379     }
 380
 381     fn compare(&mut self,
 382                block: BasicBlock,
 383                fail_block: BasicBlock,
 384                span: Span,
 385                op: BinOp,
 386                left: Operand<'tcx>,
 387                right: Operand<'tcx>) -> BasicBlock {
 388         let bool_ty = self.hir.bool_ty();
 389         let result = self.temp(bool_ty);
 390
 391         // result = op(left, right)
 392         let source_info = self.source_info(span);
 393         self.cfg.push_assign(block, source_info, &result,
 394                              Rvalue::BinaryOp(op, left, right));
 395
 396         // branch based on result
 397         let target_block = self.cfg.start_new_block();
 398         self.cfg.terminate(block, source_info,
 399                            TerminatorKind::if_(self.hir.tcx(), Operand::Consume(result),
 400                                                target_block, fail_block));
 401         target_block
 402     }
 403
 404     /// Given that we are performing `test` against `test_lvalue`,
 405     /// this job sorts out what the status of `candidate` will be
 406     /// after the test. The `resulting_candidates` vector stores, for
 407     /// each possible outcome of `test`, a vector of the candidates
 408     /// that will result. This fn should add a (possibly modified)
 409     /// clone of candidate into `resulting_candidates` wherever
 410     /// appropriate.
 411     ///
 412     /// So, for example, if this candidate is `x @ Some(P0)` and the
 413     /// test is a variant test, then we would add `(x as Option).0 @
 414     /// P0` to the `resulting_candidates` entry corresponding to the
 415     /// variant `Some`.
 416     ///
 417     /// However, in some cases, the test may just not be relevant to
 418     /// candidate. For example, suppose we are testing whether `foo.x == 22`,
 419     /// but in one match arm we have `Foo { x: _, ... }`... in that case,
 420     /// the test for what value `x` has has no particular relevance
 421     /// to this candidate. In such cases, this function just returns false
 422     /// without doing anything. This is used by the overall `match_candidates`
 423     /// algorithm to structure the match as a whole. See `match_candidates` for
 424     /// more details.
 425     ///
 426     /// FIXME(#29623). In some cases, we have some tricky choices to
 427     /// make.  for example, if we are testing that `x == 22`, but the
 428     /// candidate is `x @ 13..55`, what should we do? In the event
 429     /// that the test is true, we know that the candidate applies, but
 430     /// in the event of false, we don't know that it *doesn't*
 431     /// apply. For now, we return false, indicate that the test does
 432     /// not apply to this candidate, but it might be we can get
 433     /// tighter match code if we do something a bit different.
 434     pub fn sort_candidate<'pat>(&mut self,
 435                                 test_lvalue: &Lvalue<'tcx>,
 436                                 test: &Test<'tcx>,
 437                                 candidate: &Candidate<'pat, 'tcx>,
 438                                 resulting_candidates: &mut [Vec<Candidate<'pat, 'tcx>>])
 439                                 -> bool {
 440         // Find the match_pair for this lvalue (if any). At present,
 441         // afaik, there can be at most one. (In the future, if we
 442         // adopted a more general `@` operator, there might be more
 443         // than one, but it'd be very unusual to have two sides that
 444         // both require tests; you'd expect one side to be simplified
 445         // away.)
 446         let tested_match_pair = candidate.match_pairs.iter()
 447                                                      .enumerate()
 448                                                      .filter(|&(_, mp)| mp.lvalue == *test_lvalue)
 449                                                      .next();
 450         let (match_pair_index, match_pair) = match tested_match_pair {
 451             Some(pair) => pair,
 452             None => {
 453                 // We are not testing this lvalue. Therefore, this
 454                 // candidate applies to ALL outcomes.
 455                 return false;
 456             }
 457         };
 458
 459         match (&test.kind, &*match_pair.pattern.kind) {
 460             // If we are performing a variant switch, then this
 461             // informs variant patterns, but nothing else.
 462             (&TestKind::Switch { adt_def: tested_adt_def, .. },
 463              &PatternKind::Variant { adt_def, variant_index, ref subpatterns, .. }) => {
 464                 assert_eq!(adt_def, tested_adt_def);
 465                 let new_candidate =
 466                     self.candidate_after_variant_switch(match_pair_index,
 467                                                         adt_def,
 468                                                         variant_index,
 469                                                         subpatterns,
 470                                                         candidate);
 471                 resulting_candidates[variant_index].push(new_candidate);
 472                 true
 473             }
 474             (&TestKind::Switch { .. }, _) => false,
 475
 476             // If we are performing a switch over integers, then this informs integer
 477             // equality, but nothing else.
 478             //
 479             // FIXME(#29623) we could use PatternKind::Range to rule
 480             // things out here, in some cases.
 481             (&TestKind::SwitchInt { switch_ty: _, options: _, ref indices },
 482              &PatternKind::Constant { ref value })
 483             if is_switch_ty(match_pair.pattern.ty) => {
 484                 let index = indices[value];
 485                 let new_candidate = self.candidate_without_match_pair(match_pair_index,
 486                                                                       candidate);
 487                 resulting_candidates[index].push(new_candidate);
 488                 true
 489             }
 490             (&TestKind::SwitchInt { .. }, _) => false,
 491
 492
 493             (&TestKind::Len { len: test_len, op: BinOp::Eq },
 494              &PatternKind::Slice { ref prefix, ref slice, ref suffix }) => {
 495                 let pat_len = (prefix.len() + suffix.len()) as u64;
 496                 match (test_len.cmp(&pat_len), slice) {
 497                     (Ordering::Equal, &None) => {
 498                         // on true, min_len = len = $actual_length,
 499                         // on false, len != $actual_length
 500                         resulting_candidates[0].push(
 501                             self.candidate_after_slice_test(match_pair_index,
 502                                                             candidate,
 503                                                             prefix,
 504                                                             slice.as_ref(),
 505                                                             suffix)
 506                         );
 507                         true
 508                     }
 509                     (Ordering::Less, _) => {
 510                         // test_len < pat_len. If $actual_len = test_len,
 511                         // then $actual_len < pat_len and we don't have
 512                         // enough elements.
 513                         resulting_candidates[1].push(candidate.clone());
 514                         true
 515                     }
 516                     (Ordering::Equal, &Some(_)) | (Ordering::Greater, &Some(_)) => {
 517                         // This can match both if $actual_len = test_len >= pat_len,
 518                         // and if $actual_len > test_len. We can't advance.
 519                         false
 520                     }
 521                     (Ordering::Greater, &None) => {
 522                         // test_len != pat_len, so if $actual_len = test_len, then
 523                         // $actual_len != pat_len.
 524                         resulting_candidates[1].push(candidate.clone());
 525                         true
 526                     }
 527                 }
 528             }
 529
 530             (&TestKind::Len { len: test_len, op: BinOp::Ge },
 531              &PatternKind::Slice { ref prefix, ref slice, ref suffix }) => {
 532                 // the test is `$actual_len >= test_len`
 533                 let pat_len = (prefix.len() + suffix.len()) as u64;
 534                 match (test_len.cmp(&pat_len), slice) {
 535                     (Ordering::Equal, &Some(_))  => {
 536                         // $actual_len >= test_len = pat_len,
 537                         // so we can match.
 538                         resulting_candidates[0].push(
 539                             self.candidate_after_slice_test(match_pair_index,
 540                                                             candidate,
 541                                                             prefix,
 542                                                             slice.as_ref(),
 543                                                             suffix)
 544                         );
 545                         true
 546                     }
 547                     (Ordering::Less, _) | (Ordering::Equal, &None) => {
 548                         // test_len <= pat_len. If $actual_len < test_len,
 549                         // then it is also < pat_len, so the test passing is
 550                         // necessary (but insufficient).
 551                         resulting_candidates[0].push(candidate.clone());
 552                         true
 553                     }
 554                     (Ordering::Greater, &None) => {
 555                         // test_len > pat_len. If $actual_len >= test_len > pat_len,
 556                         // then we know we won't have a match.
 557                         resulting_candidates[1].push(candidate.clone());
 558                         true
 559                     }
 560                     (Ordering::Greater, &Some(_)) => {
 561                         // test_len < pat_len, and is therefore less
 562                         // strict. This can still go both ways.
 563                         false
 564                     }
 565                 }
 566             }
 567
 568             (&TestKind::Eq { .. }, _) |
 569             (&TestKind::Range { .. }, _) |
 570             (&TestKind::Len { .. }, _) => {
 571                 // These are all binary tests.
 572                 //
 573                 // FIXME(#29623) we can be more clever here
 574                 let pattern_test = self.test(&match_pair);
 575                 if pattern_test.kind == test.kind {
 576                     let new_candidate = self.candidate_without_match_pair(match_pair_index,
 577                                                                           candidate);
 578                     resulting_candidates[0].push(new_candidate);
 579                     true
 580                 } else {
 581                     false
 582                 }
 583             }
 584         }
 585     }
 586
 587     fn candidate_without_match_pair<'pat>(&mut self,
 588                                           match_pair_index: usize,
 589                                           candidate: &Candidate<'pat, 'tcx>)
 590                                           -> Candidate<'pat, 'tcx> {
 591         let other_match_pairs =
 592             candidate.match_pairs.iter()
 593                                  .enumerate()
 594                                  .filter(|&(index, _)| index != match_pair_index)
 595                                  .map(|(_, mp)| mp.clone())
 596                                  .collect();
 597         Candidate {
 598             span: candidate.span,
 599             match_pairs: other_match_pairs,
 600             bindings: candidate.bindings.clone(),
 601             guard: candidate.guard.clone(),
 602             arm_index: candidate.arm_index,
 603         }
 604     }
 605
 606     fn candidate_after_slice_test<'pat>(&mut self,
 607                                         match_pair_index: usize,
 608                                         candidate: &Candidate<'pat, 'tcx>,
 609                                         prefix: &'pat [Pattern<'tcx>],
 610                                         opt_slice: Option<&'pat Pattern<'tcx>>,
 611                                         suffix: &'pat [Pattern<'tcx>])
 612                                         -> Candidate<'pat, 'tcx> {
 613         let mut new_candidate =
 614             self.candidate_without_match_pair(match_pair_index, candidate);
 615         self.prefix_slice_suffix(
 616             &mut new_candidate.match_pairs,
 617             &candidate.match_pairs[match_pair_index].lvalue,
 618             prefix,
 619             opt_slice,
 620             suffix);
 621
 622         new_candidate
 623     }
 624
 625     fn candidate_after_variant_switch<'pat>(&mut self,
 626                                             match_pair_index: usize,
 627                                             adt_def: &'tcx ty::AdtDef,
 628                                             variant_index: usize,
 629                                             subpatterns: &'pat [FieldPattern<'tcx>],
 630                                             candidate: &Candidate<'pat, 'tcx>)
 631                                             -> Candidate<'pat, 'tcx> {
 632         let match_pair = &candidate.match_pairs[match_pair_index];
 633
 634         // So, if we have a match-pattern like `x @ Enum::Variant(P1, P2)`,
 635         // we want to create a set of derived match-patterns like
 636         // `(x as Variant).0 @ P1` and `(x as Variant).1 @ P1`.
 637         let elem = ProjectionElem::Downcast(adt_def, variant_index);
 638         let downcast_lvalue = match_pair.lvalue.clone().elem(elem); // `(x as Variant)`
 639         let consequent_match_pairs =
 640             subpatterns.iter()
 641                        .map(|subpattern| {
 642                            // e.g., `(x as Variant).0`
 643                            let lvalue = downcast_lvalue.clone().field(subpattern.field,
 644                                                                       subpattern.pattern.ty);
 645                            // e.g., `(x as Variant).0 @ P1`
 646                            MatchPair::new(lvalue, &subpattern.pattern)
 647                        });
 648
 649         // In addition, we need all the other match pairs from the old candidate.
 650         let other_match_pairs =
 651             candidate.match_pairs.iter()
 652                                  .enumerate()
 653                                  .filter(|&(index, _)| index != match_pair_index)
 654                                  .map(|(_, mp)| mp.clone());
 655
 656         let all_match_pairs = consequent_match_pairs.chain(other_match_pairs).collect();
 657
 658         Candidate {
 659             span: candidate.span,
 660             match_pairs: all_match_pairs,
 661             bindings: candidate.bindings.clone(),
 662             guard: candidate.guard.clone(),
 663             arm_index: candidate.arm_index,
 664         }
 665     }
 666
 667     fn error_simplifyable<'pat>(&mut self, match_pair: &MatchPair<'pat, 'tcx>) -> ! {
 668         span_bug!(match_pair.pattern.span,
 669                   "simplifyable pattern found: {:?}",
 670                   match_pair.pattern)
 671     }
 672 }
 673
 674 fn is_switch_ty<'tcx>(ty: Ty<'tcx>) -> bool {
 675     ty.is_integral() || ty.is_char() || ty.is_bool()
 676 }