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