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