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_SIZE 16 /* [HGM] for in declarations */
129 #define BOARD_HEIGHT (gameInfo.boardHeight) // [HGM] made user adjustable
130 #define BOARD_WIDTH (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)
131 #define BOARD_LEFT (gameInfo.holdingsWidth) // [HGM] play-board edges
132 #define BOARD_RGHT (gameInfo.boardWidth + gameInfo.holdingsWidth)
133 #define ONE ('1'-(BOARD_HEIGHT>9)) // [HGM] foremost board rank
134 #define AAA ('a'-BOARD_LEFT) // [HGM] leftmost board file
136 #define MAX_MOVES 1000
138 #define DIALOG_SIZE 256
139 #define STAR_MATCH_N 16
141 #define TIME_CONTROL "5" /* in minutes */
142 #define TIME_DELAY_QUOTE "1.0" /* seconds between moves */
143 #define TIME_DELAY ((float) 1.0)
144 #define MOVES_PER_SESSION 40 /* moves per TIME_CONTROL */
145 #define TIME_INCREMENT -1 /* if >= 0, MOVES_PER_SESSION unused */
146 #define WhiteOnMove(move) (((move) % 2) == 0)
147 #define ICS_HOST "chessclub.com"
148 #define ICS_PORT "5000"
149 #define ICS_COMM_PORT ""
150 #define FIRST_HOST "localhost"
151 #define SECOND_HOST "localhost"
152 #define TELNET_PROGRAM "telnet"
153 #define DEF_BITMAP_DIR "/usr/share/games/xboard/bitmaps.xchess" /* AP: shouldn't be hardcoded directory, but better than nothing at the moment */
154 #define MATCH_MODE "False"
155 #define INIT_STRING "new\nrandom\n"
156 #define WHITE_STRING "white\ngo\n"
157 #define BLACK_STRING "black\ngo\n"
158 #define COMPUTER_STRING "computer\n"
159 #define REUSE_CHESS_PROGRAMS 1
160 #define WHITE_PIECE_COLOR "#FFFFCC"
161 #define BLACK_PIECE_COLOR "#202020"
162 #define LIGHT_SQUARE_COLOR "#C8C365"
163 #define DARK_SQUARE_COLOR "#77A26D"
164 #define JAIL_SQUARE_COLOR "#808080"
165 #define HIGHLIGHT_SQUARE_COLOR "#FFFF00"
166 #define PREMOVE_HIGHLIGHT_COLOR "#FF0000"
167 #define BELLCHAR '\007'
168 #define NULLCHAR '\000'
169 #define FEATURE_TIMEOUT 10000 /*ms*/
172 #define ZIPPY_TALK FALSE
173 #define ZIPPY_PLAY FALSE
174 #define ZIPPY_LINES "yow.lines"
175 #define ZIPPY_PINHEAD ""
176 #define ZIPPY_PASSWORD ""
177 #define ZIPPY_PASSWORD2 ""
178 #define ZIPPY_WRONG_PASSWORD ""
179 #define ZIPPY_ACCEPT_ONLY ""
180 #define ZIPPY_USE_I TRUE
181 #define ZIPPY_BUGHOUSE 0
182 #define ZIPPY_NOPLAY_CRAFTY FALSE
183 #define ZIPPY_GAME_END "gameend\n"
184 #define ZIPPY_GAME_START ""
185 #define ZIPPY_ADJOURN FALSE
186 #define ZIPPY_ABORT FALSE
187 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
188 #define ZIPPY_MAX_GAMES 0
189 #define ZIPPY_REPLAY_TIMEOUT 120
192 BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
193 AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
194 EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
195 IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
200 /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
201 /* only the first N pieces can go into the holdings, and */
202 /* promotions in those variants shift P-W to U-S */
203 WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
204 WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
205 WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
206 WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteKing,
207 BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
208 BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
209 BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
210 BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackKing,
212 ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
215 /* [HGM] some macros that can be used as prefixes to convert piece types */
216 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
217 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
218 #define PROMOTED (int)WhiteDragon - (int)WhiteRook + (int)
219 #define DEMOTED (int)WhiteRook - (int)WhiteDragon + (int)
220 #define SHOGI (int)EmptySquare + (int)
223 typedef ChessSquare Board[BOARD_SIZE][BOARD_SIZE];
226 WhiteKingSideCastle = 1, WhiteQueenSideCastle,
227 WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
228 WhiteHSideCastleFR, WhiteASideCastleFR,
229 BlackKingSideCastle, BlackQueenSideCastle,
230 BlackKingSideCastleWild, BlackQueenSideCastleWild,
231 BlackHSideCastleFR, BlackASideCastleFR,
232 WhitePromotionKnight, WhitePromotionBishop,
233 WhitePromotionRook, WhitePromotionQueen, WhitePromotionKing,
234 WhitePromotionChancellor, WhitePromotionArchbishop, WhitePromotionCentaur,
235 BlackPromotionKnight, BlackPromotionBishop,
236 BlackPromotionRook, BlackPromotionQueen, BlackPromotionKing,
237 BlackPromotionChancellor, BlackPromotionArchbishop, BlackPromotionCentaur,
238 WhiteCapturesEnPassant, BlackCapturesEnPassant,
239 WhiteDrop, BlackDrop,
240 NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
241 WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
242 GNUChessGame, XBoardGame, MoveNumberOne,
243 Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
247 ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
248 ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
249 ColorNone, NColorClasses
253 SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
254 SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
257 /* Names for chess variants, not necessarily supported */
259 VariantNormal, /* Normal chess */
260 VariantLoadable, /* "loadgame" command allowed (not really a variant)*/
261 VariantWildCastle, /* Shuffle chess where king can castle from d file */
262 VariantNoCastle, /* Shuffle chess with no castling at all */
263 VariantFischeRandom, /* FischeRandom */
264 VariantBughouse, /* Bughouse, ICC/FICS rules */
265 VariantCrazyhouse, /* Crazyhouse, ICC/FICS rules */
266 VariantLosers, /* Try to lose all pieces or get mated (ICC wild 17)*/
267 VariantSuicide, /* Try to lose all pieces incl. king (FICS) */
268 VariantGiveaway, /* Try to have no legal moves left (ICC wild 26) */
269 VariantTwoKings, /* Weird ICC wild 9 */
270 VariantKriegspiel, /* Kriegspiel; pawns can capture invisible pieces */
271 VariantAtomic, /* Capturing piece explodes (ICC wild 27) */
272 Variant3Check, /* Win by giving check 3 times (ICC wild 25) */
273 VariantShatranj, /* Unsupported (ICC wild 28) */
274 Variant29, /* Temporary name for possible future ICC wild 29 */
275 Variant30, /* Temporary name for possible future ICC wild 30 */
276 Variant31, /* Temporary name for possible future ICC wild 31 */
277 Variant32, /* Temporary name for possible future ICC wild 32 */
278 Variant33, /* Temporary name for possible future ICC wild 33 */
279 Variant34, /* Temporary name for possible future ICC wild 34 */
280 Variant35, /* Temporary name for possible future ICC wild 35 */
281 Variant36, /* Temporary name for possible future ICC wild 36 */
282 VariantShogi, /* [HGM] added variants */
298 VariantUnknown /* Catchall for other unknown variants */
301 #define VARIANT_NAMES { \
345 #if !defined(_amigados)
346 char *whitePieceColor;
347 char *blackPieceColor;
348 char *lightSquareColor;
349 char *darkSquareColor;
350 char *jailSquareColor;
351 char *highlightSquareColor;
352 char *premoveHighlightColor;
356 int lightSquareColor;
359 int highlightSquareColor;
360 int premoveHighlightColor;
365 char *secondInitString;
366 char *firstComputerString;
367 char *secondComputerString;
368 char *firstChessProgram;
369 char *secondChessProgram;
370 char *firstDirectory;
371 char *secondDirectory;
372 Boolean firstPlaysBlack;
373 Boolean noChessProgram;
376 char *bitmapDirectory;
384 char *icsCommPort; /* if set, use serial port instead of tcp host/port */
385 char *icsLogon; /* Hack to permit variable logon scripts. */
392 int loadGameIndex; /* game # within file */
394 Boolean autoSaveGames;
395 char *loadPositionFile;
396 int loadPositionIndex; /* position # within file */
397 char *savePositionFile;
409 char *messageFont; /* WinBoard only */
411 char *font; /* xboard only: all other fonts */
412 char *tagsFont; /* WinBoard only */
413 char *commentFont; /* WinBoard only */
414 char *icsFont; /* WinBoard only */
415 Boolean ringBellAfterMoves;
416 Boolean autoCallFlag;
418 Boolean autoFlipView;
419 char *cmailGameName; /* xboard only */
420 Boolean alwaysPromoteToQueen;
421 Boolean oldSaveStyle;
423 Boolean showThinking;
424 Boolean ponderNextMove;
425 Boolean periodicUpdates;
429 Boolean testLegality;
430 int borderXoffset; /* xboard only */
431 int borderYoffset; /* xboard only */
432 Boolean titleInWindow; /* xboard only */
433 Boolean localLineEditing; /* WinBoard only */
436 int flashCount; /* Number of times to flash (xboard only) */
437 int flashRate; /* Flashes per second (xboard only) */
438 char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
439 int msLoginDelay; /* Delay per character (in msec) while sending
440 ICS logon script (xboard only) */
441 Boolean colorize; /* If True, use the following colors to color text */
442 /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
449 char *colorChallenge;
453 char *soundProgram; /* sound-playing program */
460 char *soundChallenge;
467 char *soundIcsUnfinished;
471 Boolean animateDragging; /* If True, animate mouse dragging of pieces */
472 Boolean animate; /* If True, animate non-mouse moves */
473 int animSpeed; /* Delay in milliseconds between animation frames */
474 Boolean popupMoveErrors;
475 Boolean popupExitMessage;
477 Boolean highlightLastMove;
478 Boolean highlightDragging;
479 Boolean blindfold; /* if true, no pieces are drawn */
480 Boolean premove; /* true if premove feature enabled */
481 Boolean premoveWhite; /* true if premoving White first move */
482 char *premoveWhiteText; /* text of White premove 1 */
483 Boolean premoveBlack; /* true if premoving Black first move */
484 char *premoveBlackText; /* text of Black premove 1 */
485 Boolean icsAlarm; /* true if sounding alarm at a certain time */
486 int icsAlarmTime; /* time to sound alarm, in milliseconds */
487 Boolean autoRaiseBoard;
488 int fontSizeTolerance; /* xboard only */
491 int firstProtocolVersion;
492 int secondProtocolVersion;
493 Boolean showButtonBar;
494 Boolean icsEngineAnalyze;
496 /* [AS] New properties (down to the "ZIPPY" part) */
497 Boolean firstScoreIsAbsolute; /* If true, engine score is always from white side */
498 Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
499 Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
500 Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
501 char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
502 char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
503 int liteBackTextureMode;
504 int darkBackTextureMode;
505 char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
506 char * fontToPieceTable; /* Map to translate font character to chess pieces */
507 int fontBackColorWhite;
508 int fontForeColorWhite;
509 int fontBackColorBlack;
510 int fontForeColorBlack;
511 int fontPieceSize; /* Size of font relative to square (percentage) */
512 int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
513 int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
516 char * nameOfDebugFile;
517 char * pgnEventHeader;
518 int defaultFrcPosition;
520 Boolean saveOutOfBookInfo;
521 Boolean showEvalInMoveHistory;
522 int evalHistColorWhite;
523 int evalHistColorBlack;
524 Boolean highlightMoveWithArrow;
525 int highlightArrowColor;
526 Boolean useStickyWindows;
527 int adjudicateDrawMoves;
528 Boolean autoDisplayComment;
529 Boolean autoDisplayTags;
532 Boolean firstHasOwnBookUCI;
533 Boolean secondHasOwnBookUCI;
535 Boolean usePolyglotBook;
538 int defaultCacheSizeEGTB;
539 char * defaultPathEGTB;
541 /* [HGM] Board size */
546 char * pieceToCharTable;
552 Boolean materialDraws;
553 Boolean trivialDraws;
561 char *zippyPassword2;
562 char *zippyWrongPassword;
563 char *zippyAcceptOnly;
566 int zippyNoplayCrafty;
568 char *zippyGameStart;
573 int zippyReplayTimeout; /*seconds*/
574 int zippyShortGame; /* [HGM] aborter */
576 Boolean lowTimeWarning; /* [HGM] low time */
577 char *lowTimeWarningColor;
579 char *serverMovesName;
580 Boolean suppressLoadMoves;
585 int firstAccumulateTC;
586 int secondAccumulateTC;
592 int rewindIndex; /* [HGM] autoinc */
593 int sameColorGames; /* [HGM] alternate */
594 int smpCores; /* [HGM] SMP */
596 int niceEngines; /* [HGM] nice */
597 char *firstLogo; /* [HGM] logo */
600 Boolean noGUI; /* [HGM] fast: suppress all display updates */
601 char *firstOptions; /* [HGM] options */
605 Boolean keepAlive; /* [HGM] alive */
606 Boolean forceIllegal;/*[HGM] illegal */
607 Boolean noJoin; /* [HGM] join */
608 char *wrapContSeq; /* continuation sequence when xboard wraps text */
609 Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
610 Boolean pasteSelection; /* paste X selection instead of clipboard */
611 } AppData, *AppDataPtr;
613 /* [AS] PGN tags (for showing in the game list) */
614 #define GLT_EVENT 'e'
617 #define GLT_ROUND 'o'
618 #define GLT_PLAYERS 'p' /* I.e. white "-" black */
619 #define GLT_RESULT 'r'
620 #define GLT_WHITE_ELO 'w'
621 #define GLT_BLACK_ELO 'b'
622 #define GLT_TIME_CONTROL 't'
623 #define GLT_VARIANT 'v'
624 #define GLT_OUT_OF_BOOK 'a'
625 #define GLT_RESULT_COMMENT 'c' /* [HGM] rescom */
627 #define GLT_DEFAULT_TAGS "eprd" /* Event, players, result, date */
629 #define GLT_ALL_TAGS "esdoprwbtvac"
631 #define PGN_OUT_OF_BOOK "Annotator"
633 extern AppData appData;
644 /* Additional info */
645 char *fen; /* NULL or FEN for starting position; input only */
648 char *extraTags; /* NULL or "[Tag \"Value\"]\n", etc. */
649 int whiteRating; /* -1 if unknown */
650 int blackRating; /* -1 if unknown */
651 VariantClass variant;
652 char *outOfBook; /* [AS] Move and score when engine went out of book */
653 int boardWidth; /* [HGM] adjustable board size */
655 /* [HGM] For Shogi and Crazyhouse: */
656 int holdingsSize; /* number of different piece types in holdings */
657 int holdingsWidth; /* number of files left and right of board, 0 or 2 */
662 extern int chatCount;
663 extern char chatPartner[MAX_CHAT][MSG_SIZ];