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     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   "unknown" \
 367 }
 368
 369 typedef struct {
 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     int 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     char *telnetProgram;
 415     char *gateway;
 416     char *loadGameFile;
 417     int loadGameIndex;      /* game # within file */
 418     char *saveGameFile;
 419     Boolean autoSaveGames;
 420     char *loadPositionFile;
 421     int loadPositionIndex;  /* position # within file */
 422     char *savePositionFile;
 423     Boolean matchMode;
 424     int matchGames;
 425     Boolean monoMode;
 426     Boolean debugMode;
 427     Boolean clockMode;
 428     char *boardSize;
 429     Boolean Iconic;
 430     char *searchTime;
 431     int searchDepth;
 432     Boolean showCoords;
 433     char *clockFont;
 434     char *messageFont; /* WinBoard only */
 435     char *coordFont;
 436     char *font; /* xboard only: all other fonts */
 437     char *tagsFont; /* WinBoard only */
 438     char *commentFont; /* WinBoard only */
 439     char *icsFont; /* WinBoard only */
 440     Boolean ringBellAfterMoves;
 441     Boolean autoCallFlag;
 442     Boolean flipView;
 443     Boolean autoFlipView;
 444     char *cmailGameName; /* xboard only */
 445     Boolean alwaysPromoteToQueen;
 446     Boolean oldSaveStyle;
 447     Boolean quietPlay;
 448     Boolean showThinking;
 449     Boolean ponderNextMove;
 450     Boolean periodicUpdates;
 451     Boolean autoObserve;
 452     Boolean autoComment;
 453     Boolean getMoveList;
 454     Boolean testLegality;
 455     int borderXoffset; /* xboard only */
 456     int borderYoffset; /* xboard only */
 457     Boolean titleInWindow; /* xboard only */
 458     Boolean localLineEditing; /* WinBoard only */
 459     Boolean zippyTalk;
 460     Boolean zippyPlay;
 461     int flashCount; /* Number of times to flash (xboard only) */
 462     int flashRate; /* Flashes per second (xboard only)  */
 463     char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
 464     int msLoginDelay;  /* Delay per character (in msec) while sending
 465                           ICS logon script (xboard only) */
 466     Boolean colorize;   /* If True, use the following colors to color text */
 467     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 468     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 469     char *colorSShout;
 470     char *colorChannel1;
 471     char *colorChannel;
 472     char *colorKibitz;
 473     char *colorTell;
 474     char *colorChallenge;
 475     char *colorRequest;
 476     char *colorSeek;
 477     char *colorNormal;
 478     char *soundProgram; /* sound-playing program */
 479     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 480     char *soundSShout;
 481     char *soundChannel1;
 482     char *soundChannel;
 483     char *soundKibitz;
 484     char *soundTell;
 485     char *soundChallenge;
 486     char *soundRequest;
 487     char *soundSeek;
 488     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 489     char *soundBell;
 490     char *soundIcsAlarm;
 491     char *soundIcsWin;
 492     char *soundIcsLoss;
 493     char *soundIcsDraw;
 494     char *soundIcsUnfinished;
 495     Boolean reuseFirst;
 496     Boolean reuseSecond;
 497     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 498     Boolean animate;    /* If True, animate non-mouse moves */
 499     int animSpeed;      /* Delay in milliseconds between animation frames */
 500     Boolean popupMoveErrors;
 501     Boolean popupExitMessage;
 502     int showJail;
 503     Boolean highlightLastMove;
 504     Boolean highlightDragging;
 505     Boolean blindfold;          /* if true, no pieces are drawn */
 506     Boolean premove;            /* true if premove feature enabled */
 507     Boolean premoveWhite;       /* true if premoving White first move  */
 508     char *premoveWhiteText;     /* text of White premove 1 */
 509     Boolean premoveBlack;       /* true if premoving Black first move */
 510     char *premoveBlackText;     /* text of Black premove 1 */
 511     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 512     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 513     Boolean autoRaiseBoard;
 514     int fontSizeTolerance; /* xboard only */
 515     char *initialMode;
 516     char *variant;
 517     int firstProtocolVersion;
 518     int secondProtocolVersion;
 519     Boolean showButtonBar;
 520     Boolean icsEngineAnalyze;
 521
 522     /* [AS] New properties (down to the "ZIPPY" part) */
 523     Boolean firstScoreIsAbsolute;  /* If true, engine score is always from white side */
 524     Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
 525     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 526     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 527     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 528     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 529     int liteBackTextureMode;
 530     int darkBackTextureMode;
 531     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 532     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 533     int fontBackColorWhite;
 534     int fontForeColorWhite;
 535     int fontBackColorBlack;
 536     int fontForeColorBlack;
 537     int fontPieceSize; /* Size of font relative to square (percentage) */
 538     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 539     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 540     int delayBeforeQuit;
 541     int delayAfterQuit;
 542     char * nameOfDebugFile;
 543     char * pgnEventHeader;
 544     int defaultFrcPosition;
 545     char * gameListTags;
 546     Boolean saveOutOfBookInfo;
 547     Boolean showEvalInMoveHistory;
 548     int evalHistColorWhite;
 549     int evalHistColorBlack;
 550     Boolean highlightMoveWithArrow;
 551     int highlightArrowColor;
 552     Boolean useStickyWindows;
 553     int adjudicateDrawMoves;
 554     Boolean autoDisplayComment;
 555     Boolean autoDisplayTags;
 556     Boolean firstIsUCI;
 557     Boolean secondIsUCI;
 558     Boolean firstHasOwnBookUCI;
 559     Boolean secondHasOwnBookUCI;
 560     char * adapterCommand;
 561     char * polyglotDir;
 562     Boolean usePolyglotBook;
 563     char * polyglotBook;
 564     int defaultHashSize;
 565     int defaultCacheSizeEGTB;
 566     char * defaultPathEGTB;
 567
 568     /* [HGM] Board size */
 569     int NrFiles;
 570     int NrRanks;
 571     int holdingsSize;
 572     int matchPause;
 573     char * pieceToCharTable;
 574     Boolean allWhite;
 575     Boolean upsideDown;
 576     Boolean alphaRank;
 577     Boolean testClaims;
 578     Boolean checkMates;
 579     Boolean materialDraws;
 580     Boolean trivialDraws;
 581     int ruleMoves;
 582     int drawRepeats;
 583
 584 #if ZIPPY
 585     char *zippyLines;
 586     char *zippyPinhead;
 587     char *zippyPassword;
 588     char *zippyPassword2;
 589     char *zippyWrongPassword;
 590     char *zippyAcceptOnly;
 591     int zippyUseI;
 592     int zippyBughouse;
 593     int zippyNoplayCrafty;
 594     char *zippyGameEnd;
 595     char *zippyGameStart;
 596     int zippyAdjourn;
 597     int zippyAbort;
 598     char *zippyVariants;
 599     int zippyMaxGames;
 600     int zippyReplayTimeout; /*seconds*/
 601     int zippyShortGame; /* [HGM] aborter   */
 602 #endif
 603     Boolean lowTimeWarning; /* [HGM] low time */
 604     char *lowTimeWarningColor;
 605
 606     char *serverMovesName;
 607     Boolean suppressLoadMoves;
 608     int serverPause;
 609     int firstTimeOdds;
 610     int secondTimeOdds;
 611     int timeOddsMode;
 612     int firstAccumulateTC;
 613     int secondAccumulateTC;
 614     int firstNPS;
 615     int secondNPS;
 616     Boolean autoKibitz;
 617     int engineComments;
 618     char *userName;
 619     int rewindIndex;    /* [HGM] autoinc   */
 620     int sameColorGames; /* [HGM] alternate */
 621     int smpCores;       /* [HGM] SMP       */
 622     char *egtFormats;
 623     int niceEngines;    /* [HGM] nice      */
 624     char *firstLogo;    /* [HGM] logo      */
 625     char *secondLogo;
 626     Boolean autoLogo;
 627     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 628     char *firstOptions; /* [HGM] options   */
 629     char *secondOptions;
 630     char *fenOverride1;
 631     char *fenOverride2;
 632     Boolean keepAlive;  /* [HGM] alive     */
 633     Boolean forceIllegal;/*[HGM] illegal   */
 634     Boolean noJoin;     /* [HGM] join      */
 635     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 636     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 637     Boolean pasteSelection; /* paste X selection instead of clipboard */
 638     int nrVariations;   /* [HGM] multivar  */
 639 } AppData, *AppDataPtr;
 640
 641 /* [AS] PGN tags (for showing in the game list) */
 642 #define GLT_EVENT           'e'
 643 #define GLT_SITE            's'
 644 #define GLT_DATE            'd'
 645 #define GLT_ROUND           'o'
 646 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 647 #define GLT_RESULT          'r'
 648 #define GLT_WHITE_ELO       'w'
 649 #define GLT_BLACK_ELO       'b'
 650 #define GLT_TIME_CONTROL    't'
 651 #define GLT_VARIANT         'v'
 652 #define GLT_OUT_OF_BOOK     'a'
 653 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 654
 655 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 656
 657 #define GLT_ALL_TAGS        "esdoprwbtvac"
 658
 659 #define PGN_OUT_OF_BOOK     "Annotator"
 660
 661 extern AppData appData;
 662
 663 typedef struct {
 664     /* PGN 7-tag info */
 665     char *event;
 666     char *site;
 667     char *date;
 668     char *round;
 669     char *white;
 670     char *black;
 671     ChessMove result;
 672     /* Additional info */
 673     char *fen;          /* NULL or FEN for starting position; input only */
 674     char *resultDetails;
 675     char *timeControl;
 676     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 677     int whiteRating;    /* -1 if unknown */
 678     int blackRating;    /* -1 if unknown */
 679     VariantClass variant;
 680     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 681     int boardWidth;     /* [HGM] adjustable board size */
 682     int boardHeight;
 683 /* [HGM] For Shogi and Crazyhouse: */
 684     int holdingsSize;  /* number of different piece types in holdings       */
 685     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 686 } GameInfo;
 687
 688 /* [AS] Search stats from chessprogram, for the played move */
 689 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 690 typedef struct {
 691     int score;  /* Centipawns */
 692     int depth;  /* Plies */
 693     int time;   /* Milliseconds */
 694 } ChessProgramStats_Move;
 695
 696 /* [AS] Layout management */
 697 typedef struct {
 698     Boolean visible;
 699     int x;
 700     int y;
 701     int width;
 702     int height;
 703 } WindowPlacement;
 704
 705 extern WindowPlacement wpEngineOutput;
 706 extern WindowPlacement wpEvalGraph;
 707 extern WindowPlacement wpMoveHistory;
 708 extern WindowPlacement wpGameList;
 709 extern WindowPlacement wpTags;
 710
 711 // [HGM] chat
 712 #define MAX_CHAT 3
 713 extern int chatCount;
 714 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 715
 716
 717 #endif
 718