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