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