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