moves.h

   1 /*
   2  * moves.h - Move generation and checking
   3  *
   4  * Copyright 1991 by Digital Equipment Corporation, Maynard,
   5  * Massachusetts.
   6  *
   7  * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
   8  * 2007, 2008, 2009 Free Software Foundation, Inc.
   9  *
  10  * Enhancements Copyright 2005 Alessandro Scotti
  11  *
  12  * The following terms apply to Digital Equipment Corporation's copyright
  13  * interest in XBoard:
  14  * ------------------------------------------------------------------------
  15  * All Rights Reserved
  16  *
  17  * Permission to use, copy, modify, and distribute this software and its
  18  * documentation for any purpose and without fee is hereby granted,
  19  * provided that the above copyright notice appear in all copies and that
  20  * both that copyright notice and this permission notice appear in
  21  * supporting documentation, and that the name of Digital not be
  22  * used in advertising or publicity pertaining to distribution of the
  23  * software without specific, written prior permission.
  24  *
  25  * DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  26  * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  27  * DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  28  * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  29  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  30  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  31  * SOFTWARE.
  32  * ------------------------------------------------------------------------
  33  *
  34  * The following terms apply to the enhanced version of XBoard
  35  * distributed by the Free Software Foundation:
  36  * ------------------------------------------------------------------------
  37  *
  38  * GNU XBoard is free software: you can redistribute it and/or modify
  39  * it under the terms of the GNU General Public License as published by
  40  * the Free Software Foundation, either version 3 of the License, or (at
  41  * your option) any later version.
  42  *
  43  * GNU XBoard is distributed in the hope that it will be useful, but
  44  * WITHOUT ANY WARRANTY; without even the implied warranty of
  45  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  46  * General Public License for more details.
  47  *
  48  * You should have received a copy of the GNU General Public License
  49  * along with this program. If not, see http://www.gnu.org/licenses/.  *
  50  *
  51  *------------------------------------------------------------------------
  52  ** See the file ChangeLog for a revision history.  */
  53
  54 extern ChessSquare PromoPiece P((ChessMove moveType));
  55 extern ChessMove PromoCharToMoveType P((int whiteOnMove, int promoChar));
  56 extern char PieceToChar P((ChessSquare p));
  57 extern ChessSquare CharToPiece P((int c));
  58 extern int PieceToNumber P((ChessSquare p));
  59
  60 extern void CopyBoard P((Board to, Board from));
  61 extern int CompareBoards P((Board board1, Board board2));
  62 extern char pieceToChar[(int)EmptySquare+1];
  63
  64 typedef void (*MoveCallback) P((Board board, int flags, ChessMove kind,
  65                                 int rf, int ff, int rt, int ft,
  66                                 VOIDSTAR closure));
  67
  68 /* Values for flags arguments */
  69 #define F_WHITE_ON_MOVE 1
  70 #define F_WHITE_KCASTLE_OK 2
  71 #define F_WHITE_QCASTLE_OK 4
  72 #define F_BLACK_KCASTLE_OK 8
  73 #define F_BLACK_QCASTLE_OK 16
  74 #define F_ALL_CASTLE_OK (F_WHITE_KCASTLE_OK | F_WHITE_QCASTLE_OK | \
  75                          F_BLACK_KCASTLE_OK | F_BLACK_QCASTLE_OK)
  76 #define F_IGNORE_CHECK 32
  77 #define F_KRIEGSPIEL_CAPTURE 64 /* pawns can try to capture invisible pieces */
  78 #define F_ATOMIC_CAPTURE 128    /* capturing piece explodes, destroying itself
  79                                    and all non-pawns on adjacent squares;
  80                                    destroying your own king is illegal */
  81 #define F_FRC_TYPE_CASTLING 256 /* generate castlings as captures of own Rook */
  82 #define F_MANDATORY_CAPTURE 0x200
  83
  84 /* Special epfile values. [HGM] positive values are non-reversible moves! */
  85 #define EP_NONE (-4)           /* [HGM] Tricky! order matters:            */
  86 #define EP_UNKNOWN (-1)        /*       >= EP_UNKNOWN spils rep-draw      */
  87 #define EP_CAPTURE (-2)        /*       <= EP_NONE is reversible move     */
  88 #define EP_PAWN_MOVE (-3)
  89 #define EP_REP_DRAW   (-15)
  90 #define EP_RULE_DRAW  (-14)
  91 #define EP_INSUF_DRAW  (-13)
  92 #define EP_DRAWS (-10)
  93 #define EP_WINS (-9)
  94 #define EP_BEROLIN_A 16        /* [HGM] berolina: add to file if pawn to be taken of a-side of e.p.file */
  95 #define EP_CHECKMATE 100       /* [HGM] verify: record mates in epStatus for easy claim verification    */
  96 #define EP_STALEMATE -16
  97
  98 /* Call callback once for each pseudo-legal move in the given
  99    position, except castling moves.  A move is pseudo-legal if it is
 100    legal, or if it would be legal except that it leaves the king in
 101    check.  In the arguments, epfile is EP_NONE if the previous move
 102    was not a double pawn push, or the file 0..7 if it was, or
 103    EP_UNKNOWN if we don't know and want to allow all e.p. captures.
 104    Promotion moves generated are to Queen only.
 105 */
 106 extern void GenPseudoLegal P((Board board, int flags, int epfile,
 107                               MoveCallback callback, VOIDSTAR closure));
 108
 109 /* Like GenPseudoLegal, but include castling moves and (unless
 110    F_IGNORE_CHECK is set in the flags) omit moves that would leave the
 111    king in check.  The CASTLE_OK flags are true if castling is not yet
 112    ruled out by a move of the king or rook.  Return TRUE if the player
 113    on move is currently in check and F_IGNORE_CHECK is not set.
 114 */
 115 extern int GenLegal P((Board board, int flags, int epfile,
 116                         char castlingRights[], /* [HGM] */
 117                         MoveCallback callback, VOIDSTAR closure));
 118
 119 /* If the player on move were to move from (rf, ff) to (rt, ft), would
 120    he leave himself in check?  Or if rf == -1, is the player on move
 121    in check now?  enPassant must be TRUE if the indicated move is an
 122    e.p. capture.  The possibility of castling out of a check along the
 123    back rank is not accounted for (i.e., we still return nonzero), as
 124    this is illegal anyway.  Return value is the number of times the
 125    king is in check. */
 126 extern int CheckTest P((Board board, int flags,
 127                         int rf, int ff, int rt, int ft, int enPassant));
 128
 129 /* Is a move from (rf, ff) to (rt, ft) legal for the player whom the
 130    flags say is on move?  Other arguments as in GenPseudoLegal.
 131    Returns the type of move made, taking promoChar into account. */
 132 extern ChessMove LegalityTest P((Board board, int flags, int epfile,
 133                                  char castlingRights[], /* [HGM] */
 134                                  int rf, int ff, int rt, int ft,
 135                                  int promoChar));
 136
 137 #define MT_NONE 0
 138 #define MT_CHECK 1
 139 #define MT_CHECKMATE 2
 140 #define MT_STALEMATE 3
 141 #define MT_STAINMATE 4 /* [HGM] xq: for games where being stalemated counts as a loss    */
 142 #define MT_STEALMATE 5 /* [HGM] losers: for games where being stalemated counts as a win */
 143 #define MT_TRICKMATE 6 /* [HGM] losers: for games where being checkmated counts as a win */
 144 #define MT_BARE      7 /* [HGM] shatranj: for games where having bare king loses         */
 145 #define MT_DRAW      8 /* [HGM] shatranj: other draws                                    */
 146 #define MT_NOKING    9 /* [HGM] atomic: for games lost through king capture              */
 147
 148 /* Return MT_NONE, MT_CHECK, MT_CHECKMATE, or MT_STALEMATE */
 149 extern int MateTest P((Board board, int flags, int epfile,
 150                                         char castlingRights[])); /* [HGM] */
 151
 152 typedef struct {
 153     /* Input data */
 154     ChessSquare pieceIn;        /* EmptySquare if unknown */
 155     int rfIn, ffIn, rtIn, ftIn; /* -1 if unknown */
 156     int promoCharIn;            /* NULLCHAR if unknown */
 157     /* Output data for matched move */
 158     ChessMove kind;
 159     ChessSquare piece;
 160     int rf, ff, rt, ft;
 161     int promoChar; /* 'q' if a promotion and promoCharIn was NULLCHAR */
 162     int count;     /* Number of possibilities found */
 163 } DisambiguateClosure;
 164
 165 /* Disambiguate a partially-known move */
 166 void Disambiguate P((Board board, int flags, int epfile,
 167                      DisambiguateClosure *closure));
 168
 169
 170 /* Convert coordinates to normal algebraic notation.
 171    promoChar must be NULLCHAR or '.' if not a promotion.
 172 */
 173 ChessMove CoordsToAlgebraic P((Board board, int flags, int epfile,
 174                                int rf, int ff, int rt, int ft,
 175                                int promoChar, char out[MOVE_LEN]));