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