Unify undo_promotion_move()
[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-2009 Marco Costalba
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 // Disable some silly and noisy warning from MSVC compiler
25 #if defined(_MSC_VER)
26
27 // Forcing value to bool 'true' or 'false' (performance warning)
28 #pragma warning(disable: 4800)
29
30 // Conditional expression is constant
31 #pragma warning(disable: 4127)
32
33
34 #endif
35
36 ////
37 //// Includes
38 ////
39
40 #include "bitboard.h"
41 #include "color.h"
42 #include "direction.h"
43 #include "move.h"
44 #include "piece.h"
45 #include "square.h"
46 #include "value.h"
47
48
49 ////
50 //// Constants
51 ////
52
53 /// FEN string for the initial position
54 const std::string StartPosition = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
55
56 /// Maximum number of plies per game (220 should be enough, because the
57 /// maximum search depth is 100, and during position setup we reset the
58 /// move counter for every non-reversible move).
59 const int MaxGameLength = 220;
60
61
62 ////
63 //// Types
64 ////
65
66 /// Castle rights, encoded as bit fields
67
68 enum CastleRights {
69   NO_CASTLES  = 0,
70   WHITE_OO    = 1,
71   BLACK_OO    = 2,
72   WHITE_OOO   = 4,
73   BLACK_OOO   = 8,
74   ALL_CASTLES = 15
75 };
76
77 /// Game phase
78 enum Phase {
79   PHASE_ENDGAME = 0,
80   PHASE_MIDGAME = 128
81 };
82
83
84 /// The StateInfo struct stores information we need to restore a Position
85 /// object to its previous state when we retract a move. Whenever a move
86 /// is made on the board (by calling Position::do_move), an StateInfo object
87 /// must be passed as a parameter.
88
89 struct StateInfo {
90   Key key, pawnKey, materialKey;
91   int castleRights, rule50;
92   Square epSquare;
93   Value mgValue, egValue;
94   Value npMaterial[2];
95
96   PieceType capture;
97   Bitboard checkersBB;
98   StateInfo* previous;
99 };
100
101
102 /// The position data structure. A position consists of the following data:
103 ///
104 ///    * For each piece type, a bitboard representing the squares occupied
105 ///      by pieces of that type.
106 ///    * For each color, a bitboard representing the squares occupied by
107 ///      pieces of that color.
108 ///    * A bitboard of all occupied squares.
109 ///    * A bitboard of all checking pieces.
110 ///    * A 64-entry array of pieces, indexed by the squares of the board.
111 ///    * The current side to move.
112 ///    * Information about the castling rights for both sides.
113 ///    * The initial files of the kings and both pairs of rooks. This is
114 ///      used to implement the Chess960 castling rules.
115 ///    * The en passant square (which is SQ_NONE if no en passant capture is
116 ///      possible).
117 ///    * The squares of the kings for both sides.
118 ///    * Hash keys for the position itself, the current pawn structure, and
119 ///      the current material situation.
120 ///    * Hash keys for all previous positions in the game for detecting
121 ///      repetition draws.
122 ///    * A counter for detecting 50 move rule draws.
123
124 class Position {
125
126   friend class MaterialInfo;
127   friend class EndgameFunctions;
128
129 public:
130   enum GamePhase {
131       MidGame,
132       EndGame
133   };
134
135   // Constructors
136   Position() {};
137   Position(const Position& pos);
138   Position(const std::string& fen);
139
140   // Text input/output
141   void from_fen(const std::string& fen);
142   const std::string to_fen() const;
143   void print(Move m = MOVE_NONE) const;
144
145   // Copying
146   void copy(const Position& pos);
147   void flipped_copy(const Position& pos);
148
149   // The piece on a given square
150   Piece piece_on(Square s) const;
151   PieceType type_of_piece_on(Square s) const;
152   Color color_of_piece_on(Square s) const;
153   bool square_is_empty(Square s) const;
154   bool square_is_occupied(Square s) const;
155   Value midgame_value_of_piece_on(Square s) const;
156   Value endgame_value_of_piece_on(Square s) const;
157
158   // Side to move
159   Color side_to_move() const;
160
161   // Bitboard representation of the position
162   Bitboard empty_squares() const;
163   Bitboard occupied_squares() const;
164   Bitboard pieces_of_color(Color c) const;
165   Bitboard pieces_of_type(PieceType pt) const;
166   Bitboard pieces_of_color_and_type(Color c, PieceType pt) const;
167   Bitboard pawns() const;
168   Bitboard knights() const;
169   Bitboard bishops() const;
170   Bitboard rooks() const;
171   Bitboard queens() const;
172   Bitboard kings() const;
173   Bitboard rooks_and_queens() const;
174   Bitboard bishops_and_queens() const;
175   Bitboard sliders() const;
176   Bitboard pawns(Color c) const;
177   Bitboard knights(Color c) const;
178   Bitboard bishops(Color c) const;
179   Bitboard rooks(Color c) const;
180   Bitboard queens(Color c) const;
181   Bitboard kings(Color c) const;
182   Bitboard rooks_and_queens(Color c) const;
183   Bitboard bishops_and_queens(Color c) const;
184   Bitboard sliders_of_color(Color c) const;
185
186   // Number of pieces of each color and type
187   int piece_count(Color c, PieceType pt) const;
188
189   // The en passant square
190   Square ep_square() const;
191
192   // Current king position for each color
193   Square king_square(Color c) const;
194
195   // Castling rights
196   bool can_castle_kingside(Color c) const;
197   bool can_castle_queenside(Color c) const;
198   bool can_castle(Color c) const;
199   Square initial_kr_square(Color c) const;
200   Square initial_qr_square(Color c) const;
201
202   // Attack bitboards
203   Bitboard sliding_attacks(Square s, Direction d) const;
204   Bitboard ray_attacks(Square s, SignedDirection d) const;
205   Bitboard pawn_attacks(Color c, Square s) const;
206
207   template<PieceType>
208   Bitboard piece_attacks(Square s) const;
209
210   // Bitboards for pinned pieces and discovered check candidates
211   Bitboard discovered_check_candidates(Color c) const;
212   Bitboard pinned_pieces(Color c, Bitboard& p) const;
213   Bitboard pinned_pieces(Color c) const;
214
215   // Checking pieces
216   Bitboard checkers() const;
217
218   // Piece lists
219   Square piece_list(Color c, PieceType pt, int index) const;
220
221   // Attack information for a given square
222   bool square_is_attacked(Square s, Color c) const;
223   Bitboard attacks_to(Square s) const;
224   Bitboard attacks_to(Square s, Color c) const;
225   bool is_check() const;
226   bool pawn_attacks_square(Color c, Square f, Square t) const;
227
228   template<PieceType>
229   Bitboard piece_attacks_square(Square f, Square t) const; // Dispatch at compile-time
230
231   bool piece_attacks_square(Piece p, Square f, Square t) const; // Dispatch at run-time
232
233   // Properties of moves
234   bool pl_move_is_legal(Move m) const;
235   bool pl_move_is_legal(Move m, Bitboard pinned) const;
236   bool move_is_check(Move m) const;
237   bool move_is_check(Move m, Bitboard dcCandidates) const;
238   bool move_is_capture(Move m) const;
239   bool move_is_deep_pawn_push(Move m) const;
240   bool move_is_pawn_push_to_7th(Move m) const;
241   bool move_is_passed_pawn_push(Move m) const;
242   bool move_was_passed_pawn_push(Move m) const;
243   bool move_attacks_square(Move m, Square s) const;
244
245   // Information about pawns
246   bool pawn_is_passed(Color c, Square s) const;
247   static bool pawn_is_passed(Bitboard theirPawns, Color c, Square s);
248   static bool pawn_is_isolated(Bitboard ourPawns, Square s);
249   static bool pawn_is_doubled(Bitboard ourPawns, Color c, Square s);
250
251   // Weak squares
252   bool square_is_weak(Square s, Color c) const;
253
254   // Doing and undoing moves
255   void saveState();
256   void do_move(Move m, StateInfo& st);
257   void do_move(Move m, StateInfo& st, Bitboard dcCandidates);
258   void undo_move(Move m);
259   void do_null_move(StateInfo& st);
260   void undo_null_move();
261
262   // Static exchange evaluation
263   int see(Square from, Square to) const;
264   int see(Move m) const;
265   int see(Square to) const;
266   int see_sign(Move m) const;
267
268   // Accessing hash keys
269   Key get_key() const;
270   Key get_pawn_key() const;
271   Key get_material_key() const;
272
273   // Incremental evaluation
274   Value mg_value() const;
275   Value eg_value() const;
276   Value non_pawn_material(Color c) const;
277   Phase game_phase() const;
278   template<GamePhase> Value pst_delta(Piece piece, Square from, Square to) const;
279
280   // Game termination checks
281   bool is_mate() const;
282   bool is_draw() const;
283
284   // Check if one side threatens a mate in one
285   bool has_mate_threat(Color c);
286
287   // Number of plies since the last non-reversible move
288   int rule_50_counter() const;
289
290   // Other properties of the position
291   bool opposite_colored_bishops() const;
292   bool has_pawn_on_7th(Color c) const;
293
294   // Reset the gamePly variable to 0
295   void reset_game_ply();
296
297   // Position consistency check, for debugging
298   bool is_ok(int* failedStep = NULL) const;
299
300   // Static member functions:
301   static void init_zobrist();
302   static void init_piece_square_tables();
303
304 private:
305
306   // Initialization helper functions (used while setting up a position)
307   void clear();
308   void put_piece(Piece p, Square s);
309   void allow_oo(Color c);
310   void allow_ooo(Color c);
311
312   // Helper functions for doing and undoing moves
313   void do_capture_move(PieceType capture, Color them, Square to, bool ep);
314   void do_castle_move(Move m);
315   void undo_castle_move(Move m);
316   void undo_ep_move(Move m);
317   void find_checkers();
318
319   template<PieceType Piece>
320   void update_checkers(Bitboard* pCheckersBB, Square ksq, Square from, Square to, Bitboard dcCandidates);
321
322   template<bool FindPinned>
323   Bitboard hidden_checkers(Color c) const;
324
325   // Computing hash keys from scratch (for initialization and debugging)
326   Key compute_key() const;
327   Key compute_pawn_key() const;
328   Key compute_material_key() const;
329
330   // Computing incremental evaluation scores and material counts
331   template<GamePhase> Value pst(Color c, PieceType pt, Square s) const;
332   template<GamePhase> Value compute_value() const;
333   Value compute_non_pawn_material(Color c) const;
334
335   // Bitboards
336   Bitboard byColorBB[2], byTypeBB[8];
337
338   // Board
339   Piece board[64];
340
341   // Piece counts
342   int pieceCount[2][8]; // [color][pieceType]
343
344   // Piece lists
345   Square pieceList[2][8][16]; // [color][pieceType][index]
346   int index[64];
347
348   // Other info
349   Square kingSquare[2];
350   Color sideToMove;
351   int gamePly;
352   Key history[MaxGameLength];
353   File initialKFile, initialKRFile, initialQRFile;
354   StateInfo startState;
355   StateInfo* st;
356
357   // Static variables
358   static int castleRightsMask[64];
359   static Key zobrist[2][8][64];
360   static Key zobEp[64];
361   static Key zobCastle[16];
362   static Key zobMaterial[2][8][16];
363   static Key zobSideToMove;
364   static Value MgPieceSquareTable[16][64];
365   static Value EgPieceSquareTable[16][64];
366 };
367
368
369 ////
370 //// Inline functions
371 ////
372
373 inline Piece Position::piece_on(Square s) const {
374   return board[s];
375 }
376
377 inline Color Position::color_of_piece_on(Square s) const {
378   return color_of_piece(piece_on(s));
379 }
380
381 inline PieceType Position::type_of_piece_on(Square s) const {
382   return type_of_piece(piece_on(s));
383 }
384
385 inline bool Position::square_is_empty(Square s) const {
386   return piece_on(s) == EMPTY;
387 }
388
389 inline bool Position::square_is_occupied(Square s) const {
390   return !square_is_empty(s);
391 }
392
393 inline Value Position::midgame_value_of_piece_on(Square s) const {
394   return piece_value_midgame(piece_on(s));
395 }
396
397 inline Value Position::endgame_value_of_piece_on(Square s) const {
398   return piece_value_endgame(piece_on(s));
399 }
400
401 inline Color Position::side_to_move() const {
402   return sideToMove;
403 }
404
405 inline Bitboard Position::occupied_squares() const {
406   return byTypeBB[0];
407 }
408
409 inline Bitboard Position::empty_squares() const {
410   return ~(occupied_squares());
411 }
412
413 inline Bitboard Position::pieces_of_color(Color c) const {
414   return byColorBB[c];
415 }
416
417 inline Bitboard Position::pieces_of_type(PieceType pt) const {
418   return byTypeBB[pt];
419 }
420
421 inline Bitboard Position::pieces_of_color_and_type(Color c, PieceType pt) const {
422   return pieces_of_color(c) & pieces_of_type(pt);
423 }
424
425 inline Bitboard Position::pawns() const {
426   return pieces_of_type(PAWN);
427 }
428
429 inline Bitboard Position::knights() const {
430   return pieces_of_type(KNIGHT);
431 }
432
433 inline Bitboard Position::bishops() const {
434   return pieces_of_type(BISHOP);
435 }
436
437 inline Bitboard Position::rooks() const {
438   return pieces_of_type(ROOK);
439 }
440
441 inline Bitboard Position::queens() const {
442   return pieces_of_type(QUEEN);
443 }
444
445 inline Bitboard Position::kings() const {
446   return pieces_of_type(KING);
447 }
448
449 inline Bitboard Position::rooks_and_queens() const {
450   return rooks() | queens();
451 }
452
453 inline Bitboard Position::bishops_and_queens() const {
454   return bishops() | queens();
455 }
456
457 inline Bitboard Position::sliders() const {
458   return bishops() | queens() | rooks();
459 }
460
461 inline Bitboard Position::pawns(Color c) const {
462   return pieces_of_color_and_type(c, PAWN);
463 }
464
465 inline Bitboard Position::knights(Color c) const {
466   return pieces_of_color_and_type(c, KNIGHT);
467 }
468
469 inline Bitboard Position::bishops(Color c) const {
470   return pieces_of_color_and_type(c, BISHOP);
471 }
472
473 inline Bitboard Position::rooks(Color c) const {
474   return pieces_of_color_and_type(c, ROOK);
475 }
476
477 inline Bitboard Position::queens(Color c) const {
478   return pieces_of_color_and_type(c, QUEEN);
479 }
480
481 inline Bitboard Position::kings(Color c) const {
482   return pieces_of_color_and_type(c, KING);
483 }
484
485 inline Bitboard Position::rooks_and_queens(Color c) const {
486   return rooks_and_queens() & pieces_of_color(c);
487 }
488
489 inline Bitboard Position::bishops_and_queens(Color c) const {
490   return bishops_and_queens() & pieces_of_color(c);
491 }
492
493 inline int Position::piece_count(Color c, PieceType pt) const {
494   return pieceCount[c][pt];
495 }
496
497 inline Square Position::piece_list(Color c, PieceType pt, int index) const {
498   return pieceList[c][pt][index];
499 }
500
501 inline Square Position::ep_square() const {
502   return st->epSquare;
503 }
504
505 inline Square Position::king_square(Color c) const {
506   return kingSquare[c];
507 }
508
509 inline bool Position::can_castle_kingside(Color side) const {
510   return st->castleRights & (1+int(side));
511 }
512
513 inline bool Position::can_castle_queenside(Color side) const {
514   return st->castleRights & (4+4*int(side));
515 }
516
517 inline bool Position::can_castle(Color side) const {
518   return can_castle_kingside(side) || can_castle_queenside(side);
519 }
520
521 inline Square Position::initial_kr_square(Color c) const {
522   return relative_square(c, make_square(initialKRFile, RANK_1));
523 }
524
525 inline Square Position::initial_qr_square(Color c) const {
526   return relative_square(c, make_square(initialQRFile, RANK_1));
527 }
528
529 inline Bitboard Position::pawn_attacks(Color c, Square s) const {
530   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
531 }
532
533 template<PieceType Piece> // Knight and King
534 inline Bitboard Position::piece_attacks(Square s) const {
535   return StepAttackBB[Piece][s];
536 }
537
538 template<>
539 inline Bitboard Position::piece_attacks<PAWN>(Square s) const {
540   return StepAttackBB[piece_of_color_and_type(opposite_color(sideToMove), PAWN)][s];
541 }
542
543 template<>
544 inline Bitboard Position::piece_attacks<BISHOP>(Square s) const {
545   return bishop_attacks_bb(s, occupied_squares());
546 }
547
548 template<>
549 inline Bitboard Position::piece_attacks<ROOK>(Square s) const {
550   return rook_attacks_bb(s, occupied_squares());
551 }
552
553 template<>
554 inline Bitboard Position::piece_attacks<QUEEN>(Square s) const {
555   return piece_attacks<ROOK>(s) | piece_attacks<BISHOP>(s);
556 }
557
558 inline Bitboard Position::checkers() const {
559   return st->checkersBB;
560 }
561
562 inline bool Position::is_check() const {
563   return st->checkersBB != EmptyBoardBB;
564 }
565
566 inline bool Position::pawn_attacks_square(Color c, Square f, Square t) const {
567   return bit_is_set(pawn_attacks(c, f), t);
568 }
569
570 template<PieceType Piece>
571 Bitboard Position::piece_attacks_square(Square f, Square t) const {
572   return bit_is_set(piece_attacks<Piece>(f), t);
573 }
574
575 inline Bitboard Position::attacks_to(Square s, Color c) const {
576
577   return attacks_to(s) & pieces_of_color(c);
578 }
579
580 inline bool Position::square_is_attacked(Square s, Color c) const {
581
582   return attacks_to(s, c) != EmptyBoardBB;
583 }
584
585 inline bool Position::pawn_is_passed(Color c, Square s) const {
586   return !(pawns(opposite_color(c)) & passed_pawn_mask(c, s));
587 }
588
589 inline bool Position::pawn_is_passed(Bitboard theirPawns, Color c, Square s) {
590   return !(theirPawns & passed_pawn_mask(c, s));
591 }
592
593 inline bool Position::pawn_is_isolated(Bitboard ourPawns, Square s) {
594   return !(ourPawns & neighboring_files_bb(s));
595 }
596
597 inline bool Position::pawn_is_doubled(Bitboard ourPawns, Color c, Square s) {
598   return ourPawns & squares_behind(c, s);
599 }
600
601 inline bool Position::square_is_weak(Square s, Color c) const {
602   return !(pawns(c) & outpost_mask(opposite_color(c), s));
603 }
604
605 inline Key Position::get_key() const {
606   return st->key;
607 }
608
609 inline Key Position::get_pawn_key() const {
610   return st->pawnKey;
611 }
612
613 inline Key Position::get_material_key() const {
614   return st->materialKey;
615 }
616
617 template<Position::GamePhase Ph>
618 inline Value Position::pst(Color c, PieceType pt, Square s) const {
619   return (Ph == MidGame ? MgPieceSquareTable[piece_of_color_and_type(c, pt)][s]
620                         : EgPieceSquareTable[piece_of_color_and_type(c, pt)][s]);
621 }
622
623 template<Position::GamePhase Ph>
624 inline Value Position::pst_delta(Piece piece, Square from, Square to) const {
625   return (Ph == MidGame ? MgPieceSquareTable[piece][to] - MgPieceSquareTable[piece][from]
626                         : EgPieceSquareTable[piece][to] - EgPieceSquareTable[piece][from]);
627 }
628
629 inline Value Position::mg_value() const {
630   return st->mgValue;
631 }
632
633 inline Value Position::eg_value() const {
634   return st->egValue;
635 }
636
637 inline Value Position::non_pawn_material(Color c) const {
638   return st->npMaterial[c];
639 }
640
641 inline Phase Position::game_phase() const {
642
643   // Values modified by Joona Kiiski
644   static const Value MidgameLimit = Value(15581);
645   static const Value EndgameLimit = Value(3998);
646
647   Value npm = non_pawn_material(WHITE) + non_pawn_material(BLACK);
648
649   if (npm >= MidgameLimit)
650       return PHASE_MIDGAME;
651   else if(npm <= EndgameLimit)
652       return PHASE_ENDGAME;
653   else
654       return Phase(((npm - EndgameLimit) * 128) / (MidgameLimit - EndgameLimit));
655 }
656
657 inline bool Position::move_is_deep_pawn_push(Move m) const {
658
659   Color c = side_to_move();
660   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
661         && relative_rank(c, move_to(m)) > RANK_4;
662 }
663
664 inline bool Position::move_is_pawn_push_to_7th(Move m) const {
665
666   Color c = side_to_move();
667   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
668         && relative_rank(c, move_to(m)) == RANK_7;
669 }
670
671 inline bool Position::move_is_passed_pawn_push(Move m) const {
672
673   Color c = side_to_move();
674   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
675         && pawn_is_passed(c, move_to(m));
676 }
677
678 inline bool Position::move_was_passed_pawn_push(Move m) const {
679
680   Color c = opposite_color(side_to_move());
681   return   piece_on(move_to(m)) == piece_of_color_and_type(c, PAWN)
682         && pawn_is_passed(c, move_to(m));
683 }
684
685 inline int Position::rule_50_counter() const {
686
687   return st->rule50;
688 }
689
690 inline bool Position::opposite_colored_bishops() const {
691
692   return   piece_count(WHITE, BISHOP) == 1
693         && piece_count(BLACK, BISHOP) == 1
694         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
695 }
696
697 inline bool Position::has_pawn_on_7th(Color c) const {
698
699   return pawns(c) & relative_rank_bb(c, RANK_7);
700 }
701
702 inline bool Position::move_is_capture(Move m) const {
703
704   // Move must not be MOVE_NONE !
705
706   return (!square_is_empty(move_to(m)) && !move_is_castle(m)) || move_is_ep(m);
707 }
708
709 #endif // !defined(POSITION_H_INCLUDED)