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