Make user wav file available for try-out in sound dialog
[xboard.git] / common.h
1 /*
2  * common.h -- Common definitions for X and Windows NT versions of XBoard
3  *
4  * Copyright 1991 by Digital Equipment Corporation, Maynard,
5  * Massachusetts. 
6  *
7  * Enhancements Copyright 1992-2001, 2002, 2003, 2004, 2005, 2006,
8  * 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
9  *
10  * Enhancements Copyright 2005 Alessandro Scotti
11  *
12  * The following terms apply to Digital Equipment Corporation's copyright
13  * interest in XBoard:
14  * ------------------------------------------------------------------------
15  * All Rights Reserved
16  *
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.
24  *
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
31  * SOFTWARE.
32  * ------------------------------------------------------------------------
33  *
34  * The following terms apply to the enhanced version of XBoard
35  * distributed by the Free Software Foundation:
36  * ------------------------------------------------------------------------
37  *
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.
42  *
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.
47  *
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/.  *
50  *
51  *------------------------------------------------------------------------
52  ** See the file ChangeLog for a revision history.  */
53
54 #ifndef _COMMON
55 #define _COMMON
56
57
58 /* Begin compatibility grunge  */
59
60 #if defined(__STDC__) || defined(WIN32) || defined(_amigados)
61 #define P(args) args
62 typedef void *VOIDSTAR;
63 #else
64 #define P(args)         ()
65 typedef char *VOIDSTAR;
66 #endif
67
68 #ifdef WIN32
69 typedef char Boolean;
70 typedef char *String;
71 #define popen _popen
72 #define pclose _pclose
73
74 #else
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.  */
78 #ifdef _DCC
79 FILE *popen(const char *, const char *);
80 int pclose(FILE *);
81 #endif
82
83 #else
84 #include <X11/Intrinsic.h>
85 #endif
86 #endif
87
88
89 #ifndef TRUE
90 #define TRUE 1
91 #define FALSE 0
92 #endif
93
94 #define UNKNOWN -1 /* [HGM] nps */
95
96 #if !HAVE_RANDOM
97 # if HAVE_RAND48
98 #  define srandom srand48
99 #  define random lrand48
100 # else /* not HAVE_RAND48 */
101 #  define srandom srand
102 #  define random rand
103 # endif /* not HAVE_RAND48 */
104 #endif /* !HAVE_RANDOM */
105
106 /* End compatibility grunge */
107
108 #define PROTOVER                2       /* engine protocol version */
109
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"
113
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'.
127 */
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  */
139 #define DROP_RANK               -3
140 #define MAX_MOVES               1000
141 #define MSG_SIZ                 512
142 #define DIALOG_SIZE             256
143 #define STAR_MATCH_N            16
144 #define MOVE_LEN                32
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          BITMAPDIR
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*/
175
176 #define CLOCK_FONT 0
177 #define MESSAGE_FONT 1
178 #define COORD_FONT 2
179 #define CONSOLE_FONT 3
180 #define COMMENT_FONT 4
181 #define EDITTAGS_FONT 5
182 #define MOVEHISTORY_FONT 6
183 #define NUM_FONTS 7
184
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 */
188
189 /* Default delay per character (in msec) while sending login script */
190 #define MS_LOGIN_DELAY  0
191
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
196
197 /* Zippy defaults */
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
216
217 typedef enum {
218     BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
219     AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
220     EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
221     IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
222     IcsExamining
223   } GameMode;
224
225 typedef enum {
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,
237     EmptySquare, 
238     NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
239     ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
240   } ChessSquare;
241
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)
248
249
250 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
251
252 typedef enum {
253     EndOfFile = 0,
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, Open, Close, Nothing,
267     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
268   } ChessMove;
269
270 typedef enum {
271     ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
272     ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
273     ColorNone, NColorClasses
274 } ColorClass;
275
276 typedef enum {
277     SoundMove, SoundBell, SoundAlarm, SoundIcsWin, SoundIcsLoss,
278     SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
279 } SoundClass;
280
281 /* Names for chess variants, not necessarily supported */
282 typedef enum {
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 */
307     VariantXiangqi,
308     VariantCourier,
309     VariantGothic,
310     VariantCapablanca,
311     VariantKnightmate,
312     VariantFairy,        
313     VariantCylinder,
314     VariantFalcon,
315     VariantCapaRandom,
316     VariantBerolina,
317     VariantJanus,
318     VariantSuper,
319     VariantGreat,
320     VariantTwilight,
321     VariantMakruk,
322     VariantSChess,
323     VariantSpartan,
324     VariantUnknown       /* Catchall for other unknown variants */
325 } VariantClass;
326
327 #define VARIANT_NAMES { \
328   "normal", \
329   "normal", \
330   "wildcastle", \
331   "nocastle", \
332   "fischerandom", \
333   "bughouse", \
334   "crazyhouse", \
335   "losers", \
336   "suicide", \
337   "giveaway", \
338   "twokings", \
339   "kriegspiel", \
340   "atomic", \
341   "3check", \
342   "shatranj", \
343   "wild29", \
344   "wild30", \
345   "wild31", \
346   "wild32", \
347   "wild33", \
348   "wild34", \
349   "wild35", \
350   "wild36", \
351   "shogi", \
352   "xiangqi", \
353   "courier", \
354   "gothic", \
355   "capablanca", \
356   "knightmate", \
357   "fairy", \
358   "cylinder", \
359   "falcon",\
360   "caparandom",\
361   "berolina",\
362   "janus",\
363   "super",\
364   "great",\
365   "twilight",\
366   "makruk",\
367   "seirawan",\
368   "spartan",\
369   "unknown" \
370 }
371
372 typedef struct {
373     char *language;
374 #if !defined(_amigados)
375     char *whitePieceColor;
376     char *blackPieceColor;
377     char *lightSquareColor;
378     char *darkSquareColor;
379     char *jailSquareColor;
380     char *highlightSquareColor;
381     char *premoveHighlightColor;
382 #else
383     int whitePieceColor;
384     int blackPieceColor;
385     int lightSquareColor;
386     int darkSquareColor;
387     int jailSquareColor;
388     int highlightSquareColor;
389     int premoveHighlightColor;
390 #endif
391     int movesPerSession;
392     float timeIncrement;
393     char *initString;
394     char *secondInitString;
395     char *firstComputerString;
396     char *secondComputerString;
397     char *firstChessProgram;
398     char *secondChessProgram;
399     char *firstDirectory;
400     char *secondDirectory;
401     Boolean firstPlaysBlack;
402     Boolean noChessProgram;
403     char *firstHost;
404     char *secondHost;
405     char *bitmapDirectory;
406     char *soundDirectory;
407     char *remoteShell;
408     char *remoteUser;
409     float timeDelay;
410     char *timeControl;
411     Boolean icsActive;
412     char *icsHost;
413     char *icsPort;
414     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
415     char *icsLogon;     /* Hack to permit variable logon scripts. */
416     char *icsHelper;
417     Boolean icsInputBox;
418     Boolean useTelnet;
419     Boolean seekGraph;
420     Boolean autoRefresh;
421     char *telnetProgram;
422     char *gateway;
423     char *loadGameFile;
424     int loadGameIndex;      /* game # within file */
425     char *saveGameFile;
426     Boolean autoSaveGames;
427     char *loadPositionFile;
428     int loadPositionIndex;  /* position # within file */
429     char *savePositionFile;
430     Boolean matchMode;
431     int matchGames;
432     Boolean monoMode;
433     Boolean debugMode;
434     Boolean clockMode;
435     char *boardSize;
436     Boolean Iconic;
437     char *searchTime;
438     int searchDepth;
439     Boolean showCoords;
440     char *clockFont;
441     char *messageFont; /* WinBoard only */
442     char *coordFont;
443     char *font; /* xboard only: all other fonts */
444     char *tagsFont; /* WinBoard only */
445     char *commentFont; /* WinBoard only */
446     char *icsFont; /* WinBoard only */
447     Boolean ringBellAfterMoves;
448     Boolean autoCallFlag;
449     Boolean flipView;
450     Boolean autoFlipView;
451     char *cmailGameName; /* xboard only */
452     Boolean alwaysPromoteToQueen;
453     Boolean oldSaveStyle;
454     Boolean oneClick;
455     Boolean quietPlay;
456     Boolean showThinking;
457     Boolean ponderNextMove;
458     Boolean periodicUpdates;
459     Boolean autoObserve;
460     Boolean autoComment;
461     Boolean getMoveList;
462     Boolean testLegality;
463     int borderXoffset; /* xboard only */
464     int borderYoffset; /* xboard only */
465     Boolean titleInWindow; /* xboard only */
466     Boolean localLineEditing; /* WinBoard only */
467     Boolean zippyTalk;
468     Boolean zippyPlay;
469     int flashCount; /* Number of times to flash (xboard only) */
470     int flashRate; /* Flashes per second (xboard only)  */
471     char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
472     int msLoginDelay;  /* Delay per character (in msec) while sending
473                           ICS logon script (xboard only) */
474     Boolean colorize;   /* If True, use the following colors to color text */
475     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
476     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
477     char *colorSShout;
478     char *colorChannel1;
479     char *colorChannel;
480     char *colorKibitz;
481     char *colorTell;
482     char *colorChallenge;
483     char *colorRequest;
484     char *colorSeek;
485     char *colorNormal;
486     char *soundProgram; /* sound-playing program */
487     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
488     char *soundSShout;
489     char *soundChannel1;
490     char *soundChannel;
491     char *soundKibitz;
492     char *soundTell;
493     char *soundChallenge;
494     char *soundRequest;
495     char *soundSeek;
496     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
497     char *soundBell;
498     char *soundIcsAlarm;
499     char *soundIcsWin;
500     char *soundIcsLoss;
501     char *soundIcsDraw;
502     char *soundIcsUnfinished;
503     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
504     Boolean reuseFirst;
505     Boolean reuseSecond;
506     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
507     Boolean animate;    /* If True, animate non-mouse moves */
508     int animSpeed;      /* Delay in milliseconds between animation frames */
509     Boolean popupMoveErrors;
510     Boolean popupExitMessage;
511     int showJail;
512     Boolean highlightLastMove;
513     Boolean highlightDragging;
514     Boolean blindfold;          /* if true, no pieces are drawn */
515     Boolean premove;            /* true if premove feature enabled */ 
516     Boolean premoveWhite;       /* true if premoving White first move  */ 
517     char *premoveWhiteText;     /* text of White premove 1 */ 
518     Boolean premoveBlack;       /* true if premoving Black first move */ 
519     char *premoveBlackText;     /* text of Black premove 1 */ 
520     Boolean icsAlarm;           /* true if sounding alarm at a certain time */  
521     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
522     Boolean autoRaiseBoard;
523     int fontSizeTolerance; /* xboard only */
524     char *initialMode;
525     char *variant;
526     char *chatBoxes;
527     int firstProtocolVersion;
528     int secondProtocolVersion;
529     Boolean showButtonBar;
530     Boolean icsEngineAnalyze; 
531     Boolean variations;         /* [HGM] enable variation-tree walking */
532
533     /* [AS] New properties (down to the "ZIPPY" part) */
534     Boolean firstScoreIsAbsolute;  /* If true, engine score is always from white side */
535     Boolean secondScoreIsAbsolute; /* If true, engine score is always from white side */
536     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
537     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
538     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
539     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
540     int liteBackTextureMode;
541     int darkBackTextureMode;
542     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
543     char * fontToPieceTable; /* Map to translate font character to chess pieces */
544     int fontBackColorWhite;
545     int fontForeColorWhite;
546     int fontBackColorBlack;
547     int fontForeColorBlack;
548     int fontPieceSize; /* Size of font relative to square (percentage) */
549     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
550     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
551     int delayBeforeQuit;
552     int delayAfterQuit;
553     char * nameOfDebugFile;
554     char * pgnEventHeader;
555     int defaultFrcPosition;
556     char * gameListTags;
557     Boolean saveOutOfBookInfo;
558     Boolean showEvalInMoveHistory;
559     int evalHistColorWhite;
560     int evalHistColorBlack;
561     Boolean highlightMoveWithArrow;
562     int highlightArrowColor;
563     Boolean useStickyWindows;
564     Boolean bgObserve;   /* [HGM] bughouse */
565     Boolean dualBoard;   /* [HGM] dual     */
566     int adjudicateDrawMoves;
567     Boolean autoDisplayComment;
568     Boolean autoDisplayTags;
569     Boolean firstIsUCI;
570     Boolean secondIsUCI;
571     Boolean firstHasOwnBookUCI;
572     Boolean secondHasOwnBookUCI;
573     char * adapterCommand;
574     char * polyglotDir;
575     Boolean usePolyglotBook;
576     char * polyglotBook;
577     int bookDepth;
578     int bookStrength;
579     int defaultHashSize;
580     int defaultCacheSizeEGTB;
581     char * defaultPathEGTB;
582     int defaultMatchGames;
583
584     /* [HGM] Board size */
585     int NrFiles;
586     int NrRanks;
587     int holdingsSize;
588     int matchPause;
589     char * pieceToCharTable;
590     char * pieceNickNames;
591     char * colorNickNames;
592     Boolean allWhite;
593     Boolean upsideDown;
594     Boolean alphaRank;
595     Boolean testClaims;
596     Boolean checkMates;
597     Boolean materialDraws;
598     Boolean trivialDraws;
599     int ruleMoves;
600     int drawRepeats;
601
602 #if ZIPPY
603     char *zippyLines;
604     char *zippyPinhead;
605     char *zippyPassword;
606     char *zippyPassword2;
607     char *zippyWrongPassword;
608     char *zippyAcceptOnly;
609     int zippyUseI;
610     int zippyBughouse;
611     int zippyNoplayCrafty;
612     char *zippyGameEnd;
613     char *zippyGameStart;
614     int zippyAdjourn;
615     int zippyAbort;
616     char *zippyVariants;
617     int zippyMaxGames;
618     int zippyReplayTimeout; /*seconds*/
619     int zippyShortGame; /* [HGM] aborter   */
620 #endif
621     Boolean lowTimeWarning; /* [HGM] low time */
622     char *lowTimeWarningColor;
623
624     char *serverMovesName;
625     Boolean suppressLoadMoves;
626     int serverPause;
627     int firstTimeOdds;
628     int secondTimeOdds;
629     int timeOddsMode;
630     int firstAccumulateTC;
631     int secondAccumulateTC;
632     int firstNPS;
633     int secondNPS;
634     Boolean autoKibitz;
635     int engineComments;
636     char *userName;
637     int rewindIndex;    /* [HGM] autoinc   */
638     int sameColorGames; /* [HGM] alternate */
639     int smpCores;       /* [HGM] SMP       */
640     char *egtFormats;
641     int niceEngines;    /* [HGM] nice      */
642     char *firstLogo;    /* [HGM] logo      */
643     char *secondLogo;
644     Boolean autoLogo;
645     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
646     char *firstOptions; /* [HGM] options   */
647     char *secondOptions;
648     char *fenOverride1;
649     char *fenOverride2;
650     Boolean keepAlive;  /* [HGM] alive     */
651     Boolean forceIllegal;/*[HGM] illegal   */
652     Boolean noJoin;     /* [HGM] join      */
653     char *wrapContSeq; /* continuation sequence when xboard wraps text */
654     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
655     Boolean pasteSelection; /* paste X selection instead of clipboard */
656     int nrVariations;   /* [HGM] multivar  */
657     Boolean dropMenu;   /* [HGM] pv        */
658     Boolean markers;    /* [HGM] markers   */
659     Boolean pieceMenu;
660     Boolean sweepSelect;
661 } AppData, *AppDataPtr;
662
663 /*  PGN tags (for showing in the game list) */
664 #define LPUSERGLT_SIZE      64
665
666 #define GLT_EVENT           'e'
667 #define GLT_SITE            's'
668 #define GLT_DATE            'd'
669 #define GLT_ROUND           'o'
670 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
671 #define GLT_RESULT          'r'
672 #define GLT_WHITE_ELO       'w'
673 #define GLT_BLACK_ELO       'b'
674 #define GLT_TIME_CONTROL    't'
675 #define GLT_VARIANT         'v'
676 #define GLT_OUT_OF_BOOK     'a'
677 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
678
679 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
680
681 #define GLT_ALL_TAGS        "esdoprwbtvac"
682
683 #define PGN_OUT_OF_BOOK     "Annotator"
684
685 extern AppData appData;
686
687 typedef struct {
688     /* PGN 7-tag info */
689     char *event;
690     char *site;
691     char *date;
692     char *round;
693     char *white;
694     char *black;
695     ChessMove result;
696     /* Additional info */
697     char *fen;          /* NULL or FEN for starting position; input only */
698     char *resultDetails;
699     char *timeControl;
700     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
701     int whiteRating;    /* -1 if unknown */
702     int blackRating;    /* -1 if unknown */
703     VariantClass variant;
704     char *outOfBook;    /* [AS] Move and score when engine went out of book */
705     int boardWidth;     /* [HGM] adjustable board size */
706     int boardHeight;
707 /* [HGM] For Shogi and Crazyhouse: */
708     int holdingsSize;  /* number of different piece types in holdings       */
709     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
710 } GameInfo;
711
712 /* [AS] Search stats from chessprogram, for the played move */
713 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
714 typedef struct {
715     int score;  /* Centipawns */
716     int depth;  /* Plies */
717     int time;   /* Milliseconds */
718 } ChessProgramStats_Move;
719
720 /* [AS] Layout management */
721 typedef struct {
722     Boolean visible;
723     int x;
724     int y;
725     int width;
726     int height;
727 } WindowPlacement;
728
729 extern WindowPlacement wpEngineOutput;
730 extern WindowPlacement wpEvalGraph;
731 extern WindowPlacement wpMoveHistory;
732 extern WindowPlacement wpGameList;
733 extern WindowPlacement wpTags;
734
735 // [HGM] chat   
736 #define MAX_CHAT 5
737 extern int chatCount;
738 extern char chatPartner[MAX_CHAT][MSG_SIZ];
739
740
741 #endif
742