2 * common.h -- Common definitions for X and Windows NT versions of XBoard
4 * Copyright 1991 by Digital Equipment Corporation, Maynard,
7 * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
8 * 2007, 2008, 2009 Free Software Foundation, Inc.
10 * Enhancements Copyright 2005 Alessandro Scotti
12 * The following terms apply to Digital Equipment Corporation's copyright
14 * ------------------------------------------------------------------------
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.
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
32 * ------------------------------------------------------------------------
34 * The following terms apply to the enhanced version of XBoard
35 * distributed by the Free Software Foundation:
36 * ------------------------------------------------------------------------
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.
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.
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/. *
51 *------------------------------------------------------------------------
52 ** See the file ChangeLog for a revision history. */
58 /* Begin compatibility grunge */
60 #if defined(__STDC__) || defined(WIN32) || defined(_amigados)
62 typedef void *VOIDSTAR;
65 typedef char *VOIDSTAR;
72 #define pclose _pclose
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. */
79 FILE *popen(const char *, const char *);
84 #include <X11/Intrinsic.h>
94 #define UNKNOWN -1 /* [HGM] nps */
98 # define srandom srand48
99 # define random lrand48
100 # else /* not HAVE_RAND48 */
101 # define srandom srand
103 # endif /* not HAVE_RAND48 */
104 #endif /* !HAVE_RANDOM */
106 /* End compatibility grunge */
108 #define PROTOVER 2 /* engine protocol version */
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"
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'.
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 */
140 #define MAX_MOVES 1000
142 #define DIALOG_SIZE 256
143 #define STAR_MATCH_N 16
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*/
176 /* Default to no flashing (the "usual" XBoard behavior) */
177 #define FLASH_COUNT 0 /* Number of times to flash */
178 #define FLASH_RATE 5 /* Flashes per second */
180 /* Default delay per character (in msec) while sending login script */
181 #define MS_LOGIN_DELAY 0
184 #define ZIPPY_TALK FALSE
185 #define ZIPPY_PLAY FALSE
186 #define ZIPPY_LINES "yow.lines"
187 #define ZIPPY_PINHEAD ""
188 #define ZIPPY_PASSWORD ""
189 #define ZIPPY_PASSWORD2 ""
190 #define ZIPPY_WRONG_PASSWORD ""
191 #define ZIPPY_ACCEPT_ONLY ""
192 #define ZIPPY_USE_I TRUE
193 #define ZIPPY_BUGHOUSE 0
194 #define ZIPPY_NOPLAY_CRAFTY FALSE
195 #define ZIPPY_GAME_END "gameend\n"
196 #define ZIPPY_GAME_START ""
197 #define ZIPPY_ADJOURN FALSE
198 #define ZIPPY_ABORT FALSE
199 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
200 #define ZIPPY_MAX_GAMES 0
201 #define ZIPPY_REPLAY_TIMEOUT 120
204 BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
205 AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
206 EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
207 IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
212 /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
213 /* only the first N pieces can go into the holdings, and */
214 /* promotions in those variants shift P-W to U-S */
215 WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
216 WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
217 WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
218 WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteKing,
219 BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
220 BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
221 BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
222 BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackKing,
224 NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
225 ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
228 /* [HGM] some macros that can be used as prefixes to convert piece types */
229 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
230 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
231 #define PROMOTED (int)WhiteDragon - (int)WhiteRook + (int)
232 #define DEMOTED (int)WhiteRook - (int)WhiteDragon + (int)
233 #define SHOGI (int)EmptySquare + (int)
236 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
239 WhiteKingSideCastle = 1, WhiteQueenSideCastle,
240 WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
241 WhiteHSideCastleFR, WhiteASideCastleFR,
242 BlackKingSideCastle, BlackQueenSideCastle,
243 BlackKingSideCastleWild, BlackQueenSideCastleWild,
244 BlackHSideCastleFR, BlackASideCastleFR,
245 WhitePromotionKnight, WhitePromotionBishop,
246 WhitePromotionRook, WhitePromotionQueen, WhitePromotionKing,
247 WhitePromotionChancellor, WhitePromotionArchbishop, WhitePromotionCentaur,
248 BlackPromotionKnight, BlackPromotionBishop,
249 BlackPromotionRook, BlackPromotionQueen, BlackPromotionKing,
250 BlackPromotionChancellor, BlackPromotionArchbishop, BlackPromotionCentaur,
251 WhiteCapturesEnPassant, BlackCapturesEnPassant,
252 WhiteDrop, BlackDrop,
253 NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
254 WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
255 GNUChessGame, XBoardGame, MoveNumberOne,
256 Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
260 ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
261 ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
262 ColorNone, NColorClasses
266 SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
267 SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
270 /* Names for chess variants, not necessarily supported */
272 VariantNormal, /* Normal chess */
273 VariantLoadable, /* "loadgame" command allowed (not really a variant)*/
274 VariantWildCastle, /* Shuffle chess where king can castle from d file */
275 VariantNoCastle, /* Shuffle chess with no castling at all */
276 VariantFischeRandom, /* FischeRandom */
277 VariantBughouse, /* Bughouse, ICC/FICS rules */
278 VariantCrazyhouse, /* Crazyhouse, ICC/FICS rules */
279 VariantLosers, /* Try to lose all pieces or get mated (ICC wild 17)*/
280 VariantSuicide, /* Try to lose all pieces incl. king (FICS) */
281 VariantGiveaway, /* Try to have no legal moves left (ICC wild 26) */
282 VariantTwoKings, /* Weird ICC wild 9 */
283 VariantKriegspiel, /* Kriegspiel; pawns can capture invisible pieces */
284 VariantAtomic, /* Capturing piece explodes (ICC wild 27) */
285 Variant3Check, /* Win by giving check 3 times (ICC wild 25) */
286 VariantShatranj, /* Unsupported (ICC wild 28) */
287 Variant29, /* Temporary name for possible future ICC wild 29 */
288 Variant30, /* Temporary name for possible future ICC wild 30 */
289 Variant31, /* Temporary name for possible future ICC wild 31 */
290 Variant32, /* Temporary name for possible future ICC wild 32 */
291 Variant33, /* Temporary name for possible future ICC wild 33 */
292 Variant34, /* Temporary name for possible future ICC wild 34 */
293 Variant35, /* Temporary name for possible future ICC wild 35 */
294 Variant36, /* Temporary name for possible future ICC wild 36 */
295 VariantShogi, /* [HGM] added variants */
310 VariantUnknown /* Catchall for other unknown variants */
313 #define VARIANT_NAMES { \
356 #if !defined(_amigados)
357 char *whitePieceColor;
358 char *blackPieceColor;
359 char *lightSquareColor;
360 char *darkSquareColor;
361 char *jailSquareColor;
362 char *highlightSquareColor;
363 char *premoveHighlightColor;
367 int lightSquareColor;
370 int highlightSquareColor;
371 int premoveHighlightColor;
376 char *secondInitString;
377 char *firstComputerString;
378 char *secondComputerString;
379 char *firstChessProgram;
380 char *secondChessProgram;
381 char *firstDirectory;
382 char *secondDirectory;
383 Boolean firstPlaysBlack;
384 Boolean noChessProgram;
387 char *bitmapDirectory;
395 char *icsCommPort; /* if set, use serial port instead of tcp host/port */
396 char *icsLogon; /* Hack to permit variable logon scripts. */
403 int loadGameIndex; /* game # within file */
405 Boolean autoSaveGames;
406 char *loadPositionFile;
407 int loadPositionIndex; /* position # within file */
408 char *savePositionFile;
420 char *messageFont; /* WinBoard only */
422 char *font; /* xboard only: all other fonts */
423 char *tagsFont; /* WinBoard only */
424 char *commentFont; /* WinBoard only */
425 char *icsFont; /* WinBoard only */
426 Boolean ringBellAfterMoves;
427 Boolean autoCallFlag;
429 Boolean autoFlipView;
430 char *cmailGameName; /* xboard only */
431 Boolean alwaysPromoteToQueen;
432 Boolean oldSaveStyle;
434 Boolean showThinking;
435 Boolean ponderNextMove;
436 Boolean periodicUpdates;
440 Boolean testLegality;
441 int borderXoffset; /* xboard only */
442 int borderYoffset; /* xboard only */
443 Boolean titleInWindow; /* xboard only */
444 Boolean localLineEditing; /* WinBoard only */
447 int flashCount; /* Number of times to flash (xboard only) */
448 int flashRate; /* Flashes per second (xboard only) */
449 char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
450 int msLoginDelay; /* Delay per character (in msec) while sending
451 ICS logon script (xboard only) */
452 Boolean colorize; /* If True, use the following colors to color text */
453 /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
454 char *colorShout; // [HGM] IMPORTANT: order must conform to ColorClass definition
460 char *colorChallenge;
464 char *soundProgram; /* sound-playing program */
465 char *soundShout; // [HGM] IMPORTANT: order must be as in ColorClass
471 char *soundChallenge;
474 char *soundMove; // [HGM] IMPORTANT: order must be as in SoundClass
480 char *soundIcsUnfinished;
483 Boolean animateDragging; /* If True, animate mouse dragging of pieces */
484 Boolean animate; /* If True, animate non-mouse moves */
485 int animSpeed; /* Delay in milliseconds between animation frames */
486 Boolean popupMoveErrors;
487 Boolean popupExitMessage;
489 Boolean highlightLastMove;
490 Boolean highlightDragging;
491 Boolean blindfold; /* if true, no pieces are drawn */
492 Boolean premove; /* true if premove feature enabled */
493 Boolean premoveWhite; /* true if premoving White first move */
494 char *premoveWhiteText; /* text of White premove 1 */
495 Boolean premoveBlack; /* true if premoving Black first move */
496 char *premoveBlackText; /* text of Black premove 1 */
497 Boolean icsAlarm; /* true if sounding alarm at a certain time */
498 int icsAlarmTime; /* time to sound alarm, in milliseconds */
499 Boolean autoRaiseBoard;
500 int fontSizeTolerance; /* xboard only */
503 int firstProtocolVersion;
504 int secondProtocolVersion;
505 Boolean showButtonBar;
506 Boolean icsEngineAnalyze;
508 /* [AS] New properties (down to the "ZIPPY" part) */
509 Boolean firstScoreIsAbsolute; /* If true, engine score is always from white side */
510 Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
511 Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
512 Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
513 char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
514 char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
515 int liteBackTextureMode;
516 int darkBackTextureMode;
517 char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
518 char * fontToPieceTable; /* Map to translate font character to chess pieces */
519 int fontBackColorWhite;
520 int fontForeColorWhite;
521 int fontBackColorBlack;
522 int fontForeColorBlack;
523 int fontPieceSize; /* Size of font relative to square (percentage) */
524 int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
525 int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
528 char * nameOfDebugFile;
529 char * pgnEventHeader;
530 int defaultFrcPosition;
532 Boolean saveOutOfBookInfo;
533 Boolean showEvalInMoveHistory;
534 int evalHistColorWhite;
535 int evalHistColorBlack;
536 Boolean highlightMoveWithArrow;
537 int highlightArrowColor;
538 Boolean useStickyWindows;
539 int adjudicateDrawMoves;
540 Boolean autoDisplayComment;
541 Boolean autoDisplayTags;
544 Boolean firstHasOwnBookUCI;
545 Boolean secondHasOwnBookUCI;
547 Boolean usePolyglotBook;
550 int defaultCacheSizeEGTB;
551 char * defaultPathEGTB;
553 /* [HGM] Board size */
558 char * pieceToCharTable;
564 Boolean materialDraws;
565 Boolean trivialDraws;
573 char *zippyPassword2;
574 char *zippyWrongPassword;
575 char *zippyAcceptOnly;
578 int zippyNoplayCrafty;
580 char *zippyGameStart;
585 int zippyReplayTimeout; /*seconds*/
586 int zippyShortGame; /* [HGM] aborter */
588 Boolean lowTimeWarning; /* [HGM] low time */
589 char *lowTimeWarningColor;
591 char *serverMovesName;
592 Boolean suppressLoadMoves;
597 int firstAccumulateTC;
598 int secondAccumulateTC;
604 int rewindIndex; /* [HGM] autoinc */
605 int sameColorGames; /* [HGM] alternate */
606 int smpCores; /* [HGM] SMP */
608 int niceEngines; /* [HGM] nice */
609 char *firstLogo; /* [HGM] logo */
612 Boolean noGUI; /* [HGM] fast: suppress all display updates */
613 char *firstOptions; /* [HGM] options */
617 Boolean keepAlive; /* [HGM] alive */
618 Boolean forceIllegal;/*[HGM] illegal */
619 Boolean noJoin; /* [HGM] join */
620 char *wrapContSeq; /* continuation sequence when xboard wraps text */
621 Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
622 Boolean pasteSelection; /* paste X selection instead of clipboard */
623 int nrVariations; /* [HGM] multivar */
624 } AppData, *AppDataPtr;
626 /* [AS] PGN tags (for showing in the game list) */
627 #define GLT_EVENT 'e'
630 #define GLT_ROUND 'o'
631 #define GLT_PLAYERS 'p' /* I.e. white "-" black */
632 #define GLT_RESULT 'r'
633 #define GLT_WHITE_ELO 'w'
634 #define GLT_BLACK_ELO 'b'
635 #define GLT_TIME_CONTROL 't'
636 #define GLT_VARIANT 'v'
637 #define GLT_OUT_OF_BOOK 'a'
638 #define GLT_RESULT_COMMENT 'c' /* [HGM] rescom */
640 #define GLT_DEFAULT_TAGS "eprd" /* Event, players, result, date */
642 #define GLT_ALL_TAGS "esdoprwbtvac"
644 #define PGN_OUT_OF_BOOK "Annotator"
646 extern AppData appData;
657 /* Additional info */
658 char *fen; /* NULL or FEN for starting position; input only */
661 char *extraTags; /* NULL or "[Tag \"Value\"]\n", etc. */
662 int whiteRating; /* -1 if unknown */
663 int blackRating; /* -1 if unknown */
664 VariantClass variant;
665 char *outOfBook; /* [AS] Move and score when engine went out of book */
666 int boardWidth; /* [HGM] adjustable board size */
668 /* [HGM] For Shogi and Crazyhouse: */
669 int holdingsSize; /* number of different piece types in holdings */
670 int holdingsWidth; /* number of files left and right of board, 0 or 2 */
673 /* [AS] Search stats from chessprogram, for the played move */
674 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
676 int score; /* Centipawns */
677 int depth; /* Plies */
678 int time; /* Milliseconds */
679 } ChessProgramStats_Move;
683 extern int chatCount;
684 extern char chatPartner[MAX_CHAT][MSG_SIZ];