2 * backend.h -- Interface exported by XBoard back end
4 * Copyright 1991 by Digital Equipment Corporation, Maynard,
7 * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
8 * 2007, 2008, 2009 Free Software Foundation, Inc.
10 * Enhancements Copyright 2005 Alessandro Scotti
12 * The following terms apply to Digital Equipment Corporation's copyright
14 * ------------------------------------------------------------------------
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.
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
32 * ------------------------------------------------------------------------
34 * The following terms apply to the enhanced version of XBoard
35 * distributed by the Free Software Foundation:
36 * ------------------------------------------------------------------------
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.
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.
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/. *
51 *------------------------------------------------------------------------
52 ** See the file ChangeLog for a revision history. */
57 /* unsigned int 64 for engine nodes work and display */
59 /* I don't know the name for this type of other compiler
60 * If it not work, just modify here
61 * This is for MS Visual Studio
64 #define u64 unsigned __int64
65 #define s64 signed __int64
66 #define u64Display "%I64u"
67 #define s64Display "%I64d"
68 #define u64Const(c) (c ## UI64)
69 #define s64Const(c) (c ## I64)
72 * or dummy types for other compiler
74 #define u64 unsigned long long
75 #define s64 signed long long
76 #define u64Display "%llu"
77 #define s64Display "%lld"
78 #define u64Const(c) (c ## ULL)
79 #define s64Const(c) (c ## LL)
83 #define u64 unsigned long long
84 #define s64 signed long long
85 #define u64Display "%llu"
86 #define s64Display "%lld"
87 #define u64Const(c) (c ## ull)
88 #define s64Const(c) (c ## ll)
94 extern int gotPremove;
95 extern GameMode gameMode;
96 extern int pausing, cmailMsgLoaded, flipView, mute;
97 extern char white_holding[], black_holding[];
98 extern int currentMove, backwardMostMove, forwardMostMove;
99 extern int blackPlaysFirst;
100 extern FILE *debugFP;
101 extern char* programVersion;
102 extern ProcRef firstProgramPR, secondProgramPR;
103 extern Board boards[];
104 extern char marker[BOARD_RANKS][BOARD_FILES];
106 char *CmailMsg P((void));
107 /* Tord: Added the useFEN960 parameter in PositionToFEN() below */
108 char *PositionToFEN P((int move, char* useFEN960));
109 void AlphaRank P((char *s, int n)); /* [HGM] Shogi move preprocessor */
110 void EditPositionPasteFEN P((char *fen));
111 void TimeDelay P((long ms));
112 void SendMultiLineToICS P(( char *text ));
113 void AnalysisPeriodicEvent P((int force));
114 void SetWhiteToPlayEvent P((void));
115 void SetBlackToPlayEvent P((void));
116 void InitBackEnd1 P((void));
117 void InitBackEnd2 P((void));
118 int HasPromotionChoice P((int fromX, int fromY, int toX, int toY, char *choice));
119 int InPalace P((int row, int column));
120 int PieceForSquare P((int x, int y));
121 int OKToStartUserMove P((int x, int y));
122 void Reset P((int redraw, int init));
123 void ResetGameEvent P((void));
124 Boolean HasPattern P(( const char * text, const char * pattern ));
\r
125 Boolean SearchPattern P(( const char * text, const char * pattern ));
\r
126 int LoadGame P((FILE *f, int n, char *title, int useList));
127 int LoadGameFromFile P((char *filename, int n, char *title, int useList));
128 int CmailLoadGame P((FILE *f, int n, char *title, int useList));
129 int ReloadGame P((int offset));
130 int SaveGame P((FILE *f, int dummy, char *dummy2));
131 int SaveGameToFile P((char *filename, int append));
132 int LoadPosition P((FILE *f, int n, char *title));
133 int ReloadPosition P((int offset));
134 int SavePosition P((FILE *f, int dummy, char *dummy2));
135 void EditPositionEvent P((void));
136 void FlipViewEvent P((void));
137 void MachineWhiteEvent P((void));
138 void MachineBlackEvent P((void));
139 void TwoMachinesEvent P((void));
140 void EditGameEvent P((void));
141 void TrainingEvent P((void));
142 void IcsClientEvent P((void));
143 void ForwardEvent P((void));
144 void BackwardEvent P((void));
145 void ToEndEvent P((void));
146 void ToStartEvent P((void));
147 void ToNrEvent P((int to));
148 void RevertEvent P((void));
149 void RetractMoveEvent P((void));
150 void MoveNowEvent P((void));
151 void TruncateGameEvent P((void));
152 void PauseEvent P((void));
153 void CallFlagEvent P((void));
154 void AcceptEvent P((void));
155 void DeclineEvent P((void));
156 void RematchEvent P((void));
157 void DrawEvent P((void));
158 void AbortEvent P((void));
159 void AdjournEvent P((void));
160 void ResignEvent P((void));
161 void UserAdjudicationEvent P((int result));
162 void StopObservingEvent P((void));
163 void StopExaminingEvent P((void));
164 void PonderNextMoveEvent P((int newState));
165 void NewSettingeEvent P((int option, char *command, int value));
166 void ShowThinkingEvent P(());
167 void PeriodicUpdatesEvent P((int newState));
168 void HintEvent P((void));
169 void BookEvent P((void));
170 void AboutGameEvent P((void));
171 void ExitEvent P((int status));
172 char *DefaultFileName P((char *));
173 ChessMove UserMoveTest P((int fromX, int fromY, int toX, int toY, int promoChar, Boolean captureOwn));
174 void UserMoveEvent P((int fromX, int fromY, int toX, int toY, int promoChar));
175 void DecrementClocks P((void));
176 char *TimeString P((long millisec));
177 void AutoPlayGameLoop P((void));
178 void AdjustClock P((Boolean which, int dir));
179 void DisplayBothClocks P((void));
180 void EditPositionMenuEvent P((ChessSquare selection, int x, int y));
181 void DropMenuEvent P((ChessSquare selection, int x, int y));
182 int ParseTimeControl P((char *tc, int ti, int mps));
183 void ProcessICSInitScript P((FILE * f));
184 void EditCommentEvent P((void));
185 void ReplaceComment P((int index, char *text));
186 int ReplaceTags P((char *tags, GameInfo *gi));/* returns nonzero on error */
187 void AppendComment P((int index, char *text, Boolean addBraces));
188 void ReloadCmailMsgEvent P((int unregister));
189 void MailMoveEvent P((void));
190 void EditTagsEvent P((void));
191 void GetMoveListEvent P((void));
192 void ExitAnalyzeMode P((void));
193 void AnalyzeModeEvent P((void));
194 void AnalyzeFileEvent P((void));
195 void InitPosition P((int redraw));
196 void NewSettingEvent P((int option, char *command, int value));
197 void DoEcho P((void));
198 void DontEcho P((void));
199 void TidyProgramName P((char *prog, char *host, char *buf));
200 void AskQuestionEvent P((char *title, char *question,
201 char *replyPrefix, char *which));
202 Boolean ParseOneMove P((char *move, int moveNum,
203 ChessMove *moveType, int *fromX, int *fromY,
204 int *toX, int *toY, char *promoChar));
205 char *VariantName P((VariantClass v));
206 VariantClass StringToVariant P((char *e));
207 double u64ToDouble P((u64 value));
208 void OutputChatMessage P((int partner, char *mess));
209 void EditPositionDone P((Boolean fakeRights));
210 Boolean GetArgValue P((char *name));
211 Boolean LoadPV P((int x, int y));
212 Boolean LoadMultiPV P((int x, int y, char *buf, int index, int *start, int *end));
214 void MovePV P((int x, int y, int h));
216 char *StrStr P((char *string, char *match));
217 char *StrCaseStr P((char *string, char *match));
218 char *StrSave P((char *s));
219 char *StrSavePtr P((char *s, char **savePtr));
220 char *SavePart P((char *));
223 int StrCaseCmp P((char *s1, char *s2));
224 int ToLower P((int c));
225 int ToUpper P((int c));
227 #define StrCaseCmp Stricmp /* Use utility.library functions */
228 #include <proto/utility.h>
231 extern GameInfo gameInfo;
233 /* ICS vars used with backend.c and zippy.c */
234 #define ICS_GENERIC 0
237 #define ICS_CHESSNET 3 /* not really supported */
242 /* pgntags.c prototypes
244 char *PGNTags P((GameInfo *));
245 void PrintPGNTags P((FILE *f, GameInfo *));
246 int ParsePGNTag P((char *, GameInfo *));
247 char *PGNResult P((ChessMove result));
250 /* gamelist.c prototypes
252 /* A game node in the double linked list of games.
254 typedef struct _ListGame {
257 unsigned long offset; /* Byte offset of game within file. */
258 GameInfo gameInfo; /* Note that some entries may be NULL. */
261 extern List gameList;
262 void ClearGameInfo P((GameInfo *));
263 int GameListBuild P((FILE *));
264 void GameListInitGameInfo P((GameInfo *));
265 char *GameListLine P((int, GameInfo *));
266 char * GameListLineFull P(( int, GameInfo *));
268 extern char* StripHighlight P((char *)); /* returns static data */
269 extern char* StripHighlightAndTitle P((char *)); /* returns static data */
270 extern void ics_update_width P((int new_width));
271 extern Boolean set_cont_sequence P((char *new_seq));
272 extern int wrap P((char *dest, char *src, int count, int width, int *lp));
274 typedef enum { CheckBox, ComboBox, TextBox, Button, Spin, ResetButton,
275 SaveButton, FileName, PathName, Slider, Message } Control;
277 typedef struct _OPT { // [HGM] options: descriptor of UCI-style option
278 int value; // current setting, starts as default
281 void *handle; // for use by front end
282 char *textValue; // points to beginning of text value in name field
283 char **choice; // points to array of combo choices in cps->combo
285 char name[MSG_SIZ]; // holds both option name and text value
288 typedef struct _CPS {
293 char *twoMachinesColor; /* "white\n" or "black\n" */
299 char *computerString;
300 int sendTime; /* 0=don't, 1=do, 2=test */
304 int offeredDraw; /* countdown */
306 int useSetboard; /* 0=use "edit"; 1=use "setboard" */
307 int useSAN; /* 0=use coordinate notation; 1=use SAN */
308 int usePing; /* 0=not OK to use ping; 1=OK */
311 int usePlayother;/* 0=not OK to use playother; 1=OK */
312 int useColors; /* 0=avoid obsolete white/black commands; 1=use them */
313 int useUsermove; /* 0=just send move; 1=send "usermove move" */
314 int sendICS; /* 0=don't use "ics" command; 1=do */
315 int sendName; /* 0=don't use "name" command; 1=do */
316 int sdKludge; /* 0=use "sd DEPTH" command; 1=use "depth\nDEPTH" */
317 int stKludge; /* 0=use "st TIME" command; 1=use "level 1 TIME" */
320 char variants[MSG_SIZ];
327 int useFEN960; /* 0=use "KQkq" style FENs, 1=use "HAha" style FENs */
328 int useOOCastle; /* 0="O-O" notation for castling, 1="king capture rook" notation */
329 /* End of additions by Tord */
331 int scoreIsAbsolute; /* [AS] 0=don't know (standard), 1=score is always from white side */
332 int isUCI; /* [AS] 0=no (Winboard), 1=UCI (requires Polyglot) */
333 int hasOwnBookUCI; /* [AS] 0=use GUI or Polyglot book, 1=has own book */
335 /* [HGM] time odds */
336 float timeOdds; /* factor through which we divide time for this engine */
337 int debug; /* [HGM] ignore engine debug lines starting with '#' */
338 int maxNrOfSessions; /* [HGM] secondary TC: max args in 'level' command */
339 int accumulateTC; /* [HGM] secondary TC: how to handle extra sessions */
340 int nps; /* [HGM] nps: factor for node count to replace time */
342 int alphaRank; /* [HGM] shogi: engine uses shogi-type coordinates */
343 int maxCores; /* [HGM] SMP: engine understands cores command */
344 int memSize; /* [HGM] memsize: engine understands memory command */
345 char egtFormats[MSG_SIZ]; /* [HGM] EGT: supported tablebase formats */
346 int bookSuspend; /* [HGM] book: go was deferred because of book hit */
347 int nrOptions; /* [HGM] options: remembered option="..." features */
348 #define MAX_OPTIONS 200
349 Option option[MAX_OPTIONS];
351 char *comboList[20*MAX_OPTIONS];
352 char *optionSettings;
353 void *programLogo; /* [HGM] logo: bitmap of the logo */
354 char *fenOverride; /* [HGM} FRC: force FEN casling & ep fields by hand */
355 char userError; /* [HGM] crash: flag to suppress fatal-error messages*/
\r
358 extern ChessProgramState first, second;
360 /* Search stats from chessprogram */
362 char movelist[2*MSG_SIZ]; /* Last PV we were sent */
363 int depth; /* Current search depth */
364 int nr_moves; /* Total nr of root moves */
365 int moves_left; /* Moves remaining to be searched */
366 char move_name[MOVE_LEN]; /* Current move being searched, if provided */
367 u64 nodes; /* # of nodes searched */
368 int time; /* Search time (centiseconds) */
369 int score; /* Score (centipawns) */
370 int got_only_move; /* If last msg was "(only move)" */
371 int got_fail; /* 0 - nothing, 1 - got "--", 2 - got "++" */
372 int ok_to_send; /* handshaking between send & recv */
373 int line_is_book; /* 1 if movelist is book moves */
374 int seen_stat; /* 1 if we've seen the stat01: line */
377 extern ChessProgramStats_Move pvInfoList[MAX_MOVES];
378 extern int shuffleOpenings;
379 extern ChessProgramStats programStats;
380 extern int opponentKibitzes; // used by wengineo.c
381 extern int errorExitStatus;
\r
383 #endif /* _BACKEND */