Try also /home/<user>/.logo.pgn for user logo
[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, 2012, 2013, 2014 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 XB_COMMON
55 #define XB_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 #ifdef X11
85 #include <X11/Intrinsic.h>
86 #else
87 typedef char Boolean;
88 typedef char *String;
89 #define True 1
90 #define False 0
91 #endif
92 #endif
93 #endif
94
95
96 #ifndef TRUE
97 #define TRUE 1
98 #define FALSE 0
99 #endif
100
101 #define UNKNOWN -1 /* [HGM] nps */
102
103 #if !HAVE_RANDOM
104 # if HAVE_RAND48
105 #  define srandom srand48
106 #  define random lrand48
107 # else /* not HAVE_RAND48 */
108 #  define srandom srand
109 #  define random rand
110 # endif /* not HAVE_RAND48 */
111 #endif /* !HAVE_RANDOM */
112
113 /* End compatibility grunge */
114
115 /* unsigned int 64 for engine nodes work and display */
116 #ifdef WIN32
117        /* I don't know the name for this type of other compiler
118         * If it not work, just modify here
119         * This is for MS Visual Studio
120         */
121        #ifdef _MSC_VER
122                #define u64 unsigned __int64
123                #define s64 signed __int64
124                #define u64Display "%I64u"
125                #define s64Display "%I64d"
126                #define u64Const(c) (c ## UI64)
127                #define s64Const(c) (c ## I64)
128        #else
129                /* place holder
130                 * or dummy types for other compiler
131                 * [HGM] seems that -mno-cygwin comple needs %I64?
132                 */
133                #define u64 unsigned long long
134                #define s64 signed long long
135                #ifdef USE_I64
136                   #define u64Display "%I64u"
137                   #define s64Display "%I64d"
138                #else
139                   #define u64Display "%llu"
140                   #define s64Display "%lld"
141                #endif
142                #define u64Const(c) (c ## ULL)
143                #define s64Const(c) (c ## LL)
144        #endif
145 #else
146        /* GNU gcc */
147        #define u64 unsigned long long
148        #define s64 signed long long
149        #define u64Display "%llu"
150        #define s64Display "%lld"
151        #define u64Const(c) (c ## ull)
152        #define s64Const(c) (c ## ll)
153 #endif
154
155 #define PROTOVER                2       /* engine protocol version */
156
157 // [HGM] license: Messages that engines must print to satisfy their license requirements for patented variants
158 #define GOTHIC "Gothic Chess (see www.GothicChess.com) is licensed under U.S. Patent #6,481,716 by Ed Trice"
159 #define FALCON "Falcon Chess (see www.chessvariants.com) is licensed under U.S. Patent #5,690,334 by George W. Duke"
160
161 /* [HGM] Some notes about board sizes:
162    In games that allow piece drops, the holdings are considered part of the
163    board, in the leftmost and rightmost two files. This way they are
164    automatically part of the game-history states, and enjoy all display
165    functions (including drag-drop and click-click moves to the regular part
166    of the board). The drawback of this is that the internal numbering of
167    files starts at 2 for the a-file if holdings are displayed. To ensure
168    consistency, this shifted numbering system is used _everywhere_ in the
169    code, and conversion to the 'normal' system only takes place when the
170    file number is converted to or from ASCII (by redefining the character
171    constant 'a'). This works because Winboard only communicates with the
172    outside world in ASCII. In a similar way, the different rank numbering
173    systems (starting at rank 0 or 1) are implemented by redefining '1'.
174 */
175 #define BOARD_RANKS             17            /* [HGM] for in declarations  */
176 #define BOARD_FILES             16             /* [HGM] for in declarations  */
177 #define BOARD_HEIGHT (gameInfo.boardHeight)    /* [HGM] made user adjustable */
178 #define BOARD_WIDTH  (gameInfo.boardWidth + 2*gameInfo.holdingsWidth)
179 #define BOARD_LEFT   (gameInfo.holdingsWidth)  /* [HGM] play-board edges     */
180 #define BOARD_RGHT   (gameInfo.boardWidth + gameInfo.holdingsWidth)
181 #define CASTLING     (BOARD_RANKS-1)           /* [HGM] hide in upper rank   */
182 #define VIRGIN       (BOARD_RANKS-2)           /* [HGM] pieces not moved     */
183 #define TOUCHED_W    CASTLING][(BOARD_FILES-6) /* [HGM] in upper rank        */
184 #define TOUCHED_B    CASTLING][(BOARD_FILES-5) /* [HGM] in upper rank        */
185 #define EP_RANK      CASTLING][(BOARD_FILES-4) /* [HGM] in upper rank        */
186 #define EP_FILE      CASTLING][(BOARD_FILES-3) /* [HGM] in upper rank        */
187 #define EP_STATUS    CASTLING][(BOARD_FILES-2) /* [HGM] in upper rank        */
188 #define HOLDINGS_SET CASTLING][(BOARD_FILES-1) /* [HGM] in upper-right corner*/
189 #define ONE          ('1'-(BOARD_HEIGHT==10))  /* [HGM] foremost board rank  */
190 #define AAA          ('a'-BOARD_LEFT)          /* [HGM] leftmost board file  */
191 #define VIRGIN_W                 1             /* [HGM] flags in Board[VIRGIN][X] */
192 #define VIRGIN_B                 2
193 #define DROP_RANK               -3
194 #define MAX_MOVES               1000
195 #define MSG_SIZ                 512
196 #define DIALOG_SIZE             256
197 #define STAR_MATCH_N            16
198 #define MOVE_LEN                32
199 #define TIME_CONTROL            "5"     /* in minutes */
200 #define TIME_DELAY_QUOTE        "1.0"   /* seconds between moves */
201 #define TIME_DELAY              ((float) 1.0)
202 #define MOVES_PER_SESSION       40      /* moves per TIME_CONTROL */
203 #define TIME_INCREMENT          -1      /* if >= 0, MOVES_PER_SESSION unused */
204 #define WhiteOnMove(move)       (((move) % 2) == 0)
205 #define ICS_HOST                "chessclub.com"
206 #define ICS_PORT                "5000"
207 #define ICS_COMM_PORT           ""
208 #define FIRST_HOST              "localhost"
209 #define SECOND_HOST             "localhost"
210 #define TELNET_PROGRAM          "telnet"
211 #define DEF_BITMAP_DIR          BITMAPDIR
212 #define MATCH_MODE              "False"
213 #define INIT_STRING             "new\nrandom\n"
214 #define WHITE_STRING            "white\ngo\n"
215 #define BLACK_STRING            "black\ngo\n"
216 #define COMPUTER_STRING         "computer\n"
217 #define REUSE_CHESS_PROGRAMS    1
218 #define WHITE_PIECE_COLOR       "#FFFFCC"
219 #define BLACK_PIECE_COLOR       "#202020"
220 #define LIGHT_SQUARE_COLOR      "#C8C365"
221 #define DARK_SQUARE_COLOR       "#77A26D"
222 #define JAIL_SQUARE_COLOR       "#808080"
223 #define HIGHLIGHT_SQUARE_COLOR  "#FFFF00"
224 #define PREMOVE_HIGHLIGHT_COLOR "#FF0000"
225 #define LOWTIMEWARNING_COLOR    "#FF0000"
226 #define BELLCHAR                '\007'
227 #define NULLCHAR                '\000'
228 #define FEATURE_TIMEOUT         10000 /*ms*/
229
230 #define CLOCK_FONT 0
231 #define MESSAGE_FONT 1
232 #define COORD_FONT 2
233 #define CONSOLE_FONT 3
234 #define COMMENT_FONT 4
235 #define EDITTAGS_FONT 5
236 #define MOVEHISTORY_FONT 6
237 #define GAMELIST_FONT 7
238 #define NUM_FONTS 8
239
240 /* Default to no flashing (the "usual" XBoard behavior) */
241 #define FLASH_COUNT     0               /* Number of times to flash */
242 #define FLASH_RATE      5               /* Flashes per second */
243
244 /* Default delay per character (in msec) while sending login script */
245 #define MS_LOGIN_DELAY  0
246
247 /* [AS] Support for background textures */
248 #define BACK_TEXTURE_MODE_DISABLED      0
249 #define BACK_TEXTURE_MODE_PLAIN         1
250 #define BACK_TEXTURE_MODE_FULL_RANDOM   2
251
252 /* Zippy defaults */
253 #define ZIPPY_TALK FALSE
254 #define ZIPPY_PLAY FALSE
255 #define ZIPPY_LINES "yow.lines"
256 #define ZIPPY_PINHEAD ""
257 #define ZIPPY_PASSWORD ""
258 #define ZIPPY_PASSWORD2 ""
259 #define ZIPPY_WRONG_PASSWORD ""
260 #define ZIPPY_ACCEPT_ONLY ""
261 #define ZIPPY_USE_I TRUE
262 #define ZIPPY_BUGHOUSE 0
263 #define ZIPPY_NOPLAY_CRAFTY FALSE
264 #define ZIPPY_GAME_END "gameend\n"
265 #define ZIPPY_GAME_START ""
266 #define ZIPPY_ADJOURN FALSE
267 #define ZIPPY_ABORT FALSE
268 #define ZIPPY_VARIANTS "normal,fischerandom,crazyhouse,losers,suicide,3checks,twokings,bughouse,shatranj"
269 #define ZIPPY_MAX_GAMES 0
270 #define ZIPPY_REPLAY_TIMEOUT 120
271
272 typedef VOIDSTAR ProcRef;
273 #define NoProc ((ProcRef) 0)
274 typedef VOIDSTAR InputSourceRef;
275
276 typedef void (*DelayedEventCallback) P((void));
277
278 typedef enum { Press, Release } ClickType;
279
280 typedef enum {
281     BeginningOfGame, MachinePlaysWhite, MachinePlaysBlack,
282     AnalyzeMode, AnalyzeFile, TwoMachinesPlay,
283     EditGame, PlayFromGameFile, EndOfGame, EditPosition, Training,
284     IcsIdle, IcsPlayingWhite, IcsPlayingBlack, IcsObserving,
285     IcsExamining
286   } GameMode;
287
288 typedef enum {
289     /* [HGM] the order here is crucial for Crazyhouse & Shogi: */
290     /* only the first N pieces can go into the holdings, and   */
291     /* promotions in those variants shift P-W to U-S           */
292     WhitePawn, WhiteKnight, WhiteBishop, WhiteRook, WhiteQueen,
293     WhiteFerz, WhiteAlfil, WhiteAngel, WhiteMarshall, WhiteWazir, WhiteMan,
294     WhiteCannon, WhiteNightrider, WhiteCardinal, WhiteDragon, WhiteGrasshopper,
295     WhiteSilver, WhiteFalcon, WhiteLance, WhiteCobra, WhiteUnicorn, WhiteLion,
296     WhiteTokin, WhiteDagger, WhitePCardinal, WhitePDragon, WhiteCat,
297     WhitePSword, WhiteMonarch, WhiteMother, WhiteNothing, WhitePRook, WhitePDagger,
298     WhiteDolphin, WhiteStag, WhiteHorned, WhiteEagle, WhiteSword,
299     WhiteCrown, WhiteHCrown, WhiteHorse, WhiteDrunk, WhitePBishop, WhiteKing,
300     BlackPawn, BlackKnight, BlackBishop, BlackRook, BlackQueen,
301     BlackFerz, BlackAlfil, BlackAngel, BlackMarshall, BlackWazir, BlackMan,
302     BlackCannon, BlackNightrider, BlackCardinal, BlackDragon, BlackGrasshopper,
303     BlackSilver, BlackFalcon, BlackLance, BlackCobra, BlackUnicorn, BlackLion,
304     BlackTokin, BlackDagger, BlackPCardinal, BlackPDragon, BlackCat,
305     BlackPSword, BlackMonarch, BlackMother, BlackNothing, BlackPRook, BlackPDagger,
306     BlackDolphin, BlackStag, BlackHorned, BlackEagle, BlackSword,
307     BlackCrown, BlackHCrown, BlackHorse, BlackDrunk, BlackPBishop, BlackKing,
308     EmptySquare, DarkSquare,
309     NoRights, // [HGM] gamestate: for castling rights hidden in board[CASTLING]
310     ClearBoard, WhitePlay, BlackPlay, PromotePiece, DemotePiece /*for use on EditPosition menus*/
311   } ChessSquare;
312
313 /* [HGM] some macros that can be used as prefixes to convert piece types */
314 #define WHITE_TO_BLACK (int)BlackPawn - (int)WhitePawn + (int)
315 #define BLACK_TO_WHITE (int)WhitePawn - (int)BlackPawn + (int)
316 #define PROMOTED       (int)WhiteDragon - (int)WhiteRook + (int)
317 #define DEMOTED        (int)WhiteRook - (int)WhiteDragon + (int)
318 #define SHOGI          (int)EmptySquare + (int)
319 #define CHUPROMOTED    ((int)WhitePDragon - (int)WhiteDragon)*(gameInfo.variant == VariantChu) + PROMOTED
320 #define CHUDEMOTED     ((int)WhiteDragon - (int)WhitePDragon)*(gameInfo.variant == VariantChu) + DEMOTED
321 #define IS_SHOGI(V)    ((V) == VariantShogi || (V) == VariantChu)
322 #define IS_LION(V)     ((V) == WhiteLion || (V) == BlackLion)
323
324
325 typedef ChessSquare Board[BOARD_RANKS][BOARD_FILES];
326
327 typedef enum {
328     EndOfFile = 0,
329     WhiteKingSideCastle, WhiteQueenSideCastle,
330     WhiteKingSideCastleWild, WhiteQueenSideCastleWild,
331     WhiteHSideCastleFR, WhiteASideCastleFR,
332     BlackKingSideCastle, BlackQueenSideCastle,
333     BlackKingSideCastleWild, BlackQueenSideCastleWild,
334     BlackHSideCastleFR, BlackASideCastleFR,
335     WhitePromotion, WhiteNonPromotion,
336     BlackPromotion, BlackNonPromotion,
337     WhiteCapturesEnPassant, BlackCapturesEnPassant,
338     WhiteDrop, BlackDrop, FirstLeg,
339     NormalMove, AmbiguousMove, IllegalMove, ImpossibleMove,
340     WhiteWins, BlackWins, GameIsDrawn, GameUnfinished,
341     GNUChessGame, XBoardGame, MoveNumberOne, Open, Close, Nothing,
342     Comment, PositionDiagram, ElapsedTime, PGNTag, NAG
343   } ChessMove;
344
345 typedef enum {
346     ColorShout, ColorSShout, ColorChannel1, ColorChannel, ColorKibitz,
347     ColorTell, ColorChallenge, ColorRequest, ColorSeek, ColorNormal,
348     ColorNone, NColorClasses
349 } ColorClass;
350
351 typedef enum {
352     SoundMove, SoundBell, SoundRoar, SoundAlarm, SoundIcsWin, SoundIcsLoss,
353     SoundIcsDraw, SoundIcsUnfinished, NSoundClasses
354 } SoundClass;
355
356 /* Names for chess variants, not necessarily supported */
357 typedef enum {
358     VariantNormal,       /* Normal chess */
359     VariantLoadable,     /* "loadgame" command allowed (not really a variant)*/
360     VariantWildCastle,   /* Shuffle chess where king can castle from d file */
361     VariantNoCastle,     /* Shuffle chess with no castling at all */
362     VariantFischeRandom, /* FischeRandom */
363     VariantBughouse,     /* Bughouse, ICC/FICS rules */
364     VariantCrazyhouse,   /* Crazyhouse, ICC/FICS rules */
365     VariantLosers,       /* Try to lose all pieces or get mated (ICC wild 17)*/
366     VariantSuicide,      /* Try to lose all pieces incl. king (FICS) */
367     VariantGiveaway,     /* Try to have no legal moves left (ICC wild 26) */
368     VariantTwoKings,     /* Weird ICC wild 9 */
369     VariantKriegspiel,   /* Kriegspiel; pawns can capture invisible pieces */
370     VariantAtomic,       /* Capturing piece explodes (ICC wild 27) */
371     Variant3Check,       /* Win by giving check 3 times (ICC wild 25) */
372     VariantShatranj,     /* Unsupported (ICC wild 28) */
373     Variant29,           /* Temporary name for possible future ICC wild 29 */
374     Variant30,           /* Temporary name for possible future ICC wild 30 */
375     Variant31,           /* Temporary name for possible future ICC wild 31 */
376     Variant32,           /* Temporary name for possible future ICC wild 32 */
377     Variant33,           /* Temporary name for possible future ICC wild 33 */
378     Variant34,           /* Temporary name for possible future ICC wild 34 */
379     Variant35,           /* Temporary name for possible future ICC wild 35 */
380     Variant36,           /* Temporary name for possible future ICC wild 36 */
381     VariantShogi,        /* [HGM] added variants */
382     VariantChu,
383     VariantCourier,
384     VariantGothic,
385     VariantCapablanca,
386     VariantKnightmate,
387     VariantFairy,
388     VariantCylinder,
389     VariantFalcon,
390     VariantCapaRandom,
391     VariantBerolina,
392     VariantJanus,
393     VariantSuper,
394     VariantGreat,
395     VariantTwilight,
396     VariantMakruk,
397     VariantSChess,
398     VariantGrand,
399     VariantSpartan,
400     VariantXiangqi,
401     VariantASEAN,
402     VariantLion,
403     VariantChuChess,
404     VariantUnknown       /* Catchall for other unknown variants */
405 } VariantClass;
406
407 #define VARIANT_NAMES { \
408   "normal", \
409   "normal", \
410   "wildcastle", \
411   "nocastle", \
412   "fischerandom", \
413   "bughouse", \
414   "crazyhouse", \
415   "losers", \
416   "suicide", \
417   "giveaway", \
418   "twokings", \
419   "kriegspiel", \
420   "atomic", \
421   "3check", \
422   "shatranj", \
423   "wild29", \
424   "wild30", \
425   "wild31", \
426   "wild32", \
427   "wild33", \
428   "wild34", \
429   "wild35", \
430   "wild36", \
431   "shogi", \
432   "chu", \
433   "courier", \
434   "gothic", \
435   "capablanca", \
436   "knightmate", \
437   "fairy", \
438   "cylinder", \
439   "falcon",\
440   "caparandom",\
441   "berolina",\
442   "janus",\
443   "super",\
444   "great",\
445   "twilight",\
446   "makruk",\
447   "seirawan",\
448   "grand",\
449   "spartan",\
450   "xiangqi", \
451   "asean",\
452   "lion",\
453   "elven",\
454   "unknown" \
455 }
456
457 #define ENGINES 2
458
459 typedef struct {
460     char *language;
461 #if !defined(_amigados)
462     char *whitePieceColor;
463     char *blackPieceColor;
464     char *lightSquareColor;
465     char *darkSquareColor;
466     char *jailSquareColor;
467     char *highlightSquareColor;
468     char *premoveHighlightColor;
469     char *dialogColor;
470     char *buttonColor;
471 #else
472     int whitePieceColor;
473     int blackPieceColor;
474     int lightSquareColor;
475     int darkSquareColor;
476     int jailSquareColor;
477     int highlightSquareColor;
478     int premoveHighlightColor;
479 #endif
480     int movesPerSession;
481     float timeIncrement;
482     char *engInitString[ENGINES];
483     char *computerString[ENGINES];
484     char *chessProgram[ENGINES];
485     char *directory[ENGINES];
486     char *pgnName[ENGINES];
487     Boolean firstPlaysBlack;
488     Boolean noChessProgram;
489     char *host[ENGINES];
490     char *themeNames;
491     char *pieceDirectory;
492     char *border;
493     char *soundDirectory;
494     char *remoteShell;
495     char *remoteUser;
496     float timeDelay;
497     char *timeControl;
498     Boolean trueColors;
499     Boolean icsActive;
500     Boolean autoBox;
501     char *icsHost;
502     char *icsPort;
503     char *icsCommPort;  /* if set, use serial port instead of tcp host/port */
504     char *icsLogon;     /* Hack to permit variable logon scripts. */
505     char *icsHelper;
506     Boolean icsInputBox;
507     Boolean useTelnet;
508     Boolean seekGraph;
509     Boolean autoRefresh;
510     char *telnetProgram;
511     char *gateway;
512     char *loadGameFile;
513     int loadGameIndex;      /* game # within file */
514     char *saveGameFile;
515     char *autoInstall;
516     Boolean autoSaveGames;
517     Boolean onlyOwn;        /* [HGM] suppress auto-saving of observed games */
518     char *loadPositionFile;
519     int loadPositionIndex;  /* position # within file */
520     char *savePositionFile;
521     Boolean fischerCastling;/* [HGM] fischer: allow Fischr castling in any variant */
522     Boolean matchMode;
523     int matchGames;
524     Boolean monoMode;
525     Boolean debugMode;
526     Boolean clockMode;
527     char *boardSize;
528     char *logoDir;
529     int logoSize;
530     Boolean Iconic;
531     char *searchTime;
532     int searchDepth;
533     Boolean showCoords;
534     char *clockFont;
535     char *messageFont; /* WinBoard only */
536     char *coordFont;
537     char *font; /* xboard only */
538     char *tagsFont;
539     char *commentFont;
540     char *historyFont;
541     char *gameListFont;
542     char *icsFont;
543     Boolean ringBellAfterMoves;
544     Boolean autoCallFlag;
545     Boolean flipView;
546     Boolean autoFlipView;
547     char *cmailGameName; /* xboard only */
548     Boolean headers;
549     Boolean alwaysPromoteToQueen;
550     Boolean oldSaveStyle;
551     Boolean oneClick;
552     Boolean quietPlay;
553     Boolean showThinking;
554     Boolean ponderNextMove;
555     Boolean periodicUpdates;
556     Boolean autoObserve;
557     Boolean autoCreateLogon;
558     Boolean autoComment;
559     Boolean getMoveList;
560     Boolean testLegality;
561     Boolean topLevel;      /* xboard, top-level auxiliary windows */
562     Boolean titleInWindow; /* xboard only */
563     Boolean localLineEditing; /* WinBoard only */
564     Boolean zippyTalk;
565     Boolean zippyPlay;
566     int flashCount; /* Number of times to flash (xboard only) */
567     int flashRate; /* Flashes per second (xboard only)  */
568     int msLoginDelay;  /* Delay per character (in msec) while sending
569                           ICS logon script (xboard only) */
570     Boolean colorize;   /* If True, use the following colors to color text */
571     /* Strings for colors, as "fg, bg, bold" (strings used in xboard only) */
572     char *colorShout;    // [HGM] IMPORTANT: order must conform to ColorClass definition
573     char *colorSShout;
574     char *colorChannel1;
575     char *colorChannel;
576     char *colorKibitz;
577     char *colorTell;
578     char *colorChallenge;
579     char *colorRequest;
580     char *colorSeek;
581     char *colorNormal;
582     char *soundProgram; /* sound-playing program */
583     char *soundShout;     // [HGM] IMPORTANT: order must be as in ColorClass
584     char *soundSShout;
585     char *soundChannel1;
586     char *soundChannel;
587     char *soundKibitz;
588     char *soundTell;
589     char *soundChallenge;
590     char *soundRequest;
591     char *soundSeek;
592     char *soundMove;     // [HGM] IMPORTANT: order must be as in SoundClass
593     char *soundBell;
594     char *soundRoar;
595     char *soundIcsAlarm;
596     char *soundIcsWin;
597     char *soundIcsLoss;
598     char *soundIcsDraw;
599     char *soundIcsUnfinished;
600     Boolean disguise;        /* [HGM] Promoted Pawns look like pieces in bughouse */
601     Boolean reuse[ENGINES];
602     Boolean animateDragging; /* If True, animate mouse dragging of pieces */
603     Boolean animate;    /* If True, animate non-mouse moves */
604     int animSpeed;      /* Delay in milliseconds between animation frames */
605     Boolean popupMoveErrors;
606     Boolean popupExitMessage;
607     int showJail;
608     Boolean highlightLastMove;
609     Boolean highlightDragging;
610     Boolean blindfold;          /* if true, no pieces are drawn */
611     Boolean premove;            /* true if premove feature enabled */
612     Boolean premoveWhite;       /* true if premoving White first move  */
613     char *premoveWhiteText;     /* text of White premove 1 */
614     Boolean premoveBlack;       /* true if premoving Black first move */
615     char *premoveBlackText;     /* text of Black premove 1 */
616     Boolean icsAlarm;           /* true if sounding alarm at a certain time */
617     int icsAlarmTime;           /* time to sound alarm, in milliseconds */
618     Boolean autoRaiseBoard;
619     int fontSizeTolerance; /* xboard only */
620     char *initialMode;
621     char *variant;
622     char *chatBoxes;
623     int protocolVersion[ENGINES];
624     Boolean showButtonBar;
625     Boolean icsEngineAnalyze;
626     Boolean variations;         /* [HGM] enable variation-tree walking */
627     Boolean autoExtend;         /* [HGM] enable playing move(s) of right-clicked PV in analysis mode */
628
629     /* [AS] New properties (down to the "ZIPPY" part) */
630     Boolean scoreIsAbsolute[ENGINES];  /* If true, engine score is always from white side */
631     Boolean saveExtendedInfoInPGN; /* If true, saved PGN games contain extended info */
632     Boolean hideThinkingFromHuman; /* If true, program thinking is generated but not displayed in human/computer matches */
633     Boolean useBitmaps;
634     Boolean useFont;
635     Boolean useBorder;
636     char * liteBackTextureFile; /* Name of texture bitmap for lite squares */
637     char * darkBackTextureFile; /* Name of texture bitmap for dark squares */
638     int liteBackTextureMode;
639     int darkBackTextureMode;
640     char * renderPiecesWithFont; /* Name of font for rendering chess pieces */
641     char * fontToPieceTable; /* Map to translate font character to chess pieces */
642     char * inscriptions;         /* text (kanji) to write on top of a piece     */
643     int fontBackColorWhite;
644     int fontForeColorWhite;
645     int fontBackColorBlack;
646     int fontForeColorBlack;
647     int fontPieceSize; /* Size of font relative to square (percentage) */
648     int overrideLineGap; /* If >= 0 overrides the lineGap value of the board size properties */
649     int adjudicateLossThreshold; /* Adjudicate a two-machine game if both engines agree the score is below this for 6 plies */
650     int delayBeforeQuit;
651     int delayAfterQuit;
652     char * nameOfDebugFile;
653     char * pgnEventHeader;
654     int defaultFrcPosition;
655     char * gameListTags;
656     Boolean saveOutOfBookInfo;
657     Boolean showEvalInMoveHistory;
658     int evalHistColorWhite;
659     int evalHistColorBlack;
660     Boolean highlightMoveWithArrow;
661     Boolean tourney;
662     char * tourneyOptions;
663     int highlightArrowColor;
664     Boolean useStickyWindows;
665     Boolean bgObserve;   /* [HGM] bughouse */
666     Boolean dualBoard;   /* [HGM] dual     */
667     Boolean viewer;
668     char * viewerOptions;
669     int adjudicateDrawMoves;
670     Boolean autoDisplayComment;
671     Boolean autoDisplayTags;
672     Boolean pseudo[ENGINES]; /* [HGM] pseudo-engines */
673     Boolean isUCI[ENGINES];
674     Boolean hasOwnBookUCI[ENGINES];
675     char * adapterCommand;
676     char * ucciAdapter;
677     char * polyglotDir;
678     Boolean usePolyglotBook;
679     Boolean defNoBook;
680     char * polyglotBook;
681     int bookDepth;
682     int bookStrength;
683     int defaultHashSize;
684     int defaultCacheSizeEGTB;
685     char * defaultPathEGTB;
686     int defaultMatchGames;
687
688     /* [HGM] Board size */
689     int NrFiles;
690     int NrRanks;
691     int holdingsSize;
692     int matchPause;
693     char * pieceToCharTable;
694     char * pieceNickNames;
695     char * colorNickNames;
696     Boolean allWhite;
697     Boolean upsideDown;
698     Boolean alphaRank;
699     Boolean testClaims;
700     Boolean checkMates;
701     Boolean materialDraws;
702     Boolean trivialDraws;
703     int ruleMoves;
704     int drawRepeats;
705
706 #if ZIPPY
707     char *zippyLines;
708     char *zippyPinhead;
709     char *zippyPassword;
710     char *zippyPassword2;
711     char *zippyWrongPassword;
712     char *zippyAcceptOnly;
713     int zippyUseI;
714     int zippyBughouse;
715     int zippyNoplayCrafty;
716     char *zippyGameEnd;
717     char *zippyGameStart;
718     int zippyAdjourn;
719     int zippyAbort;
720     char *zippyVariants;
721     int zippyMaxGames;
722     int zippyReplayTimeout; /*seconds*/
723     int zippyShortGame; /* [HGM] aborter   */
724 #endif
725     Boolean lowTimeWarning; /* [HGM] low time */
726     Boolean quitNext;
727     char *lowTimeWarningColor;
728
729     char *serverFileName;
730     char *serverMovesName;
731     char *finger;
732     Boolean suppressLoadMoves;
733     int serverPause;
734     int timeOdds[ENGINES];
735     int drawDepth[ENGINES];
736     int timeOddsMode;
737     int accumulateTC[ENGINES];
738     int NPS[ENGINES];
739     Boolean autoKibitz;
740     int engineComments;
741     int eloThreshold1;  /* [HGM] select   */
742     int eloThreshold2;
743     int dateThreshold;
744     int searchMode;
745     int stretch;
746     int minPieces;
747     int maxPieces;
748     Boolean ignoreColors;
749     Boolean findMirror;
750     char *userName;
751     int rewindIndex;    /* [HGM] autoinc   */
752     int sameColorGames; /* [HGM] alternate */
753     int smpCores;       /* [HGM] SMP       */
754     char *egtFormats;
755     int niceEngines;    /* [HGM] nice      */
756     char *logo[ENGINES];/* [HGM] logo      */
757     char *pairingEngine;/* [HGM] pairing   */
758     Boolean autoLogo;
759     Boolean noGUI;      /* [HGM] fast: suppress all display updates */
760     char *engOptions[ENGINES]; /* [HGM] options   */
761     char *fenOverride[ENGINES];
762     char *features[ENGINES];
763     char *featureDefaults;
764     char *sysOpen;
765     Boolean keepAlive;  /* [HGM] alive     */
766     Boolean forceIllegal;/*[HGM] illegal   */
767     Boolean noJoin;     /* [HGM] join      */
768     char *wrapContSeq; /* continuation sequence when xboard wraps text */
769     Boolean useInternalWrap; /* use internal wrapping -- noJoin usurps this if set */
770     Boolean pasteSelection; /* paste X selection instead of clipboard */
771     int nrVariations;   /* [HGM] multivar  */
772     int zoom;           /* [HGM] evalGraph */
773     int evalThreshold;  /* [HGM] evalGraph */
774     Boolean dropMenu;   /* [HGM] pv        */
775     Boolean markers;    /* [HGM] markers   */
776     Boolean autoCopyPV;
777     Boolean pieceMenu;
778     Boolean sweepSelect;
779     Boolean whitePOV;
780     Boolean scoreWhite;
781     Boolean pvSAN[ENGINES];
782
783     int recentEngines;
784     char *recentEngineList;
785     char *tourneyFile;
786     char *defName;
787     char *processes;
788     char *results;
789     char *participants;
790     char *afterGame;
791     char *afterTourney;
792     int tourneyType;
793     int tourneyCycles;
794     int seedBase;
795     Boolean roundSync;
796     Boolean cycleSync;
797     Boolean numberTag;
798 } AppData, *AppDataPtr;
799
800 /*  PGN tags (for showing in the game list) */
801 #define LPUSERGLT_SIZE      64
802
803 #define GLT_EVENT           'e'
804 #define GLT_SITE            's'
805 #define GLT_DATE            'd'
806 #define GLT_ROUND           'o'
807 #define GLT_PLAYERS         'p'     /* I.e. white "-" black */
808 #define GLT_RESULT          'r'
809 #define GLT_WHITE_ELO       'w'
810 #define GLT_BLACK_ELO       'b'
811 #define GLT_TIME_CONTROL    't'
812 #define GLT_VARIANT         'v'
813 #define GLT_OUT_OF_BOOK     'a'
814 #define GLT_RESULT_COMMENT  'c'     /* [HGM] rescom */
815
816 #define GLT_DEFAULT_TAGS    "eprd"  /* Event, players, result, date */
817
818 #define GLT_ALL_TAGS        "esdoprwbtvac"
819
820 #define PGN_OUT_OF_BOOK     "Annotator"
821
822 extern AppData appData;
823
824 typedef struct {
825     /* PGN 7-tag info */
826     char *event;
827     char *site;
828     char *date;
829     char *round;
830     char *white;
831     char *black;
832     ChessMove result;
833     /* Additional info */
834     char *fen;          /* NULL or FEN for starting position; input only */
835     char *resultDetails;
836     char *timeControl;
837     char *extraTags;    /* NULL or "[Tag \"Value\"]\n", etc. */
838     int whiteRating;    /* -1 if unknown */
839     int blackRating;    /* -1 if unknown */
840     VariantClass variant;
841     char *outOfBook;    /* [AS] Move and score when engine went out of book */
842     int boardWidth;     /* [HGM] adjustable board size */
843     int boardHeight;
844 /* [HGM] For Shogi and Crazyhouse: */
845     int holdingsSize;  /* number of different piece types in holdings       */
846     int holdingsWidth; /* number of files left and right of board, 0 or 2   */
847 } GameInfo;
848
849 /* [AS] Search stats from chessprogram, for the played move */
850 // [HGM] moved here from backend.h because it occurs in declarations of front-end functions
851 typedef struct {
852     int score;  /* Centipawns */
853     int depth;  /* Plies */
854     int time;   /* Milliseconds */
855 } ChessProgramStats_Move;
856
857 /* [AS] Layout management */
858 typedef struct {
859     Boolean visible;
860     int x;
861     int y;
862     int width;
863     int height;
864 } WindowPlacement;
865
866 extern WindowPlacement wpEngineOutput;
867 extern WindowPlacement wpEvalGraph;
868 extern WindowPlacement wpMoveHistory;
869 extern WindowPlacement wpGameList;
870 extern WindowPlacement wpTags;
871 extern WindowPlacement wpTextMenu;
872
873 #define MAXENGINES 2000
874
875 // [HGM] chat
876 #define MAX_CHAT 5
877 extern int chatCount;
878 extern char chatPartner[MAX_CHAT][MSG_SIZ];
879
880 // Some prototypes of routines so general they should be available everywhere
881 /* If status == 0, we are exiting with a benign message, not an error */
882 void DisplayFatalError P((String message, int error, int status));
883 void DisplayError P((String message, int error));
884
885 // [HGM] generally useful macros; there are way too many memory leaks...
886 #define FREE(x) if(x) free(x)
887 #define ASSIGN(x, y) if(x) free(x); x = strdup(y)
888
889 // [HGM] for now we use the kludge to redefine all the unstructured options by their array counterpart
890 //       in due time we would have to make the actual substitutions all through the source
891
892 #define firstInitString       engInitString[0]
893 #define secondInitString      engInitString[1]
894 #define firstComputerString   computerString[0]
895 #define secondComputerString  computerString[1]
896 #define firstChessProgram     chessProgram[0]
897 #define secondChessProgram    chessProgram[1]
898 #define firstDirectory        directory[0]
899 #define secondDirectory       directory[1]
900 #define firstProtocolVersion  protocolVersion[0]
901 #define secondProtocolVersion protocolVersion[1]
902 #define firstScoreIsAbsolute  scoreIsAbsolute[0]
903 #define secondScoreIsAbsolute scoreIsAbsolute[1]
904 #define firstHasOwnBookUCI    hasOwnBookUCI[0]
905 #define secondHasOwnBookUCI   hasOwnBookUCI[1]
906 #define firstTimeOdds         timeOdds[0]
907 #define secondTimeOdds        timeOdds[1]
908 #define firstAccumulateTC     accumulateTC[0]
909 #define secondAccumulateTC    accumulateTC[1]
910 #define firstHost    host[0]
911 #define secondHost   host[1]
912 #define reuseFirst   reuse[0]
913 #define reuseSecond  reuse[1]
914 #define firstIsUCI   isUCI[0]
915 #define secondIsUCI  isUCI[1]
916 #define firstNPS     NPS[0]
917 #define secondNPS    NPS[1]
918 #define firstLogo    logo[0]
919 #define secondLogo   logo[1]
920 #define fenOverride1 fenOverride[0]
921 #define fenOverride2 fenOverride[1]
922 #define firstOptions      engOptions[0]
923 #define secondOptions     engOptions[1]
924
925 #endif