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