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

//! # SGF Parser for Rust
//!
//! A sgf parser for rust. Supports all SGF properties, and tree branching.
//!
//! Using `pest` for the actual parsing part.
//!
//! NOTE: when converting a `GameTree` to a string we convert all charset tokens to be UTF-8, since
//! that is the encoding for all strings in Rust.
//!
//! # Example usage
//! ```rust
//! use sgf_parser::*;
//!
//! let sgf_source = "(;C[comment]EV[event]PB[black]PW[white];B[aa])";
//! let tree: Result<GameTree, SgfError> = parse(sgf_source);
//!
//! let tree = tree.unwrap();
//! let unknown_nodes = tree.get_unknown_nodes();
//! assert_eq!(unknown_nodes.len(), 0);
//!
//! let invalid_nodes = tree.get_invalid_nodes();
//! assert_eq!(invalid_nodes.len(), 0);
//!
//! tree.iter().for_each(|node| {
//!   assert!(!node.tokens.is_empty());
//! });
//!
//! let sgf_string: String = tree.into();
//! assert_eq!(sgf_source, sgf_string);
//! ```
#![deny(rust_2018_idioms)]

mod error;
mod node;
mod parser;
mod token;
mod tree;

pub use crate::error::{SgfError, SgfErrorKind};
pub use crate::node::GameNode;
pub use crate::parser::parse;
pub use crate::token::{Action, Color, DisplayNodes, Encoding, Game, Outcome, RuleSet, SgfToken};
pub use crate::tree::GameTree;