git.sesse.net Git - stockfish/blob - 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 "color.h"
  27 #include "misc.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
  41 enum File {
  42   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
  43 };
  44
  45 enum Rank {
  46   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
  47 };
  48
  49 enum SquareDelta {
  50
  51   DELTA_N = 8, DELTA_E = 1, DELTA_S = -8, DELTA_W = -1, DELTA_NONE = 0,
  52
  53   DELTA_NN = DELTA_N + DELTA_N,
  54   DELTA_NE = DELTA_N + DELTA_E,
  55   DELTA_SE = DELTA_S + DELTA_E,
  56   DELTA_SS = DELTA_S + DELTA_S,
  57   DELTA_SW = DELTA_S + DELTA_W,
  58   DELTA_NW = DELTA_N + DELTA_W
  59 };
  60
  61 ENABLE_OPERATORS_ON(Square)
  62 ENABLE_OPERATORS_ON(File)
  63 ENABLE_OPERATORS_ON(Rank)
  64 ENABLE_OPERATORS_ON(SquareDelta)
  65
  66 const int FlipMask = 56;
  67 const int FlopMask =  7;
  68
  69 inline Square operator+ (Square x, SquareDelta i) { return x + Square(i); }
  70 inline void operator+= (Square& x, SquareDelta i) { x = x + Square(i); }
  71 inline Square operator- (Square x, SquareDelta i) { return x - Square(i); }
  72 inline void operator-= (Square& x, SquareDelta i) { x = x - Square(i); }
  73
  74 inline Square make_square(File f, Rank r) {
  75   return Square(int(f) | (int(r) << 3));
  76 }
  77
  78 inline File square_file(Square s) {
  79   return File(int(s) & 7);
  80 }
  81
  82 inline Rank square_rank(Square s) {
  83   return Rank(int(s) >> 3);
  84 }
  85
  86 inline Square flip_square(Square s) {
  87   return Square(int(s) ^ FlipMask);
  88 }
  89
  90 inline Square flop_square(Square s) {
  91   return Square(int(s) ^ FlopMask);
  92 }
  93
  94 inline Square relative_square(Color c, Square s) {
  95   return Square(int(s) ^ (int(c) * FlipMask));
  96 }
  97
  98 inline Rank relative_rank(Color c, Rank r) {
  99   return Rank(int(r) ^ (int(c) * 7));
 100 }
 101
 102 inline Rank relative_rank(Color c, Square s) {
 103   return relative_rank(c, square_rank(s));
 104 }
 105
 106 inline SquareColor square_color(Square s) {
 107   return SquareColor((int(square_file(s)) + int(square_rank(s))) & 1);
 108 }
 109
 110 inline bool opposite_color_squares(Square s1, Square s2) {
 111   int s = int(s1) ^ int(s2);
 112   return ((s >> 3) ^ s) & 1;
 113 }
 114
 115 inline int file_distance(File f1, File f2) {
 116   return abs(int(f1) - int(f2));
 117 }
 118
 119 inline int file_distance(Square s1, Square s2) {
 120   return file_distance(square_file(s1), square_file(s2));
 121 }
 122
 123 inline int rank_distance(Rank r1, Rank r2) {
 124   return abs(int(r1) - int(r2));
 125 }
 126
 127 inline int rank_distance(Square s1, Square s2) {
 128   return rank_distance(square_rank(s1), square_rank(s2));
 129 }
 130
 131 inline int square_distance(Square s1, Square s2) {
 132   return Max(file_distance(s1, s2), rank_distance(s1, s2));
 133 }
 134
 135 inline File file_from_char(char c) {
 136   return File(c - 'a') + FILE_A;
 137 }
 138
 139 inline char file_to_char(File f) {
 140   return char(f - FILE_A + int('a'));
 141 }
 142
 143 inline Rank rank_from_char(char c) {
 144   return Rank(c - '1') + RANK_1;
 145 }
 146
 147 inline char rank_to_char(Rank r) {
 148   return char(r - RANK_1 + int('1'));
 149 }
 150
 151 inline const std::string square_to_string(Square s) {
 152   return  std::string(1, file_to_char(square_file(s)))
 153         + std::string(1, rank_to_char(square_rank(s)));
 154 }
 155
 156 inline bool file_is_ok(File f) {
 157   return f >= FILE_A && f <= FILE_H;
 158 }
 159
 160 inline bool rank_is_ok(Rank r) {
 161   return r >= RANK_1 && r <= RANK_8;
 162 }
 163
 164 inline bool square_is_ok(Square s) {
 165   return s >= SQ_A1 && s <= SQ_H8;
 166 }
 167
 168 #endif // !defined(SQUARE_H_INCLUDED)