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