2 * common.h -- Common definitions for X and Windows NT versions of XBoard
3 * $Id: common.h,v 2.1 2003/10/27 19:21:00 mann Exp $
5 * Copyright 1991 by Digital Equipment Corporation, Maynard, Massachusetts.
6 * Enhancements Copyright 1992-95 Free Software Foundation, Inc.
8 * The following terms apply to Digital Equipment Corporation's copyright
10 * ------------------------------------------------------------------------
13 * Permission to use, copy, modify, and distribute this software and its
14 * documentation for any purpose and without fee is hereby granted,
15 * provided that the above copyright notice appear in all copies and that
16 * both that copyright notice and this permission notice appear in
17 * supporting documentation, and that the name of Digital not be
18 * used in advertising or publicity pertaining to distribution of the
19 * software without specific, written prior permission.
21 * DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
22 * ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
23 * DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
24 * ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
25 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
26 * ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
28 * ------------------------------------------------------------------------
30 * The following terms apply to the enhanced version of XBoard distributed
31 * by the Free Software Foundation:
32 * ------------------------------------------------------------------------
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
43 * You should have received a copy of the GNU General Public License
44 * along with this program; if not, write to the Free Software
45 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
46 * ------------------------------------------------------------------------
53 /* Begin compatibility grunge */
55 #if defined(__STDC__) || defined(WIN32) || defined(_amigados)
57 typedef void *VOIDSTAR;
60 typedef char *VOIDSTAR;
67 #define pclose _pclose
70 #ifdef _amigados /* It is important, that these types have */
71 typedef int Boolean; /* a length of 4 bytes each, as we are */
72 typedef char *String; /* using ReadArgs() for argument parsing. */
74 FILE *popen(const char *, const char *);
79 #include <X11/Intrinsic.h>
89 #define UNKNOWN -1 /* [HGM] nps */
93 # define srandom srand48
94 # define random lrand48
95 # else /* not HAVE_RAND48 */
96 # define srandom srand
98 # endif /* not HAVE_RAND48 */
99 #endif /* !HAVE_RANDOM */
101 /* End compatibility grunge */
103 #define PROTOVER 2 /* engine protocol version */
105 // [HGM] license: Messages that engines must print to satisfy their license requirements for patented variants
106 #define GOTHIC "Gothic Chess (see www.GothicChess.com) is licensed under U.S. Patent #6,481,716 by Ed Trice"
107 #define NOFALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
109 /* [HGM] Some notes about board sizes:
110 In games that allow piece drops, the holdings are considered part of the
111 board, in the leftmost and rightmost two files. This way they are
112 automatically part of the game-history states, and enjoy all display
113 functions (including drag-drop and click-click moves to the regular part
114 of the board). The drawback of this is that the internal numbering of
115 files starts at 2 for the a-file if holdings are displayed. To ensure
116 consistency, this shifted numbering system is used _everywhere_ in the
117 code, and conversion to the 'normal' system only takes place when the
118 file number is converted to or from ASCII (by redefining the character
119 constant 'a'). This works because Winboard only communicates with the
120 outside world in ASCII. In a similar way, the different rank numbering
121 systems (starting at rank 0 or 1) are implemented by redefining '1'.
123 #define BOARD_SIZE 16 /* [HGM] for in declarations */
124 #define BOARD_HEIGHT (gameInfo.boardHeight) // [HGM] made user adjustable
125 #define BOARD_WIDTH (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)
126 #define BOARD_LEFT (gameInfo.holdingsWidth) // [HGM] play-board edges
127 #define BOARD_RGHT (gameInfo.boardWidth + gameInfo.holdingsWidth)
128 #define ONE ('1'-(BOARD_HEIGHT>9)) // [HGM] foremost board rank
129 #define AAA ('a'-BOARD_LEFT) // [HGM] leftmost board file
131 #define MAX_MOVES 1000
133 #define DIALOG_SIZE 256
134 #define STAR_MATCH_N 16
136 #define TIME_CONTROL "5" /* in minutes */
137 #define TIME_DELAY_QUOTE "1.0" /* seconds between moves */
138 #define TIME_DELAY ((float) 1.0)
139 #define MOVES_PER_SESSION 40 /* moves per TIME_CONTROL */
140 #define TIME_INCREMENT -1 /* if >= 0, MOVES_PER_SESSION unused */
141 #define WhiteOnMove(move) (((move) % 2) == 0)
142 #define ICS_HOST "chessclub.com"
143 #define ICS_PORT "5000"
144 #define ICS_COMM_PORT ""
145 #define FIRST_HOST "localhost"
146 #define SECOND_HOST "localhost"
147 #define TELNET_PROGRAM "telnet"
148 #define MATCH_MODE "False"
149 #define INIT_STRING "new\nrandom\n"
150 #define WHITE_STRING "white\ngo\n"
151 #define BLACK_STRING "black\ngo\n"
152 #define COMPUTER_STRING "computer\n"
153 #define REUSE_CHESS_PROGRAMS 1
154 #define WHITE_PIECE_COLOR "#FFFFCC"
155 #define BLACK_PIECE_COLOR "#202020"
156 #define LIGHT_SQUARE_COLOR "#C8C365"
157 #define DARK_SQUARE_COLOR "#77A26D"
158 #define JAIL_SQUARE_COLOR "#808080"
159 #define HIGHLIGHT_SQUARE_COLOR "#FFFF00"
160 #define PREMOVE_HIGHLIGHT_COLOR "#FF0000"
161 #define BELLCHAR '\007'
162 #define NULLCHAR '\000'
163 #define FEATURE_TIMEOUT 10000 /*ms*/
166 #define ZIPPY_TALK FALSE
167 #define ZIPPY_PLAY FALSE
168 #define ZIPPY_LINES "yow.lines"
169 #define ZIPPY_PINHEAD ""
170 #define ZIPPY_PASSWORD ""
171 #define ZIPPY_PASSWORD2 ""
172 #define ZIPPY_WRONG_PASSWORD ""
173 #define ZIPPY_ACCEPT_ONLY ""
174 #define ZIPPY_USE_I TRUE
175 #define ZIPPY_BUGHOUSE 0
176 #define ZIPPY_NOPLAY_CRAFTY FALSE
177 #define ZIPPY_GAME_END "gameend\n"
178 #define ZIPPY_GAME_START ""
179 #define ZIPPY_ADJOURN FALSE
180 #define ZIPPY_ABORT FALSE
181 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
182 #define ZIPPY_MAX_GAMES 0
183 #define ZIPPY_REPLAY_TIMEOUT 120
186 BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
187 AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
188 EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
189 IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
194 /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
195 /* only the first N pieces can go into the holdings, and */
196 /* promotions in those variants shift P-W to U-S */
197 WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
198 WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
199 WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
200 WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteKing,
201 BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
202 BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
203 BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
204 BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackKing,
206 ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
209 /* [HGM] some macros that can be used as prefixes to convert piece types */
210 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
211 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
212 #define PROMOTED (int)WhiteDragon - (int)WhiteRook + (int)
213 #define DEMOTED (int)WhiteRook - (int)WhiteDragon + (int)
214 #define SHOGI (int)EmptySquare + (int)
217 typedef ChessSquare Board[BOARD_SIZE][BOARD_SIZE];
220 WhiteKingSideCastle = 1, WhiteQueenSideCastle,
221 WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
222 WhiteHSideCastleFR, WhiteASideCastleFR,
223 BlackKingSideCastle, BlackQueenSideCastle,
224 BlackKingSideCastleWild, BlackQueenSideCastleWild,
225 BlackHSideCastleFR, BlackASideCastleFR,
226 WhitePromotionKnight, WhitePromotionBishop,
227 WhitePromotionRook, WhitePromotionQueen, WhitePromotionKing,
228 WhitePromotionChancellor, WhitePromotionArchbishop, WhitePromotionCentaur,
229 BlackPromotionKnight, BlackPromotionBishop,
230 BlackPromotionRook, BlackPromotionQueen, BlackPromotionKing,
231 BlackPromotionChancellor, BlackPromotionArchbishop, BlackPromotionCentaur,
232 WhiteCapturesEnPassant, BlackCapturesEnPassant,
233 WhiteDrop, BlackDrop,
234 NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
235 WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
236 GNUChessGame, XBoardGame, MoveNumberOne,
237 Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
241 ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
242 ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
243 ColorNone, NColorClasses
247 SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
248 SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
251 /* Names for chess variants, not necessarily supported */
253 VariantNormal, /* Normal chess */
254 VariantLoadable, /* "loadgame" command allowed (not really a variant)*/
255 VariantWildCastle, /* Shuffle chess where king can castle from d file */
256 VariantNoCastle, /* Shuffle chess with no castling at all */
257 VariantFischeRandom, /* FischeRandom */
258 VariantBughouse, /* Bughouse, ICC/FICS rules */
259 VariantCrazyhouse, /* Crazyhouse, ICC/FICS rules */
260 VariantLosers, /* Try to lose all pieces or get mated (ICC wild 17)*/
261 VariantSuicide, /* Try to lose all pieces incl. king (FICS) */
262 VariantGiveaway, /* Try to have no legal moves left (ICC wild 26) */
263 VariantTwoKings, /* Weird ICC wild 9 */
264 VariantKriegspiel, /* Kriegspiel; pawns can capture invisible pieces */
265 VariantAtomic, /* Capturing piece explodes (ICC wild 27) */
266 Variant3Check, /* Win by giving check 3 times (ICC wild 25) */
267 VariantShatranj, /* Unsupported (ICC wild 28) */
268 Variant29, /* Temporary name for possible future ICC wild 29 */
269 Variant30, /* Temporary name for possible future ICC wild 30 */
270 Variant31, /* Temporary name for possible future ICC wild 31 */
271 Variant32, /* Temporary name for possible future ICC wild 32 */
272 Variant33, /* Temporary name for possible future ICC wild 33 */
273 Variant34, /* Temporary name for possible future ICC wild 34 */
274 Variant35, /* Temporary name for possible future ICC wild 35 */
275 Variant36, /* Temporary name for possible future ICC wild 36 */
276 VariantShogi, /* [HGM] added variants */
290 VariantUnknown /* Catchall for other unknown variants */
293 #define VARIANT_NAMES { \
335 #if !defined(_amigados)
336 char *whitePieceColor;
337 char *blackPieceColor;
338 char *lightSquareColor;
339 char *darkSquareColor;
340 char *jailSquareColor;
341 char *highlightSquareColor;
342 char *premoveHighlightColor;
346 int lightSquareColor;
349 int highlightSquareColor;
350 int premoveHighlightColor;
355 char *secondInitString;
356 char *firstComputerString;
357 char *secondComputerString;
358 char *firstChessProgram;
359 char *secondChessProgram;
360 char *firstDirectory;
361 char *secondDirectory;
362 Boolean firstPlaysBlack;
363 Boolean noChessProgram;
366 char *bitmapDirectory;
374 char *icsCommPort; /* if set, use serial port instead of tcp host/port */
375 char *icsLogon; /* Hack to permit variable logon scripts. */
382 int loadGameIndex; /* game # within file */
384 Boolean autoSaveGames;
385 char *loadPositionFile;
386 int loadPositionIndex; /* position # within file */
387 char *savePositionFile;
399 char *messageFont; /* WinBoard only */
401 char *font; /* xboard only: all other fonts */
402 char *tagsFont; /* WinBoard only */
403 char *commentFont; /* WinBoard only */
404 char *icsFont; /* WinBoard only */
405 Boolean ringBellAfterMoves;
406 Boolean autoCallFlag;
408 Boolean autoFlipView;
409 char *cmailGameName; /* xboard only */
410 Boolean alwaysPromoteToQueen;
411 Boolean oldSaveStyle;
413 Boolean showThinking;
414 Boolean ponderNextMove;
415 Boolean periodicUpdates;
419 Boolean testLegality;
420 int borderXoffset; /* xboard only */
421 int borderYoffset; /* xboard only */
422 Boolean titleInWindow; /* xboard only */
423 Boolean localLineEditing; /* WinBoard only */
426 int flashCount; /* Number of times to flash (xboard only) */
427 int flashRate; /* Flashes per second (xboard only) */
428 char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
429 int msLoginDelay; /* Delay per character (in msec) while sending
430 ICS logon script (xboard only) */
431 Boolean colorize; /* If True, use the following colors to color text */
432 /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
439 char *colorChallenge;
443 char *soundProgram; /* sound-playing program */
450 char *soundChallenge;
457 char *soundIcsUnfinished;
461 Boolean animateDragging; /* If True, animate mouse dragging of pieces */
462 Boolean animate; /* If True, animate non-mouse moves */
463 int animSpeed; /* Delay in milliseconds between animation frames */
464 Boolean popupMoveErrors;
465 Boolean popupExitMessage;
467 Boolean highlightLastMove;
468 Boolean highlightDragging;
469 Boolean blindfold; /* if true, no pieces are drawn */
470 Boolean premove; /* true if premove feature enabled */
471 Boolean premoveWhite; /* true if premoving White first move */
472 char *premoveWhiteText; /* text of White premove 1 */
473 Boolean premoveBlack; /* true if premoving Black first move */
474 char *premoveBlackText; /* text of Black premove 1 */
475 Boolean icsAlarm; /* true if sounding alarm at a certain time */
476 int icsAlarmTime; /* time to sound alarm, in milliseconds */
477 Boolean autoRaiseBoard;
478 int fontSizeTolerance; /* xboard only */
481 int firstProtocolVersion;
482 int secondProtocolVersion;
483 Boolean showButtonBar;
484 Boolean icsEngineAnalyze;
486 /* [AS] New properties (down to the "ZIPPY" part) */
487 Boolean firstScoreIsAbsolute; /* If true, engine score is always from white side */
488 Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
489 Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
490 Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
491 char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
492 char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
493 int liteBackTextureMode;
494 int darkBackTextureMode;
495 char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
496 char * fontToPieceTable; /* Map to translate font character to chess pieces */
497 int fontBackColorWhite;
498 int fontForeColorWhite;
499 int fontBackColorBlack;
500 int fontForeColorBlack;
501 int fontPieceSize; /* Size of font relative to square (percentage) */
502 int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
503 int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
506 char * nameOfDebugFile;
507 char * pgnEventHeader;
508 int defaultFrcPosition;
510 Boolean saveOutOfBookInfo;
511 Boolean showEvalInMoveHistory;
512 int evalHistColorWhite;
513 int evalHistColorBlack;
514 Boolean highlightMoveWithArrow;
515 int highlightArrowColor;
516 Boolean useStickyWindows;
517 int adjudicateDrawMoves;
518 Boolean autoDisplayComment;
519 Boolean autoDisplayTags;
522 Boolean firstHasOwnBookUCI;
523 Boolean secondHasOwnBookUCI;
525 Boolean usePolyglotBook;
528 int defaultCacheSizeEGTB;
529 char * defaultPathEGTB;
531 /* [HGM] Board size */
536 char * pieceToCharTable;
542 Boolean materialDraws;
543 Boolean trivialDraws;
551 char *zippyPassword2;
552 char *zippyWrongPassword;
553 char *zippyAcceptOnly;
556 int zippyNoplayCrafty;
558 char *zippyGameStart;
563 int zippyReplayTimeout; /*seconds*/
566 char *serverMovesName;
567 Boolean suppressLoadMoves;
572 int firstAccumulateTC;
573 int secondAccumulateTC;
579 int rewindIndex; /* [HGM] autoinc */
580 int sameColorGames; /* [HGM] alternate */
581 int smpCores; /* [HGM] SMP */
583 int niceEngines; /* [HGM] nice */
584 char *firstLogo; /* [HGM] logo */
587 Boolean noGUI; /* [HGM] fast: suppress all display updates */
588 char *firstOptions; /* [HGM] options */
590 } AppData, *AppDataPtr;
592 /* [AS] PGN tags (for showing in the game list) */
593 #define GLT_EVENT 'e'
596 #define GLT_ROUND 'o'
597 #define GLT_PLAYERS 'p' /* I.e. white "-" black */
598 #define GLT_RESULT 'r'
599 #define GLT_WHITE_ELO 'w'
600 #define GLT_BLACK_ELO 'b'
601 #define GLT_TIME_CONTROL 't'
602 #define GLT_VARIANT 'v'
603 #define GLT_OUT_OF_BOOK 'a'
605 #define GLT_DEFAULT_TAGS "eprd" /* Event, players, result, date */
607 #define GLT_ALL_TAGS "esdoprwbtva"
609 #define PGN_OUT_OF_BOOK "Annotator"
611 extern AppData appData;
622 /* Additional info */
623 char *fen; /* NULL or FEN for starting position; input only */
626 char *extraTags; /* NULL or "[Tag \"Value\"]\n", etc. */
627 int whiteRating; /* -1 if unknown */
628 int blackRating; /* -1 if unknown */
629 VariantClass variant;
630 char *outOfBook; /* [AS] Move and score when engine went out of book */
631 int boardWidth; /* [HGM] adjustable board size */
633 /* [HGM] For Shogi and Crazyhouse: */
634 int holdingsSize; /* number of different piece types in holdings */
635 int holdingsWidth; /* number of files left and right of board, 0 or 2 */