common.h

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