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 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          "/usr/share/games/xboard/bitmaps.xchess" /* AP: shouldn't be hardcoded directory, but better than nothing at the moment */
 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,
 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     VariantUnknown       /* Catchall for other unknown variants */
 323 } VariantClass;
 324
 325 #define VARIANT_NAMES { \
 326   "normal", \
 327   "normal", \
 328   "wildcastle", \
 329   "nocastle", \
 330   "fischerandom", \
 331   "bughouse", \
 332   "crazyhouse", \
 333   "losers", \
 334   "suicide", \
 335   "giveaway", \
 336   "twokings", \
 337   "kriegspiel", \
 338   "atomic", \
 339   "3check", \
 340   "shatranj", \
 341   "wild29", \
 342   "wild30", \
 343   "wild31", \
 344   "wild32", \
 345   "wild33", \
 346   "wild34", \
 347   "wild35", \
 348   "wild36", \
 349   "shogi", \
 350   "xiangqi", \
 351   "courier", \
 352   "gothic", \
 353   "capablanca", \
 354   "knightmate", \
 355   "fairy", \
 356   "cylinder", \
 357   "falcon",\
 358   "caparandom",\
 359   "berolina",\
 360   "janus",\
 361   "super",\
 362   "great",\
 363   "twilight",\
 364   "makruk",\
 365   "unknown" \
 366 }
 367
 368 typedef struct {
 369     char *language;
 370 #if !defined(_amigados)
 371     char *whitePieceColor;
 372     char *blackPieceColor;
 373     char *lightSquareColor;
 374     char *darkSquareColor;
 375     char *jailSquareColor;
 376     char *highlightSquareColor;
 377     char *premoveHighlightColor;
 378 #else
 379     int whitePieceColor;
 380     int blackPieceColor;
 381     int lightSquareColor;
 382     int darkSquareColor;
 383     int jailSquareColor;
 384     int highlightSquareColor;
 385     int premoveHighlightColor;
 386 #endif
 387     int movesPerSession;
 388     float timeIncrement;
 389     char *initString;
 390     char *secondInitString;
 391     char *firstComputerString;
 392     char *secondComputerString;
 393     char *firstChessProgram;
 394     char *secondChessProgram;
 395     char *firstDirectory;
 396     char *secondDirectory;
 397     Boolean firstPlaysBlack;
 398     Boolean noChessProgram;
 399     char *firstHost;
 400     char *secondHost;
 401     char *bitmapDirectory;
 402     char *remoteShell;
 403     char *remoteUser;
 404     float timeDelay;
 405     char *timeControl;
 406     Boolean icsActive;
 407     char *icsHost;
 408     char *icsPort;
 409     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
 410     char *icsLogon;     /* Hack to permit variable logon scripts. */
 411     char *icsHelper;
 412     Boolean icsInputBox;
 413     Boolean useTelnet;
 414     Boolean seekGraph;
 415     Boolean autoRefresh;
 416     char *telnetProgram;
 417     char *gateway;
 418     char *loadGameFile;
 419     int loadGameIndex;      /* game # within file */
 420     char *saveGameFile;
 421     Boolean autoSaveGames;
 422     char *loadPositionFile;
 423     int loadPositionIndex;  /* position # within file */
 424     char *savePositionFile;
 425     Boolean matchMode;
 426     int matchGames;
 427     Boolean monoMode;
 428     Boolean debugMode;
 429     Boolean clockMode;
 430     char *boardSize;
 431     Boolean Iconic;
 432     char *searchTime;
 433     int searchDepth;
 434     Boolean showCoords;
 435     char *clockFont;
 436     char *messageFont; /* WinBoard only */
 437     char *coordFont;
 438     char *font; /* xboard only: all other fonts */
 439     char *tagsFont; /* WinBoard only */
 440     char *commentFont; /* WinBoard only */
 441     char *icsFont; /* WinBoard only */
 442     Boolean ringBellAfterMoves;
 443     Boolean autoCallFlag;
 444     Boolean flipView;
 445     Boolean autoFlipView;
 446     char *cmailGameName; /* xboard only */
 447     Boolean alwaysPromoteToQueen;
 448     Boolean oldSaveStyle;
 449     Boolean oneClick;
 450     Boolean quietPlay;
 451     Boolean showThinking;
 452     Boolean ponderNextMove;
 453     Boolean periodicUpdates;
 454     Boolean autoObserve;
 455     Boolean autoComment;
 456     Boolean getMoveList;
 457     Boolean testLegality;
 458     int borderXoffset; /* xboard only */
 459     int borderYoffset; /* xboard only */
 460     Boolean titleInWindow; /* xboard only */
 461     Boolean localLineEditing; /* WinBoard only */
 462     Boolean zippyTalk;
 463     Boolean zippyPlay;
 464     int flashCount; /* Number of times to flash (xboard only) */
 465     int flashRate; /* Flashes per second (xboard only)  */
 466     char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
 467     int msLoginDelay;  /* Delay per character (in msec) while sending
 468                           ICS logon script (xboard only) */
 469     Boolean colorize;   /* If True, use the following colors to color text */
 470     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 471     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 472     char *colorSShout;
 473     char *colorChannel1;
 474     char *colorChannel;
 475     char *colorKibitz;
 476     char *colorTell;
 477     char *colorChallenge;
 478     char *colorRequest;
 479     char *colorSeek;
 480     char *colorNormal;
 481     char *soundProgram; /* sound-playing program */
 482     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 483     char *soundSShout;
 484     char *soundChannel1;
 485     char *soundChannel;
 486     char *soundKibitz;
 487     char *soundTell;
 488     char *soundChallenge;
 489     char *soundRequest;
 490     char *soundSeek;
 491     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 492     char *soundBell;
 493     char *soundIcsAlarm;
 494     char *soundIcsWin;
 495     char *soundIcsLoss;
 496     char *soundIcsDraw;
 497     char *soundIcsUnfinished;
 498     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
 499     Boolean reuseFirst;
 500     Boolean reuseSecond;
 501     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 502     Boolean animate;    /* If True, animate non-mouse moves */
 503     int animSpeed;      /* Delay in milliseconds between animation frames */
 504     Boolean popupMoveErrors;
 505     Boolean popupExitMessage;
 506     int showJail;
 507     Boolean highlightLastMove;
 508     Boolean highlightDragging;
 509     Boolean blindfold;          /* if true, no pieces are drawn */
 510     Boolean premove;            /* true if premove feature enabled */
 511     Boolean premoveWhite;       /* true if premoving White first move  */
 512     char *premoveWhiteText;     /* text of White premove 1 */
 513     Boolean premoveBlack;       /* true if premoving Black first move */
 514     char *premoveBlackText;     /* text of Black premove 1 */
 515     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 516     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 517     Boolean autoRaiseBoard;
 518     int fontSizeTolerance; /* xboard only */
 519     char *initialMode;
 520     char *variant;
 521     char *chatBoxes;
 522     int firstProtocolVersion;
 523     int secondProtocolVersion;
 524     Boolean showButtonBar;
 525     Boolean icsEngineAnalyze;
 526     Boolean variations;         /* [HGM] enable variation-tree walking */
 527
 528     /* [AS] New properties (down to the "ZIPPY" part) */
 529     Boolean firstScoreIsAbsolute;  /* If true, engine score is always from white side */
 530     Boolean secondScoreIsAbsolute; /* 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 firstIsUCI;
 565     Boolean secondIsUCI;
 566     Boolean firstHasOwnBookUCI;
 567     Boolean secondHasOwnBookUCI;
 568     char * adapterCommand;
 569     char * polyglotDir;
 570     Boolean usePolyglotBook;
 571     char * polyglotBook;
 572     int bookDepth;
 573     int bookStrength;
 574     int defaultHashSize;
 575     int defaultCacheSizeEGTB;
 576     char * defaultPathEGTB;
 577     int defaultMatchGames;
 578
 579     /* [HGM] Board size */
 580     int NrFiles;
 581     int NrRanks;
 582     int holdingsSize;
 583     int matchPause;
 584     char * pieceToCharTable;
 585     char * pieceNickNames;
 586     char * colorNickNames;
 587     Boolean allWhite;
 588     Boolean upsideDown;
 589     Boolean alphaRank;
 590     Boolean testClaims;
 591     Boolean checkMates;
 592     Boolean materialDraws;
 593     Boolean trivialDraws;
 594     int ruleMoves;
 595     int drawRepeats;
 596
 597 #if ZIPPY
 598     char *zippyLines;
 599     char *zippyPinhead;
 600     char *zippyPassword;
 601     char *zippyPassword2;
 602     char *zippyWrongPassword;
 603     char *zippyAcceptOnly;
 604     int zippyUseI;
 605     int zippyBughouse;
 606     int zippyNoplayCrafty;
 607     char *zippyGameEnd;
 608     char *zippyGameStart;
 609     int zippyAdjourn;
 610     int zippyAbort;
 611     char *zippyVariants;
 612     int zippyMaxGames;
 613     int zippyReplayTimeout; /*seconds*/
 614     int zippyShortGame; /* [HGM] aborter   */
 615 #endif
 616     Boolean lowTimeWarning; /* [HGM] low time */
 617     char *lowTimeWarningColor;
 618
 619     char *serverMovesName;
 620     Boolean suppressLoadMoves;
 621     int serverPause;
 622     int firstTimeOdds;
 623     int secondTimeOdds;
 624     int timeOddsMode;
 625     int firstAccumulateTC;
 626     int secondAccumulateTC;
 627     int firstNPS;
 628     int secondNPS;
 629     Boolean autoKibitz;
 630     int engineComments;
 631     char *userName;
 632     int rewindIndex;    /* [HGM] autoinc   */
 633     int sameColorGames; /* [HGM] alternate */
 634     int smpCores;       /* [HGM] SMP       */
 635     char *egtFormats;
 636     int niceEngines;    /* [HGM] nice      */
 637     char *firstLogo;    /* [HGM] logo      */
 638     char *secondLogo;
 639     Boolean autoLogo;
 640     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 641     char *firstOptions; /* [HGM] options   */
 642     char *secondOptions;
 643     char *fenOverride1;
 644     char *fenOverride2;
 645     Boolean keepAlive;  /* [HGM] alive     */
 646     Boolean forceIllegal;/*[HGM] illegal   */
 647     Boolean noJoin;     /* [HGM] join      */
 648     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 649     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 650     Boolean pasteSelection; /* paste X selection instead of clipboard */
 651     int nrVariations;   /* [HGM] multivar  */
 652     Boolean dropMenu;   /* [HGM] pv        */
 653     Boolean markers;    /* [HGM] markers   */
 654 } AppData, *AppDataPtr;
 655
 656 /*  PGN tags (for showing in the game list) */
 657 #define LPUSERGLT_SIZE      64
 658
 659 #define GLT_EVENT           'e'
 660 #define GLT_SITE            's'
 661 #define GLT_DATE            'd'
 662 #define GLT_ROUND           'o'
 663 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 664 #define GLT_RESULT          'r'
 665 #define GLT_WHITE_ELO       'w'
 666 #define GLT_BLACK_ELO       'b'
 667 #define GLT_TIME_CONTROL    't'
 668 #define GLT_VARIANT         'v'
 669 #define GLT_OUT_OF_BOOK     'a'
 670 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 671
 672 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 673
 674 #define GLT_ALL_TAGS        "esdoprwbtvac"
 675
 676 #define PGN_OUT_OF_BOOK     "Annotator"
 677
 678 extern AppData appData;
 679
 680 typedef struct {
 681     /* PGN 7-tag info */
 682     char *event;
 683     char *site;
 684     char *date;
 685     char *round;
 686     char *white;
 687     char *black;
 688     ChessMove result;
 689     /* Additional info */
 690     char *fen;          /* NULL or FEN for starting position; input only */
 691     char *resultDetails;
 692     char *timeControl;
 693     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 694     int whiteRating;    /* -1 if unknown */
 695     int blackRating;    /* -1 if unknown */
 696     VariantClass variant;
 697     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 698     int boardWidth;     /* [HGM] adjustable board size */
 699     int boardHeight;
 700 /* [HGM] For Shogi and Crazyhouse: */
 701     int holdingsSize;  /* number of different piece types in holdings       */
 702     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 703 } GameInfo;
 704
 705 /* [AS] Search stats from chessprogram, for the played move */
 706 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 707 typedef struct {
 708     int score;  /* Centipawns */
 709     int depth;  /* Plies */
 710     int time;   /* Milliseconds */
 711 } ChessProgramStats_Move;
 712
 713 /* [AS] Layout management */
 714 typedef struct {
 715     Boolean visible;
 716     int x;
 717     int y;
 718     int width;
 719     int height;
 720 } WindowPlacement;
 721
 722 extern WindowPlacement wpEngineOutput;
 723 extern WindowPlacement wpEvalGraph;
 724 extern WindowPlacement wpMoveHistory;
 725 extern WindowPlacement wpGameList;
 726 extern WindowPlacement wpTags;
 727
 728 // [HGM] chat
 729 #define MAX_CHAT 5
 730 extern int chatCount;
 731 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 732
 733
 734 #endif
 735