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