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