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