]> git.sesse.net Git - stockfish/blob - src/position.cpp
Clean up API for attack information
[stockfish] / src / position.cpp
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 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cstring>
27 #include <fstream>
28 #include <iostream>
29
30 #include "bitcount.h"
31 #include "mersenne.h"
32 #include "movegen.h"
33 #include "movepick.h"
34 #include "position.h"
35 #include "psqtab.h"
36 #include "san.h"
37 #include "tt.h"
38 #include "ucioption.h"
39
40 using std::string;
41
42
43 ////
44 //// Variables
45 ////
46
47 int Position::castleRightsMask[64];
48
49 Key Position::zobrist[2][8][64];
50 Key Position::zobEp[64];
51 Key Position::zobCastle[16];
52 Key Position::zobMaterial[2][8][16];
53 Key Position::zobSideToMove;
54
55 Value Position::MgPieceSquareTable[16][64];
56 Value Position::EgPieceSquareTable[16][64];
57
58 static bool RequestPending = false;
59
60 ////
61 //// Functions
62 ////
63
64 /// Constructors
65
66 Position::Position(const Position& pos) {
67   copy(pos);
68 }
69
70 Position::Position(const string& fen) {
71   from_fen(fen);
72 }
73
74
75 /// Position::from_fen() initializes the position object with the given FEN
76 /// string. This function is not very robust - make sure that input FENs are
77 /// correct (this is assumed to be the responsibility of the GUI).
78
79 void Position::from_fen(const string& fen) {
80
81   static const string pieceLetters = "KQRBNPkqrbnp";
82   static const Piece pieces[] = { WK, WQ, WR, WB, WN, WP, BK, BQ, BR, BB, BN, BP };
83
84   clear();
85
86   // Board
87   Rank rank = RANK_8;
88   File file = FILE_A;
89   size_t i = 0;
90   for ( ; fen[i] != ' '; i++)
91   {
92       if (isdigit(fen[i]))
93       {
94           // Skip the given number of files
95           file += (fen[i] - '1' + 1);
96           continue;
97       }
98       else if (fen[i] == '/')
99       {
100           file = FILE_A;
101           rank--;
102           continue;
103       }
104       size_t idx = pieceLetters.find(fen[i]);
105       if (idx == string::npos)
106       {
107            std::cout << "Error in FEN at character " << i << std::endl;
108            return;
109       }
110       Square square = make_square(file, rank);
111       put_piece(pieces[idx], square);
112       file++;
113   }
114
115   // Side to move
116   i++;
117   if (fen[i] != 'w' && fen[i] != 'b')
118   {
119       std::cout << "Error in FEN at character " << i << std::endl;
120       return;
121   }
122   sideToMove = (fen[i] == 'w' ? WHITE : BLACK);
123
124   // Castling rights
125   i++;
126   if (fen[i] != ' ')
127   {
128       std::cout << "Error in FEN at character " << i << std::endl;
129       return;
130   }
131
132   i++;
133   while(strchr("KQkqabcdefghABCDEFGH-", fen[i])) {
134     if (fen[i] == '-')
135     {
136       i++;
137       break;
138     }
139     else if(fen[i] == 'K') allow_oo(WHITE);
140     else if(fen[i] == 'Q') allow_ooo(WHITE);
141     else if(fen[i] == 'k') allow_oo(BLACK);
142     else if(fen[i] == 'q') allow_ooo(BLACK);
143     else if(fen[i] >= 'A' && fen[i] <= 'H') {
144       File rookFile, kingFile = FILE_NONE;
145       for(Square square = SQ_B1; square <= SQ_G1; square++)
146         if(piece_on(square) == WK)
147           kingFile = square_file(square);
148       if(kingFile == FILE_NONE) {
149         std::cout << "Error in FEN at character " << i << std::endl;
150         return;
151       }
152       initialKFile = kingFile;
153       rookFile = File(fen[i] - 'A') + FILE_A;
154       if(rookFile < initialKFile) {
155         allow_ooo(WHITE);
156         initialQRFile = rookFile;
157       }
158       else {
159         allow_oo(WHITE);
160         initialKRFile = rookFile;
161       }
162     }
163     else if(fen[i] >= 'a' && fen[i] <= 'h') {
164       File rookFile, kingFile = FILE_NONE;
165       for(Square square = SQ_B8; square <= SQ_G8; square++)
166         if(piece_on(square) == BK)
167           kingFile = square_file(square);
168       if(kingFile == FILE_NONE) {
169         std::cout << "Error in FEN at character " << i << std::endl;
170         return;
171       }
172       initialKFile = kingFile;
173       rookFile = File(fen[i] - 'a') + FILE_A;
174       if(rookFile < initialKFile) {
175         allow_ooo(BLACK);
176         initialQRFile = rookFile;
177       }
178       else {
179         allow_oo(BLACK);
180         initialKRFile = rookFile;
181       }
182     }
183     else {
184       std::cout << "Error in FEN at character " << i << std::endl;
185       return;
186     }
187     i++;
188   }
189
190   // Skip blanks
191   while (fen[i] == ' ')
192       i++;
193
194   // En passant square
195   if (    i <= fen.length() - 2
196       && (fen[i] >= 'a' && fen[i] <= 'h')
197       && (fen[i+1] == '3' || fen[i+1] == '6'))
198       st->epSquare = square_from_string(fen.substr(i, 2));
199
200   // Various initialisation
201   for (Square sq = SQ_A1; sq <= SQ_H8; sq++)
202       castleRightsMask[sq] = ALL_CASTLES;
203
204   castleRightsMask[make_square(initialKFile,  RANK_1)] ^= (WHITE_OO|WHITE_OOO);
205   castleRightsMask[make_square(initialKFile,  RANK_8)] ^= (BLACK_OO|BLACK_OOO);
206   castleRightsMask[make_square(initialKRFile, RANK_1)] ^= WHITE_OO;
207   castleRightsMask[make_square(initialKRFile, RANK_8)] ^= BLACK_OO;
208   castleRightsMask[make_square(initialQRFile, RANK_1)] ^= WHITE_OOO;
209   castleRightsMask[make_square(initialQRFile, RANK_8)] ^= BLACK_OOO;
210
211   find_checkers();
212
213   st->key = compute_key();
214   st->pawnKey = compute_pawn_key();
215   st->materialKey = compute_material_key();
216   st->mgValue = compute_value<MidGame>();
217   st->egValue = compute_value<EndGame>();
218   st->npMaterial[WHITE] = compute_non_pawn_material(WHITE);
219   st->npMaterial[BLACK] = compute_non_pawn_material(BLACK);
220 }
221
222
223 /// Position::to_fen() converts the position object to a FEN string. This is
224 /// probably only useful for debugging.
225
226 const string Position::to_fen() const {
227
228   static const string pieceLetters = " PNBRQK  pnbrqk";
229   string fen;
230   int skip;
231
232   for (Rank rank = RANK_8; rank >= RANK_1; rank--)
233   {
234       skip = 0;
235       for (File file = FILE_A; file <= FILE_H; file++)
236       {
237           Square sq = make_square(file, rank);
238           if (!square_is_occupied(sq))
239           {   skip++;
240               continue;
241           }
242           if (skip > 0)
243           {
244               fen += (char)skip + '0';
245               skip = 0;
246           }
247           fen += pieceLetters[piece_on(sq)];
248       }
249       if (skip > 0)
250           fen += (char)skip + '0';
251
252       fen += (rank > RANK_1 ? '/' : ' ');
253   }
254   fen += (sideToMove == WHITE ? "w " : "b ");
255   if (st->castleRights != NO_CASTLES)
256   {
257     if (can_castle_kingside(WHITE))  fen += 'K';
258     if (can_castle_queenside(WHITE)) fen += 'Q';
259     if (can_castle_kingside(BLACK))  fen += 'k';
260     if (can_castle_queenside(BLACK)) fen += 'q';
261   } else
262       fen += '-';
263
264   fen += ' ';
265   if (ep_square() != SQ_NONE)
266       fen += square_to_string(ep_square());
267   else
268       fen += '-';
269
270   return fen;
271 }
272
273
274 /// Position::print() prints an ASCII representation of the position to
275 /// the standard output. If a move is given then also the san is print.
276
277 void Position::print(Move m) const {
278
279   static const string pieceLetters = " PNBRQK  PNBRQK .";
280
281   // Check for reentrancy, as example when called from inside
282   // MovePicker that is used also here in move_to_san()
283   if (RequestPending)
284       return;
285
286   RequestPending = true;
287
288   std::cout << std::endl;
289   if (m != MOVE_NONE)
290   {
291       string col = (color_of_piece_on(move_from(m)) == BLACK ? ".." : "");
292       std::cout << "Move is: " << col << move_to_san(*this, m) << std::endl;
293   }
294   for (Rank rank = RANK_8; rank >= RANK_1; rank--)
295   {
296       std::cout << "+---+---+---+---+---+---+---+---+" << std::endl;
297       for (File file = FILE_A; file <= FILE_H; file++)
298       {
299           Square sq = make_square(file, rank);
300           Piece piece = piece_on(sq);
301           if (piece == EMPTY && square_color(sq) == WHITE)
302               piece = NO_PIECE;
303
304           char col = (color_of_piece_on(sq) == BLACK ? '=' : ' ');
305           std::cout << '|' << col << pieceLetters[piece] << col;
306       }
307       std::cout << '|' << std::endl;
308   }
309   std::cout << "+---+---+---+---+---+---+---+---+" << std::endl
310             << "Fen is: " << to_fen() << std::endl
311             << "Key is: " << st->key << std::endl;
312
313   RequestPending = false;
314 }
315
316
317 /// Position::copy() creates a copy of the input position.
318
319 void Position::copy(const Position& pos) {
320
321   memcpy(this, &pos, sizeof(Position));
322   saveState(); // detach and copy state info
323 }
324
325
326 /// Position:hidden_checkers<>() returns a bitboard of all pinned (against the
327 /// king) pieces for the given color and for the given pinner type. Or, when
328 /// template parameter FindPinned is false, the pieces of the given color
329 /// candidate for a discovery check against the enemy king.
330 /// Note that checkersBB bitboard must be already updated.
331
332 template<bool FindPinned>
333 Bitboard Position::hidden_checkers(Color c) const {
334
335   Bitboard pinners, result = EmptyBoardBB;
336
337   // Pinned pieces protect our king, dicovery checks attack
338   // the enemy king.
339   Square ksq = king_square(FindPinned ? c : opposite_color(c));
340
341   // Pinners are sliders, not checkers, that give check when
342   // candidate pinned is removed.
343   pinners =  (pieces(ROOK, QUEEN, FindPinned ? opposite_color(c) : c) & RookPseudoAttacks[ksq])
344            | (pieces(BISHOP, QUEEN, FindPinned ? opposite_color(c) : c) & BishopPseudoAttacks[ksq]);
345
346   if (FindPinned && pinners)
347       pinners &= ~st->checkersBB;
348
349   while (pinners)
350   {
351       Square s = pop_1st_bit(&pinners);
352       Bitboard b = squares_between(s, ksq) & occupied_squares();
353
354       assert(b);
355
356       if (  !(b & (b - 1)) // Only one bit set?
357           && (b & pieces_of_color(c))) // Is an our piece?
358           result |= b;
359   }
360   return result;
361 }
362
363
364 /// Position:pinned_pieces() returns a bitboard of all pinned (against the
365 /// king) pieces for the given color.
366
367 Bitboard Position::pinned_pieces(Color c) const {
368
369   return hidden_checkers<true>(c);
370 }
371
372
373 /// Position:discovered_check_candidates() returns a bitboard containing all
374 /// pieces for the given side which are candidates for giving a discovered
375 /// check.
376
377 Bitboard Position::discovered_check_candidates(Color c) const {
378
379   return hidden_checkers<false>(c);
380 }
381
382 /// Position::attacks_to() computes a bitboard containing all pieces which
383 /// attacks a given square.
384
385 Bitboard Position::attacks_to(Square s) const {
386
387   return  (pawn_attacks(BLACK, s)   & pieces(PAWN, WHITE))
388         | (pawn_attacks(WHITE, s)   & pieces(PAWN, BLACK))
389         | (piece_attacks<KNIGHT>(s) & pieces(KNIGHT))
390         | (piece_attacks<ROOK>(s)   & pieces(ROOK, QUEEN))
391         | (piece_attacks<BISHOP>(s) & pieces(BISHOP, QUEEN))
392         | (piece_attacks<KING>(s)   & pieces(KING));
393 }
394
395 /// Position::piece_attacks_square() tests whether the piece on square f
396 /// attacks square t.
397
398 bool Position::piece_attacks_square(Piece p, Square f, Square t) const {
399
400   assert(square_is_ok(f));
401   assert(square_is_ok(t));
402
403   switch (p)
404   {
405   case WP:          return pawn_attacks_square(WHITE, f, t);
406   case BP:          return pawn_attacks_square(BLACK, f, t);
407   case WN: case BN: return piece_attacks_square<KNIGHT>(f, t);
408   case WB: case BB: return piece_attacks_square<BISHOP>(f, t);
409   case WR: case BR: return piece_attacks_square<ROOK>(f, t);
410   case WQ: case BQ: return piece_attacks_square<QUEEN>(f, t);
411   case WK: case BK: return piece_attacks_square<KING>(f, t);
412   default: break;
413   }
414   return false;
415 }
416
417
418 /// Position::move_attacks_square() tests whether a move from the current
419 /// position attacks a given square.
420
421 bool Position::move_attacks_square(Move m, Square s) const {
422
423   assert(move_is_ok(m));
424   assert(square_is_ok(s));
425
426   Square f = move_from(m), t = move_to(m);
427
428   assert(square_is_occupied(f));
429
430   if (piece_attacks_square(piece_on(f), t, s))
431       return true;
432
433   // Move the piece and scan for X-ray attacks behind it
434   Bitboard occ = occupied_squares();
435   Color us = color_of_piece_on(f);
436   clear_bit(&occ, f);
437   set_bit(&occ, t);
438   Bitboard xray = ( (rook_attacks_bb(s, occ) &  pieces(ROOK, QUEEN))
439                    |(bishop_attacks_bb(s, occ) & pieces(BISHOP, QUEEN))) & pieces_of_color(us);
440
441   // If we have attacks we need to verify that are caused by our move
442   // and are not already existent ones.
443   return xray && (xray ^ (xray & piece_attacks<QUEEN>(s)));
444 }
445
446
447 /// Position::find_checkers() computes the checkersBB bitboard, which
448 /// contains a nonzero bit for each checking piece (0, 1 or 2). It
449 /// currently works by calling Position::attacks_to, which is probably
450 /// inefficient. Consider rewriting this function to use the last move
451 /// played, like in non-bitboard versions of Glaurung.
452
453 void Position::find_checkers() {
454
455   Color us = side_to_move();
456   st->checkersBB = attacks_to(king_square(us), opposite_color(us));
457 }
458
459
460 /// Position::pl_move_is_legal() tests whether a pseudo-legal move is legal
461
462 bool Position::pl_move_is_legal(Move m) const {
463
464   // If we're in check, all pseudo-legal moves are legal, because our
465   // check evasion generator only generates true legal moves.
466   return is_check() || pl_move_is_legal(m, pinned_pieces(side_to_move()));
467 }
468
469 bool Position::pl_move_is_legal(Move m, Bitboard pinned) const {
470
471   assert(is_ok());
472   assert(move_is_ok(m));
473   assert(pinned == pinned_pieces(side_to_move()));
474   assert(!is_check());
475
476   // Castling moves are checked for legality during move generation.
477   if (move_is_castle(m))
478       return true;
479
480   Color us = side_to_move();
481   Square from = move_from(m);
482
483   assert(color_of_piece_on(from) == us);
484   assert(piece_on(king_square(us)) == piece_of_color_and_type(us, KING));
485
486   // En passant captures are a tricky special case.  Because they are
487   // rather uncommon, we do it simply by testing whether the king is attacked
488   // after the move is made
489   if (move_is_ep(m))
490   {
491       Color them = opposite_color(us);
492       Square to = move_to(m);
493       Square capsq = make_square(square_file(to), square_rank(from));
494       Bitboard b = occupied_squares();
495       Square ksq = king_square(us);
496
497       assert(to == ep_square());
498       assert(piece_on(from) == piece_of_color_and_type(us, PAWN));
499       assert(piece_on(capsq) == piece_of_color_and_type(them, PAWN));
500       assert(piece_on(to) == EMPTY);
501
502       clear_bit(&b, from);
503       clear_bit(&b, capsq);
504       set_bit(&b, to);
505
506       return   !(rook_attacks_bb(ksq, b) & pieces(ROOK, QUEEN, them))
507             && !(bishop_attacks_bb(ksq, b) & pieces(BISHOP, QUEEN, them));
508   }
509
510   // If the moving piece is a king, check whether the destination
511   // square is attacked by the opponent.
512   if (type_of_piece_on(from) == KING)
513       return !attacks_to(move_to(m), opposite_color(us));
514
515   // A non-king move is legal if and only if it is not pinned or it
516   // is moving along the ray towards or away from the king.
517   return (   !pinned
518           || !bit_is_set(pinned, from)
519           || (direction_between_squares(from, king_square(us)) == direction_between_squares(move_to(m), king_square(us))));
520 }
521
522
523 /// Position::move_is_check() tests whether a pseudo-legal move is a check
524
525 bool Position::move_is_check(Move m) const {
526
527   Bitboard dc = discovered_check_candidates(side_to_move());
528   return move_is_check(m, dc);
529 }
530
531 bool Position::move_is_check(Move m, Bitboard dcCandidates) const {
532
533   assert(is_ok());
534   assert(move_is_ok(m));
535   assert(dcCandidates == discovered_check_candidates(side_to_move()));
536
537   Color us = side_to_move();
538   Color them = opposite_color(us);
539   Square from = move_from(m);
540   Square to = move_to(m);
541   Square ksq = king_square(them);
542
543   assert(color_of_piece_on(from) == us);
544   assert(piece_on(ksq) == piece_of_color_and_type(them, KING));
545
546   // Proceed according to the type of the moving piece
547   switch (type_of_piece_on(from))
548   {
549   case PAWN:
550
551       if (bit_is_set(pawn_attacks(them, ksq), to)) // Normal check?
552           return true;
553
554       if (   dcCandidates // Discovered check?
555           && bit_is_set(dcCandidates, from)
556           && (direction_between_squares(from, ksq) != direction_between_squares(to, ksq)))
557           return true;
558
559       if (move_is_promotion(m)) // Promotion with check?
560       {
561           Bitboard b = occupied_squares();
562           clear_bit(&b, from);
563
564           switch (move_promotion_piece(m))
565           {
566           case KNIGHT:
567               return bit_is_set(piece_attacks<KNIGHT>(to), ksq);
568           case BISHOP:
569               return bit_is_set(bishop_attacks_bb(to, b), ksq);
570           case ROOK:
571               return bit_is_set(rook_attacks_bb(to, b), ksq);
572           case QUEEN:
573               return bit_is_set(queen_attacks_bb(to, b), ksq);
574           default:
575               assert(false);
576           }
577       }
578       // En passant capture with check?  We have already handled the case
579       // of direct checks and ordinary discovered check, the only case we
580       // need to handle is the unusual case of a discovered check through the
581       // captured pawn.
582       else if (move_is_ep(m))
583       {
584           Square capsq = make_square(square_file(to), square_rank(from));
585           Bitboard b = occupied_squares();
586           clear_bit(&b, from);
587           clear_bit(&b, capsq);
588           set_bit(&b, to);
589           return  (rook_attacks_bb(ksq, b) & pieces(ROOK, QUEEN, us))
590                 ||(bishop_attacks_bb(ksq, b) & pieces(BISHOP, QUEEN, us));
591       }
592       return false;
593
594   // Test discovered check and normal check according to piece type
595   case KNIGHT:
596     return   (dcCandidates && bit_is_set(dcCandidates, from))
597           || bit_is_set(piece_attacks<KNIGHT>(ksq), to);
598
599   case BISHOP:
600     return   (dcCandidates && bit_is_set(dcCandidates, from))
601           || (direction_is_diagonal(ksq, to) && bit_is_set(piece_attacks<BISHOP>(ksq), to));
602
603   case ROOK:
604     return   (dcCandidates && bit_is_set(dcCandidates, from))
605           || (direction_is_straight(ksq, to) && bit_is_set(piece_attacks<ROOK>(ksq), to));
606
607   case QUEEN:
608       // Discovered checks are impossible!
609       assert(!bit_is_set(dcCandidates, from));
610       return (   (direction_is_straight(ksq, to) && bit_is_set(piece_attacks<ROOK>(ksq), to))
611               || (direction_is_diagonal(ksq, to) && bit_is_set(piece_attacks<BISHOP>(ksq), to)));
612
613   case KING:
614       // Discovered check?
615       if (   bit_is_set(dcCandidates, from)
616           && (direction_between_squares(from, ksq) != direction_between_squares(to, ksq)))
617           return true;
618
619       // Castling with check?
620       if (move_is_castle(m))
621       {
622           Square kfrom, kto, rfrom, rto;
623           Bitboard b = occupied_squares();
624           kfrom = from;
625           rfrom = to;
626
627           if (rfrom > kfrom)
628           {
629               kto = relative_square(us, SQ_G1);
630               rto = relative_square(us, SQ_F1);
631           } else {
632               kto = relative_square(us, SQ_C1);
633               rto = relative_square(us, SQ_D1);
634           }
635           clear_bit(&b, kfrom);
636           clear_bit(&b, rfrom);
637           set_bit(&b, rto);
638           set_bit(&b, kto);
639           return bit_is_set(rook_attacks_bb(rto, b), ksq);
640       }
641       return false;
642
643   default: // NO_PIECE_TYPE
644       break;
645   }
646   assert(false);
647   return false;
648 }
649
650
651 /// Position::update_checkers() udpates chekers info given the move. It is called
652 /// in do_move() and is faster then find_checkers().
653
654 template<PieceType Piece>
655 inline void Position::update_checkers(Bitboard* pCheckersBB, Square ksq, Square from,
656                                       Square to, Bitboard dcCandidates) {
657
658   const bool Bishop = (Piece == QUEEN || Piece == BISHOP);
659   const bool Rook   = (Piece == QUEEN || Piece == ROOK);
660   const bool Slider = Bishop || Rook;
661
662   // Direct checks
663   if (  (   (Bishop && bit_is_set(BishopPseudoAttacks[ksq], to))
664          || (Rook   && bit_is_set(RookPseudoAttacks[ksq], to)))
665       && bit_is_set(piece_attacks<Piece>(ksq), to)) // slow, try to early skip
666       set_bit(pCheckersBB, to);
667
668   else if (   Piece != KING
669            && !Slider
670            && bit_is_set(Piece == PAWN ? pawn_attacks(opposite_color(sideToMove), ksq) : piece_attacks<Piece>(ksq), to))
671       set_bit(pCheckersBB, to);
672
673   // Discovery checks
674   if (Piece != QUEEN && bit_is_set(dcCandidates, from))
675   {
676       if (Piece != ROOK)
677           (*pCheckersBB) |= (piece_attacks<ROOK>(ksq) & pieces(ROOK, QUEEN, side_to_move()));
678
679       if (Piece != BISHOP)
680           (*pCheckersBB) |= (piece_attacks<BISHOP>(ksq) & pieces(BISHOP, QUEEN, side_to_move()));
681   }
682 }
683
684
685 /// Position::do_move() makes a move, and saves all information necessary
686 /// to a StateInfo object. The move is assumed to be legal.
687 /// Pseudo-legal moves should be filtered out before this function is called.
688
689 void Position::do_move(Move m, StateInfo& newSt) {
690
691   do_move(m, newSt, discovered_check_candidates(side_to_move()));
692 }
693
694 void Position::do_move(Move m, StateInfo& newSt, Bitboard dcCandidates) {
695
696   assert(is_ok());
697   assert(move_is_ok(m));
698
699   Bitboard key = st->key;
700
701   // Copy some fields of old state to our new StateInfo object except the
702   // ones which are recalculated from scratch anyway, then switch our state
703   // pointer to point to the new, ready to be updated, state.
704   struct ReducedStateInfo {
705     Key key, pawnKey, materialKey;
706     int castleRights, rule50;
707     Square kingSquare[2], epSquare;
708     Value mgValue, egValue;
709     Value npMaterial[2];
710   };
711
712   memcpy(&newSt, st, sizeof(ReducedStateInfo));
713   newSt.previous = st;
714   st = &newSt;
715
716   // Save the current key to the history[] array, in order to be able to
717   // detect repetition draws.
718   history[gamePly] = key;
719   gamePly++;
720
721   // Update side to move
722   key ^= zobSideToMove;
723
724   // Increment the 50 moves rule draw counter. Resetting it to zero in the
725   // case of non-reversible moves is taken care of later.
726   st->rule50++;
727
728   if (move_is_castle(m))
729   {
730       st->key = key;
731       do_castle_move(m);
732       return;
733   }
734
735   Color us = side_to_move();
736   Color them = opposite_color(us);
737   Square from = move_from(m);
738   Square to = move_to(m);
739   bool ep = move_is_ep(m);
740   bool pm = move_is_promotion(m);
741
742   Piece piece = piece_on(from);
743   PieceType pt = type_of_piece(piece);
744
745   assert(color_of_piece_on(from) == us);
746   assert(color_of_piece_on(to) == them || square_is_empty(to));
747   assert(!(ep || pm) || piece == piece_of_color_and_type(us, PAWN));
748   assert(!pm || relative_rank(us, to) == RANK_8);
749
750   st->capture = ep ? PAWN : type_of_piece_on(to);
751
752   if (st->capture)
753       do_capture_move(key, st->capture, them, to, ep);
754
755   // Update hash key
756   key ^= zobrist[us][pt][from] ^ zobrist[us][pt][to];
757
758   // Reset en passant square
759   if (st->epSquare != SQ_NONE)
760   {
761       key ^= zobEp[st->epSquare];
762       st->epSquare = SQ_NONE;
763   }
764
765   // Update castle rights, try to shortcut a common case
766   int cm = castleRightsMask[from] & castleRightsMask[to];
767   if (cm != ALL_CASTLES && ((cm & st->castleRights) != st->castleRights))
768   {
769       key ^= zobCastle[st->castleRights];
770       st->castleRights &= castleRightsMask[from];
771       st->castleRights &= castleRightsMask[to];
772       key ^= zobCastle[st->castleRights];
773   }
774
775   // Prefetch TT access as soon as we know key is updated
776   TT.prefetch(key);
777
778   // Move the piece
779   Bitboard move_bb = make_move_bb(from, to);
780   do_move_bb(&(byColorBB[us]), move_bb);
781   do_move_bb(&(byTypeBB[pt]), move_bb);
782   do_move_bb(&(byTypeBB[0]), move_bb); // HACK: byTypeBB[0] == occupied squares
783
784   board[to] = board[from];
785   board[from] = EMPTY;
786
787   // If the moving piece was a king, update the king square
788   if (pt == KING)
789       st->kingSquare[us] = to;
790
791   // Update piece lists, note that index[from] is not updated and
792   // becomes stale. This works as long as index[] is accessed just
793   // by known occupied squares.
794   index[to] = index[from];
795   pieceList[us][pt][index[to]] = to;
796
797   // If the moving piece was a pawn do some special extra work
798   if (pt == PAWN)
799   {
800       // Reset rule 50 draw counter
801       st->rule50 = 0;
802
803       // Update pawn hash key
804       st->pawnKey ^= zobrist[us][PAWN][from] ^ zobrist[us][PAWN][to];
805
806       // Set en passant square, only if moved pawn can be captured
807       if (abs(int(to) - int(from)) == 16)
808       {
809           if (pawn_attacks(us, from + (us == WHITE ? DELTA_N : DELTA_S)) & pieces(PAWN, them))
810           {
811               st->epSquare = Square((int(from) + int(to)) / 2);
812               key ^= zobEp[st->epSquare];
813           }
814       }
815   }
816
817   // Update incremental scores
818   st->mgValue += pst_delta<MidGame>(piece, from, to);
819   st->egValue += pst_delta<EndGame>(piece, from, to);
820
821   if (pm) // promotion ?
822   {
823       PieceType promotion = move_promotion_piece(m);
824
825       assert(promotion >= KNIGHT && promotion <= QUEEN);
826
827       // Insert promoted piece instead of pawn
828       clear_bit(&(byTypeBB[PAWN]), to);
829       set_bit(&(byTypeBB[promotion]), to);
830       board[to] = piece_of_color_and_type(us, promotion);
831
832       // Update material key
833       st->materialKey ^= zobMaterial[us][PAWN][pieceCount[us][PAWN]];
834       st->materialKey ^= zobMaterial[us][promotion][pieceCount[us][promotion]+1];
835
836       // Update piece counts
837       pieceCount[us][PAWN]--;
838       pieceCount[us][promotion]++;
839
840       // Update piece lists, move the last pawn at index[to] position
841       // and shrink the list. Add a new promotion piece to the list.
842       Square lastPawnSquare = pieceList[us][PAWN][pieceCount[us][PAWN]];
843       index[lastPawnSquare] = index[to];
844       pieceList[us][PAWN][index[lastPawnSquare]] = lastPawnSquare;
845       index[to] = pieceCount[us][promotion] - 1;
846       pieceList[us][promotion][index[to]] = to;
847
848       // Partially revert hash keys update
849       key ^= zobrist[us][PAWN][to] ^ zobrist[us][promotion][to];
850       st->pawnKey ^= zobrist[us][PAWN][to];
851
852       // Partially revert and update incremental scores
853       st->mgValue -= pst<MidGame>(us, PAWN, to);
854       st->mgValue += pst<MidGame>(us, promotion, to);
855       st->egValue -= pst<EndGame>(us, PAWN, to);
856       st->egValue += pst<EndGame>(us, promotion, to);
857
858       // Update material
859       st->npMaterial[us] += piece_value_midgame(promotion);
860   }
861
862   // Update the key with the final value
863   st->key = key;
864
865   // Update checkers bitboard, piece must be already moved
866   if (ep | pm)
867       st->checkersBB = attacks_to(king_square(them), us);
868   else
869   {
870       st->checkersBB = EmptyBoardBB;
871       Square ksq = king_square(them);
872       switch (pt)
873       {
874       case PAWN:   update_checkers<PAWN>(&(st->checkersBB), ksq, from, to, dcCandidates);   break;
875       case KNIGHT: update_checkers<KNIGHT>(&(st->checkersBB), ksq, from, to, dcCandidates); break;
876       case BISHOP: update_checkers<BISHOP>(&(st->checkersBB), ksq, from, to, dcCandidates); break;
877       case ROOK:   update_checkers<ROOK>(&(st->checkersBB), ksq, from, to, dcCandidates);   break;
878       case QUEEN:  update_checkers<QUEEN>(&(st->checkersBB), ksq, from, to, dcCandidates);  break;
879       case KING:   update_checkers<KING>(&(st->checkersBB), ksq, from, to, dcCandidates);   break;
880       default: assert(false); break;
881       }
882   }
883
884   // Finish
885   sideToMove = opposite_color(sideToMove);
886
887   st->mgValue += (sideToMove == WHITE)? TempoValueMidgame : -TempoValueMidgame;
888   st->egValue += (sideToMove == WHITE)? TempoValueEndgame : -TempoValueEndgame;
889
890   assert(is_ok());
891 }
892
893
894 /// Position::do_capture_move() is a private method used to update captured
895 /// piece info. It is called from the main Position::do_move function.
896
897 void Position::do_capture_move(Bitboard& key, PieceType capture, Color them, Square to, bool ep) {
898
899     assert(capture != KING);
900
901     Square capsq = to;
902
903     if (ep) // en passant ?
904     {
905         capsq = (them == BLACK)? (to - DELTA_N) : (to - DELTA_S);
906
907         assert(to == st->epSquare);
908         assert(relative_rank(opposite_color(them), to) == RANK_6);
909         assert(piece_on(to) == EMPTY);
910         assert(piece_on(capsq) == piece_of_color_and_type(them, PAWN));
911
912         board[capsq] = EMPTY;
913     }
914
915     // Remove captured piece
916     clear_bit(&(byColorBB[them]), capsq);
917     clear_bit(&(byTypeBB[capture]), capsq);
918     clear_bit(&(byTypeBB[0]), capsq);
919
920     // Update hash key
921     key ^= zobrist[them][capture][capsq];
922
923     // Update incremental scores
924     st->mgValue -= pst<MidGame>(them, capture, capsq);
925     st->egValue -= pst<EndGame>(them, capture, capsq);
926
927     // If the captured piece was a pawn, update pawn hash key,
928     // otherwise update non-pawn material.
929     if (capture == PAWN)
930         st->pawnKey ^= zobrist[them][PAWN][capsq];
931     else
932         st->npMaterial[them] -= piece_value_midgame(capture);
933
934     // Update material hash key
935     st->materialKey ^= zobMaterial[them][capture][pieceCount[them][capture]];
936
937     // Update piece count
938     pieceCount[them][capture]--;
939
940     // Update piece list, move the last piece at index[capsq] position
941     //
942     // WARNING: This is a not perfectly revresible operation. When we
943     // will reinsert the captured piece in undo_move() we will put it
944     // at the end of the list and not in its original place, it means
945     // index[] and pieceList[] are not guaranteed to be invariant to a
946     // do_move() + undo_move() sequence.
947     Square lastPieceSquare = pieceList[them][capture][pieceCount[them][capture]];
948     index[lastPieceSquare] = index[capsq];
949     pieceList[them][capture][index[lastPieceSquare]] = lastPieceSquare;
950
951     // Reset rule 50 counter
952     st->rule50 = 0;
953 }
954
955
956 /// Position::do_castle_move() is a private method used to make a castling
957 /// move. It is called from the main Position::do_move function. Note that
958 /// castling moves are encoded as "king captures friendly rook" moves, for
959 /// instance white short castling in a non-Chess960 game is encoded as e1h1.
960
961 void Position::do_castle_move(Move m) {
962
963   assert(move_is_ok(m));
964   assert(move_is_castle(m));
965
966   Color us = side_to_move();
967   Color them = opposite_color(us);
968
969   // Reset capture field
970   st->capture = NO_PIECE_TYPE;
971
972   // Find source squares for king and rook
973   Square kfrom = move_from(m);
974   Square rfrom = move_to(m);  // HACK: See comment at beginning of function
975   Square kto, rto;
976
977   assert(piece_on(kfrom) == piece_of_color_and_type(us, KING));
978   assert(piece_on(rfrom) == piece_of_color_and_type(us, ROOK));
979
980   // Find destination squares for king and rook
981   if (rfrom > kfrom) // O-O
982   {
983       kto = relative_square(us, SQ_G1);
984       rto = relative_square(us, SQ_F1);
985   } else { // O-O-O
986       kto = relative_square(us, SQ_C1);
987       rto = relative_square(us, SQ_D1);
988   }
989
990   // Move the pieces
991   Bitboard kmove_bb = make_move_bb(kfrom, kto);
992   do_move_bb(&(byColorBB[us]), kmove_bb);
993   do_move_bb(&(byTypeBB[KING]), kmove_bb);
994   do_move_bb(&(byTypeBB[0]), kmove_bb); // HACK: byTypeBB[0] == occupied squares
995
996   Bitboard rmove_bb = make_move_bb(rfrom, rto);
997   do_move_bb(&(byColorBB[us]), rmove_bb);
998   do_move_bb(&(byTypeBB[ROOK]), rmove_bb);
999   do_move_bb(&(byTypeBB[0]), rmove_bb); // HACK: byTypeBB[0] == occupied squares
1000
1001   // Update board array
1002   Piece king = piece_of_color_and_type(us, KING);
1003   Piece rook = piece_of_color_and_type(us, ROOK);
1004   board[kfrom] = board[rfrom] = EMPTY;
1005   board[kto] = king;
1006   board[rto] = rook;
1007
1008   // Update king square
1009   st->kingSquare[us] = kto;
1010
1011   // Update piece lists
1012   pieceList[us][KING][index[kfrom]] = kto;
1013   pieceList[us][ROOK][index[rfrom]] = rto;
1014   int tmp = index[rfrom]; // In Chess960 could be rto == kfrom
1015   index[kto] = index[kfrom];
1016   index[rto] = tmp;
1017
1018   // Update incremental scores
1019   st->mgValue += pst_delta<MidGame>(king, kfrom, kto);
1020   st->egValue += pst_delta<EndGame>(king, kfrom, kto);
1021   st->mgValue += pst_delta<MidGame>(rook, rfrom, rto);
1022   st->egValue += pst_delta<EndGame>(rook, rfrom, rto);
1023
1024   // Update hash key
1025   st->key ^= zobrist[us][KING][kfrom] ^ zobrist[us][KING][kto];
1026   st->key ^= zobrist[us][ROOK][rfrom] ^ zobrist[us][ROOK][rto];
1027
1028   // Clear en passant square
1029   if (st->epSquare != SQ_NONE)
1030   {
1031       st->key ^= zobEp[st->epSquare];
1032       st->epSquare = SQ_NONE;
1033   }
1034
1035   // Update castling rights
1036   st->key ^= zobCastle[st->castleRights];
1037   st->castleRights &= castleRightsMask[kfrom];
1038   st->key ^= zobCastle[st->castleRights];
1039
1040   // Reset rule 50 counter
1041   st->rule50 = 0;
1042
1043   // Update checkers BB
1044   st->checkersBB = attacks_to(king_square(them), us);
1045
1046   // Finish
1047   sideToMove = opposite_color(sideToMove);
1048
1049   st->mgValue += (sideToMove == WHITE)? TempoValueMidgame : -TempoValueMidgame;
1050   st->egValue += (sideToMove == WHITE)? TempoValueEndgame : -TempoValueEndgame;
1051
1052   assert(is_ok());
1053 }
1054
1055
1056 /// Position::undo_move() unmakes a move. When it returns, the position should
1057 /// be restored to exactly the same state as before the move was made.
1058
1059 void Position::undo_move(Move m) {
1060
1061   assert(is_ok());
1062   assert(move_is_ok(m));
1063
1064   gamePly--;
1065   sideToMove = opposite_color(sideToMove);
1066
1067   if (move_is_castle(m))
1068   {
1069       undo_castle_move(m);
1070       return;
1071   }
1072
1073   Color us = side_to_move();
1074   Color them = opposite_color(us);
1075   Square from = move_from(m);
1076   Square to = move_to(m);
1077   bool ep = move_is_ep(m);
1078   bool pm = move_is_promotion(m);
1079
1080   PieceType pt = type_of_piece_on(to);
1081
1082   assert(square_is_empty(from));
1083   assert(color_of_piece_on(to) == us);
1084   assert(!pm || relative_rank(us, to) == RANK_8);
1085   assert(!ep || to == st->previous->epSquare);
1086   assert(!ep || relative_rank(us, to) == RANK_6);
1087   assert(!ep || piece_on(to) == piece_of_color_and_type(us, PAWN));
1088
1089   if (pm) // promotion ?
1090   {
1091       PieceType promotion = move_promotion_piece(m);
1092       pt = PAWN;
1093
1094       assert(promotion >= KNIGHT && promotion <= QUEEN);
1095       assert(piece_on(to) == piece_of_color_and_type(us, promotion));
1096
1097       // Replace promoted piece with a pawn
1098       clear_bit(&(byTypeBB[promotion]), to);
1099       set_bit(&(byTypeBB[PAWN]), to);
1100
1101       // Update piece counts
1102       pieceCount[us][promotion]--;
1103       pieceCount[us][PAWN]++;
1104
1105       // Update piece list replacing promotion piece with a pawn
1106       Square lastPromotionSquare = pieceList[us][promotion][pieceCount[us][promotion]];
1107       index[lastPromotionSquare] = index[to];
1108       pieceList[us][promotion][index[lastPromotionSquare]] = lastPromotionSquare;
1109       index[to] = pieceCount[us][PAWN] - 1;
1110       pieceList[us][PAWN][index[to]] = to;
1111   }
1112
1113   // Put the piece back at the source square
1114   Bitboard move_bb = make_move_bb(to, from);
1115   do_move_bb(&(byColorBB[us]), move_bb);
1116   do_move_bb(&(byTypeBB[pt]), move_bb);
1117   do_move_bb(&(byTypeBB[0]), move_bb); // HACK: byTypeBB[0] == occupied squares
1118
1119   board[from] = piece_of_color_and_type(us, pt);
1120   board[to] = EMPTY;
1121
1122   // Update piece list
1123   index[from] = index[to];
1124   pieceList[us][pt][index[from]] = from;
1125
1126   if (st->capture)
1127   {
1128       Square capsq = to;
1129
1130       if (ep)
1131           capsq = (us == WHITE)? (to - DELTA_N) : (to - DELTA_S);
1132
1133       assert(st->capture != KING);
1134       assert(!ep || square_is_empty(capsq));
1135
1136       // Restore the captured piece
1137       set_bit(&(byColorBB[them]), capsq);
1138       set_bit(&(byTypeBB[st->capture]), capsq);
1139       set_bit(&(byTypeBB[0]), capsq);
1140
1141       board[capsq] = piece_of_color_and_type(them, st->capture);
1142
1143       // Update piece count
1144       pieceCount[them][st->capture]++;
1145
1146       // Update piece list, add a new captured piece in capsq square
1147       index[capsq] = pieceCount[them][st->capture] - 1;
1148       pieceList[them][st->capture][index[capsq]] = capsq;
1149   }
1150
1151   // Finally point our state pointer back to the previous state
1152   st = st->previous;
1153
1154   assert(is_ok());
1155 }
1156
1157
1158 /// Position::undo_castle_move() is a private method used to unmake a castling
1159 /// move. It is called from the main Position::undo_move function. Note that
1160 /// castling moves are encoded as "king captures friendly rook" moves, for
1161 /// instance white short castling in a non-Chess960 game is encoded as e1h1.
1162
1163 void Position::undo_castle_move(Move m) {
1164
1165   assert(move_is_ok(m));
1166   assert(move_is_castle(m));
1167
1168   // When we have arrived here, some work has already been done by
1169   // Position::undo_move.  In particular, the side to move has been switched,
1170   // so the code below is correct.
1171   Color us = side_to_move();
1172
1173   // Find source squares for king and rook
1174   Square kfrom = move_from(m);
1175   Square rfrom = move_to(m);  // HACK: See comment at beginning of function
1176   Square kto, rto;
1177
1178   // Find destination squares for king and rook
1179   if (rfrom > kfrom) // O-O
1180   {
1181       kto = relative_square(us, SQ_G1);
1182       rto = relative_square(us, SQ_F1);
1183   } else { // O-O-O
1184       kto = relative_square(us, SQ_C1);
1185       rto = relative_square(us, SQ_D1);
1186   }
1187
1188   assert(piece_on(kto) == piece_of_color_and_type(us, KING));
1189   assert(piece_on(rto) == piece_of_color_and_type(us, ROOK));
1190
1191   // Put the pieces back at the source square
1192   Bitboard kmove_bb = make_move_bb(kto, kfrom);
1193   do_move_bb(&(byColorBB[us]), kmove_bb);
1194   do_move_bb(&(byTypeBB[KING]), kmove_bb);
1195   do_move_bb(&(byTypeBB[0]), kmove_bb); // HACK: byTypeBB[0] == occupied squares
1196
1197   Bitboard rmove_bb = make_move_bb(rto, rfrom);
1198   do_move_bb(&(byColorBB[us]), rmove_bb);
1199   do_move_bb(&(byTypeBB[ROOK]), rmove_bb);
1200   do_move_bb(&(byTypeBB[0]), rmove_bb); // HACK: byTypeBB[0] == occupied squares
1201
1202   // Update board
1203   board[rto] = board[kto] = EMPTY;
1204   board[rfrom] = piece_of_color_and_type(us, ROOK);
1205   board[kfrom] = piece_of_color_and_type(us, KING);
1206
1207   // Update piece lists
1208   pieceList[us][KING][index[kto]] = kfrom;
1209   pieceList[us][ROOK][index[rto]] = rfrom;
1210   int tmp = index[rto];  // In Chess960 could be rto == kfrom
1211   index[kfrom] = index[kto];
1212   index[rfrom] = tmp;
1213
1214   // Finally point our state pointer back to the previous state
1215   st = st->previous;
1216
1217   assert(is_ok());
1218 }
1219
1220
1221 /// Position::do_null_move makes() a "null move": It switches the side to move
1222 /// and updates the hash key without executing any move on the board.
1223
1224 void Position::do_null_move(StateInfo& backupSt) {
1225
1226   assert(is_ok());
1227   assert(!is_check());
1228
1229   // Back up the information necessary to undo the null move to the supplied
1230   // StateInfo object.
1231   // Note that differently from normal case here backupSt is actually used as
1232   // a backup storage not as a new state to be used.
1233   backupSt.key      = st->key;
1234   backupSt.epSquare = st->epSquare;
1235   backupSt.mgValue  = st->mgValue;
1236   backupSt.egValue  = st->egValue;
1237   backupSt.previous = st->previous;
1238   st->previous = &backupSt;
1239
1240   // Save the current key to the history[] array, in order to be able to
1241   // detect repetition draws.
1242   history[gamePly] = st->key;
1243
1244   // Update the necessary information
1245   if (st->epSquare != SQ_NONE)
1246       st->key ^= zobEp[st->epSquare];
1247
1248   st->key ^= zobSideToMove;
1249   TT.prefetch(st->key);
1250
1251   sideToMove = opposite_color(sideToMove);
1252   st->epSquare = SQ_NONE;
1253   st->rule50++;
1254   gamePly++;
1255
1256   st->mgValue += (sideToMove == WHITE)? TempoValueMidgame : -TempoValueMidgame;
1257   st->egValue += (sideToMove == WHITE)? TempoValueEndgame : -TempoValueEndgame;
1258 }
1259
1260
1261 /// Position::undo_null_move() unmakes a "null move".
1262
1263 void Position::undo_null_move() {
1264
1265   assert(is_ok());
1266   assert(!is_check());
1267
1268   // Restore information from the our backup StateInfo object
1269   StateInfo* backupSt = st->previous;
1270   st->key      = backupSt->key;
1271   st->epSquare = backupSt->epSquare;
1272   st->mgValue  = backupSt->mgValue;
1273   st->egValue  = backupSt->egValue;
1274   st->previous = backupSt->previous;
1275
1276   // Update the necessary information
1277   sideToMove = opposite_color(sideToMove);
1278   st->rule50--;
1279   gamePly--;
1280 }
1281
1282
1283 /// Position::see() is a static exchange evaluator: It tries to estimate the
1284 /// material gain or loss resulting from a move. There are three versions of
1285 /// this function: One which takes a destination square as input, one takes a
1286 /// move, and one which takes a 'from' and a 'to' square. The function does
1287 /// not yet understand promotions captures.
1288
1289 int Position::see(Square to) const {
1290
1291   assert(square_is_ok(to));
1292   return see(SQ_NONE, to);
1293 }
1294
1295 int Position::see(Move m) const {
1296
1297   assert(move_is_ok(m));
1298   return see(move_from(m), move_to(m));
1299 }
1300
1301 int Position::see_sign(Move m) const {
1302
1303   assert(move_is_ok(m));
1304
1305   Square from = move_from(m);
1306   Square to = move_to(m);
1307
1308   // Early return if SEE cannot be negative because capturing piece value
1309   // is not bigger then captured one.
1310   if (   midgame_value_of_piece_on(from) <= midgame_value_of_piece_on(to)
1311       && type_of_piece_on(from) != KING)
1312          return 1;
1313
1314   return see(from, to);
1315 }
1316
1317 int Position::see(Square from, Square to) const {
1318
1319   // Material values
1320   static const int seeValues[18] = {
1321     0, PawnValueMidgame, KnightValueMidgame, BishopValueMidgame,
1322        RookValueMidgame, QueenValueMidgame, QueenValueMidgame*10, 0,
1323     0, PawnValueMidgame, KnightValueMidgame, BishopValueMidgame,
1324        RookValueMidgame, QueenValueMidgame, QueenValueMidgame*10, 0,
1325     0, 0
1326   };
1327
1328   Bitboard attackers, stmAttackers, occ, b;
1329
1330   assert(square_is_ok(from) || from == SQ_NONE);
1331   assert(square_is_ok(to));
1332
1333   // Initialize colors
1334   Color us = (from != SQ_NONE ? color_of_piece_on(from) : opposite_color(color_of_piece_on(to)));
1335   Color them = opposite_color(us);
1336
1337   // Initialize pieces
1338   Piece piece = piece_on(from);
1339   Piece capture = piece_on(to);
1340
1341   // Find all attackers to the destination square, with the moving piece
1342   // removed, but possibly an X-ray attacker added behind it.
1343   occ = occupied_squares();
1344
1345   // Handle en passant moves
1346   if (st->epSquare == to && type_of_piece_on(from) == PAWN)
1347   {
1348       assert(capture == EMPTY);
1349
1350       Square capQq = (side_to_move() == WHITE)? (to - DELTA_N) : (to - DELTA_S);
1351       capture = piece_on(capQq);
1352       assert(type_of_piece_on(capQq) == PAWN);
1353
1354       // Remove the captured pawn
1355       clear_bit(&occ, capQq);
1356   }
1357
1358   while (true)
1359   {
1360       clear_bit(&occ, from);
1361       attackers =  (rook_attacks_bb(to, occ)   & pieces(ROOK, QUEEN))
1362                  | (bishop_attacks_bb(to, occ) & pieces(BISHOP, QUEEN))
1363                  | (piece_attacks<KNIGHT>(to)  & pieces(KNIGHT))
1364                  | (piece_attacks<KING>(to)    & pieces(KING))
1365                  | (pawn_attacks(WHITE, to)    & pieces(PAWN, BLACK))
1366                  | (pawn_attacks(BLACK, to)    & pieces(PAWN, WHITE));
1367
1368       if (from != SQ_NONE)
1369           break;
1370
1371       // If we don't have any attacker we are finished
1372       if ((attackers & pieces_of_color(us)) == EmptyBoardBB)
1373           return 0;
1374
1375       // Locate the least valuable attacker to the destination square
1376       // and use it to initialize from square.
1377       stmAttackers = attackers & pieces_of_color(us);
1378       PieceType pt;
1379       for (pt = PAWN; !(stmAttackers & pieces(pt)); pt++)
1380           assert(pt < KING);
1381
1382       from = first_1(stmAttackers & pieces(pt));
1383       piece = piece_on(from);
1384   }
1385
1386   // If the opponent has no attackers we are finished
1387   stmAttackers = attackers & pieces_of_color(them);
1388   if (!stmAttackers)
1389       return seeValues[capture];
1390
1391   attackers &= occ; // Remove the moving piece
1392
1393   // The destination square is defended, which makes things rather more
1394   // difficult to compute. We proceed by building up a "swap list" containing
1395   // the material gain or loss at each stop in a sequence of captures to the
1396   // destination square, where the sides alternately capture, and always
1397   // capture with the least valuable piece. After each capture, we look for
1398   // new X-ray attacks from behind the capturing piece.
1399   int lastCapturingPieceValue = seeValues[piece];
1400   int swapList[32], n = 1;
1401   Color c = them;
1402   PieceType pt;
1403
1404   swapList[0] = seeValues[capture];
1405
1406   do {
1407       // Locate the least valuable attacker for the side to move. The loop
1408       // below looks like it is potentially infinite, but it isn't. We know
1409       // that the side to move still has at least one attacker left.
1410       for (pt = PAWN; !(stmAttackers & pieces(pt)); pt++)
1411           assert(pt < KING);
1412
1413       // Remove the attacker we just found from the 'attackers' bitboard,
1414       // and scan for new X-ray attacks behind the attacker.
1415       b = stmAttackers & pieces(pt);
1416       occ ^= (b & (~b + 1));
1417       attackers |=  (rook_attacks_bb(to, occ) &  pieces(ROOK, QUEEN))
1418                   | (bishop_attacks_bb(to, occ) & pieces(BISHOP, QUEEN));
1419
1420       attackers &= occ;
1421
1422       // Add the new entry to the swap list
1423       assert(n < 32);
1424       swapList[n] = -swapList[n - 1] + lastCapturingPieceValue;
1425       n++;
1426
1427       // Remember the value of the capturing piece, and change the side to move
1428       // before beginning the next iteration
1429       lastCapturingPieceValue = seeValues[pt];
1430       c = opposite_color(c);
1431       stmAttackers = attackers & pieces_of_color(c);
1432
1433       // Stop after a king capture
1434       if (pt == KING && stmAttackers)
1435       {
1436           assert(n < 32);
1437           swapList[n++] = QueenValueMidgame*10;
1438           break;
1439       }
1440   } while (stmAttackers);
1441
1442   // Having built the swap list, we negamax through it to find the best
1443   // achievable score from the point of view of the side to move
1444   while (--n)
1445       swapList[n-1] = Min(-swapList[n], swapList[n-1]);
1446
1447   return swapList[0];
1448 }
1449
1450
1451 /// Position::saveState() copies the content of the current state
1452 /// inside startState and makes st point to it. This is needed
1453 /// when the st pointee could become stale, as example because
1454 /// the caller is about to going out of scope.
1455
1456 void Position::saveState() {
1457
1458   startState = *st;
1459   st = &startState;
1460   st->previous = NULL; // as a safe guard
1461 }
1462
1463
1464 /// Position::clear() erases the position object to a pristine state, with an
1465 /// empty board, white to move, and no castling rights.
1466
1467 void Position::clear() {
1468
1469   st = &startState;
1470   memset(st, 0, sizeof(StateInfo));
1471   st->epSquare = SQ_NONE;
1472
1473   memset(byColorBB,  0, sizeof(Bitboard) * 2);
1474   memset(byTypeBB,   0, sizeof(Bitboard) * 8);
1475   memset(pieceCount, 0, sizeof(int) * 2 * 8);
1476   memset(index,      0, sizeof(int) * 64);
1477
1478   for (int i = 0; i < 64; i++)
1479       board[i] = EMPTY;
1480
1481   for (int i = 0; i < 7; i++)
1482       for (int j = 0; j < 8; j++)
1483           pieceList[0][i][j] = pieceList[1][i][j] = SQ_NONE;
1484
1485   sideToMove = WHITE;
1486   gamePly = 0;
1487   initialKFile = FILE_E;
1488   initialKRFile = FILE_H;
1489   initialQRFile = FILE_A;
1490 }
1491
1492
1493 /// Position::reset_game_ply() simply sets gamePly to 0. It is used from the
1494 /// UCI interface code, whenever a non-reversible move is made in a
1495 /// 'position fen <fen> moves m1 m2 ...' command.  This makes it possible
1496 /// for the program to handle games of arbitrary length, as long as the GUI
1497 /// handles draws by the 50 move rule correctly.
1498
1499 void Position::reset_game_ply() {
1500
1501   gamePly = 0;
1502 }
1503
1504
1505 /// Position::put_piece() puts a piece on the given square of the board,
1506 /// updating the board array, bitboards, and piece counts.
1507
1508 void Position::put_piece(Piece p, Square s) {
1509
1510   Color c = color_of_piece(p);
1511   PieceType pt = type_of_piece(p);
1512
1513   board[s] = p;
1514   index[s] = pieceCount[c][pt];
1515   pieceList[c][pt][index[s]] = s;
1516
1517   set_bit(&(byTypeBB[pt]), s);
1518   set_bit(&(byColorBB[c]), s);
1519   set_bit(&byTypeBB[0], s); // HACK: byTypeBB[0] contains all occupied squares.
1520
1521   pieceCount[c][pt]++;
1522
1523   if (pt == KING)
1524       st->kingSquare[c] = s;
1525 }
1526
1527
1528 /// Position::allow_oo() gives the given side the right to castle kingside.
1529 /// Used when setting castling rights during parsing of FEN strings.
1530
1531 void Position::allow_oo(Color c) {
1532
1533   st->castleRights |= (1 + int(c));
1534 }
1535
1536
1537 /// Position::allow_ooo() gives the given side the right to castle queenside.
1538 /// Used when setting castling rights during parsing of FEN strings.
1539
1540 void Position::allow_ooo(Color c) {
1541
1542   st->castleRights |= (4 + 4*int(c));
1543 }
1544
1545
1546 /// Position::compute_key() computes the hash key of the position. The hash
1547 /// key is usually updated incrementally as moves are made and unmade, the
1548 /// compute_key() function is only used when a new position is set up, and
1549 /// to verify the correctness of the hash key when running in debug mode.
1550
1551 Key Position::compute_key() const {
1552
1553   Key result = Key(0ULL);
1554
1555   for (Square s = SQ_A1; s <= SQ_H8; s++)
1556       if (square_is_occupied(s))
1557           result ^= zobrist[color_of_piece_on(s)][type_of_piece_on(s)][s];
1558
1559   if (ep_square() != SQ_NONE)
1560       result ^= zobEp[ep_square()];
1561
1562   result ^= zobCastle[st->castleRights];
1563   if (side_to_move() == BLACK)
1564       result ^= zobSideToMove;
1565
1566   return result;
1567 }
1568
1569
1570 /// Position::compute_pawn_key() computes the hash key of the position. The
1571 /// hash key is usually updated incrementally as moves are made and unmade,
1572 /// the compute_pawn_key() function is only used when a new position is set
1573 /// up, and to verify the correctness of the pawn hash key when running in
1574 /// debug mode.
1575
1576 Key Position::compute_pawn_key() const {
1577
1578   Key result = Key(0ULL);
1579   Bitboard b;
1580   Square s;
1581
1582   for (Color c = WHITE; c <= BLACK; c++)
1583   {
1584       b = pieces(PAWN, c);
1585       while(b)
1586       {
1587           s = pop_1st_bit(&b);
1588           result ^= zobrist[c][PAWN][s];
1589       }
1590   }
1591   return result;
1592 }
1593
1594
1595 /// Position::compute_material_key() computes the hash key of the position.
1596 /// The hash key is usually updated incrementally as moves are made and unmade,
1597 /// the compute_material_key() function is only used when a new position is set
1598 /// up, and to verify the correctness of the material hash key when running in
1599 /// debug mode.
1600
1601 Key Position::compute_material_key() const {
1602
1603   Key result = Key(0ULL);
1604   for (Color c = WHITE; c <= BLACK; c++)
1605       for (PieceType pt = PAWN; pt <= QUEEN; pt++)
1606       {
1607           int count = piece_count(c, pt);
1608           for (int i = 0; i <= count; i++)
1609               result ^= zobMaterial[c][pt][i];
1610       }
1611   return result;
1612 }
1613
1614
1615 /// Position::compute_value() compute the incremental scores for the middle
1616 /// game and the endgame. These functions are used to initialize the incremental
1617 /// scores when a new position is set up, and to verify that the scores are correctly
1618 /// updated by do_move and undo_move when the program is running in debug mode.
1619 template<Position::GamePhase Phase>
1620 Value Position::compute_value() const {
1621
1622   Value result = Value(0);
1623   Bitboard b;
1624   Square s;
1625
1626   for (Color c = WHITE; c <= BLACK; c++)
1627       for (PieceType pt = PAWN; pt <= KING; pt++)
1628       {
1629           b = pieces(pt, c);
1630           while(b)
1631           {
1632               s = pop_1st_bit(&b);
1633               assert(piece_on(s) == piece_of_color_and_type(c, pt));
1634               result += pst<Phase>(c, pt, s);
1635           }
1636       }
1637
1638   const Value TempoValue = (Phase == MidGame ? TempoValueMidgame : TempoValueEndgame);
1639   result += (side_to_move() == WHITE)? TempoValue / 2 : -TempoValue / 2;
1640   return result;
1641 }
1642
1643
1644 /// Position::compute_non_pawn_material() computes the total non-pawn middle
1645 /// game material score for the given side. Material scores are updated
1646 /// incrementally during the search, this function is only used while
1647 /// initializing a new Position object.
1648
1649 Value Position::compute_non_pawn_material(Color c) const {
1650
1651   Value result = Value(0);
1652
1653   for (PieceType pt = KNIGHT; pt <= QUEEN; pt++)
1654   {
1655       Bitboard b = pieces(pt, c);
1656       while (b)
1657       {
1658           assert(piece_on(first_1(b)) == piece_of_color_and_type(c, pt));
1659           pop_1st_bit(&b);
1660           result += piece_value_midgame(pt);
1661       }
1662   }
1663   return result;
1664 }
1665
1666
1667 /// Position::is_draw() tests whether the position is drawn by material,
1668 /// repetition, or the 50 moves rule. It does not detect stalemates, this
1669 /// must be done by the search.
1670
1671 bool Position::is_draw() const {
1672
1673   // Draw by material?
1674   if (   !pieces(PAWN)
1675       && (non_pawn_material(WHITE) + non_pawn_material(BLACK) <= BishopValueMidgame))
1676       return true;
1677
1678   // Draw by the 50 moves rule?
1679   if (st->rule50 > 100 || (st->rule50 == 100 && !is_check()))
1680       return true;
1681
1682   // Draw by repetition?
1683   for (int i = 2; i < Min(gamePly, st->rule50); i += 2)
1684       if (history[gamePly - i] == st->key)
1685           return true;
1686
1687   return false;
1688 }
1689
1690
1691 /// Position::is_mate() returns true or false depending on whether the
1692 /// side to move is checkmated.
1693
1694 bool Position::is_mate() const {
1695
1696   MoveStack moves[256];
1697
1698   return is_check() && (generate_evasions(*this, moves, pinned_pieces(sideToMove)) == moves);
1699 }
1700
1701
1702 /// Position::has_mate_threat() tests whether a given color has a mate in one
1703 /// from the current position.
1704
1705 bool Position::has_mate_threat(Color c) {
1706
1707   StateInfo st1, st2;
1708   Color stm = side_to_move();
1709
1710   if (is_check())
1711       return false;
1712
1713   // If the input color is not equal to the side to move, do a null move
1714   if (c != stm)
1715       do_null_move(st1);
1716
1717   MoveStack mlist[120];
1718   bool result = false;
1719   Bitboard dc = discovered_check_candidates(sideToMove);
1720   Bitboard pinned = pinned_pieces(sideToMove);
1721
1722   // Generate pseudo-legal non-capture and capture check moves
1723   MoveStack* last = generate_non_capture_checks(*this, mlist, dc);
1724   last = generate_captures(*this, last);
1725
1726   // Loop through the moves, and see if one of them is mate
1727   for (MoveStack* cur = mlist; cur != last; cur++)
1728   {
1729       Move move = cur->move;
1730       if (!pl_move_is_legal(move, pinned))
1731           continue;
1732
1733       do_move(move, st2);
1734       if (is_mate())
1735           result = true;
1736
1737       undo_move(move);
1738   }
1739
1740   // Undo null move, if necessary
1741   if (c != stm)
1742       undo_null_move();
1743
1744   return result;
1745 }
1746
1747
1748 /// Position::init_zobrist() is a static member function which initializes the
1749 /// various arrays used to compute hash keys.
1750
1751 void Position::init_zobrist() {
1752
1753   for (int i = 0; i < 2; i++)
1754       for (int j = 0; j < 8; j++)
1755           for (int k = 0; k < 64; k++)
1756               zobrist[i][j][k] = Key(genrand_int64());
1757
1758   for (int i = 0; i < 64; i++)
1759       zobEp[i] = Key(genrand_int64());
1760
1761   for (int i = 0; i < 16; i++)
1762       zobCastle[i] = genrand_int64();
1763
1764   zobSideToMove = genrand_int64();
1765
1766   for (int i = 0; i < 2; i++)
1767       for (int j = 0; j < 8; j++)
1768           for (int k = 0; k < 16; k++)
1769               zobMaterial[i][j][k] = (k > 0)? Key(genrand_int64()) : Key(0LL);
1770
1771   for (int i = 0; i < 16; i++)
1772       zobMaterial[0][KING][i] = zobMaterial[1][KING][i] = Key(0ULL);
1773 }
1774
1775
1776 /// Position::init_piece_square_tables() initializes the piece square tables.
1777 /// This is a two-step operation:  First, the white halves of the tables are
1778 /// copied from the MgPST[][] and EgPST[][] arrays, with a small random number
1779 /// added to each entry if the "Randomness" UCI parameter is non-zero.
1780 /// Second, the black halves of the tables are initialized by mirroring
1781 /// and changing the sign of the corresponding white scores.
1782
1783 void Position::init_piece_square_tables() {
1784
1785   int r = get_option_value_int("Randomness"), i;
1786   for (Square s = SQ_A1; s <= SQ_H8; s++)
1787       for (Piece p = WP; p <= WK; p++)
1788       {
1789           i = (r == 0)? 0 : (genrand_int32() % (r*2) - r);
1790           MgPieceSquareTable[p][s] = Value(MgPST[p][s] + i);
1791           EgPieceSquareTable[p][s] = Value(EgPST[p][s] + i);
1792       }
1793
1794   for (Square s = SQ_A1; s <= SQ_H8; s++)
1795       for (Piece p = BP; p <= BK; p++)
1796       {
1797           MgPieceSquareTable[p][s] = -MgPieceSquareTable[p-8][flip_square(s)];
1798           EgPieceSquareTable[p][s] = -EgPieceSquareTable[p-8][flip_square(s)];
1799       }
1800 }
1801
1802
1803 /// Position::flipped_copy() makes a copy of the input position, but with
1804 /// the white and black sides reversed. This is only useful for debugging,
1805 /// especially for finding evaluation symmetry bugs.
1806
1807 void Position::flipped_copy(const Position& pos) {
1808
1809   assert(pos.is_ok());
1810
1811   clear();
1812
1813   // Board
1814   for (Square s = SQ_A1; s <= SQ_H8; s++)
1815       if (!pos.square_is_empty(s))
1816           put_piece(Piece(int(pos.piece_on(s)) ^ 8), flip_square(s));
1817
1818   // Side to move
1819   sideToMove = opposite_color(pos.side_to_move());
1820
1821   // Castling rights
1822   if (pos.can_castle_kingside(WHITE))  allow_oo(BLACK);
1823   if (pos.can_castle_queenside(WHITE)) allow_ooo(BLACK);
1824   if (pos.can_castle_kingside(BLACK))  allow_oo(WHITE);
1825   if (pos.can_castle_queenside(BLACK)) allow_ooo(WHITE);
1826
1827   initialKFile  = pos.initialKFile;
1828   initialKRFile = pos.initialKRFile;
1829   initialQRFile = pos.initialQRFile;
1830
1831   for (Square sq = SQ_A1; sq <= SQ_H8; sq++)
1832       castleRightsMask[sq] = ALL_CASTLES;
1833
1834   castleRightsMask[make_square(initialKFile,  RANK_1)] ^= (WHITE_OO | WHITE_OOO);
1835   castleRightsMask[make_square(initialKFile,  RANK_8)] ^= (BLACK_OO | BLACK_OOO);
1836   castleRightsMask[make_square(initialKRFile, RANK_1)] ^=  WHITE_OO;
1837   castleRightsMask[make_square(initialKRFile, RANK_8)] ^=  BLACK_OO;
1838   castleRightsMask[make_square(initialQRFile, RANK_1)] ^=  WHITE_OOO;
1839   castleRightsMask[make_square(initialQRFile, RANK_8)] ^=  BLACK_OOO;
1840
1841   // En passant square
1842   if (pos.st->epSquare != SQ_NONE)
1843       st->epSquare = flip_square(pos.st->epSquare);
1844
1845   // Checkers
1846   find_checkers();
1847
1848   // Hash keys
1849   st->key = compute_key();
1850   st->pawnKey = compute_pawn_key();
1851   st->materialKey = compute_material_key();
1852
1853   // Incremental scores
1854   st->mgValue = compute_value<MidGame>();
1855   st->egValue = compute_value<EndGame>();
1856
1857   // Material
1858   st->npMaterial[WHITE] = compute_non_pawn_material(WHITE);
1859   st->npMaterial[BLACK] = compute_non_pawn_material(BLACK);
1860
1861   assert(is_ok());
1862 }
1863
1864
1865 /// Position::is_ok() performs some consitency checks for the position object.
1866 /// This is meant to be helpful when debugging.
1867
1868 bool Position::is_ok(int* failedStep) const {
1869
1870   // What features of the position should be verified?
1871   static const bool debugBitboards = false;
1872   static const bool debugKingCount = false;
1873   static const bool debugKingCapture = false;
1874   static const bool debugCheckerCount = false;
1875   static const bool debugKey = false;
1876   static const bool debugMaterialKey = false;
1877   static const bool debugPawnKey = false;
1878   static const bool debugIncrementalEval = false;
1879   static const bool debugNonPawnMaterial = false;
1880   static const bool debugPieceCounts = false;
1881   static const bool debugPieceList = false;
1882
1883   if (failedStep) *failedStep = 1;
1884
1885   // Side to move OK?
1886   if (!color_is_ok(side_to_move()))
1887       return false;
1888
1889   // Are the king squares in the position correct?
1890   if (failedStep) (*failedStep)++;
1891   if (piece_on(king_square(WHITE)) != WK)
1892       return false;
1893
1894   if (failedStep) (*failedStep)++;
1895   if (piece_on(king_square(BLACK)) != BK)
1896       return false;
1897
1898   // Castle files OK?
1899   if (failedStep) (*failedStep)++;
1900   if (!file_is_ok(initialKRFile))
1901       return false;
1902
1903   if (!file_is_ok(initialQRFile))
1904       return false;
1905
1906   // Do both sides have exactly one king?
1907   if (failedStep) (*failedStep)++;
1908   if (debugKingCount)
1909   {
1910       int kingCount[2] = {0, 0};
1911       for (Square s = SQ_A1; s <= SQ_H8; s++)
1912           if (type_of_piece_on(s) == KING)
1913               kingCount[color_of_piece_on(s)]++;
1914
1915       if (kingCount[0] != 1 || kingCount[1] != 1)
1916           return false;
1917   }
1918
1919   // Can the side to move capture the opponent's king?
1920   if (failedStep) (*failedStep)++;
1921   if (debugKingCapture)
1922   {
1923       Color us = side_to_move();
1924       Color them = opposite_color(us);
1925       Square ksq = king_square(them);
1926       if (attacks_to(ksq, us))
1927           return false;
1928   }
1929
1930   // Is there more than 2 checkers?
1931   if (failedStep) (*failedStep)++;
1932   if (debugCheckerCount && count_1s(st->checkersBB) > 2)
1933       return false;
1934
1935   // Bitboards OK?
1936   if (failedStep) (*failedStep)++;
1937   if (debugBitboards)
1938   {
1939       // The intersection of the white and black pieces must be empty
1940       if ((pieces_of_color(WHITE) & pieces_of_color(BLACK)) != EmptyBoardBB)
1941           return false;
1942
1943       // The union of the white and black pieces must be equal to all
1944       // occupied squares
1945       if ((pieces_of_color(WHITE) | pieces_of_color(BLACK)) != occupied_squares())
1946           return false;
1947
1948       // Separate piece type bitboards must have empty intersections
1949       for (PieceType p1 = PAWN; p1 <= KING; p1++)
1950           for (PieceType p2 = PAWN; p2 <= KING; p2++)
1951               if (p1 != p2 && (pieces(p1) & pieces(p2)))
1952                   return false;
1953   }
1954
1955   // En passant square OK?
1956   if (failedStep) (*failedStep)++;
1957   if (ep_square() != SQ_NONE)
1958   {
1959       // The en passant square must be on rank 6, from the point of view of the
1960       // side to move.
1961       if (relative_rank(side_to_move(), ep_square()) != RANK_6)
1962           return false;
1963   }
1964
1965   // Hash key OK?
1966   if (failedStep) (*failedStep)++;
1967   if (debugKey && st->key != compute_key())
1968       return false;
1969
1970   // Pawn hash key OK?
1971   if (failedStep) (*failedStep)++;
1972   if (debugPawnKey && st->pawnKey != compute_pawn_key())
1973       return false;
1974
1975   // Material hash key OK?
1976   if (failedStep) (*failedStep)++;
1977   if (debugMaterialKey && st->materialKey != compute_material_key())
1978       return false;
1979
1980   // Incremental eval OK?
1981   if (failedStep) (*failedStep)++;
1982   if (debugIncrementalEval)
1983   {
1984       if (st->mgValue != compute_value<MidGame>())
1985           return false;
1986
1987       if (st->egValue != compute_value<EndGame>())
1988           return false;
1989   }
1990
1991   // Non-pawn material OK?
1992   if (failedStep) (*failedStep)++;
1993   if (debugNonPawnMaterial)
1994   {
1995       if (st->npMaterial[WHITE] != compute_non_pawn_material(WHITE))
1996           return false;
1997
1998       if (st->npMaterial[BLACK] != compute_non_pawn_material(BLACK))
1999           return false;
2000   }
2001
2002   // Piece counts OK?
2003   if (failedStep) (*failedStep)++;
2004   if (debugPieceCounts)
2005       for (Color c = WHITE; c <= BLACK; c++)
2006           for (PieceType pt = PAWN; pt <= KING; pt++)
2007               if (pieceCount[c][pt] != count_1s(pieces(pt, c)))
2008                   return false;
2009
2010   if (failedStep) (*failedStep)++;
2011   if (debugPieceList)
2012   {
2013       for(Color c = WHITE; c <= BLACK; c++)
2014           for(PieceType pt = PAWN; pt <= KING; pt++)
2015               for(int i = 0; i < pieceCount[c][pt]; i++)
2016               {
2017                   if (piece_on(piece_list(c, pt, i)) != (pieces(pt, c)))
2018                       return false;
2019
2020                   if (index[piece_list(c, pt, i)] != i)
2021                       return false;
2022               }
2023   }
2024   if (failedStep) *failedStep = 0;
2025   return true;
2026 }