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