791e5e5086472220217fdb64184a0fdf77f11e71
[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 #define ENGINES 2
373
374 typedef struct {
375     char *language;
376 #if !defined(_amigados)
377     char *whitePieceColor;
378     char *blackPieceColor;
379     char *lightSquareColor;
380     char *darkSquareColor;
381     char *jailSquareColor;
382     char *highlightSquareColor;
383     char *premoveHighlightColor;
384 #else
385     int whitePieceColor;
386     int blackPieceColor;
387     int lightSquareColor;
388     int darkSquareColor;
389     int jailSquareColor;
390     int highlightSquareColor;
391     int premoveHighlightColor;
392 #endif
393     int movesPerSession;
394     float timeIncrement;
395     char *engInitString[ENGINES];
396     char *computerString[ENGINES];
397     char *chessProgram[ENGINES];
398     char *directory[ENGINES];
399     Boolean firstPlaysBlack;
400     Boolean noChessProgram;
401     char *host[ENGINES];
402     char *bitmapDirectory;
403     char *soundDirectory;
404     char *remoteShell;
405     char *remoteUser;
406     float timeDelay;
407     char *timeControl;
408     Boolean icsActive;
409     char *icsHost;
410     char *icsPort;
411     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
412     char *icsLogon;     /* Hack to permit variable logon scripts. */
413     char *icsHelper;
414     Boolean icsInputBox;
415     Boolean useTelnet;
416     Boolean seekGraph;
417     Boolean autoRefresh;
418     char *telnetProgram;
419     char *gateway;
420     char *loadGameFile;
421     int loadGameIndex;      /* game # within file */
422     char *saveGameFile;
423     Boolean autoSaveGames;
424     char *loadPositionFile;
425     int loadPositionIndex;  /* position # within file */
426     char *savePositionFile;
427     Boolean matchMode;
428     int matchGames;
429     Boolean monoMode;
430     Boolean debugMode;
431     Boolean clockMode;
432     char *boardSize;
433     Boolean Iconic;
434     char *searchTime;
435     int searchDepth;
436     Boolean showCoords;
437     char *clockFont;
438     char *messageFont; /* WinBoard only */
439     char *coordFont;
440     char *font; /* xboard only: all other fonts */
441     char *tagsFont; /* WinBoard only */
442     char *commentFont; /* WinBoard only */
443     char *icsFont; /* WinBoard only */
444     Boolean ringBellAfterMoves;
445     Boolean autoCallFlag;
446     Boolean flipView;
447     Boolean autoFlipView;
448     char *cmailGameName; /* xboard only */
449     Boolean alwaysPromoteToQueen;
450     Boolean oldSaveStyle;
451     Boolean oneClick;
452     Boolean quietPlay;
453     Boolean showThinking;
454     Boolean ponderNextMove;
455     Boolean periodicUpdates;
456     Boolean autoObserve;
457     Boolean autoComment;
458     Boolean getMoveList;
459     Boolean testLegality;
460     int borderXoffset; /* xboard only */
461     int borderYoffset; /* xboard only */
462     Boolean titleInWindow; /* xboard only */
463     Boolean localLineEditing; /* WinBoard only */
464     Boolean zippyTalk;
465     Boolean zippyPlay;
466     int flashCount; /* Number of times to flash (xboard only) */
467     int flashRate; /* Flashes per second (xboard only)  */
468     char *pixmapDirectory; /* Path to XPM/XIM files to use (xboard only) */
469     int msLoginDelay;  /* Delay per character (in msec) while sending
470                           ICS logon script (xboard only) */
471     Boolean colorize;   /* If True, use the following colors to color text */
472     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
473     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
474     char *colorSShout;
475     char *colorChannel1;
476     char *colorChannel;
477     char *colorKibitz;
478     char *colorTell;
479     char *colorChallenge;
480     char *colorRequest;
481     char *colorSeek;
482     char *colorNormal;
483     char *soundProgram; /* sound-playing program */
484     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
485     char *soundSShout;
486     char *soundChannel1;
487     char *soundChannel;
488     char *soundKibitz;
489     char *soundTell;
490     char *soundChallenge;
491     char *soundRequest;
492     char *soundSeek;
493     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
494     char *soundBell;
495     char *soundIcsAlarm;
496     char *soundIcsWin;
497     char *soundIcsLoss;
498     char *soundIcsDraw;
499     char *soundIcsUnfinished;
500     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
501     Boolean reuse[ENGINES];
502     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
503     Boolean animate;    /* If True, animate non-mouse moves */
504     int animSpeed;      /* Delay in milliseconds between animation frames */
505     Boolean popupMoveErrors;
506     Boolean popupExitMessage;
507     int showJail;
508     Boolean highlightLastMove;
509     Boolean highlightDragging;
510     Boolean blindfold;          /* if true, no pieces are drawn */
511     Boolean premove;            /* true if premove feature enabled */ 
512     Boolean premoveWhite;       /* true if premoving White first move  */ 
513     char *premoveWhiteText;     /* text of White premove 1 */ 
514     Boolean premoveBlack;       /* true if premoving Black first move */ 
515     char *premoveBlackText;     /* text of Black premove 1 */ 
516     Boolean icsAlarm;           /* true if sounding alarm at a certain time */  
517     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
518     Boolean autoRaiseBoard;
519     int fontSizeTolerance; /* xboard only */
520     char *initialMode;
521     char *variant;
522     char *chatBoxes;
523     int protocolVersion[ENGINES];
524     Boolean showButtonBar;
525     Boolean icsEngineAnalyze; 
526     Boolean variations;         /* [HGM] enable variation-tree walking */
527
528     /* [AS] New properties (down to the "ZIPPY" part) */
529     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
530     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
531     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
532     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
533     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
534     int liteBackTextureMode;
535     int darkBackTextureMode;
536     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
537     char * fontToPieceTable; /* Map to translate font character to chess pieces */
538     int fontBackColorWhite;
539     int fontForeColorWhite;
540     int fontBackColorBlack;
541     int fontForeColorBlack;
542     int fontPieceSize; /* Size of font relative to square (percentage) */
543     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
544     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
545     int delayBeforeQuit;
546     int delayAfterQuit;
547     char * nameOfDebugFile;
548     char * pgnEventHeader;
549     int defaultFrcPosition;
550     char * gameListTags;
551     Boolean saveOutOfBookInfo;
552     Boolean showEvalInMoveHistory;
553     int evalHistColorWhite;
554     int evalHistColorBlack;
555     Boolean highlightMoveWithArrow;
556     int highlightArrowColor;
557     Boolean useStickyWindows;
558     Boolean bgObserve;   /* [HGM] bughouse */
559     Boolean dualBoard;   /* [HGM] dual     */
560     int adjudicateDrawMoves;
561     Boolean autoDisplayComment;
562     Boolean autoDisplayTags;
563     Boolean isUCI[ENGINES];
564     Boolean hasOwnBookUCI[ENGINES];
565     char * adapterCommand;
566     char * polyglotDir;
567     Boolean usePolyglotBook;
568     char * polyglotBook;
569     int bookDepth;
570     int bookStrength;
571     int defaultHashSize;
572     int defaultCacheSizeEGTB;
573     char * defaultPathEGTB;
574     int defaultMatchGames;
575
576     /* [HGM] Board size */
577     int NrFiles;
578     int NrRanks;
579     int holdingsSize;
580     int matchPause;
581     char * pieceToCharTable;
582     char * pieceNickNames;
583     char * colorNickNames;
584     Boolean allWhite;
585     Boolean upsideDown;
586     Boolean alphaRank;
587     Boolean testClaims;
588     Boolean checkMates;
589     Boolean materialDraws;
590     Boolean trivialDraws;
591     int ruleMoves;
592     int drawRepeats;
593
594 #if ZIPPY
595     char *zippyLines;
596     char *zippyPinhead;
597     char *zippyPassword;
598     char *zippyPassword2;
599     char *zippyWrongPassword;
600     char *zippyAcceptOnly;
601     int zippyUseI;
602     int zippyBughouse;
603     int zippyNoplayCrafty;
604     char *zippyGameEnd;
605     char *zippyGameStart;
606     int zippyAdjourn;
607     int zippyAbort;
608     char *zippyVariants;
609     int zippyMaxGames;
610     int zippyReplayTimeout; /*seconds*/
611     int zippyShortGame; /* [HGM] aborter   */
612 #endif
613     Boolean lowTimeWarning; /* [HGM] low time */
614     char *lowTimeWarningColor;
615
616     char *serverMovesName;
617     Boolean suppressLoadMoves;
618     int serverPause;
619     int timeOdds[ENGINES];
620     int timeOddsMode;
621     int accumulateTC[ENGINES];
622     int NPS[ENGINES];
623     Boolean autoKibitz;
624     int engineComments;
625     char *userName;
626     int rewindIndex;    /* [HGM] autoinc   */
627     int sameColorGames; /* [HGM] alternate */
628     int smpCores;       /* [HGM] SMP       */
629     char *egtFormats;
630     int niceEngines;    /* [HGM] nice      */
631     char *logo[ENGINES];/* [HGM] logo      */
632     Boolean autoLogo;
633     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
634     char *engOptions[ENGINES]; /* [HGM] options   */
635     char *fenOverride[ENGINES];
636     Boolean keepAlive;  /* [HGM] alive     */
637     Boolean forceIllegal;/*[HGM] illegal   */
638     Boolean noJoin;     /* [HGM] join      */
639     char *wrapContSeq; /* continuation sequence when xboard wraps text */
640     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
641     Boolean pasteSelection; /* paste X selection instead of clipboard */
642     int nrVariations;   /* [HGM] multivar  */
643     Boolean dropMenu;   /* [HGM] pv        */
644     Boolean markers;    /* [HGM] markers   */
645     Boolean pieceMenu;
646     Boolean sweepSelect;
647
648     char *tourneyFile;
649     char *processes;
650     char *results;
651     char *participants;
652     int tourneyType;
653     int tourneyCycles;
654     Boolean roundSync;
655     Boolean cycleSync;
656 } AppData, *AppDataPtr;
657
658 /*  PGN tags (for showing in the game list) */
659 #define LPUSERGLT_SIZE      64
660
661 #define GLT_EVENT           'e'
662 #define GLT_SITE            's'
663 #define GLT_DATE            'd'
664 #define GLT_ROUND           'o'
665 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
666 #define GLT_RESULT          'r'
667 #define GLT_WHITE_ELO       'w'
668 #define GLT_BLACK_ELO       'b'
669 #define GLT_TIME_CONTROL    't'
670 #define GLT_VARIANT         'v'
671 #define GLT_OUT_OF_BOOK     'a'
672 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
673
674 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
675
676 #define GLT_ALL_TAGS        "esdoprwbtvac"
677
678 #define PGN_OUT_OF_BOOK     "Annotator"
679
680 extern AppData appData;
681
682 typedef struct {
683     /* PGN 7-tag info */
684     char *event;
685     char *site;
686     char *date;
687     char *round;
688     char *white;
689     char *black;
690     ChessMove result;
691     /* Additional info */
692     char *fen;          /* NULL or FEN for starting position; input only */
693     char *resultDetails;
694     char *timeControl;
695     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
696     int whiteRating;    /* -1 if unknown */
697     int blackRating;    /* -1 if unknown */
698     VariantClass variant;
699     char *outOfBook;    /* [AS] Move and score when engine went out of book */
700     int boardWidth;     /* [HGM] adjustable board size */
701     int boardHeight;
702 /* [HGM] For Shogi and Crazyhouse: */
703     int holdingsSize;  /* number of different piece types in holdings       */
704     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
705 } GameInfo;
706
707 /* [AS] Search stats from chessprogram, for the played move */
708 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
709 typedef struct {
710     int score;  /* Centipawns */
711     int depth;  /* Plies */
712     int time;   /* Milliseconds */
713 } ChessProgramStats_Move;
714
715 /* [AS] Layout management */
716 typedef struct {
717     Boolean visible;
718     int x;
719     int y;
720     int width;
721     int height;
722 } WindowPlacement;
723
724 extern WindowPlacement wpEngineOutput;
725 extern WindowPlacement wpEvalGraph;
726 extern WindowPlacement wpMoveHistory;
727 extern WindowPlacement wpGameList;
728 extern WindowPlacement wpTags;
729
730 // [HGM] chat   
731 #define MAX_CHAT 5
732 extern int chatCount;
733 extern char chatPartner[MAX_CHAT][MSG_SIZ];
734
735 // [HGM] generally useful macros; there are way too many memory leaks...
736 #define FREE(x) if(x) free(x)
737 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
738
739 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
740 //       in due time we would have to make the actual substitutions all through the source
741
742 #define firstInitString       engInitString[0]
743 #define secondInitString      engInitString[1]
744 #define firstComputerString   computerString[0]
745 #define secondComputerString  computerString[1]
746 #define firstChessProgram     chessProgram[0]
747 #define secondChessProgram    chessProgram[1]
748 #define firstDirectory        directory[0]
749 #define secondDirectory       directory[1]
750 #define firstProtocolVersion  protocolVersion[0]
751 #define secondProtocolVersion protocolVersion[1]
752 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
753 #define secondScoreIsAbsolute scoreIsAbsolute[1]
754 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
755 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
756 #define firstTimeOdds         timeOdds[0]
757 #define secondTimeOdds        timeOdds[1]
758 #define firstAccumulateTC     accumulateTC[0]
759 #define secondAccumulateTC    accumulateTC[1]
760 #define firstHost    host[0]
761 #define secondHost   host[1]
762 #define reuseFirst   reuse[0]
763 #define reuseSecond  reuse[1]
764 #define firstIsUCI   isUCI[0]
765 #define secondIsUCI  isUCI[1]
766 #define firstNPS     NPS[0]
767 #define secondNPS    NPS[1]
768 #define firstLogo    logo[0]
769 #define secondLogo   logo[1]
770 #define fenOverride1 fenOverride[0]
771 #define fenOverride2 fenOverride[1]
772 #define firstOptions      engOptions[0]
773 #define secondOptions     engOptions[1]
774
775 #endif
776