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, 2010, 2011, 2012, 2013, 2014, 2015 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 #define SUFFIXES "'!"
  55
  56 extern ChessSquare PromoPiece P((ChessMove moveType));
  57 extern ChessMove PromoCharToMoveType P((int whiteOnMove, int promoChar));
  58 extern char PieceSuffix P((ChessSquare p));
  59 extern ChessSquare CharToPiece P((int c));
  60 extern int PieceToNumber P((ChessSquare p));
  61
  62 extern void CopyBoard P((Board to, Board from));
  63 extern int CompareBoards P((Board board1, Board board2));
  64 extern unsigned char pieceToChar[(int)EmptySquare+1];
  65 extern unsigned char pieceNickName[(int)EmptySquare];
  66 extern char *pieceDesc[(int)EmptySquare];
  67 extern Board initialPosition;
  68 extern Boolean pieceDefs;
  69
  70 typedef void (*MoveCallback) P((Board board, int flags, ChessMove kind,
  71                                 int rf, int ff, int rt, int ft,
  72                                 VOIDSTAR closure));
  73
  74 /* Values for flags arguments */
  75 #define F_WHITE_ON_MOVE 1
  76 #define F_WHITE_KCASTLE_OK 2
  77 #define F_WHITE_QCASTLE_OK 4
  78 #define F_BLACK_KCASTLE_OK 8
  79 #define F_BLACK_QCASTLE_OK 16
  80 #define F_ALL_CASTLE_OK (F_WHITE_KCASTLE_OK | F_WHITE_QCASTLE_OK | \
  81                          F_BLACK_KCASTLE_OK | F_BLACK_QCASTLE_OK)
  82 #define F_IGNORE_CHECK 32
  83 #define F_KRIEGSPIEL_CAPTURE 64 /* pawns can try to capture invisible pieces */
  84 #define F_ATOMIC_CAPTURE 128    /* capturing piece explodes, destroying itself
  85                                    and all non-pawns on adjacent squares;
  86                                    destroying your own king is illegal */
  87 #define F_FRC_TYPE_CASTLING 256 /* generate castlings as captures of own Rook */
  88 #define F_MANDATORY_CAPTURE 0x200
  89 #define F_NULL_MOVE         0x400
  90
  91 /* Special epfile values. [HGM] positive values are non-reversible moves! */
  92 #define EP_NONE (-6)           /* [HGM] Tricky! order matters:            */
  93 #define EP_UNKNOWN (-1)        /*       >= EP_UNKNOWN spoils rep-draw     */
  94 #define EP_CAPTURE (-2)        /*       <= EP_NONE is reversible move     */
  95 #define EP_PAWN_MOVE (-3)
  96 #define EP_IRON_LION (-4)
  97 #define EP_ROYAL_LION (-5)
  98 #define EP_REP_DRAW   (-15)
  99 #define EP_RULE_DRAW  (-14)
 100 #define EP_INSUF_DRAW  (-13)
 101 #define EP_DRAWS (-10)
 102 #define EP_WINS (-9)
 103 #define EP_BEROLIN_A 16        /* [HGM] berolina: add to file if pawn to be taken of a-side of e.p.file */
 104 #define EP_CHECKMATE 100       /* [HGM] verify: record mates in epStatus for easy claim verification    */
 105 #define EP_STALEMATE -16
 106
 107 /* Call callback once for each pseudo-legal move in the given
 108    position, except castling moves.  A move is pseudo-legal if it is
 109    legal, or if it would be legal except that it leaves the king in
 110    check.  In the arguments, epfile is EP_NONE if the previous move
 111    was not a double pawn push, or the file 0..7 if it was, or
 112    EP_UNKNOWN if we don't know and want to allow all e.p. captures.
 113    Promotion moves generated are to Queen only.
 114 */
 115 extern void GenPseudoLegal P((Board board, int flags,
 116                               MoveCallback callback, VOIDSTAR closure, ChessSquare filter));
 117
 118 /* Like GenPseudoLegal, but include castling moves and (unless
 119    F_IGNORE_CHECK is set in the flags) omit moves that would leave the
 120    king in check.  The CASTLE_OK flags are true if castling is not yet
 121    ruled out by a move of the king or rook.  Return TRUE if the player
 122    on move is currently in check and F_IGNORE_CHECK is not set.
 123 */
 124 extern int GenLegal P((Board board, int flags,
 125                         MoveCallback callback, VOIDSTAR closure, ChessSquare filter));
 126
 127 /* If the player on move were to move from (rf, ff) to (rt, ft), would
 128    he leave himself in check?  Or if rf == -1, is the player on move
 129    in check now?  enPassant must be TRUE if the indicated move is an
 130    e.p. capture.  The possibility of castling out of a check along the
 131    back rank is not accounted for (i.e., we still return nonzero), as
 132    this is illegal anyway.  Return value is the number of times the
 133    king is in check. */
 134 extern int CheckTest P((Board board, int flags,
 135                         int rf, int ff, int rt, int ft, int enPassant));
 136
 137 /* Is a move from (rf, ff) to (rt, ft) legal for the player whom the
 138    flags say is on move?  Other arguments as in GenPseudoLegal.
 139    Returns the type of move made, taking promoChar into account. */
 140 extern ChessMove LegalityTest P((Board board, int flags,
 141                                  int rf, int ff, int rt, int ft,
 142                                  int promoChar));
 143
 144 #define MT_NONE 0
 145 #define MT_CHECK 1
 146 #define MT_CHECKMATE 2
 147 #define MT_STALEMATE 3
 148 #define MT_STAINMATE 4 /* [HGM] xq: for games where being stalemated counts as a loss    */
 149 #define MT_STEALMATE 5 /* [HGM] losers: for games where being stalemated counts as a win */
 150 #define MT_TRICKMATE 6 /* [HGM] losers: for games where being checkmated counts as a win */
 151 #define MT_BARE      7 /* [HGM] shatranj: for games where having bare king loses         */
 152 #define MT_DRAW      8 /* [HGM] shatranj: other draws                                    */
 153 #define MT_NOKING    9 /* [HGM] atomic: for games lost through king capture              */
 154
 155 /* Return MT_NONE, MT_CHECK, MT_CHECKMATE, or MT_STALEMATE */
 156 extern int MateTest P((Board board, int flags));
 157
 158 typedef struct {
 159     /* Input data */
 160     ChessSquare pieceIn;        /* EmptySquare if unknown */
 161     int rfIn, ffIn, rtIn, ftIn; /* -1 if unknown */
 162     int promoCharIn;            /* NULLCHAR if unknown */
 163     /* Output data for matched move */
 164     ChessMove kind;
 165     ChessSquare piece;
 166     int rf, ff, rt, ft;
 167     int promoChar; /* 'q' if a promotion and promoCharIn was NULLCHAR */
 168     int count;     /* Number of possibilities found */
 169     int captures;  /* [HGM] oneclick: number of matching captures */
 170 } DisambiguateClosure;
 171
 172 /* Disambiguate a partially-known move */
 173 void Disambiguate P((Board board, int flags, DisambiguateClosure *closure));
 174
 175
 176 /* Convert coordinates to normal algebraic notation.
 177    promoChar must be NULLCHAR or '.' if not a promotion.
 178 */
 179 ChessMove CoordsToAlgebraic P((Board board, int flags,
 180                                int rf, int ff, int rt, int ft,
 181                                int promoChar, char out[MOVE_LEN]));
 182
 183 extern int quickFlag, killX, killY, legNr;