1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
use crate::*;
mod movegen;
mod parse;
mod zobrist;
mod builder;
mod validate;
use zobrist::*;
pub use movegen::*;
pub use parse::*;
pub use builder::*;
/// The current state of the game.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum GameStatus {
/// The game ended in a win.
Won,
/// The game ended in a draw.
Drawn,
/// The game is still ongoing.
Ongoing
}
helpers::simple_error! {
/// An error returned when the move played was illegal.
pub struct IllegalMoveError = "The move played was illegal.";
}
/// A chessboard.
///
/// This keeps about as much state as a FEN string, and does not keep track of history.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Board {
inner: ZobristBoard,
pinned: BitBoard,
checkers: BitBoard,
halfmove_clock: u8,
fullmove_number: u16
}
impl Default for Board {
fn default() -> Self {
BoardBuilder::default().build().unwrap()
}
}
impl Board {
/// Get a board with the default start position.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let startpos = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1".parse().unwrap();
/// let board = Board::default();
/// assert_eq!(board, startpos);
/// ```
pub fn startpos() -> Self {
BoardBuilder::startpos().build().unwrap()
}
/// Get a board with a chess960 start position.
/// Converts a [Scharnagl number](https://en.wikipedia.org/wiki/Fischer_random_chess_numbering_scheme)
/// to its corresponding position.
/// # Panics
/// Panic if the Scharnagl number is invalid (not within the range 0..960).
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let startpos = Board::default();
/// // 518 is the Scharnagl number for the default start position.
/// let board = Board::chess960_startpos(518);
/// assert_eq!(board, startpos);
/// ```
pub fn chess960_startpos(scharnagl_number: u32) -> Self {
BoardBuilder::chess960_startpos(scharnagl_number).build().unwrap()
}
/// Get a board with a double chess960 start position.
/// Uses two [Scharnagl numbers](https://en.wikipedia.org/wiki/Fischer_random_chess_numbering_scheme)
/// for the initial setup for white and the initial setup for black.
/// # Panics
/// Panic if either Scharnagl number is invalid (not within the range 0..960).
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let startpos = Board::default();
/// // 518 is the Scharnagl number for the default start position.
/// let board = Board::double_chess960_startpos(518, 518);
/// assert_eq!(board, startpos);
/// ```
pub fn double_chess960_startpos(white_scharnagl_number: u32, black_scharnagl_number: u32) -> Self {
BoardBuilder::double_chess960_startpos(white_scharnagl_number, black_scharnagl_number).build().unwrap()
}
/// Get a [`BitBoard`] of all the pieces of a certain type.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// let pawns = board.pieces(Piece::Pawn);
/// assert_eq!(pawns, bitboard! {
/// . . . . . . . .
/// X X X X X X X X
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// X X X X X X X X
/// . . . . . . . .
/// });
/// ```
#[inline(always)]
pub fn pieces(&self, piece: Piece) -> BitBoard {
self.inner.pieces(piece)
}
/// Get a [`BitBoard`] of all the pieces of a certain color.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// let white_pieces = board.colors(Color::White);
/// assert_eq!(white_pieces, bitboard! {
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// X X X X X X X X
/// X X X X X X X X
/// });
/// ```
#[inline(always)]
pub fn colors(&self, color: Color) -> BitBoard {
self.inner.colors(color)
}
/// Get a [`BitBoard`] of all the pieces of a certain color and type.
/// Shorthand for `board.colors(color) & board.pieces(piece)`.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// let white_pawns = board.colored_pieces(Color::White, Piece::Pawn);
/// assert_eq!(white_pawns, bitboard! {
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// X X X X X X X X
/// . . . . . . . .
/// });
/// ```
#[inline(always)]
pub fn colored_pieces(&self, color: Color, piece: Piece) -> BitBoard {
self.colors(color) & self.pieces(piece)
}
/// Get a [`BitBoard`] of all the pieces on the board.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// assert_eq!(board.occupied(), bitboard! {
/// X X X X X X X X
/// X X X X X X X X
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// X X X X X X X X
/// X X X X X X X X
/// });
/// ```
#[inline(always)]
pub fn occupied(&self) -> BitBoard {
self.inner.colors(Color::White) | self.inner.colors(Color::Black)
}
/// Get the current side to move.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// assert_eq!(board.side_to_move(), Color::White);
/// board.play("e2e4".parse().unwrap());
/// assert_eq!(board.side_to_move(), Color::Black);
/// ```
#[inline(always)]
pub fn side_to_move(&self) -> Color {
self.inner.side_to_move()
}
/// Get the [`CastleRights`] for some side.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// let rights = board.castle_rights(Color::White);
/// assert_eq!(rights.short, Some(File::H));
/// assert_eq!(rights.long, Some(File::A));
/// board.play("e2e4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// board.play("e1e2".parse().unwrap());
/// let rights = board.castle_rights(Color::White);
/// assert_eq!(rights.short, None);
/// assert_eq!(rights.long, None);
/// ```
#[inline(always)]
pub fn castle_rights(&self, color: Color) -> &CastleRights {
self.inner.castle_rights(color)
}
/// Get the en passant file, if it exists.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board: Board = "1k2r3/2p5/p4p2/Pb6/1p1b1P1R/1P6/2P3PP/5K2 w - - 1 36"
/// .parse().unwrap();
/// assert_eq!(board.en_passant(), None);
/// board.play("c2c4".parse().unwrap());
/// assert_eq!(board.en_passant(), Some(File::C));
/// board.play("b4c3".parse().unwrap());
/// assert_eq!(board.en_passant(), None);
/// ```
#[inline(always)]
pub fn en_passant(&self) -> Option<File> {
self.inner.en_passant()
}
/// Get the incrementally updated position hash.
/// Does not include the halfmove clock or fullmove number.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// board.play("e2e4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// board.play("e1e2".parse().unwrap());
/// board.play("e8e7".parse().unwrap());
/// let expected: Board = "rnbq1bnr/ppppkppp/8/4p3/4P3/8/PPPPKPPP/RNBQ1BNR w - - 2 3"
/// .parse().unwrap();
/// assert_eq!(expected.hash(), board.hash());
/// ```
#[inline(always)]
pub fn hash(&self) -> u64 {
self.inner.hash()
}
/// Get the incrementally updated position hash without en passant information.
/// Does not include the halfmove clock or fullmove number.
/// This may be used for equivalence checks if en passant is not relevant.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let has_ep: Board = "rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1"
/// .parse().unwrap();
/// let no_ep: Board = "rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq - 4 3"
/// .parse().unwrap();
/// assert_ne!(has_ep.hash(), no_ep.hash());
/// assert_eq!(has_ep.hash_without_ep(), no_ep.hash());
/// ```
#[inline(always)]
pub fn hash_without_ep(&self) -> u64 {
self.inner.hash_without_ep()
}
/// Get the pinned pieces for the side to move.
/// Note that this counts pieces regardless of color.
/// This counts any piece preventing check on our king.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board: Board = "8/8/1q4k1/5p2/1n6/3B4/1KP3r1/8 w - - 0 1".parse().unwrap();
/// assert_eq!(board.pinned(), bitboard! {
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . X . . . . . .
/// . . . . . . . .
/// . . X . . . . .
/// . . . . . . . .
/// });
/// ```
#[inline(always)]
pub fn pinned(&self) -> BitBoard {
self.pinned
}
/// Get the pieces currently giving check.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board: Board = "1r4r1/pbpknp1p/1b3P2/8/8/B1PB1q2/P4PPP/3R2K1 w - - 0 22"
/// .parse().unwrap();
/// assert_eq!(board.checkers(), BitBoard::EMPTY);
/// board.play("d3f5".parse().unwrap());
/// assert_eq!(board.checkers(), bitboard! {
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . X . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . . . . . .
/// . . . X . . . .
/// });
/// ```
#[inline(always)]
pub fn checkers(&self) -> BitBoard {
self.checkers
}
/// Get the [halfmove clock](https://www.chessprogramming.org/Halfmove_Clock).
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// assert_eq!(board.halfmove_clock(), 0);
/// board.play("e2e4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// // Remains at zero for pawn moves
/// assert_eq!(board.halfmove_clock(), 0);
/// board.play("e1e2".parse().unwrap());
/// // Non-pawn move
/// assert_eq!(board.halfmove_clock(), 1);
/// ```
#[inline(always)]
pub fn halfmove_clock(&self) -> u8 {
self.halfmove_clock
}
/// Set the [halfmove clock](https://www.chessprogramming.org/Halfmove_Clock).
/// # Panics
/// This method panics if the argument is larger than 100.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board: Board = "rnbqkb1r/pppppppp/5n2/8/8/5N2/PPPPPPPP/RNBQKB1R w KQkq - 2 2"
/// .parse().unwrap();
/// assert_eq!(board.halfmove_clock(), 2);
/// board.set_halfmove_clock(0);
/// assert_eq!(board.halfmove_clock(), 0);
/// ```
#[inline(always)]
pub fn set_halfmove_clock(&mut self, n: u8) {
assert!(n <= 100, "invalid halfmove clock {}", n);
self.halfmove_clock = n;
}
/// Get the [fullmove number](https://www.chessprogramming.org/Forsyth-Edwards_Notation#Fullmove_counter).
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// // The fullmove number starts at one.
/// assert_eq!(board.fullmove_number(), 1);
/// board.play("e2e4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// board.play("e1e2".parse().unwrap());
/// // 3 plies is 1.5 moves, which rounds down
/// assert_eq!(board.fullmove_number(), 2);
/// ```
#[inline(always)]
pub fn fullmove_number(&self) -> u16 {
self.fullmove_number
}
/// Set the [fullmove number](https://www.chessprogramming.org/Forsyth-Edwards_Notation#Fullmove_counter).
/// # Panics
/// This method panics if the argument is zero.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// // The fullmove number starts at one.
/// assert_eq!(board.fullmove_number(), 1);
/// board.set_fullmove_number(2);
/// assert_eq!(board.fullmove_number(), 2);
/// ```
#[inline(always)]
pub fn set_fullmove_number(&mut self, n: u16) {
assert!(n > 0, "invalid fullmove number {}", n);
self.fullmove_number = n;
}
/// Get the [`Piece`] on `square`, if there is one.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// assert_eq!(board.piece_on(Square::E1), Some(Piece::King));
/// ```
#[inline(always)]
pub fn piece_on(&self, square: Square) -> Option<Piece> {
Piece::ALL.iter().copied().find(|&p| self.pieces(p).has(square))
}
/// Get the [`Color`] of the piece on `square`, if there is one.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// assert_eq!(board.color_on(Square::E1), Some(Color::White));
/// ```
#[inline(always)]
pub fn color_on(&self, square: Square) -> Option<Color> {
if self.colors(Color::White).has(square) {
Some(Color::White)
} else if self.colors(Color::Black).has(square) {
Some(Color::Black)
} else {
None
}
}
/// Get the king square of some side.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board = Board::default();
/// assert_eq!(board.king(Color::White), Square::E1);
/// ```
#[inline(always)]
pub fn king(&self, color: Color) -> Square {
self.colored_pieces(color, Piece::King)
.next_square()
.expect("No king was found.")
}
/// Get the status of the game.
/// Note that this game may still be drawn from threefold repetition.
/// The game may also be drawn from insufficient material cases such
/// as bare kings; This method does not detect such cases.
/// If the game is won, the loser is the current side to move.
/// # Examples
/// ## Checkmate
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// const MOVES: &[&str] = &[
/// "e2e4", "e7e5", "g1f3", "b8c6", "d2d4", "e5d4",
/// "f3d4", "f8c5", "c2c3", "d8f6", "d4c6", "f6f2"
/// ];
/// for mv in MOVES {
/// assert_eq!(board.status(), GameStatus::Ongoing);
/// board.play(mv.parse().unwrap());
/// }
/// assert_eq!(board.status(), GameStatus::Won);
/// let winner = !board.side_to_move();
/// assert_eq!(winner, Color::Black);
/// ```
/// ## Stalemate
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// const MOVES: &[&str] = &[
/// "c2c4", "h7h5", "h2h4", "a7a5", "d1a4",
/// "a8a6", "a4a5", "a6h6", "a5c7", "f7f6",
/// "c7d7", "e8f7", "d7b7", "d8d3", "b7b8",
/// "d3h7", "b8c8", "f7g6", "c8e6"
/// ];
/// for mv in MOVES {
/// assert_eq!(board.status(), GameStatus::Ongoing);
/// board.play(mv.parse().unwrap());
/// }
/// assert_eq!(board.status(), GameStatus::Drawn);
/// ```
/// ## 50 move rule
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// board.play("e2e4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// const MOVES: &[&str] = &["e1e2", "e8e7", "e2e1", "e7e8"];
/// for mv in MOVES.iter().cycle().take(50 * 2) {
/// assert_eq!(board.status(), GameStatus::Ongoing);
/// board.play(mv.parse().unwrap());
/// }
/// assert_eq!(board.status(), GameStatus::Drawn);
/// ```
pub fn status(&self) -> GameStatus {
if self.generate_moves(|_| true) {
if self.halfmove_clock() < 100 {
GameStatus::Ongoing
} else {
GameStatus::Drawn
}
} else if self.checkers().is_empty() {
GameStatus::Drawn
} else {
GameStatus::Won
}
}
/// Check if two positions are equivalent based on the FIDE definition.
/// This differs from the [`Eq`] implementation in that:
/// - It does not check the halfmove clock or fullmove number
/// - It ignores the state of the en passant square if it does not apply (capture would not be legal)
/// This method can be used as a strict check for threefold repetition.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let board_a = "rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq e3 0 1"
/// .parse::<Board>().unwrap();
/// let board_b = "rnbqkbnr/pppppppp/8/8/4P3/8/PPPP1PPP/RNBQKBNR b KQkq - 4 3"
/// .parse::<Board>().unwrap();
/// assert!(board_a != board_b); // Differing EP and halfmove clock
/// assert!(board_a.same_position(&board_b)); // Identical by FIDE rules
///
/// let board_c = "rnbqkb1r/ppp1pppp/5n2/3pP3/8/8/PPPP1PPP/RNBQKBNR w KQkq d6 0 3"
/// .parse::<Board>().unwrap();
/// let board_d = "rnbqkb1r/ppp1pppp/5n2/3pP3/8/8/PPPP1PPP/RNBQKBNR w KQkq - 4 5"
/// .parse::<Board>().unwrap();
/// assert!(!board_c.same_position(&board_d)); // En passant is legal here
/// ```
pub fn same_position(&self, other: &Self) -> bool {
fn effective_ep(board: &Board) -> Option<File> {
if let Some(ep_file) = board.en_passant() {
let color = board.side_to_move();
let ep_rank = Rank::Sixth.relative_to(color);
let ep_square = Square::new(ep_file, ep_rank);
let attackers = get_pawn_attacks(ep_square, !color);
for attacker in attackers {
let mv = Move {
from: attacker,
to: ep_square,
promotion: None
};
if board.is_legal(mv) {
return Some(ep_file);
}
}
}
None
}
self.hash_without_ep() == other.hash_without_ep()
&& self.inner.board_is_equal(&other.inner)
&& effective_ep(self) == effective_ep(other)
}
/// Attempt to play a [null move](https://www.chessprogramming.org/Null_Move),
/// returning a new board if successful.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// board.play("f2f4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// assert_eq!(board.side_to_move(), Color::White);
/// board = board.null_move().unwrap();
/// assert_eq!(board.side_to_move(), Color::Black);
/// board.play("d8h4".parse().unwrap());
/// // Can't leave the king in check
/// assert!(board.null_move().is_none());
/// ```
pub fn null_move(&self) -> Option<Board> {
if self.checkers.is_empty() {
let mut board = self.clone();
board.halfmove_clock += 1;
if board.halfmove_clock > 100 {
board.halfmove_clock = 100;
}
if board.side_to_move() == Color::Black {
board.fullmove_number = board.fullmove_number.saturating_add(1);
}
board.inner.toggle_side_to_move();
board.inner.set_en_passant(None);
board.pinned = BitBoard::EMPTY;
let color = board.side_to_move();
let our_king = board.king(color);
let their_attackers = board.colors(!color) & (
(get_bishop_rays(our_king) & (
board.pieces(Piece::Bishop) |
board.pieces(Piece::Queen)
)) |
(get_rook_rays(our_king) & (
board.pieces(Piece::Rook) |
board.pieces(Piece::Queen)
))
);
for square in their_attackers {
let between = get_between_rays(square, our_king) & board.occupied();
if between.len() == 1 {
board.pinned |= between;
}
}
Some(board)
} else {
None
}
}
/// Play a move while checking its legality. Note that this only supports Chess960 style castling.
/// This method does not account for the 50 move rule, and checks only whether the move would be legal.
/// The halfmove clock is capped at 100 and the fullmove number is capped at `u16::MAX`.
/// # Panics
/// This is guaranteed to panic if the move is illegal.
/// See [`Board::try_play`] for a non-panicking variant.
/// See [`Board::play_unchecked`] for a faster variant
/// that's not guaranteed to panic on illegal moves.
/// # Examples
/// ## Legal moves
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// board.play("e2e4".parse().unwrap());
/// board.play("e7e5".parse().unwrap());
/// board.play("e1e2".parse().unwrap());
/// board.play("e8e7".parse().unwrap());
/// const EXPECTED: &str = "rnbq1bnr/ppppkppp/8/4p3/4P3/8/PPPPKPPP/RNBQ1BNR w - - 2 3";
/// assert_eq!(format!("{}", board), EXPECTED);
/// ```
/// ## Illegal moves
/// ```should_panic
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// board.play("e1e8".parse().unwrap());
/// ```
pub fn play(&mut self, mv: Move) {
assert!(self.try_play(mv).is_ok(), "Illegal move {}!", mv);
}
/// Non-panicking version of [`Board::play`].
/// Tries to play a move, returning `Ok(())` on success.
/// # Errors
/// Errors with [`IllegalMoveError`] if the move was illegal.
pub fn try_play(&mut self, mv: Move) -> Result<(), IllegalMoveError> {
if !self.is_legal(mv) {
return Err(IllegalMoveError);
}
self.play_unchecked(mv);
Ok(())
}
/// Unchecked version of [`Board::play`].
/// Use this method with caution; Only legal moves should ever be passed to this method.
/// Playing illegal moves may corrupt the board state, causing panics.
/// However, it will not cause undefined behaviour.
/// # Panics
/// This may panic if the move is illegal.
/// Additionally, playing illegal moves may corrupt the board state, which may cause further panics.
/// See [`Board::play`] for a variant guaranteed to panic on illegal moves.
/// # Examples
/// ```
/// # use cozy_chess::*;
/// let mut board = Board::default();
/// board.play_unchecked("e2e4".parse().unwrap());
/// board.play_unchecked("e7e5".parse().unwrap());
/// board.play_unchecked("e1e2".parse().unwrap());
/// board.play_unchecked("e8e7".parse().unwrap());
/// const EXPECTED: &str = "rnbq1bnr/ppppkppp/8/4p3/4P3/8/PPPPKPPP/RNBQ1BNR w - - 2 3";
/// assert_eq!(format!("{}", board), EXPECTED);
/// ```
pub fn play_unchecked(&mut self, mv: Move) {
self.pinned = BitBoard::EMPTY;
self.checkers = BitBoard::EMPTY;
let moved = self.piece_on(mv.from).expect("Missing piece on move's from square");
let victim = self.piece_on(mv.to);
let color = self.inner.side_to_move();
let their_king = self.king(!color);
let our_back_rank = Rank::First.relative_to(color);
let their_back_rank = Rank::Eighth.relative_to(color);
// Castling move encoded as king captures rook.
let is_castle = self.colors(color).has(mv.to);
if moved == Piece::Pawn || (victim.is_some() && !is_castle) {
self.halfmove_clock = 0;
} else {
self.halfmove_clock += 1;
if self.halfmove_clock > 100 {
self.halfmove_clock = 100;
}
}
if color == Color::Black {
self.fullmove_number = self.fullmove_number.saturating_add(1);
}
let mut new_en_passant = None;
if is_castle {
let (king, rook) = if mv.from.file() < mv.to.file() {
// Short castle
(File::G, File::F)
} else {
// Long castle
(File::C, File::D)
};
// Lift the king, lift the rook.
self.inner.xor_square(Piece::King, color, mv.from);
self.inner.xor_square(Piece::Rook, color, mv.to);
// Drop in the king, drop in the rook.
self.inner.xor_square(Piece::King, color, Square::new(king, our_back_rank));
self.inner.xor_square(Piece::Rook, color, Square::new(rook, our_back_rank));
// Remove castling rights.
self.inner.set_castle_right(color, true, None);
self.inner.set_castle_right(color, false, None);
} else {
// Lift the piece
self.inner.xor_square(moved, color, mv.from);
// Drop the piece
self.inner.xor_square(moved, color, mv.to);
if let Some(victim) = victim {
// If victim == piece, the piece was XORed out and this puts it back.
// If victim != piece, the victim is still there and this XORs it out.
self.inner.xor_square(victim, !color, mv.to);
if mv.to.rank() == their_back_rank {
let rights = self.inner.castle_rights(!color);
if Some(mv.to.file()) == rights.short {
self.inner.set_castle_right(!color, true, None);
} else if Some(mv.to.file()) == rights.long {
self.inner.set_castle_right(!color, false, None);
}
}
}
// Finalize the move (special cases for each piece).
// Updating checker information for non-sliding pieces happens here.
match moved {
Piece::Knight => self.checkers |= get_knight_moves(their_king) & mv.to.bitboard(),
Piece::Pawn => {
if let Some(promotion) = mv.promotion {
// Get rid of the pawn and replace it with the promotion. Also update checkers.
self.inner.xor_square(Piece::Pawn, color, mv.to);
self.inner.xor_square(promotion, color, mv.to);
if promotion == Piece::Knight {
self.checkers |= get_knight_moves(their_king) & mv.to.bitboard();
}
} else {
let double_move_from = Rank::Second.bitboard() | Rank::Seventh.bitboard();
let double_move_to = Rank::Fourth.bitboard() | Rank::Fifth.bitboard();
let ep_square = self.inner.en_passant().map(|ep| {
Square::new(ep, Rank::Sixth.relative_to(color))
});
if double_move_from.has(mv.from) && double_move_to.has(mv.to) {
// Double move, update en passant.
new_en_passant = Some(mv.to.file());
} else if Some(mv.to) == ep_square {
// En passant capture.
let victim_square = Square::new(
mv.to.file(),
Rank::Fifth.relative_to(color)
);
self.inner.xor_square(Piece::Pawn, !color, victim_square);
}
// Update checkers.
self.checkers |= get_pawn_attacks(their_king, !color) & mv.to.bitboard();
}
}
Piece::King => {
self.inner.set_castle_right(color, true, None);
self.inner.set_castle_right(color, false, None);
}
Piece::Rook => if mv.from.rank() == our_back_rank {
let rights = self.inner.castle_rights(color);
if Some(mv.from.file()) == rights.short {
self.inner.set_castle_right(color, true, None);
} else if Some(mv.from.file()) == rights.long {
self.inner.set_castle_right(color, false, None);
}
}
_ => {}
}
}
self.inner.set_en_passant(new_en_passant);
// Almost there. Just have to update checker and pinned information for sliding pieces.
let our_attackers = self.colors(color) & (
(get_bishop_rays(their_king) & (
self.pieces(Piece::Bishop) |
self.pieces(Piece::Queen)
)) |
(get_rook_rays(their_king) & (
self.pieces(Piece::Rook) |
self.pieces(Piece::Queen)
))
);
for square in our_attackers {
let between = get_between_rays(square, their_king) & self.occupied();
match between.len() {
0 => self.checkers |= square.bitboard(),
1 => self.pinned |= between,
_ => {}
}
}
self.inner.toggle_side_to_move();
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn play_moves() {
let mut board = "r3k2r/p1ppqpb1/bn2pnp1/3PN3/1p2P3/2N2Q1p/PPPBBPPP/R3K2R w KQkq - 0 1"
.parse::<Board>().unwrap();
const MOVES: &[(&str, &str)] = &[
("f3f5", "r3k2r/p1ppqpb1/bn2pnp1/3PNQ2/1p2P3/2N4p/PPPBBPPP/R3K2R b KQkq - 1 1"),
("h3g2", "r3k2r/p1ppqpb1/bn2pnp1/3PNQ2/1p2P3/2N5/PPPBBPpP/R3K2R w KQkq - 0 2"),
("e5g6", "r3k2r/p1ppqpb1/bn2pnN1/3P1Q2/1p2P3/2N5/PPPBBPpP/R3K2R b KQkq - 0 2"),
("g2h1r", "r3k2r/p1ppqpb1/bn2pnN1/3P1Q2/1p2P3/2N5/PPPBBP1P/R3K2r w Qkq - 0 3"),
("e2f1", "r3k2r/p1ppqpb1/bn2pnN1/3P1Q2/1p2P3/2N5/PPPB1P1P/R3KB1r b Qkq - 1 3"),
("f7g6", "r3k2r/p1ppq1b1/bn2pnp1/3P1Q2/1p2P3/2N5/PPPB1P1P/R3KB1r w Qkq - 0 4"),
("d2h6", "r3k2r/p1ppq1b1/bn2pnpB/3P1Q2/1p2P3/2N5/PPP2P1P/R3KB1r b Qkq - 1 4"),
("e7d6", "r3k2r/p1pp2b1/bn1qpnpB/3P1Q2/1p2P3/2N5/PPP2P1P/R3KB1r w Qkq - 2 5"),
("f2f4", "r3k2r/p1pp2b1/bn1qpnpB/3P1Q2/1p2PP2/2N5/PPP4P/R3KB1r b Qkq f3 0 5"),
("e8a8", "2kr3r/p1pp2b1/bn1qpnpB/3P1Q2/1p2PP2/2N5/PPP4P/R3KB1r w Q - 1 6"),
("f5h5", "2kr3r/p1pp2b1/bn1qpnpB/3P3Q/1p2PP2/2N5/PPP4P/R3KB1r b Q - 2 6"),
("f6e4", "2kr3r/p1pp2b1/bn1qp1pB/3P3Q/1p2nP2/2N5/PPP4P/R3KB1r w Q - 0 7"),
("a2a4", "2kr3r/p1pp2b1/bn1qp1pB/3P3Q/Pp2nP2/2N5/1PP4P/R3KB1r b Q a3 0 7"),
("b4a3", "2kr3r/p1pp2b1/bn1qp1pB/3P3Q/4nP2/p1N5/1PP4P/R3KB1r w Q - 0 8"),
("c3d1", "2kr3r/p1pp2b1/bn1qp1pB/3P3Q/4nP2/p7/1PP4P/R2NKB1r b Q - 1 8"),
("a6b5", "2kr3r/p1pp2b1/1n1qp1pB/1b1P3Q/4nP2/p7/1PP4P/R2NKB1r w Q - 2 9"),
("h6g7", "2kr3r/p1pp2B1/1n1qp1p1/1b1P3Q/4nP2/p7/1PP4P/R2NKB1r b Q - 0 9"),
("d6d5", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/4nP2/p7/1PP4P/R2NKB1r w Q - 0 10"),
("b2b4", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P2nP2/p7/2P4P/R2NKB1r b Q b3 0 10"),
("e4d2", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P3P2/p7/2Pn3P/R2NKB1r w Q - 1 11"),
("a1b1", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P3P2/p7/2Pn3P/1R1NKB1r b - - 2 11"),
("h1h2", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P3P2/p7/2Pn3r/1R1NKB2 w - - 0 12"),
("b1c1", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P3P2/p7/2Pn3r/2RNKB2 b - - 1 12"),
("d2b3", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P3P2/pn6/2P4r/2RNKB2 w - - 2 13"),
("d1b2", "2kr3r/p1pp2B1/1n2p1p1/1b1q3Q/1P3P2/pn6/1NP4r/2R1KB2 b - - 3 13"),
("c7c6", "2kr3r/p2p2B1/1np1p1p1/1b1q3Q/1P3P2/pn6/1NP4r/2R1KB2 w - - 0 14"),
("h5h6", "2kr3r/p2p2B1/1np1p1pQ/1b1q4/1P3P2/pn6/1NP4r/2R1KB2 b - - 1 14"),
("d5d6", "2kr3r/p2p2B1/1npqp1pQ/1b6/1P3P2/pn6/1NP4r/2R1KB2 w - - 2 15"),
("h6h2", "2kr3r/p2p2B1/1npqp1p1/1b6/1P3P2/pn6/1NP4Q/2R1KB2 b - - 0 15"),
("d6d1", "2kr3r/p2p2B1/1np1p1p1/1b6/1P3P2/pn6/1NP4Q/2RqKB2 w - - 1 16"),
("e1d1", "2kr3r/p2p2B1/1np1p1p1/1b6/1P3P2/pn6/1NP4Q/2RK1B2 b - - 0 16"),
("d7d6", "2kr3r/p5B1/1nppp1p1/1b6/1P3P2/pn6/1NP4Q/2RK1B2 w - - 0 17")
];
for &(mv, expected) in MOVES {
board.play_unchecked(mv.parse().unwrap());
println!("{}, {}", mv, board.hash());
assert_eq!(format!("{}", board), expected);
assert_eq!(board.hash(), expected.parse::<Board>().unwrap().hash());
}
}
#[test]
fn status_checkmate_priority_over_50_mr() {
let board = "8/8/2p5/3b1K1k/4p3/4Pp1R/5P2/8 b - - 100 113"
.parse::<Board>().unwrap();
assert_eq!(board.status(), GameStatus::Won);
}
#[test]
fn play_move_halfmove_is_capped() {
let mut board = "8/8/4b3/8/8/8/pK2k3/8 w - - 100 277"
.parse::<Board>().unwrap();
board.play("b2a1".parse().unwrap());
assert_eq!(board.halfmove_clock(), 100);
}
#[test]
fn play_move_fullmove_is_capped() {
let mut board = "8/Q4k2/3p3p/1PnP1p1P/2B1qPp1/8/5P2/5K2 b - - 8 65535"
.parse::<Board>().unwrap();
board.play("f7f6".parse().unwrap());
assert_eq!(board.fullmove_number(), u16::MAX);
}
}