goban 0.20.1

Library for Go move generation and Go ruling.
Documentation 
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

//! # GameBuilder Helper
//! Utility for creating complex games with non standard komi, handicap etc...
//! # Example
//! ```
//! use crate::goban::rules::game_builder::GameBuilder;
//! use crate::goban::rules::Rule;
//! use goban::rules::game::Game;
//! use goban::rules::JAPANESE;
//!
//! let mut builder = GameBuilder::default();
//! // or
//! let mut builder = Game::builder();
//! let game = builder
//!     .rule(JAPANESE)
//!     .size((19,19))
//!     .put_handicap(&[(3,3), (4,4)])
//!     .komi(10.)
//!     .build();
//! ```

use crate::pieces::goban::Goban;
use crate::pieces::stones::{Color, Stone};
use crate::pieces::util::coord::{Coord, Size};
use crate::rules::game::Game;
use crate::rules::{EndGame, Move, Rule, CHINESE};
use std::mem::take;

pub struct GameBuilder {
    size: Size,
    black_player: String,
    white_player: String,
    rule: Rule,
    komi: Option<f32>,
    handicap: Option<u32>,
    handicap_points: Vec<Coord>,
    turn: Option<Color>,
    moves: Vec<Move>,
    outcome: Option<EndGame>,
    setup: Vec<Stone>,
}

impl GameBuilder {
    pub fn moves(&mut self, moves: &[Move]) -> &mut Self {
        self.moves = moves.to_vec();
        self
    }

    pub fn outcome(&mut self, outcome: EndGame) -> &mut Self {
        self.outcome = Some(outcome);
        self
    }

    /// Overrides the turn because it's a game with handicap. So White begins.
    pub fn put_handicap(&mut self, points: &[Coord]) -> &mut Self {
        self.handicap_points = points.to_vec();
        self
    }

    pub fn handicap(&mut self, handicap: u32) -> &mut Self {
        self.handicap = Some(handicap);
        self
    }

    pub fn size(&mut self, size: Size) -> &mut Self {
        self.size = size;
        self
    }

    pub fn komi(&mut self, komi: f32) -> &mut Self {
        self.komi = Some(komi);
        self
    }

    pub fn turn(&mut self, turn: Color) -> &mut Self {
        self.turn = Some(turn);
        self
    }

    pub fn black_player(&mut self, black_player_name: &str) -> &mut Self {
        self.black_player = black_player_name.to_string();
        self
    }

    pub fn rule(&mut self, rule: Rule) -> &mut Self {
        self.rule = rule;
        self
    }

    pub fn white_player(&mut self, white_player_name: &str) -> &mut Self {
        self.white_player = white_player_name.to_string();
        self
    }

    pub fn add(&mut self, stone: Stone) -> &mut Self {
        self.setup.push(stone);
        self
    }

    fn build_inner(mut self) -> Result<Game, String> {
        let mut goban: Goban = Goban::new(self.size);

        let handicap = self.handicap.unwrap_or(self.handicap_points.len() as u32);

        for point in self.handicap_points {
            goban.push(point, Color::Black);
        }

        // Setup
        for s in self.setup {
            goban.push_stone(s);
        }

        if let Some(komi) = self.komi {
            self.rule.komi = komi;
        }

        let turn = {
            self.turn.unwrap_or(if handicap != 0 {
                Color::White
            } else {
                Color::Black
            })
        };

        let mut g = Game {
            goban: goban.clone(),
            passes: 0,
            prisoners: (0, 0),
            outcome: self.outcome,
            turn,
            rule: self.rule,
            handicap,
            history: Default::default(),
            ko_point: None,
        };

        // Moves to play
        for &m in &self.moves {
            g.play(m);
        }

        Ok(g)
    }

    pub fn build(&mut self) -> Result<Game, String> {
        let this = take(self);

        this.build_inner()
    }
}

impl Default for GameBuilder {
    fn default() -> Self {
        GameBuilder {
            size: (19, 19),
            black_player: "".to_string(),
            white_player: "".to_string(),
            handicap_points: vec![],
            rule: CHINESE,
            komi: None,
            turn: None,
            moves: vec![],
            outcome: None,
            setup: vec![],
            handicap: None,
        }
    }
}

impl Game {
    pub fn builder() -> GameBuilder {
        GameBuilder::default()
    }
}