Correct the key bindings fo view menu in texi file
[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 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 _BACKEND
55 #define _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 #include "frontend.h"
99
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 ProcRef firstProgramPR, secondProgramPR;
111 extern Board boards[];
112 extern char marker[BOARD_RANKS][BOARD_FILES];
113
114 char *CmailMsg P((void));
115 /* Tord: Added the useFEN960 parameter in PositionToFEN() below */
116 char *PositionToFEN P((int move, char* useFEN960));
117 void AlphaRank P((char *s, int n)); /* [HGM] Shogi move preprocessor */
118 void EditPositionPasteFEN P((char *fen));
119 void TimeDelay P((long ms));
120 void SendMultiLineToICS P(( char *text ));
121 void AnalysisPeriodicEvent P((int force));
122 void SetWhiteToPlayEvent P((void));
123 void SetBlackToPlayEvent P((void));
124 void UploadGameEvent P((void));
125 void InitBackEnd1 P((void));
126 void InitBackEnd2 P((void));
127 int HasPromotionChoice P((int fromX, int fromY, int toX, int toY, char *choice));
128 int InPalace P((int row, int column));
129 int PieceForSquare P((int x, int y));
130 int OKToStartUserMove P((int x, int y));
131 void Reset P((int redraw, int init));
132 void ResetGameEvent P((void));
133 Boolean HasPattern P(( const char * text, const char * pattern ));\r
134 Boolean SearchPattern P(( const char * text, const char * pattern ));\r
135 int LoadGame P((FILE *f, int n, char *title, int useList));
136 int LoadGameFromFile P((char *filename, int n, char *title, int useList));
137 int CmailLoadGame P((FILE *f, int n, char *title, int useList));
138 int ReloadGame P((int offset));
139 int SaveGame P((FILE *f, int dummy, char *dummy2));
140 int SaveGameToFile P((char *filename, int append));
141 int LoadPosition P((FILE *f, int n, char *title));
142 int ReloadPosition P((int offset));
143 int SavePosition P((FILE *f, int dummy, char *dummy2));
144 int DrawSeekGraph P(());
145 int SeekGraphClick P((ClickType click, int x, int y, int moving));
146 void EditPositionEvent P((void));
147 void FlipViewEvent P((void));
148 void MachineWhiteEvent P((void));
149 void MachineBlackEvent P((void));
150 void TwoMachinesEvent P((void));
151 void EditGameEvent P((void));
152 void TrainingEvent P((void));
153 void IcsClientEvent P((void));
154 void ForwardEvent P((void));
155 void BackwardEvent P((void));
156 void ToEndEvent P((void));
157 void ToStartEvent P((void));
158 void ToNrEvent P((int to));
159 void RevertEvent P((Boolean annotate));
160 void RetractMoveEvent P((void));
161 void MoveNowEvent P((void));
162 void TruncateGameEvent P((void));
163 void PauseEvent P((void));
164 void CallFlagEvent P((void));
165 void AcceptEvent P((void));
166 void DeclineEvent P((void));
167 void RematchEvent P((void));
168 void DrawEvent P((void));
169 void AbortEvent P((void));
170 void AdjournEvent P((void));
171 void ResignEvent P((void));
172 void UserAdjudicationEvent P((int result));
173 void StopObservingEvent P((void));
174 void StopExaminingEvent P((void));
175 void PonderNextMoveEvent P((int newState));
176 void ShowThinkingEvent P(());
177 void PeriodicUpdatesEvent P((int newState));
178 void HintEvent P((void));
179 void BookEvent P((void));
180 void AboutGameEvent P((void));
181 void ExitEvent P((int status));
182 char *DefaultFileName P((char *));
183 ChessMove UserMoveTest P((int fromX, int fromY, int toX, int toY, int promoChar, Boolean captureOwn));
184 void UserMoveEvent P((int fromX, int fromY, int toX, int toY, int promoChar));
185 void DecrementClocks P((void));
186 char *TimeString P((long millisec));
187 void AutoPlayGameLoop P((void));
188 void AdjustClock P((Boolean which, int dir));
189 void DisplayBothClocks P((void));
190 void EditPositionMenuEvent P((ChessSquare selection, int x, int y));
191 void DropMenuEvent P((ChessSquare selection, int x, int y));
192 int ParseTimeControl P((char *tc, float ti, int mps));
193 void EscapeExpand(char *p, char *q);
194 void ProcessICSInitScript P((FILE * f));
195 void EditCommentEvent P((void));
196 void ReplaceComment P((int index, char *text));
197 int ReplaceTags P((char *tags, GameInfo *gi));/* returns nonzero on error */
198 void AppendComment P((int index, char *text, Boolean addBraces));
199 void LoadVariation P((int index, char *text));
200 void ReloadCmailMsgEvent P((int unregister));
201 void MailMoveEvent P((void));
202 void EditTagsEvent P((void));
203 void GetMoveListEvent P((void));
204 void ExitAnalyzeMode P((void));
205 void AnalyzeModeEvent P((void));
206 void AnalyzeFileEvent P((void));
207 void InitPosition P((int redraw));
208 void NewSettingEvent P((int option, int *feature, char *command, int value));
209 int WaitForSecond P((DelayedEventCallback x));
210 void SettingsMenuIfReady P((void));
211 void DoEcho P((void));
212 void DontEcho P((void));
213 void TidyProgramName P((char *prog, char *host, char *buf));
214 void SetGameInfo P((void));
215 void AskQuestionEvent P((char *title, char *question,
216                          char *replyPrefix, char *which));
217 Boolean ParseOneMove P((char *move, int moveNum,
218                         ChessMove *moveType, int *fromX, int *fromY,
219                         int *toX, int *toY, char *promoChar));
220 char *VariantName P((VariantClass v));
221 VariantClass StringToVariant P((char *e));
222 double u64ToDouble P((u64 value));
223 void OutputChatMessage P((int partner, char *mess));
224 void EditPositionDone P((Boolean fakeRights));
225 Boolean GetArgValue P((char *name));
226 Boolean LoadPV P((int x, int y));
227 Boolean LoadMultiPV P((int x, int y, char *buf, int index, int *start, int *end));
228 void UnLoadPV P(());
229 void MovePV P((int x, int y, int h));
230
231 char *StrStr P((char *string, char *match));
232 char *StrCaseStr P((char *string, char *match));
233 char *StrSave P((char *s));
234 char *StrSavePtr P((char *s, char **savePtr));
235 char *SavePart P((char *));
236 char* safeStrCpy P(( char *dst, const char *src, size_t count ));
237
238 #ifndef _amigados
239 int StrCaseCmp P((char *s1, char *s2));
240 int ToLower P((int c));
241 int ToUpper P((int c));
242 #else
243 #define StrCaseCmp Stricmp  /*  Use utility.library functions   */
244 #include <proto/utility.h>
245 #endif
246
247 extern GameInfo gameInfo;
248
249 /* ICS vars used with backend.c and zippy.c */
250 #define ICS_GENERIC 0
251 #define ICS_ICC 1
252 #define ICS_FICS 2
253 #define ICS_CHESSNET 3 /* not really supported */
254 int ics_type;
255
256  
257
258 /* pgntags.c prototypes
259  */
260 char *PGNTags P((GameInfo *));
261 void PrintPGNTags P((FILE *f, GameInfo *));
262 int ParsePGNTag P((char *, GameInfo *));
263 char *PGNResult P((ChessMove result));
264
265
266 /* gamelist.c prototypes
267  */
268 /* A game node in the double linked list of games.
269  */
270 typedef struct _ListGame {
271     ListNode node;
272     int number;
273     unsigned long offset;   /*  Byte offset of game within file.     */
274     GameInfo gameInfo;      /*  Note that some entries may be NULL. */
275 } ListGame;
276  
277 extern ChessSquare gatingPiece;
278 extern List gameList;
279 void ClearGameInfo P((GameInfo *));
280 int GameListBuild P((FILE *));
281 void GameListInitGameInfo P((GameInfo *));
282 char *GameListLine P((int, GameInfo *));
283 char * GameListLineFull P(( int, GameInfo *));
284 void GLT_TagsToList P(( char * tags ));
285 void GLT_ParseList P((void));
286
287 extern char* StripHighlight P((char *));  /* returns static data */
288 extern char* StripHighlightAndTitle P((char *));  /* returns static data */
289 extern void ics_update_width P((int new_width));
290 extern Boolean set_cont_sequence P((char *new_seq));
291 extern int wrap P((char *dest, char *src, int count, int width, int *lp));
292 int Explode P((Board board, int fromX, int fromY, int toX, int toY));
293
294 typedef enum { CheckBox, ComboBox, TextBox, Button, Spin, ResetButton,
295                    SaveButton, FileName, PathName, Slider, Message } Control;
296
297 typedef struct _OPT {   // [HGM] options: descriptor of UCI-style option
298     int value;          // current setting, starts as default
299     int min;
300     int max;
301     void *handle;       // 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[MSG_SIZ]; // holds both option name and text value
306 } Option;
307
308 typedef struct _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 _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 useSAN;      /* 0=use coordinate notation; 1=use SAN */
328     int usePing;     /* 0=not OK to use ping; 1=OK */
329     int lastPing;
330     int lastPong;
331     int usePlayother;/* 0=not OK to use playother; 1=OK */
332     int useColors;   /* 0=avoid obsolete white/black commands; 1=use them */
333     int useUsermove; /* 0=just send move; 1=send "usermove move" */
334     int sendICS;     /* 0=don't use "ics" command; 1=do */
335     int sendName;    /* 0=don't use "name" command; 1=do */
336     int sdKludge;    /* 0=use "sd DEPTH" command; 1=use "depth\nDEPTH" */
337     int stKludge;    /* 0=use "st TIME" command; 1=use "level 1 TIME" */
338     char tidy[MSG_SIZ];
339     int matchWins;
340     char variants[MSG_SIZ];
341     int analysisSupport;
342     int analyzing;
343     int protocolVersion;
344     int initDone;
345
346     /* Added by Tord: */
347     int useFEN960;   /* 0=use "KQkq" style FENs, 1=use "HAha" style FENs */
348     int useOOCastle; /* 0="O-O" notation for castling, 1="king capture rook" notation */
349     /* End of additions by Tord */
350
351     int scoreIsAbsolute; /* [AS] 0=don't know (standard), 1=score is always from white side */
352     int isUCI;           /* [AS] 0=no (Winboard), 1=UCI (requires Polyglot) */
353     int hasOwnBookUCI;   /* [AS] 0=use GUI or Polyglot book, 1=has own book */
354
355     /* [HGM] time odds */
356     float timeOdds; /* factor through which we divide time for this engine  */
357     int debug;      /* [HGM] ignore engine debug lines starting with '#'    */
358     int maxNrOfSessions; /* [HGM] secondary TC: max args in 'level' command */
359     int accumulateTC; /* [HGM] secondary TC: how to handle extra sessions   */
360     int nps;          /* [HGM] nps: factor for node count to replace time   */
361     int supportsNPS;
362     int alphaRank;    /* [HGM] shogi: engine uses shogi-type coordinates    */
363     int maxCores;     /* [HGM] SMP: engine understands cores command        */
364     int memSize;      /* [HGM] memsize: engine understands memory command   */
365     char egtFormats[MSG_SIZ];     /* [HGM] EGT: supported tablebase formats */
366     int bookSuspend;  /* [HGM] book: go was deferred because of book hit    */
367     int nrOptions;    /* [HGM] options: remembered option="..." features    */
368 #define MAX_OPTIONS 200
369     Option option[MAX_OPTIONS];
370     int comboCnt;
371     char *comboList[20*MAX_OPTIONS];
372     char *optionSettings;
373     void *programLogo; /* [HGM] logo: bitmap of the logo                    */
374     char *fenOverride; /* [HGM} FRC: force FEN casling & ep fields by hand  */
375     char userError;    /* [HGM] crash: flag to suppress fatal-error messages*/\r
376 } ChessProgramState;
377
378 extern ChessProgramState first, second;
379
380 /* Search stats from chessprogram */
381 typedef struct {
382   char movelist[2*MSG_SIZ]; /* Last PV we were sent */
383   int depth;              /* Current search depth */
384   int nr_moves;           /* Total nr of root moves */
385   int moves_left;         /* Moves remaining to be searched */
386   char move_name[MOVE_LEN];  /* Current move being searched, if provided */
387   u64 nodes;    /* # of nodes searched */
388   int time;               /* Search time (centiseconds) */
389   int score;              /* Score (centipawns) */
390   int got_only_move;      /* If last msg was "(only move)" */
391   int got_fail;           /* 0 - nothing, 1 - got "--", 2 - got "++" */
392   int ok_to_send;         /* handshaking between send & recv */
393   int line_is_book;       /* 1 if movelist is book moves */
394   int seen_stat;          /* 1 if we've seen the stat01: line */
395 } ChessProgramStats;
396
397 extern ChessProgramStats_Move pvInfoList[MAX_MOVES];
398 extern int shuffleOpenings;
399 extern ChessProgramStats programStats;
400 extern int opponentKibitzes; // used by wengineo.c
401 extern int errorExitStatus;\r
402 void SettingsPopUp P((ChessProgramState *cps)); // [HGM] really in front-end, but CPS not known in frontend.h
403
404 #endif /* _BACKEND */