Use templetized operations for File and Rank
[stockfish] / src / square.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-2010 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
21 #if !defined(SQUARE_H_INCLUDED)
22 #define SQUARE_H_INCLUDED
23
24 ////
25 //// Includes
26 ////
27
28 #include <cstdlib> // for abs()
29 #include <string>
30
31 #include "color.h"
32 #include "misc.h"
33
34
35 ////
36 //// Types
37 ////
38
39 enum Square {
40   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
41   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
42   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
43   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
44   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
45   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
46   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
47   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
48   SQ_NONE
49 };
50
51 enum File {
52   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NONE
53 };
54
55 enum Rank {
56   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NONE
57 };
58
59 enum SquareDelta {
60   DELTA_SSW = -021, DELTA_SS = -020, DELTA_SSE = -017, DELTA_SWW = -012,
61   DELTA_SW = -011, DELTA_S = -010, DELTA_SE = -07, DELTA_SEE = -06,
62   DELTA_W = -01, DELTA_ZERO = 0, DELTA_E = 01, DELTA_NWW = 06, DELTA_NW = 07,
63   DELTA_N = 010, DELTA_NE = 011, DELTA_NEE = 012, DELTA_NNW = 017,
64   DELTA_NN = 020, DELTA_NNE = 021
65 };
66
67
68 ////
69 //// Constants
70 ////
71
72 const int FlipMask = 070;
73 const int FlopMask = 07;
74
75
76 ////
77 //// Inline functions
78 ////
79
80 inline Square operator+ (Square x, int i) { return Square(int(x) + i); }
81 inline void operator++ (Square &x, int) { x = Square(int(x) + 1); }
82 inline void operator+= (Square &x, int i) { x = Square(int(x) + i); }
83 inline Square operator- (Square x, int i) { return Square(int(x) - i); }
84 inline void operator-- (Square &x, int) { x = Square(int(x) - 1); }
85 inline void operator-= (Square &x, int i) { x = Square(int(x) - i); }
86 inline Square operator+ (Square x, SquareDelta i) { return Square(int(x) + i); }
87 inline void operator+= (Square &x, SquareDelta i) { x = Square(int(x) + i); }
88 inline Square operator- (Square x, SquareDelta i) { return Square(int(x) - i); }
89 inline void operator-= (Square &x, SquareDelta i) { x = Square(int(x) - i); }
90
91 inline SquareDelta operator- (Square x, Square y) {
92   return SquareDelta(int(x) - int(y));
93 }
94
95 inline Square make_square(File f, Rank r) {
96   return Square(int(f) | (int(r) << 3));
97 }
98
99 inline File square_file(Square s) {
100   return File(int(s) & 7);
101 }
102
103 inline Rank square_rank(Square s) {
104   return Rank(int(s) >> 3);
105 }
106
107 inline Square flip_square(Square s) {
108   return Square(int(s) ^ FlipMask);
109 }
110
111 inline Square flop_square(Square s) {
112   return Square(int(s) ^ FlopMask);
113 }
114
115 inline Square relative_square(Color c, Square s) {
116   return Square(int(s) ^ (int(c) * FlipMask));
117 }
118
119 inline Rank relative_rank(Color c, Square s) {
120   return square_rank(relative_square(c, s));
121 }
122
123 inline SquareColor square_color(Square s) {
124   return SquareColor((int(square_file(s)) + int(square_rank(s))) & 1);
125 }
126
127 inline bool same_color_squares(Square s1, Square s2) {
128   int s = int(s1) ^ int(s2);
129   return (((s >> 3) ^ s) & 1) == 0;
130 }
131
132 inline int file_distance(File f1, File f2) {
133   return abs(int(f1) - int(f2));
134 }
135
136 inline int file_distance(Square s1, Square s2) {
137   return file_distance(square_file(s1), square_file(s2));
138 }
139
140 inline int rank_distance(Rank r1, Rank r2) {
141   return abs(int(r1) - int(r2));
142 }
143
144 inline int rank_distance(Square s1, Square s2) {
145   return rank_distance(square_rank(s1), square_rank(s2));
146 }
147
148 inline int square_distance(Square s1, Square s2) {
149   return Max(file_distance(s1, s2), rank_distance(s1, s2));
150 }
151
152 inline File file_from_char(char c) {
153   return File(c - 'a') + FILE_A;
154 }
155
156 inline char file_to_char(File f) {
157   return char(f - FILE_A + int('a'));
158 }
159
160 inline Rank rank_from_char(char c) {
161   return Rank(c - '1') + RANK_1;
162 }
163
164 inline char rank_to_char(Rank r) {
165   return char(r - RANK_1 + int('1'));
166 }
167
168 inline Square square_from_string(const std::string& str) {
169   return make_square(file_from_char(str[0]), rank_from_char(str[1]));
170 }
171
172 inline const std::string square_to_string(Square s) {
173   return  std::string(1, file_to_char(square_file(s)))
174         + std::string(1, rank_to_char(square_rank(s)));
175 }
176
177 inline bool file_is_ok(File f) {
178   return f >= FILE_A && f <= FILE_H;
179 }
180
181 inline bool rank_is_ok(Rank r) {
182   return r >= RANK_1 && r <= RANK_8;
183 }
184
185 inline bool square_is_ok(Square s) {
186   return file_is_ok(square_file(s)) && rank_is_ok(square_rank(s));
187 }
188
189 #endif // !defined(SQUARE_H_INCLUDED)