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