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