Clean up position setup code
[stockfish] / src / position.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20
21 #if !defined(POSITION_H_INCLUDED)
22 #define POSITION_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include "bitboard.h"
29 #include "color.h"
30 #include "move.h"
31 #include "piece.h"
32 #include "square.h"
33 #include "value.h"
34
35
36 ////
37 //// Constants
38 ////
39
40 /// Maximum number of plies per game (220 should be enough, because the
41 /// maximum search depth is 100, and during position setup we reset the
42 /// move counter for every non-reversible move).
43 const int MaxGameLength = 220;
44
45
46 ////
47 //// Types
48 ////
49
50 /// struct checkInfo is initialized at c'tor time and keeps
51 /// info used to detect if a move gives check.
52
53 struct CheckInfo {
54
55     explicit CheckInfo(const Position&);
56
57     Bitboard dcCandidates;
58     Bitboard checkSq[8];
59     Square ksq;
60 };
61
62 /// Castle rights, encoded as bit fields
63
64 enum CastleRights {
65   CASTLES_NONE = 0,
66   WHITE_OO     = 1,
67   BLACK_OO     = 2,
68   WHITE_OOO    = 4,
69   BLACK_OOO    = 8,
70   ALL_CASTLES  = 15
71 };
72
73 /// Game phase
74 enum Phase {
75   PHASE_ENDGAME = 0,
76   PHASE_MIDGAME = 128
77 };
78
79
80 /// The StateInfo struct stores information we need to restore a Position
81 /// object to its previous state when we retract a move. Whenever a move
82 /// is made on the board (by calling Position::do_move), an StateInfo object
83 /// must be passed as a parameter.
84
85 struct StateInfo {
86   Key pawnKey, materialKey;
87   int castleRights, rule50, gamePly, pliesFromNull;
88   Square epSquare;
89   Score value;
90   Value npMaterial[2];
91
92   PieceType capturedType;
93   Key key;
94   Bitboard checkersBB;
95   StateInfo* previous;
96 };
97
98
99 /// The position data structure. A position consists of the following data:
100 ///
101 ///    * For each piece type, a bitboard representing the squares occupied
102 ///      by pieces of that type.
103 ///    * For each color, a bitboard representing the squares occupied by
104 ///      pieces of that color.
105 ///    * A bitboard of all occupied squares.
106 ///    * A bitboard of all checking pieces.
107 ///    * A 64-entry array of pieces, indexed by the squares of the board.
108 ///    * The current side to move.
109 ///    * Information about the castling rights for both sides.
110 ///    * The initial files of the kings and both pairs of rooks. This is
111 ///      used to implement the Chess960 castling rules.
112 ///    * The en passant square (which is SQ_NONE if no en passant capture is
113 ///      possible).
114 ///    * The squares of the kings for both sides.
115 ///    * Hash keys for the position itself, the current pawn structure, and
116 ///      the current material situation.
117 ///    * Hash keys for all previous positions in the game for detecting
118 ///      repetition draws.
119 ///    * A counter for detecting 50 move rule draws.
120
121 class Position {
122
123   friend class MaterialInfo;
124   friend class EndgameFunctions;
125
126   Position(); // No default or copy c'tor allowed
127   Position(const Position& pos);
128
129 public:
130   enum GamePhase {
131       MidGame,
132       EndGame
133   };
134
135   // Constructors
136   Position(const Position& pos, int threadID);
137   Position(const std::string& fen, bool isChess960, int threadID);
138
139   // Text input/output
140   void from_fen(const std::string& fen, bool isChess960);
141   const std::string to_fen() const;
142   void print(Move m = MOVE_NONE) const;
143
144   // Copying
145   void flipped_copy(const Position& pos);
146
147   // The piece on a given square
148   Piece piece_on(Square s) const;
149   PieceType type_of_piece_on(Square s) const;
150   Color color_of_piece_on(Square s) const;
151   bool square_is_empty(Square s) const;
152   bool square_is_occupied(Square s) const;
153   Value midgame_value_of_piece_on(Square s) const;
154   Value endgame_value_of_piece_on(Square s) const;
155
156   // Side to move
157   Color side_to_move() const;
158
159   // Bitboard representation of the position
160   Bitboard empty_squares() const;
161   Bitboard occupied_squares() const;
162   Bitboard pieces_of_color(Color c) const;
163   Bitboard pieces(PieceType pt) const;
164   Bitboard pieces(PieceType pt, Color c) const;
165   Bitboard pieces(PieceType pt1, PieceType pt2) const;
166   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
167
168   // Number of pieces of each color and type
169   int piece_count(Color c, PieceType pt) const;
170
171   // The en passant square
172   Square ep_square() const;
173
174   // Current king position for each color
175   Square king_square(Color c) const;
176
177   // Castling rights
178   bool can_castle_kingside(Color c) const;
179   bool can_castle_queenside(Color c) const;
180   bool can_castle(Color c) const;
181   Square initial_kr_square(Color c) const;
182   Square initial_qr_square(Color c) const;
183
184   // Bitboards for pinned pieces and discovered check candidates
185   Bitboard discovered_check_candidates(Color c) const;
186   Bitboard pinned_pieces(Color c) const;
187
188   // Checking pieces and under check information
189   Bitboard checkers() const;
190   bool is_check() const;
191
192   // Piece lists
193   Square piece_list(Color c, PieceType pt, int index) const;
194   const Square* piece_list_begin(Color c, PieceType pt) const;
195
196   // Information about attacks to or from a given square
197   Bitboard attackers_to(Square s) const;
198   Bitboard attacks_from(Piece p, Square s) const;
199   static Bitboard attacks_from(Piece p, Square s, Bitboard occ);
200   template<PieceType> Bitboard attacks_from(Square s) const;
201   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
202
203   // Properties of moves
204   bool pl_move_is_legal(Move m, Bitboard pinned) const;
205   bool pl_move_is_evasion(Move m, Bitboard pinned) const;
206   bool move_is_check(Move m) const;
207   bool move_is_check(Move m, const CheckInfo& ci) const;
208   bool move_is_capture(Move m) const;
209   bool move_is_capture_or_promotion(Move m) const;
210   bool move_is_passed_pawn_push(Move m) const;
211   bool move_attacks_square(Move m, Square s) const;
212
213   // Piece captured with previous moves
214   PieceType captured_piece_type() const;
215
216   // Information about pawns
217   bool pawn_is_passed(Color c, Square s) const;
218
219   // Weak squares
220   bool square_is_weak(Square s, Color c) const;
221
222   // Doing and undoing moves
223   void detach();
224   void do_setup_move(Move m, StateInfo& St);
225   void do_move(Move m, StateInfo& st);
226   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
227   void undo_move(Move m);
228   void do_null_move(StateInfo& st);
229   void undo_null_move();
230
231   // Static exchange evaluation
232   int see(Square from, Square to) const;
233   int see(Move m) const;
234   int see_sign(Move m) const;
235
236   // Accessing hash keys
237   Key get_key() const;
238   Key get_exclusion_key() const;
239   Key get_pawn_key() const;
240   Key get_material_key() const;
241
242   // Incremental evaluation
243   Score value() const;
244   Value non_pawn_material(Color c) const;
245   static Score pst_delta(Piece piece, Square from, Square to);
246
247   // Game termination checks
248   bool is_mate() const;
249   bool is_draw() const;
250
251   // Check if side to move could be mated in one
252   bool has_mate_threat();
253
254   // Number of plies from starting position
255   int startpos_ply_counter() const;
256
257   // Other properties of the position
258   bool opposite_colored_bishops() const;
259   bool has_pawn_on_7th(Color c) const;
260   bool is_chess960() const;
261
262   // Current thread ID searching on the position
263   int thread() const;
264
265   int64_t nodes_searched() const;
266   void set_nodes_searched(int64_t n);
267
268   // Position consistency check, for debugging
269   bool is_ok(int* failedStep = NULL) const;
270
271   // Static member functions
272   static void init_zobrist();
273   static void init_piece_square_tables();
274
275 private:
276
277   // Initialization helper functions (used while setting up a position)
278   void clear();
279   void put_piece(Piece p, Square s);
280   void do_allow_oo(Color c);
281   void do_allow_ooo(Color c);
282   bool set_castling_rights(char token);
283
284   // Helper functions for doing and undoing moves
285   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
286   void do_castle_move(Move m);
287   void undo_castle_move(Move m);
288   void find_checkers();
289
290   template<bool FindPinned>
291   Bitboard hidden_checkers(Color c) const;
292
293   // Computing hash keys from scratch (for initialization and debugging)
294   Key compute_key() const;
295   Key compute_pawn_key() const;
296   Key compute_material_key() const;
297
298   // Computing incremental evaluation scores and material counts
299   static Score pst(Color c, PieceType pt, Square s);
300   Score compute_value() const;
301   Value compute_non_pawn_material(Color c) const;
302
303   // Board
304   Piece board[64];
305
306   // Bitboards
307   Bitboard byTypeBB[8], byColorBB[2];
308
309   // Piece counts
310   int pieceCount[2][8]; // [color][pieceType]
311
312   // Piece lists
313   Square pieceList[2][8][16]; // [color][pieceType][index]
314   int index[64]; // [square]
315
316   // Other info
317   Color sideToMove;
318   Key history[MaxGameLength];
319   int castleRightsMask[64];
320   StateInfo startState;
321   File initialKFile, initialKRFile, initialQRFile;
322   bool isChess960;
323   int startPosPlyCounter;
324   int threadID;
325   int64_t nodes;
326   StateInfo* st;
327
328   // Static variables
329   static Key zobrist[2][8][64];
330   static Key zobEp[64];
331   static Key zobCastle[16];
332   static Key zobSideToMove;
333   static Score PieceSquareTable[16][64];
334   static Key zobExclusion;
335   static const Value seeValues[8];
336   static const Value PieceValueMidgame[17];
337   static const Value PieceValueEndgame[17];
338 };
339
340
341 ////
342 //// Inline functions
343 ////
344
345 inline int64_t Position::nodes_searched() const {
346   return nodes;
347 }
348
349 inline void Position::set_nodes_searched(int64_t n) {
350   nodes = n;
351 }
352
353 inline Piece Position::piece_on(Square s) const {
354   return board[s];
355 }
356
357 inline Color Position::color_of_piece_on(Square s) const {
358   return color_of_piece(piece_on(s));
359 }
360
361 inline PieceType Position::type_of_piece_on(Square s) const {
362   return type_of_piece(piece_on(s));
363 }
364
365 inline bool Position::square_is_empty(Square s) const {
366   return piece_on(s) == PIECE_NONE;
367 }
368
369 inline bool Position::square_is_occupied(Square s) const {
370   return !square_is_empty(s);
371 }
372
373 inline Value Position::midgame_value_of_piece_on(Square s) const {
374   return PieceValueMidgame[piece_on(s)];
375 }
376
377 inline Value Position::endgame_value_of_piece_on(Square s) const {
378   return PieceValueEndgame[piece_on(s)];
379 }
380
381 inline Color Position::side_to_move() const {
382   return sideToMove;
383 }
384
385 inline Bitboard Position::occupied_squares() const {
386   return byTypeBB[0];
387 }
388
389 inline Bitboard Position::empty_squares() const {
390   return ~occupied_squares();
391 }
392
393 inline Bitboard Position::pieces_of_color(Color c) const {
394   return byColorBB[c];
395 }
396
397 inline Bitboard Position::pieces(PieceType pt) const {
398   return byTypeBB[pt];
399 }
400
401 inline Bitboard Position::pieces(PieceType pt, Color c) const {
402   return byTypeBB[pt] & byColorBB[c];
403 }
404
405 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
406   return byTypeBB[pt1] | byTypeBB[pt2];
407 }
408
409 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
410   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
411 }
412
413 inline int Position::piece_count(Color c, PieceType pt) const {
414   return pieceCount[c][pt];
415 }
416
417 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
418   return pieceList[c][pt][idx];
419 }
420
421 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
422   return pieceList[c][pt];
423 }
424
425 inline Square Position::ep_square() const {
426   return st->epSquare;
427 }
428
429 inline Square Position::king_square(Color c) const {
430   return pieceList[c][KING][0];
431 }
432
433 inline bool Position::can_castle_kingside(Color side) const {
434   return st->castleRights & (1+int(side));
435 }
436
437 inline bool Position::can_castle_queenside(Color side) const {
438   return st->castleRights & (4+4*int(side));
439 }
440
441 inline bool Position::can_castle(Color side) const {
442   return can_castle_kingside(side) || can_castle_queenside(side);
443 }
444
445 inline Square Position::initial_kr_square(Color c) const {
446   return relative_square(c, make_square(initialKRFile, RANK_1));
447 }
448
449 inline Square Position::initial_qr_square(Color c) const {
450   return relative_square(c, make_square(initialQRFile, RANK_1));
451 }
452
453 template<>
454 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
455   return NonSlidingAttacksBB[piece_of_color_and_type(c, PAWN)][s];
456 }
457
458 template<PieceType Piece> // Knight and King and white pawns
459 inline Bitboard Position::attacks_from(Square s) const {
460   return NonSlidingAttacksBB[Piece][s];
461 }
462
463 template<>
464 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
465   return bishop_attacks_bb(s, occupied_squares());
466 }
467
468 template<>
469 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
470   return rook_attacks_bb(s, occupied_squares());
471 }
472
473 template<>
474 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
475   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
476 }
477
478 inline Bitboard Position::checkers() const {
479   return st->checkersBB;
480 }
481
482 inline bool Position::is_check() const {
483   return st->checkersBB != EmptyBoardBB;
484 }
485
486 inline bool Position::pawn_is_passed(Color c, Square s) const {
487   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
488 }
489
490 inline bool Position::square_is_weak(Square s, Color c) const {
491   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
492 }
493
494 inline Key Position::get_key() const {
495   return st->key;
496 }
497
498 inline Key Position::get_exclusion_key() const {
499   return st->key ^ zobExclusion;
500 }
501
502 inline Key Position::get_pawn_key() const {
503   return st->pawnKey;
504 }
505
506 inline Key Position::get_material_key() const {
507   return st->materialKey;
508 }
509
510 inline Score Position::pst(Color c, PieceType pt, Square s) {
511   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
512 }
513
514 inline Score Position::pst_delta(Piece piece, Square from, Square to) {
515   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
516 }
517
518 inline Score Position::value() const {
519   return st->value;
520 }
521
522 inline Value Position::non_pawn_material(Color c) const {
523   return st->npMaterial[c];
524 }
525
526 inline bool Position::move_is_passed_pawn_push(Move m) const {
527
528   Color c = side_to_move();
529   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
530         && pawn_is_passed(c, move_to(m));
531 }
532
533 inline int Position::startpos_ply_counter() const {
534   return startPosPlyCounter;
535 }
536
537 inline bool Position::opposite_colored_bishops() const {
538
539   return   piece_count(WHITE, BISHOP) == 1
540         && piece_count(BLACK, BISHOP) == 1
541         && !same_color_squares(piece_list(WHITE, BISHOP, 0), piece_list(BLACK, BISHOP, 0));
542 }
543
544 inline bool Position::has_pawn_on_7th(Color c) const {
545   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
546 }
547
548 inline bool Position::is_chess960() const {
549   return isChess960;
550 }
551
552 inline bool Position::move_is_capture(Move m) const {
553
554   // Move must not be MOVE_NONE !
555   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
556 }
557
558 inline bool Position::move_is_capture_or_promotion(Move m) const {
559
560   // Move must not be MOVE_NONE !
561   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
562 }
563
564 inline PieceType Position::captured_piece_type() const {
565   return st->capturedType;
566 }
567
568 inline int Position::thread() const {
569   return threadID;
570 }
571
572 inline void Position::do_allow_oo(Color c) {
573   st->castleRights |= (1 + int(c));
574 }
575
576 inline void Position::do_allow_ooo(Color c) {
577   st->castleRights |= (4 + 4*int(c));
578 }
579
580 #endif // !defined(POSITION_H_INCLUDED)