Fix recent-engines menu
[xboard.git] / 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 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 extern char pieceNickName[(int)EmptySquare];
64
65 typedef void (*MoveCallback) P((Board board, int flags, ChessMove kind,
66                                 int rf, int ff, int rt, int ft,
67                                 VOIDSTAR closure));
68
69 /* Values for flags arguments */
70 #define F_WHITE_ON_MOVE 1
71 #define F_WHITE_KCASTLE_OK 2
72 #define F_WHITE_QCASTLE_OK 4
73 #define F_BLACK_KCASTLE_OK 8
74 #define F_BLACK_QCASTLE_OK 16
75 #define F_ALL_CASTLE_OK (F_WHITE_KCASTLE_OK | F_WHITE_QCASTLE_OK | \
76                          F_BLACK_KCASTLE_OK | F_BLACK_QCASTLE_OK)
77 #define F_IGNORE_CHECK 32
78 #define F_KRIEGSPIEL_CAPTURE 64 /* pawns can try to capture invisible pieces */
79 #define F_ATOMIC_CAPTURE 128    /* capturing piece explodes, destroying itself
80                                    and all non-pawns on adjacent squares; 
81                                    destroying your own king is illegal */
82 #define F_FRC_TYPE_CASTLING 256 /* generate castlings as captures of own Rook */
83 #define F_MANDATORY_CAPTURE 0x200
84
85 /* Special epfile values. [HGM] positive values are non-reversible moves! */
86 #define EP_NONE (-4)           /* [HGM] Tricky! order matters:            */
87 #define EP_UNKNOWN (-1)        /*       >= EP_UNKNOWN spils rep-draw      */
88 #define EP_CAPTURE (-2)        /*       <= EP_NONE is reversible move     */
89 #define EP_PAWN_MOVE (-3)
90 #define EP_REP_DRAW   (-15)
91 #define EP_RULE_DRAW  (-14)
92 #define EP_INSUF_DRAW  (-13)
93 #define EP_DRAWS (-10)
94 #define EP_WINS (-9)
95 #define EP_BEROLIN_A 16        /* [HGM] berolina: add to file if pawn to be taken of a-side of e.p.file */
96 #define EP_CHECKMATE 100       /* [HGM] verify: record mates in epStatus for easy claim verification    */
97 #define EP_STALEMATE -16
98
99 /* Call callback once for each pseudo-legal move in the given
100    position, except castling moves.  A move is pseudo-legal if it is
101    legal, or if it would be legal except that it leaves the king in
102    check.  In the arguments, epfile is EP_NONE if the previous move
103    was not a double pawn push, or the file 0..7 if it was, or
104    EP_UNKNOWN if we don't know and want to allow all e.p. captures.
105    Promotion moves generated are to Queen only.
106 */
107 extern void GenPseudoLegal P((Board board, int flags,
108                               MoveCallback callback, VOIDSTAR closure, ChessSquare filter));
109
110 /* Like GenPseudoLegal, but include castling moves and (unless 
111    F_IGNORE_CHECK is set in the flags) omit moves that would leave the
112    king in check.  The CASTLE_OK flags are true if castling is not yet
113    ruled out by a move of the king or rook.  Return TRUE if the player
114    on move is currently in check and F_IGNORE_CHECK is not set.
115 */
116 extern int GenLegal P((Board board, int flags,
117                         MoveCallback callback, VOIDSTAR closure, ChessSquare filter));
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,
133                                  int rf, int ff, int rt, int ft,
134                                  int promoChar));
135
136 #define MT_NONE 0
137 #define MT_CHECK 1
138 #define MT_CHECKMATE 2
139 #define MT_STALEMATE 3
140 #define MT_STAINMATE 4 /* [HGM] xq: for games where being stalemated counts as a loss    */
141 #define MT_STEALMATE 5 /* [HGM] losers: for games where being stalemated counts as a win */
142 #define MT_TRICKMATE 6 /* [HGM] losers: for games where being checkmated counts as a win */
143 #define MT_BARE      7 /* [HGM] shatranj: for games where having bare king loses         */
144 #define MT_DRAW      8 /* [HGM] shatranj: other draws                                    */
145 #define MT_NOKING    9 /* [HGM] atomic: for games lost through king capture              */
146
147 /* Return MT_NONE, MT_CHECK, MT_CHECKMATE, or MT_STALEMATE */
148 extern int MateTest P((Board board, int flags));
149
150 typedef struct {
151     /* Input data */
152     ChessSquare pieceIn;        /* EmptySquare if unknown */
153     int rfIn, ffIn, rtIn, ftIn; /* -1 if unknown */
154     int promoCharIn;            /* NULLCHAR if unknown */
155     /* Output data for matched move */
156     ChessMove kind;
157     ChessSquare piece;
158     int rf, ff, rt, ft;
159     int promoChar; /* 'q' if a promotion and promoCharIn was NULLCHAR */
160     int count;     /* Number of possibilities found */
161     int captures;  /* [HGM] oneclick: number of matching captures */
162 } DisambiguateClosure;
163
164 /* Disambiguate a partially-known move */
165 void Disambiguate P((Board board, int flags, DisambiguateClosure *closure));
166
167
168 /* Convert coordinates to normal algebraic notation.
169    promoChar must be NULLCHAR or '.' if not a promotion.
170 */
171 ChessMove CoordsToAlgebraic P((Board board, int flags,
172                                int rf, int ff, int rt, int ft,
173                                int promoChar, char out[MOVE_LEN]));
174
175 extern int quickFlag;