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