06573c78ce14424b12f00608c751f8f60095e6f8
[stockfish] / src / notation.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-2013 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include <cassert>
21 #include <iomanip>
22 #include <sstream>
23 #include <stack>
24
25 #include "movegen.h"
26 #include "notation.h"
27 #include "position.h"
28
29 using namespace std;
30
31 static const char* PieceToChar[COLOR_NB] = { " PNBRQK", " pnbrqk" };
32
33
34 /// score_to_uci() converts a value to a string suitable for use with the UCI
35 /// protocol specifications:
36 ///
37 /// cp <x>     The score from the engine's point of view in centipawns.
38 /// mate <y>   Mate in y moves, not plies. If the engine is getting mated
39 ///            use negative values for y.
40
41 string score_to_uci(Value v, Value alpha, Value beta) {
42
43   stringstream s;
44
45   if (abs(v) < VALUE_MATE_IN_MAX_PLY)
46       s << "cp " << v * 100 / int(PawnValueMg);
47   else
48       s << "mate " << (v > 0 ? VALUE_MATE - v + 1 : -VALUE_MATE - v) / 2;
49
50   s << (v >= beta ? " lowerbound" : v <= alpha ? " upperbound" : "");
51
52   return s.str();
53 }
54
55
56 /// move_to_uci() converts a move to a string in coordinate notation
57 /// (g1f3, a7a8q, etc.). The only special case is castling moves, where we print
58 /// in the e1g1 notation in normal chess mode, and in e1h1 notation in chess960
59 /// mode. Internally castle moves are always coded as "king captures rook".
60
61 const string move_to_uci(Move m, bool chess960) {
62
63   Square from = from_sq(m);
64   Square to = to_sq(m);
65
66   if (m == MOVE_NONE)
67       return "(none)";
68
69   if (m == MOVE_NULL)
70       return "0000";
71
72   if (type_of(m) == CASTLE && !chess960)
73       to = (to > from ? FILE_G : FILE_C) | rank_of(from);
74
75   string move = square_to_string(from) + square_to_string(to);
76
77   if (type_of(m) == PROMOTION)
78       move += PieceToChar[BLACK][promotion_type(m)]; // Lower case
79
80   return move;
81 }
82
83
84 /// move_from_uci() takes a position and a string representing a move in
85 /// simple coordinate notation and returns an equivalent legal Move if any.
86
87 Move move_from_uci(const Position& pos, string& str) {
88
89   if (str.length() == 5) // Junior could send promotion piece in uppercase
90       str[4] = char(tolower(str[4]));
91
92   for (MoveList<LEGAL> it(pos); *it; ++it)
93       if (str == move_to_uci(*it, pos.is_chess960()))
94           return *it;
95
96   return MOVE_NONE;
97 }
98
99
100 /// move_to_san() takes a position and a legal Move as input and returns its
101 /// short algebraic notation representation.
102
103 const string move_to_san(Position& pos, Move m) {
104
105   if (m == MOVE_NONE)
106       return "(none)";
107
108   if (m == MOVE_NULL)
109       return "(null)";
110
111   assert(MoveList<LEGAL>(pos).contains(m));
112
113   Bitboard others, b;
114   string san;
115   Color us = pos.side_to_move();
116   Square from = from_sq(m);
117   Square to = to_sq(m);
118   Piece pc = pos.piece_on(from);
119   PieceType pt = type_of(pc);
120
121   if (type_of(m) == CASTLE)
122       san = to > from ? "O-O" : "O-O-O";
123   else
124   {
125       if (pt != PAWN)
126       {
127           san = PieceToChar[WHITE][pt]; // Upper case
128
129           // Disambiguation if we have more then one piece of type 'pt' that can
130           // reach 'to' with a legal move.
131           others = b = (pos.attacks_from(pc, to) & pos.pieces(us, pt)) ^ from;
132
133           while (b)
134           {
135               Move move = make_move(pop_lsb(&b), to);
136               if (!pos.legal(move, pos.pinned_pieces()))
137                   others ^= from_sq(move);
138           }
139
140           if (others)
141           {
142               if (!(others & file_bb(from)))
143                   san += file_to_char(file_of(from));
144
145               else if (!(others & rank_bb(from)))
146                   san += rank_to_char(rank_of(from));
147
148               else
149                   san += square_to_string(from);
150           }
151       }
152       else if (pos.capture(m))
153           san = file_to_char(file_of(from));
154
155       if (pos.capture(m))
156           san += 'x';
157
158       san += square_to_string(to);
159
160       if (type_of(m) == PROMOTION)
161           san += string("=") + PieceToChar[WHITE][promotion_type(m)];
162   }
163
164   if (pos.gives_check(m, CheckInfo(pos)))
165   {
166       StateInfo st;
167       pos.do_move(m, st);
168       san += MoveList<LEGAL>(pos).size() ? "+" : "#";
169       pos.undo_move(m);
170   }
171
172   return san;
173 }
174
175
176 /// pretty_pv() formats human-readable search information, typically to be
177 /// appended to the search log file. It uses the two helpers below to pretty
178 /// format time and score respectively.
179
180 static string time_to_string(int64_t msecs) {
181
182   const int MSecMinute = 1000 * 60;
183   const int MSecHour   = 1000 * 60 * 60;
184
185   int64_t hours   =   msecs / MSecHour;
186   int64_t minutes =  (msecs % MSecHour) / MSecMinute;
187   int64_t seconds = ((msecs % MSecHour) % MSecMinute) / 1000;
188
189   stringstream s;
190
191   if (hours)
192       s << hours << ':';
193
194   s << setfill('0') << setw(2) << minutes << ':' << setw(2) << seconds;
195
196   return s.str();
197 }
198
199 static string score_to_string(Value v) {
200
201   stringstream s;
202
203   if (v >= VALUE_MATE_IN_MAX_PLY)
204       s << "#" << (VALUE_MATE - v + 1) / 2;
205
206   else if (v <= VALUE_MATED_IN_MAX_PLY)
207       s << "-#" << (VALUE_MATE + v) / 2;
208
209   else
210       s << setprecision(2) << fixed << showpos << float(v) / PawnValueMg;
211
212   return s.str();
213 }
214
215 string pretty_pv(Position& pos, int depth, Value value, int64_t msecs, Move pv[]) {
216
217   const int64_t K = 1000;
218   const int64_t M = 1000000;
219
220   std::stack<StateInfo> st;
221   Move* m = pv;
222   string san, padding;
223   size_t length;
224   stringstream s;
225
226   s << setw(2) << depth
227     << setw(8) << score_to_string(value)
228     << setw(8) << time_to_string(msecs);
229
230   if (pos.nodes_searched() < M)
231       s << setw(8) << pos.nodes_searched() / 1 << "  ";
232
233   else if (pos.nodes_searched() < K * M)
234       s << setw(7) << pos.nodes_searched() / K << "K  ";
235
236   else
237       s << setw(7) << pos.nodes_searched() / M << "M  ";
238
239   padding = string(s.str().length(), ' ');
240   length = padding.length();
241
242   while (*m != MOVE_NONE)
243   {
244       san = move_to_san(pos, *m);
245
246       if (length + san.length() > 80)
247       {
248           s << "\n" + padding;
249           length = padding.length();
250       }
251
252       s << san << ' ';
253       length += san.length() + 1;
254
255       st.push(StateInfo());
256       pos.do_move(*m++, st.top());
257   }
258
259   while (m != pv)
260       pos.undo_move(*--m);
261
262   return s.str();
263 }