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, 2010 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*/
177 #define MESSAGE_FONT 1
179 #define CONSOLE_FONT 3
180 #define COMMENT_FONT 4
181 #define EDITTAGS_FONT 5
182 #define MOVEHISTORY_FONT 6
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 */
189 /* Default delay per character (in msec) while sending login script */
190 #define MS_LOGIN_DELAY 0
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
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
218 BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
219 AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
220 EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
221 IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
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,
238 NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
239 ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
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)
250 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
253 WhiteKingSideCastle = 1, WhiteQueenSideCastle,
254 WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
255 WhiteHSideCastleFR, WhiteASideCastleFR,
256 BlackKingSideCastle, BlackQueenSideCastle,
257 BlackKingSideCastleWild, BlackQueenSideCastleWild,
258 BlackHSideCastleFR, BlackASideCastleFR,
259 WhitePromotionKnight, WhitePromotionBishop,
260 WhitePromotionRook, WhitePromotionQueen, WhitePromotionKing, WhiteNonPromotion,
261 WhitePromotionChancellor, WhitePromotionArchbishop, WhitePromotionCentaur,
262 BlackPromotionKnight, BlackPromotionBishop,
263 BlackPromotionRook, BlackPromotionQueen, BlackPromotionKing, BlackNonPromotion,
264 BlackPromotionChancellor, BlackPromotionArchbishop, BlackPromotionCentaur,
265 WhiteCapturesEnPassant, BlackCapturesEnPassant,
266 WhiteDrop, BlackDrop,
267 NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
268 WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
269 GNUChessGame, XBoardGame, MoveNumberOne,
270 Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
274 ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
275 ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
276 ColorNone, NColorClasses
280 SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
281 SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
284 /* Names for chess variants, not necessarily supported */
286 VariantNormal, /* Normal chess */
287 VariantLoadable, /* "loadgame" command allowed (not really a variant)*/
288 VariantWildCastle, /* Shuffle chess where king can castle from d file */
289 VariantNoCastle, /* Shuffle chess with no castling at all */
290 VariantFischeRandom, /* FischeRandom */
291 VariantBughouse, /* Bughouse, ICC/FICS rules */
292 VariantCrazyhouse, /* Crazyhouse, ICC/FICS rules */
293 VariantLosers, /* Try to lose all pieces or get mated (ICC wild 17)*/
294 VariantSuicide, /* Try to lose all pieces incl. king (FICS) */
295 VariantGiveaway, /* Try to have no legal moves left (ICC wild 26) */
296 VariantTwoKings, /* Weird ICC wild 9 */
297 VariantKriegspiel, /* Kriegspiel; pawns can capture invisible pieces */
298 VariantAtomic, /* Capturing piece explodes (ICC wild 27) */
299 Variant3Check, /* Win by giving check 3 times (ICC wild 25) */
300 VariantShatranj, /* Unsupported (ICC wild 28) */
301 Variant29, /* Temporary name for possible future ICC wild 29 */
302 Variant30, /* Temporary name for possible future ICC wild 30 */
303 Variant31, /* Temporary name for possible future ICC wild 31 */
304 Variant32, /* Temporary name for possible future ICC wild 32 */
305 Variant33, /* Temporary name for possible future ICC wild 33 */
306 Variant34, /* Temporary name for possible future ICC wild 34 */
307 Variant35, /* Temporary name for possible future ICC wild 35 */
308 Variant36, /* Temporary name for possible future ICC wild 36 */
309 VariantShogi, /* [HGM] added variants */
325 VariantUnknown /* Catchall for other unknown variants */
328 #define VARIANT_NAMES { \
373 #if !defined(_amigados)
374 char *whitePieceColor;
375 char *blackPieceColor;
376 char *lightSquareColor;
377 char *darkSquareColor;
378 char *jailSquareColor;
379 char *highlightSquareColor;
380 char *premoveHighlightColor;
384 int lightSquareColor;
387 int highlightSquareColor;
388 int premoveHighlightColor;
393 char *secondInitString;
394 char *firstComputerString;
395 char *secondComputerString;
396 char *firstChessProgram;
397 char *secondChessProgram;
398 char *firstDirectory;
399 char *secondDirectory;
400 Boolean firstPlaysBlack;
401 Boolean noChessProgram;
404 char *bitmapDirectory;
412 char *icsCommPort; /* if set, use serial port instead of tcp host/port */
413 char *icsLogon; /* Hack to permit variable logon scripts. */
422 int loadGameIndex; /* game # within file */
424 Boolean autoSaveGames;
425 char *loadPositionFile;
426 int loadPositionIndex; /* position # within file */
427 char *savePositionFile;
439 char *messageFont; /* WinBoard only */
441 char *font; /* xboard only: all other fonts */
442 char *tagsFont; /* WinBoard only */
443 char *commentFont; /* WinBoard only */
444 char *icsFont; /* WinBoard only */
445 Boolean ringBellAfterMoves;
446 Boolean autoCallFlag;
448 Boolean autoFlipView;
449 char *cmailGameName; /* xboard only */
450 Boolean alwaysPromoteToQueen;
451 Boolean oldSaveStyle;
454 Boolean showThinking;
455 Boolean ponderNextMove;
456 Boolean periodicUpdates;
460 Boolean testLegality;
461 int borderXoffset; /* xboard only */
462 int borderYoffset; /* xboard only */
463 Boolean titleInWindow; /* xboard only */
464 Boolean localLineEditing; /* WinBoard only */
467 int flashCount; /* Number of times to flash (xboard only) */
468 int flashRate; /* Flashes per second (xboard only) */
469 char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
470 int msLoginDelay; /* Delay per character (in msec) while sending
471 ICS logon script (xboard only) */
472 Boolean colorize; /* If True, use the following colors to color text */
473 /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
474 char *colorShout; // [HGM] IMPORTANT: order must conform to ColorClass definition
480 char *colorChallenge;
484 char *soundProgram; /* sound-playing program */
485 char *soundShout; // [HGM] IMPORTANT: order must be as in ColorClass
491 char *soundChallenge;
494 char *soundMove; // [HGM] IMPORTANT: order must be as in SoundClass
500 char *soundIcsUnfinished;
503 Boolean animateDragging; /* If True, animate mouse dragging of pieces */
504 Boolean animate; /* If True, animate non-mouse moves */
505 int animSpeed; /* Delay in milliseconds between animation frames */
506 Boolean popupMoveErrors;
507 Boolean popupExitMessage;
509 Boolean highlightLastMove;
510 Boolean highlightDragging;
511 Boolean blindfold; /* if true, no pieces are drawn */
512 Boolean premove; /* true if premove feature enabled */
513 Boolean premoveWhite; /* true if premoving White first move */
514 char *premoveWhiteText; /* text of White premove 1 */
515 Boolean premoveBlack; /* true if premoving Black first move */
516 char *premoveBlackText; /* text of Black premove 1 */
517 Boolean icsAlarm; /* true if sounding alarm at a certain time */
518 int icsAlarmTime; /* time to sound alarm, in milliseconds */
519 Boolean autoRaiseBoard;
520 int fontSizeTolerance; /* xboard only */
524 int firstProtocolVersion;
525 int secondProtocolVersion;
526 Boolean showButtonBar;
527 Boolean icsEngineAnalyze;
529 /* [AS] New properties (down to the "ZIPPY" part) */
530 Boolean firstScoreIsAbsolute; /* If true, engine score is always from white side */
531 Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
532 Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
533 Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
534 char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
535 char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
536 int liteBackTextureMode;
537 int darkBackTextureMode;
538 char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
539 char * fontToPieceTable; /* Map to translate font character to chess pieces */
540 int fontBackColorWhite;
541 int fontForeColorWhite;
542 int fontBackColorBlack;
543 int fontForeColorBlack;
544 int fontPieceSize; /* Size of font relative to square (percentage) */
545 int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
546 int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
549 char * nameOfDebugFile;
550 char * pgnEventHeader;
551 int defaultFrcPosition;
553 Boolean saveOutOfBookInfo;
554 Boolean showEvalInMoveHistory;
555 int evalHistColorWhite;
556 int evalHistColorBlack;
557 Boolean highlightMoveWithArrow;
558 int highlightArrowColor;
559 Boolean useStickyWindows;
560 Boolean bgObserve; /* [HGM] bughouse */
561 Boolean dualBoard; /* [HGM] dual */
562 int adjudicateDrawMoves;
563 Boolean autoDisplayComment;
564 Boolean autoDisplayTags;
567 Boolean firstHasOwnBookUCI;
568 Boolean secondHasOwnBookUCI;
569 char * adapterCommand;
571 Boolean usePolyglotBook;
576 int defaultCacheSizeEGTB;
577 char * defaultPathEGTB;
578 int defaultMatchGames;
580 /* [HGM] Board size */
585 char * pieceToCharTable;
586 char * pieceNickNames;
587 char * colorNickNames;
593 Boolean materialDraws;
594 Boolean trivialDraws;
602 char *zippyPassword2;
603 char *zippyWrongPassword;
604 char *zippyAcceptOnly;
607 int zippyNoplayCrafty;
609 char *zippyGameStart;
614 int zippyReplayTimeout; /*seconds*/
615 int zippyShortGame; /* [HGM] aborter */
617 Boolean lowTimeWarning; /* [HGM] low time */
618 char *lowTimeWarningColor;
620 char *serverMovesName;
621 Boolean suppressLoadMoves;
626 int firstAccumulateTC;
627 int secondAccumulateTC;
633 int rewindIndex; /* [HGM] autoinc */
634 int sameColorGames; /* [HGM] alternate */
635 int smpCores; /* [HGM] SMP */
637 int niceEngines; /* [HGM] nice */
638 char *firstLogo; /* [HGM] logo */
641 Boolean noGUI; /* [HGM] fast: suppress all display updates */
642 char *firstOptions; /* [HGM] options */
646 Boolean keepAlive; /* [HGM] alive */
647 Boolean forceIllegal;/*[HGM] illegal */
648 Boolean noJoin; /* [HGM] join */
649 char *wrapContSeq; /* continuation sequence when xboard wraps text */
650 Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
651 Boolean pasteSelection; /* paste X selection instead of clipboard */
652 int nrVariations; /* [HGM] multivar */
653 Boolean dropMenu; /* [HGM] pv */
654 Boolean markers; /* [HGM] markers */
655 } AppData, *AppDataPtr;
657 /* [AS] PGN tags (for showing in the game list) */
658 #define GLT_EVENT 'e'
661 #define GLT_ROUND 'o'
662 #define GLT_PLAYERS 'p' /* I.e. white "-" black */
663 #define GLT_RESULT 'r'
664 #define GLT_WHITE_ELO 'w'
665 #define GLT_BLACK_ELO 'b'
666 #define GLT_TIME_CONTROL 't'
667 #define GLT_VARIANT 'v'
668 #define GLT_OUT_OF_BOOK 'a'
669 #define GLT_RESULT_COMMENT 'c' /* [HGM] rescom */
671 #define GLT_DEFAULT_TAGS "eprd" /* Event, players, result, date */
673 #define GLT_ALL_TAGS "esdoprwbtvac"
675 #define PGN_OUT_OF_BOOK "Annotator"
677 extern AppData appData;
688 /* Additional info */
689 char *fen; /* NULL or FEN for starting position; input only */
692 char *extraTags; /* NULL or "[Tag \"Value\"]\n", etc. */
693 int whiteRating; /* -1 if unknown */
694 int blackRating; /* -1 if unknown */
695 VariantClass variant;
696 char *outOfBook; /* [AS] Move and score when engine went out of book */
697 int boardWidth; /* [HGM] adjustable board size */
699 /* [HGM] For Shogi and Crazyhouse: */
700 int holdingsSize; /* number of different piece types in holdings */
701 int holdingsWidth; /* number of files left and right of board, 0 or 2 */
704 /* [AS] Search stats from chessprogram, for the played move */
705 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
707 int score; /* Centipawns */
708 int depth; /* Plies */
709 int time; /* Milliseconds */
710 } ChessProgramStats_Move;
712 /* [AS] Layout management */
721 extern WindowPlacement wpEngineOutput;
722 extern WindowPlacement wpEvalGraph;
723 extern WindowPlacement wpMoveHistory;
724 extern WindowPlacement wpGameList;
725 extern WindowPlacement wpTags;
729 extern int chatCount;
730 extern char chatPartner[MAX_CHAT][MSG_SIZ];