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, 2013, 2014, 2015, 2016 Free
   9  * Software Foundation, Inc.
  10  *
  11  * Enhancements Copyright 2005 Alessandro Scotti
  12  *
  13  * The following terms apply to Digital Equipment Corporation's copyright
  14  * interest in XBoard:
  15  * ------------------------------------------------------------------------
  16  * All Rights Reserved
  17  *
  18  * Permission to use, copy, modify, and distribute this software and its
  19  * documentation for any purpose and without fee is hereby granted,
  20  * provided that the above copyright notice appear in all copies and that
  21  * both that copyright notice and this permission notice appear in
  22  * supporting documentation, and that the name of Digital not be
  23  * used in advertising or publicity pertaining to distribution of the
  24  * software without specific, written prior permission.
  25  *
  26  * DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  27  * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  28  * DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  29  * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  30  * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  31  * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  32  * SOFTWARE.
  33  * ------------------------------------------------------------------------
  34  *
  35  * The following terms apply to the enhanced version of XBoard
  36  * distributed by the Free Software Foundation:
  37  * ------------------------------------------------------------------------
  38  *
  39  * GNU XBoard is free software: you can redistribute it and/or modify
  40  * it under the terms of the GNU General Public License as published by
  41  * the Free Software Foundation, either version 3 of the License, or (at
  42  * your option) any later version.
  43  *
  44  * GNU XBoard is distributed in the hope that it will be useful, but
  45  * WITHOUT ANY WARRANTY; without even the implied warranty of
  46  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  47  * General Public License for more details.
  48  *
  49  * You should have received a copy of the GNU General Public License
  50  * along with this program. If not, see http://www.gnu.org/licenses/.  *
  51  *
  52  *------------------------------------------------------------------------
  53  ** See the file ChangeLog for a revision history.  */
  54
  55 #ifndef XB_COMMON
  56 #define XB_COMMON
  57
  58
  59 /* Begin compatibility grunge  */
  60
  61 #if defined(__STDC__) || defined(WIN32) || defined(_amigados)
  62 #define P(args) args
  63 typedef void *VOIDSTAR;
  64 #else
  65 #define P(args)         ()
  66 typedef char *VOIDSTAR;
  67 #endif
  68
  69 #ifdef WIN32
  70 typedef char Boolean;
  71 typedef char *String;
  72 #define popen _popen
  73 #define pclose _pclose
  74
  75 #else
  76 #ifdef _amigados        /*  It is important, that these types have  */
  77 typedef int Boolean;    /*  a length of 4 bytes each, as we are     */
  78 typedef char *String;   /*  using ReadArgs() for argument parsing.  */
  79 #ifdef _DCC
  80 FILE *popen(const char *, const char *);
  81 int pclose(FILE *);
  82 #endif
  83
  84 #else
  85 #ifdef X11
  86 #include <X11/Intrinsic.h>
  87 #else
  88 typedef char Boolean;
  89 typedef char *String;
  90 #define True 1
  91 #define False 0
  92 #endif
  93 #endif
  94 #endif
  95
  96
  97 #ifndef TRUE
  98 #define TRUE 1
  99 #define FALSE 0
 100 #endif
 101
 102 #define UNKNOWN -1 /* [HGM] nps */
 103
 104 #if !HAVE_RANDOM
 105 # if HAVE_RAND48
 106 #  define srandom srand48
 107 #  define random lrand48
 108 # else /* not HAVE_RAND48 */
 109 #  define srandom srand
 110 #  define random rand
 111 # endif /* not HAVE_RAND48 */
 112 #endif /* !HAVE_RANDOM */
 113
 114 /* End compatibility grunge */
 115
 116 /* unsigned int 64 for engine nodes work and display */
 117 #ifdef WIN32
 118        /* I don't know the name for this type of other compiler
 119         * If it not work, just modify here
 120         * This is for MS Visual Studio
 121         */
 122        #ifdef _MSC_VER
 123                #define u64 unsigned __int64
 124                #define s64 signed __int64
 125                #define u64Display "%I64u"
 126                #define s64Display "%I64d"
 127                #define u64Const(c) (c ## UI64)
 128                #define s64Const(c) (c ## I64)
 129        #else
 130                /* place holder
 131                 * or dummy types for other compiler
 132                 * [HGM] seems that -mno-cygwin comple needs %I64?
 133                 */
 134                #define u64 unsigned long long
 135                #define s64 signed long long
 136                #ifdef USE_I64
 137                   #define u64Display "%I64u"
 138                   #define s64Display "%I64d"
 139                #else
 140                   #define u64Display "%llu"
 141                   #define s64Display "%lld"
 142                #endif
 143                #define u64Const(c) (c ## ULL)
 144                #define s64Const(c) (c ## LL)
 145        #endif
 146 #else
 147        /* GNU gcc */
 148        #define u64 unsigned long long
 149        #define s64 signed long long
 150        #define u64Display "%llu"
 151        #define s64Display "%lld"
 152        #define u64Const(c) (c ## ull)
 153        #define s64Const(c) (c ## ll)
 154 #endif
 155
 156 #define PROTOVER                2       /* engine protocol version */
 157
 158 // [HGM] license: Messages that engines must print to satisfy their license requirements for patented variants
 159 #define GOTHIC "Gothic Chess (see www.GothicChess.com) is licensed under U.S. Patent #6,481,716 by Ed Trice"
 160 #define FALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
 161
 162 /* [HGM] Some notes about board sizes:
 163    In games that allow piece drops, the holdings are considered part of the
 164    board, in the leftmost and rightmost two files. This way they are
 165    automatically part of the game-history states, and enjoy all display
 166    functions (including drag-drop and click-click moves to the regular part
 167    of the board). The drawback of this is that the internal numbering of
 168    files starts at 2 for the a-file if holdings are displayed. To ensure
 169    consistency, this shifted numbering system is used _everywhere_ in the
 170    code, and conversion to the 'normal' system only takes place when the
 171    file number is converted to or from ASCII (by redefining the character
 172    constant 'a'). This works because Winboard only communicates with the
 173    outside world in ASCII. In a similar way, the different rank numbering
 174    systems (starting at rank 0 or 1) are implemented by redefining '1'.
 175 */
 176 #define BOARD_RANKS             17            /* [HGM] for in declarations  */
 177 #define BOARD_FILES             16             /* [HGM] for in declarations  */
 178 #define BOARD_HEIGHT (gameInfo.boardHeight)    /* [HGM] made user adjustable */
 179 #define BOARD_WIDTH  (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)
 180 #define BOARD_LEFT   (gameInfo.holdingsWidth)  /* [HGM] play-board edges     */
 181 #define BOARD_RGHT   (gameInfo.boardWidth + gameInfo.holdingsWidth)
 182 #define CASTLING     (BOARD_RANKS-1)           /* [HGM] hide in upper rank   */
 183 #define VIRGIN       (BOARD_RANKS-2)           /* [HGM] pieces not moved     */
 184 #define LAST_TO      CASTLING][(BOARD_FILES-7) /* [HGM] in upper rank        */
 185 #define TOUCHED_W    CASTLING][(BOARD_FILES-6) /* [HGM] in upper rank        */
 186 #define TOUCHED_B    CASTLING][(BOARD_FILES-5) /* [HGM] in upper rank        */
 187 #define EP_RANK      CASTLING][(BOARD_FILES-4) /* [HGM] in upper rank        */
 188 #define EP_FILE      CASTLING][(BOARD_FILES-3) /* [HGM] in upper rank        */
 189 #define EP_STATUS    CASTLING][(BOARD_FILES-2) /* [HGM] in upper rank        */
 190 #define HOLDINGS_SET CASTLING][(BOARD_FILES-1) /* [HGM] in upper-right corner*/
 191 #define ONE          ('1'-(BOARD_HEIGHT==10)-appData.rankOffset)  /* [HGM] foremost board rank  */
 192 #define AAA          ('a'-BOARD_LEFT)          /* [HGM] leftmost board file  */
 193 #define VIRGIN_W                 1             /* [HGM] flags in Board[VIRGIN][X] */
 194 #define VIRGIN_B                 2
 195 #define DROP_RANK               -3
 196 #define MAX_MOVES               1000
 197 #define MSG_SIZ                 512
 198 #define DIALOG_SIZE             256
 199 #define STAR_MATCH_N            16
 200 #define MOVE_LEN                32
 201 #define TIME_CONTROL            "5"     /* in minutes */
 202 #define TIME_DELAY_QUOTE        "1.0"   /* seconds between moves */
 203 #define TIME_DELAY              ((float) 1.0)
 204 #define MOVES_PER_SESSION       40      /* moves per TIME_CONTROL */
 205 #define TIME_INCREMENT          -1      /* if >= 0, MOVES_PER_SESSION unused */
 206 #define WhiteOnMove(move)       (((move) % 2) == 0)
 207 #define ICS_HOST                "chessclub.com"
 208 #define ICS_PORT                "5000"
 209 #define ICS_COMM_PORT           ""
 210 #define FIRST_HOST              "localhost"
 211 #define SECOND_HOST             "localhost"
 212 #define TELNET_PROGRAM          "telnet"
 213 #define DEF_BITMAP_DIR          BITMAPDIR
 214 #define MATCH_MODE              "False"
 215 #define INIT_STRING             "new\nrandom\n"
 216 #define WHITE_STRING            "white\ngo\n"
 217 #define BLACK_STRING            "black\ngo\n"
 218 #define COMPUTER_STRING         "computer\n"
 219 #define REUSE_CHESS_PROGRAMS    1
 220 #define WHITE_PIECE_COLOR       "#FFFFCC"
 221 #define BLACK_PIECE_COLOR       "#202020"
 222 #define LIGHT_SQUARE_COLOR      "#C8C365"
 223 #define DARK_SQUARE_COLOR       "#77A26D"
 224 #define JAIL_SQUARE_COLOR       "#808080"
 225 #define HIGHLIGHT_SQUARE_COLOR  "#FFFF00"
 226 #define PREMOVE_HIGHLIGHT_COLOR "#FF0000"
 227 #define LOWTIMEWARNING_COLOR    "#FF0000"
 228 #define BELLCHAR                '\007'
 229 #define NULLCHAR                '\000'
 230 #define FEATURE_TIMEOUT         10000 /*ms*/
 231 #define MATE_SCORE              100000
 232
 233 #define CLOCK_FONT 0
 234 #define MESSAGE_FONT 1
 235 #define COORD_FONT 2
 236 #define CONSOLE_FONT 3
 237 #define COMMENT_FONT 4
 238 #define EDITTAGS_FONT 5
 239 #define MOVEHISTORY_FONT 6
 240 #define GAMELIST_FONT 7
 241 #define NUM_FONTS 8
 242
 243 /* Default to no flashing (the "usual" XBoard behavior) */
 244 #define FLASH_COUNT     0               /* Number of times to flash */
 245 #define FLASH_RATE      5               /* Flashes per second */
 246
 247 /* Default delay per character (in msec) while sending login script */
 248 #define MS_LOGIN_DELAY  0
 249
 250 /* [AS] Support for background textures */
 251 #define BACK_TEXTURE_MODE_DISABLED      0
 252 #define BACK_TEXTURE_MODE_PLAIN         1
 253 #define BACK_TEXTURE_MODE_FULL_RANDOM   2
 254
 255 /* Zippy defaults */
 256 #define ZIPPY_TALK FALSE
 257 #define ZIPPY_PLAY FALSE
 258 #define ZIPPY_LINES "yow.lines"
 259 #define ZIPPY_PINHEAD ""
 260 #define ZIPPY_PASSWORD ""
 261 #define ZIPPY_PASSWORD2 ""
 262 #define ZIPPY_WRONG_PASSWORD ""
 263 #define ZIPPY_ACCEPT_ONLY ""
 264 #define ZIPPY_USE_I TRUE
 265 #define ZIPPY_BUGHOUSE 0
 266 #define ZIPPY_NOPLAY_CRAFTY FALSE
 267 #define ZIPPY_GAME_END "gameend\n"
 268 #define ZIPPY_GAME_START ""
 269 #define ZIPPY_ADJOURN FALSE
 270 #define ZIPPY_ABORT FALSE
 271 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
 272 #define ZIPPY_MAX_GAMES 0
 273 #define ZIPPY_REPLAY_TIMEOUT 120
 274
 275 typedef VOIDSTAR ProcRef;
 276 #define NoProc ((ProcRef) 0)
 277 typedef VOIDSTAR InputSourceRef;
 278
 279 typedef void (*DelayedEventCallback) P((void));
 280
 281 typedef enum { Press, Release } ClickType;
 282
 283 typedef enum {
 284     BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
 285     AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
 286     EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
 287     IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
 288     IcsExamining
 289   } GameMode;
 290
 291 typedef enum {
 292     /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
 293     /* only the first N pieces can go into the holdings, and   */
 294     /* promotions in those variants shift P-W to U-S           */
 295     WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
 296     WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
 297     WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
 298     WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteLion,
 299     WhiteSword, WhiteZebra, WhiteCamel, WhiteTower, WhiteWolf,
 300     WhiteHat, WhiteDuck, WhiteAmazon, WhiteFlying, WhiteGnu, WhiteCub,
 301     WhiteShield, WhiteHorse, WhiteWizard, WhiteCopper, WhiteIron,
 302     WhiteViking, WhiteFlag, WhiteAxe, WhiteDolphin, WhiteCat, WhiteClaw,
 303     WhiteWheel, WhiteButterfly, WhitePBishop, WhitePRook, WhiteHCrown,
 304     WhiteShierd, WhiteMonarch, WhiteMother, WhiteNothing, WhiteDrunk, WhiteWheer,
 305     WhiteTokin, WhitePKnight, WhitePCardinal, WhitePDragon, WhitePLance,
 306     WhitePSilver, WhiteDagger, WhitePSword, WhitePDagger, WhiteCrown, WhiteKing,
 307     BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
 308     BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
 309     BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
 310     BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackLion,
 311     BlackSword, BlackZebra, BlackCamel, BlackTower, BlackWolf,
 312     BlackHat, BlackDuck, BlackAmazon, BlackFlying, BlackGnu, BlackCub,
 313     BlackShield, BlackHorse, BlackWizard, BlackCopper, BlackIron,
 314     BlackViking, BlackFlag, BlackAxe, BlackDolphin, BlackCat, BlackClaw,
 315     BlackWheel, BlackButterfly, BlackPBishop, BlackPRook, BlackHCrown,
 316     BlackShierd, BlackMonarch, BlackMother, BlackNothing, BlackDrunk, BlackWheer,
 317     BlackTokin, BlackPKnight, BlackPCardinal, BlackPDragon, BlackPLance,
 318     BlackPSilver, BlackDagger, BlackPSword, BlackPDagger, BlackCrown, BlackKing,
 319     EmptySquare, DarkSquare,
 320     NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
 321     ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
 322   } ChessSquare;
 323
 324 /* [HGM] some macros that can be used as prefixes to convert piece types */
 325 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
 326 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
 327 #define PROMO          (int)WhiteDragon - (int)WhiteRook + (int)
 328 #define PROMOTED(X)    (promoPartner[X])
 329 #define DEMOTED(X)     (promoPartner[X])
 330 #define SHOGI          (int)EmptySquare + (int)
 331 #define CHUPROMOTED(X) (promoPartner[X])
 332 #define CHUDEMOTED(X)  (promoPartner[X])
 333 #define IS_SHOGI(V)    ((V) == VariantShogi || (V) == VariantChu)
 334 #define IS_LION(V)     ((V) == WhiteLion || (V) == BlackLion)
 335
 336
 337 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
 338
 339 typedef enum {
 340     EndOfFile = 0,
 341     WhiteKingSideCastle, WhiteQueenSideCastle,
 342     WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
 343     WhiteHSideCastleFR, WhiteASideCastleFR,
 344     BlackKingSideCastle, BlackQueenSideCastle,
 345     BlackKingSideCastleWild, BlackQueenSideCastleWild,
 346     BlackHSideCastleFR, BlackASideCastleFR,
 347     WhitePromotion, WhiteNonPromotion,
 348     BlackPromotion, BlackNonPromotion,
 349     WhiteCapturesEnPassant, BlackCapturesEnPassant,
 350     WhiteDrop, BlackDrop, FirstLeg,
 351     NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
 352     WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
 353     GNUChessGame, XBoardGame, MoveNumberOne, Open, Close, Nothing,
 354     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
 355   } ChessMove;
 356
 357 typedef enum {
 358     ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
 359     ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
 360     ColorNone, NColorClasses
 361 } ColorClass;
 362
 363 typedef enum {
 364     SoundMove, SoundBell, SoundRoar, SoundAlarm, SoundIcsWin, SoundIcsLoss,
 365     SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
 366 } SoundClass;
 367
 368 /* Names for chess variants, not necessarily supported */
 369 typedef enum {
 370     VariantNormal,       /* Normal chess */
 371     VariantLoadable,     /* "loadgame" command allowed (not really a variant)*/
 372     VariantWildCastle,   /* Shuffle chess where king can castle from d file */
 373     VariantNoCastle,     /* Shuffle chess with no castling at all */
 374     VariantFischeRandom, /* FischeRandom */
 375     VariantBughouse,     /* Bughouse, ICC/FICS rules */
 376     VariantCrazyhouse,   /* Crazyhouse, ICC/FICS rules */
 377     VariantLosers,       /* Try to lose all pieces or get mated (ICC wild 17)*/
 378     VariantSuicide,      /* Try to lose all pieces incl. king (FICS) */
 379     VariantGiveaway,     /* Try to have no legal moves left (ICC wild 26) */
 380     VariantTwoKings,     /* Weird ICC wild 9 */
 381     VariantKriegspiel,   /* Kriegspiel; pawns can capture invisible pieces */
 382     VariantAtomic,       /* Capturing piece explodes (ICC wild 27) */
 383     Variant3Check,       /* Win by giving check 3 times (ICC wild 25) */
 384     VariantShatranj,     /* Unsupported (ICC wild 28) */
 385     Variant29,           /* Temporary name for possible future ICC wild 29 */
 386     Variant30,           /* Temporary name for possible future ICC wild 30 */
 387     Variant31,           /* Temporary name for possible future ICC wild 31 */
 388     Variant32,           /* Temporary name for possible future ICC wild 32 */
 389     Variant33,           /* Temporary name for possible future ICC wild 33 */
 390     Variant34,           /* Temporary name for possible future ICC wild 34 */
 391     Variant35,           /* Temporary name for possible future ICC wild 35 */
 392     Variant36,           /* Temporary name for possible future ICC wild 36 */
 393     VariantShogi,        /* [HGM] added variants */
 394     VariantChu,
 395     VariantCourier,
 396     VariantGothic,
 397     VariantCapablanca,
 398     VariantKnightmate,
 399     VariantFairy,
 400     VariantCylinder,
 401     VariantFalcon,
 402     VariantCapaRandom,
 403     VariantBerolina,
 404     VariantJanus,
 405     VariantSuper,
 406     VariantGreat,
 407     VariantTwilight,
 408     VariantMakruk,
 409     VariantSChess,
 410     VariantGrand,
 411     VariantSpartan,
 412     VariantXiangqi,
 413     VariantASEAN,
 414     VariantLion,
 415     VariantChuChess,
 416     VariantUnknown       /* Catchall for other unknown variants */
 417 } VariantClass;
 418
 419 #define VARIANT_NAMES { \
 420   "normal", \
 421   "normal", \
 422   "wildcastle", \
 423   "nocastle", \
 424   "fischerandom", \
 425   "bughouse", \
 426   "crazyhouse", \
 427   "losers", \
 428   "suicide", \
 429   "giveaway", \
 430   "twokings", \
 431   "kriegspiel", \
 432   "atomic", \
 433   "3check", \
 434   "shatranj", \
 435   "wild29", \
 436   "wild30", \
 437   "wild31", \
 438   "wild32", \
 439   "wild33", \
 440   "wild34", \
 441   "wild35", \
 442   "wild36", \
 443   "shogi", \
 444   "chu", \
 445   "courier", \
 446   "gothic", \
 447   "capablanca", \
 448   "knightmate", \
 449   "fairy", \
 450   "cylinder", \
 451   "falcon",\
 452   "caparandom",\
 453   "berolina",\
 454   "janus",\
 455   "super",\
 456   "great",\
 457   "twilight",\
 458   "makruk",\
 459   "seirawan",\
 460   "grand",\
 461   "spartan",\
 462   "xiangqi", \
 463   "asean",\
 464   "lion",\
 465   "elven",\
 466   "unknown" \
 467 }
 468
 469 #define ENGINES 2
 470
 471 typedef struct {
 472     char *language;
 473 #if !defined(_amigados)
 474     char *whitePieceColor;
 475     char *blackPieceColor;
 476     char *lightSquareColor;
 477     char *darkSquareColor;
 478     char *jailSquareColor;
 479     char *highlightSquareColor;
 480     char *premoveHighlightColor;
 481     char *dialogColor;
 482     char *buttonColor;
 483 #else
 484     int whitePieceColor;
 485     int blackPieceColor;
 486     int lightSquareColor;
 487     int darkSquareColor;
 488     int jailSquareColor;
 489     int highlightSquareColor;
 490     int premoveHighlightColor;
 491 #endif
 492     int movesPerSession;
 493     float timeIncrement;
 494     char *engInitString[ENGINES];
 495     char *computerString[ENGINES];
 496     char *chessProgram[ENGINES];
 497     char *directory[ENGINES];
 498     char *pgnName[ENGINES];
 499     Boolean firstPlaysBlack;
 500     Boolean noChessProgram;
 501     char *positionDir;
 502     char *host[ENGINES];
 503     char *themeNames;
 504     char *pieceDirectory;
 505     char *border;
 506     char *soundDirectory;
 507     char *remoteShell;
 508     char *remoteUser;
 509     float timeDelay;
 510     char *timeControl;
 511     Boolean trueColors;
 512     Boolean icsActive;
 513     Boolean autoBox;
 514     char *icsHost;
 515     char *icsPort;
 516     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
 517     char *icsLogon;     /* Hack to permit variable logon scripts. */
 518     char *icsHelper;
 519     Boolean icsInputBox;
 520     Boolean useTelnet;
 521     Boolean seekGraph;
 522     Boolean autoRefresh;
 523     char *telnetProgram;
 524     char *gateway;
 525     char *loadGameFile;
 526     int loadGameIndex;      /* game # within file */
 527     char *saveGameFile;
 528     char *autoInstall;
 529     Boolean autoSaveGames;
 530     Boolean onlyOwn;        /* [HGM] suppress auto-saving of observed games */
 531     char *loadPositionFile;
 532     int loadPositionIndex;  /* position # within file */
 533     char *savePositionFile;
 534     Boolean fischerCastling;/* [HGM] fischer: allow Fischr castling in any variant */
 535     Boolean matchMode;
 536     int matchGames;
 537     Boolean epd;
 538     Boolean monoMode;
 539     Boolean debugMode;
 540     Boolean clockMode;
 541     char *boardSize;
 542     char *logoDir;
 543     int logoSize;
 544     Boolean Iconic;
 545     char *searchTime;
 546     int searchDepth;
 547     Boolean showCoords;
 548     char *clockFont;
 549     char *messageFont; /* WinBoard only */
 550     char *coordFont;
 551     char *font; /* xboard only */
 552     char *tagsFont;
 553     char *commentFont;
 554     char *historyFont;
 555     char *gameListFont;
 556     char *icsFont;
 557     int analysisBell;
 558     Boolean ringBellAfterMoves;
 559     Boolean autoCallFlag;
 560     Boolean flipView;
 561     Boolean autoFlipView;
 562     char *cmailGameName; /* xboard only */
 563     Boolean moveTime;
 564     Boolean headers;
 565     Boolean alwaysPromoteToQueen;
 566     Boolean oldSaveStyle;
 567     Boolean oneClick;
 568     Boolean quietPlay;
 569     Boolean showThinking;
 570     Boolean ponderNextMove;
 571     Boolean periodicUpdates;
 572     Boolean autoObserve;
 573     Boolean autoCreateLogon;
 574     Boolean autoComment;
 575     Boolean getMoveList;
 576     Boolean testLegality;
 577     Boolean topLevel;      /* xboard, top-level auxiliary windows */
 578     Boolean titleInWindow; /* xboard only */
 579     Boolean localLineEditing; /* WinBoard only */
 580     Boolean zippyTalk;
 581     Boolean zippyPlay;
 582     int jewelled;
 583     int flashCount; /* Number of times to flash (xboard only) */
 584     int flashRate; /* Flashes per second (xboard only)  */
 585     int msLoginDelay;  /* Delay per character (in msec) while sending
 586                           ICS logon script (xboard only) */
 587     Boolean colorize;   /* If True, use the following colors to color text */
 588     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 589     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 590     char *colorSShout;
 591     char *colorChannel1;
 592     char *colorChannel;
 593     char *colorKibitz;
 594     char *colorTell;
 595     char *colorChallenge;
 596     char *colorRequest;
 597     char *colorSeek;
 598     char *colorNormal;
 599     char *soundProgram; /* sound-playing program */
 600     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 601     char *soundSShout;
 602     char *soundChannel1;
 603     char *soundChannel;
 604     char *soundKibitz;
 605     char *soundTell;
 606     char *soundChallenge;
 607     char *soundRequest;
 608     char *soundSeek;
 609     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 610     char *soundBell;
 611     char *soundRoar;
 612     char *soundIcsAlarm;
 613     char *soundIcsWin;
 614     char *soundIcsLoss;
 615     char *soundIcsDraw;
 616     char *soundIcsUnfinished;
 617     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
 618     Boolean reuse[ENGINES];
 619     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 620     Boolean animate;    /* If True, animate non-mouse moves */
 621     int animSpeed;      /* Delay in milliseconds between animation frames */
 622     Boolean popupMoveErrors;
 623     Boolean popupExitMessage;
 624     int showJail;
 625     Boolean highlightLastMove;
 626     Boolean highlightDragging;
 627     Boolean blindfold;          /* if true, no pieces are drawn */
 628     Boolean premove;            /* true if premove feature enabled */
 629     Boolean premoveWhite;       /* true if premoving White first move  */
 630     char *premoveWhiteText;     /* text of White premove 1 */
 631     Boolean premoveBlack;       /* true if premoving Black first move */
 632     char *premoveBlackText;     /* text of Black premove 1 */
 633     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 634     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 635     Boolean autoRaiseBoard;
 636     int fontSizeTolerance; /* xboard only */
 637     char *initialMode;
 638     char *variant;
 639     char *chatBoxes;
 640     int protocolVersion[ENGINES];
 641     Boolean showButtonBar;
 642     Boolean icsEngineAnalyze;
 643     Boolean variations;         /* [HGM] enable variation-tree walking */
 644     Boolean autoExtend;         /* [HGM] enable playing move(s) of right-clicked PV in analysis mode */
 645
 646     /* [AS] New properties (down to the "ZIPPY" part) */
 647     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
 648     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 649     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 650     Boolean cumulativeTimePGN;     /* If true, times saved in PGN extended info is time left on clock */
 651     Boolean useBitmaps;
 652     Boolean useFont;
 653     Boolean useBorder;
 654     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 655     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 656     int liteBackTextureMode;
 657     int darkBackTextureMode;
 658     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 659     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 660     char * inscriptions;         /* text (kanji) to write on top of a piece     */
 661     int fontBackColorWhite;
 662     int fontForeColorWhite;
 663     int fontBackColorBlack;
 664     int fontForeColorBlack;
 665     int fontPieceSize; /* Size of font relative to square (percentage) */
 666     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 667     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 668     int delayBeforeQuit;
 669     int delayAfterQuit;
 670     char * nameOfDebugFile;
 671     char * pgnEventHeader;
 672     int defaultFrcPosition;
 673     char * gameListTags;
 674     Boolean saveOutOfBookInfo;
 675     Boolean showEvalInMoveHistory;
 676     int evalHistColorWhite;
 677     int evalHistColorBlack;
 678     Boolean highlightMoveWithArrow;
 679     Boolean tourney;
 680     char * tourneyOptions;
 681     int highlightArrowColor;
 682     Boolean useStickyWindows;
 683     Boolean bgObserve;   /* [HGM] bughouse */
 684     Boolean dualBoard;   /* [HGM] dual     */
 685     Boolean viewer;
 686     char * viewerOptions;
 687     int adjudicateDrawMoves;
 688     Boolean autoDisplayComment;
 689     Boolean autoDisplayTags;
 690     Boolean pseudo[ENGINES]; /* [HGM] pseudo-engines */
 691     Boolean isUCI[ENGINES];
 692     Boolean hasOwnBookUCI[ENGINES];
 693     char * adapterCommand;
 694     char * ucciAdapter;
 695     char * polyglotDir;
 696     Boolean usePolyglotBook;
 697     Boolean defNoBook;
 698     char * polyglotBook;
 699     int bookDepth;
 700     int bookStrength;
 701     int defaultHashSize;
 702     int defaultCacheSizeEGTB;
 703     char * defaultPathEGTB;
 704     int defaultMatchGames;
 705
 706     /* [HGM] Board size */
 707     int NrFiles;
 708     int NrRanks;
 709     int rankOffset;
 710     int holdingsSize;
 711     int matchPause;
 712     char * pieceToCharTable;
 713     char * pieceNickNames;
 714     char * colorNickNames;
 715     Boolean allWhite;
 716     Boolean upsideDown;
 717     Boolean alphaRank;
 718     Boolean testClaims;
 719     Boolean checkMates;
 720     Boolean materialDraws;
 721     Boolean trivialDraws;
 722     int ruleMoves;
 723     int drawRepeats;
 724
 725 #if ZIPPY
 726     char *zippyLines;
 727     char *zippyPinhead;
 728     char *zippyPassword;
 729     char *zippyPassword2;
 730     char *zippyWrongPassword;
 731     char *zippyAcceptOnly;
 732     int zippyUseI;
 733     int zippyBughouse;
 734     int zippyNoplayCrafty;
 735     char *zippyGameEnd;
 736     char *zippyGameStart;
 737     int zippyAdjourn;
 738     int zippyAbort;
 739     char *zippyVariants;
 740     int zippyMaxGames;
 741     int zippyReplayTimeout; /*seconds*/
 742     int zippyShortGame; /* [HGM] aborter   */
 743 #endif
 744     Boolean lowTimeWarning; /* [HGM] low time */
 745     Boolean quitNext;
 746     char *lowTimeWarningColor;
 747
 748     char *serverFileName;
 749     char *serverMovesName;
 750     char *finger;
 751     Boolean suppressLoadMoves;
 752     int serverPause;
 753     int timeOdds[ENGINES];
 754     int drawDepth[ENGINES];
 755     int timeOddsMode;
 756     int accumulateTC[ENGINES];
 757     int NPS[ENGINES];
 758     Boolean autoKibitz;
 759     int engineComments;
 760     int eloThreshold1;  /* [HGM] select   */
 761     int eloThreshold2;
 762     int dateThreshold;
 763     int searchMode;
 764     int stretch;
 765     int minPieces;
 766     int maxPieces;
 767     Boolean ignoreColors;
 768     Boolean findMirror;
 769     char *userName;
 770     int rewindIndex;    /* [HGM] autoinc   */
 771     int sameColorGames; /* [HGM] alternate */
 772     int smpCores;       /* [HGM] SMP       */
 773     char *egtFormats;
 774     int niceEngines;    /* [HGM] nice      */
 775     char *logo[ENGINES];/* [HGM] logo      */
 776     char *pairingEngine;/* [HGM] pairing   */
 777     Boolean autoLogo;
 778     Boolean fixedSize;
 779     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 780     char *engOptions[ENGINES]; /* [HGM] options   */
 781     char *fenOverride[ENGINES];
 782     char *features[ENGINES];
 783     char *featureDefaults;
 784     char *sysOpen;
 785     Boolean keepAlive;  /* [HGM] alive     */
 786     Boolean forceIllegal;/*[HGM] illegal   */
 787     Boolean noJoin;     /* [HGM] join      */
 788     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 789     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 790     Boolean pasteSelection; /* paste X selection instead of clipboard */
 791     int nrVariations;   /* [HGM] multivar  */
 792     int zoom;           /* [HGM] evalGraph */
 793     int evalThreshold;  /* [HGM] evalGraph */
 794     Boolean dropMenu;   /* [HGM] pv        */
 795     Boolean markers;    /* [HGM] markers   */
 796     Boolean autoCopyPV;
 797     Boolean pieceMenu;
 798     Boolean sweepSelect;
 799     Boolean monoMouse;
 800     Boolean whitePOV;
 801     Boolean scoreWhite;
 802     Boolean pvSAN[ENGINES];
 803
 804     int recentEngines;
 805     char *recentEngineList;
 806     char *message;
 807     char *suppress;
 808     char *fen;
 809     char *men;
 810     char *tourneyFile;
 811     char *defName;
 812     char *processes;
 813     char *results;
 814     char *participants;
 815     char *afterGame;
 816     char *afterTourney;
 817     int tourneyType;
 818     int tourneyCycles;
 819     int seedBase;
 820     int bmpSave;
 821     Boolean roundSync;
 822     Boolean cycleSync;
 823     Boolean numberTag;
 824 } AppData, *AppDataPtr;
 825
 826 /*  PGN tags (for showing in the game list) */
 827 #define LPUSERGLT_SIZE      64
 828
 829 #define GLT_EVENT           'e'
 830 #define GLT_SITE            's'
 831 #define GLT_DATE            'd'
 832 #define GLT_ROUND           'o'
 833 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 834 #define GLT_RESULT          'r'
 835 #define GLT_WHITE_ELO       'w'
 836 #define GLT_BLACK_ELO       'b'
 837 #define GLT_TIME_CONTROL    't'
 838 #define GLT_VARIANT         'v'
 839 #define GLT_OUT_OF_BOOK     'a'
 840 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 841
 842 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 843
 844 #define GLT_ALL_TAGS        "esdoprwbtvac"
 845
 846 #define PGN_OUT_OF_BOOK     "Annotator"
 847
 848 extern AppData appData;
 849
 850 typedef struct {
 851     /* PGN 7-tag info */
 852     char *event;
 853     char *site;
 854     char *date;
 855     char *round;
 856     char *white;
 857     char *black;
 858     ChessMove result;
 859     /* Additional info */
 860     char *fen;          /* NULL or FEN for starting position; input only */
 861     char *resultDetails;
 862     char *timeControl;
 863     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 864     int whiteRating;    /* -1 if unknown */
 865     int blackRating;    /* -1 if unknown */
 866     VariantClass variant;
 867     char *variantName;
 868     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 869     int boardWidth;     /* [HGM] adjustable board size */
 870     int boardHeight;
 871 /* [HGM] For Shogi and Crazyhouse: */
 872     int holdingsSize;  /* number of different piece types in holdings       */
 873     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 874 } GameInfo;
 875
 876 /* [AS] Search stats from chessprogram, for the played move */
 877 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 878 typedef struct {
 879     int score;  /* Centipawns */
 880     int depth;  /* Plies */
 881     int time;   /* Milliseconds */
 882 } ChessProgramStats_Move;
 883
 884 /* [AS] Layout management */
 885 typedef struct {
 886     Boolean visible;
 887     int x;
 888     int y;
 889     int width;
 890     int height;
 891 } WindowPlacement;
 892
 893 extern WindowPlacement wpEngineOutput;
 894 extern WindowPlacement wpEvalGraph;
 895 extern WindowPlacement wpMoveHistory;
 896 extern WindowPlacement wpGameList;
 897 extern WindowPlacement wpTags;
 898 extern WindowPlacement wpTextMenu;
 899
 900 #define MAXENGINES 2000
 901
 902 // [HGM] chat
 903 #define MAX_CHAT 5
 904 extern int chatCount;
 905 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 906
 907 // Some prototypes of routines so general they should be available everywhere
 908 /* If status == 0, we are exiting with a benign message, not an error */
 909 void DisplayFatalError P((String message, int error, int status));
 910 void DisplayError P((String message, int error));
 911
 912 // [HGM] generally useful macros; there are way too many memory leaks...
 913 #define FREE(x) if(x) free(x)
 914 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
 915
 916 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
 917 //       in due time we would have to make the actual substitutions all through the source
 918
 919 #define firstInitString       engInitString[0]
 920 #define secondInitString      engInitString[1]
 921 #define firstComputerString   computerString[0]
 922 #define secondComputerString  computerString[1]
 923 #define firstChessProgram     chessProgram[0]
 924 #define secondChessProgram    chessProgram[1]
 925 #define firstDirectory        directory[0]
 926 #define secondDirectory       directory[1]
 927 #define firstProtocolVersion  protocolVersion[0]
 928 #define secondProtocolVersion protocolVersion[1]
 929 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
 930 #define secondScoreIsAbsolute scoreIsAbsolute[1]
 931 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
 932 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
 933 #define firstTimeOdds         timeOdds[0]
 934 #define secondTimeOdds        timeOdds[1]
 935 #define firstAccumulateTC     accumulateTC[0]
 936 #define secondAccumulateTC    accumulateTC[1]
 937 #define firstHost    host[0]
 938 #define secondHost   host[1]
 939 #define reuseFirst   reuse[0]
 940 #define reuseSecond  reuse[1]
 941 #define firstIsUCI   isUCI[0]
 942 #define secondIsUCI  isUCI[1]
 943 #define firstNPS     NPS[0]
 944 #define secondNPS    NPS[1]
 945 #define firstLogo    logo[0]
 946 #define secondLogo   logo[1]
 947 #define fenOverride1 fenOverride[0]
 948 #define fenOverride2 fenOverride[1]
 949 #define firstOptions      engOptions[0]
 950 #define secondOptions     engOptions[1]
 951
 952 #endif