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