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