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