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];
254 WhiteKingSideCastle, WhiteQueenSideCastle,
255 WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
256 WhiteHSideCastleFR, WhiteASideCastleFR,
257 BlackKingSideCastle, BlackQueenSideCastle,
258 BlackKingSideCastleWild, BlackQueenSideCastleWild,
259 BlackHSideCastleFR, BlackASideCastleFR,
260 WhitePromotion, WhiteNonPromotion,
261 BlackPromotion, BlackNonPromotion,
262 WhiteCapturesEnPassant, BlackCapturesEnPassant,
263 WhiteDrop, BlackDrop,
264 NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
265 WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
266 GNUChessGame, XBoardGame, MoveNumberOne,
267 Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
271 ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
272 ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
273 ColorNone, NColorClasses
277 SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
278 SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
281 /* Names for chess variants, not necessarily supported */
283 VariantNormal, /* Normal chess */
284 VariantLoadable, /* "loadgame" command allowed (not really a variant)*/
285 VariantWildCastle, /* Shuffle chess where king can castle from d file */
286 VariantNoCastle, /* Shuffle chess with no castling at all */
287 VariantFischeRandom, /* FischeRandom */
288 VariantBughouse, /* Bughouse, ICC/FICS rules */
289 VariantCrazyhouse, /* Crazyhouse, ICC/FICS rules */
290 VariantLosers, /* Try to lose all pieces or get mated (ICC wild 17)*/
291 VariantSuicide, /* Try to lose all pieces incl. king (FICS) */
292 VariantGiveaway, /* Try to have no legal moves left (ICC wild 26) */
293 VariantTwoKings, /* Weird ICC wild 9 */
294 VariantKriegspiel, /* Kriegspiel; pawns can capture invisible pieces */
295 VariantAtomic, /* Capturing piece explodes (ICC wild 27) */
296 Variant3Check, /* Win by giving check 3 times (ICC wild 25) */
297 VariantShatranj, /* Unsupported (ICC wild 28) */
298 Variant29, /* Temporary name for possible future ICC wild 29 */
299 Variant30, /* Temporary name for possible future ICC wild 30 */
300 Variant31, /* Temporary name for possible future ICC wild 31 */
301 Variant32, /* Temporary name for possible future ICC wild 32 */
302 Variant33, /* Temporary name for possible future ICC wild 33 */
303 Variant34, /* Temporary name for possible future ICC wild 34 */
304 Variant35, /* Temporary name for possible future ICC wild 35 */
305 Variant36, /* Temporary name for possible future ICC wild 36 */
306 VariantShogi, /* [HGM] added variants */
322 VariantUnknown /* Catchall for other unknown variants */
325 #define VARIANT_NAMES { \
370 #if !defined(_amigados)
371 char *whitePieceColor;
372 char *blackPieceColor;
373 char *lightSquareColor;
374 char *darkSquareColor;
375 char *jailSquareColor;
376 char *highlightSquareColor;
377 char *premoveHighlightColor;
381 int lightSquareColor;
384 int highlightSquareColor;
385 int premoveHighlightColor;
390 char *secondInitString;
391 char *firstComputerString;
392 char *secondComputerString;
393 char *firstChessProgram;
394 char *secondChessProgram;
395 char *firstDirectory;
396 char *secondDirectory;
397 Boolean firstPlaysBlack;
398 Boolean noChessProgram;
401 char *bitmapDirectory;
409 char *icsCommPort; /* if set, use serial port instead of tcp host/port */
410 char *icsLogon; /* Hack to permit variable logon scripts. */
419 int loadGameIndex; /* game # within file */
421 Boolean autoSaveGames;
422 char *loadPositionFile;
423 int loadPositionIndex; /* position # within file */
424 char *savePositionFile;
436 char *messageFont; /* WinBoard only */
438 char *font; /* xboard only: all other fonts */
439 char *tagsFont; /* WinBoard only */
440 char *commentFont; /* WinBoard only */
441 char *icsFont; /* WinBoard only */
442 Boolean ringBellAfterMoves;
443 Boolean autoCallFlag;
445 Boolean autoFlipView;
446 char *cmailGameName; /* xboard only */
447 Boolean alwaysPromoteToQueen;
448 Boolean oldSaveStyle;
451 Boolean showThinking;
452 Boolean ponderNextMove;
453 Boolean periodicUpdates;
457 Boolean testLegality;
458 int borderXoffset; /* xboard only */
459 int borderYoffset; /* xboard only */
460 Boolean titleInWindow; /* xboard only */
461 Boolean localLineEditing; /* WinBoard only */
464 int flashCount; /* Number of times to flash (xboard only) */
465 int flashRate; /* Flashes per second (xboard only) */
466 char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
467 int msLoginDelay; /* Delay per character (in msec) while sending
468 ICS logon script (xboard only) */
469 Boolean colorize; /* If True, use the following colors to color text */
470 /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
471 char *colorShout; // [HGM] IMPORTANT: order must conform to ColorClass definition
477 char *colorChallenge;
481 char *soundProgram; /* sound-playing program */
482 char *soundShout; // [HGM] IMPORTANT: order must be as in ColorClass
488 char *soundChallenge;
491 char *soundMove; // [HGM] IMPORTANT: order must be as in SoundClass
497 char *soundIcsUnfinished;
500 Boolean animateDragging; /* If True, animate mouse dragging of pieces */
501 Boolean animate; /* If True, animate non-mouse moves */
502 int animSpeed; /* Delay in milliseconds between animation frames */
503 Boolean popupMoveErrors;
504 Boolean popupExitMessage;
506 Boolean highlightLastMove;
507 Boolean highlightDragging;
508 Boolean blindfold; /* if true, no pieces are drawn */
509 Boolean premove; /* true if premove feature enabled */
510 Boolean premoveWhite; /* true if premoving White first move */
511 char *premoveWhiteText; /* text of White premove 1 */
512 Boolean premoveBlack; /* true if premoving Black first move */
513 char *premoveBlackText; /* text of Black premove 1 */
514 Boolean icsAlarm; /* true if sounding alarm at a certain time */
515 int icsAlarmTime; /* time to sound alarm, in milliseconds */
516 Boolean autoRaiseBoard;
517 int fontSizeTolerance; /* xboard only */
521 int firstProtocolVersion;
522 int secondProtocolVersion;
523 Boolean showButtonBar;
524 Boolean icsEngineAnalyze;
526 /* [AS] New properties (down to the "ZIPPY" part) */
527 Boolean firstScoreIsAbsolute; /* If true, engine score is always from white side */
528 Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
529 Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
530 Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
531 char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
532 char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
533 int liteBackTextureMode;
534 int darkBackTextureMode;
535 char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
536 char * fontToPieceTable; /* Map to translate font character to chess pieces */
537 int fontBackColorWhite;
538 int fontForeColorWhite;
539 int fontBackColorBlack;
540 int fontForeColorBlack;
541 int fontPieceSize; /* Size of font relative to square (percentage) */
542 int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
543 int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
546 char * nameOfDebugFile;
547 char * pgnEventHeader;
548 int defaultFrcPosition;
550 Boolean saveOutOfBookInfo;
551 Boolean showEvalInMoveHistory;
552 int evalHistColorWhite;
553 int evalHistColorBlack;
554 Boolean highlightMoveWithArrow;
555 int highlightArrowColor;
556 Boolean useStickyWindows;
557 Boolean bgObserve; /* [HGM] bughouse */
558 Boolean dualBoard; /* [HGM] dual */
559 int adjudicateDrawMoves;
560 Boolean autoDisplayComment;
561 Boolean autoDisplayTags;
564 Boolean firstHasOwnBookUCI;
565 Boolean secondHasOwnBookUCI;
566 char * adapterCommand;
568 Boolean usePolyglotBook;
573 int defaultCacheSizeEGTB;
574 char * defaultPathEGTB;
575 int defaultMatchGames;
577 /* [HGM] Board size */
582 char * pieceToCharTable;
583 char * pieceNickNames;
584 char * colorNickNames;
590 Boolean materialDraws;
591 Boolean trivialDraws;
599 char *zippyPassword2;
600 char *zippyWrongPassword;
601 char *zippyAcceptOnly;
604 int zippyNoplayCrafty;
606 char *zippyGameStart;
611 int zippyReplayTimeout; /*seconds*/
612 int zippyShortGame; /* [HGM] aborter */
614 Boolean lowTimeWarning; /* [HGM] low time */
615 char *lowTimeWarningColor;
617 char *serverMovesName;
618 Boolean suppressLoadMoves;
623 int firstAccumulateTC;
624 int secondAccumulateTC;
630 int rewindIndex; /* [HGM] autoinc */
631 int sameColorGames; /* [HGM] alternate */
632 int smpCores; /* [HGM] SMP */
634 int niceEngines; /* [HGM] nice */
635 char *firstLogo; /* [HGM] logo */
638 Boolean noGUI; /* [HGM] fast: suppress all display updates */
639 char *firstOptions; /* [HGM] options */
643 Boolean keepAlive; /* [HGM] alive */
644 Boolean forceIllegal;/*[HGM] illegal */
645 Boolean noJoin; /* [HGM] join */
646 char *wrapContSeq; /* continuation sequence when xboard wraps text */
647 Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
648 Boolean pasteSelection; /* paste X selection instead of clipboard */
649 int nrVariations; /* [HGM] multivar */
650 Boolean dropMenu; /* [HGM] pv */
651 Boolean markers; /* [HGM] markers */
652 } AppData, *AppDataPtr;
654 /* PGN tags (for showing in the game list) */
655 #define LPUSERGLT_SIZE 64
657 #define GLT_EVENT 'e'
660 #define GLT_ROUND 'o'
661 #define GLT_PLAYERS 'p' /* I.e. white "-" black */
662 #define GLT_RESULT 'r'
663 #define GLT_WHITE_ELO 'w'
664 #define GLT_BLACK_ELO 'b'
665 #define GLT_TIME_CONTROL 't'
666 #define GLT_VARIANT 'v'
667 #define GLT_OUT_OF_BOOK 'a'
668 #define GLT_RESULT_COMMENT 'c' /* [HGM] rescom */
670 #define GLT_DEFAULT_TAGS "eprd" /* Event, players, result, date */
672 #define GLT_ALL_TAGS "esdoprwbtvac"
674 #define PGN_OUT_OF_BOOK "Annotator"
676 extern AppData appData;
687 /* Additional info */
688 char *fen; /* NULL or FEN for starting position; input only */
691 char *extraTags; /* NULL or "[Tag \"Value\"]\n", etc. */
692 int whiteRating; /* -1 if unknown */
693 int blackRating; /* -1 if unknown */
694 VariantClass variant;
695 char *outOfBook; /* [AS] Move and score when engine went out of book */
696 int boardWidth; /* [HGM] adjustable board size */
698 /* [HGM] For Shogi and Crazyhouse: */
699 int holdingsSize; /* number of different piece types in holdings */
700 int holdingsWidth; /* number of files left and right of board, 0 or 2 */
703 /* [AS] Search stats from chessprogram, for the played move */
704 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
706 int score; /* Centipawns */
707 int depth; /* Plies */
708 int time; /* Milliseconds */
709 } ChessProgramStats_Move;
711 /* [AS] Layout management */
720 extern WindowPlacement wpEngineOutput;
721 extern WindowPlacement wpEvalGraph;
722 extern WindowPlacement wpMoveHistory;
723 extern WindowPlacement wpGameList;
724 extern WindowPlacement wpTags;
728 extern int chatCount;
729 extern char chatPartner[MAX_CHAT][MSG_SIZ];