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 #else
 388     int whitePieceColor;
 389     int blackPieceColor;
 390     int lightSquareColor;
 391     int darkSquareColor;
 392     int jailSquareColor;
 393     int highlightSquareColor;
 394     int premoveHighlightColor;
 395 #endif
 396     int movesPerSession;
 397     float timeIncrement;
 398     char *engInitString[ENGINES];
 399     char *computerString[ENGINES];
 400     char *chessProgram[ENGINES];
 401     char *directory[ENGINES];
 402     char *pgnName[ENGINES];
 403     Boolean firstPlaysBlack;
 404     Boolean noChessProgram;
 405     char *host[ENGINES];
 406     char *bitmapDirectory;
 407     char *soundDirectory;
 408     char *remoteShell;
 409     char *remoteUser;
 410     float timeDelay;
 411     char *timeControl;
 412     Boolean icsActive;
 413     char *icsHost;
 414     char *icsPort;
 415     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
 416     char *icsLogon;     /* Hack to permit variable logon scripts. */
 417     char *icsHelper;
 418     Boolean icsInputBox;
 419     Boolean useTelnet;
 420     Boolean seekGraph;
 421     Boolean autoRefresh;
 422     char *telnetProgram;
 423     char *gateway;
 424     char *loadGameFile;
 425     int loadGameIndex;      /* game # within file */
 426     char *saveGameFile;
 427     Boolean autoSaveGames;
 428     char *loadPositionFile;
 429     int loadPositionIndex;  /* position # within file */
 430     char *savePositionFile;
 431     Boolean matchMode;
 432     int matchGames;
 433     Boolean monoMode;
 434     Boolean debugMode;
 435     Boolean clockMode;
 436     char *boardSize;
 437     Boolean Iconic;
 438     char *searchTime;
 439     int searchDepth;
 440     Boolean showCoords;
 441     char *clockFont;
 442     char *messageFont; /* WinBoard only */
 443     char *coordFont;
 444     char *font; /* xboard only: all other fonts */
 445     char *tagsFont; /* WinBoard only */
 446     char *commentFont; /* WinBoard only */
 447     char *icsFont; /* WinBoard only */
 448     Boolean ringBellAfterMoves;
 449     Boolean autoCallFlag;
 450     Boolean flipView;
 451     Boolean autoFlipView;
 452     char *cmailGameName; /* xboard only */
 453     Boolean alwaysPromoteToQueen;
 454     Boolean oldSaveStyle;
 455     Boolean oneClick;
 456     Boolean quietPlay;
 457     Boolean showThinking;
 458     Boolean ponderNextMove;
 459     Boolean periodicUpdates;
 460     Boolean autoObserve;
 461     Boolean autoComment;
 462     Boolean getMoveList;
 463     Boolean testLegality;
 464     int borderXoffset; /* xboard only */
 465     int borderYoffset; /* xboard only */
 466     Boolean titleInWindow; /* xboard only */
 467     Boolean localLineEditing; /* WinBoard only */
 468     Boolean zippyTalk;
 469     Boolean zippyPlay;
 470     int flashCount; /* Number of times to flash (xboard only) */
 471     int flashRate; /* Flashes per second (xboard only)  */
 472     char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
 473     int msLoginDelay;  /* Delay per character (in msec) while sending
 474                           ICS logon script (xboard only) */
 475     Boolean colorize;   /* If True, use the following colors to color text */
 476     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 477     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 478     char *colorSShout;
 479     char *colorChannel1;
 480     char *colorChannel;
 481     char *colorKibitz;
 482     char *colorTell;
 483     char *colorChallenge;
 484     char *colorRequest;
 485     char *colorSeek;
 486     char *colorNormal;
 487     char *soundProgram; /* sound-playing program */
 488     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 489     char *soundSShout;
 490     char *soundChannel1;
 491     char *soundChannel;
 492     char *soundKibitz;
 493     char *soundTell;
 494     char *soundChallenge;
 495     char *soundRequest;
 496     char *soundSeek;
 497     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 498     char *soundBell;
 499     char *soundIcsAlarm;
 500     char *soundIcsWin;
 501     char *soundIcsLoss;
 502     char *soundIcsDraw;
 503     char *soundIcsUnfinished;
 504     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
 505     Boolean reuse[ENGINES];
 506     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 507     Boolean animate;    /* If True, animate non-mouse moves */
 508     int animSpeed;      /* Delay in milliseconds between animation frames */
 509     Boolean popupMoveErrors;
 510     Boolean popupExitMessage;
 511     int showJail;
 512     Boolean highlightLastMove;
 513     Boolean highlightDragging;
 514     Boolean blindfold;          /* if true, no pieces are drawn */
 515     Boolean premove;            /* true if premove feature enabled */
 516     Boolean premoveWhite;       /* true if premoving White first move  */
 517     char *premoveWhiteText;     /* text of White premove 1 */
 518     Boolean premoveBlack;       /* true if premoving Black first move */
 519     char *premoveBlackText;     /* text of Black premove 1 */
 520     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 521     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 522     Boolean autoRaiseBoard;
 523     int fontSizeTolerance; /* xboard only */
 524     char *initialMode;
 525     char *variant;
 526     char *chatBoxes;
 527     int protocolVersion[ENGINES];
 528     Boolean showButtonBar;
 529     Boolean icsEngineAnalyze;
 530     Boolean variations;         /* [HGM] enable variation-tree walking */
 531
 532     /* [AS] New properties (down to the "ZIPPY" part) */
 533     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
 534     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 535     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 536     Boolean useBitmaps;
 537     Boolean useFont;
 538     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 539     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 540     int liteBackTextureMode;
 541     int darkBackTextureMode;
 542     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 543     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 544     int fontBackColorWhite;
 545     int fontForeColorWhite;
 546     int fontBackColorBlack;
 547     int fontForeColorBlack;
 548     int fontPieceSize; /* Size of font relative to square (percentage) */
 549     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 550     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 551     int delayBeforeQuit;
 552     int delayAfterQuit;
 553     char * nameOfDebugFile;
 554     char * pgnEventHeader;
 555     int defaultFrcPosition;
 556     char * gameListTags;
 557     Boolean saveOutOfBookInfo;
 558     Boolean showEvalInMoveHistory;
 559     int evalHistColorWhite;
 560     int evalHistColorBlack;
 561     Boolean highlightMoveWithArrow;
 562     int highlightArrowColor;
 563     Boolean useStickyWindows;
 564     Boolean bgObserve;   /* [HGM] bughouse */
 565     Boolean dualBoard;   /* [HGM] dual     */
 566     Boolean viewer;
 567     char * viewerOptions;
 568     int adjudicateDrawMoves;
 569     Boolean autoDisplayComment;
 570     Boolean autoDisplayTags;
 571     Boolean isUCI[ENGINES];
 572     Boolean hasOwnBookUCI[ENGINES];
 573     char * adapterCommand;
 574     char * ucciAdapter;
 575     char * polyglotDir;
 576     Boolean usePolyglotBook;
 577     Boolean defNoBook;
 578     char * polyglotBook;
 579     int bookDepth;
 580     int bookStrength;
 581     int defaultHashSize;
 582     int defaultCacheSizeEGTB;
 583     char * defaultPathEGTB;
 584     int defaultMatchGames;
 585
 586     /* [HGM] Board size */
 587     int NrFiles;
 588     int NrRanks;
 589     int holdingsSize;
 590     int matchPause;
 591     char * pieceToCharTable;
 592     char * pieceNickNames;
 593     char * colorNickNames;
 594     Boolean allWhite;
 595     Boolean upsideDown;
 596     Boolean alphaRank;
 597     Boolean testClaims;
 598     Boolean checkMates;
 599     Boolean materialDraws;
 600     Boolean trivialDraws;
 601     int ruleMoves;
 602     int drawRepeats;
 603
 604 #if ZIPPY
 605     char *zippyLines;
 606     char *zippyPinhead;
 607     char *zippyPassword;
 608     char *zippyPassword2;
 609     char *zippyWrongPassword;
 610     char *zippyAcceptOnly;
 611     int zippyUseI;
 612     int zippyBughouse;
 613     int zippyNoplayCrafty;
 614     char *zippyGameEnd;
 615     char *zippyGameStart;
 616     int zippyAdjourn;
 617     int zippyAbort;
 618     char *zippyVariants;
 619     int zippyMaxGames;
 620     int zippyReplayTimeout; /*seconds*/
 621     int zippyShortGame; /* [HGM] aborter   */
 622 #endif
 623     Boolean lowTimeWarning; /* [HGM] low time */
 624     char *lowTimeWarningColor;
 625
 626     char *serverMovesName;
 627     Boolean suppressLoadMoves;
 628     int serverPause;
 629     int timeOdds[ENGINES];
 630     int timeOddsMode;
 631     int accumulateTC[ENGINES];
 632     int NPS[ENGINES];
 633     Boolean autoKibitz;
 634     int engineComments;
 635     int eloThreshold1;  /* [HGM] select   */
 636     int eloThreshold2;
 637     int dateThreshold;
 638     int searchMode;
 639     int stretch;
 640     Boolean ignoreColors;
 641     Boolean findMirror;
 642     char *userName;
 643     int rewindIndex;    /* [HGM] autoinc   */
 644     int sameColorGames; /* [HGM] alternate */
 645     int smpCores;       /* [HGM] SMP       */
 646     char *egtFormats;
 647     int niceEngines;    /* [HGM] nice      */
 648     char *logo[ENGINES];/* [HGM] logo      */
 649     char *pairingEngine;/* [HGM] pairing   */
 650     Boolean autoLogo;
 651     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 652     char *engOptions[ENGINES]; /* [HGM] options   */
 653     char *fenOverride[ENGINES];
 654     char *features[ENGINES];
 655     char *featureDefaults;
 656     Boolean keepAlive;  /* [HGM] alive     */
 657     Boolean forceIllegal;/*[HGM] illegal   */
 658     Boolean noJoin;     /* [HGM] join      */
 659     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 660     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 661     Boolean pasteSelection; /* paste X selection instead of clipboard */
 662     int nrVariations;   /* [HGM] multivar  */
 663     int zoom;           /* [HGM] evalGraph */
 664     int evalThreshold;  /* [HGM] evalGraph */
 665     Boolean dropMenu;   /* [HGM] pv        */
 666     Boolean markers;    /* [HGM] markers   */
 667     Boolean pieceMenu;
 668     Boolean sweepSelect;
 669     Boolean whitePOV;
 670     Boolean scoreWhite;
 671     Boolean pvSAN[ENGINES];
 672
 673     int recentEngines;
 674     char *recentEngineList;
 675     char *tourneyFile;
 676     char *defName;
 677     char *processes;
 678     char *results;
 679     char *participants;
 680     char *afterGame;
 681     char *afterTourney;
 682     int tourneyType;
 683     int tourneyCycles;
 684     int seedBase;
 685     Boolean roundSync;
 686     Boolean cycleSync;
 687     Boolean numberTag;
 688 } AppData, *AppDataPtr;
 689
 690 /*  PGN tags (for showing in the game list) */
 691 #define LPUSERGLT_SIZE      64
 692
 693 #define GLT_EVENT           'e'
 694 #define GLT_SITE            's'
 695 #define GLT_DATE            'd'
 696 #define GLT_ROUND           'o'
 697 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 698 #define GLT_RESULT          'r'
 699 #define GLT_WHITE_ELO       'w'
 700 #define GLT_BLACK_ELO       'b'
 701 #define GLT_TIME_CONTROL    't'
 702 #define GLT_VARIANT         'v'
 703 #define GLT_OUT_OF_BOOK     'a'
 704 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 705
 706 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 707
 708 #define GLT_ALL_TAGS        "esdoprwbtvac"
 709
 710 #define PGN_OUT_OF_BOOK     "Annotator"
 711
 712 extern AppData appData;
 713
 714 typedef struct {
 715     /* PGN 7-tag info */
 716     char *event;
 717     char *site;
 718     char *date;
 719     char *round;
 720     char *white;
 721     char *black;
 722     ChessMove result;
 723     /* Additional info */
 724     char *fen;          /* NULL or FEN for starting position; input only */
 725     char *resultDetails;
 726     char *timeControl;
 727     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 728     int whiteRating;    /* -1 if unknown */
 729     int blackRating;    /* -1 if unknown */
 730     VariantClass variant;
 731     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 732     int boardWidth;     /* [HGM] adjustable board size */
 733     int boardHeight;
 734 /* [HGM] For Shogi and Crazyhouse: */
 735     int holdingsSize;  /* number of different piece types in holdings       */
 736     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 737 } GameInfo;
 738
 739 /* [AS] Search stats from chessprogram, for the played move */
 740 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 741 typedef struct {
 742     int score;  /* Centipawns */
 743     int depth;  /* Plies */
 744     int time;   /* Milliseconds */
 745 } ChessProgramStats_Move;
 746
 747 /* [AS] Layout management */
 748 typedef struct {
 749     Boolean visible;
 750     int x;
 751     int y;
 752     int width;
 753     int height;
 754 } WindowPlacement;
 755
 756 extern WindowPlacement wpEngineOutput;
 757 extern WindowPlacement wpEvalGraph;
 758 extern WindowPlacement wpMoveHistory;
 759 extern WindowPlacement wpGameList;
 760 extern WindowPlacement wpTags;
 761
 762 #define MAXENGINES 2000
 763
 764 // [HGM] chat
 765 #define MAX_CHAT 5
 766 extern int chatCount;
 767 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 768
 769 // [HGM] generally useful macros; there are way too many memory leaks...
 770 #define FREE(x) if(x) free(x)
 771 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
 772
 773 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
 774 //       in due time we would have to make the actual substitutions all through the source
 775
 776 #define firstInitString       engInitString[0]
 777 #define secondInitString      engInitString[1]
 778 #define firstComputerString   computerString[0]
 779 #define secondComputerString  computerString[1]
 780 #define firstChessProgram     chessProgram[0]
 781 #define secondChessProgram    chessProgram[1]
 782 #define firstDirectory        directory[0]
 783 #define secondDirectory       directory[1]
 784 #define firstProtocolVersion  protocolVersion[0]
 785 #define secondProtocolVersion protocolVersion[1]
 786 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
 787 #define secondScoreIsAbsolute scoreIsAbsolute[1]
 788 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
 789 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
 790 #define firstTimeOdds         timeOdds[0]
 791 #define secondTimeOdds        timeOdds[1]
 792 #define firstAccumulateTC     accumulateTC[0]
 793 #define secondAccumulateTC    accumulateTC[1]
 794 #define firstHost    host[0]
 795 #define secondHost   host[1]
 796 #define reuseFirst   reuse[0]
 797 #define reuseSecond  reuse[1]
 798 #define firstIsUCI   isUCI[0]
 799 #define secondIsUCI  isUCI[1]
 800 #define firstNPS     NPS[0]
 801 #define secondNPS    NPS[1]
 802 #define firstLogo    logo[0]
 803 #define secondLogo   logo[1]
 804 #define fenOverride1 fenOverride[0]
 805 #define fenOverride2 fenOverride[1]
 806 #define firstOptions      engOptions[0]
 807 #define secondOptions     engOptions[1]
 808
 809 #endif
 810