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     Boolean ringBellAfterMoves;
 557     Boolean autoCallFlag;
 558     Boolean flipView;
 559     Boolean autoFlipView;
 560     char *cmailGameName; /* xboard only */
 561     Boolean headers;
 562     Boolean alwaysPromoteToQueen;
 563     Boolean oldSaveStyle;
 564     Boolean oneClick;
 565     Boolean quietPlay;
 566     Boolean showThinking;
 567     Boolean ponderNextMove;
 568     Boolean periodicUpdates;
 569     Boolean autoObserve;
 570     Boolean autoCreateLogon;
 571     Boolean autoComment;
 572     Boolean getMoveList;
 573     Boolean testLegality;
 574     Boolean topLevel;      /* xboard, top-level auxiliary windows */
 575     Boolean titleInWindow; /* xboard only */
 576     Boolean localLineEditing; /* WinBoard only */
 577     Boolean zippyTalk;
 578     Boolean zippyPlay;
 579     int flashCount; /* Number of times to flash (xboard only) */
 580     int flashRate; /* Flashes per second (xboard only)  */
 581     int msLoginDelay;  /* Delay per character (in msec) while sending
 582                           ICS logon script (xboard only) */
 583     Boolean colorize;   /* If True, use the following colors to color text */
 584     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 585     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 586     char *colorSShout;
 587     char *colorChannel1;
 588     char *colorChannel;
 589     char *colorKibitz;
 590     char *colorTell;
 591     char *colorChallenge;
 592     char *colorRequest;
 593     char *colorSeek;
 594     char *colorNormal;
 595     char *soundProgram; /* sound-playing program */
 596     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 597     char *soundSShout;
 598     char *soundChannel1;
 599     char *soundChannel;
 600     char *soundKibitz;
 601     char *soundTell;
 602     char *soundChallenge;
 603     char *soundRequest;
 604     char *soundSeek;
 605     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 606     char *soundBell;
 607     char *soundRoar;
 608     char *soundIcsAlarm;
 609     char *soundIcsWin;
 610     char *soundIcsLoss;
 611     char *soundIcsDraw;
 612     char *soundIcsUnfinished;
 613     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
 614     Boolean reuse[ENGINES];
 615     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 616     Boolean animate;    /* If True, animate non-mouse moves */
 617     int animSpeed;      /* Delay in milliseconds between animation frames */
 618     Boolean popupMoveErrors;
 619     Boolean popupExitMessage;
 620     int showJail;
 621     Boolean highlightLastMove;
 622     Boolean highlightDragging;
 623     Boolean blindfold;          /* if true, no pieces are drawn */
 624     Boolean premove;            /* true if premove feature enabled */
 625     Boolean premoveWhite;       /* true if premoving White first move  */
 626     char *premoveWhiteText;     /* text of White premove 1 */
 627     Boolean premoveBlack;       /* true if premoving Black first move */
 628     char *premoveBlackText;     /* text of Black premove 1 */
 629     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 630     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 631     Boolean autoRaiseBoard;
 632     int fontSizeTolerance; /* xboard only */
 633     char *initialMode;
 634     char *variant;
 635     char *chatBoxes;
 636     int protocolVersion[ENGINES];
 637     Boolean showButtonBar;
 638     Boolean icsEngineAnalyze;
 639     Boolean variations;         /* [HGM] enable variation-tree walking */
 640     Boolean autoExtend;         /* [HGM] enable playing move(s) of right-clicked PV in analysis mode */
 641
 642     /* [AS] New properties (down to the "ZIPPY" part) */
 643     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
 644     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 645     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 646     Boolean useBitmaps;
 647     Boolean useFont;
 648     Boolean useBorder;
 649     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 650     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 651     int liteBackTextureMode;
 652     int darkBackTextureMode;
 653     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 654     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 655     char * inscriptions;         /* text (kanji) to write on top of a piece     */
 656     int fontBackColorWhite;
 657     int fontForeColorWhite;
 658     int fontBackColorBlack;
 659     int fontForeColorBlack;
 660     int fontPieceSize; /* Size of font relative to square (percentage) */
 661     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 662     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 663     int delayBeforeQuit;
 664     int delayAfterQuit;
 665     char * nameOfDebugFile;
 666     char * pgnEventHeader;
 667     int defaultFrcPosition;
 668     char * gameListTags;
 669     Boolean saveOutOfBookInfo;
 670     Boolean showEvalInMoveHistory;
 671     int evalHistColorWhite;
 672     int evalHistColorBlack;
 673     Boolean highlightMoveWithArrow;
 674     Boolean tourney;
 675     char * tourneyOptions;
 676     int highlightArrowColor;
 677     Boolean useStickyWindows;
 678     Boolean bgObserve;   /* [HGM] bughouse */
 679     Boolean dualBoard;   /* [HGM] dual     */
 680     Boolean viewer;
 681     char * viewerOptions;
 682     int adjudicateDrawMoves;
 683     Boolean autoDisplayComment;
 684     Boolean autoDisplayTags;
 685     Boolean pseudo[ENGINES]; /* [HGM] pseudo-engines */
 686     Boolean isUCI[ENGINES];
 687     Boolean hasOwnBookUCI[ENGINES];
 688     char * adapterCommand;
 689     char * ucciAdapter;
 690     char * polyglotDir;
 691     Boolean usePolyglotBook;
 692     Boolean defNoBook;
 693     char * polyglotBook;
 694     int bookDepth;
 695     int bookStrength;
 696     int defaultHashSize;
 697     int defaultCacheSizeEGTB;
 698     char * defaultPathEGTB;
 699     int defaultMatchGames;
 700
 701     /* [HGM] Board size */
 702     int NrFiles;
 703     int NrRanks;
 704     int rankOffset;
 705     int holdingsSize;
 706     int matchPause;
 707     char * pieceToCharTable;
 708     char * pieceNickNames;
 709     char * colorNickNames;
 710     Boolean allWhite;
 711     Boolean upsideDown;
 712     Boolean alphaRank;
 713     Boolean testClaims;
 714     Boolean checkMates;
 715     Boolean materialDraws;
 716     Boolean trivialDraws;
 717     int ruleMoves;
 718     int drawRepeats;
 719
 720 #if ZIPPY
 721     char *zippyLines;
 722     char *zippyPinhead;
 723     char *zippyPassword;
 724     char *zippyPassword2;
 725     char *zippyWrongPassword;
 726     char *zippyAcceptOnly;
 727     int zippyUseI;
 728     int zippyBughouse;
 729     int zippyNoplayCrafty;
 730     char *zippyGameEnd;
 731     char *zippyGameStart;
 732     int zippyAdjourn;
 733     int zippyAbort;
 734     char *zippyVariants;
 735     int zippyMaxGames;
 736     int zippyReplayTimeout; /*seconds*/
 737     int zippyShortGame; /* [HGM] aborter   */
 738 #endif
 739     Boolean lowTimeWarning; /* [HGM] low time */
 740     Boolean quitNext;
 741     char *lowTimeWarningColor;
 742
 743     char *serverFileName;
 744     char *serverMovesName;
 745     char *finger;
 746     Boolean suppressLoadMoves;
 747     int serverPause;
 748     int timeOdds[ENGINES];
 749     int drawDepth[ENGINES];
 750     int timeOddsMode;
 751     int accumulateTC[ENGINES];
 752     int NPS[ENGINES];
 753     Boolean autoKibitz;
 754     int engineComments;
 755     int eloThreshold1;  /* [HGM] select   */
 756     int eloThreshold2;
 757     int dateThreshold;
 758     int searchMode;
 759     int stretch;
 760     int minPieces;
 761     int maxPieces;
 762     Boolean ignoreColors;
 763     Boolean findMirror;
 764     char *userName;
 765     int rewindIndex;    /* [HGM] autoinc   */
 766     int sameColorGames; /* [HGM] alternate */
 767     int smpCores;       /* [HGM] SMP       */
 768     char *egtFormats;
 769     int niceEngines;    /* [HGM] nice      */
 770     char *logo[ENGINES];/* [HGM] logo      */
 771     char *pairingEngine;/* [HGM] pairing   */
 772     Boolean autoLogo;
 773     Boolean fixedSize;
 774     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 775     char *engOptions[ENGINES]; /* [HGM] options   */
 776     char *fenOverride[ENGINES];
 777     char *features[ENGINES];
 778     char *featureDefaults;
 779     char *sysOpen;
 780     Boolean keepAlive;  /* [HGM] alive     */
 781     Boolean forceIllegal;/*[HGM] illegal   */
 782     Boolean noJoin;     /* [HGM] join      */
 783     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 784     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 785     Boolean pasteSelection; /* paste X selection instead of clipboard */
 786     int nrVariations;   /* [HGM] multivar  */
 787     int zoom;           /* [HGM] evalGraph */
 788     int evalThreshold;  /* [HGM] evalGraph */
 789     Boolean dropMenu;   /* [HGM] pv        */
 790     Boolean markers;    /* [HGM] markers   */
 791     Boolean autoCopyPV;
 792     Boolean pieceMenu;
 793     Boolean sweepSelect;
 794     Boolean monoMouse;
 795     Boolean whitePOV;
 796     Boolean scoreWhite;
 797     Boolean pvSAN[ENGINES];
 798
 799     int recentEngines;
 800     char *recentEngineList;
 801     char *message;
 802     char *suppress;
 803     char *fen;
 804     char *tourneyFile;
 805     char *defName;
 806     char *processes;
 807     char *results;
 808     char *participants;
 809     char *afterGame;
 810     char *afterTourney;
 811     int tourneyType;
 812     int tourneyCycles;
 813     int seedBase;
 814     Boolean roundSync;
 815     Boolean cycleSync;
 816     Boolean numberTag;
 817 } AppData, *AppDataPtr;
 818
 819 /*  PGN tags (for showing in the game list) */
 820 #define LPUSERGLT_SIZE      64
 821
 822 #define GLT_EVENT           'e'
 823 #define GLT_SITE            's'
 824 #define GLT_DATE            'd'
 825 #define GLT_ROUND           'o'
 826 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 827 #define GLT_RESULT          'r'
 828 #define GLT_WHITE_ELO       'w'
 829 #define GLT_BLACK_ELO       'b'
 830 #define GLT_TIME_CONTROL    't'
 831 #define GLT_VARIANT         'v'
 832 #define GLT_OUT_OF_BOOK     'a'
 833 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 834
 835 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 836
 837 #define GLT_ALL_TAGS        "esdoprwbtvac"
 838
 839 #define PGN_OUT_OF_BOOK     "Annotator"
 840
 841 extern AppData appData;
 842
 843 typedef struct {
 844     /* PGN 7-tag info */
 845     char *event;
 846     char *site;
 847     char *date;
 848     char *round;
 849     char *white;
 850     char *black;
 851     ChessMove result;
 852     /* Additional info */
 853     char *fen;          /* NULL or FEN for starting position; input only */
 854     char *resultDetails;
 855     char *timeControl;
 856     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 857     int whiteRating;    /* -1 if unknown */
 858     int blackRating;    /* -1 if unknown */
 859     VariantClass variant;
 860     char *variantName;
 861     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 862     int boardWidth;     /* [HGM] adjustable board size */
 863     int boardHeight;
 864 /* [HGM] For Shogi and Crazyhouse: */
 865     int holdingsSize;  /* number of different piece types in holdings       */
 866     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 867 } GameInfo;
 868
 869 /* [AS] Search stats from chessprogram, for the played move */
 870 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 871 typedef struct {
 872     int score;  /* Centipawns */
 873     int depth;  /* Plies */
 874     int time;   /* Milliseconds */
 875 } ChessProgramStats_Move;
 876
 877 /* [AS] Layout management */
 878 typedef struct {
 879     Boolean visible;
 880     int x;
 881     int y;
 882     int width;
 883     int height;
 884 } WindowPlacement;
 885
 886 extern WindowPlacement wpEngineOutput;
 887 extern WindowPlacement wpEvalGraph;
 888 extern WindowPlacement wpMoveHistory;
 889 extern WindowPlacement wpGameList;
 890 extern WindowPlacement wpTags;
 891 extern WindowPlacement wpTextMenu;
 892
 893 #define MAXENGINES 2000
 894
 895 // [HGM] chat
 896 #define MAX_CHAT 5
 897 extern int chatCount;
 898 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 899
 900 // Some prototypes of routines so general they should be available everywhere
 901 /* If status == 0, we are exiting with a benign message, not an error */
 902 void DisplayFatalError P((String message, int error, int status));
 903 void DisplayError P((String message, int error));
 904
 905 // [HGM] generally useful macros; there are way too many memory leaks...
 906 #define FREE(x) if(x) free(x)
 907 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
 908
 909 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
 910 //       in due time we would have to make the actual substitutions all through the source
 911
 912 #define firstInitString       engInitString[0]
 913 #define secondInitString      engInitString[1]
 914 #define firstComputerString   computerString[0]
 915 #define secondComputerString  computerString[1]
 916 #define firstChessProgram     chessProgram[0]
 917 #define secondChessProgram    chessProgram[1]
 918 #define firstDirectory        directory[0]
 919 #define secondDirectory       directory[1]
 920 #define firstProtocolVersion  protocolVersion[0]
 921 #define secondProtocolVersion protocolVersion[1]
 922 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
 923 #define secondScoreIsAbsolute scoreIsAbsolute[1]
 924 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
 925 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
 926 #define firstTimeOdds         timeOdds[0]
 927 #define secondTimeOdds        timeOdds[1]
 928 #define firstAccumulateTC     accumulateTC[0]
 929 #define secondAccumulateTC    accumulateTC[1]
 930 #define firstHost    host[0]
 931 #define secondHost   host[1]
 932 #define reuseFirst   reuse[0]
 933 #define reuseSecond  reuse[1]
 934 #define firstIsUCI   isUCI[0]
 935 #define secondIsUCI  isUCI[1]
 936 #define firstNPS     NPS[0]
 937 #define secondNPS    NPS[1]
 938 #define firstLogo    logo[0]
 939 #define secondLogo   logo[1]
 940 #define fenOverride1 fenOverride[0]
 941 #define fenOverride2 fenOverride[1]
 942 #define firstOptions      engOptions[0]
 943 #define secondOptions     engOptions[1]
 944
 945 #endif