]> git.sesse.net Git - stockfish/blob - src/notation.cpp
Introduce notation.h
[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-2012 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 <string>
24
25 #include "movegen.h"
26 #include "notation.h"
27 #include "position.h"
28
29 using namespace std;
30
31 static const char* PieceToChar = " 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(PawnValueMidgame);
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[promotion_type(m) + 7]; // 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> ml(pos); !ml.end(); ++ml)
93       if (str == move_to_uci(ml.move(), pos.is_chess960()))
94           return ml.move();
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(pos.move_is_legal(m));
112
113   Bitboard attackers;
114   bool ambiguousMove, ambiguousFile, ambiguousRank;
115   string san;
116   Color us = pos.side_to_move();
117   Square from = from_sq(m);
118   Square to = to_sq(m);
119   Piece pc = pos.piece_on(from);
120
121   if (type_of(m) == CASTLE)
122       san = to > from ? "O-O" : "O-O-O";
123   else
124   {
125       if (type_of(pc) != PAWN)
126       {
127           san = PieceToChar[pc];
128
129           // Disambiguation if we have more then one piece with destination 'to'
130           // note that for pawns is not needed because starting file is explicit.
131           ambiguousMove = ambiguousFile = ambiguousRank = false;
132
133           attackers = (pos.attacks_from(pc, to) & pos.pieces(us)) ^ from;
134
135           while (attackers)
136           {
137               Square sq = pop_lsb(&attackers);
138
139               // Pinned pieces are not included in the possible sub-set
140               if (!pos.pl_move_is_legal(make_move(sq, to), pos.pinned_pieces()))
141                   continue;
142
143               ambiguousFile |= file_of(sq) == file_of(from);
144               ambiguousRank |= rank_of(sq) == rank_of(from);
145               ambiguousMove = true;
146           }
147
148           if (ambiguousMove)
149           {
150               if (!ambiguousFile)
151                   san += file_to_char(file_of(from));
152
153               else if (!ambiguousRank)
154                   san += rank_to_char(rank_of(from));
155
156               else
157                   san += square_to_string(from);
158           }
159       }
160       else if (pos.is_capture(m))
161           san = file_to_char(file_of(from));
162
163       if (pos.is_capture(m))
164           san += 'x';
165
166       san += square_to_string(to);
167
168       if (type_of(m) == PROMOTION)
169           san += string("=") + PieceToChar[promotion_type(m)];
170   }
171
172   if (pos.move_gives_check(m, CheckInfo(pos)))
173   {
174       StateInfo st;
175       pos.do_move(m, st);
176       san += MoveList<LEGAL>(pos).size() ? "+" : "#";
177       pos.undo_move(m);
178   }
179
180   return san;
181 }
182
183
184 /// pretty_pv() formats human-readable search information, typically to be
185 /// appended to the search log file. It uses the two helpers below to pretty
186 /// format time and score respectively.
187
188 static string time_to_string(int millisecs) {
189
190   const int MSecMinute = 1000 * 60;
191   const int MSecHour   = 1000 * 60 * 60;
192
193   int hours = millisecs / MSecHour;
194   int minutes =  (millisecs % MSecHour) / MSecMinute;
195   int seconds = ((millisecs % MSecHour) % MSecMinute) / 1000;
196
197   stringstream s;
198
199   if (hours)
200       s << hours << ':';
201
202   s << setfill('0') << setw(2) << minutes << ':' << setw(2) << seconds;
203
204   return s.str();
205 }
206
207 static string score_to_string(Value v) {
208
209   stringstream s;
210
211   if (v >= VALUE_MATE_IN_MAX_PLY)
212       s << "#" << (VALUE_MATE - v + 1) / 2;
213
214   else if (v <= VALUE_MATED_IN_MAX_PLY)
215       s << "-#" << (VALUE_MATE + v) / 2;
216
217   else
218       s << setprecision(2) << fixed << showpos << float(v) / PawnValueMidgame;
219
220   return s.str();
221 }
222
223 string pretty_pv(Position& pos, int depth, Value value, int time, Move pv[]) {
224
225   const int64_t K = 1000;
226   const int64_t M = 1000000;
227
228   StateInfo state[MAX_PLY_PLUS_2], *st = state;
229   Move* m = pv;
230   string san, padding;
231   size_t length;
232   stringstream s;
233
234   s << setw(2) << depth
235     << setw(8) << score_to_string(value)
236     << setw(8) << time_to_string(time);
237
238   if (pos.nodes_searched() < M)
239       s << setw(8) << pos.nodes_searched() / 1 << "  ";
240
241   else if (pos.nodes_searched() < K * M)
242       s << setw(7) << pos.nodes_searched() / K << "K  ";
243
244   else
245       s << setw(7) << pos.nodes_searched() / M << "M  ";
246
247   padding = string(s.str().length(), ' ');
248   length = padding.length();
249
250   while (*m != MOVE_NONE)
251   {
252       san = move_to_san(pos, *m);
253
254       if (length + san.length() > 80)
255       {
256           s << "\n" + padding;
257           length = padding.length();
258       }
259
260       s << san << ' ';
261       length += san.length() + 1;
262
263       pos.do_move(*m++, *st++);
264   }
265
266   while (m != pv)
267       pos.undo_move(*--m);
268
269   return s.str();
270 }