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
// This file is part of the shakmaty library.
// Copyright (C) 2017-2018 Niklas Fiekas <niklas.fiekas@backscattering.de>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! A library for chess move generation.
//!
//! # Examples
//!
//! Generate legal moves in the starting position:
//!
//! ```
//! use shakmaty::{Chess, Position};
//!
//! let pos = Chess::default();
//! let legals = pos.legals();
//! assert_eq!(legals.len(), 20);
//! ```
//!
//! Play moves:
//!
//! ```
//! # use std::error::Error;
//! #
//! # fn try_main() -> Result<(), Box<Error>> {
//! use shakmaty::{Square, Move, Role};
//! # use shakmaty::{Chess, Position};
//! # let pos = Chess::default();
//!
//! // 1. e4
//! let pos = pos.play(&Move::Normal {
//! role: Role::Pawn,
//! from: Square::E2,
//! to: Square::E4,
//! capture: None,
//! promotion: None,
//! })?;
//! #
//! # Ok(())
//! # }
//! #
//! # fn main() {
//! # try_main().unwrap();
//! # }
//! ```
//!
//! Detect game end conditions:
//!
//! ```
//! # use shakmaty::{Chess, Position};
//! # let pos = Chess::default();
//! assert!(!pos.is_checkmate());
//! assert!(!pos.is_stalemate());
//! assert!(!pos.is_insufficient_material());
//!
//! assert_eq!(pos.outcome(), None); // no winner yet
//! ```
//!
//! Also supports [FEN](fen/index.html), [SAN](san/index.html) and
//! [UCI](uci/index.html) formats for positions and moves.
#![doc(html_root_url = "https://docs.rs/shakmaty/0.12.0")]
#![warn(missing_debug_implementations)]
#![warn(bare_trait_objects)]
#![cfg_attr(nightly, feature(exact_size_is_empty))]
extern crate arrayvec;
#[macro_use]
extern crate bitflags;
extern crate btoi;
mod square;
mod types;
mod material;
mod board;
mod position;
mod setup;
mod movelist;
mod magics;
mod perft;
pub mod attacks;
pub mod bitboard;
pub mod fen;
pub mod uci;
pub mod san;
pub use square::{ParseSquareError, File, Rank, Square};
pub use types::{CastlingSide, Color, Move, Piece, RemainingChecks, Role};
pub use material::{Material, MaterialSide, ParseMaterialError};
pub use bitboard::Bitboard;
pub use board::{Board, Pieces};
pub use setup::{Castles, Setup};
pub use movelist::MoveList;
pub use position::{Chess, IllegalMoveError, Outcome, Position, PositionError};
pub use perft::perft;
pub mod variants {
//! Chess variants.
//!
//! These are games played with normal chess pieces but special rules.
//! Every chess variant implements [`Setup`] and [`Position`].
//!
//! [`Setup`]: ../trait.Setup.html
//! [`Position`]: ../trait.Position.html
pub use Chess;
pub use position::Atomic;
pub use position::Giveaway;
pub use position::KingOfTheHill;
pub use position::ThreeCheck;
pub use position::Crazyhouse;
pub use position::RacingKings;
pub use position::Horde;
}