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 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 #ifdef X11
  85 #include <X11/Intrinsic.h>
  86 #else
  87 typedef char Boolean;
  88 typedef char *String;
  89 #define True 1
  90 #define False 0
  91 #endif
  92 #endif
  93 #endif
  94
  95
  96 #ifndef TRUE
  97 #define TRUE 1
  98 #define FALSE 0
  99 #endif
 100
 101 #define UNKNOWN -1 /* [HGM] nps */
 102
 103 #if !HAVE_RANDOM
 104 # if HAVE_RAND48
 105 #  define srandom srand48
 106 #  define random lrand48
 107 # else /* not HAVE_RAND48 */
 108 #  define srandom srand
 109 #  define random rand
 110 # endif /* not HAVE_RAND48 */
 111 #endif /* !HAVE_RANDOM */
 112
 113 /* End compatibility grunge */
 114
 115 /* unsigned int 64 for engine nodes work and display */
 116 #ifdef WIN32
 117        /* I don't know the name for this type of other compiler
 118         * If it not work, just modify here
 119         * This is for MS Visual Studio
 120         */
 121        #ifdef _MSC_VER
 122                #define u64 unsigned __int64
 123                #define s64 signed __int64
 124                #define u64Display "%I64u"
 125                #define s64Display "%I64d"
 126                #define u64Const(c) (c ## UI64)
 127                #define s64Const(c) (c ## I64)
 128        #else
 129                /* place holder
 130                 * or dummy types for other compiler
 131                 * [HGM] seems that -mno-cygwin comple needs %I64?
 132                 */
 133                #define u64 unsigned long long
 134                #define s64 signed long long
 135                #ifdef USE_I64
 136                   #define u64Display "%I64u"
 137                   #define s64Display "%I64d"
 138                #else
 139                   #define u64Display "%llu"
 140                   #define s64Display "%lld"
 141                #endif
 142                #define u64Const(c) (c ## ULL)
 143                #define s64Const(c) (c ## LL)
 144        #endif
 145 #else
 146        /* GNU gcc */
 147        #define u64 unsigned long long
 148        #define s64 signed long long
 149        #define u64Display "%llu"
 150        #define s64Display "%lld"
 151        #define u64Const(c) (c ## ull)
 152        #define s64Const(c) (c ## ll)
 153 #endif
 154
 155 #define PROTOVER                2       /* engine protocol version */
 156
 157 // [HGM] license: Messages that engines must print to satisfy their license requirements for patented variants
 158 #define GOTHIC "Gothic Chess (see www.GothicChess.com) is licensed under U.S. Patent #6,481,716 by Ed Trice"
 159 #define FALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
 160
 161 /* [HGM] Some notes about board sizes:
 162    In games that allow piece drops, the holdings are considered part of the
 163    board, in the leftmost and rightmost two files. This way they are
 164    automatically part of the game-history states, and enjoy all display
 165    functions (including drag-drop and click-click moves to the regular part
 166    of the board). The drawback of this is that the internal numbering of
 167    files starts at 2 for the a-file if holdings are displayed. To ensure
 168    consistency, this shifted numbering system is used _everywhere_ in the
 169    code, and conversion to the 'normal' system only takes place when the
 170    file number is converted to or from ASCII (by redefining the character
 171    constant 'a'). This works because Winboard only communicates with the
 172    outside world in ASCII. In a similar way, the different rank numbering
 173    systems (starting at rank 0 or 1) are implemented by redefining '1'.
 174 */
 175 #define BOARD_RANKS             17            /* [HGM] for in declarations  */
 176 #define BOARD_FILES             16             /* [HGM] for in declarations  */
 177 #define BOARD_HEIGHT (gameInfo.boardHeight)    /* [HGM] made user adjustable */
 178 #define BOARD_WIDTH  (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)
 179 #define BOARD_LEFT   (gameInfo.holdingsWidth)  /* [HGM] play-board edges     */
 180 #define BOARD_RGHT   (gameInfo.boardWidth + gameInfo.holdingsWidth)
 181 #define CASTLING     (BOARD_RANKS-1)           /* [HGM] hide in upper rank   */
 182 #define VIRGIN       (BOARD_RANKS-2)           /* [HGM] pieces not moved     */
 183 #define TOUCHED_W    CASTLING][(BOARD_FILES-6) /* [HGM] in upper rank        */
 184 #define TOUCHED_B    CASTLING][(BOARD_FILES-5) /* [HGM] in upper rank        */
 185 #define EP_RANK      CASTLING][(BOARD_FILES-4) /* [HGM] in upper rank        */
 186 #define EP_FILE      CASTLING][(BOARD_FILES-3) /* [HGM] in upper rank        */
 187 #define EP_STATUS    CASTLING][(BOARD_FILES-2) /* [HGM] in upper rank        */
 188 #define HOLDINGS_SET CASTLING][(BOARD_FILES-1) /* [HGM] in upper-right corner*/
 189 #define ONE          ('1'-(BOARD_HEIGHT==10)-appData.rankOffset)  /* [HGM] foremost board rank  */
 190 #define AAA          ('a'-BOARD_LEFT)          /* [HGM] leftmost board file  */
 191 #define VIRGIN_W                 1             /* [HGM] flags in Board[VIRGIN][X] */
 192 #define VIRGIN_B                 2
 193 #define DROP_RANK               -3
 194 #define MAX_MOVES               1000
 195 #define MSG_SIZ                 512
 196 #define DIALOG_SIZE             256
 197 #define STAR_MATCH_N            16
 198 #define MOVE_LEN                32
 199 #define TIME_CONTROL            "5"     /* in minutes */
 200 #define TIME_DELAY_QUOTE        "1.0"   /* seconds between moves */
 201 #define TIME_DELAY              ((float) 1.0)
 202 #define MOVES_PER_SESSION       40      /* moves per TIME_CONTROL */
 203 #define TIME_INCREMENT          -1      /* if >= 0, MOVES_PER_SESSION unused */
 204 #define WhiteOnMove(move)       (((move) % 2) == 0)
 205 #define ICS_HOST                "chessclub.com"
 206 #define ICS_PORT                "5000"
 207 #define ICS_COMM_PORT           ""
 208 #define FIRST_HOST              "localhost"
 209 #define SECOND_HOST             "localhost"
 210 #define TELNET_PROGRAM          "telnet"
 211 #define DEF_BITMAP_DIR          BITMAPDIR
 212 #define MATCH_MODE              "False"
 213 #define INIT_STRING             "new\nrandom\n"
 214 #define WHITE_STRING            "white\ngo\n"
 215 #define BLACK_STRING            "black\ngo\n"
 216 #define COMPUTER_STRING         "computer\n"
 217 #define REUSE_CHESS_PROGRAMS    1
 218 #define WHITE_PIECE_COLOR       "#FFFFCC"
 219 #define BLACK_PIECE_COLOR       "#202020"
 220 #define LIGHT_SQUARE_COLOR      "#C8C365"
 221 #define DARK_SQUARE_COLOR       "#77A26D"
 222 #define JAIL_SQUARE_COLOR       "#808080"
 223 #define HIGHLIGHT_SQUARE_COLOR  "#FFFF00"
 224 #define PREMOVE_HIGHLIGHT_COLOR "#FF0000"
 225 #define LOWTIMEWARNING_COLOR    "#FF0000"
 226 #define BELLCHAR                '\007'
 227 #define NULLCHAR                '\000'
 228 #define FEATURE_TIMEOUT         10000 /*ms*/
 229 #define MATE_SCORE              100000
 230
 231 #define CLOCK_FONT 0
 232 #define MESSAGE_FONT 1
 233 #define COORD_FONT 2
 234 #define CONSOLE_FONT 3
 235 #define COMMENT_FONT 4
 236 #define EDITTAGS_FONT 5
 237 #define MOVEHISTORY_FONT 6
 238 #define GAMELIST_FONT 7
 239 #define NUM_FONTS 8
 240
 241 /* Default to no flashing (the "usual" XBoard behavior) */
 242 #define FLASH_COUNT     0               /* Number of times to flash */
 243 #define FLASH_RATE      5               /* Flashes per second */
 244
 245 /* Default delay per character (in msec) while sending login script */
 246 #define MS_LOGIN_DELAY  0
 247
 248 /* [AS] Support for background textures */
 249 #define BACK_TEXTURE_MODE_DISABLED      0
 250 #define BACK_TEXTURE_MODE_PLAIN         1
 251 #define BACK_TEXTURE_MODE_FULL_RANDOM   2
 252
 253 /* Zippy defaults */
 254 #define ZIPPY_TALK FALSE
 255 #define ZIPPY_PLAY FALSE
 256 #define ZIPPY_LINES "yow.lines"
 257 #define ZIPPY_PINHEAD ""
 258 #define ZIPPY_PASSWORD ""
 259 #define ZIPPY_PASSWORD2 ""
 260 #define ZIPPY_WRONG_PASSWORD ""
 261 #define ZIPPY_ACCEPT_ONLY ""
 262 #define ZIPPY_USE_I TRUE
 263 #define ZIPPY_BUGHOUSE 0
 264 #define ZIPPY_NOPLAY_CRAFTY FALSE
 265 #define ZIPPY_GAME_END "gameend\n"
 266 #define ZIPPY_GAME_START ""
 267 #define ZIPPY_ADJOURN FALSE
 268 #define ZIPPY_ABORT FALSE
 269 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
 270 #define ZIPPY_MAX_GAMES 0
 271 #define ZIPPY_REPLAY_TIMEOUT 120
 272
 273 typedef VOIDSTAR ProcRef;
 274 #define NoProc ((ProcRef) 0)
 275 typedef VOIDSTAR InputSourceRef;
 276
 277 typedef void (*DelayedEventCallback) P((void));
 278
 279 typedef enum { Press, Release } ClickType;
 280
 281 typedef enum {
 282     BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
 283     AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
 284     EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
 285     IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
 286     IcsExamining
 287   } GameMode;
 288
 289 typedef enum {
 290     /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
 291     /* only the first N pieces can go into the holdings, and   */
 292     /* promotions in those variants shift P-W to U-S           */
 293     WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
 294     WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
 295     WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
 296     WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteLion,
 297     WhiteButterfly, WhiteZebra, WhiteCamel, WhiteTower, WhiteWolf,
 298     WhiteFlying, WhiteDuck, WhiteAxe, WhiteHat, WhiteGnu, WhiteCub,
 299     WhiteTokin, WhiteClaw, WhitePCardinal, WhitePDragon, WhiteCat,
 300     WhitePSword, WhiteMonarch, WhiteMother, WhiteNothing, WhitePRook, WhitePDagger,
 301     WhiteDolphin, WhiteStag, WhiteHorned, WhiteEagle, WhiteSword,
 302     WhiteCrown, WhiteHCrown, WhiteHorse, WhiteDrunk, WhitePBishop,
 303     WhiteWheel, WhitePKnight, WhiteWizard, WhiteCopper, WhiteIron, WhiteViking,
 304     WhiteFlag, WhiteAmazon, WhiteWheer, WhiteShield, WhiteShierd,
 305     WhiteKing,
 306     BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
 307     BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
 308     BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
 309     BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackLion,
 310     BlackButterfly, BlackZebra, BlackCamel, BlackTower, BlackWolf,
 311     BlackFlying, BlackDuck, BlackAxe, BlackHat, BlackGnu, BlackCub,
 312     BlackTokin, BlackClaw, BlackPCardinal, BlackPDragon, BlackCat,
 313     BlackPSword, BlackMonarch, BlackMother, BlackNothing, BlackPRook, BlackPDagger,
 314     BlackDolphin, BlackStag, BlackHorned, BlackEagle, BlackSword,
 315     BlackCrown, BlackHCrown, BlackHorse, BlackDrunk, BlackPBishop,
 316     BlackWheel, BlackPKnight, BlackWizard, BlackCopper, BlackIron, BlackViking,
 317     BlackFlag, BlackAmazon, BlackWheer, BlackShield, BlackShierd,
 318     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     Boolean ringBellAfterMoves;
 558     Boolean autoCallFlag;
 559     Boolean flipView;
 560     Boolean autoFlipView;
 561     char *cmailGameName; /* xboard only */
 562     Boolean headers;
 563     Boolean alwaysPromoteToQueen;
 564     Boolean oldSaveStyle;
 565     Boolean oneClick;
 566     Boolean quietPlay;
 567     Boolean showThinking;
 568     Boolean ponderNextMove;
 569     Boolean periodicUpdates;
 570     Boolean autoObserve;
 571     Boolean autoCreateLogon;
 572     Boolean autoComment;
 573     Boolean getMoveList;
 574     Boolean testLegality;
 575     Boolean topLevel;      /* xboard, top-level auxiliary windows */
 576     Boolean titleInWindow; /* xboard only */
 577     Boolean localLineEditing; /* WinBoard only */
 578     Boolean zippyTalk;
 579     Boolean zippyPlay;
 580     int flashCount; /* Number of times to flash (xboard only) */
 581     int flashRate; /* Flashes per second (xboard only)  */
 582     int msLoginDelay;  /* Delay per character (in msec) while sending
 583                           ICS logon script (xboard only) */
 584     Boolean colorize;   /* If True, use the following colors to color text */
 585     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 586     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 587     char *colorSShout;
 588     char *colorChannel1;
 589     char *colorChannel;
 590     char *colorKibitz;
 591     char *colorTell;
 592     char *colorChallenge;
 593     char *colorRequest;
 594     char *colorSeek;
 595     char *colorNormal;
 596     char *soundProgram; /* sound-playing program */
 597     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 598     char *soundSShout;
 599     char *soundChannel1;
 600     char *soundChannel;
 601     char *soundKibitz;
 602     char *soundTell;
 603     char *soundChallenge;
 604     char *soundRequest;
 605     char *soundSeek;
 606     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 607     char *soundBell;
 608     char *soundRoar;
 609     char *soundIcsAlarm;
 610     char *soundIcsWin;
 611     char *soundIcsLoss;
 612     char *soundIcsDraw;
 613     char *soundIcsUnfinished;
 614     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
 615     Boolean reuse[ENGINES];
 616     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 617     Boolean animate;    /* If True, animate non-mouse moves */
 618     int animSpeed;      /* Delay in milliseconds between animation frames */
 619     Boolean popupMoveErrors;
 620     Boolean popupExitMessage;
 621     int showJail;
 622     Boolean highlightLastMove;
 623     Boolean highlightDragging;
 624     Boolean blindfold;          /* if true, no pieces are drawn */
 625     Boolean premove;            /* true if premove feature enabled */
 626     Boolean premoveWhite;       /* true if premoving White first move  */
 627     char *premoveWhiteText;     /* text of White premove 1 */
 628     Boolean premoveBlack;       /* true if premoving Black first move */
 629     char *premoveBlackText;     /* text of Black premove 1 */
 630     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 631     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 632     Boolean autoRaiseBoard;
 633     int fontSizeTolerance; /* xboard only */
 634     char *initialMode;
 635     char *variant;
 636     char *chatBoxes;
 637     int protocolVersion[ENGINES];
 638     Boolean showButtonBar;
 639     Boolean icsEngineAnalyze;
 640     Boolean variations;         /* [HGM] enable variation-tree walking */
 641     Boolean autoExtend;         /* [HGM] enable playing move(s) of right-clicked PV in analysis mode */
 642
 643     /* [AS] New properties (down to the "ZIPPY" part) */
 644     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
 645     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 646     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 647     Boolean useBitmaps;
 648     Boolean useFont;
 649     Boolean useBorder;
 650     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 651     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 652     int liteBackTextureMode;
 653     int darkBackTextureMode;
 654     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 655     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 656     char * inscriptions;         /* text (kanji) to write on top of a piece     */
 657     int fontBackColorWhite;
 658     int fontForeColorWhite;
 659     int fontBackColorBlack;
 660     int fontForeColorBlack;
 661     int fontPieceSize; /* Size of font relative to square (percentage) */
 662     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 663     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 664     int delayBeforeQuit;
 665     int delayAfterQuit;
 666     char * nameOfDebugFile;
 667     char * pgnEventHeader;
 668     int defaultFrcPosition;
 669     char * gameListTags;
 670     Boolean saveOutOfBookInfo;
 671     Boolean showEvalInMoveHistory;
 672     int evalHistColorWhite;
 673     int evalHistColorBlack;
 674     Boolean highlightMoveWithArrow;
 675     Boolean tourney;
 676     char * tourneyOptions;
 677     int highlightArrowColor;
 678     Boolean useStickyWindows;
 679     Boolean bgObserve;   /* [HGM] bughouse */
 680     Boolean dualBoard;   /* [HGM] dual     */
 681     Boolean viewer;
 682     char * viewerOptions;
 683     int adjudicateDrawMoves;
 684     Boolean autoDisplayComment;
 685     Boolean autoDisplayTags;
 686     Boolean pseudo[ENGINES]; /* [HGM] pseudo-engines */
 687     Boolean isUCI[ENGINES];
 688     Boolean hasOwnBookUCI[ENGINES];
 689     char * adapterCommand;
 690     char * ucciAdapter;
 691     char * polyglotDir;
 692     Boolean usePolyglotBook;
 693     Boolean defNoBook;
 694     char * polyglotBook;
 695     int bookDepth;
 696     int bookStrength;
 697     int defaultHashSize;
 698     int defaultCacheSizeEGTB;
 699     char * defaultPathEGTB;
 700     int defaultMatchGames;
 701
 702     /* [HGM] Board size */
 703     int NrFiles;
 704     int NrRanks;
 705     int rankOffset;
 706     int holdingsSize;
 707     int matchPause;
 708     char * pieceToCharTable;
 709     char * pieceNickNames;
 710     char * colorNickNames;
 711     Boolean allWhite;
 712     Boolean upsideDown;
 713     Boolean alphaRank;
 714     Boolean testClaims;
 715     Boolean checkMates;
 716     Boolean materialDraws;
 717     Boolean trivialDraws;
 718     int ruleMoves;
 719     int drawRepeats;
 720
 721 #if ZIPPY
 722     char *zippyLines;
 723     char *zippyPinhead;
 724     char *zippyPassword;
 725     char *zippyPassword2;
 726     char *zippyWrongPassword;
 727     char *zippyAcceptOnly;
 728     int zippyUseI;
 729     int zippyBughouse;
 730     int zippyNoplayCrafty;
 731     char *zippyGameEnd;
 732     char *zippyGameStart;
 733     int zippyAdjourn;
 734     int zippyAbort;
 735     char *zippyVariants;
 736     int zippyMaxGames;
 737     int zippyReplayTimeout; /*seconds*/
 738     int zippyShortGame; /* [HGM] aborter   */
 739 #endif
 740     Boolean lowTimeWarning; /* [HGM] low time */
 741     Boolean quitNext;
 742     char *lowTimeWarningColor;
 743
 744     char *serverFileName;
 745     char *serverMovesName;
 746     char *finger;
 747     Boolean suppressLoadMoves;
 748     int serverPause;
 749     int timeOdds[ENGINES];
 750     int drawDepth[ENGINES];
 751     int timeOddsMode;
 752     int accumulateTC[ENGINES];
 753     int NPS[ENGINES];
 754     Boolean autoKibitz;
 755     int engineComments;
 756     int eloThreshold1;  /* [HGM] select   */
 757     int eloThreshold2;
 758     int dateThreshold;
 759     int searchMode;
 760     int stretch;
 761     int minPieces;
 762     int maxPieces;
 763     Boolean ignoreColors;
 764     Boolean findMirror;
 765     char *userName;
 766     int rewindIndex;    /* [HGM] autoinc   */
 767     int sameColorGames; /* [HGM] alternate */
 768     int smpCores;       /* [HGM] SMP       */
 769     char *egtFormats;
 770     int niceEngines;    /* [HGM] nice      */
 771     char *logo[ENGINES];/* [HGM] logo      */
 772     char *pairingEngine;/* [HGM] pairing   */
 773     Boolean autoLogo;
 774     Boolean fixedSize;
 775     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 776     char *engOptions[ENGINES]; /* [HGM] options   */
 777     char *fenOverride[ENGINES];
 778     char *features[ENGINES];
 779     char *featureDefaults;
 780     char *sysOpen;
 781     Boolean keepAlive;  /* [HGM] alive     */
 782     Boolean forceIllegal;/*[HGM] illegal   */
 783     Boolean noJoin;     /* [HGM] join      */
 784     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 785     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 786     Boolean pasteSelection; /* paste X selection instead of clipboard */
 787     int nrVariations;   /* [HGM] multivar  */
 788     int zoom;           /* [HGM] evalGraph */
 789     int evalThreshold;  /* [HGM] evalGraph */
 790     Boolean dropMenu;   /* [HGM] pv        */
 791     Boolean markers;    /* [HGM] markers   */
 792     Boolean autoCopyPV;
 793     Boolean pieceMenu;
 794     Boolean sweepSelect;
 795     Boolean monoMouse;
 796     Boolean whitePOV;
 797     Boolean scoreWhite;
 798     Boolean pvSAN[ENGINES];
 799
 800     int recentEngines;
 801     char *recentEngineList;
 802     char *tourneyFile;
 803     char *defName;
 804     char *processes;
 805     char *results;
 806     char *participants;
 807     char *afterGame;
 808     char *afterTourney;
 809     int tourneyType;
 810     int tourneyCycles;
 811     int seedBase;
 812     Boolean roundSync;
 813     Boolean cycleSync;
 814     Boolean numberTag;
 815 } AppData, *AppDataPtr;
 816
 817 /*  PGN tags (for showing in the game list) */
 818 #define LPUSERGLT_SIZE      64
 819
 820 #define GLT_EVENT           'e'
 821 #define GLT_SITE            's'
 822 #define GLT_DATE            'd'
 823 #define GLT_ROUND           'o'
 824 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 825 #define GLT_RESULT          'r'
 826 #define GLT_WHITE_ELO       'w'
 827 #define GLT_BLACK_ELO       'b'
 828 #define GLT_TIME_CONTROL    't'
 829 #define GLT_VARIANT         'v'
 830 #define GLT_OUT_OF_BOOK     'a'
 831 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 832
 833 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 834
 835 #define GLT_ALL_TAGS        "esdoprwbtvac"
 836
 837 #define PGN_OUT_OF_BOOK     "Annotator"
 838
 839 extern AppData appData;
 840
 841 typedef struct {
 842     /* PGN 7-tag info */
 843     char *event;
 844     char *site;
 845     char *date;
 846     char *round;
 847     char *white;
 848     char *black;
 849     ChessMove result;
 850     /* Additional info */
 851     char *fen;          /* NULL or FEN for starting position; input only */
 852     char *resultDetails;
 853     char *timeControl;
 854     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 855     int whiteRating;    /* -1 if unknown */
 856     int blackRating;    /* -1 if unknown */
 857     VariantClass variant;
 858     char *variantName;
 859     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 860     int boardWidth;     /* [HGM] adjustable board size */
 861     int boardHeight;
 862 /* [HGM] For Shogi and Crazyhouse: */
 863     int holdingsSize;  /* number of different piece types in holdings       */
 864     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 865 } GameInfo;
 866
 867 /* [AS] Search stats from chessprogram, for the played move */
 868 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 869 typedef struct {
 870     int score;  /* Centipawns */
 871     int depth;  /* Plies */
 872     int time;   /* Milliseconds */
 873 } ChessProgramStats_Move;
 874
 875 /* [AS] Layout management */
 876 typedef struct {
 877     Boolean visible;
 878     int x;
 879     int y;
 880     int width;
 881     int height;
 882 } WindowPlacement;
 883
 884 extern WindowPlacement wpEngineOutput;
 885 extern WindowPlacement wpEvalGraph;
 886 extern WindowPlacement wpMoveHistory;
 887 extern WindowPlacement wpGameList;
 888 extern WindowPlacement wpTags;
 889 extern WindowPlacement wpTextMenu;
 890
 891 #define MAXENGINES 2000
 892
 893 // [HGM] chat
 894 #define MAX_CHAT 5
 895 extern int chatCount;
 896 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 897
 898 // Some prototypes of routines so general they should be available everywhere
 899 /* If status == 0, we are exiting with a benign message, not an error */
 900 void DisplayFatalError P((String message, int error, int status));
 901 void DisplayError P((String message, int error));
 902
 903 // [HGM] generally useful macros; there are way too many memory leaks...
 904 #define FREE(x) if(x) free(x)
 905 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
 906
 907 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
 908 //       in due time we would have to make the actual substitutions all through the source
 909
 910 #define firstInitString       engInitString[0]
 911 #define secondInitString      engInitString[1]
 912 #define firstComputerString   computerString[0]
 913 #define secondComputerString  computerString[1]
 914 #define firstChessProgram     chessProgram[0]
 915 #define secondChessProgram    chessProgram[1]
 916 #define firstDirectory        directory[0]
 917 #define secondDirectory       directory[1]
 918 #define firstProtocolVersion  protocolVersion[0]
 919 #define secondProtocolVersion protocolVersion[1]
 920 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
 921 #define secondScoreIsAbsolute scoreIsAbsolute[1]
 922 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
 923 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
 924 #define firstTimeOdds         timeOdds[0]
 925 #define secondTimeOdds        timeOdds[1]
 926 #define firstAccumulateTC     accumulateTC[0]
 927 #define secondAccumulateTC    accumulateTC[1]
 928 #define firstHost    host[0]
 929 #define secondHost   host[1]
 930 #define reuseFirst   reuse[0]
 931 #define reuseSecond  reuse[1]
 932 #define firstIsUCI   isUCI[0]
 933 #define secondIsUCI  isUCI[1]
 934 #define firstNPS     NPS[0]
 935 #define secondNPS    NPS[1]
 936 #define firstLogo    logo[0]
 937 #define secondLogo   logo[1]
 938 #define fenOverride1 fenOverride[0]
 939 #define fenOverride2 fenOverride[1]
 940 #define firstOptions      engOptions[0]
 941 #define secondOptions     engOptions[1]
 942
 943 #endif