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, 2010, 2011, 2012, 2013, 2014 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. */
59 typedef int (*FileProc) P((FILE *f, int n, char *title));
61 extern char *wbOptions;
62 extern int gotPremove;
63 extern GameMode gameMode;
66 extern int pausing, cmailMsgLoaded, flipView, mute;
67 extern char white_holding[], black_holding[];
68 extern int currentMove, backwardMostMove, forwardMostMove;
69 extern int blackPlaysFirst;
71 extern char* programVersion;
72 extern Board boards[];
73 extern char marker[BOARD_RANKS][BOARD_FILES];
74 extern char lastMsg[MSG_SIZ];
75 extern Boolean bookUp;
76 extern int tinyLayout, smallLayout;
77 extern Boolean mcMode;
79 extern char variantError[];
80 extern char lastTalker[];
82 void MarkMenuItem P((char *menuRef, int state));
83 char *CmailMsg P((void));
84 /* Tord: Added the useFEN960 parameter in PositionToFEN() below */
85 char *PositionToFEN P((int move, char* useFEN960, int moveCounts));
86 void AlphaRank P((char *s, int n)); /* [HGM] Shogi move preprocessor */
87 void EditPositionPasteFEN P((char *fen));
88 void TimeDelay P((long ms));
89 void SendMultiLineToICS P(( char *text ));
90 void AnalysisPeriodicEvent P((int force));
91 void SetWhiteToPlayEvent P((void));
92 void SetBlackToPlayEvent P((void));
93 void UploadGameEvent P((void));
94 void InitBackEnd1 P((void));
95 void InitBackEnd2 P((void));
96 int HasPromotionChoice P((int fromX, int fromY, int toX, int toY, char *choice, int sweep));
97 int InPalace P((int row, int column));
98 int PieceForSquare P((int x, int y));
99 int OKToStartUserMove P((int x, int y));
100 void Reset P((int redraw, int init));
101 void ResetGameEvent P((void));
102 Boolean HasPattern P(( const char * text, const char * pattern ));
103 Boolean SearchPattern P(( const char * text, const char * pattern ));
104 int LoadGame P((FILE *f, int n, char *title, int useList));
105 int LoadGameFromFile P((char *filename, int n, char *title, int useList));
106 int CmailLoadGame P((FILE *f, int n, char *title, int useList));
107 int ReloadGame P((int offset));
108 int SaveGame P((FILE *f, int dummy, char *dummy2));
109 int SaveGameToFile P((char *filename, int append));
110 int LoadPosition P((FILE *f, int n, char *title));
111 int ReloadPosition P((int offset));
112 int SavePosition P((FILE *f, int dummy, char *dummy2));
113 int DrawSeekGraph P(());
114 int SeekGraphClick P((ClickType click, int x, int y, int moving));
115 void EditPositionEvent P((void));
116 void FlipViewEvent P((void));
117 void MachineWhiteEvent P((void));
118 void MachineBlackEvent P((void));
119 void TwoMachinesEvent P((void));
120 void EditGameEvent P((void));
121 void TrainingEvent P((void));
122 void IcsClientEvent P((void));
123 void ForwardEvent P((void));
124 void BackwardEvent P((void));
125 void ToEndEvent P((void));
126 void ToStartEvent P((void));
127 void ToNrEvent P((int to));
128 void RevertEvent P((Boolean annotate));
129 void RetractMoveEvent P((void));
130 void MoveNowEvent P((void));
131 void TruncateGameEvent P((void));
132 void PauseEvent P((void));
133 void CallFlagEvent P((void));
134 void ClockClick P((int which));
135 void AcceptEvent P((void));
136 void DeclineEvent P((void));
137 void RematchEvent P((void));
138 void DrawEvent P((void));
139 void AbortEvent P((void));
140 void AdjournEvent P((void));
141 void ResignEvent P((void));
142 void UserAdjudicationEvent P((int result));
143 void StopObservingEvent P((void));
144 void StopExaminingEvent P((void));
145 void PonderNextMoveEvent P((int newState));
146 void ShowThinkingEvent P(());
147 void PeriodicUpdatesEvent P((int newState));
148 void HintEvent P((void));
149 void BookEvent P((void));
150 void AboutGameEvent P((void));
151 void ExitEvent P((int status));
152 char *DefaultFileName P((char *));
153 ChessMove UserMoveTest P((int fromX, int fromY, int toX, int toY, int promoChar, Boolean captureOwn));
154 void UserMoveEvent P((int fromX, int fromY, int toX, int toY, int promoChar));
155 void DecrementClocks P((void));
156 char *TimeString P((long millisec));
157 void AutoPlayGameLoop P((void));
158 void AdjustClock P((Boolean which, int dir));
159 void DisplayBothClocks P((void));
160 void EditPositionMenuEvent P((ChessSquare selection, int x, int y));
161 void DropMenuEvent P((ChessSquare selection, int x, int y));
162 int ParseTimeControl P((char *tc, float ti, int mps));
163 void EscapeExpand(char *p, char *q);
164 void ProcessICSInitScript P((FILE * f));
165 void EditCommentEvent P((void));
166 void ReplaceComment P((int index, char *text));
167 int ReplaceTags P((char *tags, GameInfo *gi));/* returns nonzero on error */
168 void AppendComment P((int index, char *text, Boolean addBraces));
169 void LoadVariation P((int index, char *text));
170 void ReloadCmailMsgEvent P((int unregister));
171 void MailMoveEvent P((void));
172 void EditTagsEvent P((void));
173 void GetMoveListEvent P((void));
174 void ExitAnalyzeMode P((void));
175 int AnalyzeModeEvent P((void));
176 void AnalyzeFileEvent P((void));
177 void MatchEvent P((int mode));
178 void RecentEngineEvent P((int nr));
179 void TypeInEvent P((char first));
180 void TypeInDoneEvent P((char *move));
181 void InitPosition P((int redraw));
182 void NewSettingEvent P((int option, int *feature, char *command, int value));
183 void SettingsMenuIfReady P((void));
184 void DoEcho P((void));
185 void DontEcho P((void));
186 void TidyProgramName P((char *prog, char *host, char *buf));
187 void SetGameInfo P((void));
188 void AskQuestionEvent P((char *title, char *question,
189 char *replyPrefix, char *which));
190 Boolean ParseOneMove P((char *move, int moveNum,
191 ChessMove *moveType, int *fromX, int *fromY,
192 int *toX, int *toY, char *promoChar));
193 char *VariantName P((VariantClass v));
194 VariantClass StringToVariant P((char *e));
195 double u64ToDouble P((u64 value));
196 void OutputChatMessage P((int partner, char *mess));
197 void EditPositionDone P((Boolean fakeRights));
198 Boolean GetArgValue P((char *name));
199 Boolean LoadPV P((int x, int y));
200 Boolean LoadMultiPV P((int x, int y, char *buf, int index, int *start, int *end, int pane));
202 void MovePV P((int x, int y, int h));
203 int PromoScroll P((int x, int y));
204 void EditBookEvent P((void));
205 Boolean DisplayBook P((int moveNr));
206 void SaveToBook P((char *text));
207 void HoverEvent P((int hiX, int hiY, int x, int y));
208 int PackGame P((Board board));
209 Boolean ParseFEN P((Board board, int *blackPlaysFirst, char *fen, Boolean autoSize));
210 void ApplyMove P((int fromX, int fromY, int toX, int toY, int promoChar, Board board));
211 void PackMove P((int fromX, int fromY, int toX, int toY, ChessSquare promoPiece));
212 void ics_printf P((char *format, ...));
213 int GetEngineLine P((char *nick, int engine));
214 void AddGameToBook P((int always));
215 void FlushBook P((void));
217 char *StrStr P((char *string, char *match));
218 char *StrCaseStr P((char *string, char *match));
219 char *StrSave P((char *s));
220 char *StrSavePtr P((char *s, char **savePtr));
221 char *SavePart P((char *));
222 char* safeStrCpy P(( char *dst, const char *src, size_t count ));
225 int StrCaseCmp P((char *s1, char *s2));
226 int ToLower P((int c));
227 int ToUpper P((int c));
229 #define StrCaseCmp Stricmp /* Use utility.library functions */
230 #include <proto/utility.h>
233 extern GameInfo gameInfo;
235 /* ICS vars used with backend.c and zippy.c */
236 enum ICS_TYPE { ICS_GENERIC, ICS_ICC, ICS_FICS, ICS_CHESSNET /* not really supported */ };
237 enum ICS_TYPE ics_type;
239 /* pgntags.c prototypes
241 char *PGNTags P((GameInfo *));
242 void PrintPGNTags P((FILE *f, GameInfo *));
243 int ParsePGNTag P((char *, GameInfo *));
244 char *PGNResult P((ChessMove result));
247 /* gamelist.c prototypes
249 /* A game node in the double linked list of games.
251 typedef struct XB_ListGame {
256 unsigned long offset; /* Byte offset of game within file. */
257 GameInfo gameInfo; /* Note that some entries may be NULL. */
260 extern int doubleClick;
261 extern int storedGames;
262 extern int opponentKibitzes;
263 extern ChessSquare gatingPiece;
264 extern List gameList;
265 extern int lastLoadGameNumber;
266 void ClearGameInfo P((GameInfo *));
267 int GameListBuild P((FILE *));
268 void GameListInitGameInfo P((GameInfo *));
269 char *GameListLine P((int, GameInfo *));
270 char * GameListLineFull P(( int, GameInfo *));
271 void InitSearch P((void));
272 int GameContainsPosition P((FILE *f, ListGame *lg));
273 void GLT_TagsToList P(( char * tags ));
274 void GLT_ParseList P((void));
275 int NamesToList P((char *name, char **engines, char **mnemonics, char *group));
276 int CreateTourney P((char *name));
277 char *MakeName P((char *templ));
278 void SwapEngines P((int n));
279 void Substitute P((char *participants, int expunge));
281 extern char* StripHighlight P((char *)); /* returns static data */
282 extern char* StripHighlightAndTitle P((char *)); /* returns static data */
283 extern void ics_update_width P((int new_width));
284 extern Boolean set_cont_sequence P((char *new_seq));
285 extern int wrap P((char *dest, char *src, int count, int width, int *lp));
286 int Explode P((Board board, int fromX, int fromY, int toX, int toY));
288 typedef enum { CheckBox, ComboBox, TextBox, Button, Spin, ResetButton, SaveButton, ListBox, Graph, PopUp,
289 FileName, PathName, Slider, Message, Fractional, Label, Icon,
290 BoxBegin, BoxEnd, BarBegin, BarEnd, DropDown, Break, EndMark, Skip } Control;
292 typedef struct XB_OPT { // [HGM] options: descriptor of UCI-style option
293 int value; // current setting, starts as default
294 int min; // Also used for flags
296 void *handle; // for use by front end
297 void *target; // for use by front end
298 char *textValue; // points to beginning of text value in name field
299 char **choice; // points to array of combo choices in cps->combo
301 char *name; // holds both option name and text value (in allocated memory)
304 typedef struct XB_CPS {
309 char *twoMachinesColor; /* "white\n" or "black\n" */
313 struct XB_CPS *other;
315 char *computerString;
316 int sendTime; /* 0=don't, 1=do, 2=test */
320 int offeredDraw; /* countdown */
322 int useSetboard; /* 0=use "edit"; 1=use "setboard" */
323 int extendedEdit;/* 1=also set holdings with "edit" */
324 int useSAN; /* 0=use coordinate notation; 1=use SAN */
325 int usePing; /* 0=not OK to use ping; 1=OK */
328 int usePlayother;/* 0=not OK to use playother; 1=OK */
329 int useColors; /* 0=avoid obsolete white/black commands; 1=use them */
330 int useUsermove; /* 0=just send move; 1=send "usermove move" */
331 int sendICS; /* 0=don't use "ics" command; 1=do */
332 int sendName; /* 0=don't use "name" command; 1=do */
333 int sdKludge; /* 0=use "sd DEPTH" command; 1=use "depth\nDEPTH" */
334 int stKludge; /* 0=use "st TIME" command; 1=use "level 1 TIME" */
335 int excludeMoves;/* 0=don't use "exclude" command; 1=do */
345 int useFEN960; /* 0=use "KQkq" style FENs, 1=use "HAha" style FENs */
346 int useOOCastle; /* 0="O-O" notation for castling, 1="king capture rook" notation */
347 /* End of additions by Tord */
349 int scoreIsAbsolute; /* [AS] 0=don't know (standard), 1=score is always from white side */
350 int isUCI; /* [AS] 0=no (Winboard), 1=UCI (requires Polyglot) */
351 int hasOwnBookUCI; /* [AS] 0=use GUI or Polyglot book, 1=has own book */
353 /* [HGM] time odds */
354 float timeOdds; /* factor through which we divide time for this engine */
355 int debug; /* [HGM] ignore engine debug lines starting with '#' */
356 int maxNrOfSessions; /* [HGM] secondary TC: max args in 'level' command */
357 int accumulateTC; /* [HGM] secondary TC: how to handle extra sessions */
358 int drawDepth; /* [HGM] egbb: search depth to play egbb draws */
359 int nps; /* [HGM] nps: factor for node count to replace time */
361 int alphaRank; /* [HGM] shogi: engine uses shogi-type coordinates */
362 int maxCores; /* [HGM] SMP: engine understands cores command */
363 int memSize; /* [HGM] memsize: engine understands memory command */
364 char *egtFormats; /* [HGM] EGT: supported tablebase formats */
365 int bookSuspend; /* [HGM] book: go was deferred because of book hit */
366 int pause; /* [HGM] pause: 1=supports it, 2=actually paused */
367 int highlight; /* [HGM] engine wants to get lift and put commands */
368 int nrOptions; /* [HGM] options: remembered option="..." features */
369 #define MAX_OPTIONS 200
370 Option option[MAX_OPTIONS];
372 char *comboList[20*MAX_OPTIONS];
373 char *optionSettings;
374 void *programLogo; /* [HGM] logo: bitmap of the logo */
375 char *fenOverride; /* [HGM} FRC: force FEN casling & ep fields by hand */
376 char userError; /* [HGM] crash: flag to suppress fatal-error messages*/
377 char reload; /* [HGM] options: flag to resend options with xreuse */
380 extern ChessProgramState first, second;
382 /* Search stats from chessprogram */
384 char movelist[2*MSG_SIZ]; /* Last PV we were sent */
385 int depth; /* Current search depth */
386 int nr_moves; /* Total nr of root moves */
387 int moves_left; /* Moves remaining to be searched */
388 char move_name[MOVE_LEN]; /* Current move being searched, if provided */
389 u64 nodes; /* # of nodes searched */
390 int time; /* Search time (centiseconds) */
391 int score; /* Score (centipawns) */
392 int got_only_move; /* If last msg was "(only move)" */
393 int got_fail; /* 0 - nothing, 1 - got "--", 2 - got "++" */
394 int ok_to_send; /* handshaking between send & recv */
395 int line_is_book; /* 1 if movelist is book moves */
396 int seen_stat; /* 1 if we've seen the stat01: line */
399 extern ChessProgramStats_Move pvInfoList[MAX_MOVES];
400 extern Boolean shuffleOpenings;
401 extern ChessProgramStats programStats;
402 extern int opponentKibitzes; // used by wengineo.c
403 extern int errorExitStatus;
404 extern char *recentEngines;
405 extern char *comboLine;
406 extern Boolean partnerUp, twoBoards;
407 extern char engineVariant[];
408 char *EngineDefinedVariant P((ChessProgramState *cps, int n));
409 void SettingsPopUp P((ChessProgramState *cps)); // [HGM] really in front-end, but CPS not known in frontend.h
410 int WaitForEngine P((ChessProgramState *cps, DelayedEventCallback x));
411 void Load P((ChessProgramState *cps, int n));
412 int MultiPV P((ChessProgramState *cps));
413 void MoveHistorySet P(( char movelist[][2*MOVE_LEN], int first, int last, int current, ChessProgramStats_Move * pvInfo ));
414 void MakeEngineOutputTitle P((void));
415 void LoadTheme P((void));
416 void CreateBookEvent P((void));
417 char *SupportedVariant P((char *list, VariantClass v, int w, int h, int s, int proto, char *engine));
419 /* A point in time */
421 long sec; /* Assuming this is >= 32 bits */
422 int ms; /* Assuming this is >= 16 bits */
425 void GetTimeMark P((TimeMark *));
426 long SubtractTimeMarks P((TimeMark *, TimeMark *));
428 #endif /* XB_BACKEND */