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