moves.h

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