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