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