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