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