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