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 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     WhiteKingSideCastle = 1, WhiteQueenSideCastle,
 254     WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
 255     WhiteHSideCastleFR, WhiteASideCastleFR,
 256     BlackKingSideCastle, BlackQueenSideCastle,
 257     BlackKingSideCastleWild, BlackQueenSideCastleWild,
 258     BlackHSideCastleFR, BlackASideCastleFR,
 259     WhitePromotionKnight, WhitePromotionBishop,
 260     WhitePromotionRook, WhitePromotionQueen, WhitePromotionKing,
 261     WhitePromotionChancellor, WhitePromotionArchbishop, WhitePromotionCentaur,
 262     BlackPromotionKnight, BlackPromotionBishop,
 263     BlackPromotionRook, BlackPromotionQueen, BlackPromotionKing,
 264     BlackPromotionChancellor, BlackPromotionArchbishop, BlackPromotionCentaur,
 265     WhiteCapturesEnPassant, BlackCapturesEnPassant,
 266     WhiteDrop, BlackDrop,
 267     NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
 268     WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
 269     GNUChessGame, XBoardGame, MoveNumberOne,
 270     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
 271   } ChessMove;
 272
 273 typedef enum {
 274     ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
 275     ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
 276     ColorNone, NColorClasses
 277 } ColorClass;
 278
 279 typedef enum {
 280     SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
 281     SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
 282 } SoundClass;
 283
 284 /* Names for chess variants, not necessarily supported */
 285 typedef enum {
 286     VariantNormal,       /* Normal chess */
 287     VariantLoadable,     /* "loadgame" command allowed (not really a variant)*/
 288     VariantWildCastle,   /* Shuffle chess where king can castle from d file */
 289     VariantNoCastle,     /* Shuffle chess with no castling at all */
 290     VariantFischeRandom, /* FischeRandom */
 291     VariantBughouse,     /* Bughouse, ICC/FICS rules */
 292     VariantCrazyhouse,   /* Crazyhouse, ICC/FICS rules */
 293     VariantLosers,       /* Try to lose all pieces or get mated (ICC wild 17)*/
 294     VariantSuicide,      /* Try to lose all pieces incl. king (FICS) */
 295     VariantGiveaway,     /* Try to have no legal moves left (ICC wild 26) */
 296     VariantTwoKings,     /* Weird ICC wild 9 */
 297     VariantKriegspiel,   /* Kriegspiel; pawns can capture invisible pieces */
 298     VariantAtomic,       /* Capturing piece explodes (ICC wild 27) */
 299     Variant3Check,       /* Win by giving check 3 times (ICC wild 25) */
 300     VariantShatranj,     /* Unsupported (ICC wild 28) */
 301     Variant29,           /* Temporary name for possible future ICC wild 29 */
 302     Variant30,           /* Temporary name for possible future ICC wild 30 */
 303     Variant31,           /* Temporary name for possible future ICC wild 31 */
 304     Variant32,           /* Temporary name for possible future ICC wild 32 */
 305     Variant33,           /* Temporary name for possible future ICC wild 33 */
 306     Variant34,           /* Temporary name for possible future ICC wild 34 */
 307     Variant35,           /* Temporary name for possible future ICC wild 35 */
 308     Variant36,           /* Temporary name for possible future ICC wild 36 */
 309     VariantShogi,        /* [HGM] added variants */
 310     VariantXiangqi,
 311     VariantCourier,
 312     VariantGothic,
 313     VariantCapablanca,
 314     VariantKnightmate,
 315     VariantFairy,
 316     VariantCylinder,
 317     VariantFalcon,
 318     VariantCapaRandom,
 319     VariantBerolina,
 320     VariantJanus,
 321     VariantSuper,
 322     VariantGreat,
 323     VariantTwilight,
 324     VariantMakruk,
 325     VariantUnknown       /* Catchall for other unknown variants */
 326 } VariantClass;
 327
 328 #define VARIANT_NAMES { \
 329   "normal", \
 330   "normal", \
 331   "wildcastle", \
 332   "nocastle", \
 333   "fischerandom", \
 334   "bughouse", \
 335   "crazyhouse", \
 336   "losers", \
 337   "suicide", \
 338   "giveaway", \
 339   "twokings", \
 340   "kriegspiel", \
 341   "atomic", \
 342   "3check", \
 343   "shatranj", \
 344   "wild29", \
 345   "wild30", \
 346   "wild31", \
 347   "wild32", \
 348   "wild33", \
 349   "wild34", \
 350   "wild35", \
 351   "wild36", \
 352   "shogi", \
 353   "xiangqi", \
 354   "courier", \
 355   "gothic", \
 356   "capablanca", \
 357   "knightmate", \
 358   "fairy", \
 359   "cylinder", \
 360   "falcon",\
 361   "caparandom",\
 362   "berolina",\
 363   "janus",\
 364   "super",\
 365   "great",\
 366   "twilight",\
 367   "makruk",\
 368   "unknown" \
 369 }
 370
 371 typedef struct {
 372 #if !defined(_amigados)
 373     char *whitePieceColor;
 374     char *blackPieceColor;
 375     char *lightSquareColor;
 376     char *darkSquareColor;
 377     char *jailSquareColor;
 378     char *highlightSquareColor;
 379     char *premoveHighlightColor;
 380 #else
 381     int whitePieceColor;
 382     int blackPieceColor;
 383     int lightSquareColor;
 384     int darkSquareColor;
 385     int jailSquareColor;
 386     int highlightSquareColor;
 387     int premoveHighlightColor;
 388 #endif
 389     int movesPerSession;
 390     int timeIncrement;
 391     char *initString;
 392     char *secondInitString;
 393     char *firstComputerString;
 394     char *secondComputerString;
 395     char *firstChessProgram;
 396     char *secondChessProgram;
 397     char *firstDirectory;
 398     char *secondDirectory;
 399     Boolean firstPlaysBlack;
 400     Boolean noChessProgram;
 401     char *firstHost;
 402     char *secondHost;
 403     char *bitmapDirectory;
 404     char *remoteShell;
 405     char *remoteUser;
 406     float timeDelay;
 407     char *timeControl;
 408     Boolean icsActive;
 409     char *icsHost;
 410     char *icsPort;
 411     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
 412     char *icsLogon;     /* Hack to permit variable logon scripts. */
 413     char *icsHelper;
 414     Boolean icsInputBox;
 415     Boolean useTelnet;
 416     Boolean seekGraph;
 417     char *telnetProgram;
 418     char *gateway;
 419     char *loadGameFile;
 420     int loadGameIndex;      /* game # within file */
 421     char *saveGameFile;
 422     Boolean autoSaveGames;
 423     char *loadPositionFile;
 424     int loadPositionIndex;  /* position # within file */
 425     char *savePositionFile;
 426     Boolean matchMode;
 427     int matchGames;
 428     Boolean monoMode;
 429     Boolean debugMode;
 430     Boolean clockMode;
 431     char *boardSize;
 432     Boolean Iconic;
 433     char *searchTime;
 434     int searchDepth;
 435     Boolean showCoords;
 436     char *clockFont;
 437     char *messageFont; /* WinBoard only */
 438     char *coordFont;
 439     char *font; /* xboard only: all other fonts */
 440     char *tagsFont; /* WinBoard only */
 441     char *commentFont; /* WinBoard only */
 442     char *icsFont; /* WinBoard only */
 443     Boolean ringBellAfterMoves;
 444     Boolean autoCallFlag;
 445     Boolean flipView;
 446     Boolean autoFlipView;
 447     char *cmailGameName; /* xboard only */
 448     Boolean alwaysPromoteToQueen;
 449     Boolean oldSaveStyle;
 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 reuseFirst;
 499     Boolean reuseSecond;
 500     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 501     Boolean animate;    /* If True, animate non-mouse moves */
 502     int animSpeed;      /* Delay in milliseconds between animation frames */
 503     Boolean popupMoveErrors;
 504     Boolean popupExitMessage;
 505     int showJail;
 506     Boolean highlightLastMove;
 507     Boolean highlightDragging;
 508     Boolean blindfold;          /* if true, no pieces are drawn */
 509     Boolean premove;            /* true if premove feature enabled */
 510     Boolean premoveWhite;       /* true if premoving White first move  */
 511     char *premoveWhiteText;     /* text of White premove 1 */
 512     Boolean premoveBlack;       /* true if premoving Black first move */
 513     char *premoveBlackText;     /* text of Black premove 1 */
 514     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 515     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 516     Boolean autoRaiseBoard;
 517     int fontSizeTolerance; /* xboard only */
 518     char *initialMode;
 519     char *variant;
 520     int firstProtocolVersion;
 521     int secondProtocolVersion;
 522     Boolean showButtonBar;
 523     Boolean icsEngineAnalyze;
 524
 525     /* [AS] New properties (down to the "ZIPPY" part) */
 526     Boolean firstScoreIsAbsolute;  /* If true, engine score is always from white side */
 527     Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
 528     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 529     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 530     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 531     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 532     int liteBackTextureMode;
 533     int darkBackTextureMode;
 534     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 535     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 536     int fontBackColorWhite;
 537     int fontForeColorWhite;
 538     int fontBackColorBlack;
 539     int fontForeColorBlack;
 540     int fontPieceSize; /* Size of font relative to square (percentage) */
 541     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 542     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 543     int delayBeforeQuit;
 544     int delayAfterQuit;
 545     char * nameOfDebugFile;
 546     char * pgnEventHeader;
 547     int defaultFrcPosition;
 548     char * gameListTags;
 549     Boolean saveOutOfBookInfo;
 550     Boolean showEvalInMoveHistory;
 551     int evalHistColorWhite;
 552     int evalHistColorBlack;
 553     Boolean highlightMoveWithArrow;
 554     int highlightArrowColor;
 555     Boolean useStickyWindows;
 556     int adjudicateDrawMoves;
 557     Boolean autoDisplayComment;
 558     Boolean autoDisplayTags;
 559     Boolean firstIsUCI;
 560     Boolean secondIsUCI;
 561     Boolean firstHasOwnBookUCI;
 562     Boolean secondHasOwnBookUCI;
 563     char * adapterCommand;
 564     char * polyglotDir;
 565     Boolean usePolyglotBook;
 566     char * polyglotBook;
 567     int defaultHashSize;
 568     int defaultCacheSizeEGTB;
 569     char * defaultPathEGTB;
 570
 571     /* [HGM] Board size */
 572     int NrFiles;
 573     int NrRanks;
 574     int holdingsSize;
 575     int matchPause;
 576     char * pieceToCharTable;
 577     Boolean allWhite;
 578     Boolean upsideDown;
 579     Boolean alphaRank;
 580     Boolean testClaims;
 581     Boolean checkMates;
 582     Boolean materialDraws;
 583     Boolean trivialDraws;
 584     int ruleMoves;
 585     int drawRepeats;
 586
 587 #if ZIPPY
 588     char *zippyLines;
 589     char *zippyPinhead;
 590     char *zippyPassword;
 591     char *zippyPassword2;
 592     char *zippyWrongPassword;
 593     char *zippyAcceptOnly;
 594     int zippyUseI;
 595     int zippyBughouse;
 596     int zippyNoplayCrafty;
 597     char *zippyGameEnd;
 598     char *zippyGameStart;
 599     int zippyAdjourn;
 600     int zippyAbort;
 601     char *zippyVariants;
 602     int zippyMaxGames;
 603     int zippyReplayTimeout; /*seconds*/
 604     int zippyShortGame; /* [HGM] aborter   */
 605 #endif
 606     Boolean lowTimeWarning; /* [HGM] low time */
 607     char *lowTimeWarningColor;
 608
 609     char *serverMovesName;
 610     Boolean suppressLoadMoves;
 611     int serverPause;
 612     int firstTimeOdds;
 613     int secondTimeOdds;
 614     int timeOddsMode;
 615     int firstAccumulateTC;
 616     int secondAccumulateTC;
 617     int firstNPS;
 618     int secondNPS;
 619     Boolean autoKibitz;
 620     int engineComments;
 621     char *userName;
 622     int rewindIndex;    /* [HGM] autoinc   */
 623     int sameColorGames; /* [HGM] alternate */
 624     int smpCores;       /* [HGM] SMP       */
 625     char *egtFormats;
 626     int niceEngines;    /* [HGM] nice      */
 627     char *firstLogo;    /* [HGM] logo      */
 628     char *secondLogo;
 629     Boolean autoLogo;
 630     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 631     char *firstOptions; /* [HGM] options   */
 632     char *secondOptions;
 633     char *fenOverride1;
 634     char *fenOverride2;
 635     Boolean keepAlive;  /* [HGM] alive     */
 636     Boolean forceIllegal;/*[HGM] illegal   */
 637     Boolean noJoin;     /* [HGM] join      */
 638     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 639     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 640     Boolean pasteSelection; /* paste X selection instead of clipboard */
 641     int nrVariations;   /* [HGM] multivar  */
 642     Boolean dropMenu;   /* [HGM] pv        */
 643     Boolean markers;    /* [HGM] markers   */
 644 } AppData, *AppDataPtr;
 645
 646 /* [AS] PGN tags (for showing in the game list) */
 647 #define GLT_EVENT           'e'
 648 #define GLT_SITE            's'
 649 #define GLT_DATE            'd'
 650 #define GLT_ROUND           'o'
 651 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 652 #define GLT_RESULT          'r'
 653 #define GLT_WHITE_ELO       'w'
 654 #define GLT_BLACK_ELO       'b'
 655 #define GLT_TIME_CONTROL    't'
 656 #define GLT_VARIANT         'v'
 657 #define GLT_OUT_OF_BOOK     'a'
 658 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 659
 660 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 661
 662 #define GLT_ALL_TAGS        "esdoprwbtvac"
 663
 664 #define PGN_OUT_OF_BOOK     "Annotator"
 665
 666 extern AppData appData;
 667
 668 typedef struct {
 669     /* PGN 7-tag info */
 670     char *event;
 671     char *site;
 672     char *date;
 673     char *round;
 674     char *white;
 675     char *black;
 676     ChessMove result;
 677     /* Additional info */
 678     char *fen;          /* NULL or FEN for starting position; input only */
 679     char *resultDetails;
 680     char *timeControl;
 681     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 682     int whiteRating;    /* -1 if unknown */
 683     int blackRating;    /* -1 if unknown */
 684     VariantClass variant;
 685     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 686     int boardWidth;     /* [HGM] adjustable board size */
 687     int boardHeight;
 688 /* [HGM] For Shogi and Crazyhouse: */
 689     int holdingsSize;  /* number of different piece types in holdings       */
 690     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 691 } GameInfo;
 692
 693 /* [AS] Search stats from chessprogram, for the played move */
 694 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 695 typedef struct {
 696     int score;  /* Centipawns */
 697     int depth;  /* Plies */
 698     int time;   /* Milliseconds */
 699 } ChessProgramStats_Move;
 700
 701 /* [AS] Layout management */
 702 typedef struct {
 703     Boolean visible;
 704     int x;
 705     int y;
 706     int width;
 707     int height;
 708 } WindowPlacement;
 709
 710 extern WindowPlacement wpEngineOutput;
 711 extern WindowPlacement wpEvalGraph;
 712 extern WindowPlacement wpMoveHistory;
 713 extern WindowPlacement wpGameList;
 714 extern WindowPlacement wpTags;
 715
 716 // [HGM] chat
 717 #define MAX_CHAT 3
 718 extern int chatCount;
 719 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 720
 721
 722 #endif
 723