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 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 NOFALCON "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          "/usr/share/games/xboard/bitmaps.xchess" /* AP: shouldn't be hardcoded directory, but better than nothing at the moment */
 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 NUM_FONTS 7
 184
 185 /* Default to no flashing (the "usual" XBoard behavior) */
 186 #define FLASH_COUNT     0               /* Number of times to flash */
 187 #define FLASH_RATE      5               /* Flashes per second */
 188
 189 /* Default delay per character (in msec) while sending login script */
 190 #define MS_LOGIN_DELAY  0
 191
 192 /* [AS] Support for background textures */
 193 #define BACK_TEXTURE_MODE_DISABLED      0
 194 #define BACK_TEXTURE_MODE_PLAIN         1
 195 #define BACK_TEXTURE_MODE_FULL_RANDOM   2
 196
 197 /* Zippy defaults */
 198 #define ZIPPY_TALK FALSE
 199 #define ZIPPY_PLAY FALSE
 200 #define ZIPPY_LINES "yow.lines"
 201 #define ZIPPY_PINHEAD ""
 202 #define ZIPPY_PASSWORD ""
 203 #define ZIPPY_PASSWORD2 ""
 204 #define ZIPPY_WRONG_PASSWORD ""
 205 #define ZIPPY_ACCEPT_ONLY ""
 206 #define ZIPPY_USE_I TRUE
 207 #define ZIPPY_BUGHOUSE 0
 208 #define ZIPPY_NOPLAY_CRAFTY FALSE
 209 #define ZIPPY_GAME_END "gameend\n"
 210 #define ZIPPY_GAME_START ""
 211 #define ZIPPY_ADJOURN FALSE
 212 #define ZIPPY_ABORT FALSE
 213 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
 214 #define ZIPPY_MAX_GAMES 0
 215 #define ZIPPY_REPLAY_TIMEOUT 120
 216
 217 typedef enum {
 218     BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
 219     AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
 220     EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
 221     IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
 222     IcsExamining
 223   } GameMode;
 224
 225 typedef enum {
 226     /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
 227     /* only the first N pieces can go into the holdings, and   */
 228     /* promotions in those variants shift P-W to U-S           */
 229     WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
 230     WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
 231     WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
 232     WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteKing,
 233     BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
 234     BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
 235     BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
 236     BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackKing,
 237     EmptySquare,
 238     NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
 239     ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
 240   } ChessSquare;
 241
 242 /* [HGM] some macros that can be used as prefixes to convert piece types */
 243 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
 244 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
 245 #define PROMOTED       (int)WhiteDragon - (int)WhiteRook + (int)
 246 #define DEMOTED        (int)WhiteRook - (int)WhiteDragon + (int)
 247 #define SHOGI          (int)EmptySquare + (int)
 248
 249
 250 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
 251
 252 typedef enum {
 253     WhiteKingSideCastle = 1, WhiteQueenSideCastle,
 254     WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
 255     WhiteHSideCastleFR, WhiteASideCastleFR,
 256     BlackKingSideCastle, BlackQueenSideCastle,
 257     BlackKingSideCastleWild, BlackQueenSideCastleWild,
 258     BlackHSideCastleFR, BlackASideCastleFR,
 259     WhitePromotion, WhiteNonPromotion,
 260     BlackPromotion, BlackNonPromotion,
 261     WhiteCapturesEnPassant, BlackCapturesEnPassant,
 262     WhiteDrop, BlackDrop,
 263     NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
 264     WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
 265     GNUChessGame, XBoardGame, MoveNumberOne,
 266     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
 267   } ChessMove;
 268
 269 typedef enum {
 270     ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
 271     ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
 272     ColorNone, NColorClasses
 273 } ColorClass;
 274
 275 typedef enum {
 276     SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
 277     SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
 278 } SoundClass;
 279
 280 /* Names for chess variants, not necessarily supported */
 281 typedef enum {
 282     VariantNormal,       /* Normal chess */
 283     VariantLoadable,     /* "loadgame" command allowed (not really a variant)*/
 284     VariantWildCastle,   /* Shuffle chess where king can castle from d file */
 285     VariantNoCastle,     /* Shuffle chess with no castling at all */
 286     VariantFischeRandom, /* FischeRandom */
 287     VariantBughouse,     /* Bughouse, ICC/FICS rules */
 288     VariantCrazyhouse,   /* Crazyhouse, ICC/FICS rules */
 289     VariantLosers,       /* Try to lose all pieces or get mated (ICC wild 17)*/
 290     VariantSuicide,      /* Try to lose all pieces incl. king (FICS) */
 291     VariantGiveaway,     /* Try to have no legal moves left (ICC wild 26) */
 292     VariantTwoKings,     /* Weird ICC wild 9 */
 293     VariantKriegspiel,   /* Kriegspiel; pawns can capture invisible pieces */
 294     VariantAtomic,       /* Capturing piece explodes (ICC wild 27) */
 295     Variant3Check,       /* Win by giving check 3 times (ICC wild 25) */
 296     VariantShatranj,     /* Unsupported (ICC wild 28) */
 297     Variant29,           /* Temporary name for possible future ICC wild 29 */
 298     Variant30,           /* Temporary name for possible future ICC wild 30 */
 299     Variant31,           /* Temporary name for possible future ICC wild 31 */
 300     Variant32,           /* Temporary name for possible future ICC wild 32 */
 301     Variant33,           /* Temporary name for possible future ICC wild 33 */
 302     Variant34,           /* Temporary name for possible future ICC wild 34 */
 303     Variant35,           /* Temporary name for possible future ICC wild 35 */
 304     Variant36,           /* Temporary name for possible future ICC wild 36 */
 305     VariantShogi,        /* [HGM] added variants */
 306     VariantXiangqi,
 307     VariantCourier,
 308     VariantGothic,
 309     VariantCapablanca,
 310     VariantKnightmate,
 311     VariantFairy,
 312     VariantCylinder,
 313     VariantFalcon,
 314     VariantCapaRandom,
 315     VariantBerolina,
 316     VariantJanus,
 317     VariantSuper,
 318     VariantGreat,
 319     VariantTwilight,
 320     VariantMakruk,
 321     VariantUnknown       /* Catchall for other unknown variants */
 322 } VariantClass;
 323
 324 #define VARIANT_NAMES { \
 325   "normal", \
 326   "normal", \
 327   "wildcastle", \
 328   "nocastle", \
 329   "fischerandom", \
 330   "bughouse", \
 331   "crazyhouse", \
 332   "losers", \
 333   "suicide", \
 334   "giveaway", \
 335   "twokings", \
 336   "kriegspiel", \
 337   "atomic", \
 338   "3check", \
 339   "shatranj", \
 340   "wild29", \
 341   "wild30", \
 342   "wild31", \
 343   "wild32", \
 344   "wild33", \
 345   "wild34", \
 346   "wild35", \
 347   "wild36", \
 348   "shogi", \
 349   "xiangqi", \
 350   "courier", \
 351   "gothic", \
 352   "capablanca", \
 353   "knightmate", \
 354   "fairy", \
 355   "cylinder", \
 356   "falcon",\
 357   "caparandom",\
 358   "berolina",\
 359   "janus",\
 360   "super",\
 361   "great",\
 362   "twilight",\
 363   "makruk",\
 364   "unknown" \
 365 }
 366
 367 typedef struct {
 368     char *language;
 369 #if !defined(_amigados)
 370     char *whitePieceColor;
 371     char *blackPieceColor;
 372     char *lightSquareColor;
 373     char *darkSquareColor;
 374     char *jailSquareColor;
 375     char *highlightSquareColor;
 376     char *premoveHighlightColor;
 377 #else
 378     int whitePieceColor;
 379     int blackPieceColor;
 380     int lightSquareColor;
 381     int darkSquareColor;
 382     int jailSquareColor;
 383     int highlightSquareColor;
 384     int premoveHighlightColor;
 385 #endif
 386     int movesPerSession;
 387     int timeIncrement;
 388     char *initString;
 389     char *secondInitString;
 390     char *firstComputerString;
 391     char *secondComputerString;
 392     char *firstChessProgram;
 393     char *secondChessProgram;
 394     char *firstDirectory;
 395     char *secondDirectory;
 396     Boolean firstPlaysBlack;
 397     Boolean noChessProgram;
 398     char *firstHost;
 399     char *secondHost;
 400     char *bitmapDirectory;
 401     char *remoteShell;
 402     char *remoteUser;
 403     float timeDelay;
 404     char *timeControl;
 405     Boolean icsActive;
 406     char *icsHost;
 407     char *icsPort;
 408     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
 409     char *icsLogon;     /* Hack to permit variable logon scripts. */
 410     char *icsHelper;
 411     Boolean icsInputBox;
 412     Boolean useTelnet;
 413     Boolean seekGraph;
 414     Boolean autoRefresh;
 415     char *telnetProgram;
 416     char *gateway;
 417     char *loadGameFile;
 418     int loadGameIndex;      /* game # within file */
 419     char *saveGameFile;
 420     Boolean autoSaveGames;
 421     char *loadPositionFile;
 422     int loadPositionIndex;  /* position # within file */
 423     char *savePositionFile;
 424     Boolean matchMode;
 425     int matchGames;
 426     Boolean monoMode;
 427     Boolean debugMode;
 428     Boolean clockMode;
 429     char *boardSize;
 430     Boolean Iconic;
 431     char *searchTime;
 432     int searchDepth;
 433     Boolean showCoords;
 434     char *clockFont;
 435     char *messageFont; /* WinBoard only */
 436     char *coordFont;
 437     char *font; /* xboard only: all other fonts */
 438     char *tagsFont; /* WinBoard only */
 439     char *commentFont; /* WinBoard only */
 440     char *icsFont; /* WinBoard only */
 441     Boolean ringBellAfterMoves;
 442     Boolean autoCallFlag;
 443     Boolean flipView;
 444     Boolean autoFlipView;
 445     char *cmailGameName; /* xboard only */
 446     Boolean alwaysPromoteToQueen;
 447     Boolean oldSaveStyle;
 448     Boolean oneClick;
 449     Boolean quietPlay;
 450     Boolean showThinking;
 451     Boolean ponderNextMove;
 452     Boolean periodicUpdates;
 453     Boolean autoObserve;
 454     Boolean autoComment;
 455     Boolean getMoveList;
 456     Boolean testLegality;
 457     int borderXoffset; /* xboard only */
 458     int borderYoffset; /* xboard only */
 459     Boolean titleInWindow; /* xboard only */
 460     Boolean localLineEditing; /* WinBoard only */
 461     Boolean zippyTalk;
 462     Boolean zippyPlay;
 463     int flashCount; /* Number of times to flash (xboard only) */
 464     int flashRate; /* Flashes per second (xboard only)  */
 465     char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
 466     int msLoginDelay;  /* Delay per character (in msec) while sending
 467                           ICS logon script (xboard only) */
 468     Boolean colorize;   /* If True, use the following colors to color text */
 469     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
 470     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
 471     char *colorSShout;
 472     char *colorChannel1;
 473     char *colorChannel;
 474     char *colorKibitz;
 475     char *colorTell;
 476     char *colorChallenge;
 477     char *colorRequest;
 478     char *colorSeek;
 479     char *colorNormal;
 480     char *soundProgram; /* sound-playing program */
 481     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
 482     char *soundSShout;
 483     char *soundChannel1;
 484     char *soundChannel;
 485     char *soundKibitz;
 486     char *soundTell;
 487     char *soundChallenge;
 488     char *soundRequest;
 489     char *soundSeek;
 490     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
 491     char *soundBell;
 492     char *soundIcsAlarm;
 493     char *soundIcsWin;
 494     char *soundIcsLoss;
 495     char *soundIcsDraw;
 496     char *soundIcsUnfinished;
 497     Boolean reuseFirst;
 498     Boolean reuseSecond;
 499     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
 500     Boolean animate;    /* If True, animate non-mouse moves */
 501     int animSpeed;      /* Delay in milliseconds between animation frames */
 502     Boolean popupMoveErrors;
 503     Boolean popupExitMessage;
 504     int showJail;
 505     Boolean highlightLastMove;
 506     Boolean highlightDragging;
 507     Boolean blindfold;          /* if true, no pieces are drawn */
 508     Boolean premove;            /* true if premove feature enabled */
 509     Boolean premoveWhite;       /* true if premoving White first move  */
 510     char *premoveWhiteText;     /* text of White premove 1 */
 511     Boolean premoveBlack;       /* true if premoving Black first move */
 512     char *premoveBlackText;     /* text of Black premove 1 */
 513     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
 514     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
 515     Boolean autoRaiseBoard;
 516     int fontSizeTolerance; /* xboard only */
 517     char *initialMode;
 518     char *variant;
 519     char *chatBoxes;
 520     int firstProtocolVersion;
 521     int secondProtocolVersion;
 522     Boolean showButtonBar;
 523     Boolean icsEngineAnalyze;
 524
 525     /* [AS] New properties (down to the "ZIPPY" part) */
 526     Boolean firstScoreIsAbsolute;  /* If true, engine score is always from white side */
 527     Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
 528     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
 529     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
 530     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
 531     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
 532     int liteBackTextureMode;
 533     int darkBackTextureMode;
 534     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
 535     char * fontToPieceTable; /* Map to translate font character to chess pieces */
 536     int fontBackColorWhite;
 537     int fontForeColorWhite;
 538     int fontBackColorBlack;
 539     int fontForeColorBlack;
 540     int fontPieceSize; /* Size of font relative to square (percentage) */
 541     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
 542     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
 543     int delayBeforeQuit;
 544     int delayAfterQuit;
 545     char * nameOfDebugFile;
 546     char * pgnEventHeader;
 547     int defaultFrcPosition;
 548     char * gameListTags;
 549     Boolean saveOutOfBookInfo;
 550     Boolean showEvalInMoveHistory;
 551     int evalHistColorWhite;
 552     int evalHistColorBlack;
 553     Boolean highlightMoveWithArrow;
 554     int highlightArrowColor;
 555     Boolean useStickyWindows;
 556     Boolean bgObserve;   /* [HGM] bughouse */
 557     Boolean dualBoard;   /* [HGM] dual     */
 558     int adjudicateDrawMoves;
 559     Boolean autoDisplayComment;
 560     Boolean autoDisplayTags;
 561     Boolean firstIsUCI;
 562     Boolean secondIsUCI;
 563     Boolean firstHasOwnBookUCI;
 564     Boolean secondHasOwnBookUCI;
 565     char * adapterCommand;
 566     char * polyglotDir;
 567     Boolean usePolyglotBook;
 568     char * polyglotBook;
 569     int bookDepth;
 570     int bookStrength;
 571     int defaultHashSize;
 572     int defaultCacheSizeEGTB;
 573     char * defaultPathEGTB;
 574     int defaultMatchGames;
 575
 576     /* [HGM] Board size */
 577     int NrFiles;
 578     int NrRanks;
 579     int holdingsSize;
 580     int matchPause;
 581     char * pieceToCharTable;
 582     char * pieceNickNames;
 583     char * colorNickNames;
 584     Boolean allWhite;
 585     Boolean upsideDown;
 586     Boolean alphaRank;
 587     Boolean testClaims;
 588     Boolean checkMates;
 589     Boolean materialDraws;
 590     Boolean trivialDraws;
 591     int ruleMoves;
 592     int drawRepeats;
 593
 594 #if ZIPPY
 595     char *zippyLines;
 596     char *zippyPinhead;
 597     char *zippyPassword;
 598     char *zippyPassword2;
 599     char *zippyWrongPassword;
 600     char *zippyAcceptOnly;
 601     int zippyUseI;
 602     int zippyBughouse;
 603     int zippyNoplayCrafty;
 604     char *zippyGameEnd;
 605     char *zippyGameStart;
 606     int zippyAdjourn;
 607     int zippyAbort;
 608     char *zippyVariants;
 609     int zippyMaxGames;
 610     int zippyReplayTimeout; /*seconds*/
 611     int zippyShortGame; /* [HGM] aborter   */
 612 #endif
 613     Boolean lowTimeWarning; /* [HGM] low time */
 614     char *lowTimeWarningColor;
 615
 616     char *serverMovesName;
 617     Boolean suppressLoadMoves;
 618     int serverPause;
 619     int firstTimeOdds;
 620     int secondTimeOdds;
 621     int timeOddsMode;
 622     int firstAccumulateTC;
 623     int secondAccumulateTC;
 624     int firstNPS;
 625     int secondNPS;
 626     Boolean autoKibitz;
 627     int engineComments;
 628     char *userName;
 629     int rewindIndex;    /* [HGM] autoinc   */
 630     int sameColorGames; /* [HGM] alternate */
 631     int smpCores;       /* [HGM] SMP       */
 632     char *egtFormats;
 633     int niceEngines;    /* [HGM] nice      */
 634     char *firstLogo;    /* [HGM] logo      */
 635     char *secondLogo;
 636     Boolean autoLogo;
 637     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
 638     char *firstOptions; /* [HGM] options   */
 639     char *secondOptions;
 640     char *fenOverride1;
 641     char *fenOverride2;
 642     Boolean keepAlive;  /* [HGM] alive     */
 643     Boolean forceIllegal;/*[HGM] illegal   */
 644     Boolean noJoin;     /* [HGM] join      */
 645     char *wrapContSeq; /* continuation sequence when xboard wraps text */
 646     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
 647     Boolean pasteSelection; /* paste X selection instead of clipboard */
 648     int nrVariations;   /* [HGM] multivar  */
 649     Boolean dropMenu;   /* [HGM] pv        */
 650     Boolean markers;    /* [HGM] markers   */
 651 } AppData, *AppDataPtr;
 652
 653 /* [AS] PGN tags (for showing in the game list) */
 654 #define GLT_EVENT           'e'
 655 #define GLT_SITE            's'
 656 #define GLT_DATE            'd'
 657 #define GLT_ROUND           'o'
 658 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
 659 #define GLT_RESULT          'r'
 660 #define GLT_WHITE_ELO       'w'
 661 #define GLT_BLACK_ELO       'b'
 662 #define GLT_TIME_CONTROL    't'
 663 #define GLT_VARIANT         'v'
 664 #define GLT_OUT_OF_BOOK     'a'
 665 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
 666
 667 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
 668
 669 #define GLT_ALL_TAGS        "esdoprwbtvac"
 670
 671 #define PGN_OUT_OF_BOOK     "Annotator"
 672
 673 extern AppData appData;
 674
 675 typedef struct {
 676     /* PGN 7-tag info */
 677     char *event;
 678     char *site;
 679     char *date;
 680     char *round;
 681     char *white;
 682     char *black;
 683     ChessMove result;
 684     /* Additional info */
 685     char *fen;          /* NULL or FEN for starting position; input only */
 686     char *resultDetails;
 687     char *timeControl;
 688     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
 689     int whiteRating;    /* -1 if unknown */
 690     int blackRating;    /* -1 if unknown */
 691     VariantClass variant;
 692     char *outOfBook;    /* [AS] Move and score when engine went out of book */
 693     int boardWidth;     /* [HGM] adjustable board size */
 694     int boardHeight;
 695 /* [HGM] For Shogi and Crazyhouse: */
 696     int holdingsSize;  /* number of different piece types in holdings       */
 697     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
 698 } GameInfo;
 699
 700 /* [AS] Search stats from chessprogram, for the played move */
 701 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
 702 typedef struct {
 703     int score;  /* Centipawns */
 704     int depth;  /* Plies */
 705     int time;   /* Milliseconds */
 706 } ChessProgramStats_Move;
 707
 708 /* [AS] Layout management */
 709 typedef struct {
 710     Boolean visible;
 711     int x;
 712     int y;
 713     int width;
 714     int height;
 715 } WindowPlacement;
 716
 717 extern WindowPlacement wpEngineOutput;
 718 extern WindowPlacement wpEvalGraph;
 719 extern WindowPlacement wpMoveHistory;
 720 extern WindowPlacement wpGameList;
 721 extern WindowPlacement wpTags;
 722
 723 // [HGM] chat
 724 #define MAX_CHAT 5
 725 extern int chatCount;
 726 extern char chatPartner[MAX_CHAT][MSG_SIZ];
 727
 728
 729 #endif
 730