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