common.h

   1 /*
   2  * common.h -- Common definitions for X and Windows NT versions of XBoard
   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_COMMON
  55 #define XB_COMMON
  56
  57
  58 /* Begin compatibility grunge  */
  59
  60 #if defined(__STDC__) || defined(WIN32) || defined(_amigados)
  61 #define P(args) args
  62 typedef void *VOIDSTAR;
  63 #else
  64 #define P(args)         ()
  65 typedef char *VOIDSTAR;
  66 #endif
  67
  68 #ifdef WIN32
  69 typedef char Boolean;
  70 typedef char *String;
  71 #define popen _popen
  72 #define pclose _pclose
  73
  74 #else
  75 #ifdef _amigados        /*  It is important, that these types have  */
  76 typedef int Boolean;    /*  a length of 4 bytes each, as we are     */
  77 typedef char *String;   /*  using ReadArgs() for argument parsing.  */
  78 #ifdef _DCC
  79 FILE *popen(const char *, const char *);
  80 int pclose(FILE *);
  81 #endif
  82
  83 #else
  84 #ifdef X11
  85 #include <X11/Intrinsic.h>
  86 #else
  87 typedef char Boolean;
  88 typedef char *String;
  89 #define True 1
  90 #define False 0
  91 #endif
  92 #endif
  93 #endif
  94
  95
  96 #ifndef TRUE
  97 #define TRUE 1
  98 #define FALSE 0
  99 #endif
 100
 101 #define UNKNOWN -1 /* [HGM] nps */
 102
 103 #if !HAVE_RANDOM
 104 # if HAVE_RAND48
 105 #  define srandom srand48
 106 #  define random lrand48
 107 # else /* not HAVE_RAND48 */
 108 #  define srandom srand
 109 #  define random rand
 110 # endif /* not HAVE_RAND48 */
 111 #endif /* !HAVE_RANDOM */
 112
 113 /* End compatibility grunge */
 114
 115 /* unsigned int 64 for engine nodes work and display */
 116 #ifdef WIN32
 117        /* I don't know the name for this type of other compiler
 118         * If it not work, just modify here
 119         * This is for MS Visual Studio
 120         */
 121        #ifdef _MSC_VER
 122                #define u64 unsigned __int64
 123                #define s64 signed __int64
 124                #define u64Display "%I64u"
 125                #define s64Display "%I64d"
 126                #define u64Const(c) (c ## UI64)
 127                #define s64Const(c) (c ## I64)
 128        #else
 129                /* place holder
 130                 * or dummy types for other compiler
 131                 * [HGM] seems that -mno-cygwin comple needs %I64?
 132                 */
 133                #define u64 unsigned long long
 134                #define s64 signed long long
 135                #ifdef USE_I64
 136                   #define u64Display "%I64u"
 137                   #define s64Display "%I64d"
 138                #else
 139                   #define u64Display "%llu"
 140                   #define s64Display "%lld"
 141                #endif
 142                #define u64Const(c) (c ## ULL)
 143                #define s64Const(c) (c ## LL)
 144        #endif
 145 #else
 146        /* GNU gcc */
 147        #define u64 unsigned long long
 148        #define s64 signed long long
 149        #define u64Display "%llu"
 150        #define s64Display "%lld"
 151        #define u64Const(c) (c ## ull)
 152        #define s64Const(c) (c ## ll)
 153 #endif
 154
 155 #define PROTOVER                2       /* engine protocol version */
 156
 157 // [HGM] license: Messages that engines must print to satisfy their license requirements for patented variants
 158 #define GOTHIC "Gothic Chess (see www.GothicChess.com) is licensed under U.S. Patent #6,481,716 by Ed Trice"
 159 #define FALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
 160
 161 /* [HGM] Some notes about board sizes:
 162    In games that allow piece drops, the holdings are considered part of the
 163    board, in the leftmost and rightmost two files. This way they are
 164    automatically part of the game-history states, and enjoy all display
 165    functions (including drag-drop and click-click moves to the regular part
 166    of the board). The drawback of this is that the internal numbering of
 167    files starts at 2 for the a-file if holdings are displayed. To ensure
 168    consistency, this shifted numbering system is used _everywhere_ in the
 169    code, and conversion to the 'normal' system only takes place when the
 170    file number is converted to or from ASCII (by redefining the character
 171    constant 'a'). This works because Winboard only communicates with the
 172    outside world in ASCII. In a similar way, the different rank numbering
 173    systems (starting at rank 0 or 1) are implemented by redefining '1'.
 174 */
 175 #define BOARD_RANKS             17            /* [HGM] for in declarations  */
 176 #define BOARD_FILES             16             /* [HGM] for in declarations  */
 177 #define BOARD_HEIGHT (gameInfo.boardHeight)    /* [HGM] made user adjustable */
 178 #define BOARD_WIDTH  (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)
 179 #define BOARD_LEFT   (gameInfo.holdingsWidth)  /* [HGM] play-board edges     */
 180 #define BOARD_RGHT   (gameInfo.boardWidth + gameInfo.holdingsWidth)
 181 #define CASTLING     (BOARD_RANKS-1)           /* [HGM] hide in upper rank   */
 182 #define VIRGIN       (BOARD_RANKS-2)           /* [HGM] pieces not moved     */
 183 #define EP_STATUS    CASTLING][(BOARD_FILES-2) /* [HGM] in upper rank        */
 184 #define HOLDINGS_SET CASTLING][(BOARD_FILES-1) /* [HGM] in upper-right corner*/
 185 #define ONE          ('1'-(BOARD_HEIGHT==10))  /* [HGM] foremost board rank  */
 186 #define AAA          ('a'-BOARD_LEFT)          /* [HGM] leftmost board file  */
 187 #define VIRGIN_W                 1             /* [HGM] flags in Board[VIRGIN][X] */
 188 #define VIRGIN_B                 2
 189 #define DROP_RANK               -3
 190 #define MAX_MOVES               1000
 191 #define MSG_SIZ                 512
 192 #define DIALOG_SIZE             256
 193 #define STAR_MATCH_N            16
 194 #define MOVE_LEN                32
 195 #define TIME_CONTROL            "5"     /* in minutes */
 196 #define TIME_DELAY_QUOTE        "1.0"   /* seconds between moves */
 197 #define TIME_DELAY              ((float) 1.0)
 198 #define MOVES_PER_SESSION       40      /* moves per TIME_CONTROL */
 199 #define TIME_INCREMENT          -1      /* if >= 0, MOVES_PER_SESSION unused */
 200 #define WhiteOnMove(move)       (((move) % 2) == 0)
 201 #define ICS_HOST                "chessclub.com"
 202 #define ICS_PORT                "5000"
 203 #define ICS_COMM_PORT           ""
 204 #define FIRST_HOST              "localhost"
 205 #define SECOND_HOST             "localhost"
 206 #define TELNET_PROGRAM          "telnet"
 207 #define DEF_BITMAP_DIR          BITMAPDIR
 208 #define MATCH_MODE              "False"
 209 #define INIT_STRING             "new\nrandom\n"
 210 #define WHITE_STRING            "white\ngo\n"
 211 #define BLACK_STRING            "black\ngo\n"
 212 #define COMPUTER_STRING         "computer\n"
 213 #define REUSE_CHESS_PROGRAMS    1
 214 #define WHITE_PIECE_COLOR       "#FFFFCC"
 215 #define BLACK_PIECE_COLOR       "#202020"
 216 #define LIGHT_SQUARE_COLOR      "#C8C365"
 217 #define DARK_SQUARE_COLOR       "#77A26D"
 218 #define JAIL_SQUARE_COLOR       "#808080"
 219 #define HIGHLIGHT_SQUARE_COLOR  "#FFFF00"
 220 #define PREMOVE_HIGHLIGHT_COLOR "#FF0000"
 221 #define LOWTIMEWARNING_COLOR    "#FF0000"
 222 #define BELLCHAR                '\007'
 223 #define NULLCHAR                '\000'
 224 #define FEATURE_TIMEOUT         10000 /*ms*/
 225
 226 #define CLOCK_FONT 0
 227 #define MESSAGE_FONT 1
 228 #define COORD_FONT 2
 229 #define CONSOLE_FONT 3
 230 #define COMMENT_FONT 4
 231 #define EDITTAGS_FONT 5
 232 #define MOVEHISTORY_FONT 6
 233 #define GAMELIST_FONT 7
 234 #define NUM_FONTS 8
 235
 236 /* Default to no flashing (the "usual" XBoard behavior) */
 237 #define FLASH_COUNT     0               /* Number of times to flash */
 238 #define FLASH_RATE      5               /* Flashes per second */
 239
 240 /* Default delay per character (in msec) while sending login script */
 241 #define MS_LOGIN_DELAY  0
 242
 243 /* [AS] Support for background textures */
 244 #define BACK_TEXTURE_MODE_DISABLED      0
 245 #define BACK_TEXTURE_MODE_PLAIN         1
 246 #define BACK_TEXTURE_MODE_FULL_RANDOM   2
 247
 248 /* Zippy defaults */
 249 #define ZIPPY_TALK FALSE
 250 #define ZIPPY_PLAY FALSE
 251 #define ZIPPY_LINES "yow.lines"
 252 #define ZIPPY_PINHEAD ""
 253 #define ZIPPY_PASSWORD ""
 254 #define ZIPPY_PASSWORD2 ""
 255 #define ZIPPY_WRONG_PASSWORD ""
 256 #define ZIPPY_ACCEPT_ONLY ""
 257 #define ZIPPY_USE_I TRUE
 258 #define ZIPPY_BUGHOUSE 0
 259 #define ZIPPY_NOPLAY_CRAFTY FALSE
 260 #define ZIPPY_GAME_END "gameend\n"
 261 #define ZIPPY_GAME_START ""
 262 #define ZIPPY_ADJOURN FALSE
 263 #define ZIPPY_ABORT FALSE
 264 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
 265 #define ZIPPY_MAX_GAMES 0
 266 #define ZIPPY_REPLAY_TIMEOUT 120
 267
 268 typedef VOIDSTAR ProcRef;
 269 #define NoProc ((ProcRef) 0)
 270 typedef VOIDSTAR InputSourceRef;
 271
 272 typedef void (*DelayedEventCallback) P((void));
 273
 274 typedef enum { Press, Release } ClickType;
 275
 276 typedef enum {
 277     BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
 278     AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
 279     EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
 280     IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
 281     IcsExamining
 282   } GameMode;
 283
 284 typedef enum {
 285     /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
 286     /* only the first N pieces can go into the holdings, and   */
 287     /* promotions in those variants shift P-W to U-S           */
 288     WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
 289     WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
 290     WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
 291     WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteLion,
 292     WhiteTokin, WhiteDagger, WhitePCardinal, WhitePDragon, WhiteCat,
 293     WhitePSword, WhiteMonarch, WhiteMother, WhiteNothing, WhitePRook, WhitePDagger,
 294     WhiteDolphin, WhiteStag, WhiteHorned, WhiteEagle, WhiteSword,
 295     WhiteCrown, WhiteHCrown, WhiteHorse, WhiteDrunk, WhitePBishop, WhiteKing,
 296     BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
 297     BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
 298     BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
 299     BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackLion,
 300     BlackTokin, BlackDagger, BlackPCardinal, BlackPDragon, BlackCat,
 301     BlackPSword, BlackMonarch, BlackMother, BlackNothing, BlackPRook, BlackPDagger,
 302     BlackDolphin, BlackStag, BlackHorned, BlackEagle, BlackSword,
 303     BlackCrown, BlackHCrown, BlackHorse, BlackDrunk, BlackPBishop, BlackKing,
 304     EmptySquare, DarkSquare,
 305     NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
 306     ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
 307   } ChessSquare;
 308
 309 /* [HGM] some macros that can be used as prefixes to convert piece types */
 310 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
 311 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
 312 #define PROMOTED       (int)WhiteDragon - (int)WhiteRook + (int)
 313 #define DEMOTED        (int)WhiteRook - (int)WhiteDragon + (int)
 314 #define SHOGI          (int)EmptySquare + (int)
 315 #define CHUPROMOTED    ((int)WhitePDragon - (int)WhiteDragon)*(gameInfo.variant == VariantChu) + PROMOTED
 316 #define IS_SHOGI(V)    ((V) == VariantShogi || (V) == VariantChu)
 317 #define IS_LION(V)     ((V) == WhiteLion || (V) == BlackLion)
 318
 319
 320 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
 321
 322 typedef enum {
 323     EndOfFile = 0,
 324     WhiteKingSideCastle, WhiteQueenSideCastle,
 325     WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
 326     WhiteHSideCastleFR, WhiteASideCastleFR,
 327     BlackKingSideCastle, BlackQueenSideCastle,
 328     BlackKingSideCastleWild, BlackQueenSideCastleWild,
 329     BlackHSideCastleFR, BlackASideCastleFR,
 330     WhitePromotion, WhiteNonPromotion,
 331     BlackPromotion, BlackNonPromotion,
 332     WhiteCapturesEnPassant, BlackCapturesEnPassant,
 333     WhiteDrop, BlackDrop, FirstLeg,
 334     NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
 335     WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
 336     GNUChessGame, XBoardGame, MoveNumberOne, Open, Close, Nothing,
 337     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
 338   } ChessMove;
 339
 340 typedef enum {
 341     ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
 342     ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
 343     ColorNone, NColorClasses
 344 } ColorClass;
 345
 346 typedef enum {
 347     SoundMove, SoundBell, SoundRoar, SoundAlarm, SoundIcsWin, SoundIcsLoss,
 348     SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
 349 } SoundClass;
 350
 351 /* Names for chess variants, not necessarily supported */
 352 typedef enum {
 353     VariantNormal,       /* Normal chess */
 354     VariantLoadable,     /* "loadgame" command allowed (not really a variant)*/
 355     VariantWildCastle,   /* Shuffle chess where king can castle from d file */
 356     VariantNoCastle,     /* Shuffle chess with no castling at all */
 357     VariantFischeRandom, /* FischeRandom */
 358     VariantBughouse,     /* Bughouse, ICC/FICS rules */
 359     VariantCrazyhouse,   /* Crazyhouse, ICC/FICS rules */
 360     VariantLosers,       /* Try to lose all pieces or get mated (ICC wild 17)*/
 361     VariantSuicide,      /* Try to lose all pieces incl. king (FICS) */
 362     VariantGiveaway,     /* Try to have no legal moves left (ICC wild 26) */
 363     VariantTwoKings,     /* Weird ICC wild 9 */
 364     VariantKriegspiel,   /* Kriegspiel; pawns can capture invisible pieces */
 365     VariantAtomic,       /* Capturing piece explodes (ICC wild 27) */
 366     Variant3Check,       /* Win by giving check 3 times (ICC wild 25) */
 367     VariantShatranj,     /* Unsupported (ICC wild 28) */
 368     Variant29,           /* Temporary name for possible future ICC wild 29 */
 369     Variant30,           /* Temporary name for possible future ICC wild 30 */
 370     Variant31,           /* Temporary name for possible future ICC wild 31 */
 371     Variant32,           /* Temporary name for possible future ICC wild 32 */
 372     Variant33,           /* Temporary name for possible future ICC wild 33 */
 373     Variant34,           /* Temporary name for possible future ICC wild 34 */
 374     Variant35,           /* Temporary name for possible future ICC wild 35 */
 375     Variant36,           /* Temporary name for possible future ICC wild 36 */
 376     VariantShogi,        /* [HGM] added variants */
 377     VariantChu,
 378     VariantXiangqi,
 379     VariantCourier,
 380     VariantGothic,
 381     VariantCapablanca,
 382     VariantKnightmate,
 383     VariantFairy,
 384     VariantCylinder,
 385     VariantFalcon,
 386     VariantCapaRandom,
 387     VariantBerolina,
 388     VariantJanus,
 389     VariantSuper,
 390     VariantGreat,
 391     VariantTwilight,
 392     VariantMakruk,
 393     VariantASEAN,
 394     VariantSChess,
 395     VariantGrand,
 396     VariantSpartan,
 397     VariantLion,
 398     VariantChuChess,
 399     VariantUnknown       /* Catchall for other unknown variants */
 400 } VariantClass;
 401
 402 #define VARIANT_NAMES { \
 403   "normal", \
 404   "normal", \
 405   "wildcastle", \
 406   "nocastle", \
 407   "fischerandom", \
 408   "bughouse", \
 409   "crazyhouse", \
 410   "losers", \
 411   "suicide", \
 412   "giveaway", \
 413   "twokings", \
 414   "kriegspiel", \
 415   "atomic", \
 416   "3check", \
 417   "shatranj", \
 418   "wild29", \
 419   "wild30", \
 420   "wild31", \
 421   "wild32", \
 422   "wild33", \
 423   "wild34", \
 424   "wild35", \
 425   "wild36", \
 426   "shogi", \
 427   "chu", \
 428   "xiangqi", \
 429   "courier", \
 430   "gothic", \
 431   "capablanca", \
 432   "knightmate", \
 433   "fairy", \
 434   "cylinder", \
 435   "falcon",\
 436   "caparandom",\
 437   "berolina",\
 438   "janus",\
 439   "super",\
 440   "great",\
 441   "twilight",\
 442   "makruk",\
 443   "asean",\
 444   "seirawan",\
 445   "grand",\
 446   "spartan",\
 447   "lion",\
 448   "chuchess",\
 449   "unknown" \
 450 }
 451
 452 #define ENGINES 2
 453
 454 typedef struct {
 455     char *language;
 456 #if !defined(_amigados)
 457     char *whitePieceColor;
 458     char *blackPieceColor;
 459     char *lightSquareColor;
 460     char *darkSquareColor;
 461     char *jailSquareColor;
 462     char *highlightSquareColor;
 463     char *premoveHighlightColor;
 464     char *dialogColor;
 465     char *buttonColor;
 466 #else
 467     int whitePieceColor;
 468     int blackPieceColor;
 469     int lightSquareColor;
 470     int darkSquareColor;
 471     int jailSquareColor;
 472     int highlightSquareColor;
 473     int premoveHighlightColor;
 474 #endif
 475     int movesPerSession;
 476     float timeIncrement;
 477     char *engInitString[ENGINES];
 478     char *computerString[ENGINES];
 479     char *chessProgram[ENGINES];
 480     char *directory[ENGINES];
 481     char *pgnName[ENGINES];
 482     Boolean firstPlaysBlack;
 483     Boolean noChessProgram;
 484     char *host[ENGINES];
 485     char *themeNames;
 486     char *pieceDirectory;
 487     char *border;
 488     char *soundDirectory;
 489     char *remoteShell;
 490     char *remoteUser;
 491     float timeDelay;
 492     char *timeControl;
 493     Boolean trueColors;
 494     Boolean icsActive;
 495     Boolean autoBox;
 496     char *icsHost;
 497     char *icsPort;
 498     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
 499     char *icsLogon;     /* Hack to permit variable logon scripts. */
 500     char *icsHelper;
 501     Boolean icsInputBox;
 502     Boolean useTelnet;
 503     Boolean seekGraph;
 504     Boolean autoRefresh;
 505     char *telnetProgram;
 506     char *gateway;
 507     char *loadGameFile;
 508     int loadGameIndex;      /* game # within file */
 509     char *saveGameFile;
 510     Boolean autoSaveGames;
 511     Boolean onlyOwn;        /* [HGM] suppress auto-saving of observed games */
 512     char *loadPositionFile;
 513     int loadPositionIndex;  /* position # within file */
 514     char *savePositionFile;
 515     Boolean matchMode;
 516     int matchGames;
 517     Boolean monoMode;
 518     Boolean debugMode;
 519     Boolean clockMode;
 520     char *boardSize;
 521     char *logoDir;
 522     int logoSize;
 523     Boolean Iconic;
 524     char *searchTime;
 525     int searchDepth;
 526     Boolean showCoords;
 527     char *clockFont;
 528     char *messageFont; /* WinBoard only */
 529     char *coordFont;
 530     char *font; /* xboard only: all other fonts */
 531     char *tagsFont; /* WinBoard only */
 532     char *commentFont; /* WinBoard only */
 533     char *icsFont; /* WinBoard only */
 534     Boolean ringBellAfterMoves;
 535     Boolean autoCallFlag;
 536     Boolean flipView;
 537     Boolean autoFlipView;
 538     char *cmailGameName; /* xboard only */
 539     Boolean headers;
 540     Boolean alwaysPromoteToQueen;
 541     Boolean oldSaveStyle;
 542     Boolean oneClick;
 543     Boolean quietPlay;
 544     Boolean showThinking;
 545     Boolean ponderNextMove;
 546     Boolean periodicUpdates;
 547     Boolean autoObserve;
 548     Boolean autoCreateLogon;
 549     Boolean autoComment;
 550     Boolean getMoveList;
 551     Boolean testLegality;
 552     Boolean topLevel;      /* xboard, top-level auxiliary windows */
 553     Boolean titleInWindow; /* xboard only */
 554     Boolean localLineEditing; /* WinBoard only */
 555     Boolean zippyTalk;
 556     Boolean zippyPlay;
 557     int flashCount; /* Number of times to flash (xboard only) */
 558     int flashRate; /* Flashes per second (xboard only)  */
 559     int msLoginDelay;  /* Delay per character (in msec) while sending
 560                           ICS logon script (xboard only) */
 561     Boolean colorize;   /* If True, use the following colors to color text */
 562     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 563     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 564     char *colorSShout;
 565     char *colorChannel1;
 566     char *colorChannel;
 567     char *colorKibitz;
 568     char *colorTell;
 569     char *colorChallenge;
 570     char *colorRequest;
 571     char *colorSeek;
 572     char *colorNormal;
 573     char *soundProgram; /* sound-playing program */
 574     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 575     char *soundSShout;
 576     char *soundChannel1;
 577     char *soundChannel;
 578     char *soundKibitz;
 579     char *soundTell;
 580     char *soundChallenge;
 581     char *soundRequest;
 582     char *soundSeek;
 583     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 584     char *soundBell;
 585     char *soundRoar;
 586     char *soundIcsAlarm;
 587     char *soundIcsWin;
 588     char *soundIcsLoss;
 589     char *soundIcsDraw;
 590     char *soundIcsUnfinished;
 591     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
 592     Boolean reuse[ENGINES];
 593     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 594     Boolean animate;    /* If True, animate non-mouse moves */
 595     int animSpeed;      /* Delay in milliseconds between animation frames */
 596     Boolean popupMoveErrors;
 597     Boolean popupExitMessage;
 598     int showJail;
 599     Boolean highlightLastMove;
 600     Boolean highlightDragging;
 601     Boolean blindfold;          /* if true, no pieces are drawn */
 602     Boolean premove;            /* true if premove feature enabled */
 603     Boolean premoveWhite;       /* true if premoving White first move  */
 604     char *premoveWhiteText;     /* text of White premove 1 */
 605     Boolean premoveBlack;       /* true if premoving Black first move */
 606     char *premoveBlackText;     /* text of Black premove 1 */
 607     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 608     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 609     Boolean autoRaiseBoard;
 610     int fontSizeTolerance; /* xboard only */
 611     char *initialMode;
 612     char *variant;
 613     char *chatBoxes;
 614     int protocolVersion[ENGINES];
 615     Boolean showButtonBar;
 616     Boolean icsEngineAnalyze;
 617     Boolean variations;         /* [HGM] enable variation-tree walking */
 618     Boolean autoExtend;         /* [HGM] enable playing move(s) of right-clicked PV in analysis mode */
 619
 620     /* [AS] New properties (down to the "ZIPPY" part) */
 621     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
 622     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 623     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 624     Boolean useBitmaps;
 625     Boolean useFont;
 626     Boolean useBorder;
 627     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 628     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 629     int liteBackTextureMode;
 630     int darkBackTextureMode;
 631     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 632     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 633     int fontBackColorWhite;
 634     int fontForeColorWhite;
 635     int fontBackColorBlack;
 636     int fontForeColorBlack;
 637     int fontPieceSize; /* Size of font relative to square (percentage) */
 638     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 639     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 640     int delayBeforeQuit;
 641     int delayAfterQuit;
 642     char * nameOfDebugFile;
 643     char * pgnEventHeader;
 644     int defaultFrcPosition;
 645     char * gameListTags;
 646     Boolean saveOutOfBookInfo;
 647     Boolean showEvalInMoveHistory;
 648     int evalHistColorWhite;
 649     int evalHistColorBlack;
 650     Boolean highlightMoveWithArrow;
 651     Boolean tourney;
 652     char * tourneyOptions;
 653     int highlightArrowColor;
 654     Boolean useStickyWindows;
 655     Boolean bgObserve;   /* [HGM] bughouse */
 656     Boolean dualBoard;   /* [HGM] dual     */
 657     Boolean viewer;
 658     char * viewerOptions;
 659     int adjudicateDrawMoves;
 660     Boolean autoDisplayComment;
 661     Boolean autoDisplayTags;
 662     Boolean isUCI[ENGINES];
 663     Boolean hasOwnBookUCI[ENGINES];
 664     char * adapterCommand;
 665     char * ucciAdapter;
 666     char * polyglotDir;
 667     Boolean usePolyglotBook;
 668     Boolean defNoBook;
 669     char * polyglotBook;
 670     int bookDepth;
 671     int bookStrength;
 672     int defaultHashSize;
 673     int defaultCacheSizeEGTB;
 674     char * defaultPathEGTB;
 675     int defaultMatchGames;
 676
 677     /* [HGM] Board size */
 678     int NrFiles;
 679     int NrRanks;
 680     int holdingsSize;
 681     int matchPause;
 682     char * pieceToCharTable;
 683     char * pieceNickNames;
 684     char * colorNickNames;
 685     Boolean allWhite;
 686     Boolean upsideDown;
 687     Boolean alphaRank;
 688     Boolean testClaims;
 689     Boolean checkMates;
 690     Boolean materialDraws;
 691     Boolean trivialDraws;
 692     int ruleMoves;
 693     int drawRepeats;
 694
 695 #if ZIPPY
 696     char *zippyLines;
 697     char *zippyPinhead;
 698     char *zippyPassword;
 699     char *zippyPassword2;
 700     char *zippyWrongPassword;
 701     char *zippyAcceptOnly;
 702     int zippyUseI;
 703     int zippyBughouse;
 704     int zippyNoplayCrafty;
 705     char *zippyGameEnd;
 706     char *zippyGameStart;
 707     int zippyAdjourn;
 708     int zippyAbort;
 709     char *zippyVariants;
 710     int zippyMaxGames;
 711     int zippyReplayTimeout; /*seconds*/
 712     int zippyShortGame; /* [HGM] aborter   */
 713 #endif
 714     Boolean lowTimeWarning; /* [HGM] low time */
 715     Boolean quitNext;
 716     char *lowTimeWarningColor;
 717
 718     char *serverFileName;
 719     char *serverMovesName;
 720     char *finger;
 721     Boolean suppressLoadMoves;
 722     int serverPause;
 723     int timeOdds[ENGINES];
 724     int drawDepth[ENGINES];
 725     int timeOddsMode;
 726     int accumulateTC[ENGINES];
 727     int NPS[ENGINES];
 728     Boolean autoKibitz;
 729     int engineComments;
 730     int eloThreshold1;  /* [HGM] select   */
 731     int eloThreshold2;
 732     int dateThreshold;
 733     int searchMode;
 734     int stretch;
 735     Boolean ignoreColors;
 736     Boolean findMirror;
 737     char *userName;
 738     int rewindIndex;    /* [HGM] autoinc   */
 739     int sameColorGames; /* [HGM] alternate */
 740     int smpCores;       /* [HGM] SMP       */
 741     char *egtFormats;
 742     int niceEngines;    /* [HGM] nice      */
 743     char *logo[ENGINES];/* [HGM] logo      */
 744     char *pairingEngine;/* [HGM] pairing   */
 745     Boolean autoLogo;
 746     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 747     char *engOptions[ENGINES]; /* [HGM] options   */
 748     char *fenOverride[ENGINES];
 749     char *features[ENGINES];
 750     char *featureDefaults;
 751     char *sysOpen;
 752     Boolean keepAlive;  /* [HGM] alive     */
 753     Boolean forceIllegal;/*[HGM] illegal   */
 754     Boolean noJoin;     /* [HGM] join      */
 755     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 756     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 757     Boolean pasteSelection; /* paste X selection instead of clipboard */
 758     int nrVariations;   /* [HGM] multivar  */
 759     int zoom;           /* [HGM] evalGraph */
 760     int evalThreshold;  /* [HGM] evalGraph */
 761     Boolean dropMenu;   /* [HGM] pv        */
 762     Boolean markers;    /* [HGM] markers   */
 763     Boolean autoCopyPV;
 764     Boolean pieceMenu;
 765     Boolean sweepSelect;
 766     Boolean whitePOV;
 767     Boolean scoreWhite;
 768     Boolean pvSAN[ENGINES];
 769
 770     int recentEngines;
 771     char *recentEngineList;
 772     char *tourneyFile;
 773     char *defName;
 774     char *processes;
 775     char *results;
 776     char *participants;
 777     char *afterGame;
 778     char *afterTourney;
 779     int tourneyType;
 780     int tourneyCycles;
 781     int seedBase;
 782     Boolean roundSync;
 783     Boolean cycleSync;
 784     Boolean numberTag;
 785 } AppData, *AppDataPtr;
 786
 787 /*  PGN tags (for showing in the game list) */
 788 #define LPUSERGLT_SIZE      64
 789
 790 #define GLT_EVENT           'e'
 791 #define GLT_SITE            's'
 792 #define GLT_DATE            'd'
 793 #define GLT_ROUND           'o'
 794 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 795 #define GLT_RESULT          'r'
 796 #define GLT_WHITE_ELO       'w'
 797 #define GLT_BLACK_ELO       'b'
 798 #define GLT_TIME_CONTROL    't'
 799 #define GLT_VARIANT         'v'
 800 #define GLT_OUT_OF_BOOK     'a'
 801 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 802
 803 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 804
 805 #define GLT_ALL_TAGS        "esdoprwbtvac"
 806
 807 #define PGN_OUT_OF_BOOK     "Annotator"
 808
 809 extern AppData appData;
 810
 811 typedef struct {
 812     /* PGN 7-tag info */
 813     char *event;
 814     char *site;
 815     char *date;
 816     char *round;
 817     char *white;
 818     char *black;
 819     ChessMove result;
 820     /* Additional info */
 821     char *fen;          /* NULL or FEN for starting position; input only */
 822     char *resultDetails;
 823     char *timeControl;
 824     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 825     int whiteRating;    /* -1 if unknown */
 826     int blackRating;    /* -1 if unknown */
 827     VariantClass variant;
 828     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 829     int boardWidth;     /* [HGM] adjustable board size */
 830     int boardHeight;
 831 /* [HGM] For Shogi and Crazyhouse: */
 832     int holdingsSize;  /* number of different piece types in holdings       */
 833     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 834 } GameInfo;
 835
 836 /* [AS] Search stats from chessprogram, for the played move */
 837 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 838 typedef struct {
 839     int score;  /* Centipawns */
 840     int depth;  /* Plies */
 841     int time;   /* Milliseconds */
 842 } ChessProgramStats_Move;
 843
 844 /* [AS] Layout management */
 845 typedef struct {
 846     Boolean visible;
 847     int x;
 848     int y;
 849     int width;
 850     int height;
 851 } WindowPlacement;
 852
 853 extern WindowPlacement wpEngineOutput;
 854 extern WindowPlacement wpEvalGraph;
 855 extern WindowPlacement wpMoveHistory;
 856 extern WindowPlacement wpGameList;
 857 extern WindowPlacement wpTags;
 858
 859 #define MAXENGINES 2000
 860
 861 // [HGM] chat
 862 #define MAX_CHAT 5
 863 extern int chatCount;
 864 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 865
 866 // Some prototypes of routines so general they should be available everywhere
 867 /* If status == 0, we are exiting with a benign message, not an error */
 868 void DisplayFatalError P((String message, int error, int status));
 869 void DisplayError P((String message, int error));
 870
 871 // [HGM] generally useful macros; there are way too many memory leaks...
 872 #define FREE(x) if(x) free(x)
 873 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
 874
 875 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
 876 //       in due time we would have to make the actual substitutions all through the source
 877
 878 #define firstInitString       engInitString[0]
 879 #define secondInitString      engInitString[1]
 880 #define firstComputerString   computerString[0]
 881 #define secondComputerString  computerString[1]
 882 #define firstChessProgram     chessProgram[0]
 883 #define secondChessProgram    chessProgram[1]
 884 #define firstDirectory        directory[0]
 885 #define secondDirectory       directory[1]
 886 #define firstProtocolVersion  protocolVersion[0]
 887 #define secondProtocolVersion protocolVersion[1]
 888 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
 889 #define secondScoreIsAbsolute scoreIsAbsolute[1]
 890 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
 891 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
 892 #define firstTimeOdds         timeOdds[0]
 893 #define secondTimeOdds        timeOdds[1]
 894 #define firstAccumulateTC     accumulateTC[0]
 895 #define secondAccumulateTC    accumulateTC[1]
 896 #define firstHost    host[0]
 897 #define secondHost   host[1]
 898 #define reuseFirst   reuse[0]
 899 #define reuseSecond  reuse[1]
 900 #define firstIsUCI   isUCI[0]
 901 #define secondIsUCI  isUCI[1]
 902 #define firstNPS     NPS[0]
 903 #define secondNPS    NPS[1]
 904 #define firstLogo    logo[0]
 905 #define secondLogo   logo[1]
 906 #define fenOverride1 fenOverride[0]
 907 #define fenOverride2 fenOverride[1]
 908 #define firstOptions      engOptions[0]
 909 #define secondOptions     engOptions[1]
 910
 911 #endif