common.h

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