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
// This file is part of the pgn-reader 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 fast non-allocating and streaming reader for chess games in PGN notation. //! //! [`BufferedReader`] parses games and calls methods of a user provided //! [`Visitor`]. Implementing custom visitors allows for maximum flexibility: //! //! * The reader itself does not allocate (besides a single fixed-size buffer). //! The visitor can decide if and how to represent games in memory. //! * The reader does not validate move legality. This allows implementing //! support for custom chess variants, or delaying move validation. //! * The visitor can signal to the reader that it does not care about a game //! or variation. //! //! # Flow //! //! Visitor methods are called in this order: //! //! ![Flow](https://github.com/niklasf/rust-pgn-reader/blob/master/docs/visitor.png?raw=true) //! //! # Examples //! //! A visitor that counts the number of syntactically valid moves in mainline //! of each game. //! //! ``` //! extern crate pgn_reader; //! //! use std::io; //! use pgn_reader::{Visitor, Skip, BufferedReader, SanPlus}; //! //! struct MoveCounter { //! moves: usize, //! } //! //! impl MoveCounter { //! fn new() -> MoveCounter { //! MoveCounter { moves: 0 } //! } //! } //! //! impl Visitor for MoveCounter { //! type Result = usize; //! //! fn begin_game(&mut self) { //! self.moves = 0; //! } //! //! fn san(&mut self, _san_plus: SanPlus) { //! self.moves += 1; //! } //! //! fn begin_variation(&mut self) -> Skip { //! Skip(true) // stay in the mainline //! } //! //! fn end_game(&mut self) -> Self::Result { //! self.moves //! } //! } //! //! fn main() -> io::Result<()> { //! let pgn = b"1. e4 e5 2. Nf3 (2. f4) //! { game paused due to bad weather } //! 2... Nf6 *"; //! //! let mut reader = BufferedReader::new_cursor(&pgn[..]); //! //! let mut counter = MoveCounter::new(); //! let moves = reader.read_game(&mut counter)?; //! //! assert_eq!(moves, Some(4)); //! Ok(()) //! } //! ``` //! //! A visitor that returns the final position using [Shakmaty]. //! //! ``` //! extern crate pgn_reader; //! extern crate shakmaty; //! //! use std::io; //! //! use shakmaty::{Chess, Position}; //! use shakmaty::fen::Fen; //! //! use pgn_reader::{Visitor, Skip, RawHeader, BufferedReader, SanPlus}; //! //! struct LastPosition { //! pos: Chess, //! } //! //! impl LastPosition { //! fn new() -> LastPosition { //! LastPosition { pos: Chess::default() } //! } //! } //! //! impl Visitor for LastPosition { //! type Result = Chess; //! //! fn header(&mut self, key: &[u8], value: RawHeader<'_>) { //! // Support games from a non-standard starting position. //! if key == b"FEN" { //! let pos = Fen::from_ascii(value.as_bytes()).ok() //! .and_then(|f| f.position().ok()); //! //! if let Some(pos) = pos { //! self.pos = pos; //! } //! } //! } //! //! fn begin_variation(&mut self) -> Skip { //! Skip(true) // stay in the mainline //! } //! //! fn san(&mut self, san_plus: SanPlus) { //! if let Ok(m) = san_plus.san.to_move(&self.pos) { //! self.pos.play_unchecked(&m); //! } //! } //! //! fn end_game(&mut self) -> Self::Result { //! ::std::mem::replace(&mut self.pos, Chess::default()) //! } //! } //! //! fn main() -> io::Result<()> { //! let pgn = b"1. f3 e5 2. g4 Qh4#"; //! //! let mut reader = BufferedReader::new_cursor(&pgn[..]); //! //! let mut visitor = LastPosition::new(); //! let pos = reader.read_game(&mut visitor)?; //! //! assert!(pos.map_or(false, |p| p.is_checkmate())); //! Ok(()) //! } //! ``` //! //! [`BufferedReader`]: struct.BufferedReader.html //! [`Visitor`]: trait.Visitor.html //! [Shakmaty]: ../shakmaty/index.html #![doc(html_root_url = "https://docs.rs/pgn-reader/0.15.0")] #![warn(missing_debug_implementations)] extern crate memchr; extern crate btoi; extern crate shakmaty; extern crate slice_deque; mod types; mod visitor; mod reader; pub use shakmaty::{Color, Role, CastlingSide, Outcome, Square, File, Rank}; pub use shakmaty::san::{San, SanPlus}; pub use types::{Skip, Nag, RawHeader, RawComment}; pub use visitor::Visitor; pub use reader::{BufferedReader, IntoIter};