Retire color.h
[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 #if !defined(SQUARE_H_INCLUDED)
21 #define SQUARE_H_INCLUDED
22
23 #include <cstdlib> // for abs()
24 #include <string>
25
26 #include "misc.h"
27 #include "piece.h"
28
29 enum Square {
30   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
31   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
32   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
33   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
34   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
35   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
36   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
37   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
38   SQ_NONE,
39
40   DELTA_N =  8,
41   DELTA_E =  1,
42   DELTA_S = -8,
43   DELTA_W = -1,
44
45   DELTA_NN = DELTA_N + DELTA_N,
46   DELTA_NE = DELTA_N + DELTA_E,
47   DELTA_SE = DELTA_S + DELTA_E,
48   DELTA_SS = DELTA_S + DELTA_S,
49   DELTA_SW = DELTA_S + DELTA_W,
50   DELTA_NW = DELTA_N + DELTA_W
51 };
52
53 enum File {
54   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
55 };
56
57 enum Rank {
58   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
59 };
60
61 enum SquareColor {
62   DARK, LIGHT
63 };
64
65 ENABLE_OPERATORS_ON(Square)
66 ENABLE_OPERATORS_ON(File)
67 ENABLE_OPERATORS_ON(Rank)
68
69 inline Square make_square(File f, Rank r) {
70   return Square((int(r) << 3) | int(f));
71 }
72
73 inline File square_file(Square s) {
74   return File(int(s) & 7);
75 }
76
77 inline Rank square_rank(Square s) {
78   return Rank(int(s) >> 3);
79 }
80
81 inline Square flip_square(Square s) {
82   return Square(int(s) ^ 56);
83 }
84
85 inline Square flop_square(Square s) {
86   return Square(int(s) ^ 7);
87 }
88
89 inline Square relative_square(Color c, Square s) {
90   return Square(int(s) ^ (int(c) * 56));
91 }
92
93 inline Rank relative_rank(Color c, Rank r) {
94   return Rank(int(r) ^ (int(c) * 7));
95 }
96
97 inline Rank relative_rank(Color c, Square s) {
98   return relative_rank(c, square_rank(s));
99 }
100
101 inline SquareColor square_color(Square s) {
102   return SquareColor(int(square_rank(s) + s) & 1);
103 }
104
105 inline bool opposite_color_squares(Square s1, Square s2) {
106   int s = int(s1) ^ int(s2);
107   return ((s >> 3) ^ s) & 1;
108 }
109
110 inline int file_distance(Square s1, Square s2) {
111   return abs(square_file(s1) - square_file(s2));
112 }
113
114 inline int rank_distance(Square s1, Square s2) {
115   return abs(square_rank(s1) - square_rank(s2));
116 }
117
118 inline int square_distance(Square s1, Square s2) {
119   return Max(file_distance(s1, s2), rank_distance(s1, s2));
120 }
121
122 inline File file_from_char(char c) {
123   return File(c - 'a') + FILE_A;
124 }
125
126 inline char file_to_char(File f) {
127   return char(f - FILE_A + int('a'));
128 }
129
130 inline Rank rank_from_char(char c) {
131   return Rank(c - '1') + RANK_1;
132 }
133
134 inline char rank_to_char(Rank r) {
135   return char(r - RANK_1 + int('1'));
136 }
137
138 inline const std::string square_to_string(Square s) {
139   char ch[] = { file_to_char(square_file(s)), rank_to_char(square_rank(s)), 0 };
140   return std::string(ch);
141 }
142
143 inline bool file_is_ok(File f) {
144   return f >= FILE_A && f <= FILE_H;
145 }
146
147 inline bool rank_is_ok(Rank r) {
148   return r >= RANK_1 && r <= RANK_8;
149 }
150
151 inline bool square_is_ok(Square s) {
152   return s >= SQ_A1 && s <= SQ_H8;
153 }
154
155 #endif // !defined(SQUARE_H_INCLUDED)